docs/hal_html/hal__i2s_8h_source.html

#ifndef HAL_I2S_H

#define HAL_I2S_H


#ifdef __cplusplus

extern "C" {

#endif


#include "hal_common.h"


#define HAL_I2S_DRIVER_VERSION (MAKE_VERSION(0, 1, 0))


typedef enum _i2s_status {

    I2S_Status_Ok                 = 0U,

    I2S_Status_Fail               = 1U,

    I2S_Status_InvalidArgument    = 2U,

    I2S_Status_TxBusy             = 3U,

    I2S_Status_UnsupportedBitRate = 4U,

} i2s_status_t;


typedef enum _i2s_flag {

    I2S_FlagTxFifoEmpty   =  4U,

    I2S_FlagTxFifoOverrun =  5U,

} i2s_flag_t;


#if defined(__CC_ARM)

#pragma anon_unions

#endif


typedef enum _i2s_sclk_per_sample {

    I2S_SclkCycles_16 = 0U,

    I2S_SclkCycles_24 = 1U,

    I2S_SclkCycles_32 = 2U,

} i2s_sclk_per_sample_t;


typedef enum _i2s_sclk_gating {

    I2S_NoSclkGating        = 0U,

    I2S_SclkGatingCycles_12 = 1U,

    I2S_SclkGatingCycles_16 = 2U,

    I2S_SclkGatingCycles_20 = 3U,

    I2S_SclkGatingCycles_24 = 4U,

} i2s_sclk_gating_t;


typedef enum _i2s_resolution {

    I2S_ResolutionDefault = 0U,

    I2S_Resolution_12     = 1U,

    I2S_Resolution_16     = 2U,

    I2S_Resolution_20     = 3U,

    I2S_Resolution_24     = 4U,

    I2S_Resolution_32     = 5U,

} i2s_resolution_t;


typedef enum _i2s_interrupt_level {

    I2S_InterruptTriggerLevel_1  = 0U,

    I2S_InterruptTriggerLevel_2  = 1U,

    I2S_InterruptTriggerLevel_3  = 2U,

    I2S_InterruptTriggerLevel_4  = 3U,

    I2S_InterruptTriggerLevel_5  = 4U,

    I2S_InterruptTriggerLevel_6  = 5U,

    I2S_InterruptTriggerLevel_7  = 6U,

    I2S_InterruptTriggerLevel_8  = 7U,

    I2S_InterruptTriggerLevel_9  = 8U,

    I2S_InterruptTriggerLevel_10 = 9U,

    I2S_InterruptTriggerLevel_11 = 10U,

    I2S_InterruptTriggerLevel_12 = 11U,

    I2S_InterruptTriggerLevel_13 = 12U,

    I2S_InterruptTriggerLevel_14 = 13U,

    I2S_InterruptTriggerLevel_15 = 14U,

    I2S_InterruptTriggerLevel_16 = 15U,

} i2s_interrupt_level_t;


typedef struct _i2s_config {

    uint32_t              sample_rate;

    i2s_sclk_per_sample_t sclk_per_sample;

    i2s_sclk_gating_t     sclk_gating;

    i2s_resolution_t      resolution;

    i2s_interrupt_level_t interrupt_level;

} i2s_config_t;


typedef struct _i2s_transfer {

    uint32_t *left_samples;

    uint32_t *right_samples;

    size_t   nb_samples;

} i2s_transfer_t;


typedef struct _i2s_handle i2s_handle_t;


typedef void (*i2s_transfer_callback_t)(I2S_Type *base, i2s_handle_t *handle,

    i2s_flag_t interrupt_flag, void *user_data);


struct _i2s_handle {

    i2s_transfer_callback_t callback;

    void                    *user_data;

    uint32_t                *left_samples;

    uint32_t                *right_samples;

    size_t                  nb_samples;

};


i2s_status_t I2S_Init(I2S_Type *base, const i2s_config_t *config,

    uint32_t source_clock_hz);


void I2S_Deinit(I2S_Type *base);


void I2S_GetDefaultConfig(i2s_config_t *config);


static inline void I2S_EnableInterrupt(I2S_Type *base, i2s_flag_t idx)

{

    base->IMR0 &= ~(1 << idx);

}


static inline void I2S_EnableInterruptMask(I2S_Type *base, uint32_t mask)

{

   base->IMR0 &= ~mask;

}


static inline bool I2S_IsInterruptEnabled(I2S_Type *base, i2s_flag_t idx)

{

    return !(base->IMR0 & (1 << idx));

}


static inline uint32_t I2S_GetEnabledInterruptMask(I2S_Type *base)

{

    return base->IMR0;

}


static inline void I2S_DisableInterrupt(I2S_Type *base, i2s_flag_t idx)

{

    base->IMR0 |= (1 << idx);

}


static inline void I2S_DisableInterruptMask(I2S_Type *base, uint32_t mask)

{

    base->IMR0 |= mask;

}


static inline bool I2S_GetInterruptStatus(I2S_Type *base, i2s_flag_t idx)

{

    return base->ISR0 & (1 << idx);

}


static inline uint32_t I2S_GetInterruptStatusMask(I2S_Type *base)

{

    return base->ISR0;

}


static inline void I2S_ClearDataOverrunFlag(I2S_Type *base)

{

    (void) base->TOR0;

}


void I2S_WriteLeftFifo(I2S_Type *base, uint32_t sample);


void I2S_WriteRightFifo(I2S_Type *base, uint32_t sample);


static inline void I2S_AbortTx(I2S_Type *base)

{

    base->TXFFR = (1 << I2S_TXFFR_TXFFR_Pos);

}


static inline void I2S_EnableTx(I2S_Type *base)

{

    SET_VAL_MSK(base->ITER, I2S_ITER_TXEN_Msk, I2S_ITER_TXEN_Pos, 1U);

    SET_VAL_MSK(base->CER, I2S_CER_CLKEN_Msk, I2S_CER_CLKEN_Pos, 1U);

}


static inline void I2S_DisableTx(I2S_Type *base)

{

    SET_VAL_MSK(base->CER, I2S_CER_CLKEN_Msk, I2S_CER_CLKEN_Pos, 0U);

    SET_VAL_MSK(base->ITER, I2S_ITER_TXEN_Msk, I2S_ITER_TXEN_Pos, 0U);

}


i2s_status_t I2S_TransferCreateHandle(I2S_Type *base, i2s_handle_t *handle,

    i2s_transfer_callback_t callback, void *user_data);


i2s_status_t I2S_TransferNonBlocking(I2S_Type *base,

    i2s_handle_t *handle, i2s_transfer_t *xfer);


void I2S_TransferAbort(I2S_Type *base, i2s_handle_t *handle);


void I2S_TransferHandleIRQ(I2S_Type *base, i2s_handle_t *handle);


#ifdef __cplusplus

}

