Changeset 1af97ad in rtems-docs for c-user/config/index.rst


Ignore:
Timestamp:
Mar 9, 2020, 7:52:24 AM (5 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
4bb586b
Parents:
c0a70db
git-author:
Sebastian Huber <sebastian.huber@…> (03/09/20 07:52:24)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/12/20 09:18:57)
Message:

c-user: Move "Block Device Cache Configuration"

Update #3836.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/config/index.rst

    rc0a70db r1af97ad  
    2121    msg-queue-buffer
    2222    filesystem
    23 
    24 Block Device Cache Configuration
    25 ================================
    26 
    27 This section defines Block Device Cache (bdbuf) related configuration
    28 parameters.
    29 
    30 .. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
    31 
    32 .. _CONFIGURE_APPLICATION_NEEDS_LIBBLOCK:
    33 
    34 CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
    35 ------------------------------------
    36 
    37 CONSTANT:
    38     ``CONFIGURE_APPLICATION_NEEDS_LIBBLOCK``
    39 
    40 DATA TYPE:
    41     Boolean feature macro.
    42 
    43 RANGE:
    44     Defined or undefined.
    45 
    46 DEFAULT VALUE:
    47     This is not defined by default.
    48 
    49 DESCRIPTION:
    50     Provides a Block Device Cache configuration.
    51 
    52 NOTES:
    53     Each option of the Block Device Cache configuration can be explicitly set
    54     by the user with the configuration options below.  The Block Device Cache
    55     is used for example by the RFS and DOSFS file systems.
    56 
    57 .. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
    58 
    59 .. _CONFIGURE_BDBUF_CACHE_MEMORY_SIZE:
    60 
    61 CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
    62 ---------------------------------
    63 
    64 CONSTANT:
    65     ``CONFIGURE_BDBUF_CACHE_MEMORY_SIZE``
    66 
    67 DATA TYPE:
    68     Unsigned integer (``size_t``).
    69 
    70 RANGE:
    71     Positive.
    72 
    73 DEFAULT VALUE:
    74     The default value is 32768 bytes.
    75 
    76 DESCRIPTION:
    77     Size of the cache memory in bytes.
    78 
    79 NOTES:
    80     None.
    81 
    82 .. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
    83 
    84 .. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE:
    85 
    86 CONFIGURE_BDBUF_BUFFER_MAX_SIZE
    87 -------------------------------
    88 
    89 CONSTANT:
    90     ``CONFIGURE_BDBUF_BUFFER_MAX_SIZE``
    91 
    92 DATA TYPE:
    93     Unsigned integer (``uint32_t``).
    94 
    95 RANGE:
    96     It must be positive and an integral multiple of the buffer minimum size.
    97 
    98 DEFAULT VALUE:
    99     The default value is 4096 bytes.
    100 
    101 DESCRIPTION:
    102     Defines the maximum size of a buffer in bytes.
    103 
    104 NOTES:
    105     None.
    106 
    107 .. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
    108 
    109 .. _CONFIGURE_BDBUF_BUFFER_MIN_SIZE:
    110 
    111 CONFIGURE_BDBUF_BUFFER_MIN_SIZE
    112 -------------------------------
    113 
    114 CONSTANT:
    115     ``CONFIGURE_BDBUF_BUFFER_MIN_SIZE``
    116 
    117 DATA TYPE:
    118     Unsigned integer (``uint32_t``).
    119 
    120 RANGE:
    121     Positive.
    122 
    123 DEFAULT VALUE:
    124     The default value is 512 bytes.
    125 
    126 DESCRIPTION:
    127     Defines the minimum size of a buffer in bytes.
    128 
    129 NOTES:
    130     None.
    131 
    132 .. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
    133 
    134 .. _CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS:
    135 
    136 CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
    137 -------------------------------------
    138 
    139 CONSTANT:
    140     ``CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS``
    141 
    142 DATA TYPE:
    143     Unsigned integer (``uint32_t``).
    144 
    145 RANGE:
    146     Positive.
    147 
    148 DEFAULT VALUE:
    149     The default value is 0.
    150 
    151 DESCRIPTION:
    152     Defines the maximum blocks per read-ahead request.
    153 
    154 NOTES:
    155     A value of 0 disables the read-ahead task (default).  The read-ahead task
    156     will issue speculative read transfers if a sequential access pattern is
    157     detected.  This can improve the performance on some systems.
    158 
    159 .. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
    160 
    161 .. _CONFIGURE_BDBUF_MAX_WRITE_BLOCKS:
    162 
    163 CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
    164 --------------------------------
    165 
    166 CONSTANT:
    167     ``CONFIGURE_BDBUF_MAX_WRITE_BLOCKS``
    168 
    169 DATA TYPE:
    170     Unsigned integer (``uint32_t``).
    171 
    172 RANGE:
    173     Positive.
    174 
    175 DEFAULT VALUE:
    176     The default value is 16.
    177 
    178 DESCRIPTION:
    179     Defines the maximum blocks per write request.
    180 
    181 NOTES:
    182     None.
    183 
    184 .. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
    185 
    186 .. _CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY:
    187 
    188 CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
    189 ----------------------------------------
    190 
    191 CONSTANT:
    192     ``CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY``
    193 
    194 DATA TYPE:
    195     Task priority (``rtems_task_priority``).
    196 
    197 RANGE:
    198     Valid task priority.
    199 
    200 DEFAULT VALUE:
    201     The default value is 15.
    202 
    203 DESCRIPTION:
    204     Defines the read-ahead task priority.
    205 
    206 NOTES:
    207     None.
    208 
    209 .. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
    210 
    211 .. _CONFIGURE_BDBUF_TASK_STACK_SIZE:
    212 
    213 CONFIGURE_BDBUF_TASK_STACK_SIZE
    214 -------------------------------
    215 
    216 CONSTANT:
    217     ``CONFIGURE_BDBUF_TASK_STACK_SIZE``
    218 
    219 DATA TYPE:
    220     Unsigned integer (``size_t``).
    221 
    222 RANGE:
    223     Zero or positive.
    224 
    225 DEFAULT VALUE:
    226     The default value is RTEMS_MINIMUM_STACK_SIZE.
    227 
    228 DESCRIPTION:
    229     Defines the task stack size of the Block Device Cache tasks in bytes.
    230 
    231 NOTES:
    232     None.
    233 
    234 .. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
    235 
    236 .. _CONFIGURE_SWAPOUT_BLOCK_HOLD:
    237 
    238 CONFIGURE_SWAPOUT_BLOCK_HOLD
    239 ----------------------------
    240 
    241 CONSTANT:
    242     ``CONFIGURE_SWAPOUT_BLOCK_HOLD``
    243 
    244 DATA TYPE:
    245     Unsigned integer (``uint32_t``).
    246 
    247 RANGE:
    248     Positive.
    249 
    250 DEFAULT VALUE:
    251     The default value is 1000 milliseconds.
    252 
    253 DESCRIPTION:
    254     Defines the swapout task maximum block hold time in milliseconds.
    255 
    256 NOTES:
    257     None.
    258 
    259 .. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
    260 
    261 .. _CONFIGURE_SWAPOUT_SWAP_PERIOD:
    262 
    263 CONFIGURE_SWAPOUT_SWAP_PERIOD
    264 -----------------------------
    265 
    266 CONSTANT:
    267     ``CONFIGURE_SWAPOUT_SWAP_PERIOD``
    268 
    269 DATA TYPE:
    270     Unsigned integer (``uint32_t``).
    271 
    272 RANGE:
    273     Positive.
    274 
    275 DEFAULT VALUE:
    276     The default value is 250 milliseconds.
    277 
    278 DESCRIPTION:
    279     Defines the swapout task swap period in milliseconds.
    280 
    281 NOTES:
    282     None.
    283 
    284 .. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
    285 
    286 .. _CONFIGURE_SWAPOUT_TASK_PRIORITY:
    287 
    288 CONFIGURE_SWAPOUT_TASK_PRIORITY
    289 -------------------------------
    290 
    291 CONSTANT:
    292     ``CONFIGURE_SWAPOUT_TASK_PRIORITY``
    293 
    294 DATA TYPE:
    295     Task priority (``rtems_task_priority``).
    296 
    297 RANGE:
    298     Valid task priority.
    299 
    300 DEFAULT VALUE:
    301     The default value is 15.
    302 
    303 DESCRIPTION:
    304     Defines the swapout task priority.
    305 
    306 NOTES:
    307     None.
    308 
    309 .. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
    310 
    311 .. _CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY:
    312 
    313 CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
    314 --------------------------------------
    315 
    316 CONSTANT:
    317     ``CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY``
    318 
    319 DATA TYPE:
    320     Task priority (``rtems_task_priority``).
    321 
    322 RANGE:
    323     Valid task priority.
    324 
    325 DEFAULT VALUE:
    326     The default value is 15.
    327 
    328 DESCRIPTION:
    329     Defines the swapout worker task priority.
    330 
    331 NOTES:
    332     None.
    333 
    334 .. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
    335 
    336 .. _CONFIGURE_SWAPOUT_WORKER_TASKS:
    337 
    338 CONFIGURE_SWAPOUT_WORKER_TASKS
    339 ------------------------------
    340 
    341 CONSTANT:
    342     ``CONFIGURE_SWAPOUT_WORKER_TASKS``
    343 
    344 DATA TYPE:
    345     Unsigned integer (``size_t``).
    346 
    347 RANGE:
    348     Zero or positive.
    349 
    350 DEFAULT VALUE:
    351     The default value is 0.
    352 
    353 DESCRIPTION:
    354     Defines the swapout worker task count.
    355 
    356 NOTES:
    357     None.
     23    bdbuf
    35824
    35925BSP Related Configuration Options
Note: See TracChangeset for help on using the changeset viewer.