Macros
I2S Exported Macros
Peripheral Driver » HAL Driver » I2S » Defines

## 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->ENABLE, I2S_ENABLE_EN)
| Enable the specified I2S peripheral. More...
#define | __HAL_I2S_DISABLE(__HANDLE__) CLEAR_BITS((__HANDLE__)->p_instance->ENABLE, I2S_ENABLE_EN)
| Disable the specified I2S peripheral. More...
#define | __HAL_I2S_ENABLE_CLOCK(__HANDLE__) SET_BITS((__HANDLE__)->p_instance->CLKEN, I2S_CLKEN_EN)
| Enable the specified I2S clock. More...
#define | __HAL_I2S_DISABLE_CLOCK(__HANDLE__) CLEAR_BITS((__HANDLE__)->p_instance->CLKEN, I2S_CLKEN_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__, __CH__) ll_i2s_enable_tx((__HANDLE__)->p_instance, (__CH__))
| Enable the specified I2S transmitter channel. More...
#define | __HAL_I2S_DISABLE_TX_CHANNEL(__HANDLE__, __CH__) ll_i2s_disable_tx((__HANDLE__)->p_instance, (__CH__))
| Disable the specified I2S transmitter channel. More...
#define | __HAL_I2S_ENABLE_RX_CHANNEL(__HANDLE__, __CH__) ll_i2s_enable_rx((__HANDLE__)->p_instance, (__CH__))
| Enable the specified I2S receiver channel. More...
#define | __HAL_I2S_DISABLE_RX_CHANNEL(__HANDLE__, __CH__) ll_i2s_disable_rx((__HANDLE__)->p_instance, (__CH__))
| 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->TXDMA_RST, I2S_TXDMA_RST)
| Reset the I2S TX DMA request to the lowest enabled channel. More...
#define | __HAL_I2S_RESET_RXDMA(__HANDLE__) WRITE_REG((__HANDLE__)->p_instance->RXDMA_RST, I2S_RXDMA_RST)
| Reset the I2S RX DMA request to the lowest enabled channel. More...
#define | __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BITS((__HANDLE__)->p_instance->I2S_CHANNEL[0].INTMASK, (__INTERRUPT__))
| Enable the specified I2S interrupts. More...
#define | __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) SET_BITS((__HANDLE__)->p_instance->I2S_CHANNEL[0].INTMASK, (__INTERRUPT__))
| Disable the specified I2S interrupts. More...
#define | __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((READ_BITS((__HANDLE__)->p_instance->I2S_CHANNEL[0].INTSTAT, (__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->I2S_CHANNEL[0].RXOVR, I2S_RXOVR_RXCHO);\
} \
if ((__FLAG__) & I2S_FLAG_TXFO) \
{ \
READ_BITS((__HANDLE__)->p_instance->I2S_CHANNEL[0].TXOVR, I2S_TXOVR_TXCHO);\
} \
} 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 |

## ◆ __HAL_I2S_DISABLE

#define __HAL_I2S_DISABLE | ( |  | __HANDLE__ | ) | CLEAR_BITS((__HANDLE__)->p_instance->ENABLE, I2S_ENABLE_EN)

Disable the specified I2S peripheral.

Parameters

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

Return values

  None |

## ◆ __HAL_I2S_DISABLE_CLOCK

#define __HAL_I2S_DISABLE_CLOCK | ( |  | __HANDLE__ | ) | CLEAR_BITS((__HANDLE__)->p_instance->CLKEN, I2S_CLKEN_EN)

Disable the specified I2S clock.

Parameters

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

Return values

  None |

## ◆ __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 |

## ◆ __HAL_I2S_DISABLE_IT

#define __HAL_I2S_DISABLE_IT | ( |  | __HANDLE__,
|  |  | __INTERRUPT__
| ) |  | SET_BITS((__HANDLE__)->p_instance->I2S_CHANNEL[0].INTMASK, (__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 |

## ◆ __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 |

## ◆ __HAL_I2S_DISABLE_RX_CHANNEL

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

Disable the specified I2S receiver channel.

Parameters

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

Return values

  None |

## ◆ __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 |

## ◆ __HAL_I2S_DISABLE_TX_CHANNEL

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

Disable the specified I2S transmitter channel.

Parameters

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

Return values

  None |

## ◆ __HAL_I2S_ENABLE

#define __HAL_I2S_ENABLE | ( |  | __HANDLE__ | ) | SET_BITS((__HANDLE__)->p_instance->ENABLE, I2S_ENABLE_EN)

Enable the specified I2S peripheral.

Parameters

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

Return values

  None |

## ◆ __HAL_I2S_ENABLE_CLOCK

#define __HAL_I2S_ENABLE_CLOCK | ( |  | __HANDLE__ | ) | SET_BITS((__HANDLE__)->p_instance->CLKEN, I2S_CLKEN_EN)

Enable the specified I2S clock.

Parameters

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

Return values

  None |

## ◆ __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 |

## ◆ __HAL_I2S_ENABLE_IT

#define __HAL_I2S_ENABLE_IT | ( |  | __HANDLE__,
|  |  | __INTERRUPT__
| ) |  | CLEAR_BITS((__HANDLE__)->p_instance->I2S_CHANNEL[0].INTMASK, (__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 |

## ◆ __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 |

## ◆ __HAL_I2S_ENABLE_RX_CHANNEL

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

Enable the specified I2S receiver channel.

Parameters

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

Return values

  None |

## ◆ __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 |

## ◆ __HAL_I2S_ENABLE_TX_CHANNEL

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

Enable the specified I2S transmitter channel.

Parameters

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

Return values

  None |

## ◆ __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 |

## ◆ __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 |

## ◆ __HAL_I2S_GET_FLAG

#define __HAL_I2S_GET_FLAG | ( |  | __HANDLE__,
|  |  | __FLAG__
| ) |  | ((READ_BITS((__HANDLE__)->p_instance->I2S_CHANNEL[0].INTSTAT, (__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).

## ◆ __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 |

## ◆ __HAL_I2S_RESET_RXDMA

#define __HAL_I2S_RESET_RXDMA | ( |  | __HANDLE__ | ) | WRITE_REG((__HANDLE__)->p_instance->RXDMA_RST, I2S_RXDMA_RST)

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

Parameters

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

Return values

  None |

## ◆ __HAL_I2S_RESET_TXDMA

#define __HAL_I2S_RESET_TXDMA | ( |  | __HANDLE__ | ) | WRITE_REG((__HANDLE__)->p_instance->TXDMA_RST, I2S_TXDMA_RST)

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

Parameters

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

Return values

  None |

I2S_FLAG_RXFO
#define I2S_FLAG_RXFO
Definition: gr55xx_hal_i2s.h:252
I2S_FLAG_TXFO
#define I2S_FLAG_TXFO
Definition: gr55xx_hal_i2s.h:250