xref: /openbmc/linux/sound/soc/codecs/ssm2602.h (revision 3213486f)
1 /*
2  * File:         sound/soc/codecs/ssm2602.h
3  * Author:       Cliff Cai <Cliff.Cai@analog.com>
4  *
5  * Created:      Tue June 06 2008
6  *
7  * Modified:
8  *               Copyright 2008 Analog Devices Inc.
9  *
10  * Bugs:         Enter bugs at http://blackfin.uclinux.org/
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, see the file COPYING, or write
24  * to the Free Software Foundation, Inc.,
25  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
26  */
27 
28 #ifndef _SSM2602_H
29 #define _SSM2602_H
30 
31 #include <linux/regmap.h>
32 
33 struct device;
34 
35 enum ssm2602_type {
36 	SSM2602,
37 	SSM2604,
38 };
39 
40 extern const struct regmap_config ssm2602_regmap_config;
41 
42 int ssm2602_probe(struct device *dev, enum ssm2602_type type,
43 	struct regmap *regmap);
44 
45 /* SSM2602 Codec Register definitions */
46 
47 #define SSM2602_LINVOL   0x00
48 #define SSM2602_RINVOL   0x01
49 #define SSM2602_LOUT1V   0x02
50 #define SSM2602_ROUT1V   0x03
51 #define SSM2602_APANA    0x04
52 #define SSM2602_APDIGI   0x05
53 #define SSM2602_PWR      0x06
54 #define SSM2602_IFACE    0x07
55 #define SSM2602_SRATE    0x08
56 #define SSM2602_ACTIVE   0x09
57 #define SSM2602_RESET	 0x0f
58 
59 /*SSM2602 Codec Register Field definitions
60  *(Mask value to extract the corresponding Register field)
61  */
62 
63 /*Left ADC Volume Control (SSM2602_REG_LEFT_ADC_VOL)*/
64 #define     LINVOL_LIN_VOL                0x01F   /* Left Channel PGA Volume control                      */
65 #define     LINVOL_LIN_ENABLE_MUTE        0x080   /* Left Channel Input Mute                              */
66 #define     LINVOL_LRIN_BOTH              0x100   /* Left Channel Line Input Volume update                */
67 
68 /*Right ADC Volume Control (SSM2602_REG_RIGHT_ADC_VOL)*/
69 #define     RINVOL_RIN_VOL                0x01F   /* Right Channel PGA Volume control                     */
70 #define     RINVOL_RIN_ENABLE_MUTE        0x080   /* Right Channel Input Mute                             */
71 #define     RINVOL_RLIN_BOTH              0x100   /* Right Channel Line Input Volume update               */
72 
73 /*Left DAC Volume Control (SSM2602_REG_LEFT_DAC_VOL)*/
74 #define     LOUT1V_LHP_VOL                0x07F   /* Left Channel Headphone volume control                */
75 #define     LOUT1V_ENABLE_LZC             0x080   /* Left Channel Zero cross detect enable                */
76 #define     LOUT1V_LRHP_BOTH              0x100   /* Left Channel Headphone volume update                 */
77 
78 /*Right DAC Volume Control (SSM2602_REG_RIGHT_DAC_VOL)*/
79 #define     ROUT1V_RHP_VOL                0x07F   /* Right Channel Headphone volume control               */
80 #define     ROUT1V_ENABLE_RZC             0x080   /* Right Channel Zero cross detect enable               */
81 #define     ROUT1V_RLHP_BOTH              0x100   /* Right Channel Headphone volume update                */
82 
83 /*Analogue Audio Path Control (SSM2602_REG_ANALOGUE_PATH)*/
84 #define     APANA_ENABLE_MIC_BOOST       0x001   /* Primary Microphone Amplifier gain booster control    */
85 #define     APANA_ENABLE_MIC_MUTE        0x002   /* Microphone Mute Control                              */
86 #define     APANA_ADC_IN_SELECT          0x004   /* Microphone/Line IN select to ADC (1=MIC, 0=Line In)  */
87 #define     APANA_ENABLE_BYPASS          0x008   /* Line input bypass to line output                     */
88 #define     APANA_SELECT_DAC             0x010   /* Select DAC (1=Select DAC, 0=Don't Select DAC)        */
89 #define     APANA_ENABLE_SIDETONE        0x020   /* Enable/Disable Side Tone                             */
90 #define     APANA_SIDETONE_ATTN          0x0C0   /* Side Tone Attenuation                                */
91 #define     APANA_ENABLE_MIC_BOOST2      0x100   /* Secondary Microphone Amplifier gain booster control  */
92 
93 /*Digital Audio Path Control (SSM2602_REG_DIGITAL_PATH)*/
94 #define     APDIGI_ENABLE_ADC_HPF         0x001   /* Enable/Disable ADC Highpass Filter                   */
95 #define     APDIGI_DE_EMPHASIS            0x006   /* De-Emphasis Control                                  */
96 #define     APDIGI_ENABLE_DAC_MUTE        0x008   /* DAC Mute Control                                     */
97 #define     APDIGI_STORE_OFFSET           0x010   /* Store/Clear DC offset when HPF is disabled           */
98 
99 /*Power Down Control (SSM2602_REG_POWER)
100  *(1=Enable PowerDown, 0=Disable PowerDown)
101  */
102 #define     PWR_LINE_IN_PDN            0x001   /* Line Input Power Down                                */
103 #define     PWR_MIC_PDN                0x002   /* Microphone Input & Bias Power Down                   */
104 #define     PWR_ADC_PDN                0x004   /* ADC Power Down                                       */
105 #define     PWR_DAC_PDN                0x008   /* DAC Power Down                                       */
106 #define     PWR_OUT_PDN                0x010   /* Outputs Power Down                                   */
107 #define     PWR_OSC_PDN                0x020   /* Oscillator Power Down                                */
108 #define     PWR_CLK_OUT_PDN            0x040   /* CLKOUT Power Down                                    */
109 #define     PWR_POWER_OFF              0x080   /* POWEROFF Mode                                        */
110 
111 /*Digital Audio Interface Format (SSM2602_REG_DIGITAL_IFACE)*/
112 #define     IFACE_IFACE_FORMAT           0x003   /* Digital Audio input format control                   */
113 #define     IFACE_AUDIO_DATA_LEN         0x00C   /* Audio Data word length control                       */
114 #define     IFACE_DAC_LR_POLARITY        0x010   /* Polarity Control for clocks in RJ,LJ and I2S modes   */
115 #define     IFACE_DAC_LR_SWAP            0x020   /* Swap DAC data control                                */
116 #define     IFACE_ENABLE_MASTER          0x040   /* Enable/Disable Master Mode                           */
117 #define     IFACE_BCLK_INVERT            0x080   /* Bit Clock Inversion control                          */
118 
119 /*Sampling Control (SSM2602_REG_SAMPLING_CTRL)*/
120 #define     SRATE_ENABLE_USB_MODE        0x001   /* Enable/Disable USB Mode                              */
121 #define     SRATE_BOS_RATE               0x002   /* Base Over-Sampling rate                              */
122 #define     SRATE_SAMPLE_RATE            0x03C   /* Clock setting condition (Sampling rate control)      */
123 #define     SRATE_CORECLK_DIV2           0x040   /* Core Clock divider select                            */
124 #define     SRATE_CLKOUT_DIV2            0x080   /* Clock Out divider select                             */
125 
126 /*Active Control (SSM2602_REG_ACTIVE_CTRL)*/
127 #define     ACTIVE_ACTIVATE_CODEC         0x001   /* Activate Codec Digital Audio Interface               */
128 
129 /*********************************************************************/
130 
131 #define SSM2602_CACHEREGNUM 	10
132 
133 enum ssm2602_clk {
134 	SSM2602_SYSCLK,
135 	SSM2602_CLK_CLKOUT,
136 	SSM2602_CLK_XTO
137 };
138 
139 #endif
140