diff options
Diffstat (limited to 'lib/chibios-contrib/ext/mcux-sdk/components/codec/wm8960/fsl_wm8960.h')
-rw-r--r-- | lib/chibios-contrib/ext/mcux-sdk/components/codec/wm8960/fsl_wm8960.h | 536 |
1 files changed, 536 insertions, 0 deletions
diff --git a/lib/chibios-contrib/ext/mcux-sdk/components/codec/wm8960/fsl_wm8960.h b/lib/chibios-contrib/ext/mcux-sdk/components/codec/wm8960/fsl_wm8960.h new file mode 100644 index 000000000..92fa98bfd --- /dev/null +++ b/lib/chibios-contrib/ext/mcux-sdk/components/codec/wm8960/fsl_wm8960.h | |||
@@ -0,0 +1,536 @@ | |||
1 | /* | ||
2 | * Copyright (c) 2015, Freescale Semiconductor, Inc. | ||
3 | * Copyright 2016-2019 NXP | ||
4 | * All rights reserved. | ||
5 | * | ||
6 | * SPDX-License-Identifier: BSD-3-Clause | ||
7 | */ | ||
8 | |||
9 | #ifndef _FSL_WM8960_H_ | ||
10 | #define _FSL_WM8960_H_ | ||
11 | |||
12 | #include "fsl_codec_i2c.h" | ||
13 | #include "fsl_common.h" | ||
14 | |||
15 | /*! | ||
16 | * @addtogroup wm8960 | ||
17 | * @{ | ||
18 | */ | ||
19 | |||
20 | /******************************************************************************* | ||
21 | * Definitions | ||
22 | ******************************************************************************/ | ||
23 | /*! @name Driver version */ | ||
24 | /*@{*/ | ||
25 | /*! @brief CLOCK driver version 2.1.3 */ | ||
26 | #define FSL_WM8960_DRIVER_VERSION (MAKE_VERSION(2, 1, 3)) | ||
27 | /*@}*/ | ||
28 | |||
29 | /*! @brief wm8960 handle size */ | ||
30 | #ifndef WM8960_I2C_HANDLER_SIZE | ||
31 | #define WM8960_I2C_HANDLER_SIZE CODEC_I2C_MASTER_HANDLER_SIZE | ||
32 | #endif | ||
33 | |||
34 | /*! @brief Define the register address of WM8960. */ | ||
35 | #define WM8960_LINVOL 0x0U | ||
36 | #define WM8960_RINVOL 0x1U | ||
37 | #define WM8960_LOUT1 0x2U | ||
38 | #define WM8960_ROUT1 0x3U | ||
39 | #define WM8960_CLOCK1 0x4U | ||
40 | #define WM8960_DACCTL1 0x5U | ||
41 | #define WM8960_DACCTL2 0x6U | ||
42 | #define WM8960_IFACE1 0x7U | ||
43 | #define WM8960_CLOCK2 0x8U | ||
44 | #define WM8960_IFACE2 0x9U | ||
45 | #define WM8960_LDAC 0xaU | ||
46 | #define WM8960_RDAC 0xbU | ||
47 | |||
48 | #define WM8960_RESET 0xfU | ||
49 | #define WM8960_3D 0x10U | ||
50 | #define WM8960_ALC1 0x11U | ||
51 | #define WM8960_ALC2 0x12U | ||
52 | #define WM8960_ALC3 0x13U | ||
53 | #define WM8960_NOISEG 0x14U | ||
54 | #define WM8960_LADC 0x15U | ||
55 | #define WM8960_RADC 0x16U | ||
56 | #define WM8960_ADDCTL1 0x17U | ||
57 | #define WM8960_ADDCTL2 0x18U | ||
58 | #define WM8960_POWER1 0x19U | ||
59 | #define WM8960_POWER2 0x1aU | ||
60 | #define WM8960_ADDCTL3 0x1bU | ||
61 | #define WM8960_APOP1 0x1cU | ||
62 | #define WM8960_APOP2 0x1dU | ||
63 | |||
64 | #define WM8960_LINPATH 0x20U | ||
65 | #define WM8960_RINPATH 0x21U | ||
66 | #define WM8960_LOUTMIX 0x22U | ||
67 | |||
68 | #define WM8960_ROUTMIX 0x25U | ||
69 | #define WM8960_MONOMIX1 0x26U | ||
70 | #define WM8960_MONOMIX2 0x27U | ||
71 | #define WM8960_LOUT2 0x28U | ||
72 | #define WM8960_ROUT2 0x29U | ||
73 | #define WM8960_MONO 0x2aU | ||
74 | #define WM8960_INBMIX1 0x2bU | ||
75 | #define WM8960_INBMIX2 0x2cU | ||
76 | #define WM8960_BYPASS1 0x2dU | ||
77 | #define WM8960_BYPASS2 0x2eU | ||
78 | #define WM8960_POWER3 0x2fU | ||
79 | #define WM8960_ADDCTL4 0x30U | ||
80 | #define WM8960_CLASSD1 0x31U | ||
81 | |||
82 | #define WM8960_CLASSD3 0x33U | ||
83 | #define WM8960_PLL1 0x34U | ||
84 | #define WM8960_PLL2 0x35U | ||
85 | #define WM8960_PLL3 0x36U | ||
86 | #define WM8960_PLL4 0x37U | ||
87 | |||
88 | /*! @brief Cache register number */ | ||
89 | #define WM8960_CACHEREGNUM 56U | ||
90 | |||
91 | /*! @brief WM8960_IFACE1 FORMAT bits */ | ||
92 | #define WM8960_IFACE1_FORMAT_MASK 0x03U | ||
93 | #define WM8960_IFACE1_FORMAT_SHIFT 0x00U | ||
94 | #define WM8960_IFACE1_FORMAT_RJ 0x00U | ||
95 | #define WM8960_IFACE1_FORMAT_LJ 0x01U | ||
96 | #define WM8960_IFACE1_FORMAT_I2S 0x02U | ||
97 | #define WM8960_IFACE1_FORMAT_DSP 0x03U | ||
98 | #define WM8960_IFACE1_FORMAT(x) (((x) << WM8960_IFACE1_FORMAT_SHIFT) & WM8960_IFACE1_FORMAT_MASK) | ||
99 | |||
100 | /*! @brief WM8960_IFACE1 WL bits */ | ||
101 | #define WM8960_IFACE1_WL_MASK 0x0CU | ||
102 | #define WM8960_IFACE1_WL_SHIFT 0x02U | ||
103 | #define WM8960_IFACE1_WL_16BITS 0x00U | ||
104 | #define WM8960_IFACE1_WL_20BITS 0x01U | ||
105 | #define WM8960_IFACE1_WL_24BITS 0x02U | ||
106 | #define WM8960_IFACE1_WL_32BITS 0x03U | ||
107 | #define WM8960_IFACE1_WL(x) (((x) << WM8960_IFACE1_WL_SHIFT) & WM8960_IFACE1_WL_MASK) | ||
108 | |||
109 | /*! @brief WM8960_IFACE1 LRP bit */ | ||
110 | #define WM8960_IFACE1_LRP_MASK 0x10U | ||
111 | #define WM8960_IFACE1_LRP_SHIFT 0x04U | ||
112 | #define WM8960_IFACE1_LRCLK_NORMAL_POL 0x00U | ||
113 | #define WM8960_IFACE1_LRCLK_INVERT_POL 0x01U | ||
114 | #define WM8960_IFACE1_DSP_MODEA 0x00U | ||
115 | #define WM8960_IFACE1_DSP_MODEB 0x01U | ||
116 | #define WM8960_IFACE1_LRP(x) (((x) << WM8960_IFACE1_LRP_SHIFT) & WM8960_IFACE1_LRP_MASK) | ||
117 | |||
118 | /*! @brief WM8960_IFACE1 DLRSWAP bit */ | ||
119 | #define WM8960_IFACE1_DLRSWAP_MASK 0x20U | ||
120 | #define WM8960_IFACE1_DLRSWAP_SHIFT 0x05U | ||
121 | #define WM8960_IFACE1_DACCH_NORMAL 0x00U | ||
122 | #define WM8960_IFACE1_DACCH_SWAP 0x01U | ||
123 | #define WM8960_IFACE1_DLRSWAP(x) (((x) << WM8960_IFACE1_DLRSWAP_SHIFT) & WM8960_IFACE1_DLRSWAP_MASK) | ||
124 | |||
125 | /*! @brief WM8960_IFACE1 MS bit */ | ||
126 | #define WM8960_IFACE1_MS_MASK 0x40U | ||
127 | #define WM8960_IFACE1_MS_SHIFT 0x06U | ||
128 | #define WM8960_IFACE1_SLAVE 0x00U | ||
129 | #define WM8960_IFACE1_MASTER 0x01U | ||
130 | #define WM8960_IFACE1_MS(x) (((x) << WM8960_IFACE1_MS_SHIFT) & WM8960_IFACE1_MS_MASK) | ||
131 | |||
132 | /*! @brief WM8960_IFACE1 BCLKINV bit */ | ||
133 | #define WM8960_IFACE1_BCLKINV_MASK 0x80U | ||
134 | #define WM8960_IFACE1_BCLKINV_SHIFT 0x07U | ||
135 | #define WM8960_IFACE1_BCLK_NONINVERT 0x00U | ||
136 | #define WM8960_IFACE1_BCLK_INVERT 0x01U | ||
137 | #define WM8960_IFACE1_BCLKINV(x) (((x) << WM8960_IFACE1_BCLKINV_SHIFT) & WM8960_IFACE1_BCLKINV_MASK) | ||
138 | |||
139 | /*! @brief WM8960_IFACE1 ALRSWAP bit */ | ||
140 | #define WM8960_IFACE1_ALRSWAP_MASK 0x100U | ||
141 | #define WM8960_IFACE1_ALRSWAP_SHIFT 0x08U | ||
142 | #define WM8960_IFACE1_ADCCH_NORMAL 0x00U | ||
143 | #define WM8960_IFACE1_ADCCH_SWAP 0x01U | ||
144 | #define WM8960_IFACE1_ALRSWAP(x) (((x) << WM8960_IFACE1_ALRSWAP_SHIFT) & WM8960_IFACE1_ALRSWAP_MASK) | ||
145 | |||
146 | /*! @brief WM8960_POWER1 */ | ||
147 | #define WM8960_POWER1_VREF_MASK 0x40U | ||
148 | #define WM8960_POWER1_VREF_SHIFT 0x06U | ||
149 | |||
150 | #define WM8960_POWER1_AINL_MASK 0x20U | ||
151 | #define WM8960_POWER1_AINL_SHIFT 0x05U | ||
152 | |||
153 | #define WM8960_POWER1_AINR_MASK 0x10U | ||
154 | #define WM8960_POWER1_AINR_SHIFT 0x04U | ||
155 | |||
156 | #define WM8960_POWER1_ADCL_MASK 0x08U | ||
157 | #define WM8960_POWER1_ADCL_SHIFT 0x03U | ||
158 | |||
159 | #define WM8960_POWER1_ADCR_MASK 0x0U | ||
160 | #define WM8960_POWER1_ADCR_SHIFT 0x02U | ||
161 | |||
162 | #define WM8960_POWER1_MICB_MASK 0x02U | ||
163 | #define WM8960_POWER1_MICB_SHIFT 0x01U | ||
164 | |||
165 | #define WM8960_POWER1_DIGENB_MASK 0x01U | ||
166 | #define WM8960_POWER1_DIGENB_SHIFT 0x00U | ||
167 | |||
168 | /*! @brief WM8960_POWER2 */ | ||
169 | #define WM8960_POWER2_DACL_MASK 0x100U | ||
170 | #define WM8960_POWER2_DACL_SHIFT 0x08U | ||
171 | |||
172 | #define WM8960_POWER2_DACR_MASK 0x80U | ||
173 | #define WM8960_POWER2_DACR_SHIFT 0x07U | ||
174 | |||
175 | #define WM8960_POWER2_LOUT1_MASK 0x40U | ||
176 | #define WM8960_POWER2_LOUT1_SHIFT 0x06U | ||
177 | |||
178 | #define WM8960_POWER2_ROUT1_MASK 0x20U | ||
179 | #define WM8960_POWER2_ROUT1_SHIFT 0x05U | ||
180 | |||
181 | #define WM8960_POWER2_SPKL_MASK 0x10U | ||
182 | #define WM8960_POWER2_SPKL_SHIFT 0x04U | ||
183 | |||
184 | #define WM8960_POWER2_SPKR_MASK 0x08U | ||
185 | #define WM8960_POWER2_SPKR_SHIFT 0x03U | ||
186 | |||
187 | #define WM8960_POWER3_LMIC_MASK 0x20U | ||
188 | #define WM8960_POWER3_LMIC_SHIFT 0x05U | ||
189 | #define WM8960_POWER3_RMIC_MASK 0x10U | ||
190 | #define WM8960_POWER3_RMIC_SHIFT 0x04U | ||
191 | #define WM8960_POWER3_LOMIX_MASK 0x08U | ||
192 | #define WM8960_POWER3_LOMIX_SHIFT 0x03U | ||
193 | #define WM8960_POWER3_ROMIX_MASK 0x04U | ||
194 | #define WM8960_POWER3_ROMIX_SHIFT 0x02U | ||
195 | /*! @brief WM8960 I2C address. */ | ||
196 | #define WM8960_I2C_ADDR 0x1A | ||
197 | /*! @brief WM8960 I2C baudrate */ | ||
198 | #define WM8960_I2C_BAUDRATE (100000U) | ||
199 | /*! @brief WM8960 maximum volume value */ | ||
200 | #define WM8960_ADC_MAX_VOLUME_vALUE 0xFFU | ||
201 | #define WM8960_DAC_MAX_VOLUME_vALUE 0xFFU | ||
202 | #define WM8960_HEADPHONE_MAX_VOLUME_vALUE 0x7FU | ||
203 | #define WM8960_HEADPHONE_MIN_VOLUME_vALUE 0x30U | ||
204 | #define WM8960_LINEIN_MAX_VOLUME_vALUE 0x3FU | ||
205 | #define WM8960_SPEAKER_MAX_VOLUME_vALUE 0x7FU | ||
206 | #define WM8960_SPEAKER_MIN_VOLUME_vALUE 0x30U | ||
207 | |||
208 | /*! @brief Modules in WM8960 board. */ | ||
209 | typedef enum _wm8960_module | ||
210 | { | ||
211 | kWM8960_ModuleADC = 0, /*!< ADC module in WM8960 */ | ||
212 | kWM8960_ModuleDAC = 1, /*!< DAC module in WM8960 */ | ||
213 | kWM8960_ModuleVREF = 2, /*!< VREF module */ | ||
214 | kWM8960_ModuleHP = 3, /*!< Headphone */ | ||
215 | kWM8960_ModuleMICB = 4, /*!< Mic bias */ | ||
216 | kWM8960_ModuleMIC = 5, /*!< Input Mic */ | ||
217 | kWM8960_ModuleLineIn = 6, /*!< Analog in PGA */ | ||
218 | kWM8960_ModuleLineOut = 7, /*!< Line out module */ | ||
219 | kWM8960_ModuleSpeaker = 8, /*!< Speaker module */ | ||
220 | kWM8960_ModuleOMIX = 9, /*!< Output mixer */ | ||
221 | } wm8960_module_t; | ||
222 | |||
223 | /*! @brief wm8960 play channel | ||
224 | * @anchor _wm8960_play_channel | ||
225 | */ | ||
226 | enum | ||
227 | { | ||
228 | kWM8960_HeadphoneLeft = 1, /*!< wm8960 headphone left channel */ | ||
229 | kWM8960_HeadphoneRight = 2, /*!< wm8960 headphone right channel */ | ||
230 | kWM8960_SpeakerLeft = 4, /*!< wm8960 speaker left channel */ | ||
231 | kWM8960_SpeakerRight = 8, /*!< wm8960 speaker right channel */ | ||
232 | }; | ||
233 | |||
234 | /*! @brief wm8960 play source */ | ||
235 | typedef enum _wm8960_play_source | ||
236 | { | ||
237 | kWM8960_PlaySourcePGA = 1, /*!< wm8960 play source PGA */ | ||
238 | kWM8960_PlaySourceInput = 2, /*!< wm8960 play source Input */ | ||
239 | kWM8960_PlaySourceDAC = 4, /*!< wm8960 play source DAC */ | ||
240 | } wm8960_play_source_t; | ||
241 | |||
242 | /*! | ||
243 | * @brief WM8960 data route. | ||
244 | * Only provide some typical data route, not all route listed. | ||
245 | * Note: Users cannot combine any routes, once a new route is set, the previous one would be replaced. | ||
246 | */ | ||
247 | typedef enum _wm8960_route | ||
248 | { | ||
249 | kWM8960_RouteBypass = 0, /*!< LINEIN->Headphone. */ | ||
250 | kWM8960_RoutePlayback = 1, /*!< I2SIN->DAC->Headphone. */ | ||
251 | kWM8960_RoutePlaybackandRecord = 2, /*!< I2SIN->DAC->Headphone, LINEIN->ADC->I2SOUT. */ | ||
252 | kWM8960_RouteRecord = 5 /*!< LINEIN->ADC->I2SOUT. */ | ||
253 | } wm8960_route_t; | ||
254 | |||
255 | /*! | ||
256 | * @brief The audio data transfer protocol choice. | ||
257 | * WM8960 only supports I2S format and PCM format. | ||
258 | */ | ||
259 | typedef enum _wm8960_protocol | ||
260 | { | ||
261 | kWM8960_BusI2S = 2, /*!< I2S type */ | ||
262 | kWM8960_BusLeftJustified = 1, /*!< Left justified mode */ | ||
263 | kWM8960_BusRightJustified = 0, /*!< Right justified mode */ | ||
264 | kWM8960_BusPCMA = 3, /*!< PCM A mode */ | ||
265 | kWM8960_BusPCMB = 3 | (1 << 4) /*!< PCM B mode */ | ||
266 | } wm8960_protocol_t; | ||
267 | |||
268 | /*! @brief wm8960 input source */ | ||
269 | typedef enum _wm8960_input | ||
270 | { | ||
271 | kWM8960_InputClosed = 0, /*!< Input device is closed */ | ||
272 | kWM8960_InputSingleEndedMic = 1, /*!< Input as single ended mic, only use L/RINPUT1 */ | ||
273 | kWM8960_InputDifferentialMicInput2 = 2, /*!< Input as differential mic, use L/RINPUT1 and L/RINPUT2 */ | ||
274 | kWM8960_InputDifferentialMicInput3 = 3, /*!< Input as differential mic, use L/RINPUT1 and L/RINPUT3*/ | ||
275 | kWM8960_InputLineINPUT2 = 4, /*!< Input as line input, only use L/RINPUT2 */ | ||
276 | kWM8960_InputLineINPUT3 = 5 /*!< Input as line input, only use L/RINPUT3 */ | ||
277 | } wm8960_input_t; | ||
278 | |||
279 | /*! @brief audio sample rate definition | ||
280 | * @anchor _wm8960_sample_rate | ||
281 | */ | ||
282 | enum | ||
283 | { | ||
284 | kWM8960_AudioSampleRate8KHz = 8000U, /*!< Sample rate 8000 Hz */ | ||
285 | kWM8960_AudioSampleRate11025Hz = 11025U, /*!< Sample rate 11025 Hz */ | ||
286 | kWM8960_AudioSampleRate12KHz = 12000U, /*!< Sample rate 12000 Hz */ | ||
287 | kWM8960_AudioSampleRate16KHz = 16000U, /*!< Sample rate 16000 Hz */ | ||
288 | kWM8960_AudioSampleRate22050Hz = 22050U, /*!< Sample rate 22050 Hz */ | ||
289 | kWM8960_AudioSampleRate24KHz = 24000U, /*!< Sample rate 24000 Hz */ | ||
290 | kWM8960_AudioSampleRate32KHz = 32000U, /*!< Sample rate 32000 Hz */ | ||
291 | kWM8960_AudioSampleRate44100Hz = 44100U, /*!< Sample rate 44100 Hz */ | ||
292 | kWM8960_AudioSampleRate48KHz = 48000U, /*!< Sample rate 48000 Hz */ | ||
293 | kWM8960_AudioSampleRate96KHz = 96000U, /*!< Sample rate 96000 Hz */ | ||
294 | kWM8960_AudioSampleRate192KHz = 192000U, /*!< Sample rate 192000 Hz */ | ||
295 | kWM8960_AudioSampleRate384KHz = 384000U, /*!< Sample rate 384000 Hz */ | ||
296 | }; | ||
297 | |||
298 | /*! @brief audio bit width | ||
299 | * @anchor _wm8960_audio_bit_width | ||
300 | */ | ||
301 | enum | ||
302 | { | ||
303 | kWM8960_AudioBitWidth16bit = 16U, /*!< audio bit width 16 */ | ||
304 | kWM8960_AudioBitWidth20bit = 20U, /*!< audio bit width 20 */ | ||
305 | kWM8960_AudioBitWidth24bit = 24U, /*!< audio bit width 24 */ | ||
306 | kWM8960_AudioBitWidth32bit = 32U, /*!< audio bit width 32 */ | ||
307 | }; | ||
308 | |||
309 | /*! @brief wm8960 audio format */ | ||
310 | typedef struct _wm8960_audio_format | ||
311 | { | ||
312 | uint32_t mclk_HZ; /*!< master clock frequency */ | ||
313 | uint32_t sampleRate; /*!< sample rate */ | ||
314 | uint32_t bitWidth; /*!< bit width */ | ||
315 | } wm8960_audio_format_t; | ||
316 | |||
317 | /*! @brief Initialize structure of WM8960 */ | ||
318 | typedef struct wm8960_config | ||
319 | { | ||
320 | wm8960_route_t route; /*!< Audio data route.*/ | ||
321 | wm8960_protocol_t bus; /*!< Audio transfer protocol */ | ||
322 | wm8960_audio_format_t format; /*!< Audio format */ | ||
323 | bool master_slave; /*!< Master or slave. */ | ||
324 | bool enableSpeaker; /*!< True means enable class D speaker as output, false means no */ | ||
325 | wm8960_input_t leftInputSource; /*!< Left input source for WM8960 */ | ||
326 | wm8960_input_t rightInputSource; /*!< Right input source for wm8960 */ | ||
327 | wm8960_play_source_t playSource; /*!< play source */ | ||
328 | uint8_t slaveAddress; /*!< wm8960 device address */ | ||
329 | codec_i2c_config_t i2cConfig; /*!< i2c configuration */ | ||
330 | } wm8960_config_t; | ||
331 | |||
332 | /*! @brief wm8960 codec handler | ||
333 | */ | ||
334 | typedef struct _wm8960_handle | ||
335 | { | ||
336 | const wm8960_config_t *config; /*!< wm8904 config pointer */ | ||
337 | uint8_t i2cHandle[WM8960_I2C_HANDLER_SIZE]; /*!< i2c handle */ | ||
338 | } wm8960_handle_t; | ||
339 | /******************************************************************************* | ||
340 | * API | ||
341 | ******************************************************************************/ | ||
342 | #if defined(__cplusplus) | ||
343 | extern "C" { | ||
344 | #endif | ||
345 | |||
346 | /*! | ||
347 | * @brief WM8960 initialize function. | ||
348 | * | ||
349 | * The second parameter is NULL to WM8960 in this version. If users want | ||
350 | * to change the settings, they have to use wm8960_write_reg() or wm8960_modify_reg() | ||
351 | * to set the register value of WM8960. | ||
352 | * Note: If the codec_config is NULL, it would initialize WM8960 using default settings. | ||
353 | * The default setting: | ||
354 | * codec_config->route = kWM8960_RoutePlaybackandRecord | ||
355 | * codec_config->bus = kWM8960_BusI2S | ||
356 | * codec_config->master = slave | ||
357 | * | ||
358 | * @param handle WM8960 handle structure. | ||
359 | * @param config WM8960 configuration structure. | ||
360 | */ | ||
361 | status_t WM8960_Init(wm8960_handle_t *handle, const wm8960_config_t *config); | ||
362 | |||
363 | /*! | ||
364 | * @brief Deinit the WM8960 codec. | ||
365 | * | ||
366 | * This function close all modules in WM8960 to save power. | ||
367 | * | ||
368 | * @param handle WM8960 handle structure pointer. | ||
369 | */ | ||
370 | status_t WM8960_Deinit(wm8960_handle_t *handle); | ||
371 | |||
372 | /*! | ||
373 | * @brief Set audio data route in WM8960. | ||
374 | * | ||
375 | * This function would set the data route according to route. The route cannot be combined, | ||
376 | * as all route would enable different modules. | ||
377 | * Note: If a new route is set, the previous route would not work. | ||
378 | * | ||
379 | * @param handle WM8960 handle structure. | ||
380 | * @param route Audio data route in WM8960. | ||
381 | */ | ||
382 | status_t WM8960_SetDataRoute(wm8960_handle_t *handle, wm8960_route_t route); | ||
383 | |||
384 | /*! | ||
385 | * @brief Set left audio input source in WM8960. | ||
386 | * | ||
387 | * @param handle WM8960 handle structure. | ||
388 | * @param input Audio input source. | ||
389 | */ | ||
390 | status_t WM8960_SetLeftInput(wm8960_handle_t *handle, wm8960_input_t input); | ||
391 | |||
392 | /*! | ||
393 | * @brief Set right audio input source in WM8960. | ||
394 | * | ||
395 | * @param handle WM8960 handle structure. | ||
396 | * @param input Audio input source. | ||
397 | */ | ||
398 | status_t WM8960_SetRightInput(wm8960_handle_t *handle, wm8960_input_t input); | ||
399 | |||
400 | /*! | ||
401 | * @brief Set the audio transfer protocol. | ||
402 | * | ||
403 | * WM8960 only supports I2S, left justified, right justified, PCM A, PCM B format. | ||
404 | * | ||
405 | * @param handle WM8960 handle structure. | ||
406 | * @param protocol Audio data transfer protocol. | ||
407 | */ | ||
408 | status_t WM8960_SetProtocol(wm8960_handle_t *handle, wm8960_protocol_t protocol); | ||
409 | |||
410 | /*! | ||
411 | * @brief Set WM8960 as master or slave. | ||
412 | * | ||
413 | * @param handle WM8960 handle structure. | ||
414 | * @param master 1 represent master, 0 represent slave. | ||
415 | */ | ||
416 | void WM8960_SetMasterSlave(wm8960_handle_t *handle, bool master); | ||
417 | |||
418 | /*! | ||
419 | * @brief Set the volume of different modules in WM8960. | ||
420 | * | ||
421 | * This function would set the volume of WM8960 modules. Uses need to appoint the module. | ||
422 | * The function assume that left channel and right channel has the same volume. | ||
423 | * | ||
424 | * Module:kWM8960_ModuleADC, volume range value: 0 is mute, 1-255 is -97db to 30db | ||
425 | * Module:kWM8960_ModuleDAC, volume range value: 0 is mute, 1-255 is -127db to 0db | ||
426 | * Module:kWM8960_ModuleHP, volume range value: 0 - 2F is mute, 0x30 - 0x7F is -73db to 6db | ||
427 | * Module:kWM8960_ModuleLineIn, volume range value: 0 - 0x3F is -17.25db to 30db | ||
428 | * Module:kWM8960_ModuleSpeaker, volume range value: 0 - 2F is mute, 0x30 - 0x7F is -73db to 6db | ||
429 | * | ||
430 | * | ||
431 | * @param handle WM8960 handle structure. | ||
432 | * @param module Module to set volume, it can be ADC, DAC, Headphone and so on. | ||
433 | * @param volume Volume value need to be set. | ||
434 | */ | ||
435 | status_t WM8960_SetVolume(wm8960_handle_t *handle, wm8960_module_t module, uint32_t volume); | ||
436 | |||
437 | /*! | ||
438 | * @brief Get the volume of different modules in WM8960. | ||
439 | * | ||
440 | * This function gets the volume of WM8960 modules. Uses need to appoint the module. | ||
441 | * The function assume that left channel and right channel has the same volume. | ||
442 | * | ||
443 | * @param handle WM8960 handle structure. | ||
444 | * @param module Module to set volume, it can be ADC, DAC, Headphone and so on. | ||
445 | * @return Volume value of the module. | ||
446 | */ | ||
447 | uint32_t WM8960_GetVolume(wm8960_handle_t *handle, wm8960_module_t module); | ||
448 | |||
449 | /*! | ||
450 | * @brief Mute modules in WM8960. | ||
451 | * | ||
452 | * @param handle WM8960 handle structure. | ||
453 | * @param module Modules need to be mute. | ||
454 | * @param isEnabled Mute or unmute, 1 represent mute. | ||
455 | */ | ||
456 | status_t WM8960_SetMute(wm8960_handle_t *handle, wm8960_module_t module, bool isEnabled); | ||
457 | |||
458 | /*! | ||
459 | * @brief Enable/disable expected devices. | ||
460 | * | ||
461 | * @param handle WM8960 handle structure. | ||
462 | * @param module Module expected to enable. | ||
463 | * @param isEnabled Enable or disable moudles. | ||
464 | */ | ||
465 | status_t WM8960_SetModule(wm8960_handle_t *handle, wm8960_module_t module, bool isEnabled); | ||
466 | |||
467 | /*! | ||
468 | * @brief SET the WM8960 play source. | ||
469 | * | ||
470 | * @param handle WM8960 handle structure. | ||
471 | * @param playSource play source , can be a value combine of kWM8960_ModuleHeadphoneSourcePGA, | ||
472 | * kWM8960_ModuleHeadphoneSourceDAC, kWM8960_ModulePlaySourceInput, kWM8960_ModulePlayMonoRight, | ||
473 | * kWM8960_ModulePlayMonoLeft. | ||
474 | * | ||
475 | * @return kStatus_WM8904_Success if successful, different code otherwise.. | ||
476 | */ | ||
477 | status_t WM8960_SetPlay(wm8960_handle_t *handle, uint32_t playSource); | ||
478 | |||
479 | /*! | ||
480 | * @brief Configure the data format of audio data. | ||
481 | * | ||
482 | * This function would configure the registers about the sample rate, bit depths. | ||
483 | * | ||
484 | * @param handle WM8960 handle structure pointer. | ||
485 | * @param sysclk system clock of the codec which can be generated by MCLK or PLL output. | ||
486 | * @param sample_rate Sample rate of audio file running in WM8960. WM8960 now | ||
487 | * supports 8k, 11.025k, 12k, 16k, 22.05k, 24k, 32k, 44.1k, 48k and 96k sample rate. | ||
488 | * @param bits Bit depth of audio file (WM8960 only supports 16bit, 20bit, 24bit | ||
489 | * and 32 bit in HW). | ||
490 | */ | ||
491 | status_t WM8960_ConfigDataFormat(wm8960_handle_t *handle, uint32_t sysclk, uint32_t sample_rate, uint32_t bits); | ||
492 | |||
493 | /*! | ||
494 | * @brief Enable/disable jack detect feature. | ||
495 | * | ||
496 | * @param handle WM8960 handle structure. | ||
497 | * @param isEnabled Enable or disable moudles. | ||
498 | */ | ||
499 | status_t WM8960_SetJackDetect(wm8960_handle_t *handle, bool isEnabled); | ||
500 | |||
501 | /*! | ||
502 | * @brief Write register to WM8960 using I2C. | ||
503 | * | ||
504 | * @param handle WM8960 handle structure. | ||
505 | * @param reg The register address in WM8960. | ||
506 | * @param val Value needs to write into the register. | ||
507 | */ | ||
508 | status_t WM8960_WriteReg(wm8960_handle_t *handle, uint8_t reg, uint16_t val); | ||
509 | |||
510 | /*! | ||
511 | * @brief Read register from WM8960 using I2C. | ||
512 | * @param reg The register address in WM8960. | ||
513 | * @param val Value written to. | ||
514 | */ | ||
515 | status_t WM8960_ReadReg(uint8_t reg, uint16_t *val); | ||
516 | |||
517 | /*! | ||
518 | * @brief Modify some bits in the register using I2C. | ||
519 | * @param handle WM8960 handle structure. | ||
520 | * @param reg The register address in WM8960. | ||
521 | * @param mask The mask code for the bits want to write. The bit you want to write should be 0. | ||
522 | * @param val Value needs to write into the register. | ||
523 | */ | ||
524 | status_t WM8960_ModifyReg(wm8960_handle_t *handle, uint8_t reg, uint16_t mask, uint16_t val); | ||
525 | |||
526 | #if defined(__cplusplus) | ||
527 | } | ||
528 | #endif | ||
529 | |||
530 | /*! @} */ | ||
531 | |||
532 | #endif /* _FSL_WM8960_H_ */ | ||
533 | |||
534 | /******************************************************************************* | ||
535 | * API | ||
536 | ******************************************************************************/ | ||