Function esp_idf_svc::hal::sys::spi_slave_get_trans_result

source ·
pub unsafe extern "C" fn spi_slave_get_trans_result(
    host: u32,
    trans_desc: *mut *mut spi_slave_transaction_t,
    ticks_to_wait: u32,
) -> i32
Expand description

@brief Get the result of a SPI transaction queued earlier

This routine will wait until a transaction to the given device (queued earlier with spi_slave_queue_trans) has succesfully completed. It will then return the description of the completed transaction so software can inspect the result and e.g. free the memory or re-use the buffers.

It is mandatory to eventually use this function for any transaction queued by spi_slave_queue_trans.

@param host SPI peripheral to that is acting as a slave @param[out] trans_desc Pointer to variable able to contain a pointer to the description of the transaction that is executed @param ticks_to_wait Ticks to wait until there’s a returned item; use portMAX_DELAY to never time out. @return - ESP_ERR_INVALID_ARG if parameter is invalid - ESP_ERR_NOT_SUPPORTED if flag SPI_SLAVE_NO_RETURN_RESULT is set - ESP_OK on success