1 /* 2 * Copyright (c) 2020, The OpenThread Authors. 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 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef OPENTHREAD_PLATFORM_FLASH_H_ 30 #define OPENTHREAD_PLATFORM_FLASH_H_ 31 32 #include <stdint.h> 33 34 #include <openthread/instance.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /** 41 * This function initializes the flash driver. 42 * 43 * @param[in] aInstance The OpenThread instance structure. 44 * 45 */ 46 void otPlatFlashInit(otInstance *aInstance); 47 48 /** 49 * This function gets the size of the swap space. 50 * 51 * @param[in] aInstance The OpenThread instance structure. 52 * 53 * @returns The size of the swap space in bytes. 54 * 55 */ 56 uint32_t otPlatFlashGetSwapSize(otInstance *aInstance); 57 58 /** 59 * This function erases the swap space indicated by @p aSwapIndex. 60 * 61 * @param[in] aInstance The OpenThread instance structure. 62 * @param[in] aSwapIndex A value in [0, 1] that indicates the swap space. 63 * 64 */ 65 void otPlatFlashErase(otInstance *aInstance, uint8_t aSwapIndex); 66 67 /** 68 * This function reads @p aSize bytes into @p aData. 69 * 70 * @param[in] aInstance The OpenThread instance structure. 71 * @param[in] aSwapIndex A value in [0, 1] that indicates the swap space. 72 * @param[in] aOffset A byte offset within the swap space. 73 * @param[out] aData A pointer to the data buffer for reading. 74 * @param[in] aSize Number of bytes to read. 75 * 76 */ 77 void otPlatFlashRead(otInstance *aInstance, uint8_t aSwapIndex, uint32_t aOffset, void *aData, uint32_t aSize); 78 79 /** 80 * This function writes @p aSize bytes from @p aData. 81 * 82 * @param[in] aInstance The OpenThread instance structure. 83 * @param[in] aSwapIndex A value in [0, 1] that indicates the swap space. 84 * @param[in] aOffset A byte offset within the swap space. 85 * @param[out] aData A pointer to the data to write. 86 * @param[in] aSize Number of bytes to write. 87 * 88 * 89 */ 90 void otPlatFlashWrite(otInstance *aInstance, uint8_t aSwapIndex, uint32_t aOffset, const void *aData, uint32_t aSize); 91 92 #ifdef __cplusplus 93 } // extern "C" 94 #endif 95 96 #endif // OPENTHREAD_PLATFORM_FLASH_H_ 97
