[ALSA] Changed Jaroslav Kysela's e-mail from perex@suse.cz to perex@perex.cz
[linux-2.6.git] / include / sound / cs8427.h
1 #ifndef __SOUND_CS8427_H
2 #define __SOUND_CS8427_H
3
4 /*
5  *  Routines for Cirrus Logic CS8427
6  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>,
7  *
8  *
9  *   This program is free software; you can redistribute it and/or modify
10  *   it under the terms of the GNU General Public License as published by
11  *   the Free Software Foundation; either version 2 of the License, or
12  *   (at your option) any later version.
13  *
14  *   This program is distributed in the hope that it will be useful,
15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *   GNU General Public License for more details.
18  *
19  *   You should have received a copy of the GNU General Public License
20  *   along with this program; if not, write to the Free Software
21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
22  *
23  */
24
25 #include <sound/i2c.h>
26
27 #define CS8427_BASE_ADDR        0x10    /* base I2C address */
28
29 #define CS8427_REG_AUTOINC      0x80    /* flag - autoincrement */
30 #define CS8427_REG_CONTROL1     0x01
31 #define CS8427_REG_CONTROL2     0x02
32 #define CS8427_REG_DATAFLOW     0x03
33 #define CS8427_REG_CLOCKSOURCE  0x04
34 #define CS8427_REG_SERIALINPUT  0x05
35 #define CS8427_REG_SERIALOUTPUT 0x06
36 #define CS8427_REG_INT1STATUS   0x07
37 #define CS8427_REG_INT2STATUS   0x08
38 #define CS8427_REG_INT1MASK     0x09
39 #define CS8427_REG_INT1MODEMSB  0x0a
40 #define CS8427_REG_INT1MODELSB  0x0b
41 #define CS8427_REG_INT2MASK     0x0c
42 #define CS8427_REG_INT2MODEMSB  0x0d
43 #define CS8427_REG_INT2MODELSB  0x0e
44 #define CS8427_REG_RECVCSDATA   0x0f
45 #define CS8427_REG_RECVERRORS   0x10
46 #define CS8427_REG_RECVERRMASK  0x11
47 #define CS8427_REG_CSDATABUF    0x12
48 #define CS8427_REG_UDATABUF     0x13
49 #define CS8427_REG_QSUBCODE     0x14    /* 0x14-0x1d (10 bytes) */
50 #define CS8427_REG_OMCKRMCKRATIO 0x1e
51 #define CS8427_REG_CORU_DATABUF 0x20    /* 24 byte buffer area */
52 #define CS8427_REG_ID_AND_VER   0x7f
53
54 /* CS8427_REG_CONTROL1 bits */
55 #define CS8427_SWCLK            (1<<7)  /* 0 = RMCK default, 1 = OMCK output on RMCK pin */
56 #define CS8427_VSET             (1<<6)  /* 0 = valid PCM data, 1 = invalid PCM data */
57 #define CS8427_MUTESAO          (1<<5)  /* mute control for the serial audio output port, 0 = disabled, 1 = enabled */
58 #define CS8427_MUTEAES          (1<<4)  /* mute control for the AES transmitter output, 0 = disabled, 1 = enabled */
59 #define CS8427_INTMASK          (3<<1)  /* interrupt output pin setup mask */
60 #define CS8427_INTACTHIGH       (0<<1)  /* active high */
61 #define CS8427_INTACTLOW        (1<<1)  /* active low */
62 #define CS8427_INTOPENDRAIN     (2<<1)  /* open drain, active low */
63 #define CS8427_TCBLDIR          (1<<0)  /* 0 = TCBL is an input, 1 = TCBL is an output */
64
65 /* CS8427_REQ_CONTROL2 bits */
66 #define CS8427_HOLDMASK         (3<<5)  /* action when a receiver error occurs */
67 #define CS8427_HOLDLASTSAMPLE   (0<<5)  /* hold the last valid sample */
68 #define CS8427_HOLDZERO         (1<<5)  /* replace the current audio sample with zero (mute) */
69 #define CS8427_HOLDNOCHANGE     (2<<5)  /* do not change the received audio sample */
70 #define CS8427_RMCKF            (1<<4)  /* 0 = 256*Fsi, 1 = 128*Fsi */
71 #define CS8427_MMR              (1<<3)  /* AES3 receiver operation, 0 = stereo, 1 = mono */
72 #define CS8427_MMT              (1<<2)  /* AES3 transmitter operation, 0 = stereo, 1 = mono */
73 #define CS8427_MMTCS            (1<<1)  /* 0 = use A + B CS data, 1 = use MMTLR CS data */
74 #define CS8427_MMTLR            (1<<0)  /* 0 = use A CS data, 1 = use B CS data */
75
76 /* CS8427_REG_DATAFLOW */
77 #define CS8427_TXOFF            (1<<6)  /* AES3 transmitter Output, 0 = normal operation, 1 = off (0V) */
78 #define CS8427_AESBP            (1<<5)  /* AES3 hardware bypass mode, 0 = normal, 1 = bypass (RX->TX) */
79 #define CS8427_TXDMASK          (3<<3)  /* AES3 Transmitter Data Source Mask */
80 #define CS8427_TXDSERIAL        (1<<3)  /* TXD - serial audio input port */
81 #define CS8427_TXAES3DRECEIVER  (2<<3)  /* TXD - AES3 receiver */
82 #define CS8427_SPDMASK          (3<<1)  /* Serial Audio Output Port Data Source Mask */
83 #define CS8427_SPDSERIAL        (1<<1)  /* SPD - serial audio input port */
84 #define CS8427_SPDAES3RECEIVER  (2<<1)  /* SPD - AES3 receiver */
85
86 /* CS8427_REG_CLOCKSOURCE */
87 #define CS8427_RUN              (1<<6)  /* 0 = clock off, 1 = clock on */
88 #define CS8427_CLKMASK          (3<<4)  /* OMCK frequency mask */
89 #define CS8427_CLK256           (0<<4)  /* 256*Fso */
90 #define CS8427_CLK384           (1<<4)  /* 384*Fso */
91 #define CS8427_CLK512           (2<<4)  /* 512*Fso */
92 #define CS8427_OUTC             (1<<3)  /* Output Time Base, 0 = OMCK, 1 = recovered input clock */
93 #define CS8427_INC              (1<<2)  /* Input Time Base Clock Source, 0 = recoverd input clock, 1 = OMCK input pin */
94 #define CS8427_RXDMASK          (3<<0)  /* Recovered Input Clock Source Mask */
95 #define CS8427_RXDILRCK         (0<<0)  /* 256*Fsi from ILRCK pin */
96 #define CS8427_RXDAES3INPUT     (1<<0)  /* 256*Fsi from AES3 input */
97 #define CS8427_EXTCLOCKRESET    (2<<0)  /* bypass PLL, 256*Fsi clock, synchronous reset */
98 #define CS8427_EXTCLOCK         (3<<0)  /* bypass PLL, 256*Fsi clock */
99
100 /* CS8427_REG_SERIALINPUT */
101 #define CS8427_SIMS             (1<<7)  /* 0 = slave, 1 = master mode */
102 #define CS8427_SISF             (1<<6)  /* ISCLK freq, 0 = 64*Fsi, 1 = 128*Fsi */
103 #define CS8427_SIRESMASK        (3<<4)  /* Resolution of the input data for right justified formats */
104 #define CS8427_SIRES24          (0<<4)  /* SIRES 24-bit */
105 #define CS8427_SIRES20          (1<<4)  /* SIRES 20-bit */
106 #define CS8427_SIRES16          (2<<4)  /* SIRES 16-bit */
107 #define CS8427_SIJUST           (1<<3)  /* Justification of SDIN data relative to ILRCK, 0 = left-justified, 1 = right-justified */
108 #define CS8427_SIDEL            (1<<2)  /* Delay of SDIN data relative to ILRCK for left-justified data formats, 0 = first ISCLK period, 1 = second ISCLK period */
109 #define CS8427_SISPOL           (1<<1)  /* ICLK clock polarity, 0 = rising edge of ISCLK, 1 = falling edge of ISCLK */
110 #define CS8427_SILRPOL          (1<<0)  /* ILRCK clock polarity, 0 = SDIN data left channel when ILRCK is high, 1 = SDIN right when ILRCK is high */
111
112 /* CS8427_REG_SERIALOUTPUT */
113 #define CS8427_SOMS             (1<<7)  /* 0 = slave, 1 = master mode */
114 #define CS8427_SOSF             (1<<6)  /* OSCLK freq, 0 = 64*Fso, 1 = 128*Fso */
115 #define CS8427_SORESMASK        (3<<4)  /* Resolution of the output data on SDOUT and AES3 output */
116 #define CS8427_SORES24          (0<<4)  /* SIRES 24-bit */
117 #define CS8427_SORES20          (1<<4)  /* SIRES 20-bit */
118 #define CS8427_SORES16          (2<<4)  /* SIRES 16-bit */
119 #define CS8427_SORESDIRECT      (2<<4)  /* SIRES direct copy from AES3 receiver */
120 #define CS8427_SOJUST           (1<<3)  /* Justification of SDOUT data relative to OLRCK, 0 = left-justified, 1 = right-justified */
121 #define CS8427_SODEL            (1<<2)  /* Delay of SDOUT data relative to OLRCK for left-justified data formats, 0 = first OSCLK period, 1 = second OSCLK period */
122 #define CS8427_SOSPOL           (1<<1)  /* OSCLK clock polarity, 0 = rising edge of ISCLK, 1 = falling edge of ISCLK */
123 #define CS8427_SOLRPOL          (1<<0)  /* OLRCK clock polarity, 0 = SDOUT data left channel when OLRCK is high, 1 = SDOUT right when OLRCK is high */
124
125 /* CS8427_REG_INT1STATUS */
126 #define CS8427_TSLIP            (1<<7)  /* AES3 transmitter source data slip interrupt */
127 #define CS8427_OSLIP            (1<<6)  /* Serial audio output port data slip interrupt */
128 #define CS8427_DETC             (1<<2)  /* D to E C-buffer transfer interrupt */
129 #define CS8427_EFTC             (1<<1)  /* E to F C-buffer transfer interrupt */
130 #define CS8427_RERR             (1<<0)  /* A receiver error has occurred */
131
132 /* CS8427_REG_INT2STATUS */
133 #define CS8427_DETU             (1<<3)  /* D to E U-buffer transfer interrupt */
134 #define CS8427_EFTU             (1<<2)  /* E to F U-buffer transfer interrupt */
135 #define CS8427_QCH              (1<<1)  /* A new block of Q-subcode data is available for reading */
136
137 /* CS8427_REG_INT1MODEMSB && CS8427_REG_INT1MODELSB */
138 /* bits are defined in CS8427_REG_INT1STATUS */
139 /* CS8427_REG_INT2MODEMSB && CS8427_REG_INT2MODELSB */
140 /* bits are defined in CS8427_REG_INT2STATUS */
141 #define CS8427_INTMODERISINGMSB 0
142 #define CS8427_INTMODERESINGLSB 0
143 #define CS8427_INTMODEFALLINGMSB 0
144 #define CS8427_INTMODEFALLINGLSB 1
145 #define CS8427_INTMODELEVELMSB  1
146 #define CS8427_INTMODELEVELLSB  0
147
148 /* CS8427_REG_RECVCSDATA */
149 #define CS8427_AUXMASK          (15<<4) /* auxiliary data field width */
150 #define CS8427_AUXSHIFT         4
151 #define CS8427_PRO              (1<<3)  /* Channel status block format indicator */
152 #define CS8427_AUDIO            (1<<2)  /* Audio indicator (0 = audio, 1 = nonaudio */
153 #define CS8427_COPY             (1<<1)  /* 0 = copyright asserted, 1 = copyright not asserted */
154 #define CS8427_ORIG             (1<<0)  /* SCMS generation indicator, 0 = 1st generation or highter, 1 = original */
155
156 /* CS8427_REG_RECVERRORS */
157 /* CS8427_REG_RECVERRMASK for CS8427_RERR */
158 #define CS8427_QCRC             (1<<6)  /* Q-subcode data CRC error indicator */
159 #define CS8427_CCRC             (1<<5)  /* Chancnel Status Block Cyclick Redundancy Check Bit */
160 #define CS8427_UNLOCK           (1<<4)  /* PLL lock status bit */
161 #define CS8427_V                (1<<3)  /* 0 = valid data */
162 #define CS8427_CONF             (1<<2)  /* Confidence bit */
163 #define CS8427_BIP              (1<<1)  /* Bi-phase error bit */
164 #define CS8427_PAR              (1<<0)  /* Parity error */
165
166 /* CS8427_REG_CSDATABUF */
167 #define CS8427_BSEL             (1<<5)  /* 0 = CS data, 1 = U data */
168 #define CS8427_CBMR             (1<<4)  /* 0 = overwrite first 5 bytes for CS D to E buffer, 1 = prevent */
169 #define CS8427_DETCI            (1<<3)  /* D to E CS data buffer transfer inhibit bit, 0 = allow, 1 = inhibit */
170 #define CS8427_EFTCI            (1<<2)  /* E to F CS data buffer transfer inhibit bit, 0 = allow, 1 = inhibit */
171 #define CS8427_CAM              (1<<1)  /* CS data buffer control port access mode bit, 0 = one byte, 1 = two byte */
172 #define CS8427_CHS              (1<<0)  /* Channel select bit, 0 = Channel A, 1 = Channel B */
173
174 /* CS8427_REG_UDATABUF */
175 #define CS8427_UD               (1<<4)  /* User data pin (U) direction, 0 = input, 1 = output */
176 #define CS8427_UBMMASK          (3<<2)  /* Operating mode of the AES3 U bit manager */
177 #define CS8427_UBMZEROS         (0<<2)  /* transmit all zeros mode */
178 #define CS8427_UBMBLOCK         (1<<2)  /* block mode */
179 #define CS8427_DETUI            (1<<1)  /* D to E U-data buffer transfer inhibit bit, 0 = allow, 1 = inhibit */
180 #define CS8427_EFTUI            (1<<1)  /* E to F U-data buffer transfer inhibit bit, 0 = allow, 1 = inhibit */
181
182 /* CS8427_REG_ID_AND_VER */
183 #define CS8427_IDMASK           (15<<4)
184 #define CS8427_IDSHIFT          4
185 #define CS8427_VERMASK          (15<<0)
186 #define CS8427_VERSHIFT         0
187 #define CS8427_VER8427A         0x71
188
189 struct snd_pcm_substream;
190
191 int snd_cs8427_create(struct snd_i2c_bus *bus, unsigned char addr,
192                       unsigned int reset_timeout, struct snd_i2c_device **r_cs8427);
193 int snd_cs8427_reg_write(struct snd_i2c_device *device, unsigned char reg,
194                          unsigned char val);
195 int snd_cs8427_iec958_build(struct snd_i2c_device *cs8427,
196                             struct snd_pcm_substream *playback_substream,
197                             struct snd_pcm_substream *capture_substream);
198 int snd_cs8427_iec958_active(struct snd_i2c_device *cs8427, int active);
199 int snd_cs8427_iec958_pcm(struct snd_i2c_device *cs8427, unsigned int rate);
200
201 #endif /* __SOUND_CS8427_H */