src/main/drivers/persistent.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 #include <stdint.h>
  24
  25 // Available RTC backup registers (4-byte words) per MCU type
  26 // F4: 20 words
  27 // F7: 32 words
  28 // H7: 32 words
  29
  30 typedef enum {
  31     PERSISTENT_OBJECT_MAGIC = 0,
  32     PERSISTENT_OBJECT_RESET_REASON,
  33     PERSISTENT_OBJECT_COUNT,
  34 } persistentObjectId_e;
  35
  36 // Values for PERSISTENT_OBJECT_RESET_REASON
  37 #define RESET_NONE                                      0
  38 #define RESET_BOOTLOADER_REQUEST_ROM                    1  // DFU request
  39 #define RESET_MSC_REQUEST                               2  // MSC invocation was requested
  40 #define RESET_BOOTLOADER_FIRMWARE_UPDATE                3  // Bootloader request to flash stored firmware update
  41 #define RESET_BOOTLOADER_FIRMWARE_ROLLBACK              4  // Bootloader request to rollback to stored firmware and config backup
  42 #define RESET_BOOTLOADER_FIRMWARE_UPDATE_SUCCESS        5
  43 #define RESET_BOOTLOADER_FIRMWARE_UPDATE_FAILED         6
  44
  45 void persistentObjectInit(void);
  46 uint32_t persistentObjectRead(persistentObjectId_e id);
  47 void persistentObjectWrite(persistentObjectId_e id, uint32_t value);