Macros
I2S Exported Macros
Peripheral Driver » HAL Driver » I2S » Defines
Collaboration diagram for I2S Exported Macros:

## Macros
#define | __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->state = HAL_I2S_STATE_RESET)
| Reset I2S handle states. More...
#define | __HAL_I2S_ENABLE(__HANDLE__) SET_BITS((__HANDLE__)->p_instance->EN, I2S_EN_I2S_EN)
| Enable the specified I2S peripheral. More...
#define | __HAL_I2S_DISABLE(__HANDLE__) CLEAR_BITS((__HANDLE__)->p_instance->EN, I2S_EN_I2S_EN)
| Disable the specified I2S peripheral. More...
#define | __HAL_I2S_ENABLE_CLOCK(__HANDLE__) SET_BITS((__HANDLE__)->p_instance->CLK_EN, I2S_CLK_EN_CLK_EN)
| Enable the specified I2S clock. More...
#define | __HAL_I2S_DISABLE_CLOCK(__HANDLE__) CLEAR_BITS((__HANDLE__)->p_instance->CLK_EN, I2S_CLK_EN_CLK_EN)
| Disable the specified I2S clock. More...
#define | __HAL_I2S_ENABLE_TX_BLOCK(__HANDLE__) ll_i2s_enable_txblock((__HANDLE__)->p_instance)
| Enable the specified I2S transmitter block. More...
#define | __HAL_I2S_DISABLE_TX_BLOCK(__HANDLE__) ll_i2s_disable_txblock((__HANDLE__)->p_instance)
| Disable the specified I2S transmitter block. More...
#define | __HAL_I2S_ENABLE_RX_BLOCK(__HANDLE__) ll_i2s_enable_rxblock((__HANDLE__)->p_instance)
| Enable the specified I2S receiver block. More...
#define | __HAL_I2S_DISABLE_RX_BLOCK(__HANDLE__) ll_i2s_disable_rxblock((__HANDLE__)->p_instance)
| Disable the specified I2S receiver block. More...
#define | __HAL_I2S_ENABLE_TX_CHANNEL(__HANDLE__) ll_i2s_enable_tx((__HANDLE__)->p_instance)
| Enable the specified I2S transmitter channel. More...
#define | __HAL_I2S_DISABLE_TX_CHANNEL(__HANDLE__) ll_i2s_disable_tx((__HANDLE__)->p_instance)
| Disable the specified I2S transmitter channel. More...
#define | __HAL_I2S_ENABLE_RX_CHANNEL(__HANDLE__) ll_i2s_enable_rx((__HANDLE__)->p_instance)
| Enable the specified I2S receiver channel. More...
#define | __HAL_I2S_DISABLE_RX_CHANNEL(__HANDLE__) ll_i2s_disable_rx((__HANDLE__)->p_instance)
| Disable the specified I2S receiver channel. More...
#define | __HAL_I2S_FLUSH_TX_FIFO(__HANDLE__) ll_i2s_clr_txfifo_all((__HANDLE__)->p_instance)
| Flush the I2S transmitter FIFO. More...
#define | __HAL_I2S_FLUSH_RX_FIFO(__HANDLE__) ll_i2s_clr_rxfifo_all((__HANDLE__)->p_instance)
| Flush the I2S receiver FIFO. More...
#define | __HAL_I2S_ENABLE_DMA(__HANDLE__) ll_i2s_enable_dma(__HANDLE__->p_instance)
| Enable the I2S DMA Request. More...
#define | __HAL_I2S_DISABLE_DMA(__HANDLE__) ll_i2s_disable_dma(__HANDLE__->p_instance)
| Disable the I2S DMA Request. More...
#define | __HAL_I2S_RESET_TXDMA(__HANDLE__) WRITE_REG((__HANDLE__)->p_instance->RST_TX_DMA, I2S_RST_TX_DMA_RST_TX_DMA)
| Reset the I2S TX DMA request to the lowest enabled channel. More...
#define | __HAL_I2S_ENABLE_DMA_MODE(__HANDLE__) ll_i2s_enable_dma_mode(__HANDLE__->p_instance)
| Enable the I2S DMA mode. More...
#define | __HAL_I2S_DISABLE_DMA_MODE(__HANDLE__) ll_i2s_disable_dma_mode(__HANDLE__->p_instance)
| Disable the I2S DMA mode. More...
#define | __HAL_I2S_RESET_RXDMA(__HANDLE__) WRITE_REG((__HANDLE__)->p_instance->RST_RX_DMA, I2S_RST_RX_DMA_RST_RX_DMA)
| Reset the I2S RX DMA request to the lowest enabled channel. More...
#define | __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BITS((__HANDLE__)->p_instance->INT_MASK, (__INTERRUPT__))
| Enable the specified I2S interrupts. More...
#define | __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) SET_BITS((__HANDLE__)->p_instance->INT_MASK, (__INTERRUPT__))
| Disable the specified I2S interrupts. More...
#define | __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((READ_BITS((__HANDLE__)->p_instance->INT_STAT, (__FLAG__)) != 0) ? SET : RESET)
| Check whether the specified I2S flag is set or not. More...
#define | __HAL_I2S_CLEAR_FLAG(__HANDLE__, __FLAG__)
| Clear the specified I2S flag. More...

## Detailed Description

## Macro Definition Documentation

## ◆ __HAL_I2S_CLEAR_FLAG

#define __HAL_I2S_CLEAR_FLAG | ( |  | __HANDLE__,
|  |  | __FLAG__
| ) |  |

Value:
do { \
if ((__FLAG__) & I2S_FLAG_RXFO) \
{ \
READ_BITS((__HANDLE__)->p_instance->RX_OVER, I2S_RX_OVER_RX_CLR_FDO);\
} \
if ((__FLAG__) & I2S_FLAG_TXFO) \
{ \
READ_BITS((__HANDLE__)->p_instance->TX_OVER, I2S_TX_OVER_TX_CLR_FDO);\
} \
} while(0);

Clear the specified I2S flag.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.
  <strong>FLAG</strong> | Specifies the flag to check. This parameter can be one of the following values: I2S_FLAG_TXFO TX FIFO write overflow flag I2S_FLAG_RXFO RX FIFO receive overflow flag

Return values

  None |

Definition at line 481 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE

#define __HAL_I2S_DISABLE | ( |  | __HANDLE__ | ) | CLEAR_BITS((__HANDLE__)->p_instance->EN, I2S_EN_I2S_EN)

Disable the specified I2S peripheral.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 308 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE_CLOCK

#define __HAL_I2S_DISABLE_CLOCK | ( |  | __HANDLE__ | ) | CLEAR_BITS((__HANDLE__)->p_instance->CLK_EN, I2S_CLK_EN_CLK_EN)

Disable the specified I2S clock.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 327 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE_DMA

#define __HAL_I2S_DISABLE_DMA | ( |  | __HANDLE__ | ) | ll_i2s_disable_dma(__HANDLE__->p_instance)

Disable the I2S DMA Request.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 405 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE_DMA_MODE

#define __HAL_I2S_DISABLE_DMA_MODE | ( |  | __HANDLE__ | ) | ll_i2s_disable_dma_mode(__HANDLE__->p_instance)

Disable the I2S DMA mode.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 424 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE_IT

#define __HAL_I2S_DISABLE_IT | ( |  | __HANDLE__,
|  |  | __INTERRUPT__
| ) |  | SET_BITS((__HANDLE__)->p_instance->INT_MASK, (__INTERRUPT__))

Disable the specified I2S interrupts.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S handle.
  <strong>INTERRUPT</strong> | Specifies the interrupt source to disable. This parameter can be one of the following values: I2S_IT_TXFO TX FIFO write overflow interrupt I2S_IT_TXFE TX FIFO empty trigger interrupt I2S_IT_RXFO RX FIFO receive overflow interrupt I2S_IT_RXDA RX FIFO data available interrupt

Return values

  None |

Definition at line 457 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE_RX_BLOCK

#define __HAL_I2S_DISABLE_RX_BLOCK | ( |  | __HANDLE__ | ) | ll_i2s_disable_rxblock((__HANDLE__)->p_instance)

Disable the specified I2S receiver block.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 353 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE_RX_CHANNEL

#define __HAL_I2S_DISABLE_RX_CHANNEL | ( |  | __HANDLE__ | ) | ll_i2s_disable_rx((__HANDLE__)->p_instance)

Disable the specified I2S receiver channel.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 381 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE_TX_BLOCK

#define __HAL_I2S_DISABLE_TX_BLOCK | ( |  | __HANDLE__ | ) | ll_i2s_disable_txblock((__HANDLE__)->p_instance)

Disable the specified I2S transmitter block.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 341 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_DISABLE_TX_CHANNEL

#define __HAL_I2S_DISABLE_TX_CHANNEL | ( |  | __HANDLE__ | ) | ll_i2s_disable_tx((__HANDLE__)->p_instance)

Disable the specified I2S transmitter channel.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 367 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE

#define __HAL_I2S_ENABLE | ( |  | __HANDLE__ | ) | SET_BITS((__HANDLE__)->p_instance->EN, I2S_EN_I2S_EN)

Enable the specified I2S peripheral.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 302 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE_CLOCK

#define __HAL_I2S_ENABLE_CLOCK | ( |  | __HANDLE__ | ) | SET_BITS((__HANDLE__)->p_instance->CLK_EN, I2S_CLK_EN_CLK_EN)

Enable the specified I2S clock.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 316 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE_DMA

#define __HAL_I2S_ENABLE_DMA | ( |  | __HANDLE__ | ) | ll_i2s_enable_dma(__HANDLE__->p_instance)

Enable the I2S DMA Request.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 399 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE_DMA_MODE

