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

## Macros
#define | IS_I2S_DIRECTION(__MODE__)
| Check if I2S Direction Mode is valid. More...
#define | IS_I2S_DATASIZE(__DATASIZE__)
| Check if I2S Data Size is valid. More...
#define | IS_I2S_CPOL(__CPOL__)
| Check if I2S Clock Polarity is valid. More...
#define | IS_I2S_AUDIO_FREQUENCY(__FREQUENCY__) (((__FREQUENCY__) > 0) && ((__FREQUENCY__) <= 1500000))
| Check if I2S Audio Frequency is valid. More...
#define | IS_I2S_FIFO_THRESHOLD(__THR__) (((__THR__) >= 0) && ((__THR__) <= I2S_TX_FIFO_LEVEL_MAX))
| Check if I2S FIFO Threshold is valid. More...

## Detailed Description

## Macro Definition Documentation

## ◆ IS_I2S_AUDIO_FREQUENCY

#define IS_I2S_AUDIO_FREQUENCY | ( |  | __FREQUENCY__ | ) | (((__FREQUENCY__) > 0) && ((__FREQUENCY__) <= 1500000))

Check if I2S Audio Frequency is valid.

Parameters

  <strong>FREQUENCY</strong> | I2S Audio Frequency.

Return values

  SET | (FREQUENCY is valid) or RESET (FREQUENCY is invalid)

Definition at line 528 of file gr55xx_hal_i2s.h.

## ◆ IS_I2S_CPOL

#define IS_I2S_CPOL | ( |  | __CPOL__ | ) |

Value:
(((__CPOL__) == I2S_POLARITY_LOW) || \
((__CPOL__) == I2S_POLARITY_HIGH))

Check if I2S Clock Polarity is valid.

Parameters

  <strong>CPOL</strong> | I2S Clock Polarity.

Return values

  SET | (CPOL is valid) or RESET (CPOL is invalid)

Definition at line 521 of file gr55xx_hal_i2s.h.

## ◆ IS_I2S_DATASIZE

#define IS_I2S_DATASIZE | ( |  | __DATASIZE__ | ) |

Value:
(((__DATASIZE__) == I2S_DATASIZE_12BIT) || \
((__DATASIZE__) == I2S_DATASIZE_16BIT) || \
((__DATASIZE__) == I2S_DATASIZE_20BIT) || \
((__DATASIZE__) == I2S_DATASIZE_24BIT) || \
((__DATASIZE__) == I2S_DATASIZE_32BIT))

Check if I2S Data Size is valid.

Parameters

  <strong>DATASIZE</strong> | I2S Data Size.

Return values

  SET | (DATASIZE is valid) or RESET (DATASIZE is invalid)

Definition at line 511 of file gr55xx_hal_i2s.h.

## ◆ IS_I2S_DIRECTION

#define IS_I2S_DIRECTION | ( |  | __MODE__ | ) |

Value:
(((__MODE__) == I2S_DIRECTION_FULL_DUPLEX) || \
((__MODE__) == I2S_DIRECTION_SIMPLEX_TX) || \
((__MODE__) == I2S_DIRECTION_SIMPLEX_RX))

Check if I2S Direction Mode is valid.

Parameters

  <strong>MODE</strong> | I2S Direction Mode.

Return values

  SET | (MODE is valid) or RESET (MODE is invalid)

Definition at line 503 of file gr55xx_hal_i2s.h.

## ◆ IS_I2S_FIFO_THRESHOLD

#define IS_I2S_FIFO_THRESHOLD | ( |  | __THR__ | ) | (((__THR__) >= 0) && ((__THR__) <= I2S_TX_FIFO_LEVEL_MAX))

Check if I2S FIFO Threshold is valid.

Parameters

  <strong>THR</strong> | I2S FIFO Threshold.

Return values

  SET | (THR is valid) or RESET (THR is invalid)

Definition at line 534 of file gr55xx_hal_i2s.h.

I2S_DATASIZE_32BIT
#define I2S_DATASIZE_32BIT
32-bit serial data transfer
Definition: gr55xx_hal_i2s.h:235
I2S_DIRECTION_SIMPLEX_RX
#define I2S_DIRECTION_SIMPLEX_RX
Simplex RX: Receive only
Definition: gr55xx_hal_i2s.h:213
I2S_DATASIZE_16BIT
#define I2S_DATASIZE_16BIT
16-bit serial data transfer
Definition: gr55xx_hal_i2s.h:232
I2S_DATASIZE_20BIT
#define I2S_DATASIZE_20BIT
20-bit serial data transfer
Definition: gr55xx_hal_i2s.h:233
I2S_DIRECTION_FULL_DUPLEX
#define I2S_DIRECTION_FULL_DUPLEX
Full Duplex: Transmit & Receive
Definition: gr55xx_hal_i2s.h:211
I2S_DIRECTION_SIMPLEX_TX
#define I2S_DIRECTION_SIMPLEX_TX
Simplex TX: Transmit only
Definition: gr55xx_hal_i2s.h:212
I2S_DATASIZE_12BIT
#define I2S_DATASIZE_12BIT
12-bit serial data transfer
Definition: gr55xx_hal_i2s.h:231
I2S_DATASIZE_24BIT
#define I2S_DATASIZE_24BIT
24-bit serial data transfer
Definition: gr55xx_hal_i2s.h:234