arduino-audio-driver
Loading...
Searching...
No Matches
Classes | Namespaces | Enumerations | Variables
WM8960.h File Reference
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "DriverCommon.h"
#include "Platforms/API_I2C.h"

Go to the source code of this file.

Classes

struct  _wm8960_operation_t
 
class  WM8960
 Header-only driver class for the WM8960 audio codec chip. More...
 

Namespaces

namespace  audio_driver
 Namespace for audio driver components.
 

Enumerations

enum  _wm8960_sysclk_freq_t { _WM8960_SYSCLK_FREQ_12288000_HZ = 12288000 , _WM8960_SYSCLK_FREQ_11289600_HZ = 11289600 }
 
enum  wm8960_adc_dac_sample_rate_t {
  WM8960_ADC_DAC_SAMPLE_RATE_48_KHZ , WM8960_ADC_DAC_SAMPLE_RATE_44_1_KHZ , WM8960_ADC_DAC_SAMPLE_RATE_32_KHZ , WM8960_ADC_DAC_SAMPLE_RATE_24_KHZ ,
  WM8960_ADC_DAC_SAMPLE_RATE_22_05_KHZ , WM8960_ADC_DAC_SAMPLE_RATE_16_KHZ , WM8960_ADC_DAC_SAMPLE_RATE_12_KHZ , WM8960_ADC_DAC_SAMPLE_RATE_11_025_KHZ ,
  WM8960_ADC_DAC_SAMPLE_RATE_8_018_KHZ , WM8960_ADC_DAC_SAMPLE_RATE_8_KHZ
}
 
enum  wm8960_features_t {
  WM8960_FEATURE_NONE = 0x00 , WM8960_FEATURE_MICROPHONE1 = 0x01 , WM8960_FEATURE_MICROPHONE2 = 0x02 , WM8960_FEATURE_MICROPHONE3 = 0x04 ,
  WM8960_FEATURE_HEADPHONE = 0x08 , WM8960_FEATURE_SPEAKER = 0x10
}
 
enum  wm8960_mode_t { WM8960_MODE_MASTER = WM8960_AUDIO_INTF0_MS_MASTER , WM8960_MODE_SLAVE = WM8960_AUDIO_INTF0_MS_SLAVE }
 
enum  wm8960_reg_t {
  WM8960_REG_LEFT_IN_VOL , WM8960_REG_RIGHT_IN_VOL , WM8960_REG_LOUT1_VOL , WM8960_REG_ROUT1_VOL ,
  WM8960_REG_CLK1 , WM8960_REG_CTR1 , WM8960_REG_CTR2 , WM8960_REG_AUDIO_INTF0 ,
  WM8960_REG_CLK2 , WM8960_REG_AUDIO_INTF1 , WM8960_REG_LEFT_DAC_VOL , WM8960_REG_RIGHT_DAC_VOL ,
  WM8960_REG_RSVD0 , WM8960_REG_RSVD1 , WM8960_REG_RSVD2 , WM8960_REG_RESET ,
  WM8960_REG_3D_CTR , WM8960_REG_ALC1 , WM8960_REG_ALC2 , WM8960_REG_ALC3 ,
  WM8960_REG_NOISE_GATE , WM8960_REG_LEFT_ADC_VOL , WM8960_REG_RIGHT_ADC_VOL , WM8960_REG_ADD_CTL1 ,
  WM8960_REG_ADD_CTL2 , WM8960_REG_PWR_MGMT1 , WM8960_REG_PWR_MGMT2 , WM8960_REG_ADD_CTL3 ,
  WM8960_REG_ANTI_POP1 , WM8960_REG_ANTI_POP2 , WM8960_REG_RSVD3 , WM8960_REG_RSVD4 ,
  WM8960_REG_ADCL_SIG_PTH , WM8960_REG_ADCR_SIG_PTH , WM8960_REG_LEFT_OUT_MIX , WM8960_REG_RSVD5 ,
  WM8960_REG_RSVD6 , WM8960_REG_RIGHT_OUT_MIX , WM8960_REG_MONO_OUT_MIX1 , WM8960_REG_MONO_OUT_MIX2 ,
  WM8960_REG_LOUT2_VOL , WM8960_REG_ROUT2_VOL , WM8960_REG_MONO_OUT_VOL , WM8960_REG_IN_BOOST_MIX1 ,
  WM8960_REG_IN_BOOST_MIX2 , WM8960_REG_BYPASS1 , WM8960_REG_BYPASS2 , WM8960_REG_PWR_MGMT3 ,
  WM8960_REG_ADD_CTL4 , WM8960_REG_CLASS_D_CTL1 , WM8960_REG_RSVD7 , WM8960_REG_CLASS_D_CTL3 ,
  WM8960_REG_PLL_N , WM8960_REG_PLL_K1 , WM8960_REG_PLL_K2 , WM8960_REG_PLL_K3
}
 