#endif


#endif /* HAL_I2S_H */


I2S_DisableTx
static void I2S_DisableTx(I2S_Type *base)
Выключение передатчика I2S.
Definition hal_i2s.h:375

I2S_DisableInterrupt
static void I2S_DisableInterrupt(I2S_Type *base, i2s_flag_t idx)
Запрет прерывания
Definition hal_i2s.h:272

I2S_EnableInterrupt
static void I2S_EnableInterrupt(I2S_Type *base, i2s_flag_t idx)
Разрешение прерывания
Definition hal_i2s.h:220

I2S_DisableInterruptMask
static void I2S_DisableInterruptMask(I2S_Type *base, uint32_t mask)
Запрет прерываний по маске
Definition hal_i2s.h:283

I2S_Init
i2s_status_t I2S_Init(I2S_Type *base, const i2s_config_t *config, uint32_t source_clock_hz)
Инициализация драйвера I2S.

I2S_EnableTx
static void I2S_EnableTx(I2S_Type *base)
Включение передатчика I2S.
Definition hal_i2s.h:364

I2S_GetEnabledInterruptMask
static uint32_t I2S_GetEnabledInterruptMask(I2S_Type *base)
Запрос маски разрешенных прерываний I2S.
Definition hal_i2s.h:261

i2s_resolution_t
enum _i2s_resolution i2s_resolution_t
Разрядность данных I2S.

I2S_TransferNonBlocking
i2s_status_t I2S_TransferNonBlocking(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_t *xfer)
Неблокирующая выдача через высокоприоритетный буфер

I2S_AbortTx
static void I2S_AbortTx(I2S_Type *base)
Отмена выдачи по I2S.
Definition hal_i2s.h:354

i2s_config_t
struct _i2s_config i2s_config_t
Структура конфигурации контроллера I2S.

I2S_GetInterruptStatus
static bool I2S_GetInterruptStatus(I2S_Type *base, i2s_flag_t idx)
Получение состояния флага прерывания
Definition hal_i2s.h:297

i2s_flag_t
enum _i2s_flag i2s_flag_t
Флаги прерываний I2S.

_i2s_flag
_i2s_flag
Флаги прерываний I2S.
Definition hal_i2s.h:51

i2s_transfer_t
struct _i2s_transfer i2s_transfer_t
Структура для передачи данных I2S в неблокирующем режиме (по прерыванию)

I2S_Deinit
void I2S_Deinit(I2S_Type *base)
Деинициализация драйвера I2S.

