Viktor Zhezher / Mbed 2 deprecated SI570_VFO_F746NG

Library to control Silicon Labs SI570 10 MHZ TO 1.4 GHZ I2C PROGRAMMABLE XO/VCXO.

Dependencies:   mbed

Fork of SI570 by Gerrit Polder

BSP_F746NG/wm8994.h@1:1556bcaaf759, 2016-03-27 (annotated)

Committer:
DL3LD
Date:
Sun Mar 27 06:55:59 2016 +0000
Revision:
1:1556bcaaf759
STM32F746NG SI570 VFO Test

Who changed what in which revision?

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