ST / BSP_DISCO_L476VG

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   DiscoLogger DISCO_L476VG_GlassLCD DISCO_L476VG_MicrophoneRecorder DISCO_L476VG_UART ... more

Drivers/BSP/Components/cs43l22/cs43l22.h@1:917af0ca86df, 2017-07-05 (annotated)

Committer:
Jerome Coutant
Date:
Wed Jul 05 10:51:49 2017 +0200
Revision:
1:917af0ca86df
Child:
5:4943b15cce9f
Update with STM32Cube_FW_L4_V1.8.0

Who changed what in which revision?

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