The latest development version of this page may be more current than this released 2.3-beta.1 version.

SPI Master API Reference

SPI Master

enum WM_SPIM_TRANS_FLAG

Values:

enumerator SPI_TRANS_CS_KEEP_ACTIVE: if set, CS will keep active after transceive done

enumerator SPI_TRANS_BIG_ENDIAN: if set, transmit high address byte first in a word

enumerator SPI_TRANS_VARIABLE_CMD: if set, cmd and cmd_len will valid in spim_transceive_ex_t

enumerator SPI_TRANS_VARIABLE_ADDR: if set, addr and addr_len will valid in spim_transceive_ex_t

int wm_drv_spim_transceive_sync(wm_device_t *dev, const wm_dt_hw_spim_dev_cfg_t *config, spim_transceive_t *desc, uint32_t ms_to_wait)

transceive data synchronously, the api return until synchronously done or timeout

Parameters:

dev – [in] SPI device pointer
config – [in] Pointer to a valid wm_hw_spi_device_config_t structure instance.
desc – [in] transceive descrption about tx and rx
ms_to_wait – [in] the max wait time for transeceive done, unit is millisecon

Returns:

int wm_drv_spim_transceive_async(wm_device_t *dev, const wm_dt_hw_spim_dev_cfg_t *config, spim_transceive_t *desc, wm_spim_callback_t callback, void *usr_data)

transceive data asynchronously, callback will be trigger after transceive done

Parameters:

dev – [in] SPI device pointer
config – [in] Pointer to a valid wm_hw_spi_device_config_t structure instance.
desc – [in] transceive descrption about tx and rx
callback – [in] the function will be trigger after transceive done
usr_data – [in] the argument for callback function

Returns:

wm_device_t *wm_drv_spim_init(const char *dev_name)

Initialize SPI master driver.

Parameters:

dev_name – [in] spi master device name

Returns:

int wm_drv_spim_deinit(wm_device_t *dev)

deinit SPI master driver

Parameters:

dev – [in] SPI master device pointer

Returns: