WM8918 w Ultra Low Power DAC for Portable Audio Applications DESCRIPTION FEATURES The WM8918 is a high performance ultra-low power stereo DAC optimised for portable audio applications. 3.8mW quiescent power consumption for DAC to headphone playback DAC SNR 96dB typical, THD -86dB typical 2.4mW quiescent power consumption for analogue bypass playback Control write sequencer for pop minimised start-up and shutdown Single register write for default start-up sequence The device features stereo ground-referenced headphone amplifiers using the Wolfson ‘Class-W’ amplifier techniques incorporating an innovative dual-mode charge pump architecture - to optimise efficiency and power consumption during playback. The ground-referenced headphone and line outputs eliminate AC coupling capacitors, and both outputs include common mode feedback paths to reject ground noise. Control sequences for audio path setup can be pre-loaded and executed by an integrated control write sequencer to reduce software driver development and minimise pops and clicks via Wolfson’s SilentSwitch™ technology. The analogue input stage can be configured for single ended or differential inputs. Up to 3 stereo microphone or line inputs may be connected. The input impedance is constant with PGA gain setting. Stereo digital microphone input 3 single ended inputs per stereo channel 1 fully differential mic / line input per stereo channel Digital Dynamic Range Controller (compressor / limiter) Digital sidetone mixing Ground-referenced headphone driver Ground-referenced line outputs 32-pin QFN package (4x4mm, 0.4mm pitch) A stereo digital microphone interface is provided, with a choice of two inputs. The analogue or digital microphone inputs can be mixed into the headphone or line output paths. A dynamic range controller provides compression and level control to support a wide range of portable recording applications in conjunction with the digital microphone interface. Anti-clip and quick release features offer good performance in the presence of loud impulsive noises. TM ReTune Mobile 5-band parametric equaliser with fully programmable coefficients is integrated for optimization of speaker characteristics. Programmable dynamic range control is also available for maximizing loudness, protecting speakers from clipping and preventing premature shutdown due to battery droop. Common audio sampling frequencies are supported from a wide range of external clocks, either directly or generated via the FLL. Integrated FLL provides all necessary clocks - Self-clocking modes allow processor to sleep All standard sample rates from 8kHz to 96kHz APPLICATIONS Wireless headsets Portable multimedia players Handheld gaming The WM8918 can operate directly from a single 1.8V switched supply. For optimal power consumption, the digital core can be operated from a 1.0V supply. WOLFSON MICROELECTRONICS plc To receive regular email updates, sign up at http://www.wolfsonmicro.com/enews Production Data, January 2012, Rev 4.1 Copyright 2012 Wolfson Microelectronics plc WM8918 Production Data BLOCK DIAGRAM M U X PGA IN2R DIGITAL SIDE TONE MIXING DIGITAL VOLUME CONTROL INTERPOLATION FILTERS DIGITAL MONO MIX DAC HPOUTR CLASS-W GROUNDREFERENCED OUTPUTS M U X DAC LINEOUTFB M U X PGA LINEOUTR VMID Reference MICVDD AUDIO INTERFACE TDM SUPPORT FLL / CLOCK CIRCUITRY ADAPTIVE CHARGE PUMP CPVOUTP 2.2µF 2.2µF CPVDD 2.2µF 2.2µF CPCB CPCA CPGND 100nF 100nF IRQ / GPIO1 MCLK DGND DBVDD DCVDD 4.7µF 4.7µF AIFRXDAT LRCLK AIFTXDAT BCLK / GPIO4 SDA SCLK AGND AVDD VMIDC 100nF 4.7µF w CONTROL INTERFACE 100nF 20Ω CPVOUTN MICBIAS Ground-referenced Class-W LINEOUTL 100nF 20Ω 1µF 5-BAND EQUALISER M U X 100nF 20Ω M U X DYNAMIC RANGE CONTROLLER (DRC) 100nF 20Ω DIGITAL MIC INTERFACE IN1R/DMICDAT2 HPOUTL HPOUTFB DECIMATION FILTERS 1µF DAC R IN2L DAC L M U X BYPASS R BYPASS L WM8918 IN1L/DMICDAT1 PD, Rev 4.1, January 2012 2 WM8918 Production Data TABLE OF CONTENTS DESCRIPTION ....................................................................................................... 1 FEATURES ............................................................................................................ 1 APPLICATIONS..................................................................................................... 1 BLOCK DIAGRAM ................................................................................................ 2 TABLE OF CONTENTS ......................................................................................... 3 AUDIO SIGNAL PATHS DIAGRAM ...................................................................... 6 PIN CONFIGURATION .......................................................................................... 7 ORDERING INFORMATION .................................................................................. 7 PIN DESCRIPTION ................................................................................................ 8 ABSOLUTE MAXIMUM RATINGS ........................................................................ 9 RECOMMENDED OPERATING CONDITIONS ..................................................... 9 ELECTRICAL CHARACTERISTICS ................................................................... 10 TERMINOLOGY ............................................................................................................ 10 COMMON TEST CONDITIONS .................................................................................... 10 INPUT SIGNAL PATH ................................................................................................... 11 OUTPUT SIGNAL PATH ............................................................................................... 11 BYPASS PATH .............................................................................................................. 12 CHARGE PUMP ............................................................................................................ 13 FLL ................................................................................................................................ 13 OTHER PARAMETERS ................................................................................................ 13 POWER CONSUMPTION .................................................................................... 16 COMMON TEST CONDITIONS .................................................................................... 16 POWER CONSUMPTION MEASUREMENTS .............................................................. 16 SIGNAL TIMING REQUIREMENTS .................................................................... 18 COMMON TEST CONDITIONS .................................................................................... 18 MASTER CLOCK .......................................................................................................... 18 AUDIO INTERFACE TIMING ........................................................................................ 19 MASTER MODE ............................................................................................................................................................ 19 SLAVE MODE................................................................................................................................................................ 20 TDM MODE ................................................................................................................................................................... 21 CONTROL INTERFACE TIMING .................................................................................. 22 DIGITAL FILTER CHARACTERISTICS .............................................................. 23 DMIC FILTER RESPONSES ......................................................................................... 24 DMIC HIGH PASS FILTER RESPONSES .................................................................... 24 DAC FILTER RESPONSES .......................................................................................... 25 DE-EMPHASIS FILTER RESPONSES ......................................................................... 26 DEVICE DESCRIPTION ...................................................................................... 27 INTRODUCTION ........................................................................................................... 27 ANALOGUE INPUT SIGNAL PATH .............................................................................. 28 INPUT PGA ENABLE .................................................................................................................................................... 29 INPUT PGA CONFIGURATION..................................................................................................................................... 29 SINGLE-ENDED INPUT ................................................................................................................................................ 31 DIFFERENTIAL LINE INPUT ......................................................................................................................................... 31 DIFFERENTIAL MICROPHONE INPUT ........................................................................................................................ 32 INPUT PGA GAIN CONTROL ....................................................................................................................................... 32 INPUT PGA COMMON MODE AMPLIFIER .................................................................................................................. 34 ELECTRET CONDENSER MICROPHONE INTERFACE ............................................. 35 MICBIAS CONTROL ...................................................................................................................................................... 35 w PD, Rev 4.1, January 2012 3 WM8918 Production Data MICBIAS CURRENT DETECT ...................................................................................................................................... 36 MICBIAS CURRENT DETECT FILTERING .................................................................................................................. 37 MICROPHONE HOOK SWITCH DETECTION .............................................................................................................. 39 DIGITAL MICROPHONE INTERFACE .......................................................................... 40 DIGITAL MICROPHONE VOLUME CONTROL............................................................................................................. 42 HIGH PASS FILTER ...................................................................................................................................................... 44 DYNAMIC RANGE CONTROL (DRC) ........................................................................... 45 COMPRESSION/LIMITING CAPABILITIES .................................................................................................................. 45 GAIN LIMITS .................................................................................................................................................................. 47 DYNAMIC CHARACTERISTICS ................................................................................................................................... 47 ANTI-CLIP CONTROL ................................................................................................................................................... 48 QUICK RELEASE CONTROL ....................................................................................................................................... 49 GAIN SMOOTHING ....................................................................................................................................................... 49 INITIALISATION ............................................................................................................................................................ 50 RETUNETM MOBILE PARAMETRIC EQUALIZER (EQ) ................................................ 51 DEFAULT MODE (5-BAND PARAMETRIC EQ) ........................................................................................................... 51 TM RETUNE MOBILE MODE........................................................................................................................................... 52 EQ FILTER CHARACTERISTICS ................................................................................................................................. 52 DIGITAL MIXING ........................................................................................................... 54 DIGITAL MIXING PATHS .............................................................................................................................................. 54 DAC INTERFACE VOLUME BOOST ............................................................................................................................ 56 DIGITAL SIDETONE ...................................................................................................................................................... 56 DIGITAL-TO-ANALOGUE CONVERTER (DAC) ........................................................... 58 DAC DIGITAL VOLUME CONTROL .............................................................................................................................. 58 DAC SOFT MUTE AND SOFT UN-MUTE ..................................................................................................................... 60 DAC MONO MIX ............................................................................................................................................................ 61 DAC DE-EMPHASIS ...................................................................................................................................................... 61 DAC SLOPING STOPBAND FILTER ............................................................................................................................ 62 DAC OVERSAMPLING RATIO (OSR) .......................................................................................................................... 62 OUTPUT SIGNAL PATH ............................................................................................... 63 OUTPUT SIGNAL PATHS ENABLE .............................................................................................................................. 64 HEADPHONE / LINE OUTPUT SIGNAL PATHS ENABLE ........................................................................................... 64 OUTPUT MUX CONTROL ............................................................................................................................................. 69 OUTPUT VOLUME CONTROL...................................................................................................................................... 69 ANALOGUE OUTPUTS ................................................................................................. 72 HEADPHONE OUTPUTS – HPOUTL AND HPOUTR ................................................................................................... 72 LINE OUTPUTS – LINEOUTL AND LINEOUTR............................................................................................................ 72 EXTERNAL COMPONENTS FOR GROUND REFERENCED OUTPUTS .................................................................... 73 REFERENCE VOLTAGES AND MASTER BIAS........................................................... 74 POP SUPPRESSION CONTROL .................................................................................. 75 DISABLED INPUT CONTROL ....................................................................................................................................... 75 CHARGE PUMP ............................................................................................................ 76 DC SERVO .................................................................................................................... 77 DC SERVO ENABLE AND START-UP ......................................................................................................................... 77 DC SERVO ACTIVE MODES ........................................................................................................................................ 80 DC SERVO READBACK ............................................................................................................................................... 82 DIGITAL AUDIO INTERFACE ....................................................................................... 82 MASTER AND SLAVE MODE OPERATION ................................................................................................................. 83 OPERATION WITH TDM ............................................................................................................................................... 83 BCLK FREQUENCY ...................................................................................................................................................... 84 AUDIO DATA FORMATS (NORMAL MODE) ................................................................................................................ 84 AUDIO DATA FORMATS (TDM MODE)........................................................................................................................ 87 DIGITAL AUDIO INTERFACE CONTROL..................................................................... 89 AUDIO INTERFACE OUTPUT TRI-STATE ................................................................................................................... 90 w PD, Rev 4.1, January 2012 4 Production Data WM8918 BCLK AND LRCLK CONTROL ...................................................................................................................................... 90 COMPANDING .............................................................................................................................................................. 91 LOOPBACK ................................................................................................................................................................... 93 DIGITAL PULL-UP AND PULL-DOWN .......................................................................................................................... 93 CLOCKING AND SAMPLE RATES ............................................................................... 95 SYSCLK CONTROL ...................................................................................................................................................... 97 CONTROL INTERFACE CLOCKING ............................................................................................................................ 97 CLOCKING CONFIGURATION ..................................................................................................................................... 98 DMIC / DAC CLOCK CONTROL ................................................................................................................................... 98 OPCLK CONTROL ........................................................................................................................................................ 99 TOCLK CONTROL ........................................................................................................................................................ 99 DAC OPERATION AT 88.2K / 96K .............................................................................................................................. 100 FREQUENCY LOCKED LOOP (FLL) .......................................................................... 101 FREE-RUNNING FLL CLOCK ..................................................................................................................................... 105 GPIO OUTPUTS FROM FLL ....................................................................................................................................... 105 EXAMPLE FLL CALCULATION................................................................................................................................... 106 EXAMPLE FLL SETTINGS .......................................................................................................................................... 107 GENERAL PURPOSE INPUT/OUTPUT (GPIO) ......................................................... 108 IRQ/GPIO1 ................................................................................................................................................................... 108 BCLK/GPIO4 ................................................................................................................................................................ 109 INTERRUPTS .............................................................................................................. 110 USING IN1L AND IN1R AS INTERRUPT INPUTS ...................................................................................................... 114 CONTROL INTERFACE .............................................................................................. 115 CONTROL WRITE SEQUENCER ............................................................................... 117 INITIATING A SEQUENCE .......................................................................................................................................... 117 PROGRAMMING A SEQUENCE ................................................................................................................................ 118 DEFAULT SEQUENCES ............................................................................................................................................. 121 START-UP SEQUENCE .............................................................................................................................................. 121 SHUTDOWN SEQUENCE ........................................................................................................................................... 123 POWER-ON RESET .................................................................................................... 125 QUICK START-UP AND SHUTDOWN ........................................................................ 127 QUICK START-UP (DEFAULT SEQUENCE) .............................................................................................................. 127 FAST START-UP FROM STANDBY ........................................................................................................................... 127 QUICK SHUTDOWN (DEFAULT SEQUENCE)........................................................................................................... 128 SOFTWARE RESET AND CHIP ID ............................................................................. 129 REGISTER MAP ................................................................................................ 130 REGISTER BITS BY ADDRESS ....................................................................... 134 APPLICATIONS INFORMATION ...................................................................... 173 RECOMMENDED EXTERNAL COMPONENTS ......................................................... 173 MIC DETECTION SEQUENCE USING MICBIAS CURRENT ..................................... 175 PACKAGE DIMENSIONS .................................................................................. 177 IMPORTANT NOTICE ....................................................................................... 178 ADDRESS .......................................................................................................... 178 w PD, Rev 4.1, January 2012 5 WM8918 Production Data AUDIO SIGNAL PATHS DIAGRAM w PD, Rev 4.1, January 2012 6 WM8918 Production Data PIN CONFIGURATION IN2L IN1R/DMICDAT2 HPOUTR LINEOUTL IN1L/DMICDAT1 HPOUTFB MCLK BCLK/GPIO4 CPVOUTN HPOUTL LRCLK AIFTXDAT CPCB CPVOUTP AIFRXDAT CPGND The WM8918 is supplied in a 32-pin QFN package. ORDERING INFORMATION DEVICE WM8918CGEFL/V TEMPERATURE RANGE -40°C to +85°C PACKAGE MOISTURE SENSITIVITY LEVEL PEAK SOLDERING TEMPERATURE 32-lead QFN MSL3 260°C MSL3 260°C (4x4x0.4mm, lead-free) WM8918CGEFL/RV -40°C to +85°C 32-lead QFN (4x4x0.4mm, lead-free, tape and reel) Note: Reel quantity = 3,500 w PD, Rev 4.1, January 2012 7 WM8918 Production Data PIN DESCRIPTION PIN NAME TYPE Digital Input / Output DESCRIPTION 1 IRQ / GPIO1 Interrupt / GPIO1 2 SCLK Digital Input Control interface clock input 3 SDA Digital Input / Output Control interface data input / output 4 DBVDD Supply Digital buffer supply (powers audio interface and control interface) 5 DGND Supply Digital ground (return path for DCVDD and DBVDD) 6 DCVDD Supply Digital core supply 7 CPVDD Supply Charge pump power supply 8 CPCA Analogue Output Charge pump flyback capacitor pin 9 CPGND Supply Charge pump ground 10 CPCB Analogue Output Charge pump flyback capacitor pin 11 CPVOUTP Analogue Output Charge pump positive supply decoupling (powers HPOUTL/R, LINEOUTL/R) 12 CPVOUTN Analogue Output Charge pump negative supply decoupling (powers HPOUTL/R, LINEOUTL/R) 13 HPOUTL Analogue Output Left headphone output (line or headphone output) 14 HPOUTFB Analogue Input Headphone output ground loop noise rejection feedback 15 HPOUTR Analogue Output Right headphone output (line or headphone output) 16 LINEOUTL Analogue Output Left line output 1 (line output) 17 LINEOUTFB Analogue Input Line output ground loop noise rejection feedback 18 LINEOUTR Analogue Output Right line output 1 (line output) 19 MICVDD Supply Microphone bias amp supply 20 MICBIAS Analogue Output Microphone bias 21 VMIDC Analogue Output Midrail voltage decoupling capacitor 22 AGND Supply Analogue power return 23 AVDD Supply Analogue power supply (powers analogue inputs, reference, DAC) 24 IN2R Analogue Input Right channel input 2 25 IN1R / DMICDAT2 Analogue / Digital Input Right channel input 1 / Digital microphone data input 2 26 IN2L Analogue Input Left channel input 2 27 IN1L / DMICDAT1 Analogue / Digital Input Left channel input 1 / Digital microphone data input 1 28 MCLK Digital Input Master clock 29 BCLK / GPIO4 Digital Input / Output Audio interface bit clock / GPIO4 30 LRCLK Digital Input / Output Audio interface left / right clock (common for TX and RX) 31 AIFTXDAT Digital Output TX digital audio data (digital microphone data) 32 AIFRXDAT Digital Input RX digital audio data (DAC digital playback data) Note: 1. It is recommended that the QFN ground paddle is connected to analogue ground on the application PCB. w PD, Rev 4.1, January 2012 8 WM8918 Production Data ABSOLUTE MAXIMUM RATINGS Absolute Maximum Ratings are stress ratings only. Permanent damage to the device may be caused by continuously operating at or beyond these limits. Device functional operating limits and guaranteed performance specifications are given under Electrical Characteristics at the test conditions specified. ESD Sensitive Device. This device is manufactured on a CMOS process. It is therefore generically susceptible to damage from excessive static voltages. Proper ESD precautions must be taken during handling and storage of this device. Wolfson tests its package types according to IPC/JEDEC J-STD-020B for Moisture Sensitivity to determine acceptable storage conditions prior to surface mount assembly. These levels are: MSL1 = unlimited floor life at <30C / 85% Relative Humidity. Not normally stored in moisture barrier bag. MSL2 = out of bag storage for 1 year at <30C / 60% Relative Humidity. Supplied in moisture barrier bag. MSL3 = out of bag storage for 168 hours at <30C / 60% Relative Humidity. Supplied in moisture barrier bag. The Moisture Sensitivity Level for each package type is specified in Ordering Information. CONDITION MIN MAX AVDD, DCVDD -0.3V +2.5V DBVDD -0.3V +4.5V MICVDD -0.3V +4.5V CPVDD -0.3V +2.2V (CPVDD + 0.3V) * -1 CPVDD + 0.3V Voltage range digital inputs DGND -0.3V DBVDD +0.3V Voltage range analogue inputs AGND -0.3V AVDD +0.3V HPOUTL, HPOUTR, LINEOUTL, LINEOUTR Temperature range, TA -40C +85C Storage temperature after soldering -65C +150C Notes: 1. Analogue and digital grounds must always be within 0.3V of each other. 2. All digital and analogue supplies are completely independent from each other; there is no restriction on power supply sequencing. 3. HPOUTL, HPOUTR, LINEOUTL, LINEOUTR are outputs, and should not normally become connected to DC levels. However, if the limits above are exceeded, then damage to the WM8918 may occur. RECOMMENDED OPERATING CONDITIONS PARAMETER SYMBOL MIN TYP MAX UNIT Digital supply range (Core) DCVDD 0.95 1.0 1.98 V Digital supply range (Buffer) DBVDD 1.42 1.8 3.6 V AVDD 1.71 1.8 2.0 V Analogue supplies range Charge pump supply range CPVDD 1.71 1.8 2.0 V Microphone bias MICVDD 1.71 2.5 3.6 V -40 +25 +85 C Ground Operating Temperature (ambient) w DGND, AGND, CPGND TA 0 V PD, Rev 4.1, January 2012 9 WM8918 Production Data ELECTRICAL CHARACTERISTICS TERMINOLOGY 1. Signal-to-Noise Ratio (dB) – SNR is the difference in level between a full scale output signal and the device output noise with no signal applied, measured over a bandwidth of 20Hz to 20kHz. This ratio is also called idle channel noise. (No Auto-zero or Automute function is employed). 2. Total Harmonic Distortion (dB) – THD is the difference in level between a 1kHz full scale sinewave output signal and the first seven harmonics of the output signal. The amplitude of the fundamental frequency of the output signal is compared to the RMS value of the next seven harmonics and expressed as a ratio. 3. Total Harmonic Distortion + Noise (dB) – THD+N is the difference in level between a 1kHz full scale sine wave output signal and all noise and distortion products in the audio band. The amplitude of the fundamental reference frequency of the output signal is compared to the RMS value of all other noise and distortion products and expressed as a ratio. 4. Channel Separation (dB) – is a measure of the coupling between left and right channels. A full scale signal is applied to the left channel only, the right channel amplitude is measured. Then a full scale signal is applied to the right channel only and the left channel amplitude is measured. The worst case channel separation is quoted as a ratio. 5. Channel Level Matching (dB) – measures the difference in gain between the left and the right channels. 6. Power Supply Rejection Ratio (dB) – PSRR is a measure of ripple attenuation between the power supply pin and an output path. With the signal path idle, a small signal sine wave is summed onto the power supply rail, The amplitude of the sine wave is measured at the output port and expressed as a ratio. 7. All performance measurements carried out with 20kHz AES17 low pass filter for distortion measurements, and an A-weighted filter for noise measurement. Failure to use such a filter will result in higher THD and lower SNR and Dynamic Range readings than are found in the Electrical Characteristics. The low pass filter removes out of band noise; although it is not audible it may affect dynamic specification values. COMMON TEST CONDITIONS Unless otherwise stated, the following test conditions apply throughout the following sections: DCVDD = 1.0V DBVDD = 1.8V AVDD = CPVDD =1.8V Ambient temperature = +25°C Audio signal: 1kHz sine wave, sampled at 48kHz with 24-bit data resolution SYSCLK_SRC = 0 (system clock comes direct from MCLK, not from FLL). Additional, specific test conditions are given within the relevant sections below. w PD, Rev 4.1, January 2012 10 WM8918 Production Data INPUT SIGNAL PATH PGA and Microphone Boost PARAMETER Minimum PGA gain setting TEST CONDITIONS MIN TYP L_MODE/R_MODE= 00b or 01b -1.55 L_MODE/R_MODE= 10b +12 L_MODE/R_MODE= 00b or 01b +28.28 L_MODE/R_MODE= 10b +30 Single-ended to differential conversion gain L_MODE/R_MODE= 00b +6 PGA gain accuracy L_MODE/R_MODE= 00b Maximum PGA gain setting MAX UNIT dB dB dB -1 +1 -1.5 +1.5 -1 +1 -1.5 +1.5 dB Gain -1.5 to +6.7dB L_MODE/R_MODE= 00b Gain +7.5 to +28.3dB L_MODE/R_MODE= 1X Gain +12 to +24dB L_MODE/R_MODE= 1X Gain +27 to +30dB Mute attenuation Equivalent input noise all modes of operation 100 dB L_MODE/R_MODE= 00b or 01b 30 µVrms 214 nV/√Hz OUTPUT SIGNAL PATH Stereo Playback to Headphones - DAC input to HPOUTL+HPOUTR pins with 15 load Test conditions: HPOUTL_VOL = HPOUTR_VOL = 111001b (0dB) PARAMETER Output Power (per Channel) SYMBOL Po TEST CONDITIONS MIN TYP MAX 1% THD 28 mW RLoad= 30 0.92 Vrms -0.76 dBV 1% THD 32 mW RLoad= 15 0.69 Vrms -3.19 DC Offset Signal to Noise Ratio Total Harmonic Distortion + Noise DC servo enabled, calibration complete. -1.5 SNR A-weighted 90 THD+N RL=30; Po=2mW -91 RL=30; Po=20mW -84 RL=15; Po=2mW -87 RL=15; Po=20mW -85 Channel Separation Channel Level Matching Power Supply Rejection Ratio w PSRR UNIT dBV +1.5 96 1kHz signal, 0dBFS 100 10kHz signal, 0dBFS 90 1kHz signal, 0dBFS +/-1 217Hz, 100mVpk-pk 75 1kHz, 100mV pk-pk 70 mV dB -80 dB dB dB dB PD, Rev 4.1, January 2012 11 WM8918 Production Data Stereo Playback to Line-out - DAC input to LINEOUTL+LINEOUTR pins with 10k / 50pF load Test conditions: LINEOUTL_VOL = LINEOUTR_VOL = 111001b (0dB) PARAMETER SYMBOL TEST CONDITIONS Full Scale Output Signal Level MIN DAC 0dBFS output at 0dB volume DC offset DC servo enabled. TYP MAX 1.0 UNIT Vrms 0 dBV 2.83 Vpk-pk -1.5 +1.5 mV Calibration complete. Signal to Noise Ratio SNR Total Harmonic Distortion + Noise A-weighted THD+N 96 10k load -85 1kHz signal, 0dBFS 100 10kHz signal, 0dBFS 90 Channel Separation Channel Level Matching Power Supply Rejection Ratio 90 PSRR 1kHz signal, 0dBFS +/-1 217Hz, 100mVpk-pk 62 1kHz, 100mV pk-pk 62 dB -70 dB dB dB dB Output PGAs (HP, LINE) PARAMETER TEST CONDITIONS MIN TYP MAX UNIT Minimum PGA gain setting -57 dB Maximum PGA gain setting 6 dB PGA Gain Step Size 1 dB PGA gain accuracy Mute attenuation +6dB to -40dB -1.5 +1.5 -40dB to -57dB -1 +1 dB HPOUTL/R 85 dB LINEOUTL/R 85 dB BYPASS PATH Differential Stereo Line Input to Stereo Line Output- IN1L-IN2L / IN1R-IN2R pins to LINEOUTL+LINEOUTR pins with 10k / 50pF load Test conditions: L_MODE = R_MODE = 01b (Differential Line) LIN_VOL = RIN_VOL = 00101b (0dB) LINEOUTL_VOL = LINEOUTR_VOL = 111001b (0dB) Total signal path gain = 0dB PARAMETER SYMBOL TEST CONDITIONS MIN Full Scale Output Signal Level Signal to Noise Ratio Total Harmonic Distortion + Noise SNR A-weighted THD+N -1dBV input Channel Level Matching w MAX 1.0 Channel Separation Power Supply Rejection Ratio TYP PSRR 90 UNIT Vrms 0 dBV 2.83 Vpk-pk 100 -92 dBV -85 dBV 1kHz signal, -1dBV 90 10kHz signal, -1dBV 80 1kHz signal, -1dBV +/-1 dB 217Hz, 100mV pk-pk 45 dB dB PD, Rev 4.1, January 2012 12 WM8918 Production Data CHARGE PUMP PARAMETER TEST CONDITIONS MIN Start-up Time TYP MAX CPCA CPCB UNIT s 260 Normal mode CPVDD V Low power mode CPVDD/2 V Normal mode -CPVDD V Low power mode -CPVDD/2 V External component requirements To achieve specified headphone output power and performance at 2V 1 2.2 F CPVOUTN Capacitor at 2V 2 2.2 F CPVOUTP Capacitor at 2V 2 2.2 F TYP Flyback Capacitor (between CPCA and CPCB) FLL PARAMETER Input Frequency SYMBOL TEST CONDITIONS MIN MAX UNIT FREF FLL_CLK_REF_DIV = 00 0.032 13.5 MHz FLL_CLK_REF_DIV = 01 0.064 27 MHz Lock time Free-running mode start-up time Free-running mode frequency accuracy 2 ms VMID enabled 100 s Reference supplied initially +/-10 % No reference provided +/-30 % OTHER PARAMETERS VMID Reference PARAMETER TEST CONDITIONS Midrail Reference Voltage MIN TYP MAX UNIT -3% AVDD/2 +3% V (VMIDC pin) Charge up time (from fully discharged to 10% below VMID) w External capacitor 4.7F 890 μs PD, Rev 4.1, January 2012 13 WM8918 Production Data Microphone Bias (for analogue electret condenser microphones) Additional test conditions: MICBIAS_ENA=1, all parameters measured at the MICBIAS pin PARAMETER SYMBOL TEST CONDITIONS MIN Bias Voltage. VMICBIAS Note: 7/6 and 9/10 are available only if MICVDD > AVDD. Note: 3/2 and 4/3 are available only if MICVDD ≥ 2.5V. TYP MAX UNIT -10% 3/2 x AVDD +10% V MICBIAS_SEL = 011 -10% 4/3 x AVDD +10% MICBIAS_SEL = 010 -10% 7/6 x AVDD +10% MICBIAS_SEL = 001 -10% 10/9 x AVDD +10% MICBIAS_SEL = 000 -10% 9/10 ×AVDD +10% MICVDD = 2.5V 3mA load current, MICBIAS_SEL = 1xx Drop out voltage between MICVDD and MICBIAS Maximum source current 200 IMICBIAS Noise spectral density Power Supply Rejection Ratio PSRR MICVDD to MICBIAS mV 4 mA At 1kHz 19 nV/√Hz 1kHz, 100mV pk-pk 67 MICVDD = 1.71 V 20kHz, 100mV pk-pk 76 MICVDD = 1.71 V 1kHz, 100mV pk-pk 88 MICVDD = 2.5 V 20kHz, 100mV pk-pk dB 84 MICVDD = 2.5 V 1kHz, 100mV pk-pk 61 MICVDD = 3.6 V 20kHz, 100mV pk-pk 70 MICVDD = 3.6 V Power Supply Rejection Ratio PSRR MICVDD and AVDD to MICBIAS 1kHz, 100mV pk-pk 54 dB AVDD = MICVDD = 1.8 V 20kHz, 100mV pk-pk 79 AVDD = MICVDD = 1.8 V MICBIAS Current Detect Function (See Note 1) Current Detect Threshold MICDET_THR = 00 80 A (Microphone insertion) Current Detect Threshold 60 (Microphone removal) Delay Time for Current Detect Interrupt tDET 3.2 ms MICBIAS Short Circuit (Hook Switch) Detect Function (See Note 1) Short Circuit Detect Threshold (Button press) MICSHORT_THR = 00 Short Circuit Detect Threshold (Button release) Minimum Delay Time for Short Circuit Detect Interrupt 600 A 400 tSHORT 47 ms Note: 1. If AVDD 1.8, current threshold values should be multiplied by (AVDD/1.8) w PD, Rev 4.1, January 2012 14 WM8918 Production Data Digital Inputs / Outputs PARAMETER Input HIGH Level SYMBOL TEST CONDITIONS MIN TYP MAX 0.7DBVDD VIH UNIT V (Digital Input) Input LOW Level 0.3DBVDD VIL V (Digital Input) Input HIGH Level 0.7AVDD VIH V (Analogue / Digital Input) Input LOW Level VIL 0.3AVDD V 0.1DBVDD V (Analogue / Digital Input) Output HIGH Level VOH IOH = +1mA Output LOW Level VOL IOL = -1mA w 0.9DBVDD V PD, Rev 4.1, January 2012 15 WM8918 Production Data POWER CONSUMPTION The WM8918 power consumption is dependent on many parameters. Most significantly, it depends on supply voltages, sample rates, mode of operation, and output loading. The power consumption on each supply rail varies approximately with the square of the voltage. Power consumption is greater at fast sample rates than at slower ones. When the digital audio interface is operating in Master mode, the DBVDD current is significantly greater than in Slave mode. (Note also that power savings can be made by using MCLK as the BCLK source in Slave mode.) The output load conditions (impedance, capacitance and inductance) can also impact significantly on the device power consumption. COMMON TEST CONDITIONS Unless otherwise stated, the following test conditions apply throughout the following sections: Ambient temperature = +25°C Audio signal = quiescent (zero amplitude) Sample rate = 48kHz MCLK = 12.288MHz Audio interface mode = Slave (LRCLK_DIR=0, BCLK_DIR=0) SYSCLK_SRC = 0 (system clock comes direct from MCLK, not from FLL) Additional, variant test conditions are quoted within the relevant sections below. Where applicable, power dissipated in the headphone or line loads is included. POWER CONSUMPTION MEASUREMENTS Stereo Playback to Headphones - DAC input to HPOUTL+HPOUTR pins with 30Ω load. Test conditions: VMID_RES = 01 (for normal operation) CP_DYN_PWR = 1 (Class-W, Charge pump controlled by real-time audio level) Variant test conditions AVDD DCVDD DBVDD CPVDD MICVDD TOTAL V mA V mA V mA V mA V mA mW 48kHz sample rate 1.80 1.69 1.00 0.76 1.80 0.00 1.80 0.31 2.50 0.01 4.38 8kHz sample rate 1.80 1.69 1.00 0.18 1.80 0.00 1.80 0.31 2.50 0.01 3.80 48kHz, Po = 0.1mW/channel 1kHz sine wave 0dBFS 1.80 1.71 1.00 0.77 1.80 0.00 1.80 1.99 2.50 0.01 7.45 1.80 1.73 1.00 0.77 1.80 0.00 1.80 5.61 2.50 0.01 13.99 1.80 1.82 1.00 1.05 1.80 0.73 1.80 0.30 2.50 0.01 6.18 1.80 1.83 1.00 0.94 1.80 0.76 1.80 0.29 2.50 0.01 6.14 HPOUT_VOL= -25dB DAC_VOL= 0dB 48kHz, Po = 1mW/channel 1kHz sine wave 0dBFS HPOUT_VOL= -15dB DAC_VOL= 0dB 48kHz sample rate, Master mode, FLL enabled, MCLK input frequency = 13MHz 48kHz sample rate, Master mode, FLL enabled, MCLK input frequency = 32.768kHz w PD, Rev 4.1, January 2012 16 WM8918 Production Data Stereo Playback to Line-out - DAC input to LINEOUTL+LINEOUTR or HPOUTL+HPOUTR pins with 10kΩ / 50pF load Test conditions: VMID_RES = 01 (for normal operation) CP_DYN_PWR = 1 (Class-W, Charge pump controlled by real-time audio level) Variant test conditions AVDD DCVDD DBVDD CPVDD MICVDD TOTAL V mA V mA V mA V mA V mA mW 48kHz sample rate 1.8 1.67 1 0.76 1.8 0.00 1.8 0.36 2.5 0.01 4.43 8kHz sample rate 1.8 1.67 1 0.18 1.8 0.00 1.8 0.36 2.5 0.01 3.86 48kHz, Po = 0dBFS 1kHz sine wave 1.8 1.78 1 0.77 1.8 0.00 1.8 2.27 2.5 0.01 8.09 Stereo analogue bypass to headphones - IN1L/R or IN2L/R pins to HPOUTL+HPOUTR pins with 30Ω load. Test conditions: LIN_VOL = RIN_VOL = 00101 = +0.0 dB MCLK = 11.2896MHz Digital audio interface disabled Note that the Analogue bypass configuration does not benefit from the Class W dynamic control. Variant test conditions AVDD DCVDD DBVDD CPVDD MICVDD TOTAL V mA V mA V mA V mA V mA mW Quiescent HPOUTVOL = 000000 (-57dB) 1.8 1.24 1 0.11 1.8 0.00 1.8 0.26 2.5 0.01 2.82 Po = 0.1mW/channel 1kHz sine wave HPOUTVOL = 100000 (-25dB) 1.8 1.29 1 0.11 1.8 0.00 1.8 2.05 2.5 0.01 6.13 Po = 1mW/channel 1kHz sine wave HPOUTVOL = 101010 (-15dB) 1.8 1.30 1 0.11 1.8 0.00 1.8 5.86 2.5 0.01 13.02 Stereo analogue bypass to Line-out - IN1L/R or IN2L/R pins to LINEOUTL+LINEOUTR pins with 30Ω load. Test conditions: LIN_VOL = RIN_VOL = 00101 = +0.0 dB MCLK = 11.2896MHz Digital audio interface disabled Note that the Analogue bypass configuration does not benefit from the Class W dynamic control. Variant test conditions AVDD DCVDD DBVDD CPVDD MICVDD TOTAL V mA V mA V mA V mA V mA mW 1.8 1.04 1.0 0.15 1.8 0.00 1.8 0.21 1.8 0.01 2.41 1.8 1.04 1.0 0.15 1.8 0.00 1.8 0.63 1.8 0.01 3.18 1.8 1.04 1.0 0.15 1.8 0.00 1.8 1.25 1.8 0.01 4.28 Quiescent LINEOUTVOL = 000000 (-57dB) Quiescent LINEOUTVOL = 101011 (-14dB) Quiescent LINEOUTVOL = 111001 (0dB) Off Note: DC servo calibration is retained in this state as long as DCVDD is supplied. This allows fast, pop suppressed start-up from the off state. Variant test conditions Off (default settings) AVDD DCVDD DBVDD CPVDD MICVDD TOTAL V mA V mA V mA V mA V mA mW 1.8 0.01 1 0.00 1.8 0.00 1.8 0.01 2.5 0.01 0.04 1.8 0.01 1 0.02 1.8 0.00 1.8 0.01 2.5 0.01 0.06 No Clocks applied Off (default settings) AIFRXDAT, MCLK, BCLK, and LRCLK applied w PD, Rev 4.1, January 2012 17 WM8918 Production Data SIGNAL TIMING REQUIREMENTS COMMON TEST CONDITIONS Unless otherwise stated, the following test conditions apply throughout the following sections: Ambient temperature = +25°C DCVDD = 1.0V DBVDD = AVDD = CPVDD = 1.8V DGND = AGND = CPGND = 0V Additional, specific test conditions are given within the relevant sections below. MASTER CLOCK Figure 1 Master Clock Timing Master Clock Timing PARAMETER SYMBOL MCLK cycle time TMCLKY MCLK duty cycle TMCLKDS w TEST CONDITIONS MIN MCLK_DIV=1 40 MCLK_DIV=0 80 60:40 TYP MAX UNIT ns ns 40:60 PD, Rev 4.1, January 2012 18 WM8918 Production Data AUDIO INTERFACE TIMING MASTER MODE Figure 2 Audio Interface Timing – Master Mode Test Conditions o DCVDD = 1.0V, AVDD = DBVDD = CPVDD = 1.8V, DGND=AGND=CPGND =0V, TA = +25 C, Master Mode, fs=48kHz, MCLK=256fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN TYP MAX UNIT ns Audio Interface Timing - Master Mode LRCLK propagation delay from BCLK falling edge tDL 20 AIFTXDAT propagation delay from BCLK falling edge tDDA 20 AIFRXDAT setup time to BCLK rising edge tDST 20 ns AIFRXDAT hold time from BCLK rising edge tDHT 10 ns w ns PD, Rev 4.1, January 2012 19 WM8918 Production Data SLAVE MODE tBCY BCLK (input) tBCH tBCL LRCLK (input) AIFTXDAT (output) tLRH tLRSU tDD AIFRXDAT (input) tDS tDH Figure 3 Audio Interface Timing – Slave Mode Test Conditions o DCVDD = 1.0V, AVDD = DBVDD = CPVDD = 1.8V, DGND=AGND=CPGND =0V, TA = +25 C, Slave Mode, fs=48kHz, MCLK=256fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN TYP MAX UNIT Audio Interface Timing - Slave Mode BCLK cycle time tBCY 50 ns BCLK pulse width high tBCH 20 ns BCLK pulse width low tBCL 20 ns LRCLK set-up time to BCLK rising edge tLRSU 20 ns LRCLK hold time from BCLK rising edge tLRH 10 ns AIFRXDAT hold time from BCLK rising edge tDH 10 AIFTXDAT propagation delay from BCLK falling edge tDD AIFRXDAT set-up time to BCLK rising edge tDS ns 20 20 ns ns Note: BCLK period must always be greater than or equal to MCLK period. w PD, Rev 4.1, January 2012 20 WM8918 Production Data TDM MODE In TDM mode, it is important that two devices do not attempt to drive the AIFTXDAT pin simultaneously. The timing of the WM8918 AIFTXDAT tri-stating at the start and end of the data transmission is described below. BCLK AIFTXDAT AIFTXDAT undriven (tri-state) AIFTXDAT valid (DMIC output) AIFTXDAT set-up time AIFTXDAT valid AIFTXDAT undriven (tri-state) AIFTXDAT release time Figure 4 Audio Interface Timing - TDM Mode Test Conditions o AVDD = CPVDD = 1.8V , DGND=AGND=CPGND= =0V, TA = +25 C, Master Mode, fs=48kHz, MCLK=256fs, 24-bit data, unless otherwise stated. PARAMETER CONDITIONS MIN TYP MAX UNIT Audio Data Timing Information AIFTXDAT setup time from BCLK falling edge AIFTXDAT release time from BCLK falling edge w DCVDD =2.0V DBVDD = 3.6V 5 ns DCVDD = 1.08V DBVDD = 1.62V 15 ns DCVDD = 2.0V DBVDD = 3.6V 5 ns DCVDD = 1.08V DBVDD = 1.62V 15 ns PD, Rev 4.1, January 2012 21 WM8918 Production Data CONTROL INTERFACE TIMING Figure 5 Control Interface Timing Test Conditions o DCVDD = 1.0V, AVDD = DBVDD = CPVDD = 1.8V, DGND=AGND=CPGND =0V, TA=+25 C, Slave Mode, fs=48kHz, MCLK = 256fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN SCLK Frequency TYP MAX UNIT 400 kHz SCLK Low Pulse-Width t1 1300 ns SCLK High Pulse-Width t2 600 ns Hold Time (Start Condition) t3 600 ns Setup Time (Start Condition) t4 600 ns Data Setup Time t5 100 SDA, SCLK Rise Time t6 SDA, SCLK Fall Time t7 Setup Time (Stop Condition) t8 Data Hold Time t9 Pulse width of spikes that will be suppressed tps w ns 300 ns 300 ns 900 ns 5 ns 600 0 ns PD, Rev 4.1, January 2012 22 WM8918 Production Data DIGITAL FILTER CHARACTERISTICS PARAMETER TEST CONDITIONS MIN +/- 0.05dB 0 TYP MAX UNIT Digital Microphone (DMIC) Filter Passband -6dB 0.454 fs 0.5 fs Passband Ripple +/- 0.05 Stopband dB 0.546 fs Stopband Attenuation f > 0.546 fs -60 +/- 0.05dB 0 dB DAC Normal Filter Passband -6dB Passband Ripple 0.454 fs 0.5 fs 0.454 fs +/- 0.03 Stopband dB 0.546 fs Stopband Attenuation f > 0.546 fs -50 dB DAC Sloping Stopband Filter Passband +/- 0.03dB 0 0.25 fs +/- 1dB 0.25 fs 0.454 fs -6dB Passband Ripple 0.5 fs 0.25 fs +/- 0.03 Stopband 1 0.546 fs Stopband 1 Attenuation f > 0.546 fs Stopband 2 -60 dB 0.7 fs Stopband 2 Attenuation f > 0.7 fs Stopband 3 dB 0.7 fs 1.4 fs -85 dB 1.4 fs Stopband 3 Attenuation F > 1.4 fs DAC FILTERS -55 dB DMIC FILTERS Mode Group Delay Mode Group Delay Normal 16.5 / fs Normal 16.5 / fs Sloping Stopband 18 / fs TERMINOLOGY 1. Stop Band Attenuation (dB) – the degree to which the frequency spectrum is attenuated (outside audio band) 2. Pass-band Ripple – any variation of the frequency response in the pass-band region w PD, Rev 4.1, January 2012 23 WM8918 Production Data DMIC FILTER RESPONSES Figure 6 DMIC Digital Filter Frequency Response Figure 7 DMIC Digital Filter Ripple DMIC HIGH PASS FILTER RESPONSES 2.1246m -2.3338m -1.1717 -8.3373 -2.3455 -16.672 -3.5193 -25.007 -4.6931 -33.342 -5.8669 -41.677 -7.0407 -50.012 -8.2145 -58.347 -9.3883 -66.682 -10.562 -75.017 -11.736 1 2.6923 7.2484 19.515 52.54 141.45 380.83 1.0253k 2.7605k 7.432k 20.009k -83.352 2 5.0248 12.624 31.716 79.683 200.19 502.96 1.2636k 3.1747k 7.9761k 20.039k MAGNITUDE(dB) hpf_response.res MAGNITUDE(dB) hpf_response2.res MAGNITUDE(dB) hpf_response2.res#1 MAGNITUDE(dB) Figure 8 DMIC Digital High Pass Filter Frequency Response (48kHz, Hi-Fi Mode, DMIC_HPF_CUT[1:0]=00) w Figure 9 DMIC Digital High Pass Filter Ripple (48kHz, Voice Mode, DMIC_HPF_CUT=01, 10 and 11) PD, Rev 4.1, January 2012 24 WM8918 Production Data DAC FILTER RESPONSES MAGNITUDE(dB) 0.04 0.035 0.03 0.025 0.02 0.015 0.01 0.005 0 -0.005 0 0.05 0.1 0.15 0.2 0.25 0.3 0.35 0.4 0.45 0.5 Frequency (fs) Figure 10 DAC Digital Filter Frequency Response; (Normal Mode); Sample Rate > 24kHz Figure 11 DAC Digital Filter Ripple (Normal Mode) MAGNITUDE(dB) 0.05 0 -0.05 0 0.05 0.1 0.15 0.2 0.25 0.3 0.35 0.4 0.45 0.5 -0.1 -0.15 -0.2 -0.25 -0.3 -0.35 -0.4 -0.45 -0.5 Frequency (fs) Figure 12 DAC Digital Filter Frequency Response; (Sloping Stopband Mode); Sample Rate <= 24kHz w Figure 13 DAC Digital Filter Ripple (Sloping Stopband Mode) PD, Rev 4.1, January 2012 25 WM8918 Production Data DE-EMPHASIS FILTER RESPONSES MAGNITUDE(dB) MAGNITUDE(dB) 0.3 0 -1 0 5000 10000 15000 20000 -2 0.25 0.2 -3 0.15 -4 0.1 -5 0.05 -6 0 -7 -0.05 -8 -9 -0.1 -10 -0.15 0 2000 4000 6000 Frequency (Hz) 10000 12000 14000 16000 18000 Frequency (Hz) Figure 14 De-Emphasis Digital Filter Response (32kHz) Figure 15 De-Emphasis Error (32kHz) MAGNITUDE(dB) MAGNITUDE(dB) 0 -1 8000 0.2 0 5000 10000 15000 20000 25000 0.15 -2 -3 0.1 -4 0.05 -5 -6 0 -7 0 -8 5000 10000 15000 20000 25000 -0.05 -9 -0.1 -10 Frequency (Hz) Frequency (Hz) Figure 16 De-Emphasis Digital Filter Response (44.1kHz) Figure 17 De-Emphasis Error (44.1kHz) MAGNITUDE(dB) MAGNITUDE(dB) 0.15 0 0 5000 10000 15000 20000 25000 30000 -2 0.1 -4 0.05 -6 0 -8 -0.05 -10 -0.1 0 5000 10000 15000 20000 25000 30000 -0.15 -12 Frequency (Hz) Figure 18 De-Emphasis Digital Filter Response (48kHz) w Frequency (Hz) Figure 19 De-Emphasis Error (48kHz) PD, Rev 4.1, January 2012 26 WM8918 Production Data DEVICE DESCRIPTION INTRODUCTION The WM8918 is a high performance ultra-low power stereo CODEC optimised for portable audio applications. Flexible analogue interfaces and powerful digital signal processing (DSP) make it ideal for small portable devices. The WM8918 supports up to 4 analogue audio inputs. One pair of single-ended or differential microphone/line inputs is selected as the analogue input source. An integrated bias reference is provided to power standard electret microphones. The analogue inputs can be mixed into the headphone or line output signal paths. A two-channel digital microphone interface is also supported, with direct input to the DSP core. The digital microphone can be routed to the digital audio interface output and/or mixed into the DAC output signal path. One pair of ground-reference Class-W headphone outputs is provided; these are powered from an integrated Charge Pump, enabling high quality, power efficient headphone playback without any requirement for DC blocking capacitors. A DC Servo circuit is available for DC offset correction, thereby suppressing pops and reducing power consumption. Two line outputs are provided; these are also capable of driving ear speakers and stereo headsets. Ground loop feedback is available on the headphone outputs and the line outputs, providing rejection of noise on the ground connections. All outputs use Wolfson SilentSwitch™ technology for pop and click suppression. The stereo DACs are of hi-fi quality, using a 24-bit low-order oversampling architecture to deliver optimum performance. A flexible clocking arrangement supports many common audio sample rates, whilst an integrated ultra-low power FLL provides additional flexibility. A high pass filter is available in the digital microphone path for suppressing low frequency noise such as mechanical vibration and wind noise. A digital mixing path provides a digital microphone sidetone of enhanced quality during voice calls. DAC soft mute and un-mute is available for pop-free music playback. TM The integrated Dynamic Range Controller (DRC) and ReTune Mobile 5-band parametric equaliser (EQ) provide further processing capability of the digital audio paths. The DRC provides compression and signal level control to improve the handling of unpredictable signal levels. ‘Anti-clip’ and ‘quick release’ algorithms improve intelligibility in the presence of transients and impulsive noises. The EQ provides the capability to tailor the audio path according to the frequency characteristics of an earpiece or loudspeaker, and/or according to user preferences. The WM8918 has a highly flexible digital audio interface, supporting a number of protocols, including I2S, DSP, MSB-first left/right justified, and can operate in master or slave modes. PCM operation is supported in the DSP mode. A-law and -law companding are also supported. Time division multiplexing (TDM) is available to allow multiple devices to stream data simultaneously on the same bus, saving space and power. The system clock SYSCLK provides clocking for the DACs, DSP core, digital audio interface and other circuits. SYSCLK can be derived directly from the MCLK pin or via an integrated FLL, providing flexibility to support a wide range of clocking schemes. Typical portable system MCLK frequencies, and sample rates from 8kHz to 96kHz are all supported. The clocking circuits are configured automatically from the sample rate (fs) and from the SYSCLK / fs ratio. The integrated FLL can be used to generate SYSCLK from a wide variety of different reference sources and frequencies. The FLL can accept a wide range of reference frequencies, which may be high frequency (e.g. 13MHz) or low frequency (eg. 32.768kHz). The FLL is tolerant of jitter and may be used to generate a stable SYSCLK from a less stable input signal. The integrated FLL can be used as a free-running oscillator, enabling autonomous clocking of the Charge Pump and DC Servo if required. The WM8918 uses a standard 2-wire control interface, providing full software control of all features, together with device register readback. An integrated Control Write Sequencer enables automatic scheduling of control sequences; commonly-used signal configurations may be selected using readyprogrammed sequences, including time-optimised control of the WM8918 pop suppression features. It is an ideal partner for a wide range of industry standard microprocessors, controllers and DSPs. Unused circuitry can be disabled under software control, in order to save power; low leakage currents enable extended standby/off time in portable battery-powered applications. w PD, Rev 4.1, January 2012 27 WM8918 Production Data Up to 2 GPIO pins may be configured for miscellaneous input/output functions such as button/accessory detect inputs, or for clock, system status, or programmable logic level output for control of additional external circuitry. Interrupt logic, status readback and de-bouncing options are supported within this functionality. ANALOGUE INPUT SIGNAL PATH The WM8918 has four analogue input pins, which may be used to support connections to multiple microphone or line input sources. The input multiplexer on the Left and Right channels can be used to select different configurations for each of the input sources. The analogue input paths can support line and microphone inputs, in single-ended and differential modes. The input stage can also provide common mode noise rejection in some configurations. Two of the analogue input pins have dual functionality and can be used as digital microphone inputs. (See the “Digital Microphone Interface” section for details.) The Left and Right analogue input channels are routed to the output multiplexers and PGAs. The WM8918 input signal paths and control registers are illustrated in Figure 20. Figure 20 Block Diagram for Input Signal Path w PD, Rev 4.1, January 2012 28 WM8918 Production Data INPUT PGA ENABLE The input PGAs (Programmable Gain Amplifiers) and Multiplexers are enabled using register bits INL_ENA and INR_ENA, as shown in Table 1. REGISTER ADDRESS R12 (0Ch) Power Management 0 BIT 1 LABEL INL_ENA DEFAULT 0 DESCRIPTION Left Input PGA Enable 0 = disabled 1 = enabled 0 INR_ENA 0 Right Input PGA Enable 0 = disabled 1 = enabled Table 1 Input PGA Enable To enable the input PGAs, the reference voltage VMID and the bias current must also be enabled. See Reference Voltages and Master Bias for details of the associated controls VMID_RES and BIAS_ENA. INPUT PGA CONFIGURATION The analogue input channels can each be configured in three different modes, which are as follows: Single-Ended Mode (Inverting) Differential Line Mode Differential Mic Mode The mode is selected by the L_MODE and R_MODE fields for the Left and Right channels respectively. The input pins are selected using the L_IP_SEL_N and L_IP_SEL_P fields for the Left channel and the R_IP_SEL_N and R_IP_SEL_P for the Right channel. In Single-Ended mode, L_IP_SEL_N alone determines the Left Input pin, and the R_IP_SEL_N determines the Right Input pin. The three modes are illustrated in Figure 21, Figure 22 and Figure 23. It should be noted that the available gain and input impedance varies between configurations (see also “Electrical Characteristics”). The input impedance is constant with PGA gain setting. The Input PGA modes are selected and configured using the register fields described in Table 2 below. w PD, Rev 4.1, January 2012 29 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT DESCRIPTION R46 (2Eh) 5:4 L_IP_SEL_N [1:0] 00 In Single-Ended or Differential Line Modes, this field selects the input pin for the inverting side of the left input path. Analogue Left Input 1 In Differential Mic Mode, this field selects the input pin for the noninverting side of the left input path. 00 = IN1L 01 = IN2L 1X = Reserved 3:2 L_IP_SEL_P [1:0] 01 In Single-Ended or Differential Line Modes, this field selects the input pin for the non-inverting side of the left input path. In Differential Mic Mode, this field selects the input pin for the inverting side of the left input path. 00 = IN1L 01 = IN2L 1X = Reserved 1:0 L_MODE [1:0] 00 Sets the mode for the left analogue input: 00 = Single-Ended 01 = Differential Line 10 = Differential MIC 11 = Reserved R47 (2Fh) Analogue Right Input 1 5:4 R_IP_SEL_N [1:0] 00 In Single-Ended or Differential Line Modes, this field selects the input pin for the inverting side of the right input path. In Differential Mic Mode, this field selects the input pin for the noninverting side of the right input path. 00 = IN1R 01 = IN2R 1X = Reserved 3:2 R_IP_SEL_P [1:0] 01 In Single-Ended or Differential Line Modes, this field selects the input pin for the non-inverting side of the right input path. In Differential Mic Mode, this field selects the input pin for the inverting side of the right input path. 00 = IN1R 01 = IN2R 1X = Reserved 1:0 R_MODE [1:0] 00 Sets the mode for the right analogue input: 00 = Single-Ended 01 = Differential Line 10 = Differential MIC 11 = Reserved Table 2 Input PGA Mode Selection w PD, Rev 4.1, January 2012 30 WM8918 Production Data SINGLE-ENDED INPUT The Single-Ended PGA configuration is illustrated in Figure 21 for the Left channel. The available gain in this mode is from -1.57dB to +28.5dB in non-linear steps. The PGA output is phase inverted with respect to the selected input pin. Different input pins can be selected in the same mode by altering the L_IP_SEL_N field. The equivalent configuration is also available on the Right channel; this can be selected independently of the Left channel mode. Figure 21 Single Ended Mode DIFFERENTIAL LINE INPUT The Differential Line PGA configuration is illustrated in Figure 22 for the Left channel. The available gain in this mode is from -1.57dB to +28.5dB in non-linear steps. The PGA output is in phase with the input pin selected by L_IP_SEL_P. The PGA output is phase inverted with respect to the input pin selected by L_IP_SEL_N. As an option, common mode noise rejection can be provided in this PGA configuration, as illustrated in Figure 22. This is enabled using the register bits defined in Table 5. The equivalent configuration is also available on the Right channel; this can be selected independently of the Left channel mode. -1.57dB to +28.5dB, non-linear steps IN1L/DMICDAT1 IN2L M U X + L_IP_SEL_N M U X + BYPASSL INL_ENA LIN_MUTE LIN_VOL INL_CM_ENA L_IP_SEL_P Differential Line Mode (L_MODE = 01) Figure 22 Differential Line Mode w PD, Rev 4.1, January 2012 31 WM8918 Production Data DIFFERENTIAL MICROPHONE INPUT The Differential Mic PGA configuration is illustrated in Figure 23 for the Left channel. The available gain in this mode is from +12dB to +30dB in 3dB linear steps. The PGA output is in phase with the input pin selected by L_IP_SEL_N. The PGA output is phase inverted with respect to the input pin selected by L_IP_SEL_P. Note that the inverting input pin is selected using L_IP_SEL_P and the non-inverting input pin is selected using L_IP_SEL_N. This is not the same as for the Differential Line mode. The equivalent configuration is also available on the Right channel; this can be selected independently of the Left channel mode. +12dB to +30dB, 3dB steps IN1L/DMICDAT1 M U X IN2L + INL_ENA LIN_MUTE LIN_VOL L_IP_SEL_N BYPASSL - +12dB to +30dB, 3dB steps M U X INL_ENA LIN_MUTE LIN_VOL L_IP_SEL_P Differential Microphone Mode (L_MODE = 10) Figure 23 Differential Microphone Mode INPUT PGA GAIN CONTROL The volume control gain for the Left and Right channels be independently controlled using the LIN_VOL and RIN_VOL register fields as described in Table 3. The available gain range varies according to the selected PGA Mode as detailed in Table 4. Note that the value ‘00000’ must not be used in Differential Mic Mode, as the PGA will not function correctly under this setting. In singleended mode (L_MODE / R_MODE = 00b), the conversion from single-ended to differential within the WM8918 adds a further 6dB of gain to the signal path. Each input channel can be independently muted using LINMUTE and RINMUTE. It is recommended to not adjust the gain dynamically whilst the signal path is enabled; the signal should be muted at the input or output stage prior to adjusting the volume control. REGISTER ADDRESS R44 (2Ch) BIT LABEL DEFAULT 7 LINMUTE 1 Analogue Left Input 0 DESCRIPTION Left Input PGA Mute 0 = not muted 1 = muted 4:0 LIN_VOL [4:0] 00101 Left Input PGA Volume 7 RINMUTE 1 Right Input PGA Mute (See Table 4 for volume range) R45 (2Dh) 0 = not muted Analogue Right Input 0 1 = muted 4:0 RIN_VOL [4:0] 00101 Right Input PGA Volume (See Table 4 for volume range) Table 3 Input PGA Volume Control w PD, Rev 4.1, January 2012 32 WM8918 Production Data LIN_VOL [4:0], RIN_VOL [4:0] GAIN – GAIN – SINGLE-ENDED MODE / DIFFERENTIAL MIC MODE DIFFERENTIAL LINE MODE 00000 -1.5 dB Not valid 00001 -1.3 dB +12 dB 00010 -1.0 dB +15 dB 00011 -0.7 dB +18 dB 00100 -0.3 dB +21 dB 00101 0.0 dB +24 dB 00110 +0.3 dB +27 dB 00111 +0.7 dB +30 dB 01000 +1.0 dB +30 dB 01001 +1.4 dB +30 dB 01010 +1.8 dB +30 dB 01011 +2.3 dB +30 dB 01100 +2.7 dB +30 dB 01101 +3.2 dB +30 dB 01110 +3.7 dB +30 dB 01111 +4.2 dB +30 dB 10000 +4.8 dB +30 dB 10001 +5.4 dB +30 dB 10010 +6.0 dB +30 dB 10011 +6.7 dB +30 dB 10100 +7.5 dB +30 dB 10101 +8.3 dB +30 dB 10110 +9.2 dB +30 dB 10111 +10.2 dB +30 dB 11000 +11.4 dB +30 dB 11001 +12.7 dB +30 dB 11010 +14.3 dB +30 dB 11011 +16.2 dB +30 dB 11100 +19.2 dB +30 dB 11101 +22.3 dB +30 dB 11110 +25.2 dB +30 dB 11111 +28.3 dB +30 dB Table 4 Input PGA Volume Range w PD, Rev 4.1, January 2012 33 WM8918 Production Data INPUT PGA COMMON MODE AMPLIFIER In Differential Line Mode only, a Common Mode amplifier can be enabled as part of the input PGA circuit. This feature provides approximately 20dB reduction in common mode noise on the differential input, which can reduce problematic interference. Since the internal signal paths use a differential configuration, they have an inherent immunity to common mode noise (see “Electrical Characteristics”). However, the presence of Common Mode noise can limit the usable signal range of the analogue input path; enabling the Common Mode amplifier can solve this issue. It should be noted that the Common Mode amplifier consumes additional power and can also add its own noise to the input signal. For these reasons, it is recommended that the Common Mode Amplifier is only enabled if there is a known source of Common Mode interference. The Common Mode amplifier is controlled by the INL_CM_ENA and INR_CM_ENA fields as described in Table 5. Although the Common Mode amplifier may be enabled regardless of the input PGA mode, its function is only effective in the Differential Line Mode configuration. REGISTER ADDRESS R46 (2Eh) BIT LABEL DEFAULT 6 INL_CM_ENA 1 Analogue Left Input 1 DESCRIPTION Left Input PGA Common Mode Rejection enable 0 = Disabled 1 = Enabled (only available for L_MODE=01 – Differential Line) R47 (2Fh) 6 INR_CM_ENA Analogue Right Input 1 1 Right Input PGA Common Mode Rejection enable 0 = Disabled 1 = Enabled (only available for R_MODE=01 – Differential Line) Table 5 Common Mode Amplifier Enable w PD, Rev 4.1, January 2012 34 WM8918 Production Data ELECTRET CONDENSER MICROPHONE INTERFACE Electret Condenser microphones may be connected as single-ended or differential inputs to the Input PGAs described in the “Analogue Input Signal Path” section. The WM8918 provides a low-noise reference voltage (MICBIAS) suitable for biasing electret condenser microphones. MICBIAS CONTROL The MICBIAS reference is provided on the MICBIAS pin. This reference voltage is enabled by setting the MICBIAS_ENA register bit. The MICBIAS output voltage is selected using the MICBIAS_SEL register. This register selects the output voltage as a ratio of AVDD; the actual output voltage scales with AVDD. The MICBIAS output is powered from the MICVDD supply pin, and uses VMID (ie. AVDD/2) as a reference, as illustrated in Figure 24. In all cases, MICVDD must be at least 200mV greater than the required MICBIAS output voltage. Under the default setting of MICBIAS_SEL, the MICVDD supply may be connected directly to AVDD. For other settings of MICBIAS_SEL, (ie. for higher MICBIAS voltages), the MICVDD supply must be greater than AVDD. The MICBIAS generator is illustrated in in Figure 24. The associated control registers are defined in Table 6. MICVDD VMIDC MICBIAS MICBIAS_ENA MICBIAS_SEL[2:0] AGND Figure 24 MICBIAS Generator REGISTER ADDRESS R6 (06h) BIT LABEL DEFAULT 0 MICBIAS_ENA 0 Mic Bias Control 0 R7 (07h) Mic Bias Control 1 DESCRIPTION MICBIAS Enable 0 = disabled 1 = enabled 2:0 MICBIAS_SEL [2:0] 000 Selects MICBIAS voltage 000 = 9/10 x AVDD (1.6V) 001 = 10/9 x AVDD (2.0V) 010 = 7/6 x AVDD (2.1V) 011 = 4/3 x AVDD (2.4V) 100 to 111 = 3/2 x AVDD (2.7V) Note that the voltage scales with AVDD. The value quoted in brackets is correct for AVDD=1.8V. Table 6 MICBIAS Control w PD, Rev 4.1, January 2012 35 WM8918 Production Data MICBIAS CURRENT DETECT A MICBIAS Current Detect function is provided for external accessory detection. This is provided in order to detect the insertion/removal of a microphone or the pressing/releasing of the microphone ‘hook’ switch; these events will cause a significant change in MICBIAS current flow, which can be detected and used to generate a signal to the host processor. The MICBIAS current detect function is enabled by setting the MICDET_ENA register bit. When this function is enabled, two current thresholds can be defined, using the MICDET_THR and MICSHORT_THR registers. When a change in MICBIAS current which crosses either threshold is detected, then an interrupt event can be generated. In a typical application, accessory insertion would be detected when the MICBIAS current exceeds MICDET_THR, and microphone hookswitch operation would be detected when the MICBIAS current exceeds MICSHORT_THR. The current detect threshold functions are both inputs to the Interrupt control circuit and can be used to trigger an Interrupt event when either threshold is crossed. Both events can also be indicated as an output on a GPIO pin - see “General Purpose Input/Output (GPIO)”. The current detect thresholds are enabled and controlled using the registers described in Table 7. Performance parameters for this circuit block can be found in the “Electrical Characteristics” section. Hysteresis and filtering is also provided in the both current detect circuits to improve reliability in conditions where AC current spikes are present due to ambient noise conditions. These features are described in the following section. Further guidance on the usage of the MICBIAS current monitoring features is also described in the following pages. REGISTER ADDRESS BIT LABEL DEFAULT DESCRIPTION R6 (06h) 6:4 MICDET_THR [2:0] 000 MICBIAS Current Detect Threshold (AVDD = 1.8V) Mic Bias Control 0 000 = 0.070mA 001 = 0.260mA 010 = 0.450mA 011 = 0.640mA 100 = 0.830mA 101 = 1.020mA 110 = 1.210mA 111 = 1.400mA Note that the value scales with AVDD. The value quoted is correct for AVDD=1.8V. 3:2 MICSHORT_THR [1:0] 00 MICBIAS Short Circuit Threshold (AVDD = 1.8V) 00 = 0.520mA 01 = 0.880mA 10 = 1.240mA 11 = 1.600mA Note that the value scales with AVDD. The value quoted is correct for AVDD=1.8V. 1 MICDET_ENA 0 MICBIAS Current and Short Circuit Detect Enable 0 = disabled 1 = enabled Table 7 MICBIAS Current Detect w PD, Rev 4.1, January 2012 36 WM8918 Production Data MICBIAS CURRENT DETECT FILTERING The function of the filtering is to ensure that AC current spikes caused by ambient noise conditions near the microphone do not lead to incorrect signalling of the microphone insertion/removal status or the microphone hookswitch status. Hysteresis on the current thresholds is provided; this means that a different current threshold is used to detect microphone insertion and microphone removal. Similarly, a different current threshold is used to detect hookswitch press and hookswtich release. Digital filtering of the hookswitch status ensures that the MICBIAS Short Circuit detection event is only signalled if the MICSHORT_THR threshold condition has been met for 10 consecutive measurements. In a typical application, microphone insertion would be detected when the MICBIAS current exceeds the Current Detect threshold set by MICDET_THR. When the MIC_DET_EINT_POL interrupt polarity bit is set to 0, then microphone insertion detection will cause the MIC_DET_EINT interrupt status register to be set. For detection of microphone removal, the MIC_DET_EINT_POL bit should be set to 1. When the MIC_DET_EINT_POL interrupt polarity bit is set to 1, then microphone removal detection will cause the MIC_DET_EINT interrupt status register to be set. The detection of these events is bandwidth limited for best noise rejection, and is subject to detection delay time tDET, as specified in the “Electrical Characteristics”. Provided that the MICDET_THR field has been set appropriately, each insertion or removal event is guaranteed to be detected within the delay time tDET. It is likely that the microphone socket contacts will have mechanical “bounce” when a microphone is inserted or removed, and hence the resultant control signal will not be a clean logic level transition. Since tDET has a range of values, it is possible that the interrupt will be generated before the mechanical “bounce” has ceased. Hence after a mic insertion or removal has been detected, a time delay should be applied before re-configuring the MIC_DET_EINT_POL bit. The maximum possible mechanical bounce times for mic insertion and removal must be understood by the software programmer. Utilising a GPIO pin to monitor the steady state of the microphone detection function does not change the timing of the detection mechanism, so there will also be a delay tDET before the signal changes state. It may be desirable to implement de-bounce in the host processor when monitoring the state of the GPIO signal. Microphone hook switch operation is detected when the MICBIAS current exceeds the Short Circuit Detect threshold set by MICSHORT_THR. Using the digital filtering, the hook switch detection event is only signalled if the MICSHORT_THR threshold condition has been met for 10 consecutive measurements. When the MIC_SHRT_EINT_POL interrupt polarity bit is set to 0, then hook switch operation will cause the MIC_SHRT_EINT interrupt status register to be set. For detection of microphone removal, the MIC_SHRT_EINT_POL bit should be set to 1. When the MIC_SHRT_EINT_POL interrupt polarity bit is set to 1, then hook switch release will cause the MIC_SHRT_EINT interrupt status register to be set. The hook switch detection measurement frequency and the detection delay time tSHORT are detailed in the “Electrical Characteristics” section. The WM8918 Interrupt function is described in the “Interrupts” section. Example control sequences for configuring the Interrupts functions for MICBIAS current detection events are described in the “Applications Information” section. w PD, Rev 4.1, January 2012 37 WM8918 Production Data A clock is required for the digital filtering function, and the DC Servo must also be running. This requires: MCLK is present or the FLL is selected as the SYSCLK source in free-running mode CLK_SYS_ENA = 1 DCS_ENA_CHAN_n is enabled (where n = 0, 1, 2 or 3) Any MICBIAS Current Detect event (accessory insertion/removal or hookswitch press/release) which happens while one or more of the clocking criteria is not satisfied (for example during a low power mode where the CPU has disabled MCLK) will still be detected, but only after the clocking conditions are met. An example is illustrated in Figure 25, where the mic is inserted while MCLK is stopped. Figure 25 MICBIAS Detection events without MCLK w PD, Rev 4.1, January 2012 38 WM8918 Production Data MICROPHONE HOOK SWITCH DETECTION The possibility of spurious hook switch interrupts due to ambient noise conditions can be removed by careful understanding of microphone behaviour under extremely high sound pressure levels or during mechanical shock, and by correct selection of the MICBIAS resistor value; these factors will affect the level of the MICBIAS AC current spikes. In applications where where the Current Detect threshold is close to the level of the current spikes, the probability of false detections is reduced by the hysteresis and digital filtering described above. Note that the filtering algorithm provides only limited rejection of very high current spikes at frequencies less than or equal to the hook switch detect measurement frequency, or at frequencies equal to harmonics of the hook switch detect measurement frequency. The MICBIAS Hook Switch detection filtering is illustrated in Figure 26. Example control sequences for configuring the Interrupts functions for MICBIAS current detection events are described in the “Applications Information” section. Figure 26 MICBIAS Hook Switch Detection Filtering w PD, Rev 4.1, January 2012 39 WM8918 Production Data DIGITAL MICROPHONE INTERFACE The WM8918 supports a stereo digital microphone interface. This may be provided on DMICDAT1 or on DMICDAT2, as selected by the DMIC_SRC register bit. The analogue signal path from the selected input pin must be disabled when using the digital microphone interface; this is achieved by disabling the associated input PGA. The two-channel audio data is multiplexed on the selected input pin. The associated clock, DMICCLK, is provided on a GPIO pin. The Digital Microphone Input is selected as input by setting the DMIC_ENA bit. The Digital Microphone DSP functions are enabled by setting DMICL_ENA and DMICR_ENA for the left and right channels respectively. The correct Digital Microphone sampling rate must be selected by setting the DMIC_OSR128 register to 0. The digital microphone interface configuration is illustrated in Figure 27. Note that care must be taken to ensure that the respective digital logic levels of the microphone are compatible with the digital input thresholds of the WM8918. The digital input thresholds are referenced to DBVDD, as defined in “Electrical Characteristics”. It is recommended to power the digital microphones from DBVDD. Figure 27 Digital Microphone Interface When a GPIO pin is configured as DMIC Clock output, the WM8918 outputs a clock, which supports Digital Microphone operation at a multiple of the device sampling rate, in the range 1-3MHz. The Digital Micropone DSP must be enabled (see Table 8) and the sampling rate must be set in order to ensure correct operation of all DSP functions associated with the digital microphone. Volume control for the Digital Microphone Interface signals is provided using the registers described in Table 9. See “General Purpose Input/Output (GPIO)” for details of configuring the DMICCLK output. See “Clocking and Sample Rates” for details of the supported clocking configurations. When the DMIC_ENA bit is set, then the IN1L/DMICDAT1 or IN1R/DMICDAT2 pin is used as the digital microphone input DMICDAT. Up to two microphones can share each pin; the two microphones are interleaved as illustrated in Figure 28. w PD, Rev 4.1, January 2012 40 WM8918 Production Data The digital microphone interface requires that MIC1 (Left Channel) transmits a data bit each time that DMICCLK is high, and MIC2 (Right Channel) transmits when DMICCLK is low. The WM8918 samples the digital microphone data in the middle of each DMICCLK clock phase. Each microphone must tristate its data output when the other microphone is transmitting. Figure 28 Digital Microphone Interface Timing The digital microphone interface control fields are described in Table 8. REGISTER ADDRESS R10 (0Ah) BIT LABEL DEFAULT 0 DMIC_OSR12 8 1 Analogue DMIC 0 DESCRIPTION DMIC Oversampling Ratio 0 = Normal (64 x fs) 1 = Reserved This bit must be set to 0 for digital microphone operation. R18 (12h) Power Management (6) 1 DMICL_ENA 0 Digital Microphone DSP Enable 0 = Disabled 1 = Enabled 0 DMICR_ENA 0 Digital Microphone DSP Enable 0 = Disabled 1 = Enabled R39 (27h) 12 DMIC_ENA 0 Digital Microphone 0 Digital Microphone mode 0 = Disabled 1 = Audio DSP input is from digital microphone interface When DMIC_ENA = 0, the Digital microphone clock (DMICCLK) is held low. 11 DMIC_SRC 0 Selects Digital Microphone Data Input pin 0 = IN1L/DMICDAT1 1 = IN1R/DMICDAT2 Table 8 Digital Microphone Interface Control Note that all the GPIO pins are referenced to the DBVDD power domain; the IN1L and IN1R pins are referenced to the AVDD power domain. Care must be taken to ensure the microphone logic levels are compatible with the applicable power domain. w PD, Rev 4.1, January 2012 41 WM8918 Production Data DIGITAL MICROPHONE VOLUME CONTROL The output of the Digital Microphone DSP can be digitally amplified or attenuated over a range from 71.625dB to +17.625dB in 0.375dB steps. The volume of each channel can be controlled separately. The gain for a given eight-bit code is detailed in Table 10. The DMIC_VU bit controls the loading of digital volume control data. When DMIC_VU is set to 0, the DMICL_VOL or DMICR_VOL control data will be loaded into the respective control register, but will not actually change the digital gain setting. Both left and right gain settings are updated when a 1 is written to DMIC_VU. This makes it possible to update the gain of both channels simultaneously. REGISTER ADDRESS R36 (24h) BIT LABEL DEFAULT 8 DMIC_VU 0 DMIC Digital Volume Left DESCRIPTION Digital Microphone Volume Update Writing a 1 to this bit will cause left and right DMIC volume to be updated simultaneously 7:0 DMICL_VOL [7:0] 1100_0000 (0dB) Left Digital Microphone Volume 00h = Mute 01h = -71.625dB 02h = -71.250dB … (0.375dB steps) C0h = 0dB … (0.375dB steps) EFh to FFh = +17.625dB (See Table 10 for volume range) R37 (25h) 8 DMIC_VU 0 DMIC Digital Volume Right Digital Microphone Volume Update Writing a 1 to this bit will cause left and right DMIC volume to be updated simultaneously 7:0 DMICR_VOL [7:0] 1100_0000 (0dB) Right Digital Microphone Volume 00h = Mute 01h = -71.625dB 02h = -71.250dB … (0.375dB steps) C0h = 0dB … (0.375dB steps) EFh to FFh = +17.625dB (See Table 10 for volume range) Table 9 Digital Microphone Volume Control w PD, Rev 4.1, January 2012 42 WM8918 Production Data DMICL_VOL or DMICL_VOL or DMICL_VOL or DMICL_VOL or DMICR_VOL Volume (dB) DMICR_VOL Volume (dB) DMICR_VOL Volume (dB) DMICR_VOL Volume (dB) 0h 1h 2h 3h 4h 5h 6h 7h 8h 9h Ah Bh Ch Dh Eh Fh 10h 11h 12h 13h 14h 15h 16h 17h 18h 19h 1Ah 1Bh 1Ch 1Dh 1Eh 1Fh 20h 21h 22h 23h 24h 25h 26h 27h 28h 29h 2Ah 2Bh 2Ch 2Dh 2Eh 2Fh 30h 31h 32h 33h 34h 35h 36h 37h 38h 39h 3Ah 3Bh 3Ch 3Dh 3Eh 3Fh MUTE -71.625 -71.250 -70.875 -70.500 -70.125 -69.750 -69.375 -69.000 -68.625 -68.250 -67.875 -67.500 -67.125 -66.750 -66.375 -66.000 -65.625 -65.250 -64.875 -64.500 -64.125 -63.750 -63.375 -63.000 -62.625 -62.250 -61.875 -61.500 -61.125 -60.750 -60.375 -60.000 -59.625 -59.250 -58.875 -58.500 -58.125 -57.750 -57.375 -57.000 -56.625 -56.250 -55.875 -55.500 -55.125 -54.750 -54.375 -54.000 -53.625 -53.250 -52.875 -52.500 -52.125 -51.750 -51.375 -51.000 -50.625 -50.250 -49.875 -49.500 -49.125 -48.750 -48.375 40h 41h 42h 43h 44h 45h 46h 47h 48h 49h 4Ah 4Bh 4Ch 4Dh 4Eh 4Fh 50h 51h 52h 53h 54h 55h 56h 57h 58h 59h 5Ah 5Bh 5Ch 5Dh 5Eh 5Fh 60h 61h 62h 63h 64h 65h 66h 67h 68h 69h 6Ah 6Bh 6Ch 6Dh 6Eh 6Fh 70h 71h 72h 73h 74h 75h 76h 77h 78h 79h 7Ah 7Bh 7Ch 7Dh 7Eh 7Fh -48.000 -47.625 -47.250 -46.875 -46.500 -46.125 -45.750 -45.375 -45.000 -44.625 -44.250 -43.875 -43.500 -43.125 -42.750 -42.375 -42.000 -41.625 -41.250 -40.875 -40.500 -40.125 -39.750 -39.375 -39.000 -38.625 -38.250 -37.875 -37.500 -37.125 -36.750 -36.375 -36.000 -35.625 -35.250 -34.875 -34.500 -34.125 -33.750 -33.375 -33.000 -32.625 -32.250 -31.875 -31.500 -31.125 -30.750 -30.375 -30.000 -29.625 -29.250 -28.875 -28.500 -28.125 -27.750 -27.375 -27.000 -26.625 -26.250 -25.875 -25.500 -25.125 -24.750 -24.375 80h 81h 82h 83h 84h 85h 86h 87h 88h 89h 8Ah 8Bh 8Ch 8Dh 8Eh 8Fh 90h 91h 92h 93h 94h 95h 96h 97h 98h 99h 9Ah 9Bh 9Ch 9Dh 9Eh 9Fh A0h A1h A2h A3h A4h A5h A6h A7h A8h A9h AAh ABh ACh ADh AEh AFh B0h B1h B2h B3h B4h B5h B6h B7h B8h B9h BAh BBh BCh BDh BEh BFh -24.000 -23.625 -23.250 -22.875 -22.500 -22.125 -21.750 -21.375 -21.000 -20.625 -20.250 -19.875 -19.500 -19.125 -18.750 -18.375 -18.000 -17.625 -17.250 -16.875 -16.500 -16.125 -15.750 -15.375 -15.000 -14.625 -14.250 -13.875 -13.500 -13.125 -12.750 -12.375 -12.000 -11.625 -11.250 -10.875 -10.500 -10.125 -9.750 -9.375 -9.000 -8.625 -8.250 -7.875 -7.500 -7.125 -6.750 -6.375 -6.000 -5.625 -5.250 -4.875 -4.500 -4.125 -3.750 -3.375 -3.000 -2.625 -2.250 -1.875 -1.500 -1.125 -0.750 -0.375 C0h C1h C2h C3h C4h C5h C6h C7h C8h C9h CAh CBh CCh CDh CEh CFh D0h D1h D2h D3h D4h D5h D6h D7h D8h D9h DAh DBh DCh DDh DEh DFh E0h E1h E2h E3h E4h E5h E6h E7h E8h E9h EAh EBh ECh EDh EEh EFh F0h F1h F2h F3h F4h F5h F6h F7h F8h F9h FAh FBh FCh FDh FEh FFh 0.000 0.375 0.750 1.125 1.500 1.875 2.250 2.625 3.000 3.375 3.750 4.125 4.500 4.875 5.250 5.625 6.000 6.375 6.750 7.125 7.500 7.875 8.250 8.625 9.000 9.375 9.750 10.125 10.500 10.875 11.250 11.625 12.000 12.375 12.750 13.125 13.500 13.875 14.250 14.625 15.000 15.375 15.750 16.125 16.500 16.875 17.250 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 17.625 Table 10 Digital Microphone Volume Range w PD, Rev 4.1, January 2012 43 WM8918 Production Data HIGH PASS FILTER A digital high pass filter is applied by default to the DMIC path to remove low frequency noise in voice applications (e.g. wind noise or mechanical vibration). This filter is controlled using the DMIC_HPF and DMIC_HPF_CUT register bits. In hi-fi mode the high pass filter is optimised for removing DC offsets without degrading the bass response and has a cut-off frequency of 3.7Hz at fs=44.1kHz. In voice mode the high pass filter is optimised for voice communication and it is recommended to program the cut-off frequency below 300Hz (e.g. DMIC_HPF_CUT=11 at fs=8kHz or DMIC_HPF_CUT=10 at fs=16kHz). REGISTER ADDRESS R38 (26h) BIT LABEL DEFAULT 6:5 DMIC_HPF_C UT [1:0] 00 DMIC Digital 0 DESCRIPTION DMIC Digital High Pass Filter Cut-Off Frequency (fc) 00 = Hi-fi mode (fc=4Hz at fs=48kHz) 01 = Voice mode 1 (fc=127Hz at fs=16kHz) 10 = Voice mode 2 (fc=130Hz at fs=8kHz) 11 = Voice mode 3 (fc=267Hz at fs=8kHz) (Note: fc scales with sample rate. See Table 12 for cut-off frequencies at all supported sample rates) 4 DMIC_HPF 1 DMIC Digital High Pass Filter Enable 0 = Disabled 1 = Enabled Table 11 DMIC Digital 0 Register Sample Frequency (kHz) CUT-OFF FREQUENCY (Hz) DMIC_HPF_CUT =00 DMIC_HPF_CUT =01 DMIC_HPF_CUT =10 DMIC_HPF_CUT =11 8.000 0.7 64 130 267 11.025 0.9 88 178 367 16.000 1.3 127 258 532 22.050 1.9 175 354 733 24.000 2.0 190 386 798 32.000 2.7 253 514 1063 44.100 3.7 348 707 1464 48.000 4.0 379 770 1594 Table 12 DMIC High Pass Filter Cut-Off Frequencies The high pass filter characteristics are shown in the “Digital Filter Characteristics” section. w PD, Rev 4.1, January 2012 44 WM8918 Production Data DYNAMIC RANGE CONTROL (DRC) The dynamic range controller (DRC) is a circuit which can be enabled in the digital data path of either the Digital Microphone input or the DAC playback. The function of the DRC is to adjust the signal gain in conditions where the input amplitude is unknown or varies over a wide range, e.g. when recording from microphones built into a handheld system. The DRC can apply Compression and Automatic Level Control to the signal path. It incorporates ‘anti-clip’ and ‘quick release’ features for handling transients in order to improve intelligibility in the presence of loud impulsive noises. The DRC is enabled by DRC_ENA, as shown in Table 13. It can be enabled in the Digital Microphone path or in the DAC digital path, under the control of the DRC_DAC_PATH register bit. Note that the DRC can be active in only one of these paths at any time. REGISTER ADDRESS R40 (28h) BIT LABEL DEFAULT DRC_ENA 15 DESCRIPTION DRC enable 0 DRC Control 0 0 = Disabled 1 = Enabled DRC_DAC_PAT H 14 DRC path select 0 0 = Digital Microphone path 1 = DAC path Table 13 DRC Enable COMPRESSION/LIMITING CAPABILITIES The DRC supports two different compression regions, separated by a “knee” at input amplitude T. For signals above the knee, the compression slope DRC_HI_COMP applies; for signals below the knee, the compression slope DRC_LO_COMP applies. The overall DRC compression characteristic in “steady state” (i.e. where the input amplitude is nearconstant) is illustrated in Figure 29. DRC Output Amplitude (dB) (Y0) “knee” DRC_KNEE_OP D RC D O _L RC O _C _HI_ CO M P MP DRC_KNEE_IP 0dB DRC Input Amplitude (dB) Figure 29 DRC Compression Characteristic The slope of the DRC response is determined by register fields DRC_HI_COMP and DRC_LO_COMP respectively. A slope of 1 indicates constant gain in this region. A slope less than 1 represents compression (i.e. a change in input amplitude produces only a smaller change in output amplitude). A slope of 0 indicates that the target output amplitude is the same across a range of input amplitudes; this is infinite compression. w PD, Rev 4.1, January 2012 45 WM8918 Production Data The “knee” in Figure 29 is represented by register fields DRC_KNEE_IP and DRC_KNEE_OP. Parameter Y0, the output level for a 0dB input, is not specified directly, but can be calculated from the other parameters, using the equation The DRC Compression parameters are defined in Table 14. REGISTER ADDRESS R43 (2Bh) BIT LABEL DEFAULT 10:5 DRC_KNEE_IP [5:0] 00_0000 DRC Control 3 DESCRIPTION Input signal at the Compressor 'knee'. 000000 = 0dB 000001 = -0.75dB 000010 = -1.5dB … (-0.75dB steps) 111100 = -45dB 111101 to 111111 = Reserved 4:0 DRC_KNEE_OP [4:0] 0_0000 Output signal at the Compressor 'knee'. 00000 = 0dB 00001 = -0.75dB 00010 = -1.5dB … (-0.75dB steps) 11110 = -22.5dB 11111 = Reserved R42 (2Ah) 5:3 DRC Control 2 DRC_HI_COMP [2:0] 000 Compressor slope (upper region) 000 = 1 (no compression) 001 = 1/2 010 = 1/4 011 = 1/8 100 = 1/16 101 = 0 110 to 111 = Reserved 2:0 DRC_LO_COMP [2:0] 000 Compressor slope (lower region) 000 = 1 (no compression) 001 = 1/2 010 = 1/4 011 = 1/8 100 = 0 101 to 111 = Reserved Table 14 DRC Compression Control w PD, Rev 4.1, January 2012 46 WM8918 Production Data GAIN LIMITS The minimum and maximum gain applied by the DRC is set by register fields DRC_MINGAIN and DRC_MAXGAIN. These limits can be used to alter the DRC response from that illustrated in Figure 29. If the range between maximum and minimum gain is reduced, then the extent of the dynamic range control is reduced. The maximum gain prevents quiet signals (or silence) from being excessively amplified. REGISTER ADDRESS R41 (29h) BIT LABEL DEFAULT 3:2 DRC_MINGAIN [1:0] 10 DRC Control 1 DESCRIPTION Minimum gain the DRC can use to attenuate audio signals 00 = 0dB (default) 01 = -6dB 10 = -12dB 11 = -18dB 1:0 DRC_MAXGAIN [1:0] 00 Maximum gain the DRC can use to boost audio signals 00 = 12dB 01 = 18dB (default) 10 = 24dB 11 = 36dB Table 15 DRC Gain Limits DYNAMIC CHARACTERISTICS The dynamic behaviour determines how quickly the DRC responds to changing signal levels. Note that the DRC responds to the average (RMS) signal amplitude over a period of time. DRC_ATK determines how quickly the DRC gain decreases when the signal amplitude is high. DRC_DCY determines how quickly the DRC gain increases when the signal amplitude is low. These register fields are described in Table 16. Note that the register defaults are suitable for general purpose microphone use. REGISTER ADDRESS R41 (29h) DRC Control 1 BIT LABEL DEFAULT 15:12 DRC_ATK [3:0] 0011 DESCRIPTION Gain attack rate (seconds/6dB) 0000 = Reserved 0001 = 182µs 0010 = 363µs 0011 = 726µs (default) 0100 = 1.45ms 0101 = 2.9ms 0110 = 5.8ms 0111 = 11.6ms 1000 = 23.2ms 1001 = 46.4ms 1010 = 92.8ms 1011-1111 = Reserved w PD, Rev 4.1, January 2012 47 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT 11:8 DRC_DCY [3:0] 0010 DESCRIPTION Gain decay rate (seconds/6dB) 0000 = 186ms 0001 = 372ms 0010 = 743ms (default) 0011 = 1.49s 0100 = 2.97s 0101 = 5.94s 0110 = 11.89s 0111 = 23.78s 1000 = 47.56s 1001-1111 = Reserved Table 16 DRC Attack and Decay Rates Note: For detailed information about DRC attack and decay rates, please see Wolfson application note WAN0247. ANTI-CLIP CONTROL The DRC includes an Anti-Clip feature to avoid signal clipping when the input amplitude rises very quickly. This feature uses a feed-forward technique for early detection of a rising signal level. Signal clipping is avoided by dynamically increasing the gain attack rate when required. The Anti-Clip feature is enabled using the DRC_ANTICLIP bit. Note that the feed-forward processing increases the latency in the input signal path. For low-latency applications (e.g. telephony), it may be desirable to reduce the delay, although this will also reduce the effectiveness of the anti-clip feature. The latency is determined by the DRC_FF_DELAY bit. If necessary, the latency can be minimised by disabling the anti-clip feature altogether. The DRC Anti-Clip control bits are described in Table 17. REGISTER ADDRESS BIT LABEL DEFAULT R40 (28h) DRC Control 0 5 DRC_FF_DELAY 1 DESCRIPTION Feed-forward delay for anti-clip feature 0 = 5 samples 1 = 9 samples Time delay can be calculated as 5/fs or 9/ fs, where fs is the sample rate. 1 DRC_ANTICLIP 1 Anti-clip enable 0 = disabled 1 = enabled Table 17 DRC Anti-Clip Control Note that the Anti-Clip feature operates entirely in the digital domain. It cannot be used to prevent signal clipping in the analogue domain nor in the source signal. Analogue clipping can only be prevented by reducing the analogue signal gain or by adjusting the source signal. w PD, Rev 4.1, January 2012 48 WM8918 Production Data QUICK RELEASE CONTROL The DRC includes a Quick-Release feature to handle short transient peaks that are not related to the intended source signal. For example, in handheld microphone recording, transient signal peaks sometimes occur due to user handling, key presses or accidental tapping against the microphone. The Quick Release feature ensures that these transients do not cause the intended signal to be masked by the longer time constants of DRC_DCY. The Quick-Release feature is enabled by setting the DRC_QR bit. When this bit is enabled, the DRC measures the crest factor (peak to RMS ratio) of the input signal. A high crest factor is indicative of a transient peak that may not be related to the intended source signal. If the crest factor exceeds the level set by DRC_QR_THR, then the normal decay rate (DRC_DCY) is ignored and a faster decay rate (DRC _QR_DCY) is used instead. The DRC Quick-Release control bits are described in Table 18. REGISTER ADDRESS R40 (28h) BIT LABEL DEFAULT 2 DRC_QR 1 DRC Control 0 DESCRIPTION Quick release enable 0 = disabled 1 = enabled R41 (29h) 7:6 DRC Control 1 DRC_QR_THR [1:0] 01 Quick release crest factor threshold 00 = 12dB 01 = 18dB (default) 10 = 24dB 11 = 30dB 5:4 DRC_QR_DCY [1:0] 00 Quick release decay rate (seconds/6dB) 00 = 0.725ms (default) 01 = 1.45ms 10 = 5.8ms 11 = Reserved Table 18 DRC Quick-Release Control GAIN SMOOTHING The DRC includes a gain smoothing filter in order to prevent gain ripples. A programmable level of hysteresis is also used to control the DRC gain. This improves the handling of very low frequency input signals whose period is close to the DRC attack/decay time. DRC Gain Smoothing is enabled by default and it is recommended to use the default register settings. The extent of the gain smoothing filter may be adjusted or disabled using the control fields described in Table 19. REGISTER ADDRESS R40 (28h) BIT LABEL DEFAULT 12:11 DRC_GS_HYST _LVL [1:0] 00 DRC Control 0 DESCRIPTION Gain smoothing hysteresis threshold 00 = Low 01 = Medium (recommended) 10 = High 11 = Reserved 3 DRC_GS_ENA 1 Gain smoothing enable 0 = disabled 1 = enabled 0 DRC_GS_HYST 1 Gain smoothing hysteresis enable 0 = disabled 1 = enabled Table 19 DRC Gain Smoothing w PD, Rev 4.1, January 2012 49 WM8918 Production Data INITIALISATION When the DRC is initialised, the gain is set to the level determined by the DRC_STARTUP_GAIN register field. The default setting is 0dB, but values from -3dB to +6dB are available, as described in Table 20. REGISTER ADDRESS R40 (28h) DRC Control 0 BIT LABEL DEFAULT 10:6 DRC_STARTUP_ GAIN [4:0] 00110 DESCRIPTION Initial gain at DRC start-up 00000 = -3dB 00001 = -2.5dB 00010 = -2dB 00011 = -1.5dB 00100 = -1dB 00101 = -0.5dB 00110 = 0dB (default) 00111 = 0.5dB 01000 = 1dB 01001 = 1.5dB 01010 = 2dB 01011 = 2.5dB 01100 = 3dB 01101 = 3.5dB 01110 = 4dB 01111 = 4.5dB 10000 = 5dB 10001 = 5.5dB 10010 = 6dB 10011 to 11111 = Reserved Table 20 DRC Initialisation w PD, Rev 4.1, January 2012 50 WM8918 Production Data RETUNETM MOBILE PARAMETRIC EQUALIZER (EQ) TM The ReTune Mobile Parametric Equaliser is a circuit that can be enabled in the DAC path. The function of the EQ is to adjust the frequency characteristic of the output to compensate for unwanted frequency characteristics in the loudspeaker (or other output transducer). It can also be used to tailor the response according to user preferences, for example to accentuate or attenuate specific frequency bands to emulate different sound profiles or environments such as concert hall, rock etc. The EQ is enabled using the EQ_ENA bit as shown in Table 21. REGISTER ADDRESS BIT R134 (86h) 0 LABEL DEFAULT EQ_ENA 0 EQ1 DESCRIPTION EQ enable 0 = EQ disabled 1 = EQ enabled TM Table 21 ReTune Mobile Parametric EQ Enable The EQ can be configured to operate in two modes - “Default” mode or “ReTune TM Mobile” mode. DEFAULT MODE (5-BAND PARAMETRIC EQ) In default mode, the cut-off / centre frequencies are fixed as per Table 22. The filter bandwidths are also fixed in default mode. The gain of the individual bands (-12dB to +12dB) can be controlled as described in Table 23. Note that the cut-off / centre frequencies noted in Table 22 are applicable to a DAC Sample Rate of 48kHz. When using other sample rates, these frequencies will be scaled in proportion to the selected sample rate. EQ BAND CUT-OFF/CENTRE FREQUENCY 1 100 Hz 2 300 Hz 3 875 Hz 4 2400 Hz 5 6900 Hz Table 22 EQ Band Cut-off / Centre Frequencies REGISTER ADDRESS R135 (87h) BIT LABEL DEFAULT 4:0 EQ_B1_GAIN [4:0] 01100b EQ2 R136 (88h) (0dB) 4:0 EQ_B2_GAIN [4:0] EQ3 R137 (89h) (0dB) 4:0 EQ_B3_GAIN [4:0] EQ4 R138 (8Ah) 01100b (0dB) 4:0 EQ_B4_GAIN [4:0] EQ5 R139 (8Bh) 01100b 01100b (0dB) 4:0 EQ_B5_GAIN [4:0] EQ6 01100b (0dB) DESCRIPTION EQ Band 1 Gain (see Table 24 for gain range) EQ Band 2 Gain (see Table 24 for gain range) EQ Band 3 Gain (see Table 24 for gain range) EQ Band 4 Gain (see Table 24 for gain range) EQ Band 5 Gain (see Table 24 for gain range) Table 23 EQ Band Gain Control w PD, Rev 4.1, January 2012 51 WM8918 Production Data EQ GAIN SETTING GAIN (DB) 00000 -12 00001 -11 00010 -10 00011 -9 00100 -8 00101 -7 00110 -6 00111 -5 01000 -4 01001 -3 01010 -2 01011 -1 01100 0 01101 +1 01110 +2 01111 +3 10000 +4 10001 +5 10010 +6 10011 +7 10100 +8 10101 +9 10110 +10 10111 +11 11000 +12 11001 to 11111 Reserved Table 24 EQ Gain Control TM RETUNE MOBILE MODE TM ReTune Mobile mode provides a comprehensive facility for the user to define the cut-off/centre frequencies and filter bandwidth for each EQ band, in addition to the gain controls already described. This enables the EQ to be accurately customised for a specific transducer characteristic or desired sound profile. The EQ enable and EQ gain controls are the same as defined for the default mode. The additional TM coefficients used in ReTune Mobile mode are held in registers R140 to R157. These coefficients are derived using tools provided in Wolfson’s WISCE™ evaluation board control software. Please contact your local Wolfson representative for more details. EQ FILTER CHARACTERISTICS The filter characteristics for each frequency band are shown in Figure 30 to Figure 34. These figures show the frequency response for all available gain settings, using default cut-off/centre frequencies and bandwidth. w PD, Rev 4.1, January 2012 52 WM8918 15 15 10 10 5 5 Gain (dB) Gain (dB) Production Data 0 0 -5 -5 -10 -10 -15 -15 1 10 100 1000 10000 100000 1 10 Frequency (Hz) 1000 10000 100000 Frequency (Hz) Figure 30 EQ Band 1 – Low Freq Shelf Filter Response Figure 31 EQ Band 2 – Peak Filter Response 15 15 10 10 5 5 Gain (dB) Gain (dB) 100 0 0 -5 -5 -10 -10 -15 -15 1 10 100 1000 10000 100000 Frequency (Hz) 1 10 100 1000 10000 100000 Frequency (Hz) Figure 32 EQ Band 3 – Peak Filter Response Figure 33 EQ Band 4 – Peak Filter Response 15 10 Gain (dB) 5 0 -5 -10 -15 1 10 100 1000 10000 100000 Frequency (Hz) Figure 34 EQ Band 5 – High Freq Shelf Filter Response w PD, Rev 4.1, January 2012 53 WM8918 Production Data DIGITAL MIXING The Digital Microphone and DAC data can be combined in various ways to support a range of different usage modes. Data from either of the two Digital Microphone channels can be routed to either the left or the right channel of the digital audio interface. In addition, data from either of the digital audio interface channels can be routed to either the left or the right DAC. See "Digital Audio Interface" for more information on the audio interface. The WM8918 provides a Dynamic Range Control (DRC) feature, which can apply compression and gain adjustment in the digital domain to either the Digital Microphone or DAC signal path. This is effective in controlling signal levels under conditions where input amplitude is unknown or varies over a wide range. The DACs can be configured as a mono mix of the two audio channels. Digital sidetone from the Digital Microphones can also be selectively mixed into the DAC output path. DIGITAL MIXING PATHS Figure 35 shows the digital mixing paths available in the WM8918 digital core. Figure 35 Digital Mixing Paths w PD, Rev 4.1, January 2012 54 WM8918 Production Data The polarity of each Digital Microphone output signal can be changed under software control using the AIFTXL_DATINV and AIFTXR_DATINV register bits. The AIFTXL_SRC and AIFTXR_SRC register bits may be used to select which Digital Microphone channel is used for the left and right digital audio interface data. These register bits are described in Table 25. REGISTER ADDRESS R24 (18h) BIT LABEL DEFAULT 7 AIFTXL_SRC 0 Audio Interface 0 DESCRIPTION Left Digital Audio interface source 0 = Left DMIC data is output on left channel 1 = Right DMIC data is output on left channel 6 AIFTXR_SRC 1 Right Digital Audio interface source 0 = Left DMIC data is output on right channel 1 = Right DMIC data is output on right channel R38 (26h) 1 DMIC Digital 0 AIFTXL_DATIN V 0 AIFTXR_DATIN V 0 Left Digital Microphone Invert 0 = Left DMIC output not inverted 1 = Left DMIC output inverted 0 Right Digital Microphone Invert 0 = Right DMIC output not inverted 1 = Right DMIC output inverted Table 25 DMIC Routing and Control The input data source for each DAC can be changed under software control using register bits AIFRXL_SRC and AIFRXR_SRC. The polarity of each DAC input may also be modified using register bits AIFRXL_DATINV and AIFRXR_DATINV. These register bits are described in Table 26. REGISTER ADDRESS BIT LABEL DEFAULT R24 (18h) 12 AIFRXL_DATIN V 0 Audio Interface 0 DESCRIPTION Left DAC Invert 0 = Left DAC output not inverted 1 = Left DAC output inverted 11 AIFRXR_DATIN V 0 AIFRXL_SRC 0 Right DAC Invert 0 = Right DAC output not inverted 1 = Right DAC output inverted 5 Left DAC Data Source Select 0 = Left DAC outputs left interface data 1 = Left DAC outputs right interface data 4 AIFRXR_SRC 1 Right DAC Data Source Select 0 = Right DAC outputs left interface data 1 = Right DAC outputs right interface data Table 26 DAC Routing and Control w PD, Rev 4.1, January 2012 55 WM8918 Production Data DAC INTERFACE VOLUME BOOST A digital gain function is available at the audio interface to boost the DAC volume when a small signal is received on AIFRXDAT. This is controlled using register bits DAC_BOOST [1:0]. To prevent clipping at the DAC input, this function should not be used when the boosted DAC data is expected to be greater than 0dBFS. The digital interface volume is controlled as shown in Table 27. REGISTER ADDRESS BIT LABEL DEFAULT R24 (18h) 10:9 DAC_BOOST [1:0] 00 Audio Interface 0 DESCRIPTION DAC Input Volume Boost 00 = 0dB 01 = +6dB (Input data must not exceed -6dBFS) 10 = +12dB (Input data must not exceed -12dBFS) 11 = +18dB (Input data must not exceed -18dBFS) Table 27 DAC Interface Volume Boost DIGITAL SIDETONE A digital sidetone is available, allowing digital data from either Left or Right Digital Microphone (TX) channels to be mixed with the audio interface data on the Left and Right DAC (RX) channels. Sidetone data is taken from the DMIC high pass filter output, to reduce low frequency noise in the sidetone (e.g. wind noise or mechanical vibration). When using the digital sidetone, it is recommended that the DMIC paths are enabled before unmuting the DACs to prevent pop noise. The DAC volumes and sidetone volumes should be set to an appropriate level to avoid clipping at the DAC input. When digital sidetone is used, it is recommended that the Charge Pump operates in Register Control mode only (CP_DYN_PWR = 0). See “Charge Pump” for details. The digital sidetone is controlled as shown in Table 28. REGISTER ADDRESS BIT LABEL DEFAULT DESCRIPTION R32 (20h) 11:8 DMICL_DAC_SVOL [3:0] 0000 Left Digital Sidetone Volume DAC Digital 0 7:4 DMICR_DAC_SVOL [3:0] 0000 Right Digital Sidetone Volume 3:2 DMIC_TO_DACL [1:0] 00 (See Table 29 for volume range) (See Table 29 for volume range) Left DAC Digital Sidetone Source 00 = No sidetone 01 = Left DMIC 10 = Right DMIC 11 = Reserved 1:0 DMIC_TO_DACR [1:0] 00 Right DAC Digital Sidetone Source 00 = No sidetone 01 = Left DMIC 10 = Right DMIC 11 = Reserved Table 28 Digital Sidetone Control w PD, Rev 4.1, January 2012 56 WM8918 Production Data The digital sidetone volume settings are shown in Table 29. DACL_DAC_SVOL SIDETONE VOLUME OR DACR_DAC_SVOL 0000 -36 0001 -33 0010 -30 0011 -27 0100 -24 0101 -21 0110 -18 0111 -15 1000 -12 1001 -9 1010 -6 1011 -3 1100 0 1101 0 1110 0 1111 0 Table 29 Digital Sidetone Volume w PD, Rev 4.1, January 2012 57 WM8918 Production Data DIGITAL-TO-ANALOGUE CONVERTER (DAC) The WM8918 DACs receive digital input data from the AIFRXDAT pin and via the digital sidetone path (see “Digital Mixing” section). The digital audio data is converted to oversampled bit streams in the on-chip, true 24-bit digital interpolation filters. The bitstream data enters two multi-bit, sigma-delta DACs, which convert them to high quality analogue audio signals. The Wolfson SmartDAC™ architecture offers reduced power consumption, whilst also delivering a reduction in high frequency noise and sensitivity to clock jitter. It also uses a Dynamic Element Matching technique for high linearity and low distortion. The analogue outputs from the DACs are sent directly to the output PGAs (see “Output Signal Path”). The DACs are enabled by the DACL_ENA and DACR_ENA register bits. REGISTER ADDRESS R18 (12h) Power Management 6 BIT LABEL DEFAULT 3 DACL_ENA 0 DESCRIPTION Left DAC Enable 0 = DAC disabled 1 = DAC enabled 2 DACR_ENA 0 Right DAC Enable 0 = DAC disabled 1 = DAC enabled Table 30 DAC Enable Control DAC DIGITAL VOLUME CONTROL The output level of each DAC can be controlled digitally over a range from -71.625dB to 0dB in 0.375dB steps. The level of attenuation for an eight-bit code is detailed in Table 32. The DAC_VU bit controls the loading of digital volume control data. When DAC_VU is set to 0, the DACL_VOL or DACR_VOL control data is loaded into the respective control register, but does not actually change the digital gain setting. Both left and right gain settings are updated when a 1 is written to DAC_VU. This makes it possible to update the gain of both channels simultaneously. REGISTER ADDRESS R30 (1Eh) BIT LABEL DEFAULT 8 DAC_VU N/A DAC Digital Volume Left DESCRIPTION DAC Volume Update Writing a 1 to this bit causes left and right DAC volume to be updated simultaneously 7:0 DACL_VOL [7:0] 1100_0000 (0dB) Left DAC Digital Volume 00h = Mute 01h = -71.625dB 02h = -71.250dB … (0.375dB steps) C0h to FFh = 0dB (See Table 32 for volume range) R31 (1Fh) 8 DAC_VU N/A DAC Volume Update Writing a 1 to this bit causes left and right DAC volume to be updated simultaneously DAC Digital Volume Right 7:0 DACR_VOL [7:0] 1100_0000 (0dB) Right DAC Digital Volume 00h = Mute 01h = -71.625dB 02h = -71.250dB … (0.375dB steps) C0h to FFh = 0dB (See Table 32 for volume range) Table 31 DAC Digital Volume Control w PD, Rev 4.1, January 2012 58 WM8918 Production Data DACL_VOL or DACL_VOL or DACL_VOL or DACL_VOL or DACR_VOL Volume (dB) DACR_VOL Volume (dB) DACR_VOL Volume (dB) DACR_VOL Volume (dB) 0h 1h 2h 3h 4h 5h 6h 7h 8h 9h Ah Bh Ch Dh Eh Fh 10h 11h 12h 13h 14h 15h 16h 17h 18h 19h 1Ah 1Bh 1Ch 1Dh 1Eh 1Fh 20h 21h 22h 23h 24h 25h 26h 27h 28h 29h 2Ah 2Bh 2Ch 2Dh 2Eh 2Fh 30h 31h 32h 33h 34h 35h 36h 37h 38h 39h 3Ah 3Bh 3Ch 3Dh 3Eh 3Fh MUTE -71.625 -71.250 -70.875 -70.500 -70.125 -69.750 -69.375 -69.000 -68.625 -68.250 -67.875 -67.500 -67.125 -66.750 -66.375 -66.000 -65.625 -65.250 -64.875 -64.500 -64.125 -63.750 -63.375 -63.000 -62.625 -62.250 -61.875 -61.500 -61.125 -60.750 -60.375 -60.000 -59.625 -59.250 -58.875 -58.500 -58.125 -57.750 -57.375 -57.000 -56.625 -56.250 -55.875 -55.500 -55.125 -54.750 -54.375 -54.000 -53.625 -53.250 -52.875 -52.500 -52.125 -51.750 -51.375 -51.000 -50.625 -50.250 -49.875 -49.500 -49.125 -48.750 -48.375 40h 41h 42h 43h 44h 45h 46h 47h 48h 49h 4Ah 4Bh 4Ch 4Dh 4Eh 4Fh 50h 51h 52h 53h 54h 55h 56h 57h 58h 59h 5Ah 5Bh 5Ch 5Dh 5Eh 5Fh 60h 61h 62h 63h 64h 65h 66h 67h 68h 69h 6Ah 6Bh 6Ch 6Dh 6Eh 6Fh 70h 71h 72h 73h 74h 75h 76h 77h 78h 79h 7Ah 7Bh 7Ch 7Dh 7Eh 7Fh -48.000 -47.625 -47.250 -46.875 -46.500 -46.125 -45.750 -45.375 -45.000 -44.625 -44.250 -43.875 -43.500 -43.125 -42.750 -42.375 -42.000 -41.625 -41.250 -40.875 -40.500 -40.125 -39.750 -39.375 -39.000 -38.625 -38.250 -37.875 -37.500 -37.125 -36.750 -36.375 -36.000 -35.625 -35.250 -34.875 -34.500 -34.125 -33.750 -33.375 -33.000 -32.625 -32.250 -31.875 -31.500 -31.125 -30.750 -30.375 -30.000 -29.625 -29.250 -28.875 -28.500 -28.125 -27.750 -27.375 -27.000 -26.625 -26.250 -25.875 -25.500 -25.125 -24.750 -24.375 80h 81h 82h 83h 84h 85h 86h 87h 88h 89h 8Ah 8Bh 8Ch 8Dh 8Eh 8Fh 90h 91h 92h 93h 94h 95h 96h 97h 98h 99h 9Ah 9Bh 9Ch 9Dh 9Eh 9Fh A0h A1h A2h A3h A4h A5h A6h A7h A8h A9h AAh ABh ACh ADh AEh AFh B0h B1h B2h B3h B4h B5h B6h B7h B8h B9h BAh BBh BCh BDh BEh BFh -24.000 -23.625 -23.250 -22.875 -22.500 -22.125 -21.750 -21.375 -21.000 -20.625 -20.250 -19.875 -19.500 -19.125 -18.750 -18.375 -18.000 -17.625 -17.250 -16.875 -16.500 -16.125 -15.750 -15.375 -15.000 -14.625 -14.250 -13.875 -13.500 -13.125 -12.750 -12.375 -12.000 -11.625 -11.250 -10.875 -10.500 -10.125 -9.750 -9.375 -9.000 -8.625 -8.250 -7.875 -7.500 -7.125 -6.750 -6.375 -6.000 -5.625 -5.250 -4.875 -4.500 -4.125 -3.750 -3.375 -3.000 -2.625 -2.250 -1.875 -1.500 -1.125 -0.750 -0.375 C0h C1h C2h C3h C4h C5h C6h C7h C8h C9h CAh CBh CCh CDh CEh CFh D0h D1h D2h D3h D4h D5h D6h D7h D8h D9h DAh DBh DCh DDh DEh DFh E0h E1h E2h E3h E4h E5h E6h E7h E8h E9h EAh EBh ECh EDh EEh EFh F0h F1h F2h F3h F4h F5h F6h F7h F8h F9h FAh FBh FCh FDh FEh FFh 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 Table 32 DAC Digital Volume Range w PD, Rev 4.1, January 2012 59 WM8918 Production Data DAC SOFT MUTE AND SOFT UN-MUTE The WM8918 has a soft mute function. When enabled, this gradually attenuates the volume of the DAC output. When soft mute is disabled, the gain will either gradually ramp back up to the digital gain setting, or return instantly to the digital gain setting, depending on the DAC_UNMUTE_RAMP register bit. To mute the DAC, this function must be enabled by setting DAC_MUTE to 1. Soft Mute Mode would typically be enabled (DAC_UNMUTE_RAMP = 1) when using DAC_MUTE during playback of audio data so that when DAC_MUTE is subsequently disabled, the sudden volume increase will not create pop noise by jumping immediately to the previous volume level (e.g. resuming playback after pausing during a track). Soft Mute Mode would typically be disabled (DAC_UNMUTE_RAMP = 0) when un-muting at the start of a music file, in order that the first part of the track is not attenuated (e.g. when starting playback of a new track, or resuming playback after pausing between tracks). DAC muting and un-muting using volume control bits DACL_VOL and DACR_VOL. DAC muting and un-muting using the DAC_MUTE bit. If soft Mute Mode is not enabled (DAC_UNMUTE_RAMP = 0): Setting the DAC_MUTE bit causes the volume to ramp down at a rate controlled by DAC_MUTERATE. Clearing the DAC_MUTE bit causes the volume to return to the un-muted level immediately. DAC muting and un-muting using the DAC_MUTE bit. If soft Mute Mode is enabled (DAC_UNMUTE_RAMP = 1): Setting the DAC_MUTE bit causes the volume to ramp down. Clearing the DAC_MUTE bit causes the volume to ramp up to the un-muted level at a rate controlled by DAC_MUTERATE. Figure 36 DAC Mute Control The volume ramp rate during soft mute and un-mute is controlled by the DAC_MUTERATE bit. Ramp rates of fs/32 and fs/2 can be selected, as shown in Table 33. The ramp rate determines the rate at which the volume is increased or decreased. The actual ramp time depends on the extent of the difference between the muted and un-muted volume settings. w PD, Rev 4.1, January 2012 60 WM8918 Production Data REGISTER ADDRESS R33 (21h) BIT LABEL DEFAULT 10 DAC_MUTERA TE 0 DAC Digital 1 DESCRIPTION DAC Soft Mute Ramp Rate 0 = Fast ramp (fs/2, maximum ramp time is 10.7ms at fs=48k) 1 = Slow ramp (fs/32, maximum ramp time is 171ms at fs=48k) 9 DAC_UNMUTE _RAMP DAC Soft Mute Mode 0 0 = Disabling soft-mute (DAC_MUTE=0) will cause the DAC volume to change immediately to DACL_VOL and DACR_VOL settings 1 = Disabling soft-mute (DAC_MUTE=0) will cause the DAC volume to ramp up gradually to the DACL_VOL and DACR_VOL settings 3 DAC_MUTE DAC Soft Mute Control 1 0 = DAC Un-mute 1 = DAC Mute Table 33 DAC Soft-Mute Control DAC MONO MIX A DAC digital mono-mix mode can be enabled using the DAC_MONO register bit. This mono mix will be output on whichever DAC is enabled. To prevent clipping, a -6dB attenuation is automatically applied to the mono mix. The mono mix is only supported when one or other DAC is disabled. When the mono mix is selected, then the mono mix is output on the enabled DAC only; there is no output from the disabled DAC. If DACL_ENA and DACR_ENA are both set, then stereo operation applies. REGISTER ADDRESS R33 (21h) BIT LABEL DEFAULT 12 DAC_MONO 0 DAC Digital 1 DESCRIPTION DAC Mono Mix 0 = Stereo 1 = Mono (Mono mix output on enabled DAC) Table 34 DAC Mono Mix DAC DE-EMPHASIS Digital de-emphasis can be applied to the DAC playback data (e.g. when the data comes from a CD with pre-emphasis used in the recording). De-emphasis filtering is available for sample rates of 48kHz, 44.1kHz and 32kHz. See “Digital Filter Characteristics” for details of de-emphasis filter characteristics. REGISTER ADDRESS BIT LABEL DEFAULT R33 (21h) DAC Digital 1 2:1 DEEMPH [1:0] 00 DESCRIPTION DAC De-Emphasis Control 00 = No de-emphasis 01 = 32kHz sample rate 10 = 44.1kHz sample rate 11 = 48kHz sample rate Table 35 DAC De-Emphasis Control w PD, Rev 4.1, January 2012 61 WM8918 Production Data DAC SLOPING STOPBAND FILTER Two DAC filter types are available, selected by the register bit DAC_SB_FILT. When operating at sample rates <= 24kHz (eg. during voice communication) it is recommended that the sloping stopband filter type is selected (DAC_SB_FILT=1) to reduce out-of-band noise which can be audible at low DAC sample rates. See “Digital Filter Characteristics” for details of DAC filter characteristics. REGISTER ADDRESS BIT LABEL DEFAULT R33 (21h) DAC Digital 1 11 DAC_SB_FILT 0 DESCRIPTION Selects DAC filter characteristics 0 = Normal mode 1 = Sloping stopband mode (recommended when fs 24kHz Table 36 DAC Sloping Stopband Filter DAC OVERSAMPLING RATIO (OSR) The DAC oversampling rate is programmable to allow power consumption versus audio performance trade-offs. The default oversampling rate is low for reduced power consumption; using the higher OSR setting improves the DAC signal-to-noise performance. REGISTER ADDRESS R33 (21h) BIT LABEL DEFAULT 6 DAC_OSR128 0 DAC Digital 1 DESCRIPTION DAC Oversample Rate Select 0 = Low power (normal OSR) 1 = High performance (double OSR) Table 37 DAC Oversampling Control w PD, Rev 4.1, January 2012 62 WM8918 Production Data OUTPUT SIGNAL PATH The outputs HPOUTL and LINEOUTL are normally derived from the Left DAC output, whilst the outputs HPOUTR and LINEOUTR are normally derived from the Right DAC output, as illustrated in Figure 37. A multiplexer is provided on each output path to select the BYPASSL or BYPASSR analogue input signals in place of the DAC outputs. A feedback path for common mode noise rejection is provided at HPOUTFB and LINEOUTFB for the Headphone and Line outputs respectively. This pin must be connected to ground for normal operation. HPOUTL_MUTE HPOUT_VU HPOUTLZC HPOUTL_VOL (-57dB to +6dB, 1 dB steps) DACR DACL BYPASSR BYPASSL Each analogue output can be separately enabled; independent volume control is also provided for each output. The output signal paths and associated control registers are illustrated in Figure 37. See “Analogue Outputs” for details of the external connections to these outputs. M U X BYPASSL HPOUTL HPL_PGA_ENA HPL_BYP_ENA HPOUTFB M U X DAC L HPOUTR HPR_PGA_ENA HPR_BYP_ENA HPOUTR_MUTE HPOUT_VU HPOUTRZC HPOUTR_VOL (-57dB to +6dB, 1 dB steps) LINEOUTL_MUTE LINEOUT_VU LINEOUTLZC LINEOUTL_VOL (-57dB to +6dB, 1 dB steps) M U X DAC R LINEOUTL LINEOUTL_PGA_ENA LINEOUTL_BYP_ENA LINEOUTFB M U X BYPASSR LINEOUTR_BYP_ENA LINEOUTR LINEOUTR_PGA_ENA LINEOUTR_MUTE LINEOUT_VU LINEOUTRZC LINEOUTR_VOL (-57dB to +6dB, 1 dB steps) AVDD DCVDD DC Servo HPOUT and LINEOUT drivers CPVOUTN CPVOUTP CPGND CPVDD CPCB CPCA CHARGE PUMP Figure 37 Output Signal Path and Control Registers w PD, Rev 4.1, January 2012 63 WM8918 Production Data OUTPUT SIGNAL PATHS ENABLE The output PGAs for each analogue output pin can be enabled and disabled using the register bits described in Table 38. Note that the Headphone Outputs and Line Outputs are also controlled by fields located within Register R90 and R94, which provide suppression of pops & clicks when enabling and disabling these signal paths. These registers are described in the following “Headphone / Line Output Signal Paths Enable” section. Under recommended usage conditions, all the control bits associated with enabling the Headphone Outputs and the Line Outputs will be configured by scheduling the default Start-Up and Shutdown sequences as described in the “Control Write Sequencer” section. In these cases, the user does not need to set the register fields in R14, R15, R90 and R94 directly. REGISTER ADDRESS R14 (0Eh) BIT LABEL DEFAULT 1 HPL_PGA_ENA 0 Power Management 2 DESCRIPTION Left Headphone Output Enable 0 = Disabled 1 = Enabled 0 HPR_PGA_ENA 0 Right Headphone Output Enable 0 = Disabled 1 = Enabled R15 (0Fh) 1 Power Management 3 LINEOUTL_PGA_ ENA 0 LINEOUTR_PGA _ENA 0 Left Line Output Enable 0 = Disabled 1 = Enabled 0 Right Line Output Enable 0 = Disabled 1 = Enabled Table 38 Output Signal Paths Enable To enable the output PGAs and multiplexers, the reference voltage VMID and the bias current must also be enabled. See “Reference Voltages and Master Bias” for details of the associated controls VMID_RES and BIAS_ENA. HEADPHONE / LINE OUTPUT SIGNAL PATHS ENABLE The output paths can be actively discharged to AGND through internal resistors if desired. This is desirable at start-up in order to achieve a known output stage condition prior to enabling the VMID reference voltage. This is also desirable in shutdown to prevent the external connections from being affected by the internal circuits. The ground-referenced Headphone outputs and Line outputs are shorted to AGND by default; the short circuit is removed on each of these paths by setting the applicable fields HPL_RMV_SHORT, HPR_RMV_SHORT, LINEOUTL_RMV_SHORT or LINEOUTR_RMV_SHORT. The ground-referenced Headphone output and Line output drivers are designed to suppress pops and clicks when enabled or disabled. However, it is necessary to control the drivers in accordance with a defined sequence in start-up and shutdown to achieve the pop suppression. It is also necessary to schedule the DC Servo offset correction at the appropriate point in the sequence (see “DC Servo”). Table 39 and Table 40 describe the recommended sequences for enabling and disabling these output drivers. w PD, Rev 4.1, January 2012 64 WM8918 Production Data SEQUENCE HEADPHONE ENABLE Step 1 Step 2 Step 3 Step 4 Step 5 LINEOUT ENABLE HPL_ENA = 1 LINEOUTL_ENA = 1 HPR_ENA = 1 LINEOUTR_ENA = 1 HPL_ENA_DLY = 1 LINEOUTL_ENA_DLY = 1 HPR_ENA_DLY = 1 LINEOUTR_ENA_DLY = 1 DC offset correction DC offset correction HPL_ENA_OUTP = 1 LINEOUTL_ENA_OUTP = 1 HPR_ENA_OUTP = 1 LINEOUTR_ENA_OUTP = 1 HPL_RMV_SHORT = 1 LINEOUTL_RMV_SHORT = 1 HPR_RMV_SHORT = 1 LINEOUTR_RMV_SHORT = 1 Table 39 Headphone / Line Output Enable Sequence SEQUENCE HEADPHONE DISABLE LINEOUT DISABLE Step 1 HPL_RMV_SHORT = 0 LINEOUTL_RMV_SHORT = 0 HPR_RMV_SHORT = 0 LINEOUTR_RMV_SHORT = 0 Step 2 HPL_ENA = 0 LINEOUTL_ENA = 0 HPL_ENA_DLY = 0 LINEOUTL_ENA_DLY = 0 HPL_ENA_OUTP = 0 LINEOUTL_ENA_OUTP = 0 HPR_ENA = 0 LINEOUTR_ENA = 0 HPR_ENA_DLY = 0 LINEOUTR_ENA_DLY = 0 HPR_ENA_OUTP = 0 LINEOUTR_ENA_OUTP = 0 Table 40 Headphone / Line Output Disable Sequence The registers relating to Headphone / Line Output pop suppression control are defined in Table 41. REGISTER ADDRESS R90 (5Ah) BIT LABEL DEFAULT 7 HPL_RMV_SHOR T 0 Analogue HP 0 DESCRIPTION Removes HPL short 0 = HPL short enabled 1 = HPL short removed For normal operation, this bit should be set as the final step of the HPL Enable sequence. 6 HPL_ENA_OUTP 0 Enables HPL output stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the DC offset cancellation has been scheduled. 5 HPL_ENA_DLY 0 Enables HPL intermediate stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the output signal path has been configured, and before DC offset cancellation is scheduled. This bit should be set with at least 20us delay after HPL_ENA. w PD, Rev 4.1, January 2012 65 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT 4 HPL_ENA 0 DESCRIPTION Enables HPL input stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set as the first step of the HPL Enable sequence. 3 HPR_RMV_SHO RT 0 Removes HPR short 0 = HPR short enabled 1 = HPR short removed For normal operation, this bit should be set as the final step of the HPR Enable sequence. 2 HPR_ENA_OUTP 0 Enables HPR output stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the DC offset cancellation has been scheduled. 1 HPR_ENA_DLY 0 Enables HPR intermediate stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the output signal path has been configured, and before DC offset cancellation is scheduled. This bit should be set with at least 20us delay after HPR_ENA. 0 HPR_ENA 0 Enables HPR input stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set as the first step of the HPR Enable sequence. w PD, Rev 4.1, January 2012 66 WM8918 Production Data REGISTER ADDRESS R94 (5Eh) BIT LABEL DEFAULT 7 LINEOUTL_RMV_ SHORT 0 LINEOUTL_ENA_ OUTP 0 LINEOUTL_ENA_ DLY 0 Analogue Lineout 0 6 5 DESCRIPTION Removes LINEOUTL short 0 = LINEOUTL short enabled 1 = LINEOUTL short removed For normal operation, this bit should be set as the final step of the LINEOUTL Enable sequence. Enables LINEOUTL output stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the DC offset cancellation has been scheduled. Enables LINEOUTL intermediate stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the output signal path has been configured, and before DC offset cancellation is scheduled. This bit should be set with at least 20us delay after LINEOUTL_ENA. 4 LINEOUTL_ENA 0 Enables LINEOUTL input stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set as the first step of the LINEOUTL Enable sequence. 3 2 1 LINEOUTR_RMV _SHORT 0 LINEOUTR_ENA_ OUTP 0 LINEOUTR_ENA_ DLY 0 Removes LINEOUTR short 0 = LINEOUTR short enabled 1 = LINEOUTR short removed For normal operation, this bit should be set as the final step of the LINEOUTR Enable sequence. Enables LINEOUTR output stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the DC offset cancellation has been scheduled. Enables LINEOUTR intermediate stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the output signal path has been configured, and before DC offset cancellation is scheduled. This bit should be set with at least 20us delay after LINEOUTR_ENA. 0 LINEOUTR_ENA 0 Enables LINEOUTR input stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set as the first step of the LINEOUTR Enable sequence. Table 41 Headphone / Line Output Pop Suppression Control w PD, Rev 4.1, January 2012 67 WM8918 Production Data OUTPUT MUX CONTROL By default, the DAC outputs are routed directly to the respective output PGAs. A multiplexer (mux) is provided on each output path to select the BYPASSL or BYPASSR analogue signals from the Left/Right Input PGAs in place of the DAC outputs. The output multiplexers are configured using the register bits described in Table 42. REGISTER ADDRESS R61 (3Dh) Analogue OUT12 ZC BIT LABEL DEFAULT 3 HPL_BYP_ENA 0 DESCRIPTION Selects input for left headphone output MUX 0 = Left DAC 1 = Left input PGA (Analogue bypass) 2 HPR_BYP_ENA 0 Selects input for right headphone output MUX 0 = Right DAC 1 = Right input PGA (Analogue bypass) 1 LINEOUTL_BYP_ ENA 0 Selects input for left line output MUX 0 = Left DAC 1 = Left input PGA (Analogue bypass) 0 LINEOUTR_BYP_ ENA 0 Selects input for right line output MUX 0 = Right DAC 1 = Right input PGA (Analogue bypass) Table 42 Output Mux Control OUTPUT VOLUME CONTROL Each analogue output can be independently controlled. The headphone output control fields are described in Table 43. The line output control fields are described in Table 44. The output pins are described in more detail in “Analogue Outputs”. The volume and mute status of each output can be controlled individually using the bit fields shown in Table 43 and Table 44. To prevent “zipper noise” when a volume adjustment is made, a zero-cross function is provided on all output paths. When this function is enabled, volume updates will not take place until a zero-crossing is detected. In the event of a long period without zero-crossings, a timeout will apply. The timeout must be enabled by setting the TOCLK_ENA bit, as defined in “Clocking and Sample Rates”. The volume update bits control the loading of the output driver volume data. For example, when HPOUT_VU is set to 0, the headphone volume data can be loaded into the respective control register, but will not actually change the gain setting. The Left and Right headphone volume settings are updated when a 1 is written to HPOUT_VU. This makes it possible to update the gain of a Left/Right pair of output paths simultaneously. w PD, Rev 4.1, January 2012 68 WM8918 Production Data REGISTER ADDRESS R57 (39h) BIT LABEL DEFAULT 8 HPOUTL_MUTE 0 DESCRIPTION Left Headphone Output Mute 0 = Un-mute Analogue OUT1 Left 1 = Mute 7 HPOUT_VU 0 Headphone Output Volume Update Writing a 1 to this bit will update HPOUTL and HPOUTR volumes simultaneously. 6 HPOUTLZC 0 Left Headphone Output Zero Cross Enable 0 = disabled 1 = enabled 5:0 HPOUTL_VOL [5:0] 10_1101 Left Headphone Output Volume 000000 = -57dB 000001 = -56dB (… 1dB steps) 111001 = 0dB (… 1dB steps) 111110 = +5dB 111111 = +6dB R58 (3Ah) 8 HPOUTR_MUTE 0 Right Headphone Output Mute 0 = Un-mute Analogue OUT1 Right 1 = Mute 7 HPOUT_VU 0 Headphone Output Volume Update Writing a 1 to this bit will update HPOUTL and HPOUTR volumes simultaneously. 6 HPOUTRZC 0 Right Headphone Output Zero Cross Enable 0 = disabled 1 = enabled 5:0 HPOUTR_VOL [5:0] 10_1101 Right Headphone Output Volume 000000 = -57dB 000001 = -56dB (… 1dB steps) 111001 = 0dB (… 1dB steps) 111110 = +5dB 111111 = +6dB Table 43 Volume Control for HPOUTL and HPOUTR w PD, Rev 4.1, January 2012 69 WM8918 Production Data REGISTER ADDRESS R59 (3Bh) BIT LABEL DEFAULT 8 LINEOUTL_MUTE 0 DESCRIPTION Left Line Output Mute 0 = Un-mute Analogue OUT2 Left 1 = Mute 7 LINEOUT_VU 0 Line Output Volume Update Writing a 1 to this bit will update LINEOUTL and LINEOUTR volumes simultaneously. 6 LINEOUTLZC 0 Left Line Output Zero Cross Enable 0 = disabled 1 = enabled 5:0 LINEOUTL_VOL [5:0] 11_1001 Left Line Output Volume 000000 = -57dB 000001 = -56dB (… 1dB steps) 111001 = 0dB (… 1dB steps) 111110 = +5dB R60 (3Ch) 8 Analogue OUT2 Right LINEOUTR_MUT E 0 LINEOUT_VU 0 111111 = +6dB Right Line Output Mute 0 = Un-mute 1 = Mute 7 Line Output Volume Update Writing a 1 to this bit will update LINEOUTL and LINEOUTR volumes simultaneously. 6 LINEOUTRZC 0 Right Line Output Zero Cross Enable 0 = disabled 1 = enabled 5:0 LINEOUTR_VOL [5:0] 11_1001 Right Line Output Volume 000000 = -57dB 000001 = -56dB (… 1dB steps) 111001 = 0dB (… 1dB steps) 111110 = +5dB 111111 = +6dB Table 44 Volume Control for LINEOUTL and LINEOUTR w PD, Rev 4.1, January 2012 70 WM8918 Production Data ANALOGUE OUTPUTS The WM8918 has four analogue output pins: Headphone outputs, HPOUTL and HPOUTR, with feedback HPOUTFB Line outputs, LINEOUTL and LINEOUTR, with feedback LINEOUTFB The output signal paths and associated control registers are illustrated in Figure 37. HEADPHONE OUTPUTS – HPOUTL AND HPOUTR The headphone outputs are designed to drive 16Ω or 32Ω headphones. These outputs are groundreferenced, i.e. no series capacitor is required between the pins and the headphone load. They are powered by an on-chip charge pump (see “Charge Pump” section). Signal volume at the headphone outputs is controlled as shown in Table 43. The ground-referenced outputs incorporates a common mode, or ground loop, feedback path which provides rejection of system-related ground noise. The return path for the HPOUTL and HPOUTR outputs is via HPOUTFB. This pin must be connected to ground for normal operation of the headphone output. No register configuration is required. LINE OUTPUTS – LINEOUTL AND LINEOUTR The line outputs are identical to the headphone outputs in design. They are ground-referenced and powered by the on-chip charge pump. Signal volume at the line outputs is controlled as shown in Table 44. Note that these outputs are intended for driving line loads, as the charge pump powering both the Headphone and Line outputs can only provide sufficient power to drive one set of headphones at any given time. The ground-referenced outputs incorporates a common mode, or ground loop, feedback path which provides rejection of system-related ground noise. The return path for the LINEOUTL and LINEOUTR outputs is via LINEOUTFB. This pin must be connected to ground for normal operation of the line output. No register configuration is required. w PD, Rev 4.1, January 2012 71 WM8918 Production Data EXTERNAL COMPONENTS FOR GROUND REFERENCED OUTPUTS It is recommended to connect a zobel network to the ground-referenced outputs HPOUTL, HPOUTR, LINEOUTL and LINEOUTR in order to ensure best audio performance in all applications. The components of the zobel network have the effect of dampening high frequency oscillations or instabilities that can arise outside the audio band under certain conditions. Possible sources of these instabilities include the inductive load of a headphone coil or an active load in the form of an external line amplifier. The capacitance of lengthy cables or PCB tracks can also lead to amplifier instability. The zobel network should comprise a 20 resistor and 100nF capacitor in series with each other, as illustrated in Figure 38. Note that the zobel network is recommended for best audio quality and amplifier stability in all cases. Figure 38 Zobel Network Components for HPOUTL, HPOUTR, LINEOUTL and LINEOUTR w PD, Rev 4.1, January 2012 72 WM8918 Production Data REFERENCE VOLTAGES AND MASTER BIAS This section describes the analogue reference voltage and bias current controls. Note that, under the recommended usage conditions of the WM8918, these features will be configured by scheduling the default Start-Up and Shutdown sequences as described in the “Control Write Sequencer” section. In these cases, the user does not need to set these register fields directly. The analogue circuits in the WM8918 require a mid-rail analogue reference voltage, VMID. This reference is generated from AVDD via a programmable resistor chain. VMID is enabled by setting the VMID_ENA register bit. The programmable resistor chain is configured by VMID_RES [1:0], and can be used to optimise the reference for normal operation, low power standby or for fast start-up as described in Table 45. For normal operation, the VMID_RES field should be set to 01. The VMID_BUF_ENA bit allows the buffered VMID reference to be connected to unused inputs/outputs. The analogue circuits in the WM8918 require a bias current. The bias current is enabled by setting BIAS_ENA. Note that the bias current source requires VMID to be enabled also. REGISTER ADDRESS R5 (05h) BIT LABEL DEFAULT DESCRIPTION 6 VMID_BUF_ ENA 0 Enable VMID buffer to unused Inputs/Outputs VMID_RES [1:0] 00 VMID Control (0) 0 = Disabled 1 = Enabled 2:1 VMID Divider Enable and Select 00 = VMID disabled (for OFF mode) 01 = 2 x 50k divider (for normal operation) 10 = 2 x 250k divider (for low power standby) 11 = 2 x 5k divider (for fast start-up) 0 VMID_ENA 0 Enable VMID master bias current source 0 = Disabled 1 = Enabled R4 (04h) Bias Control (0) 0 BIAS_ENA 0 Enables the Normal bias current generator (for all analogue functions) 0 = Disabled 1 = Enabled Table 45 Reference Voltages and Master Bias Enable w PD, Rev 4.1, January 2012 73 WM8918 Production Data POP SUPPRESSION CONTROL The WM8918 incorporates Wolfson’s SilentSwitch™ technology which enables pops normally associated with Start-Up, Shutdown or signal path control to be suppressed. To achieve maximum benefit from these features, careful attention is required to the sequence and timing of these controls. Note that, under the recommended usage conditions of the WM8918, these features will be configured by running the default Start-Up and Shutdown sequences as described in the “Control Write Sequencer” section. In these cases, the user does not need to set these register fields directly. The Pop Suppression controls relating to the Headphone / Line Output drivers are described in the “Output Signal Path” section. DISABLED INPUT CONTROL The analogue inputs to the WM8918 are biased to VMID in normal operation. In order to avoid audible pops caused by a disabled signal path dropping to AGND, the WM8918 can maintain these connections at VMID when the relevant input stage is disabled. This is achieved by connecting a buffered VMID reference to the input. The buffered VMID reference is enabled by setting VMID_BUF_ENA; when the buffered VMID reference is enabled, it is connected to any unused input pins. REGISTER ADDRESS R5 (05h) BIT LABEL DEFAULT DESCRIPTION 6 VMID_BUF_ENA 0 VMID buffer to unused Inputs/Outputs 0 = Disabled VMID Control 0 1 = Enabled 0 VMID_ENA 0 VMID Buffer Enable 0 = Disabled 1 = Enabled Table 46 Disabled Line Input Control w PD, Rev 4.1, January 2012 74 WM8918 Production Data CHARGE PUMP The WM8918 incorporates a dual-mode Charge Pump which generates the supply rails for the headphone and line output drivers, HPOUTL, HPOUTR, and LINEOUTL and LINEOUTR. The Charge Pump has a single supply input, CPVDD, and generates split rails CPVOUTP and CPVOUTN according to the selected mode of operation. The Charge Pump connections are illustrated in Figure 39 (see the “Electrical Characteristics” section for external component values). An input decoupling capacitor may also be required at CPVDD, depending upon the system configuration. CPCA CPCB CPVOUTP CPVDD Charge Pump CPVOUTN CPGND Figure 39 Charge Pump External Connections The Charge Pump is enabled by setting the CP_ENA bit. When enabled, the charge pump adjusts the output voltages (CPVOUTP and CPVOUTN) as well as the switching frequency in order to optimise the power consumption according to the operating conditions. This can take two forms, which are selected using the CP_DYN_PWR register bit. Register control (CP_DYN_PWR = 0) Dynamic control (CP_DYN_PWR = 1) Under Register control, the HPOUTL_VOL, HPOUTR_VOL, LINEOUTL_VOL and LINEOUTR_VOL register settings are used to control the charge pump mode of operation. Under Dynamic control, the audio signal level in the DAC is used to control the charge pump mode of operation. This is the Wolfson ‘Class W’ mode, which allows the power consumption to be optimised in real time, but can only be used if the DAC is the only signal source. This mode should not be used if any of the bypass paths are used to feed analogue inputs into the output signal path. Under the recommended usage conditions of the WM8918, the Charge Pump will be enabled by running the default headphone Start-Up sequence as described in the “Control Write Sequencer” section. (Similarly, it will be disabled by running the Shutdown sequence.) In these cases, the user does not need to write to the CP_ENA bit. The Charge Pump operating mode defaults to Register control; Dynamic control may be selected by setting the CP_DYN_PWR register bit, if appropriate. When digital sidetone is used (see “Digital Mixing”), it is recommended that the Charge Pump operates in Register Control mode only (CP_DYN_PWR = 0). This is because the Dynamic Control mode (Class W) does not measure the sidetone signal level and hence the Charge Pump configuration cannot be optimised for all signal conditions when digital sidetone is enabled; this could lead to signal clipping. Note that the charge pump clock is derived from internal clock SYSCLK; this may be derived from MCLK directly or else using the FLL output, as determined by the SYSCLK_SRC bit. Under normal circumstances an external clock signal must be present for the charge pump to function. However, the FLL has a free-running mode that does not require an external clock but will generate an internal clock suitable for running the charge pump. The clock division from SYSCLK is handled transparently by the WM8918 without user intervention, as long as SYSCLK and sample rates are set correctly. w PD, Rev 4.1, January 2012 75 WM8918 Production Data Refer to the “Clocking and Sample Rates” section for more detail on the FLL and clocking configuration. The Charge Pump control fields are described in Table 47. REGISTER ADDRESS R98 (62h) BIT LABEL DEFAULT 0 CP_ENA 0 Enable charge-pump digits 0 = disable Charge Pump 0 R104 (68h) DESCRIPTION 1 = enable 0 CP_DYN_PWR Class W (0) 0 Enable dynamic charge pump power control 0 = Charge pump controlled by volume register settings (Class G) 1 = Charge pump controlled by realtime audio level (Class W) Class W is recommended for lowest power consumption Table 47 Charge Pump Control DC SERVO The WM8918 provides four DC servo circuits, two on the headphone outputs HPOUTL and HPOUTR and two on the line outputs LINEOUTL and LINEOUTR, to remove DC offset from these groundreferenced outputs. When enabled, the DC servos ensure that the DC level of these outputs remains within 1mV of ground. Removal of the DC offset is important because any deviation from GND at the output pin will cause current to flow through the load under quiescent conditions, resulting in increased power consumption. Additionally, the presence of DC offsets can result in audible pops and clicks at power up and power down. The recommended usage of the DC Servo is initialised by running the default Start-Up sequence as described in the “Control Write Sequencer” section. The default Start-Up sequence executes a series of DC offset corrections, after which the measured offset correction is maintained on the headphone output channels. If a different usage is required, e.g. if a periodic DC offset correction is required, then the default Start-Up sequence may be modified according to specific requirements. The relevant control fields are described in the following paragraphs and are defined in Table 48. DC SERVO ENABLE AND START-UP The DC Servo circuits are enabled on HPOUTL and HPOUTR by setting DCS_ENA_CHAN_0 and DCS_ENA_CHAN_1 respectively. Similarly, the DC Servo circuits are enabled on LINEOUTL and LINEOUTR by setting DCS_ENA_CHAN_2 and DCS_ENA_CHAN_3 respectively When the DC Servo is enabled, the DC offset correction can be commanded in a number of different ways, including single-shot and periodically recurring events. Writing a logic 1 to DCS_TRIG_STARTUP_n initiates a series of DC offset measurements and applies the necessary correction to the associated output; (‘n’ = 3 for LINEOUTR channel, 2 for LINEOUTL channel, 1 for HPOUTR channel, 0 for HPOUTL channel). On completion, the output will be within 1mV of AGND. This is the DC Servo mode selected by the default Start-Up sequence. Completion of the DC offset correction triggered in this way is indicated by the DCS_STARTUP_COMPLETE field, as described in Table 48. Typically, this operation takes 86ms per channel. Writing a logic 1 to DCS_TRIG_DAC_WR_n causes the DC offset correction to be set to the value contained in the DCS_DAC_WR_VAL_n fields in Registers R73 to R76. This mode is useful if the required offset correction has already been determined and stored; it is faster than the DCS_TRIG_STARTUP_n mode, but relies on the accuracy of the stored settings. Completion of the DC offset correction triggered in this way is indicated by the DCS_DAC_WR_COMPLETE field, as described in Table 48. Typically, this operation takes 2ms per channel. w PD, Rev 4.1, January 2012 76 WM8918 Production Data When using either of the DC Servo options above, the status of the DC offset correction process is indicated by the DCS_CAL_COMPLETE field; this is the logical OR of the DCS_STARTUP_COMPLETE and DCS_DAC_WR_COMPLETE fields. The DC Servo control fields associated with start-up operation are described in Table 48. It is important to note that, to minimise audible pops/clicks, the Start-Up and DAC Write modes of DC Servo operation should be commanded as part of a control sequence which includes muting and shorting of the headphone outputs; a suitable sequence is defined in the default Start-Up sequence. REGISTER ADDRESS R67 (43h) BIT LABEL DEFAULT 3 DCS_ENA_CHAN _3 0 DCS_ENA_CHAN _2 0 DCS_ENA_CHAN _1 0 DCS_ENA_CHAN _0 0 DCS_TRIG_STAR TUP_3 0 DC Servo 0 DESCRIPTION DC Servo enable for LINEOUTR 0 = disabled 1 = enabled 2 DC Servo enable for LINEOUTL 0 = disabled 1 = enabled 1 DC Servo enable for HPOUTR 0 = disabled 1 = enabled 0 DC Servo enable for HPOUTL 0 = disabled 1 = enabled R68 (44h) 7 DC Servo 1 Writing 1 to this bit selects Start-Up DC Servo mode for LINEOUTR. In readback, a value of 1 indicates that the DC Servo Start-Up correction is in progress. 6 DCS_TRIG_STAR TUP_2 0 Writing 1 to this bit selects Start-Up DC Servo mode for LINEOUTL. In readback, a value of 1 indicates that the DC Servo Start-Up correction is in progress. 5 DCS_TRIG_STAR TUP_1 0 Writing 1 to this bit selects Start-Up DC Servo mode for HPOUTR. In readback, a value of 1 indicates that the DC Servo Start-Up correction is in progress. 4 DCS_TRIG_STAR TUP_0 0 Writing 1 to this bit selects Start-Up DC Servo mode for HPOUTL. In readback, a value of 1 indicates that the DC Servo Start-Up correction is in progress. 3 DCS_TRIG_DAC_ WR_3 0 Writing 1 to this bit selects DAC Write DC Servo mode for LINEOUTR. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 2 DCS_TRIG_DAC_ WR_2 0 Writing 1 to this bit selects DAC Write DC Servo mode for LINEOUTL. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 1 DCS_TRIG_DAC_ WR_1 0 Writing 1 to this bit selects DAC Write DC Servo mode for HPOUTR. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. w PD, Rev 4.1, January 2012 77 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT DESCRIPTION 0 DCS_TRIG_DAC_ WR_0 0 Writing 1 to this bit selects DAC Write DC Servo mode for HPOUTL. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. R73 (49h) DC Servo 6 7:0 DCS_DAC_WR_V AL_3 [7:0] 0000 0000 DC Offset value for LINEOUTR in DAC Write DC Servo mode in two's complement format. In readback, the current DC offset value is returned in two's complement format. Two’s complement format: LSB is 0.25mV. Range is +/-32mV R74 (4Ah) DC Servo 7 7:0 DCS_DAC_WR_V AL_2 [7:0] 0000 0000 DC Offset value for LINEOUTL in DAC Write DC Servo mode in two's complement format. In readback, the current DC offset value is returned in two's complement format. Two’s complement format: LSB is 0.25mV. Range is +/-32mV R75 (4Bh) 7:0 DC Servo 8 DCS_DAC_WR_V AL1 [7:0] 0000 0000 DC Offset value for HPOUTR in DAC Write DC Servo mode in two's complement format. In readback, the current DC offset value is returned in two's complement format. Two’s complement format: LSB is 0.25mV. Range is +/-32mV R76 (4Ch) DC Servo 9 7:0 DCS_DAC_WR_V AL0 [7:0] 0000 0000 DC Offset value for HPOUTL in DAC Write DC Servo mode in two's complement format. In readback, the current DC offset value is returned in two's complement format. Two’s complement format: LSB is 0.25mV. Range is +/-32mV w PD, Rev 4.1, January 2012 78 WM8918 Production Data REGISTER ADDRESS R77 (4Dh) BIT LABEL DEFAULT 11:8 DCS_CAL_COMP LETE [3:0] 0000 DC Servo Readback 0 DESCRIPTION DC Servo Complete status [3] - LINEOUTR [2] - LINEOUTL [1] - HPOUTR [0] - HPOUTL 0 = DAC Write or Start-Up DC Servo mode not completed. 1 = DAC Write or Start-Up DC Servo mode complete. 7:4 DCS_DAC_WR_C OMPLETE [3:0] 0000 DC Servo DAC Write status [3] - LINEOUTR [2] - LINEOUTL [1] - HPOUTR [0] - HPOUTL 0 = DAC Write DC Servo mode not completed. 1 = DAC Write DC Servo mode complete. 3:0 DCS_STARTUP_ COMPLETE [3:0] 0000 DC Servo Start-Up status [3] - LINEOUTR [2] - LINEOUTL [1] - HPOUTR [0] - HPOUTL 0 = Start-Up DC Servo mode not completed.. 1 = Start-Up DC Servo mode complete. Table 48 DC Servo Enable and Start-Up Modes DC SERVO ACTIVE MODES The DC Servo modes described above are suitable for initialising the DC offset correction circuit on the Line and Headphone outputs as part of a controlled start-up sequence which is executed before the signal path is fully enabled. Additional modes are available for use whilst the signal path is active; these modes may be of benefit following a large change in signal gain, which can lead to a change in DC offset level. Periodic updates may also be desirable to remove slow drifts in DC offset caused by changes in parameters such as device temperature. The DC Servo circuit is enabled on HPOUTR and HPOUTL by setting DCS_ENA_CHAN_1 and DCS_ENA_CHAN_0 respectively, as described earlier in Table 48. Similarly, the DC Servo circuit is enabled on LINEOUTR and LINEOUTL by setting DCS_ENA_CHAN_3 and DCS_ENA_CHAN_2 respectively. Writing a logic 1 to DCS_TRIG_SINGLE_n initiates a single DC offset measurement and adjustment to the associated output; (‘n’ = 3 for LINEOUTR channel, 2 for LINEOUTL channel, 1 for HPOUTR channel, 0 for HPOUTL channel). This will adjust the DC offset correction on the selected channel by no more than 1LSB (0.25mV). Setting DCS_TIMER_PERIOD_01 or DCS_TIMER_PERIOD_23 to a non-zero value will cause a single DC offset measurement and adjustment to be scheduled on a periodic basis. Periodic rates ranging from every 0.52s to in excess of 2 hours can be selected. w PD, Rev 4.1, January 2012 79 WM8918 Production Data Writing a logic 1 to DCS_TRIG_SERIES_n initiates a series of DC offset measurements and applies the necessary correction to the associated output. The number of DC Servo operations performed is determined by DCS_SERIES_NO_01 or DCS_SERIES_NO_23. A maximum of 128 operations may be selected, though a much lower value will be sufficient in most applications. The DC Servo control fields associated with active modes (suitable for use on a signal path that is in active use) are described in Table 49. REGISTER ADDRESS R68 (44h) BIT LABEL DEFAULT DESCRIPTION 15 DCS_TRIG_SING LE_3 0 Writing 1 to this bit selects a single DC offset correction for LINEOUTR. DC Servo 1 In readback, a value of 1 indicates that the DC Servo single correction is in progress. 14 DCS_TRIG_SING LE_2 0 Writing 1 to this bit selects a single DC offset correction for LINEOUTL. In readback, a value of 1 indicates that the DC Servo single correction is in progress. 13 DCS_TRIG_SING LE_1 0 Writing 1 to this bit selects a single DC offset correction for HPOUTR. In readback, a value of 1 indicates that the DC Servo single correction is in progress. 12 DCS_TRIG_SING LE_0 0 Writing 1 to this bit selects a single DC offset correction for HPOUTL. In readback, a value of 1 indicates that the DC Servo single correction is in progress. 11 DCS_TRIG_SERI ES_3 0 Writing 1 to this bit selects a series of DC offset corrections for LINEOUTR. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 10 DCS_TRIG_SERI ES_2 0 Writing 1 to this bit selects a series of DC offset corrections for LINEOUTL. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 9 DCS_TRIG_SERI ES_1 0 Writing 1 to this bit selects a series of DC offset corrections for HPOUTR. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 8 DCS_TRIG_SERI ES_0 0 Writing 1 to this bit selects a series of DC offset corrections for HPOUTL. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. R71 (47h) DC Servo 4 6:0 DCS_SERIES_N O_23 [6:0] 010_1010 Number of DC Servo updates to perform in a series event for LINEOUTL/LINEOUTR. 0 = 1 updates 1 = 2 updates ... 127 = 128 updates w PD, Rev 4.1, January 2012 80 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT 6:0 DCS_SERIES_N O_01 [6:0] 010 1010 R72 (48h) DC Servo 5 DESCRIPTION Number of DC Servo updates to perform in a series event for HPOUTL/HPOUTR. 0 = 1 updates 1 = 2 updates ... 127 = 128 updates R69 (45h) 11:8 DC Servo 2 DCS_TIMER_PE RIOD_23 [3:0] 1010 Time between periodic updates for LINEOUTL/LINEOUTR. Time is calculated as 0.256s x (2^PERIOD) 0000 = Off 0001 = 0.52s 1010 = 266s (4min 26s) 1111 = 8519s (2hr 22s) 3:0 DCS_TIMER_PE RIOD_01 [3:0] 1010 Time between periodic updates for HPOUTL/HPOUTR. Time is calculated as 0.256s x (2^PERIOD) 0000 = Off 0001 = 0.52s 1010 = 266s (4min 26s) 1111 = 8519s (2hr 22s) Table 49 DC Servo Active Modes DC SERVO READBACK The current DC offset value for each Line and Headphone output channel can be read in two’s complement format from the DCS_DAC_WR_VAL_n [7:0] bit fields in Registers R73, R74, R75 and R76. Note that these values may form the basis of settings that are subsequently used by the DC Servo in DAC Write mode. DIGITAL AUDIO INTERFACE The digital audio interface is used for inputting DAC data to the WM8918 and outputting Digital Microphone data from it. The digital audio interface uses four pins: AIFTXDAT: Digital Microphone data output AIFRXDAT: DAC data input LRCLK: Left/Right data alignment clock BCLK: Bit clock, for synchronisation The clock signals BCLK and LRCLK can be outputs when the WM8918 operates as a master, or inputs when it is a slave (see “Master and Slave Mode Operation”, below). Four different audio data formats are supported: w Left justified Right justified I2S DSP mode PD, Rev 4.1, January 2012 81 WM8918 Production Data All four of these modes are MSB first. They are described in “Audio Data Formats (Normal Mode)”, below. Refer to the “Signal Timing Requirements” section for timing information. Time Division Multiplexing (TDM) is available in all four data format modes. The WM8918 can be programmed to send and receive data in one of two time slots. PCM operation is supported using the DSP mode. MASTER AND SLAVE MODE OPERATION The WM8918 digital audio interface can operate in master or slave mode, as shown in Figure 40 and Figure 41. Figure 40 Master Mode Figure 41 Slave Mode In master mode, BCLK is derived from SYSCLK via a programmable division set by BCLK_DIV. In master mode, LRCLK is derived from BCLK via a programmable division set by LRCLK_RATE. The BCLK input to this divider may be internal or external, allowing mixed master and slave modes. The direction of these signals and the clock frequencies are controlled as described in the “Digital Audio Interface Control” section. BCLK and LRCLK can be enabled as outputs in Slave mode, allowing mixed Master/Slave operation see “Digital Audio Interface Control”. OPERATION WITH TDM Time division multiplexing (TDM) allows multiple devices to transfer data simultaneously on the same bus. The WM8918 supports TDM in master and slave modes for all data formats and word lengths. TDM is enabled and configured using register bits defined in the “Digital Audio Interface Control” section. w PD, Rev 4.1, January 2012 82 WM8918 Production Data BCLK BCLK LRCLK WM8918 WM8918 or Similar CODEC LRCLK Processor WM8918 Processor AIFTXDAT AIFTXDAT AIFRXDAT AIFRXDAT BCLK BCLK LRCLK WM8918 or Similar CODEC AIFTXDAT AIFRXDAT LRCLK AIFTXDAT AIFRXDAT Figure 42 TDM with WM8918 as Master Figure 43 TDM with Other CODEC as Master BCLK LRCLK WM8918 Processor AIFTXDAT AIFRXDAT BCLK WM8918 or Similar CODEC LRCLK AIFTXDAT AIFRXDAT Figure 44 TDM with Processor as Master Note: The WM8918 is a 24-bit device. If the user operates the WM8918 in 32-bit mode then the 8 LSBs will be ignored on the receiving side and not driven on the transmitting side. It is therefore recommended to add a pull-down resistor if necessary to the AIFRXDAT line and the AIFTXDAT line in TDM mode. BCLK FREQUENCY The BCLK frequency is controlled relative to SYSCLK by the BCLK_DIV divider. Internal clock divide and phase control mechanisms ensure that the BCLK and LRCLK edges will occur in a predictable and repeatable position relative to each other and relative to the data for a given combination of DAC sample rate and BCLK_DIV settings. BCLK_DIV is defined in the “Digital Audio Interface Control” section. See also the “Clocking and Sample Rates” section for more information. w PD, Rev 4.1, January 2012 83 WM8918 Production Data AUDIO DATA FORMATS (NORMAL MODE) In Right Justified mode, the LSB is available on the last rising edge of BCLK before a LRCLK transition. All other bits are transmitted before (MSB first). Depending on word length, BCLK frequency and sample rate, there may be unused BCLK cycles after each LRCLK transition. Figure 45 Right Justified Audio Interface (assuming n-bit word length) In Left Justified mode, the MSB is available on the first rising edge of BCLK following a LRCLK transition. The other bits up to the LSB are then transmitted in order. Depending on word length, BCLK frequency and sample rate, there may be unused BCLK cycles before each LRCLK transition. Figure 46 Left Justified Audio Interface (assuming n-bit word length) 2 In I S mode, the MSB is available on the second rising edge of BCLK following a LRCLK transition. The other bits up to the LSB are then transmitted in order. Depending on word length, BCLK frequency and sample rate, there may be unused BCLK cycles between the LSB of one sample and the MSB of the next. Figure 47 I2S Justified Audio Interface (assuming n-bit word length) w PD, Rev 4.1, January 2012 84 WM8918 Production Data st nd In DSP mode, the left channel MSB is available on either the 1 (mode B) or 2 (mode A) rising edge of BCLK (selectable by AIF_LRCLK_INV) following a rising edge of LRCLK. Right channel data immediately follows left channel data. Depending on word length, BCLK frequency and sample rate, there may be unused BCLK cycles between the LSB of the right channel data and the next sample. In device master mode, the LRCLK output will resemble the frame pulse shown in Figure 48 and Figure 49. In device slave mode, Figure 50 and Figure 51, it is possible to use any length of frame pulse less than 1/fs, providing the falling edge of the frame pulse occurs greater than one BCLK period before the rising edge of the next frame pulse. Figure 48 DSP Mode Audio Interface (mode A, AIF_LRCLK_INV=0, Master) Figure 49 DSP Mode Audio Interface (mode B, AIF_LRCLK_INV=1, Master) Figure 50 DSP Mode Audio Interface (mode A, AIF_LRCLK_INV=0, Slave) w PD, Rev 4.1, January 2012 85 WM8918 Production Data Figure 51 DSP Mode Audio Interface (mode B, AIF_LRCLK_INV=1, Slave) PCM operation is supported in DSP interface mode. WM8918 DMIC data that is output on the Left Channel will be read as mono PCM data by the receiving equipment. Mono PCM data received by the WM8918 will be treated as Left Channel data. This data may be routed to the Left/Right DACs as described in the “Digital Mixing” section. AUDIO DATA FORMATS (TDM MODE) TDM is supported in master and slave mode and is enabled by register bits AIFTX_TDM and AIFRX_TDM. All audio interface data formats support time division multiplexing (TDM) for Digital Microphone and DAC data. Two time slots are available (Slot 0 and Slot 1), selected by register bits AIFTX_TDM_CHAN and AIFRX_TDM_CHAN which control time slots for the Digital Microphone data and the DAC data. When TDM is enabled, the AIFTXDAT pin will be tri-stated immediately before and immediately after data transmission, to allow another audio device to drive this signal line for the remainder of the sample period. It is important that two audio devices do not attempt to drive the data pin simultaneously, as this could result in a short circuit. See “Audio Interface Timing” for details of the AIFTXDAT output relative to BCLK signal. Note that it is possible to ensure a gap exists between transmissions by setting the transmitted word length to a value higher than the actual length of the data. For example, if 32-bit word length is selected where only 24-bit data is available, then the WM8918 interface will tri-state after transmission of the 24-bit data; this creates an 8-bit gap after the WM8918’s TDM transmission slot. When TDM is enabled, BCLK frequency must be high enough to allow data from both time slots to be transferred. The relative timing of Slot 0 and Slot 1 depends upon the selected data format as shown in Figure 52 to Figure 56. Figure 52 TDM in Right-Justified Mode w PD, Rev 4.1, January 2012 86 WM8918 Production Data Figure 53 TDM in Left-Justified Mode 2 Figure 54 TDM in I S Mode Figure 55 TDM in DSP Mode A Figure 56 TDM in DSP Mode B w PD, Rev 4.1, January 2012 87 WM8918 Production Data DIGITAL AUDIO INTERFACE CONTROL The register bits controlling audio data format, word length, left/right channel data source and TDM are summarised in Table 50. REGISTER ADDRESS R24 (18h) BIT LABEL DEFAULT 7 AIFTXL_SRC 0 DESCRIPTION Left Digital Audio interface source 0 = Left DMIC data is output on left channel Audio Interface 0 1 = Right DMIC data is output on left channel 6 AIFTXR_SRC 1 Right Digital Audio interface source 0 = Left DMIC data is output on right channel 1 = Right DMIC data is output on right channel 5 AIFRXL_SRC 0 Left DAC Data Source Select 0 = Left DAC outputs left channel data 1 = Left DAC outputs right channel data 4 AIFRXR_SRC 1 Right DAC Data Source Select 0 = Right DAC outputs left channel data 1 = Right DAC outputs right channel data R25 (19h) 13 AIFRX_TDM 0 AIFRX TDM Enable 0 = Normal AIFRXDAT operation Audio Interface 1 1 = TDM enabled on AIFRXDAT 12 AIFRX_TDM_ CHAN 0 AIFTX_TDM 0 AIFRX TDM Channel Select 0 = AIFRXDAT data input on slot 0 1 = AIFRXDAT data input on slot 1 11 AIFTX TDM Enable 0 = Normal AIFTXDAT operation 1 = TDM enabled on AIFTXDAT 10 AIFTX_TDM_ CHAN 0 AIFTX TDM Channel Select 0 = AIFTXDAT outputs data on slot 0 1 = AIFTXDAT output data on slot 1 7 AIF_BCLK_IN V 0 AIF_LRCLK_I NV 0 BCLK Invert 0 = BCLK not inverted 1 = BCLK inverted 4 LRC Polarity / DSP Mode A-B select. Right, left and I2S modes – LRC polarity 0 = Not Inverted 1 = Inverted DSP Mode – Mode A-B select 0 = MSB is available on 2nd BCLK rising edge after LRC rising edge (mode A) 1 = MSB is available on 1st BCLK rising edge after LRC rising edge (mode B) 3:2 1:0 AIF_WL [1:0] AIF_FMT [1:0] 10 Digital Audio Interface Word Length 10 00 = 16 bits 01 = 20 bits 10 = 24 bits 11 = 32 bits Digital Audio Interface Format 00 = Right Justified 01 = Left Justified 10 = I2S 11 = DSP Table 50 Digital Audio Interface Data Control w PD, Rev 4.1, January 2012 88 WM8918 Production Data Note that the WM8918 is a 24-bit device. In 32-bit mode (AIF_WL=11), the 8 LSBs are ignored on the receiving side and not driven on the transmitting side. AUDIO INTERFACE OUTPUT TRI-STATE Register bit AIF_TRIS can be used to tri-state the audio interface pins as described in Table 51. All digital audio interface pins will be tri-stated by this function, regardless of the state of other registers which control these pin configurations. REGISTER ADDRESS R25 (19h) BIT LABEL DEFAULT 8 AIF_TRIS 0 DESCRIPTION Audio Interface Tristate 0 = Audio interface pins operate normally Audio Interface 1 1 = Tristate all audio interface pins Table 51 Digital Audio Interface Tri-State Control BCLK AND LRCLK CONTROL The audio interface can be programmed to operate in master mode or slave mode using the BCLK_DIR and LRCLK_DIR register bits. In master mode, the BCLK and LRCLK signals are generated by the WM8918 when any of the DMICs or DACs is enabled. In slave mode, the BCLK and LRCLK clock outputs are disabled by default to allow another digital audio interface to drive these pins. It is also possible to force the BCLK or LRCLK signals to be output using BCLK_DIR and LRCLK_DIR, allowing mixed master and slave modes. The BCLK_DIR and LRCLK_DIR fields are defined in Table 52. REGISTER ADDRESS R25 (19h) BIT LABEL DEFAULT 6 BCLK_DIR 0 Audio Interface 2 Audio Interface BCLK Direction 0 = BCLK is input Audio Interface 1 R26 (1Ah) DESCRIPTION 1 = BCLK is output 4:0 BCLK_DIV [4:0] 0_0100 BCLK Frequency (Master Mode) 00000 = SYSCLK 00001 = SYSCLK / 1.5 00010 = SYSCLK / 2 00011 = SYSCLK / 3 00100 = SYSCLK / 4 (default) 00101 = SYSCLK / 5 00110 = SYSCLK / 5.5 00111 = SYSCLK / 6 01000 = SYSCLK / 8 01001 = SYSCLK / 10 01010 = SYSCLK / 11 01011 = SYSCLK / 12 01100 = SYSCLK / 16 01101 = SYSCLK / 20 01110 = SYSCLK / 22 01111 = SYSCLK / 24 10000 = SYSCLK / 25 10001 = SYSCLK / 30 10010 = SYSCLK / 32 10011 = SYSCLK / 44 10100 = SYSCLK / 48 w PD, Rev 4.1, January 2012 89 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT R27 (1Bh) 11 LRCLK_DIR 0 DESCRIPTION Audio Interface LRCLK Direction 0 = LRCLK is input Audio Interface 3 1 = LRCLK is output 10:0 LRCLK_RATE [10:0] LRCLK Rate (Master Mode) 000_0100 _0000 LRCLK clock output = BCLK / LRCLK_RATE Integer (LSB = 1) Valid range: 8 to 2047 Table 52 Digital Audio Interface Clock Control COMPANDING The WM8918 supports A-law and -law companding on both transmit (DMIC) and receive (DAC) sides as shown in Table 53. REGISTER ADDRESS R24 (18h) BIT LABEL DEFAULT 3 AIFTX_COMP 0 Audio Interface 0 DESCRIPTION AIFTX Companding Enable 0 = Disabled 1 = Enabled 2 AIFTX_COMPMOD E 0 AIFRX_COMP 0 AIFTX Companding Type 0 = µ-law 1 = A-law 1 AIFRX Companding Enable 0 = Disabled 1 = Enabled 0 AIFRX_COMPMOD E 0 AIFRX Companding Type 0 = µ-law 1 = A-law Table 53 Companding Control Companding involves using a piecewise linear approximation of the following equations (as set out by ITU-T G.711 standard) for data compression: -law (where =255 for the U.S. and Japan): F(x) = ln( 1 + |x|) / ln( 1 + ) -1 ≤ x ≤ 1 A-law (where A=87.6 for Europe): F(x) = A|x| / ( 1 + lnA) x ≤ 1/A F(x) = ( 1 + lnA|x|) / (1 + lnA) 1/A ≤ x ≤ 1 The companded data is also inverted as recommended by the G.711 standard (all 8 bits are inverted for -law, all even data bits are inverted for A-law). The data will be transmitted as the first 8 MSBs of data. Companding converts 13 bits (-law) or 12 bits (A-law) to 8 bits using non-linear quantization. This provides greater precision for low amplitude signals than for high amplitude signals, resulting in a greater usable dynamic range than 8 bit linear quantization. The companded signal is an 8-bit word comprising sign (1 bit), exponent (3 bits) and mantissa (4 bits). 8-bit mode is selected whenever AIFRX_COMP=1 or AIFTX_COMP=1. The use of 8-bit data allows samples to be passed using as few as 8 BCLK cycles per LRCLK frame. When using DSP mode B, 8-bit data words may be transferred consecutively every 8 BCLK cycles. w PD, Rev 4.1, January 2012 90 WM8918 Production Data 8-bit mode (without Companding) may be enabled by setting AIFRX_COMPMODE=1 or AIFTX_COMPMODE=1, when AIFRX_COMP=0 and AIFTX_COMP=0. BIT7 BIT [6:4] BIT [3:0] SIGN EXPONENT MANTISSA Table 54 8-bit Companded Word Composition u-law Companding 1 120 0.9 Companded Output 0.7 80 0.6 0.5 60 0.4 40 0.3 Normalised Output 0.8 100 0.2 20 0.1 0 0 0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1 Normalised Input Figure 57 µ-Law Companding A-law Companding 1 120 0.9 Companded Output 0.7 80 0.6 0.5 60 0.4 40 0.3 Normalised Output 0.8 100 0.2 20 0.1 0 0 0 0.2 0.4 0.6 0.8 1 Normalised Input Figure 58 A-Law Companding w PD, Rev 4.1, January 2012 91 WM8918 Production Data LOOPBACK Setting the LOOPBACK register bit enables digital loopback. When this bit is set, the DMIC digital data output is routed to the DAC digital data input path. The digital audio interface input (AIFRXDAT) is not used when LOOPBACK is enabled. REGISTER ADDRESS R24 (18h) BIT LABEL DEFAULT 8 LOOPBACK 0 Audio Interface 0 DESCRIPTION Digital Loopback Function 0 = No loopback 1 = Loopback enabled (DMIC data output is directly input to DAC data input). Table 55 Loopback Control Note: When the digital sidetone is enabled, DMIC data will also be added to DAC digital data input path within the Digital Mixing circuit. This applies regardless of whether LOOPBACK is enabled. DIGITAL PULL-UP AND PULL-DOWN The WM8918 provides integrated pull-up and pull-down resistors on each of the MCLK, AIFRXDAT, LRCLK and BCLK pins. This provides a flexible capability for interfacing with other devices. Each of the pull-up and pull-down resistors can be configured independently using the register bits described in Table 56. REGISTER ADDRESS R126 (7Eh) BIT LABEL DEFAULT 7 MCLK_PU 0 Digital Pulls DESCRIPTION MCLK pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 6 MCLK_PD 0 MCLK pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled 5 AIFRXDAT_P U 0 AIFRXDAT_P D 0 LRCLK_PU 0 AIFRXDAT pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 4 AIFRXDAT pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled 3 LRCLK pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 2 LRCLK_PD 0 LRCLK pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled 1 BCLK_PU 0 BCLK pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 0 BCLK_PD 0 BCLK pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled Table 56 Digital Audio Interface Pull-Up and Pull-Down Control w PD, Rev 4.1, January 2012 92 WM8918 Production Data CLOCKING AND SAMPLE RATES The internal clocks for the WM8918 are all derived from a common internal clock source, SYSCLK. This clock is the reference for the DACs, DSP core functions, digital audio interface, DC servo control and other internal functions. SYSCLK can either be derived directly from MCLK, or may be generated from a Frequency Locked Loop (FLL) using MCLK, BCLK or LRCLK as a reference. Many commonly-used audio sample rates can be derived directly from typical MCLK frequencies; the FLL provides additional flexibility for a wide range of MCLK frequencies. To avoid audible glitches, all clock configurations must be set up before enabling playback. The FLL can be used to generate a free-running clock in the absence of an external reference source; see “Frequency Locked Loop (FLL)” for further details. The WM8918 supports automatic clocking configuration. The programmable dividers associated with the DACs, DSP core functions and DC servo are configured automatically, with values determined from the CLK_SYS_RATE and SAMPLE_RATE fields. The user must also configure the OPCLK (if required), the TOCLK (if required) and the Digital Audio Interface. Oversample rates of 64fs or 128fs are supported (based on a 48kHz sample rate). A 256kHz clock, supporting a number of internal functions, is derived from SYSCLK. The DC servo control is clocked from SYSCLK. A GPIO Clock, OPCLK, can be derived from SYSCLK and output on a GPIO pin to provide clocking to other devices. This clock is enabled by OPCLK_ENA and controlled by OPCLK_DIV. A slow clock, TOCLK, is used to de-bounce the button/accessory detect inputs, and to set the timeout period for volume updates when zero-cross detect is used. This clock is enabled by TOCLK_ENA and controlled by TOCLK_RATE, TOCLK_RATE_X4 and TOCLK_RATE_DIV16. In master mode, BCLK is derived from SYSCLK via a programmable divider set by BCLK_DIV. In master mode, the LRCLK is derived from BCLK via a programmable divider LRCLK_RATE. The LRCLK can be derived from an internal or external BCLK source, allowing mixed master/slave operation. The control registers associated with Clocking and Sample Rates are shown in Table 57 to Table 61. The overall clocking scheme for the WM8918 is illustrated in Figure 59. w PD, Rev 4.1, January 2012 93 WM8918 Production Data Figure 59 Clocking Overview w PD, Rev 4.1, January 2012 94 WM8918 Production Data SYSCLK CONTROL The SYSCLK_SRC bit is used to select the source for SYSCLK. The source may be either the MCLK input or the FLL output. The MCLK input can be inverted or non-inverted, as selected by the MCLK_INV bit. The selected source may also be adjusted by the MCLK_DIV divider to generate SYSCLK. These register fields are described in Table 57. See “Frequency Locked Loop (FLL)” for more details of the Frequency Locked Loop clock generator. The SYSCLK signal is enabled by register bit CLK_SYS_ENA. This bit should be set to 0 when reconfiguring clock sources. It is not recommended to change SYSCLK_SRC while the CLK_SYS_ENA bit is set. The following operating frequency limits must be observed when configuring SYSCLK. Failure to observe these limits will result in degraded noise performance and/or incorrect DMIC/DAC functionality. SYSCLK 3MHz If DAC_OSR128 = 1 then SYSCLK 6MHz If DAC_MONO = 1, then SYSCLK 64 x fs If DAC_MONO = 0, then SYSCLK 128 x fs If DMICL_ENA = 1 or DMICR_ENA = 1 then SYSCLK 256 x fs Note that DAC Mono mode (DAC_MONO = 1) is only valid when one or other DAC is disabled. If both DACs are enabled, then the minimum SYSCLK for clocking the DACs is 128 x fs. The SYSCLK control register fields are defined in Table 57. REGISTER ADDRESS BIT LABEL DEFAULT R22 (16h) 15 MCLK_INV 0 DESCRIPTION MCLK Invert 0 = MCLK not inverted Clock Rates 2 1 = MCLK inverted 14 SYSCLK_SRC 0 SYSCLK Source Select 0 = MCLK 1 = FLL output 2 CLK_SYS_ENA 0 System Clock enable 0 = Disabled 1 = Enabled R20 (14h) 0 MCLK_DIV Clock Rates 0 0 Enables divide by 2 on MCLK 0 = SYSCLK = MCLK 1 = SYSCLK = MCLK / 2 Table 57 MCLK and SYSCLK Control CONTROL INTERFACE CLOCKING Register map access is possible with or without a Master Clock (MCLK). However, if CLK_SYS_ENA has been set to 1, then a Master Clock must be present for control register Read/Write operations. If CLK_SYS_ENA = 1 and MCLK is not present, then register access will be unsuccessful. (Note that read/write access to register R22, containing CLK_SYS_ENA, is always possible.) If it cannot be assured that MCLK is present when accessing the register map, then it is required to set CLK_SYS_ENA = 0 to ensure correct operation. It is possible to use the WM8918 analogue bypass paths to the differential line outputs (LON/LOP and RON/ROP) without MCLK. Note that MCLK is always required when using HPOUTL, HPOUTR, LINEOUTL or LINEOUTR. w PD, Rev 4.1, January 2012 95 WM8918 Production Data CLOCKING CONFIGURATION The WM8918 supports a wide range of standard audio sample rates from 8kHz to 96kHz. The Automatic Clocking Configuration simplifies the configuration of the clock dividers in the WM8918 by deriving most of the necessary parameters from a minimum number of user registers. The SAMPLE_RATE field selects the sample rate, fs, of the DAC. The CLK_SYS_RATE field must be set according to the ratio of SYSCLK to fs. When these fields are set correctly, the Sample Rate Decoder circuit automatically determines the clocking configuration for all other circuits within the WM8918. A high performance mode of DAC operation can be selected by setting the DAC_OSR128 bit; in 48kHz sample mode, the DAC_OSR128 feature results in 128x oversampling. Audio performance is improved, but power consumption is also increased. REGISTER ADDRESS R33 (21h) BIT LABEL DEFAULT 6 DAC_OSR128 0 DESCRIPTION DAC Oversample Rate Select DAC Digital 1 0 = Low power (normal OSR) R21 (15h) Clock Rates 1 Selects the SYSCLK / fs ratio 1 = High performance (double OSR) 13:10 CLK_SYS_RAT E [3:0] 0011 0000 = 64 0001 = 128 0010 = 192 0011 = 256 0100 = 384 0101 = 512 0110 = 768 0111 = 1024 1000 = 1408 1001 = 1536 2:0 SAMPLE_RATE [2:0] 101 Selects the Sample Rate (fs) 000 = 8kHz 001 = 11.025kHz, 12kHz 010 = 16kHz 011 = 22.05kHz, 24kHz 100 = 32kHz 101 = 44.1kHz, 48kHz 110 to 111 = Reserved Table 58 Automatic Clocking Configuration Control DMIC / DAC CLOCK CONTROL The clocking of the DMIC and DAC circuits is derived from CLK_DSP, which is enabled by CLK_DSP_ENA. CLK_DSP is generated from SYSCLK which is separately enabled, using the register bit CLK_SYS_ENA. Higher performance DAC operation can be achieved by increasing the DAC oversample rate - see Table 58. The DMIC / DAC Clock Control registers are defined in Table 59. REGISTER ADDRESS R22 (16h) BIT LABEL DEFAULT 1 CLK_DSP_ENA 0 Clock Rates 2 DESCRIPTION DSP Clock enable 0 = Disabled 1 = Enabled Table 59 DMIC / DAC Clock Control w PD, Rev 4.1, January 2012 96 WM8918 Production Data OPCLK CONTROL A clock output (OPCLK) derived from SYSCLK may be output on a GPIO pin. This clock is enabled by register bit OPCLK_ENA, and its frequency is controlled by OPCLK_DIV. This output of this clock is also dependent upon the GPIO register settings described under “General Purpose Input/Output (GPIO)”. REGISTER ADDRESS R22 (16h) BIT LABEL DEFAULT 3 OPCLK_ENA 0 Clock Rates 2 DESCRIPTION GPIO Clock Output Enable 0 = disabled 1 = enabled R26 (1Ah) 11:8 OPCLK_DIV [3:0] 0000 Audio Interface 2 GPIO Output Clock Divider 0000 = SYSCLK 0001 = SYSCLK / 2 0010 = SYSCLK / 3 0011 = SYSCLK / 4 0100 = SYSCLK / 5.5 0101 = SYSCLK / 6 0110 = SYSCLK / 8 0111 = SYSCLK / 12 1000 = SYSCLK / 16 1001 to 1111 = Reserved Table 60 OPCLK Control TOCLK CONTROL A slow clock (TOCLK) is derived from the internally generated 256kHz clock to enable input debouncing and volume update timeout functions. This clock is enabled by register bit TOCLK_ENA, and its frequency is controlled by TOCLK_RATE and TOCLK_RATE_X4, as described in Table 61. REGISTER ADDRESS R22 (16h) BIT LABEL DEFAULT 12 TOCLK_RATE 0 Clock Rates 2 DESCRIPTION TOCLK Rate Divider (/2) 0=f/2 1=f/1 0 TOCLK_ENA 0 Zero Cross timeout enable 0 = Disabled 1 = Enabled R20 (14h) Clock Rates 0 14 TOCLK_RATE_ DIV16 0 TOCLK_RATE_ X4 0 TOCLK Rate Divider (/16) 0=f/1 1 = f / 16 13 TOCLK Rate Multiplier 0=fx1 1=fx4 Table 61 TOCLK Control w PD, Rev 4.1, January 2012 97 WM8918 Production Data A list of possible TOCLK rates is provided in Table 62. TOCLK TOCLK_RATE TOCLK_RATE_X4 TOCLK_RATE_DIV16 FREQ (Hz) PERIOD (ms) 1 1 0 1000 1 0 1 0 500 2 1 0 0 250 4 0 0 0 125 8 1 1 1 62.5 16 0 1 1 31.25 32 1 0 1 15.625 64 0 0 1 7.8125 128 Table 62 TOCLK Rates DAC OPERATION AT 88.2K / 96K The WM8918 supports DAC operation at 88.2kHz and 96kHz sample rates. This section details specific conditions applicable to these operating modes. Note that Digital Microphone operation at 88.2kHz or 96kHz is not possible. For DAC operation at 88.2kHz or 96kHz sample rates, the available clocking configurations are detailed in Table 63. DAC operation at these sample rates is achieved by setting the SAMPLE_RATE field to half the required sample rate (eg. select 48kHz for 96kHz mode). The Digital Microphone DSP must be disabled (DMICL_ENA = 0 and DMICR_ENA = 0). Note that the DAC_OSR128 and EQ_ENA TM registers must be set to 0. ReTune Mobile can not be used during 88.2kHz or 96kHz operation. The SYSCLK frequency is derived from MCLK. The maximum MCLK frequency is defined in the “Signal Timing Requirements” section. SAMPLE RATE 88.2kHz REGISTER CONFIGURATION SAMPLE_RATE = 101 CLOCKING RATIO SYSCLK = 128 x fs CLK_SYS_RATE = 0001 (SYSCLK / fs = 128) BCLK_DIV = 00010 LRCLK_RATE = 040h DAC_OSR128 = 0 EQ_ENA = 0 96kHz SAMPLE_RATE = 101 SYSCLK = 128 x fs CLK_SYS_RATE = 0001 (SYSCLK / fs = 128) BCLK_DIV = 00010 LRCLK_RATE = 040h DAC_OSR128 = 0 EQ_ENA = 0 Table 63 DAC Operation at 88.2kHz and 96kHz Sample Rates w PD, Rev 4.1, January 2012 98 WM8918 Production Data FREQUENCY LOCKED LOOP (FLL) The integrated FLL can be used to generate SYSCLK from a wide variety of different reference sources and frequencies. The FLL can use either MCLK, BCLK or LRCLK as its reference, which may be a high frequency (eg. 12.288MHz) or low frequency (eg. 32,768kHz) reference. The FLL is tolerant of jitter and may be used to generate a stable SYSCLK from a less stable input signal. The FLL characteristics are summarised in “Electrical Characteristics”. Note that the FLL can be used to generate a free-running clock in the absence of an external reference source. This is described in the “Free-Running FLL Clock” section below. The FLL is enabled using the FLL_ENA register bit. Note that, when changing FLL settings, it is recommended that the digital circuit be disabled via FLL_ENA and then re-enabled after the other register settings have been updated. When changing the input reference frequency FREF, it is recommended the FLL be reset by setting FLL_ENA to 0. The FLL_CLK_REF_SRC field allows MCLK, BCLK or LRCLK to be selected as the input reference clock. The field FLL_CLK_REF_DIV provides the option to divide the input reference (MCLK, BCLK or LRCLK) by 1, 2, 4 or 8. This field should be set to bring the reference down to 13.5MHz or below. For best performance, it is recommended that the highest possible frequency - within the 13.5MHz limit should be selected. The field FLL_CTRL_RATE controls internal functions within the FLL; it is recommended that only the default setting be used for this parameter. FLL_GAIN controls the internal loop gain and should be set to the recommended value quoted in Table 66. The FLL output frequency is directly determined from FLL_FRATIO, FLL_OUTDIV and the real number represented by FLL_N and FLL_K. The field FLL_N is an integer (LSB = 1); FLL_K is the fractional portion of the number (MSB = 0.5). The fractional portion is only valid in Fractional Mode when enabled by the field FLL_FRACN_ENA. It is recommended that FLL_FRACN_ENA is enabled at all times. Power consumption in the FLL is reduced in integer mode; however, the performance may also be reduced, with increased noise or jitter on the output. If low power consumption is required, then FLL settings must be chosen when N.K is an integer (ie. FLL_K = 0). In this case, the fractional mode can be disabled by setting FLL_FRACN_ENA = 0. For best FLL performance, a non-integer value of N.K is required. In this case, the fractional mode must be enabled by setting FLL_FRACN_ENA = 1. The FLL settings must be adjusted, if necessary, to produce a non-integer value of N.K. The FLL output frequency is generated according to the following equation: FOUT = (FVCO / FLL_OUTDIV) The FLL operating frequency, FVCO is set according to the following equation: FVCO = (FREF x N.K x FLL_FRATIO) See Table 66 for the coding of the FLL_OUTDIV and FLL_FRATIO fields. FREF is the input frequency, as determined by FLL_CLK_REF_DIV. FVCO must be in the range 90-100 MHz. Frequencies outside this range cannot be supported. Note that the output frequencies that do not lie within the ranges quoted above cannot be guaranteed across the full range of device operating temperatures. w PD, Rev 4.1, January 2012 99 WM8918 Production Data In order to follow the above requirements for FVCO, the value of FLL_OUTDIV should be selected according to the desired output FOUT. The divider, FLL_OUTDIV, must be set so that FVCO is in the range 90-100MHz. The available divisions are integers from 4 to 64. Some typical settings of FLL_OUTDIV are noted in Table 64. OUTPUT FREQUENCY FOUT FLL_OUTDIV 2.8125 MHz - 3.125 MHz 011111 (divide by 32) 3.75 MHz - 4.1667 MHz 011000 (divide by 24) 5.625 MHz - 6.25 MHz 001111 (divide by 16) 11.25 MHz - 12.5 MHz 000111 (divide by 8) 18 MHz - 20 MHz 000100 (divide by 5) 22.5 MHz - 25 MHz 000011 (divide by 4) Table 64 Selection of FLL_OUTDIV The value of FLL_FRATIO should be selected as described in Table 65. FLL_FRATIO REFERENCE FREQUENCY FREF 1MHz - 13.5MHz 0h (divide by 1) 256kHz - 1MHz 1h (divide by 2) 128kHz - 256kHz 2h (divide by 4) 64kHz - 128kHz 3h (divide by 8) Less than 64kHz 4h (divide by 16) Table 65 Selection of FLL_FRATIO In order to determine the remaining FLL parameters, the FLL operating frequency, FVCO, must be calculated, as given by the following equation: FVCO = (FOUT x FLL_OUTDIV) The value of FLL_N and FLL_K can then be determined as follows: N.K = FVCO / (FLL_FRATIO x FREF) See Table 66 for the coding of the FLL_OUTDIV and FLL_FRATIO fields. Note that FREF is the input frequency, after division by FLL_CLK_REF_DIV, where applicable. In FLL Fractional Mode, the fractional portion of the N.K multiplier is held in the FLL_K register field. This field is coded as a fixed point quantity, where the MSB has a weighting of 0.5. Note that, if 16 desired, the value of this field may be calculated by multiplying K by 2 and treating FLL_K as an integer value, as illustrated in the following example: If N.K = 8.192, then K = 0.192 16 Multiplying K by 2 gives 0.192 x 65536 = 12582.912 (decimal) Apply rounding to the nearest integer = 12583 (decimal) = 3127 (hex) For best performance, FLL Fractional Mode should always be used. Therefore, if the calculations yield an integer value of N.K, then it is recommended to adjust FLL_OUTDIV in order to obtain a noninteger value of N.K. Care must always be taken to ensure that the FLL operating frequency, FVCO, is within its recommended limits of 90-100 MHz. The register fields that control the FLL are described in Table 66. Example settings for a variety of reference frequencies and output frequencies are shown in Table 68. w PD, Rev 4.1, January 2012 100 WM8918 Production Data REGISTER ADDRESS R116 (74h) BIT LABEL DEFAULT 2 FLL_FRACN_E NA 0 FLL Control 1 DESCRIPTION FLL Fractional enable 0 = Integer Mode 1 = Fractional Mode Fractional Mode (FLL_FRACN_ENA=1) is recommended in all cases 1 FLL_OSC_ENA 0 FLL Oscillator enable 0 = Disabled 1 = Enabled FLL_OSC_ENA must be enabled before enabling FLL_ENA. Note that this field is required for freerunning FLL modes only. 0 FLL_ENA 0 FLL Enable 0 = Disabled 1 = Enabled FLL_OSC_ENA must be enabled before enabling FLL_ENA. R117 (75h) 13:8 FLL Control 2 FLL_OUTDIV [5:0] 00_0000 FLL FOUT clock divider 00_0000 = Reserved 00_0001 = Reserved 00_0010 = Reserved 00_0011 = 4 00_0100 = 5 00_0101 = 6 … 11_1110 = 63 11_1111 = 64 (FOUT = FVCO / FLL_OUTDIV) 6:4 FLL_CTRL_RAT E [2:0] 000 Frequency of the FLL control block 000 = FVCO / 1 (Recommended value) 001 = FVCO / 2 010 = FVCO / 3 011 = FVCO / 4 100 = FVCO / 5 101 = FVCO / 6 110 = FVCO / 7 111 = FVCO / 8 Recommended that these are not changed from default. w PD, Rev 4.1, January 2012 101 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT 2:0 FLL_FRATIO [2:0] 111 DESCRIPTION FVCO clock divider 000 = divide by 1 001 = divide by 2 010 = divide by 4 011 = divide by 8 1XX = divide by 16 000 recommended for FREF > 1MHz 100 recommended for FREF < 64kHz R118 (76h) 15:0 FLL_K [15:0] 0000h R119 (77h) Fractional multiply for FREF (MSB = 0.5) FLL Control 3 14:5 FLL_N [9:0] 177h FLL Control 4 Integer multiply for FREF (LSB = 1) 3:0 FLL_GAIN [3:0] 0h Gain applied to error 0000 = x 1 (Recommended value) 0001 = x 2 0010 = x 4 0011 = x 8 0100 = x 16 0101 = x 32 0110 = x 64 0111 = x 128 1000 = x 256 Recommended that these are not changed from default. R120 (78h) 4:3 FLL Control 5 FLL_CLK_REF_ DIV [1:0] 00 FLL Clock Reference Divider 00 = MCLK / 1 01 = MCLK / 2 10 = MCLK / 4 11 = MCLK / 8 MCLK (or other input reference) must be divided down to <=13.5MHz. For lower power operation, the reference clock can be divided down further if desired. 1:0 FLL_CLK_REF_ SRC [1:0] 00 FLL Clock source 00 = MCLK 01 = BCLK 10 = LRCLK 11 = Reserved Table 66 FLL Register Map w PD, Rev 4.1, January 2012 102 WM8918 Production Data FREE-RUNNING FLL CLOCK The FLL can generate a clock signal even when no external reference is available. However, it should be noted that the accuracy of this clock is reduced, and a reference source should always be used where possible. Note that, in free-running mode, the FLL is not sufficiently accurate for hi-fi DAC applications. However, the free-running mode is suitable for clocking most other functions, including the Write Sequencer, Charge Pump, DC Servo and Class W output driver. If an accurate reference clock is available at FLL start-up, then the FLL should be configured as described above. The FLL will continue to generate a stable output clock after the reference input is stopped or disconnected. If no reference clock is available at the time of starting up the FLL, then an internal clock frequency of approximately 12MHz can be generated by enabling the FLL Analogue Oscillator using the FLL_OSC_ENA register bit, and setting FOUT clock divider to divide by 8 (FLL_OUTDIV = 07h), as defined in Table 66. Under recommended operating conditions, the FLL output may be forced to approximately 12MHz by then enabling the FLL_FRC_NCO bit and setting FLL_FRC_NCO_VAL to 19h (see Table 67). The resultant SYSCLK delivers the required clock frequencies for the Class W output driver, DC Servo, Charge Pump and other functions. Note that the value of FLL_FRC_NCO_VAL may be adjusted to control FOUT, but care should be taken to maintain the correct relationship between SYSCLK and the aforementioned functional blocks. REGISTER ADDRESS R248 (F8h) BIT LABEL DEFAULT 5:0 FLL_FRC_NCO_ VAL [5:0] 01_1001 FLL NCO Test 1 DESCRIPTION FLL Forced oscillator value Valid range is 000000 to 111111 0x19h (011001) = 12MHz approx (Note that this field is required for free-running FLL modes only) R247 (F7h) 0 FLL_FRC_NCO FLL NCO Test 0 0 FLL Forced control select 0 = Normal 1 = FLL oscillator controlled by FLL_FRC_NCO_VAL (Note that this field is required for free-running FLL modes only) Table 67 FLL Free-Running Mode In both cases described above, the FLL must be selected as the SYSCLK source by setting SYSCLK_SRC (see Table 57). Note that, in the absence of any reference clock, the FLL output is subject to a very wide tolerance. See “Electrical Characteristics” for details of the FLL accuracy. GPIO OUTPUTS FROM FLL The WM8918 has an internal signal which indicates whether the FLL Lock has been achieved. The FLL Lock status is an input to the Interrupt control circuit and can be used to trigger an Interrupt event - see “Interrupts”. The FLL Lock signal can be output directly on a GPIO pin as an external indication of FLL Lock. See “General Purpose Input/Output (GPIO)” for details of how to configure a GPIO pin to output the FLL Lock signal. The FLL Clock can be output directly on a GPIO pin as a clock signal for other circuits. Note that the FLL Clock may be output even if the FLL is not selected as the WM8918 SYSCLK source. The clocking configuration is illustrated in Figure 59. See “General Purpose Input/Output (GPIO)” for details of how to configure a GPIO pin to output the FLL Clock. w PD, Rev 4.1, January 2012 103 WM8918 Production Data EXAMPLE FLL CALCULATION To generate 12.288 MHz output (FOUT) from a 12.000 MHz reference clock (FREF): w Set FLL_CLK_REF_DIV in order to generate FREF <=13.5MHz: FLL_CLK_REF_DIV = 00 (divide by 1) Set FLL_CTRL_RATE to the recommended setting: FLL_CTRL_RATE = 000 (divide by 1) Set FLL_GAIN to the recommended setting: FLL_GAIN = 0000 (multiply by 1) Set FLL_OUTDIV for the required output frequency as shown in Table 64:FOUT = 12.288 MHz, therefore FLL_OUTDIV = 07h (divide by 8) Set FLL_FRATIO for the given reference frequency as shown in Table 65: FREF = 12MHz, therefore FLL_FRATIO = 0h (divide by 1) Calculate FVCO as given by FVCO = FOUT x FLL_OUTDIV:FVCO = 12.288 x 8 = 98.304MHz Calculate N.K as given by N.K = FVCO / (FLL_FRATIO x FREF): N.K = 98.304 / (1 x 12) = 8.192 Determine FLL_N and FLL_K from the integer and fractional portions of N.K:FLL_N is 8. FLL_K is 0.192 Confirm that N.K is a fractional quantity and set FLL_FRACN_ENA: N.K is fractional. Set FLL_FRACN_ENA = 1. Note that, if N.K is an integer, then an alternative value of FLL_FRATIO should be selected in order to produce a fractional value of N.K. PD, Rev 4.1, January 2012 104 WM8918 Production Data EXAMPLE FLL SETTINGS Table 68 provides example FLL settings for generating common SYSCLK frequencies from a variety of low and high frequency reference inputs. FREF 32.768 kHz 32.768 kHz 32.768 kHz 48 kHz 12.000 MHz 12.000 MHz 12.288 MHz 12.288 MHz 13.000 MHz 13.000 MHz 19.200 MHz 19.200 MHz FOUT 12.288 MHz FLL_CLK_ REF_DIV FVCO FLL_N FLL_K FLL_ FRATIO FLL_ OUTDIV Divide by 1 98.304 187 0.5 16 8 (0h) MHz (0BBh) (8000h) (4h) (7h) 11.288576 MHz Divide by 1 90.308608 344 0.5 8 8 (0h) MHz (158h) (8000h) (3h) (7h) 11.2896 MHz Divide by 1 90.3168 344 0.53125 8 8 (0h) MHz (158h) (8800h) (3h) (7h) 12.288 MHz 12.288 MHz 11.289597 MHz 12.288 MHz Divide by 1 98.304 256 0 8 8 (0h) MHz (100h) (0000h) (3h) (7h) Divide by 1 98.3040 8 0.192 1 8 (0h) MHz (008h) (3127h) (0h) (7h) Divide by 1 90.3168 7 0.526398 1 8 (0h) MHz (007h) (86C2h) (0h) (7h) Divide by 1 98.304 8 0 1 8 (0h) MHz (008h) (0000h) (0h) (7h) 11.2896 MHz Divide by 1 90.3168 7 0.35 1 8 (0h) MHz (007h) (599Ah) (0h) (7h) 12.287990 MHz Divide by 1 98.3040 7 0.56184 1 8 (0h) MHz (007h) (8FD5h) (0h) (7h) 11.289606 MHz Divide by 1 90.3168 6 0.94745 1 8 (0h) MHz (006h) (F28Ch) (0h) (7h) 12.287988 MHz Divide by 2 98.3039 5 0.119995 1 8 (1h) MHz (005h) (1EB8h) (0h) (7h) 11.289588 MHz Divide by 2 90.3168 4 0.703995 1 8 (1h) MHz (004h) (B439h) (0h) (7h) FLL_ FRACN _ENA 1 1 1 0 1 1 0 1 1 1 1 1 Table 68 Example FLL Settings w PD, Rev 4.1, January 2012 105 WM8918 Production Data GENERAL PURPOSE INPUT/OUTPUT (GPIO) The WM8918 provides two multi-function pins which can be configured to provide a number of different functions. These are digital input/output pins on the DBVDD power domain. The GPIO pins are: IRQ/GPIO1 BCLK/GPIO4 Each general purpose I/O pin can be configured to be a GPIO input or configured as one of a number of output functions. Signal de-bouncing can be selected on GPIO input pins for use with jack/button detect applications. Table 69 lists the functions that are available on each of the GPIO pins. GPIO PINS GPIO Pin Function GPIO input IRQ / GPIO1 BCLK / GPIO4 Yes Yes (including jack/button detect) GPIO output Yes Yes BCLK No Yes Interrupt (IRQ) Yes Yes MICBIAS current detect Yes Yes MICBIAS short-circuit detect Yes Yes Digital microphone interface Yes Yes FLL Lock output Yes Yes FLL Clock output Yes Yes (DMIC clock output) Table 69 GPIO Functions Available IRQ/GPIO1 The IRQ/GPIO1 pin is configured using the register bits described in Table 70. By default, this pin is IRQ output with pull-down resistor enabled. REGISTER ADDRESS BIT LABEL DEFAULT R121 (79h) GPIO 5 GPIO1_PU 0 DESCRIPTION GPIO1 pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled Control 1 4 GPIO1_PD 1 GPIO1 pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled 3:0 GPIO1_SEL [3:0] 0100 GPIO1 Function Select 0000 = Input pin 0001 = Clock output (f=SYSCLK/OPCLKDIV) 0010 = Logic '0' 0011 = Logic '1' 0100 = IRQ (default) 0101 = FLL Lock 0110 = Mic Detect 0111 = Mic Short 1000 = DMIC clock out 1001 = FLL Clock Output 1010 to 1111 = Reserved Table 70 IRQ/GPIO1 Control w PD, Rev 4.1, January 2012 106 WM8918 Production Data BCLK/GPIO4 The BCLK/GPIO4 pin is configured using the register bits described in Table 71. By default, this pin provides the BCLK function associated with the Digital Audio Interface. The BCLK function can operate in slave mode (BCLK input) or in master mode (BCLK output), depending on the BCLK_DIR register bit as described in the “Digital Audio Interface” section. It is possible to configure the BCLK/GPIO4 pin to provide various GPIO functions; in this case, the BCLK function is provided using the MCLK pin. Note that the BCLK function is always in slave mode (BCLK input) in this mode. To select the GPIO4 functions, it is required to set BCLK_DIR = 0 (see Table 52) and to set GPIO_BCLK_MODE_ENA = 1 (see Table 71 below). In this configuration, the MCLK input is used as the bit-clock (BCLK) for the Digital Audio Interface. When the BCLK/GPIO4 pin is configured as GPIO4, then the pin function is determined by the GPIO_BCLK_SEL register field. REGISTER ADDRESS BIT LABEL DEFAULT R124 (7Ch) GPIO 7 GPIO_BCLK_MODE_ ENA 0 DESCRIPTION Selects BCLK/GPIO4 pin function 0 = BCLK/GPIO4 is used as BCLK 1 = BCLK/GPIO4 is used as GPIO. MCLK provides the BCLK in the AIF in this mode. Control 4 3:0 GPIO_BCLK_SEL [3:0] 0000 GPIO_BCLK function select: 0000 = Input Pin (default) 0001 = Clock output (f=SYSCLK/OPCLKDIV) 0010 = Logic '0' 0011 = Logic '1' 0100 = IRQ 0101 = FLL Lock 0110 = Mic Detect 0111 = Mic Short 1000 = DMIC clock out 1001 = FLL Clock Output 1010 to 1111 = Reserved Table 71 BCLK/GPIO4 Control w PD, Rev 4.1, January 2012 107 WM8918 Production Data INTERRUPTS The Interrupt Controller has multiple inputs; these include the GPIO input pins and the MICBIAS current detection circuits. Any combination of these inputs can be used to trigger an Interrupt (IRQ) event. WM8918 interrupt events may be triggered in response to external GPIO inputs, FLL Lock status, MICBIAS status or Write Sequencer status. Note that the GPIO inputs (including GPI7 and GPI8) are only supported as interrupt events when the respective pin is configured as a GPIO input. There is an Interrupt Status field associated with each of the IRQ inputs. These are contained in the Interrupt Status Register (R127), as described in Table 72. The status of the IRQ inputs can be read from this register at any time, or in response to the Interrupt Output being signalled via a GPIO pin. Individual mask bits can select or deselect different functions from the Interrupt controller. These are listed within the Interrupt Status Mask register (R128), as described in Table 73. Note that the Interrupt Status fields remain valid, even when masked, but the masked bits will not cause the Interrupt (IRQ) output to be asserted. The Interrupt (IRQ) output represents the logical ‘OR’ of all unmasked IRQ inputs. The bits within the Interrupt Status register (R127) are latching fields and, once set, are not reset until a ‘1’ is written to the respective register bit in the Interrupt Status Register. The Interrupt (IRQ) output is not reset until each of the unmasked IRQ inputs has been reset. Each of the IRQ inputs can be individually inverted in the Interrupt function, enabling either active high or active low behaviour on each IRQ input. The polarity inversion is controlled using the bits contained in the Interrupt Polarity register (R129). Each of the IRQ inputs can be debounced to ensure that spikes and transient glitches do not assert the Interrupt Output. This is selected using the bits contained in the Interrupt Debounce Register (R130). The WM8918 Interrupt Controller circuit is illustrated in Figure 60. The associated control fields are described in Table 72 through to Table 75. Figure 60 Interrupt Controller w PD, Rev 4.1, January 2012 108 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT DESCRIPTION R127 (7Fh) 10 IRQ 0 Interrupt Status Logical OR of all other interrupt flags 9 GPIO_BCLK_EINT 0 GPIO4 interrupt 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 8 WSEQ_EINT Write Sequence interrupt 0 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written. Note that the read value of WSEQ_EINT is not valid whilst the Write Sequencer is Busy 5 GPIO1_EINT GPIO1 interrupt 0 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 4 GPI8_EINT GPI8 interrupt 0 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 3 GPI7_EINT GPI7 interrupt 0 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 2 FLL_LOCK_EINT FLL Lock interrupt 0 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 1 MIC_SHRT_EINT MICBIAS short circuit interrupt 0 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 0 MIC_DET_EINT MICBIAS current detect interrupt 0 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written Table 72 Interrupt Status Registers REGISTER ADDRESS BIT LABEL DEFAULT R128 (80h) Interrupt Status Mask 9 IM_GPIO_BCLK_EINT 1 DESCRIPTION GPIO4 interrupt mask 0 = do not mask interrupt 1 = mask interrupt 8 IM_WSEQ_EINT 1 Write sequencer interrupt mask 0 = do not mask interrupt 1 = mask interrupt 5 IM_GPIO1_EINT 1 GPIO1 interrupt mask 0 = do not mask interrupt 1 = mask interrupt w PD, Rev 4.1, January 2012 109 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT 4 IM_GPI8_EINT 1 DESCRIPTION GPI8 interrupt mask 0 = do not mask interrupt 1 = mask interrupt 3 IM_GPI7_EINT 1 GPI7 interrupt mask 0 = do not mask interrupt 1 = mask interrupt 2 IM_FLL_LOCK_EINT 1 FLL Lock interrupt mask 0 = do not mask interrupt 1 = mask interrupt 1 IM_MIC_SHRT_EINT 1 MICBIAS short circuit interrupt mask 0 = do not mask interrupt 1 = mask interrupt 0 IM_MIC_DET_EINT 1 MICBIAS current detect interrupt mask 0 = do not mask interrupt 1 = mask interrupt Table 73 Interrupt Mask Registers REGISTER ADDRESS R129 (81h) Interrupt Polarity BIT LABEL DEFAULT 9 GPIO_BCLK_EINT_POL 0 DESCRIPTION GPIO4 interrupt polarity 0 = active high 1 = active low 8 WSEQ_EINT_POL 0 Write Sequencer interrupt polarity 0 = active high (interrupt is triggered when WSEQ is busy) 1 = active low (interrupt is triggered when WSEQ is idle) 5 GPIO1_EINT_POL 0 GPIO1 interrupt polarity 0 = active high 1 = active low 4 GPI8_EINT_POL 0 GPI8 interrupt polarity 0 = active high 1 = active low 3 GPI7_EINT_POL 0 GPI7 interrupt polarity 0 = active high 1 = active low 2 FLL_LOCK_EINT_POL 0 FLL Lock interrupt polarity 0 = active high (interrupt is triggered when FLL Lock is reached) 1 = active low (interrupt is triggered when FLL is not locked) 1 MIC_SHRT_EINT_POL 0 MICBIAS short circuit interrupt polarity 0 = active high 1 = active low w PD, Rev 4.1, January 2012 110 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT 0 MIC_DET_EINT_POL 0 DESCRIPTION MICBIAS current detect interrupt polarity 0 = active high 1 = active low Table 74 Interrupt Polarity Registers REGISTER ADDRESS BIT LABEL DEFAULT R130 (82h) Interrupt Debounce 9 GPIO_BCLK_EINT_DB 0 DESCRIPTION GPIO4 interrupt debounce 0 = disabled 1 = enabled 8 WSEQ_EINT_DB 0 Write Sequencer interrupt debounce enable 0 = disabled 1 = enabled 5 GPIO1_EINT_DB 0 GPIO1 input debounce 0 = disabled 1 = enabled 4 GPI8_EINT_DB 0 GPI8 input debounce 0 = disabled 1 = enabled 3 GPI7_EINT_DB 0 GPI7 input debounce 0 = disabled 1 = enabled 2 FLL_LOCK_EINT_DB 0 FLL Lock debounce 0 = disabled 1 = enabled 1 MIC_SHRT_EINT_DB 0 MICBIAS short circuit interrupt debounce 0 = disabled 1 = enabled 0 MIC_DET_EINT_DB 0 MICBIAS current detect interrupt debounce 0 = disabled 1 = enabled Table 75 Interrupt Debounce Registers w PD, Rev 4.1, January 2012 111 WM8918 Production Data USING IN1L AND IN1R AS INTERRUPT INPUTS IN1L pin has three input functions. Analogue audio input Digital microphone input (DMICDAT1) Digital interrupt input (GPI7) IN1R pin has three input functions. Analogue audio input Digital microphone input (DMICDAT2) Digital interrupt input (GPI8) To use these pins as digital interrupt inputs, they must be enabled using the GPI7_ENA and GPI8_ENA bits as described in Table 76. REGISTER ADDRESS R124 (7Ch) BIT LABEL DEFAULT 9 GPI7_ENA 0 DESCRIPTION GPI7 input enable 0 = disabled GPIO Control 4 1 = enabled 8 GPI8_ENA 0 GPI8 input enable 0 = disabled 1 = enabled Table 76 Enabling IN1L and IN1R as Interrupts GPI7 and GPI8 w PD, Rev 4.1, January 2012 112 WM8918 Production Data CONTROL INTERFACE The WM8918 is controlled by writing to registers through a 2-wire serial control interface. Readback is available for all registers, including Chip ID, power management status and GPIO status. Note that, if it cannot be assured that MCLK is present when accessing the register map, then it is required to set CLK_SYS_ENA = 0 to ensure correct operation. See “Clocking and Sample Rates” for details of CLK_SYS_ENA. The WM8918 is a slave device on the control interface; SCLK is a clock input, while SDA is a bidirectional data pin. To allow arbitration of multiple slaves (and/or multiple masters) on the same interface, the WM8918 transmits logic 1 by tri-stating the SDA pin, rather than pulling it high. An external pull-up resistor is required to pull the SDA line high so that the logic 1 can be recognised by the master. In order to allow many devices to share a single 2-wire control bus, every device on the bus has a unique 8-bit device ID (this is not the same as the 8-bit address of each register in the WM8918). The WM8918 device ID is 0011 0100 (34h). The LSB of the device ID is the Read/Write bit; this bit is set to logic 1 for “Read” and logic 0 for “Write”. The WM8918 operates as a slave device only. The controller indicates the start of data transfer with a high to low transition on SDA while SCLK remains high. This indicates that a device ID, register address and data will follow. The WM8918 responds to the start condition and shifts in the next eight bits on SDA (8-bit device ID including Read/Write bit, MSB first). If the device ID received matches the device ID of the WM8918, then the WM8918 responds by pulling SDA low on the next clock pulse (ACK). If the device ID is not recognised or the R/W bit is set incorrectly, the WM8918 returns to the idle condition and waits for a new start condition and valid address. If the device ID matches the device ID of the WM8918, the data transfer continues as described below. The controller indicates the end of data transfer with a low to high transition on SDA while SCLK remains high. After receiving a complete address and data sequence the WM8918 returns to the idle state and waits for another start condition. If a start or stop condition is detected out of sequence at any point during data transfer (i.e. SDA changes while SCLK is high), the device returns to the idle condition. The WM8918 supports the following read and write operations: Single write Single read Multiple write using auto-increment Multiple read using auto-increment The sequence of signals associated with a single register write operation is illustrated in Figure 61. Figure 61 Control Interface Register Write The sequence of signals associated with a single register read operation is illustrated in Figure 62. w PD, Rev 4.1, January 2012 113 WM8918 Production Data Figure 62 Control Interface Register Read The Control Interface also supports other register operations, as listed above. The interface protocol for these operations is summarised below. The terminology used in the following figures is detailed in Table 77. Note that multiple write and multiple read operations are supported using the auto-increment mode. This feature enables the host processor to access sequential blocks of the data in the WM8918 register map faster than is possible with single register operations. TERMINOLOGY DESCRIPTION S Start Condition Sr Repeated start A Acknowledge (SDA Low) ¯¯ A Not Acknowledge (SDA High) P Stop Condition R/W ¯¯ ReadNotWrite 0 = Write 1 = Read [White field] Data flow from bus master to WM8918 [Grey field] Data flow from WM8918 to bus master Table 77 Control Interface Terminology Figure 63 Single Register Write to Specified Address Figure 64 Single Register Read from Specified Address Figure 65 Multiple Register Write to Specified Address using Auto-increment w PD, Rev 4.1, January 2012 114 WM8918 Production Data Read from 'Register Address' S Device ID RW A Register Address A Sr Device ID (0) A MSByte Data 0 A LSByte Data 0 A (1) Read from 'Last Register Address+N-1' A RW MSByte Data N-1 A LSByte Data N-1 Read from 'Last Register Address+N' A MSByte Data N A LSByte Data N A P Figure 66 Multiple Register Read from Specified Address using Auto-increment Figure 67 Multiple Register Read from Last Address using Auto-increment CONTROL WRITE SEQUENCER The Control Write Sequencer is a programmable unit that forms part of the WM8918 control interface logic. It provides the ability to perform a sequence of register write operations with the minimum of demands on the host processor - the sequence may be initiated by a single operation from the host processor and then left to execute independently. Default sequences for Start-Up and Shutdown are provided (see “Default Sequences” section). It is recommended that these default sequences are used unless changes become necessary. When a sequence is initiated, the sequencer performs a series of pre-defined register writes. The host processor informs the sequencer of the start index of the required sequence within the sequencer’s memory. At each step of the sequence, the contents of the selected register fields are read from the sequencer’s memory and copied into the WM8918 control registers. This continues sequentially through the sequencer’s memory until an “End of Sequence” bit is encountered; at this point, the sequencer stops and an Interrupt status flag is asserted. For cases where the timing of the write sequence is important, a programmable delay can be set for specific steps within the sequence. Note that the Control Write Sequencer’s internal clock is derived from the internal clock SYSCLK. An external MCLK signal must be present when using the Control Write Sequencer, and SYSCLK must be enabled by setting CLK_SYS_ENA (see “Clocking and Sample Rates”). The clock division from MCLK is handled transparently by the WM8918 without user intervention, as long as MCLK and sample rates are set correctly. INITIATING A SEQUENCE The Register fields associated with running the Control Write Sequencer are described in Table 78. The Write Sequencer Clock is enabled by setting the WSEQ_ENA bit. Note that the operation of the Control Write Sequencer also requires the internal clock SYSCLK to be enabled via the CLK_SYS_ENA (see “Clocking and Sample Rates”). The start index of the required sequence must be written to the WSEQ_START_INDEX field. Setting the WSEQ_START bit initiates the sequencer at the given start index. w PD, Rev 4.1, January 2012 115 WM8918 Production Data The Write Sequencer can be interrupted by writing a logic 1 to the WSEQ_ABORT bit. The current status of the Write Sequencer can be read using two further register fields - when the WSEQ_BUSY bit is asserted, this indicates that the Write Sequencer is busy. Note that, whilst the Control Write Sequencer is running a sequence (indicated by the WSEQ_BUSY bit), normal read/write operations to the Control Registers cannot be supported. (The Write Sequencer registers and the Software Reset register can still be accessed when the Sequencer is busy.) The index of the current step in the Write Sequencer can be read from the WSEQ_CURRENT_INDEX field; this is an indicator of the sequencer’s progress. On completion of a sequence, this field holds the index of the last step within the last commanded sequence. When the Write Sequencer reaches the end of a sequence, it asserts the WSEQ_EINT flag in Register R127 (see Table 72 within the “Interrupts” section). This flag can be used to generate an Interrupt Event on completion of the sequence. Note that the WSEQ_EINT flag is asserted to indicate that the WSEQ is NOT Busy. REGISTER ADDRESS R108 (6Ch) BIT LABEL DEFAULT 8 WSEQ_ENA 0 Write Sequencer 0 R111 (6Fh) DESCRIPTION Write Sequencer Enable. 0 = Disabled 1 = Enabled 9 WSEQ_ABORT 0 Writing a 1 to this bit aborts the current sequence and returns control of the device back to the serial control interface. 8 WSEQ_START 0 Writing a 1 to this bit starts the write sequencer at the memory location indicated by the WSEQ_START_INDEX field. The sequence continues until it reaches an “End of sequence” flag. At the end of the sequence, this bit will be reset by the Write Sequencer. 5:0 WSEQ_START_ INDEX [5:0] 00_0000 Sequence Start Index. This is the memory location of the first command in the selected sequence. Write Sequencer 3 0 to 31 = RAM addresses 32 to 48 = ROM addresses 49 to 63 = Reserved R112 (70h) 9:4 Write Sequencer 4 0 WSEQ_CURRE NT_INDEX [5:0] 00_0000 WSEQ_BUSY 0 Sequence Current Index (read only): This is the location of the most recently accessed command in the write sequencer memory. Sequencer Busy flag (read only): 0 = Sequencer idle 1 = Sequencer busy Note: it is not possible to write to control registers via the control interface while the Sequencer is Busy. Table 78 Write Sequencer Control - Initiating a Sequence PROGRAMMING A SEQUENCE A sequence consists of write operations to data bits (or groups of bits) within the control registers. The register fields associated with programming the Control Write Sequencer are described in Table 79. For each step of the sequence being programmed, the Sequencer Index must be written to the WSEQ_WRITE_INDEX field. The values 0 to 31 correspond to all the available RAM addresses within the Write Sequencer memory. (Note that memory addresses 32 to 48 also exist, but these are ROM addresses, which are not programmable.) w PD, Rev 4.1, January 2012 116 WM8918 Production Data Having set the Index as described above, Register R109 must be written to (containing the Control Register Address, the Start Bit Position and the Field Width applicable to this step of the sequence). Also, Register R110 must be written to (containing the Register Data, the End of Sequence flag and the Delay time required after this step is executed). After writing to these two registers, the next step in the sequence may be programmed by updating WSEQ_WRITE_INDEX and repeating the procedure. WSEQ_ADDR is an 8-bit field containing the Control Register Address in which the data should be written. WSEQ_DATA_START is a 4-bit field which identifies the LSB position within the selected Control Register to which the data should be written. Setting WSEQ_DATA_START = 0100 will cause 1-bit data to be written to bit 4. With this setting, 4-bit data would be written to bits 7:4 and so on. WSEQ_DATA_WIDTH is a 3-bit field which identifies the width of the data block to be written. This enables selected portions of a Control Register to be updated without any concern for other bits within the same register, eliminating the need for read-modify-write procedures. Values of 0 to 7 correspond to data widths of 1 to 8 respectively. For example, setting WSEQ_DATA_WIDTH = 010 will cause a 3-bit data block to be written. Note that the maximum value of this field corresponds to an 8-bit data block; writing to register fields greater than 8 bits wide must be performed using two separate operations of the Control Write Sequencer. WSEQ_DATA is an 8-bit field which contains the data to be written to the selected Control Register. The WSEQ_DATA_WIDTH field determines how many of these bits are written to the selected register; the most significant bits (above the number indicated by WSEQ_DATA_WIDTH) are ignored. WSEQ_DELAY is a 4-bit field which controls the waiting time between the current step and the next step in the sequence. The total delay time per step (including execution) is given by: T = k × (2 WSEQ_DELAY + 8) where k = 62.5s (under recommended operating conditions) This gives a useful range of execution/delay times from 562s up to 2.048s per step. WSEQ_EOS is a 1-bit field which indicates the End of Sequence. If this bit is set, then the Control Write Sequencer will automatically stop after this step has been executed. REGISTER ADDRESS BIT LABEL DEFAULT DESCRIPTION R108 (6Ch) Write Sequencer 0 4:0 WSEQ_WRITE _INDEX [4:0] 0_0000 Sequence Write Index. This is the memory location to which any updates to R109 and R110 will be copied. R109 (6Dh) Write Sequencer 1 14:12 WSEQ_DATA_ WIDTH [2:0] 000 0 to 31 = RAM addresses Width of the data block written in this sequence step. 000 = 1 bit 001 = 2 bits 010 = 3 bits 011 = 4 bits 100 = 5 bits 101 = 6 bits 110 = 7 bits 111 = 8 bits 11:8 WSEQ_DATA_ START [3:0] 0000 Bit position of the LSB of the data block written in this sequence step. 0000 = Bit 0 … 1111 = Bit 15 7:0 w WSEQ_ADDR [7:0] 0000_0000 Control Register Address to be written to in this sequence step. PD, Rev 4.1, January 2012 117 WM8918 Production Data REGISTER ADDRESS BIT LABEL DEFAULT DESCRIPTION R110 (6Eh) Write Sequencer 2 14 WSEQ_EOS 0 End of Sequence flag. This bit indicates whether the Control Write Sequencer should stop after executing this step. 0 = Not end of sequence 1 = End of sequence (Stop the sequencer after this step). 11:8 Time delay after executing this step. WSEQ_DELAY [3:0] 0000 WSEQ_DATA [7:0] 0000_0000 Total delay time per step (including execution)= 62.5µs × (2^WSEQ_DELAY + 8) 7:0 Data to be written in this sequence step. When the data width is less than 8 bits, then one or more of the MSBs of WSEQ_DATA are ignored. It is recommended that unused bits be set to 0. Table 79 Write Sequencer Control - Programming a Sequence Note that a ‘Dummy’ write can be inserted into a control sequence by commanding the sequencer to write a value of 0 to bit 0 of Register R255 (FFh). This is effectively a write to a non-existent register location. This can be used in order to create placeholders ready for easy adaptation of the sequence. For example, a sequence could be defined to power-up a mono signal path from DACL to headphone, with a ‘dummy’ write included to leave space for easy modification to a stereo signal path configuration. Dummy writes can also be used in order to implement additional time delays between register writes. Dummy writes are included in the default start-up sequence – see Table 81. In summary, the Control Register to be written is set by the WSEQ_ADDR field. The data bits that are written are determined by a combination of WSEQ_DATA_START, WSEQ_DATA_WIDTH and WSEQ_DATA. This is illustrated below for an example case of writing to the VMID_RES field within Register R5 (05h). In this example, the Start Position is bit 01 (WSEQ_DATA_START = 0001b) and the Data width is 2 bits (WSEQ_DATA_WIDTH = 0001b). With these settings, the Control Write Sequencer would updated the Control Register R5 [2:1] with the contents of WSEQ_DATA [1:0]. LSB position = b01 WSEQ_DATA_STARTn = 0001 b15 b14 b13 b12 b11 b10 b09 b08 b07 b06 b05 R5 (05h) VMID Control 0 b04 b03 b02 b01 b00 VMID_RES Data Width = 2 bits WSEQ_DATA_WIDTHn = 0001 WSEQ_DATAn (8 bits) b07 b06 b05 b04 b03 b02 b01 b00 WSEQ_DATA_WIDTHn = 2 bits. Therefore, only the Least Significant 2 bits are valid. Bits 02 to 07 are discarded Figure 68 Control Write Sequencer Example w PD, Rev 4.1, January 2012 118 WM8918 Production Data DEFAULT SEQUENCES When the WM8918 is powered up, two Control Write Sequences are available through default settings in both RAM and ROM memory locations. The purpose of these sequences, and the register write required to initiate them, is summarised in Table 80. In both cases, a single register write will initiate the sequence. WSEQ START WSEQ FINISH INDEX INDEX PURPOSE 0 (00h) 22 (16h) Start-Up sequence 25 (19h) 39 (27h) Shutdown sequence TO INITIATE Write 0100h to Register R111 (6Fh) Write 0119h to Register R111 (6Fh) Table 80 Write Sequencer Default Sequences Note on Shutdown sequence: The instruction at Index Address 25 (19h) shorts the outputs LINEOUTL and LINEOUTR. If the Line outputs are not in use at the time the sequence is run, then the sequence could, instead, be started at Index Address 26. Index addresses 0 to 31 may be programmed to users’ own settings at any time, as described in “Programming a Sequence”. Users’ own settings remain in memory and are not affected by software resets (i.e. writing to Register R0). However, any non-default sequences are lost when the device is powered down. START-UP SEQUENCE The Start-up sequence is initiated by writing 0100h to Register R111 (6Fh). This single operation starts the Control Write Sequencer at Index Address 0 (00h) and executes the sequence defined in Table 81. For typical clocking configurations with MCLK=12.288MHz, this sequence takes approximately 300ms to run. Note that, for fast startup, step 18 may be overwritten with dummy data in order to achieve startup within 50ms (see “Quick Start-Up and Shutdown”). WSEQ INDEX REGISTER ADDRESS WIDTH START DATA DELAY EOS 0 (00h) R4 (04h) 5 bits Bit 0 1Ah 0h 0b 1 (01h) R5 (05h) 8 bits Bit 0 47h 6h 0b DESCRIPTION BIAS_ENA = 0 (delay = 0.5625ms) VMID_BUF_ENA = 1 VMID_RES[1:0] = 11b VMID_ENA = 1 (delay = 4.5ms) 2 (02h) R5 (05h) 2 bits Bit 1 01h 0h 0b VMID_RES[1:0] = 01b (delay = 0.5625ms) 3 (03h) R4 (04h) 1 bit Bit 0 01h 0h 0b BIAS_ENA = 1 (delay = 0.5625ms) 4 (04h) R14 (0Eh) 2 bits Bit 0 03h 0h 0b HPL_PGA_ENA = 1 HPR_PGA_ENA = 1 (delay = 0.5625ms) 5 (05h) R15 (0Fh) 2 bits Bit 0 03h 0h 0b LINEOUTL_PGA_ENA = 1 LINEOUTR_PGA_ENA = 1 (delay = 0.5625ms) 6 (06h) R22 (16h) 1 bit Bit 1 01h 0h 0b CLK_DSP_ENA = 1 7 (07h) R18 (12h) 2 bits Bit 2 03h 5h 0b DACL_ENA = 1 (delay = 0.5625ms) w PD, Rev 4.1, January 2012 119 WM8918 WSEQ INDEX REGISTER ADDRESS Production Data WIDTH START DATA DELAY EOS DESCRIPTION DACR_ENA = 1 (delay = 2.5ms) 8 (08h) R255 (FFh) 1 bit Bit 0 00h 0h 0b Dummy Write for expansion (delay = 0.5625ms) 9 (09h) R4 (04h) 1 bit Bit 4 00h 0h 0b (delay = 0.5625ms) 10 (0Ah) R98 (62h) 1 bit Bit 0 01h 6h 0b CP_ENA = 1 11 (0Bh) R255 (FFh) 1 bit Bit 0 00h 0h 0b (delay = 4.5ms) Dummy Write for expansion (delay = 0.5625ms) 12 (0Ch) R90 (5Ah) 8 bits Bit 0 11h 0h 0b HPL_ENA = 1 HPR_ENA = 1 (delay = 0.5625ms) 13 (0Dh) R94 (5Eh) 8 bits Bit 0 11h 0h 0b LINEOUTL_ENA = 1 LINEOUTR_ENA = 1 (delay = 0.5625ms) 14 (0Eh) R90 (5Ah) 8 bits Bit 0 33h 0h 0b HPL_ENA_DLY = 1 HPR_ENA_DLY = 1 (delay = 0.5625ms) 15 (0Fh) R94 (5Eh) 8 bits Bit 0 33h 0h 0b LINEOUTL_ENA_DLY = 1 LINEOUTR_ENA_DLY = 1 (delay = 0.5625ms) 16 (10h) R67 (43h) 4 bits Bit 0 0Fh Ch 0b DCS_ENA_CHAN_0 = 1 DCS_ENA_CHAN_1 = 1 DCS_ENA_CHAN_2 = 1 DCS_ENA_CHAN_3 = 1 (delay = 0.5625ms) 17 (11h) R68 (44h) 8 bits Bit 0 F0h 0h 0b DCS_TRIG_STARTUP_0 = 1 DCS_TRIG_STARTUP_1 = 1 DCS_TRIG_STARTUP_2 = 1 DCS_TRIG_STARTUP_3 = 1 (delay = 256.5ms) 18 (12h) R255 (FFh) 1 bit Bit 0 00h 0h 0b Dummy Write for expansion (delay = 0.5625ms) 19 (13h) R90 (5Ah) 8 bits Bit 0 77h 0h 0b HPL_ENA_OUTP = 1 HPR_ENA_OUTP = 1 (delay = 0.5625ms) 20 (14h) R94 (5Eh) 8 bits Bit 0 77h 0h 0b LINEOUTL_ENA_OUTP = 1 LINEOUTR_ENA_OUTP = 1 (delay = 0.5625ms) 21 (15h) R90 (5Ah) 8 bits Bit 0 FFh 0h 0b HPL_RMV_SHORT = 1 HPR_RMV_SHORT = 1 (delay = 0.5625ms) 22 (16h) R94 (5Eh) 8 bits Bit 0 FFh 0h 1b LINEOUTL_RMV_SHORT = 1 LINEOUTR_RMV_SHORT = 1 End of Sequence 23 (17h) R255 (FFh) 1 bit Bit 0 00h 0h 0b Spare 24 (18h) R255 (FFh) 1 bit Bit 0 00h 0h 0b Spare Table 81 Start-up Sequence w PD, Rev 4.1, January 2012 120 WM8918 Production Data SHUTDOWN SEQUENCE The Shutdown sequence is initiated by writing 0119h to Register R111 (6Fh). This single operation starts the Control Write Sequencer at Index Address 25 (19h) and executes the sequence defined in Table 82. For typical clocking configurations with MCLK=12.288MHz, this sequence takes approximately 350ms to run. WSEQ INDEX REGISTER ADDRESS WIDTH START DATA DELAY EOS 25 (19h) R94 (5Eh) 8 bits Bit 0 77h 0h 0b DESCRIPTION LINEOUTL_RMV_SHORT = 0 LINEOUTR_RMV_SHORT = 0 (delay = 0.5625ms) 26 (1Ah) R90 (5Ah) 8 bits Bit 0 77h 0h 0b HPL_RMV_SHORT = 0 HPR_RMV_SHORT = 0 (delay = 0.5625ms) 27 (1Bh) R90 (5Ah) 8 bits Bit 0 00h 0h 0b HPL_ENA_OUTP = 0 HPL_ENA_DLY = 0 HPL_ENA = 0 HPR_ENA_OUTP = 0 HPR_ENA_DLY = 0 HPR_ENA = 0 (delay = 0.5625ms) 28 (1Ch) R94 (5Eh) 8 bits Bit 0 00h 0h 0b LINEOUTL_ENA_OUTP = 0 LINEOUTL_ENA_DLY = 0 LINEOUTL_ENA = 0 LINEOUTR_ENA_OUTP = 0 LINEOUTR_ENA_DLY = 0 LINEOUTR_ENA = 0 (delay = 0.5625ms) 29 (1Dh) R67 (43h) 4 bits Bit 0 00h 0h 0b DCS_ENA_CHAN_0 = 0 DCS_ENA_CHAN_1 = 0 DCS_ENA_CHAN_2 = 0 DCS_ENA_CHAN_3 = 0 (delay = 0.5625ms) 30 (1Eh) R98 (62h) 1 bit Bit 0 00h 0h 0b CP_ENA = 0 31 (1Fh) R18 (12h) 2 bits Bit 2 00h 0h 0b DACL_ENA = 0 (delay = 0.5625ms) DACR_ENA = 0 (delay = 0.5625ms) 32 (20h) R22 (16h) 1 bit Bit 1 00h 0h 0b CLK_DSP_ENA = 0 33 (21h) R14 (0Eh) 2 bits Bit 0 00h 0h 0b HPL_PGA_ENA = 0 (delay = 0.5625ms) HPR_PGA_ENA = 0 (delay = 0.5625ms) 34 (22h) R15 (0Fh) 2 bits Bit 0 00h 0h 0b LINEOUTL_PGA_ENA = 0 LINEOUTR_PGA_ENA = 0 (delay = 0.5625ms) 35 (23h) R4 (04h) 1 bit Bit 0 00h 0h 0b BIAS_ENA = 0 (delay = 0.5625ms) 36 (24h) R5 (05h) 1 bit Bit 0 00h Ch 0b VMID_ENA = 0 (delay = 256.5ms) 37 (25h) R5 (05h) 1 bit Bit 0 00h 9h 0b VMID_ENA = 0 (delay = 32.5ms) 38 (26h) R5 (05h) w 8 bits Bit 0 00h 0h 0b VMID_BUF_ENA = 0 PD, Rev 4.1, January 2012 121 WM8918 WSEQ INDEX REGISTER ADDRESS Production Data WIDTH START DATA DELAY EOS DESCRIPTION VMID_RES[1:0] = 00 VMID_ENA = 0 (delay = 0.5625ms) 39 (27h) R4 (04h) 2 bits Bit 0 00h 0h 1b BIAS_ENA = 0 End of Sequence Table 82 Shutdown Sequence w PD, Rev 4.1, January 2012 122 WM8918 Production Data POWER-ON RESET The WM8918 includes an internal Power-On-Reset (POR) circuit, which is used to reset the digital logic into a default state after power up. The POR circuit is powered from AVDD and monitors DCVDD. The internal POR ¯¯¯ signal is asserted low when AVDD or DCVDD are below minimum thresholds. The specific behaviour of the circuit will vary, depending on the relative timing of the supply voltages. Typical scenarios are illustrated in Figure 69 and Figure 70. AVDD Vpora Vpora_off 0V DCVDD Vpord_on 0V HI Internal POR LO POR active Device ready POR active POR undefined Figure 69 Power On Reset timing - AVDD enabled first AVDD Vpora Vpora_on 0V DCVDD Vpord_off 0V HI Internal POR LO POR active Device ready POR active POR undefined Figure 70 Power On Reset timing - DCVDD enabled first w PD, Rev 4.1, January 2012 123 WM8918 Production Data The POR ¯¯¯ signal is undefined until AVDD has exceeded the minimum threshold, Vpora Once this threshold has been exceeded, POR ¯¯¯ is asserted low and the chip is held in reset. In this condition, all writes to the control interface are ignored. Once AVDD and DCVDD have reached their respective power on thresholds, POR ¯¯¯ is released high, all registers are in their default state, and writes to the control interface may take place. Note that a minimum power-on reset period, TPOR, applies even if AVDD and DCVDD have zero rise time. (This specification is guaranteed by design rather than test.) On power down, POR ¯¯¯ is asserted low when any of AVDD or DCVDD falls below their respective power-down thresholds. Typical Power-On Reset parameters for the WM8918 are defined in Table 83. SYMBOL TYP UNIT AVDD threshold below which POR is undefined 0.25 V Vpora_on Power-On threshold (AVDD) 1.15 V Vpora_off Power-Off threshold (AVDD) 1.12 V Vpora DESCRIPTION Vpord_on Power-On threshold (DCVDD) 0.57 V Vpord_off Power-Off threshold (DCVDD) 0.55 V Minimum Power-On Reset period 9.5 s TPOR Table 83 Typical Power-On Reset parameters Notes: w 1. If AVDD and DCVDD suffer a brown-out (i.e. drop below the minimum recommended operating level but do not go below Vpora_off or Vpord_off) then the chip does not reset and resumes normal operation when the voltage is back to the recommended level again. 2. The chip enters reset at power down when AVDD or DCVDD falls below Vpora_off or Vpord_off. This may be important if the supply is turned on and off frequently by a power management system. 3. The minimum Tpor period is maintained even if DCVDD and AVDD have zero rise time. This specification is guaranteed by design rather than test. PD, Rev 4.1, January 2012 124 WM8918 Production Data QUICK START-UP AND SHUTDOWN The WM8918 has the capability to perform a quick start-up and shutdown with a minimum number of register operations. This is achieved using the Control Write Sequencer, which is configured with default start-up settings that set up the device for DAC playback via Headphone and Line output. Assuming a 12.288MHz external clock, the start-up sequence configures the device for 48kHz playback mode. The default start-up sequence requires three register write operations. The default shutdown sequence requires just a single register write. The minimum procedure for executing the quick startup and shutdown sequences is described below. See “Control Write Sequencer” for more details. After the default start-up sequence has been performed, the DC offset correction values will be held in memory, provided that power is maintained and a software reset is not performed. Fast start-up using the stored values of DC offset correction is also possible, as described below. QUICK START-UP (DEFAULT SEQUENCE) An external clock must be applied to MCLK. Assuming 12.288MHz input clock, the start-up sequence will take approximately 300ms to complete. The following register operations will initiate the quick start-up sequence. REGISTER ADDRESS R108 (6Ch) VALUE 0100h Write Sequencer 0 DESCRIPTION WSEQ_ENA = 1 WSEQ_WRITE_INDEX = 00h This enables the Write Sequencer R111 (6Fh) 0100h Write Sequencer 3 WSEQ_ABORT = 0 WSEQ_START = 1 WSEQ_START_INDEX = 00h This starts the Write Sequencer at Index address 0 (00h) R33 (21h) 0000h DAC Digital 1 DAC_MONO = 0 DAC_SB_FILT = 0 DAC_MUTERATE = 0 DAC_UNMUTE_RAMP = 0 DAC_OSR128 = 0 DAC_MUTE = 0 DEEMPH = 00 This un-mutes the DACs Table 84 Quick Start-up Control The WSEQ_BUSY bit (in Register R112, see Table 78) will be set to 1 while the sequence runs. When this bit returns to 0, the device has been set up and is ready for DAC playback operation. FAST START-UP FROM STANDBY The default start-up sequence runs the DC Servo to remove DC offsets from the outputs. The offset for this path selection is then stored in memory. Provided that power is maintained to the chip, and a software reset is not performed, then the DC offset correction will be held in memory on the WM8918. This allows the DC Servo calibrations to be omitted from the start-up sequence if the offset correction has already been performed. By omitting this part of the start-up sequence, a fast start-up time of less than 50ms can be achieved. The register write sequence described in Table 85 replaces the default DC Servo operation with dummy operations, allowing a fast start-up to be achieved, assuming the device is initially in a standby condition with DC offset correction previously performed. w PD, Rev 4.1, January 2012 125 WM8918 Production Data Note that, if power is removed from the WM8918 or if a software reset is performed, then the default sequence will be restored, and the DC offset correction will be necessary on the output paths once more. REGISTER ADDRESS R108 (6Ch) VALUE 0111h Write Sequencer 0 DESCRIPTION WSEQ_ENA = 1 WSEQ_WRITE_INDEX = 11h This enables the Write Sequencer and selects WSEQ Index 17 (11h) for modification R109 (6Dh) 00FFh Write Sequencer 1 WSEQ_DATA_WIDTH = 000 WSEQ_DATA_START = 0000 WSEQ_ADDR = FFh This modifies WSEQ Index 17 (11h) with Dummy step R110 (6Eh) 0000h Write Sequencer 2 WSEQ_EOS = 0 WSEQ_DELAY = 0000 WSEQ_DATA = 00h This modifies WSEQ Index 17 (11h) with Dummy step R111 (6Fh) 0100h Write Sequencer 3 WSEQ_ABORT = 0 WSEQ_START = 1 WSEQ_START_INDEX = 00h This starts the Write Sequencer at Index address 0 (00h) R33 (21h) 0000h DAC Digital 1 DAC_MONO = 0 DAC_SB_FILT = 0 DAC_MUTERATE = 0 DAC_UNMUTE_RAMP = 0 DAC_OSR128 = 0 DAC_MUTE = 0 DEEMPH = 00 This un-mutes the DACs Table 85 Fast Start-up from Standby Control The WSEQ_BUSY bit (in Register R112, see Table 78) will be set to 1 while the sequence runs. When this bit returns to 0, the device has been set up and is ready for DAC playback operation. QUICK SHUTDOWN (DEFAULT SEQUENCE) The default shutdown sequence assumes the initial device conditions are as configured by the default start-up sequence. Assuming 12.288MHz input clock, the shutdown sequence will take approximately 350ms to complete. The following register operation will initiate the default shutdown sequence. REGISTER ADDRESS R111 (6Fh) VALUE 0119h Write Sequencer 3 DESCRIPTION WSEQ_ABORT = 0 WSEQ_START = 1 WSEQ_START_INDEX = 19h This starts the Write Sequencer at Index address 25 (19h) Table 86 Quick Shutdown Control The WSEQ_BUSY bit (in Register R112, see Table 78) will be set to 1 while the sequence runs. When this bit returns to 0, the system clock can be disabled (CLK_SYS_ENA=0) and MCLK can be stopped. w PD, Rev 4.1, January 2012 126 WM8918 Production Data SOFTWARE RESET AND CHIP ID A Software Reset can be commanded by writing to Register R0. This is a read-only register field and the contents will not be affected by writing to this Register. The Chip ID can be read back from Register R0. REGISTER ADDRESS R0 (00h) SW Reset and ID BIT LABEL DEFAULT 15:0 SW_RST_DE V_ID1 [15:0] 8904h DESCRIPTION Writing to this register resets all registers to their default state. Reading from this register will indicate Device ID 8904h. Table 87 Software Reset and Chip ID w PD, Rev 4.1, January 2012 127 w 12 14 15 16 18 19 1A 1B 1E 1F 20 21 24 25 26 27 28 29 2A 2B 2C 18 20 21 22 24 25 26 27 30 31 32 33 36 37 38 39 40 41 42 43 44 2D 0F 15 45 0E 14 07 7 0A 06 6 0C 05 5 12 04 4 10 00 Analogue Right Input 0 Analogue Left Input 0 DRC 3 DRC 2 DRC 1 DRC 0 Digital Microphone 0 0 0 0 0 DRC_ENA 0 0 0 DMIC Digital 0 0 DMIC Digital Volume Right 0 DMIC Digital Volume Left DAC Digital 1 0 0 DAC Digital 0 0 DAC Digital Volume Right 0 0 0 0 MCLK_INV 0 1 0 0 0 0 0 0 0 0 0 15 DAC Digital Volume Left Audio Interface 3 Audio Interface 2 Audio Interface 1 Audio Interface 0 Clock Rates 2 Clock Rates 1 Clock Rates 0 Power Management 6 Power Management 3 Power Management 2 Power Management 0 Analogue DMIC 0 Mic Bias Control 1 Mic Bias Control 0 VMID Control 0 Bias Control 0 SW Reset and ID Hex Addr Name 0 Dec Addr 0 0 0 0 0 0 0 0 0 13 0 0 0 0 0 0 0 0 0 DRC_DAC_PA TH DRC_ATK[3:0] 0 0 0 0 0 0 0 0 0 0 AIFRX_TDM 0 0 0 0 0 0 0 0 0 0 0 0 0 0 SYSCLK_SRC 0 TOCLK_RATE TOCLK_RATE _DIV16 _X4 0 0 0 0 0 0 0 0 0 14 1 0 0 0 0 0 0 0 0 0 11 0 DMIC_SRC 0 0 0 DAC_SB_FILT 0 0 LRCLK_DIR AIFTX_TDM 0 0 0 0 0 0 0 0 DRC_GS_HYST_LVL[1:0] DMIC_ENA 0 0 0 DAC_MONO 0 0 0 0 0 AIFRX_TDM_CHA N AIFRXL_DATI AIFRXR_DATI NV NV TOCLK_RATE CLK_SYS_RATE[3:0] 0 0 0 0 0 0 0 0 0 0 12 0 0 0 0 0 0 0 0 0 0 0 0 9 0 0 0 0 0 0 0 0 0 0 0 0 0 DRC_DCY[3:0] 0 0 0 0 8 7 0 0 DMIC_VU DMIC_VU 0 DAC_VU DAC_VU AIF_TRIS LOOPBACK 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 RINMUTE LINMUTE DRC_KNEE_IP[5:0] 0 0 0 0 0 0 0 0 0 SAMPLE_RATE[2:0] 1 BCLK_DIV[4:0] DRC_QR 0 0 0 0 0000_0000_0000_0000 0000_0000_1000_0101 0000_0000_1000_0101 LIN_VOL[4:0] RIN_VOL[4:0] 0000_0000_0000_0000 0011_0010_0100_1000 0000_0001_1010_1111 0000_0000_0000_0000 0000_0000_0001_0000 0000_000P_1100_0000 0000_000P_1100_0000 0000_0000_0000_1000 0000_0000_0000_0000 0000_000P_1100_0000 0000_000P_1100_0000 0000_0000_0100_0000 0000_0000_1110_0100 0000_0000_0000_1010 DRC_KNEE_OP[4:0] DRC_LO_COMP[2:0] DRC_MAXGAIN[1:0] DRC_ANTICLI DRC_GS_HYS P T 0 AIFTXL_DATIN AIFTXR_DATI V NV DEEMPH[1:0] DMIC_TO_DACR[1:0] AIF_FMT[1:0] 0000_0000_0101_0000 0000_1100_0000_0101 1000_1100_0101_1110 0000_0000_0000_0000 0000_0000_0000_0000 MCLK_DIV DMICR_ENA 0000_0000_0000_0000 DMICL_ENA 0000_0000_0000_0000 LINEOUTL_PG LINEOUTR_P A_ENA GA_ENA 0000_0000_0000_0000 0000_0000_0000_0001 HPL_PGA_EN HPR_PGA_EN A A INR_ENA DMIC_OSR128 0000_0000_0000_0000 0000_0000_0000_0000 0000_0000_0000_0000 0000_0000_0001_1000 AIFRX_COMP AIFTX_COMP AIFRX_COMP MODE MODE DRC_MINGAIN[1:0] DRC_GS_ENA DRC_HI_COMP[2:0] DRC_QR_DCY[1:0] 0 DRC_FF_DEL AY DMIC_HPF DMICR_VOL[7:0] 0 INL_ENA Bin Default 1000_1001_0000_0100 TOCLK_ENA AIF_WL[1:0] DAC_MUTE DMICL_VOL[7:0] 0 MICBIAS_ENA MICBIAS_SEL[2:0] CLK_SYS_EN CLK_DSP_EN A A 1 DACR_ENA 0 0 0 0 DMIC_TO_DACL[1:0] DACR_VOL[7:0] 0 0 OPCLK_ENA 0 1 DACL_ENA 0 0 0 0 0 MICDET_ENA BIAS_ENA VMID_ENA 0 0 1 VMID_RES[1:0] 0 2 MICSHORT_THR[1:0] 0 1 3 DACL_VOL[7:0] AIF_LRCLK_IN V 0 DMIC_HPF_CUT[1:0] DAC_OSR128 0 0 1 0 0 0 0 0 0 0 1 4 AIFRXR_SRC AIFTX_COMP LRCLK_RATE[10:0] 1 0 AIFRXL_SRC 0 0 0 0 0 0 0 0 0 DMICR_DAC_SVOL[3:0] 1 BCLK_DIR AIFTXR_SRC 0 0 1 0 0 0 0 0 0 0 MICDET_THR[2:0] 0 0 5 VMID_BUF_ENA 6 DRC_QR_THR[1:0] 0 0 0 1 AIF_BCLK_INV AIFTXL_SRC 0 0 0 0 0 0 0 0 0 0 0 0 SW_RST_DEV_ID1[15:0] DRC_STARTUP_GAIN[4:0] DAC_MUTERA DAC_UNMUTE TE _RAMP DMICL_DAC_SVOL[3:0] 0 0 OPCLK_DIV[3:0] AIFTX_TDM_CHA N DAC_BOOST[1:0] 0 1 0 0 0 0 0 0 0 0 0 10 WM8918 Production Data REGISTER MAP PD, Rev 4.1, January 2012 128 w 120 78 77 62 98 119 5E 94 76 5A 90 118 4D 77 75 4C 76 117 4B 75 74 4A 74 116 49 73 70 48 72 112 47 71 6F 45 69 111 44 68 6E 43 67 6D 3D 61 110 3C 60 109 3B 59 68 3A 58 6C 39 57 108 2F 47 104 2E 0 FLL Control 5 FLL Control 4 FLL Control 3 FLL Control 2 FLL Control 1 Write Sequencer 4 Write Sequencer 3 Write Sequencer 2 Write Sequencer 1 0 0 0 0 0 0 0 0 0 Class W 0 0 0 0 0 0 0 0 0 0 0 0 Write Sequencer 0 0 0 0 0 0 0 0 0 14 0 0 0 0 0 0 0 0 13 0 0 0 0 0 0 0 0 12 0 0 0 0 0 0 0 0 11 0 0 0 0 0 0 0 0 10 0 0 0 0 0 0 0 0 9 6 0 0 0 LINEOUTR_MUTE LINEOUT_VU LINEOUTRZC 0 HPOUTRZC LINEOUTLZC HPOUT_VU HPOUTR_MUTE LINEOUTL_MUTE LINEOUT_VU 0 0 HPOUTLZC INR_CM_ENA 0 HPOUT_VU INL_CM_ENA 0 0 7 HPOUTL_MUTE 0 8 0 0 0 0 0000_0000_0000_0000 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 WSEQ_DATA_WIDTH[2:0] WSEQ_EOS 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 DCS_DAC_WR_COMPLETE[3:0] 1 HPR_ENA 0 0 0 0 WSEQ_WRITE_INDEX[4:0] 1 0 0 0 0 WSEQ_BUSY CP_DYN_PWR CP_ENA 0000_0000_0000_0000 0000_0000_0000_0000 0000_0000_0000_0100 0000_0000_0000_0000 0 0 0 0 FLL_N[9:0] 0 0 0 0 0 0 0 0 0 0 0 0 0 FLL_CTRL_RATE[2:0] WSEQ_CURRENT_INDEX[5:0] FLL_K[15:0] WSEQ_ABOR WSEQ_STAR T T 0 0 FLL_CLK_REF_DIV[1:0] 0 0 0 1 FLL_ENA FLL_CLK_REF_SRC[1:0] FLL_GAIN[3:0] FLL_FRATIO[2:0] FLL_FRACN_ENA FLL_OSC_ENA 0 WSEQ_START_INDEX[5:0] 0000_0000_0000_0100 0010_1110_1110_0000 0000_0000_0000_0000 0000_0000_0000_0111 0000_0000_0000_0000 0000_0000_0000_0000 0000_0000_0000_0000 0000_0000_0000_0000 0 0 0 0000_0000_0000_0000 0 0 0 WSEQ_DATA[7:0] 0 0 0 0000_0000_0000_0000 0000_0000_0000_0000 0000_0000_0000_0000 HPR_RMV_SH HPR_ENA_OU HPR_ENA_DL ORT TP Y 0000_0000_0000_0000 DCS_DAC_WR_VAL_0[7:0] HPL_ENA 0000_0000_0000_0000 DCS_DAC_WR_VAL_1[7:0] DCS_STARTUP_COMPLETE[3:0] 0000_0000_0000_0000 1010_1010_1010_1010 DCS_DAC_WR_VAL_2[7:0] 1010_1010_1010_1010 1010_1010_1010_1010 DCS_SERIES_NO_01[6:0] DCS_TIMER_PERIOD_01[3:0] DCS_SERIES_NO_23[6:0] DCS_DAC_WR_VAL_3[7:0] 0 LINEOUTL_RM LINEOUTL_EN LINEOUTL_EN LINEOUTL_EN LINEOUTR_R LINEOUTR_E LINEOUTR_E LINEOUTR_E V_SHORT A_OUTP A_DLY A MV_SHORT NA_OUTP NA_DLY NA HPL_RMV_SH HPL_ENA_OU HPL_ENA_DL ORT TP Y 0 0 WSEQ_ADDR[7:0] WSEQ_ENA 0 0 0 0 1 0 WSEQ_DELAY[3:0] 0 0 0 0 0 0 0 0 0 0 0 WSEQ_DATA_START[3:0] 0 0 0 0 0 DCS_CAL_COMPLETE[3:0] 0 0 0 0 0 0 DCS_TIMER_PERIOD_23[3:0] FLL_OUTDIV[5:0] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 PPPP_PPPP_PPPP_PPPP 0000_0000_0000_0000 0000_0000_P011_1001 DCS_ENA_CH DCS_ENA_CH DCS_ENA_CH DCS_ENA_CH AN_3 AN_2 AN_1 AN_0 0000_0000_P011_1001 LINEOUTR_VOL[5:0] HPL_BYP_EN HPR_BYP_EN LINEOUTL_BY LINEOUTR_BY A A P_ENA P_ENA 0000_0000_P010_1101 HPOUTR_VOL[5:0] LINEOUTL_VOL[5:0] 0000_0000_0100_0100 R_MODE[1:0] Bin Default 0000_0000_0100_0100 0 L_MODE[1:0] 0000_0000_P010_1101 1 HPOUTL_VOL[5:0] R_IP_SEL_P[1:0] 2 R_IP_SEL_N[1:0] 3 L_IP_SEL_P[1:0] 4 L_IP_SEL_N[1:0] 5 DCS_TRIG_SI DCS_TRIG_SI DCS_TRIG_SI DCS_TRIG_SI DCS_TRIG_SE DCS_TRIG_SE DCS_TRIG_SE DCS_TRIG_SE DCS_TRIG_ST DCS_TRIG_ST DCS_TRIG_ST DCS_TRIG_ST DCS_TRIG_D DCS_TRIG_D DCS_TRIG_D DCS_TRIG_D NGLE_3 NGLE_2 NGLE_1 NGLE_0 RIES_3 RIES_2 RIES_1 RIES_0 ARTUP_3 ARTUP_2 ARTUP_1 ARTUP_0 AC_WR_3 AC_WR_2 AC_WR_1 AC_WR_0 0 0 0 0 0 0 0 0 15 Charge Pump 0 Analogue Lineout 0 Analogue HP 0 DC Servo Readback 0 DC Servo 9 DC Servo 8 DC Servo 7 DC Servo 6 DC Servo 5 DC Servo 4 DC Servo 2 DC Servo 1 DC Servo 0 Analogue OUT12 ZC Analogue OUT2 Right Analogue OUT2 Left Analogue OUT1 Right Analogue OUT1 Left Analogue Right Input 1 Analogue Left Input 1 Hex Addr Name 46 Dec Addr Production Data WM8918 PD, Rev 4.1, January 2012 129 w 80 81 82 86 87 88 89 8A 8B 8C 8D 8E 8F 90 91 92 93 94 95 96 97 98 99 9A 9B 9C 128 129 130 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 9D EQ14 7F 127 157 EQ13 7E 126 EQ24 EQ23 EQ22 EQ21 EQ20 EQ19 EQ18 EQ17 EQ16 EQ15 EQ12 EQ11 EQ10 EQ9 EQ8 EQ7 EQ6 EQ5 EQ4 EQ3 EQ2 EQ1 Interrupt Debounce Interrupt Polarity Interrupt Status Mask Interrupt Status Digital Pulls GPIO Control 4 7C 124 GPIO Control 1 79 Hex Addr Name 121 Dec Addr 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 14 15 0 0 0 0 0 0 0 0 0 0 0 0 0 13 0 0 0 0 0 0 0 0 0 0 0 0 0 12 0 0 0 0 0 0 0 0 0 0 0 0 0 11 0 0 0 0 0 0 0 0 0 IRQ 0 0 0 10 0 0 0 0 0 0 0000_1011_0111_0101 0000_0001_1100_0101 0001_1100_0101_1000 1111_0011_0111_0011 0000_1010_0101_0100 0000_0101_0101_1000 0001_0110_1000_1110 1111_1000_0010_1001 0000_0111_1010_1101 0001_0001_0000_0011 0000_0101_0110_0100 0000_0101_0101_1001 0100_0000_0000_0000 EQ_B2_PG[15:0] EQ_B3_A[15:0] EQ_B3_B[15:0] EQ_B3_C[15:0] EQ_B3_PG[15:0] EQ_B4_A[15:0] EQ_B4_B[15:0] EQ_B4_C[15:0] EQ_B4_PG[15:0] EQ_B5_A[15:0] EQ_B5_B[15:0] EQ_B5_PG[15:0] 1111_0001_0100_0101 EQ_B2_C[15:0] 0001_1110_1011_0101 0000_0000_0000_1100 EQ_B2_B[15:0] 0000_0000_0000_1100 EQ_B5_GAIN[4:0] 0000_0000_1101_1000 0000_0000_0000_1100 EQ_B4_GAIN[4:0] EQ_B2_A[15:0] 0000_0000_0000_1100 EQ_B3_GAIN[4:0] 0000_0000_0000_0000 0000_0000_0000_1100 EQ_ENA EQ_B2_GAIN[4:0] 0 EQ_B1_GAIN[4:0] 0 0000_0100_0000_0000 0 EQ_B1_PG[15:0] 0 0 0 0 0 0 0000_0000_0000_0000 0 0000_0000_0000_0000 XXXX_XPPP_PPPP_PPPP 0000_0000_0000_0000 0000_0000_0000_0000 GPIO1_EINT_ GPI8_EINT_D GPI7_EINT_D FLL_LOCK_EI MIC_SHRT_EI MIC_DET_EIN DB B B NT_DB NT_DB T_DB FLL_LOCK_EI MIC_SHRT_EI MIC_DET_EIN NT NT T BCLK_PD Bin Default 0000_0000_0001_0100 1111_1111_1111_1111 GPI7_EINT BCLK_PU GPIO_BCLK_SEL[3:0] LRCLK_PD 0 GPIO1_EINT_ GPI8_EINT_P GPI7_EINT_P FLL_LOCK_EI MIC_SHRT_EI MIC_DET_EIN POL OL OL NT_POL NT_POL T_POL GPI8_EINT 1 GPIO1_SEL[3:0] 2 IM_FLL_LOCK IM_MIC_SHRT IM_MIC_DET_ IM_GPIO1_EIN IM_GPI8_EINT IM_GPI7_EINT _EINT _EINT EINT T GPIO1_EINT LRCLK_PU 3 0000_1111_1100_1010 0 0 0 0 0 0 AIFRXDAT_PU AIFRXDAT_PD 0 4 GPIO1_PD EQ_B1_B[15:0] 0 0 0 0 0 0 0 0 1 5 GPIO1_PU EQ_B1_A[15:0] 0 0 0 0 0 0 0 GPIO_BCLK_E WSEQ_EINT_ INT_DB DB 0 0 0 1 IM_GPIO_BCL IM_WSEQ_EIN K_EINT T GPIO_BCLK_E WSEQ_EINT_ INT_POL POL 0 MCLK_PD GPIO_BCLK_ MODE_ENA MCLK_PU 0 6 0 7 0 0 GPI8_ENA 0 8 GPIO_BCLK_E WSEQ_EINT INT 0 GPI7_ENA 0 9 WM8918 Production Data PD, Rev 4.1, January 2012 130 F7 F8 248 FLL NCO Test 1 FLL NCO Test 0 Hex Addr Name 247 Dec Addr 0 0 15 0 0 14 0 0 13 0 0 12 0 0 11 0 0 10 0 0 9 0 0 8 0 0 7 0 0 6 0 5 0 4 0 2 FLL_FRC_NCO_VAL[5:0] 0 3 0 1 0000_0000_0001_1001 Bin Default 0000_0000_0000_0000 0 FLL_FRC_NCO Production Data w WM8918 PD, Rev 4.1, January 2012 131 WM8918 Production Data REGISTER BITS BY ADDRESS REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R0 (00h) SW Reset and ID 15:0 SW_RST_DEV 1000_1001 Writing to this register resets all registers to their default _ID1[15:0] _0000_010 state. 0 Reading from this register will indicate Device ID 8904h. Register 00h SW Reset and ID REGISTER BIT LABEL DEFAULT 0 BIAS_ENA 0 DESCRIPTION REFER TO ADDRESS R4 (04h) Bias Control 0 Enables the Normal bias current generator (for all analogue functions) 0 = Disabled 1 = Enabled Register 04h Bias Control 0 REGISTER BIT LABEL DEFAULT 6 VMID_BUF_EN A 0 VMID_RES[1:0 ] 00 DESCRIPTION REFER TO ADDRESS R5 (05h) VMID Control 0 Enable VMID buffer to unused Inputs/Outputs 0 = Disabled 1 = Enabled 2:1 VMID Divider Enable and Select 00 = VMID disabled (for OFF mode) 01 = 2 x 50k divider (for normal operation) 10 = 2 x 250k divider (for low power standby) 11 = 2 x 5k divider (for fast start-up) 0 VMID_ENA 0 Enable VMID master bias current source 0 = Disabled 1 = Enabled Register 05h VMID Control 0 REGISTER BIT LABEL DEFAULT 6:4 MICDET_THR[ 2:0] 000 DESCRIPTION REFER TO ADDRESS R6 (06h) Mic Bias Control 0 MICBIAS Current Detect Threshold (AVDD = 1.8V) 000 = 0.070mA 001 = 0.260mA 010 = 0.450mA 011 = 0.640mA 100 = 0.830mA 101 = 1.020mA 110 = 1.210mA 111 = 1.400mA Values scale with AVDD. 3:2 MICSHORT_T HR[1:0] 00 MICBIAS Short Circuit Threshold (AVDD = 1.8V) 00 = 0.520mA 01 = 0.880mA 10 = 1.240mA 11 = 1.600mA Values scale with AVDD. w PD, Rev 4.1, January 2012 132 WM8918 Production Data REGISTER BIT LABEL DEFAULT 1 MICDET_ENA 0 DESCRIPTION REFER TO ADDRESS MICBIAS Current and Short Circuit Detect Enable 0 = disabled 1 = enabled 0 MICBIAS_ENA 0 MICBIAS Enable 0 = disabled 1 = enabled Register 06h Mic Bias Control 0 REGISTER BIT LABEL DEFAULT 2:0 MICBIAS_SEL[ 2:0] 000 DESCRIPTION REFER TO ADDRESS R7 (07h) Mic Bias Control 1 Selects MICBIAS voltage (AVDD=1.8V) 000 = 1.6V 001 = 2.0V 010 = 2.1V 011 = 2.4V 100 to 111 = 2.7V Values scale with AVDD. Register 07h Mic Bias Control 1 REGISTER BIT LABEL DEFAULT 0 DMIC_OSR128 1 DESCRIPTION REFER TO ADDRESS R10 (0Ah) Analogue DMIC 0 DMIC Oversampling Ratio 0 = Normal (64 x fs) 1 = Reserved This bit must be set to 0 for digital microphone operation. Register 0Ah Analogue DMIC 0 REGISTER BIT LABEL DEFAULT 1 INL_ENA 0 DESCRIPTION REFER TO ADDRESS R12 (0Ch) Power Managemen t0 Left Input PGA Enable 0 = disabled 1 = enabled 0 INR_ENA 0 Right Input PGA Enable 0 = disabled 1 = enabled Register 0Ch Power Management 0 REGISTER BIT LABEL DEFAULT 1 HPL_PGA_EN A 0 HPR_PGA_EN A 0 DESCRIPTION REFER TO ADDRESS R14 (0Eh) Power Managemen t2 Left Headphone Output Enable 0 = disabled 1 = enabled 0 Right Headphone Output Enable 0 = disabled 1 = enabled Register 0Eh Power Management 2 w PD, Rev 4.1, January 2012 133 WM8918 REGISTER Production Data BIT LABEL DEFAULT 1 LINEOUTL_PG A_ENA 0 LINEOUTR_PG A_ENA 0 DESCRIPTION REFER TO ADDRESS R15 (0Fh) Power Managemen t3 Left Line Output Enable 0 = disabled 1 = enabled 0 Right Line Output Enable 0 = disabled 1 = enabled Register 0Fh Power Management 3 REGISTER BIT LABEL DEFAULT 3 DACL_ENA 0 DESCRIPTION REFER TO ADDRESS R18 (12h) Power Managemen t6 Left DAC Enable 0 = DAC disabled 1 = DAC enabled 2 DACR_ENA 0 Right DAC Enable 0 = DAC disabled 1 = DAC enabled 1 DMICL_ENA 0 Digital Microphone DSP Enable 0 = Disabled 1 = Enabled 0 DMICR_ENA 0 Digital Microphone DSP Enable 0 = Disabled 1 = Enabled Register 12h Power Management 6 REGISTER BIT LABEL DEFAULT 14 TOCLK_RATE _DIV16 0 DESCRIPTION REFER TO ADDRESS R20 (14h) Clock Rates 0 TOCLK Rate Divider (/16) 0=f/1 1 = f / 16 13 TOCLK_RATE _X4 0 MCLK_DIV 0 TOCLK Rate Multiplier 0=fx1 1=fx4 0 Enables divide by 2 on MCLK 0 = SYSCLK = MCLK 1 = SYSCLK = MCLK / 2 Register 14h Clock Rates 0 w PD, Rev 4.1, January 2012 134 WM8918 Production Data REGISTER BIT LABEL DEFAULT 13:10 CLK_SYS_RAT E[3:0] 0011 DESCRIPTION REFER TO ADDRESS R21 (15h) Clock Rates 1 Selects the SYSCLK / fs ratio 0000 = 64 0001 = 128 0010 = 192 0011 = 256 0100 = 384 0101 = 512 0110 = 768 0111 = 1024 1000 = 1408 1001 = 1536 2:0 SAMPLE_RAT E[2:0] 101 Selects the Sample Rate (fs) 000 = 8kHz 001 = 11.025kHz, 12kHz 010 = 16kHz 011 = 22.05kHz, 24kHz 100 = 32kHz 101 = 44.1kHz, 48kHz 110 to 111 = Reserved Register 15h Clock Rates 1 REGISTER BIT LABEL DEFAULT 15 MCLK_INV 0 DESCRIPTION REFER TO ADDRESS R22 (16h) Clock Rates 2 MCLK Invert 0 = MCLK not inverted 1 = MCLK inverted 14 SYSCLK_SRC 0 SYSCLK Source Select 0 = MCLK 1 = FLL output 12 TOCLK_RATE 0 TOCLK Rate Divider (/2) 0=f/2 1=f/1 3 OPCLK_ENA 0 GPIO Clock Output Enable 0 = disabled 1 = enabled 2 CLK_SYS_EN A 0 CLK_DSP_EN A 0 TOCLK_ENA 0 System Clock enable 0 = Disabled 1 = Enabled 1 DSP Clock enable 0 = Disabled 1 = Enabled 0 Zero Cross timeout enable 0 = Disabled 1 = Enabled Register 16h Clock Rates 2 w PD, Rev 4.1, January 2012 135 WM8918 REGISTER Production Data BIT LABEL DEFAULT 12 AIFRXL_DATI NV 0 AIFRXR_DATI NV 0 DAC_BOOST[1 :0] 00 DESCRIPTION REFER TO ADDRESS R24 (18h) Audio Interface 0 Left DAC Invert 0 = Left DAC output not inverted 1 = Left DAC output inverted 11 Right DAC Invert 0 = Right DAC output not inverted 1 = Right DAC output inverted 10:9 DAC Digital Input Volume Boost 00 = 0dB 01 = +6dB (Input data must not exceed -6dBFS) 10 = +12dB (Input data must not exceed -12dBFS) 11 = +18dB (Input data must not exceed -18dBFS) 8 LOOPBACK 0 Digital Loopback Function 0 = No loopback 1 = Loopback enabled (DMIC data output is directly input to DAC data input) 7 AIFTXL_SRC 0 Left Digital Audio interface source 0 = Left DMIC data is output on left channel 1 = Right DMIC data is output on left channel 6 AIFTXR_SRC 1 Right Digital Audio interface source 0 = Left DMIC data is output on right channel 1 = Right DMIC data is output on right channel 5 AIFRXL_SRC 0 Left DAC Data Source Select 0 = Left DAC outputs left channel data 1 = Left DAC outputs right channel data 4 AIFRXR_SRC 1 Right DAC Data Source Select 0 = Right DAC outputs left channel data 1 = Right DAC outputs right channel data 3 AIFTX_COMP 0 AIFTX Companding Enable 0 = Disabled 1 = Enabled 2 AIFTX_COMP MODE 0 AIFRX_COMP 0 AIFTX Companding Type 0 = µ-law 1 = A-law 1 AIFRX Companding Enable 0 = Disabled 1 = Enabled 0 AIFRX_COMP MODE 0 AIFRX Companding Type 0 = µ-law 1 = A-law Register 18h Audio Interface 0 w PD, Rev 4.1, January 2012 136 WM8918 Production Data REGISTER BIT LABEL DEFAULT 13 AIFRX_TDM 0 DESCRIPTION REFER TO ADDRESS R25 (19h) Audio Interface 1 AIFRX TDM Enable 0 = Normal AIFRXDAT operation 1 = TDM enabled on AIFRXDAT 12 AIFRX_TDM_C HAN 0 AIFTX_TDM 0 AIFRX TDM Channel Select 0 = AIFRXDAT data input on slot 0 1 = AIFRXDAT data input on slot 1 11 AIFTX TDM Enable 0 = Normal AIFTXDAT operation 1 = TDM enabled on AIFTXDAT 10 AIFTX_TDM_C HAN 0 AIF_TRIS 0 AIFTX TDM Channel Select 0 = AIFTXDAT outputs data on slot 0 1 = AIFTXDAT output data on slot 1 8 Audio Interface Tristate 0 = Audio interface pins operate normally 1 = Tristate all audio interface pins 7 AIF_BCLK_INV 0 BCLK Invert 0 = BCLK not inverted 1 = BCLK inverted 6 BCLK_DIR 0 Audio Interface BCLK Direction 0 = BCLK is input 1 = BCLK is output 4 AIF_LRCLK_IN V 0 LRC Polarity / DSP Mode A-B select. Right, left and I2S modes – LRC polarity 0 = Not Inverted 1 = Inverted DSP Mode – Mode A-B select 0 = MSB is available on 2nd BCLK rising edge after LRC rising edge (mode A) 1 = MSB is available on 1st BCLK rising edge after LRC rising edge (mode B) 3:2 AIF_WL[1:0] 10 Digital Audio Interface Word Length 00 = 16 bits 01 = 20 bits 10 = 24 bits 11 = 32 bits 1:0 AIF_FMT[1:0] 10 Digital Audio Interface Format 00 = Right Justified 01 = Left Justified 10 = I2S 11 = DSP Register 19h Audio Interface 1 w PD, Rev 4.1, January 2012 137 WM8918 REGISTER Production Data BIT LABEL DEFAULT 11:8 OPCLK_DIV[3: 0] 0000 DESCRIPTION REFER TO ADDRESS R26 (1Ah) Audio Interface 2 GPIO Output Clock Divider 0000 = SYSCLK 0001 = SYSCLK / 2 0010 = SYSCLK / 3 0011 = SYSCLK / 4 0100 = SYSCLK / 5.5 0101 = SYSCLK / 6 0110 = SYSCLK / 8 0111 = SYSCLK / 12 1000 = SYSCLK / 16 1001 to 1111 = Reserved 4:0 BCLK_DIV[4:0] 0_0100 BCLK Frequency (Master Mode) 00000 = SYSCLK 00001 = SYSCLK / 1.5 00010 = SYSCLK / 2 00011 = SYSCLK / 3 00100 = SYSCLK / 4 00101 = SYSCLK / 5 00110 = SYSCLK / 5.5 00111 = SYSCLK / 6 01000 = SYSCLK / 8 (default) 01001 = SYSCLK / 10 01010 = SYSCLK / 11 01011 = SYSCLK / 12 01100 = SYSCLK / 16 01101 = SYSCLK / 20 01110 = SYSCLK / 22 01111 = SYSCLK / 24 10000 = SYSCLK / 25 10001 = SYSCLK / 30 10010 = SYSCLK / 32 10011 = SYSCLK / 44 10100 = SYSCLK / 48 Register 1Ah Audio Interface 2 REGISTER BIT LABEL DEFAULT 11 LRCLK_DIR 0 DESCRIPTION REFER TO ADDRESS R27 (1Bh) Audio Interface 3 Audio Interface LRCLK Direction 0 = LRCLK is input 1 = LRCLK is output 10:0 LRCLK_RATE[ 000_0100_ LRCLK Rate (Master Mode) 10:0] 0000 LRCLK clock output = BCLK / LRCLK_RATE Integer (LSB = 1) Valid range: 8 to 2047 Register 1Bh Audio Interface 3 w PD, Rev 4.1, January 2012 138 WM8918 Production Data REGISTER BIT LABEL DEFAULT 8 DAC_VU 0 DESCRIPTION REFER TO ADDRESS R30 (1Eh) DAC Digital Volume Left DAC Volume Update Writing a 1 to this bit causes left and right DAC volume to be updated simultaneously 7:0 DACL_VOL[7:0 1100_0000 Left DAC Digital Volume ] 00h = Mute 01h = -71.625dB 02h = -71.250dB … (0.375dB steps) C0h to FFh = 0dB Register 1Eh DAC Digital Volume Left REGISTER BIT LABEL DEFAULT 8 DAC_VU 0 DESCRIPTION REFER TO ADDRESS R31 (1Fh) DAC Digital Volume Right DAC Volume Update Writing a 1 to this bit causes left and right DAC volume to be updated simultaneously 7:0 DACR_VOL[7: 0] 1100_0000 Right DAC Digital Volume 00h = Mute 01h = -71.625dB 02h = -71.250dB … (0.375dB steps) C0h to FFh = 0dB Register 1Fh DAC Digital Volume Right REGISTER BIT LABEL DEFAULT 11:8 DMICL_DAC_S VOL[3:0] 0000 DESCRIPTION REFER TO ADDRESS R32 (20h) DAC Digital 0 Left Digital Sidetone Volume 0000 = -36dB 0001 = -33dB (… 3dB steps) 1011 = -3dB 11XX = 0dB 7:4 DMICR_DAC_ SVOL[3:0] 0000 Right Digital Sidetone Volume 0000 = -36dB 0001 = -33dB (… 3dB steps) 1011 = -3dB 11XX = 0dB 3:2 DMIC_TO_DA CL[1:0] 00 Left DAC Digital Sidetone Source 00 = No sidetone 01 = Left DMIC 10 = Right DMIC 11 = Reserved 1:0 DMIC_TO_DA CR[1:0] 00 Right DAC Digital Sidetone Source 00 = No sidetone 01 = Left DMIC 10 = Right DMIC 11 = Reserved Register 20h DAC Digital 0 w PD, Rev 4.1, January 2012 139 WM8918 REGISTER Production Data BIT LABEL DEFAULT 12 DAC_MONO 0 DESCRIPTION REFER TO ADDRESS R33 (21h) DAC Digital 1 DAC Mono Mix 0 = Stereo 1 = Mono (Mono mix output on enabled DAC) 11 DAC_SB_FILT 0 Selects DAC filter characteristics 0 = Normal mode 1 = Sloping stopband mode (recommended when fs<=24kHz) 10 DAC_MUTERA TE 0 DAC Soft Mute Ramp Rate 0 = Fast ramp (fs/2, maximum ramp time is 10.7ms at fs=48k) 1 = Slow ramp (fs/32, maximum ramp time is 171ms at fs=48k) 9 DAC_UNMUTE _RAMP 0 DAC Soft Mute Mode 0 = Disabling soft-mute (DAC_MUTE=0) will cause the DAC volume to change immediately to DACL_VOL and DACR_VOL settings 1 = Disabling soft-mute (DAC_MUTE=0) will cause the DAC volume to ramp up gradually to the DACL_VOL and DACR_VOL settings 6 DAC_OSR128 0 DAC Oversample Rate Select 0 = Low power (normal OSR) 1 = High performance (double OSR) 3 DAC_MUTE 1 DAC Soft Mute Control 0 = DAC Un-mute 1 = DAC Mute 2:1 DEEMPH[1:0] 00 DAC De-Emphasis Control 00 = No de-emphasis 01 = 32kHz sample rate 10 = 44.1kHz sample rate 11 = 48kHz sample rate Register 21h DAC Digital 1 REGISTER BIT LABEL DEFAULT 8 DMIC_VU 0 DESCRIPTION REFER TO ADDRESS R36 (24h) DMIC Digital Volume Left Digital Microphone Volume Update Writing a 1 to this bit will cause left and right DMIC volume to be updated simultaneously 7:0 DMICL_VOL[7: 1100_0000 Left Digital Microphone Volume 0] 00h = Mute 01h = -71.625dB 02h = -71.250dB … (0.375dB steps) C0h = 0dB … (0.375dB steps) EFh to FFh = +17.625dB Register 24h DMIC Digital Volume Left w PD, Rev 4.1, January 2012 140 WM8918 Production Data REGISTER BIT LABEL DEFAULT 8 DMIC_VU 0 DESCRIPTION REFER TO ADDRESS R37 (25h) DMIC Digital Volume Right Digital Microphone Volume Update Writing a 1 to this bit will cause left and right DMIC volume to be updated simultaneously 7:0 DMICR_VOL[7: 1100_0000 Right Digital Microphone Volume 0] 00h = Mute 01h = -71.625dB 02h = -71.250dB … (0.375dB steps) C0h = 0dB … (0.375dB steps) EFh to FFh = +17.625dB Register 25h DMIC Digital Volume Right REGISTER BIT LABEL DEFAULT 6:5 DMIC_HPF_C UT[1:0] 00 DESCRIPTION REFER TO ADDRESS R38 (26h) DMIC Digital 0 DMIC Digital High Pass Filter Cut-Off Frequency (fc) 00 = Hi-fi mode (fc=4Hz at fs=48kHz) 01 = Voice mode 1 (fc=127Hz at fs=16kHz) 10 = Voice mode 2 (fc=130Hz at fs=8kHz) 11 = Voice mode 3 (fc=267Hz at fs=8kHz) (Note: fc scales with sample rate.) 4 DMIC_HPF 1 DMIC Digital High Pass Filter Enable 0 = Disabled 1 = Enabled 1 AIFTXL_DATIN V 0 AIFTXR_DATI NV 0 Left Digital Microphone Invert 0 = Left DMIC output not inverted 1 = Left DMIC output inverted 0 Right Digital Microphone Invert 0 = Right DMIC output not inverted 1 = Right DMIC output inverted Register 26h DMIC Digital 0 REGISTER BIT LABEL DEFAULT 12 DMIC_ENA 0 DESCRIPTION REFER TO ADDRESS R39 (27h) Digital Microphone 0 Digital Microphone mode 0 = Disabled 1 = Audio DSP input is from digital microphone interface When DMIC_ENA = 0, the Digital microphone clock (DMICCLK) is held low. 11 DMIC_SRC 0 Selects Digital Microphone Data Input pin 0 = IN1L/DMICDAT1 1 = IN1R/DMICDAT2 Register 27h Digital Microphone 0 w PD, Rev 4.1, January 2012 141 WM8918 REGISTER Production Data BIT LABEL DEFAULT 15 DRC_ENA 0 DESCRIPTION REFER TO ADDRESS R40 (28h) DRC 0 DRC enable 1 = enabled 0 = disabled 14 DRC_DAC_PA TH 0 DRC_GS_HYS T_LVL[1:0] 00 DRC path select 0 = Digital Microphone path 1 = DAC path 12:11 Gain smoothing hysteresis threshold 00 = Low 01 = Medium (recommended) 10 = High 11 = Reserved 10:6 DRC_STARTU P_GAIN[4:0] 0_0110 Initial gain at DRC startup 00000 = -3dB 00001 = -2.5dB 00010 = -2dB 00011 = -1.5dB 00100 = -1dB 00101 = -0.5dB 00110 = 0dB (default) 00111 = 0.5dB 01000 = 1dB 01001 = 1.5dB 01010 = 2dB 01011 = 2.5dB 01100 = 3dB 01101 = 3.5dB 01110 = 4dB 01111 = 4.5dB 10000 = 5dB 10001 = 5.5dB 10010 = 6dB 10011 to 11111 = Reserved 5 DRC_FF_DEL AY 1 Feed-forward delay for anti-clip feature 0 = 5 samples 1 = 9 samples Time delay can be calculated as 5/fs or 9/ fs, where fs is the sample rate. 3 DRC_GS_ENA 1 Gain smoothing enable 0 = disabled 1 = enabled 2 DRC_QR 1 Quick release enable 0 = disabled 1 = enabled 1 DRC_ANTICLI P 1 DRC_GS_HYS T 1 Anti-clip enable 0 = disabled 1 = enabled 0 Gain smoothing hysteresis enable 0 = disabled 1 = enabled Register 28h DRC 0 w PD, Rev 4.1, January 2012 142 WM8918 Production Data REGISTER BIT LABEL DEFAULT 15:12 DRC_ATK[3:0] 0011 DESCRIPTION REFER TO ADDRESS R41 (29h) DRC 1 Gain attack rate (seconds/6dB) 0000 = instantaneous 0001 = 363us 0010 = 726us 0011 = 1.45ms (default) 0100 = 2.9ms 0101 = 5.8ms 0110 = 11.6ms 0111 = 23.2ms 1000 = 46.4ms 1001 = 92.8ms 1010 = 185.6ms 1011-1111 = Reserved 11:8 DRC_DCY[3:0] 0010 Gain decay rate (seconds/6dB) 0000 = 186ms 0001 = 372ms 0010 = 743ms (default) 0011 = 1.49s 0100 = 2.97s 0101 = 5.94s 0110 = 11.89s 0111 = 23.78s 1000 = 47.56s 1001-1111 = Reserved 7:6 DRC_QR_THR [1:0] 01 Quick release crest factor threshold 00 = 12dB 01 = 18dB (default) 10 = 24dB 11 = 30dB 5:4 DRC_QR_DCY [1:0] 00 Quick release decay rate (seconds/6dB) 00 = 0.725ms (default) 01 = 1.45ms 10 = 5.8ms 11 = Reserved 3:2 DRC_MINGAIN [1:0] 10 Minimum gain the DRC can use to attenuate audio signals 00 = 0dB (default) 01 = -6dB 10 = -12dB 11 = -18dB 1:0 DRC_MAXGAI N[1:0] 00 Maximum gain the DRC can use to boost audio signals 00 = 12dB 01 = 18dB (default) 10 = 24dB 11 = 36dB Register 29h DRC 1 w PD, Rev 4.1, January 2012 143 WM8918 REGISTER Production Data BIT LABEL DEFAULT 5:3 DRC_HI_COM P[2:0] 000 DESCRIPTION REFER TO ADDRESS R42 (2Ah) DRC 2 Compressor slope R0 000 = 1 (no compression) 001 = 1/2 010 = 1/4 011 = 1/8 100 = 1/16 101 = 0 110 = Reserved 111 = Reserved 2:0 DRC_LO_COM P[2:0] 000 Compressor slope R1 000 = 1 (no compression) 001 = 1/2 010 = 1/4 011 = 1/8 100 = 0 101 = Reserved 11X = Reserved Register 2Ah DRC 2 REGISTER BIT LABEL DEFAULT 10:5 DRC_KNEE_IP [5:0] 00_0000 DESCRIPTION REFER TO ADDRESS R43 (2Bh) DRC 3 Compressor threshold T (dB) 000000 = 0dB 000001 = -0.75dB 000010 = -1.5dB … (-0.75dB steps) 111100 = -45dB 111101 = Reserved 11111X = Reserved 4:0 DRC_KNEE_O P[4:0] 0_0000 Compressor amplitude at threshold YT (dB) 00000 = 0dB 00001 = -0.75dB 00010 = -1.5dB … (-0.75dB steps) 11110 = -22.5dB 11111 = Reserved Register 2Bh DRC 3 w PD, Rev 4.1, January 2012 144 WM8918 Production Data REGISTER BIT LABEL DEFAULT 7 LINMUTE 1 DESCRIPTION REFER TO ADDRESS R44 (2Ch) Analogue Left Input 0 Left Input PGA Mute 0 = not muted 1 = muted 4:0 LIN_VOL[4:0] 0_0101 Left Input PGA Volume If L_MODE = 00 (Single ended) OR L_MODE = 01 (Differential Line) 00000 = -1.5 dB 00001 = -1.3 dB 00010 = -1.0 dB 00011 = -0.7 dB 00100 = -0.3 dB 00101 = +0.0 dB (default) 00110 = +0.3 dB 00111 = +0.7 dB 01000 = +1.0 dB 01001 = +1.4 dB 01010 = +1.8 dB 01011 = +2.3 dB 01100 = +2.7 dB 01101 = +3.2 dB 01110 = +3.7 dB 01111 = +4.2 dB 10000 = +4.8 dB 10001 = +5.4 dB 10010 = +6.0 dB 10011 = +6.7 dB 10100 = +7.5 dB 10101 = +8.3 dB 10110 = +9.2 dB 10111 = +10.2 dB 11000 = +11.4 dB 11001 = +12.7 dB 11010 = +14.3 dB 11011 = +16.2 dB 11100 = +19.2 dB 11101 = +22.3 dB 11110 = +25.2 dB 11111 = +28.3 dB If L_MODE = 10 (Differential MIC) 00000 = Reserved 00001 = +12 dB 00010 = +15 dB 00011 = +18 dB 00100 = +21 dB 00101 = +24 dB (default) 00110 = +27 dB 00111 to 11111 = +30 dB Register 2Ch Analogue Left Input 0 w PD, Rev 4.1, January 2012 145 WM8918 REGISTER Production Data BIT LABEL DEFAULT 7 RINMUTE 1 DESCRIPTION REFER TO ADDRESS R45 (2Dh) Analogue Right Input 0 Right Input PGA Mute 0 = not muted 1 = muted 4:0 RIN_VOL[4:0] 0_0101 Right Input PGA Volume If R_MODE = 00 (Single ended) OR R_MODE = 01 (Differential Line) 00000 = -1.5 dB 00001 = -1.3 dB 00010 = -1.0 dB 00011 = -0.7 dB 00100 = -0.3 dB 00101 = +0.0 dB (default) 00110 = +0.3 dB 00111 = +0.7 dB 01000 = +1.0 dB 01001 = +1.4 dB 01010 = +1.8 dB 01011 = +2.3 dB 01100 = +2.7 dB 01101 = +3.2 dB 01110 = +3.7 dB 01111 = +4.2 dB 10000 = +4.8 dB 10001 = +5.4 dB 10010 = +6.0 dB 10011 = +6.7 dB 10100 = +7.5 dB 10101 = +8.3 dB 10110 = +9.2 dB 10111 = +10.2 dB 11000 = +11.4 dB 11001 = +12.7 dB 11010 = +14.3 dB 11011 = +16.2 dB 11100 = +19.2 dB 11101 = +22.3 dB 11110 = +25.2 dB 11111 = +28.3 dB If R_MODE = 10 (Differential MIC) 00000 = Reserved 00001 = +12 dB 00010 = +15 dB 00011 = +18 dB 00100 = +21 dB 00101 = +24 dB (default) 00110 = +27 dB 00111 to 11111 = +30 dB Register 2Dh Analogue Right Input 0 w PD, Rev 4.1, January 2012 146 WM8918 Production Data REGISTER BIT LABEL DEFAULT 6 INL_CM_ENA 1 DESCRIPTION REFER TO ADDRESS R46 (2Eh) Analogue Left Input 1 Left Input PGA Common Mode Rejection enable 0 = Disabled 1 = Enabled (only available for L_MODE=01 – Differential Line) 5:4 L_IP_SEL_N[1: 0] 00 In Single-Ended or Differential Line Modes, this field selects the input pin for the inverting side of the left input path. In Differential Mic Mode, this field selects the input pin for the non-inverting side of the left input path. 00 = IN1L 01 = IN2L 1X = Reserved 3:2 L_IP_SEL_P[1: 0] 01 In Single-Ended or Differential Line Modes, this field selects the input pin for the non-inverting side of the left input path. In Differential Mic Mode, this field selects the input pin for the inverting side of the left input path. 00 = IN1L 01 = IN2L 1X = Reserved 1:0 L_MODE[1:0] 00 Sets the mode for the left analogue input: 00 = Single-Ended 01 = Differential Line 10 = Differential MIC 11 = Reserved Register 2Eh Analogue Left Input 1 w PD, Rev 4.1, January 2012 147 WM8918 REGISTER Production Data BIT LABEL DEFAULT 6 INR_CM_ENA 1 DESCRIPTION REFER TO ADDRESS R47 (2Fh) Analogue Right Input 1 Right Input PGA Common Mode Rejection enable 0 = Disabled 1 = Enabled (only available for R_MODE=01 – Differential Line) 5:4 R_IP_SEL_N[1 :0] 00 In Single-Ended or Differential Line Modes, this field selects the input pin for the inverting side of the right input path. In Differential Mic Mode, this field selects the input pin for the non-inverting side of the right input path. 00 = IN1R 01 = IN2R 1X = Reserved 3:2 R_IP_SEL_P[1: 0] 01 In Single-Ended or Differential Line Modes, this field selects the input pin for the non-inverting side of the right input path. In Differential Mic Mode, this field selects the input pin for the inverting side of the right input path. 00 = IN1R 01 = IN2R 1X = Reserved 1:0 R_MODE[1:0] 00 Sets the mode for the right analogue input: 00 = Single-Ended 01 = Differential Line 10 = Differential MIC 11 = Reserved Register 2Fh Analogue Right Input 1 REGISTER BIT LABEL DEFAULT 8 HPOUTL_MUT E 0 DESCRIPTION REFER TO ADDRESS R57 (39h) Analogue OUT1 Left Left Headphone Output Mute 0 = Un-mute 1 = Mute 7 HPOUT_VU 0 Headphone Output Volume Update Writing a 1 to this bit will update HPOUTL and HPOUTR volumes simultaneously. 6 HPOUTLZC 0 Left Headphone Output Zero Cross Enable 0 = disabled 1 = enabled 5:0 HPOUTL_VOL[ 5:0] 10_1101 Left Headphone Output Volume 000000 = -57dB 000001 = -56dB (… 1dB steps) 111001 = 0dB (… 1dB steps) 111110 = +5dB 111111 = +6dB Register 39h Analogue OUT1 Left w PD, Rev 4.1, January 2012 148 WM8918 Production Data REGISTER BIT LABEL DEFAULT 8 HPOUTR_MUT E 0 HPOUT_VU 0 DESCRIPTION REFER TO ADDRESS R58 (3Ah) Analogue OUT1 Right Right Headphone Output Mute 0 = Un-mute 1 = Mute 7 Headphone Output Volume Update Writing a 1 to this bit will update HPOUTL and HPOUTR volumes simultaneously. 6 HPOUTRZC 0 Right Headphone Output Zero Cross Enable 0 = disabled 1 = enabled 5:0 HPOUTR_VOL[ 5:0] 10_1101 Right Headphone Output Volume 000000 = -57dB 000001 = -56dB (… 1dB steps) 111001 = 0dB (… 1dB steps) 111110 = +5dB 111111 = +6dB Register 3Ah Analogue OUT1 Right REGISTER BIT LABEL DEFAULT 8 LINEOUTL_MU TE 0 LINEOUT_VU 0 DESCRIPTION REFER TO ADDRESS R59 (3Bh) Analogue OUT2 Left Left Line Output Mute 0 = Un-mute 1 = Mute 7 Line Output Volume Update Writing a 1 to this bit will update LINEOUTL and LINEOUTR volumes simultaneously. 6 LINEOUTLZC 0 Left Line Output Zero Cross Enable 0 = disabled 1 = enabled 5:0 LINEOUTL_VO L[5:0] 11_1001 Left Line Output Volume 000000 = -57dB 000001 = -56dB (… 1dB steps) 111001 = 0dB (… 1dB steps) 111110 = +5dB 111111 = +6dB Register 3Bh Analogue OUT2 Left w PD, Rev 4.1, January 2012 149 WM8918 REGISTER Production Data BIT LABEL DEFAULT 8 LINEOUTR_M UTE 0 LINEOUT_VU 0 DESCRIPTION REFER TO ADDRESS R60 (3Ch) Analogue OUT2 Right Right Line Output Mute 0 = Un-mute 1 = Mute 7 Line Output Volume Update Writing a 1 to this bit will update LINEOUTL and LINEOUTR volumes simultaneously. 6 LINEOUTRZC 0 Right Line Output Zero Cross Enable 0 = disabled 1 = enabled 5:0 LINEOUTR_VO L[5:0] 11_1001 Right Line Output Volume 000000 = -57dB 000001 = -56dB (… 1dB steps) 111001 = 0dB (… 1dB steps) 111110 = +5dB 111111 = +6dB Register 3Ch Analogue OUT2 Right REGISTER BIT LABEL DEFAULT 3 HPL_BYP_EN A 0 HPR_BYP_EN A 0 DESCRIPTION REFER TO ADDRESS R61 (3Dh) Analogue OUT12 ZC Selects input for left headphone output MUX 0 = Left DAC 1 = Left input PGA (Analogue bypass) 2 Selects input for right headphone output MUX 0 = Right DAC 1 = Right input PGA (Analogue bypass) 1 LINEOUTL_BY P_ENA 0 LINEOUTR_BY P_ENA 0 Selects input for left line output MUX 0 = Left DAC 1 = Left input PGA (Analogue bypass) 0 Selects input for right line output MUX 0 = Right DAC 1 = Right input PGA (Analogue bypass) Register 3Dh Analogue OUT12 ZC REGISTER BIT LABEL DEFAULT 3 DCS_ENA_CH AN_3 0 DCS_ENA_CH AN_2 0 DESCRIPTION REFER TO ADDRESS R67 (43h) DC Servo 0 DC Servo enable for LINEOUTR 0 = disabled 1 = enabled 2 DC Servo enable for LINEOUTL 0 = disabled 1 = enabled 1 DCS_ENA_CH AN_1 0 DCS_ENA_CH AN_0 0 DC Servo enable for HPOUTR 0 = disabled 1 = enabled 0 DC Servo enable for HPOUTL 0 = disabled 1 = enabled Register 43h DC Servo 0 w PD, Rev 4.1, January 2012 150 WM8918 Production Data REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO 15 DCS_TRIG_SI NGLE_3 0 Writing 1 to this bit selects a single DC offset correction for LINEOUTR. ADDRESS R68 (44h) DC Servo 1 In readback, a value of 1 indicates that the DC Servo single correction is in progress. 14 DCS_TRIG_SI NGLE_2 0 Writing 1 to this bit selects a single DC offset correction for LINEOUTL. In readback, a value of 1 indicates that the DC Servo single correction is in progress. 13 DCS_TRIG_SI NGLE_1 0 Writing 1 to this bit selects a single DC offset correction for HPOUTR. In readback, a value of 1 indicates that the DC Servo single correction is in progress. 12 DCS_TRIG_SI NGLE_0 0 Writing 1 to this bit selects a single DC offset correction for HPOUTL. In readback, a value of 1 indicates that the DC Servo single correction is in progress. 11 DCS_TRIG_SE RIES_3 0 Writing 1 to this bit selects a series of DC offset corrections for LINEOUTR. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 10 DCS_TRIG_SE RIES_2 0 Writing 1 to this bit selects a series of DC offset corrections for LINEOUTL. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 9 DCS_TRIG_SE RIES_1 0 Writing 1 to this bit selects a series of DC offset corrections for HPOUTR. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 8 DCS_TRIG_SE RIES_0 0 Writing 1 to this bit selects a series of DC offset corrections for HPOUTL. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 7 DCS_TRIG_ST ARTUP_3 0 Writing 1 to this bit selects Start-Up DC Servo mode for LINEOUTR. In readback, a value of 1 indicates that the DC Servo Start-Up correction is in progress. 6 DCS_TRIG_ST ARTUP_2 0 Writing 1 to this bit selects Start-Up DC Servo mode for LINEOUTL. In readback, a value of 1 indicates that the DC Servo Start-Up correction is in progress. 5 DCS_TRIG_ST ARTUP_1 0 Writing 1 to this bit selects Start-Up DC Servo mode for HPOUTR. In readback, a value of 1 indicates that the DC Servo Start-Up correction is in progress. 4 DCS_TRIG_ST ARTUP_0 0 Writing 1 to this bit selects Start-Up DC Servo mode for HPOUTL. In readback, a value of 1 indicates that the DC Servo Start-Up correction is in progress. 3 DCS_TRIG_DA C_WR_3 0 Writing 1 to this bit selects DAC Write DC Servo mode for LINEOUTR. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 2 DCS_TRIG_DA C_WR_2 0 Writing 1 to this bit selects DAC Write DC Servo mode for LINEOUTL. In readback, a value of 1 indicates that the DC Servo w PD, Rev 4.1, January 2012 151 WM8918 REGISTER Production Data BIT LABEL DEFAULT 1 DCS_TRIG_DA C_WR_1 0 DESCRIPTION REFER TO ADDRESS DAC Write correction is in progress. Writing 1 to this bit selects DAC Write DC Servo mode for HPOUTR. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. 0 DCS_TRIG_DA C_WR_0 0 Writing 1 to this bit selects DAC Write DC Servo mode for HPOUTL. In readback, a value of 1 indicates that the DC Servo DAC Write correction is in progress. Register 44h DC Servo 1 REGISTER BIT LABEL DEFAULT 11:8 DCS_TIMER_P ERIOD_23[3:0] 1010 DESCRIPTION REFER TO ADDRESS R69 (45h) DC Servo 2 Time between periodic updates for LINEOUTL/LINEOUTR. Time is calculated as 0.256s x (2^PERIOD) 0000 = Off 0001 = 0.52s 1010 = 266s (4min 26s) 1111 = 8519s (2hr 22s) 7 1 1 [No description available] [No description available] 5 1 1 3:0 DCS_TIMER_P ERIOD_01[3:0] 1010 Time between periodic updates for HPOUTL/HPOUTR. Time is calculated as 0.256s x (2^PERIOD) 0000 = Off 0001 = 0.52s 1010 = 266s (4min 26s) 1111 = 8519s (2hr 22s) Register 45h DC Servo 2 REGISTER BIT LABEL DEFAULT 6:0 DCS_SERIES_ NO_23[6:0] 010_1010 DESCRIPTION REFER TO ADDRESS R71 (47h) DC Servo 4 Number of DC Servo updates to perform in a series event for LINEOUTL/LINEOUTR. 0 = 1 updates 1 = 2 updates ... 127 = 128 updates Register 47h DC Servo 4 REGISTER BIT LABEL DEFAULT 6:0 DCS_SERIES_ NO_01[6:0] 010_1010 DESCRIPTION REFER TO ADDRESS R72 (48h) DC Servo 5 Number of DC Servo updates to perform in a series event for HPOUTL/HPOUTR. 0 = 1 updates 1 = 2 updates ... 127 = 128 updates Register 48h DC Servo 5 w PD, Rev 4.1, January 2012 152 WM8918 Production Data REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R73 (49h) DC Servo 6 7:0 DCS_DAC_WR 0000_0000 DC Offset value for LINEOUTR in DAC Write DC Servo mode in two's complement format. _VAL_3[7:0] In readback, the current DC offset value is returned in two's complement format. Two’s complement format: LSB is 0.25mV. Range is +/-32mV Register 49h DC Servo 6 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R74 (4Ah) DC Servo 7 7:0 DCS_DAC_WR 0000_0000 DC Offset value for LINEOUTL in DAC Write DC Servo mode in two's complement format. _VAL_2[7:0] In readback, the current DC offset value is returned in two's complement format. Two’s complement format: LSB is 0.25mV. Range is +/-32mV Register 4Ah DC Servo 7 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R75 (4Bh) DC Servo 8 7:0 DCS_DAC_WR 0000_0000 DC Offset value for HPOUTR in DAC Write DC Servo mode in two's complement format. _VAL_1[7:0] In readback, the current DC offset value is returned in two's complement format. Two’s complement format: LSB is 0.25mV. Range is +/-32mV Register 4Bh DC Servo 8 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R76 (4Ch) DC Servo 9 7:0 DCS_DAC_WR 0000_0000 DC Offset value for HPOUTL in DAC Write DC Servo mode in two's complement format. _VAL_0[7:0] In readback, the current DC offset value is returned in two's complement format. Two’s complement format: LSB is 0.25mV. Range is +/-32mV Register 4Ch DC Servo 9 w PD, Rev 4.1, January 2012 153 WM8918 REGISTER Production Data BIT LABEL DEFAULT 11:8 DCS_CAL_CO MPLETE[3:0] 0000 DESCRIPTION REFER TO ADDRESS R77 (4Dh) DC Servo Readback 0 DC Servo Complete status [3] - LINEOUTR [2] - LINEOUTL [1] - HPOUTR [0] - HPOUTL 0 = DAC Write or Start-Up DC Servo mode not completed. 1 = DAC Write or Start-Up DC Servo mode complete. 7:4 DCS_DAC_WR _COMPLETE[3 :0] 0000 DC Servo DAC Write status [3] - LINEOUTR [2] - LINEOUTL [1] - HPOUTR [0] - HPOUTL 0 = DAC Write DC Servo mode not completed. 1 = DAC Write DC Servo mode complete. 3:0 DCS_STARTU P_COMPLETE [3:0] 0000 DC Servo Start-Up status [3] - LINEOUTR [2] - LINEOUTL [1] - HPOUTR [0] - HPOUTL 0 = Start-Up DC Servo mode not completed.. 1 = Start-Up DC Servo mode complete. Register 4Dh DC Servo Readback 0 REGISTER BIT LABEL DEFAULT 7 HPL_RMV_SH ORT 0 DESCRIPTION REFER TO ADDRESS R90 (5Ah) Analogue HP 0 Removes HPOUTL short 0 = HPOUTL short enabled 1 = HPOUTL short removed For normal operation, this bit should be set as the final step of the HPL Enable sequence. 6 HPL_ENA_OU TP 0 Enables HPOUTL output stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the DC offset cancellation has been scheduled. 5 HPL_ENA_DLY 0 Enables HPOUTL intermediate stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the output signal path has been configured, and before DC offset cancellation is scheduled. This bit should be set with at least 20us delay after HPL_ENA. 4 HPL_ENA 0 Enables HPOUTL input stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set as the first step of the HPL Enable sequence. w PD, Rev 4.1, January 2012 154 WM8918 Production Data REGISTER BIT LABEL DEFAULT 3 HPR_RMV_SH ORT 0 DESCRIPTION REFER TO ADDRESS Removes HPOUTR short 0 = HPOUTR short enabled 1 = HPOUTR short removed For normal operation, this bit should be set as the final step of the HPR Enable sequence. 2 HPR_ENA_OU TP 0 Enables HPOUTR output stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the DC offset cancellation has been scheduled. 1 HPR_ENA_DL Y 0 Enables HPOUTR intermediate stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the output signal path has been configured, and before DC offset cancellation is scheduled. This bit should be set with at least 20us delay after HPR_ENA. 0 HPR_ENA 0 Enables HPOUTR input stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set as the first step of the HPR Enable sequence. Register 5Ah Analogue HP 0 REGISTER BIT LABEL DEFAULT 7 LINEOUTL_RM V_SHORT 0 DESCRIPTION REFER TO ADDRESS R94 (5Eh) Analogue Lineout 0 Removes LINEOUTL short 0 = LINEOUTL short enabled 1 = LINEOUTL short removed For normal operation, this bit should be set as the final step of the LINEOUTL Enable sequence. 6 LINEOUTL_EN A_OUTP 0 Enables LINEOUTL output stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the DC offset cancellation has been scheduled. 5 LINEOUTL_EN A_DLY 0 Enables LINEOUTL intermediate stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the output signal path has been configured, and before DC offset cancellation is scheduled. This bit should be set with at least 20us delay after LINEOUTL_ENA. 4 LINEOUTL_EN A 0 Enables LINEOUTL input stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set as the first step of the LINEOUTL Enable sequence. 3 LINEOUTR_R MV_SHORT 0 Removes LINEOUTR short 0 = LINEOUTR short enabled 1 = LINEOUTR short removed For normal operation, this bit should be set as the final step of the LINEOUTR Enable sequence. w PD, Rev 4.1, January 2012 155 WM8918 REGISTER Production Data BIT LABEL DEFAULT 2 LINEOUTR_EN A_OUTP 0 DESCRIPTION REFER TO ADDRESS Enables LINEOUTR output stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the DC offset cancellation has been scheduled. 1 LINEOUTR_EN A_DLY 0 Enables LINEOUTR intermediate stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set to 1 after the output signal path has been configured, and before DC offset cancellation is scheduled. This bit should be set with at least 20us delay after LINEOUTR_ENA. 0 LINEOUTR_EN A 0 Enables LINEOUTR input stage 0 = Disabled 1 = Enabled For normal operation, this bit should be set as the first step of the LINEOUTR Enable sequence. Register 5Eh Analogue Lineout 0 REGISTER BIT LABEL DEFAULT 0 CP_ENA 0 DESCRIPTION REFER TO ADDRESS R98 (62h) Charge Pump 0 Enable charge-pump digits 0 = disable 1 = enable Register 62h Charge Pump 0 REGISTER BIT LABEL DEFAULT 0 CP_DYN_PWR 0 DESCRIPTION REFER TO ADDRESS R104 (68h) Class W 0 Enable dynamic charge pump power control 0 = Charge pump controlled by volume register settings (Class G) 1 = Charge pump controlled by real-time audio level (Class W) Class W is recommended for lowest power consumption. Register 68h Class W 0 REGISTER BIT LABEL DEFAULT 8 WSEQ_ENA 0 DESCRIPTION REFER TO ADDRESS R108 (6Ch) Write Sequencer 0 Write Sequencer Enable. 0 = Disabled 1 = Enabled 4:0 WSEQ_WRITE _INDEX[4:0] 0_0000 Sequence Write Index. This is the memory location to which any updates to R109 and R110 will be copied. 0 to 31 = RAM addresses Register 6Ch Write Sequencer 0 w PD, Rev 4.1, January 2012 156 WM8918 Production Data REGISTER BIT LABEL DEFAULT 14:12 WSEQ_DATA_ WIDTH[2:0] 000 DESCRIPTION REFER TO ADDRESS R109 (6Dh) Write Sequencer 1 Width of the data block written in this sequence step. 000 = 1 bit 001 = 2 bits 010 = 3 bits 011 = 4 bits 100 = 5 bits 101 = 6 bits 110 = 7 bits 111 = 8 bits 11:8 WSEQ_DATA_ START[3:0] 0000 Bit position of the LSB of the data block written in this sequence step. 0000 = Bit 0 … 1111 = Bit 15 7:0 WSEQ_ADDR[ 0000_0000 Control Register Address to be written to in this sequence step. 7:0] Register 6Dh Write Sequencer 1 REGISTER BIT LABEL DEFAULT 14 WSEQ_EOS 0 DESCRIPTION REFER TO ADDRESS R110 (6Eh) Write Sequencer 2 End of Sequence flag. This bit indicates whether the Control Write Sequencer should stop after executing this step. 0 = Not end of sequence 1 = End of sequence (Stop the sequencer after this step). 11:8 WSEQ_DELAY [3:0] 0000 Time delay after executing this step. Total delay time per step (including execution)= 62.5µs × (2^WSEQ_DELAY + 8) 7:0 WSEQ_DATA[ 0000_0000 Data to be written in this sequence step. When the data width is less than 8 bits, then one or more of the MSBs 7:0] of WSEQ_DATA are ignored. It is recommended that unused bits be set to 0. Register 6Eh Write Sequencer 2 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO 9 WSEQ_ABOR T 0 Writing a 1 to this bit aborts the current sequence and returns control of the device back to the serial control interface. 8 WSEQ_START 0 Writing a 1 to this bit starts the write sequencer at the memory location indicated by the WSEQ_START_INDEX field. The sequence continues until it reaches an “End of sequence” flag. At the end of the sequence, this bit will be reset by the Write Sequencer. 5:0 WSEQ_START _INDEX[5:0] 00_0000 ADDRESS R111 (6Fh) Write Sequencer 3 Sequence Start Index. This is the memory location of the first command in the selected sequence. 0 to 31 = RAM addresses 32 to 48 = ROM addresses 49 to 63 = Reserved Register 6Fh Write Sequencer 3 w PD, Rev 4.1, January 2012 157 WM8918 REGISTER Production Data BIT LABEL DEFAULT 9:4 WSEQ_CURR ENT_INDEX[5: 0] 00_0000 WSEQ_BUSY 0 DESCRIPTION REFER TO ADDRESS R112 (70h) Write Sequencer 4 0 Sequence Current Index (read only): This is the location of the most recently accessed command in the write sequencer memory. Sequencer Busy flag (read only): 0 = Sequencer idle 1 = Sequencer busy Note: it is not possible to write to control registers via the control interface while the Sequencer is Busy. Register 70h Write Sequencer 4 REGISTER BIT LABEL DEFAULT 2 FLL_FRACN_E NA 0 DESCRIPTION REFER TO ADDRESS R116 (74h) FLL Control 1 FLL Fractional enable 0 = Integer Mode 1 = Fractional Mode Fractional Mode (FLL_FRACN_ENA=1) is recommended in all cases 1 FLL_OSC_EN A 0 FLL Oscillator enable 0 = Disabled 1 = Enabled FLL_OSC_ENA must be enabled before enabling FLL_ENA. Note that this field is required for free-running FLL modes only. 0 FLL_ENA 0 FLL Enable 0 = Disabled 1 = Enabled FLL_OSC_ENA must be enabled before enabling FLL_ENA. Register 74h FLL Control 1 REGISTER BIT LABEL DEFAULT 13:8 FLL_OUTDIV[5 :0] 00_0000 DESCRIPTION REFER TO ADDRESS R117 (75h) FLL Control 2 FLL FOUT clock divider 00_0000 = Reserved 00_0001 = Reserved 00_0010 = Reserved 00_0011 = 4 00_0100 = 5 00_0101 = 6 … 11_1110 = 63 11_1111 = 64 (FOUT = FVCO / FLL_OUTDIV) 6:4 FLL_CTRL_RA TE[2:0] w 000 Frequency of the FLL control block 000 = FVCO / 1 (Recommended value) PD, Rev 4.1, January 2012 158 WM8918 Production Data REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS 001 = FVCO / 2 010 = FVCO / 3 011 = FVCO / 4 100 = FVCO / 5 101 = FVCO / 6 110 = FVCO / 7 111 = FVCO / 8 Recommended that these are not changed from default. 2:0 FLL_FRATIO[2: 0] 111 FVCO clock divider 000 = 1 001 = 2 010 = 4 011 = 8 1XX = 16 000 recommended for FREF > 1MHz 100 recommended for FREF < 64kHz Register 75h FLL Control 2 REGISTER BIT LABEL 15:0 FLL_K[15:0] DEFAULT DESCRIPTION REFER TO ADDRESS R118 (76h) FLL Control 3 0000_0000 Fractional multiply for FREF _0000_000 (MSB = 0.5) 0 Register 76h FLL Control 3 REGISTER BIT LABEL 14:5 FLL_N[9:0] 3:0 FLL_GAIN[3:0] DEFAULT DESCRIPTION REFER TO ADDRESS R119 (77h) FLL Control 4 01_0111_0 Integer multiply for FREF 111 (LSB = 1) 0000 FLL Gain applied to error 0000 = x 1 (Recommended value) 0001 = x 2 0010 = x 4 0011 = x 8 0100 = x 16 0101 = x 32 0110 = x 64 0111 = x 128 1000 = x 256 Recommended that these are not changed from default. Register 77h FLL Control 4 w PD, Rev 4.1, January 2012 159 WM8918 REGISTER Production Data BIT LABEL DEFAULT 4:3 FLL_CLK_REF _DIV[1:0] 00 DESCRIPTION REFER TO ADDRESS R120 (78h) FLL Control 5 FLL Clock Reference Divider 00 = MCLK / 1 01 = MCLK / 2 10 = MCLK / 4 11 = MCLK / 8 MCLK (or other input reference) must be divided down to <=13.5MHz. For lower power operation, the reference clock can be divided down further if desired. 1:0 FLL_CLK_REF _SRC[1:0] 00 FLL Clock source 00 = MCLK 01 = BCLK 10 = LRCLK 11 = Reserved Register 78h FLL Control 5 REGISTER BIT LABEL DEFAULT 5 GPIO1_PU 0 DESCRIPTION REFER TO ADDRESS R121 (79h) GPIO Control 1 GPIO1 pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 4 GPIO1_PD 1 GPIO1 pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled 3:0 GPIO1_SEL[3: 0] 0100 GPIO1 Function Select 0000 = Input pin 0001 = Clock output (f=SYSCLK/OPCLKDIV) 0010 = Logic '0' 0011 = Logic '1' 0100 = IRQ (deafult) 0101 = FLL Lock 0110 = Mic Detect 0111 = Mic Short 1000 = DMIC clock out 1001 = FLL Clock Output 1010 to 1111 = Reserved Register 79h GPIO Control 1 w PD, Rev 4.1, January 2012 160 WM8918 Production Data REGISTER BIT LABEL DEFAULT 9 GPI7_ENA 0 DESCRIPTION REFER TO ADDRESS R124 (7Ch) GPIO Control 4 GPI7 input enable 0 = disabled 1 = enabled 8 GPI8_ENA 0 GPI8 input enable 0 = disabled 1 = enabled 7 GPIO_BCLK_ MODE_ENA 0 Selects BCLK/GPIO4 pin function 0 = BCLK/GPIO4 is used as BCLK 1 = BCLK/GPIO4 is used as GPIO. MCLK provides the BCLK in the AIF in this mode. 3:0 GPIO_BCLK_S EL[3:0] 0000 GPIO_BCLK function select: 0000 = Input Pin (deafult) 0001 = Clock output (f=SYSCLK/OPCLKDIV) 0010 = Logic '0' 0011 = Logic '1' 0100 = IRQ 0101 = FLL Lock 0110 = Mic Detect 0111 = Mic Short 1000 = DMIC clock out 1001 = FLL Clock Output 1010 to 1111 = Reserved Register 7Ch GPIO Control 4 REGISTER BIT LABEL DEFAULT 7 MCLK_PU 0 DESCRIPTION REFER TO ADDRESS R126 (7Eh) Digital Pulls MCLK pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 6 MCLK_PD 0 MCLK pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled 5 AIFRXDAT_PU 0 AIFRXDAT pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 4 AIFRXDAT_PD 0 AIFRXDAT pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled 3 LRCLK_PU 0 LRCLK pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 2 LRCLK_PD 0 LRCLK pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled 1 BCLK_PU 0 BCLK pull-up resistor enable 0 = pull-up disabled 1 = pull-up enabled 0 BCLK_PD 0 BCLK pull-down resistor enable 0 = pull-down disabled 1 = pull-down enabled Register 7Eh Digital Pulls w PD, Rev 4.1, January 2012 161 WM8918 REGISTER Production Data BIT LABEL DEFAULT DESCRIPTION 10 IRQ 0 Logical OR of all other interrupt flags 0 GPIO4 interrupt REFER TO ADDRESS R127 (7Fh) Interrupt Status 9 GPIO_BCLK_E INT 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 8 WSEQ_EINT 0 Write Sequence interrupt 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written. Note that the read value of WSEQ_EINT is not valid whilst the Write Sequencer is Busy 5 GPIO1_EINT 0 GPIO1 interrupt 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 4 GPI8_EINT 0 GPI8 interrupt 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 3 GPI7_EINT 0 GPI7 interrupt 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 2 FLL_LOCK_EI NT 0 FLL Lock interrupt 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 1 MIC_SHRT_EI NT 0 MICBIAS short circuit interrupt 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written 0 MIC_DET_EIN T 0 MICBIAS current detect interrupt 0 = interrupt not set 1 = interrupt is set Cleared when a ‘1’ is written Register 7Fh Interrupt Status w PD, Rev 4.1, January 2012 162 WM8918 Production Data REGISTER BIT LABEL DEFAULT 9 IM_GPIO_BCL K_EINT 1 IM_WSEQ_EIN T 1 IM_GPIO1_EIN T 1 IM_GPI8_EINT 1 DESCRIPTION REFER TO ADDRESS R128 (80h) Interrupt Status Mask GPIO4 interrupt mask 0 = do not mask interrupt 1 = mask interrupt 8 Write sequencer interrupt mask 0 = do not mask interrupt 1 = mask interrupt 5 GPIO1 interrupt mask 0 = do not mask interrupt 1 = mask interrupt 4 GPI8 interrupt mask 0 = do not mask interrupt 1 = mask interrupt 3 IM_GPI7_EINT 1 GPI7 interrupt mask 0 = do not mask interrupt 1 = mask interrupt 2 IM_FLL_LOCK _EINT 1 IM_MIC_SHRT _EINT 1 IM_MIC_DET_ EINT 1 FLL Lock interrupt mask 0 = do not mask interrupt 1 = mask interrupt 1 MICBIAS short circuit interrupt mask 0 = do not mask interrupt 1 = mask interrupt 0 MICBIAS current detect interrupt mask 0 = do not mask interrupt 1 = mask interrupt Register 80h Interrupt Status Mask REGISTER BIT LABEL DEFAULT 9 GPIO_BCLK_E INT_POL 0 WSEQ_EINT_ POL 0 GPIO1_EINT_ POL 0 GPI8_EINT_P OL 0 GPI7_EINT_P OL 0 FLL_LOCK_EI NT_POL 0 DESCRIPTION REFER TO ADDRESS R129 (81h) Interrupt Polarity GPIO4 interrupt polarity 0 = active high 1 = active low 8 Write Sequencer interrupt polarity 0 = active high (interrupt is triggered when WSEQ is busy) 1 = active low (interrupt is triggered when WSEQ is idle) 5 GPIO1 interrupt polarity 0 = active high 1 = active low 4 GPI8 interrupt polarity 0 = active high 1 = active low 3 GPI7 interrupt polarity 0 = active high 1 = active low 2 FLL Lock interrupt polarity 0 = active high (interrupt is triggered when FLL Lock is reached) 1 = active low (interrupt is triggered when FLL is not locked) 1 MIC_SHRT_EI NT_POL w 0 MICBIAS short circuit interrupt polarity 0 = active high PD, Rev 4.1, January 2012 163 WM8918 REGISTER Production Data BIT LABEL DEFAULT 0 MIC_DET_EIN T_POL 0 DESCRIPTION REFER TO ADDRESS 1 = active low MICBIAS current detect interrupt polarity 0 = active high 1 = active low Register 81h Interrupt Polarity REGISTER BIT LABEL DEFAULT 9 GPIO_BCLK_E INT_DB 0 WSEQ_EINT_ DB 0 GPIO1_EINT_ DB 0 DESCRIPTION REFER TO ADDRESS R130 (82h) Interrupt Debounce GPIO4 interrupt debounce 0 = disabled 1 = enabled 8 Write Sequencer interrupt debounce enable 0 = disabled 1 = enabled 5 GPIO1 input debounce 0 = disabled 1 = enabled 4 GPI8_EINT_D B 0 GPI7_EINT_D B 0 FLL_LOCK_EI NT_DB 0 MIC_SHRT_EI NT_DB 0 MIC_DET_EIN T_DB 0 GPI8 input debounce 0 = disabled 1 = enabled 3 GPI7 input debounce 0 = disabled 1 = enabled 2 FLL Lock debounce 0 = disabled 1 = enabled 1 MICBIAS short circuit interrupt debounce 0 = disabled 1 = enabled 0 MICBIAS current detect interrupt debounce 0 = disabled 1 = enabled Register 82h Interrupt Debounce REGISTER BIT LABEL DEFAULT 0 EQ_ENA 0 DESCRIPTION REFER TO ADDRESS R134 (86h) EQ1 EQ enable 0 = EQ disabled 1 = EQ enabled Register 86h EQ1 w PD, Rev 4.1, January 2012 164 WM8918 Production Data REGISTER BIT LABEL DEFAULT 4:0 EQ_B1_GAIN[ 4:0] 0_1100 DESCRIPTION REFER TO ADDRESS R135 (87h) EQ2 Gain for EQ band 1 00000 = -12dB 00001 = -11dB (… 1dB steps) 01100 = 0dB (… 1dB steps) 11000 = +12dB 11001 to 11111 = reserved Register 87h EQ2 REGISTER BIT LABEL DEFAULT 4:0 EQ_B2_GAIN[ 4:0] 0_1100 DESCRIPTION REFER TO ADDRESS R136 (88h) EQ3 Gain for EQ band 2 00000 = -12dB 00001 = -11dB (… 1dB steps) 01100 = 0dB (… 1dB steps) 11000 = +12dB 11001 to 11111 = reserved Register 88h EQ3 REGISTER BIT LABEL DEFAULT 4:0 EQ_B3_GAIN[ 4:0] 0_1100 DESCRIPTION REFER TO ADDRESS R137 (89h) EQ4 Gain for EQ band 3 00000 = -12dB 00001 = -11dB (… 1dB steps) 01100 = 0dB (… 1dB steps) 11000 = +12dB 11001 to 11111 = reserved Register 89h EQ4 REGISTER BIT LABEL DEFAULT 4:0 EQ_B4_GAIN[ 4:0] 0_1100 DESCRIPTION REFER TO ADDRESS R138 (8Ah) EQ5 Gain for EQ band 4 00000 = -12dB 00001 = -11dB (… 1dB steps) 01100 = 0dB (… 1dB steps) 11000 = +12dB 11001 to 11111 = reserved Register 8Ah EQ5 w PD, Rev 4.1, January 2012 165 WM8918 REGISTER Production Data BIT LABEL DEFAULT 4:0 EQ_B5_GAIN[ 4:0] 0_1100 DESCRIPTION REFER TO ADDRESS R139 (8Bh) EQ6 Gain for EQ band5 00000 = -12dB 00001 = -11dB (… 1dB steps) 01100 = 0dB (… 1dB steps) 11000 = +12dB 11001 to 11111 = reserved Register 8Bh EQ6 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R140 (8Ch) EQ7 15:0 EQ_B1_A[15:0] 0000_1111 EQ Band 1 Coefficient A _1100_101 0 Register 8Ch EQ7 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R141 (8Dh) EQ8 15:0 EQ_B1_B[15:0] 0000_0100 EQ Band 1 Coefficient B _0000_000 0 Register 8Dh EQ8 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R142 (8Eh) EQ9 15:0 EQ_B1_PG[15: 0000_0000 EQ Band 1 Coefficient PG 0] _1101_100 0 Register 8Eh EQ9 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R143 (8Fh) EQ10 15:0 EQ_B2_A[15:0] 0001_1110 EQ Band 2 Coefficient A _1011_010 1 Register 8Fh EQ10 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R144 (90h) EQ11 15:0 EQ_B2_B[15:0] 1111_0001 EQ Band 2 Coefficient B _0100_010 1 Register 90h EQ11 w PD, Rev 4.1, January 2012 166 WM8918 Production Data REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R145 (91h) EQ12 15:0 EQ_B2_C[15:0] 0000_1011 EQ Band 2 Coefficient C _0111_010 1 Register 91h EQ12 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R146 (92h) EQ13 15:0 EQ_B2_PG[15: 0000_0001 EQ Band 2 Coefficient PG 0] _1100_010 1 Register 92h EQ13 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R147 (93h) EQ14 15:0 EQ_B3_A[15:0] 0001_1100 EQ Band 3 Coefficient A _0101_100 0 Register 93h EQ14 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R148 (94h) EQ15 15:0 EQ_B3_B[15:0] 1111_0011 EQ Band 3 Coefficient B _0111_001 1 Register 94h EQ15 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R149 (95h) EQ16 15:0 EQ_B3_C[15:0] 0000_1010 EQ Band 3 Coefficient C _0101_010 0 Register 95h EQ16 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R150 (96h) EQ17 15:0 EQ_B3_PG[15: 0000_0101 EQ Band 3 Coefficient PG 0] _0101_100 0 Register 96h EQ17 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R151 (97h) EQ18 15:0 EQ_B4_A[15:0] 0001_0110 EQ Band 4 Coefficient A _1000_111 0 Register 97h EQ18 w PD, Rev 4.1, January 2012 167 WM8918 REGISTER Production Data BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R152 (98h) EQ19 15:0 EQ_B4_B[15:0] 1111_1000 EQ Band 4 Coefficient B _0010_100 1 Register 98h EQ19 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R153 (99h) EQ20 15:0 EQ_B4_C[15:0] 0000_0111 EQ Band 4 Coefficient C _1010_110 1 Register 99h EQ20 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R154 (9Ah) EQ21 15:0 EQ_B4_PG[15: 0001_0001 EQ Band 4 Coefficient PG 0] _0000_001 1 Register 9Ah EQ21 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R155 (9Bh) EQ22 15:0 EQ_B5_A[15:0] 0000_0101 EQ Band 5 Coefficient A _0110_010 0 Register 9Bh EQ22 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R156 (9Ch) EQ23 15:0 EQ_B5_B[15:0] 0000_0101 EQ Band 1 Coefficient B _0101_100 1 Register 9Ch EQ23 REGISTER BIT LABEL DEFAULT DESCRIPTION REFER TO ADDRESS R157 (9Dh) EQ24 15:0 EQ_B5_PG[15: 0100_0000 EQ Band 5 Coefficient PG 0] _0000_000 0 Register 9Dh EQ24 w PD, Rev 4.1, January 2012 168 WM8918 Production Data REGISTER BIT LABEL DEFAULT 0 FLL_FRC_NC O 0 DESCRIPTION REFER TO ADDRESS R247 (F7h) FLL NCO Test 0 FLL Forced control select 0 = Normal 1 = FLL oscillator controlled by FLL_FRC_NCO_VAL (Note that this field is required for free-running FLL modes only) Register F7h FLL NCO Test 0 REGISTER BIT LABEL DEFAULT 5:0 FLL_FRC_NC O_VAL[5:0] 01_1001 DESCRIPTION REFER TO ADDRESS R248 (F8h) FLL NCO Test 1 FLL Forced oscillator value Valid range is 000000 to 111111 0x19h (011001) = 12MHz approx (Note that this field is required for free-running FLL modes only) Register F8h FLL NCO Test 1 w PD, Rev 4.1, January 2012 169 WM8918 Production Data APPLICATIONS INFORMATION RECOMMENDED EXTERNAL COMPONENTS Figure 71 Recommended External Components Notes: 1. Decoupling Capacitors X5R ceramic capacitor is recommended for capacitors C1, C2, C3, C4, C5, C15, C16, C17 and C18. The positioning of C17 and C18 is very important - these should be as close to the WM8918 as possible. Capacitors C15 and C16 should also be positioned as close to the WM8918 as possible. 2. Charge Pump Capacitors Specific recommendations for C14, C15 and C16 are provided in Table 88. Note that two different recommendations are provided for C15 and C16; either of these components is suitable, depending upon size requirements and availability. The positioning of C14 is very important - this should be as close to the WM8918 as possible. It is important to select a suitable capacitor type for the Charge Pump. Note that the capacitance may vary with DC voltage; care is required to ensure that required capacitance is achieved at the applicable operating voltage, as specified in Table 88. The capacitor datasheet should be consulted for this information. COMPONENT REQUIRED CAPACITANCE C14 (CPCA-CPCB) 1F at 2VDC 2F at 2VDC 4.7F C15 (CPVOUTN) C16 (CPVOUTP) VALUE PART NUMBER VOLTAGE TYPE SIZE 2.2F Kemet C0402C225M9PAC 6.3v X5R 0402 2.2F MuRata GRM188R61A225KE34D 10v X5R 0603 MuRata GRM155R60J475M_EIA 6.3v X5R 0402 Table 88 Charge Pump Capacitors w PD, Rev 4.1, January 2012 170 WM8918 Production Data 3. Zobel Networks The Zobel network shown in Figure 71 is required on HPOUTL, HPOUTR, LINEOUTL and LINEOUTR whenever that output is enabled. Stability of these ground-referenced outputs across all process corners cannot be guaranteed without the Zobel network components. (Note that, if any ground-referenced output pin is not required, the zobel network components can be omitted from the output pin, and the pin can be left floating.) The Zobel network requirement is detailed further in the applications note WAN_0212 “Class W Headphone Impedance Compensation”. Zobel networks (C6, C7, C8, C9, R1, R2, R3, R4) should be positioned reasonably close to the WM8918. 4. Microphone Grounding R7 can be populated with other values to remove common mode noise on the microphone if required. w PD, Rev 4.1, January 2012 171 WM8918 Production Data MIC DETECTION SEQUENCE USING MICBIAS CURRENT This section details an example sequence which summarises how the host processor can configure and detect the events supported by the MICBIAS current detect function (see “Electret Condenser Microphone Interface”): Mic insertion/removal Hook switch press/release Figure 72 shows an example of how the MICBIAS current flow varies versus time, during mic insertion and hook switch events. The Y axis is annotated with the Mic detection thresholds, and the X axis is annotated with the stages of an example sequence as detailed in Table 89, to illustrate how the host processor can implement mic insertion and hook switch detection. The sequence assumes that the microphone insertion and hook switch detection functions are monitored by polling the interrupt flags using the control interface. Note that the maximum mechanical bounce times for mic insertion and removal must be fully understood by the software programmer. A GPIO pin could be used as an alternative mechanism to monitor the MICBIAS detection functions. This enables the host processor to detect mechanical bounce at any time. Example plot of MICBIAS Current versus time (1) Step (2) (3) (4) (5) (6) (7) (8) (9) (10) MICBIAS Current Mic inserted TSHORT Hook switch pressed Mic Hook Switch Threshold TDET TDET Hysteresis TSHORT Mic Detect Threshold Step (1) (2) (3) (4) (5) (6) (7) (8) Time (9) (10) Mic Detect Interrupt MIC_DET_EINT Mic Detect Interrupt Polarity MIC_DET_EINT_POL MIC_SHRT_EINT Mic Short Interrupt Mic Short Interrupt Polarity Read the Mic detect interrupt HOST PROCESSOR flag. If high, can then set MIC_DET_EINT_POL to 1, but only if mechanical bounce phase has finished. Clear MIC_DET_EINT by writing ‘1’. MIC_SHRT_EINT_POL Read the Hook switch interrupt flag. If high, can immediately set MIC_SHRT_EINT_POL to 1. Clear MIC_SHRT_EINT by writing ‘1’. Read the Mic detect interrupt flag. If high, can then clear MIC_DET_EINT_POL to 0, but only if mechanical bounce phase has finished. Clear MIC_DET_EINT by writing ‘1’. Read the Hook switch interrupt flag. If high, can immediately clear MIC_SHRT_EINT_POL to 0. Clear MIC_SHRT_EINT by writing ‘1’. Figure 72 Mic Insert and Hook Switch Detect: Example MICBIAS Current Plot w PD, Rev 4.1, January 2012 172 WM8918 Production Data STEP DETAILS 1 Mic not inserted. To detect mic insertion, Host processor must initialise interrupts and clear MIC_DET_EINT_POL = 0. At every step, the host processor should poll the interrupt status register. Note that Mic Insertion de-bounce circuitry can be enabled by setting MIC_DET_EINT_DB = 1. 2 Mechanical bounce of jack socket during Mic insertion. Host processor may already detect a mic insertion interrupt (MIC_DET_EINT) during this step. Once detected, the host processor can set MIC_DET_EINT_POL = 1 and then clear the interrupt, unless mechanical bounce can last longer than the shortest possible TDET, in which case the host processor should wait until step 3. 3 Mic fully inserted. If not already set, the host processor must now set MIC_DET_EINT_POL = 1. If not already cleared, the host processor must now clear the MIC_DET_EINT interrupt. To detect Hook switch press, the host processor must clear MIC_SHRT_EINT_POL = 0. At this step, the diagram shows no AC current swing, due to a very low ambient noise level. 4 Mic fully inserted. Diagram shows AC current swing due to high levels of background noise (such as wind). 5 Mechanical bounce during hook switch press. The hook switch interrupt is unlikely to be set during this step, because 10 successive samples of the MICBIAS current exceeding the hook switch threshold have not yet been sampled. Note that Hook Switch de-bounce circuitry can be enabled by setting MIC_SHRT_EINT_DB = 1. 6 Hook switch is fully pressed down. After TSHORT, 10 successive samples of the MICBIAS current exceeding the hook switch threshold have been detected, hence a hook switch interrupt (MIC_SHRT_EINT) will be generated. Once detected, the host processor can immediately set MIC_SHRT_EINT_POL = 1 and then clear the MIC_SHRT_EINT interrupt. 7 Mechanical bounce during hook switch release. The hook switch interrupt is unlikely to be set during this step, because 10 successive samples of the MICBIAS current lower than the hook switch threshold have not yet been sampled. 8 Hook switch fully released. After TSHORT, 10 successive samples of the MICBIAS current lower than the hook switch threshold have been detected, hence a hook switch interrupt (MIC_SHRT_EINT) will be generated. Once detected, the host processor can immediately clear MIC_SHRT_EINT_POL = 0 and then clear the MIC_SHRT_EINT interrupt. 9 Mechanical bounce of jack socket during Mic removal. Host processor may already detect a mic removal interrupt (MIC_DET_EINT) during this step. Once detected, the host processor can clear MIC_DET_EINT_POL = 0 and then clear the interrupt, unless mechanical bounce can last longer than the shortest possible TDET, in which case the host processor should wait until step 10. 10 Mic fully removed. If not already cleared, the host processor must now clear MIC_DET_EINT_POL = 0. If not already cleared, the host processor must now clear the MIC_DET_EINT interrupt. Table 89 Mic Insert and Hook Switch Detect: Example Sequence Alternatively, utilising a GPIO pin to monitor the MICBIAS current detect functionality permits the host processor to monitor the steady state of microphone detection or hook switch press functions. Because the GPIO shows the steady state condition, software de-bounce may be easier to implement in the host processor, dependant on the processor performance characteristics, hence use of the GPIO is likely to simplify the rejection of mechanical bounce. Changes of state in the GPIO pin are also subject to the time delays tDET and tSHORT. w PD, Rev 4.1, January 2012 173 WM8918 Production Data PACKAGE DIMENSIONS FL: 32 PIN QFN PLASTIC PACKAGE 4 X 4 X 0.75 mm BODY, 0.40 mm LEAD PITCH DM067.A D D2 32 25 L 1 24 4 EXPOSED GROUND 6 PADDLE A INDEX AREA (D/2 X E/2) E2 17 E 8 2X 16 15 9 b B e 1 bbb M C A B 2X aaa C aaa C TOP VIEW BOTTOM VIEW ccc C A3 A 0.08 C C SEATING PLANE 5 A1 SIDE VIEW DETAIL 1 A3 G b Exposed lead DETAIL 1 2.65 Dimensions (mm) NOM MAX NOTE 0.75 0.8 0.035 0.05 0.203 REF 0.2 0.25 1 4.00 BSC 2.7 2.75 2 4.00 BSC 2.7 2.75 2 0.35 0.40 BSC 0.5 0.40 Symbols A A1 A3 b D D2 E E2 e G L aaa bbb ccc REF: MIN 0.70 0 0.15 2.65 0.45 Tolerances of Form and Position 0.05 0.10 0.10 NOTES: 1. DIMENSION b APPLIES TO METALLIZED TERMINAL AND IS MEASURED BETWEEN 0.15 mm AND 0.25 mm FROM TERMINAL TIP. 2. ALL DIMENSIONS ARE IN MILLIMETRES. 3. THE TERMINAL #1 IDENTIFIER AND TERMINAL NUMBERING CONVENTION SHALL CONFORM TO JEDEC 95-1 SPP-002. 4. COPLANARITY APPLIES TO THE EXPOSED HEAT SINK SLUG AS WELL AS THE TERMINALS. 5. REFER TO APPLICATION NOTE WAN_0118 FOR FURTHER INFORMATION REGARDING PCB FOOTPRINTS AND QFN PACKAGE SOLDERING. 6. THIS DRAWING IS SUBJECT TO CHANGE WITHOUT NOTICE. w PD, Rev 4.1, January 2012 174 Production Data WM8918 IMPORTANT NOTICE Wolfson Microelectronics plc (“Wolfson”) products and services are sold subject to Wolfson’s terms and conditions of sale, delivery and payment supplied at the time of order acknowledgement. Wolfson warrants performance of its products to the specifications in effect at the date of shipment. Wolfson reserves the right to make changes to its products and specifications or to discontinue any product or service without notice. Customers should therefore obtain the latest version of relevant information from Wolfson to verify that the information is current. Testing and other quality control techniques are utilised to the extent Wolfson deems necessary to support its warranty. Specific testing of all parameters of each device is not necessarily performed unless required by law or regulation. In order to minimise risks associated with customer applications, the customer must use adequate design and operating safeguards to minimise inherent or procedural hazards. Wolfson is not liable for applications assistance or customer product design. The customer is solely responsible for its selection and use of Wolfson products. Wolfson is not liable for such selection or use nor for use of any circuitry other than circuitry entirely embodied in a Wolfson product. Wolfson’s products are not intended for use in life support systems, appliances, nuclear systems or systems where malfunction can reasonably be expected to result in personal injury, death or severe property or environmental damage. Any use of products by the customer for such purposes is at the customer’s own risk. Wolfson does not grant any licence (express or implied) under any patent right, copyright, mask work right or other intellectual property right of Wolfson covering or relating to any combination, machine, or process in which its products or services might be or are used. Any provision or publication of any third party’s products or services does not constitute Wolfson’s approval, licence, warranty or endorsement thereof. Any third party trade marks contained in this document belong to the respective third party owner. Reproduction of information from Wolfson datasheets is permissible only if reproduction is without alteration and is accompanied by all associated copyright, proprietary and other notices (including this notice) and conditions. Wolfson is not liable for any unauthorised alteration of such information or for any reliance placed thereon. Any representations made, warranties given, and/or liabilities accepted by any person which differ from those contained in this datasheet or in Wolfson’s standard terms and conditions of sale, delivery and payment are made, given and/or accepted at that person’s own risk. Wolfson is not liable for any such representations, warranties or liabilities or for any reliance placed thereon by any person. ADDRESS Wolfson Microelectronics plc Westfield House 26 Westfield Road Edinburgh EH11 2QB Tel :: +44 (0)131 272 7000 Fax :: +44 (0)131 272 7001 Email :: [email protected] w PD, Rev 4.1, January 2012 175 WM8918 Production Data REVISION HISTORY DATE REV ORIGINATOR CHANGES 15/12/11 4.1 JMacD Order codes updated from WM8918GEFL/V and WM8918GEFL/RV to WM8918CGEFL/V and WM8918CGEFL/RV to reflect change to copper wire bonding. w PD, Rev 4.1, January 2012 176