1 /**
2  * @file    i2s.c
3  * @brief   Inter-Integrated Sound (I2S) driver implementation.
4  */
5 
6 /******************************************************************************
7  *
8  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by
9  * Analog Devices, Inc.),
10  * Copyright (C) 2023-2024 Analog Devices, Inc.
11  *
12  * Licensed under the Apache License, Version 2.0 (the "License");
13  * you may not use this file except in compliance with the License.
14  * You may obtain a copy of the License at
15  *
16  *     http://www.apache.org/licenses/LICENSE-2.0
17  *
18  * Unless required by applicable law or agreed to in writing, software
19  * distributed under the License is distributed on an "AS IS" BASIS,
20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  * See the License for the specific language governing permissions and
22  * limitations under the License.
23  *
24  ******************************************************************************/
25 
26 #include <stdio.h>
27 #include <stddef.h>
28 #include <stdint.h>
29 #include "mxc_device.h"
30 #include "mxc_assert.h"
31 #include "mxc_lock.h"
32 #include "mxc_sys.h"
33 #include "mxc_delay.h"
34 #include "dma.h"
35 #include "i2s.h"
36 #include "i2s_reva.h"
37 #include "i2s_regs.h"
38 
39 static mxc_i2s_clksrc_t g_i2s_clksrc = MXC_I2S_CLKSRC_ERFO;
40 static uint32_t g_i2s_clkfreq = ERFO_FREQ;
41 
MXC_I2S_Init(mxc_i2s_req_t * req)42 int MXC_I2S_Init(mxc_i2s_req_t *req)
43 {
44     MXC_I2S_Shutdown();
45 
46     // Use ERFO clock by default
47     MXC_SYS_ClockSourceEnable(MXC_SYS_CLOCK_ERFO);
48 
49     MXC_SYS_ClockEnable(MXC_SYS_PERIPH_CLOCK_I2S);
50     MXC_GPIO_Config(&gpio_cfg_i2s0);
51 
52     return MXC_I2S_RevA_Init((mxc_i2s_reva_regs_t *)MXC_I2S, req);
53 }
54 
MXC_I2S_Shutdown(void)55 int MXC_I2S_Shutdown(void)
56 {
57     MXC_I2S_RevA_Shutdown((mxc_i2s_reva_regs_t *)MXC_I2S);
58 
59     MXC_SYS_ClockDisable(MXC_SYS_PERIPH_CLOCK_I2S);
60     MXC_SYS_Reset_Periph(MXC_SYS_RESET1_I2S);
61 
62     return E_NO_ERROR;
63 }
64 
MXC_I2S_ConfigData(mxc_i2s_req_t * req)65 int MXC_I2S_ConfigData(mxc_i2s_req_t *req)
66 {
67     return MXC_I2S_RevA_ConfigData((mxc_i2s_reva_regs_t *)MXC_I2S, req);
68 }
69 
MXC_I2S_SelectClockSource(mxc_i2s_clksrc_t clk_src,uint32_t freq_ext)70 int MXC_I2S_SelectClockSource(mxc_i2s_clksrc_t clk_src, uint32_t freq_ext)
71 {
72     // Check for bad parameters
73     if (clk_src < MXC_I2S_CLKSRC_ERFO || clk_src > MXC_I2S_CLKSRC_EXT) {
74         return E_BAD_PARAM;
75     } else if ((MXC_SYS_GetRevision() & 0xB0) != 0xB0 && clk_src == MXC_I2S_CLKSRC_EXT) {
76         // I2S External Only Supported on ME17 Rev. B chips
77         return E_NOT_SUPPORTED;
78     }
79 
80     // Enable clock source and set frequency
81     if (clk_src == MXC_I2S_CLKSRC_EXT) {
82         MXC_GPIO_Config(&gpio_cfg_i2s0_clkext);
83         g_i2s_clkfreq = freq_ext;
84         MXC_I2S->ctrl1ch0 |= MXC_F_I2S_CTRL1CH0_EXTCLK_EN;
85     } else {
86         MXC_SYS_ClockSourceEnable(MXC_SYS_CLOCK_ERFO);
87         g_i2s_clkfreq = ERFO_FREQ;
88         MXC_I2S->ctrl1ch0 &= ~MXC_F_I2S_CTRL1CH0_EXTCLK_EN;
89     }
90 
91     // Set clock source
92     g_i2s_clksrc = clk_src;
93 
94     return E_NO_ERROR;
95 }
96 
MXC_I2S_TXEnable()97 void MXC_I2S_TXEnable()
98 {
99     MXC_I2S_RevA_TXEnable((mxc_i2s_reva_regs_t *)MXC_I2S);
100 }
101 
MXC_I2S_TXDisable()102 void MXC_I2S_TXDisable()
103 {
104     MXC_I2S_RevA_TXDisable((mxc_i2s_reva_regs_t *)MXC_I2S);
105 }
106 
MXC_I2S_RXEnable()107 void MXC_I2S_RXEnable()
108 {
109     MXC_I2S_RevA_RXEnable((mxc_i2s_reva_regs_t *)MXC_I2S);
110 }
111 
MXC_I2S_RXDisable()112 void MXC_I2S_RXDisable()
113 {
114     MXC_I2S_RevA_RXDisable((mxc_i2s_reva_regs_t *)MXC_I2S);
115 }
116 
MXC_I2S_SetRXThreshold(uint8_t threshold)117 int MXC_I2S_SetRXThreshold(uint8_t threshold)
118 {
119     return MXC_I2S_RevA_SetRXThreshold((mxc_i2s_reva_regs_t *)MXC_I2S, threshold);
120 }
121 
MXC_I2S_SetFrequency(mxc_i2s_ch_mode_t mode,uint16_t clkdiv)122 int MXC_I2S_SetFrequency(mxc_i2s_ch_mode_t mode, uint16_t clkdiv)
123 {
124     return MXC_I2S_RevA_SetFrequency((mxc_i2s_reva_regs_t *)MXC_I2S, mode, clkdiv);
125 }
126 
MXC_I2S_SetSampleRate(uint32_t smpl_rate,mxc_i2s_wsize_t smpl_sz)127 int MXC_I2S_SetSampleRate(uint32_t smpl_rate, mxc_i2s_wsize_t smpl_sz)
128 {
129     return MXC_I2S_RevA_SetSampleRate((mxc_i2s_reva_regs_t *)MXC_I2S, smpl_rate, smpl_sz,
130                                       g_i2s_clkfreq);
131 }
132 
MXC_I2S_GetSampleRate(void)133 int MXC_I2S_GetSampleRate(void)
134 {
135     return MXC_I2S_RevA_GetSampleRate((mxc_i2s_reva_regs_t *)MXC_I2S, g_i2s_clkfreq);
136 }
137 
MXC_I2S_CalculateClockDiv(uint32_t smpl_rate,mxc_i2s_wsize_t smpl_sz)138 int MXC_I2S_CalculateClockDiv(uint32_t smpl_rate, mxc_i2s_wsize_t smpl_sz)
139 {
140     return MXC_I2S_RevA_CalculateClockDiv((mxc_i2s_reva_regs_t *)MXC_I2S, smpl_rate, smpl_sz,
141                                           g_i2s_clkfreq);
142 }
143 
MXC_I2S_Flush(void)144 void MXC_I2S_Flush(void)
145 {
146     MXC_I2S_RevA_Flush((mxc_i2s_reva_regs_t *)MXC_I2S);
147 }
148 
MXC_I2S_FillTXFIFO(void * txData,mxc_i2s_wsize_t wordSize,int len,int smpl_cnt)149 int MXC_I2S_FillTXFIFO(void *txData, mxc_i2s_wsize_t wordSize, int len, int smpl_cnt)
150 {
151     return MXC_I2S_RevA_FillTXFIFO((mxc_i2s_reva_regs_t *)MXC_I2S, txData, wordSize, len, smpl_cnt);
152 }
153 
MXC_I2S_ReadRXFIFO(void * rxData,mxc_i2s_wsize_t wordSize,int len,int smpl_cnt)154 int MXC_I2S_ReadRXFIFO(void *rxData, mxc_i2s_wsize_t wordSize, int len, int smpl_cnt)
155 {
156     return MXC_I2S_RevA_ReadRXFIFO((mxc_i2s_reva_regs_t *)MXC_I2S, rxData, wordSize, len, smpl_cnt);
157 }
158 
MXC_I2S_EnableInt(uint32_t flags)159 void MXC_I2S_EnableInt(uint32_t flags)
160 {
161     MXC_I2S_RevA_EnableInt((mxc_i2s_reva_regs_t *)MXC_I2S, flags);
162 }
163 
MXC_I2S_DisableInt(uint32_t flags)164 void MXC_I2S_DisableInt(uint32_t flags)
165 {
166     MXC_I2S_RevA_DisableInt((mxc_i2s_reva_regs_t *)MXC_I2S, flags);
167 }
168 
MXC_I2S_GetFlags()169 int MXC_I2S_GetFlags()
170 {
171     return MXC_I2S_RevA_GetFlags((mxc_i2s_reva_regs_t *)MXC_I2S);
172 }
173 
MXC_I2S_ClearFlags(uint32_t flags)174 void MXC_I2S_ClearFlags(uint32_t flags)
175 {
176     MXC_I2S_RevA_ClearFlags((mxc_i2s_reva_regs_t *)MXC_I2S, flags);
177 }
178 
MXC_I2S_Transaction(mxc_i2s_req_t * i2s_req)179 int MXC_I2S_Transaction(mxc_i2s_req_t *i2s_req)
180 {
181     return MXC_I2S_RevA_Transaction((mxc_i2s_reva_regs_t *)MXC_I2S, i2s_req);
182 }
183 
MXC_I2S_TransactionAsync(mxc_i2s_req_t * i2s_req)184 int MXC_I2S_TransactionAsync(mxc_i2s_req_t *i2s_req)
185 {
186     return MXC_I2S_RevA_TransactionAsync((mxc_i2s_reva_regs_t *)MXC_I2S, i2s_req);
187 }
188 
MXC_I2S_TXDMAConfig(void * src_addr,int len)189 int MXC_I2S_TXDMAConfig(void *src_addr, int len)
190 {
191     return MXC_I2S_RevA_TXDMAConfig((mxc_i2s_reva_regs_t *)MXC_I2S, src_addr, len);
192 }
193 
MXC_I2S_RXDMAConfig(void * dest_addr,int len)194 int MXC_I2S_RXDMAConfig(void *dest_addr, int len)
195 {
196     return MXC_I2S_RevA_RXDMAConfig((mxc_i2s_reva_regs_t *)MXC_I2S, dest_addr, len);
197 }
198 
MXC_I2S_Handler(void)199 void MXC_I2S_Handler(void)
200 {
201     MXC_I2S_RevA_Handler((mxc_i2s_reva_regs_t *)MXC_I2S);
202 }
203 
MXC_I2S_RegisterDMACallback(void (* callback)(int,int))204 void MXC_I2S_RegisterDMACallback(void (*callback)(int, int))
205 {
206     MXC_I2S_RevA_RegisterDMACallback(callback);
207 }
208 
MXC_I2S_RegisterAsyncCallback(void (* callback)(int))209 void MXC_I2S_RegisterAsyncCallback(void (*callback)(int))
210 {
211     MXC_I2S_RevA_RegisterAsyncCallback(callback);
212 }
213