BSP Drivers
Dependencies: CMSIS_STM32L4xx CMSIS_DSP_401 STM32L4xx_HAL_Driver
Components/cs43l22/cs43l22.h
- Committer:
- EricLew
- Date:
- 2015-11-22
- Revision:
- 4:a1219ef3537f
- Parent:
- 0:ad9dfc0179dc
File content as of revision 4:a1219ef3537f:
/** ****************************************************************************** * @file cs43l22.h * @author MCD Application Team * @version V2.0.1 * @date 16-September-2015 * @brief This file contains all the functions prototypes for the cs43l22.c driver. ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __CS43l22_H #define __CS43l22_H /* Includes ------------------------------------------------------------------*/ #include "../Common/audio.h" /** @addtogroup BSP * @{ */ /** @addtogroup Component * @{ */ /** @addtogroup CS43l22 * @{ */ /** @defgroup CS43l22_Exported_Types * @{ */ /** * @} */ /** @defgroup CS43l22_Exported_Constants * @{ */ /******************************************************************************/ /*************************** Codec User defines ******************************/ /******************************************************************************/ /* Codec output DEVICE */ #define OUTPUT_DEVICE_SPEAKER 1 #define OUTPUT_DEVICE_HEADPHONE 2 #define OUTPUT_DEVICE_BOTH 3 #define OUTPUT_DEVICE_AUTO 4 /* Volume Levels values */ #define DEFAULT_VOLMIN 0x00 #define DEFAULT_VOLMAX 0xFF #define DEFAULT_VOLSTEP 0x04 #define AUDIO_PAUSE 0 #define AUDIO_RESUME 1 /* Codec POWER DOWN modes */ #define CODEC_PDWN_HW 1 #define CODEC_PDWN_SW 2 /* MUTE commands */ #define AUDIO_MUTE_ON 1 #define AUDIO_MUTE_OFF 0 /* AUDIO FREQUENCY */ #define AUDIO_FREQUENCY_192K ((uint32_t)192000) #define AUDIO_FREQUENCY_96K ((uint32_t)96000) #define AUDIO_FREQUENCY_48K ((uint32_t)48000) #define AUDIO_FREQUENCY_44K ((uint32_t)44100) #define AUDIO_FREQUENCY_32K ((uint32_t)32000) #define AUDIO_FREQUENCY_22K ((uint32_t)22050) #define AUDIO_FREQUENCY_16K ((uint32_t)16000) #define AUDIO_FREQUENCY_11K ((uint32_t)11025) #define AUDIO_FREQUENCY_8K ((uint32_t)8000) /******************************************************************************/ /****************************** REGISTER MAPPING ******************************/ /******************************************************************************/ /** * @brief CS43L22 ID */ #define CS43L22_ID 0xE0 #define CS43L22_ID_MASK 0xF8 /** * @brief Chip ID Register: Chip I.D. and Revision Register * Read only register * Default value: 0x01 * [7:3] CHIPID[4:0]: I.D. code for the CS43L22. * Default value: 11100b * [2:0] REVID[2:0]: CS43L22 revision level. * Default value: * 000 - Rev A0 * 001 - Rev A1 * 010 - Rev B0 * 011 - Rev B1 */ #define CS43L22_CHIPID_ADDR 0x01 /** * @} */ /** @defgroup CS43l22_Exported_Macros * @{ */ #define VOLUME_CONVERT(Volume) (((Volume) > 100)? 100:((uint8_t)(((Volume) * 255) / 100))) /** * @} */ /** @defgroup CS43l22_Exported_Functions * @{ */ /*------------------------------------------------------------------------------ Audio Codec functions ------------------------------------------------------------------------------*/ /* High Layer codec functions */ uint32_t cs43l22_Init(uint16_t DeviceAddr, uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq); void cs43l22_DeInit(void); uint32_t cs43l22_ReadID(uint16_t DeviceAddr); uint32_t cs43l22_Play(uint16_t DeviceAddr, uint16_t* pBuffer, uint16_t Size); uint32_t cs43l22_Pause(uint16_t DeviceAddr); uint32_t cs43l22_Resume(uint16_t DeviceAddr); uint32_t cs43l22_Stop(uint16_t DeviceAddr, uint32_t Cmd); uint32_t cs43l22_SetVolume(uint16_t DeviceAddr, uint8_t Volume); uint32_t cs43l22_SetFrequency(uint16_t DeviceAddr, uint32_t AudioFreq); uint32_t cs43l22_SetMute(uint16_t DeviceAddr, uint32_t Cmd); uint32_t cs43l22_SetOutputMode(uint16_t DeviceAddr, uint8_t Output); uint32_t cs43l22_Reset(uint16_t DeviceAddr); /* AUDIO IO functions */ void AUDIO_IO_Init(void); void AUDIO_IO_DeInit(void); void AUDIO_IO_Write(uint8_t Addr, uint8_t Reg, uint8_t Value); uint8_t AUDIO_IO_Read(uint8_t Addr, uint8_t Reg); /* Audio driver structure */ extern AUDIO_DrvTypeDef cs43l22_drv; #endif /* __CS43l22_H */ /** * @} */ /** * @} */ /** * @} */ /** * @} */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/