接口函数

表 568 QSPI驱动接口函数
API	芯片
API	GR551x	GR5526
app_qspi_init	Y	Y
app_qspi_deinit	Y	Y
app_qspi_abort	Y	Y
app_qspi_config_memory_mappped	N	Y
app_qspi_active_memory_mappped	N	Y
app_qspi_command_receive_sync	Y	Y
app_qspi_command_receive_async	Y	Y
app_qspi_command_transmit_sync	Y	Y
app_qspi_command_transmit_async	Y	Y
app_qspi_command_sync	Y	Y
app_qspi_command_async	Y	Y
app_qspi_transmit_sync	Y	N
app_qspi_transmit_async	Y	N
app_qspi_receive_sync	Y	N
app_qspi_receive_async	Y	N
app_qspi_transmit_sync_ex	Y	Y
app_qspi_transmit_async_ex	Y	Y
app_qspi_receive_sync_ex	Y	Y
app_qspi_receive_async_ex	Y	Y
app_qspi_mmap_set_endian_mode	N	Y
app_qspi_mmap_read_u8	N	Y
app_qspi_mmap_read_u16	N	Y
app_qspi_mmap_read_u32	N	Y
app_qspi_mmap_read_block	N	Y
app_qspi_get_xip_base_address	N	Y
app_qspi_transmit_in_qpi_async	Y	N
app_qspi_get_handle	Y	Y

app_qspi_init

表 569 app_qspi_init接口
函数原型	uint16_t app_qspi_init(app_qspi_params_t *p_params, app_qspi_evt_handler_t evt_handler)
功能说明	初始化QSPI
输入参数	p_params：初始化参数的结构体指针 evt_handler：用户自己实现的中断回调函数
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	回调函数形式参照typedef void (app_qspi_evt_handler_t)(app_qspi_evt_t p_evt)； HAL层已经实现中断标志位的清理，用户无需关心中断标志的清理，回调函数根据返回事件类型进行相应的处理即可

app_qspi_deinit

表 570 app_qspi_deinit接口
函数原型	uint16_t app_qspi_deinit(app_qspi_id_t id)
功能说明	反初始化QSPI
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述）
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_qspi_abort

表 571 app_qspi_abort接口
函数原型	uint16_t app_qspi_abort(app_qspi_id_t id)
功能说明	中止QSPI传输
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述）
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_qspi_config_memory_mappped

表 572 app_qspi_config_memory_mappped接口
函数原型	bool app_qspi_config_memory_mappped(app_qspi_id_t id, app_qspi_mmap_device_t dev)
功能说明	配置内存映射模式并激活该模式
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） dev：内存映射设备配置
返回值	true：配置成功 false：配置失败
备注	仅适用于GR5526

app_qspi_active_memory_mappped

表 573 app_qspi_active_memory_mappped接口
函数原型	bool app_qspi_active_memory_mappped(app_qspi_id_t id, bool is_active)
功能说明	使能/不使能内存映射模式
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） is_active： true：使能 false：不使能
返回值	true：使能/不使能成功 false：使能/不使能失败
备注	仅适用于GR5526

app_qspi_command_receive_sync

表 574 app_qspi_command_receive_sync接口
函数原型	uint16_t app_qspi_command_receive_sync(app_qspi_id_t id, app_qspi_command_t p_cmd, uint8_t p_data, uint32_t timeout)
功能说明	QSPI轮询方式（同步）读取数据，带控制命令封装
输入参数	id：QSPI模块ID p_cmd：封装的控制命令，参考app_qspi_command_t结构体描述 p_data：读取数据存放的buffer timeout：超时时间，以ms为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_qspi_command_receive_async

表 575 app_qspi_command_receive_async接口
函数原型	uint16_t app_qspi_command_receive_async(app_qspi_id_t id, app_qspi_command_t p_cmd, uint8_t p_data)
功能说明	QSPI中断方式（异步）读取数据，带控制命令封装
输入参数	id：QSPI模块ID p_cmd：封装的控制命令，参考app_qspi_command_t结构体描述 p_data：读取数据存放的buffer
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_qspi_command_transmit_sync

