Glimworm Beacons / nRF51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/drivers_nrf/ble_flash/ble_flash.c@103:138bdc859cc9, 2015-04-15 (annotated)

Committer:
rgrover1
Date:
Wed Apr 15 08:59:11 2015 +0100
Revision:
103:138bdc859cc9
Child:
343:6675661fa600
Synchronized with git rev fa183c40

Author: Rohit Grover

updating to v7.1 of the Nordic SDK.

Re-organized file layout to match that from the SDK.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 103:138bdc859cc9 1 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
rgrover1 103:138bdc859cc9 2 *
rgrover1 103:138bdc859cc9 3 * The information contained herein is property of Nordic Semiconductor ASA.
rgrover1 103:138bdc859cc9 4 * Terms and conditions of usage are described in detail in NORDIC
rgrover1 103:138bdc859cc9 5 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
rgrover1 103:138bdc859cc9 6 *
rgrover1 103:138bdc859cc9 7 * Licensees are granted free, non-transferable use of the information. NO
rgrover1 103:138bdc859cc9 8 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
rgrover1 103:138bdc859cc9 9 * the file.
rgrover1 103:138bdc859cc9 10 *
rgrover1 103:138bdc859cc9 11 */
rgrover1 103:138bdc859cc9 12
rgrover1 103:138bdc859cc9 13 #include "ble_flash.h"
rgrover1 103:138bdc859cc9 14 #include <stdlib.h>
rgrover1 103:138bdc859cc9 15 #include <stdint.h>
rgrover1 103:138bdc859cc9 16 #include <string.h>
rgrover1 103:138bdc859cc9 17 #include "nrf_soc.h"
rgrover1 103:138bdc859cc9 18 #include "nordic_common.h"
rgrover1 103:138bdc859cc9 19 #include "nrf_error.h"
rgrover1 103:138bdc859cc9 20 #include "nrf.h"
rgrover1 103:138bdc859cc9 21 #include "nrf51_bitfields.h"
rgrover1 103:138bdc859cc9 22 #include "app_util.h"
rgrover1 103:138bdc859cc9 23
rgrover1 103:138bdc859cc9 24
rgrover1 103:138bdc859cc9 25 static volatile bool m_radio_active = false; /**< TRUE if radio is active (or about to become active), FALSE otherwise. */
rgrover1 103:138bdc859cc9 26
rgrover1 103:138bdc859cc9 27
rgrover1 103:138bdc859cc9 28 uint16_t ble_flash_crc16_compute(uint8_t * p_data, uint16_t size, uint16_t * p_crc)
rgrover1 103:138bdc859cc9 29 {
rgrover1 103:138bdc859cc9 30 uint16_t i;
rgrover1 103:138bdc859cc9 31 uint16_t crc = (p_crc == NULL) ? 0xffff : *p_crc;
rgrover1 103:138bdc859cc9 32
rgrover1 103:138bdc859cc9 33 for (i = 0; i < size; i++)
rgrover1 103:138bdc859cc9 34 {
rgrover1 103:138bdc859cc9 35 crc = (unsigned char)(crc >> 8) | (crc << 8);
rgrover1 103:138bdc859cc9 36 crc ^= p_data[i];
rgrover1 103:138bdc859cc9 37 crc ^= (unsigned char)(crc & 0xff) >> 4;
rgrover1 103:138bdc859cc9 38 crc ^= (crc << 8) << 4;
rgrover1 103:138bdc859cc9 39 crc ^= ((crc & 0xff) << 4) << 1;
rgrover1 103:138bdc859cc9 40 }
rgrover1 103:138bdc859cc9 41 return crc;
rgrover1 103:138bdc859cc9 42 }
rgrover1 103:138bdc859cc9 43
rgrover1 103:138bdc859cc9 44
rgrover1 103:138bdc859cc9 45 /**@brief Function for erasing a page in flash.
rgrover1 103:138bdc859cc9 46 *
rgrover1 103:138bdc859cc9 47 * @param[in] p_page Pointer to first word in page to be erased.
rgrover1 103:138bdc859cc9 48 */
rgrover1 103:138bdc859cc9 49 static void flash_page_erase(uint32_t * p_page)
rgrover1 103:138bdc859cc9 50 {
rgrover1 103:138bdc859cc9 51 // Turn on flash erase enable and wait until the NVMC is ready.
rgrover1 103:138bdc859cc9 52 NRF_NVMC->CONFIG = (NVMC_CONFIG_WEN_Een << NVMC_CONFIG_WEN_Pos);
rgrover1 103:138bdc859cc9 53 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 54 {
rgrover1 103:138bdc859cc9 55 // Do nothing.
rgrover1 103:138bdc859cc9 56 }
rgrover1 103:138bdc859cc9 57
rgrover1 103:138bdc859cc9 58 // Erase page.
rgrover1 103:138bdc859cc9 59 NRF_NVMC->ERASEPAGE = (uint32_t)p_page;
rgrover1 103:138bdc859cc9 60 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 61 {
rgrover1 103:138bdc859cc9 62 // Do nothing.
rgrover1 103:138bdc859cc9 63 }
rgrover1 103:138bdc859cc9 64
rgrover1 103:138bdc859cc9 65 // Turn off flash erase enable and wait until the NVMC is ready.
rgrover1 103:138bdc859cc9 66 NRF_NVMC->CONFIG = (NVMC_CONFIG_WEN_Ren << NVMC_CONFIG_WEN_Pos);
rgrover1 103:138bdc859cc9 67 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 68 {
rgrover1 103:138bdc859cc9 69 // Do nothing
rgrover1 103:138bdc859cc9 70 }
rgrover1 103:138bdc859cc9 71 }
rgrover1 103:138bdc859cc9 72
rgrover1 103:138bdc859cc9 73
rgrover1 103:138bdc859cc9 74 /**@brief Function for writing one word to flash. Unprotected write, which can interfere with radio communication.
rgrover1 103:138bdc859cc9 75 *
rgrover1 103:138bdc859cc9 76 * @details This function DOES NOT use the m_radio_active variable, but will force the write even
rgrover1 103:138bdc859cc9 77 * when the radio is active. To be used only from @ref ble_flash_page_write.
rgrover1 103:138bdc859cc9 78 *
rgrover1 103:138bdc859cc9 79 * @note Flash location to be written must have been erased previously.
rgrover1 103:138bdc859cc9 80 *
rgrover1 103:138bdc859cc9 81 * @param[in] p_address Pointer to flash location to be written.
rgrover1 103:138bdc859cc9 82 * @param[in] value Value to write to flash.
rgrover1 103:138bdc859cc9 83 */
rgrover1 103:138bdc859cc9 84 static void flash_word_unprotected_write(uint32_t * p_address, uint32_t value)
rgrover1 103:138bdc859cc9 85 {
rgrover1 103:138bdc859cc9 86 // Turn on flash write enable and wait until the NVMC is ready.
rgrover1 103:138bdc859cc9 87 NRF_NVMC->CONFIG = (NVMC_CONFIG_WEN_Wen << NVMC_CONFIG_WEN_Pos);
rgrover1 103:138bdc859cc9 88 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 89 {
rgrover1 103:138bdc859cc9 90 // Do nothing.
rgrover1 103:138bdc859cc9 91 }
rgrover1 103:138bdc859cc9 92 *p_address = value;
rgrover1 103:138bdc859cc9 93
rgrover1 103:138bdc859cc9 94 // Wait flash write to finish
rgrover1 103:138bdc859cc9 95 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 96 {
rgrover1 103:138bdc859cc9 97 // Do nothing.
rgrover1 103:138bdc859cc9 98 }
rgrover1 103:138bdc859cc9 99
rgrover1 103:138bdc859cc9 100 // Turn off flash write enable and wait until the NVMC is ready.
rgrover1 103:138bdc859cc9 101 NRF_NVMC->CONFIG = (NVMC_CONFIG_WEN_Ren << NVMC_CONFIG_WEN_Pos);
rgrover1 103:138bdc859cc9 102 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 103 {
rgrover1 103:138bdc859cc9 104 // Do nothing.
rgrover1 103:138bdc859cc9 105 }
rgrover1 103:138bdc859cc9 106 }
rgrover1 103:138bdc859cc9 107
rgrover1 103:138bdc859cc9 108
rgrover1 103:138bdc859cc9 109 /**@brief Function for writing one word to flash.
rgrover1 103:138bdc859cc9 110 *
rgrover1 103:138bdc859cc9 111 * @note Flash location to be written must have been erased previously.
rgrover1 103:138bdc859cc9 112 *
rgrover1 103:138bdc859cc9 113 * @param[in] p_address Pointer to flash location to be written.
rgrover1 103:138bdc859cc9 114 * @param[in] value Value to write to flash.
rgrover1 103:138bdc859cc9 115 */
rgrover1 103:138bdc859cc9 116 static void flash_word_write(uint32_t * p_address, uint32_t value)
rgrover1 103:138bdc859cc9 117 {
rgrover1 103:138bdc859cc9 118 // If radio is active, wait for it to become inactive.
rgrover1 103:138bdc859cc9 119 while (m_radio_active)
rgrover1 103:138bdc859cc9 120 {
rgrover1 103:138bdc859cc9 121 // Do nothing (just wait for radio to become inactive).
rgrover1 103:138bdc859cc9 122 (void) sd_app_evt_wait();
rgrover1 103:138bdc859cc9 123 }
rgrover1 103:138bdc859cc9 124
rgrover1 103:138bdc859cc9 125 // Turn on flash write enable and wait until the NVMC is ready.
rgrover1 103:138bdc859cc9 126 NRF_NVMC->CONFIG = (NVMC_CONFIG_WEN_Wen << NVMC_CONFIG_WEN_Pos);
rgrover1 103:138bdc859cc9 127 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 128 {
rgrover1 103:138bdc859cc9 129 // Do nothing.
rgrover1 103:138bdc859cc9 130 }
rgrover1 103:138bdc859cc9 131
rgrover1 103:138bdc859cc9 132 *p_address = value;
rgrover1 103:138bdc859cc9 133 // Wait flash write to finish
rgrover1 103:138bdc859cc9 134 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 135 {
rgrover1 103:138bdc859cc9 136 // Do nothing.
rgrover1 103:138bdc859cc9 137 }
rgrover1 103:138bdc859cc9 138 // Turn off flash write enable and wait until the NVMC is ready.
rgrover1 103:138bdc859cc9 139 NRF_NVMC->CONFIG = (NVMC_CONFIG_WEN_Ren << NVMC_CONFIG_WEN_Pos);
rgrover1 103:138bdc859cc9 140 while (NRF_NVMC->READY == NVMC_READY_READY_Busy)
rgrover1 103:138bdc859cc9 141 {
rgrover1 103:138bdc859cc9 142 // Do nothing
rgrover1 103:138bdc859cc9 143 }
rgrover1 103:138bdc859cc9 144 }
rgrover1 103:138bdc859cc9 145
rgrover1 103:138bdc859cc9 146
rgrover1 103:138bdc859cc9 147 uint32_t ble_flash_word_write(uint32_t * p_address, uint32_t value)
rgrover1 103:138bdc859cc9 148 {
rgrover1 103:138bdc859cc9 149 flash_word_write(p_address, value);
rgrover1 103:138bdc859cc9 150 return NRF_SUCCESS;
rgrover1 103:138bdc859cc9 151 }
rgrover1 103:138bdc859cc9 152
rgrover1 103:138bdc859cc9 153
rgrover1 103:138bdc859cc9 154 uint32_t ble_flash_block_write(uint32_t * p_address, uint32_t * p_in_array, uint16_t word_count)
rgrover1 103:138bdc859cc9 155 {
rgrover1 103:138bdc859cc9 156 uint16_t i;
rgrover1 103:138bdc859cc9 157
rgrover1 103:138bdc859cc9 158 for (i = 0; i < word_count; i++)
rgrover1 103:138bdc859cc9 159 {
rgrover1 103:138bdc859cc9 160 flash_word_write(p_address, p_in_array[i]);
rgrover1 103:138bdc859cc9 161 p_address++;
rgrover1 103:138bdc859cc9 162 }
rgrover1 103:138bdc859cc9 163
rgrover1 103:138bdc859cc9 164 return NRF_SUCCESS;
rgrover1 103:138bdc859cc9 165 }
rgrover1 103:138bdc859cc9 166
rgrover1 103:138bdc859cc9 167
rgrover1 103:138bdc859cc9 168 uint32_t ble_flash_page_erase(uint8_t page_num)
rgrover1 103:138bdc859cc9 169 {
rgrover1 103:138bdc859cc9 170 uint32_t * p_page = (uint32_t *)(BLE_FLASH_PAGE_SIZE * page_num);
rgrover1 103:138bdc859cc9 171 flash_page_erase(p_page);
rgrover1 103:138bdc859cc9 172
rgrover1 103:138bdc859cc9 173 return NRF_SUCCESS;
rgrover1 103:138bdc859cc9 174 }
rgrover1 103:138bdc859cc9 175
rgrover1 103:138bdc859cc9 176
rgrover1 103:138bdc859cc9 177 uint32_t ble_flash_page_write(uint8_t page_num, uint32_t * p_in_array, uint8_t word_count)
rgrover1 103:138bdc859cc9 178 {
rgrover1 103:138bdc859cc9 179 int i;
rgrover1 103:138bdc859cc9 180 uint32_t * p_page;
rgrover1 103:138bdc859cc9 181 uint32_t * p_curr_addr;
rgrover1 103:138bdc859cc9 182 uint16_t in_data_crc;
rgrover1 103:138bdc859cc9 183 uint16_t flash_crc;
rgrover1 103:138bdc859cc9 184 uint32_t flash_header;
rgrover1 103:138bdc859cc9 185
rgrover1 103:138bdc859cc9 186 p_page = (uint32_t *)(BLE_FLASH_PAGE_SIZE * page_num);
rgrover1 103:138bdc859cc9 187 p_curr_addr = p_page;
rgrover1 103:138bdc859cc9 188
rgrover1 103:138bdc859cc9 189 // Calculate CRC of the data to write.
rgrover1 103:138bdc859cc9 190 in_data_crc = ble_flash_crc16_compute((uint8_t *)p_in_array,
rgrover1 103:138bdc859cc9 191 word_count * sizeof(uint32_t),
rgrover1 103:138bdc859cc9 192 NULL);
rgrover1 103:138bdc859cc9 193
rgrover1 103:138bdc859cc9 194 // Compare the calculated to the one in flash.
rgrover1 103:138bdc859cc9 195 flash_header = *p_curr_addr;
rgrover1 103:138bdc859cc9 196 flash_crc = (uint16_t)flash_header;
rgrover1 103:138bdc859cc9 197
rgrover1 103:138bdc859cc9 198 if (flash_crc == in_data_crc)
rgrover1 103:138bdc859cc9 199 {
rgrover1 103:138bdc859cc9 200 // Data is the same as the data already stored in flash, return without modifying flash.
rgrover1 103:138bdc859cc9 201 return NRF_SUCCESS;
rgrover1 103:138bdc859cc9 202 }
rgrover1 103:138bdc859cc9 203
rgrover1 103:138bdc859cc9 204 // Erase flash page
rgrover1 103:138bdc859cc9 205 flash_page_erase(p_page);
rgrover1 103:138bdc859cc9 206
rgrover1 103:138bdc859cc9 207 // Reserve space for magic number (for detecting if flash content is valid).
rgrover1 103:138bdc859cc9 208 p_curr_addr++;
rgrover1 103:138bdc859cc9 209
rgrover1 103:138bdc859cc9 210 // Reserve space for saving word_count.
rgrover1 103:138bdc859cc9 211 p_curr_addr++;
rgrover1 103:138bdc859cc9 212
rgrover1 103:138bdc859cc9 213 // Write data
rgrover1 103:138bdc859cc9 214 for (i = 0; i < word_count; i++)
rgrover1 103:138bdc859cc9 215 {
rgrover1 103:138bdc859cc9 216 flash_word_unprotected_write(p_curr_addr, p_in_array[i]);
rgrover1 103:138bdc859cc9 217 p_curr_addr++;
rgrover1 103:138bdc859cc9 218 }
rgrover1 103:138bdc859cc9 219
rgrover1 103:138bdc859cc9 220 // Write number of elements.
rgrover1 103:138bdc859cc9 221 flash_word_write(p_page + 1, (uint32_t)(word_count));
rgrover1 103:138bdc859cc9 222
rgrover1 103:138bdc859cc9 223 // Write magic number and CRC to indicate that flash content is valid.
rgrover1 103:138bdc859cc9 224 flash_header = BLE_FLASH_MAGIC_NUMBER | (uint32_t)in_data_crc;
rgrover1 103:138bdc859cc9 225 flash_word_write(p_page, flash_header);
rgrover1 103:138bdc859cc9 226
rgrover1 103:138bdc859cc9 227 return NRF_SUCCESS;
rgrover1 103:138bdc859cc9 228 }
rgrover1 103:138bdc859cc9 229
rgrover1 103:138bdc859cc9 230
rgrover1 103:138bdc859cc9 231 uint32_t ble_flash_page_read(uint8_t page_num, uint32_t * p_out_array, uint8_t * p_word_count)
rgrover1 103:138bdc859cc9 232 {
rgrover1 103:138bdc859cc9 233 int byte_count;
rgrover1 103:138bdc859cc9 234 uint32_t * p_page;
rgrover1 103:138bdc859cc9 235 uint32_t * p_curr_addr;
rgrover1 103:138bdc859cc9 236 uint32_t flash_header;
rgrover1 103:138bdc859cc9 237 uint32_t calc_header;
rgrover1 103:138bdc859cc9 238 uint16_t calc_crc;
rgrover1 103:138bdc859cc9 239 uint32_t tmp;
rgrover1 103:138bdc859cc9 240
rgrover1 103:138bdc859cc9 241 p_page = (uint32_t *)(BLE_FLASH_PAGE_SIZE * page_num);
rgrover1 103:138bdc859cc9 242 p_curr_addr = p_page;
rgrover1 103:138bdc859cc9 243
rgrover1 103:138bdc859cc9 244 // Check if block is valid
rgrover1 103:138bdc859cc9 245 flash_header = *p_curr_addr;
rgrover1 103:138bdc859cc9 246 tmp = flash_header & 0xFFFF0000;
rgrover1 103:138bdc859cc9 247 if (tmp != BLE_FLASH_MAGIC_NUMBER)
rgrover1 103:138bdc859cc9 248 {
rgrover1 103:138bdc859cc9 249 *p_word_count = 0;
rgrover1 103:138bdc859cc9 250 return NRF_ERROR_NOT_FOUND;
rgrover1 103:138bdc859cc9 251 }
rgrover1 103:138bdc859cc9 252 p_curr_addr++;
rgrover1 103:138bdc859cc9 253
rgrover1 103:138bdc859cc9 254 // Read number of elements
rgrover1 103:138bdc859cc9 255 *p_word_count = (uint8_t)(*(p_curr_addr));
rgrover1 103:138bdc859cc9 256 p_curr_addr++;
rgrover1 103:138bdc859cc9 257
rgrover1 103:138bdc859cc9 258 // Read data
rgrover1 103:138bdc859cc9 259 byte_count = (*p_word_count) * sizeof(uint32_t);
rgrover1 103:138bdc859cc9 260 memcpy(p_out_array, p_curr_addr, byte_count);
rgrover1 103:138bdc859cc9 261
rgrover1 103:138bdc859cc9 262 // Check CRC
rgrover1 103:138bdc859cc9 263 calc_crc = ble_flash_crc16_compute((uint8_t *)p_out_array,
rgrover1 103:138bdc859cc9 264 (*p_word_count) * sizeof(uint32_t),
rgrover1 103:138bdc859cc9 265 NULL);
rgrover1 103:138bdc859cc9 266 calc_header = BLE_FLASH_MAGIC_NUMBER | (uint32_t)calc_crc;
rgrover1 103:138bdc859cc9 267
rgrover1 103:138bdc859cc9 268 if (calc_header != flash_header)
rgrover1 103:138bdc859cc9 269 {
rgrover1 103:138bdc859cc9 270 return NRF_ERROR_NOT_FOUND;
rgrover1 103:138bdc859cc9 271 }
rgrover1 103:138bdc859cc9 272
rgrover1 103:138bdc859cc9 273 return NRF_SUCCESS;
rgrover1 103:138bdc859cc9 274 }
rgrover1 103:138bdc859cc9 275
rgrover1 103:138bdc859cc9 276
rgrover1 103:138bdc859cc9 277 uint32_t ble_flash_page_addr(uint8_t page_num, uint32_t ** pp_page_addr)
rgrover1 103:138bdc859cc9 278 {
rgrover1 103:138bdc859cc9 279 *pp_page_addr = (uint32_t *)(BLE_FLASH_PAGE_SIZE * page_num);
rgrover1 103:138bdc859cc9 280 return NRF_SUCCESS;
rgrover1 103:138bdc859cc9 281 }
rgrover1 103:138bdc859cc9 282
rgrover1 103:138bdc859cc9 283
rgrover1 103:138bdc859cc9 284 void ble_flash_on_radio_active_evt(bool radio_active)
rgrover1 103:138bdc859cc9 285 {
rgrover1 103:138bdc859cc9 286 m_radio_active = radio_active;
rgrover1 103:138bdc859cc9 287 }