8250.c: less than 2400 baud fix.
[linux-2.6.git] / drivers / ide / palm_bk3710.c
1 /*
2  * Palmchip bk3710 IDE controller
3  *
4  * Copyright (C) 2006 Texas Instruments.
5  * Copyright (C) 2007 MontaVista Software, Inc., <source@mvista.com>
6  *
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., 675 Mass Ave, Cambridge, MA 02139, USA.
22  * ----------------------------------------------------------------------------
23  *
24  */
25
26 #include <linux/types.h>
27 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/ioport.h>
30 #include <linux/ide.h>
31 #include <linux/delay.h>
32 #include <linux/init.h>
33 #include <linux/clk.h>
34 #include <linux/platform_device.h>
35
36 /* Offset of the primary interface registers */
37 #define IDE_PALM_ATA_PRI_REG_OFFSET 0x1F0
38
39 /* Primary Control Offset */
40 #define IDE_PALM_ATA_PRI_CTL_OFFSET 0x3F6
41
42 #define BK3710_BMICP            0x00
43 #define BK3710_BMISP            0x02
44 #define BK3710_BMIDTP           0x04
45 #define BK3710_IDETIMP          0x40
46 #define BK3710_IDESTATUS        0x47
47 #define BK3710_UDMACTL          0x48
48 #define BK3710_MISCCTL          0x50
49 #define BK3710_REGSTB           0x54
50 #define BK3710_REGRCVR          0x58
51 #define BK3710_DATSTB           0x5C
52 #define BK3710_DATRCVR          0x60
53 #define BK3710_DMASTB           0x64
54 #define BK3710_DMARCVR          0x68
55 #define BK3710_UDMASTB          0x6C
56 #define BK3710_UDMATRP          0x70
57 #define BK3710_UDMAENV          0x74
58 #define BK3710_IORDYTMP         0x78
59
60 static unsigned ideclk_period; /* in nanoseconds */
61
62 struct palm_bk3710_udmatiming {
63         unsigned int rptime;    /* tRP -- Ready to pause time (nsec) */
64         unsigned int cycletime; /* tCYCTYP2/2 -- avg Cycle Time (nsec) */
65                                 /* tENV is always a minimum of 20 nsec */
66 };
67
68 static const struct palm_bk3710_udmatiming palm_bk3710_udmatimings[6] = {
69         { 160, 240 / 2 },       /* UDMA Mode 0 */
70         { 125, 160 / 2 },       /* UDMA Mode 1 */
71         { 100, 120 / 2 },       /* UDMA Mode 2 */
72         { 100,  90 / 2 },       /* UDMA Mode 3 */
73         { 100,  60 / 2 },       /* UDMA Mode 4 */
74         {  85,  40 / 2 },       /* UDMA Mode 5 */
75 };
76
77 static void palm_bk3710_setudmamode(void __iomem *base, unsigned int dev,
78                                     unsigned int mode)
79 {
80         u8 tenv, trp, t0;
81         u32 val32;
82         u16 val16;
83
84         /* DMA Data Setup */
85         t0 = DIV_ROUND_UP(palm_bk3710_udmatimings[mode].cycletime,
86                           ideclk_period) - 1;
87         tenv = DIV_ROUND_UP(20, ideclk_period) - 1;
88         trp = DIV_ROUND_UP(palm_bk3710_udmatimings[mode].rptime,
89                            ideclk_period) - 1;
90
91         /* udmastb Ultra DMA Access Strobe Width */
92         val32 = readl(base + BK3710_UDMASTB) & (0xFF << (dev ? 0 : 8));
93         val32 |= (t0 << (dev ? 8 : 0));
94         writel(val32, base + BK3710_UDMASTB);
95
96         /* udmatrp Ultra DMA Ready to Pause Time */
97         val32 = readl(base + BK3710_UDMATRP) & (0xFF << (dev ? 0 : 8));
98         val32 |= (trp << (dev ? 8 : 0));
99         writel(val32, base + BK3710_UDMATRP);
100
101         /* udmaenv Ultra DMA envelop Time */
102         val32 = readl(base + BK3710_UDMAENV) & (0xFF << (dev ? 0 : 8));
103         val32 |= (tenv << (dev ? 8 : 0));
104         writel(val32, base + BK3710_UDMAENV);
105
106         /* Enable UDMA for Device */
107         val16 = readw(base + BK3710_UDMACTL) | (1 << dev);
108         writew(val16, base + BK3710_UDMACTL);
109 }
110
111 static void palm_bk3710_setdmamode(void __iomem *base, unsigned int dev,
112                                    unsigned short min_cycle,
113                                    unsigned int mode)
114 {
115         u8 td, tkw, t0;
116         u32 val32;
117         u16 val16;
118         struct ide_timing *t;
119         int cycletime;
120
121         t = ide_timing_find_mode(mode);
122         cycletime = max_t(int, t->cycle, min_cycle);
123
124         /* DMA Data Setup */
125         t0 = DIV_ROUND_UP(cycletime, ideclk_period);
126         td = DIV_ROUND_UP(t->active, ideclk_period);
127         tkw = t0 - td - 1;
128         td -= 1;
129
130         val32 = readl(base + BK3710_DMASTB) & (0xFF << (dev ? 0 : 8));
131         val32 |= (td << (dev ? 8 : 0));
132         writel(val32, base + BK3710_DMASTB);
133
134         val32 = readl(base + BK3710_DMARCVR) & (0xFF << (dev ? 0 : 8));
135         val32 |= (tkw << (dev ? 8 : 0));
136         writel(val32, base + BK3710_DMARCVR);
137
138         /* Disable UDMA for Device */
139         val16 = readw(base + BK3710_UDMACTL) & ~(1 << dev);
140         writew(val16, base + BK3710_UDMACTL);
141 }
142
143 static void palm_bk3710_setpiomode(void __iomem *base, ide_drive_t *mate,
144                                    unsigned int dev, unsigned int cycletime,
145                                    unsigned int mode)
146 {
147         u8 t2, t2i, t0;
148         u32 val32;
149         struct ide_timing *t;
150
151         t = ide_timing_find_mode(XFER_PIO_0 + mode);
152
153         /* PIO Data Setup */
154         t0 = DIV_ROUND_UP(cycletime, ideclk_period);
155         t2 = DIV_ROUND_UP(t->active, ideclk_period);
156
157         t2i = t0 - t2 - 1;
158         t2 -= 1;
159
160         val32 = readl(base + BK3710_DATSTB) & (0xFF << (dev ? 0 : 8));
161         val32 |= (t2 << (dev ? 8 : 0));
162         writel(val32, base + BK3710_DATSTB);
163
164         val32 = readl(base + BK3710_DATRCVR) & (0xFF << (dev ? 0 : 8));
165         val32 |= (t2i << (dev ? 8 : 0));
166         writel(val32, base + BK3710_DATRCVR);
167
168         if (mate) {
169                 u8 mode2 = mate->pio_mode - XFER_PIO_0;
170
171                 if (mode2 < mode)
172                         mode = mode2;
173         }
174
175         /* TASKFILE Setup */
176         t0 = DIV_ROUND_UP(t->cyc8b, ideclk_period);
177         t2 = DIV_ROUND_UP(t->act8b, ideclk_period);
178
179         t2i = t0 - t2 - 1;
180         t2 -= 1;
181
182         val32 = readl(base + BK3710_REGSTB) & (0xFF << (dev ? 0 : 8));
183         val32 |= (t2 << (dev ? 8 : 0));
184         writel(val32, base + BK3710_REGSTB);
185
186         val32 = readl(base + BK3710_REGRCVR) & (0xFF << (dev ? 0 : 8));
187         val32 |= (t2i << (dev ? 8 : 0));
188         writel(val32, base + BK3710_REGRCVR);
189 }
190
191 static void palm_bk3710_set_dma_mode(ide_hwif_t *hwif, ide_drive_t *drive)
192 {
193         int is_slave = drive->dn & 1;
194         void __iomem *base = (void *)hwif->dma_base;
195         const u8 xferspeed = drive->dma_mode;
196
197         if (xferspeed >= XFER_UDMA_0) {
198                 palm_bk3710_setudmamode(base, is_slave,
199                                         xferspeed - XFER_UDMA_0);
200         } else {
201                 palm_bk3710_setdmamode(base, is_slave,
202                                        drive->id[ATA_ID_EIDE_DMA_MIN],
203                                        xferspeed);
204         }
205 }
206
207 static void palm_bk3710_set_pio_mode(ide_hwif_t *hwif, ide_drive_t *drive)
208 {
209         unsigned int cycle_time;
210         int is_slave = drive->dn & 1;
211         ide_drive_t *mate;
212         void __iomem *base = (void *)hwif->dma_base;
213         const u8 pio = drive->pio_mode - XFER_PIO_0;
214
215         /*
216          * Obtain the drive PIO data for tuning the Palm Chip registers
217          */
218         cycle_time = ide_pio_cycle_time(drive, pio);
219         mate = ide_get_pair_dev(drive);
220         palm_bk3710_setpiomode(base, mate, is_slave, cycle_time, pio);
221 }
222
223 static void __devinit palm_bk3710_chipinit(void __iomem *base)
224 {
225         /*
226          * REVISIT:  the ATA reset signal needs to be managed through a
227          * GPIO, which means it should come from platform_data.  Until
228          * we get and use such information, we have to trust that things
229          * have been reset before we get here.
230          */
231
232         /*
233          * Program the IDETIMP Register Value based on the following assumptions
234          *
235          * (ATA_IDETIMP_IDEEN           , ENABLE ) |
236          * (ATA_IDETIMP_PREPOST1        , DISABLE) |
237          * (ATA_IDETIMP_PREPOST0        , DISABLE) |
238          *
239          * DM6446 silicon rev 2.1 and earlier have no observed net benefit
240          * from enabling prefetch/postwrite.
241          */
242         writew(BIT(15), base + BK3710_IDETIMP);
243
244         /*
245          * UDMACTL Ultra-ATA DMA Control
246          * (ATA_UDMACTL_UDMAP1  , 0 ) |
247          * (ATA_UDMACTL_UDMAP0  , 0 )
248          *
249          */
250         writew(0, base + BK3710_UDMACTL);
251
252         /*
253          * MISCCTL Miscellaneous Conrol Register
254          * (ATA_MISCCTL_HWNHLD1P        , 1 cycle)
255          * (ATA_MISCCTL_HWNHLD0P        , 1 cycle)
256          * (ATA_MISCCTL_TIMORIDE        , 1)
257          */
258         writel(0x001, base + BK3710_MISCCTL);
259
260         /*
261          * IORDYTMP IORDY Timer for Primary Register
262          * (ATA_IORDYTMP_IORDYTMP     , 0xffff  )
263          */
264         writel(0xFFFF, base + BK3710_IORDYTMP);
265
266         /*
267          * Configure BMISP Register
268          * (ATA_BMISP_DMAEN1    , DISABLE )     |
269          * (ATA_BMISP_DMAEN0    , DISABLE )     |
270          * (ATA_BMISP_IORDYINT  , CLEAR)        |
271          * (ATA_BMISP_INTRSTAT  , CLEAR)        |
272          * (ATA_BMISP_DMAERROR  , CLEAR)
273          */
274         writew(0, base + BK3710_BMISP);
275
276         palm_bk3710_setpiomode(base, NULL, 0, 600, 0);
277         palm_bk3710_setpiomode(base, NULL, 1, 600, 0);
278 }
279
280 static u8 palm_bk3710_cable_detect(ide_hwif_t *hwif)
281 {
282         return ATA_CBL_PATA80;
283 }
284
285 static int __devinit palm_bk3710_init_dma(ide_hwif_t *hwif,
286                                           const struct ide_port_info *d)
287 {
288         printk(KERN_INFO "    %s: MMIO-DMA\n", hwif->name);
289
290         if (ide_allocate_dma_engine(hwif))
291                 return -1;
292
293         hwif->dma_base = hwif->io_ports.data_addr - IDE_PALM_ATA_PRI_REG_OFFSET;
294
295         return 0;
296 }
297
298 static const struct ide_port_ops palm_bk3710_ports_ops = {
299         .set_pio_mode           = palm_bk3710_set_pio_mode,
300         .set_dma_mode           = palm_bk3710_set_dma_mode,
301         .cable_detect           = palm_bk3710_cable_detect,
302 };
303
304 static struct ide_port_info __devinitdata palm_bk3710_port_info = {
305         .init_dma               = palm_bk3710_init_dma,
306         .port_ops               = &palm_bk3710_ports_ops,
307         .dma_ops                = &sff_dma_ops,
308         .host_flags             = IDE_HFLAG_MMIO,
309         .pio_mask               = ATA_PIO4,
310         .mwdma_mask             = ATA_MWDMA2,
311         .chipset                = ide_palm3710,
312 };
313
314 static int __init palm_bk3710_probe(struct platform_device *pdev)
315 {
316         struct clk *clk;
317         struct resource *mem, *irq;
318         void __iomem *base;
319         unsigned long rate, mem_size;
320         int i, rc;
321         struct ide_hw hw, *hws[] = { &hw };
322
323         clk = clk_get(&pdev->dev, NULL);
324         if (IS_ERR(clk))
325                 return -ENODEV;
326
327         clk_enable(clk);
328         rate = clk_get_rate(clk);
329
330         /* NOTE:  round *down* to meet minimum timings; we count in clocks */
331         ideclk_period = 1000000000UL / rate;
332
333         mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
334         if (mem == NULL) {
335                 printk(KERN_ERR "failed to get memory region resource\n");
336                 return -ENODEV;
337         }
338
339         irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
340         if (irq == NULL) {
341                 printk(KERN_ERR "failed to get IRQ resource\n");
342                 return -ENODEV;
343         }
344
345         mem_size = resource_size(mem);
346         if (request_mem_region(mem->start, mem_size, "palm_bk3710") == NULL) {
347                 printk(KERN_ERR "failed to request memory region\n");
348                 return -EBUSY;
349         }
350
351         base = ioremap(mem->start, mem_size);
352         if (!base) {
353                 printk(KERN_ERR "failed to map IO memory\n");
354                 release_mem_region(mem->start, mem_size);
355                 return -ENOMEM;
356         }
357
358         /* Configure the Palm Chip controller */
359         palm_bk3710_chipinit(base);
360
361         memset(&hw, 0, sizeof(hw));
362         for (i = 0; i < IDE_NR_PORTS - 2; i++)
363                 hw.io_ports_array[i] = (unsigned long)
364                                 (base + IDE_PALM_ATA_PRI_REG_OFFSET + i);
365         hw.io_ports.ctl_addr = (unsigned long)
366                         (base + IDE_PALM_ATA_PRI_CTL_OFFSET);
367         hw.irq = irq->start;
368         hw.dev = &pdev->dev;
369
370         palm_bk3710_port_info.udma_mask = rate < 100000000 ? ATA_UDMA4 :
371                                                              ATA_UDMA5;
372
373         /* Register the IDE interface with Linux */
374         rc = ide_host_add(&palm_bk3710_port_info, hws, 1, NULL);
375         if (rc)
376                 goto out;
377
378         return 0;
379 out:
380         printk(KERN_WARNING "Palm Chip BK3710 IDE Register Fail\n");
381         return rc;
382 }
383
384 /* work with hotplug and coldplug */
385 MODULE_ALIAS("platform:palm_bk3710");
386
387 static struct platform_driver platform_bk_driver = {
388         .driver = {
389                 .name = "palm_bk3710",
390                 .owner = THIS_MODULE,
391         },
392 };
393
394 static int __init palm_bk3710_init(void)
395 {
396         return platform_driver_probe(&platform_bk_driver, palm_bk3710_probe);
397 }
398
399 module_init(palm_bk3710_init);
400 MODULE_LICENSE("GPL");