xref: /linux/sound/soc/fsl/fsl_ssi.h (revision 00a6d7b6762c27d441e9ac8faff36384bc0fc180)
1 /*
2  * fsl_ssi.h - ALSA SSI interface for the Freescale MPC8610 SoC
3  *
4  * Author: Timur Tabi <timur@freescale.com>
5  *
6  * Copyright 2007-2008 Freescale Semiconductor, Inc.  This file is licensed
7  * under the terms of the GNU General Public License version 2.  This
8  * program is licensed "as is" without any warranty of any kind, whether
9  * express or implied.
10  */
11 
12 #ifndef _MPC8610_I2S_H
13 #define _MPC8610_I2S_H
14 
15 /* SSI Register Map */
16 struct ccsr_ssi {
17 	__be32 stx0;	/* 0x.0000 - SSI Transmit Data Register 0 */
18 	__be32 stx1;	/* 0x.0004 - SSI Transmit Data Register 1 */
19 	__be32 srx0;	/* 0x.0008 - SSI Receive Data Register 0 */
20 	__be32 srx1;	/* 0x.000C - SSI Receive Data Register 1 */
21 	__be32 scr;	/* 0x.0010 - SSI Control Register */
22 	__be32 sisr;	/* 0x.0014 - SSI Interrupt Status Register Mixed */
23 	__be32 sier;	/* 0x.0018 - SSI Interrupt Enable Register */
24 	__be32 stcr;	/* 0x.001C - SSI Transmit Configuration Register */
25 	__be32 srcr;	/* 0x.0020 - SSI Receive Configuration Register */
26 	__be32 stccr;	/* 0x.0024 - SSI Transmit Clock Control Register */
27 	__be32 srccr;	/* 0x.0028 - SSI Receive Clock Control Register */
28 	__be32 sfcsr;	/* 0x.002C - SSI FIFO Control/Status Register */
29 	__be32 str;	/* 0x.0030 - SSI Test Register */
30 	__be32 sor;	/* 0x.0034 - SSI Option Register */
31 	__be32 sacnt;	/* 0x.0038 - SSI AC97 Control Register */
32 	__be32 sacadd;	/* 0x.003C - SSI AC97 Command Address Register */
33 	__be32 sacdat;	/* 0x.0040 - SSI AC97 Command Data Register */
34 	__be32 satag;	/* 0x.0044 - SSI AC97 Tag Register */
35 	__be32 stmsk;	/* 0x.0048 - SSI Transmit Time Slot Mask Register */
36 	__be32 srmsk;	/* 0x.004C - SSI Receive Time Slot Mask Register */
37 	__be32 saccst;	/* 0x.0050 - SSI AC97 Channel Status Register */
38 	__be32 saccen;	/* 0x.0054 - SSI AC97 Channel Enable Register */
39 	__be32 saccdis; /* 0x.0058 - SSI AC97 Channel Disable Register */
40 };
41 
42 #define CCSR_SSI_SCR_SYNC_TX_FS		0x00001000
43 #define CCSR_SSI_SCR_RFR_CLK_DIS	0x00000800
44 #define CCSR_SSI_SCR_TFR_CLK_DIS	0x00000400
45 #define CCSR_SSI_SCR_TCH_EN		0x00000100
46 #define CCSR_SSI_SCR_SYS_CLK_EN		0x00000080
47 #define CCSR_SSI_SCR_I2S_MODE_MASK	0x00000060
48 #define CCSR_SSI_SCR_I2S_MODE_NORMAL	0x00000000
49 #define CCSR_SSI_SCR_I2S_MODE_MASTER	0x00000020
50 #define CCSR_SSI_SCR_I2S_MODE_SLAVE	0x00000040
51 #define CCSR_SSI_SCR_SYN		0x00000010
52 #define CCSR_SSI_SCR_NET		0x00000008
53 #define CCSR_SSI_SCR_RE			0x00000004
54 #define CCSR_SSI_SCR_TE			0x00000002
55 #define CCSR_SSI_SCR_SSIEN		0x00000001
56 
57 #define CCSR_SSI_SISR_RFRC		0x01000000
58 #define CCSR_SSI_SISR_TFRC		0x00800000
59 #define CCSR_SSI_SISR_CMDAU		0x00040000
60 #define CCSR_SSI_SISR_CMDDU		0x00020000
61 #define CCSR_SSI_SISR_RXT		0x00010000
62 #define CCSR_SSI_SISR_RDR1		0x00008000
63 #define CCSR_SSI_SISR_RDR0		0x00004000
64 #define CCSR_SSI_SISR_TDE1		0x00002000
65 #define CCSR_SSI_SISR_TDE0		0x00001000
66 #define CCSR_SSI_SISR_ROE1		0x00000800
67 #define CCSR_SSI_SISR_ROE0		0x00000400
68 #define CCSR_SSI_SISR_TUE1		0x00000200
69 #define CCSR_SSI_SISR_TUE0		0x00000100
70 #define CCSR_SSI_SISR_TFS		0x00000080
71 #define CCSR_SSI_SISR_RFS		0x00000040
72 #define CCSR_SSI_SISR_TLS		0x00000020
73 #define CCSR_SSI_SISR_RLS		0x00000010
74 #define CCSR_SSI_SISR_RFF1		0x00000008
75 #define CCSR_SSI_SISR_RFF0		0x00000004
76 #define CCSR_SSI_SISR_TFE1		0x00000002
77 #define CCSR_SSI_SISR_TFE0		0x00000001
78 
79 #define CCSR_SSI_SIER_RFRC_EN		0x01000000
80 #define CCSR_SSI_SIER_TFRC_EN		0x00800000
81 #define CCSR_SSI_SIER_RDMAE		0x00400000
82 #define CCSR_SSI_SIER_RIE		0x00200000
83 #define CCSR_SSI_SIER_TDMAE		0x00100000
84 #define CCSR_SSI_SIER_TIE		0x00080000
85 #define CCSR_SSI_SIER_CMDAU_EN		0x00040000
86 #define CCSR_SSI_SIER_CMDDU_EN		0x00020000
87 #define CCSR_SSI_SIER_RXT_EN		0x00010000
88 #define CCSR_SSI_SIER_RDR1_EN		0x00008000
89 #define CCSR_SSI_SIER_RDR0_EN		0x00004000
90 #define CCSR_SSI_SIER_TDE1_EN		0x00002000
91 #define CCSR_SSI_SIER_TDE0_EN		0x00001000
92 #define CCSR_SSI_SIER_ROE1_EN		0x00000800
93 #define CCSR_SSI_SIER_ROE0_EN		0x00000400
94 #define CCSR_SSI_SIER_TUE1_EN		0x00000200
95 #define CCSR_SSI_SIER_TUE0_EN		0x00000100
96 #define CCSR_SSI_SIER_TFS_EN		0x00000080
97 #define CCSR_SSI_SIER_RFS_EN		0x00000040
98 #define CCSR_SSI_SIER_TLS_EN		0x00000020
99 #define CCSR_SSI_SIER_RLS_EN		0x00000010
100 #define CCSR_SSI_SIER_RFF1_EN		0x00000008
101 #define CCSR_SSI_SIER_RFF0_EN		0x00000004
102 #define CCSR_SSI_SIER_TFE1_EN		0x00000002
103 #define CCSR_SSI_SIER_TFE0_EN		0x00000001
104 
105 #define CCSR_SSI_STCR_TXBIT0		0x00000200
106 #define CCSR_SSI_STCR_TFEN1		0x00000100
107 #define CCSR_SSI_STCR_TFEN0		0x00000080
108 #define CCSR_SSI_STCR_TFDIR		0x00000040
109 #define CCSR_SSI_STCR_TXDIR		0x00000020
110 #define CCSR_SSI_STCR_TSHFD		0x00000010
111 #define CCSR_SSI_STCR_TSCKP		0x00000008
112 #define CCSR_SSI_STCR_TFSI		0x00000004
113 #define CCSR_SSI_STCR_TFSL		0x00000002
114 #define CCSR_SSI_STCR_TEFS		0x00000001
115 
116 #define CCSR_SSI_SRCR_RXEXT		0x00000400
117 #define CCSR_SSI_SRCR_RXBIT0		0x00000200
118 #define CCSR_SSI_SRCR_RFEN1		0x00000100
119 #define CCSR_SSI_SRCR_RFEN0		0x00000080
120 #define CCSR_SSI_SRCR_RFDIR		0x00000040
121 #define CCSR_SSI_SRCR_RXDIR		0x00000020
122 #define CCSR_SSI_SRCR_RSHFD		0x00000010
123 #define CCSR_SSI_SRCR_RSCKP		0x00000008
124 #define CCSR_SSI_SRCR_RFSI		0x00000004
125 #define CCSR_SSI_SRCR_RFSL		0x00000002
126 #define CCSR_SSI_SRCR_REFS		0x00000001
127 
128 /* STCCR and SRCCR */
129 #define CCSR_SSI_SxCCR_DIV2_SHIFT	18
130 #define CCSR_SSI_SxCCR_DIV2		0x00040000
131 #define CCSR_SSI_SxCCR_PSR_SHIFT	17
132 #define CCSR_SSI_SxCCR_PSR		0x00020000
133 #define CCSR_SSI_SxCCR_WL_SHIFT		13
134 #define CCSR_SSI_SxCCR_WL_MASK		0x0001E000
135 #define CCSR_SSI_SxCCR_WL(x) \
136 	(((((x) / 2) - 1) << CCSR_SSI_SxCCR_WL_SHIFT) & CCSR_SSI_SxCCR_WL_MASK)
137 #define CCSR_SSI_SxCCR_DC_SHIFT		8
138 #define CCSR_SSI_SxCCR_DC_MASK		0x00001F00
139 #define CCSR_SSI_SxCCR_DC(x) \
140 	((((x) - 1) << CCSR_SSI_SxCCR_DC_SHIFT) & CCSR_SSI_SxCCR_DC_MASK)
141 #define CCSR_SSI_SxCCR_PM_SHIFT		0
142 #define CCSR_SSI_SxCCR_PM_MASK		0x000000FF
143 #define CCSR_SSI_SxCCR_PM(x) \
144 	((((x) - 1) << CCSR_SSI_SxCCR_PM_SHIFT) & CCSR_SSI_SxCCR_PM_MASK)
145 
146 /*
147  * The xFCNT bits are read-only, and the xFWM bits are read/write.  Use the
148  * CCSR_SSI_SFCSR_xFCNTy() macros to read the FIFO counters, and use the
149  * CCSR_SSI_SFCSR_xFWMy() macros to set the watermarks.
150  */
151 #define CCSR_SSI_SFCSR_RFCNT1_SHIFT	28
152 #define CCSR_SSI_SFCSR_RFCNT1_MASK	0xF0000000
153 #define CCSR_SSI_SFCSR_RFCNT1(x) \
154 	(((x) & CCSR_SSI_SFCSR_RFCNT1_MASK) >> CCSR_SSI_SFCSR_RFCNT1_SHIFT)
155 #define CCSR_SSI_SFCSR_TFCNT1_SHIFT	24
156 #define CCSR_SSI_SFCSR_TFCNT1_MASK	0x0F000000
157 #define CCSR_SSI_SFCSR_TFCNT1(x) \
158 	(((x) & CCSR_SSI_SFCSR_TFCNT1_MASK) >> CCSR_SSI_SFCSR_TFCNT1_SHIFT)
159 #define CCSR_SSI_SFCSR_RFWM1_SHIFT	20
160 #define CCSR_SSI_SFCSR_RFWM1_MASK	0x00F00000
161 #define CCSR_SSI_SFCSR_RFWM1(x)	\
162 	(((x) << CCSR_SSI_SFCSR_RFWM1_SHIFT) & CCSR_SSI_SFCSR_RFWM1_MASK)
163 #define CCSR_SSI_SFCSR_TFWM1_SHIFT	16
164 #define CCSR_SSI_SFCSR_TFWM1_MASK	0x000F0000
165 #define CCSR_SSI_SFCSR_TFWM1(x)	\
166 	(((x) << CCSR_SSI_SFCSR_TFWM1_SHIFT) & CCSR_SSI_SFCSR_TFWM1_MASK)
167 #define CCSR_SSI_SFCSR_RFCNT0_SHIFT	12
168 #define CCSR_SSI_SFCSR_RFCNT0_MASK	0x0000F000
169 #define CCSR_SSI_SFCSR_RFCNT0(x) \
170 	(((x) & CCSR_SSI_SFCSR_RFCNT0_MASK) >> CCSR_SSI_SFCSR_RFCNT0_SHIFT)
171 #define CCSR_SSI_SFCSR_TFCNT0_SHIFT	8
172 #define CCSR_SSI_SFCSR_TFCNT0_MASK	0x00000F00
173 #define CCSR_SSI_SFCSR_TFCNT0(x) \
174 	(((x) & CCSR_SSI_SFCSR_TFCNT0_MASK) >> CCSR_SSI_SFCSR_TFCNT0_SHIFT)
175 #define CCSR_SSI_SFCSR_RFWM0_SHIFT	4
176 #define CCSR_SSI_SFCSR_RFWM0_MASK	0x000000F0
177 #define CCSR_SSI_SFCSR_RFWM0(x)	\
178 	(((x) << CCSR_SSI_SFCSR_RFWM0_SHIFT) & CCSR_SSI_SFCSR_RFWM0_MASK)
179 #define CCSR_SSI_SFCSR_TFWM0_SHIFT	0
180 #define CCSR_SSI_SFCSR_TFWM0_MASK	0x0000000F
181 #define CCSR_SSI_SFCSR_TFWM0(x)	\
182 	(((x) << CCSR_SSI_SFCSR_TFWM0_SHIFT) & CCSR_SSI_SFCSR_TFWM0_MASK)
183 
184 #define CCSR_SSI_STR_TEST		0x00008000
185 #define CCSR_SSI_STR_RCK2TCK		0x00004000
186 #define CCSR_SSI_STR_RFS2TFS		0x00002000
187 #define CCSR_SSI_STR_RXSTATE(x) (((x) >> 8) & 0x1F)
188 #define CCSR_SSI_STR_TXD2RXD		0x00000080
189 #define CCSR_SSI_STR_TCK2RCK		0x00000040
190 #define CCSR_SSI_STR_TFS2RFS		0x00000020
191 #define CCSR_SSI_STR_TXSTATE(x) ((x) & 0x1F)
192 
193 #define CCSR_SSI_SOR_CLKOFF		0x00000040
194 #define CCSR_SSI_SOR_RX_CLR		0x00000020
195 #define CCSR_SSI_SOR_TX_CLR		0x00000010
196 #define CCSR_SSI_SOR_INIT		0x00000008
197 #define CCSR_SSI_SOR_WAIT_SHIFT		1
198 #define CCSR_SSI_SOR_WAIT_MASK		0x00000006
199 #define CCSR_SSI_SOR_WAIT(x) (((x) & 3) << CCSR_SSI_SOR_WAIT_SHIFT)
200 #define CCSR_SSI_SOR_SYNRST 		0x00000001
201 
202 #define CCSR_SSI_SACNT_FRDIV(x)		(((x) & 0x3f) << 5)
203 #define CCSR_SSI_SACNT_WR		0x00000010
204 #define CCSR_SSI_SACNT_RD		0x00000008
205 #define CCSR_SSI_SACNT_RDWR_MASK	0x00000018
206 #define CCSR_SSI_SACNT_TIF		0x00000004
207 #define CCSR_SSI_SACNT_FV		0x00000002
208 #define CCSR_SSI_SACNT_AC97EN		0x00000001
209 
210 
211 struct device;
212 
213 #if IS_ENABLED(CONFIG_DEBUG_FS)
214 
215 struct fsl_ssi_dbg {
216 	struct dentry *dbg_dir;
217 	struct dentry *dbg_stats;
218 
219 	struct {
220 		unsigned int rfrc;
221 		unsigned int tfrc;
222 		unsigned int cmdau;
223 		unsigned int cmddu;
224 		unsigned int rxt;
225 		unsigned int rdr1;
226 		unsigned int rdr0;
227 		unsigned int tde1;
228 		unsigned int tde0;
229 		unsigned int roe1;
230 		unsigned int roe0;
231 		unsigned int tue1;
232 		unsigned int tue0;
233 		unsigned int tfs;
234 		unsigned int rfs;
235 		unsigned int tls;
236 		unsigned int rls;
237 		unsigned int rff1;
238 		unsigned int rff0;
239 		unsigned int tfe1;
240 		unsigned int tfe0;
241 	} stats;
242 };
243 
244 void fsl_ssi_dbg_isr(struct fsl_ssi_dbg *ssi_dbg, u32 sisr);
245 
246 int fsl_ssi_debugfs_create(struct fsl_ssi_dbg *ssi_dbg, struct device *dev);
247 
248 void fsl_ssi_debugfs_remove(struct fsl_ssi_dbg *ssi_dbg);
249 
250 #else
251 
252 struct fsl_ssi_dbg {
253 };
254 
255 static inline void fsl_ssi_dbg_isr(struct fsl_ssi_dbg *stats, u32 sisr)
256 {
257 }
258 
259 static inline int fsl_ssi_debugfs_create(struct fsl_ssi_dbg *ssi_dbg,
260 		struct device *dev)
261 {
262 	return 0;
263 }
264 
265 static inline void fsl_ssi_debugfs_remove(struct fsl_ssi_dbg *ssi_dbg)
266 {
267 }
268 #endif  /* ! IS_ENABLED(CONFIG_DEBUG_FS) */
269 
270 #endif
271