i2s.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_I2S_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_I2S_H_
 
/* **** Includes **** */
#include "mxc_sys.h"
#include "dma.h"
#include "i2s_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* **** Definitions **** */
 
typedef enum {
    MXC_I2S_STEREO = 0,
    MXC_I2S_MONO_LEFT_CH = 2,
    MXC_I2S_MONO_RIGHT_CH = 3
} mxc_i2s_stereo_t;
 
typedef enum { MXC_I2S_POL_NORMAL, MXC_I2S_POL_INVERSE } mxc_i2s_polarity_t;
 
typedef enum { MXC_I2S_MSB_FIRST, MXC_I2S_LSB_FIRST } mxc_i2s_bitorder_t;
 
typedef enum { MXC_I2S_MSB_JUSTIFY, MXC_I2S_LSB_JUSTIFY } mxc_i2s_justify_t;
 
typedef enum {
    MXC_I2S_WSIZE_BYTE, 
    MXC_I2S_WSIZE_HALFWORD, 
    MXC_I2S_WSIZE_WORD, 
 
    MXC_I2S_DATASIZE_BYTE = MXC_I2S_WSIZE_BYTE, 
    MXC_I2S_DATASIZE_HALFWORD =
        MXC_I2S_WSIZE_HALFWORD, 
    MXC_I2S_DATASIZE_WORD = MXC_I2S_WSIZE_WORD, 
} mxc_i2s_wsize_t;
 
typedef enum {
    MXC_I2S_ADJUST_LEFT,
    MXC_I2S_ADJUST_RIGHT,
} mxc_i2s_adjust_t;
 
typedef enum {
    MXC_I2S_INTERNAL_SCK_WS_0,
    MXC_I2S_INTERNAL_SCK_WS_1,
    MXC_I2S_EXTERNAL_SCK_INTERNAL_WS,
    MXC_I2S_EXTERNAL_SCK_EXTERNAL_WS,
} mxc_i2s_ch_mode_t;
 
#define MXC_I2S_SAMPLESIZE_EIGHT (8)
#define MXC_I2S_SAMPLESIZE_SIXTEEN (16)
#define MXC_I2S_SAMPLESIZE_TWENTY (20)
#define MXC_I2S_SAMPLESIZE_TWENTYFOUR (24)
#define MXC_I2S_SAMPLESIZE_THIRTYTWO (32)
 
typedef uint8_t mxc_i2s_samplesize_t;
 
typedef struct {
    mxc_i2s_ch_mode_t channelMode;
    mxc_i2s_stereo_t stereoMode;
    mxc_i2s_wsize_t wordSize;
    mxc_i2s_justify_t justify;
    mxc_i2s_bitorder_t bitOrder;
    mxc_i2s_polarity_t wsPolarity;
    mxc_i2s_samplesize_t
        sampleSize; 
    uint16_t clkdiv;
    mxc_i2s_adjust_t adjust;
    uint8_t bitsWord; 
    void *rawData;
    void *txData;
    void *rxData;
    uint32_t length;
} mxc_i2s_req_t;
 
/* **** Function Prototypes **** */
 
int MXC_I2S_Init(mxc_i2s_req_t *req);
 
int MXC_I2S_Shutdown(void);
 
int MXC_I2S_ConfigData(mxc_i2s_req_t *req);
 
void MXC_I2S_TXEnable(void);
 
void MXC_I2S_TXDisable(void);
 
void MXC_I2S_RXEnable(void);
 
void MXC_I2S_RXDisable(void);
 
int MXC_I2S_SetRXThreshold(uint8_t threshold);
 
int MXC_I2S_SetFrequency(mxc_i2s_ch_mode_t mode, uint16_t clkdiv);
 
int MXC_I2S_SetSampleRate(uint32_t smpl_rate, mxc_i2s_wsize_t smpl_sz);
 
int MXC_I2S_GetSampleRate(void);
 
int MXC_I2S_CalculateClockDiv(uint32_t smpl_rate, mxc_i2s_wsize_t smpl_sz);
 
void MXC_I2S_Flush(void);
 
int MXC_I2S_FillTXFIFO(void *txData, mxc_i2s_wsize_t wordSize, int len, int smpl_cnt);
 
int MXC_I2S_ReadRXFIFO(void *rxData, mxc_i2s_wsize_t wordSize, int len, int smpl_cnt);
 
void MXC_I2S_EnableInt(uint32_t flags);
 
void MXC_I2S_DisableInt(uint32_t flags);
 
int MXC_I2S_GetFlags(void);
 
void MXC_I2S_ClearFlags(uint32_t flags);
 
int MXC_I2S_Transaction(mxc_i2s_req_t *i2s_req);
 
int MXC_I2S_TransactionAsync(mxc_i2s_req_t *i2s_req);
 
int MXC_I2S_TXDMAConfig(void *src_addr, int len);
 
int MXC_I2S_RXDMAConfig(void *dest_addr, int len);
 
void MXC_I2S_Handler(void);
 
void MXC_I2S_RegisterDMACallback(void (*callback)(int, int));
 
void MXC_I2S_RegisterAsyncCallback(void (*callback)(int));
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_I2S_H_