Changeset a6a88f4 in rtems


Ignore:
Timestamp:
Apr 10, 2013, 1:46:54 PM (6 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
14c55cc
Parents:
b2cf295f
git-author:
Sebastian Huber <sebastian.huber@…> (04/10/13 13:46:54)
git-committer:
Sebastian Huber <sebastian.huber@…> (04/10/13 13:47:54)
Message:

doc: Add bdbuf configuration options

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/conf.t

    rb2cf295f ra6a88f4  
    26242624
    26252625@c
     2626@c === Block Device Cache Configuration ===
     2627@c
     2628@section Block Device Cache Configuration
     2629
     2630This section defines Block Device Cache (bdbuf) related configuration
     2631parameters.
     2632
     2633@c
     2634@c === CONFIGURE_APPLICATION_NEEDS_LIBBLOCK ===
     2635@c
     2636@subsection Enable Block Device Cache
     2637
     2638@findex CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
     2639
     2640@table @b
     2641@item CONSTANT:
     2642@code{CONFIGURE_APPLICATION_NEEDS_LIBBLOCK}
     2643
     2644@item DATA TYPE:
     2645Boolean feature macro.
     2646
     2647@item RANGE:
     2648Defined or undefined.
     2649
     2650@item DEFAULT VALUE:
     2651This option is not defined by default.
     2652
     2653@end table
     2654
     2655@subheading DESCRIPTION:
     2656Provides a Block Device Cache configuration.
     2657
     2658@subheading NOTES:
     2659Each option of the Block Device Cache configuration can be explicitly set by
     2660the user with the configuration options below.  The Block Device Cache is used
     2661for example by the RFS and DOSFS file systems.
     2662
     2663@c
     2664@c === CONFIGURE_BDBUF_CACHE_MEMORY_SIZE ===
     2665@c
     2666@subsection Size of the Cache Memory
     2667
     2668@findex CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
     2669
     2670@table @b
     2671@item CONSTANT:
     2672@code{CONFIGURE_BDBUF_CACHE_MEMORY_SIZE}
     2673
     2674@item DATA TYPE:
     2675Unsigned integer (@code{size_t}).
     2676
     2677@item RANGE:
     2678Positive.
     2679
     2680@item DEFAULT VALUE:
     2681The default value is 32KiB.
     2682
     2683@end table
     2684
     2685@subheading DESCRIPTION:
     2686Size of the cache memory in bytes.
     2687
     2688@subheading NOTES:
     2689None.
     2690
     2691@c
     2692@c === CONFIGURE_BDBUF_BUFFER_MIN_SIZE ===
     2693@c
     2694@subsection Minimum Size of a Buffer
     2695
     2696@findex CONFIGURE_BDBUF_BUFFER_MIN_SIZE
     2697
     2698@table @b
     2699@item CONSTANT:
     2700@code{CONFIGURE_BDBUF_BUFFER_MIN_SIZE}
     2701
     2702@item DATA TYPE:
     2703Unsigned integer (@code{uint32_t}).
     2704
     2705@item RANGE:
     2706Positive.
     2707
     2708@item DEFAULT VALUE:
     2709The default value is 512 bytes.
     2710
     2711@end table
     2712
     2713@subheading DESCRIPTION:
     2714Defines the minimum size of a buffer in bytes.
     2715
     2716@subheading NOTES:
     2717None.
     2718
     2719@c
     2720@c === CONFIGURE_BDBUF_BUFFER_MAX_SIZE ===
     2721@c
     2722@subsection Maximum Size of a Buffer
     2723
     2724@findex CONFIGURE_BDBUF_BUFFER_MAX_SIZE
     2725
     2726@table @b
     2727@item CONSTANT:
     2728@code{CONFIGURE_BDBUF_BUFFER_MAX_SIZE}
     2729
     2730@item DATA TYPE:
     2731Unsigned integer (@code{uint32_t}).
     2732
     2733@item RANGE:
     2734It must be positive and an integral multiple of the buffer minimum size.
     2735
     2736@item DEFAULT VALUE:
     2737The default value is 4096 bytes.
     2738
     2739@end table
     2740
     2741@subheading DESCRIPTION:
     2742Defines the maximum size of a buffer in bytes.
     2743
     2744@subheading NOTES:
     2745None.
     2746
     2747@c
     2748@c === CONFIGURE_SWAPOUT_SWAP_PERIOD ===
     2749@c
     2750@subsection Swapout Task Swap Period
     2751
     2752@findex CONFIGURE_SWAPOUT_SWAP_PERIOD
     2753
     2754@table @b
     2755@item CONSTANT:
     2756@code{CONFIGURE_SWAPOUT_SWAP_PERIOD}
     2757
     2758@item DATA TYPE:
     2759Unsigned integer (@code{uint32_t}).
     2760
     2761@item RANGE:
     2762Positive.
     2763
     2764@item DEFAULT VALUE:
     2765The default value is 250 milliseconds.
     2766
     2767@end table
     2768
     2769@subheading DESCRIPTION:
     2770Defines the swapout task swap period in milliseconds.
     2771
     2772@subheading NOTES:
     2773None.
     2774
     2775@c
     2776@c === CONFIGURE_SWAPOUT_BLOCK_HOLD ===
     2777@c
     2778@subsection Swapout Task Maximum Block Hold Time
     2779
     2780@findex CONFIGURE_SWAPOUT_BLOCK_HOLD
     2781
     2782@table @b
     2783@item CONSTANT:
     2784@code{CONFIGURE_SWAPOUT_BLOCK_HOLD}
     2785
     2786@item DATA TYPE:
     2787Unsigned integer (@code{uint32_t}).
     2788
     2789@item RANGE:
     2790Positive.
     2791
     2792@item DEFAULT VALUE:
     2793The default value is 1000 milliseconds.
     2794
     2795@end table
     2796
     2797@subheading DESCRIPTION:
     2798Defines the swapout task maximum block hold time in milliseconds.
     2799
     2800@subheading NOTES:
     2801None.
     2802
     2803@c
     2804@c === CONFIGURE_SWAPOUT_TASK_PRIORITY ===
     2805@c
     2806@subsection Swapout Task Priority
     2807
     2808@findex CONFIGURE_SWAPOUT_TASK_PRIORITY
     2809
     2810@table @b
     2811@item CONSTANT:
     2812@code{CONFIGURE_SWAPOUT_TASK_PRIORITY}
     2813
     2814@item DATA TYPE:
     2815Task priority (@code{rtems_task_priority}).
     2816
     2817@item RANGE:
     2818Valid task priority.
     2819
     2820@item DEFAULT VALUE:
     2821The default value is 15.
     2822
     2823@end table
     2824
     2825@subheading DESCRIPTION:
     2826Defines the swapout task priority.
     2827
     2828@subheading NOTES:
     2829None.
     2830
     2831@c
     2832@c === CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS ===
     2833@c
     2834@subsection Maximum Blocks per Read-Ahead Request
     2835
     2836@findex CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
     2837
     2838@table @b
     2839@item CONSTANT:
     2840@code{CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS}
     2841
     2842@item DATA TYPE:
     2843Unsigned integer (@code{uint32_t}).
     2844
     2845@item RANGE:
     2846Positive.
     2847
     2848@item DEFAULT VALUE:
     2849The default value is 0.
     2850
     2851@end table
     2852
     2853@subheading DESCRIPTION:
     2854Defines the maximum blocks per read-ahead request.
     2855
     2856@subheading NOTES:
     2857A value of 0 disables the read-ahead task (default).  The read-ahead task will
     2858issue speculative read transfers if a sequential access pattern is detected.
     2859This can improve the performance on some systems.
     2860
     2861@c
     2862@c === CONFIGURE_BDBUF_MAX_WRITE_BLOCKS ===
     2863@c
     2864@subsection Maximum Blocks per Write Request
     2865
     2866@findex CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
     2867
     2868@table @b
     2869@item CONSTANT:
     2870@code{CONFIGURE_BDBUF_MAX_WRITE_BLOCKS}
     2871
     2872@item DATA TYPE:
     2873Unsigned integer (@code{uint32_t}).
     2874
     2875@item RANGE:
     2876Positive.
     2877
     2878@item DEFAULT VALUE:
     2879The default value is 16.
     2880
     2881@end table
     2882
     2883@subheading DESCRIPTION:
     2884Defines the maximum blocks per write request.
     2885
     2886@subheading NOTES:
     2887None.
     2888
     2889@c
     2890@c === CONFIGURE_BDBUF_TASK_STACK_SIZE ===
     2891@c
     2892@subsection Task Stack Size of the Block Device Cache Tasks
     2893
     2894@findex CONFIGURE_BDBUF_TASK_STACK_SIZE
     2895
     2896@table @b
     2897@item CONSTANT:
     2898@code{CONFIGURE_BDBUF_TASK_STACK_SIZE}
     2899
     2900@item DATA TYPE:
     2901Unsigned integer (@code{size_t}).
     2902
     2903@item RANGE:
     2904Zero or positive.
     2905
     2906@item DEFAULT VALUE:
     2907The default value is the RTEMS minimum stack size.
     2908
     2909@end table
     2910
     2911@subheading DESCRIPTION:
     2912Defines the task stack size of the Block Device Cache tasks in bytes.
     2913
     2914@subheading NOTES:
     2915None.
     2916
     2917@c
     2918@c === CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY ===
     2919@c
     2920@subsection Read-Ahead Task Priority
     2921
     2922@findex CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
     2923
     2924@table @b
     2925@item CONSTANT:
     2926@code{CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY}
     2927
     2928@item DATA TYPE:
     2929Task priority (@code{rtems_task_priority}).
     2930
     2931@item RANGE:
     2932Valid task priority.
     2933
     2934@item DEFAULT VALUE:
     2935The default value is 15.
     2936
     2937@end table
     2938
     2939@subheading DESCRIPTION:
     2940Defines the read-ahead task priority.
     2941
     2942@subheading NOTES:
     2943None.
     2944
     2945@c
     2946@c === CONFIGURE_SWAPOUT_WORKER_TASKS ===
     2947@c
     2948@subsection Swapout Worker Task Count
     2949
     2950@findex CONFIGURE_SWAPOUT_WORKER_TASKS
     2951
     2952@table @b
     2953@item CONSTANT:
     2954@code{CONFIGURE_SWAPOUT_WORKER_TASKS}
     2955
     2956@item DATA TYPE:
     2957Unsigned integer (@code{size_t}).
     2958
     2959@item RANGE:
     2960Zero or positive.
     2961
     2962@item DEFAULT VALUE:
     2963The default value is 0.
     2964
     2965@end table
     2966
     2967@subheading DESCRIPTION:
     2968Defines the swapout worker task count.
     2969
     2970@subheading NOTES:
     2971None.
     2972
     2973@c
     2974@c === CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY ===
     2975@c
     2976@subsection Swapout Worker Task Priority
     2977
     2978@findex CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
     2979
     2980@table @b
     2981@item CONSTANT:
     2982@code{CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY}
     2983
     2984@item DATA TYPE:
     2985Task priority (@code{rtems_task_priority}).
     2986
     2987@item RANGE:
     2988Valid task priority.
     2989
     2990@item DEFAULT VALUE:
     2991The default value is 15.
     2992
     2993@end table
     2994
     2995@subheading DESCRIPTION:
     2996Defines the swapout worker task priority.
     2997
     2998@subheading NOTES:
     2999None.
     3000
     3001@c
    26263002@c === BSP Specific Settings ===
    26273003@c
Note: See TracChangeset for help on using the changeset viewer.