ST / BSP_DISCO_L496AG

BSP driver for DISCO_L496AG

Dependents:   DISCO_L496AG-LCD-prova_1 DISCO_L496AG-LCD-prova_2 DISCO_L496AG-LCD-demo DISCO_L496AG-SRAM-demo

Drivers/BSP/Components/cs42l51/cs42l51.h@0:d83f1c8ca282, 2018-03-26 (annotated)

Committer:
bcostm
Date:
Mon Mar 26 10:28:18 2018 +0200
Revision:
0:d83f1c8ca282
Child:
2:106c7b82e064
Add BSP files coming from CubeL4 V1.11.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bcostm 0:d83f1c8ca282 1 /**
bcostm 0:d83f1c8ca282 2 ******************************************************************************
bcostm 0:d83f1c8ca282 3 * @file cs42l51.h
bcostm 0:d83f1c8ca282 4 * @author MCD Application Team
bcostm 0:d83f1c8ca282 5 * @version V1.0.0
bcostm 0:d83f1c8ca282 6 * @date 17-February-2017
bcostm 0:d83f1c8ca282 7 * @brief This file contains all the functions prototypes for the cs42l51.c driver.
bcostm 0:d83f1c8ca282 8 ******************************************************************************
bcostm 0:d83f1c8ca282 9 * @attention
bcostm 0:d83f1c8ca282 10 *
bcostm 0:d83f1c8ca282 11 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
bcostm 0:d83f1c8ca282 12 *
bcostm 0:d83f1c8ca282 13 * Redistribution and use in source and binary forms, with or without modification,
bcostm 0:d83f1c8ca282 14 * are permitted provided that the following conditions are met:
bcostm 0:d83f1c8ca282 15 * 1. Redistributions of source code must retain the above copyright notice,
bcostm 0:d83f1c8ca282 16 * this list of conditions and the following disclaimer.
bcostm 0:d83f1c8ca282 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
bcostm 0:d83f1c8ca282 18 * this list of conditions and the following disclaimer in the documentation
bcostm 0:d83f1c8ca282 19 * and/or other materials provided with the distribution.
bcostm 0:d83f1c8ca282 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bcostm 0:d83f1c8ca282 21 * may be used to endorse or promote products derived from this software
bcostm 0:d83f1c8ca282 22 * without specific prior written permission.
bcostm 0:d83f1c8ca282 23 *
bcostm 0:d83f1c8ca282 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bcostm 0:d83f1c8ca282 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bcostm 0:d83f1c8ca282 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bcostm 0:d83f1c8ca282 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bcostm 0:d83f1c8ca282 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bcostm 0:d83f1c8ca282 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bcostm 0:d83f1c8ca282 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bcostm 0:d83f1c8ca282 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bcostm 0:d83f1c8ca282 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bcostm 0:d83f1c8ca282 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bcostm 0:d83f1c8ca282 34 *
bcostm 0:d83f1c8ca282 35 ******************************************************************************
bcostm 0:d83f1c8ca282 36 */
bcostm 0:d83f1c8ca282 37
bcostm 0:d83f1c8ca282 38 /* Define to prevent recursive inclusion -------------------------------------*/
bcostm 0:d83f1c8ca282 39 #ifndef __CS42L51_H
bcostm 0:d83f1c8ca282 40 #define __CS42L51_H
bcostm 0:d83f1c8ca282 41
bcostm 0:d83f1c8ca282 42 /* Includes ------------------------------------------------------------------*/
bcostm 0:d83f1c8ca282 43 #include "../Common/audio.h"
bcostm 0:d83f1c8ca282 44
bcostm 0:d83f1c8ca282 45 /** @addtogroup BSP
bcostm 0:d83f1c8ca282 46 * @{
bcostm 0:d83f1c8ca282 47 */
bcostm 0:d83f1c8ca282 48
bcostm 0:d83f1c8ca282 49 /** @addtogroup Component
bcostm 0:d83f1c8ca282 50 * @{
bcostm 0:d83f1c8ca282 51 */
bcostm 0:d83f1c8ca282 52
bcostm 0:d83f1c8ca282 53 /** @addtogroup CS42L51
bcostm 0:d83f1c8ca282 54 * @{
bcostm 0:d83f1c8ca282 55 */
bcostm 0:d83f1c8ca282 56
bcostm 0:d83f1c8ca282 57 /** @defgroup CS42L51_Exported_Types
bcostm 0:d83f1c8ca282 58 * @{
bcostm 0:d83f1c8ca282 59 */
bcostm 0:d83f1c8ca282 60
bcostm 0:d83f1c8ca282 61 /**
bcostm 0:d83f1c8ca282 62 * @}
bcostm 0:d83f1c8ca282 63 */
bcostm 0:d83f1c8ca282 64
bcostm 0:d83f1c8ca282 65 /** @defgroup CS42L51_Exported_Constants
bcostm 0:d83f1c8ca282 66 * @{
bcostm 0:d83f1c8ca282 67 */
bcostm 0:d83f1c8ca282 68
bcostm 0:d83f1c8ca282 69 /******************************************************************************/
bcostm 0:d83f1c8ca282 70 /*************************** Codec User defines ******************************/
bcostm 0:d83f1c8ca282 71 /******************************************************************************/
bcostm 0:d83f1c8ca282 72 /* Codec output devices */
bcostm 0:d83f1c8ca282 73 #define OUTPUT_DEVICE_HEADPHONE 0x01
bcostm 0:d83f1c8ca282 74
bcostm 0:d83f1c8ca282 75 /* Codec input devices */
bcostm 0:d83f1c8ca282 76 #define INPUT_DEVICE_MIC1 0x10
bcostm 0:d83f1c8ca282 77
bcostm 0:d83f1c8ca282 78 /* Volume Levels values */
bcostm 0:d83f1c8ca282 79 #define DEFAULT_VOLMIN 0x00
bcostm 0:d83f1c8ca282 80 #define DEFAULT_VOLMAX 0xFF
bcostm 0:d83f1c8ca282 81 #define DEFAULT_VOLSTEP 0x04
bcostm 0:d83f1c8ca282 82
bcostm 0:d83f1c8ca282 83 #define AUDIO_PAUSE 0
bcostm 0:d83f1c8ca282 84 #define AUDIO_RESUME 1
bcostm 0:d83f1c8ca282 85
bcostm 0:d83f1c8ca282 86 /* Codec POWER DOWN modes */
bcostm 0:d83f1c8ca282 87 #define CODEC_PDWN_HW 1
bcostm 0:d83f1c8ca282 88 #define CODEC_PDWN_SW 2
bcostm 0:d83f1c8ca282 89
bcostm 0:d83f1c8ca282 90 /* MUTE commands */
bcostm 0:d83f1c8ca282 91 #define AUDIO_MUTE_ON 1
bcostm 0:d83f1c8ca282 92 #define AUDIO_MUTE_OFF 0
bcostm 0:d83f1c8ca282 93
bcostm 0:d83f1c8ca282 94 /* AUDIO FREQUENCY */
bcostm 0:d83f1c8ca282 95 #define AUDIO_FREQUENCY_192K ((uint32_t)192000)
bcostm 0:d83f1c8ca282 96 #define AUDIO_FREQUENCY_96K ((uint32_t)96000)
bcostm 0:d83f1c8ca282 97 #define AUDIO_FREQUENCY_48K ((uint32_t)48000)
bcostm 0:d83f1c8ca282 98 #define AUDIO_FREQUENCY_44K ((uint32_t)44100)
bcostm 0:d83f1c8ca282 99 #define AUDIO_FREQUENCY_32K ((uint32_t)32000)
bcostm 0:d83f1c8ca282 100 #define AUDIO_FREQUENCY_22K ((uint32_t)22050)
bcostm 0:d83f1c8ca282 101 #define AUDIO_FREQUENCY_16K ((uint32_t)16000)
bcostm 0:d83f1c8ca282 102 #define AUDIO_FREQUENCY_11K ((uint32_t)11025)
bcostm 0:d83f1c8ca282 103 #define AUDIO_FREQUENCY_8K ((uint32_t)8000)
bcostm 0:d83f1c8ca282 104
bcostm 0:d83f1c8ca282 105 /******************************************************************************/
bcostm 0:d83f1c8ca282 106 /****************************** REGISTER MAPPING ******************************/
bcostm 0:d83f1c8ca282 107 /******************************************************************************/
bcostm 0:d83f1c8ca282 108 /**
bcostm 0:d83f1c8ca282 109 * @brief CS42L51 ID
bcostm 0:d83f1c8ca282 110 */
bcostm 0:d83f1c8ca282 111 #define CS42L51_ID 0xD8
bcostm 0:d83f1c8ca282 112 #define CS42L51_ID_MASK 0xF8
bcostm 0:d83f1c8ca282 113 /**
bcostm 0:d83f1c8ca282 114 * @brief Chip ID Register: Chip I.D. and Revision Register
bcostm 0:d83f1c8ca282 115 * Read only register
bcostm 0:d83f1c8ca282 116 * Default value: 0x01
bcostm 0:d83f1c8ca282 117 * [7:3] CHIPID[4:0]: I.D. code for the CS42L51.
bcostm 0:d83f1c8ca282 118 * Default value: 11100b
bcostm 0:d83f1c8ca282 119 * [2:0] REVID[2:0]: CS42L51 revision level.
bcostm 0:d83f1c8ca282 120 * Default value:
bcostm 0:d83f1c8ca282 121 * 000 - Rev A0
bcostm 0:d83f1c8ca282 122 * 001 - Rev A1
bcostm 0:d83f1c8ca282 123 * 010 - Rev B0
bcostm 0:d83f1c8ca282 124 * 011 - Rev B1
bcostm 0:d83f1c8ca282 125 */
bcostm 0:d83f1c8ca282 126 #define CS42L51_CHIPID_ADDR 0x01
bcostm 0:d83f1c8ca282 127
bcostm 0:d83f1c8ca282 128 /**
bcostm 0:d83f1c8ca282 129 * @}
bcostm 0:d83f1c8ca282 130 */
bcostm 0:d83f1c8ca282 131
bcostm 0:d83f1c8ca282 132 /** @defgroup CS42L51_Exported_Macros
bcostm 0:d83f1c8ca282 133 * @{
bcostm 0:d83f1c8ca282 134 */
bcostm 0:d83f1c8ca282 135 #define VOLUME_CONVERT(Volume) ((Volume >= 100) ? 0 : ((uint8_t)(((Volume * 2) + 56))))
bcostm 0:d83f1c8ca282 136 /**
bcostm 0:d83f1c8ca282 137 * @}
bcostm 0:d83f1c8ca282 138 */
bcostm 0:d83f1c8ca282 139
bcostm 0:d83f1c8ca282 140 /** @defgroup CS42L51_Exported_Functions
bcostm 0:d83f1c8ca282 141 * @{
bcostm 0:d83f1c8ca282 142 */
bcostm 0:d83f1c8ca282 143
bcostm 0:d83f1c8ca282 144 /*------------------------------------------------------------------------------
bcostm 0:d83f1c8ca282 145 Audio Codec functions
bcostm 0:d83f1c8ca282 146 ------------------------------------------------------------------------------*/
bcostm 0:d83f1c8ca282 147 /* High Layer codec functions */
bcostm 0:d83f1c8ca282 148 uint32_t cs42l51_Init(uint16_t DeviceAddr, uint16_t Device, uint8_t Volume, uint32_t AudioFreq);
bcostm 0:d83f1c8ca282 149 void cs42l51_DeInit(void);
bcostm 0:d83f1c8ca282 150 uint32_t cs42l51_ReadID(uint16_t DeviceAddr);
bcostm 0:d83f1c8ca282 151 uint32_t cs42l51_Play(uint16_t DeviceAddr, uint16_t* pBuffer, uint16_t Size);
bcostm 0:d83f1c8ca282 152 uint32_t cs42l51_Pause(uint16_t DeviceAddr);
bcostm 0:d83f1c8ca282 153 uint32_t cs42l51_Resume(uint16_t DeviceAddr);
bcostm 0:d83f1c8ca282 154 uint32_t cs42l51_Stop(uint16_t DeviceAddr, uint32_t Cmd);
bcostm 0:d83f1c8ca282 155 uint32_t cs42l51_SetVolume(uint16_t DeviceAddr, uint8_t Volume);
bcostm 0:d83f1c8ca282 156 uint32_t cs42l51_SetFrequency(uint16_t DeviceAddr, uint32_t AudioFreq);
bcostm 0:d83f1c8ca282 157 uint32_t cs42l51_SetMute(uint16_t DeviceAddr, uint32_t Cmd);
bcostm 0:d83f1c8ca282 158 uint32_t cs42l51_SetOutputMode(uint16_t DeviceAddr, uint8_t Output);
bcostm 0:d83f1c8ca282 159 uint32_t cs42l51_Reset(uint16_t DeviceAddr);
bcostm 0:d83f1c8ca282 160
bcostm 0:d83f1c8ca282 161 /* AUDIO IO functions */
bcostm 0:d83f1c8ca282 162 void AUDIO_IO_Init(void);
bcostm 0:d83f1c8ca282 163 void AUDIO_IO_DeInit(void);
bcostm 0:d83f1c8ca282 164 void AUDIO_IO_Write(uint8_t Addr, uint8_t Reg, uint8_t Value);
bcostm 0:d83f1c8ca282 165 uint8_t AUDIO_IO_Read(uint8_t Addr, uint8_t Reg);
bcostm 0:d83f1c8ca282 166 void AUDIO_IO_Delay(uint32_t Delay);
bcostm 0:d83f1c8ca282 167
bcostm 0:d83f1c8ca282 168 /* Audio driver structure */
bcostm 0:d83f1c8ca282 169 extern AUDIO_DrvTypeDef cs42l51_drv;
bcostm 0:d83f1c8ca282 170
bcostm 0:d83f1c8ca282 171 /**
bcostm 0:d83f1c8ca282 172 * @}
bcostm 0:d83f1c8ca282 173 */
bcostm 0:d83f1c8ca282 174
bcostm 0:d83f1c8ca282 175 /**
bcostm 0:d83f1c8ca282 176 * @}
bcostm 0:d83f1c8ca282 177 */
bcostm 0:d83f1c8ca282 178
bcostm 0:d83f1c8ca282 179 /**
bcostm 0:d83f1c8ca282 180 * @}
bcostm 0:d83f1c8ca282 181 */
bcostm 0:d83f1c8ca282 182
bcostm 0:d83f1c8ca282 183 /**
bcostm 0:d83f1c8ca282 184 * @}
bcostm 0:d83f1c8ca282 185 */
bcostm 0:d83f1c8ca282 186
bcostm 0:d83f1c8ca282 187 #endif /* __CS42L51_H */
bcostm 0:d83f1c8ca282 188
bcostm 0:d83f1c8ca282 189 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/