Go to the documentation of this file.
52 #ifndef __GR55xx_HAL_SPI_H__
53 #define __GR55xx_HAL_SPI_H__
170 #if defined(HAL_SPI_V2_MODULE_ENABLED)
220 #define SPI_DIRECTION_FULL_DUPLEX LL_SSI_FULL_DUPLEX
221 #define SPI_DIRECTION_SIMPLEX_TX LL_SSI_SIMPLEX_TX
222 #define SPI_DIRECTION_SIMPLEX_RX LL_SSI_SIMPLEX_RX
223 #define SPI_DIRECTION_READ_EEPROM LL_SSI_READ_EEPROM
229 #define HAL_SPI_ERROR_NONE ((uint32_t)0x00000000)
230 #define HAL_SPI_ERROR_TIMEOUT ((uint32_t)0x00000001)
231 #define HAL_SPI_ERROR_TRANSFER ((uint32_t)0x00000002)
232 #define HAL_SPI_ERROR_DMA ((uint32_t)0x00000004)
233 #define HAL_SPI_ERROR_INVALID_PARAM ((uint32_t)0x00000008)
239 #define SPI_DATASIZE_4BIT LL_SSI_DATASIZE_4BIT
240 #define SPI_DATASIZE_5BIT LL_SSI_DATASIZE_5BIT
241 #define SPI_DATASIZE_6BIT LL_SSI_DATASIZE_6BIT
242 #define SPI_DATASIZE_7BIT LL_SSI_DATASIZE_7BIT
243 #define SPI_DATASIZE_8BIT LL_SSI_DATASIZE_8BIT
244 #define SPI_DATASIZE_9BIT LL_SSI_DATASIZE_9BIT
245 #define SPI_DATASIZE_10BIT LL_SSI_DATASIZE_10BIT
246 #define SPI_DATASIZE_11BIT LL_SSI_DATASIZE_11BIT
247 #define SPI_DATASIZE_12BIT LL_SSI_DATASIZE_12BIT
248 #define SPI_DATASIZE_13BIT LL_SSI_DATASIZE_13BIT
249 #define SPI_DATASIZE_14BIT LL_SSI_DATASIZE_14BIT
250 #define SPI_DATASIZE_15BIT LL_SSI_DATASIZE_15BIT
251 #define SPI_DATASIZE_16BIT LL_SSI_DATASIZE_16BIT
252 #define SPI_DATASIZE_17BIT LL_SSI_DATASIZE_17BIT
253 #define SPI_DATASIZE_18BIT LL_SSI_DATASIZE_18BIT
254 #define SPI_DATASIZE_19BIT LL_SSI_DATASIZE_19BIT
255 #define SPI_DATASIZE_20BIT LL_SSI_DATASIZE_20BIT
256 #define SPI_DATASIZE_21BIT LL_SSI_DATASIZE_21BIT
257 #define SPI_DATASIZE_22BIT LL_SSI_DATASIZE_22BIT
258 #define SPI_DATASIZE_23BIT LL_SSI_DATASIZE_23BIT
259 #define SPI_DATASIZE_24BIT LL_SSI_DATASIZE_24BIT
260 #define SPI_DATASIZE_25BIT LL_SSI_DATASIZE_25BIT
261 #define SPI_DATASIZE_26BIT LL_SSI_DATASIZE_26BIT
262 #define SPI_DATASIZE_27BIT LL_SSI_DATASIZE_27BIT
263 #define SPI_DATASIZE_28BIT LL_SSI_DATASIZE_28BIT
264 #define SPI_DATASIZE_29BIT LL_SSI_DATASIZE_29BIT
265 #define SPI_DATASIZE_30BIT LL_SSI_DATASIZE_30BIT
266 #define SPI_DATASIZE_31BIT LL_SSI_DATASIZE_31BIT
267 #define SPI_DATASIZE_32BIT LL_SSI_DATASIZE_32BIT
273 #define SPI_POLARITY_LOW LL_SSI_SCPOL_LOW
274 #define SPI_POLARITY_HIGH LL_SSI_SCPOL_HIGH
280 #define SPI_PHASE_1EDGE LL_SSI_SCPHA_1EDGE
281 #define SPI_PHASE_2EDGE LL_SSI_SCPHA_2EDGE
287 #define SPI_TIMODE_DISABLE ((uint32_t)0x00000000)
288 #define SPI_TIMODE_ENABLE LL_SSI_PROTOCOL_TI
294 #define SPI_SLAVE_SELECT_0 LL_SSI_SLAVE0
295 #define SPI_SLAVE_SELECT_1 LL_SSI_SLAVE1
296 #define SPI_SLAVE_SELECT_ALL (LL_SSI_SLAVE0 | LL_SSI_SLAVE1)
302 #define SPI_TX_FIFO_LEVEL_MAX 8
303 #define SPI_RX_FIFO_LEVEL_MAX 8
309 #define SPI_FLAG_DCOL LL_SSI_SR_DCOL
310 #define SPI_FLAG_TXE LL_SSI_SR_TXE
311 #define SPI_FLAG_RFF LL_SSI_SR_RFF
312 #define SPI_FLAG_RFNE LL_SSI_SR_RFNE
313 #define SPI_FLAG_TFE LL_SSI_SR_TFE
314 #define SPI_FLAG_TFNF LL_SSI_SR_TFNF
315 #define SPI_FLAG_BUSY LL_SSI_SR_BUSY
321 #define SPI_IT_MST LL_SSI_IS_MST
322 #define SPI_IT_RXF LL_SSI_IS_RXF
323 #define SPI_IT_RXO LL_SSI_IS_RXO
324 #define SPI_IT_RXU LL_SSI_IS_RXU
325 #define SPI_IT_TXO LL_SSI_IS_TXO
326 #define SPI_IT_TXE LL_SSI_IS_TXE
332 #define HAL_SPI_TIMEOUT_DEFAULT_VALUE ((uint32_t)5000)
346 #define __HAL_SPI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->state = HAL_SPI_STATE_RESET)
352 #define __HAL_SPI_ENABLE(__HANDLE__) SET_BITS((__HANDLE__)->p_instance->SSI_EN, SSI_SSIEN_EN)
358 #define __HAL_SPI_DISABLE(__HANDLE__) CLEAR_BITS((__HANDLE__)->p_instance->SSI_EN, SSI_SSIEN_EN)
364 #define __HAL_SPI_ENABLE_DMATX(__HANDLE__) SET_BITS((__HANDLE__)->p_instance->DMAC, SSI_DMAC_TDMAE)
370 #define __HAL_SPI_ENABLE_DMARX(__HANDLE__) SET_BITS((__HANDLE__)->p_instance->DMAC, SSI_DMAC_RDMAE)
376 #define __HAL_SPI_DISABLE_DMATX(__HANDLE__) CLEAR_BITS((__HANDLE__)->p_instance->DMAC, SSI_DMAC_TDMAE)
382 #define __HAL_SPI_DISABLE_DMARX(__HANDLE__) CLEAR_BITS((__HANDLE__)->p_instance->DMAC, SSI_DMAC_RDMAE)
396 #define __HAL_SPI_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BITS((__HANDLE__)->p_instance->INTMASK, (__INTERRUPT__))
410 #define __HAL_SPI_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BITS((__HANDLE__)->p_instance->INTMASK, (__INTERRUPT__))
424 #define __HAL_SPI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (READ_BITS((__HANDLE__)->p_instance->INTSTAT, (__INTERRUPT__)) == (__INTERRUPT__))
439 #define __HAL_SPI_GET_FLAG(__HANDLE__, __FLAG__) ((READ_BITS((__HANDLE__)->p_instance->STAT, (__FLAG__)) != 0) ? SET : RESET)
454 #define __HAL_SPI_CLEAR_FLAG(__HANDLE__, __FLAG__) READ_BITS((__HANDLE__)->p_instance->STAT, (__FLAG__))
467 #define IS_SPI_DIRECTION(__MODE__) (((__MODE__) == SPI_DIRECTION_FULL_DUPLEX) || \
468 ((__MODE__) == SPI_DIRECTION_SIMPLEX_TX) || \
469 ((__MODE__) == SPI_DIRECTION_SIMPLEX_RX) || \
470 ((__MODE__) == SPI_DIRECTION_READ_EEPROM))
476 #define IS_SPI_DATASIZE(__DATASIZE__) (((__DATASIZE__) >= SPI_DATASIZE_4BIT) && \
477 ((__DATASIZE__) <= SPI_DATASIZE_32BIT))
483 #define IS_SPI_CPOL(__CPOL__) (((__CPOL__) == SPI_POLARITY_LOW) || \
484 ((__CPOL__) == SPI_POLARITY_HIGH))
490 #define IS_SPI_CPHA(__CPHA__) (((__CPHA__) == SPI_PHASE_1EDGE) || \
491 ((__CPHA__) == SPI_PHASE_2EDGE))
497 #define IS_SPI_BAUDRATE_PRESCALER(__PRESCALER__) ((__PRESCALER__) <= 0xFFFF)
503 #define IS_SPI_TIMODE(__MODE__) (((__MODE__) == SPI_TIMODE_DISABLE) || \
504 ((__MODE__) == SPI_TIMODE_ENABLE))
510 #define IS_SPI_SLAVE(__SLAVE__) (((__SLAVE__) == SPI_SLAVE_SELECT_0) || \
511 ((__SLAVE__) == SPI_SLAVE_SELECT_1) || \
512 ((__SLAVE__) == SPI_SLAVE_SELECT_ALL))
518 #define IS_SPI_RX_SAMPLE_DLY(__DLY__) (((__DLY__) >= 0) && ((__DLY__) <= 7))
525 #define IS_SPI_FIFO_THRESHOLD(__THR__) (((__THR__) >= 0) && ((__THR__) <= 7))
void hal_spi_abort_cplt_callback(spi_handle_t *p_spi)
SPI Abort Completed callback.
hal_spi_state_t hal_spi_get_state(spi_handle_t *p_spi)
Return the SPI handle state.
void(* spi_rx_cplt_callback)(spi_handle_t *p_spi)
SPI rx transfer completed callback
@ HAL_SPI_STATE_READY
Peripheral initialized and ready for use
SPI handle Structure definition.
hal_status_t hal_spi_deinit(spi_handle_t *p_spi)
De-initialize the SPI peripheral.
uint32_t ti_mode
Specifies if the TI mode is enabled or not.
hal_lock_t
HAL Lock structures definition.
hal_status_t hal_spi_abort(spi_handle_t *p_spi)
Abort ongoing transfer (blocking mode).
void(* spi_abort_cplt_callback)(spi_handle_t *p_spi)
SPI abort completed callback
void(* spi_tx_cplt_callback)(spi_handle_t *p_spi)
SPI tx transfer completed callback
struct _hal_spi_callback hal_spi_callback_t
HAL_SPI Callback function definition.
void hal_spi_error_callback(spi_handle_t *p_spi)
SPI error callback.
uint32_t slave_select
Specifies the slaves to be selected.
void(* read_fifo)(struct _spi_handle *p_spi)
Pointer to SPI Rx transfer FIFO read function
hal_status_t hal_spi_init(spi_handle_t *p_spi)
Initialize the SPI according to the specified parameters in the spi_init_t and initialize the associa...
ssi_regs_t * p_instance
SPI registers base address
uint32_t hal_spi_get_tx_fifo_threshold(spi_handle_t *p_spi)
Get the TX FIFO threshold.
@ HAL_SPI_STATE_ERROR
Peripheral in error
hal_status_t hal_spi_transmit_dma(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length)
Transmit an amount of data in non-blocking mode with DMA.
hal_status_t hal_spi_transmit(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length, uint32_t timeout)
Transmit an amount of data in blocking mode.
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)
Read an amount of data from EEPROM in non-blocking mode with DMA.
uint8_t * p_tx_buffer
Pointer to SPI Tx transfer Buffer.
SPI init Structure definition.
@ HAL_SPI_STATE_BUSY_TX
Data Transmission process is ongoing
uint32_t retention[8]
SPI important register information.
__IO uint32_t tx_xfer_count
SPI Tx Transfer Counter
hal_status_t hal_spi_receive_dma(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length)
Receive an amount of data in non-blocking mode with DMA.
void hal_spi_tx_cplt_callback(spi_handle_t *p_spi)
Tx Transfer completed callback.
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)
Read an amount of data from EEPROM in blocking mode.
hal_spi_state_t
HAL SPI State Enumerations definition.
void hal_spi_rx_cplt_callback(spi_handle_t *p_spi)
Rx Transfer completed callback.
dma_handle_t * p_dmatx
SPI Tx DMA Handle parameters
uint32_t timeout
Timeout for the SPI memory access.
uint8_t * p_rx_buffer
Pointer to SPI Rx transfer Buffer.
void(* spi_error_callback)(spi_handle_t *p_spi)
SPI error callback
__IO uint32_t error_code
SPI Error code
@ HAL_SPI_STATE_BUSY
An internal process is ongoing
__IO uint32_t rx_xfer_count
SPI Rx Transfer Counter
void hal_spi_irq_handler(spi_handle_t *p_spi)
Handle SPI interrupt request.
void(* spi_msp_init)(spi_handle_t *p_spi)
SPI init MSP callback
hal_status_t hal_spi_suspend_reg(spi_handle_t *p_spi)
Suspend some registers related to SPI configuration before sleep.
void(* spi_tx_rx_cplt_callback)(spi_handle_t *p_spi)
SPI tx/rx transfer completed callback
__IO uint32_t tx_xfer_size
SPI Tx Transfer size
hal_status_t hal_spi_resume_reg(spi_handle_t *p_spi)
Restore some registers related to SPI configuration after sleep.
dma_handle_t * p_dmarx
SPI Rx DMA Handle parameters
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)
Transmit and Receive an amount of data in blocking mode.
hal_status_t hal_spi_set_rx_fifo_threshold(spi_handle_t *p_spi, uint32_t threshold)
Set the RX FIFO threshold.
uint32_t hal_spi_get_rx_fifo_threshold(spi_handle_t *p_spi)
Get the RX FIFO threshold.
struct _spi_handle spi_handle_t
SPI handle Structure definition.
@ HAL_SPI_STATE_ABORT
Peripheral with abort request ongoing
@ HAL_SPI_STATE_BUSY_RX
Data Reception process is ongoing
spi_init_t init
SPI communication parameters
hal_status_t hal_spi_abort_it(spi_handle_t *p_spi)
Abort ongoing transfer (Interrupt mode).
@ HAL_SPI_STATE_RESET
Peripheral not initialized
hal_status_t hal_spi_transmit_it(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length)
Transmit an amount of data in non-blocking mode with Interrupt.
hal_status_t hal_spi_receive_it(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length)
Receive an amount of data in non-blocking mode with Interrupt.
@ HAL_SPI_STATE_BUSY_TX_RX
Data Transmission and Reception process is ongoing
Header file containing functions prototypes of SPI LL library.
void hal_spi_msp_deinit(spi_handle_t *p_spi)
De-initialize the SPI MSP.
hal_status_t hal_spi_receive(spi_handle_t *p_spi, uint8_t *p_data, uint32_t length, uint32_t timeout)
Receive an amount of data in blocking mode.
hal_status_t hal_spi_transmit_dma_with_ia(spi_handle_t *p_spi, uint8_t inst, uint32_t addr, uint8_t *p_data, uint32_t length)
Transmit an amount of data in non-blocking mode with DMA.
struct _spi_init spi_init_t
SPI init Structure definition.
void(* spi_msp_deinit)(spi_handle_t *p_spi)
SPI de-init MSP callback
hal_status_t
HAL Status structures definition.
uint32_t clock_polarity
Specifies the serial clock steady state.
uint32_t baudrate_prescaler
Specifies the BaudRate prescaler value which will be used to configure the transmit and receive SCK c...
hal_status_t hal_spi_set_tx_fifo_threshold(spi_handle_t *p_spi, uint32_t threshold)
Set the TX FIFO threshold.
void(* read_write_fifo)(struct _spi_handle *p_spi)
Pointer to SPI transfer FIFO read and write function
void hal_spi_msp_init(spi_handle_t *p_spi)
Initialize the SPI MSP.
__IO hal_spi_state_t state
SPI communication state
void hal_spi_tx_rx_cplt_callback(spi_handle_t *p_spi)
Tx and Rx Transfer completed callback.
__IO uint32_t rx_xfer_size
SPI Rx Transfer size
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)
Transmit and Receive an amount of data in non-blocking mode with DMA.
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)
Read an amount of data from EEPROM in non-blocking mode with Interrupt.
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)
Transmit and Receive an amount of data in non-blocking mode with Interrupt.
uint32_t hal_spi_get_error(spi_handle_t *p_spi)
Return the SPI error code.
uint32_t clock_phase
Specifies the clock active edge for the bit capture.
__IO hal_lock_t lock
Locking object
HAL_SPI Callback function definition.
DMA handle Structure definition.
hal_status_t hal_spi_transmit_with_ia(spi_handle_t *p_spi, uint8_t inst, uint32_t addr, uint8_t *p_data, uint32_t length, uint32_t timeout)
Transmit an amount of data in non-blocking mode with polling.
This file contains HAL common definitions, enumeration, macros and structures definitions.
void(* write_fifo)(struct _spi_handle *p_spi)
Pointer to SPI Tx transfer FIFO write function.
uint32_t data_size
Specifies the SPI data size.
void hal_spi_set_timeout(spi_handle_t *p_spi, uint32_t timeout)
Set the SPI internal process timeout value.