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