| Andrzej Puzdrowski | 35f61d3 | 2022-04-01 17:00:08 +0200 | [diff] [blame] | 1 | # Copyright (c) 2017-2020 Linaro Limited |
| 2 | # Copyright (c) 2020 Arm Limited |
| 3 | # Copyright (c) 2017-2022 Nordic Semiconductor ASA |
| 4 | # |
| 5 | # SPDX-License-Identifier: Apache-2.0 |
| 6 | |
| 7 | |
| 8 | menuconfig MCUBOOT_SERIAL |
| 9 | bool "MCUboot serial recovery" |
| 10 | default n |
| 11 | select REBOOT |
| 12 | select GPIO |
| 13 | select SERIAL |
| 14 | select UART_INTERRUPT_DRIVEN |
| 15 | select BASE64 |
| Dominik Ermel | e009e19 | 2022-11-21 13:01:29 +0000 | [diff] [blame^] | 16 | select CRC |
| Andrzej Puzdrowski | 35f61d3 | 2022-04-01 17:00:08 +0200 | [diff] [blame] | 17 | help |
| 18 | If y, enables a serial-port based update mode. This allows |
| 19 | MCUboot itself to load update images into flash over a UART. |
| 20 | If unsure, leave at the default value. |
| 21 | |
| 22 | if MCUBOOT_SERIAL |
| 23 | |
| 24 | choice BOOT_SERIAL_DEVICE |
| 25 | prompt "Serial device" |
| 26 | default BOOT_SERIAL_UART if !BOARD_NRF52840DONGLE_NRF52840 |
| 27 | default BOOT_SERIAL_CDC_ACM if BOARD_NRF52840DONGLE_NRF52840 |
| 28 | |
| 29 | config BOOT_SERIAL_UART |
| 30 | bool "UART" |
| 31 | # SERIAL and UART_INTERRUPT_DRIVEN already selected |
| 32 | |
| 33 | config BOOT_SERIAL_CDC_ACM |
| 34 | bool "CDC ACM" |
| 35 | select USB_DEVICE_STACK |
| 36 | |
| 37 | endchoice |
| 38 | |
| 39 | config MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD |
| 40 | bool "Allow to select image number for DFU" |
| 41 | help |
| 42 | With the option enabled, the mcuboot serial recovery will |
| 43 | respect the "image" field in mcumgr image update frame |
| 44 | header. |
| 45 | The mapping of image number to partition is as follows: |
| 46 | 0 -> default behaviour, same as 1; |
| 47 | 1 -> image-0 (primary slot of the first image); |
| 48 | 2 -> image-1 (secondary slot of the first image); |
| 49 | 3 -> image-2; |
| 50 | 4 -> image-3. |
| 51 | Note that 0 is default upload target when no explicit |
| 52 | selection is done. |
| 53 | |
| 54 | config BOOT_MAX_LINE_INPUT_LEN |
| 55 | int "Maximum command line length" |
| 56 | default 512 |
| 57 | help |
| 58 | Maximum length of commands transported over the serial port. |
| 59 | |
| 60 | config BOOT_SERIAL_DETECT_PORT |
| Andrzej Puzdrowski | c5faf43 | 2022-04-09 13:34:23 +0200 | [diff] [blame] | 61 | string "GPIO device to trigger serial recovery mode (DEPRECATED)" |
| Andrzej Puzdrowski | 35f61d3 | 2022-04-01 17:00:08 +0200 | [diff] [blame] | 62 | default GPIO_0 if SOC_FAMILY_NRF |
| 63 | help |
| 64 | Zephyr GPIO device that contains the pin used to trigger |
| 65 | serial recovery mode. |
| 66 | |
| 67 | config BOOT_SERIAL_DETECT_PIN |
| Andrzej Puzdrowski | c5faf43 | 2022-04-09 13:34:23 +0200 | [diff] [blame] | 68 | int "Pin to trigger serial recovery mode (DEPRECATED)" |
| Andrzej Puzdrowski | 35f61d3 | 2022-04-01 17:00:08 +0200 | [diff] [blame] | 69 | default 6 if BOARD_NRF9160DK_NRF9160 |
| 70 | default 11 if BOARD_NRF52840DK_NRF52840 |
| 71 | default 13 if BOARD_NRF52DK_NRF52832 || BOARD_NRF52833DK_NRF52833 |
| 72 | default 23 if BOARD_NRF5340PDK_NRF5340_CPUAPP || BOARD_NRF5340PDK_NRF5340_CPUAPP_NS || \ |
| 73 | BOARD_NRF5340DK_NRF5340_CPUAPP || BOARD_NRF5340DK_NRF5340_CPUAPP_NS |
| Marek Pieta | 2fa1190 | 2022-09-13 11:31:30 +0200 | [diff] [blame] | 74 | default -1 |
| Andrzej Puzdrowski | 35f61d3 | 2022-04-01 17:00:08 +0200 | [diff] [blame] | 75 | help |
| 76 | Pin on the serial detect port that triggers serial recovery mode. |
| 77 | |
| 78 | config BOOT_SERIAL_DETECT_PIN_VAL |
| Andrzej Puzdrowski | c5faf43 | 2022-04-09 13:34:23 +0200 | [diff] [blame] | 79 | int "Serial detect pin trigger value (DEPRECATED)" |
| Andrzej Puzdrowski | 35f61d3 | 2022-04-01 17:00:08 +0200 | [diff] [blame] | 80 | default 0 |
| 81 | range 0 1 |
| 82 | help |
| 83 | Logic value of the detect pin that triggers serial recovery |
| 84 | mode. |
| 85 | |
| 86 | config BOOT_SERIAL_DETECT_DELAY |
| 87 | int "Serial detect pin detection delay time [ms]" |
| 88 | default 0 |
| 89 | help |
| 90 | Used to prevent the bootloader from loading on button press. |
| 91 | Useful for powering on when using the same button as |
| 92 | the one used to place the device in bootloader mode. |
| 93 | |
| 94 | config BOOT_ERASE_PROGRESSIVELY |
| 95 | bool "Erase flash progressively when receiving new firmware" |
| 96 | default y if SOC_FAMILY_NRF |
| 97 | help |
| 98 | If enabled, flash is erased as necessary when receiving new firmware, |
| 99 | instead of erasing the whole image slot at once. This is necessary |
| 100 | on some hardware that has long erase times, to prevent long wait |
| 101 | times at the beginning of the DFU process. |
| 102 | |
| 103 | config BOOT_MGMT_ECHO |
| 104 | bool "Enable echo command" |
| 105 | help |
| 106 | if enabled, support for the mcumgr echo command is being added. |
| 107 | |
| 108 | menuconfig ENABLE_MGMT_PERUSER |
| 109 | bool "Enable system specific mcumgr commands" |
| 110 | help |
| 111 | The option enables processing of system specific mcumgr commands; |
| 112 | system specific commands are within group MGMT_GROUP_ID_PERUSER (64) |
| 113 | and above, as defined within mcumgr library. |
| 114 | These are system specific command and system specific implementation |
| 115 | function is required to process these commands. |
| 116 | |
| 117 | if ENABLE_MGMT_PERUSER |
| 118 | config BOOT_MGMT_CUSTOM_STORAGE_ERASE |
| 119 | bool "Enable storage erase command" |
| 120 | help |
| 121 | The option enables mcumgr command that allows to erase storage |
| 122 | partition. |
| 123 | Note that the storage partition needs to be defined, in DTS, otherwise |
| 124 | enabling the option will cause a compilation to fail. |
| 125 | |
| 126 | config BOOT_MGMT_CUSTOM_IMG_LIST |
| 127 | bool "Enable custom image list command" |
| 128 | help |
| 129 | The option enables command which returns versions and installation |
| 130 | statuses (custom property) for all images. |
| 131 | |
| 132 | endif # ENABLE_MGMT_PERUSER |
| 133 | |
| 134 | config BOOT_SERIAL_ENCRYPT_EC256 |
| 135 | bool "Support for encrypted upgrade images using ECIES-P256 in serial recovery upload" |
| 136 | default n |
| 137 | help |
| 138 | If y, uploaded images via serial recovery can be decrypted |
| 139 | on the fly when upgrading to the primary slot. The |
| 140 | encryption mechanism used in this case is ECIES using primitives |
| 141 | described under "ECIES-P256 encryption" in docs/encrypted_images.md. |
| 142 | |
| 143 | config BOOT_SERIAL_WAIT_FOR_DFU |
| 144 | bool "Wait for a prescribed duration to see if DFU is invoked by receiving a mcumgr comand" |
| 145 | depends on BOOT_SERIAL_UART |
| 146 | help |
| 147 | If y, MCUboot waits for a prescribed duration of time to allow |
| 148 | for DFU to be invoked. The serial recovery can be entered by receiving any |
| 149 | mcumgr command. |
| 150 | |
| 151 | config BOOT_SERIAL_WAIT_FOR_DFU_TIMEOUT |
| 152 | int "Duration to wait for the serial DFU timeout in ms" |
| 153 | default 500 |
| 154 | depends on BOOT_SERIAL_WAIT_FOR_DFU |
| 155 | help |
| 156 | timeout in ms for MCUboot to wait to allow for DFU to be invoked. |
| 157 | |
| 158 | endif # MCUBOOT_SERIAL |