SPI

SPI Driver API functions. More...

Collaboration diagram for SPI:

Functions
tr_hal_status_t	tr_hal_spi_init (tr_hal_spi_id_t spi_id, tr_hal_spi_settings_t *spi_settings)
tr_hal_status_t	tr_hal_spi_uninit (tr_hal_spi_id_t spi_id)
tr_hal_status_t	tr_hal_spi_settings_read (tr_hal_spi_id_t spi_id, tr_hal_spi_settings_t *spi_settings)
tr_hal_status_t	tr_hal_spi_raw_rx_one_byte (tr_hal_spi_id_t spi_id, uint8_t *byte)
tr_hal_status_t	tr_hal_spi_raw_rx_available_bytes (tr_hal_spi_id_t spi_id, char *bytes, uint16_t buffer_size, uint16_t *num_returned_bytes)
tr_hal_status_t	tr_hal_spi_raw_tx_one_byte (tr_hal_spi_id_t spi_id, uint8_t chip_select_index_to_use, char byte_to_send, bool receive_bytes)
tr_hal_status_t	tr_hal_spi_raw_tx_buffer (tr_hal_spi_id_t spi_id, uint8_t chip_select_index_to_use, char *bytes_to_send, uint16_t num_bytes_to_send, bool receive_bytes)
tr_hal_status_t	tr_hal_spi_dma_tx_bytes_in_buffer (tr_hal_spi_id_t spi_id, uint8_t chip_select_index_to_use, char *bytes_to_send, uint16_t num_bytes_to_send, bool receive_bytes)
tr_hal_status_t	tr_hal_spi_dma_receive_buffer_num_bytes_left (tr_hal_spi_id_t spi_id, uint32_t *bytes_left)
tr_hal_status_t	tr_hal_spi_dma_change_rx_buffer (tr_hal_spi_id_t spi_id, uint8_t *new_receive_buffer, uint16_t new_buffer_length)

Detailed Description

SPI Driver API functions.

---

---

---

---

Function Documentation

tr_hal_spi_dma_change_rx_buffer()

tr_hal_status_t tr_hal_spi_dma_change_rx_buffer	(	tr_hal_spi_id_t	spi_id,
		uint8_t *	new_receive_buffer,
		uint16_t	new_buffer_length )

tr_hal_spi_dma_receive_buffer_num_bytes_left()

tr_hal_status_t tr_hal_spi_dma_receive_buffer_num_bytes_left	(	tr_hal_spi_id_t	spi_id,
		uint32_t *	bytes_left )

---

-— SPI DMA receive -— to receive bytes with SPI, the app should check the receive buffer passed in

---

tr_hal_spi_dma_tx_bytes_in_buffer()

tr_hal_status_t tr_hal_spi_dma_tx_bytes_in_buffer	(	tr_hal_spi_id_t	spi_id,
		uint8_t	chip_select_index_to_use,
		char *	bytes_to_send,
		uint16_t	num_bytes_to_send,
		bool	receive_bytes )

---

-— SPI DMA transmit -—

---

tr_hal_spi_init()

tr_hal_status_t tr_hal_spi_init	(	tr_hal_spi_id_t	spi_id,
		tr_hal_spi_settings_t *	spi_settings )

---

-— init settings / uninit settings / read settings -—

---

tr_hal_spi_raw_rx_available_bytes()

tr_hal_status_t tr_hal_spi_raw_rx_available_bytes	(	tr_hal_spi_id_t	spi_id,
		char *	bytes,
		uint16_t	buffer_size,
		uint16_t *	num_returned_bytes )

tr_hal_spi_raw_rx_one_byte()

tr_hal_status_t tr_hal_spi_raw_rx_one_byte	(	tr_hal_spi_id_t	spi_id,
		uint8_t *	byte )

---

-— SPI receive APIs -—

---

tr_hal_spi_raw_tx_buffer()

tr_hal_status_t tr_hal_spi_raw_tx_buffer	(	tr_hal_spi_id_t	spi_id,
		uint8_t	chip_select_index_to_use,
		char *	bytes_to_send,
		uint16_t	num_bytes_to_send,
		bool	receive_bytes )

tr_hal_spi_raw_tx_one_byte()

tr_hal_status_t tr_hal_spi_raw_tx_one_byte	(	tr_hal_spi_id_t	spi_id,
		uint8_t	chip_select_index_to_use,
		char	byte_to_send,
		bool	receive_bytes )

---

-— SPI transmit APIs -—

---

tr_hal_spi_settings_read()

tr_hal_status_t tr_hal_spi_settings_read	(	tr_hal_spi_id_t	spi_id,
		tr_hal_spi_settings_t *	spi_settings )

tr_hal_spi_uninit()

tr_hal_status_t tr_hal_spi_uninit

(

tr_hal_spi_id_t

spi_id

)