表 576 app_qspi_command_transmit_sync接口
函数原型	uint16_t app_qspi_command_transmit_sync(app_qspi_id_t id, app_qspi_command_t p_cmd, uint8_t p_data, uint32_t timeout)
功能说明	QSPI轮询方式（同步）发送数据，带控制命令封装
输入参数	id：QSPI模块ID p_cmd：封装的控制命令，参考app_qspi_command_t结构体描述 p_data：待发送数据存放的buffer timeout：超时时间，以ms为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_qspi_command_transmit_async

表 577 app_qspi_command_transmit_async接口
函数原型	uint16_t app_qspi_command_transmit_async(app_qspi_id_t id, app_qspi_command_t p_cmd, uint8_t p_data)
功能说明	QSPI中断方式（异步）发送数据，带控制命令封装
输入参数	id：QSPI模块ID p_cmd：封装的控制命令，参考app_qspi_command_t结构体描述 p_data：待发送数据存放的buffer
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_qspi_command_sync

表 578 app_qspi_command_sync接口
函数原型	uint16_t app_qspi_command_sync(app_qspi_id_t id, app_qspi_command_t *p_cmd, uint32_t timeout)
功能说明	QSPI轮询方式（同步）发送命令
输入参数	id：QSPI模块ID p_cmd：待发送命令的buffer timeout：超时时间，以ms为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_qspi_command_async

表 579 app_qspi_command_async接口
函数原型	uint16_t app_qspi_command_async(app_qspi_id_t id, app_qspi_command_t *p_cmd)
功能说明	QSPI中断方式（异步）发送命令
输入参数	id：QSPI模块ID p_cmd：待发送命令的buffer
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_qspi_transmit_sync

表 580 app_qspi_transmit_sync接口
函数原型	uint16_t app_qspi_transmit_sync(app_qspi_id_t id, uint8_t *p_data, uint32_t length, uint32_t timeout)
功能说明	QSPI轮询方式（同步）发送数据
输入参数	id：QSPI模块ID p_data：需要发送数据的buffer length：发送数据的长度，以Byte为单位 timeout：超时时间，以ms为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	该函数仅适用于GR551x

app_qspi_transmit_async

表 581 app_qspi_transmit_async接口
函数原型	uint16_t app_qspi_transmit_async(app_qspi_id_t id, uint8_t *p_data, uint32_t length)
功能说明	QSPI中断方式（异步）发送数据
输入参数	id：QSPI模块ID p_data：需要发送数据的buffer length：待发送数据的长度，以Byte为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	该函数仅适用于GR551x

app_qspi_receive_sync

表 582 app_qspi_receive_sync接口
函数原型	uint16_t app_qspi_receive_sync(app_qspi_id_t id, uint8_t *p_data, uint32_t length, uint32_t timeout)
功能说明	QSPI轮询方式（同步）接收数据
输入参数	id：QSPI模块ID p_data：接收数据的buffer length：接收数据的长度，以Byte为单位 timeout：超时时间，以ms为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	该函数仅适用于GR551x

app_qspi_receive_async

表 583 app_qspi_receive_async接口
函数原型	uint16_t app_qspi_receive_async(app_qspi_id_t id, uint8_t *p_data, uint32_t length)
功能说明	QSPI中断方式（异步）接收数据
输入参数	id：QSPI模块ID p_data：接收数据的buffer length：接收数据的长度，以Byte为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	该函数仅适用于GR551x

app_qspi_transmit_sync_ex

