Adafruit_FRAM_SPI.h

Go to the documentation of this file.

#ifndef _ADAFRUIT_FRAM_SPI_H_
#define _ADAFRUIT_FRAM_SPI_H_

#include <Adafruit_SPIDevice.h>
#include <Arduino.h>
#include <SPI.h>

typedef enum opcodes_e {
  OPCODE_WREN = 0b0110,    /* Write Enable Latch */
  OPCODE_WRDI = 0b0100,    /* Reset Write Enable Latch */
  OPCODE_RDSR = 0b0101,    /* Read Status Register */
  OPCODE_WRSR = 0b0001,    /* Write Status Register */
  OPCODE_READ = 0b0011,    /* Read Memory */
  OPCODE_WRITE = 0b0010,   /* Write Memory */
  OPCODE_RDID = 0b10011111 /* Read Device ID */
} opcodes_t;

class Adafruit_FRAM_SPI {
public:
  Adafruit_FRAM_SPI(int8_t cs, SPIClass *theSPI = &SPI,
                    uint32_t freq = 1000000);
  Adafruit_FRAM_SPI(int8_t clk, int8_t miso, int8_t mosi, int8_t cs);

  bool begin(uint8_t nAddressSizeBytes = 2);
  bool writeEnable(bool enable);
  bool write8(uint32_t addr, uint8_t value);
  bool write(uint32_t addr, const uint8_t *values, size_t count);
  uint8_t read8(uint32_t addr);
  bool read(uint32_t addr, uint8_t *values, size_t count);
  bool getDeviceID(uint8_t *manufacturerID, uint16_t *productID);
  uint8_t getStatusRegister(void);
  bool setStatusRegister(uint8_t value);
  void setAddressSize(uint8_t nAddressSize);

private:
  Adafruit_SPIDevice *spi_dev = NULL;
  uint8_t _nAddressSizeBytes;
};

#endif