enum  wm8960_word_length_t { WM8960_WL_16BITS = WM8960_AUDIO_INTF0_WL_16BITS , WM8960_WL_20BITS = WM8960_AUDIO_INTF0_WL_20BITS , WM8960_WL_24BITS = WM8960_AUDIO_INTF0_WL_24BITS , WM8960_WL_32BITS = WM8960_AUDIO_INTF0_WL_32BITS }
 

Variables

static constexpr bool MTB_RSLT_WM8960_BAD_ARG = false
 
static constexpr uint32_t REGISTER_MAP_SIZE = 56u
 
static constexpr uint16_t WM8960_3D_CTR_3DDEPTH_100 = 0x01Eu
 
static constexpr uint16_t WM8960_3D_CTR_3DEN = 0x001u
 
static constexpr uint16_t WM8960_3D_CTR_3DLC_HIGH = 0x020u
 
static constexpr uint16_t WM8960_3D_CTR_3DLC_LOW = 0x000u
 
static constexpr uint16_t WM8960_3D_CTR_3DUC_HIGH = 0x000u
 
static constexpr uint16_t WM8960_3D_CTR_3DUC_LOW = 0x040u
 
static constexpr uint16_t WM8960_ADCL_ADCR_SIG_PTH_MIC2B_CON = 0x008u
 
static constexpr uint16_t WM8960_ADCL_ADCR_SIG_PTH_MICBOOST_0dB = 0x000u
 
static constexpr uint16_t WM8960_ADCL_ADCR_SIG_PTH_MICBOOST_13dB = 0x010u
 
static constexpr uint16_t WM8960_ADCL_ADCR_SIG_PTH_MICBOOST_20dB = 0x020u
 
static constexpr uint16_t WM8960_ADCL_ADCR_SIG_PTH_MICBOOST_29dB = 0x030u
 
static constexpr uint16_t WM8960_ADCL_ADCR_SIG_PTH_MN1_CON = 0x100u
 
static constexpr uint16_t WM8960_ADCL_ADCR_SIG_PTH_MP2_CON = 0x040u
 
static constexpr uint16_t WM8960_ADCL_ADCR_SIG_PTH_MP3_CON = 0x080u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_ALRSWAP = 0x100u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_BCLKINV = 0x080u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_DLRSWAP = 0x020u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_FORMAT_DSP_MODE = 0x003u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_FORMAT_I2S_MODE = 0x002u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_FORMAT_L_JUSTIF = 0x001u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_FORMAT_R_JUSTIF = 0x000u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_LRP_INV = 0x010u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_MS_MASTER = 0x040u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_MS_SLAVE = 0x000u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_WL_16BITS = 0x000u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_WL_20BITS = 0x004u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_WL_24BITS = 0x008u
 
static constexpr uint16_t WM8960_AUDIO_INTF0_WL_32BITS = 0x00Cu
 
static constexpr uint16_t WM8960_AUDIO_INTF1_ADCCOMP_ALAW = 0x006u
 
static constexpr uint16_t WM8960_AUDIO_INTF1_ADCCOMP_ULAW = 0x004u
 
static constexpr uint16_t WM8960_AUDIO_INTF1_ALRCGPIO_GPIO = 0x040u
 
