Skip to content

Commit 07ff22e

Browse files
kegilbertkegilbert
committed
Post script config markdown files
1 parent 7495427 commit 07ff22e

File tree

7 files changed

+734
-206
lines changed

7 files changed

+734
-206
lines changed

‎docs/reference/configuration/Connectivity.md

Lines changed: 134 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ The following is the complete list of connectivity configuration parameters, as
99
```
1010
Configuration parameters
1111
------------------------
12-
1312
Name: lwip.addr-timeout
1413
Description: On dual-stack system how long to additionally wait for other stack's address in seconds
1514
Defined by: library:lwip
@@ -24,23 +23,42 @@ Name: lwip.debug-enabled
2423
Description: Enable debug trace support
2524
Defined by: library:lwip
2625
No value set
27-
Name: lwip.use-mbed-trace
28-
Description: Use mbed trace for debug, rather than printf
29-
Defined by: library:lwip
30-
No value set
3126
Name: lwip.default-thread-stacksize
3227
Description: Stack size for lwip system threads
3328
Defined by: library:lwip
3429
Macro name: MBED_CONF_LWIP_DEFAULT_THREAD_STACKSIZE
3530
Value: 512 (set by library:lwip)
31+
Name: lwip.enable-ppp-trace
32+
Description: Enable trace support for PPP interfaces
33+
Defined by: library:lwip
34+
No value set
35+
Name: lwip.ethernet-enabled
36+
Description: Enable support for Ethernet interfaces
37+
Defined by: library:lwip
38+
Macro name: MBED_CONF_LWIP_ETHERNET_ENABLED
39+
Value: 1 (set by library:lwip)
3640
Name: lwip.ip-ver-pref
3741
Description: On dual-stack system the preferred stack: 4 for IPv4 and 6 for IPv6
3842
Defined by: library:lwip
3943
Macro name: MBED_CONF_LWIP_IP_VER_PREF
4044
Value: 4 (set by library:lwip)
45+
Name: lwip.ipv4-enabled
46+
Description: Enable IPv4
47+
Defined by: library:lwip
48+
Macro name: MBED_CONF_LWIP_IPV4_ENABLED
49+
Value: 1 (set by library:lwip)
50+
Name: lwip.ipv6-enabled
51+
Description: Enable IPv6
52+
Defined by: library:lwip
53+
No value set
4154
Name: lwip.mem-size
4255
Description: Size of heap (bytes) - used for outgoing packets, and also used by some drivers for reception. Current default (used if null here) is set to 1600 in opt.h, unless overridden by target Ethernet drivers.
4356
Defined by: library:lwip
57+
Macro name: MBED_CONF_LWIP_MEM_SIZE
58+
Value: 16384 (set by library:lwip[Freescale])
59+
Name: lwip.memp-num-tcp-seg
60+
Description: Number of simultaneously queued TCP segments. Current default (used if null here) is set to 16 in opt.h, unless overridden by target Ethernet drivers.
61+
Defined by: library:lwip
4462
No value set
4563
Name: lwip.pbuf-pool-bufsize
4664
Description: Size of pbufs in pool. If set to null, lwIP will base the size on the TCP MSS, which is 536 unless overridden by the target
@@ -50,21 +68,65 @@ Name: lwip.pbuf-pool-size
5068
Description: Number of pbufs in pool - usually used for received packets, so this determines how much data can be buffered between reception and the application reading. If a driver uses PBUF_RAM for reception, less pool may be needed. Current default (used if null here) is set to 5 in lwipopts.h, unless overridden by target Ethernet drivers.
5169
Defined by: library:lwip
5270
No value set
71+
Name: lwip.ppp-enabled
72+
Description: Enable support for PPP interfaces
73+
Defined by: library:lwip
74+
No value set
75+
Name: lwip.ppp-ipv4-enabled
76+
Description: Enable support for ipv4 PPP interface
77+
Defined by: library:lwip
78+
Macro name: NSAPI_PPP_IPV4_AVAILABLE
79+
Value: 1 (set by library:lwip)
80+
Name: lwip.ppp-ipv6-enabled
81+
Description: Enable support for ipv6 PPP interface
82+
Defined by: library:lwip
83+
No value set
84+
Name: lwip.ppp-thread-stacksize
85+
Description: Thread stack size for PPP
86+
Defined by: library:lwip
87+
Macro name: MBED_CONF_LWIP_PPP_THREAD_STACKSIZE
88+
Value: 768 (set by library:lwip)
5389
Name: lwip.socket-max
5490
Description: Maximum number of open TCPServer, TCPSocket and UDPSocket instances allowed, including one used internally for DNS. Each requires 236 bytes of pre-allocated RAM
5591
Defined by: library:lwip
5692
Macro name: MBED_CONF_LWIP_SOCKET_MAX
5793
Value: 4 (set by library:lwip)
94+
Name: lwip.tcp-enabled
95+
Description: Enable TCP
96+
Defined by: library:lwip
97+
Macro name: MBED_CONF_LWIP_TCP_ENABLED
98+
Value: 1 (set by library:lwip)
99+
Name: lwip.tcp-maxrtx
100+
Description: Maximum number of retransmissions of data segments.
101+
Defined by: library:lwip
102+
Macro name: MBED_CONF_LWIP_TCP_MAXRTX
103+
Value: 6 (set by library:lwip)
104+
Name: lwip.tcp-mss
105+
Description: TCP Maximum segment size. Current default (used if null here) is set to 536 in opt.h, unless overridden by target Ethernet drivers.
106+
Defined by: library:lwip
107+
No value set
58108
Name: lwip.tcp-server-max
59109
Description: Maximum number of open TCPServer instances allowed. Each requires 72 bytes of pre-allocated RAM
60110
Defined by: library:lwip
61111
Macro name: MBED_CONF_LWIP_TCP_SERVER_MAX
62112
Value: 4 (set by library:lwip)
113+
Name: lwip.tcp-snd-buf
114+
Description: TCP sender buffer space (bytes). Current default (used if null here) is set to (2 * TCP_MSS) in opt.h, unless overridden by target Ethernet drivers.
115+
Defined by: library:lwip
116+
No value set
63117
Name: lwip.tcp-socket-max
64118
Description: Maximum number of open TCPSocket instances allowed. Each requires 196 bytes of pre-allocated RAM
65119
Defined by: library:lwip
66120
Macro name: MBED_CONF_LWIP_TCP_SOCKET_MAX
67121
Value: 4 (set by library:lwip)
122+
Name: lwip.tcp-synmaxrtx
123+
Description: Maximum number of retransmissions of SYN segments. Current default (used if null here) is set to 6 in opt.h
124+
Defined by: library:lwip
125+
No value set
126+
Name: lwip.tcp-wnd
127+
Description: TCP sender buffer space (bytes). Current default (used if null here) is set to (4 * TCP_MSS) in opt.h, unless overridden by target Ethernet drivers.
128+
Defined by: library:lwip
129+
No value set
68130
Name: lwip.tcpip-thread-stacksize
69131
Description: Stack size for lwip TCPIP thread
70132
Defined by: library:lwip
@@ -75,73 +137,10 @@ Name: lwip.udp-socket-max
75137
Defined by: library:lwip
76138
Macro name: MBED_CONF_LWIP_UDP_SOCKET_MAX
77139
Value: 4 (set by library:lwip)
78-
Name: lwip.ppp-thread-stacksize
79-
Description: Thread stack size for PPP
80-
Defined by: library:lwip
81-
Macro name: MBED_CONF_LWIP_PPP_THREAD_STACKSIZE
82-
Value: 768 (set by library:lwip)
83-
Name: lwip.ethernet-enabled
84-
Description: Enable support for Ethernet interfaces
85-
Defined by: library:lwip
86-
Macro name: MBED_CONF_LWIP_ETHERNET_ENABLED
87-
Value: 1 (set by library:lwip)
88-
Name: lwip.ipv4-enabled
89-
Description: Enable IPv4
90-
Defined by: library:lwip
91-
Macro name: MBED_CONF_LWIP_IPV4_ENABLED
92-
Value: 1 (set by library:lwip)
93-
Name: lwip.ipv6-enabled
94-
Description: Enable IPv6
95-
Defined by: library:lwip
96-
No value set
97-
Name: lwip.tcp-enabled
98-
Description: Enable TCP
99-
Defined by: library:lwip
100-
Macro name: MBED_CONF_LWIP_TCP_ENABLED
101-
Value: 1 (set by library:lwip)
102-
Name: lwip.ppp-enabled
103-
Description: Enable support for PPP interfaces
104-
Defined by: library:lwip
105-
No value set
106-
Name: lwip.ppp-ipv4-enabled
107-
Description: Enable support for ipv4 PPP interface
108-
Defined by: library:lwip
109-
Macro name: NSAPI_PPP_IPV4_AVAILABLE
110-
Value: 1 (set by library:lwip)
111-
Name: lwip.ppp-ipv6-enabled
112-
Description: Enable support for ipv6 PPP interface
113-
Defined by: library:lwip
114-
No value set
115-
Name: cellular.random_max_start_delay
116-
Description: Maximum random delay value used in start-up sequence in milliseconds
117-
Defined by: library:cellular
118-
No value set
119-
Name: cellular.use-apn-lookup
120-
Description: Use APN database lookup
121-
Defined by: library:cellular
122-
Macro name: MBED_CONF_CELLULAR_USE_APN_LOOKUP
123-
Value: 1 (set by library:cellular)
124-
Name: ppp-cell-iface.apn-lookup
125-
Defined by: library:ppp-cell-iface
126-
Macro name: MBED_CONF_PPP_CELL_IFACE_APN_LOOKUP
127-
Value: 1 (set by library:ppp-cell-iface)
128-
Name: ppp-cell-iface.at-parser-buffer-size
129-
Defined by: library:ppp-cell-iface
130-
Macro name: MBED_CONF_PPP_CELL_IFACE_AT_PARSER_BUFFER_SIZE
131-
Value: 256 (set by library:ppp-cell-iface)
132-
Name: ppp-cell-iface.at-parser-timeout
133-
Defined by: library:ppp-cell-iface
134-
Macro name: MBED_CONF_PPP_CELL_IFACE_AT_PARSER_TIMEOUT
135-
Value: 8000 (set by library:ppp-cell-iface)
136-
Name: ppp-cell-iface.baud-rate
137-
Defined by: library:ppp-cell-iface
138-
Macro name: MBED_CONF_PPP_CELL_IFACE_BAUD_RATE
139-
Value: 115200 (set by library:ppp-cell-iface)
140-
Name: lwip.enable-ppp-trace
141-
Description: Enable trace support for PPP interfaces
140+
Name: lwip.use-mbed-trace
141+
Description: Use mbed trace for debug, rather than printf
142142
Defined by: library:lwip
143143
No value set
144-
145144
```
146145

