nrf_dfu_types.h

/*$$$LICENCE_NORDIC_STANDARD<2016>$$$*/
#ifndef NRF_DFU_TYPES_H__
#define NRF_DFU_TYPES_H__

#include "nrf.h"
#include "nrf_mbr.h"
#include "app_util_platform.h"

#ifdef SOFTDEVICE_PRESENT
#include "nrf_sdm.h"
#include "ble_gap.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if defined(SOFTDEVICE_PRESENT)

#define SOFTDEVICE_REGION_START MBR_SIZE


#ifndef CODE_REGION_1_START
#define CODE_REGION_1_START SD_SIZE_GET(MBR_SIZE)
#endif


#else

#ifndef CODE_REGION_1_START
#define CODE_REGION_1_START MBR_SIZE
#endif

#endif


#define INIT_COMMAND_MAX_SIZE 256 
#if defined(NRF51)
 #define CODE_PAGE_SIZE (PAGE_SIZE_IN_WORDS * sizeof(uint32_t))
#elif defined(NRF52) || defined(NRF52840_XXAA) || defined(NRF52810_XXAA)
 #define CODE_PAGE_SIZE (MBR_PAGE_SIZE_IN_WORDS * sizeof(uint32_t))
#else
 #error "Architecture not set."
#endif


#if defined( NRF51 )
 #define DATA_OBJECT_MAX_SIZE (CODE_PAGE_SIZE * 4)
#elif defined( NRF52_SERIES ) || defined ( __SDK_DOXYGEN__ )
 #define DATA_OBJECT_MAX_SIZE (CODE_PAGE_SIZE)
#else
 #error "Architecture not set."
#endif

#if defined ( NRF51 )
 #define BOOTLOADER_SETTINGS_ADDRESS (0x0003FC00UL)
#elif defined( NRF52832_XXAA )
 #define BOOTLOADER_SETTINGS_ADDRESS (0x0007F000UL)
#elif defined( NRF52810_XXAA )
 #define BOOTLOADER_SETTINGS_ADDRESS (0x0002F000UL)
#elif defined( NRF52840_XXAA )
 #define BOOTLOADER_SETTINGS_ADDRESS (0x000FF000UL)
#else
 #error "No valid target set for BOOTLOADER_SETTINGS_ADDRESS."
#endif


#if !defined(NRF_DFU_UPDATABLE_APPLICATION_ONLY) || (NRF_DFU_UPDATABLE_APPLICATION_ONLY == 0)
#if defined(NRF52832_XXAA) || defined(NRF52810_XXAA)

#define NRF_UICR_MBR_PARAMS_PAGE_ADDRESS (NRF_UICR_BASE + 0x18)
#endif


#if defined(NRF52840_XXAA_ENGA)
#define NRF_MBR_PARAMS_PAGE_ADDRESS (0x000FE000UL)
#elif defined( NRF52810_XXAA )
#define NRF_MBR_PARAMS_PAGE_ADDRESS (0x0002E000UL)
#else
#define NRF_MBR_PARAMS_PAGE_ADDRESS (0x0007E000UL)
#endif


#if defined(NRF52840_XXAA)

#define NRF_UICR_MBR_PARAMS_PAGE_ADDRESS (NRF_UICR_BASE + 0x18)


#define NRF_MBR_PARAMS_PAGE_ADDRESS (0x000FE000UL)

#endif
#endif /* !defined(NRF_DFU_UPDATABLE_APPLICATION_ONLY) || (NRF_DFU_UPDATABLE_APPLICATION_ONLY == 0) */


#ifndef DFU_APP_DATA_RESERVED
#define DFU_APP_DATA_RESERVED CODE_PAGE_SIZE * 3
#endif


#define DFU_REGION_TOTAL_SIZE ((* (uint32_t *)NRF_UICR_BOOTLOADER_START_ADDRESS) - CODE_REGION_1_START)

#ifdef SOFTDEVICE_PRESENT

#define SOFTDEVICE_REGION_START MBR_SIZE


#ifndef CODE_REGION_1_START
#define CODE_REGION_1_START SD_SIZE_GET(MBR_SIZE)
#endif
#else
#ifndef CODE_REGION_1_START
#define CODE_REGION_1_START MBR_SIZE
#endif
#endif

#define NRF_DFU_CURRENT_BANK_0 0x00
#define NRF_DFU_CURRENT_BANK_1 0x01

#define NRF_DFU_BANK_LAYOUT_DUAL 0x00
#define NRF_DFU_BANK_LAYOUT_SINGLE 0x01


#define NRF_DFU_BANK_INVALID 0x00 
#define NRF_DFU_BANK_VALID_APP 0x01 
#define NRF_DFU_BANK_VALID_SD 0xA5 
#define NRF_DFU_BANK_VALID_BL 0xAA 
#define NRF_DFU_BANK_VALID_SD_BL 0xAC 
#pragma pack(4)
typedef struct
{
 uint32_t image_size; 
 uint32_t image_crc; 
 uint32_t bank_code; 
} nrf_dfu_bank_t;

ANON_UNIONS_ENABLE
typedef struct
{
 uint32_t command_size; 
 uint32_t command_offset; 
 uint32_t command_crc; 
 uint32_t data_object_size; 
 union
 {
 struct
 {
 uint32_t firmware_image_crc; 
 uint32_t firmware_image_crc_last; 
 uint32_t firmware_image_offset; 
 uint32_t firmware_image_offset_last;
 };
 struct
 {
 uint32_t sd_start_address; 
 };
 };
} dfu_progress_t;
ANON_UNIONS_DISABLE

#define SYSTEM_SERVICE_ATT_SIZE 8 
typedef struct
{
 ble_gap_id_key_t ble_id; 
 ble_gap_enc_key_t enc_key; 
 uint8_t sys_serv_attr[SYSTEM_SERVICE_ATT_SIZE]; 
} nrf_dfu_peer_data_t;

typedef struct
{
 uint8_t name[20]; 
 uint32_t len; 
} nrf_dfu_adv_name_t;

typedef struct
{
 uint32_t crc; 
 ble_gap_addr_t ble_addr; 
 nrf_dfu_peer_data_t peer_data; 
 nrf_dfu_adv_name_t adv_name; 
} nrf_dfu_shared_data_t;

typedef struct
{
 uint32_t crc; 
 /* Bootloader private settings. Included in calculated CRC. */

 uint32_t settings_version; 
 uint32_t app_version; 
 uint32_t bootloader_version; 
 uint32_t bank_layout; 
 uint32_t bank_current; 
 nrf_dfu_bank_t bank_0; 
 nrf_dfu_bank_t bank_1; 
 uint32_t write_offset; 
 uint32_t sd_size; 
 dfu_progress_t progress; 
 uint32_t transport_activated; 
 /* Below fields are not included in calculated CRC and are not part of the settings layout. */

 uint8_t init_command[INIT_COMMAND_MAX_SIZE]; 
 nrf_dfu_shared_data_t shared_data; 
} nrf_dfu_settings_t;


#ifdef SOFTDEVICE_PRESENT


#endif // SYSTEM_SERVICE_ATT_SIZE


#pragma pack() // revert pack settings


#ifdef __cplusplus
}
#endif

#endif // NRF_DFU_TYPES_H__