nguyen nam / F746-GUI

SPKT

Dependents:   Player

BSP_DISCO_F746NG/wm8994.h@0:4e245f4bc8ac, 2019-06-07 (annotated)

Committer:
phungductung
Date:
Fri Jun 07 05:06:42 2019 +0000
Revision:
0:4e245f4bc8ac
spkt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:4e245f4bc8ac 1 /**
phungductung 0:4e245f4bc8ac 2 ******************************************************************************
phungductung 0:4e245f4bc8ac 3 * @file wm8994.h
phungductung 0:4e245f4bc8ac 4 * @author MCD Application Team
phungductung 0:4e245f4bc8ac 5 * @version V2.0.0
phungductung 0:4e245f4bc8ac 6 * @date 24-June-2015
phungductung 0:4e245f4bc8ac 7 * @brief This file contains all the functions prototypes for the
phungductung 0:4e245f4bc8ac 8 * wm8994.c driver.
phungductung 0:4e245f4bc8ac 9 ******************************************************************************
phungductung 0:4e245f4bc8ac 10 * @attention
phungductung 0:4e245f4bc8ac 11 *
phungductung 0:4e245f4bc8ac 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
phungductung 0:4e245f4bc8ac 13 *
phungductung 0:4e245f4bc8ac 14 * Redistribution and use in source and binary forms, with or without modification,
phungductung 0:4e245f4bc8ac 15 * are permitted provided that the following conditions are met:
phungductung 0:4e245f4bc8ac 16 * 1. Redistributions of source code must retain the above copyright notice,
phungductung 0:4e245f4bc8ac 17 * this list of conditions and the following disclaimer.
phungductung 0:4e245f4bc8ac 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
phungductung 0:4e245f4bc8ac 19 * this list of conditions and the following disclaimer in the documentation
phungductung 0:4e245f4bc8ac 20 * and/or other materials provided with the distribution.
phungductung 0:4e245f4bc8ac 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
phungductung 0:4e245f4bc8ac 22 * may be used to endorse or promote products derived from this software
phungductung 0:4e245f4bc8ac 23 * without specific prior written permission.
phungductung 0:4e245f4bc8ac 24 *
phungductung 0:4e245f4bc8ac 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
phungductung 0:4e245f4bc8ac 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
phungductung 0:4e245f4bc8ac 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
phungductung 0:4e245f4bc8ac 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
phungductung 0:4e245f4bc8ac 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
phungductung 0:4e245f4bc8ac 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
phungductung 0:4e245f4bc8ac 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
phungductung 0:4e245f4bc8ac 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
phungductung 0:4e245f4bc8ac 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
phungductung 0:4e245f4bc8ac 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
phungductung 0:4e245f4bc8ac 35 *
phungductung 0:4e245f4bc8ac 36 ******************************************************************************
phungductung 0:4e245f4bc8ac 37 */
phungductung 0:4e245f4bc8ac 38
phungductung 0:4e245f4bc8ac 39 /* Define to prevent recursive inclusion -------------------------------------*/
phungductung 0:4e245f4bc8ac 40 #ifndef __WM8994_H
phungductung 0:4e245f4bc8ac 41 #define __WM8994_H
phungductung 0:4e245f4bc8ac 42
phungductung 0:4e245f4bc8ac 43 /* Includes ------------------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 44 #include "audio.h" // MBED
phungductung 0:4e245f4bc8ac 45
phungductung 0:4e245f4bc8ac 46 /** @addtogroup BSP
phungductung 0:4e245f4bc8ac 47 * @{
phungductung 0:4e245f4bc8ac 48 */
phungductung 0:4e245f4bc8ac 49
phungductung 0:4e245f4bc8ac 50 /** @addtogroup Component
phungductung 0:4e245f4bc8ac 51 * @{
phungductung 0:4e245f4bc8ac 52 */
phungductung 0:4e245f4bc8ac 53
phungductung 0:4e245f4bc8ac 54 /** @addtogroup WM8994
phungductung 0:4e245f4bc8ac 55 * @{
phungductung 0:4e245f4bc8ac 56 */
phungductung 0:4e245f4bc8ac 57
phungductung 0:4e245f4bc8ac 58 /** @defgroup WM8994_Exported_Types
phungductung 0:4e245f4bc8ac 59 * @{
phungductung 0:4e245f4bc8ac 60 */
phungductung 0:4e245f4bc8ac 61
phungductung 0:4e245f4bc8ac 62 /**
phungductung 0:4e245f4bc8ac 63 * @}
phungductung 0:4e245f4bc8ac 64 */
phungductung 0:4e245f4bc8ac 65
phungductung 0:4e245f4bc8ac 66 /** @defgroup WM8994_Exported_Constants
phungductung 0:4e245f4bc8ac 67 * @{
phungductung 0:4e245f4bc8ac 68 */
phungductung 0:4e245f4bc8ac 69
phungductung 0:4e245f4bc8ac 70 /******************************************************************************/
phungductung 0:4e245f4bc8ac 71 /*************************** Codec User defines ******************************/
phungductung 0:4e245f4bc8ac 72 /******************************************************************************/
phungductung 0:4e245f4bc8ac 73 /* Codec output DEVICE */
phungductung 0:4e245f4bc8ac 74 #define OUTPUT_DEVICE_SPEAKER ((uint16_t)0x0001)
phungductung 0:4e245f4bc8ac 75 #define OUTPUT_DEVICE_HEADPHONE ((uint16_t)0x0002)
phungductung 0:4e245f4bc8ac 76 #define OUTPUT_DEVICE_BOTH ((uint16_t)0x0003)
phungductung 0:4e245f4bc8ac 77 #define OUTPUT_DEVICE_AUTO ((uint16_t)0x0004)
phungductung 0:4e245f4bc8ac 78 #define INPUT_DEVICE_DIGITAL_MICROPHONE_1 ((uint16_t)0x0100)
phungductung 0:4e245f4bc8ac 79 #define INPUT_DEVICE_DIGITAL_MICROPHONE_2 ((uint16_t)0x0200)
phungductung 0:4e245f4bc8ac 80 #define INPUT_DEVICE_INPUT_LINE_1 ((uint16_t)0x0300)
phungductung 0:4e245f4bc8ac 81 #define INPUT_DEVICE_INPUT_LINE_2 ((uint16_t)0x0400)
phungductung 0:4e245f4bc8ac 82
phungductung 0:4e245f4bc8ac 83 /* Volume Levels values */
phungductung 0:4e245f4bc8ac 84 #define DEFAULT_VOLMIN 0x00
phungductung 0:4e245f4bc8ac 85 #define DEFAULT_VOLMAX 0xFF
phungductung 0:4e245f4bc8ac 86 #define DEFAULT_VOLSTEP 0x04
phungductung 0:4e245f4bc8ac 87
phungductung 0:4e245f4bc8ac 88 #define AUDIO_PAUSE 0
phungductung 0:4e245f4bc8ac 89 #define AUDIO_RESUME 1
phungductung 0:4e245f4bc8ac 90
phungductung 0:4e245f4bc8ac 91 /* Codec POWER DOWN modes */
phungductung 0:4e245f4bc8ac 92 #define CODEC_PDWN_HW 1
phungductung 0:4e245f4bc8ac 93 #define CODEC_PDWN_SW 2
phungductung 0:4e245f4bc8ac 94
phungductung 0:4e245f4bc8ac 95 /* MUTE commands */
phungductung 0:4e245f4bc8ac 96 #define AUDIO_MUTE_ON 1
phungductung 0:4e245f4bc8ac 97 #define AUDIO_MUTE_OFF 0
phungductung 0:4e245f4bc8ac 98
phungductung 0:4e245f4bc8ac 99 /* AUDIO FREQUENCY */
phungductung 0:4e245f4bc8ac 100 #define AUDIO_FREQUENCY_192K ((uint32_t)192000)
phungductung 0:4e245f4bc8ac 101 #define AUDIO_FREQUENCY_96K ((uint32_t)96000)
phungductung 0:4e245f4bc8ac 102 #define AUDIO_FREQUENCY_48K ((uint32_t)48000)
phungductung 0:4e245f4bc8ac 103 #define AUDIO_FREQUENCY_44K ((uint32_t)44100)
phungductung 0:4e245f4bc8ac 104 #define AUDIO_FREQUENCY_32K ((uint32_t)32000)
phungductung 0:4e245f4bc8ac 105 #define AUDIO_FREQUENCY_22K ((uint32_t)22050)
phungductung 0:4e245f4bc8ac 106 #define AUDIO_FREQUENCY_16K ((uint32_t)16000)
phungductung 0:4e245f4bc8ac 107 #define AUDIO_FREQUENCY_11K ((uint32_t)11025)
phungductung 0:4e245f4bc8ac 108 #define AUDIO_FREQUENCY_8K ((uint32_t)8000)
phungductung 0:4e245f4bc8ac 109
phungductung 0:4e245f4bc8ac 110 #define VOLUME_CONVERT(Volume) (((Volume) > 100)? 100:((uint8_t)(((Volume) * 63) / 100)))
phungductung 0:4e245f4bc8ac 111 #define VOLUME_IN_CONVERT(Volume) (((Volume) >= 100)? 239:((uint8_t)(((Volume) * 240) / 100)))
phungductung 0:4e245f4bc8ac 112
phungductung 0:4e245f4bc8ac 113 /******************************************************************************/
phungductung 0:4e245f4bc8ac 114 /****************************** REGISTER MAPPING ******************************/
phungductung 0:4e245f4bc8ac 115 /******************************************************************************/
phungductung 0:4e245f4bc8ac 116 /**
phungductung 0:4e245f4bc8ac 117 * @brief WM8994 ID
phungductung 0:4e245f4bc8ac 118 */
phungductung 0:4e245f4bc8ac 119 #define WM8994_ID 0x8994
phungductung 0:4e245f4bc8ac 120
phungductung 0:4e245f4bc8ac 121 /**
phungductung 0:4e245f4bc8ac 122 * @brief Device ID Register: Reading from this register will indicate device
phungductung 0:4e245f4bc8ac 123 * family ID 8994h
phungductung 0:4e245f4bc8ac 124 */
phungductung 0:4e245f4bc8ac 125 #define WM8994_CHIPID_ADDR 0x00
phungductung 0:4e245f4bc8ac 126
phungductung 0:4e245f4bc8ac 127 /**
phungductung 0:4e245f4bc8ac 128 * @}
phungductung 0:4e245f4bc8ac 129 */
phungductung 0:4e245f4bc8ac 130
phungductung 0:4e245f4bc8ac 131 /** @defgroup WM8994_Exported_Macros
phungductung 0:4e245f4bc8ac 132 * @{
phungductung 0:4e245f4bc8ac 133 */
phungductung 0:4e245f4bc8ac 134 /**
phungductung 0:4e245f4bc8ac 135 * @}
phungductung 0:4e245f4bc8ac 136 */
phungductung 0:4e245f4bc8ac 137
phungductung 0:4e245f4bc8ac 138 /** @defgroup WM8994_Exported_Functions
phungductung 0:4e245f4bc8ac 139 * @{
phungductung 0:4e245f4bc8ac 140 */
phungductung 0:4e245f4bc8ac 141
phungductung 0:4e245f4bc8ac 142 /*------------------------------------------------------------------------------
phungductung 0:4e245f4bc8ac 143 Audio Codec functions
phungductung 0:4e245f4bc8ac 144 ------------------------------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 145 /* High Layer codec functions */
phungductung 0:4e245f4bc8ac 146 uint32_t wm8994_Init(uint16_t DeviceAddr, uint16_t OutputInputDevice, uint8_t Volume, uint32_t AudioFreq);
phungductung 0:4e245f4bc8ac 147 void wm8994_DeInit(void);
phungductung 0:4e245f4bc8ac 148 uint32_t wm8994_ReadID(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 149 uint32_t wm8994_Play(uint16_t DeviceAddr, uint16_t* pBuffer, uint16_t Size);
phungductung 0:4e245f4bc8ac 150 uint32_t wm8994_Pause(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 151 uint32_t wm8994_Resume(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 152 uint32_t wm8994_Stop(uint16_t DeviceAddr, uint32_t Cmd);
phungductung 0:4e245f4bc8ac 153 uint32_t wm8994_SetVolume(uint16_t DeviceAddr, uint8_t Volume);
phungductung 0:4e245f4bc8ac 154 uint32_t wm8994_SetMute(uint16_t DeviceAddr, uint32_t Cmd);
phungductung 0:4e245f4bc8ac 155 uint32_t wm8994_SetOutputMode(uint16_t DeviceAddr, uint8_t Output);
phungductung 0:4e245f4bc8ac 156 uint32_t wm8994_SetFrequency(uint16_t DeviceAddr, uint32_t AudioFreq);
phungductung 0:4e245f4bc8ac 157 uint32_t wm8994_Reset(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 158
phungductung 0:4e245f4bc8ac 159 /* AUDIO IO functions */
phungductung 0:4e245f4bc8ac 160 void AUDIO_IO_Init(void);
phungductung 0:4e245f4bc8ac 161 void AUDIO_IO_DeInit(void);
phungductung 0:4e245f4bc8ac 162 void AUDIO_IO_Write(uint8_t Addr, uint16_t Reg, uint16_t Value);
phungductung 0:4e245f4bc8ac 163 uint8_t AUDIO_IO_Read(uint8_t Addr, uint16_t Reg);
phungductung 0:4e245f4bc8ac 164 void AUDIO_IO_Delay(uint32_t Delay);
phungductung 0:4e245f4bc8ac 165
phungductung 0:4e245f4bc8ac 166 /* Audio driver structure */
phungductung 0:4e245f4bc8ac 167 extern AUDIO_DrvTypeDef wm8994_drv;
phungductung 0:4e245f4bc8ac 168
phungductung 0:4e245f4bc8ac 169 #endif /* __WM8994_H */
phungductung 0:4e245f4bc8ac 170
phungductung 0:4e245f4bc8ac 171 /**
phungductung 0:4e245f4bc8ac 172 * @}
phungductung 0:4e245f4bc8ac 173 */
phungductung 0:4e245f4bc8ac 174
phungductung 0:4e245f4bc8ac 175 /**
phungductung 0:4e245f4bc8ac 176 * @}
phungductung 0:4e245f4bc8ac 177 */
phungductung 0:4e245f4bc8ac 178
phungductung 0:4e245f4bc8ac 179 /**
phungductung 0:4e245f4bc8ac 180 * @}
phungductung 0:4e245f4bc8ac 181 */
phungductung 0:4e245f4bc8ac 182
phungductung 0:4e245f4bc8ac 183 /**
phungductung 0:4e245f4bc8ac 184 * @}
phungductung 0:4e245f4bc8ac 185 */
phungductung 0:4e245f4bc8ac 186
phungductung 0:4e245f4bc8ac 187 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/