src/main/drivers/flash_impl.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 /*
  22  * Author: jflyper
  23  */
  24
  25 #pragma once
  26
  27 #include "drivers/bus.h"
  28
  29 struct flashVTable_s;
  30
  31 typedef struct flashDevice_s {
  32     busDevice_t *busdev;
  33     const struct flashVTable_s *vTable;
  34     flashGeometry_t geometry;
  35     uint32_t currentWriteAddress;
  36     bool isLargeFlash;
  37     // Whether we've performed an action that could have made the device busy
  38     // for writes. This allows us to avoid polling for writable status
  39     // when it is definitely ready already.
  40     bool couldBeBusy;
  41 } flashDevice_t;
  42
  43 typedef struct flashVTable_s {
  44     bool (*isReady)(flashDevice_t *fdevice);
  45     bool (*waitForReady)(flashDevice_t *fdevice, uint32_t timeoutMillis);
  46     void (*eraseSector)(flashDevice_t *fdevice, uint32_t address);
  47     void (*eraseCompletely)(flashDevice_t *fdevice);
  48     void (*pageProgramBegin)(flashDevice_t *fdevice, uint32_t address);
  49     void (*pageProgramContinue)(flashDevice_t *fdevice, const uint8_t *data, int length);
  50     void (*pageProgramFinish)(flashDevice_t *fdevice);
  51     void (*pageProgram)(flashDevice_t *fdevice, uint32_t address, const uint8_t *data, int length);
  52     void (*flush)(flashDevice_t *fdevice);
  53     int (*readBytes)(flashDevice_t *fdevice, uint32_t address, uint8_t *buffer, int length);
  54     const flashGeometry_t *(*getGeometry)(flashDevice_t *fdevice);
  55 } flashVTable_t;