表 584 app_qspi_transmit_sync_ex接口
函数原型	uint16_t app_qspi_transmit_sync_ex(app_qspi_id_t id, uint32_t qspi_mode, uint32_t data_width, uint8_t *p_data, uint32_t length, uint32_t timeout)
功能说明	QSPI轮询方式（同步）发送数据，可设置时序模式和传输数据位宽
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） qspi_mode：数据传输采用的时序模式，可选QSPI_DATA_MODE_SPI（标准SPI模式）、QSPI_DATA_MODE_DUALSPI（Dual SPI模式）、QSPI_DATA_MODE_QUADSPI（Quad SPI模式） data_width：数据位宽（支持QSPI_DATASIZE_08_BITS、QSPI_DATASIZE_16_BITS、QSPI_DATASIZE_32_BITS） p_data：需要传输数据的buffer length：待发送数据的长度，以Byte为单位 timeout：超时时间，以ms为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	GR551x使用该函数时，qspi_mode和data_width无意义

app_qspi_transmit_async_ex

表 585 app_qspi_transmit_async_ex接口
函数原型	uint16_t app_qspi_transmit_async_ex(app_qspi_id_t id, uint32_t qspi_mode, uint32_t data_width, uint8_t *p_data, uint32_t length)
功能说明	QSPI中断方式（异步）发送数据，可设置时序模式和传输数据位宽
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） qspi_mode：数据传输采用的时序模式，可选QSPI_DATA_MODE_SPI（标准SPI模式）、QSPI_DATA_MO DE_DUALSPI（Dual SPI模式）、QSPI_DATA_MODE_QUADSPI（Quad SPI模式） data_width：数据位宽（支持QSPI_DATASIZE_08_BITS、QSPI_DATASIZE_16_BITS、QSPI_DATASIZE_32_BITS） p_data：需要发送数据的buffer length：待发送数据的长度，以Byte为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	当GR551x使用该函数时，qspi_mode和data_width无意义

app_qspi_receive_sync_ex

表 586 app_qspi_receive_sync_ex接口
函数原型	uint16_t app_qspi_receive_sync_ex(app_qspi_id_t id, uint32_t qspi_mode, uint32_t data_width, uint8_t *p_data, uint32_t length , uint32_t timeout, uint32_t timeout)
功能说明	QSPI轮询方式（同步）接收数据，可设置时序模式和传输数据位宽
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） qspi_mode：数据传输采用的时序模式，可选QSPI_DATA_MODE_SPI（标准SPI模式）、QSPI_DATA_MO DE_DUALSPI（Dual SPI模式）、QSPI_DATA_MODE_QUADSPI（Quad SPI模式） data_width：传输数据位宽（支持QSPI_DATASIZE_08_BITS、QSPI_DATASIZE_16_BITS、QSPI_DATASIZE_32_BITS） p_data：需要接收数据的buffer length：待接收数据的长度，以Byte为单位 timeout：超时时间，以ms为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	当GR551x使用该函数时，qspi_mode和data_width无意义

app_qspi_receive_async_ex

表 587 app_qspi_receive_async_ex接口
函数原型	uint16_t app_qspi_receive_async_ex(app_qspi_id_t id, uint32_t qspi_mode, uint32_t data_width, uint8_t *p_data, uint32_t length)
功能说明	QSPI中断方式（异步）接收数据，可设置时序模式和传输数据位宽
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） qspi_mode：数据传输采用的时序模式，可选QSPI_DATA_MODE_SPI（标准SPI模式）、QSPI_DATA_MO DE_DUALSPI（Dual SPI模式）、QSPI_DATA_MODE_QUADSPI（Quad SPI模式） data_width：传输数据位宽（支持QSPI_DATASIZE_08_BITS、QSPI_DATASIZE_16_BITS、QSPI_DATASIZE_32_BITS） p_data：需要接收数据的buffer length：待接收数据的长度，以Byte为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	当GR551x使用该函数时，qspi_mode和data_width无意义

app_qspi_mmap_set_endian_mode

表 588 app_qspi_mmap_set_endian_mode接口
函数原型	bool app_qspi_mmap_set_endian_mode(app_qspi_id_t id, app_qspi_mmap_endian_mode_e mode)
功能说明	设置内存映射模式下的端序模式
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） mode：端序模式
返回值	true：设置成功 false：设置失败
备注	仅适用于GR5526

app_qspi_mmap_read_u8

