Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 3.02 KB

nf-spb-spb_multi_spi_transfer_init.md

File metadata and controls

80 lines (63 loc) · 3.02 KB
UID tech.root title ms.date targetos description prerelease req.assembly req.construct-type req.ddi-compliance req.dll req.header req.idl req.include-header req.irql req.kmdf-ver req.lib req.max-support req.namespace req.redist req.target-min-winverclnt req.target-min-winversvr req.target-type req.type-library req.umdf-ver req.unicode-ansi topic_type api_type api_location api_name f1_keywords dev_langs
NF:spb.SPB_MULTI_SPI_TRANSFER_INIT
SPB
SPB_MULTI_SPI_TRANSFER_INIT
11/11/2021
Windows
The SPB_MULTI_SPI_TRANSFER_INIT function initializes an SPB_MULTI_SPI_TRANSFER structure.
false
function
spb.h
apiref
HeaderDef
spb.h
SPB_MULTI_SPI_TRANSFER_INIT
SPB_MULTI_SPI_TRANSFER_INIT
spb/SPB_MULTI_SPI_TRANSFER_INIT
c++

-description

The SPB_MULTI_SPI_TRANSFER_INIT function initializes an SPB_MULTI_SPI_TRANSFER structure.

-parameters

-param SpiTransfer

A pointer to the SPB_MULTI_SPI_TRANSFER structure that is to be initialized. This structure includes a single transfer phase - an additional transfer phase should be provided when using this function to initialize a two-phase read operation.

-param 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.

-param TransferPhaseCount

The number of phases in the multi-SPI transfer. For a read operation, this should be set to 2, representing a read phase, then a write phase. For a write operation, this should be set to 1, representing solely a write phase.

-param 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.

-param 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. This should be set to 0 if the transfer does not have a read phase.

-remarks

Typically, this function should not be called directly, instead SPB_MULTI_SPI_READ_TRANSFER_INIT or SPB_MULTI_SPI_WRITE_TRANSFER_INIT may be used as appropriate.

-see-also