static constexpr uint16_t WM8960_AUDIO_INTF1_DACCOMP_ALAW = 0x010u
 
static constexpr uint16_t WM8960_AUDIO_INTF1_DACCOMP_ULAW = 0x018u
 
static constexpr uint16_t WM8960_AUDIO_INTF1_LOOPBACK_EN = 0x001u
 
static constexpr uint16_t WM8960_AUDIO_INTF1_WL8_8BIT = 0x020u
 
static constexpr uint16_t WM8960_CLK1_ADCDIV_BY_1 = 0x000u
 
static constexpr uint16_t WM8960_CLK1_ADCDIV_BY_1_5 = 0x040u
 
static constexpr uint16_t WM8960_CLK1_ADCDIV_BY_2 = 0x080u
 
static constexpr uint16_t WM8960_CLK1_ADCDIV_BY_3 = 0x0C0u
 
static constexpr uint16_t WM8960_CLK1_ADCDIV_BY_4 = 0x100u
 
static constexpr uint16_t WM8960_CLK1_ADCDIV_BY_5_5 = 0x140u
 
static constexpr uint16_t WM8960_CLK1_ADCDIV_BY_6 = 0x180u
 
static constexpr uint16_t WM8960_CLK1_CLKSEL_MCLK = 0x000u
 
static constexpr uint16_t WM8960_CLK1_CLKSEL_PLL = 0x001u
 
static constexpr uint16_t WM8960_CLK1_DACDIV_BY_1 = 0x000u
 
static constexpr uint16_t WM8960_CLK1_DACDIV_BY_1_5 = 0x008u
 
static constexpr uint16_t WM8960_CLK1_DACDIV_BY_2 = 0x010u
 
static constexpr uint16_t WM8960_CLK1_DACDIV_BY_3 = 0x018u
 
static constexpr uint16_t WM8960_CLK1_DACDIV_BY_4 = 0x020u
 
static constexpr uint16_t WM8960_CLK1_DACDIV_BY_5_5 = 0x028u
 
static constexpr uint16_t WM8960_CLK1_DACDIV_BY_6 = 0x030u
 
static constexpr uint16_t WM8960_CLK1_SYSCLKDIV_BY_1 = 0x000u
 
static constexpr uint16_t WM8960_CLK1_SYSCLKDIV_BY_2 = 0x004u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_11 = 0x008u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_12 = 0x009u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_16 = 0x00Au
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_1_5 = 0x001u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_2 = 0x002u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_22 = 0x00Bu
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_24 = 0x00Cu
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_3 = 0x003u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_32 = 0x00Du
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_4 = 0x004u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_5_5 = 0x005u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_6 = 0x006u
 
static constexpr uint16_t WM8960_CLK2_BCLKDIV_BY_8 = 0x007u
 
static constexpr uint16_t WM8960_CLK2_DCLKDIV_BY_12 = 0x180u
 
static constexpr uint16_t WM8960_CLK2_DCLKDIV_BY_16 = 0x1C0u
 
static constexpr uint16_t WM8960_CLK2_DCLKDIV_BY_2 = 0x040u
 
static constexpr uint16_t WM8960_CLK2_DCLKDIV_BY_3 = 0x080u
 
static constexpr uint16_t WM8960_CLK2_DCLKDIV_BY_4 = 0x0C0u
 
static constexpr uint16_t WM8960_CLK2_DCLKDIV_BY_6 = 0x100u
 
static constexpr uint16_t WM8960_CLK2_DCLKDIV_BY_8 = 0x140u
 
static constexpr uint16_t WM8960_CTR1_ADCHPD_DIS = 0x001u
 
static constexpr uint16_t WM8960_CTR1_ADCPOL_L_INV = 0x040u
 
static constexpr uint16_t WM8960_CTR1_ADCPOL_LR_INV = 0x060u
 
static constexpr uint16_t WM8960_CTR1_ADCPOL_R_INV = 0x020u
 
static constexpr uint16_t WM8960_CTR1_DACDIV2_6B_EN = 0x080u
 
