Skip to content

Commit 62717ff

Browse files
author
Amanda Butler
authored
Update Storage.md
Update config page using `mbed compile --config -v`.
1 parent 83fb4ef commit 62717ff

File tree

1 file changed

+53
-99
lines changed

1 file changed

+53
-99
lines changed

docs/reference/configuration/Storage.md

Lines changed: 53 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -11,122 +11,76 @@ Name: filesystem.present
1111
Macro name: MBED_CONF_FILESYSTEM_PRESENT
1212
Value: 1 (set by library:filesystem)
1313
14-
Name: littlefs.read_size
15-
Description:
16-
Minimum size of a block read. This determines the size of read buffers.
17-
This may be larger than the physical read size to improve performance
18-
by caching more of the block device.
19-
20-
By default, this is set to 64 bytes, which we determined experimentally.
21-
Note that the LittleFS uses the block device's read size if it is
22-
larger.
23-
Defined by: library:littlefs
24-
Macro name: MBED_LFS_READ_SIZE
25-
Value: 64 (set by library:littlefs)
26-
Name: littlefs.prog_size
27-
Description:
28-
Minimum size of a block program. This determines the size of the program
29-
buffers. This may be larger than the physical program size to improve
30-
performance by caching more of the block device.
31-
32-
By default, this is set to 64 bytes, which we determined experimentally.
33-
Note that the LittleFS uses the block device's program size if it is
34-
larger.
35-
Defined by: library:littlefs
36-
Macro name: MBED_LFS_PROG_SIZE
37-
Value: 64 (set by library:littlefs)
3814
Name: littlefs.block_size
39-
Description:
40-
Minimum size of an erasable block. This does not affect RAM consumption
41-
and may be larger than the physical erase size. However, this needs to
42-
be small because each file takes up an entire block.
43-
44-
By default, this is set to 512 bytes. Note that the LittleFS uses the
45-
block device's erase size if it is larger.
15+
Description: Size of an erasable block. This does not impact ram consumption and may be larger than the physical erase size. However, this should be kept small as each file currently takes up an entire block.
4616
Defined by: library:littlefs
4717
Macro name: MBED_LFS_BLOCK_SIZE
4818
Value: 512 (set by library:littlefs)
49-
Name: littlefs.lookahead
50-
Description:
51-
Number of blocks to lookahead during block allocation. A larger
52-
lookahead reduces the number of passes required to allocate a block.
53-
The lookahead buffer requires only 1 bit per block, so it can be large
54-
with little effect on RAM. This is a multiple of 32.
55-
56-
By default, this is set to 512 blocks (which use 64 bytes of RAM),
57-
which we determined experimentally.
58-
Defined by: library:littlefs
59-
Macro name: MBED_LFS_LOOKAHEAD
60-
Value: 512 (set by library:littlefs)
61-
Name: littlefs.enable_info
62-
Description:
63-
Enables information logging (true = enabled, false = disabled,
64-
null = disabled) in release builds.
65-
66-
By default, information logging is disabled.
19+
Name: littlefs.enable_assert
20+
Description: Enables asserts, true = enabled, false = disabled, null = disabled only in release builds
6721
Defined by: library:littlefs
68-
Macro name: MBED_LFS_ENABLE_INFO
69-
Value: false (set by library:littlefs)
22+
No value set
7023
Name: littlefs.enable_debug
71-
Description:
72-
Enables debug logging (true = enabled, false = disabled,
73-
null = disabled) in release builds.
74-
75-
By default, debug logging is enabled unless you are using a release
76-
build.
24+
Description: Enables debug logging, true = enabled, false = disabled, null = disabled only in release builds
25+
Defined by: library:littlefs
26+
No value set
27+
Name: littlefs.enable_error
28+
Description: Enables error logging, true = enabled, false = disabled, null = disabled only in release builds
7729
Defined by: library:littlefs
78-
Macro name: MBED_LFS_ENABLE_DEBUG
79-
Value: null (set by library:littlefs)
30+
No value set
31+
Name: littlefs.enable_info
32+
Description: Enables info logging, true = enabled, false = disabled, null = disabled only in release builds
33+
Defined by: library:littlefs
34+
No value set
8035
Name: littlefs.enable_warn
81-
Description:
82-
Enables warn logging (true = enabled, false = disabled,
83-
null = disabled) in release builds.
84-
85-
By default, warn logging is enabled unless you are using a release
86-
build.
36+
Description: Enables warn logging, true = enabled, false = disabled, null = disabled only in release builds
8737
Defined by: library:littlefs
88-
Macro name: MBED_LFS_ENABLE_WARN
89-
Value: null (set by library:littlefs)
90-
Name: littlefs.enable_error
91-
Description:
92-
Enables error logging (true = enabled, false = disabled,
93-
null = disabled) in release builds.
94-
95-
By default, error logging is enabled unless you are using a release
96-
build.
38+
No value set
39+
Name: littlefs.intrinsics
40+
Description: Enable intrinsics for bit operations such as ctz, popc, and le32 conversion. Can be disabled to help debug toolchain issues
41+
Defined by: library:littlefs
42+
Macro name: MBED_LFS_INTRINSICS
43+
Value: 1 (set by library:littlefs)
44+
Name: littlefs.lookahead
45+
Description: Number of blocks to lookahead during block allocation. A larger lookahead reduces the number of passes required to allocate a block. The lookahead buffer requires only 1 bit per block so it can be quite large with little ram impact. Should be a multiple of 32.
46+
Defined by: library:littlefs
47+
Macro name: MBED_LFS_LOOKAHEAD
48+
Value: 512 (set by library:littlefs)
49+
Name: littlefs.prog_size
50+
Description: Minimum size of a block program. This determines the size of program buffers. This may be larger than the physical program size to improve performance by caching more of the block device.
51+
Defined by: library:littlefs
52+
Macro name: MBED_LFS_PROG_SIZE
53+
Value: 64 (set by library:littlefs)
54+
Name: littlefs.read_size
55+
Description: Minimum size of a block read. This determines the size of read buffers. This may be larger than the physical read size to improve performance by caching more of the block device.
9756
Defined by: library:littlefs
98-
Macro name: MBED_LFS_ENABLE_ERROR
99-
Value: null (set by library:littlefs)
57+
Macro name: MBED_LFS_READ_SIZE
58+
Value: 64 (set by library:littlefs)
10059
101-
Name: nvstore.max_keys
102-
Description:
103-
Maximal number of allowed NVStore keys.
104-
Defined by: library:nvstore
105-
Macro name: NVSTORE_MAX_KEYS
106-
Value: 16 (set by library:nvstore)
10760
Name: nvstore.area_1_address
108-
Description:
109-
Address of the first NVStore area in flash.
61+
Description: Area 1 address
11062
Defined by: library:nvstore
111-
Macro name: NVSTORE_AREA_1_ADDRESS
112-
Value: null (set by library:nvstore)
63+
No value set
11364
Name: nvstore.area_1_size
114-
Description:
115-
Size of the first NVStore area in flash.
65+
Description: Area 1 size
11666
Defined by: library:nvstore
117-
Macro name: NVSTORE_AREA_1_SIZE
118-
Value: null (set by library:nvstore)
67+
No value set
11968
Name: nvstore.area_2_address
120-
Description:
121-
Address of the second NVStore area in flash.
69+
Description: Area 2 address
12270
Defined by: library:nvstore
123-
Macro name: NVSTORE_AREA_2_ADDRESS
124-
Value: null (set by library:nvstore)
71+
No value set
12572
Name: nvstore.area_2_size
126-
Description:
127-
Size of the second NVStore area in flash.
73+
Description: Area 2 size
12874
Defined by: library:nvstore
129-
Macro name: NVSTORE_AREA_2_SIZE
130-
Value: null (set by library:nvstore)
131-
75+
No value set
76+
Name: nvstore.enabled
77+
Description: Enabled
78+
Defined by: library:nvstore
79+
Macro name: NVSTORE_ENABLED
80+
Value: 1 (set by library:nvstore)
81+
Name: nvstore.max_keys
82+
Description: Maximal number of allowed NVStore keys
83+
Defined by: library:nvstore
84+
Macro name: NVSTORE_MAX_KEYS
85+
Value: 16 (set by library:nvstore)
13286
```

0 commit comments

Comments
 (0)