nrf_mesh_dfu_types.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef NRF_MESH_DFU_TYPES_H__
#define NRF_MESH_DFU_TYPES_H__

#include <stdint.h>
#include <stdbool.h>
#include "nrf_mesh_assert.h"

#define NRF_MESH_DFU_PUBLIC_KEY_LEN (64)

#define NRF_MESH_DFU_SIGNATURE_LEN (64)

#define NRF_MESH_DFU_SEGMENT_LENGTH (16)

/*lint -align_max(push) -align_max(1) */

typedef struct __attribute((packed))
{
 uint8_t bl_id;
 uint8_t bl_version;
} nrf_mesh_bootloader_id_t;

typedef struct __attribute((packed))
{
 uint32_t company_id;
 uint16_t app_id;
 uint32_t app_version;
} nrf_mesh_app_id_t;

typedef union __attribute((packed))
{
 nrf_mesh_app_id_t application; 
 nrf_mesh_bootloader_id_t bootloader; 
 uint16_t softdevice; 
} nrf_mesh_fwid_t;

/*lint -align_max(pop) */

typedef enum
{
 NRF_MESH_DFU_TYPE_INVALID = 0,
 NRF_MESH_DFU_TYPE_SOFTDEVICE = (1 << 0),
 NRF_MESH_DFU_TYPE_BOOTLOADER = (1 << 1),
 NRF_MESH_DFU_TYPE_APPLICATION = (1 << 2),
 NRF_MESH_DFU_TYPE_BL_INFO = (1 << 3),

 NRF_MESH_DFU_TYPE__LAST = NRF_MESH_DFU_TYPE_BL_INFO,
} nrf_mesh_dfu_type_t;

typedef enum
{
 NRF_MESH_DFU_STATE_UNINITIALIZED, 
 NRF_MESH_DFU_STATE_INITIALIZED, 
 NRF_MESH_DFU_STATE_FIND_FWID, 
 NRF_MESH_DFU_STATE_DFU_REQ, 
 NRF_MESH_DFU_STATE_READY, 
 NRF_MESH_DFU_STATE_TARGET, 
 NRF_MESH_DFU_STATE_VALIDATE, 
 NRF_MESH_DFU_STATE_STABILIZE, 
 NRF_MESH_DFU_STATE_RELAY_CANDIDATE, 
 NRF_MESH_DFU_STATE_RELAY, 
 NRF_MESH_DFU_STATE__LAST = NRF_MESH_DFU_STATE_RELAY,
} nrf_mesh_dfu_state_t;

typedef enum
{
 NRF_MESH_DFU_END_SUCCESS, 
 NRF_MESH_DFU_END_FWID_VALID, 
 NRF_MESH_DFU_END_APP_ABORT, 
 NRF_MESH_DFU_END_ERROR_PACKET_LOSS, 
 NRF_MESH_DFU_END_ERROR_UNAUTHORIZED, 
 NRF_MESH_DFU_END_ERROR_NO_START, 
 NRF_MESH_DFU_END_ERROR_TIMEOUT, 
 NRF_MESH_DFU_END_ERROR_NO_MEM, 
 NRF_MESH_DFU_END_ERROR_INVALID_PERSISTENT_STORAGE, 
 NRF_MESH_DFU_END_ERROR_SEGMENT_VIOLATION, 
 NRF_MESH_DFU_END_ERROR_MBR_CALL_FAILED, 
 NRF_MESH_DFU_END_ERROR_INVALID_TRANSFER, 
 NRF_MESH_DFU_END_ERROR_BANK_IN_BOOTLOADER_AREA, 
 NRF_MESH_DFU_END_ERROR_BANK_AND_DESTINATION_OVERLAP, 
 NRF_MESH_DFU_END_ERROR__LAST = NRF_MESH_DFU_END_ERROR_BANK_IN_BOOTLOADER_AREA,
} nrf_mesh_dfu_end_t;

typedef enum
{
 NRF_MESH_DFU_ROLE_NONE, 
 NRF_MESH_DFU_ROLE_TARGET, 
 NRF_MESH_DFU_ROLE_RELAY, 
 NRF_MESH_DFU_ROLE_SOURCE, 
 NRF_MESH_DFU_ROLE__LAST = NRF_MESH_DFU_ROLE_SOURCE,
} nrf_mesh_dfu_role_t;

typedef struct
{
 nrf_mesh_dfu_type_t dfu_type;
 nrf_mesh_fwid_t id;
} nrf_mesh_dfu_transfer_t;

typedef struct
{
 nrf_mesh_dfu_type_t dfu_type; 
 nrf_mesh_fwid_t fwid; 
 bool is_signed; 
 uint32_t* p_start_addr; 
 uint32_t length; 
} nrf_mesh_dfu_bank_info_t;

typedef struct
{
 nrf_mesh_dfu_role_t role; 
 nrf_mesh_dfu_type_t type; 
 nrf_mesh_fwid_t fwid; 
 nrf_mesh_dfu_state_t state; 
 uint8_t data_progress; 
} nrf_mesh_dfu_transfer_state_t;

#endif /* NRF_MESH_DFU_TYPES_H__ */