IS62/65WVS2568GALL fast serial RAM. More...

#include <IS62-65.h>

Inheritance diagram for HSPI::RAM::IS62_65:
Collaboration diagram for HSPI::RAM::IS62_65:

Public Types

enum class  OpMode { Byte = 0x00 , Page = 0x80 , Sequential = 0x40 }
 Memory operating mode determines how read/write operations are performed. More...
 

Public Member Functions

size_t getSize () const override
 
IoModes getSupportedIoModes () const override
 Return set of IO modes supported by a device implementation. More...
 
bool begin (PinSet pinSet, uint8_t chipSelect, uint32_t clockSpeed)
 Configure the RAM into a known operating mode. More...
 
bool setIoMode (IoMode mode) override
 
void setOpMode (OpMode mode)
 
OpMode getOpMode () const
 Get current operating mode (cached value) More...
 
OpMode readOpMode ()
 Read current operating mode from device. More...
 
void prepareWrite (HSPI::Request &req, uint32_t address) override
 Prepare request without data. More...
 
void prepareRead (HSPI::Request &req, uint32_t address) override
 Prepare without buffer. More...
 
- Public Member Functions inherited from HSPI::MemoryDevice
void write (uint32_t address, const void *data, size_t len)
 Write a block of data. More...
 
void write (Request &req, uint32_t address, const void *data, size_t len, Callback callback=nullptr, void *param=nullptr)
 
void write8 (uint32_t address, uint8_t value)
 
void write8 (Request &req, uint32_t address, uint8_t value, Callback callback=nullptr, void *param=nullptr)
 
void write16 (uint32_t address, uint16_t value)
 
void write16 (Request &req, uint32_t address, uint16_t value, Callback callback=nullptr, void *param=nullptr)
 
void write32 (uint32_t address, uint32_t value)
 
void write32 (Request &req, uint32_t address, uint32_t value, Callback callback=nullptr, void *param=nullptr)
 
void writeWord (Request &req, uint32_t address, uint32_t value, unsigned byteCount)
 
void read (uint32_t address, void *buffer, size_t len)
 Read a block of data. More...
 
uint8_t read8 (uint32_t address)
 
uint16_t read16 (uint32_t address)
 
uint32_t read32 (uint32_t address)
 
uint32_t readWord (uint32_t address, unsigned byteCount)
 
void read (Request &req, uint32_t address, void *buffer, size_t len, Callback callback=nullptr, void *param=nullptr)
 
 Device (Controller &controller)
 
void prepareWrite (HSPI::Request &req, uint32_t address, const void *data, size_t len)
 Prepare request with data. More...
 
void prepareRead (HSPI::Request &req, uint32_t address, void *buffer, size_t len)
 Prepare with buffer. More...
 
- Public Member Functions inherited from HSPI::Device
 Device (Controller &controller)
 
virtual ~Device ()
 
bool begin (PinSet pinSet, uint8_t chipSelect, uint32_t clockSpeed)
 Register device with controller and prepare for action. More...
 
void end ()
 
bool isReady () const
 Determine if the device is initialised. More...
 
PinSet getPinSet () const
 
uint8_t getChipSelect () const
 
uint32_t getSpeed () const
 
void setBitOrder (BitOrder bitOrder)
 
BitOrder getBitOrder () const
 
void setClockMode (ClockMode mode)
 
ClockMode getClockMode () const
 
bool isSupported (IoMode mode) const
 Determine if the device/controller combination supports an IO mode Must be called after begin() as other settings (e.g. pinset) can affect support. More...
 
IoMode getIoMode () const
 
size_t getBitsPerClock () const
 
void execute (Request &request)
 
void onTransfer (Callback callback)
 Set a callback to be invoked before a request is started, and when it has finished. More...
 
void wait (Request &request)
 

Additional Inherited Members

- Public Attributes inherited from HSPI::Device
Controllercontroller
 
- Protected Member Functions inherited from HSPI::Device
void transferStarting (Request &request)
 
bool transferComplete (Request &request)
 
- Protected Attributes inherited from HSPI::Device
friend Controller
 

Detailed Description

IS62/65WVS2568GALL fast serial RAM.

Member Enumeration Documentation

◆ OpMode

Memory operating mode determines how read/write operations are performed.

Enumerator
Byte 

Limited to one byte.

Page 

Limited to single 32-bit page.

Sequential 

Access entire memory array (DEFAULT)

Member Function Documentation

◆ begin()

bool HSPI::RAM::IS62_65::begin ( PinSet  pinSet,
uint8_t  chipSelect,
uint32_t  clockSpeed 
)
inline

Configure the RAM into a known operating mode.

◆ getOpMode()

OpMode HSPI::RAM::IS62_65::getOpMode ( ) const
inline

Get current operating mode (cached value)

Return values
OpModeNo device access is performed.

◆ getSize()

size_t HSPI::RAM::IS62_65::getSize ( ) const
inlineoverridevirtual

Implements HSPI::MemoryDevice.

◆ getSupportedIoModes()

IoModes HSPI::RAM::IS62_65::getSupportedIoModes ( ) const
inlineoverridevirtual

Return set of IO modes supported by a device implementation.

Implements HSPI::Device.

◆ prepareRead()

void HSPI::RAM::IS62_65::prepareRead ( HSPI::Request req,
uint32_t  address 
)
inlineoverridevirtual

Prepare without buffer.

Implements HSPI::MemoryDevice.

◆ prepareWrite()

void HSPI::RAM::IS62_65::prepareWrite ( HSPI::Request req,
uint32_t  address 
)
inlineoverridevirtual

Prepare request without data.

Implements HSPI::MemoryDevice.

◆ readOpMode()

OpMode HSPI::RAM::IS62_65::readOpMode ( )
inline

Read current operating mode from device.

Return values
OpMode

◆ setIoMode()

bool HSPI::RAM::IS62_65::setIoMode ( IoMode  mode)
inlineoverridevirtual

Reimplemented from HSPI::Device.

◆ setOpMode()

void HSPI::RAM::IS62_65::setOpMode ( OpMode  mode)
inline

The documentation for this class was generated from the following file: