Header file containing functions prototypes of QSPI HAL library. More...
Go to the source code of this file.
Classes | |
struct | _qspi_init_t |
QSPI init Structure definition. More... | |
struct | _qspi_handle |
QSPI handle Structure definition. More... | |
struct | _qspi_command_t |
QSPI command Structure definition. More... | |
struct | _hal_qspi_callback |
HAL_QSPI Callback function definition. More... | |
Typedefs | |
typedef struct _qspi_init_t | qspi_init_t |
QSPI init Structure definition. More... | |
typedef struct _qspi_handle | qspi_handle_t |
QSPI handle Structure definition. More... | |
typedef struct _qspi_command_t | qspi_command_t |
QSPI command Structure definition. More... | |
typedef struct _hal_qspi_callback | hal_qspi_callback_t |
HAL_QSPI Callback function definition. More... | |
Enumerations | |
enum | hal_qspi_state_t { HAL_QSPI_STATE_RESET = 0x00, HAL_QSPI_STATE_READY = 0x01, HAL_QSPI_STATE_BUSY = 0x02, HAL_QSPI_STATE_BUSY_INDIRECT_TX = 0x12, HAL_QSPI_STATE_BUSY_INDIRECT_RX = 0x22, HAL_QSPI_STATE_ABORT = 0x08, HAL_QSPI_STATE_ERROR = 0x04 } |
HAL QSPI State Enumerations definition. More... | |
Functions | |
hal_status_t | hal_qspi_init (qspi_handle_t *p_qspi) |
Initialize the QSPI according to the specified parameters in the qspi_init_t and initialize the associated handle. More... | |
hal_status_t | hal_qspi_deinit (qspi_handle_t *p_qspi) |
De-initialize the QSPI peripheral. More... | |
void | hal_qspi_msp_init (qspi_handle_t *p_qspi) |
Initialize the QSPI MSP. More... | |
void | hal_qspi_msp_deinit (qspi_handle_t *p_qspi) |
De-initialize the QSPI MSP. More... | |
hal_status_t | hal_qspi_command_transmit (qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data, uint32_t timeout) |
Transmit an amount of data with the specified instruction and address in blocking mode. More... | |
hal_status_t | hal_qspi_command_receive (qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data, uint32_t timeout) |
Receive an amount of data with the specified instruction, address and dummy cycles in blocking mode. More... | |
hal_status_t | hal_qspi_command (qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint32_t timeout) |
Transmit only instruction in blocking mode. More... | |
hal_status_t | hal_qspi_transmit (qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length, uint32_t timeout) |
Transmit an amount of data in blocking mode with standard SPI. More... | |
hal_status_t | hal_qspi_receive (qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length, uint32_t timeout) |
Receive an amount of data in blocking mode with standard SPI. More... | |
hal_status_t | hal_qspi_command_transmit_it (qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data) |
Transmit an amount of data with the specified instruction and address in non-blocking mode with Interrupt. More... | |
hal_status_t | hal_qspi_command_receive_it (qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data) |
Receive an amount of data with the specified instruction, address and dummy cycles in non-blocking mode with Interrupt. More... | |
hal_status_t | hal_qspi_command_it (qspi_handle_t *p_qspi, qspi_command_t *p_cmd) |
Transmit instruction in non-blocking mode with Interrupt. More... | |
hal_status_t | hal_qspi_transmit_it (qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length) |
Transmit an amount of data in non-blocking mode at standard SPI with Interrupt. More... | |
hal_status_t | hal_qspi_receive_it (qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length) |
Receive an amount of data in non-blocking mode at standard SPI with Interrupt. More... | |
hal_status_t | hal_qspi_command_transmit_dma (qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data) |
Transmit an amount of data with the specified instruction and address in non-blocking mode with DMA . More... | |
hal_status_t | hal_qspi_command_receive_dma (qspi_handle_t *p_qspi, qspi_command_t *p_cmd, uint8_t *p_data) |
Receive an amount of data with the specified instruction, address and dummy cycles in non-blocking mode with DMA . More... | |
hal_status_t | hal_qspi_command_dma (qspi_handle_t *p_qspi, qspi_command_t *p_cmd) |
Transmit instruction in non-blocking mode with DMA. More... | |
hal_status_t | hal_qspi_transmit_dma (qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length) |
Transmit an amount of data in non-blocking mode at standard SPI with DMA. More... | |
hal_status_t | hal_qspi_receive_dma (qspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length) |
Receive an amount of data in non-blocking mode at standard SPI with DMA. More... | |
hal_status_t | hal_qspi_abort (qspi_handle_t *p_qspi) |
Abort the current transmission. More... | |
hal_status_t | hal_qspi_abort_it (qspi_handle_t *p_qspi) |
Abort the current transmission (non-blocking function) More... | |
void | hal_qspi_irq_handler (qspi_handle_t *p_qspi) |
Handle QSPI interrupt request. More... | |
void | hal_qspi_tx_cplt_callback (qspi_handle_t *p_qspi) |
Tx Transfer completed callback. More... | |
void | hal_qspi_rx_cplt_callback (qspi_handle_t *p_qspi) |
Rx Transfer completed callback. More... | |
void | hal_qspi_error_callback (qspi_handle_t *p_qspi) |
QSPI error callback. More... | |
void | hal_qspi_abort_cplt_callback (qspi_handle_t *p_qspi) |
QSPI Abort Complete callback. More... | |
void | hal_qspi_fifo_threshold_callback (qspi_handle_t *p_qspi) |
FIFO Threshold callback. More... | |
hal_qspi_state_t | hal_qspi_get_state (qspi_handle_t *p_qspi) |
Return the QSPI handle state. More... | |
uint32_t | hal_qspi_get_error (qspi_handle_t *p_qspi) |
Return the QSPI error code. More... | |
void | hal_qspi_set_timeout (qspi_handle_t *p_qspi, uint32_t timeout) |
Set the QSPI internal process timeout value. More... | |
hal_status_t | hal_qspi_set_tx_fifo_threshold (qspi_handle_t *p_qspi, uint32_t threshold) |
Set the TX FIFO threshold. More... | |
hal_status_t | hal_qspi_set_rx_fifo_threshold (qspi_handle_t *p_qspi, uint32_t threshold) |
Set the RX FIFO threshold. More... | |
uint32_t | hal_qspi_get_tx_fifo_threshold (qspi_handle_t *p_qspi) |
Get the TX FIFO threshold. More... | |
uint32_t | hal_qspi_get_rx_fifo_threshold (qspi_handle_t *p_qspi) |
Get the RX FIFO threshold. More... | |
hal_status_t | hal_qspi_suspend_reg (qspi_handle_t *p_qspi) |
Suspend some registers related to QSPI configuration before sleep. More... | |
hal_status_t | hal_qspi_resume_reg (qspi_handle_t *p_qspi) |
Restore some registers related to QSPI configuration after sleep. This function must be used in conjunction with the hal_qspi_suspend_reg(). More... | |
Header file containing functions prototypes of QSPI HAL library.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Definition in file gr55xx_hal_qspi.h.