QSPI驱动API描述

hal_status_t hal_qspi_init(qspi_handle_t *p_qspi)

根据qspi_init_t中的指定参数初始化QSPI模式，并初始化相关句柄。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

HAL状态。

hal_status_t hal_qspi_deinit(qspi_handle_t *p_qspi)

反初始化QSPI外设。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

HAL状态。

void hal_qspi_msp_init(qspi_handle_t *p_qspi)

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

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

无

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

void hal_qspi_msp_deinit(qspi_handle_t *p_qspi)

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

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

无

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

hal_status_t hal_qspi_command_transmit(qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data, uint32_t timeout)

发送数据（包含：指令，地址，数据），轮询方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

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

timeout：超时时间。

HAL状态。

hal_status_t hal_qspi_command_receive(qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data, uint32_t timeout)

接收数据(包含：指令，地址，dummy，数据)，轮询方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

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

timeout：超时时间。

HAL状态。

hal_status_t hal_qspi_command(qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint32_t timeout)

发送指令，轮询方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

timeout：超时时间。

HAL状态。

该接口只用于轮询方式下的指令发送，可与hal_qspi_transmit()及hal_qspi_receive()配合使用进行指令、地址、数据的收发，或者可直接使用hal_qspi_command_transmit()和hal_qspi_command_receive()进行指令、地址、数据的收发。

hal_status_t hal_qspi_transmit(qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length, uint32_t timeout)

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

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

length：待发送数据的长度。

timeout：超时时间。

HAL状态。

该函数只在Standard SPI模式里使用。

hal_status_t hal_qspi_receive(qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length, uint32_t timeout)

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

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

length：待接收数据的长度。

timeout：超时时间。

HAL状态。

该函数只在Standard SPI模式里使用。

hal_status_t hal_qspi_command_transmit_it(qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data)

发送数据（(包含：指令，地址，数据)，中断方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

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

HAL状态。

传输过程中，QSPI中断处理无法及时响应，可能出现发送数据错误的情况。

hal_status_t hal_qspi_command_receive_it(qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data)

接收数据（(包含：指令，地址，dummy，数据)，中断方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

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

HAL状态。

传输过程中，QSPI中断处理无法及时响应，可能出现接收数据错误的情况。

hal_status_t hal_qspi_command_it(qspi_handle_t *p_qspi, qspi_command_t *p_cmd)

发送指令，中断方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

HAL状态。

该接口只用于中断方式下的指令发送，可与hal_qspi_receive_it()及hal_qspi_transmit_it()配合使用进行指令、地址、数据的收发，或者直接使用hal_qspi_command_receive_it()和hal_qspi_command_transmit_it()进行指令、地址、数据的收发。

hal_status_t hal_qspi_transmit_it(qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length)

以SPI方式发送数据，中断方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

length：待发送数据的长度。

HAL状态。

• 该函数只在Standard SPI模式里使用。
• 传输过程中，QSPI中断处理无法及时响应，可能出现发送数据错误的情况。

hal_status_t hal_qspi_receive_it(qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length)

以SPI方式接收数据，中断方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

length：待接收数据的长度。

HAL状态。

• 该函数只在Standard SPI模式里使用。
• 传输过程中，QSPI中断处理无法及时响应，可能出现接收数据错误的情况。

hal_status_t hal_qspi_command_transmit_dma(qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data)

发送数据(包含：指令，地址，数据)，DMA方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

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

HAL状态。

hal_status_t hal_qspi_command_receive_dma(qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data)

接收数据（包含：指令，地址，dummy，数据），DMA方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

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

HAL状态。

hal_status_t hal_qspi_command_dma(qspi_handle_t *p_qspi, qspi_command_t *p_cmd)

发送指令，DMA方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

p_cmd：指向qspi_command_t结构体变量的指针，该结构体变量包含命令配置信息。

HAL状态。

