S25FL127S.hh

Go to the documentation of this file.

#ifndef COSA_S25FL127S_HH
#define COSA_S25FL127S_HH

#include "Cosa/Types.h"
#include "Cosa/SPI.hh"
#include "Cosa/Flash.hh"

class S25FL127S : public Flash::Device, protected SPI::Driver {
public:
  static const size_t PAGE_MAX = 256;
  static const size_t PAGE_MASK = PAGE_MAX - 1;

#if !defined(BOARD_ATTINYX5)
  S25FL127S(Board::DigitalPin csn = Board::D5) :
    Flash::Device(64 * 1024L, 256),
    SPI::Driver(csn, SPI::ACTIVE_LOW, SPI::DIV2_CLOCK, 0, SPI::MSB_ORDER, NULL)
  {}
#else
  S25FL127S(Board::DigitalPin csn = Board::D3) :
    Flash::Device(64 * 1024L, 256),
    SPI::Driver(csn, SPI::ACTIVE_LOW, SPI::DIV2_CLOCK, 0, SPI::MSB_ORDER, NULL)
  {}
#endif

  virtual bool begin();

  virtual bool is_ready();

  virtual int read(void* dest, uint32_t src, size_t size);

  virtual int erase(uint32_t dest, uint8_t size = 4);

  virtual int write(uint32_t dest, const void* src, size_t size);

  virtual int write_P(uint32_t dest, const void* buf, size_t size);

  union config_t {
    uint8_t as_uint8;           
    struct {                    
      uint8_t FREEZE:1;         
      uint8_t QUAD:1;           
      uint8_t TBPARAM:1;        
      uint8_t BPNV:1;           
      uint8_t RFU:1;            
      uint8_t TBPROT:1;         
      uint8_t LC:2;             
    };
    config_t(uint8_t value = 0)
    {
      as_uint8 = value;
    }
    operator uint8_t()
    {
      return (as_uint8);
    }
  };

  uint8_t read_config()
  {
    return (issue(RDCR));
  }

  union status1_t {
    uint8_t as_uint8;           
    struct {                    
      uint8_t WIP:1;            
      uint8_t WEL:1;            
      uint8_t BP:3;             
      uint8_t E_ERR:1;          
      uint8_t P_ERR:1;          
      uint8_t SRWD:1;           
    };
    status1_t(uint8_t value = 0)
    {
      as_uint8 = value;
    }
    operator uint8_t()
    {
      return (as_uint8);
    }
  };

  uint8_t read_status1()
  {
    return (issue(RDSR1));
  }

  union status2_t {
    uint8_t as_uint8;           
    struct {                    
      uint8_t PS:1;             
      uint8_t ES:1;             
      uint8_t RFU:3;            
      uint8_t IO3:1;            
      uint8_t PBW:1;            
      uint8_t BES:1;            
    };
    status2_t(uint8_t value = 0)
    {
      as_uint8 = value;
    }
    operator uint8_t()
    {
      return (as_uint8);
    }
  };

  uint8_t read_status2()
  {
    return (issue(RDSR2));
  }

protected:
  enum Command {
    READ_ID = 0x90,             
    RDRID = 0x9f,               
    RSFDP = 0x5a,               
    RES = 0xab,                 

    RDSR1 = 0x05,               
    RDSR2 = 0x07,               
    RDCR = 0x35,                
    WRR = 0x01,                 
    WRDI = 0x04,                
    WREN = 0x06,                
    CLSR = 0x30,                
    ABRD = 0x14,                
    ABWR = 0x15,                
    BRRD = 0x16,                
    BRWR = 0x17,                
    BRAC = 0x89,                
    DLPRD = 0x41,               
    PNVDLR = 0x43,              
    WVDLR = 0x4A,               

    READ = 0x03,                
    READ4 = 0x13,               
    FAST_READ = 0x0b,           
    FAST_READ4 = 0x0c,          
    DOR = 0x3b,                 
    DOR4 = 0x3c,                
    QOR = 0x6b,                 
    QOR4 = 0x6c,                
    DIOR = 0xbb,                
    DIOR4 = 0xbc,               
    QIOR = 0xeb,                
    QIOR4 = 0xec,               

    PP = 0x02,                  
    PP4 = 0x12,                 
    QPP = 0x32,                 
    QPP4 = 0x34,                
    PGSP = 0x85,                
    PGRS = 0x8a,                

    P4E = 0x20,                 
    P4E4 = 0x21,                
    BER = 0x60,                 
    SER = 0xd8,                 
    SER4 = 0xdc,                
    ERSP = 0x75,                
    ERRS = 0x7a,                

    OTPP = 0x42,                
    OTPR = 0x4b,                

    DYBRD = 0xe0,               
    DYBWR = 0xe1,               
    PPBRD = 0xe2,               
    PPBP = 0xe3,                
    PPBE = 0xe4,                
    ASPRD = 0x2b,               
    ASPP = 0x2f,                
    PLBRD = 0xa7,               
    PLBWR = 0xa6,               
    PASSRD = 0xe7,              
    PASSP = 0xe8,               
    PASSU = 0xe9,               

    RESET = 0xf0,               
    MBR = 0xff                  
  } __attribute__((packed));

  static const uint8_t MANUFACTURER = 0x01;

  static const uint8_t DEVICE = 0x17;

  uint8_t issue(Command cmd);

  status1_t m_status;
};

#endif