f91f73ede2
The nrf51822 chip is still widely available, for example in the BBC micro:bit. Therefore it's a good idea to support it too. Unfortunately, Nordic decided to change the API in some significant ways so many parts are not compatible between S110 for nrf51 and the other nrf52* SoftDevices.
185 lines
7.2 KiB
C
185 lines
7.2 KiB
C
/*
|
|
* Copyright (c) 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 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 other
|
|
* contributors to this software may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* 4. This software must only be used in a processor manufactured by Nordic
|
|
* Semiconductor ASA, or in a processor manufactured by a third party that
|
|
* is used in combination with a processor manufactured by Nordic Semiconductor.
|
|
*
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
|
|
*
|
|
*/
|
|
/**
|
|
@defgroup nrf_mbr_api Master Boot Record API
|
|
@{
|
|
|
|
@brief APIs for updating SoftDevice and BootLoader
|
|
|
|
*/
|
|
|
|
/* Header guard */
|
|
#ifndef NRF_MBR_H__
|
|
#define NRF_MBR_H__
|
|
|
|
#include "nrf_svc.h"
|
|
#include <stdint.h>
|
|
|
|
|
|
/** @addtogroup NRF_MBR_DEFINES Defines
|
|
* @{ */
|
|
|
|
/**@brief MBR SVC Base number. */
|
|
#define MBR_SVC_BASE (0x18)
|
|
|
|
/** @} */
|
|
|
|
/** @addtogroup NRF_MBR_ENUMS Enumerations
|
|
* @{ */
|
|
|
|
/**@brief nRF Master Boot Record API SVC numbers. */
|
|
enum NRF_MBR_SVCS
|
|
{
|
|
SD_MBR_COMMAND = MBR_SVC_BASE, /**< ::sd_mbr_command */
|
|
};
|
|
|
|
/**@brief Possible values for ::sd_mbr_command_t.command */
|
|
enum NRF_MBR_COMMANDS
|
|
{
|
|
SD_MBR_COMMAND_COPY_BL, /**< Copy a new BootLoader. @see sd_mbr_command_copy_bl_t */
|
|
SD_MBR_COMMAND_COPY_SD, /**< Copy a new SoftDevice. @see ::sd_mbr_command_copy_sd_t*/
|
|
SD_MBR_COMMAND_INIT_SD, /**< Init forwarding interrupts to SD, and run reset function in SD*/
|
|
SD_MBR_COMMAND_COMPARE, /**< This command works like memcmp. @see ::sd_mbr_command_compare_t*/
|
|
SD_MBR_COMMAND_VECTOR_TABLE_BASE_SET, /**< Start forwarding all exception to this address @see ::sd_mbr_command_vector_table_base_set_t*/
|
|
};
|
|
|
|
/** @} */
|
|
|
|
/** @addtogroup NRF_MBR_TYPES Types
|
|
* @{ */
|
|
|
|
/**@brief This command copies part of a new SoftDevice
|
|
* The destination area is erased before copying.
|
|
* If dst is in the middle of a flash page, that whole flash page will be erased.
|
|
* If (dst+len) is in the middle of a flash page, that whole flash page will be erased.
|
|
*
|
|
* The user of this function is responsible for setting the PROTENSET registers.
|
|
*
|
|
* @retval ::NRF_SUCCESS indicates that the contents of the memory blocks where copied correctly.
|
|
* @retval ::NRF_ERROR_INTERNAL indicates that the contents of the memory blocks where not verified correctly after copying.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t *src; /**< Pointer to the source of data to be copied.*/
|
|
uint32_t *dst; /**< Pointer to the destination where the content is to be copied.*/
|
|
uint32_t len; /**< Number of 32 bit words to copy. Must be a multiple of PAGE_SIZE_IN_WORDS words.*/
|
|
} sd_mbr_command_copy_sd_t;
|
|
|
|
|
|
/**@brief This command works like memcmp, but takes the length in words.
|
|
*
|
|
* @retval ::NRF_SUCCESS indicates that the contents of both memory blocks are equal.
|
|
* @retval ::NRF_ERROR_NULL indicates that the contents of the memory blocks are not equal.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t *ptr1; /**< Pointer to block of memory. */
|
|
uint32_t *ptr2; /**< Pointer to block of memory. */
|
|
uint32_t len; /**< Number of 32 bit words to compare.*/
|
|
} sd_mbr_command_compare_t;
|
|
|
|
|
|
/**@brief This command copies a new BootLoader.
|
|
* With this command, destination of BootLoader is always the address written in NRF_UICR->BOOTADDR.
|
|
*
|
|
* Destination is erased by this function.
|
|
* If (destination+bl_len) is in the middle of a flash page, that whole flash page will be erased.
|
|
*
|
|
* This function will use PROTENSET to protect the flash that is not intended to be written.
|
|
*
|
|
* On Success, this function will not return. It will start the new BootLoader from reset-vector as normal.
|
|
*
|
|
* @retval ::NRF_ERROR_INTERNAL indicates an internal error that should not happen.
|
|
* @retval ::NRF_ERROR_FORBIDDEN if NRF_UICR->BOOTADDR is not set.
|
|
* @retval ::NRF_ERROR_INVALID_LENGTH if parameters attempts to read or write outside flash area.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t *bl_src; /**< Pointer to the source of the Bootloader to be be copied.*/
|
|
uint32_t bl_len; /**< Number of 32 bit words to copy for BootLoader. */
|
|
} sd_mbr_command_copy_bl_t;
|
|
|
|
/**@brief Sets the base address of the interrupt vector table for interrupts forwarded from the MBR
|
|
*
|
|
* Once this function has been called, this address is where the MBR will start to forward interrupts to after a reset.
|
|
*
|
|
* To restore default forwarding this function should be called with @param address set to 0.
|
|
* The MBR will then start forwarding to interrupts to the adress in NFR_UICR->BOOTADDR or to the SoftDevice if the BOOTADDR is not set.
|
|
*
|
|
* @retval ::NRF_SUCCESS
|
|
* @retval ::NRF_ERROR_INTERNAL indicates an internal error that should not happen.
|
|
* @retval ::NRF_ERROR_INVALID_ADDR if parameter address is outside of the flash size.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t address; /**< The base address of the interrupt vector table for forwarded interrupts.*/
|
|
} sd_mbr_command_vector_table_base_set_t;
|
|
|
|
typedef struct
|
|
{
|
|
uint32_t command; /**< type of command to be issued see @ref NRF_MBR_COMMANDS. */
|
|
union
|
|
{
|
|
sd_mbr_command_copy_sd_t copy_sd; /**< Parameters for copy SoftDevice.*/
|
|
sd_mbr_command_copy_bl_t copy_bl; /**< Parameters for copy BootLoader.*/
|
|
sd_mbr_command_compare_t compare; /**< Parameters for verify.*/
|
|
sd_mbr_command_vector_table_base_set_t base_set; /**< Parameters for vector table base set.*/
|
|
} params;
|
|
} sd_mbr_command_t;
|
|
|
|
/** @} */
|
|
|
|
/** @addtogroup NRF_MBR_FUNCTIONS Functions
|
|
* @{ */
|
|
|
|
/**@brief Issue Master Boot Record commands
|
|
*
|
|
* Commands used when updating a SoftDevice and bootloader.
|
|
*
|
|
* @param[in] param Pointer to a struct describing the command.
|
|
*
|
|
*@note for retvals see ::sd_mbr_command_copy_sd_t ::sd_mbr_command_copy_bl_t ::sd_mbr_command_compare_t
|
|
|
|
*/
|
|
SVCALL(SD_MBR_COMMAND, uint32_t, sd_mbr_command(sd_mbr_command_t* param));
|
|
|
|
/** @} */
|
|
#endif // NRF_MBR_H__
|
|
|
|
/**
|
|
@}
|
|
*/
|