static constexpr uint16_t WM8960_CTR1_DACMU_MUTE = 0x008u
 
static constexpr uint16_t WM8960_CTR1_DACMU_NO = 0x000u
 
static constexpr uint16_t WM8960_CTR1_DEEMPH_32_KHZ = 0x002u
 
static constexpr uint16_t WM8960_CTR1_DEEMPH_44_1_KHZ = 0x004u
 
static constexpr uint16_t WM8960_CTR1_DEEMPH_48_KHZ = 0x006u
 
static constexpr uint16_t WM8960_CTR2_DACMR_SLOW_RMP = 0x004u
 
static constexpr uint16_t WM8960_CTR2_DACPOL_L_INV = 0x040u
 
static constexpr uint16_t WM8960_CTR2_DACPOL_LR_INV = 0x060u
 
static constexpr uint16_t WM8960_CTR2_DACPOL_R_INV = 0x020u
 
static constexpr uint16_t WM8960_CTR2_DACSLOPE_SS = 0x002u
 
static constexpr uint16_t WM8960_CTR2_DACSMM_GRAD = 0x008u
 
static constexpr uint8_t WM8960_FEATURE_MICROPHONES
 
static constexpr int WM8960_I2C_ADDRESS = 0x1A
 
static constexpr uint16_t WM8960_LEFT_OUT_MIX_LD2LO_EN = 0x100u
 
static constexpr uint16_t WM8960_LEFT_OUT_MIX_LI2LO_EN = 0x080u
 
static constexpr uint16_t WM8960_LEFT_RIGHT_ADC_VOL_ADCVOL_0dB = 0x0C3u
 
static constexpr uint16_t WM8960_LEFT_RIGHT_ADC_VOL_ADCVOL_30dB = 0x0FFu
 
static constexpr uint16_t WM8960_LEFT_RIGHT_ADC_VOL_ADCVU_UP = 0x100u
 
static constexpr uint16_t WM8960_LEFT_RIGHT_DAC_VOL_0dB = 0x0FFu
 
static constexpr uint16_t WM8960_LEFT_RIGHT_DAC_VOL_127dB = 0x001u
 
static constexpr uint16_t WM8960_LEFT_RIGHT_DAC_VOL_DACVU_UP = 0x100u
 
static constexpr uint16_t WM8960_LEFT_RIGHT_IN_VOL_INMUTE = 0x080u
 
static constexpr uint16_t WM8960_LEFT_RIGHT_IN_VOL_INVOL_0dB = 0x017u
 
static constexpr uint16_t WM8960_LEFT_RIGHT_IN_VOL_INVOL_30dB = 0x03Fu
 
static constexpr uint16_t WM8960_LEFT_RIGHT_IN_VOL_IPVU = 0x100u
 
static constexpr uint16_t WM8960_LEFT_RIGHT_IN_VOL_IZC_ZC = 0x040u
 
static constexpr uint16_t WM8960_LOUT1_ROUT1_VOL_O1ZC_ZC = 0x080u
 
static constexpr uint16_t WM8960_LOUT1_ROUT1_VOL_OUT1VOL_0dB = 0x079u
 
static constexpr uint16_t WM8960_LOUT1_ROUT1_VOL_OUT1VOL_6dB = 0x07Fu
 
static constexpr uint16_t WM8960_LOUT1_ROUT1_VOL_OUT1VU = 0x100u
 
static constexpr uint16_t WM8960_LOUT2_ROUT2_VOL_SPKRVOL_0dB = 0x079u
 
static constexpr uint16_t WM8960_LOUT2_ROUT2_VOL_SPKRVOL_6dB = 0x07Fu
 
static constexpr uint16_t WM8960_LOUT2_ROUT2_VOL_SPKRZC = 0x080u
 
static constexpr uint16_t WM8960_LOUT2_ROUT2_VOL_SPKVU = 0x100u
 
static constexpr uint16_t WM8960_MONO_OUT_MIX1_MIX2_2MO_DI = 0x000u
 
static constexpr uint16_t WM8960_MONO_OUT_MIX1_MIX2_2MO_EN = 0x080u
 
static constexpr uint16_t WM8960_PLL_N_OPCLKDIV_BY_1 = 0x000u
 
static constexpr uint16_t WM8960_PLL_N_OPCLKDIV_BY_2 = 0x040u
 
static constexpr uint16_t WM8960_PLL_N_OPCLKDIV_BY_3 = 0x080u
 
static constexpr uint16_t WM8960_PLL_N_OPCLKDIV_BY_4 = 0x0C0u
 
static constexpr uint16_t WM8960_PLL_N_OPCLKDIV_BY_5_5 = 0x100u
 
static constexpr uint16_t WM8960_PLL_N_OPCLKDIV_BY_6 = 0x140u
 
static constexpr uint16_t WM8960_PLL_N_PLLPRESCALE_DI = 0x000u
 
static constexpr uint16_t WM8960_PLL_N_PLLPRESCALE_EN = 0x010u
 
static constexpr uint16_t WM8960_PLL_N_SDM_FRAC = 0x020u
 
static constexpr uint16_t WM8960_PLL_N_SDM_INT = 0x000u
 
static constexpr uint16_t WM8960_PWR_MGMT1_ADCL_UP = 0x008u
 
static constexpr uint16_t WM8960_PWR_MGMT1_ADCR_UP = 0x004u
 
static constexpr uint16_t WM8960_PWR_MGMT1_AINL_UP = 0x020u
 
static constexpr uint16_t WM8960_PWR_MGMT1_AINR_UP = 0x010u
 
static constexpr uint16_t WM8960_PWR_MGMT1_DIGENB_DI = 0x001u
 
static constexpr uint16_t WM8960_PWR_MGMT1_MICB_UP = 0x002u
 
static constexpr uint16_t WM8960_PWR_MGMT1_VMIDSEL_250K = 0x100u
 
static constexpr uint16_t WM8960_PWR_MGMT1_VMIDSEL_50K = 0x080u
 
static constexpr uint16_t WM8960_PWR_MGMT1_VMIDSEL_5K = 0x180u
 
static constexpr uint16_t WM8960_PWR_MGMT1_VREF_UP = 0x040u
 
static constexpr uint16_t WM8960_PWR_MGMT2_DACL_UP = 0x100u
 
static constexpr uint16_t WM8960_PWR_MGMT2_DACR_UP = 0x080u
 
static constexpr uint16_t WM8960_PWR_MGMT2_LOUT1_UP = 0x040u
 
static constexpr uint16_t WM8960_PWR_MGMT2_OUT3_UP = 0x002u
 
static constexpr uint16_t WM8960_PWR_MGMT2_PLL_EN_UP = 0x001u
 
static constexpr uint16_t WM8960_PWR_MGMT2_ROUT1_UP = 0x020u
 
static constexpr uint16_t WM8960_PWR_MGMT2_SPKL_UP = 0x010u
 
static constexpr uint16_t WM8960_PWR_MGMT2_SPKR_UP = 0x008u
 
static constexpr uint16_t WM8960_PWR_MGMT3_LMIC_UP = 0x020u
 
static constexpr uint16_t WM8960_PWR_MGMT3_LOMIX_UP = 0x008u
 
static constexpr uint16_t WM8960_PWR_MGMT3_RMIC_UP = 0x010u
 
static constexpr uint16_t WM8960_PWR_MGMT3_ROMIX_UP = 0x004u
 
static constexpr uint16_t WM8960_RIGHT_OUT_MIX_RD2RO_EN = 0x100u
 
static constexpr uint16_t WM8960_RIGHT_OUT_MIX_RI2RO_EN = 0x080u
 
static constexpr uint32_t WM8960_TIMEOUT_MS = 100u
 

Detailed Description

Description: This file contains the function prototypes and constants used in wm8960.c. This driver is intended for the WM8960 audio codec.

Copyright
Copyright 2018-2021 Cypress Semiconductor Corporation SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Generated by doxygen 1.9.8