-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathKconfig
executable file
·445 lines (355 loc) · 17.1 KB
/
Kconfig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
# @file Kconfig
# @brief mender-mcu-client module Kconfig file
#
# Copyright joelguittet and mender-mcu-client contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
menuconfig MENDER_MCU_CLIENT
bool "Mender Firmware Over-the-Air support"
select BOOTLOADER_MCUBOOT
select CJSON
select DNS_RESOLVER
select FLASH
select FLASH_MAP
select HTTP_CLIENT
select IMG_ENABLE_IMAGE_CHECK
select IMG_ERASE_PROGRESSIVELY
select IMG_MANAGER
select MPU_ALLOW_FLASH_WRITE
select MSGPACK_C if MENDER_CLIENT_ADD_ON_TROUBLESHOOT
select NETWORKING
select NET_TCP
select NET_SOCKETS
select REBOOT
select STREAM_FLASH
select WEBSOCKET_CLIENT if MENDER_CLIENT_ADD_ON_TROUBLESHOOT
help
Secure, risk tolerant and efficient over-the-air updates for all device software.
if MENDER_MCU_CLIENT
menu "General configuration"
config MENDER_SERVER_HOST
string "Mender server host URL"
default "https://hosted.mender.io"
help
Set the Mender server host URL to be used on the device.
config MENDER_SERVER_TENANT_TOKEN
string "Mender server Tenant Token"
help
Set the Mender server Tenant Token, to be used with https://hosted.mender.io. Retrieve it from the "Organization and billing" settings of your account.
config MENDER_CLIENT_AUTHENTICATION_POLL_INTERVAL
int "Mender client Authentication poll interval (seconds)"
range 0 3600
default 600
help
Interval used to periodically try to authenticate to the Mender server until it succeeds.
Setting this value to 0 permits to disable the periodic execution and relies on the application to do it.
config MENDER_CLIENT_UPDATE_POLL_INTERVAL
int "Mender client Update poll interval (seconds)"
range 0 86400
default 1800
help
Interval used to periodically check for new deployments on the Mender server.
Setting this value to 0 permits to disable the periodic execution and relies on the application to do it.
module = MENDER
module-str = Log Level for mender
module-help = Enables logging for mender code.
source "subsys/logging/Kconfig.template.log_config"
endmenu
menu "Add-ons integration"
menu "Configure Add-on configuration"
config MENDER_CLIENT_ADD_ON_CONFIGURE
bool "Mender client Configure"
default n
help
Configure add-on permits to get/set configuration key-value pairs to/from the Mender server.
if MENDER_CLIENT_ADD_ON_CONFIGURE
config MENDER_CLIENT_CONFIGURE_STORAGE
bool "Mender client Configure storage"
default y
help
Activate this option to save the configuration from the Mender server in the storage area of the device.
config MENDER_CLIENT_CONFIGURE_REFRESH_INTERVAL
int "Mender client Configure refresh interval (seconds)"
range 0 86400
default 28800
help
Interval used to periodically refresh configuration to/from the Mender server.
Setting this value to 0 permits to disable the periodic execution and relies on the application to do it.
endif
endmenu
menu "Inventory Add-on configuration"
config MENDER_CLIENT_ADD_ON_INVENTORY
bool "Mender client Inventory"
default y
help
Inventory add-on permits to send inventory key-value pairs to the Mender server.
It is particularly used to send artifact name and device type, and it permits to see the last check-in time of the device.
if MENDER_CLIENT_ADD_ON_INVENTORY
config MENDER_CLIENT_INVENTORY_REFRESH_INTERVAL
int "Mender client Inventory refresh interval (seconds)"
range 0 86400
default 28800
help
Interval used to periodically send inventory to the Mender server.
Setting this value to 0 permits to disable the periodic execution and relies on the application to do it.
endif
endmenu
menu "Troubleshoot Add-on configuration"
config MENDER_CLIENT_ADD_ON_TROUBLESHOOT
bool "Mender client Troubleshoot (EXPERIMENTAL)"
default n
help
Troubleshoot add-on permits to perform debugging on the target from the Mender server.
It is particularly used to connect to the remote terminal of the device.
if MENDER_CLIENT_ADD_ON_TROUBLESHOOT
config MENDER_CLIENT_TROUBLESHOOT_HEALTHCHECK_INTERVAL
int "Mender client Troubleshoot healthcheck interval (seconds)"
range 10 60
default 30
help
Interval used to periodically perform healthcheck with the Mender server.
config MENDER_CLIENT_TROUBLESHOOT_SHELL
bool "Mender client Troubleshoot Shell"
default y
help
Troubleshoot shell permits to display a remote shell interface on the Mender server.
config MENDER_CLIENT_TROUBLESHOOT_FILE_TRANSFER
bool "Mender client Troubleshoot File Transfer"
default n
help
Troubleshoot file transfer permits to upload/download files to/from the device on the Mender server.
config MENDER_CLIENT_TROUBLESHOOT_PORT_FORWARDING
bool "Mender client Troubleshoot Port Forwarding"
default n
help
Troubleshoot port forwarding permits to remotly connect to a local service from the Mender server.
endif
endmenu
endmenu
menu "Platform configuration (ADVANCED)"
choice MENDER_PLATFORM_FLASH_TYPE
prompt "Mender platform flash implementation type"
default MENDER_PLATFORM_FLASH_TYPE_DEFAULT
help
Specify platform flash implementation type, select 'weak' to use you own implementation.
config MENDER_PLATFORM_FLASH_TYPE_DEFAULT
bool "default"
config MENDER_PLATFORM_FLASH_TYPE_WEAK
bool "weak"
endchoice
config MENDER_PLATFORM_FLASH_TYPE
string
default "zephyr" if MENDER_PLATFORM_FLASH_TYPE_DEFAULT
default "generic/weak" if MENDER_PLATFORM_FLASH_TYPE_WEAK
choice MENDER_PLATFORM_LOG_TYPE
prompt "Mender platform log implementation type"
default MENDER_PLATFORM_LOG_TYPE_DEFAULT
help
Specify platform log implementation type, select 'weak' to use you own implementation.
config MENDER_PLATFORM_LOG_TYPE_DEFAULT
bool "default"
config MENDER_PLATFORM_LOG_TYPE_WEAK
bool "weak"
endchoice
config MENDER_PLATFORM_LOG_TYPE
string
default "zephyr" if MENDER_PLATFORM_LOG_TYPE_DEFAULT
default "generic/weak" if MENDER_PLATFORM_LOG_TYPE_WEAK
choice MENDER_PLATFORM_NET_TYPE
prompt "Mender platform network implementation type"
default MENDER_PLATFORM_NET_TYPE_DEFAULT
help
Specify platform network implementation type, select 'weak' to use you own implementation.
config MENDER_PLATFORM_NET_TYPE_DEFAULT
bool "default"
config MENDER_PLATFORM_NET_TYPE_WEAK
bool "weak"
endchoice
config MENDER_PLATFORM_NET_TYPE
string
default "zephyr" if MENDER_PLATFORM_NET_TYPE_DEFAULT
default "generic/weak" if MENDER_PLATFORM_NET_TYPE_WEAK
choice MENDER_PLATFORM_SCHEDULER_TYPE
prompt "Mender platform scheduler implementation type"
default MENDER_PLATFORM_SCHEDULER_TYPE_DEFAULT
help
Specify platform scheduler implementation type, select 'weak' to use you own implementation.
config MENDER_PLATFORM_SCHEDULER_TYPE_DEFAULT
bool "default"
config MENDER_PLATFORM_SCHEDULER_TYPE_WEAK
bool "weak"
endchoice
config MENDER_PLATFORM_SCHEDULER_TYPE
string
default "zephyr" if MENDER_PLATFORM_SCHEDULER_TYPE_DEFAULT
default "generic/weak" if MENDER_PLATFORM_SCHEDULER_TYPE_WEAK
choice MENDER_PLATFORM_STORAGE_TYPE
prompt "Mender platform storage implementation type"
default MENDER_PLATFORM_STORAGE_TYPE_NVS
help
Specify platform storage implementation type, select 'weak' to use you own implementation.
config MENDER_PLATFORM_STORAGE_TYPE_NVS
bool "nvs"
select NVS
config MENDER_PLATFORM_STORAGE_TYPE_WEAK
bool "weak"
endchoice
config MENDER_PLATFORM_STORAGE_TYPE
string
default "zephyr/nvs" if MENDER_PLATFORM_STORAGE_TYPE_NVS
default "generic/weak" if MENDER_PLATFORM_STORAGE_TYPE_WEAK
choice MENDER_PLATFORM_TLS_TYPE
prompt "Mender platform TLS implementation type"
default MENDER_PLATFORM_TLS_TYPE_MBEDTLS
help
Specify platform TLS implementation type, select 'weak' to use you own implementation.
config MENDER_PLATFORM_TLS_TYPE_MBEDTLS
bool "mbedtls"
select MBEDTLS
config MENDER_PLATFORM_TLS_TYPE_CRYPTOAUTHLIB
bool "cryptoauthlib"
select CRYPTOAUTHLIB
config MENDER_PLATFORM_TLS_TYPE_WEAK
bool "weak"
endchoice
config MENDER_PLATFORM_TLS_TYPE
string
default "generic/mbedtls" if MENDER_PLATFORM_TLS_TYPE_MBEDTLS
default "generic/cryptoauthlib" if MENDER_PLATFORM_TLS_TYPE_CRYPTOAUTHLIB
default "generic/weak" if MENDER_PLATFORM_TLS_TYPE_WEAK
endmenu
if MENDER_PLATFORM_NET_TYPE_DEFAULT
menu "Network options (ADVANCED)"
config MENDER_NET_CA_CERTIFICATE_TAG
int "CA certificate tag"
default 1
help
A security tag that ROOT CA server credential will be referenced with, see tls_credential_add.
config MENDER_NET_TLS_PEER_VERIFY
int "TLS_PEER_VERIFY option"
range 0 2
default 2
help
Peer verification level for TLS connection.
if MENDER_CLIENT_ADD_ON_TROUBLESHOOT
config MENDER_WEBSOCKET_THREAD_STACK_SIZE
int "Mender WebSocket client Thread Stack Size (kB)"
range 0 64
default 4
help
Mender WebSocket client thread stack size, customize only if you have a deep understanding of the impacts! Default value is suitable for most applications.
config MENDER_WEBSOCKET_THREAD_PRIORITY
int "Mender WebSocket client Thread Priority"
range 0 128
default 5
help
Mender WebSocket client thread priority, customize only if you have a deep understanding of the impacts! Default value is suitable for most applications.
config MENDER_WEBSOCKET_CONNECT_TIMEOUT
int "Mender WebSocket client connect timeout (milliseconds)"
range 0 60000
default 3000
help
Mender WebSocket client connect timeout. Default value is suitable for most applications.
config MENDER_WEBSOCKET_REQUEST_TIMEOUT
int "Mender WebSocket client request timeout (milliseconds)"
range 0 60000
default 3000
help
Mender WebSocket client request timeout. Default value is suitable for most applications.
endif
endmenu
endif
if MENDER_PLATFORM_SCHEDULER_TYPE_DEFAULT
menu "Scheduler options (ADVANCED)"
config MENDER_SCHEDULER_WORK_QUEUE_STACK_SIZE
int "Mender Scheduler Work Queue Stack Size (kB)"
range 0 64
default 12
help
Mender scheduler work queue stack size, customize only if you have a deep understanding of the impacts! Default value is suitable for most applications.
config MENDER_SCHEDULER_WORK_QUEUE_PRIORITY
int "Mender Scheduler Work Queue Priority"
range 0 128
default 5
help
Mender scheduler work queue priority, customize only if you have a deep understanding of the impacts! Default value is suitable for most applications.
endmenu
endif
if MENDER_CLIENT_ADD_ON_TROUBLESHOOT
menu "Shell options (ADVANCED)"
config MENDER_SHELL_PROMPT
string "Mender Shell prompt"
default "~$ "
help
Mender Shell prompt to be dislayed on the Mender server Troubleshoot add-on interface.
config MENDER_SHELL_RX_RING_BUFFER_SIZE
int "Mender Shell RX ring buffer size (bytes)"
range 0 512
default 64
help
Mender Shell RX ring buffer size. Default value is suitable for most applications.
config MENDER_SHELL_TX_RING_BUFFER_SIZE
int "Mender Shell TX ring buffer size (bytes)"
range 0 2048
default 512
help
Mender Shell TX ring buffer size. Default value is suitable for most applications.
config MENDER_SHELL_TX_WORK_QUEUE_STACK_SIZE
int "Mender Shell TX Work Queue Stack Size (kB)"
range 0 64
default 2
help
Mender Shell TX work queue stack size, customize only if you have a deep understanding of the impacts! Default value is suitable for most applications.
config MENDER_SHELL_TX_WORK_QUEUE_PRIORITY
int "Mender Shell TX Work Queue Priority"
range 0 128
default 5
help
Mender Shell TX work queue priority, customize only if you have a deep understanding of the impacts! Default value is suitable for most applications.
config MENDER_SHELL_TX_WORK_DELAY
int "Mender Shell TX Work Delay (milliseconds)"
range 0 1000
default 100
help
Mender Shell TX work delay, used to flush data of the TX work queue. Default value is suitable for most applications.
config MENDER_SHELL_LOG_BACKEND_LEVEL
int "Mender Shell Log Backend Level"
range 0 4
default 0
help
Mender Shell log backend level. Default value is no log (log backend disabled).
config MENDER_SHELL_LOG_BACKEND_MESSAGE_QUEUE_SIZE
int "Mender Shell Log Backend Message Queue Size (bytes)"
range 0 2048
default 512
help
Mender Shell log backend message queue size. Default value is suitable for most applications.
config MENDER_SHELL_LOG_BACKEND_MESSAGE_QUEUE_TIMEOUT
int "Mender Shell Log Backend Message Queue Timeout (milliseconds)"
range 0 1000
default 100
help
Mender Shell log backend message queue timeout. Default value is suitable for most applications.
endmenu
endif
if MENDER_PLATFORM_STORAGE_TYPE_NVS
menu "Storage options"
config MENDER_STORAGE_NVS_SECTOR_COUNT
int "Number of sectors of the mender_storage partition"
default 2
range 2 8
help
Number of sectors of the mender_storage partition, must match the configuration of the partition.
endmenu
endif
endif