_i2s_status
_i2s_status
Коды возврата функций драйвера I2S.
Definition hal_i2s.h:40

i2s_interrupt_level_t
enum _i2s_interrupt_level i2s_interrupt_level_t
Уровни срабатывания прерывания по опустошению очереди I2S.

_i2s_sclk_per_sample
_i2s_sclk_per_sample
Перечисление возможных значений числа синхроимпульсов sclk на левый и правый поток
Definition hal_i2s.h:64

I2S_WriteRightFifo
void I2S_WriteRightFifo(I2S_Type *base, uint32_t sample)
Запись сэмпла в правый канал I2S.

I2S_IsInterruptEnabled
static bool I2S_IsInterruptEnabled(I2S_Type *base, i2s_flag_t idx)
Запрос - разрешено ли прерывание I2S.
Definition hal_i2s.h:245

i2s_sclk_per_sample_t
enum _i2s_sclk_per_sample i2s_sclk_per_sample_t
Перечисление возможных значений числа синхроимпульсов sclk на левый и правый поток

I2S_TransferCreateHandle
i2s_status_t I2S_TransferCreateHandle(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_callback_t callback, void *user_data)
Инициализация обработчика событий I2S.

i2s_sclk_gating_t
enum _i2s_sclk_gating i2s_sclk_gating_t
Перечисление возможных значений обрезания числа синхроимпульсов sclk.

I2S_ClearDataOverrunFlag
static void I2S_ClearDataOverrunFlag(I2S_Type *base)
Сброс флага переполнения очереди выдачи
Definition hal_i2s.h:319

I2S_GetInterruptStatusMask
static uint32_t I2S_GetInterruptStatusMask(I2S_Type *base)
Получение маски активных прерываний
Definition hal_i2s.h:309

I2S_EnableInterruptMask
static void I2S_EnableInterruptMask(I2S_Type *base, uint32_t mask)
Разрешение прерываний по маске
Definition hal_i2s.h:231

I2S_WriteLeftFifo
void I2S_WriteLeftFifo(I2S_Type *base, uint32_t sample)
Запись сэмпла в левый канал I2S.

I2S_GetDefaultConfig
void I2S_GetDefaultConfig(i2s_config_t *config)
Получение параметров драйвера I2S по умолчанию

_i2s_sclk_gating
_i2s_sclk_gating
Перечисление возможных значений обрезания числа синхроимпульсов sclk.
Definition hal_i2s.h:77

_i2s_resolution
_i2s_resolution
Разрядность данных I2S.
Definition hal_i2s.h:88

_i2s_interrupt_level
_i2s_interrupt_level
Уровни срабатывания прерывания по опустошению очереди I2S.
Definition hal_i2s.h:100

I2S_TransferHandleIRQ
void I2S_TransferHandleIRQ(I2S_Type *base, i2s_handle_t *handle)
Установка обработчика на прерывания от I2S, не связанных с приемом/выдачей

I2S_TransferAbort
void I2S_TransferAbort(I2S_Type *base, i2s_handle_t *handle)
Отмена выдачи из высокоприоритетного буфера

i2s_transfer_callback_t
void(* i2s_transfer_callback_t)(I2S_Type *base, i2s_handle_t *handle, i2s_flag_t interrupt_flag, void *user_data)
Функция обратного вызова I2S.
Definition hal_i2s.h:153

i2s_status_t
enum _i2s_status i2s_status_t
Коды возврата функций драйвера I2S.

I2S_FlagTxFifoOverrun
@ I2S_FlagTxFifoOverrun
Definition hal_i2s.h:53

I2S_FlagTxFifoEmpty
@ I2S_FlagTxFifoEmpty
Definition hal_i2s.h:52

I2S_Status_Ok
@ I2S_Status_Ok
Definition hal_i2s.h:41

I2S_Status_Fail
@ I2S_Status_Fail
Definition hal_i2s.h:42

I2S_Status_UnsupportedBitRate
@ I2S_Status_UnsupportedBitRate
Definition hal_i2s.h:45

I2S_Status_TxBusy
@ I2S_Status_TxBusy
Definition hal_i2s.h:44

I2S_Status_InvalidArgument
@ I2S_Status_InvalidArgument
Definition hal_i2s.h:43

I2S_SclkCycles_16
@ I2S_SclkCycles_16
Definition hal_i2s.h:65

I2S_SclkCycles_24
@ I2S_SclkCycles_24
Definition hal_i2s.h:66

I2S_SclkCycles_32
@ I2S_SclkCycles_32
Definition hal_i2s.h:67

I2S_SclkGatingCycles_12
@ I2S_SclkGatingCycles_12
Definition hal_i2s.h:79

I2S_NoSclkGating
@ I2S_NoSclkGating
Definition hal_i2s.h:78

