xref: /btstack/port/stm32-f4discovery-usb/bsp/cs43l22.h (revision f763b8ceaf9411e1c5e999bc4423cdc8accb9a47)
1 /**
2   ******************************************************************************
3   * @file    cs43l22.h
4   * @author  MCD Application Team
5   * @version V2.0.2
6   * @date    06-October-2015
7   * @brief   This file contains all the functions prototypes for the cs43l22.c driver.
8   ******************************************************************************
9   * @attention
10   *
11   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
12   *
13   * Redistribution and use in source and binary forms, with or without modification,
14   * are permitted provided that the following conditions are met:
15   *   1. Redistributions of source code must retain the above copyright notice,
16   *      this list of conditions and the following disclaimer.
17   *   2. Redistributions in binary form must reproduce the above copyright notice,
18   *      this list of conditions and the following disclaimer in the documentation
19   *      and/or other materials provided with the distribution.
20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
21   *      may be used to endorse or promote products derived from this software
22   *      without specific prior written permission.
23   *
24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34   *
35   ******************************************************************************
36   */
37 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __CS43L22_H
40 #define __CS43L22_H
41 
42 /* Includes ------------------------------------------------------------------*/
43 #include "audio.h"
44 
45 /** @addtogroup BSP
46   * @{
47   */
48 
49 /** @addtogroup Component
50   * @{
51   */
52 
53 /** @addtogroup CS43L22
54   * @{
55   */
56 
57 /** @defgroup CS43L22_Exported_Types
58   * @{
59   */
60 
61 /**
62   * @}
63   */
64 
65 /** @defgroup CS43L22_Exported_Constants
66   * @{
67   */
68 
69 /******************************************************************************/
70 /***************************  Codec User defines ******************************/
71 /******************************************************************************/
72 /* Codec output DEVICE */
73 #define OUTPUT_DEVICE_SPEAKER         1
74 #define OUTPUT_DEVICE_HEADPHONE       2
75 #define OUTPUT_DEVICE_BOTH            3
76 #define OUTPUT_DEVICE_AUTO            4
77 
78 /* Volume Levels values */
79 #define DEFAULT_VOLMIN                0x00
80 #define DEFAULT_VOLMAX                0xFF
81 #define DEFAULT_VOLSTEP               0x04
82 
83 #define AUDIO_PAUSE                   0
84 #define AUDIO_RESUME                  1
85 
86 /* Codec POWER DOWN modes */
87 #define CODEC_PDWN_HW                 1
88 #define CODEC_PDWN_SW                 2
89 
90 /* MUTE commands */
91 #define AUDIO_MUTE_ON                 1
92 #define AUDIO_MUTE_OFF                0
93 
94 /* AUDIO FREQUENCY */
95 #define AUDIO_FREQUENCY_192K          ((uint32_t)192000)
96 #define AUDIO_FREQUENCY_96K           ((uint32_t)96000)
97 #define AUDIO_FREQUENCY_48K           ((uint32_t)48000)
98 #define AUDIO_FREQUENCY_44K           ((uint32_t)44100)
99 #define AUDIO_FREQUENCY_32K           ((uint32_t)32000)
100 #define AUDIO_FREQUENCY_22K           ((uint32_t)22050)
101 #define AUDIO_FREQUENCY_16K           ((uint32_t)16000)
102 #define AUDIO_FREQUENCY_11K           ((uint32_t)11025)
103 #define AUDIO_FREQUENCY_8K            ((uint32_t)8000)
104 
105 /** CS43l22 Registers  ***/
106 #define   CS43L22_REG_ID                  0x01
107 #define   CS43L22_REG_POWER_CTL1          0x02
108 #define   CS43L22_REG_POWER_CTL2          0x04
109 #define   CS43L22_REG_CLOCKING_CTL        0x05
110 #define   CS43L22_REG_INTERFACE_CTL1      0x06
111 #define   CS43L22_REG_INTERFACE_CTL2      0x07
112 #define   CS43L22_REG_PASSTHR_A_SELECT    0x08
113 #define   CS43L22_REG_PASSTHR_B_SELECT    0x09
114 #define   CS43L22_REG_ANALOG_ZC_SR_SETT   0x0A
115 #define   CS43L22_REG_PASSTHR_GANG_CTL    0x0C
116 #define   CS43L22_REG_PLAYBACK_CTL1       0x0D
117 #define   CS43L22_REG_MISC_CTL            0x0E
118 #define   CS43L22_REG_PLAYBACK_CTL2       0x0F
119 #define   CS43L22_REG_PASSTHR_A_VOL       0x14
120 #define   CS43L22_REG_PASSTHR_B_VOL       0x15
121 #define   CS43L22_REG_PCMA_VOL            0x1A
122 #define   CS43L22_REG_PCMB_VOL            0x1B
123 #define   CS43L22_REG_BEEP_FREQ_ON_TIME   0x1C
124 #define   CS43L22_REG_BEEP_VOL_OFF_TIME   0x1D
125 #define   CS43L22_REG_BEEP_TONE_CFG       0x1E
126 #define   CS43L22_REG_TONE_CTL            0x1F
127 #define   CS43L22_REG_MASTER_A_VOL        0x20
128 #define   CS43L22_REG_MASTER_B_VOL        0x21
129 #define   CS43L22_REG_HEADPHONE_A_VOL     0x22
130 #define   CS43L22_REG_HEADPHONE_B_VOL     0x23
131 #define   CS43L22_REG_SPEAKER_A_VOL       0x24
132 #define   CS43L22_REG_SPEAKER_B_VOL       0x25
133 #define   CS43L22_REG_CH_MIXER_SWAP       0x26
134 #define   CS43L22_REG_LIMIT_CTL1          0x27
135 #define   CS43L22_REG_LIMIT_CTL2          0x28
136 #define   CS43L22_REG_LIMIT_ATTACK_RATE   0x29
137 #define   CS43L22_REG_OVF_CLK_STATUS      0x2E
138 #define   CS43L22_REG_BATT_COMPENSATION   0x2F
139 #define   CS43L22_REG_VP_BATTERY_LEVEL    0x30
140 #define   CS43L22_REG_SPEAKER_STATUS      0x31
141 #define   CS43L22_REG_TEMPMONITOR_CTL     0x32
142 #define   CS43L22_REG_THERMAL_FOLDBACK    0x33
143 #define   CS43L22_REG_CHARGE_PUMP_FREQ    0x34
144 
145 /******************************************************************************/
146 /****************************** REGISTER MAPPING ******************************/
147 /******************************************************************************/
148 /**
149   * @brief  CS43L22 ID
150   */
151 #define  CS43L22_ID            0xE0
152 #define  CS43L22_ID_MASK       0xF8
153 /**
154   * @brief Chip ID Register: Chip I.D. and Revision Register
155   *  Read only register
156   *  Default value: 0x01
157   *  [7:3] CHIPID[4:0]: I.D. code for the CS43L22.
158   *        Default value: 11100b
159   *  [2:0] REVID[2:0]: CS43L22 revision level.
160   *        Default value:
161   *        000 - Rev A0
162   *        001 - Rev A1
163   *        010 - Rev B0
164   *        011 - Rev B1
165   */
166 #define CS43L22_CHIPID_ADDR    0x01
167 
168 /**
169   * @}
170   */
171 
172 /** @defgroup CS43L22_Exported_Macros
173   * @{
174   */
175 
176 /**
177   * @}
178   */
179 
180 /** @defgroup CS43L22_Exported_Functions
181   * @{
182   */
183 
184 /*------------------------------------------------------------------------------
185                            Audio Codec functions
186 ------------------------------------------------------------------------------*/
187 /* High Layer codec functions */
188 uint32_t cs43l22_Init(uint16_t DeviceAddr, uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq);
189 void     cs43l22_DeInit(void);
190 uint32_t cs43l22_ReadID(uint16_t DeviceAddr);
191 uint32_t cs43l22_Play(uint16_t DeviceAddr, uint16_t* pBuffer, uint16_t Size);
192 uint32_t cs43l22_Pause(uint16_t DeviceAddr);
193 uint32_t cs43l22_Resume(uint16_t DeviceAddr);
194 uint32_t cs43l22_Stop(uint16_t DeviceAddr, uint32_t Cmd);
195 uint32_t cs43l22_SetVolume(uint16_t DeviceAddr, uint8_t Volume);
196 uint32_t cs43l22_SetFrequency(uint16_t DeviceAddr, uint32_t AudioFreq);
197 uint32_t cs43l22_SetMute(uint16_t DeviceAddr, uint32_t Cmd);
198 uint32_t cs43l22_SetOutputMode(uint16_t DeviceAddr, uint8_t Output);
199 uint32_t cs43l22_Reset(uint16_t DeviceAddr);
200 
201 /* AUDIO IO functions */
202 void      AUDIO_IO_Init(void);
203 void      AUDIO_IO_DeInit(void);
204 void      AUDIO_IO_Write(uint8_t Addr, uint8_t Reg, uint8_t Value);
205 uint8_t   AUDIO_IO_Read(uint8_t Addr, uint8_t Reg);
206 
207 /* Audio driver structure */
208 extern AUDIO_DrvTypeDef   cs43l22_drv;
209 
210 #endif /* __CS43L22_H */
211 
212 /**
213   * @}
214   */
215 
216 /**
217   * @}
218   */
219 
220 /**
221   * @}
222   */
223 
224 /**
225   * @}
226   */
227 
228 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
229