Stuart Northfield / mbed-src

mbed library sources

Fork of mbed-src by mbed official

targets/hal/TARGET_NORDIC/TARGET_MCU_NRF51822/Lib/s110_nrf51822_7_1_0/s110_nrf51822_7.1.0_API/include/nrf_mbr.h@357:d73ca02bc818, 2014-10-17 (annotated)

Committer:
mbed_official
Date:
Fri Oct 17 14:15:08 2014 +0100
Revision:
357:d73ca02bc818
Parent:
targets/hal/TARGET_NORDIC/TARGET_MCU_NRF51822/Lib/s110_nrf51822_7_0_0/s110_nrf51822_7.0.0_API/include/nrf_mbr.h@277:0dffe5d9e928 
Synchronized with git revision 74cc430faad92b2df0cd91d78a074ec315ad7533



Full URL: https://github.com/mbedmicro/mbed/commit/74cc430faad92b2df0cd91d78a074ec315ad7533/



updating to v7.1.0 of the Nordic soft-device.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 277:0dffe5d9e928 1 /*
mbed_official 277:0dffe5d9e928 2 * Copyright (c) 2014 Nordic Semiconductor. All Rights Reserved.
mbed_official 277:0dffe5d9e928 3 *
mbed_official 277:0dffe5d9e928 4 * The information contained herein is confidential property of Nordic Semiconductor. The use,
mbed_official 277:0dffe5d9e928 5 * copying, transfer or disclosure of such information is prohibited except by express written
mbed_official 277:0dffe5d9e928 6 * agreement with Nordic Semiconductor.
mbed_official 277:0dffe5d9e928 7 *
mbed_official 277:0dffe5d9e928 8 */
mbed_official 277:0dffe5d9e928 9 /**
mbed_official 277:0dffe5d9e928 10 @defgroup nrf_mbr_api Master Boot Record API
mbed_official 277:0dffe5d9e928 11 @{
mbed_official 277:0dffe5d9e928 12
mbed_official 277:0dffe5d9e928 13 @brief APIs for updating SoftDevice and BootLoader
mbed_official 277:0dffe5d9e928 14
mbed_official 277:0dffe5d9e928 15 */
mbed_official 277:0dffe5d9e928 16
mbed_official 277:0dffe5d9e928 17 /* Header guard */
mbed_official 277:0dffe5d9e928 18 #ifndef NRF_MBR_H__
mbed_official 277:0dffe5d9e928 19 #define NRF_MBR_H__
mbed_official 277:0dffe5d9e928 20
mbed_official 277:0dffe5d9e928 21 #include "nrf_svc.h"
mbed_official 277:0dffe5d9e928 22 #include <stdint.h>
mbed_official 277:0dffe5d9e928 23
mbed_official 277:0dffe5d9e928 24
mbed_official 277:0dffe5d9e928 25 /** @addtogroup NRF_MBR_DEFINES Defines
mbed_official 277:0dffe5d9e928 26 * @{ */
mbed_official 277:0dffe5d9e928 27
mbed_official 277:0dffe5d9e928 28 /**@brief MBR SVC Base number. */
mbed_official 277:0dffe5d9e928 29 #define MBR_SVC_BASE 0x18
mbed_official 277:0dffe5d9e928 30 /** @} */
mbed_official 277:0dffe5d9e928 31
mbed_official 277:0dffe5d9e928 32 /** @addtogroup NRF_MBR_ENUMS Enumerations
mbed_official 277:0dffe5d9e928 33 * @{ */
mbed_official 277:0dffe5d9e928 34
mbed_official 277:0dffe5d9e928 35 /**@brief nRF Master Boot Record API SVC numbers. */
mbed_official 277:0dffe5d9e928 36 enum NRF_MBR_SVCS
mbed_official 277:0dffe5d9e928 37 {
mbed_official 277:0dffe5d9e928 38 SD_MBR_COMMAND = MBR_SVC_BASE, /**< ::sd_mbr_command */
mbed_official 277:0dffe5d9e928 39 };
mbed_official 277:0dffe5d9e928 40
mbed_official 277:0dffe5d9e928 41 /**@brief Possible values for ::sd_mbr_command_t.command */
mbed_official 277:0dffe5d9e928 42 enum NRF_MBR_COMMANDS
mbed_official 277:0dffe5d9e928 43 {
mbed_official 277:0dffe5d9e928 44 SD_MBR_COMMAND_COPY_BL, /**< Copy a new a new BootLoader. @see sd_mbr_command_copy_bl_t */
mbed_official 277:0dffe5d9e928 45 SD_MBR_COMMAND_COPY_SD, /**< Copy a new SoftDevice. @see ::sd_mbr_command_copy_sd_t*/
mbed_official 277:0dffe5d9e928 46 SD_MBR_COMMAND_INIT_SD, /**< Init forwarding interrupts to SD, and run reset function in SD*/
mbed_official 277:0dffe5d9e928 47 SD_MBR_COMMAND_COMPARE, /**< This command works like memcmp. @see ::sd_mbr_command_compare_t*/
mbed_official 277:0dffe5d9e928 48 SD_MBR_COMMAND_VECTOR_TABLE_BASE_SET, /**< Start forwarding all exception to this address @see ::sd_mbr_command_vector_table_base_set_t*/
mbed_official 277:0dffe5d9e928 49 };
mbed_official 277:0dffe5d9e928 50
mbed_official 277:0dffe5d9e928 51 /** @} */
mbed_official 277:0dffe5d9e928 52
mbed_official 277:0dffe5d9e928 53 /** @addtogroup NRF_MBR_TYPES Types
mbed_official 277:0dffe5d9e928 54 * @{ */
mbed_official 277:0dffe5d9e928 55
mbed_official 277:0dffe5d9e928 56 /**@brief This command copies part of a new SoftDevice
mbed_official 277:0dffe5d9e928 57 * The destination area is erased before copying.
mbed_official 277:0dffe5d9e928 58 * If dst is in the middle of a flash page, that whole flash page will be erased.
mbed_official 277:0dffe5d9e928 59 * If (dst+len) is in the middle of a flash page, that whole flash page will be erased.
mbed_official 277:0dffe5d9e928 60 *
mbed_official 277:0dffe5d9e928 61 * The user of this function is responsible for setting the PROTENSET registers.
mbed_official 277:0dffe5d9e928 62 *
mbed_official 277:0dffe5d9e928 63 * @retval ::NRF_SUCCESS indicates that the contents of the memory blocks where copied correctly.
mbed_official 277:0dffe5d9e928 64 * @retval ::NRF_ERROR_INTERNAL indicates that the contents of the memory blocks where not verified correctly after copying.
mbed_official 277:0dffe5d9e928 65 */
mbed_official 277:0dffe5d9e928 66 typedef struct
mbed_official 277:0dffe5d9e928 67 {
mbed_official 277:0dffe5d9e928 68 uint32_t *src; /**< Pointer to the source of data to be copied.*/
mbed_official 277:0dffe5d9e928 69 uint32_t *dst; /**< Pointer to the destination where the content is to be copied.*/
mbed_official 277:0dffe5d9e928 70 uint32_t len; /**< Number of 32 bit words to copy. Must be a multiple of 256 words*/
mbed_official 277:0dffe5d9e928 71 }sd_mbr_command_copy_sd_t;
mbed_official 277:0dffe5d9e928 72
mbed_official 277:0dffe5d9e928 73
mbed_official 277:0dffe5d9e928 74 /**@brief This command works like memcmp, but takes the length in words.
mbed_official 277:0dffe5d9e928 75 *
mbed_official 277:0dffe5d9e928 76 * @retval ::NRF_SUCCESS indicates that the contents of both memory blocks are equal.
mbed_official 277:0dffe5d9e928 77 * @retval ::NRF_ERROR_NULL indicates that the contents of the memory blocks are not equal.
mbed_official 277:0dffe5d9e928 78 */
mbed_official 277:0dffe5d9e928 79 typedef struct
mbed_official 277:0dffe5d9e928 80 {
mbed_official 277:0dffe5d9e928 81 uint32_t *ptr1; /**< Pointer to block of memory */
mbed_official 277:0dffe5d9e928 82 uint32_t *ptr2; /**< Pointer to block of memory */
mbed_official 277:0dffe5d9e928 83 uint32_t len; /**< Number of 32 bit words to compare*/
mbed_official 277:0dffe5d9e928 84 }sd_mbr_command_compare_t;
mbed_official 277:0dffe5d9e928 85
mbed_official 277:0dffe5d9e928 86
mbed_official 277:0dffe5d9e928 87 /**@brief This command copies a new BootLoader.
mbed_official 277:0dffe5d9e928 88 * With this command, destination of BootLoader is always the address written in NRF_UICR->BOOTADDR.
mbed_official 277:0dffe5d9e928 89 *
mbed_official 277:0dffe5d9e928 90 * Destination is erased by this function.
mbed_official 277:0dffe5d9e928 91 * If (destination+bl_len) is in the middle of a flash page, that whole flash page will be erased.
mbed_official 277:0dffe5d9e928 92 *
mbed_official 277:0dffe5d9e928 93 * This function will use PROTENSET to protect the flash that is not intended to be written.
mbed_official 277:0dffe5d9e928 94 *
mbed_official 277:0dffe5d9e928 95 * On Success, this function will not return. It will start the new BootLoader from reset-vector as normal.
mbed_official 277:0dffe5d9e928 96 *
mbed_official 277:0dffe5d9e928 97 * @retval ::NRF_ERROR_INVALID_STATE indicates that something was wrong.
mbed_official 277:0dffe5d9e928 98 * @retval ::NRF_ERROR_INTERNAL indicates an internal error that should not happen.
mbed_official 277:0dffe5d9e928 99 * @retval ::NRF_ERROR_FORBIDDEN if NRF_UICR->BOOTADDR is not set
mbed_official 277:0dffe5d9e928 100 * @retval ::NRF_ERROR_INVALID_LENGTH is invalid.
mbed_official 277:0dffe5d9e928 101 */
mbed_official 277:0dffe5d9e928 102 typedef struct
mbed_official 277:0dffe5d9e928 103 {
mbed_official 277:0dffe5d9e928 104 uint32_t *bl_src; /**< Pointer to the source of the Bootloader to be be copied.*/
mbed_official 277:0dffe5d9e928 105 uint32_t bl_len; /**< Number of 32 bit words to copy for BootLoader */
mbed_official 277:0dffe5d9e928 106 }sd_mbr_command_copy_bl_t;
mbed_official 277:0dffe5d9e928 107
mbed_official 277:0dffe5d9e928 108 /**@brief Sets the base address of the interrupt vector table for interrupts forwarded from the MBR
mbed_official 277:0dffe5d9e928 109 *
mbed_official 277:0dffe5d9e928 110 * Once this function has been called, this address is where the MBR will start to forward interrupts to after a reset.
mbed_official 277:0dffe5d9e928 111 *
mbed_official 277:0dffe5d9e928 112 * To restore default forwarding thiss function should be called with @param address set to 0.
mbed_official 277:0dffe5d9e928 113 * 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.
mbed_official 277:0dffe5d9e928 114 *
mbed_official 277:0dffe5d9e928 115 * @retval ::NRF_SUCCESS
mbed_official 277:0dffe5d9e928 116 */
mbed_official 277:0dffe5d9e928 117 typedef struct
mbed_official 277:0dffe5d9e928 118 {
mbed_official 277:0dffe5d9e928 119 uint32_t address; /**< The base address of the interrupt vector table for forwarded interrupts.*/
mbed_official 277:0dffe5d9e928 120 }sd_mbr_command_vector_table_base_set_t;
mbed_official 277:0dffe5d9e928 121
mbed_official 277:0dffe5d9e928 122 typedef struct
mbed_official 277:0dffe5d9e928 123 {
mbed_official 277:0dffe5d9e928 124 uint32_t command; /**< type of command to be issued see @ref NRF_MBR_COMMANDS. */
mbed_official 277:0dffe5d9e928 125 union
mbed_official 277:0dffe5d9e928 126 {
mbed_official 277:0dffe5d9e928 127 sd_mbr_command_copy_sd_t copy_sd; /**< Parameters for copy*/
mbed_official 277:0dffe5d9e928 128 sd_mbr_command_copy_bl_t copy_bl; /**< Parameters for copy SoftDevice and BootLoader*/
mbed_official 277:0dffe5d9e928 129 sd_mbr_command_compare_t compare; /**< Parameters for verify*/
mbed_official 277:0dffe5d9e928 130 sd_mbr_command_vector_table_base_set_t base_set; /**< Parameters for vector table base set.*/
mbed_official 277:0dffe5d9e928 131 } params;
mbed_official 277:0dffe5d9e928 132 }sd_mbr_command_t;
mbed_official 277:0dffe5d9e928 133
mbed_official 277:0dffe5d9e928 134 /** @} */
mbed_official 277:0dffe5d9e928 135
mbed_official 277:0dffe5d9e928 136 /** @addtogroup NRF_MBR_FUNCTIONS Functions
mbed_official 277:0dffe5d9e928 137 * @{ */
mbed_official 277:0dffe5d9e928 138
mbed_official 277:0dffe5d9e928 139 /**@brief Issue Master Boot Record commands
mbed_official 277:0dffe5d9e928 140 *
mbed_official 277:0dffe5d9e928 141 * Commands used when updating a SoftDevice and bootloader
mbed_official 277:0dffe5d9e928 142 *
mbed_official 277:0dffe5d9e928 143 * @param[in] param Pointer to a struct describing the command
mbed_official 277:0dffe5d9e928 144 *
mbed_official 277:0dffe5d9e928 145 *@note for retvals see ::sd_mbr_command_copy_sd_t ::sd_mbr_command_copy_bl_t ::sd_mbr_command_compare_t
mbed_official 277:0dffe5d9e928 146
mbed_official 277:0dffe5d9e928 147 */
mbed_official 277:0dffe5d9e928 148 SVCALL(SD_MBR_COMMAND, uint32_t, sd_mbr_command(sd_mbr_command_t* param));
mbed_official 277:0dffe5d9e928 149
mbed_official 277:0dffe5d9e928 150 /** @} */
mbed_official 277:0dffe5d9e928 151 #endif // NRF_MBR_H__
mbed_official 277:0dffe5d9e928 152
mbed_official 277:0dffe5d9e928 153 /**
mbed_official 277:0dffe5d9e928 154 @}
mbed_official 277:0dffe5d9e928 155 */