Communication#
Host communication interface.
The Communication component provides an interface for implementing communication with a host device, such as a computer or a microcontroller.
Communication Protocol Implementations#
Several components implement the communication interface, using different transports and protocols.
Modules#
Functions#
Initialize hardware for the BGAPI UART DFU Bootloader communication.
Initialize communication between the BGAPI UART DFU bootloader and external host.
Communication main for the BGAPI UART DFU bootloader.
Initialize hardware for the EZSP SPI Bootloader communication.
Initialize communication between the EZSP SPI bootloader and external host.
Communication main for the EZSP SPI bootloader.
Stop communication between the bootloader and external host.
Initialize hardware for the UART XMODEM Bootloader communication.
Initialize communication between the UART XMODEM bootloader and external host.
Communication main for the UART XMODEM bootloader.
Initialize hardware for the BLE Apploader OTA DFU Bootloader communication.
Initialize communication between the BLE Apploader OTA DFU bootloader and external host.
Communication main for the BLE Apploader OTA DFU bootloader.
Get custom device address.
Initialize hardware for the communication component.
Initialize communication between the bootloader and external host.
Not supposed to return until either the host signals the end of the current session or a new image has been flashed and verified.
Stop communication between the bootloader and external host.
Function Documentation#
bootloader_bgapi_communication_init#
void bootloader_bgapi_communication_init (void )
Initialize hardware for the BGAPI UART DFU Bootloader communication.
| N/A |
159 of file platform/bootloader/communication/bgapi-uart-dfu/btl_comm_bgapi.hbootloader_bgapi_communication_start#
int32_t bootloader_bgapi_communication_start (void )
Initialize communication between the BGAPI UART DFU bootloader and external host.
| N/A |
Returns
Error code indicating success or failure.
167 of file platform/bootloader/communication/bgapi-uart-dfu/btl_comm_bgapi.hbootloader_bgapi_communication_main#
int32_t bootloader_bgapi_communication_main (ImageProperties_t * imageProps, ParserContext_t * parserContext, const BootloaderParserCallbacks_t * parseCb)
Communication main for the BGAPI UART DFU bootloader.
| N/A | imageProps | The image file processed |
| N/A | parserContext | Image parser context |
| N/A | parseCb | Bootloader parser callbacks |
Returns
Error code indicating success or failure.
178 of file platform/bootloader/communication/bgapi-uart-dfu/btl_comm_bgapi.hbootloader_ezsp_communication_init#
void bootloader_ezsp_communication_init (void )
Initialize hardware for the EZSP SPI Bootloader communication.
| N/A |
197 of file platform/bootloader/communication/ezsp-spi/btl_ezsp_spi.hbootloader_ezsp_communication_start#
int32_t bootloader_ezsp_communication_start (void )
Initialize communication between the EZSP SPI bootloader and external host.
| N/A |
Returns
Error code indicating success or failure.
205 of file platform/bootloader/communication/ezsp-spi/btl_ezsp_spi.hbootloader_ezsp_communication_main#
int32_t bootloader_ezsp_communication_main (ImageProperties_t * imageProps, ParserContext_t * parserContext, const BootloaderParserCallbacks_t * parseCb)
Communication main for the EZSP SPI bootloader.
| N/A | imageProps | The image file processed |
| N/A | parserContext | Image parser context |
| N/A | parseCb | Bootloader parser callbacks |
Returns
Error code indicating success or failure.
216 of file platform/bootloader/communication/ezsp-spi/btl_ezsp_spi.hbootloader_ezsp_communication_shutdown#
void bootloader_ezsp_communication_shutdown (void )
Stop communication between the bootloader and external host.
| N/A |
223 of file platform/bootloader/communication/ezsp-spi/btl_ezsp_spi.hbootloader_xmodem_communication_init#
void bootloader_xmodem_communication_init (void )
Initialize hardware for the UART XMODEM Bootloader communication.
| N/A |
72 of file platform/bootloader/communication/xmodem-uart/btl_comm_xmodem.hbootloader_xmodem_communication_start#
int32_t bootloader_xmodem_communication_start (void )
Initialize communication between the UART XMODEM bootloader and external host.
| N/A |
Returns
Error code indicating success or failure.
80 of file platform/bootloader/communication/xmodem-uart/btl_comm_xmodem.hbootloader_xmodem_communication_main#
int32_t bootloader_xmodem_communication_main (ImageProperties_t * imageProps, const BootloaderParserCallbacks_t * parseCb)
Communication main for the UART XMODEM bootloader.
| N/A | imageProps | The image file processed |
| N/A | parseCb | Bootloader parser callbacks |
Returns
Error code indicating success or failure.
90 of file platform/bootloader/communication/xmodem-uart/btl_comm_xmodem.hbootloader_apploader_communication_init#
void bootloader_apploader_communication_init (void )
Initialize hardware for the BLE Apploader OTA DFU Bootloader communication.
| N/A |
50 of file platform/bootloader/communication/apploader/btl_apploader.hbootloader_apploader_communication_start#
int32_t bootloader_apploader_communication_start (void )
Initialize communication between the BLE Apploader OTA DFU bootloader and external host.
| N/A |
Returns
Error code indicating success or failure.
58 of file platform/bootloader/communication/apploader/btl_apploader.hbootloader_apploader_communication_main#
int32_t bootloader_apploader_communication_main (ImageProperties_t * imageProps, void * parserContext, void * decryptContext, void * authContext, const BootloaderParserCallbacks_t * parseCb)
Communication main for the BLE Apploader OTA DFU bootloader.
| N/A | imageProps | The image file processed |
| N/A | parserContext | Image parser context |
| N/A | decryptContext | Image decryption context |
| N/A | authContext | Image authentication context |
| N/A | parseCb | Bootloader parser callbacks |
Returns
Error code indicating success or failure.
71 of file platform/bootloader/communication/apploader/btl_apploader.hbootloader_apploader_get_custom_device_address#
void bootloader_apploader_get_custom_device_address (sl_apploader_address_t * btAddress)
Get custom device address.
| N/A | btAddress | Device address |
The address must be set in little endian format Default implementation of this function reads the address from MFG_CUSTOM_EUI_64 manufacturing token stored in user data page. The function can be overridden if custom implementation is wanted.
85 of file platform/bootloader/communication/apploader/btl_apploader.hcommunication_init#
void communication_init (void )
Initialize hardware for the communication component.
| N/A |
41 of file platform/bootloader/communication/btl_communication.hcommunication_start#
int32_t communication_start (void )
Initialize communication between the bootloader and external host.
| N/A |
For example, indicate that all is well to the external host.
Returns
Error code indicating success or failure
Return values
BOOTLOADER_OK: on success
BOOTLOADER_ERROR_COMMUNICATION_START: on failure
51 of file platform/bootloader/communication/btl_communication.hcommunication_main#
int32_t communication_main (void )
Not supposed to return until either the host signals the end of the current session or a new image has been flashed and verified.
| N/A |
Returns
Error code indicating success or failure
Return values
BOOTLOADER_OK: when a new image was flashed
BOOTLOADER_ERROR_COMMUNICATION_ERROR: on communication error
BOOTLOADER_ERROR_COMMUNICATION_DONE: when no image was received
BOOTLOADER_ERROR_COMMUNICATION_IMAGE_ERROR: when received image is invalid
64 of file platform/bootloader/communication/btl_communication.hcommunication_shutdown#
void communication_shutdown (void )
Stop communication between the bootloader and external host.
| N/A |
69 of file platform/bootloader/communication/btl_communication.h