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_MAX32660_I2S_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32660_I2S_H_
 
/* **** Includes **** */
#include "mxc_sys.h"
#include "dma.h"
#include "spimss_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* **** Definitions **** */
 
typedef enum {
    I2S_MAP_A = 0,
    I2S_MAP_B = 1,
} mxc_i2s_sys_map_t;
 
typedef enum {
    LEFT_JUSTIFIED = 0,
    RIGHT_JUSTIFIED = 1,
} mxc_i2s_justify_t;
 
typedef enum {
    STEREO_MODE = 0,
    MONO_MODE = 1,
} mxc_i2s_audio_mode_t;
 
typedef enum {
    AUDIO_OUT = 1,
    AUDIO_IN = 2,
} mxc_i2s_direction_t;
 
typedef struct {
    mxc_i2s_sys_map_t map;
    mxc_i2s_justify_t justify;
    mxc_i2s_audio_mode_t audio_mode;
    mxc_i2s_direction_t audio_direction;
    uint16_t sample_rate;
    unsigned int start_immediately;
    unsigned int dma_reload_en;
    void *src_addr;
    void *dst_addr;
    uint32_t length;
} mxc_i2s_config_t;
 
/* **** Function Prototypes **** */
 
int MXC_I2S_Init(const mxc_i2s_config_t *config, void (*dma_ctz_cb)(int, int));
 
int MXC_I2S_Shutdown(void);
 
int MXC_I2S_Mute(void);
 
int MXC_I2S_Unmute(void);
 
int MXC_I2S_Pause(void);
 
int MXC_I2S_Unpause(void);
 
int MXC_I2S_Stop(void);
 
int MXC_I2S_Start(void);
 
int MXC_I2S_DMA_ClearFlags(void);
 
int MXC_I2S_DMA_SetAddrCnt(void *src_addr, void *dst_addr, unsigned int count);
 
int MXC_I2S_DMA_SetReload(void *src_addr, void *dst_addr, unsigned int count);
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32660_I2S_H_