147146
### Selecting the default network interface
@@ -172,48 +171,98 @@ Select the default interface type by using one of the following `target.network-
172171
```
173172
Configuration parameters
174173
------------------------
174+
Name: target.boot-stack-size
175+
Description: Define the boot stack size in bytes. This value must be a multiple of 8
176+
Defined by: target:Target
177+
Macro name: MBED_CONF_TARGET_BOOT_STACK_SIZE
178+
Value: 0x400 (set by library:rtos[*])
179+
Name: target.console-uart-flow-control
180+
Description: Console hardware flow control. Options: null, RTS, CTS, RTSCTS.
181+
Defined by: target:Target
182+
No value set
183+
Name: target.deep-sleep-latency
184+
Description: Time in ms required to go to and wake up from deep sleep (max 10)
185+
Defined by: target:Target
186+
No value set
187+
Name: target.mpu-rom-end
188+
Description: Last address of ROM protected by the MPU
189+
Defined by: target:Target
190+
Macro name: MBED_CONF_TARGET_MPU_ROM_END
191+
Value: 0x0fffffff (set by target:Target)
175192
Name: target.network-default-interface-type
176193
Description: Default network interface type. Typical options: null, ETHERNET, WIFI, CELLULAR, MESH
177194
Defined by: target:Target
178195
Macro name: MBED_CONF_TARGET_NETWORK_DEFAULT_INTERFACE_TYPE
179-
Value: ETHERNET
196+
Value: ETHERNET (set by target:K64F)
180197
```
181198

182199
```
183200
Configuration parameters
184201
------------------------
185-
186-
Name: nsapi.default-wifi-security
187-
Defined by: library:nsapi
188-
Macro name: MBED_CONF_NSAPI_DEFAULT_WIFI_SECURITY
189-
Value: NONE (set by library:nsapi)
190-
Name: nsapi.default-wifi-ssid
202+
Name: nsapi.default-cellular-apn
191203
Defined by: library:nsapi
192204
No value set
193-
Name: nsapi.default-wifi-password
205+
Name: nsapi.default-cellular-password
194206
Defined by: library:nsapi
195207
No value set
196208
Name: nsapi.default-cellular-plmn
197-
Defined by: library:nsapi
198-
No value set
199-
Name: nsapi.default-cellular-sim-pin
200-
Defined by: library:nsapi
201-
No value set
202-
Name: nsapi.default-cellular-apn
203209
Defined by: library:nsapi
204210
No value set
205-
Name: nsapi.default-cellular-password
211+
Name: nsapi.default-cellular-sim-pin
206212
Defined by: library:nsapi
207213
No value set
208214
Name: nsapi.default-cellular-username
209215
Defined by: library:nsapi
210216
No value set
211217
Name: nsapi.default-mesh-type
218+
Description: Configuration type for MeshInterface::get_default_instance(). [LOWPAN/THREAD]
212219
Defined by: library:nsapi
213220
Macro name: MBED_CONF_NSAPI_DEFAULT_MESH_TYPE
214221
Value: THREAD (set by library:nsapi)
215222
Name: nsapi.default-stack
216223
Defined by: library:nsapi
217224
Macro name: MBED_CONF_NSAPI_DEFAULT_STACK
218225
Value: LWIP (set by library:nsapi)
226+
Name: nsapi.default-wifi-password
227+
Defined by: library:nsapi
228+
No value set
229+
Name: nsapi.default-wifi-security
230+
Defined by: library:nsapi
231+
Macro name: MBED_CONF_NSAPI_DEFAULT_WIFI_SECURITY
232+
Value: NONE (set by library:nsapi)
233+
Name: nsapi.default-wifi-ssid
234+
Defined by: library:nsapi
235+
No value set
236+
Name: nsapi.dns-cache-size
237+
Description: Number of cached host name resolutions
238+
Defined by: library:nsapi
239+
Macro name: MBED_CONF_NSAPI_DNS_CACHE_SIZE
240+
Value: 3 (set by library:nsapi)
241+
Name: nsapi.dns-response-wait-time
242+
Description: How long the DNS translator waits for a reply from a server in milliseconds
243+
Defined by: library:nsapi
244+
Macro name: MBED_CONF_NSAPI_DNS_RESPONSE_WAIT_TIME
245+
Value: 5000 (set by library:nsapi)
246+
Name: nsapi.dns-retries
247+
Description: Number of DNS query retries that the DNS translator makes per server, before moving on to the next server. Total retries/attempts is always limited by dns-total-attempts.
248+
Defined by: library:nsapi
249+
No value set
250+
Name: nsapi.dns-total-attempts
251+
Description: Number of total DNS query attempts that the DNS translator makes
252+
Defined by: library:nsapi
253+
Macro name: MBED_CONF_NSAPI_DNS_TOTAL_ATTEMPTS
254+
Value: 3 (set by library:nsapi)
255+
Name: nsapi.present
256+
Defined by: library:nsapi
257+
Macro name: MBED_CONF_NSAPI_PRESENT
258+
Value: 1 (set by library:nsapi)
259+
Name: nsapi.socket-stats-enable
260+
Description: Enable network socket statistics
261+
Defined by: library:nsapi
262+
No value set
263+
Name: nsapi.socket-stats-max-count
264+
Description: Maximum number of socket statistics cached
265+
Defined by: library:nsapi
266+
Macro name: MBED_CONF_NSAPI_SOCKET_STATS_MAX_COUNT
267+
Value: 10 (set by library:nsapi)
219268
```

‎docs/reference/configuration/Drivers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ The following is the complete list of driver configuration parameters, as genera
77
```
88
Configuration parameters
99
------------------------
10-
1110
Name: drivers.uart-serial-rxbuf-size
1211
Description: Default RX buffer size for a UARTSerial instance (unit Bytes))
1312
Defined by: library:drivers
@@ -19,3 +18,4 @@ Name: drivers.uart-serial-txbuf-size
1918
Macro name: MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE
2019
Value: 256 (set by library:drivers)
2120
```
21+

‎docs/reference/configuration/Platform.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ The following is the complete list of platform configuration parameters, as gene
77
```
88
Configuration parameters
99
------------------------
10-
1110
Name: platform.all-stats-enabled
1211
Description: Set to 1 to enable all platform stats. When enabled the functions mbed_stats_*_get returns non-zero data. See mbed_stats.h for more information
1312
Defined by: library:platform
@@ -19,7 +18,8 @@ Name: platform.cpu-stats-enabled
1918
Name: platform.crash-capture-enabled
2019
Description: Enables crash context capture when the system enters a fatal error/crash.
2120
Defined by: library:platform
22-
No value set
21+
Macro name: MBED_CONF_PLATFORM_CRASH_CAPTURE_ENABLED
22+
Value: 1 (set by library:platform[K64F])
2323
Name: platform.cthunk_count_max
2424
Description: The maximum CThunk objects used at the same time. This must be greater than 0 and less 256
2525
Defined by: library:platform
@@ -34,11 +34,6 @@ Name: platform.error-all-threads-info
3434
Description: Reports all the threads in the system as part of error report.
3535
Defined by: library:platform
3636
No value set
37-
Name: platform.error-decode-http-url-str
38-
Description: HTTP URL string for ARM Mbed-OS Error Decode microsite
39-
Defined by: library:platform
40-
Macro name: MBED_CONF_PLATFORM_ERROR_DECODE_HTTP_URL_STR
41-
Value: "\nFor more info, visit: https://armmbed.github.io/mbedos-error/?error=0x%08X" (set by library:platform)
4237
Name: platform.error-filename-capture-enabled
4338
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
4439
Defined by: library:platform
@@ -60,7 +55,8 @@ Name: platform.error-reboot-max
6055
Name: platform.fatal-error-auto-reboot-enabled
6156
Description: Setting this to true enables auto-reboot on a fatal error.
6257
Defined by: library:platform
63-
No value set
58+
Macro name: MBED_CONF_PLATFORM_FATAL_ERROR_AUTO_REBOOT_ENABLED
59+
Value: 1 (set by library:platform[K64F])
6460
Name: platform.force-non-copyable-error
6561
Description: Force compile time error when a NonCopyable object is copied
6662
Defined by: library:platform
@@ -122,3 +118,8 @@ Name: platform.use-mpu
122118
Macro name: MBED_CONF_PLATFORM_USE_MPU
123119
Value: 1 (set by library:platform)
124120
```
121+
ed to reduce image size.
122+
Defined by: library:platform
123+
Macro name: MBED_CONF_PLATFORM_USE_MPU
124+
Value: 1 (set by library:platform)
125+
```

0 commit comments

Comments
 (0)