#define __HAL_I2S_ENABLE_DMA_MODE | ( |  | __HANDLE__ | ) | ll_i2s_enable_dma_mode(__HANDLE__->p_instance)

Enable the I2S DMA mode.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 418 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE_IT

#define __HAL_I2S_ENABLE_IT | ( |  | __HANDLE__,
|  |  | __INTERRUPT__
| ) |  | CLEAR_BITS((__HANDLE__)->p_instance->INT_MASK, (__INTERRUPT__))

Enable the specified I2S interrupts.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.
  <strong>INTERRUPT</strong> | Specifies the interrupt source to enable. This parameter can be one of the following values: I2S_IT_TXFO TX FIFO write overflow interrupt I2S_IT_TXFE TX FIFO empty trigger interrupt I2S_IT_RXFO RX FIFO receive overflow interrupt I2S_IT_RXDA RX FIFO data available interrupt

Return values

  None |

Definition at line 444 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE_RX_BLOCK

#define __HAL_I2S_ENABLE_RX_BLOCK | ( |  | __HANDLE__ | ) | ll_i2s_enable_rxblock((__HANDLE__)->p_instance)

Enable the specified I2S receiver block.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 347 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE_RX_CHANNEL

#define __HAL_I2S_ENABLE_RX_CHANNEL | ( |  | __HANDLE__ | ) | ll_i2s_enable_rx((__HANDLE__)->p_instance)

Enable the specified I2S receiver channel.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 374 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE_TX_BLOCK

#define __HAL_I2S_ENABLE_TX_BLOCK | ( |  | __HANDLE__ | ) | ll_i2s_enable_txblock((__HANDLE__)->p_instance)

Enable the specified I2S transmitter block.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 335 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_ENABLE_TX_CHANNEL

#define __HAL_I2S_ENABLE_TX_CHANNEL | ( |  | __HANDLE__ | ) | ll_i2s_enable_tx((__HANDLE__)->p_instance)

Enable the specified I2S transmitter channel.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 360 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_FLUSH_RX_FIFO

#define __HAL_I2S_FLUSH_RX_FIFO | ( |  | __HANDLE__ | ) | ll_i2s_clr_rxfifo_all((__HANDLE__)->p_instance)

Flush the I2S receiver FIFO.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 393 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_FLUSH_TX_FIFO

#define __HAL_I2S_FLUSH_TX_FIFO | ( |  | __HANDLE__ | ) | ll_i2s_clr_txfifo_all((__HANDLE__)->p_instance)

Flush the I2S transmitter FIFO.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 387 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_GET_FLAG

#define __HAL_I2S_GET_FLAG | ( |  | __HANDLE__,
|  |  | __FLAG__
| ) |  | ((READ_BITS((__HANDLE__)->p_instance->INT_STAT, (__FLAG__)) != 0) ? SET : RESET)

Check whether the specified I2S flag is set or not.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.
  <strong>FLAG</strong> | Specifies the flag to check. This parameter can be one of the following values: I2S_FLAG_TXFO TX FIFO write overflow flag I2S_FLAG_TXFE TX FIFO empty trigger flag I2S_FLAG_RXFO RX FIFO receive overflow flag I2S_FLAG_RXDA RX FIFO data available flag

Return values

  The | new state of FLAG (TRUE or FALSE).

Definition at line 470 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_RESET_HANDLE_STATE

#define __HAL_I2S_RESET_HANDLE_STATE | ( |  | __HANDLE__ | ) | ((__HANDLE__)->state = HAL_I2S_STATE_RESET)

Reset I2S handle states.

Parameters

  <strong>HANDLE</strong> | I2S handle.

Return values

  None |

Definition at line 296 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_RESET_RXDMA

#define __HAL_I2S_RESET_RXDMA | ( |  | __HANDLE__ | ) | WRITE_REG((__HANDLE__)->p_instance->RST_RX_DMA, I2S_RST_RX_DMA_RST_RX_DMA)

Reset the I2S RX DMA request to the lowest enabled channel.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 431 of file gr55xx_hal_i2s.h.

## ◆ __HAL_I2S_RESET_TXDMA

#define __HAL_I2S_RESET_TXDMA | ( |  | __HANDLE__ | ) | WRITE_REG((__HANDLE__)->p_instance->RST_TX_DMA, I2S_RST_TX_DMA_RST_TX_DMA)

Reset the I2S TX DMA request to the lowest enabled channel.

Parameters

  <strong>HANDLE</strong> | Specifies the I2S Handle.

Return values

  None |

Definition at line 412 of file gr55xx_hal_i2s.h.

I2S_FLAG_RXFO
#define I2S_FLAG_RXFO
RX FIFO receive overflow flag
Definition: gr55xx_hal_i2s.h:266
I2S_FLAG_TXFO
#define I2S_FLAG_TXFO
TX FIFO write overflow flag
Definition: gr55xx_hal_i2s.h:264