Module esp_idf_hal::spi

SPI peripheral control

SPI0 is reserved for accessing flash and sram and therefore not usable for other purposes. SPI1 shares its external pins with SPI0 and therefore has severe restrictions in use.

SPI2 & 3 can be used freely.

The CS pin can be controlled by hardware on esp32 variants (contrary to the description of embedded_hal).

Look at the following table to determine which driver best suits your requirements:

		SpiDeviceDriver::new	SpiDeviceDriver::new (no CS)	SpiSoftCsDeviceDriver::new	SpiBusDriver::new
	Managed CS	Hardware	N	Software triggered	N
	1 device	Y	Y	Y	Y
	1-3 devices	Y	N	Y	N
	4-6 devices	Only on esp32CX	N	Y	N
	More than 6	N	N	Y	N
	DMA	N	N	N	N
	Polling transmit	Y	Y	Y	Y
	ISR transmit	Y	Y	Y	Y
	Async support*	Y	Y	Y	Y

• True non-blocking async possible only when all devices attached to the SPI bus are used in async mode (i.e. calling methods xxx_async() instead of their blocking xxx() counterparts)

The [Transfer::transfer], [Write::write] and [WriteIter::write_iter] functions lock the APB frequency and therefore the requests are always run at the requested baudrate. The primitive [FullDuplex::read] and [FullDuplex::send] do not lock the APB frequency and therefore may run at a different frequency.

TODO

• Quad SPI
• Slave SPI

Modules

• config
  SPI configuration

Structs

• SPI1
• SPI2
• SpiBusDriver
• SpiDeviceDriver
• SpiDriver
• SpiError
• SpiSharedDeviceDriver
• SpiSoftCsDeviceDriver

Enums

• Dma
• Operation
  SPI transaction operation.

Traits

• Spi
• SpiAnyPins
  A marker interface implemented by all SPI peripherals except SPI1 which should use a fixed set of pins

Type Aliases

• SpiConfig
• SpiDriverConfig
• SpiSingleDeviceDriver