w WM8988 Stereo CODEC for Portable Audio Applications DESCRIPTION FEATURES The WM8988 is a low power, high quality stereo CODEC designed for portable digital audio applications. The device integrates complete interfaces to 2 stereo headphone or line out ports. External component requirements are drastically reduced as no separate headphone amplifiers are required. Advanced on-chip digital signal processing performs graphic equaliser, 3-D sound enhancement and automatic level control for the microphone or line input. The WM8988 can operate as a master or a slave, with various master clock frequencies including 12 or 24MHz for USB devices, or standard 256fs rates like 12.288MHz and 24.576MHz. Different audio sample rates such as 96kHz, 48kHz, 44.1kHz are generated directly from the master clock without the need for an external PLL. The WM8988 operates at supply voltages down to 1.8V, although the digital core can operate at voltages down to 1.42V to save power, and the maximum for all supplies is 3.6 Volts. Different sections of the chip can also be powered down under software control. The WM8988 is supplied in a very small and thin 4x4mm COL package, ideal for use in hand-held and portable systems. DAC SNR 100dB (`A' weighted), THD -90dB at 48kHz, 3.3V ADC SNR 93dB (`A' weighted), THD -81dB at 48kHz, 3.3V Programmable ALC / Noise Gate 2x On-chip Headphone Drivers - >40mW output power on 16 / 3.3V - THD -80dB at 20mW, SNR 90dB with 16 load Digital Graphic Equaliser Low Power - 7mW stereo playback (1.8V / 1.5V supplies) - 14mW record and playback (1.8V / 1.5V supplies) Low Supply Voltages - Analogue 1.8V to 3.6V - Digital core: 1.42V to 3.6V - Digital I/O: 1.8V to 3.6V 256fs / 384fs or USB master clock rates: 12MHz, 24MHz Audio sample rates: 8, 11.025, 16, 22.05, 24, 32, 44.1, 48, 88.2, 96kHz generated internally from master clock 4x4mm COL package APPLICATIONS Portable Multimedia players Multimedia handsets Handheld gaming BLOCK DIAGRAM DGND M U X DCVDD DBVDD W M U X RD2LO ADC DIGITAL FILTERS LINSEL ANALOGUE MONO MIX VOLUME DIGITAL MONO MIX RINSEL RINPUT2 RINPUT1 M U X LEFT LD2LO MIXER WM8988 PGA + MIC BOOST DIFF. INPUT L1-R1 OR L2-R2 ADC PGA + MIC BOOST DIGITAL FILTERS LI2LO RI2LO DAC LOUT1VOL GRAPHIC EQUALISER BASS BOOST DAC RIGHT LD2RO MIXER LI2RO ROUT1 RD2RO RI2RO ROUT1VOL (headphone / line output LOUT2VOL LOUT2 (headphone / line output RMIXSEL 50K LCOM AUDIO INTERFACE 50K CLOCK CIRCUITRY CONTROL INTERFACE WOLFSON MICROELECTRONICS plc ROUT2 (headphone / line output MODE SCLK SDIN CSB MCLK BCLK ADCDAT LRC DACDAT VREF VMID AVDD ROUT2VOL AGND LOUT1 (headphone / line output HPCOM DC MEASUREMENT M U X HPVDD LMIXSEL DC MEASUREMENT LINPUT1 LINPUT2 HPGND Production Data, October 2013, Rev 4.1 Copyright 2013 Wolfson Microelectronics plc WM8988 Production Data TABLE OF CONTENTS DESCRIPTION ....................................................................................................... 1 FEATURES ............................................................................................................ 1 APPLICATIONS..................................................................................................... 1 BLOCK DIAGRAM ................................................................................................ 1 TABLE OF CONTENTS ......................................................................................... 2 PIN CONFIGURATION AND DEVICE MARKING ................................................. 3 ORDERING INFORMATION .................................................................................. 3 PIN DESCRIPTION ................................................................................................ 4 ABSOLUTE MAXIMUM RATINGS ........................................................................ 5 RECOMMENDED OPERATION CONDITIONS ..................................................... 5 ELECTRICAL CHARACTERISTICS ..................................................................... 6 POWER CONSUMPTION .................................................................................... 10 SIGNAL TIMING REQUIREMENTS .................................................................... 11 SYSTEM CLOCK TIMING .............................................................................................. 11 AUDIO INTERFACE TIMING - MASTER MODE .......................................................... 11 AUDIO INTERFACE TIMING - SLAVE MODE .............................................................. 12 INTERNAL POWER ON RESET CIRCUIT .......................................................... 15 DEVICE DESCRIPTION ...................................................................................... 16 INTRODUCTION ............................................................................................................ 16 INPUT SIGNAL PATH .................................................................................................... 16 AUTOMATIC LEVEL CONTROL (ALC) ......................................................................... 23 OUTPUT SIGNAL PATH ................................................................................................ 27 ANALOGUE OUTPUTS ................................................................................................. 32 ENABLING THE OUTPUTS ........................................................................................... 34 THERMAL SHUTDOWN ................................................................................................ 34 DIGITAL AUDIO INTERFACE ........................................................................................ 35 AUDIO INTERFACE CONTROL .................................................................................... 38 CLOCKING AND SAMPLE RATES................................................................................ 40 CONTROL INTERFACE................................................................................................. 42 POWER SUPPLIES ....................................................................................................... 43 POWER MANAGEMENT ............................................................................................... 43 REGISTER MAP .................................................................................................. 47 DIGITAL FILTER CHARACTERISTICS .............................................................. 48 TERMINOLOGY ............................................................................................................. 48 DAC FILTER RESPONSES ........................................................................................... 49 ADC FILTER RESPONSES ........................................................................................... 50 DE-EMPHASIS FILTER RESPONSES .......................................................................... 51 HIGHPASS FILTER ....................................................................................................... 52 APPLICATIONS INFORMATION ........................................................................ 53 RECOMMENDED EXTERNAL COMPONENTS ............................................................ 53 LINE INPUT CONFIGURATION..................................................................................... 54 HEADPHONE OUTPUT CONFIGURATION .................................................................. 54 LINE OUTPUT CONFIGURATION................................................................................. 54 MINIMISING POP NOISE AT THE ANALOGUE OUTPUTS.......................................... 55 POWER MANAGEMENT EXAMPLES ........................................................................... 55 PACKAGE DIMENSIONS .................................................................................... 56 IMPORTANT NOTICE ......................................................................................... 57 ADDRESS ...................................................................................................................... 57 REVISION HISTORY ........................................................................................... 58 w PD, Rev 4.1, October 2013 2 WM8988 Production Data PIN CONFIGURATION AND DEVICE MARKING ORDERING INFORMATION ORDER CODE WM8988LGECN/V TEMPERATURE RANGE -25C to +85C PACKAGE MOISTURE SENSITIVITY LEVEL PEAK SOLDERING TEMPERATURE 28-lead COL QFN MSL3 260C MSL3 260C (4x4x0.55mm, lead-free) WM8988LGECN/RV -25C to +85C 28-lead COL QFN (4x4x0.55mm, lead-free) Tape and reel Note: Reel quantity = 3,500 w PD, Rev 4.1, October 2013 3 WM8988 Production Data PIN DESCRIPTION PIN NO NAME 1 MCLK 2 TYPE DESCRIPTION Digital Input Master Clock DCVDD Supply Digital Core Supply 3 DBVDD Supply Digital Buffer (I/O) Supply 4 DGND Supply Digital Ground (return path for both DCVDD and DBVDD) 5 BCLK Digital Input / Output Audio Interface Bit Clock 6 DACDAT Digital Input DAC Digital Audio Data 7 LRC Digital Input / Output Audio Interface Left / Right Clock 8 ADCDAT Digital Output ADC Digital Audio Data LOUT1 and ROUT1 common mode feedback 9 HPCOM Analogue Input 10 LCOM Analogue Input LOUT2 and ROUT2 common mode feedback 11 ROUT1 Analogue Output Right Output 1 (Line or Headphone) 12 LOUT1 Analogue Output Left Output 1 (Line or Headphone) 13 HPGND Supply Supply for Analogue Output Drivers (LOUT1/2, ROUT1/2) 14 ROUT2 Analogue Output Right Output 1 (Line or Headphone ) 15 LOUT2 Analogue Output Left Output 1 (Line or Headphone) 16 HPVDD Supply Supply for Analogue Output Drivers (LOUT1/2, ROUT1/2, MONOUT) 17 AVDD Supply Analogue Supply 18 AGND Supply Analogue Ground (return path for AVDD) 19 VREF Analogue Output Reference Voltage Decoupling Capacitor 20 VMID Analogue Output Midrail Voltage Decoupling Capacitor 21 RINPUT2 Analogue Input Right Channel Input 2 22 LINPUT2 Analogue Input Left Channel Input 2 23 RINPUT1 Analogue Input Right Channel Input 1 24 LINPUT1 Analogue Input Left Channel Input 1 25 MODE Digital Input Control Interface Selection 26 CSB Digital Input Chip Select / Device Address Selection 27 28 SDIN SCLK Digital Input/Output Digital Input Control Interface Data Input / 2-wire Acknowledge output Control Interface Clock Input w PD, Rev 4.1, October 2013 4 WM8988 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-020 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 -0.3V +4.5V Voltage range digital inputs DGND -0.3V DBVDD +0.3V Voltage range analogue inputs AGND -0.3V AVDD +0.3V Supply voltages Operating temperature range, TA -25C +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. 3. DCVDD must be less than or equal to AVDD and DBVDD. RECOMMENDED OPERATION CONDITIONS PARAMETER SYMBOL MIN Digital supply range (Core) DCVDD 1.42 3.6 V Digital supply range (Buffer) DBVDD 1.7 3.6 V AVDD, HPVDD 1.8 3.6 V Analogue supplies range Ground w DGND,AGND, HPGND TYP 0 MAX UNIT V PD, Rev 4.1, October 2013 5 WM8988 Production Data ELECTRICAL CHARACTERISTICS Test Conditions o DCVDD = 1.5V, DBVDD = 2.4V, AVDD = HPVDD =2.4V , TA = +25 C, 1kHz signal, fs = 48kHz, PGA gain = 0dB, 24-bit audio data unless otherwise stated. PARAMETER SYMBOL TEST CONDITIONS MIN TYP MAX UNIT Vrms Analogue Inputs (LINPUT1, RINPUT1, LINPUT2, RINPUT2) to ADC out Full Scale Input Signal Level VINFS (for ADC 0dB Input at 0dB Gain) Input Resistance RIN AVDD = 3.3V 0.95 1.0 1.05 AVDD = 2.4V 0.690 0.727 0.763 AVDD = 1.8V 0.480 0.545 0.610 L/RINPUT1 to ADC, 16 22 1.5 2.8 16 22 1.5 2.8 k PGA gain = 0dB L/RINPUT1 to ADC, PGA gain = +30dB L/RINPUT2 to ADC PGA gain = 0dB L/RINPUT2 to ADC PGA gain = 30dB Input Capacitance Signal to Noise Ratio SNR (A-weighted) Total Harmonic Distortion THD 10 pF AVDD = 3.3V 80 93 dB AVDD = 2.4V 80 88 AVDD = 1.8V 78 -1dBFs input, 87 -81 -68 -80 -68 -76 -65 -75 -65 -70 -65 -70 -60 dB AVDD = 3.3V -1dBFS input, AVDD = 2.4V -1dBFs input, AVDD = 1.8V Total Harmonic Distortion + Noise THD+N -1dBFs input, dB AVDD = 3.3V -1dBFS input, AVDD = 2.4V -1dBFs input, AVDD = 1.8V ADC Channel Separation Channel Matching 1kHz signal 85 10kHz signal 85 1kHz signal -0.5 0.2 dB +0.5 dB Vrms Analogue Outputs (LOUT1/2, ROUT1/2) 0dB Full scale output voltage Mute attenuation Channel Separation VOUTFS AVDD = 3.3V 0.95 1.0 1.05 AVDD = 2.4V 0.690 0.727 0.763 AVDD = 1.8V 0.507 0.545 0.583 1kHz, full scale signal 90 dB 1kHz signal 85 dB 10kHz signal PGA Gain range PGA step size w guaranteed monotonic 85 +6 0.25 1 -67 dB 1.25 dB PD, Rev 4.1, October 2013 6 WM8988 Production Data Test Conditions o DCVDD = 1.5V, DBVDD = 2.4V, AVDD = HPVDD =2.4V , TA = +25 C, 1kHz signal, fs = 48kHz, PGA gain = 0dB, 24-bit audio data unless otherwise stated. PARAMETER SYMBOL TEST CONDITIONS MIN TYP 88 100 MAX UNIT DAC to Line-Out (L/ROUT1 or L/ROUT2 with 10k / 50pF load) Signal to Noise Ratio SNR (A-weighted) AVDD=3.3V DACMIXBIAS=0 HPCOM=LC DACMIXBIAS=1 OM=0 AVDD = 2.4V DACMIXBIAS=0 HPCOM=LC DACMIXBIAS=1 OM=1 97 88 96 85 95 AVDD=1.8V DACMIXBIAS=0 HPCOM=LC DACMIXBIAS=1 OM=0 Total Harmonic Distortion Total Harmonic Distortion + Noise THD THD+N Channel Separation Ground noise rejection dB 99 96 AVDD=3.3V DACMIXBIAS=0 -90 HPCOM=LC DACMIXBIAS=1 OM=0 -89 AVDD = 2.4V DACMIXBIAS=0 -83 HPCOM=LC DACMIXBIAS=1 OM=1 -82 AVDD=1.8V DACMIXBIAS=0 -80 HPCOM=LC DACMIXBIAS=1 OM=0 -79 -65 -70 AVDD=3.3V DACMIXBIAS=0 -88 HPCOM=LC OM=0 DACMIXBIAS=1 -87 AVDD = 2.4V DACMIXBIAS=0 -75 HPCOM=LC OM=1 DACMIXBIAS=1 -74 AVDD=1.8V DACMIXBIAS=0 -75 HPCOM=LC OM=0 DACMIXBIAS=1 -74 -75 dB -75 dB -70 -65 1kHz signal 100 10kHz signal 85 dB dB 10mV, 20kHz noise on LCOM/HPCOM, LCOM/HPCOM enabled 40 dB Headphone Output (LOUT1/ROUT1, LOUT2/ROUT2 AC coupled to load) Output Power per channel PO Total Harmonic Distortion THD Output power is very closely correlated with THD; see below. HPVDD=1.8V, RL=32 0.013 % PO=5mW -78 dB HPCOM=LCOM=0 DACMIXBIAS=1 HPVDD=1.8V, RL=16 0.010 PO=5mW -80 HPCOM=LCOM=0 DACMIXBIAS=1 HPVDD=2.4V, RL=32, 0.010 PO=5mW -80 HPCOM=LCOM=1 DACMIXBIAS=1 HPVDD=2.4V, RL=16, 0.013 0.032 PO=5mW -78 -70 HPCOM=LCOM=1 DACMIXBIAS=1 w PD, Rev 4.1, October 2013 7 WM8988 Production Data Test Conditions o DCVDD = 1.5V, DBVDD = 2.4V, AVDD = HPVDD =2.4V , TA = +25 C, 1kHz signal, fs = 48kHz, PGA gain = 0dB, 24-bit audio data unless otherwise stated. PARAMETER SYMBOL TEST CONDITIONS MIN HPVDD=3.3V, RL=32, PO=20mW TYP MAX UNIT 0.010 -82 HPCOM=LCOM=0 DACMIXBIAS=0 HPVDD=3.3V, RL=16, PO=20mW 0.010 -80 HPCOM=LCOM=0 DACMIXBIAS=0 Total Harmonic Distortion + Noise THD+N -80 HPVDD=1.8V, RL=32 dB PO=5mW HPCOM=LCOM=0 DACMIXBIAS=1 HPVDD=1.8V, RL=16 -78 PO=5mW HPCOM=LCOM=0 DACMIXBIAS=1 HPVDD=2.4V, RL=32, -79 PO=5mW HPCOM=LCOM=1 DACMIXBIAS=1 HPVDD=2.4V, RL=16, -77 -65 PO=5mW HPCOM=LCOM=1 DACMIXBIAS=1 HPVDD=3.3V, RL=32, PO=20mW -80 HPCOM=LCOM=0 DACMIXBIAS=0 HPVDD=3.3V, RL=16, PO=20mW -78 HPCOM=LCOM=0 DACMIXBIAS=0 Signal to Noise Ratio SNR (A-weighted) HPVDD = 3.3V 100 dB HPCOM=LCOM=0 DACMIXBIAS=1 HPVDD = 2.4V 90 96 HPCOM=LCOM=1 DACMIXBIAS=1 HPVDD = 1.8V 96 HPCOM=LCOM=0 DACMIXBIAS=0 Headphone Output Ground noise rejection 10mV, 20kHz noise on HPCOM, HPCOM enabled 40 dB Line Output Ground Noise Rejection 10mV, 20kHz noise on LCOM, LCOM enabled 40 dB Analogue Reference Levels Midrail Reference Voltage VMID -3% AVDD/2 +3% V Buffered Reference Voltage VREF -3% AVDD/2 +3% V Input HIGH Level VIH 0.7DB VDD Input LOW Level VIL Digital Input / Output w V 0.3DBVDD V PD, Rev 4.1, October 2013 8 WM8988 Production Data Test Conditions o DCVDD = 1.5V, DBVDD = 2.4V, AVDD = HPVDD =2.4V , TA = +25 C, 1kHz signal, fs = 48kHz, PGA gain = 0dB, 24-bit audio data unless otherwise stated. PARAMETER SYMBOL TEST CONDITIONS Output HIGH Level VOH IOH = +1mA Output LOW Level VOL IOL = -1mA w MIN TYP MAX 0.9DB VDD UNIT V 0.1DBVDD V PD, Rev 4.1, October 2013 9 WM8988 Production Data POWER CONSUMPTION The power consumption of the WM8988 depends on the following factors. Supply voltages: Reducing the supply voltages also reduces supply currents, and therefore results in significant power savings, especially in the digital sections of the WM8988. Operating mode: Significant power savings can be achieved by always disabling parts of the WM8988 that are not used (e.g. mic pre-amps, unused outputs, DAC, ADC, etc.) SCENARIO DETAIL AVDD POWER HPVDD POWER DCVDD POWER DBVDD POWER (MW) (MW) (MW) (MW) TOTAL POWER (MW) OFF Clocks Stopped 0.001 0.000 0.012 0.000 0.01 Playback to Lineout 0dB 1kHz Sinusoid 4.9 1.2 4.8 0.4 11.3 Playback to Headphone 32ohm Quiescent No Signal 4.7 1.0 4.7 0.4 10.3 Playback to Headphone 32ohm -50dB (near silence) 1kHz Sinusoid 4.6 1.1 4.8 0.4 10.9 Playback to Headphone 32ohm -21dB (0.1mW/channel) 1kHz Sinusoid 4.6 4.9 4.8 0.4 14.7 Playback to Headphone 32ohm -9dB (2mW/channel) 1kHz Sinusoid 4.6 17.7 4.8 0.4 27.5 Table 1 Power Consumption for 2.4v / 1.8v Supplies SCENARIO DETAIL AVDD HPVDD POWER POWER DCVDD POWER DBVDD TOTAL POWER POWER (MW) (MW) (MW) (MW) (MW) 0.001 0.000 0.013 0.000 0.01 OFF Clocks Stopped Playback to Lineout 0dB 1kHz Sinusoid 7.6 2.0 4.9 0.4 14.9 Playback to Headphone 32ohm Quiescent No Signal 7.6 1.8 4.9 0.4 14.7 Playback to Headphone 32ohm -50dB (near silence) 1kHz Sinusoid 7.6 1.8 4.8 0.4 14.6 Playback to Headphone 32ohm -24dB (0.1mW/channel) 1kHz Sinusoid 7.6 5.9 4.8 0.4 18.7 Playback to Headphone 32ohm -11dB (2mW/channel) 1kHz Sinusoid 7.6 22.3 4.8 0.4 35.1 Table 2 Power Consumption for 3.0v / 1.8v Supplies Notes: o 1. All figures are at TA = +25 C, Slave Mode, fs = 48kHz, MCLK = 12.288 MHz (256fs), 2. The power dissipated in the headphone is not included in the above table. w PD, Rev 4.1, October 2013 10 WM8988 Production Data SIGNAL TIMING REQUIREMENTS SYSTEM CLOCK TIMING tMCLKL MCLK tMCLKH tMCLKY Figure 1 System Clock Timing Requirements Test Conditions o CLKDIV2=0, DCVDD = 1.42V, DBVDD = 3.3V, DGND = 0V, TA = +25 C, Slave Mode fs = 48kHz, MCLK = 384fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN TYP MAX UNIT System Clock Timing Information MCLK System clock pulse width high TMCLKL 21 ns MCLK System clock pulse width low TMCLKH 21 ns MCLK System clock cycle time TMCLKY 54 MCLK duty cycle TMCLKDS 60:40 ns 40:60 Test Conditions o CLKDIV2=1, DCVDD = 1.42V, DBVDD = 3.3V, DGND = 0V, TA = +25 C, Slave Mode fs = 48kHz, MCLK = 384fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN TYP MAX UNIT MCLK System clock pulse width high TMCLKL 10 ns MCLK System clock pulse width low TMCLKH 10 ns MCLK System clock cycle time TMCLKY 27 ns System Clock Timing Information AUDIO INTERFACE TIMING - MASTER MODE BCLK (Output) t DL LRC (Output) t DDA ADCDAT DACDAT t DST t DHT Figure 2 Digital Audio Data Timing - Master Mode w PD, Rev 4.1, October 2013 11 WM8988 Production Data Test Conditions o DCVDD = 1.42V, DBVDD = 3.3V, DGND = 0V, TA = +25 C, Slave Mode, fs = 48kHz, MCLK = 256fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN TYP MAX UNIT Bit Clock Timing Information BCLK rise time (10pF load) tBCLKR 3 ns BCLK fall time (10pF load) tBCLKF 3 ns BCLK duty cycle (normal mode, BCLK = MCLK/n) tBCLKDS 50:50 BCLK duty cycle (USB mode, BCLK = MCLK) tBCLKDS TMCLKDS Audio Data Input Timing Information DACLRC propagation delay from BCLK falling edge tDL 10 ns ADCDAT propagation delay from BCLK falling edge tDDA 10 ns DACDAT setup time to BCLK rising edge tDST 10 ns DACDAT hold time from BCLK rising edge tDHT 10 ns AUDIO INTERFACE TIMING - SLAVE MODE t t BCH BCL BCLK t BCY LRC t t t DS LRH LRSU DACDAT t t DD DH ADCDAT Figure 3 Digital Audio Data Timing - Slave Mode Test Conditions o DCVDD = 1.42V, DBVDD = 3.3V, DGND = 0V, TA = +25 C, Slave Mode, fs = 48kHz, MCLK = 256fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN TYP MAX UNIT BCLK cycle time tBCY 50 BCLK pulse width high tBCH 20 ns BCLK pulse width low tBCL 20 ns DACLRC set-up time to BCLK rising edge tLRSU 10 ns DACLRC hold time from BCLK rising edge tLRH 10 ns DACDAT hold time from BCLK rising edge tDH 10 ADCDAT propagation delay from BCLK falling edge tDD Audio Data Input Timing Information ns ns 10 ns Note: BCLK period should always be greater than or equal to MCLK period. w PD, Rev 4.1, October 2013 12 WM8988 Production Data CONTROL INTERFACE TIMING - 3-WIRE MODE tCSL tCSH CSB tCSS tSCY tSCH tSCS tSCL SCLK LSB SDIN tDSU tDHO Figure 4 Control Interface Timing - 3-Wire Serial Control Mode Test Conditions o DCVDD = 1.42V, DBVDD = 3.3V, DGND = 0V, TA = +25 C, Slave Mode, fs = 48kHz, MCLK = 256fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN TYP MAX UNIT Program Register Input Information SCLK rising edge to CSB rising edge tSCS 80 ns SCLK pulse cycle time tSCY 200 ns SCLK pulse width low tSCL 80 ns SCLK pulse width high tSCH 80 ns SDIN to SCLK set-up time tDSU 40 ns SCLK to SDIN hold time tDHO 40 ns CSB pulse width low tCSL 40 ns CSB pulse width high tCSH 40 ns CSB rising to SCLK rising tCSS 40 tps 0 Pulse width of spikes that will be suppressed w ns 5 ns PD, Rev 4.1, October 2013 13 WM8988 Production Data CONTROL INTERFACE TIMING - 2-WIRE MODE t3 t3 t5 SDIN t4 t6 t2 t8 SCLK t1 t9 t7 Figure 5 Control Interface Timing - 2-Wire Serial Control Mode Test Conditions o DCVDD = 1.42V, DBVDD = 3.3V, DGND = 0V, TA = +25 C, Slave Mode, fs = 48kHz, MCLK = 256fs, 24-bit data, unless otherwise stated. PARAMETER SYMBOL MIN TYP MAX UNIT Program Register Input Information SCLK Frequency 0 526 kHz SCLK Low Pulse-Width t1 1.3 us 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 SDIN, SCLK Rise Time t6 300 ns SDIN, SCLK Fall Time t7 300 ns Setup Time (Stop Condition) t8 Data Hold Time t9 Pulse width of spikes that will be suppressed tps w ns 600 0 ns 900 ns 5 ns PD, Rev 4.1, October 2013 14 WM8988 Production Data INTERNAL POWER ON RESET CIRCUIT DCVDD AVDD T1 VDD Power on Reset Circuit Internal PORB GND DGND Figure 6 Internal Power on Reset Circuit Schematic The WM8988 includes an internal Power-On-Reset Circuit, as shown in Figure 6, which is used to reset the digital logic into a default state after power up. The power on reset circuit is powered from DCVDD and monitors DCVDD and AVDD. It asserts PORB low if DCVDD or AVDD are below a minimum threshold. Figure 7 Typical Power-Up Sequence Figure 7 shows a typical power-up sequence. When DCVDD and AVDD rise above the minimum thresholds, Vpord_dcvdd and Vpord_avdd, there is enough voltage for the circuit to guarantee the Power on Reset is asserted low and the chip is held in reset. In this condition, all writes to the control interface are ignored. When DCVDD rises to Vpor_dcvdd_on and AVDD rises to Vpor_avdd_on, PORB is released high and all registers are in their default state and writes to the control interface may take place. If DCVDD and AVDD rise at different rates then PORB will only be released when DCVDD and AVDD have both exceeded the Vpor_dcvdd_on and Vpor_avdd_on thresholds. On power down, PORB is asserted low whenever DCVDD drops below the minimum threshold Vpor_dcvdd_off or AVDD drops below the minimum threshold Vpor_avdd_off. SYMBOL MIN TYP MAX Vpord_dcvdd 0.4 0.6 0.8 UNIT V Vpor_dcvdd_on 0.9 1.26 1.6 V Vpor_avdd_on 0.5 0.7 0.9 V Vpor_avdd_off 0.4 0.6 0.8 V Table 3 Typical POR Operation (typical values, not tested) w PD, Rev 4.1, October 2013 15 WM8988 Production Data DEVICE DESCRIPTION INTRODUCTION The WM8988 is a low power audio CODEC offering a combination of high quality audio, advanced features, low power and small size. These characteristics make it ideal for portable digital audio applications such as MP3 and minidisk player / recorders. Stereo 24-bit multi-bit delta sigma ADCs and DACs are used with oversampling digital interpolation and decimation filters. The device includes three stereo analogue inputs that can be switched internally. Each can be used as either a line level input or microphone input and LINPUT1/RINPUT1 and LINPUT2/RINPUT2 can be configured as mono differential inputs. A programmable gain amplifier with automatic level control (ALC) keeps the recording volume constant. The on-chip stereo ADC and DAC are of a high quality using a multi-bit, low-order oversampling architecture to deliver optimum performance with low power consumption. The DAC output signal first enters an analogue mixer where an analogue input and/or the post-ALC signal can be added to it. This mix is available on line and headphone outputs. The WM8988 has a configurable digital audio interface where ADC data can be read and digital audio 2 playback data fed to the DAC. It supports a number of audio data formats including I S, DSP Mode (a burst mode in which frame sync plus 2 data packed words are transmitted), MSB-First, left justified and can operate in master or slave modes. The WM8988 uses a unique clocking scheme that can generate many commonly used audio sample rates from either a 12.00MHz USB clock or an industry standard 256/384 fs clock. This feature eliminates the common requirement for an external phase-locked loop (PLL) in applications where the master clock is not an integer multiple of the sample rate. Sample rates of 8kHz, 11.025kHz, 12kHz, 16kHz, 22.05kHz, 24kHz, 32kHz, 44.1kHz, 48kHz, 88.2kHz and 96kHz can be generated. The digital filters used for recording and playback are optimised for each sampling rate used. To allow full software control over all its features, the WM8988 offers a choice of 2 or 3 wire MPU control interface. It is fully compatible and an ideal partner for a wide range of industry standard microprocessors, controllers and DSPs. The design of the WM8988 has given much attention to power consumption without compromising performance. It operates at very low voltages, and includes the ability to power off parts of the circuitry under software control, including standby and power off modes. INPUT SIGNAL PATH The input signal path for each channel consists of a switch to select between three analogue inputs, followed by a PGA (programmable gain amplifier) and an optional microphone gain boost. A differential input of either (LINPUT1 - RINPUT1) or (LINPUT2 - RINPUT2) may also be selected. The gain of the PGA can be controlled either by the user or by the on-chip ALC function (see Automatic Level Control). The signal then enters an ADC where it is digitised. Alternatively, the two channels can also be mixed in the analogue domain and digitised in one ADC while the other ADC is switched off. The mono-mix signal appears on both digital output channels. SIGNAL INPUTS The WM8988 has two sets of high impedance, low capacitance AC coupled analogue inputs, LINPUT1/RINPUT1 and LINPUT2/RINPUT2. Inputs can be configured as microphone or line level by enabling or disabling the microphone gain boost. LINSEL and RINSEL control bits (see Table 4) are used to select independently between external inputs and internally generated differential products (LINPUT1-RINPUT1 or LINPUT2-RINPUT2). The choice of differential signal, LINPUT1-RINPUT1 or LINPUT2-RINPUT2 is made using DS (refer to Table 6). As an example, the WM8988 can be set up to convert one differential and one single ended mono signal by applying the differential signal to LINPUT1/RINPUT1 and the single ended signal to RINPUT2. By setting LINSEL to L-R Differential (see Table 4), DS to LINPUT1 - RINPUT1 (see Table 6) and RINSEL to RINPUT2, each mono signal can then be routed to a separate ADC or Bypass path. w PD, Rev 4.1, October 2013 16 WM8988 Production Data The signal inputs are biased internally to the reference voltage VREF. Whenever the line inputs are muted or the device placed into standby mode, the inputs are kept biased to VREF using special antithump circuitry. This reduces any audible clicks that may otherwise be heard when changing inputs. DC MEASUREMENT For DC measurements (for example, battery voltage monitoring), the input signal at the LINPUT1 and/or RINPUT1 pins can be taken directly into the respective ADC, bypassing both PGA and microphone boost. The ADC output then becomes unsigned relative to AVDD, instead of being a signed (two's complement) number relative to VREF. Setting L/RDCM will override L/RINSEL. The input range for dc measurement is AGND to AVDD. REGISTER ADDRESS R32 (20h) BIT 7:6 LABEL LINSEL DEFAULT 00 ADC Signal Path Control (Left) DESCRIPTION Left Channel Input Select 00 = LINPUT1 01 = LINPUT2 10 = Reserved 11 = L-R Differential (either LINPUT1RINPUT1 or LINPUT2-RINPUT2, selected by DS) 5:4 LMICBOOST 00 Left Channel Microphone Gain Boost 00 = Boost off (bypassed) 01 = 13dB boost 10 = 20dB boost 11 = 29dB boost R33 (21h) 7:6 RINSEL 00 ADC Signal Path Control (Right) Right Channel Input Select 00 = RINPUT1 01 = RINPUT2 10 = Reserved 11 = L-R Differential (either LINPUT1RINPUT1 or LINPUT2-RINPUT2, selected by DS) 5:4 RMICBOOST 00 Right Channel Microphone Gain Boost 00 = Boost off (bypassed) 01 = 13dB boost 10 = 20dB boost 11 = 29dB boost Table 4 Input Software Control REGISTER ADDRESS R31 (1Fh) BIT 5 LABEL RDCM DEFAULT 0 ADC input Mode DESCRIPTION Right Channel DC Measurement 0 = Normal Operation, PGA Enabled 1 = Measure DC level on RINPUT1 4 LDCM 0 Left Channel DC Measurement 0 = Normal Operation, PGA Enabled 1 = Measure DC level on LINPUT1 Table 5 DC Measurement Select REGISTER ADDRESS R31 (1Fh) BIT 8 LABEL DS ADC Input Mode DEFAULT 0 DESCRIPTION Differential input select 0: LINPUT1 - RINPUT1 1: LINPUT2 - RINPUT2 Table 6 Differential Input Select w PD, Rev 4.1, October 2013 17 WM8988 Production Data MONO MIXING The stereo ADC can operate as a stereo or mono device, or the two channels can be mixed to mono, either in the analogue domain (i.e. before the ADC) or in the digital domain (after the ADC). MONOMIX selects the mode of operation. For analogue mono mix either the left or right channel ADC can be used, allowing the unused ADC to be powered off or used for a dc measurement conversion. The user also has the flexibility to select the data output from the audio interface using DATSEL. The default is for left and right channel ADC data to be output, but the interface may also be configured so that e.g. left channel ADC data is output as both left and right data for when an analogue mono mix is selected. Note: If DC measurement is selected this overrides the MONOMIX selection. REGISTER ADDRESS BIT R31 (1Fh) 7:6 ADC input Mode LABEL MONOMIX DEFAULT 00 [1:0] DESCRIPTION 00: Stereo 01: Analogue Mono Mix (using left ADC) 10: Analogue Mono Mix (using right ADC) 11: Digital Mono Mix Table 7 Mono Mixing REGISTER ADDRESS R23 (17h) BIT 3:2 Additional Control (1) LABEL DATSEL [1:0] DEFAULT 00 DESCRIPTION 00: left data=left ADC; right data =right ADC 01: left data =left ADC; right data = left ADC 10: left data = right ADC; right data =right ADC 11: left data = right ADC; right data = left ADC Table 8 ADC Data Output Configuration PGA CONTROL The PGA matches the input signal level to the ADC input range. The PGA gain is logarithmically adjustable from +30dB to -17.25dB in 0.75dB steps. Each PGA can be controlled either by the user or by the ALC function (see Automatic Level Control). When ALC is enabled for one or both channels, then writing to the corresponding PGA control register has no effect. The gain is independently adjustable on both Right and Left Line Inputs. Additionally, by controlling the register bits LIVU and RIVU, the left and right gain settings can be simultaneously updated. Setting the LZCEN and RZCEN bits enables a zero-cross detector which ensures that PGA gain changes only occur when the signal is at zero, eliminating any zipper noise. If zero cross is enabled a timeout is also available to update the gain if a zero cross does not occur. This function may be enabled by setting TOEN in register R23 (17h). The inputs can also be muted in the analogue domain under software control. The software control registers are shown in Table 9. If zero crossing is enabled, it is necessary to enable zero cross timeout to un-mute the input PGAs. This is because their outputs will not cross zero when muted. Alternatively, zero cross can be disabled before sending the un-mute command. w PD, Rev 4.1, October 2013 18 WM8988 Production Data REGISTER ADDRESS R0 (00h) BIT 8 LABEL LIVU DEFAULT 0 Left Channel DESCRIPTION Left Volume Update 0 = Store LINVOL in intermediate latch (no gain change) PGA 1 = Update left and right channel gains (left = LINVOL, right = intermediate latch) 7 LINMUTE 1 Left Channel Input Analogue Mute 1 = Enable Mute 0 = Disable Mute Note: LIVU must be set to un-mute. 6 LZCEN 0 Left Channel Zero Cross Detector 1 = Change gain on zero cross only 0 = Change gain immediately 5:0 LINVOL 010111 Left Channel Input Volume Control [5:0] ( 0dB ) 111111 = +30dB 111110 = +29.25dB . . 0.75dB steps down to 000000 = -17.25dB R1 (01h) 8 RIVU 0 Right Channel Right Volume Update 0 = Store RINVOL in intermediate latch (no gain change) PGA 1 = Update left and right channel gains (right = RINVOL, left = intermediate latch) 7 RINMUTE 1 Right Channel Input Analogue Mute 1 = Enable Mute 0 = Disable Mute Note: RIVU must be set to un-mute. 6 RZCEN 0 Right Channel Zero Cross Detector 1 = Change gain on zero cross only 0 = Change gain immediately 5:0 RINVOL 010111 Right Channel Input Volume Control [5:0] ( 0dB ) 111111 = +30dB 111110 = +29.25dB . . 0.75dB steps down to 000000 = -17.25dB R23 (17h) 0 TOEN Additional Control (1) 0 Timeout Enable 0 : Timeout Disabled 1 : Timeout Enabled Table 9 Input PGA Software Control w PD, Rev 4.1, October 2013 19 WM8988 Production Data ANALOGUE TO DIGITAL CONVERTER (ADC) The WM8988 uses a multi-bit, oversampled sigma-delta ADC for each channel. The use of multi-bit feedback and high oversampling rates reduces the effects of jitter and high frequency noise. The ADC Full Scale input level is proportional to AVDD. With a 3.3V supply voltage, the full scale level is 1.0 Volts r.m.s. Any voltage greater than full scale may overload the ADC and cause distortion. ADC DIGITAL FILTER The ADC filters perform true 24-bit signal processing to convert the raw multi-bit oversampled data from the ADC to the correct sampling frequency to be output on the digital audio interface. The digital filter path is illustrated in Figure 8. FROM ADC DIGITAL DECIMATOR DIGITAL HPF DIGITAL FILTER TO DIGITAL AUDIO INTERFACE ADCHPD Figure 8 ADC Digital Filter The ADC digital filters contain a digital high-pass filter, selectable via software control. The high-pass filter response is detailed in the Digital Filter Characteristics section. When the high-pass filter is enabled the DC offset is continuously calculated and subtracted from the input signal. By setting HPOR, the last calculated DC offset value is stored when the high-pass filter is disabled and will continue to be subtracted from the input signal. If the DC offset is changed, the stored and subtracted value will not change unless the high-pass filter is enabled. This feature can be used for calibration purposes. In addition the high-pass filter may be enabled separately on the left and right channels (see Table 11). The output data format can be programmed by the user to accommodate stereo or monophonic recording on both inputs. The polarity of the output signal can also be changed under software control. The software control is shown in Table 10. REGISTER ADDRESS R5 (05h) BIT 6:5 ADC and DAC Control LABEL ADCPOL DEFAULT 00 [1:0] DESCRIPTION 00 = Polarity not inverted 01 = L polarity invert 10 = R polarity invert 11 = L and R polarity invert 4 HPOR 0 Store dc offset when high-pass filter disabled 1 = store offset 0 = clear offset R27 (1Bh) 0 ADCHPD 0 5 HPFLREN 0 ADCHPD and HPFLREN together determine high-pass filter behaviour (see Table 11) Table 10 ADC Signal Path Control HPFLREN ADCHPD LEFT CHANNEL 0 0 HPF ON RIGHT CHANNEL HPF ON 0 1 HPF OFF HPF OFF 1 0 HPF ON HPF OFF 1 1 HPF OFF HPF ON Table 11 ADC High Pass Filter Modes w PD, Rev 4.1, October 2013 20 Production Data w WM8988 PD, Rev 4.1, October 2013 21 WM8988 Production Data DIGITAL ADC VOLUME CONTROL The output of the ADCs can be digitally amplified or attenuated over a range from -97dB to +30dB in 0.5dB steps. The volume of each channel can be controlled separately. The gain for a given eight-bit code X is given by: 0.5 (X-195) dB for 1 X 255; MUTE for X = 0 The LAVU and RAVU control bits control the loading of digital volume control data. When LAVU or RAVU are set to 0, the LADCVOL or RADCVOL 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 either LAVU or RAVU are set to 1. This makes it possible to update the gain of both channels simultaneously. REGISTER ADDRESS R21 (15h) BIT 7:0 Left ADC Digital Volume LABEL DEFAULT DESCRIPTION LADCVOL 11000011 Left ADC Digital Volume Control [7:0] ( 0dB ) 0000 0000 = Digital Mute 0000 0001 = -97dB 0000 0010 = -96.5dB ... 0.5dB steps up to 1111 1111 = +30dB 8 LAVU 0 Left ADC Volume Update 0 = Store LADCVOL in intermediate latch (no gain change) 1 = Update left and right channel gains (left = LADCVOL, right = intermediate latch) R22 (16h) 7:0 Right ADC Digital Volume RADCVOL 11000011 Right ADC Digital Volume Control [7:0] ( 0dB ) 0000 0000 = Digital Mute 0000 0001 = -97dB 0000 0010 = -96.5dB ... 0.5dB steps up to 1111 1111 = +30dB 8 RAVU 0 Right ADC Volume Update 0 = Store RADCVOL in intermediate latch (no gain change) 1 = Update left and right channel gains (left = intermediate latch, right = RADCVOL) Table 12 ADC Digital Volume Control w PD, Rev 4.1, October 2013 22 WM8988 Production Data AUTOMATIC LEVEL CONTROL (ALC) The WM8988 has an automatic level control that aims to keep a constant recording volume irrespective of the input signal level. This is achieved by continuously adjusting the PGA gain so that the signal level at the ADC input remains constant. A digital peak detector monitors the ADC output and changes the PGA gain if necessary. Note that when the ALC function is enabled, the settings of registers 0 and 1 (LINVOL, LIVU, LIZC, LINMUTE, RINVOL, RIVU, RIZC and RINMUTE) are ignored. input signal PGA gain ALC target level signal after ALC hold time decay time attack time Figure 9 ALC Operation The ALC function is enabled using the ALCSEL control bits. When enabled, the recording volume can be programmed between -6dB and -28.5dB (relative to ADC full scale) using the ALCL register bits. An upper limit for the PGA gain can be imposed by setting the MAXGAIN control bits. HLD, DCY and ATK control the hold, decay and attack times, respectively: Hold time is the time delay between the peak level detected being below target and the PGA gain n beginning to ramp up. It can be programmed in power-of-two (2 ) steps, e.g. 2.67ms, 5.33ms, 10.67ms etc. up to 43.7s. Alternatively, the hold time can also be set to zero. The hold time only applies to gain ramp-up, there is no delay before ramping the gain down when the signal level is above target. Decay (Gain Ramp-Up) Time is the time that it takes for the PGA gain to ramp up across 90% of its range (e.g. from -15B up to 27.75dB). The time it takes for the recording level to return to its target value therefore depends on both the decay time and on the gain adjustment required. If the gain adjustment is small, it will be shorter than the decay time. The decay time can be programmed in n power-of-two (2 ) steps, from 24ms, 48ms, 96ms, etc. to 24.58s. Attack (Gain Ramp-Down) Time is the time that it takes for the PGA gain to ramp down across 90% of its range (e.g. from 27.75dB down to -15B gain). The time it takes for the recording level to return to its target value therefore depends on both the attack time and on the gain adjustment required. If the gain adjustment is small, it will be shorter than the attack time. The attack time can be programmed in n power-of-two (2 ) steps, from 6ms, 12ms, 24ms, etc. to 6.14s. When operating in stereo, the peak detector takes the maximum of left and right channel peak values, and any new gain setting is applied to both left and right PGAs, so that the stereo image is preserved. However, the ALC function can also be enabled on one channel only. In this case, only one PGA is controlled by the ALC mechanism, while the other channel runs independently with its PGA gain set through the control register. When one ADC channel is unused or used for DC measurement, the peak detector disregards that channel. The ALC function can also operate when the two ADC outputs are mixed to mono in the digital domain, but not if they are mixed to mono in the analogue domain, before entering the ADCs. w PD, Rev 4.1, October 2013 23 WM8988 Production Data REGISTER ADDRESS R17 (11h) BIT 8:7 ALC Control 1 LABEL DEFAULT DESCRIPTION ALCSEL 00 ALC function select [1:0] (OFF) 00 = ALC off (PGA gain set by register) 01 = Right channel only 10 = Left channel only 11 = Stereo (PGA registers unused) Note: ensure that LINVOL and RINVOL settings (reg. 0 and 1) are the same before entering this mode. 6:4 MAXGAIN [2:0] 111 (+30dB) Set Maximum Gain of PGA 111 : +30dB 110 : +24dB ....(-6dB steps) 001 : -6dB 000 : -12dB 3:0 ALCL 1011 [3:0] (-12dB) ALC target - sets signal level at ADC input 0000 = -28.5dB FS 0001 = -27.0dB FS ... (1.5dB steps) 1110 = -7.5dB FS 1111 = -6dB FS R18 (12h) 7 ALCZC 0 (zero cross off) ALC uses zero cross detection circuit. 3:0 HLD 0000 ALC hold time before gain is increased. [3:0] (0ms) 0000 = 0ms ALC Control 2 0001 = 2.67ms 0010 = 5.33ms ... (time doubles with every step) 1111 = 43.7s R19 (13h) 7:4 ALC Control 3 DCY 0011 ALC decay (gain ramp-up) time [3:0] (192ms) 0000 = 24ms 0001 = 48ms 0010 = 96ms ... (time doubles with every step) 1010 or higher = 24.58s 3:0 ATK 0010 ALC attack (gain ramp-down) time [3:0] (24ms) 0000 = 6ms 0001 = 12ms 0010 = 24ms ... (time doubles with every step) 1010 or higher = 6.14s Table 13 ALC Control PEAK LIMITER To prevent clipping when a large signal occurs just after a period of quiet, the ALC circuit includes a limiter function. If the ADC input signal exceeds 87.5% of full scale (-1.16dB), the PGA gain is ramped down at the maximum attack rate (as when ATK = 0000), until the signal level falls below 87.5% of full scale. This function is automatically enabled whenever the ALC is enabled. Note: If ATK = 0000, then the limiter makes no difference to the operation of the ALC. It is designed to prevent clipping when long attack times are used. w PD, Rev 4.1, October 2013 24 WM8988 Production Data NOISE GATE When the signal is very quiet and consists mainly of noise, the ALC function may cause "noise pumping", i.e. loud hissing noise during silence periods. The WM8988 has a noise gate function that prevents noise pumping by comparing the signal level at the LINPUT1/2 and/or RINPUT1/2 pins against a noise gate threshold, NGTH. The noise gate cuts in when: Signal level at ADC [dB] < NGTH [dB] + PGA gain [dB] + Mic Boost gain [dB] This is equivalent to: Signal level at input pin [dB] < NGTH [dB] The ADC output can then either be muted or alternatively, the PGA gain can be held constant (preventing it from ramping up as it normally would when the signal is quiet). The table below summarises the noise gate control register. The NGTH control bits set the noise gate threshold with respect to the ADC full-scale range. The threshold is adjusted in 1.5dB steps. Levels at the extremes of the range may cause inappropriate operation, so care should be taken with set-up of the function. Note that the noise gate only works in conjunction with the ALC function, and always operates on the same channel(s) as the ALC (left, right, both, or none). REGISTER ADDRESS R20 (14h) BIT 7:3 Noise Gate LABEL NGTH DEFAULT 00000 [4:0] Control DESCRIPTION Noise gate threshold 13 -76.5dBfs 13 -75dBfs ... 1.5 dB steps 2:1 NGG 00 [1:0] 11110 -31.5dBfs 11111 -30dBfs Noise gate type X0 = PGA gain held constant 01 = mute ADC output 11 = reserved (do not use this setting) 0 NGAT 0 Noise gate function enable 1 = enable 0 = disable Table 14 Noise Gate Control Note: The performance of the ADC may degrade at high input signal levels if the monitor bypass mux is selected with MIC boost and ALC enabled. w PD, Rev 4.1, October 2013 25 WM8988 Production Data 3D STEREO ENHANCEMENT The WM8988 has a digital 3D enhancement option to artificially increase the separation between the left and right channels. This effect can be used for recording or playback, but not for both simultaneously. Selection of 3D for record or playback is controlled by register bit MODE3D. Important: Switching the 3D filter from record to playback or from playback to record may only be done when ADC and DAC are disabled. The WM8988 control interface will only allow MODE3D to be changed when ADC and DAC are disabled (i.e. bits ADCL, ADCR, DACL and DACR in reg. 26 / 1Ah are all zero). The 3D enhancement function is activated by the 3DEN bit, and has two programmable parameters. The 3DDEPTH setting controls the degree of stereo expansion. Additionally, one of four filter characteristics can be selected for the 3D processing, using the 3DVC and 3DLC control bits. REGISTER ADDRESS R16 (10h) BIT 7 LABEL DEFAULT MODE3D 0 3D enhance DESCRIPTION Playback/Record 3D select 0 = 3D selected for Record 1 = 3D selected for Playback 6 3DUC 0 Upper Cut-off frequency 0 = High (2.2kHz at 48kHz sampling) 1 = Low (1.5kHz at 48kHz sampling) 5 3DLC 0 Lower Cut-off frequency 0 = Low (200Hz at 48kHz sampling) 1 = High (500Hz at 48kHz sampling) 4:1 3DDEPTH 0000 [3:0] Stereo depth 0000: 0% (minimum 3D effect) 0001: 6.67% .... 1110: 93.3% 1111: 100% (maximum 3D effect) 0 3DEN 0 3D function enable 1: enabled 0: disabled Table 15 3D Stereo Enhancement Function When 3D enhancement is enabled (and/or the graphic equaliser for playback) it may be necessary to attenuate the signal by 6dB to avoid limiting. This is a user selectable function, enabled by setting ADCDIV2 for the record path and DACDIV2 for the playback path. REGISTER ADDRESS R5 (05h) BIT 8 LABEL ADCDIV2 DEFAULT 0 ADC and DAC control DESCRIPTION ADC 6dB attenuate enable 0 = disabled (0dB) 1 = -6dB enabled 7 DACDIV2 0 DAC 6dB attenuate enable 0 = disabled (0dB) 1 = -6dB enabled Table 16 ADC and DAC 6dB Attenuation Select w PD, Rev 4.1, October 2013 26 WM8988 Production Data OUTPUT SIGNAL PATH The WM8988 output signal paths consist of digital filters, DACs, analogue mixers and output drivers. The digital filters and DACs are enabled when the WM8988 is in `playback only' or `record and playback' mode. The mixers and output drivers can be separately enabled by individual control bits (see Analogue Outputs). Thus it is possible to utilise the analogue mixing and amplification provided by the WM8988, irrespective of whether the DACs are running or not. The WM8988 receives digital input data on the DACDAT pin. The digital filter block processes the data to provide the following functions: Digital volume control Graphic equaliser and Dynamic Bass Boost Sigma-Delta Modulation Two high performance sigma-delta audio DACs convert the digital data into two analogue signals (left and right). These can then be mixed with analogue signals from the LINPUT1/2 and RINPUT1/2 pins, and the mix is fed to the output drivers, LOUT1/ROUT1 and LOUT2/ROUT2. LOUT1/ROUT1: can drive a 16 or 32 stereo headphone or stereo line output. LOUT2/ROUT2: can drive a 16 or 32 stereo headphone or stereo line output DIGITAL DAC VOLUME CONTROL The signal volume from each DAC can be controlled digitally, in the same way as the ADC volume (see Digital ADC Volume Control). The gain and attenuation range is -127dB to 0dB in 0.5dB steps. The level of attenuation for an eight-bit code X is given by: 0.5 (X-255) dB for 1 X 255; MUTE for X = 0 The LDVU and RDVU control bits control the loading of digital volume control data. When LDVU or RDVU are set to 0, the LDACVOL or RDACVOL control data is loaded into an intermediate register, but the actual gain does not change. Both left and right gain settings are updated simultaneously when either LDVU or RDVU are set to 1. REGISTER ADDRESS R10 (0Ah) BIT 8 LABEL LDVU DEFAULT 0 Left Channel Digital Volume DESCRIPTION Left DAC Volume Update 0 = Store LDACVOL in intermediate latch (no gain change) 1 = Update left and right channel gains (left = LDACVOL, right = intermediate latch) 7:0 LDACVOL 11111111 Left DAC Digital Volume Control [7:0] ( 0dB ) 0000 0000 = Digital Mute 0000 0001 = -127dB 0000 0010 = -126.5dB ... 0.5dB steps up to 1111 1111 = 0dB R11 (0Bh) 8 RDVU 0 Right Channel Digital Volume Right DAC Volume Update 0 = Store RDACVOL in intermediate latch (no gain change) 1 = Update left and right channel gains (left = intermediate latch, right = RDACVOL) 7:0 RDACVOL 11111111 Right DAC Digital Volume Control [7:0] ( 0dB ) similar to LDACVOL Table 17 Digital Volume Control w PD, Rev 4.1, October 2013 27 WM8988 Production Data GRAPHIC EQUALISER The WM8988 has a digital graphic equaliser and adaptive bass boost function. This function operates on digital audio data before it is passed to the audio DACs. Bass enhancement can take two different forms: Linear bass control: bass signals are amplified or attenuated by a user programmable gain. This is independent of signal volume, and very high bass gains on loud signals may lead to signal clipping. Adaptive bass boost: The bass volume is amplified by a variable gain. When the bass volume is low, it is boosted more than when the bass volume is high. This method is recommended because it prevents clipping, and usually sounds more pleasant to the human ear. Treble control applies a user programmable gain, without any adaptive boost function. Bass and treble control are completely independent with separately programmable gains and filter characteristics. REGISTER ADDRESS R12 (0Ch) BIT 7 LABEL BB DEFAULT 0 Bass Control DESCRIPTION Bass Boost 0 = Linear bass control 1 = Adaptive bass boost 6 BC 0 Bass Filter Characteristic 0 = Low Cutoff (130Hz at 48kHz sampling) 1 = High Cutoff (200Hz at 48kHz sampling) 3:0 BASS [3:0] R13 (0Dh) 6 TC 1111 (Disabled) 0 Treble Control Bass Intensity Code BB=0 BB=1 0000 +9dB 15 (max) 0001 +9dB 14 0010 +7.5dB 13 0011 +6dB 12 0100 +4.5dB 11 0101 +3dB 10 0110 +1.5dB 9 0111 0dB 8 1000 -1.5dB 7 1001 -3dB 6 1010 -4.5dB 5 1011 -6dB 4 1100 -6dB 3 1101 -6dB 2 1110 -6dB 1 1111 Bypass (OFF) Treble Filter Characteristic 0 = High Cutoff (8kHz at 48kHz sampling) 1 = Low Cutoff (4kHz at 48kHz sampling) 3:0 TRBL [3:0] 1111 (Disabled) Treble Intensity 0000 or 0001 = +9dB 0010 = +7.5dB ... (1.5dB steps) 1011 to 1110 = -6dB 1111 = Disable Table 18 Graphic Equaliser w PD, Rev 4.1, October 2013 28 WM8988 Production Data DIGITAL TO ANALOGUE CONVERTER (DAC) After passing through the graphic equaliser filters, digital `de-emphasis' can be applied to the audio data if necessary (e.g. when the data comes from a CD with pre-emphasis used in the recording). Deemphasis filtering is available for sample rates of 48kHz, 44.1kHz and 32kHz. The WM8988 also has a Soft Mute function, which gradually attenuates the volume of the digital signal to zero. When removed, the gain will return to the original setting. This function is enabled by default. To play back an audio signal, it must first be disabled by setting the DACMU bit to zero. REGISTER ADDRESS R5 (05h) BIT 2:1 ADC and DAC Control LABEL DEEMP DEFAULT 00 DESCRIPTION De-emphasis Control [1:0] 11 = 48kHz sample rate 10 = 44.1kHz sample rate 01 = 32kHz sample rate 00 = No De-emphasis 3 DACMU 1 Digital Soft Mute 1 = mute 0 = no mute (signal active) Table 19 DAC Control 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 multi-bit DAC architecture reduces high frequency noise and sensitivity to clock jitter. It also uses a Dynamic Element Matching technique for high linearity and low distortion. In normal operation, the left and right channel digital audio data is converted to analogue in two separate DACs. However, it is also possible to disable one channel, so that the same signal (left or right) appears on both analogue output channels. Additionally, there is a mono-mix mode where the two audio channels are mixed together digitally and then converted to analogue using only one DAC, while the other DAC is switched off. The mono-mix signal can be selected to appear on both analogue output channels. The DAC output defaults to non-inverted. Setting DACINV will invert the DAC output phase on both left and right channels. REGISTER ADDRESS R23 (17h) BIT 5:4 Additional Control (1) LABEL DMONOMIX DEFAULT 00 [1:0] DESCRIPTION DAC mono mix 00: stereo 01: mono ((L+R)/2) into DACL, `0' into DACR 10: mono ((L+R)/2) into DACR, `0' into DACL 11: mono ((L+R)/2) into DACL and DACR 1 DACINV 0 DAC phase invert 0 : non-inverted 1 : inverted Table 20 DAC Mono Mix and Phase Invert Select w PD, Rev 4.1, October 2013 29 WM8988 Production Data OUTPUT MIXERS The WM8988 provides the option to mix the DAC output signal with analogue line-in signals from the LINPUT1/2, RINPUT1/2 pins or a mono differential input (LINPUT1 - RINPUT1) or (LINPUT2 - RINPUT2), selected by DS (see Table 6) . The level of the mixed-in signals can be controlled with PGAs (Programmable Gain Amplifiers). The mono mixer is designed to allow a number of signal combinations to be mixed, including the possibility of mixing both the right and left channels together to produce a mono output. To prevent overloading of the mixer when full-scale DAC left and right signals are input, the mixer inputs from the DAC outputs each have a fixed gain of -6dB. The bypass path inputs to the mono mixer have variable gain as determined by R38/R39 bits [6:4]. REGISTER ADDRESS R34 (22h) BIT 2:0 LABEL LMIXSEL DEFAULT 000 Left Mixer (1) DESCRIPTION Left Input Selection for Output Mix 000 = LINPUT1 001 = LINPUT2 010 = Reserved 011 = Left ADC Input (after PGA / MICBOOST) 100 = Differential input R36 (24h) 2:0 RMIXSEL 000 Right Mixer (1) Right Input Selection for Output Mix 000 = RINPUT1 001 = RINPUT2 010 = Reserved 011 = Right ADC Input (after PGA / MICBOOST) 100 = Differential input Table 21 Output Mixer Signal Selection REGISTER ADDRESS R34 (22h) BIT 8 LABEL LD2LO DEFAULT 0 Left Mixer Control (1) DESCRIPTION Left DAC to Left Mixer 0 = Disable (Mute) 1 = Enable Path 7 LI2LO 0 LMIXSEL Signal to Left Mixer 0 = Disable (Mute) 1 = Enable Path 6:4 LI2LOVOL [2:0] 101 LMIXSEL Signal to Left Mixer Volume (-9dB) 000 = +6dB ... (3dB steps) 111 = -15dB R35 (23h) 8 RD2LO 0 Left Mixer Control (2) Right DAC to Left Mixer 0 = Disable (Mute) 1 = Enable Path 7 RI2LO 0 RMIXSEL Signal to Left Mixer 0 = Disable (Mute) 1 = Enable Path 6:4 RI2LOVOL [2:0] 101 RMIXSEL Signal to Left Mixer Volume (-9dB) 000 = +6dB ... (3dB steps) 111 = -15dB Table 22 Left Output Mixer Control w PD, Rev 4.1, October 2013 30 WM8988 Production Data REGISTER ADDRESS R36 (24h) BIT 8 LABEL LD2RO DEFAULT 0 Right Mixer Control (1) DESCRIPTION Left DAC to Right Mixer 0 = Disable (Mute) 1 = Enable Path 7 LI2RO 0 LMIXSEL Signal to Right Mixer 0 = Disable (Mute) 1 = Enable Path 6:4 LI2ROVOL [2:0] 101 LMIXSEL Signal to Right Mixer Volume (-9dB) 000 = +6dB ... (3dB steps) 111 = -15dB R37 (25h) 8 RD2RO 0 Right Mixer Control (2) Right DAC to Right Mixer 0 = Disable (Mute) 1 = Enable Path 7 RI2RO 0 RMIXSEL Signal to Right Mixer 0 = Disable (Mute) 1 = Enable Path 6:4 RI2ROVOL [2:0] 101 RMIXSEL Signal to Right Mixer Volume (-9dB) 000 = +6dB ... (3dB steps) 111 = -15dB Table 23 Right Output Mixer Control w PD, Rev 4.1, October 2013 31 WM8988 Production Data ANALOGUE OUTPUTS LOUT1/ROUT1 OUTPUTS The LOUT1 and ROUT1 pins can drive a 16 or 32 headphone or a line output (see Headphone Output and Line Output sections, respectively). The signal volume on LOUT1 and ROUT1 can be independently adjusted under software control by writing to LOUT1VOL and ROUT1VOL, respectively. Note that gains over 0dB may cause clipping if the signal is large. Any gain setting below 0101111 (minimum) mutes the output driver. The corresponding output pin remains at the same DC level (the reference voltage on the VREF pin), so that no click noise is produced when muting or unmuting. A zero cross detect on the analogue output may also be enabled when changing the gain setting to minimize audible clicks and zipper noise as the gain updates. If zero cross is enabled a timeout is also available to update the gain if a zero cross does not occur. This function may be enabled by setting TOEN in register R23 (17h). REGISTER ADDRESS R2 (02h) BIT 8 LABEL LO1VU DEFAULT 0 LOUT1 DESCRIPTION Left Volume Update 0 = Store LOUT1VOL in intermediate latch (no gain change) Volume 1 = Update left and right channel gains (left = LOUT1VOL, right = intermediate latch) 7 LO1ZC 0 Left zero cross enable 1 = Change gain on zero cross only 0 = Change gain immediately 6:0 LOUT1VOL 1111001 LOUT1 Volume [6:0] (0dB) 1111111 = +6dB ... (80 steps) 0110000 = -67dB 0111111 to 0000000 = Analogue MUTE R3 (03h) 8 RO1VU 0 ROUT1 Right Volume Update 0 = Store ROUT1VOL in intermediate latch (no gain change) Volume 1 = Update left and right channel gains (left = intermediate latch, right = ROUT1VOL) 7 RO1ZC 0 Right zero cross enable 1 = Change gain on zero cross only 0 = Change gain immediately 6:0 ROUT1VOL [6:0] 1111001 ROUT1 Volume 1111111 = +6dB ... (80 steps) 0110000 = -67dB 0111111 to 0000000 = Analogue MUTE Table 24 LOUT1/ROUT1 Volume Control LOUT1/ROUT1 COMMON GROUND FEEDBACK (HPCOM) The LOUT1/ROUT1 outputs also have the option of incorporating common ground feedback from the output signal ground, via a connection to the HPCOM input. This common ground feedback signal should be AC-coupled via a 4.7uF capacitor for the headphone loads. AC coupling of these outputs if they are used as LINE level outputs requires similar 1 to 4.7uF AC coupling capacitors depending upon LINE load resistance. w PD, Rev 4.1, October 2013 32 WM8988 Production Data REGISTER ADDRESS R24 (18h) BIT 7 LABEL HPCOMEN DEFAULT 0 DESCRIPTION HPCOM Enables common mode feedback on LOUT1 and ROUT1 Control 0: Disable Common Mode Feedback 1: Enable Common Mode Feedback Table 25 HPCOM Control LOUT2/ROUT2 OUTPUTS The LOUT2 and ROUT2 output pins are essentially similar to LOUT1 and ROUT1, but they are independently controlled. REGISTER ADDRESS R40 (28h) BIT 6:0 LOUT2 LABEL DEFAULT DESCRIPTION LOUT2VOL 1111001 LOUT2 Volume [6:0] (0dB) 1111111 = +6dB Volume ... (80 steps) 0110000 = -67dB 0111111 to 0000000 = Analogue MUTE 7 LO2ZC 0 Left zero cross enable 1 = Change gain on zero cross only 0 = Change gain immediately R41 (29h) 8 LO2VU 0 Same as LO1VU 6:0 ROUT2VOL 1111001 ROUT2 Volume [6:0] (0dB) 1111111 = +6dB ROUT2 Volume ... (80 steps) 0110000 = -67dB 0111111 to 0000000 = Analogue MUTE 7 RO2ZC 0 Right zero cross enable 1 = Change gain on zero cross only 0 = Change gain immediately R24 (18h) 8 RO2VU 0 Same as RO1VU 4 ROUT2INV 0 ROUT2 Invert Additional Control (2) 0 = No Inversion (0 phase shift) 1 = Signal inverted (180 phase shift) Table 26 LOUT2/ROUT2 Volume Control LOUT2/ROUT2 COMMON GROUND FEEDBACK (LCOM) The LOUT2/ROUT2 outputs also have the option of incorporating common ground feedback from the output signal ground, via a connection to the LCOM input. This common ground feedback signal should be AC-coupled via a 4.7uF capacitor for headphone loads. AC coupling of these outputs if they are used as LINE level outputs requires similar 1 to 4.7uF AC coupling capacitors depending upon LINE load resistance. REGISTER ADDRESS R24 (18h) BIT 8 LABEL LCOMEN DEFAULT 0 DESCRIPTION LCOM Enables common mode feedback on LOUT2 and ROUT2 Control 0: Disable Common Mode Feedback 1: Enable Common Mode Feedback Table 27 LCOM Control w PD, Rev 4.1, October 2013 33 WM8988 Production Data ENABLING THE OUTPUTS Each analogue output of the WM8988 can be separately enabled or disabled. The analogue mixer associated with each output is powered on or off along with the output pin. All outputs are disabled by default. To save power, unused outputs should remain disabled. Outputs can be enabled at any time, except when VREF is disabled (VR=0), as this may cause pop noise (see "Power Management" and "Applications Information" sections) REGISTER ADDRESS BIT LABEL DEFAULT DESCRIPTION R26 (1Ah) 6 LOUT1 0 Power Management (2) 5 ROUT1 0 LOUT1 Enable ROUT1 Enable 4 LOUT2 0 LOUT2 Enable 3 ROUT2 0 ROUT2 Enable Note: All "Enable" bits are 1 = Enabled, 0 = Disabled Table 28 Analogue Output Control Whenever an analogue output is disabled, it remains connected to VREF (pin 20) through a resistor. This helps to prevent pop noise when the output is re-enabled. The resistance between VREF and each output can be controlled using the VROI bit in register 27. The default is low (1.5k), so that any capacitors on the outputs can charge up quickly at start-up. If a high impedance is desired for disabled outputs, VROI can then be set to 1, increasing the resistance to about 40k. REGISTER ADDRESS R27 (1Bh) BIT 6 LABEL VROI DEFAULT 0 DESCRIPTION VREF to analogue output resistance Additional (1) 0: 1.5 k 1: 40 k Table 29 Disabled Outputs to VREF Resistance THERMAL SHUTDOWN The headphone outputs can drive very large currents. To protect the WM8988 from overheating a 0 thermal shutdown circuit is included. If the device temperature reaches approximately 150 C and the thermal shutdown circuit is enabled (TSDEN = 1) then the headphone amplifiers (outputs OUT1L/R and OUT2L/R) will be disabled. REGISTER ADDRESS R23 (17h) BIT 8 LABEL TSDEN Additional Control (1) DEFAULT 0 DESCRIPTION Thermal Shutdown Enable 0 : thermal shutdown disabled 1 : thermal shutdown enabled Table 30 Thermal Shutdown w PD, Rev 4.1, October 2013 34 WM8988 Production Data DIGITAL AUDIO INTERFACE The digital audio interface is used for inputting DAC data into the WM8988 and outputting ADC data from it. It uses four pins: ADCDAT: ADC data output DACDAT: DAC data input LRC: DAC and ADC data alignment clock BCLK: Bit clock, for synchronisation The clock signals BCLK and LRC can be an output when the WM8988 operates as a master, or an input when it is a slave (see Master and Slave Mode Operation, below). Four different audio data formats are supported: Left justified 2 IS DSP mode All four of these modes are MSB first. They are described in Audio Data Formats, below. Refer to the Electrical Characteristic section for timing information. MASTER AND SLAVE MODE OPERATION The WM8988 can be configured as either a master or slave mode device. As a master device the WM8988 generates BCLK, ADCLRC and DACLRC and thus controls sequencing of the data transfer on ADCDAT and DACDAT. In slave mode, the WM8988 responds with data to clocks it receives over the digital audio interface. The mode can be selected by writing to the MS bit (see Table 23). Master and slave modes are illustrated below. Figure 10 Master Mode Figure 11 Slave Mode AUDIO DATA FORMATS 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 12 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. w PD, Rev 4.1, October 2013 35 WM8988 Production Data 2 Figure 13 I S Justified Audio Interface (assuming n-bit word length) st nd In DSP/PCM mode, the left channel MSB is available on either the 1 (mode B) or 2 (mode A) rising edge of BCLK (selectable by LRP) following a rising edge of LRC. 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 LRC output will resemble the frame pulse shown in Figure 14 and Figure 15. In device slave mode, Figure 16 and Figure 17, 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 14 DSP/PCM Mode Audio Interface (mode A, LRP=0, Master) Figure 15 DSP/PCM Mode Audio Interface (mode B, LRP=1, Master) w PD, Rev 4.1, October 2013 36 WM8988 Production Data Figure 16 DSP/PCM Mode Audio Interface (mode A, LRP=0, Slave) Figure 17 DSP/PCM Mode Audio Interface (mode B, LRP=0, Slave) w PD, Rev 4.1, October 2013 37 WM8988 Production Data AUDIO INTERFACE CONTROL The register bits controlling audio format, word length and master / slave mode are summarised in Table 31. MS selects audio interface operation in master or slave mode. In Master mode BCLK and LRC are outputs. The frequency of LRC is set by the sample rate control bits SR[4:0] and USB. In Slave mode BCLK and LRC are inputs. REGISTER ADDRESS R7 (07h) BIT 7 LABEL DEFAULT BCLKINV 0 Digital Audio Interface Format DESCRIPTION BCLK invert bit (for master and slave modes) 0 = BCLK not inverted 1 = BCLK inverted 6 MS 0 Master / Slave Mode Control 1 = Enable Master Mode 0 = Enable Slave Mode 5 LRSWAP 0 Left/Right channel swap 1 = swap left and right DAC data in audio interface 0 = output left and right data as normal 4 LRP 0 right, left and I2S modes - LRCLK polarity 1 = invert LRCLK polarity 0 = normal LRCLK polarity DSP Mode - mode A/B select st 1 = MSB is available on 1 BCLK rising edge after LRC rising edge (mode B) nd 0 = MSB is available on 2 BCLK rising edge after LRC rising edge (mode A) 3:2 WL[1:0] 10 Audio Data Word Length 11 = 32-bits (see Note) 10 = 24-bits 01 = 20-bits 00 = 16-bits 1:0 FORMAT[1:0] 10 Audio Data Format Select 11 = DSP Mode 2 10 = I S Format 01 = Left justified 00 = reserved (do not use this setting) Table 31 Audio Data Format Control AUDIO INTERFACE OUTPUT TRISTATE Register bit TRI, register 24(18h) bit[3] can be used to tristate the ADCDAT pin and switch ADCLRC, DACLRC and BCLK to inputs. In Slave mode (MASTER=0) LRC and BCLK are by default configured as inputs and only ADCDAT will be tri-stated, (see Table 32). REGISTER ADDRESS R24(18h) Additional Control (2) BIT LABEL DEFAULT 3 TRI 0 DESCRIPTION Tristates ADCDAT and switches ADCLRC, DACLRC and BCLK to inputs. 0 = ADCDAT is an output, LRC and BCLK are inputs (slave mode) or outputs (master mode) 1 = ADCDAT is tristated, LRC and BCLK are inputs Table 32 Tri-stating the Audio Interface w PD, Rev 4.1, October 2013 38 WM8988 Production Data MASTER MODE LRC ENABLE In Master mode the lrclk (LRC) is enabled by default only when the DAC is enabled. If ADC only operation in Master mode is required register bit LRCM must be set in order to generate an lrclk. For DAC only operation LRCM may be set to `0'. REGISTER ADDRESS R24(18h) Additional Control (2) BIT LABEL DEFAULT 2 LRCM 0 DESCRIPTION Selects disable mode for LRC 0 = LRC disabled when DAC (Left and Right) disabled. 1 = LRC disabled only when ADC (Left and Right) and DAC (Left and Right) are disabled. Table 33 LRC Enable BIT CLOCK MODE The default master mode bit clock generator produces a bit clock frequency based on the sample rate and input MCLK frequency as shown in Table 36. When enabled by setting the appropriate BCM[1:0] bits, the bit clock mode (BCM) function overrides the default master mode bit clock generator to produce the bit clock frequency shown in the table below: REGISTER ADDRESS R8 (08h) BIT LABEL DEFAULT 8:7 BCM[1:0] 00 Clocking and Sample Rate Control DESCRIPTION BCLK Frequency 00 = BCM function disabled 01 = MCLK/4 10 = MCLK/8 11 = MCLK/16 Table 34 Master Mode BCLK Frequency Control The BCM mode bit clock generator produces 16 or 24-bit clock cycles per sample. The number of bit clock cycles per sample in this mode is determined by the word length bits (WL[1:0]) in the Digital Audio Interface Format register (R7). When these bits are set to 00, there will be 16-bit clock cycles per sample. When these bits are set to 01, 10 or 11, there will be 24 bit clock cycles per sample. Please refer to Figure 18. In order to use BCM either the ADC must be enabled or, if the ADC is disabled, the LRCM bit must be set and the DAC enabled. When the BCM function is enabled, the following restrictions apply: 1. The bit clock invert (BCLKINV) function is not available. 2. DSP late digital audio interface mode is not available and must not be enabled. Figure 18 Bit Clock Mode Note: The shaded bit clock cycles are present only when 24-bit mode is selected. Please refer to the "Bit Clock Mode" description for details. w PD, Rev 4.1, October 2013 39 WM8988 Production Data CLOCKING AND SAMPLE RATES The WM8988 supports a wide range of master clock frequencies on the MCLK pin, and can generate many commonly used audio sample rates directly from the master clock. The ADC and DAC must always run at the same sample rate. There are two clocking modes: `Normal' mode supports master clocks of 128fs, 192fs, 256fs, 384fs, and their multiples (Note: fs refers to the ADC or DAC sample rate, whichever is faster) USB mode supports 12MHz or 24MHz master clocks. This mode is intended for use in systems with a USB interface, and eliminates the need for an external PLL to generate another clock frequency for the audio CODEC. REGISTER ADDRESS R8 (08h) Clocking and Sample Rate Control BIT 6 LABEL CLKDIV2 DEFAULT 0 DESCRIPTION Master Clock Divide by 2 1 = MCLK is divided by 2 0 = MCLK is not divided 5:1 SR [4:0] 00000 0 USB 0 Sample Rate Control Clocking Mode Select 1 = USB Mode 0 = `Normal' Mode Table 35 Clocking and Sample Rate Control The clocking of the WM8988 is controlled using the CLKDIV2, USB, and SR control bits. Setting the CLKDIV2 bit divides MCLK by two internally. The USB bit selects between `Normal' and USB mode. Each value of SR[4:0] selects one combination of MCLK division ratios and hence one combination of sample rates (see next page). Since all sample rates are generated by dividing MCLK, their accuracy depends on the accuracy of MCLK. If MCLK changes, the sample rates change proportionately. Note that some sample rates (e.g. 44.1kHz in USB mode) are approximated, i.e. they differ from their target value by a very small amount. This is not audible, as the maximum deviation is only 0.27% (8.0214kHz instead of 8kHz in USB mode). By comparison, a half-tone step corresponds to a 5.9% change in pitch. The SR[4:0] bits must be set to configure the appropriate ADC and DAC sample rates in both master and slave mode. w PD, Rev 4.1, October 2013 40 WM8988 Production Data MCLK MCLK ADC SAMPLE RATE DAC SAMPLE RATE CLKDIV2=0 CLKDIV2=1 (ADCLRC) (DACLRC) `Normal' Clock Mode (`*' indicates backward compatibility with WM8731) 8 kHz (MCLK/1536) 8 kHz (MCLK/1536) 24.576 MHz 12 kHz (MCLK/1024) 12 kHz (MCLK/1024) 16 kHz (MCLK/768) 16 kHz (MCLK/768) 24 kHz (MCLK/512) 24 kHz (MCLK/512) 32 kHz (MCLK/384) 32 kHz (MCLK/384) 48 kHz (MCLK/256) 48 kHz (MCLK/256) 96 kHz (MCLK/128) 96 kHz (MCLK/128) 8.0182 kHz (MCLK/1408) 8.0182 kHz (MCLK/1408) 11.2896MHz 22.5792MHz 11.025 kHz (MCLK/1024) 11.025 kHz (MCLK/1024) 22.05 kHz (MCLK/512) 22.05 kHz (MCLK/512) 44.1 kHz (MCLK/256) 44.1 kHz (MCLK/256) 88.2 kHz (MCLK/128) 88.2 kHz (MCLK/128) 8 kHz (MCLK/2304) 8 kHz (MCLK/2304) 18.432MHz 36.864MHz 12 kHz (MCLK/1536) 12 kHz (MCLK/1536) 16kHz (MCLK/1152) 16 kHz (MCLK/1152) 24kHz (MCLK/768) 24 kHz (MCLK/768) 32 kHz (MCLK/576) 32 kHz (MCLK/576) 48 kHz (MCLK/384) 48 kHz (MCLK/384) 96 kHz (MCLK/192) 96 kHz (MCLK/192) 8.0182 kHz (MCLK/2112) 8.0182 kHz (MCLK/2112) 16.9344MHz 33.8688MHz 11.025 kHz (MCLK/1536) 11.025 kHz (MCLK/1536) 22.05 kHz (MCLK/768) 22.05 kHz (MCLK/768) 44.1 kHz (MCLK/384) 44.1 kHz (MCLK/384) 88.2 kHz (MCLK/192) 88.2 kHz (MCLK/192) USB Mode (`*' indicates backward compatibility with WM8731) 8 kHz (MCLK/1500) 8 kHz (MCLK/1500) 12.000MHz 24.000MHz 8.0214 kHz (MCLK/1496) 8.0214kHz (MCLK/1496) 11.0259 kHz (MCLK/1088) 11.0259kHz (MCLK/1088) 12 kHz (MCLK/1000) 12 kHz (MCLK/1000) 16kHz (MCLK/750) 16kHz (MCLK/750) 22.0588kHz (MCLK/544) 22.0588kHz (MCLK/544) 24kHz (MCLK/500) 24kHz (MCLK/500) 32 kHz (MCLK/375) 32 kHz (MCLK/375) 44.118 kHz (MCLK/272) 44.118 kHz (MCLK/272) 48 kHz (MCLK/250) 48 kHz (MCLK/250) 88.235kHz (MCLK/136) 88.235kHz (MCLK/136) 96 kHz (MCLK/125) 96 kHz (MCLK/125) 12.288 MHz USB SR [4:0] FILTER BCLK TYPE (MS=1) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 00110 * 01000 01010 11100 01100 * 00000 * 01110 * 10110 * 11000 11010 10000 * 11110 * 00111 * 01001 01011 11101 01101 * 00001 * 01111 * 10111 * 11001 11011 10001 * 11111 * 1 1 1 1 1 1 3 1 1 1 1 3 1 1 1 1 1 1 3 1 1 1 1 3 MCLK/4 MCLK/4 MCLK/4 MCLK/4 MCLK/4 MCLK/4 MCLK/2 MCLK/4 MCLK/4 MCLK/4 MCLK/4 MCLK/2 MCLK/6 MCLK/6 MCLK/6 MCLK/6 MCLK/6 MCLK/6 MCLK/3 MCLK/6 MCLK/6 MCLK/6 MCLK/6 MCLK/3 1 1 1 1 1 1 1 1 1 1 1 1 00110 * 10111 * 11001 01000 01010 11011 11100 01100 * 10001 * 00000 * 11111 * 01110 * 0 1 1 0 0 1 0 0 1 0 3 2 MCLK MCLK MCLK MCLK MCLK MCLK MCLK MCLK MCLK MCLK MCLK MCLK Table 36 Master Clock and Sample Rates w PD, Rev 4.1, October 2013 41 WM8988 Production Data CONTROL INTERFACE SELECTION OF CONTROL MODE The WM8988 is controlled by writing to registers through a serial control interface. A control word consists of 16 bits. The first 7 bits (B15 to B9) are address bits that select which control register is accessed. The remaining 9 bits (B8 to B0) are data bits, corresponding to the 9 bits in each control register. The control interface can operate as either a 3-wire or 2-wire MPU interface. The MODE pin selects the interface format. MODE INTERFACE FORMAT Low 2 wire High 3 wire Table 37 Control Interface Mode Selection 3-WIRE SERIAL CONTROL MODE In 3-wire mode, every rising edge of SCLK clocks in one data bit from the SDIN pin. A rising edge on CSB latches in a complete control word consisting of the last 16 bits. latch CSB SCLK B15 SDIN B14 B13 B12 B11 B10 B9 B8 B7 B6 control register address B5 B4 B3 B2 B1 B0 control register data bits Figure 19 3-Wire Serial Control Interface 2-WIRE SERIAL CONTROL MODE The WM8988 supports software control via a 2-wire serial bus. Many devices can be controlled by the same bus, and each device has a unique 7-bit address (this is not the same as the 7-bit address of each register in the WM8988). The WM8988 operates as a slave device only. The controller indicates the start of data transfer with a high to low transition on SDIN while SCLK remains high. This indicates that a device address and data will follow. All devices on the 2-wire bus respond to the start condition and shift in the next eight bits on SDIN (7-bit address + Read/Write bit, MSB first). If the device address received matches the address of the WM8988 and the R/W bit is `0', indicating a write, then the WM8988 responds by pulling SDIN low on the next clock pulse (ACK). If the address is not recognised or the R/W bit is `1', the WM8988 returns to the idle condition and wait for a new start condition and valid address. Once the WM8988 has acknowledged a correct address, the controller sends the first byte of control data (B15 to B8, i.e. the WM8988 register address plus the first bit of register data). The WM8988 then acknowledges the first data byte by pulling SDIN low for one clock pulse. The controller then sends the second byte of control data (B7 to B0, i.e. the remaining 8 bits of register data), and the WM8988 acknowledges again by pulling SDIN low. The transfer of data is complete when there is a low to high transition on SDIN while SCLK is high. After receiving a complete address and data sequence the WM8988 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. SDIN changes while SCLK is high), the device jumps to the idle condition. DEVICE ADDRESS (7 BITS) SDIN RD / WR BIT ACK (LOW) CONTROL BYTE 1 (BITS 15 TO 8) ACK (LOW) CONTROL BYTE 2 (BITS 7 TO 0) ACK (LOW) SCLK START register address and 1st register data bit remaining 8 bits of register data STOP Figure 20 2-Wire Serial Control Interface w PD, Rev 4.1, October 2013 42 WM8988 Production Data The WM8988 has two possible device addresses, which can be selected using the CSB pin. CSB STATE DEVICE ADDRESS Low 0011010 (0 x 34h) High 0011011 (0 x 36h) Table 38 2-Wire MPU Interface Address Selection POWER SUPPLIES The WM8988 can use up to four separate power supplies: AVDD / AGND: Analogue supply, powers all analogue functions except the headphone drivers. AVDD can range from 1.8V to 3.6V and has the most significant impact on overall power consumption (except for power consumed in the headphone). A large AVDD slightly improves audio quality. HPVDD / HPGND: Headphone supply, powers the headphone drivers. HPVDD is normally tied to AVDD, but it requires separate layout and decoupling capacitors to curb harmonic distortion. If HPVDD is lower than AVDD, the output signal may be clipped. DCVDD: Digital core supply, powers all digital functions except the audio and control interfaces. DCVDD can range from 1.42V to 3.6V, and has no effect on audio quality. The return path for DCVDD is DGND, which is shared with DBVDD. DBVDD: Digital buffer supply, powers the audio and control interface buffers. This makes it possible to run the digital core at very low voltages, saving power, while interfacing to other digital devices using a higher voltage. DBVDD draws much less power than DCVDD, and has no effect on audio quality. DBVDD can range from 1.8V to 3.6V. The return path for DBVDD is DGND, which is shared with DCVDD. It is possible to use the same supply voltage on all four. However, digital and analogue supplies should be routed and decoupled separately to keep digital switching noise out of the analogue signal paths. POWER MANAGEMENT The WM8988 has two control registers that allow users to select which functions are active. For minimum power consumption, unused functions should be disabled. To avoid any pop or click noise, it is important to enable or disable functions in the correct order (see Applications Information). VMIDSEL is the enable for the Vmid reference, which defaults to disabled and can be enabled as a 50k potential divider or, for low power maintenance of Vref when all other blocks are disabled, as a 500k potential divider. w PD, Rev 4.1, October 2013 43 WM8988 Production Data REGISTER ADDRESS R25 (19h) BIT 8:7 LABEL VMIDSEL DEFAULT 00 Power Management (1) DESCRIPTION Vmid divider enable and select 00 - Vmid disabled (for OFF mode) 01 - 50k divider enabled (for playback/record) 10 - 500k divider enabled (for low-power standby) 11 - 5k divider enabled (for fast start-up) 6 VREF 0 VREF (necessary for all other functions) 0 = Power down 1 = Power up 5 AINL 0 Analogue in PGA Left 0 = Power down 1 = Power up 4 AINR 0 Analogue in PGA Right 0 = Power down 1 = Power up 3 ADCL 0 ADC Left 0 = Power down 1 = Power up 2 ADCR 0 ADC Right 0 = Power down 1 = Power up R26 (1Ah) Power Management (2) 8 DACL 0 DAC Left 0 = Power down 1 = Power up 7 DACR 0 DAC Right 0 = Power down 1 = Power up 6 LOUT1 0 LOUT1 Output Buffer* 0 = Power down 1 = Power up 5 ROUT1 0 ROUT1 Output Buffer* 0 = Power down 1 = Power up 4 LOUT2 0 LOUT2 Output Buffer* 0 = Power down 1 = Power up 3 ROUT2 0 ROUT2 Output Buffer* 0 = Power down 1 = Power up * The left mixer is enabled when LOUT1=1 or LOUT2=1. The right mixer is enabled when ROUT1=1 or ROUT2=1. Table 39 Power Management w PD, Rev 4.1, October 2013 44 WM8988 Production Data STOPPING THE MASTER CLOCK In order to minimise power consumed in the digital core of the WM8988, the master clock may be stopped in Standby and OFF modes. If this cannot be done externally at the clock source, the DIGENB bit (R25, bit 0) can be set to stop the MCLK signal from propagating into the device core. In Standby mode, setting DIGENB will typically provide an additional power saving on DCVDD of 20uA. However, since setting DIGENB has no effect on the power consumption of other system components external to the WM8988, it is preferable to disable the master clock at its source wherever possible. REGISTER ADDRESS BIT R25 (19h) 0 LABEL DIGENB DEFAULT 0 DESCRIPTION Master clock disable Additional Control (1) 0: master clock enabled 1: master clock disabled Table 40 ADC and DAC Oversampling Rate Selection NOTE: Before DIGENB can be set, the control bits ADCL, ADCR, DACL and DACR must be set to zero and a waiting time of 1ms must be observed. Any failure to follow this procedure may prevent DACs and ADCs from re-starting correctly. SAVING POWER BY REDUCING BIAS CURRENTS The design of the DAC allows user trade-off between power consumption and performance, using the DACMIXBIAS bit. The default setting (DACMIXBIAS=0) delivers the best audio performance. Setting DACMIXBIAS=1 reduces AVDD current consumption, at the cost of marginally reduced performance (see "Electrical Characteristics" for details). REGISTER ADDRESS R67 (43h) BIT LABEL 3 DACMIX BIAS DEFAULT 0 DESCRIPTION DAC biasing 0 = high bias current (results in higher performance and power consumption) 1 = low bias current (results in lower performance and power consumption) Table 41 DAC Biasing SAVING POWER BY REDUCING OVERSAMPLING RATE The default mode of operation of the ADC and DAC digital filters is in 128x oversampling mode. Under the control of ADCOSR and DACOSR the oversampling rate may be halved. This will result in a slight decrease in noise performance but will also reduce the power consumption of the device. In USB mode ADCOSR must be set to 0, i.e. 128x oversampling. REGISTER ADDRESS R24 (18h) BIT 1 LABEL ADCOSR DEFAULT 0 Additional Control (2) DESCRIPTION ADC oversample rate select 1 = 64x (lowest power) 0 = 128x (best SNR) 0 DACOSR 0 DAC oversample rate select 1 = 64x (lowest power) 0 = 128x (best SNR) Table 42 ADC and DAC Oversampling Rate Selection ADCOSR set to `1', 64x oversample mode, is not supported in USB mode (USB=1). w PD, Rev 4.1, October 2013 45 WM8988 Production Data SAVING POWER AT HIGHER SUPPLY VOLTAGES The analogue supplies to the WM8988 can run from 1.8V to 3.6V. By default, all analogue circuitry on the device is optimized to run at 3.3V. This set-up is also good for all other supply voltages down to 1.8V. At lower voltages, performance can be improved by increasing the bias current. If low power operation is preferred the bias current can be left at the default setting. This is controlled as shown below. REGISTER ADDRESS BIT LABEL R23 (17h) 7:6 VSEL [1:0] Additional Control(1) DEFAULT 11 DESCRIPTION Analogue Bias optimization 00: Highest bias current, optimized for AVDD=1.8V 01: Bias current optimized for AVDD=2.5V 1X: Lowest bias current, optimized for AVDD=3.3V w PD, Rev 4.1, October 2013 46 WM8988 Production Data REGISTER MAP ADDRESS REGISTER remarks Bit[8] Bit[7] Bit[6] Bit[5] Bit[4] Bit[3] Bit[2] Bit[1] Bit[0] default page ref (Bit 15 - 9) R0 (00h) 0000000 Left Input volume LIVU LINMUTE LIZC LINVOL 010010111 19 R1 (01h) 0000001 Right Input volume RIVU RINMUTE RIZC RINVOL 010010111 19 R2 (02h) 0000010 LOUT1 volume LO1VU LO1ZC LOUT1VOL[6:0] 001111001 32 R3 (03h) 0000011 ROUT1 volume RO1VU RO1ZC ROUT1VOL[6:0] 001111001 32 R4 (04h) 0000100 Reserved 0 0 R5 (05h) 0000101 ADC & DAC Control 0 ADCDIV2 DACDIV2 0 ADCPOL[1:0] 0 0 HPOR DACMU 0 R6 (06h) 0000110 Reserved 0 0 0 0 0 R7 (07h) 0000111 Audio Interface 0 BCLKINV MS LRSWAP LRP R8 (08h) 0001000 Sample rate R9 (09h) 0001001 Reserved 0 0 BCM[1:0] 0 0 000000000 - ADCHPD 000001000 19,26,29 0 DEEMPH[1:0] 0 000000000 - FORMAT[1:0] 000001010 38 USB 000000000 40 0 000000000 - 011111111 27 0 WL[1:0] CLKDIV2 0 0 0 SR[4:0] 0 0 0 R10 (0Ah) 0001010 Left DAC volume LDVU LDACVOL[7:0] R11 (0Bh) 0001011 Right DAC volume RDVU RDACVOL[7:0] R12 (0Ch) 0001100 Bass control 0 BB R13 (0Dh) 0001101 Treble control 0 0 R15 (0Fh) 0001111 Reset R16 (10h) 0010000 3D control R17 (11h) 0010001 ALC1 ALCSEL[1:0] R18 (12h) 0010010 ALC2 0 R19 (13h) 0010011 ALC3 0 R20 (14h) 0010100 Noise Gate 0 0 011111111 27 BC 0 0 BASS[3:0] 000001111 28 TC 0 0 TRBL[3:0] 000001111 28 not reset - writing to this register resets all registers to their default state 0 MODE3D ALCZC 3DUC 3DLC 0 000000000 26 ALCL[3:0] 001111011 24 HLD[3:0] 000000000 24 ATK[3:0] 000110010 24 000000000 25 22 3DDEPTH[3:0] MAXGAIN[2:0] 0 0 DCY[3:0] NGTH[4:0] 3DEN NGG[1:0] NGAT R21 (15h) 0010101 Left ADC volume LAVU LADCVOL[7:0] 011000011 R22 (16h) 0010110 Right ADC volume RAVU RADCVOL[7:0] 011000011 22 R23 (17h) 0010111 Additional control(1) TSDEN 18,19,29,34 R24 (18h) 0011000 Additional control(2) VSEL[1:0] LCOMEN HPCOMEN 0 0 0 DATSEL[1:0] DACINV TOEN 011000000 TRI LRCM ADCOSR DACOSR 000000000 VREF AINL AINR ADCL ADCR 0 DIGENB 000000000 44 LOUT1 ROUT1 LOUT2 ROUT2 0 0 0 000000000 44 VROI HPFLREN 0 0 0 0 0 000000000 35 RDCM LDCM 0 0 0 0 000000000 17 LMICBOOST[1:0] 0 0 0 0 000000000 17 0 0 0 0 R25 (19h) 0011001 Pwr Mgmt (1) R26 (1Ah) 0011010 Pwr Mgmt (2) R27 (1Bh) 0011011 Additional Control (3) R31 (1Fh) 0011111 ADC input mode DS MONOMIX[1:0] R32 (20h) 0100000 ADCL signal path 0 LINSEL[1:0] R33 (21h) 0100001 ADCR signal path 0 R34 (22h) 0100010 Left out Mix (1) LD2LO LI2LO LI2LOVOL[2:0] 0 R35 (23h) 0100011 Left out Mix (2) RD2LO RI2LO RI2LOVOL[2:0] 0 R36 (24h) 0100100 Right out Mix (1) LD2RO LI2RO LI2ROVOL[2:0] 0 R37 (25h) 0100101 Right out Mix (2) RD2RO RI2RO R38 (26h) 0100110 Reserved 0 0 1 0 1 R39 (27h) 0100111 Reserved 0 0 1 0 1 R40 (28h) 0101000 LOUT2 volume LO2VU LO2ZC LOUT2VOL[6:0] R41 (29h) 0101001 ROUT2 volume RO2VU RO2ZC ROUT2VOL[6:0] 001111001 33 R42 (2Ah) 0101010 Reserved 0 0 35 R67 (43h) 1000011 Low Power Playback VMIDSEL[1:0] DMONOMIX[1:0] DACL DACR 00 0 RINSEL[1:0] 0 RMICBOOST[1:0] RI2ROVOL[2:0] 1 0 1 0 1 0 LMIXSEL[2:0] 0 0 0 RMIXSEL[2:0] 000000000 17 001010000 30 001010000 30 001010000 31 0 0 0 0 001010000 31 0 0 0 0 001010000 30 0 0 0 0 001010000 30 001111001 33 1 DACMIX BIAS 0 0 1 001111001 0 0 0 000000000 50 Highlighting indicates bits or registers which differ from WM8750L / WM8750BL device family. w PD, Rev 4.1, October 2013 47 WM8988 Production Data DIGITAL FILTER CHARACTERISTICS The ADC and DAC employ different digital filters. There are 4 types of digital filter, called Type 0, 1, 2 and 3. The performance of Types 0 and 1 is listed in the table below, the responses of all filters is shown in the proceeding pages. PARAMETER TEST CONDITIONS MIN TYP MAX UNIT ADC Filter Type 0 (USB Mode, 250fs operation) Passband +/- 0.05dB 0 -6dB 0.416fs 0.5fs Passband Ripple +/- 0.05 Stopband dB 0.584fs Stopband Attenuation f > 0.584fs -60 dB ADC Filter Type 1 (USB mode, 272fs or Normal mode operation) Passband +/- 0.05dB 0 -6dB 0.4535fs 0.5fs Passband Ripple +/- 0.05 Stopband dB 0.5465fs Stopband Attenuation f > 0.5465fs High Pass Filter Corner Frequency -60 dB -3dB 3.7 -0.5dB 10.4 -0.1dB 21.6 Hz DAC Filter Type 0 (USB mode, 250fs operation) Passband +/- 0.03dB 0 -6dB 0.416fs 0.5fs Passband Ripple +/-0.03 Stopband dB 0.584fs Stopband Attenuation f > 0.584fs -50 dB DAC Filter Type 1 (USB mode, 272fs or Normal mode operation) Passband +/- 0.03dB 0 -6dB 0.4535fs 0.5fs Passband Ripple +/- 0.03 Stopband dB 0.5465fs Stopband Attenuation f > 0.5465fs -50 dB Table 43 Digital Filter Characteristics DAC FILTERS ADC FILTERS Mode Group Delay Mode Group Delay 0 (250 USB) 11/fs 0 (250 USB) 13/fs 1 (256/272) 16/fs 1 (256/272) 23/fs 2 (250 USB, 96k mode) 4/fs 2 (250 USB, 96k mode) 4/fs 3 (256/272, 88.2/96k mode) 3/fs 3 (256/272, 88.2/96k mode) 5/fs Table 44 ADC/DAC Digital Filters Group Delay 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, October 2013 48 WM8988 Production Data DAC FILTER RESPONSES 0.02 0 0.01 0 Response (dB) Response (dB) -20 -40 -60 -0.01 -0.02 -0.03 -0.04 -80 -0.05 -100 0 0.5 1 1.5 Frequency (Fs) 2 2.5 3 -0.06 0 0.05 0.1 0.15 0.2 0.25 0.3 Frequency (Fs) 0.35 0.4 0.45 0.5 0.4 0.45 0.5 Figure 21 DAC Digital Filter Frequency Response - Type 0 Figure 22 DAC Digital Filter Ripple - Type 0 0.02 0 0.01 0 Response (dB) Response (dB) -20 -40 -60 -0.01 -0.02 -0.03 -0.04 -80 -0.05 -0.06 -100 0 0.5 1 1.5 Frequency (Fs) 2 2.5 0 3 0.05 0.1 0.15 0.2 0.25 0.3 Frequency (Fs) 0.35 Figure 23 DAC Digital Filter Frequency Response - Type 1 Figure 24 DAC Digital Filter Ripple - Type 1 0.02 0 0.01 0 Response (dB) Response (dB) -20 -40 -60 -0.01 -0.02 -0.03 -0.04 -80 -0.05 -0.06 -100 0 0.5 1 1.5 Frequency (Fs) 2 2.5 3 0 0.05 0.1 0.15 Frequency (Fs) 0.2 0.25 Figure 25 DAC Digital Filter Frequency Response - Type 2 Figure 26 DAC Digital Filter Ripple - Type 2 w PD, Rev 4.1, October 2013 49 WM8988 Production Data 0.25 0 0.2 0.15 -20 Response (dB) Response (dB) 0.1 -40 -60 0.05 0 -0.05 -0.1 -80 -0.15 -100 -0.25 -0.2 0 0.5 1 1.5 Frequency (Fs) 2 2.5 3 0 0.05 0.1 0.15 Frequency (Fs) 0.2 0.25 Figure 27 DAC Digital Filter Frequency Response - Type 3 Figure 28 DAC Digital Filter Ripple - Type 3 ADC FILTER RESPONSES 0.04 0 0.03 0.02 Response (dB) Response (dB) -20 -40 -60 0.01 0 -0.01 -0.02 -80 -0.03 -100 0 0.5 1 1.5 Frequency (Fs) 2 2.5 -0.04 3 0 Figure 29 ADC Digital Filter Frequency Response - Type 0 0.05 0.1 0.15 0.2 0.25 0.3 Frequency (Fs) 0.35 0.4 0.45 0.5 Figure 30 ADC Digital Filter Ripple - Type 0 0.02 0 0.01 0 Response (dB) Response (dB) -20 -40 -60 -0.01 -0.02 -0.03 -0.04 -80 -0.05 -0.06 -100 0 0.5 1 1.5 Frequency (Fs) 2 2.5 Figure 31 ADC Digital Filter Frequency Response - Type 1 w 3 0 0.05 0.1 0.15 0.2 0.25 0.3 Frequency (Fs) 0.35 0.4 0.45 0.5 Figure 32 ADC Digital Filter Ripple - Type 1 PD, Rev 4.1, October 2013 50 WM8988 Production Data 0.25 0 0.2 0.15 -20 Response (dB) Response (dB) 0.1 -40 -60 0.05 0 -0.05 -0.1 -80 -0.15 -100 -0.25 -0.2 0 0.5 1 1.5 Frequency (Fs) 2 2.5 3 0 Figure 33 ADC Digital Filter Frequency Response - Type 2 0.05 0.1 0.15 Frequency (Fs) 0.2 0.25 Figure 34 ADC Digital Filter Ripple - Type 2 0.25 0 0.2 0.15 -20 Response (dB) Response (dB) 0.1 -40 -60 0.05 0 -0.05 -0.1 -80 -0.15 -100 -0.25 -0.2 0 0.5 1 1.5 Frequency (Fs) 2 2.5 0 3 Figure 35 ADC Digital Filter Frequency Response - Type 2 0.05 0.1 0.15 Frequency (Fs) 0.2 0.25 Figure 36 ADC Digital Filter Ripple - Type 3 DE-EMPHASIS FILTER RESPONSES 0.4 0 0.3 -2 Response (dB) Response (dB) 0.2 -4 -6 0.1 0 -0.1 -0.2 -8 -0.3 -0.4 -10 0 2000 4000 6000 8000 10000 Frequency (Fs) 12000 14000 Figure 37 De-emphasis Frequency Response (32kHz) w 16000 0 2000 4000 6000 8000 10000 Frequency (Fs) 12000 14000 16000 Figure 38 De-emphasis Error (32kHz) PD, Rev 4.1, October 2013 51 WM8988 Production Data 0.4 0 0.3 -2 Response (dB) Response (dB) 0.2 -4 -6 0.1 0 -0.1 -0.2 -8 -0.3 -0.4 -10 0 5000 10000 Frequency (Fs) 15000 0 20000 Figure 39 De-emphasis Frequency Response (44.1kHz) 5000 10000 Frequency (Fs) 15000 20000 15000 20000 Figure 40 De-emphasis Error (44.1kHz) 0.4 0 0.3 -2 Response (dB) Response (dB) 0.2 -4 -6 0.1 0 -0.1 -0.2 -8 -0.3 -0.4 -10 0 5000 10000 Frequency (Fs) 15000 0 20000 Figure 41 De-emphasis Frequency Response (48kHz) 5000 10000 Frequency (Fs) Figure 42 De-emphasis Error (48kHz) HIGHPASS FILTER The WM8988 has a selectable digital highpass filter in the ADC filter path to remove DC offsets. The filter response is characterised by the following polynomial: H(z) = 1 - z-1 1 - 0.9995z-1 Response (dB) 0 -5 -10 -15 0 0.0005 0.001 Frequency (Fs) 0.0015 0.002 Figure 43 ADC Highpass Filter Response w PD, Rev 4.1, October 2013 52 WM8988 Production Data APPLICATIONS INFORMATION RECOMMENDED EXTERNAL COMPONENTS DVDD AVDD DGND DBVDD DCVDD HPGND AGND GND AVDD HPVDD C1 C2 0.1uF 0.1uF GND GND C4 C3 4.7uF 220uF + C14 LOUT1 4.7uF + ROUT1 GND MCLK HPCOM + 16 OR 32 OHM HEADPHONES C15 220uF C20 4.7uF BCLK AUDIO INTERFACE (I2S/LJ/RJ/DSP) LRC DACDAT ADCDAT GND WM8988 + LOUT2 HIGH for 3-wire LOW for 2-wire + ROUT2 CONTROL INTERFACE (2 OR 3-WIRE) CSB SDIN SCLK Lineout C23 10uF + LCOM C22 10uF MODE C21 4.7uF C7 1uF C8 1uF C9 1uF C10 1uF LINPUT1 GND RINPUT1 LINPUT2 RINPUT2 VREF VMID + C19 + C17 4.7uF 4.7uF GND GND Layout Notes: 1. C1 to C4, C17, C19, C20 and C21 should be as close to the relative WM8988 connecting pin as possible. 2. For capacitors C7 to C10, C14, C15, C22 and C23 it is recommended that low ESR components are used. 3. HPCOM and LCOM should be connected to GND at the connector. Figure 44 Recommended External Components Diagram w PD, Rev 4.1, October 2013 53 WM8988 Production Data LINE INPUT CONFIGURATION When LINPUT1/RINPUT1 or LINPUT2/RINPUT2 are used as line inputs, the microphone boost and ALC functions should normally be disabled. In order to avoid clipping, the user must ensure that the input signal does not exceed AVDD. This may require a potential divider circuit in some applications. It is also recommended to remove RF interference picked up on any cables using a simple first-order RC filter, as high-frequency components in the input signal may otherwise cause aliasing distortion in the audio band. AC signals with no DC bias should be fed to the WM8988 through a DC blocking capacitor, e.g. 1F. HEADPHONE OUTPUT CONFIGURATION Analogue outputs LOUT1/ROUT1 and LOUT2/ROUT2, can drive a 16 or 32 headphone load, as shown in Figure 45. Figure 45 Recommended Headphone Output Configurations The DC blocking capacitors C1 and C2 and the load resistance together determine the lower cut-off frequency, fc. Increasing the capacitance lowers fc, improving the bass response. Smaller capacitance values will diminish the bass response. Assuming a 16 Ohm load and C1, C2 = 220F: fc = 1 / 2 RLC1 = 1 / (2 x 16 x 220F) = 45 Hz LINE OUTPUT CONFIGURATION The analogue outputs, LOUT1/ROUT1 and LOUT2/ROUT2, can be used as line outputs. Recommended external components are shown below. Figure 46 Recommended Circuit for Line Output The DC blocking capacitors and the load resistance together determine the lower cut-off frequency, fc. Assuming a 10 k load and C1, C2 = 1F: fc = 1 / 2 (RL+R1) C1 = 1 / (2 x 10.1k x 1F) = 16 Hz Increasing the capacitance lowers fc, improving the bass response. Smaller values of C1 and C2 will diminish the bass response. The function of R1 and R2 is to protect the line outputs from damage when used improperly. w PD, Rev 4.1, October 2013 54 WM8988 Production Data MINIMISING POP NOISE AT THE ANALOGUE OUTPUTS To minimize any pop or click noise when the system is powered up or down, the following procedures are recommended. POWER UP Switch on power supplies. By default the WM8988 is in Standby Mode, the DAC is digitally muted and the Audio Interface, Line outputs and Headphone outputs are all OFF (DACMU = 1 Power Management registers 1 and 2 are all zeros). Enable Vmid and VREF. Enable DACs as required Enable line and / or headphone output buffers as required. Set DACMU = 0 to soft-un-mute the audio DACs. POWER DOWN Set DACMU = 1 to soft-mute the audio DACs. Disable all output buffers. Switch off the power supplies. POWER MANAGEMENT EXAMPLES POWER MANAGEMENT (1) POWER MANAGEMENT (2) ADCs DACs Output Buffers AINL/R PGAs VREF OPERATION MODE Stereo Headphone Playback 1 0 0 0 0 0 0 1 1 1 1 0 0 Stereo Line-in Record 1 1 1 1 1 1 0 0 0 0 0 0 0 Stereo Microphone Record 1 1 1 1 1 1 1 0 0 0 0 0 0 Mono Microphone Record 1 1 1 0 1 0 1 0 0 0 0 0 0 Stereo Line-in to Headphone Out 1 1 0 0 0 0 0 0 0 1 1 0 0 PGL PGR ADL ADR MBI DAL DAR LO1 RO1 LO2 RO2 Table 45 Register Settings for Power Management w PD, Rev 4.1, October 2013 55 WM8988 Production Data PACKAGE DIMENSIONS DM050.C FL: 28 PIN COL QFN PLASTIC PACKAGE 4 X 4 X 0.55 mm BODY, 0.45 mm LEAD PITCH DETAIL 1 D 28 22 21 1 INDEX AREA (D/2 X E/2) 4 A E SEE DETAIL 2 15 7 2X 8 14 1 bbb M C A B b e 2X aaa C aaa C TOP VIEW BOTTOM VIEW DETAIL 1 DETAIL 2 A 0.08 C C 5 A1 SIDE VIEW PIN 1 IDENTIFICATION 0.150MM SQUARE L Datum L1 0.275MM DETAIL 2 SEATING PLANE 0.275MM 1 ccc C A3 Terminal Tip e/2 e R W T A3 H G b Exposed lead DETAIL 2 Symbols A A1 A3 b D E e G H L L1 T W MIN 0.500 0 0.18 3.95 3.95 Dimensions (mm) NOM MAX NOTE 0.550 0.600 0.025 0.05 0.152 REF 1 0.23 0.28 4.00 4.00 0.45 BSC 0.535 REF 0.076 REF 0.40 REF 0.05 REF 0.076 REF 0.230 REF 4.05 4.05 5 Tolerances of Form and Position aaa bbb ccc REF: 0.15 0.10 0.10 JEDEC, MO-220 NOTES: 1. DIMENSION b APPLIES TO METALLIZED TERMINAL AND IS MEASURED BETWEEN 0.15 mm AND 0.30 mm FROM TERMINAL TIP. 2. ALL DIMENSIONS ARE IN MILLIMETRES. 3. COPLANARITY APPLIES TO THE TERMINALS. 4. REFER TO APPLICATIONS NOTE WAN_0118 FOR FURTHER INFORMATION REGARDING PCB FOOTPRINTS AND QFN PACKAGE SOLDERING. 5. DEPENDING ON THE METHOD OF LEAD TERMINATION AT THE EDGE OF THE PACKAGE, PULL BACK (L1) MAY BE PRESENT. 6. THIS DRAWING IS SUBJECT TO CHANGE WITHOUT NOTICE. w PD, Rev 4.1, October 2013 56 WM8988 Production Data 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 United Kingdom Tel :: +44 (0)131 272 7000 Fax :: +44 (0)131 272 7001 Email :: sales@wolfsonmicro.com w PD, Rev 4.1, October 2013 57 WM8988 Production Data REVISION HISTORY DATE 01/05/08 RELEASE 3.0 DESCRIPTION OF CHANGES PAGES WM8988 datasheet created 26/09/08 4.0 Product Status updated to Production Data all 18/10/13 4.1 Package Diagram updated: Reference removed to exposed heat sink slug (Note 3) 55 w PD, Rev 4.1, October 2013 58 Mouser Electronics Authorized Distributor Click to View Pricing, Inventory, Delivery & Lifecycle Information: Cirrus Logic: WM8988LGECN/RV WM8988LGECN/V