mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NRF51_DONGLE/TOOLCHAIN_GCC_ARM/fstorage_internal_defs.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_NRF51_DONGLE/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/libraries/fstorage/fstorage_internal_defs.h@169:a7c7b631e539 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 143:86740a56073b 1 /*
AnnaBridge 143:86740a56073b 2 * Copyright (c) 2015 Nordic Semiconductor ASA
AnnaBridge 143:86740a56073b 3 * All rights reserved.
AnnaBridge 143:86740a56073b 4 *
AnnaBridge 143:86740a56073b 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 143:86740a56073b 6 * are permitted provided that the following conditions are met:
AnnaBridge 143:86740a56073b 7 *
AnnaBridge 143:86740a56073b 8 * 1. Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 143:86740a56073b 9 * of conditions and the following disclaimer.
AnnaBridge 143:86740a56073b 10 *
AnnaBridge 143:86740a56073b 11 * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA
AnnaBridge 143:86740a56073b 12 * integrated circuit in a product or a software update for such product, must reproduce
AnnaBridge 143:86740a56073b 13 * the above copyright notice, this list of conditions and the following disclaimer in
AnnaBridge 143:86740a56073b 14 * the documentation and/or other materials provided with the distribution.
AnnaBridge 143:86740a56073b 15 *
AnnaBridge 143:86740a56073b 16 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be
AnnaBridge 143:86740a56073b 17 * used to endorse or promote products derived from this software without specific prior
AnnaBridge 143:86740a56073b 18 * written permission.
AnnaBridge 143:86740a56073b 19 *
AnnaBridge 143:86740a56073b 20 * 4. This software, with or without modification, must only be used with a
AnnaBridge 143:86740a56073b 21 * Nordic Semiconductor ASA integrated circuit.
AnnaBridge 143:86740a56073b 22 *
AnnaBridge 143:86740a56073b 23 * 5. Any software provided in binary or object form under this license must not be reverse
AnnaBridge 143:86740a56073b 24 * engineered, decompiled, modified and/or disassembled.
AnnaBridge 143:86740a56073b 25 *
AnnaBridge 143:86740a56073b 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 143:86740a56073b 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 143:86740a56073b 28 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 143:86740a56073b 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 143:86740a56073b 30 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 143:86740a56073b 31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 143:86740a56073b 32 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 143:86740a56073b 33 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 143:86740a56073b 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 143:86740a56073b 35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 143:86740a56073b 36 *
AnnaBridge 143:86740a56073b 37 */
AnnaBridge 143:86740a56073b 38
AnnaBridge 143:86740a56073b 39
AnnaBridge 143:86740a56073b 40 #ifndef FSTORAGE_INTERNAL_DEFS_H__
AnnaBridge 143:86740a56073b 41 #define FSTORAGE_INTERNAL_DEFS_H__
AnnaBridge 143:86740a56073b 42
AnnaBridge 143:86740a56073b 43 #include "nrf.h"
AnnaBridge 143:86740a56073b 44
AnnaBridge 143:86740a56073b 45
AnnaBridge 143:86740a56073b 46 #define FS_FLAG_INITIALIZED (1 << 0) // The module has been initialized.
AnnaBridge 143:86740a56073b 47 #define FS_FLAG_PROCESSING (1 << 1) // The module is processing flash operations.
AnnaBridge 143:86740a56073b 48 // The module is waiting for a flash operation initiated by another module to complete.
AnnaBridge 143:86740a56073b 49 #define FS_FLAG_FLASH_REQ_PENDING (1 << 2)
AnnaBridge 143:86740a56073b 50
AnnaBridge 143:86740a56073b 51 #define FS_ERASED_WORD (0xFFFFFFFF)
AnnaBridge 143:86740a56073b 52
AnnaBridge 143:86740a56073b 53 // Helper macros for section variables.
AnnaBridge 143:86740a56073b 54 #define FS_SECTION_VARS_GET(i) NRF_SECTION_VARS_GET((i), fs_config_t, fs_data)
AnnaBridge 143:86740a56073b 55 #define FS_SECTION_VARS_COUNT NRF_SECTION_VARS_COUNT(fs_config_t, fs_data)
AnnaBridge 143:86740a56073b 56 #define FS_SECTION_VARS_START_ADDR NRF_SECTION_VARS_START_ADDR(fs_data)
AnnaBridge 143:86740a56073b 57 #define FS_SECTION_VARS_END_ADDR NRF_SECTION_VARS_END_ADDR(fs_data)
AnnaBridge 143:86740a56073b 58
AnnaBridge 143:86740a56073b 59
AnnaBridge 143:86740a56073b 60 // Register the section 'fs_data'.
AnnaBridge 143:86740a56073b 61 //lint -save -e19
AnnaBridge 143:86740a56073b 62 NRF_SECTION_VARS_REGISTER_SECTION(fs_data);
AnnaBridge 143:86740a56073b 63 //lint -restore
AnnaBridge 143:86740a56073b 64
AnnaBridge 143:86740a56073b 65 // Declare symbols into the 'fs_data' section.
AnnaBridge 143:86740a56073b 66 NRF_SECTION_VARS_REGISTER_SYMBOLS(fs_config_t, fs_data);
AnnaBridge 143:86740a56073b 67 //lint -esym(526,fs_dataBase)
AnnaBridge 143:86740a56073b 68 //lint -esym(526,fs_dataLimit)
AnnaBridge 143:86740a56073b 69
AnnaBridge 143:86740a56073b 70
AnnaBridge 143:86740a56073b 71 // fstorage op-codes.
AnnaBridge 143:86740a56073b 72 typedef enum
AnnaBridge 143:86740a56073b 73 {
AnnaBridge 143:86740a56073b 74 FS_OP_NONE, // No operation.
AnnaBridge 143:86740a56073b 75 FS_OP_STORE, // Store data.
AnnaBridge 143:86740a56073b 76 FS_OP_ERASE // Erase one or more flash pages.
AnnaBridge 143:86740a56073b 77 } fs_op_code_t;
AnnaBridge 143:86740a56073b 78
AnnaBridge 143:86740a56073b 79
AnnaBridge 143:86740a56073b 80 #if defined(__CC_ARM)
AnnaBridge 143:86740a56073b 81 #pragma push
AnnaBridge 143:86740a56073b 82 #pragma anon_unions
AnnaBridge 143:86740a56073b 83 #elif defined(__ICCARM__)
AnnaBridge 143:86740a56073b 84 #pragma language=extended
AnnaBridge 143:86740a56073b 85 #elif defined(__GNUC__)
AnnaBridge 143:86740a56073b 86 // anonymous unions are enabled by default.
AnnaBridge 143:86740a56073b 87 #endif
AnnaBridge 143:86740a56073b 88
AnnaBridge 143:86740a56073b 89 // fstorage operation.
AnnaBridge 143:86740a56073b 90 // Encapsulates details of a flash operation to be executed by this module.
AnnaBridge 143:86740a56073b 91 typedef struct
AnnaBridge 143:86740a56073b 92 {
AnnaBridge 143:86740a56073b 93 fs_config_t const * p_config; // Application-specific fstorage configuration.
AnnaBridge 143:86740a56073b 94 fs_op_code_t op_code; // ID of the operation.
AnnaBridge 143:86740a56073b 95 union
AnnaBridge 143:86740a56073b 96 {
AnnaBridge 143:86740a56073b 97 struct
AnnaBridge 143:86740a56073b 98 {
AnnaBridge 143:86740a56073b 99 uint32_t const * p_src; // Pointer to the data to be written to flash.
AnnaBridge 143:86740a56073b 100 uint32_t const * p_dest; // Destination of the data in flash.
AnnaBridge 143:86740a56073b 101 uint16_t length_words; // Length of the data to be written, in words.
AnnaBridge 143:86740a56073b 102 uint16_t offset; // Write offset.
AnnaBridge 143:86740a56073b 103 } store;
AnnaBridge 143:86740a56073b 104 struct
AnnaBridge 143:86740a56073b 105 {
AnnaBridge 143:86740a56073b 106 uint16_t page;
AnnaBridge 143:86740a56073b 107 uint16_t pages_erased;
AnnaBridge 143:86740a56073b 108 uint16_t pages_to_erase;
AnnaBridge 143:86740a56073b 109 } erase;
AnnaBridge 143:86740a56073b 110 };
AnnaBridge 143:86740a56073b 111 } fs_op_t;
AnnaBridge 143:86740a56073b 112
AnnaBridge 143:86740a56073b 113 #if defined(__CC_ARM)
AnnaBridge 143:86740a56073b 114 #pragma pop
AnnaBridge 143:86740a56073b 115 #elif defined(__ICCARM__)
AnnaBridge 143:86740a56073b 116 // leave anonymous unions enabled.
AnnaBridge 143:86740a56073b 117 #elif defined(__GNUC__)
AnnaBridge 143:86740a56073b 118 // anonymous unions are enabled by default.
AnnaBridge 143:86740a56073b 119 #endif
AnnaBridge 143:86740a56073b 120
AnnaBridge 143:86740a56073b 121
AnnaBridge 143:86740a56073b 122 // Queue of requested operations.
AnnaBridge 143:86740a56073b 123 // This queue holds flash operations requested to the module.
AnnaBridge 143:86740a56073b 124 // The data to be written to flash must be kept in memory until the write operation
AnnaBridge 143:86740a56073b 125 // is completed, i.e., an event indicating completion is received.
AnnaBridge 143:86740a56073b 126 typedef struct
AnnaBridge 143:86740a56073b 127 {
AnnaBridge 143:86740a56073b 128 fs_op_t op[FS_QUEUE_SIZE]; // Queue elements.
AnnaBridge 143:86740a56073b 129 uint32_t rp; // Index of the operation being processed.
AnnaBridge 143:86740a56073b 130 uint32_t count; // Number of elements in the queue.
AnnaBridge 143:86740a56073b 131 } fs_op_queue_t;
AnnaBridge 143:86740a56073b 132
AnnaBridge 143:86740a56073b 133
AnnaBridge 143:86740a56073b 134 // Size of a flash page in bytes.
AnnaBridge 143:86740a56073b 135 #if defined (NRF51)
AnnaBridge 143:86740a56073b 136 #define FS_PAGE_SIZE (1024)
AnnaBridge 143:86740a56073b 137 #elif defined (NRF52)
AnnaBridge 143:86740a56073b 138 #define FS_PAGE_SIZE (4096)
AnnaBridge 143:86740a56073b 139 #endif
AnnaBridge 143:86740a56073b 140
AnnaBridge 143:86740a56073b 141
AnnaBridge 143:86740a56073b 142 // Size of a flash page in words.
AnnaBridge 143:86740a56073b 143 #define FS_PAGE_SIZE_WORDS (FS_PAGE_SIZE / sizeof(uint32_t))
AnnaBridge 143:86740a56073b 144
AnnaBridge 143:86740a56073b 145
AnnaBridge 143:86740a56073b 146 // Function to obtain the end of the flash space available to fstorage.
AnnaBridge 143:86740a56073b 147 static uint32_t const * fs_flash_page_end_addr()
AnnaBridge 143:86740a56073b 148 {
AnnaBridge 143:86740a56073b 149 uint32_t const bootloader_addr = NRF_UICR->NRFFW[0];
AnnaBridge 143:86740a56073b 150
AnnaBridge 143:86740a56073b 151 return (uint32_t*)((bootloader_addr != FS_ERASED_WORD) ? bootloader_addr :
AnnaBridge 143:86740a56073b 152 NRF_FICR->CODESIZE * FS_PAGE_SIZE);
AnnaBridge 143:86740a56073b 153 }
AnnaBridge 143:86740a56073b 154
AnnaBridge 143:86740a56073b 155
AnnaBridge 143:86740a56073b 156 // Macro to obtain the address of the last page.
AnnaBridge 143:86740a56073b 157 // If there is a bootloader present the bootloader address read from UICR
AnnaBridge 143:86740a56073b 158 // will act as the page beyond the end of the available flash storage.
AnnaBridge 143:86740a56073b 159 #define FS_PAGE_END_ADDR (fs_flash_page_end_addr())
AnnaBridge 143:86740a56073b 160
AnnaBridge 143:86740a56073b 161
AnnaBridge 143:86740a56073b 162 #endif //__FSTORAGE_INTERNAL_DEFS_H