PSRAM64(H) pseudo-SRAM. More...

#include <PSRAM64.h>

Inheritance diagram for HSPI::RAM::PSRAM64:
Collaboration diagram for HSPI::RAM::PSRAM64:

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...
 
uint8_t readId ()
 
bool setIoMode (IoMode mode) override
 
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

PSRAM64(H) pseudo-SRAM.

Member Function Documentation

◆ begin()

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

Configure the RAM into a known operating mode.

◆ getSize()

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

Implements HSPI::MemoryDevice.

◆ getSupportedIoModes()

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

Return set of IO modes supported by a device implementation.

Implements HSPI::Device.

◆ prepareRead()

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

Prepare without buffer.

Implements HSPI::MemoryDevice.

◆ prepareWrite()

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

Prepare request without data.

Implements HSPI::MemoryDevice.

◆ readId()

uint8_t HSPI::RAM::PSRAM64::readId ( )
inline

◆ setIoMode()

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

Reimplemented from HSPI::Device.


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