1.1.8.4.15 DRV_SPI_TRANSFER_HANDLE Typedef

typedef uintptr_t DRV_SPI_TRANSFER_HANDLE;

Handle identifying the transfer request queued.

A transfer handle value is returned by a call to the DRV_SPI_ReadTransferAdd or DRV_SPI_WriteTransferAdd or DRV_SPI_WriteReadTransferAdd functions. This handle is associated with the transfer request passed into the function and it allows the application to track the completion of the transfer request. The transfer handle value returned from the "transfer add" function is returned back to the client by the "event handler callback" function registered with the driver.

This handle can also be used to poll the transfer completion status using DRV_SPI_TransferStatusGet API.

The transfer handle assigned to a client request expires when a new transfer request is made after the completion of the current request.

None