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_DK/TOOLCHAIN_ARM_STD/nrf_nvmc.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 143:86740a56073b 1 /*
AnnaBridge 143:86740a56073b 2 * Copyright (c) 2012 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 /**
AnnaBridge 143:86740a56073b 41 * @file
AnnaBridge 143:86740a56073b 42 * @brief NMVC driver API.
AnnaBridge 143:86740a56073b 43 */
AnnaBridge 143:86740a56073b 44
AnnaBridge 143:86740a56073b 45 #ifndef NRF_NVMC_H__
AnnaBridge 143:86740a56073b 46 #define NRF_NVMC_H__
AnnaBridge 143:86740a56073b 47
AnnaBridge 143:86740a56073b 48 #include <stdint.h>
AnnaBridge 143:86740a56073b 49
AnnaBridge 143:86740a56073b 50
AnnaBridge 143:86740a56073b 51 /**
AnnaBridge 143:86740a56073b 52 * @defgroup nrf_nvmc Non-volatile memory controller
AnnaBridge 143:86740a56073b 53 * @{
AnnaBridge 143:86740a56073b 54 * @ingroup nrf_drivers
AnnaBridge 143:86740a56073b 55 * @brief Driver for the NVMC peripheral.
AnnaBridge 143:86740a56073b 56 *
AnnaBridge 143:86740a56073b 57 * This driver allows writing to the non-volatile memory (NVM) regions
AnnaBridge 143:86740a56073b 58 * of the chip. In order to write to NVM the controller must be powered
AnnaBridge 143:86740a56073b 59 * on and the relevant page must be erased.
AnnaBridge 143:86740a56073b 60 *
AnnaBridge 143:86740a56073b 61 */
AnnaBridge 143:86740a56073b 62
AnnaBridge 143:86740a56073b 63
AnnaBridge 143:86740a56073b 64 /**
AnnaBridge 143:86740a56073b 65 * @brief Erase a page in flash. This is required before writing to any
AnnaBridge 143:86740a56073b 66 * address in the page.
AnnaBridge 143:86740a56073b 67 *
AnnaBridge 143:86740a56073b 68 * @param address Start address of the page.
AnnaBridge 143:86740a56073b 69 */
AnnaBridge 143:86740a56073b 70 void nrf_nvmc_page_erase(uint32_t address);
AnnaBridge 143:86740a56073b 71
AnnaBridge 143:86740a56073b 72
AnnaBridge 143:86740a56073b 73 /**
AnnaBridge 143:86740a56073b 74 * @brief Write a single byte to flash.
AnnaBridge 143:86740a56073b 75 *
AnnaBridge 143:86740a56073b 76 * The function reads the word containing the byte, and then
AnnaBridge 143:86740a56073b 77 * rewrites the entire word.
AnnaBridge 143:86740a56073b 78 *
AnnaBridge 143:86740a56073b 79 * @param address Address to write to.
AnnaBridge 143:86740a56073b 80 * @param value Value to write.
AnnaBridge 143:86740a56073b 81 */
AnnaBridge 143:86740a56073b 82 void nrf_nvmc_write_byte(uint32_t address , uint8_t value);
AnnaBridge 143:86740a56073b 83
AnnaBridge 143:86740a56073b 84
AnnaBridge 143:86740a56073b 85 /**
AnnaBridge 143:86740a56073b 86 * @brief Write a 32-bit word to flash.
AnnaBridge 143:86740a56073b 87 * @param address Address to write to.
AnnaBridge 143:86740a56073b 88 * @param value Value to write.
AnnaBridge 143:86740a56073b 89 */
AnnaBridge 143:86740a56073b 90 void nrf_nvmc_write_word(uint32_t address, uint32_t value);
AnnaBridge 143:86740a56073b 91
AnnaBridge 143:86740a56073b 92
AnnaBridge 143:86740a56073b 93 /**
AnnaBridge 143:86740a56073b 94 * @brief Write consecutive bytes to flash.
AnnaBridge 143:86740a56073b 95 *
AnnaBridge 143:86740a56073b 96 * @param address Address to write to.
AnnaBridge 143:86740a56073b 97 * @param src Pointer to data to copy from.
AnnaBridge 143:86740a56073b 98 * @param num_bytes Number of bytes in src to write.
AnnaBridge 143:86740a56073b 99 */
AnnaBridge 143:86740a56073b 100 void nrf_nvmc_write_bytes(uint32_t address, const uint8_t * src, uint32_t num_bytes);
AnnaBridge 143:86740a56073b 101
AnnaBridge 143:86740a56073b 102
AnnaBridge 143:86740a56073b 103 /**
AnnaBridge 143:86740a56073b 104 * @brief Write consecutive words to flash.
AnnaBridge 143:86740a56073b 105 *
AnnaBridge 143:86740a56073b 106 * @param address Address to write to.
AnnaBridge 143:86740a56073b 107 * @param src Pointer to data to copy from.
AnnaBridge 143:86740a56073b 108 * @param num_words Number of bytes in src to write.
AnnaBridge 143:86740a56073b 109 */
AnnaBridge 143:86740a56073b 110 void nrf_nvmc_write_words(uint32_t address, const uint32_t * src, uint32_t num_words);
AnnaBridge 143:86740a56073b 111
AnnaBridge 143:86740a56073b 112
AnnaBridge 143:86740a56073b 113 #endif // NRF_NVMC_H__
AnnaBridge 143:86740a56073b 114 /** @} */
AnnaBridge 143:86740a56073b 115
AnnaBridge 143:86740a56073b 116