Header file containing functions prototypes of DSPI HAL library. More...
Go to the source code of this file.
Classes | |
struct | _dspi_init_t |
QSPI init Structure definition. More... | |
struct | _dspi_handle |
DSPI handle Structure definition. More... | |
struct | _dspi_command_t |
DSPI command Structure definition. More... | |
struct | _dspi_callback |
HAL_DSPI Callback function definition. More... | |
Typedefs | |
typedef struct _dspi_init_t | dspi_init_t |
QSPI init Structure definition. More... | |
typedef struct _dspi_handle | dspi_handle_t |
DSPI handle Structure definition. More... | |
typedef struct _dspi_command_t | dspi_command_t |
DSPI command Structure definition. More... | |
typedef struct _dspi_callback | dspi_callback_t |
HAL_DSPI Callback function definition. More... | |
Enumerations | |
enum | hal_dspi_state_t { HAL_DSPI_STATE_RESET = 0x00, HAL_DSPI_STATE_READY = 0x01, HAL_DSPI_STATE_BUSY = 0x02, HAL_DSPI_STATE_BUSY_INDIRECT_TX = 0x12, HAL_DSPI_STATE_ABORT = 0x08, HAL_DSPI_STATE_ERROR = 0x04 } |
HAL DSPI State Enumerations definition. More... | |
Functions | |
hal_status_t | hal_dspi_init (dspi_handle_t *p_dspi) |
Initialize the DSPI according to the specified parameters in the dspi_init_t and initialize the associated handle. More... | |
hal_status_t | hal_dspi_deinit (dspi_handle_t *p_dspi) |
De-initialize the DSPI peripheral. More... | |
void | hal_dspi_msp_init (dspi_handle_t *p_dspi) |
Initialize the DSPI MSP. More... | |
void | hal_dspi_msp_deinit (dspi_handle_t *p_dspi) |
De-initialize the DSPI MSP. More... | |
hal_status_t | hal_dspi_command_transmit (dspi_handle_t *p_dspi, dspi_command_t *p_cmd, uint8_t *p_data, uint32_t timeout) |
Transmit an amount of data with the specified instruction in blocking mode. More... | |
hal_status_t | hal_dspi_command (dspi_handle_t *p_dspi, dspi_command_t *p_cmd, uint32_t timeout) |
Transmit only instruction in blocking mode. More... | |
hal_status_t | hal_dspi_transmit (dspi_handle_t *p_qspi, uint8_t *p_data, uint32_t length, uint32_t timeout) |
Transmit an amount of data in blocking mode. More... | |
hal_status_t | hal_dspi_command_transmit_it (dspi_handle_t *p_dspi, dspi_command_t *p_cmd, uint8_t *p_data) |
Transmit an amount of data with the specified instruction in non-blocking mode with Interrupt. More... | |
hal_status_t | hal_dspi_command_it (dspi_handle_t *p_dspi, dspi_command_t *p_cmd) |
Transmit instruction in non-blocking mode with Interrupt. More... | |
hal_status_t | hal_dspi_transmit_it (dspi_handle_t *p_dspi, uint8_t *p_data, uint32_t length) |
Transmit an amount of data in non-blocking mode with Interrupt. More... | |
hal_status_t | hal_dspi_command_transmit_dma (dspi_handle_t *p_dspi, dspi_command_t *p_cmd, uint8_t *p_data) |
Transmit an amount of data with the specified instruction in non-blocking mode with DMA . More... | |
hal_status_t | hal_dspi_command_transmit_dma_sg_llp (dspi_handle_t *p_dspi, dspi_command_t *p_cmd, uint8_t *p_data, dma_sg_llp_config_t *sg_llp_config) |
Transmit an amount of data with the specified instruction in non-blocking mode with DMA SG or LLP. More... | |
hal_status_t | hal_dspi_command_dma (dspi_handle_t *p_dspi, dspi_command_t *p_cmd) |
Transmit instruction in non-blocking mode with DMA. More... | |
hal_status_t | hal_dspi_transmit_dma (dspi_handle_t *p_dspi, uint8_t *p_data, uint32_t length) |
Transmit an amount of data in non-blocking mode with DMA. More... | |
hal_status_t | hal_dspi_transmit_dma_sg_llp (dspi_handle_t *p_dspi, uint8_t *p_data, uint32_t length, dma_sg_llp_config_t *sg_llp_config) |
Transmit an amount of data in non-blocking mode with DMA SG or LLP. More... | |
hal_status_t | hal_dspi_abort (dspi_handle_t *p_dspi) |
Abort the current transmission. More... | |
hal_status_t | hal_dspi_abort_it (dspi_handle_t *p_dspi) |
Abort the current transmission (non-blocking function) More... | |
void | hal_dspi_irq_handler (dspi_handle_t *p_dspi) |
Handle DSPI interrupt request. More... | |
void | hal_dspi_tx_cplt_callback (dspi_handle_t *p_dspi) |
Tx Transfer completed callback. More... | |
void | hal_dspi_error_callback (dspi_handle_t *p_dspi) |
DSPI error callback. More... | |
void | hal_dspi_abort_callback (dspi_handle_t *p_dspi) |
DSPI Abort callback. More... | |
hal_dspi_state_t | hal_dspi_get_state (dspi_handle_t *p_dspi) |
Return the DSPI handle state. More... | |
uint32_t | hal_dspi_get_error (dspi_handle_t *p_dspi) |
Return the DSPI error code. More... | |
void | hal_dspi_set_timeout (dspi_handle_t *p_dspi, uint32_t timeout) |
Set the DSPI internal process timeout value. More... | |
hal_status_t | hal_dspi_config_mode (dspi_handle_t *p_dspi, uint32_t mode) |
Set the DSPI transmission mode. More... | |
hal_status_t | hal_dspi_suspend_reg (dspi_handle_t *p_dspi) |
Suspend some registers related to DSPI configuration before sleep. More... | |
hal_status_t | hal_dspi_resume_reg (dspi_handle_t *p_dspi) |
Restore some registers related to DSPI configuration after sleep. This function must be used in conjunction with the hal_dspi_suspend_reg(). More... | |
Header file containing functions prototypes of DSPI 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_dspi.h.