Edit

Share via

SPB_MULTI_SPI_READ_TRANSFER_INIT function (spb.h)

  • Article

The SPB_MULTI_SPI_READ_TRANSFER_INIT function initializes an SPB_MULTI_SPI_READ_TRANSFER structure.

Syntax

void SPB_MULTI_SPI_READ_TRANSFER_INIT(
  SPB_MULTI_SPI_READ_TRANSFER *SpiTransfer,
  SPB_MULTI_SPI_TRANSFER_MODE Mode,
  ULONG                       WritePhaseSingleSpiByteCount,
  ULONG                       WaitCycleByteCount
);

Parameters

SpiTransfer

A pointer to the SPB_MULTI_SPI_READ_TRANSFER structure that is to be initialized.

Mode

An SPB_MULTI_SPI_TRANSFER_MODE enumeration value, specifying the line mode of the multi-SPI transfer to be used by a bus driver to communicate with a peripheral device.

WritePhaseSingleSpiByteCount

The count of bytes at the beginning of the write phase to be transferred in single-SPI mode, before line mode switch to the mode specified in the Mode member of this struct.

WaitCycleByteCount

The number of wait cycles represented as the number of bytes, representing multi-SPI transfer cycles - e.g. 1 byte => 8 bits => 2 clock cycles in quad-SPI mode, between the write phase and read phase of the transfer. These wait cycle bytes should be present, and of an undefined value at the end of the WritePhaseBuffer.

Return value

None

Remarks

The SPB_MULTI_SPI_READ_TRANSFER_INIT function should be used to initialize multi-SPI read transfers. It initializes a SPB_MULTI_SPI_READ_TRANSFER structure with the two transfer phases required for a read operation.

Requirements

Requirement Value
Header spb.h

See also