Mouse code for the MacroRat
mbed-dev/targets/TARGET_NORDIC/TARGET_NRF5/TARGET_MCU_NRF52832/sdk/softdevice/s132/headers/nrf52/nrf_mbr.h
- Committer:
- sahilmgandhi
- Date:
- 2017-05-14
- Revision:
- 18:6a4db94011d3
File content as of revision 18:6a4db94011d3:
/* * Copyright (c) 2000 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 or object form under this license must not be reverse * engineered, decompiled, modified and/or disassembled. * * 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> #ifndef NRF52 #error "This header file shall only be included for nRF52 projects" #endif #ifdef __cplusplus extern "C" { #endif /** @addtogroup NRF_MBR_DEFINES Defines * @{ */ /**@brief MBR SVC Base number. */ #define MBR_SVC_BASE (0x18) /**@brief Page size in words. */ #define MBR_PAGE_SIZE_IN_WORDS (1024) /** @brief The size that must be reserved for the MBR when a softdevice is written to flash. This is the offset where the first byte of the softdevice hex file is written.*/ #define MBR_SIZE (0x1000) /** @} */ /** @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 BPROT 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 @ref MBR_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. * @retval ::NRF_ERROR_NO_MEM if no parameter page is provided (see sds for more info) */ 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 address in NFR_UICR->BOOTADDR or to the SoftDevice if the BOOTADDR is not set. * * On Success, this function will not return. It will reset the device. * * @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. * @retval ::NRF_ERROR_NO_MEM if no parameter page is provided (see sds for more info) */ 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_compare_t compare; /**< Parameters for verify.*/ sd_mbr_command_copy_bl_t copy_bl; /**< Parameters for copy BootLoader. Requires parameter page. */ sd_mbr_command_vector_table_base_set_t base_set; /**< Parameters for vector table base set. Requires parameter page.*/ } params; } sd_mbr_command_t; /** @} */ /** @addtogroup NRF_MBR_FUNCTIONS Functions * @{ */ /**@brief Issue Master Boot Record commands * * Commands used when updating a SoftDevice and bootloader. * * The SD_MBR_COMMAND_COPY_BL and SD_MBR_COMMAND_VECTOR_TABLE_BASE_SET requires parameters to be * retained by the MBR when resetting the IC. This is done in a separate flash page * provided by the application. The uicr register UICR.NRFFW[1] must be set * to an address corresponding to a page in the application flash space. This page will be cleared * by the MBR and used to store the command before reset. When the UICR.NRFFW[1] field is set * the page it refers to must not be used by the application. If the UICR.NRFFW[1] is set to * 0xFFFFFFFF (the default) MBR commands which use flash will be unavailable and return * NRF_ERROR_NO_MEM. * * @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 ::sd_mbr_command_vector_table_base_set_t * * @retval NRF_ERROR_NO_MEM if UICR.NRFFW[1] is not set (i.e. is 0xFFFFFFFF). * @retval NRF_ERROR_INVALID_PARAM if an invalid command is given. */ SVCALL(SD_MBR_COMMAND, uint32_t, sd_mbr_command(sd_mbr_command_t* param)); /** @} */ #ifdef __cplusplus } #endif #endif // NRF_MBR_H__ /** @} */