I2S_SclkGatingCycles_20
@ I2S_SclkGatingCycles_20
Definition hal_i2s.h:81

I2S_SclkGatingCycles_16
@ I2S_SclkGatingCycles_16
Definition hal_i2s.h:80

I2S_SclkGatingCycles_24
@ I2S_SclkGatingCycles_24
Definition hal_i2s.h:82

I2S_Resolution_24
@ I2S_Resolution_24
Definition hal_i2s.h:93

I2S_Resolution_32
@ I2S_Resolution_32
Definition hal_i2s.h:94

I2S_Resolution_20
@ I2S_Resolution_20
Definition hal_i2s.h:92

I2S_Resolution_12
@ I2S_Resolution_12
Definition hal_i2s.h:90

I2S_ResolutionDefault
@ I2S_ResolutionDefault
Definition hal_i2s.h:89

I2S_Resolution_16
@ I2S_Resolution_16
Definition hal_i2s.h:91

I2S_InterruptTriggerLevel_11
@ I2S_InterruptTriggerLevel_11
Definition hal_i2s.h:111

I2S_InterruptTriggerLevel_16
@ I2S_InterruptTriggerLevel_16
Definition hal_i2s.h:116

I2S_InterruptTriggerLevel_13
@ I2S_InterruptTriggerLevel_13
Definition hal_i2s.h:113

I2S_InterruptTriggerLevel_14
@ I2S_InterruptTriggerLevel_14
Definition hal_i2s.h:114

I2S_InterruptTriggerLevel_15
@ I2S_InterruptTriggerLevel_15
Definition hal_i2s.h:115

I2S_InterruptTriggerLevel_2
@ I2S_InterruptTriggerLevel_2
Definition hal_i2s.h:102

I2S_InterruptTriggerLevel_6
@ I2S_InterruptTriggerLevel_6
Definition hal_i2s.h:106

I2S_InterruptTriggerLevel_5
@ I2S_InterruptTriggerLevel_5
Definition hal_i2s.h:105

I2S_InterruptTriggerLevel_12
@ I2S_InterruptTriggerLevel_12
Definition hal_i2s.h:112

I2S_InterruptTriggerLevel_8
@ I2S_InterruptTriggerLevel_8
Definition hal_i2s.h:108

I2S_InterruptTriggerLevel_10
@ I2S_InterruptTriggerLevel_10
Definition hal_i2s.h:110

I2S_InterruptTriggerLevel_4
@ I2S_InterruptTriggerLevel_4
Definition hal_i2s.h:104

I2S_InterruptTriggerLevel_9
@ I2S_InterruptTriggerLevel_9
Definition hal_i2s.h:109

I2S_InterruptTriggerLevel_7
@ I2S_InterruptTriggerLevel_7
Definition hal_i2s.h:107

I2S_InterruptTriggerLevel_1
@ I2S_InterruptTriggerLevel_1
Definition hal_i2s.h:101

I2S_InterruptTriggerLevel_3
@ I2S_InterruptTriggerLevel_3
Definition hal_i2s.h:103

_i2s_config
Структура конфигурации контроллера I2S.
Definition hal_i2s.h:122

_i2s_config::resolution
i2s_resolution_t resolution
Definition hal_i2s.h:126

_i2s_config::interrupt_level
i2s_interrupt_level_t interrupt_level
Definition hal_i2s.h:127

_i2s_config::sclk_per_sample
i2s_sclk_per_sample_t sclk_per_sample
Definition hal_i2s.h:124

_i2s_config::sclk_gating
i2s_sclk_gating_t sclk_gating
Definition hal_i2s.h:125

_i2s_config::sample_rate
uint32_t sample_rate
Definition hal_i2s.h:123

_i2s_handle
Структура обработчика драйвера I2S.
Definition hal_i2s.h:159

_i2s_handle::nb_samples
size_t nb_samples
Definition hal_i2s.h:165

_i2s_handle::callback
i2s_transfer_callback_t callback
Definition hal_i2s.h:160

_i2s_handle::user_data
void * user_data
Definition hal_i2s.h:161

_i2s_handle::left_samples
uint32_t * left_samples
Definition hal_i2s.h:163

_i2s_handle::right_samples
uint32_t * right_samples
Definition hal_i2s.h:164

_i2s_transfer
Структура для передачи данных I2S в неблокирующем режиме (по прерыванию)
Definition hal_i2s.h:134

_i2s_transfer::right_samples
uint32_t * right_samples
Definition hal_i2s.h:136

_i2s_transfer::left_samples
uint32_t * left_samples
Definition hal_i2s.h:135

_i2s_transfer::nb_samples
size_t nb_samples
Definition hal_i2s.h:137