SPI Hardware support

Provides hardware SPI support. More...

Namespaces

 HSPI
 

Classes

class  SPIClass
 Hardware SPI class. More...
 
struct  HSPI::Data
 Specifies a block incoming or outgoing data. More...
 
class  HSPI::Device
 Manages a specific SPI device instance attached to a controller. More...
 
class  HSPI::MemoryDevice
 Base class for read/write addressable devices. More...
 
class  HSPI::RAM::IS62_65
 IS62/65WVS2568GALL fast serial RAM. More...
 
class  HSPI::RAM::PSRAM64
 PSRAM64(H) pseudo-SRAM. More...
 
struct  HSPI::Request
 Defines an SPI Request Packet. More...
 
class  HSPI::StreamAdapter
 Helper class for streaming data to/from SPI devices. More...
 

Typedefs

using HSPI::Callback = bool(*)(Request &request)
 SPI completion callback routine. More...
 

Enumerations

enum  SpiBus {
  SpiBus::INVALID = 0, SpiBus::MIN = 1, SpiBus::SPI1 = 1, SpiBus::FSPI = 1,
  SpiBus::SPI2 = 2, SpiBus::HSPI = 2, SpiBus::MAX = SOC_SPI_PERIPH_NUM, SpiBus::DEFAULT = SPI2,
  SpiBus::INVALID = 0, SpiBus::MIN = 1, SpiBus::SPI1 = 1, SpiBus::MAX = 1,
  SpiBus::DEFAULT = SPI1, SpiBus::INVALID = 0, SpiBus::MIN = 1, SpiBus::SPI1 = 1,
  SpiBus::SPI2 = 2, SpiBus::SPI3 = 3, SpiBus::MAX = SOC_SPI_PERIPH_NUM, SpiBus::DEFAULT = SPI1,
  SpiBus::INVALID = 0, SpiBus::MIN = 1, SpiBus::SPI1 = 1, SpiBus::SPI2 = 2,
  SpiBus::MAX = SOC_SPI_PERIPH_NUM, SpiBus::DEFAULT = SPI1
}
 Identifies bus selection. More...
 

Variables

SPIClass SPI
 Global instance of SPI class. More...
 

Detailed Description

Provides hardware SPI support.

Typedef Documentation

◆ Callback

using HSPI::Callback = typedef bool (*)(Request& request)

SPI completion callback routine.

Parameters
request
Return values
boolReturn true if request is finished, false to re-queue it immediately

Enumeration Type Documentation

◆ SpiBus

enum SpiBus
strong

Identifies bus selection.

Enumerator
INVALID 
MIN 
SPI1 
FSPI 
SPI2 
HSPI 
MAX 
DEFAULT 
INVALID 
MIN 
SPI1 
MAX 
DEFAULT 
INVALID 
MIN 
SPI1 
SPI2 
SPI3 
MAX 
DEFAULT 
INVALID 
MIN 
SPI1 
SPI2 
MAX 
DEFAULT 

Variable Documentation

◆ SPI

SPIClass SPI

Global instance of SPI class.