1 /* 2 * Copyright (C) 2017 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 20 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 21 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 23 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 24 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 25 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 27 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 */ 31 32 /* 33 * hal_flash_bank.h 34 * 35 * HAL abstraction for Flash memory that can be written anywhere 36 * after being erased 37 */ 38 39 #ifndef HAL_FLASH_BANK_H 40 #define HAL_FLASH_BANK_H 41 42 #include <stdint.h> 43 44 #if defined __cplusplus 45 extern "C" { 46 #endif 47 48 typedef struct { 49 50 /** 51 * Get size of flash banks 52 */ 53 uint32_t (*get_size)(void * context); 54 55 /** 56 * Get flash read/write alignmenent requirements 57 */ 58 uint32_t (*get_alignment)(void * context); 59 60 /** 61 * Erase a bank 62 * @param context 63 * @param bank 64 */ 65 void (*erase)(void * context, int bank); 66 67 /** 68 * Read from flash into provided buffer 69 * @param context 70 * @param bank 71 * @param offset into flash bank 72 * @param buffer to read data 73 * @param size of data to read 74 */ 75 void (*read)(void * context, int bank, uint32_t offset, uint8_t * buffer, uint32_t size); 76 77 /** 78 * Write data into flash. Each offset can only be written once after bank was erased 79 * @param context 80 * @param bank 81 * @param offset into flash bank 82 to read data 83 * @param size of data to store 84 */ 85 void (*write)(void * context, int bank, uint32_t offset, const uint8_t * data, uint32_t size); 86 87 } hal_flash_bank_t; 88 89 #if defined __cplusplus 90 } 91 #endif 92 #endif // HAL_FLASH_BANK_H 93