SPIFlash.hxx

Go to the documentation of this file.

 
#ifndef _FREERTOS_DRIVERS_COMMON_SPIFLASH_HXX_
#define _FREERTOS_DRIVERS_COMMON_SPIFLASH_HXX_
 
#include <inttypes.h>
#include <spi/spidev.h>
#include <sys/types.h>
 
#include "utils/logging.h"
 
class OSMutex;
class SPI;
 
struct SPIFlashConfig
{
    uint32_t speedHz_ {1000000};
 
    uint32_t sectorSize_ {4 * 1024};
 
    uint32_t pageSizeMask_ {~(256u - 1)};
 
    uint8_t spiMode_ {SPI_MODE_0};
 
    uint8_t idCommand_ {0x9F};
    uint8_t readCommand_ {0x03};
    uint8_t writeEnableCommand_ {0x06};
    uint8_t writeCommand_ {0x02};
    uint8_t eraseCommand_ {0x20};
    uint8_t chipEraseCommand_ {0x60};
 
    uint8_t statusReadCommand_ {0x05};
    uint8_t statusWritePendingBit_ {0x01};
 
    uint8_t readNeedsStuffing_ : 1;
};
 
class SPIFlash
{
public:
    SPIFlash(const SPIFlashConfig *cfg, OSMutex *lock)
        : cfg_(cfg)
        , lock_(lock)
    {
        HASSERT((cfg->sectorSize_ & (cfg->sectorSize_ - 1)) == 0);
    }
 
    const SPIFlashConfig &cfg()
    {
        return *cfg_;
    }
 
    void init(const char *dev_name);
 
    void write(uint32_t addr, const void *buf, size_t len);
 
    void read(uint32_t addr, void *buf, size_t len);
 
    uint32_t next_sector_address(uint32_t addr)
    {
        return (addr + cfg_->sectorSize_ - 1) & ~(cfg_->sectorSize_ - 1);
    }
 
    void erase(uint32_t addr, size_t len);
 
    void chip_erase();
 
    void get_id(char id_out[3]);
 
private:
    unsigned wait_for_write();
 
    const SPIFlashConfig *cfg_;
 
    OSMutex *lock_;
 
    int spiFd_ {-1};
    SPI *spi_;
};
 
#endif // _FREERTOS_DRIVERS_COMMON_SPIFLASH_HXX_