SectorDevice.h

 
#ifndef MFRAME_1627DA37_C8B8_4F57_8873_E86DB3A5093D
#define MFRAME_1627DA37_C8B8_4F57_8873_E86DB3A5093D
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------------
#include "./../Base.h"
 
/* ***************************************************************************************
 * Namespace
 */
namespace hal::storage {
  struct SectorDevice;
}  // namespace hal::storage
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
 
struct hal::storage::SectorDevice : public hal::Base {
  /* *************************************************************************************
   * Class/Interface/Struct/Enum
   */
  enum struct Status : uint8;
 
  /* *************************************************************************************
   * Method
   */
  virtual uint32 pageSize(void) const abstract;
 
  virtual uint32 pageCount(void) const abstract;
 
  virtual uint32 sectorCount(void) const abstract;
 
  virtual Status read(uint32 address, void* buffer) abstract;
 
  virtual Status write(uint32 address, const void* buffer) abstract;
 
  virtual Status erase(uint32 address) abstract;
 
  /* *************************************************************************************
   * Default Method
   */
 
  inline uint32 sectorSize(void) const {
    return this->pageSize() * this->pageCount();
  }
 
  inline uint32 totalSize(void) const {
    return this->sectorSize() * this->sectorCount();
  }
 
  inline Status readPage(uint32 page, void* buffer) {
    return this->read(page * this->pageSize(), buffer);
  }
 
  inline Status writePage(uint32 page, const void* buffer) {
    return this->write(page * this->pageSize(), buffer);
  }
 
  inline Status eraseSector(uint32 sector) {
    return this->erase(sector * this->sectorSize());
  }
};
 
enum struct hal::storage::SectorDevice::Status : uint8 {
  OK             = 0x00,  
  ERROR          = 0x01,  
  NOT_SUPPORTED  = 0x02,  
  OUT_OF_BOUNDS  = 0x03,  
  TIMEOUT        = 0x04,  
  NOT_RAM_SOURCE = 0x05,  
  NOT_ALIGNED    = 0x06   
};
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MFRAME_1627DA37_C8B8_4F57_8873_E86DB3A5093D */