1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * arch/arm/include/asm/hardware/sa1111.h
4  *
5  * Copyright (C) 2000 John G Dorsey <john+@cs.cmu.edu>
6  *
7  * This file contains definitions for the SA-1111 Companion Chip.
8  * (Structure and naming borrowed from SA-1101.h, by Peter Danielsson.)
9  *
10  * Macro that calculates real address for registers in the SA-1111
11  */
12 
13 #ifndef _ASM_ARCH_SA1111
14 #define _ASM_ARCH_SA1111
15 
16 /*
17  * Don't ask the (SAC) DMA engines to move less than this amount.
18  */
19 
20 #define SA1111_SAC_DMA_MIN_XFER	(0x800)
21 
22 /*
23  * System Bus Interface (SBI)
24  *
25  * Registers
26  *    SKCR	Control Register
27  *    SMCR	Shared Memory Controller Register
28  *    SKID	ID Register
29  */
30 #define SA1111_SKCR	0x0000
31 #define SA1111_SMCR	0x0004
32 #define SA1111_SKID	0x0008
33 
34 #define SKCR_PLL_BYPASS	(1<<0)
35 #define SKCR_RCLKEN	(1<<1)
36 #define SKCR_SLEEP	(1<<2)
37 #define SKCR_DOZE	(1<<3)
38 #define SKCR_VCO_OFF	(1<<4)
39 #define SKCR_SCANTSTEN	(1<<5)
40 #define SKCR_CLKTSTEN	(1<<6)
41 #define SKCR_RDYEN	(1<<7)
42 #define SKCR_SELAC	(1<<8)
43 #define SKCR_OPPC	(1<<9)
44 #define SKCR_PLLTSTEN	(1<<10)
45 #define SKCR_USBIOTSTEN	(1<<11)
46 /*
47  * Don't believe the specs!  Take them, throw them outside.  Leave them
48  * there for a week.  Spit on them.  Walk on them.  Stamp on them.
49  * Pour gasoline over them and finally burn them.  Now think about coding.
50  *  - The October 1999 errata (278260-007) says its bit 13, 1 to enable.
51  *  - The Feb 2001 errata (278260-010) says that the previous errata
52  *    (278260-009) is wrong, and its bit actually 12, fixed in spec
53  *    278242-003.
54  *  - The SA1111 manual (278242) says bit 12, but 0 to enable.
55  *  - Reality is bit 13, 1 to enable.
56  *      -- rmk
57  */
58 #define SKCR_OE_EN	(1<<13)
59 
60 #define SMCR_DTIM	(1<<0)
61 #define SMCR_MBGE	(1<<1)
62 #define SMCR_DRAC_0	(1<<2)
63 #define SMCR_DRAC_1	(1<<3)
64 #define SMCR_DRAC_2	(1<<4)
65 #define SMCR_DRAC	Fld(3, 2)
66 #define SMCR_CLAT	(1<<5)
67 
68 #define SKID_SIREV_MASK	(0x000000f0)
69 #define SKID_MTREV_MASK (0x0000000f)
70 #define SKID_ID_MASK	(0xffffff00)
71 #define SKID_SA1111_ID	(0x690cc200)
72 
73 /*
74  * System Controller
75  *
76  * Registers
77  *    SKPCR	Power Control Register
78  *    SKCDR	Clock Divider Register
79  *    SKAUD	Audio Clock Divider Register
80  *    SKPMC	PS/2 Mouse Clock Divider Register
81  *    SKPTC	PS/2 Track Pad Clock Divider Register
82  *    SKPEN0	PWM0 Enable Register
83  *    SKPWM0	PWM0 Clock Register
84  *    SKPEN1	PWM1 Enable Register
85  *    SKPWM1	PWM1 Clock Register
86  */
87 #define SA1111_SKPCR	0x0200
88 #define SA1111_SKCDR	0x0204
89 #define SA1111_SKAUD	0x0208
90 #define SA1111_SKPMC	0x020c
91 #define SA1111_SKPTC	0x0210
92 #define SA1111_SKPEN0	0x0214
93 #define SA1111_SKPWM0	0x0218
94 #define SA1111_SKPEN1	0x021c
95 #define SA1111_SKPWM1	0x0220
96 
97 #define SKPCR_UCLKEN	(1<<0)
98 #define SKPCR_ACCLKEN	(1<<1)
99 #define SKPCR_I2SCLKEN	(1<<2)
100 #define SKPCR_L3CLKEN	(1<<3)
101 #define SKPCR_SCLKEN	(1<<4)
102 #define SKPCR_PMCLKEN	(1<<5)
103 #define SKPCR_PTCLKEN	(1<<6)
104 #define SKPCR_DCLKEN	(1<<7)
105 #define SKPCR_PWMCLKEN	(1<<8)
106 
107 /* USB Host controller */
108 #define SA1111_USB		0x0400
109 
110 /*
111  * Serial Audio Controller
112  *
113  * Registers
114  *    SACR0             Serial Audio Common Control Register
115  *    SACR1             Serial Audio Alternate Mode (I2C/MSB) Control Register
116  *    SACR2             Serial Audio AC-link Control Register
117  *    SASR0             Serial Audio I2S/MSB Interface & FIFO Status Register
118  *    SASR1             Serial Audio AC-link Interface & FIFO Status Register
119  *    SASCR             Serial Audio Status Clear Register
120  *    L3_CAR            L3 Control Bus Address Register
121  *    L3_CDR            L3 Control Bus Data Register
122  *    ACCAR             AC-link Command Address Register
123  *    ACCDR             AC-link Command Data Register
124  *    ACSAR             AC-link Status Address Register
125  *    ACSDR             AC-link Status Data Register
126  *    SADTCS            Serial Audio DMA Transmit Control/Status Register
127  *    SADTSA            Serial Audio DMA Transmit Buffer Start Address A
128  *    SADTCA            Serial Audio DMA Transmit Buffer Count Register A
129  *    SADTSB            Serial Audio DMA Transmit Buffer Start Address B
130  *    SADTCB            Serial Audio DMA Transmit Buffer Count Register B
131  *    SADRCS            Serial Audio DMA Receive Control/Status Register
132  *    SADRSA            Serial Audio DMA Receive Buffer Start Address A
133  *    SADRCA            Serial Audio DMA Receive Buffer Count Register A
134  *    SADRSB            Serial Audio DMA Receive Buffer Start Address B
135  *    SADRCB            Serial Audio DMA Receive Buffer Count Register B
136  *    SAITR             Serial Audio Interrupt Test Register
137  *    SADR              Serial Audio Data Register (16 x 32-bit)
138  */
139 
140 #define SA1111_SERAUDIO		0x0600
141 
142 /*
143  * These are offsets from the above base.
144  */
145 #define SA1111_SACR0		0x00
146 #define SA1111_SACR1		0x04
147 #define SA1111_SACR2		0x08
148 #define SA1111_SASR0		0x0c
149 #define SA1111_SASR1		0x10
150 #define SA1111_SASCR		0x18
151 #define SA1111_L3_CAR		0x1c
152 #define SA1111_L3_CDR		0x20
153 #define SA1111_ACCAR		0x24
154 #define SA1111_ACCDR		0x28
155 #define SA1111_ACSAR		0x2c
156 #define SA1111_ACSDR		0x30
157 #define SA1111_SADTCS		0x34
158 #define SA1111_SADTSA		0x38
159 #define SA1111_SADTCA		0x3c
160 #define SA1111_SADTSB		0x40
161 #define SA1111_SADTCB		0x44
162 #define SA1111_SADRCS		0x48
163 #define SA1111_SADRSA		0x4c
164 #define SA1111_SADRCA		0x50
165 #define SA1111_SADRSB		0x54
166 #define SA1111_SADRCB		0x58
167 #define SA1111_SAITR		0x5c
168 #define SA1111_SADR		0x80
169 
170 #ifndef CONFIG_ARCH_PXA
171 
172 #define SACR0_ENB	(1<<0)
173 #define SACR0_BCKD	(1<<2)
174 #define SACR0_RST	(1<<3)
175 
176 #define SACR1_AMSL	(1<<0)
177 #define SACR1_L3EN	(1<<1)
178 #define SACR1_L3MB	(1<<2)
179 #define SACR1_DREC	(1<<3)
180 #define SACR1_DRPL	(1<<4)
181 #define SACR1_ENLBF	(1<<5)
182 
183 #define SACR2_TS3V	(1<<0)
184 #define SACR2_TS4V	(1<<1)
185 #define SACR2_WKUP	(1<<2)
186 #define SACR2_DREC	(1<<3)
187 #define SACR2_DRPL	(1<<4)
188 #define SACR2_ENLBF	(1<<5)
189 #define SACR2_RESET	(1<<6)
190 
191 #define SASR0_TNF	(1<<0)
192 #define SASR0_RNE	(1<<1)
193 #define SASR0_BSY	(1<<2)
194 #define SASR0_TFS	(1<<3)
195 #define SASR0_RFS	(1<<4)
196 #define SASR0_TUR	(1<<5)
197 #define SASR0_ROR	(1<<6)
198 #define SASR0_L3WD	(1<<16)
199 #define SASR0_L3RD	(1<<17)
200 
201 #define SASR1_TNF	(1<<0)
202 #define SASR1_RNE	(1<<1)
203 #define SASR1_BSY	(1<<2)
204 #define SASR1_TFS	(1<<3)
205 #define SASR1_RFS	(1<<4)
206 #define SASR1_TUR	(1<<5)
207 #define SASR1_ROR	(1<<6)
208 #define SASR1_CADT	(1<<16)
209 #define SASR1_SADR	(1<<17)
210 #define SASR1_RSTO	(1<<18)
211 #define SASR1_CLPM	(1<<19)
212 #define SASR1_CRDY	(1<<20)
213 #define SASR1_RS3V	(1<<21)
214 #define SASR1_RS4V	(1<<22)
215 
216 #define SASCR_TUR	(1<<5)
217 #define SASCR_ROR	(1<<6)
218 #define SASCR_DTS	(1<<16)
219 #define SASCR_RDD	(1<<17)
220 #define SASCR_STO	(1<<18)
221 
222 #define SADTCS_TDEN	(1<<0)
223 #define SADTCS_TDIE	(1<<1)
224 #define SADTCS_TDBDA	(1<<3)
225 #define SADTCS_TDSTA	(1<<4)
226 #define SADTCS_TDBDB	(1<<5)
227 #define SADTCS_TDSTB	(1<<6)
228 #define SADTCS_TBIU	(1<<7)
229 
230 #define SADRCS_RDEN	(1<<0)
231 #define SADRCS_RDIE	(1<<1)
232 #define SADRCS_RDBDA	(1<<3)
233 #define SADRCS_RDSTA	(1<<4)
234 #define SADRCS_RDBDB	(1<<5)
235 #define SADRCS_RDSTB	(1<<6)
236 #define SADRCS_RBIU	(1<<7)
237 
238 #define SAD_CS_DEN	(1<<0)
239 #define SAD_CS_DIE	(1<<1)	/* Not functional on metal 1 */
240 #define SAD_CS_DBDA	(1<<3)	/* Not functional on metal 1 */
241 #define SAD_CS_DSTA	(1<<4)
242 #define SAD_CS_DBDB	(1<<5)	/* Not functional on metal 1 */
243 #define SAD_CS_DSTB	(1<<6)
244 #define SAD_CS_BIU	(1<<7)	/* Not functional on metal 1 */
245 
246 #define SAITR_TFS	(1<<0)
247 #define SAITR_RFS	(1<<1)
248 #define SAITR_TUR	(1<<2)
249 #define SAITR_ROR	(1<<3)
250 #define SAITR_CADT	(1<<4)
251 #define SAITR_SADR	(1<<5)
252 #define SAITR_RSTO	(1<<6)
253 #define SAITR_TDBDA	(1<<8)
254 #define SAITR_TDBDB	(1<<9)
255 #define SAITR_RDBDA	(1<<10)
256 #define SAITR_RDBDB	(1<<11)
257 
258 #endif  /* !CONFIG_ARCH_PXA */
259 
260 /*
261  * General-Purpose I/O Interface
262  *
263  * Registers
264  *    PA_DDR		GPIO Block A Data Direction
265  *    PA_DRR/PA_DWR	GPIO Block A Data Value Register (read/write)
266  *    PA_SDR		GPIO Block A Sleep Direction
267  *    PA_SSR		GPIO Block A Sleep State
268  *    PB_DDR		GPIO Block B Data Direction
269  *    PB_DRR/PB_DWR	GPIO Block B Data Value Register (read/write)
270  *    PB_SDR		GPIO Block B Sleep Direction
271  *    PB_SSR		GPIO Block B Sleep State
272  *    PC_DDR		GPIO Block C Data Direction
273  *    PC_DRR/PC_DWR	GPIO Block C Data Value Register (read/write)
274  *    PC_SDR		GPIO Block C Sleep Direction
275  *    PC_SSR		GPIO Block C Sleep State
276  */
277 
278 #define SA1111_GPIO	0x1000
279 
280 #define SA1111_GPIO_PADDR	(0x000)
281 #define SA1111_GPIO_PADRR	(0x004)
282 #define SA1111_GPIO_PADWR	(0x004)
283 #define SA1111_GPIO_PASDR	(0x008)
284 #define SA1111_GPIO_PASSR	(0x00c)
285 #define SA1111_GPIO_PBDDR	(0x010)
286 #define SA1111_GPIO_PBDRR	(0x014)
287 #define SA1111_GPIO_PBDWR	(0x014)
288 #define SA1111_GPIO_PBSDR	(0x018)
289 #define SA1111_GPIO_PBSSR	(0x01c)
290 #define SA1111_GPIO_PCDDR	(0x020)
291 #define SA1111_GPIO_PCDRR	(0x024)
292 #define SA1111_GPIO_PCDWR	(0x024)
293 #define SA1111_GPIO_PCSDR	(0x028)
294 #define SA1111_GPIO_PCSSR	(0x02c)
295 
296 #define GPIO_A0		(1 << 0)
297 #define GPIO_A1		(1 << 1)
298 #define GPIO_A2		(1 << 2)
299 #define GPIO_A3		(1 << 3)
300 
301 #define GPIO_B0		(1 << 8)
302 #define GPIO_B1		(1 << 9)
303 #define GPIO_B2		(1 << 10)
304 #define GPIO_B3		(1 << 11)
305 #define GPIO_B4		(1 << 12)
306 #define GPIO_B5		(1 << 13)
307 #define GPIO_B6		(1 << 14)
308 #define GPIO_B7		(1 << 15)
309 
310 #define GPIO_C0		(1 << 16)
311 #define GPIO_C1		(1 << 17)
312 #define GPIO_C2		(1 << 18)
313 #define GPIO_C3		(1 << 19)
314 #define GPIO_C4		(1 << 20)
315 #define GPIO_C5		(1 << 21)
316 #define GPIO_C6		(1 << 22)
317 #define GPIO_C7		(1 << 23)
318 
319 /*
320  * Interrupt Controller
321  *
322  * Registers
323  *    INTTEST0		Test register 0
324  *    INTTEST1		Test register 1
325  *    INTEN0		Interrupt Enable register 0
326  *    INTEN1		Interrupt Enable register 1
327  *    INTPOL0		Interrupt Polarity selection 0
328  *    INTPOL1		Interrupt Polarity selection 1
329  *    INTTSTSEL		Interrupt source selection
330  *    INTSTATCLR0	Interrupt Status/Clear 0
331  *    INTSTATCLR1	Interrupt Status/Clear 1
332  *    INTSET0		Interrupt source set 0
333  *    INTSET1		Interrupt source set 1
334  *    WAKE_EN0		Wake-up source enable 0
335  *    WAKE_EN1		Wake-up source enable 1
336  *    WAKE_POL0		Wake-up polarity selection 0
337  *    WAKE_POL1		Wake-up polarity selection 1
338  */
339 #define SA1111_INTC		0x1600
340 
341 /*
342  * These are offsets from the above base.
343  */
344 #define SA1111_INTTEST0		0x0000
345 #define SA1111_INTTEST1		0x0004
346 #define SA1111_INTEN0		0x0008
347 #define SA1111_INTEN1		0x000c
348 #define SA1111_INTPOL0		0x0010
349 #define SA1111_INTPOL1		0x0014
350 #define SA1111_INTTSTSEL	0x0018
351 #define SA1111_INTSTATCLR0	0x001c
352 #define SA1111_INTSTATCLR1	0x0020
353 #define SA1111_INTSET0		0x0024
354 #define SA1111_INTSET1		0x0028
355 #define SA1111_WAKEEN0		0x002c
356 #define SA1111_WAKEEN1		0x0030
357 #define SA1111_WAKEPOL0		0x0034
358 #define SA1111_WAKEPOL1		0x0038
359 
360 /* PS/2 Trackpad and Mouse Interfaces */
361 #define SA1111_KBD		0x0a00
362 #define SA1111_MSE		0x0c00
363 
364 /* PCMCIA Interface */
365 #define SA1111_PCMCIA		0x1600
366 
367 
368 
369 
370 
371 extern struct bus_type sa1111_bus_type;
372 
373 #define SA1111_DEVID_SBI	(1 << 0)
374 #define SA1111_DEVID_SK		(1 << 1)
375 #define SA1111_DEVID_USB	(1 << 2)
376 #define SA1111_DEVID_SAC	(1 << 3)
377 #define SA1111_DEVID_SSP	(1 << 4)
378 #define SA1111_DEVID_PS2	(3 << 5)
379 #define SA1111_DEVID_PS2_KBD	(1 << 5)
380 #define SA1111_DEVID_PS2_MSE	(1 << 6)
381 #define SA1111_DEVID_GPIO	(1 << 7)
382 #define SA1111_DEVID_INT	(1 << 8)
383 #define SA1111_DEVID_PCMCIA	(1 << 9)
384 
385 struct sa1111_dev {
386 	struct device	dev;
387 	unsigned int	devid;
388 	struct resource	res;
389 	void __iomem	*mapbase;
390 	unsigned int	skpcr_mask;
391 	unsigned int	hwirq[6];
392 	u64		dma_mask;
393 };
394 
395 #define to_sa1111_device(x)	container_of(x, struct sa1111_dev, dev)
396 
397 #define sa1111_get_drvdata(d)	dev_get_drvdata(&(d)->dev)
398 #define sa1111_set_drvdata(d,p)	dev_set_drvdata(&(d)->dev, p)
399 
400 struct sa1111_driver {
401 	struct device_driver	drv;
402 	unsigned int		devid;
403 	int (*probe)(struct sa1111_dev *);
404 	void (*remove)(struct sa1111_dev *);
405 };
406 
407 #define SA1111_DRV(_d)	container_of((_d), struct sa1111_driver, drv)
408 
409 #define SA1111_DRIVER_NAME(_sadev) ((_sadev)->dev.driver->name)
410 
411 /*
412  * These frob the SKPCR register, and call platform specific
413  * enable/disable functions.
414  */
415 int sa1111_enable_device(struct sa1111_dev *);
416 void sa1111_disable_device(struct sa1111_dev *);
417 
418 int sa1111_get_irq(struct sa1111_dev *, unsigned num);
419 
420 unsigned int sa1111_pll_clock(struct sa1111_dev *);
421 
422 #define SA1111_AUDIO_ACLINK	0
423 #define SA1111_AUDIO_I2S	1
424 
425 void sa1111_select_audio_mode(struct sa1111_dev *sadev, int mode);
426 int sa1111_set_audio_rate(struct sa1111_dev *sadev, int rate);
427 int sa1111_get_audio_rate(struct sa1111_dev *sadev);
428 
429 int sa1111_check_dma_bug(dma_addr_t addr);
430 
431 int sa1111_driver_register(struct sa1111_driver *);
432 void sa1111_driver_unregister(struct sa1111_driver *);
433 
434 struct sa1111_platform_data {
435 	int	irq_base;	/* base for cascaded on-chip IRQs */
436 	unsigned disable_devs;
437 	void	*data;
438 	int	(*enable)(void *, unsigned);
439 	void	(*disable)(void *, unsigned);
440 };
441 
442 #endif  /* _ASM_ARCH_SA1111 */
443