storage.h

// SPDX-FileCopyrightText: AC SOFTWARE SP. Z O.O.
// SPDX-License-Identifier: GPL-2.0-or-later
 
#ifndef SRC_SUPLA_STORAGE_STORAGE_H_
#define SRC_SUPLA_STORAGE_STORAGE_H_
 
#include <stdint.h>
 
#define SUPLA_STORAGE_VERSION 1
 
#define STORAGE_SECTION_TYPE_DEVICE_CONFIG           1
#define STORAGE_SECTION_TYPE_ELEMENT_CONFIG          2
#define STORAGE_SECTION_TYPE_ELEMENT_STATE           3
#define STORAGE_SECTION_TYPE_ELEMENT_STATE_WL_BYTE   4
#define STORAGE_SECTION_TYPE_ELEMENT_STATE_WL_SECTOR 5
 
namespace Supla {
 
class Config;
class SpecialSectionInfo;
class StateStorageInterface;
 
class Storage {
 public:
  static bool storageInitDone;
 
  enum class WearLevelingMode {
    OFF = 0,
    BYTE_WRITE_MODE = 1,   // Used i.e. for EEPROM memory
    SECTOR_WRITE_MODE = 2  // Used i.e. for FLASH memory
  };
 
  friend class StateStorageInterface;
  static Storage *Instance();
  static Config *ConfigInstance();
  static void SetConfigInstance(Config *instance);
  static bool IsConfigStorageAvailable();
 
  static bool Init();
  static bool SaveStateAllowed(uint32_t);
  static void ScheduleSave(uint32_t delayMsMax, uint32_t delayMsMin = 0);
  static bool IsStateStorageValid();
  static void LoadStateStorage();
  static void WriteStateStorage();
 
  static bool ReadState(unsigned char *, int);
  static bool WriteState(const unsigned char *, int);
 
  static void EraseSector(unsigned int offset, int size);
 
  // Register special section in storage data (outside of State storage)
  // sectionId - user selected sectionId
  // offset - storage memory offset - absolute value. Please make sure that it
  // doesn't overlap with other sections and state section
  // size - amount of bytes reserved
  // addCrc - tell if Storage class should add CRC at the end of section
  // Actual size of section is size + 2 bytes for CRC (if enabled)
  static bool RegisterSection(int sectionId, int offset, int size,
      bool addCrc, bool addBackupCopy);
  // Reads data section. Returns false when size doesn't match and when crc
  // check failed (if enabled)
  static bool ReadSection(int sectionId, unsigned char *data, int size);
  // Writes data section. Returns false when size doesn't match with
  // registration info
  static bool WriteSection(int sectionId, const unsigned char *data, int size);
  // Delete content of section
  static bool DeleteSection(int sectionId);
 
  explicit Storage(unsigned int storageStartingOffset = 0,
                   unsigned int availableSize = 0,
                   enum WearLevelingMode = WearLevelingMode::OFF);
  virtual ~Storage();
 
  // Changes default state save period time
  virtual void setStateSavePeriod(uint32_t periodMs);
 
  virtual void deleteAll();
  virtual void eraseSector(unsigned int address, int size);
 
  void enableChannelNumbers();
  bool isAddChannelNumbersEnabled() const;
 
  void setDeleteAllMethodEnabled(bool value);
 
 protected:
  virtual bool init();
  bool getInitResult() const;
  virtual int readStorage(unsigned int address,
                          unsigned char *buf,
                          unsigned int size,
                          bool logs = true) = 0;
  virtual int writeStorage(unsigned int address,
                           const unsigned char *buf,
                           unsigned int size) = 0;
  virtual void commit() = 0;
 
  virtual int updateStorage(unsigned int, const unsigned char *, int);
 
  virtual bool saveStateAllowed(uint32_t);
  virtual void scheduleSave(uint32_t delayMsMax, uint32_t delayMsMin);
 
  bool registerSection(
      int sectionId, int offset, int size, bool addCrc, bool addBackupCopy);
  bool readSection(int sectionId, unsigned char *data, int size);
  bool writeSection(int sectionId, const unsigned char *data, int size);
  bool deleteSection(int sectionId);
 
  static void WriteElementsState();
 
  const uint32_t storageStartingOffset = 0;
  const uint32_t availableSize = 0;
  const enum WearLevelingMode wearLevelingMode = WearLevelingMode::OFF;
 
  uint32_t saveStatePeriod = 1000;
  uint32_t lastWriteTimestamp = 0;
 
  SpecialSectionInfo *firstSectionInfo = nullptr;
  StateStorageInterface *stateStorage = nullptr;
 
  static Storage *instance;
  static Config *configInstance;
  bool addChannelNumbers = false;
  bool deleteAllMethodEnabled = true;
  bool initResult = false;
};
 
#pragma pack(push, 1)
struct Preamble {
  unsigned char suplaTag[5];
  uint16_t version;
  uint8_t sectionsCount;
};
 
struct SectionPreamble {
  uint8_t type;
  uint16_t size;
  uint16_t crc1;
  uint16_t crc2;
};
#pragma pack(pop)
 
};  // namespace Supla
 
#endif  // SRC_SUPLA_STORAGE_STORAGE_H_