summaryrefslogtreecommitdiffstats
path: root/c-user/config/bdbuf.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-17 14:10:58 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-17 14:11:26 +0100
commitf3076bcd52ad1acf4ed5a0147a4ade659c6f8716 (patch)
tree2e458a6b79e4cd17ddcddce0c7a0cc62198c6350 /c-user/config/bdbuf.rst
parentc-user: Obsolete CONFIGURE_MAXIMUM_DEVICES (diff)
downloadrtems-docs-f3076bcd52ad1acf4ed5a0147a4ade659c6f8716.tar.bz2
c-user: Sort configuration options alphabetically
Update #3836.
Diffstat (limited to 'c-user/config/bdbuf.rst')
-rw-r--r--c-user/config/bdbuf.rst48
1 files changed, 24 insertions, 24 deletions
diff --git a/c-user/config/bdbuf.rst b/c-user/config/bdbuf.rst
index 011d4ee..7c3114c 100644
--- a/c-user/config/bdbuf.rst
+++ b/c-user/config/bdbuf.rst
@@ -35,77 +35,77 @@ NOTES:
by the user with the configuration options below. The Block Device Cache
is used for example by the RFS and DOSFS file systems.
-.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
+.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
-.. _CONFIGURE_BDBUF_CACHE_MEMORY_SIZE:
+.. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE:
-CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
----------------------------------
+CONFIGURE_BDBUF_BUFFER_MAX_SIZE
+-------------------------------
CONSTANT:
- ``CONFIGURE_BDBUF_CACHE_MEMORY_SIZE``
+ ``CONFIGURE_BDBUF_BUFFER_MAX_SIZE``
DATA TYPE:
- Unsigned integer (``size_t``).
+ Unsigned integer (``uint32_t``).
RANGE:
- Positive.
+ It must be positive and an integral multiple of the buffer minimum size.
DEFAULT VALUE:
- The default value is 32768 bytes.
+ The default value is 4096 bytes.
DESCRIPTION:
- Size of the cache memory in bytes.
+ Defines the maximum size of a buffer in bytes.
NOTES:
None.
-.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
+.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
-.. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE:
+.. _CONFIGURE_BDBUF_BUFFER_MIN_SIZE:
-CONFIGURE_BDBUF_BUFFER_MAX_SIZE
+CONFIGURE_BDBUF_BUFFER_MIN_SIZE
-------------------------------
CONSTANT:
- ``CONFIGURE_BDBUF_BUFFER_MAX_SIZE``
+ ``CONFIGURE_BDBUF_BUFFER_MIN_SIZE``
DATA TYPE:
Unsigned integer (``uint32_t``).
RANGE:
- It must be positive and an integral multiple of the buffer minimum size.
+ Positive.
DEFAULT VALUE:
- The default value is 4096 bytes.
+ The default value is 512 bytes.
DESCRIPTION:
- Defines the maximum size of a buffer in bytes.
+ Defines the minimum size of a buffer in bytes.
NOTES:
None.
-.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
+.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
-.. _CONFIGURE_BDBUF_BUFFER_MIN_SIZE:
+.. _CONFIGURE_BDBUF_CACHE_MEMORY_SIZE:
-CONFIGURE_BDBUF_BUFFER_MIN_SIZE
--------------------------------
+CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
+---------------------------------
CONSTANT:
- ``CONFIGURE_BDBUF_BUFFER_MIN_SIZE``
+ ``CONFIGURE_BDBUF_CACHE_MEMORY_SIZE``
DATA TYPE:
- Unsigned integer (``uint32_t``).
+ Unsigned integer (``size_t``).
RANGE:
Positive.
DEFAULT VALUE:
- The default value is 512 bytes.
+ The default value is 32768 bytes.
DESCRIPTION:
- Defines the minimum size of a buffer in bytes.
+ Size of the cache memory in bytes.
NOTES:
None.