表 589 app_qspi_mmap_read_u8接口
函数原型	uint8_t app_qspi_mmap_read_u8(app_qspi_id_t id, uint32_t address)
功能说明	内存映射模式下，读取U8数据，用于Flash/PSRAM设备
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） address：待访问设备的偏移地址（Flash/PSRAM）
返回值	读取的数据
备注	仅适用于GR5526

app_qspi_mmap_read_u16

表 590 app_qspi_mmap_read_u16接口
函数原型	uint16_t app_qspi_mmap_read_u16(app_qspi_id_t id, uint32_t address)
功能说明	内存映射模式下，读取U16数据，用于Flash/PSRAM设备
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） address：待访问设备的偏移地址（Flash/PSRAM）
返回值	读取的数据
备注	仅适用于GR5526

app_qspi_mmap_read_u32

表 591 app_qspi_mmap_read_u32接口
函数原型	uint32_t app_qspi_mmap_read_u32(app_qspi_id_t id, uint32_t address)
功能说明	内存映射模式下，读取U32数据，用于Flash/PSRAM设备
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） address：待访问设备的偏移地址（Flash/PSRAM）
返回值	读取的数据
备注	仅适用于GR5526

app_qspi_mmap_read_block

表 592 app_qspi_mmap_read_block接口
函数原型	bool app_qspi_mmap_read_block(app_qspi_id_t id, uint32_t address, uint8_t * buffer, uint32_t length)
功能说明	内存映射模式下读取一个数据块
输入参数	id：QSPI模块ID（详见app_qspi_params_t中描述） address：待访问设备的偏移地址（Flash/PSRAM） buffer：读取数据存放的缓存指针 length：读取数据长度，以Byte为单位
返回值	true：成功 false：失败
备注	仅适用于GR5526

app_qspi_get_xip_base_address

表 593 app_qspi_get_xip_base_address接口
函数原型	uint32_t app_qspi_get_xip_base_address(app_qspi_id_t id)
功能说明	获取QSPI内存映射在系统总线的基地址
输入参数	id：QSPI模块ID
返回值	QSPI内存映射在系统总线的基地址
备注	仅适用于GR5526

app_qspi_transmit_in_qpi_async

表 594 app_qspi_transmit_in_qpi_async接口
函数原型	uint16_t app_qspi_transmit_in_qpi_async(app_qspi_id_t id, uint32_t data_width, uint8_t *p_data, uint32_t length)
功能说明	QSPI在QPI模式下中断方式（异步）发送数据
输入参数	id：QSPI模块ID data_width：数据位宽（支持QSPI_DATASIZE_08_BITS、QSPI_DATASIZE_16_BITS、QSPI_DATASIZE_32_BITS） p_data：需要发送数据的buffer length：待发送数据的长度，以Byte为单位
返回值	APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注	仅适用于GR551x

app_qspi_get_handle

表 595 app_qspi_get_handle接口
函数原型	qspi_handle_t *app_qspi_get_handle(app_qspi_id_t id)
功能说明	获取QSPI句柄
输入参数	id：QSPI模块ID
返回值	QSPI句柄：参考SDK_Folder\drivers\inc\gr55xx_hal_qspi.h
备注

接口函数

app_qspi_init

app_qspi_deinit

app_qspi_abort

app_qspi_config_memory_mappped

app_qspi_active_memory_mappped

app_qspi_command_receive_sync

app_qspi_command_receive_async

app_qspi_command_transmit_sync

app_qspi_command_transmit_async

app_qspi_command_sync

app_qspi_command_async

app_qspi_transmit_sync

app_qspi_transmit_async

app_qspi_receive_sync

app_qspi_receive_async

app_qspi_transmit_sync_ex

app_qspi_transmit_async_ex

app_qspi_receive_sync_ex

app_qspi_receive_async_ex

app_qspi_mmap_set_endian_mode

app_qspi_mmap_read_u8

app_qspi_mmap_read_u16

app_qspi_mmap_read_u32

app_qspi_mmap_read_block

app_qspi_get_xip_base_address

app_qspi_transmit_in_qpi_async

app_qspi_get_handle

扫描关注