i2s_user_config_t Struct Reference

I2S user configuration structure. More...

#include <platform/pal/i2s/inc/i2s_pal.h>

Data Fields

i2s_transfer_type_t transferType
 
i2s_mode_t mode
 
uint32_t baudRate
 
uint8_t wordWidth
 
i2s_callback_t callback
 
void * callbackParam
 
uint8_t rxDMAChannel
 
uint8_t txDMAChannel
 
void * extension
 

Detailed Description

I2S user configuration structure.

Implements : i2s_user_config_t_Class

Definition at line 62 of file i2s_pal.h.

Field Documentation

uint32_t baudRate

Baud rate in hertz

Definition at line 66 of file i2s_pal.h.

i2s_callback_t callback

User callback function. Can be null if not needed.

Definition at line 70 of file i2s_pal.h.

void* callbackParam

Parameter for the callback function

Definition at line 71 of file i2s_pal.h.

void* extension

This field will be used to add extra settings to the basic configuration like FlexIO data pins

Definition at line 74 of file i2s_pal.h.

i2s_mode_t mode

Master or slave

Definition at line 65 of file i2s_pal.h.

uint8_t rxDMAChannel

Rx DMA channel number. Only used in DMA mode

Definition at line 72 of file i2s_pal.h.

i2s_transfer_type_t transferType

Driver type: interrupts/DMA

Definition at line 64 of file i2s_pal.h.

uint8_t txDMAChannel

Tx DMA channel number. Only used in DMA mode

Definition at line 73 of file i2s_pal.h.

uint8_t wordWidth

Number of bits in a word - multiple of 8. The word size in transfer functions depends on this parameter Word size for each buffer read/write is 1 byte, 2 bytes or 4 byte, whichever larger and close to wordWidth the most

Definition at line 67 of file i2s_pal.h.


The documentation for this struct was generated from the following file: