Sukkin Pang / nrf51-sdk

Initial release

Fork of nrf51-sdk by Lancaster University

Embed: (wiki syntax)

« Back to documentation index

Init packet handling in DFU
Data Structures | Functions

Init packet handling in DFU

Device Firmware Update module type and function declaration for init packet handling. More...

Data Structures

struct  dfu_init_packet_t
 Structure contained in an init packet. More...
struct  dfu_device_info_t
 Structure holding basic device information settings. More...

Functions

uint32_t dfu_init_prevalidate (uint8_t *p_init_data, uint32_t init_data_len)
 DFU prevalidate call for pre-checking the received init packet.
uint32_t dfu_init_postvalidate (uint8_t *p_image, uint32_t image_len)
 DFU postvalidate call for post-checking the received image using the init packet.

Detailed Description

Device Firmware Update module type and function declaration for init packet handling.

This header contains basic functionality for performing safety checks on software updates for based devices. It provides a skeleton for pre-checking an init packet to ensure the following image is compatible with this device. A safety check should always be performed to prevent accidental flashing of unsupported applications or a wrong combination of application and SoftDevice. The device information contains information such as:

  • Device type (2 bytes), for example Heart Rate. The device type is a number defined by the customer. It can be located in UICR or FICR.
  • Device revision (2 bytes), for example major revision 1, minor revision 0. The device revision is a number defined by the customer. It can be located in UICR or FICR.
  • List of SoftDevices supported by this application, for example 0x0049 = S110v6_0_0 0xFFFE = S110 development (any SoftDevice accepted),
  • CRC or hash of firmware image
Note:
This module does not support security features such as image signing, but the corresponding implementation allows for such extensions. If the init packet is signed by a trusted source, it must be decrypted before it can be processed.

Function Documentation

uint32_t dfu_init_postvalidate ( uint8_t *  p_image,
uint32_t  image_len 
)

DFU postvalidate call for post-checking the received image using the init packet.

Post-validation can verify the integrity check the firmware image received before activating the image. Checks performed can be:

  • A simple CRC as shown in the corresponding implementation of this API in the file dfu_init_template.c
  • A hash for better verification of the image.
  • A signature to ensure the image originates from a trusted source. Checks are intended to be expanded for customer-specific requirements.
Parameters:
[in]p_imagePointer to the received image. The init data provided in the call dfu_init_prevalidate will be used for validating the image.
[in]image_lenLength of the image data.
Return values:
NRF_SUCCESSIf the post-validation succeeded, that meant the integrity of the image has been verified and the image originates from a trusted source (signing).
NRF_ERROR_INVALID_DATAIf the post-validation failed, that meant the post check of the image failed such as the CRC is not matching the image transfered or the verification of the image fails (signing).

Definition at line 152 of file dfu_init_template.c.

uint32_t dfu_init_prevalidate ( uint8_t *  p_init_data,
uint32_t  init_data_len 
)

DFU prevalidate call for pre-checking the received init packet.

Pre-validation will safety check the firmware image to be transfered in second stage. The function currently checks the device type, device revision, application firmware version, and supported SoftDevices. More checks should be added according to customer-specific requirements.

Parameters:
[in]p_init_dataPointer to the init packet. If the init packet is encrypted or signed, it must first be decrypted before being checked.
[in]init_data_lenLength of the init data.
Return values:
NRF_SUCCESSIf the pre-validation succeeded, that means the image is supported by the device and it is considered to come from a trusted source (signing).
NRF_ERROR_INVALID_DATAIf the pre-validation failed, that means the image is not supported by the device or comes from an un-trusted source (signing).
NRF_ERROR_INVALID_LENGTHIf the size of the init packet is not within the limits of the init packet handler.

[DFU init application version]

[DFU init application version]

Definition at line 77 of file dfu_init_template.c.

Generated on Tue Jul 12 2022 11:17:21 by  doxygen 1.7.2