[ARM] 3739/1: genirq updates: irq_chip, add and use irq_chip.name
[linux-2.6.git] / arch / arm / common / sa1111.c
1 /*
2  * linux/arch/arm/mach-sa1100/sa1111.c
3  *
4  * SA1111 support
5  *
6  * Original code by John Dorsey
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  *
12  * This file contains all generic SA1111 support.
13  *
14  * All initialization functions provided here are intended to be called
15  * from machine specific code with proper arguments when required.
16  */
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/kernel.h>
20 #include <linux/delay.h>
21 #include <linux/ptrace.h>
22 #include <linux/errno.h>
23 #include <linux/ioport.h>
24 #include <linux/platform_device.h>
25 #include <linux/slab.h>
26 #include <linux/spinlock.h>
27 #include <linux/dma-mapping.h>
28 #include <linux/clk.h>
29
30 #include <asm/hardware.h>
31 #include <asm/mach-types.h>
32 #include <asm/io.h>
33 #include <asm/irq.h>
34 #include <asm/mach/irq.h>
35 #include <asm/sizes.h>
36
37 #include <asm/hardware/sa1111.h>
38
39 extern void __init sa1110_mb_enable(void);
40
41 /*
42  * We keep the following data for the overall SA1111.  Note that the
43  * struct device and struct resource are "fake"; they should be supplied
44  * by the bus above us.  However, in the interests of getting all SA1111
45  * drivers converted over to the device model, we provide this as an
46  * anchor point for all the other drivers.
47  */
48 struct sa1111 {
49         struct device   *dev;
50         struct clk      *clk;
51         unsigned long   phys;
52         int             irq;
53         spinlock_t      lock;
54         void __iomem    *base;
55 };
56
57 /*
58  * We _really_ need to eliminate this.  Its only users
59  * are the PWM and DMA checking code.
60  */
61 static struct sa1111 *g_sa1111;
62
63 struct sa1111_dev_info {
64         unsigned long   offset;
65         unsigned long   skpcr_mask;
66         unsigned int    devid;
67         unsigned int    irq[6];
68 };
69
70 static struct sa1111_dev_info sa1111_devices[] = {
71         {
72                 .offset         = SA1111_USB,
73                 .skpcr_mask     = SKPCR_UCLKEN,
74                 .devid          = SA1111_DEVID_USB,
75                 .irq = {
76                         IRQ_USBPWR,
77                         IRQ_HCIM,
78                         IRQ_HCIBUFFACC,
79                         IRQ_HCIRMTWKP,
80                         IRQ_NHCIMFCIR,
81                         IRQ_USB_PORT_RESUME
82                 },
83         },
84         {
85                 .offset         = 0x0600,
86                 .skpcr_mask     = SKPCR_I2SCLKEN | SKPCR_L3CLKEN,
87                 .devid          = SA1111_DEVID_SAC,
88                 .irq = {
89                         AUDXMTDMADONEA,
90                         AUDXMTDMADONEB,
91                         AUDRCVDMADONEA,
92                         AUDRCVDMADONEB
93                 },
94         },
95         {
96                 .offset         = 0x0800,
97                 .skpcr_mask     = SKPCR_SCLKEN,
98                 .devid          = SA1111_DEVID_SSP,
99         },
100         {
101                 .offset         = SA1111_KBD,
102                 .skpcr_mask     = SKPCR_PTCLKEN,
103                 .devid          = SA1111_DEVID_PS2,
104                 .irq = {
105                         IRQ_TPRXINT,
106                         IRQ_TPTXINT
107                 },
108         },
109         {
110                 .offset         = SA1111_MSE,
111                 .skpcr_mask     = SKPCR_PMCLKEN,
112                 .devid          = SA1111_DEVID_PS2,
113                 .irq = {
114                         IRQ_MSRXINT,
115                         IRQ_MSTXINT
116                 },
117         },
118         {
119                 .offset         = 0x1800,
120                 .skpcr_mask     = 0,
121                 .devid          = SA1111_DEVID_PCMCIA,
122                 .irq = {
123                         IRQ_S0_READY_NINT,
124                         IRQ_S0_CD_VALID,
125                         IRQ_S0_BVD1_STSCHG,
126                         IRQ_S1_READY_NINT,
127                         IRQ_S1_CD_VALID,
128                         IRQ_S1_BVD1_STSCHG,
129                 },
130         },
131 };
132
133 void __init sa1111_adjust_zones(int node, unsigned long *size, unsigned long *holes)
134 {
135         unsigned int sz = SZ_1M >> PAGE_SHIFT;
136
137         if (node != 0)
138                 sz = 0;
139
140         size[1] = size[0] - sz;
141         size[0] = sz;
142 }
143
144 /*
145  * SA1111 interrupt support.  Since clearing an IRQ while there are
146  * active IRQs causes the interrupt output to pulse, the upper levels
147  * will call us again if there are more interrupts to process.
148  */
149 static void
150 sa1111_irq_handler(unsigned int irq, struct irqdesc *desc, struct pt_regs *regs)
151 {
152         unsigned int stat0, stat1, i;
153         void __iomem *base = get_irq_data(irq);
154
155         stat0 = sa1111_readl(base + SA1111_INTSTATCLR0);
156         stat1 = sa1111_readl(base + SA1111_INTSTATCLR1);
157
158         sa1111_writel(stat0, base + SA1111_INTSTATCLR0);
159
160         desc->chip->ack(irq);
161
162         sa1111_writel(stat1, base + SA1111_INTSTATCLR1);
163
164         if (stat0 == 0 && stat1 == 0) {
165                 do_bad_IRQ(irq, desc, regs);
166                 return;
167         }
168
169         for (i = IRQ_SA1111_START; stat0; i++, stat0 >>= 1)
170                 if (stat0 & 1)
171                         handle_edge_irq(i, irq_desc + i, regs);
172
173         for (i = IRQ_SA1111_START + 32; stat1; i++, stat1 >>= 1)
174                 if (stat1 & 1)
175                         handle_edge_irq(i, irq_desc + i, regs);
176
177         /* For level-based interrupts */
178         desc->chip->unmask(irq);
179 }
180
181 #define SA1111_IRQMASK_LO(x)    (1 << (x - IRQ_SA1111_START))
182 #define SA1111_IRQMASK_HI(x)    (1 << (x - IRQ_SA1111_START - 32))
183
184 static void sa1111_ack_irq(unsigned int irq)
185 {
186 }
187
188 static void sa1111_mask_lowirq(unsigned int irq)
189 {
190         void __iomem *mapbase = get_irq_chipdata(irq);
191         unsigned long ie0;
192
193         ie0 = sa1111_readl(mapbase + SA1111_INTEN0);
194         ie0 &= ~SA1111_IRQMASK_LO(irq);
195         writel(ie0, mapbase + SA1111_INTEN0);
196 }
197
198 static void sa1111_unmask_lowirq(unsigned int irq)
199 {
200         void __iomem *mapbase = get_irq_chipdata(irq);
201         unsigned long ie0;
202
203         ie0 = sa1111_readl(mapbase + SA1111_INTEN0);
204         ie0 |= SA1111_IRQMASK_LO(irq);
205         sa1111_writel(ie0, mapbase + SA1111_INTEN0);
206 }
207
208 /*
209  * Attempt to re-trigger the interrupt.  The SA1111 contains a register
210  * (INTSET) which claims to do this.  However, in practice no amount of
211  * manipulation of INTEN and INTSET guarantees that the interrupt will
212  * be triggered.  In fact, its very difficult, if not impossible to get
213  * INTSET to re-trigger the interrupt.
214  */
215 static int sa1111_retrigger_lowirq(unsigned int irq)
216 {
217         unsigned int mask = SA1111_IRQMASK_LO(irq);
218         void __iomem *mapbase = get_irq_chipdata(irq);
219         unsigned long ip0;
220         int i;
221
222         ip0 = sa1111_readl(mapbase + SA1111_INTPOL0);
223         for (i = 0; i < 8; i++) {
224                 sa1111_writel(ip0 ^ mask, mapbase + SA1111_INTPOL0);
225                 sa1111_writel(ip0, mapbase + SA1111_INTPOL0);
226                 if (sa1111_readl(mapbase + SA1111_INTSTATCLR1) & mask)
227                         break;
228         }
229
230         if (i == 8)
231                 printk(KERN_ERR "Danger Will Robinson: failed to "
232                         "re-trigger IRQ%d\n", irq);
233         return i == 8 ? -1 : 0;
234 }
235
236 static int sa1111_type_lowirq(unsigned int irq, unsigned int flags)
237 {
238         unsigned int mask = SA1111_IRQMASK_LO(irq);
239         void __iomem *mapbase = get_irq_chipdata(irq);
240         unsigned long ip0;
241
242         if (flags == IRQT_PROBE)
243                 return 0;
244
245         if ((!(flags & __IRQT_RISEDGE) ^ !(flags & __IRQT_FALEDGE)) == 0)
246                 return -EINVAL;
247
248         ip0 = sa1111_readl(mapbase + SA1111_INTPOL0);
249         if (flags & __IRQT_RISEDGE)
250                 ip0 &= ~mask;
251         else
252                 ip0 |= mask;
253         sa1111_writel(ip0, mapbase + SA1111_INTPOL0);
254         sa1111_writel(ip0, mapbase + SA1111_WAKEPOL0);
255
256         return 0;
257 }
258
259 static int sa1111_wake_lowirq(unsigned int irq, unsigned int on)
260 {
261         unsigned int mask = SA1111_IRQMASK_LO(irq);
262         void __iomem *mapbase = get_irq_chipdata(irq);
263         unsigned long we0;
264
265         we0 = sa1111_readl(mapbase + SA1111_WAKEEN0);
266         if (on)
267                 we0 |= mask;
268         else
269                 we0 &= ~mask;
270         sa1111_writel(we0, mapbase + SA1111_WAKEEN0);
271
272         return 0;
273 }
274
275 static struct irq_chip sa1111_low_chip = {
276         .name           = "SA1111-l",
277         .ack            = sa1111_ack_irq,
278         .mask           = sa1111_mask_lowirq,
279         .unmask         = sa1111_unmask_lowirq,
280         .retrigger      = sa1111_retrigger_lowirq,
281         .set_type       = sa1111_type_lowirq,
282         .set_wake       = sa1111_wake_lowirq,
283 };
284
285 static void sa1111_mask_highirq(unsigned int irq)
286 {
287         void __iomem *mapbase = get_irq_chipdata(irq);
288         unsigned long ie1;
289
290         ie1 = sa1111_readl(mapbase + SA1111_INTEN1);
291         ie1 &= ~SA1111_IRQMASK_HI(irq);
292         sa1111_writel(ie1, mapbase + SA1111_INTEN1);
293 }
294
295 static void sa1111_unmask_highirq(unsigned int irq)
296 {
297         void __iomem *mapbase = get_irq_chipdata(irq);
298         unsigned long ie1;
299
300         ie1 = sa1111_readl(mapbase + SA1111_INTEN1);
301         ie1 |= SA1111_IRQMASK_HI(irq);
302         sa1111_writel(ie1, mapbase + SA1111_INTEN1);
303 }
304
305 /*
306  * Attempt to re-trigger the interrupt.  The SA1111 contains a register
307  * (INTSET) which claims to do this.  However, in practice no amount of
308  * manipulation of INTEN and INTSET guarantees that the interrupt will
309  * be triggered.  In fact, its very difficult, if not impossible to get
310  * INTSET to re-trigger the interrupt.
311  */
312 static int sa1111_retrigger_highirq(unsigned int irq)
313 {
314         unsigned int mask = SA1111_IRQMASK_HI(irq);
315         void __iomem *mapbase = get_irq_chipdata(irq);
316         unsigned long ip1;
317         int i;
318
319         ip1 = sa1111_readl(mapbase + SA1111_INTPOL1);
320         for (i = 0; i < 8; i++) {
321                 sa1111_writel(ip1 ^ mask, mapbase + SA1111_INTPOL1);
322                 sa1111_writel(ip1, mapbase + SA1111_INTPOL1);
323                 if (sa1111_readl(mapbase + SA1111_INTSTATCLR1) & mask)
324                         break;
325         }
326
327         if (i == 8)
328                 printk(KERN_ERR "Danger Will Robinson: failed to "
329                         "re-trigger IRQ%d\n", irq);
330         return i == 8 ? -1 : 0;
331 }
332
333 static int sa1111_type_highirq(unsigned int irq, unsigned int flags)
334 {
335         unsigned int mask = SA1111_IRQMASK_HI(irq);
336         void __iomem *mapbase = get_irq_chipdata(irq);
337         unsigned long ip1;
338
339         if (flags == IRQT_PROBE)
340                 return 0;
341
342         if ((!(flags & __IRQT_RISEDGE) ^ !(flags & __IRQT_FALEDGE)) == 0)
343                 return -EINVAL;
344
345         ip1 = sa1111_readl(mapbase + SA1111_INTPOL1);
346         if (flags & __IRQT_RISEDGE)
347                 ip1 &= ~mask;
348         else
349                 ip1 |= mask;
350         sa1111_writel(ip1, mapbase + SA1111_INTPOL1);
351         sa1111_writel(ip1, mapbase + SA1111_WAKEPOL1);
352
353         return 0;
354 }
355
356 static int sa1111_wake_highirq(unsigned int irq, unsigned int on)
357 {
358         unsigned int mask = SA1111_IRQMASK_HI(irq);
359         void __iomem *mapbase = get_irq_chipdata(irq);
360         unsigned long we1;
361
362         we1 = sa1111_readl(mapbase + SA1111_WAKEEN1);
363         if (on)
364                 we1 |= mask;
365         else
366                 we1 &= ~mask;
367         sa1111_writel(we1, mapbase + SA1111_WAKEEN1);
368
369         return 0;
370 }
371
372 static struct irq_chip sa1111_high_chip = {
373         .name           = "SA1111-h",
374         .ack            = sa1111_ack_irq,
375         .mask           = sa1111_mask_highirq,
376         .unmask         = sa1111_unmask_highirq,
377         .retrigger      = sa1111_retrigger_highirq,
378         .set_type       = sa1111_type_highirq,
379         .set_wake       = sa1111_wake_highirq,
380 };
381
382 static void sa1111_setup_irq(struct sa1111 *sachip)
383 {
384         void __iomem *irqbase = sachip->base + SA1111_INTC;
385         unsigned int irq;
386
387         /*
388          * We're guaranteed that this region hasn't been taken.
389          */
390         request_mem_region(sachip->phys + SA1111_INTC, 512, "irq");
391
392         /* disable all IRQs */
393         sa1111_writel(0, irqbase + SA1111_INTEN0);
394         sa1111_writel(0, irqbase + SA1111_INTEN1);
395         sa1111_writel(0, irqbase + SA1111_WAKEEN0);
396         sa1111_writel(0, irqbase + SA1111_WAKEEN1);
397
398         /*
399          * detect on rising edge.  Note: Feb 2001 Errata for SA1111
400          * specifies that S0ReadyInt and S1ReadyInt should be '1'.
401          */
402         sa1111_writel(0, irqbase + SA1111_INTPOL0);
403         sa1111_writel(SA1111_IRQMASK_HI(IRQ_S0_READY_NINT) |
404                       SA1111_IRQMASK_HI(IRQ_S1_READY_NINT),
405                       irqbase + SA1111_INTPOL1);
406
407         /* clear all IRQs */
408         sa1111_writel(~0, irqbase + SA1111_INTSTATCLR0);
409         sa1111_writel(~0, irqbase + SA1111_INTSTATCLR1);
410
411         for (irq = IRQ_GPAIN0; irq <= SSPROR; irq++) {
412                 set_irq_chip(irq, &sa1111_low_chip);
413                 set_irq_chipdata(irq, irqbase);
414                 set_irq_handler(irq, do_edge_IRQ);
415                 set_irq_flags(irq, IRQF_VALID | IRQF_PROBE);
416         }
417
418         for (irq = AUDXMTDMADONEA; irq <= IRQ_S1_BVD1_STSCHG; irq++) {
419                 set_irq_chip(irq, &sa1111_high_chip);
420                 set_irq_chipdata(irq, irqbase);
421                 set_irq_handler(irq, do_edge_IRQ);
422                 set_irq_flags(irq, IRQF_VALID | IRQF_PROBE);
423         }
424
425         /*
426          * Register SA1111 interrupt
427          */
428         set_irq_type(sachip->irq, IRQT_RISING);
429         set_irq_data(sachip->irq, irqbase);
430         set_irq_chained_handler(sachip->irq, sa1111_irq_handler);
431 }
432
433 /*
434  * Bring the SA1111 out of reset.  This requires a set procedure:
435  *  1. nRESET asserted (by hardware)
436  *  2. CLK turned on from SA1110
437  *  3. nRESET deasserted
438  *  4. VCO turned on, PLL_BYPASS turned off
439  *  5. Wait lock time, then assert RCLKEn
440  *  7. PCR set to allow clocking of individual functions
441  *
442  * Until we've done this, the only registers we can access are:
443  *   SBI_SKCR
444  *   SBI_SMCR
445  *   SBI_SKID
446  */
447 static void sa1111_wake(struct sa1111 *sachip)
448 {
449         unsigned long flags, r;
450
451         spin_lock_irqsave(&sachip->lock, flags);
452
453         clk_enable(sachip->clk);
454
455         /*
456          * Turn VCO on, and disable PLL Bypass.
457          */
458         r = sa1111_readl(sachip->base + SA1111_SKCR);
459         r &= ~SKCR_VCO_OFF;
460         sa1111_writel(r, sachip->base + SA1111_SKCR);
461         r |= SKCR_PLL_BYPASS | SKCR_OE_EN;
462         sa1111_writel(r, sachip->base + SA1111_SKCR);
463
464         /*
465          * Wait lock time.  SA1111 manual _doesn't_
466          * specify a figure for this!  We choose 100us.
467          */
468         udelay(100);
469
470         /*
471          * Enable RCLK.  We also ensure that RDYEN is set.
472          */
473         r |= SKCR_RCLKEN | SKCR_RDYEN;
474         sa1111_writel(r, sachip->base + SA1111_SKCR);
475
476         /*
477          * Wait 14 RCLK cycles for the chip to finish coming out
478          * of reset. (RCLK=24MHz).  This is 590ns.
479          */
480         udelay(1);
481
482         /*
483          * Ensure all clocks are initially off.
484          */
485         sa1111_writel(0, sachip->base + SA1111_SKPCR);
486
487         spin_unlock_irqrestore(&sachip->lock, flags);
488 }
489
490 #ifdef CONFIG_ARCH_SA1100
491
492 static u32 sa1111_dma_mask[] = {
493         ~0,
494         ~(1 << 20),
495         ~(1 << 23),
496         ~(1 << 24),
497         ~(1 << 25),
498         ~(1 << 20),
499         ~(1 << 20),
500         0,
501 };
502
503 /*
504  * Configure the SA1111 shared memory controller.
505  */
506 void
507 sa1111_configure_smc(struct sa1111 *sachip, int sdram, unsigned int drac,
508                      unsigned int cas_latency)
509 {
510         unsigned int smcr = SMCR_DTIM | SMCR_MBGE | FInsrt(drac, SMCR_DRAC);
511
512         if (cas_latency == 3)
513                 smcr |= SMCR_CLAT;
514
515         sa1111_writel(smcr, sachip->base + SA1111_SMCR);
516
517         /*
518          * Now clear the bits in the DMA mask to work around the SA1111
519          * DMA erratum (Intel StrongARM SA-1111 Microprocessor Companion
520          * Chip Specification Update, June 2000, Erratum #7).
521          */
522         if (sachip->dev->dma_mask)
523                 *sachip->dev->dma_mask &= sa1111_dma_mask[drac >> 2];
524
525         sachip->dev->coherent_dma_mask &= sa1111_dma_mask[drac >> 2];
526 }
527
528 #endif
529
530 static void sa1111_dev_release(struct device *_dev)
531 {
532         struct sa1111_dev *dev = SA1111_DEV(_dev);
533
534         release_resource(&dev->res);
535         kfree(dev);
536 }
537
538 static int
539 sa1111_init_one_child(struct sa1111 *sachip, struct resource *parent,
540                       struct sa1111_dev_info *info)
541 {
542         struct sa1111_dev *dev;
543         int ret;
544
545         dev = kzalloc(sizeof(struct sa1111_dev), GFP_KERNEL);
546         if (!dev) {
547                 ret = -ENOMEM;
548                 goto out;
549         }
550
551         snprintf(dev->dev.bus_id, sizeof(dev->dev.bus_id),
552                  "%4.4lx", info->offset);
553
554         dev->devid       = info->devid;
555         dev->dev.parent  = sachip->dev;
556         dev->dev.bus     = &sa1111_bus_type;
557         dev->dev.release = sa1111_dev_release;
558         dev->dev.coherent_dma_mask = sachip->dev->coherent_dma_mask;
559         dev->res.start   = sachip->phys + info->offset;
560         dev->res.end     = dev->res.start + 511;
561         dev->res.name    = dev->dev.bus_id;
562         dev->res.flags   = IORESOURCE_MEM;
563         dev->mapbase     = sachip->base + info->offset;
564         dev->skpcr_mask  = info->skpcr_mask;
565         memmove(dev->irq, info->irq, sizeof(dev->irq));
566
567         ret = request_resource(parent, &dev->res);
568         if (ret) {
569                 printk("SA1111: failed to allocate resource for %s\n",
570                         dev->res.name);
571                 kfree(dev);
572                 goto out;
573         }
574
575
576         ret = device_register(&dev->dev);
577         if (ret) {
578                 release_resource(&dev->res);
579                 kfree(dev);
580                 goto out;
581         }
582
583         /*
584          * If the parent device has a DMA mask associated with it,
585          * propagate it down to the children.
586          */
587         if (sachip->dev->dma_mask) {
588                 dev->dma_mask = *sachip->dev->dma_mask;
589                 dev->dev.dma_mask = &dev->dma_mask;
590
591                 if (dev->dma_mask != 0xffffffffUL) {
592                         ret = dmabounce_register_dev(&dev->dev, 1024, 4096);
593                         if (ret) {
594                                 printk("SA1111: Failed to register %s with dmabounce", dev->dev.bus_id);
595                                 device_unregister(&dev->dev);
596                         }
597                 }
598         }
599
600 out:
601         return ret;
602 }
603
604 /**
605  *      sa1111_probe - probe for a single SA1111 chip.
606  *      @phys_addr: physical address of device.
607  *
608  *      Probe for a SA1111 chip.  This must be called
609  *      before any other SA1111-specific code.
610  *
611  *      Returns:
612  *      %-ENODEV        device not found.
613  *      %-EBUSY         physical address already marked in-use.
614  *      %0              successful.
615  */
616 static int
617 __sa1111_probe(struct device *me, struct resource *mem, int irq)
618 {
619         struct sa1111 *sachip;
620         unsigned long id;
621         unsigned int has_devs, val;
622         int i, ret = -ENODEV;
623
624         sachip = kzalloc(sizeof(struct sa1111), GFP_KERNEL);
625         if (!sachip)
626                 return -ENOMEM;
627
628         sachip->clk = clk_get(me, "GPIO27_CLK");
629         if (!sachip->clk) {
630                 ret = PTR_ERR(sachip->clk);
631                 goto err_free;
632         }
633
634         spin_lock_init(&sachip->lock);
635
636         sachip->dev = me;
637         dev_set_drvdata(sachip->dev, sachip);
638
639         sachip->phys = mem->start;
640         sachip->irq = irq;
641
642         /*
643          * Map the whole region.  This also maps the
644          * registers for our children.
645          */
646         sachip->base = ioremap(mem->start, PAGE_SIZE * 2);
647         if (!sachip->base) {
648                 ret = -ENOMEM;
649                 goto err_clkput;
650         }
651
652         /*
653          * Probe for the chip.  Only touch the SBI registers.
654          */
655         id = sa1111_readl(sachip->base + SA1111_SKID);
656         if ((id & SKID_ID_MASK) != SKID_SA1111_ID) {
657                 printk(KERN_DEBUG "SA1111 not detected: ID = %08lx\n", id);
658                 ret = -ENODEV;
659                 goto err_unmap;
660         }
661
662         printk(KERN_INFO "SA1111 Microprocessor Companion Chip: "
663                 "silicon revision %lx, metal revision %lx\n",
664                 (id & SKID_SIREV_MASK)>>4, (id & SKID_MTREV_MASK));
665
666         /*
667          * We found it.  Wake the chip up, and initialise.
668          */
669         sa1111_wake(sachip);
670
671 #ifdef CONFIG_ARCH_SA1100
672         /*
673          * The SDRAM configuration of the SA1110 and the SA1111 must
674          * match.  This is very important to ensure that SA1111 accesses
675          * don't corrupt the SDRAM.  Note that this ungates the SA1111's
676          * MBGNT signal, so we must have called sa1110_mb_disable()
677          * beforehand.
678          */
679         sa1111_configure_smc(sachip, 1,
680                              FExtr(MDCNFG, MDCNFG_SA1110_DRAC0),
681                              FExtr(MDCNFG, MDCNFG_SA1110_TDL0));
682
683         /*
684          * We only need to turn on DCLK whenever we want to use the
685          * DMA.  It can otherwise be held firmly in the off position.
686          * (currently, we always enable it.)
687          */
688         val = sa1111_readl(sachip->base + SA1111_SKPCR);
689         sa1111_writel(val | SKPCR_DCLKEN, sachip->base + SA1111_SKPCR);
690
691         /*
692          * Enable the SA1110 memory bus request and grant signals.
693          */
694         sa1110_mb_enable();
695 #endif
696
697         /*
698          * The interrupt controller must be initialised before any
699          * other device to ensure that the interrupts are available.
700          */
701         if (sachip->irq != NO_IRQ)
702                 sa1111_setup_irq(sachip);
703
704         g_sa1111 = sachip;
705
706         has_devs = ~0;
707         if (machine_is_assabet() || machine_is_jornada720() ||
708             machine_is_badge4())
709                 has_devs &= ~(1 << 4);
710         else
711                 has_devs &= ~(1 << 1);
712
713         for (i = 0; i < ARRAY_SIZE(sa1111_devices); i++)
714                 if (has_devs & (1 << i))
715                         sa1111_init_one_child(sachip, mem, &sa1111_devices[i]);
716
717         return 0;
718
719  err_unmap:
720         iounmap(sachip->base);
721  err_clkput:
722         clk_put(sachip->clk);
723  err_free:
724         kfree(sachip);
725         return ret;
726 }
727
728 static int sa1111_remove_one(struct device *dev, void *data)
729 {
730         device_unregister(dev);
731         return 0;
732 }
733
734 static void __sa1111_remove(struct sa1111 *sachip)
735 {
736         void __iomem *irqbase = sachip->base + SA1111_INTC;
737
738         device_for_each_child(sachip->dev, NULL, sa1111_remove_one);
739
740         /* disable all IRQs */
741         sa1111_writel(0, irqbase + SA1111_INTEN0);
742         sa1111_writel(0, irqbase + SA1111_INTEN1);
743         sa1111_writel(0, irqbase + SA1111_WAKEEN0);
744         sa1111_writel(0, irqbase + SA1111_WAKEEN1);
745
746         clk_disable(sachip->clk);
747
748         if (sachip->irq != NO_IRQ) {
749                 set_irq_chained_handler(sachip->irq, NULL);
750                 set_irq_data(sachip->irq, NULL);
751
752                 release_mem_region(sachip->phys + SA1111_INTC, 512);
753         }
754
755         iounmap(sachip->base);
756         clk_put(sachip->clk);
757         kfree(sachip);
758 }
759
760 /*
761  * According to the "Intel StrongARM SA-1111 Microprocessor Companion
762  * Chip Specification Update" (June 2000), erratum #7, there is a
763  * significant bug in the SA1111 SDRAM shared memory controller.  If
764  * an access to a region of memory above 1MB relative to the bank base,
765  * it is important that address bit 10 _NOT_ be asserted. Depending
766  * on the configuration of the RAM, bit 10 may correspond to one
767  * of several different (processor-relative) address bits.
768  *
769  * This routine only identifies whether or not a given DMA address
770  * is susceptible to the bug.
771  *
772  * This should only get called for sa1111_device types due to the
773  * way we configure our device dma_masks.
774  */
775 int dma_needs_bounce(struct device *dev, dma_addr_t addr, size_t size)
776 {
777         /*
778          * Section 4.6 of the "Intel StrongARM SA-1111 Development Module
779          * User's Guide" mentions that jumpers R51 and R52 control the
780          * target of SA-1111 DMA (either SDRAM bank 0 on Assabet, or
781          * SDRAM bank 1 on Neponset). The default configuration selects
782          * Assabet, so any address in bank 1 is necessarily invalid.
783          */
784         return ((machine_is_assabet() || machine_is_pfs168()) &&
785                 (addr >= 0xc8000000 || (addr + size) >= 0xc8000000));
786 }
787
788 struct sa1111_save_data {
789         unsigned int    skcr;
790         unsigned int    skpcr;
791         unsigned int    skcdr;
792         unsigned char   skaud;
793         unsigned char   skpwm0;
794         unsigned char   skpwm1;
795
796         /*
797          * Interrupt controller
798          */
799         unsigned int    intpol0;
800         unsigned int    intpol1;
801         unsigned int    inten0;
802         unsigned int    inten1;
803         unsigned int    wakepol0;
804         unsigned int    wakepol1;
805         unsigned int    wakeen0;
806         unsigned int    wakeen1;
807 };
808
809 #ifdef CONFIG_PM
810
811 static int sa1111_suspend(struct platform_device *dev, pm_message_t state)
812 {
813         struct sa1111 *sachip = platform_get_drvdata(dev);
814         struct sa1111_save_data *save;
815         unsigned long flags;
816         unsigned int val;
817         void __iomem *base;
818
819         save = kmalloc(sizeof(struct sa1111_save_data), GFP_KERNEL);
820         if (!save)
821                 return -ENOMEM;
822         dev->dev.power.saved_state = save;
823
824         spin_lock_irqsave(&sachip->lock, flags);
825
826         /*
827          * Save state.
828          */
829         base = sachip->base;
830         save->skcr     = sa1111_readl(base + SA1111_SKCR);
831         save->skpcr    = sa1111_readl(base + SA1111_SKPCR);
832         save->skcdr    = sa1111_readl(base + SA1111_SKCDR);
833         save->skaud    = sa1111_readl(base + SA1111_SKAUD);
834         save->skpwm0   = sa1111_readl(base + SA1111_SKPWM0);
835         save->skpwm1   = sa1111_readl(base + SA1111_SKPWM1);
836
837         base = sachip->base + SA1111_INTC;
838         save->intpol0  = sa1111_readl(base + SA1111_INTPOL0);
839         save->intpol1  = sa1111_readl(base + SA1111_INTPOL1);
840         save->inten0   = sa1111_readl(base + SA1111_INTEN0);
841         save->inten1   = sa1111_readl(base + SA1111_INTEN1);
842         save->wakepol0 = sa1111_readl(base + SA1111_WAKEPOL0);
843         save->wakepol1 = sa1111_readl(base + SA1111_WAKEPOL1);
844         save->wakeen0  = sa1111_readl(base + SA1111_WAKEEN0);
845         save->wakeen1  = sa1111_readl(base + SA1111_WAKEEN1);
846
847         /*
848          * Disable.
849          */
850         val = sa1111_readl(sachip->base + SA1111_SKCR);
851         sa1111_writel(val | SKCR_SLEEP, sachip->base + SA1111_SKCR);
852         sa1111_writel(0, sachip->base + SA1111_SKPWM0);
853         sa1111_writel(0, sachip->base + SA1111_SKPWM1);
854
855         clk_disable(sachip->clk);
856
857         spin_unlock_irqrestore(&sachip->lock, flags);
858
859         return 0;
860 }
861
862 /*
863  *      sa1111_resume - Restore the SA1111 device state.
864  *      @dev: device to restore
865  *
866  *      Restore the general state of the SA1111; clock control and
867  *      interrupt controller.  Other parts of the SA1111 must be
868  *      restored by their respective drivers, and must be called
869  *      via LDM after this function.
870  */
871 static int sa1111_resume(struct platform_device *dev)
872 {
873         struct sa1111 *sachip = platform_get_drvdata(dev);
874         struct sa1111_save_data *save;
875         unsigned long flags, id;
876         void __iomem *base;
877
878         save = (struct sa1111_save_data *)dev->dev.power.saved_state;
879         if (!save)
880                 return 0;
881
882         spin_lock_irqsave(&sachip->lock, flags);
883
884         /*
885          * Ensure that the SA1111 is still here.
886          * FIXME: shouldn't do this here.
887          */
888         id = sa1111_readl(sachip->base + SA1111_SKID);
889         if ((id & SKID_ID_MASK) != SKID_SA1111_ID) {
890                 __sa1111_remove(sachip);
891                 platform_set_drvdata(dev, NULL);
892                 kfree(save);
893                 return 0;
894         }
895
896         /*
897          * First of all, wake up the chip.
898          */
899         sa1111_wake(sachip);
900         sa1111_writel(0, sachip->base + SA1111_INTC + SA1111_INTEN0);
901         sa1111_writel(0, sachip->base + SA1111_INTC + SA1111_INTEN1);
902
903         base = sachip->base;
904         sa1111_writel(save->skcr,     base + SA1111_SKCR);
905         sa1111_writel(save->skpcr,    base + SA1111_SKPCR);
906         sa1111_writel(save->skcdr,    base + SA1111_SKCDR);
907         sa1111_writel(save->skaud,    base + SA1111_SKAUD);
908         sa1111_writel(save->skpwm0,   base + SA1111_SKPWM0);
909         sa1111_writel(save->skpwm1,   base + SA1111_SKPWM1);
910
911         base = sachip->base + SA1111_INTC;
912         sa1111_writel(save->intpol0,  base + SA1111_INTPOL0);
913         sa1111_writel(save->intpol1,  base + SA1111_INTPOL1);
914         sa1111_writel(save->inten0,   base + SA1111_INTEN0);
915         sa1111_writel(save->inten1,   base + SA1111_INTEN1);
916         sa1111_writel(save->wakepol0, base + SA1111_WAKEPOL0);
917         sa1111_writel(save->wakepol1, base + SA1111_WAKEPOL1);
918         sa1111_writel(save->wakeen0,  base + SA1111_WAKEEN0);
919         sa1111_writel(save->wakeen1,  base + SA1111_WAKEEN1);
920
921         spin_unlock_irqrestore(&sachip->lock, flags);
922
923         dev->dev.power.saved_state = NULL;
924         kfree(save);
925
926         return 0;
927 }
928
929 #else
930 #define sa1111_suspend NULL
931 #define sa1111_resume  NULL
932 #endif
933
934 static int sa1111_probe(struct platform_device *pdev)
935 {
936         struct resource *mem;
937         int irq;
938
939         mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
940         if (!mem)
941                 return -EINVAL;
942         irq = platform_get_irq(pdev, 0);
943         if (irq < 0)
944                 return -ENXIO;
945
946         return __sa1111_probe(&pdev->dev, mem, irq);
947 }
948
949 static int sa1111_remove(struct platform_device *pdev)
950 {
951         struct sa1111 *sachip = platform_get_drvdata(pdev);
952
953         if (sachip) {
954                 __sa1111_remove(sachip);
955                 platform_set_drvdata(pdev, NULL);
956
957 #ifdef CONFIG_PM
958                 kfree(pdev->dev.power.saved_state);
959                 pdev->dev.power.saved_state = NULL;
960 #endif
961         }
962
963         return 0;
964 }
965
966 /*
967  *      Not sure if this should be on the system bus or not yet.
968  *      We really want some way to register a system device at
969  *      the per-machine level, and then have this driver pick
970  *      up the registered devices.
971  *
972  *      We also need to handle the SDRAM configuration for
973  *      PXA250/SA1110 machine classes.
974  */
975 static struct platform_driver sa1111_device_driver = {
976         .probe          = sa1111_probe,
977         .remove         = sa1111_remove,
978         .suspend        = sa1111_suspend,
979         .resume         = sa1111_resume,
980         .driver         = {
981                 .name   = "sa1111",
982         },
983 };
984
985 /*
986  *      Get the parent device driver (us) structure
987  *      from a child function device
988  */
989 static inline struct sa1111 *sa1111_chip_driver(struct sa1111_dev *sadev)
990 {
991         return (struct sa1111 *)dev_get_drvdata(sadev->dev.parent);
992 }
993
994 /*
995  * The bits in the opdiv field are non-linear.
996  */
997 static unsigned char opdiv_table[] = { 1, 4, 2, 8 };
998
999 static unsigned int __sa1111_pll_clock(struct sa1111 *sachip)
1000 {
1001         unsigned int skcdr, fbdiv, ipdiv, opdiv;
1002
1003         skcdr = sa1111_readl(sachip->base + SA1111_SKCDR);
1004
1005         fbdiv = (skcdr & 0x007f) + 2;
1006         ipdiv = ((skcdr & 0x0f80) >> 7) + 2;
1007         opdiv = opdiv_table[(skcdr & 0x3000) >> 12];
1008
1009         return 3686400 * fbdiv / (ipdiv * opdiv);
1010 }
1011
1012 /**
1013  *      sa1111_pll_clock - return the current PLL clock frequency.
1014  *      @sadev: SA1111 function block
1015  *
1016  *      BUG: we should look at SKCR.  We also blindly believe that
1017  *      the chip is being fed with the 3.6864MHz clock.
1018  *
1019  *      Returns the PLL clock in Hz.
1020  */
1021 unsigned int sa1111_pll_clock(struct sa1111_dev *sadev)
1022 {
1023         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1024
1025         return __sa1111_pll_clock(sachip);
1026 }
1027
1028 /**
1029  *      sa1111_select_audio_mode - select I2S or AC link mode
1030  *      @sadev: SA1111 function block
1031  *      @mode: One of %SA1111_AUDIO_ACLINK or %SA1111_AUDIO_I2S
1032  *
1033  *      Frob the SKCR to select AC Link mode or I2S mode for
1034  *      the audio block.
1035  */
1036 void sa1111_select_audio_mode(struct sa1111_dev *sadev, int mode)
1037 {
1038         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1039         unsigned long flags;
1040         unsigned int val;
1041
1042         spin_lock_irqsave(&sachip->lock, flags);
1043
1044         val = sa1111_readl(sachip->base + SA1111_SKCR);
1045         if (mode == SA1111_AUDIO_I2S) {
1046                 val &= ~SKCR_SELAC;
1047         } else {
1048                 val |= SKCR_SELAC;
1049         }
1050         sa1111_writel(val, sachip->base + SA1111_SKCR);
1051
1052         spin_unlock_irqrestore(&sachip->lock, flags);
1053 }
1054
1055 /**
1056  *      sa1111_set_audio_rate - set the audio sample rate
1057  *      @sadev: SA1111 SAC function block
1058  *      @rate: sample rate to select
1059  */
1060 int sa1111_set_audio_rate(struct sa1111_dev *sadev, int rate)
1061 {
1062         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1063         unsigned int div;
1064
1065         if (sadev->devid != SA1111_DEVID_SAC)
1066                 return -EINVAL;
1067
1068         div = (__sa1111_pll_clock(sachip) / 256 + rate / 2) / rate;
1069         if (div == 0)
1070                 div = 1;
1071         if (div > 128)
1072                 div = 128;
1073
1074         sa1111_writel(div - 1, sachip->base + SA1111_SKAUD);
1075
1076         return 0;
1077 }
1078
1079 /**
1080  *      sa1111_get_audio_rate - get the audio sample rate
1081  *      @sadev: SA1111 SAC function block device
1082  */
1083 int sa1111_get_audio_rate(struct sa1111_dev *sadev)
1084 {
1085         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1086         unsigned long div;
1087
1088         if (sadev->devid != SA1111_DEVID_SAC)
1089                 return -EINVAL;
1090
1091         div = sa1111_readl(sachip->base + SA1111_SKAUD) + 1;
1092
1093         return __sa1111_pll_clock(sachip) / (256 * div);
1094 }
1095
1096 void sa1111_set_io_dir(struct sa1111_dev *sadev,
1097                        unsigned int bits, unsigned int dir,
1098                        unsigned int sleep_dir)
1099 {
1100         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1101         unsigned long flags;
1102         unsigned int val;
1103         void __iomem *gpio = sachip->base + SA1111_GPIO;
1104
1105 #define MODIFY_BITS(port, mask, dir)            \
1106         if (mask) {                             \
1107                 val = sa1111_readl(port);       \
1108                 val &= ~(mask);                 \
1109                 val |= (dir) & (mask);          \
1110                 sa1111_writel(val, port);       \
1111         }
1112
1113         spin_lock_irqsave(&sachip->lock, flags);
1114         MODIFY_BITS(gpio + SA1111_GPIO_PADDR, bits & 15, dir);
1115         MODIFY_BITS(gpio + SA1111_GPIO_PBDDR, (bits >> 8) & 255, dir >> 8);
1116         MODIFY_BITS(gpio + SA1111_GPIO_PCDDR, (bits >> 16) & 255, dir >> 16);
1117
1118         MODIFY_BITS(gpio + SA1111_GPIO_PASDR, bits & 15, sleep_dir);
1119         MODIFY_BITS(gpio + SA1111_GPIO_PBSDR, (bits >> 8) & 255, sleep_dir >> 8);
1120         MODIFY_BITS(gpio + SA1111_GPIO_PCSDR, (bits >> 16) & 255, sleep_dir >> 16);
1121         spin_unlock_irqrestore(&sachip->lock, flags);
1122 }
1123
1124 void sa1111_set_io(struct sa1111_dev *sadev, unsigned int bits, unsigned int v)
1125 {
1126         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1127         unsigned long flags;
1128         unsigned int val;
1129         void __iomem *gpio = sachip->base + SA1111_GPIO;
1130
1131         spin_lock_irqsave(&sachip->lock, flags);
1132         MODIFY_BITS(gpio + SA1111_GPIO_PADWR, bits & 15, v);
1133         MODIFY_BITS(gpio + SA1111_GPIO_PBDWR, (bits >> 8) & 255, v >> 8);
1134         MODIFY_BITS(gpio + SA1111_GPIO_PCDWR, (bits >> 16) & 255, v >> 16);
1135         spin_unlock_irqrestore(&sachip->lock, flags);
1136 }
1137
1138 void sa1111_set_sleep_io(struct sa1111_dev *sadev, unsigned int bits, unsigned int v)
1139 {
1140         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1141         unsigned long flags;
1142         unsigned int val;
1143         void __iomem *gpio = sachip->base + SA1111_GPIO;
1144
1145         spin_lock_irqsave(&sachip->lock, flags);
1146         MODIFY_BITS(gpio + SA1111_GPIO_PASSR, bits & 15, v);
1147         MODIFY_BITS(gpio + SA1111_GPIO_PBSSR, (bits >> 8) & 255, v >> 8);
1148         MODIFY_BITS(gpio + SA1111_GPIO_PCSSR, (bits >> 16) & 255, v >> 16);
1149         spin_unlock_irqrestore(&sachip->lock, flags);
1150 }
1151
1152 /*
1153  * Individual device operations.
1154  */
1155
1156 /**
1157  *      sa1111_enable_device - enable an on-chip SA1111 function block
1158  *      @sadev: SA1111 function block device to enable
1159  */
1160 void sa1111_enable_device(struct sa1111_dev *sadev)
1161 {
1162         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1163         unsigned long flags;
1164         unsigned int val;
1165
1166         spin_lock_irqsave(&sachip->lock, flags);
1167         val = sa1111_readl(sachip->base + SA1111_SKPCR);
1168         sa1111_writel(val | sadev->skpcr_mask, sachip->base + SA1111_SKPCR);
1169         spin_unlock_irqrestore(&sachip->lock, flags);
1170 }
1171
1172 /**
1173  *      sa1111_disable_device - disable an on-chip SA1111 function block
1174  *      @sadev: SA1111 function block device to disable
1175  */
1176 void sa1111_disable_device(struct sa1111_dev *sadev)
1177 {
1178         struct sa1111 *sachip = sa1111_chip_driver(sadev);
1179         unsigned long flags;
1180         unsigned int val;
1181
1182         spin_lock_irqsave(&sachip->lock, flags);
1183         val = sa1111_readl(sachip->base + SA1111_SKPCR);
1184         sa1111_writel(val & ~sadev->skpcr_mask, sachip->base + SA1111_SKPCR);
1185         spin_unlock_irqrestore(&sachip->lock, flags);
1186 }
1187
1188 /*
1189  *      SA1111 "Register Access Bus."
1190  *
1191  *      We model this as a regular bus type, and hang devices directly
1192  *      off this.
1193  */
1194 static int sa1111_match(struct device *_dev, struct device_driver *_drv)
1195 {
1196         struct sa1111_dev *dev = SA1111_DEV(_dev);
1197         struct sa1111_driver *drv = SA1111_DRV(_drv);
1198
1199         return dev->devid == drv->devid;
1200 }
1201
1202 static int sa1111_bus_suspend(struct device *dev, pm_message_t state)
1203 {
1204         struct sa1111_dev *sadev = SA1111_DEV(dev);
1205         struct sa1111_driver *drv = SA1111_DRV(dev->driver);
1206         int ret = 0;
1207
1208         if (drv && drv->suspend)
1209                 ret = drv->suspend(sadev, state);
1210         return ret;
1211 }
1212
1213 static int sa1111_bus_resume(struct device *dev)
1214 {
1215         struct sa1111_dev *sadev = SA1111_DEV(dev);
1216         struct sa1111_driver *drv = SA1111_DRV(dev->driver);
1217         int ret = 0;
1218
1219         if (drv && drv->resume)
1220                 ret = drv->resume(sadev);
1221         return ret;
1222 }
1223
1224 static int sa1111_bus_probe(struct device *dev)
1225 {
1226         struct sa1111_dev *sadev = SA1111_DEV(dev);
1227         struct sa1111_driver *drv = SA1111_DRV(dev->driver);
1228         int ret = -ENODEV;
1229
1230         if (drv->probe)
1231                 ret = drv->probe(sadev);
1232         return ret;
1233 }
1234
1235 static int sa1111_bus_remove(struct device *dev)
1236 {
1237         struct sa1111_dev *sadev = SA1111_DEV(dev);
1238         struct sa1111_driver *drv = SA1111_DRV(dev->driver);
1239         int ret = 0;
1240
1241         if (drv->remove)
1242                 ret = drv->remove(sadev);
1243         return ret;
1244 }
1245
1246 struct bus_type sa1111_bus_type = {
1247         .name           = "sa1111-rab",
1248         .match          = sa1111_match,
1249         .probe          = sa1111_bus_probe,
1250         .remove         = sa1111_bus_remove,
1251         .suspend        = sa1111_bus_suspend,
1252         .resume         = sa1111_bus_resume,
1253 };
1254
1255 int sa1111_driver_register(struct sa1111_driver *driver)
1256 {
1257         driver->drv.bus = &sa1111_bus_type;
1258         return driver_register(&driver->drv);
1259 }
1260
1261 void sa1111_driver_unregister(struct sa1111_driver *driver)
1262 {
1263         driver_unregister(&driver->drv);
1264 }
1265
1266 static int __init sa1111_init(void)
1267 {
1268         int ret = bus_register(&sa1111_bus_type);
1269         if (ret == 0)
1270                 platform_driver_register(&sa1111_device_driver);
1271         return ret;
1272 }
1273
1274 static void __exit sa1111_exit(void)
1275 {
1276         platform_driver_unregister(&sa1111_device_driver);
1277         bus_unregister(&sa1111_bus_type);
1278 }
1279
1280 subsys_initcall(sa1111_init);
1281 module_exit(sa1111_exit);
1282
1283 MODULE_DESCRIPTION("Intel Corporation SA1111 core driver");
1284 MODULE_LICENSE("GPL");
1285
1286 EXPORT_SYMBOL(sa1111_select_audio_mode);
1287 EXPORT_SYMBOL(sa1111_set_audio_rate);
1288 EXPORT_SYMBOL(sa1111_get_audio_rate);
1289 EXPORT_SYMBOL(sa1111_set_io_dir);
1290 EXPORT_SYMBOL(sa1111_set_io);
1291 EXPORT_SYMBOL(sa1111_set_sleep_io);
1292 EXPORT_SYMBOL(sa1111_enable_device);
1293 EXPORT_SYMBOL(sa1111_disable_device);
1294 EXPORT_SYMBOL(sa1111_pll_clock);
1295 EXPORT_SYMBOL(sa1111_bus_type);
1296 EXPORT_SYMBOL(sa1111_driver_register);
1297 EXPORT_SYMBOL(sa1111_driver_unregister);