Nordic Semiconductor / nRF51822

Nordic stack and drivers for the mbed BLE API

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate writable_gatt ... more

TARGET_MCU_NRF51822/sdk/source/drivers_nrf/hal/nrf_nvmc.h@638:c90ae1400bf2, 2016-09-14 (annotated)

Committer:
Vincent Coubard
Date:
Wed Sep 14 14:39:43 2016 +0100
Revision:
638:c90ae1400bf2
Sync with bdab10dc0f90748b6989c8b577771bb403ca6bd8 from ARMmbed/mbed-os.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Vincent Coubard 638:c90ae1400bf2 1 /*
Vincent Coubard 638:c90ae1400bf2 2 * Copyright (c) Nordic Semiconductor ASA
Vincent Coubard 638:c90ae1400bf2 3 * All rights reserved.
Vincent Coubard 638:c90ae1400bf2 4 *
Vincent Coubard 638:c90ae1400bf2 5 * Redistribution and use in source and binary forms, with or without modification,
Vincent Coubard 638:c90ae1400bf2 6 * are permitted provided that the following conditions are met:
Vincent Coubard 638:c90ae1400bf2 7 *
Vincent Coubard 638:c90ae1400bf2 8 * 1. Redistributions of source code must retain the above copyright notice, this
Vincent Coubard 638:c90ae1400bf2 9 * list of conditions and the following disclaimer.
Vincent Coubard 638:c90ae1400bf2 10 *
Vincent Coubard 638:c90ae1400bf2 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
Vincent Coubard 638:c90ae1400bf2 12 * list of conditions and the following disclaimer in the documentation and/or
Vincent Coubard 638:c90ae1400bf2 13 * other materials provided with the distribution.
Vincent Coubard 638:c90ae1400bf2 14 *
Vincent Coubard 638:c90ae1400bf2 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
Vincent Coubard 638:c90ae1400bf2 16 * contributors to this software may be used to endorse or promote products
Vincent Coubard 638:c90ae1400bf2 17 * derived from this software without specific prior written permission.
Vincent Coubard 638:c90ae1400bf2 18 *
Vincent Coubard 638:c90ae1400bf2 19 *
Vincent Coubard 638:c90ae1400bf2 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
Vincent Coubard 638:c90ae1400bf2 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Vincent Coubard 638:c90ae1400bf2 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Vincent Coubard 638:c90ae1400bf2 23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
Vincent Coubard 638:c90ae1400bf2 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
Vincent Coubard 638:c90ae1400bf2 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
Vincent Coubard 638:c90ae1400bf2 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
Vincent Coubard 638:c90ae1400bf2 27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Vincent Coubard 638:c90ae1400bf2 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Vincent Coubard 638:c90ae1400bf2 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Vincent Coubard 638:c90ae1400bf2 30 *
Vincent Coubard 638:c90ae1400bf2 31 */
Vincent Coubard 638:c90ae1400bf2 32
Vincent Coubard 638:c90ae1400bf2 33 /**
Vincent Coubard 638:c90ae1400bf2 34 * @file
Vincent Coubard 638:c90ae1400bf2 35 * @brief NMVC driver API.
Vincent Coubard 638:c90ae1400bf2 36 */
Vincent Coubard 638:c90ae1400bf2 37
Vincent Coubard 638:c90ae1400bf2 38 #ifndef NRF_NVMC_H__
Vincent Coubard 638:c90ae1400bf2 39 #define NRF_NVMC_H__
Vincent Coubard 638:c90ae1400bf2 40
Vincent Coubard 638:c90ae1400bf2 41 #include <stdint.h>
Vincent Coubard 638:c90ae1400bf2 42
Vincent Coubard 638:c90ae1400bf2 43
Vincent Coubard 638:c90ae1400bf2 44 /**
Vincent Coubard 638:c90ae1400bf2 45 * @defgroup nrf_nvmc Non-volatile memory controller
Vincent Coubard 638:c90ae1400bf2 46 * @{
Vincent Coubard 638:c90ae1400bf2 47 * @ingroup nrf_drivers
Vincent Coubard 638:c90ae1400bf2 48 * @brief Driver for the NVMC peripheral.
Vincent Coubard 638:c90ae1400bf2 49 *
Vincent Coubard 638:c90ae1400bf2 50 * This driver allows writing to the non-volatile memory (NVM) regions
Vincent Coubard 638:c90ae1400bf2 51 * of the chip. In order to write to NVM the controller must be powered
Vincent Coubard 638:c90ae1400bf2 52 * on and the relevant page must be erased.
Vincent Coubard 638:c90ae1400bf2 53 *
Vincent Coubard 638:c90ae1400bf2 54 */
Vincent Coubard 638:c90ae1400bf2 55
Vincent Coubard 638:c90ae1400bf2 56
Vincent Coubard 638:c90ae1400bf2 57 /**
Vincent Coubard 638:c90ae1400bf2 58 * @brief Erase a page in flash. This is required before writing to any
Vincent Coubard 638:c90ae1400bf2 59 * address in the page.
Vincent Coubard 638:c90ae1400bf2 60 *
Vincent Coubard 638:c90ae1400bf2 61 * @param address Start address of the page.
Vincent Coubard 638:c90ae1400bf2 62 */
Vincent Coubard 638:c90ae1400bf2 63 void nrf_nvmc_page_erase(uint32_t address);
Vincent Coubard 638:c90ae1400bf2 64
Vincent Coubard 638:c90ae1400bf2 65
Vincent Coubard 638:c90ae1400bf2 66 /**
Vincent Coubard 638:c90ae1400bf2 67 * @brief Write a single byte to flash.
Vincent Coubard 638:c90ae1400bf2 68 *
Vincent Coubard 638:c90ae1400bf2 69 * The function reads the word containing the byte, and then
Vincent Coubard 638:c90ae1400bf2 70 * rewrites the entire word.
Vincent Coubard 638:c90ae1400bf2 71 *
Vincent Coubard 638:c90ae1400bf2 72 * @param address Address to write to.
Vincent Coubard 638:c90ae1400bf2 73 * @param value Value to write.
Vincent Coubard 638:c90ae1400bf2 74 */
Vincent Coubard 638:c90ae1400bf2 75 void nrf_nvmc_write_byte(uint32_t address , uint8_t value);
Vincent Coubard 638:c90ae1400bf2 76
Vincent Coubard 638:c90ae1400bf2 77
Vincent Coubard 638:c90ae1400bf2 78 /**
Vincent Coubard 638:c90ae1400bf2 79 * @brief Write a 32-bit word to flash.
Vincent Coubard 638:c90ae1400bf2 80 * @param address Address to write to.
Vincent Coubard 638:c90ae1400bf2 81 * @param value Value to write.
Vincent Coubard 638:c90ae1400bf2 82 */
Vincent Coubard 638:c90ae1400bf2 83 void nrf_nvmc_write_word(uint32_t address, uint32_t value);
Vincent Coubard 638:c90ae1400bf2 84
Vincent Coubard 638:c90ae1400bf2 85
Vincent Coubard 638:c90ae1400bf2 86 /**
Vincent Coubard 638:c90ae1400bf2 87 * @brief Write consecutive bytes to flash.
Vincent Coubard 638:c90ae1400bf2 88 *
Vincent Coubard 638:c90ae1400bf2 89 * @param address Address to write to.
Vincent Coubard 638:c90ae1400bf2 90 * @param src Pointer to data to copy from.
Vincent Coubard 638:c90ae1400bf2 91 * @param num_bytes Number of bytes in src to write.
Vincent Coubard 638:c90ae1400bf2 92 */
Vincent Coubard 638:c90ae1400bf2 93 void nrf_nvmc_write_bytes(uint32_t address, const uint8_t * src, uint32_t num_bytes);
Vincent Coubard 638:c90ae1400bf2 94
Vincent Coubard 638:c90ae1400bf2 95
Vincent Coubard 638:c90ae1400bf2 96 /**
Vincent Coubard 638:c90ae1400bf2 97 * @brief Write consecutive words to flash.
Vincent Coubard 638:c90ae1400bf2 98 *
Vincent Coubard 638:c90ae1400bf2 99 * @param address Address to write to.
Vincent Coubard 638:c90ae1400bf2 100 * @param src Pointer to data to copy from.
Vincent Coubard 638:c90ae1400bf2 101 * @param num_words Number of bytes in src to write.
Vincent Coubard 638:c90ae1400bf2 102 */
Vincent Coubard 638:c90ae1400bf2 103 void nrf_nvmc_write_words(uint32_t address, const uint32_t * src, uint32_t num_words);
Vincent Coubard 638:c90ae1400bf2 104
Vincent Coubard 638:c90ae1400bf2 105
Vincent Coubard 638:c90ae1400bf2 106 #endif // NRF_NVMC_H__
Vincent Coubard 638:c90ae1400bf2 107 /** @} */
Vincent Coubard 638:c90ae1400bf2 108
Vincent Coubard 638:c90ae1400bf2 109