src/main/io/flashfs.h

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #pragma once
  22
  23 #define FLASHFS_WRITE_BUFFER_SIZE 128
  24 #define FLASHFS_WRITE_BUFFER_USABLE (FLASHFS_WRITE_BUFFER_SIZE - 1)
  25
  26 // Automatically trigger a flush when this much data is in the buffer
  27 #define FLASHFS_WRITE_BUFFER_AUTO_FLUSH_LEN 64
  28
  29 void flashfsEraseCompletely(void);
  30 void flashfsEraseRange(uint32_t start, uint32_t end);
  31
  32 uint32_t flashfsGetSize(void);
  33 uint32_t flashfsGetOffset(void);
  34 uint32_t flashfsGetWriteBufferFreeSpace(void);
  35 uint32_t flashfsGetWriteBufferSize(void);
  36 int flashfsIdentifyStartOfFreeSpace(void);
  37 struct flashGeometry_s;
  38 const struct flashGeometry_s* flashfsGetGeometry(void);
  39
  40 void flashfsSeekAbs(uint32_t offset);
  41
  42 void flashfsWriteByte(uint8_t byte);
  43 void flashfsWrite(const uint8_t *data, unsigned int len, bool sync);
  44
  45 int flashfsReadAbs(uint32_t offset, uint8_t *data, unsigned int len);
  46
  47 bool flashfsFlushAsync(void);
  48 void flashfsFlushSync(void);
  49
  50 void flashfsClose(void);
  51 void flashfsInit(void);
  52 bool flashfsIsSupported(void);
  53
  54 bool flashfsIsReady(void);
  55 bool flashfsIsEOF(void);
  56
  57 bool flashfsVerifyEntireFlash(void);
  58