Skip to content

Commit 8c824fd

Browse files
author
Amanda Butler
authored
Merge pull request #738 from c1728p9/config
Update platform and rtos config docs
2 parents c1283a8 + 6053c51 commit 8c824fd

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

docs/reference/configuration/Platform.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ The following is the complete list of platform configuration parameters, as gene
88
Configuration parameters
99
------------------------
1010
11+
Name: platform.cpu-stats-enabled
12+
Description: Set to 1 to enable cpu stats. When enabled the function mbed_stats_cpu_get returns non-zero data. See mbed_stats.h for more information
13+
Defined by: library:platform
14+
No value set
1115
Name: platform.default-serial-baud-rate
1216
Description: Default baud rate for a Serial or RawSerial instance (if not specified in the constructor)
1317
Defined by: library:platform
@@ -17,6 +21,11 @@ Name: platform.error-all-threads-info
1721
Description: Reports all the threads in the system as part of error report.
1822
Defined by: library:platform
1923
No value set
24+
Name: platform.error-decode-http-url-str
25+
Description: HTTP URL string for ARM Mbed-OS Error Decode microsite
26+
Defined by: library:platform
27+
Macro name: MBED_CONF_PLATFORM_ERROR_DECODE_HTTP_URL_STR
28+
Value: "\nFor more info, visit: https:/\/armmbed.github.io/mbedos-error/?error=0x%08X" (set by library:platform)
2029
Name: platform.error-filename-capture-enabled
2130
Description: Enables capture of filename and line number as part of error context capture, this works only for debug and develop builds. On release builds, filename capture is always disabled
2231
Defined by: library:platform
@@ -34,15 +43,27 @@ Name: platform.force-non-copyable-error
3443
Description: Force compile time error when a NonCopyable object is copied
3544
Defined by: library:platform
3645
No value set
46+
Name: platform.heap-stats-enabled
47+
Description: Set to 1 to enable heap stats. When enabled the function mbed_stats_heap_get returns non-zero data. See mbed_stats.h for more information
48+
Defined by: library:platform
49+
No value set
3750
Name: platform.max-error-filename-len
3851
Description: Sets the maximum length of buffer used for capturing the filename in error context. This needs error-filename-capture-enabled feature.
3952
Defined by: library:platform
4053
Macro name: MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN
4154
Value: 16 (set by library:platform)
55+
Name: platform.memory-tracing-enabled
56+
Description: Enable tracing of each memory call by invoking a callback on each memory operation. See mbed_mem_trace.h in the HAL API for more information
57+
Defined by: library:platform
58+
No value set
4259
Name: platform.poll-use-lowpower-timer
4360
Description: Enable use of low power timer class for poll(). May cause missing events.
4461
Defined by: library:platform
4562
No value set
63+
Name: platform.stack-stats-enabled
64+
Description: Set to 1 to enable stack stats. When enabled the functions mbed_stats_stack_get and mbed_stats_stack_get_each return non-zero data. See mbed_stats.h for more information
65+
Defined by: library:platform
66+
No value set
4667
Name: platform.stdio-baud-rate
4768
Description: Baud rate for stdio
4869
Defined by: library:platform
@@ -65,4 +86,12 @@ Name: platform.stdio-flush-at-exit
6586
Defined by: library:platform
6687
Macro name: MBED_CONF_PLATFORM_STDIO_FLUSH_AT_EXIT
6788
Value: 1 (set by library:platform)
89+
Name: platform.sys-stats-enabled
90+
Description: Set to 1 to enable system stats. When enabled the function mbed_stats_sys_get returns non-zero data. See mbed_stats.h for more information
91+
Defined by: library:platform
92+
No value set
93+
Name: platform.thread-stats-enabled
94+
Description: Set to 1 to enable thread stats. When enabled the function mbed_stats_thread_get_each returns non-zero data. See mbed_stats.h for more information
95+
Defined by: library:platform
96+
No value set
6897
```

docs/reference/configuration/RTOS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,30 @@ The following is the complete list of RTOS configuration parameters, as generate
1717
Configuration parameters
1818
------------------------
1919
20+
Name: rtos.idle-thread-stack-size
21+
Description: The size of the idle thread's stack
22+
Defined by: library:rtos
23+
Macro name: MBED_CONF_RTOS_IDLE_THREAD_STACK_SIZE
24+
Value: 512 (set by library:rtos)
25+
Name: rtos.main-thread-stack-size
26+
Description: The size of the main thread's stack
27+
Defined by: library:rtos
28+
Macro name: MBED_CONF_RTOS_MAIN_THREAD_STACK_SIZE
29+
Value: 4096 (set by library:rtos)
2030
Name: rtos.present
2131
Defined by: library:rtos
2232
Macro name: MBED_CONF_RTOS_PRESENT
2333
Value: 1 (set by library:rtos)
34+
Name: rtos.thread-stack-size
35+
Description: The default stack size of new threads
36+
Defined by: library:rtos
37+
Macro name: MBED_CONF_RTOS_THREAD_STACK_SIZE
38+
Value: 4096 (set by library:rtos)
39+
Name: rtos.timer-thread-stack-size
40+
Description: The size of the timer thread's stack
41+
Defined by: library:rtos
42+
Macro name: MBED_CONF_RTOS_TIMER_THREAD_STACK_SIZE
43+
Value: 768 (set by library:rtos)
2444
```
2545

2646
### EventQueue configuration parameters

0 commit comments

Comments
 (0)