SPI驱动API描述

hal_status_t hal_spi_init(spi_handle_t *p_spi)

根据spi_init_t里的参数初始化SPI外设和初始化关联句柄。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

HAL状态。

hal_status_t hal_spi_deinit(spi_handle_t *p_spi)

反初始化SPI外设。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

HAL状态。

void hal_spi_msp_init(spi_handle_t *p_spi)

初始化SPI所使用的GPIO引脚复用、NVIC中断、DMA通道等配置。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

无

该函数为weak类型的空函数，开发者需重写该API完成GPIO引脚复用、NVIC中断、DMA通道的初始化。

void hal_spi_msp_deinit(spi_handle_t *p_spi)

反初始化SPI所使用的GPIO引脚复用、NVIC中断、DMA通道等配置。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

无

该函数为weak类型的空函数，开发者需重写该API完成GPIO引脚复用、NVIC中断、DMA通道的反初始化。

hal_status_t hal_spi_transmit(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length, uint32_t timeout)

发送大量数据，轮询方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_data：指向数据缓冲区的指针。

length：待发送数据的长度。

timout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_spi_get_error()获取具体的错误码。

hal_status_t hal_spi_receive(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length, uint32_t timeout)

接收大量数据，轮询方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_data：指向数据缓冲区的指针。

length：待接收数据的长度。

timout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_spi_get_error()获取具体的错误码。

hal_status_t hal_spi_transmit_receive(spi_handle_t *p_spi, uint8_t *p_tx_data, uint8_t *p_rx_data, uint32_t length, uint32_t timeout)

发送和接收大量数据，全双工，轮询方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_tx_data：指向发送数据缓冲区的指针。

p_rx_data：指向接收数据缓冲区的指针。

length：待发送和接收数据的长度。

timout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_spi_get_error()获取具体的错误码。

hal_status_t hal_spi_read_eeprom(spi_handle_t *p_spi, uint8_t *p_tx_data, uint8_t *p_rx_data, uint32_t tx_number_data, uint32_t rx_number_data, uint32_t timeout)

读取EEPROM中的数据，半双工，轮询方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_tx_data：指向发送数据缓冲区的指针。

p_rx_data：指向接收数据缓冲区的指针。

tx_number_data：待发送数据的长度。

rx_number_data：待接收数据的长度。

timout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_spi_get_error()获取具体的错误码。

hal_status_t hal_spi_transmit_it(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length)

发送大量数据，中断方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_data：指向数据缓冲区的指针。

length：待发送数据的长度。

HAL状态。

hal_status_t hal_spi_receive_it(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length)

接收大量数据，中断方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_data：指向数据缓冲区的指针。

length：待接收数据的长度。

HAL状态

hal_status_t hal_spi_transmit_receive_it(spi_handle_t *p_spi, uint8_t *p_tx_data, uint8_t *p_rx_data, uint32_t length)

发送和接收大量数据，全双工，中断方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息

p_tx_data：指向发送数据缓冲区的指针。

p_rx_data：指向接收数据缓冲区的指针。

length：待发送和接收数据的长度。

HAL状态。

hal_status_t hal_spi_read_eeprom_it(spi_handle_t *p_spi, uint8_t *p_tx_data, uint8_t *p_rx_data, uint32_t tx_number_data, uint32_t rx_number_data)

读取EEPROM中的数据，半双工，中断方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_tx_data：指向发送数据缓冲区的指针。

p_rx_data：指向接收数据缓冲区的指针。

tx_number_data：待发送数据的长度。

rx_number_data：待接收数据的长度。

HAL状态。

hal_status_t hal_spi_transmit_dma(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length)

发送大量数据，DMA方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_data：指向数据缓冲区的指针。

length：待发送数据的长度。

HAL状态。

hal_status_t hal_spi_receive_dma(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length)

接收大量数据，DMA方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_data：指向数据缓冲区的指针。

length：待接收数据的长度。

HAL状态。

hal_status_t hal_spi_transmit_receive_dma(spi_handle_t *p_spi, uint8_t *p_tx_data, uint8_t *p_rx_data, uint32_t length)

发送和接收大量数据，全双工，DMA方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_tx_data：指向发送数据缓冲区的指针。

p_rx_data：指向接收数据缓冲区的指针。

length：待发送和接收数据的长度。

HAL状态

hal_status_t hal_spi_read_eeprom_dma(spi_handle_t *p_spi, uint8_t *p_tx_data, uint8_t *p_rx_data, uint32_t tx_number_data, uint32_t rx_number_data)

读取EEPROM中的数据，半双工，DMA方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

p_tx_data：指向发送数据缓冲区的指针。

p_rx_data：指向接收数据缓冲区的指针。

tx_number_data：待发送数据的长度。

rx_number_data：待接收数据的长度。

HAL状态

hal_status_t hal_spi_abort(spi_handle_t *p_spi)

中止中断及DMA方式下的数据传输，轮询方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

HAL状态。

该函数为轮询式函数，传输中止完成后退出函数。

hal_status_t hal_spi_abort_it(spi_handle_t *p_spi)

中止中断及DMA方式下的数据传输，中断方式。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

HAL状态。

该函数为非轮询式函数，使能收发中断后，该函数立即返回。TX_ABRT中断触发后中止完成，此时hal_spi_abort_cplt_callback()将会被调用。

void hal_spi_irq_handler(spi_handle_t *p_spi)

处理SPI中断请求。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

无

void hal_spi_tx_cplt_callback(spi_handle_t *p_spi)

发送完成中断回调函数。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_spi_rx_cplt_callback(spi_handle_t *p_spi)

接收完成中断回调函数。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_spi_tx_rx_cplt_callback(spi_handle_t *p_spi)

收发完成中断回调函数。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_spi_error_callback(spi_handle_t *p_spi)

SPI错误回调函数。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_spi_abort_cplt_callback(spi_handle_t *p_spi)

SPI中止完成回调函数。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

hal_spi_state_t hal_spi_get_state(spi_handle_t *p_spi)

获取SPI运行状态。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

uint32_t hal_spi_get_error(spi_handle_t *p_spi)

获取SPI错误码。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

void hal_spi_set_timeout(spi_handle_t *p_spi, uint32_t timeout)

设置SPI内部API的超时时间。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

timeout：超时时间（ms）。

无

hal_status_t hal_spi_set_tx_fifo_threshold(spi_handle_t *p_spi, uint32_t threshold)

设置TX FIFO阈值。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

threshold：TX FIFO阈值。

HAL状态。

hal_status_t hal_spi_set_rx_fifo_threshold(spi_handle_t *p_spi, uint32_t threshold)

设置RX FIFO阈值。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

threshold：RX FIFO阈值。

HAL状态。

uint32_t hal_spi_get_tx_fifo_threshold(spi_handle_t *p_spi)

获取TX FIFO阈值。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

TX FIFO阈值（取值范围0 ～ 7，其中0表示TX FIFO为空，7表示TX FIFO差一个字节满）。

uint32_t hal_spi_get_rx_fifo_threshold(spi_handle_t *p_spi)

获取RX FIFO阈值。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

RX FIFO阈值（取值范围0 ～ 7，其中0表示RX FIFO中有一个字节，7表示RX FIFO满）。

hal_status_t hal_spi_suspend_reg(spi_handle_t *p_spi)

睡眠时挂起SPI配置相关的寄存器。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

HAL状态。

hal_status_t hal_spi_resume_reg(spi_handle_t *p_spi)

唤醒时恢复SPI配置相关的寄存器。

p_spi：指向spi_handle_t结构体变量的指针，该结构体变量包含指定的SPI的配置信息。

HAL状态。