该接口只用于DMA方式下的指令发送，可与hal_qspi_receive_dma()及hal_qspi_transmit_dma()配合使用进行指令、地址、数据的收发，或者可直接使用hal_qspi_command_receive_dma()和hal_qspi_command_transmit_dma()进行指令、地址、数据的收发。

hal_status_t hal_qspi_transmit_dma(qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length)

以SPI方式发送数据，DMA方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

length：待发送数据的长度。

HAL状态。

该函数只在Standard SPI模式里使用：

• 如果DMA外围设备访问被配置为半字节，那么数据长度和fifo阈值应该以半字节对齐。
• 如果DMA外围设备访问被配置为字节，那么数据长度和fifo阈值应该以字节对齐。

hal_status_t hal_qspi_receive_dma(qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length)

以SPI方式接收数据，DMA方式。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

length：待接收数据的长度。

HAL状态。

该函数只在Standard SPI模式里使用：

• 如果DMA外围设备访问被配置为半字节，那么数据长度和fifo阈值应该以半字节对齐。
• 如果DMA外围设备访问被配置为字节，那么数据长度和fifo阈值应该以字节对齐。

hal_status_t hal_qspi_abort(qspi_handle_t *p_qspi)

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

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

HAL状态。

hal_status_t hal_qspi_abort_it(qspi_handle_t *p_qspi)

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

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

HAL状态。

void hal_qspi_irq_handler(qspi_handle_t *p_qspi)

处理QSPI中断请求。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

无

void hal_qspi_tx_cplt_callback(qspi_handle_t *p_qspi)

发送完成回调。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

无

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

void hal_qspi_rx_cplt_callback(qspi_handle_t *p_qspi)

接收完成回调。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

无

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

void hal_qspi_error_callback(qspi_handle_t *p_qspi)

传输错误回调。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

无

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

void hal_qspi_abort_cplt_callback(qspi_handle_t *p_qspi)

中止完成回调。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

无

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

hal_qspi_state_t hal_qspi_get_state(qspi_handle_t *p_qspi)

获取QSPI运行状态。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

QSPI运行状态，该参数的取值可以是下列值中的任意一个：

• HAL_QSPI_STATE_RESET（未初始化）
• HAL_QSPI_STATE_READY（已初始化且空闲）
• HAL_QSPI_STATE_BUSY（忙）
• HAL_QSPI_STATE_BUSY_INDIRECT_TX（正在发送）
• HAL_QSPI_STATE_BUSY_INDIRECT_RX （正在接收）
• HAL_QSPI_STATE_ABORT（被中断）
• HAL_QSPI_STATE_ERROR（错误）

uint32_t hal_qspi_get_error(qspi_handle_t *p_qspi)

获取QSPI错误码。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

void hal_qspi_set_timeout(qspi_handle_t *p_qspi, uint32_t timeout)

设置QSPI超时时间。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

timeout：QSPI内存访问超时时间。

无

hal_status_t hal_qspi_set_tx_fifo_threshold(qspi_handle_t *p_qspi, uint32_t threshold)

设置QSPI TX FIFO阈值。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

HAL状态

hal_status_t hal_qspi_set_rx_fifo_threshold(qspi_handle_t *p_qspi, uint32_t threshold)

设置QSPI RX FIFO阈值。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

HAL状态

uint32_t hal_qspi_get_tx_fifo_threshold(qspi_handle_t *p_qspi)

获取QSPI TX FIFO阈值。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

uint32_t hal_qspi_get_rx_fifo_threshold(qspi_handle_t *p_qspi)

获取QSPI RX FIFO阈值。

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

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

hal_status_t hal_qspi_suspend_reg(qspi_handle_t *p_qspi)

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

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

HAL状态

hal_status_t hal_qspi_resume_reg(qspi_handle_t *p_qspi)

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

p_qspi：指向qspi_handle_t结构体变量的指针，该结构体变量包含指定的QSPI的配置信息。

HAL状态