Cefn Hoile / 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.

Dependencies:   nrf51-sdk

Dependents:   microbit-dal

Fork of nRF51822 by Lancaster University

nordic-sdk/components/drivers_nrf/ble_flash/ble_flash.h@345:dfde56236c36, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:35 2015 +0100
Revision:
345:dfde56236c36
Parent:
343:6675661fa600
Child:
346:14b090482fd2
Synchronized with git rev fbfc6d16

Author: Andrew Fernandes

Fix various GCC compilation issues.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 345:dfde56236c36 1 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
rgrover1 345:dfde56236c36 2 *
rgrover1 345:dfde56236c36 3 * The information contained herein is property of Nordic Semiconductor ASA.
rgrover1 345:dfde56236c36 4 * Terms and conditions of usage are described in detail in NORDIC
rgrover1 345:dfde56236c36 5 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
rgrover1 345:dfde56236c36 6 *
rgrover1 345:dfde56236c36 7 * Licensees are granted free, non-transferable use of the information. NO
rgrover1 345:dfde56236c36 8 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
rgrover1 345:dfde56236c36 9 * the file.
rgrover1 345:dfde56236c36 10 *
rgrover1 345:dfde56236c36 11 */
rgrover1 345:dfde56236c36 12
rgrover1 345:dfde56236c36 13 /** @file
rgrover1 345:dfde56236c36 14 *
rgrover1 345:dfde56236c36 15 * @defgroup ble_flash_module Flash Manager
rgrover1 345:dfde56236c36 16 * @{
rgrover1 345:dfde56236c36 17 * @ingroup ble_sdk_lib
rgrover1 345:dfde56236c36 18 * @brief Module for accessing flash memory.
rgrover1 345:dfde56236c36 19 *
rgrover1 345:dfde56236c36 20 * @details It contains functions for reading, writing and erasing one page in flash.
rgrover1 345:dfde56236c36 21 *
rgrover1 345:dfde56236c36 22 * The module uses the first 32 bits of the flash page to write a magic number in order to
rgrover1 345:dfde56236c36 23 * determine if the page has been written or not.
rgrover1 345:dfde56236c36 24 *
rgrover1 345:dfde56236c36 25 * @note Be careful not to use a page number in the SoftDevice area (which currently occupies the
rgrover1 345:dfde56236c36 26 * range 0 to 127), or in your application space! In both cases, this would end up
rgrover1 345:dfde56236c36 27 * with a hard fault.
rgrover1 345:dfde56236c36 28 */
rgrover1 345:dfde56236c36 29
rgrover1 345:dfde56236c36 30 #ifndef BLE_FLASH_H__
rgrover1 345:dfde56236c36 31 #define BLE_FLASH_H__
rgrover1 345:dfde56236c36 32
rgrover1 345:dfde56236c36 33 #include <stdint.h>
rgrover1 345:dfde56236c36 34 #include <stdbool.h>
rgrover1 345:dfde56236c36 35 #include <nrf51.h>
rgrover1 345:dfde56236c36 36
rgrover1 345:dfde56236c36 37 #define BLE_FLASH_PAGE_SIZE ((uint16_t)NRF_FICR->CODEPAGESIZE) /**< Size of one flash page. */
rgrover1 345:dfde56236c36 38 #define BLE_FLASH_MAGIC_NUMBER 0x45DE0000 /**< Magic value to identify if flash contains valid data. */
rgrover1 345:dfde56236c36 39 #define BLE_FLASH_EMPTY_MASK 0xFFFFFFFF /**< Bit mask that defines an empty address in flash. */
rgrover1 345:dfde56236c36 40
rgrover1 345:dfde56236c36 41
rgrover1 345:dfde56236c36 42 /**@brief Macro for getting the end of the flash available for application.
rgrover1 345:dfde56236c36 43 *
rgrover1 345:dfde56236c36 44 * @details The result flash page number indicates the end boundary of the flash available
rgrover1 345:dfde56236c36 45 * to the application. If a bootloader is used, the end will be the start of the
rgrover1 345:dfde56236c36 46 * bootloader region. Otherwise, the end will be the size of the flash.
rgrover1 345:dfde56236c36 47 */
rgrover1 345:dfde56236c36 48 #define BLE_FLASH_PAGE_END \
rgrover1 345:dfde56236c36 49 ((NRF_UICR->BOOTLOADERADDR != BLE_FLASH_EMPTY_MASK) \
rgrover1 345:dfde56236c36 50 ? (NRF_UICR->BOOTLOADERADDR / BLE_FLASH_PAGE_SIZE) \
rgrover1 345:dfde56236c36 51 : NRF_FICR->CODESIZE)
rgrover1 345:dfde56236c36 52
rgrover1 345:dfde56236c36 53 /**@brief Function for erasing the specified flash page, and then writes the given data to this page.
rgrover1 345:dfde56236c36 54 *
rgrover1 345:dfde56236c36 55 * @warning This operation blocks the CPU. DO NOT use while in a connection!
rgrover1 345:dfde56236c36 56 *
rgrover1 345:dfde56236c36 57 * @param[in] page_num Page number to update.
rgrover1 345:dfde56236c36 58 * @param[in] p_in_array Pointer to a RAM area containing the elements to write in flash.
rgrover1 345:dfde56236c36 59 * This area has to be 32 bits aligned.
rgrover1 345:dfde56236c36 60 * @param[in] word_count Number of 32 bits words to write in flash.
rgrover1 345:dfde56236c36 61 *
rgrover1 345:dfde56236c36 62 * @return NRF_SUCCESS on successful flash write, otherwise an error code.
rgrover1 345:dfde56236c36 63 */
rgrover1 345:dfde56236c36 64 uint32_t ble_flash_page_write(uint8_t page_num, uint32_t * p_in_array, uint8_t word_count);
rgrover1 345:dfde56236c36 65
rgrover1 345:dfde56236c36 66 /**@brief Function for reading data from flash to RAM.
rgrover1 345:dfde56236c36 67 *
rgrover1 345:dfde56236c36 68 * @param[in] page_num Page number to read.
rgrover1 345:dfde56236c36 69 * @param[out] p_out_array Pointer to a RAM area where the found data will be written.
rgrover1 345:dfde56236c36 70 * This area has to be 32 bits aligned.
rgrover1 345:dfde56236c36 71 * @param[out] p_word_count Number of 32 bits words read.
rgrover1 345:dfde56236c36 72 *
rgrover1 345:dfde56236c36 73 * @return NRF_SUCCESS on successful upload, NRF_ERROR_NOT_FOUND if no valid data has been found
rgrover1 345:dfde56236c36 74 * in flash (first 32 bits not equal to the MAGIC_NUMBER+CRC).
rgrover1 345:dfde56236c36 75 */
rgrover1 345:dfde56236c36 76 uint32_t ble_flash_page_read(uint8_t page_num, uint32_t * p_out_array, uint8_t * p_word_count);
rgrover1 345:dfde56236c36 77
rgrover1 345:dfde56236c36 78 /**@brief Function for erasing a flash page.
rgrover1 345:dfde56236c36 79 *
rgrover1 345:dfde56236c36 80 * @note This operation blocks the CPU, so it should not be done while the radio is running!
rgrover1 345:dfde56236c36 81 *
rgrover1 345:dfde56236c36 82 * @param[in] page_num Page number to erase.
rgrover1 345:dfde56236c36 83 *
rgrover1 345:dfde56236c36 84 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 345:dfde56236c36 85 */
rgrover1 345:dfde56236c36 86 uint32_t ble_flash_page_erase(uint8_t page_num);
rgrover1 345:dfde56236c36 87
rgrover1 345:dfde56236c36 88 /**@brief Function for writing one word to flash.
rgrover1 345:dfde56236c36 89 *
rgrover1 345:dfde56236c36 90 * @note Flash location to be written must have been erased previously.
rgrover1 345:dfde56236c36 91 *
rgrover1 345:dfde56236c36 92 * @param[in] p_address Pointer to flash location to be written.
rgrover1 345:dfde56236c36 93 * @param[in] value Value to write to flash.
rgrover1 345:dfde56236c36 94 *
rgrover1 345:dfde56236c36 95 * @return NRF_SUCCESS.
rgrover1 345:dfde56236c36 96 */
rgrover1 345:dfde56236c36 97 uint32_t ble_flash_word_write(uint32_t * p_address, uint32_t value);
rgrover1 345:dfde56236c36 98
rgrover1 345:dfde56236c36 99 /**@brief Function for writing a data block to flash.
rgrover1 345:dfde56236c36 100 *
rgrover1 345:dfde56236c36 101 * @note Flash locations to be written must have been erased previously.
rgrover1 345:dfde56236c36 102 *
rgrover1 345:dfde56236c36 103 * @param[in] p_address Pointer to start of flash location to be written.
rgrover1 345:dfde56236c36 104 * @param[in] p_in_array Pointer to start of flash block to be written.
rgrover1 345:dfde56236c36 105 * @param[in] word_count Number of words to be written.
rgrover1 345:dfde56236c36 106 *
rgrover1 345:dfde56236c36 107 * @return NRF_SUCCESS.
rgrover1 345:dfde56236c36 108 */
rgrover1 345:dfde56236c36 109 uint32_t ble_flash_block_write(uint32_t * p_address, uint32_t * p_in_array, uint16_t word_count);
rgrover1 345:dfde56236c36 110
rgrover1 345:dfde56236c36 111 /**@brief Function for computing pointer to start of specified flash page.
rgrover1 345:dfde56236c36 112 *
rgrover1 345:dfde56236c36 113 * @param[in] page_num Page number.
rgrover1 345:dfde56236c36 114 * @param[out] pp_page_addr Pointer to start of flash page.
rgrover1 345:dfde56236c36 115 *
rgrover1 345:dfde56236c36 116 * @return NRF_SUCCESS.
rgrover1 345:dfde56236c36 117 */
rgrover1 345:dfde56236c36 118 uint32_t ble_flash_page_addr(uint8_t page_num, uint32_t ** pp_page_addr);
rgrover1 345:dfde56236c36 119
rgrover1 345:dfde56236c36 120 /**@brief Function for calculating a 16 bit CRC using the CRC-16-CCITT scheme.
rgrover1 345:dfde56236c36 121 *
rgrover1 345:dfde56236c36 122 * @param[in] p_data Pointer to data on which the CRC is to be calulated.
rgrover1 345:dfde56236c36 123 * @param[in] size Number of bytes on which the CRC is to be calulated.
rgrover1 345:dfde56236c36 124 * @param[in] p_crc Initial CRC value (if NULL, a preset value is used as the initial value).
rgrover1 345:dfde56236c36 125 *
rgrover1 345:dfde56236c36 126 * @return Calculated CRC.
rgrover1 345:dfde56236c36 127 */
rgrover1 345:dfde56236c36 128 uint16_t ble_flash_crc16_compute(uint8_t * p_data, uint16_t size, uint16_t * p_crc);
rgrover1 345:dfde56236c36 129
rgrover1 345:dfde56236c36 130 /**@brief Function for handling flashing module Radio Notification event.
rgrover1 345:dfde56236c36 131 *
rgrover1 345:dfde56236c36 132 * @note For flash writing to work safely while in a connection or while advertising, this function
rgrover1 345:dfde56236c36 133 * MUST be called from the Radio Notification module's event handler (see
rgrover1 345:dfde56236c36 134 * @ref ble_radio_notification for details).
rgrover1 345:dfde56236c36 135 *
rgrover1 345:dfde56236c36 136 * @param[in] radio_active TRUE if radio is active (or about to become active), FALSE otherwise.
rgrover1 345:dfde56236c36 137 */
rgrover1 345:dfde56236c36 138 void ble_flash_on_radio_active_evt(bool radio_active);
rgrover1 345:dfde56236c36 139
rgrover1 345:dfde56236c36 140 #endif // BLE_FLASH_H__
rgrover1 345:dfde56236c36 141
rgrover1 345:dfde56236c36 142 /** @} */