?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
atm: iphase: Fix Spectre v1 vulnerability
[linux/fpc-iii.git] / drivers / ata / pata_atp867x.c
blob3ea50dc5ea47480d0cf81b5f69825b8675737070
1 /*
2 * pata_atp867x.c - ARTOP 867X 64bit 4-channel UDMA133 ATA controller driver
3 *
4 * (C) 2009 Google Inc. John(Jung-Ik) Lee <jilee@google.com>
5 *
6 * Per Atp867 data sheet rev 1.2, Acard.
7 * Based in part on early ide code from
8 * 2003-2004 by Eric Uhrhane, Google, Inc.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
24 *
25 * TODO:
26 * 1. RAID features [comparison, XOR, striping, mirroring, etc.]
27 */
28
29 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/pci.h>
32 #include <linux/blkdev.h>
33 #include <linux/delay.h>
34 #include <linux/device.h>
35 #include <linux/gfp.h>
36 #include <scsi/scsi_host.h>
37 #include <linux/libata.h>
38
39 #define DRV_NAME "pata_atp867x"
40 #define DRV_VERSION "0.7.5"
41
42 /*
43 * IO Registers
44 * Note that all runtime hot priv ports are cached in ap private_data
45 */
46
47 enum {
48 ATP867X_IO_CHANNEL_OFFSET = 0x10,
49
50 /*
51 * IO Register Bitfields
52 */
53
54 ATP867X_IO_PIOSPD_ACTIVE_SHIFT = 4,
55 ATP867X_IO_PIOSPD_RECOVER_SHIFT = 0,
56
57 ATP867X_IO_DMAMODE_MSTR_SHIFT = 0,
58 ATP867X_IO_DMAMODE_MSTR_MASK = 0x07,
59 ATP867X_IO_DMAMODE_SLAVE_SHIFT = 4,
60 ATP867X_IO_DMAMODE_SLAVE_MASK = 0x70,
61
62 ATP867X_IO_DMAMODE_UDMA_6 = 0x07,
63 ATP867X_IO_DMAMODE_UDMA_5 = 0x06,
64 ATP867X_IO_DMAMODE_UDMA_4 = 0x05,
65 ATP867X_IO_DMAMODE_UDMA_3 = 0x04,
66 ATP867X_IO_DMAMODE_UDMA_2 = 0x03,
67 ATP867X_IO_DMAMODE_UDMA_1 = 0x02,
68 ATP867X_IO_DMAMODE_UDMA_0 = 0x01,
69 ATP867X_IO_DMAMODE_DISABLE = 0x00,
70
71 ATP867X_IO_SYS_INFO_66MHZ = 0x04,
72 ATP867X_IO_SYS_INFO_SLOW_UDMA5 = 0x02,
73 ATP867X_IO_SYS_MASK_RESERVED = (~0xf1),
74
75 ATP867X_IO_PORTSPD_VAL = 0x1143,
76 ATP867X_PREREAD_VAL = 0x0200,
77
78 ATP867X_NUM_PORTS = 4,
79 ATP867X_BAR_IOBASE = 0,
80 ATP867X_BAR_ROMBASE = 6,
81 };
82
83 #define ATP867X_IOBASE(ap) ((ap)->host->iomap[0])
84 #define ATP867X_SYS_INFO(ap) (0x3F + ATP867X_IOBASE(ap))
85
86 #define ATP867X_IO_PORTBASE(ap, port) (0x00 + ATP867X_IOBASE(ap) + \
87 (port) * ATP867X_IO_CHANNEL_OFFSET)
88 #define ATP867X_IO_DMABASE(ap, port) (0x40 + \
89 ATP867X_IO_PORTBASE((ap), (port)))
90
91 #define ATP867X_IO_STATUS(ap, port) (0x07 + \
92 ATP867X_IO_PORTBASE((ap), (port)))
93 #define ATP867X_IO_ALTSTATUS(ap, port) (0x0E + \
94 ATP867X_IO_PORTBASE((ap), (port)))
95
96 /*
97 * hot priv ports
98 */
99 #define ATP867X_IO_MSTRPIOSPD(ap, port) (0x08 + \
100 ATP867X_IO_DMABASE((ap), (port)))
101 #define ATP867X_IO_SLAVPIOSPD(ap, port) (0x09 + \
102 ATP867X_IO_DMABASE((ap), (port)))
103 #define ATP867X_IO_8BPIOSPD(ap, port) (0x0A + \
104 ATP867X_IO_DMABASE((ap), (port)))
105 #define ATP867X_IO_DMAMODE(ap, port) (0x0B + \
106 ATP867X_IO_DMABASE((ap), (port)))
107
108 #define ATP867X_IO_PORTSPD(ap, port) (0x4A + \
109 ATP867X_IO_PORTBASE((ap), (port)))
110 #define ATP867X_IO_PREREAD(ap, port) (0x4C + \
111 ATP867X_IO_PORTBASE((ap), (port)))
112
113 struct atp867x_priv {
114 void __iomem *dma_mode;
115 void __iomem *mstr_piospd;
116 void __iomem *slave_piospd;
117 void __iomem *eightb_piospd;
118 int pci66mhz;
119 };
120
121 static void atp867x_set_dmamode(struct ata_port *ap, struct ata_device *adev)
122 {
123 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
124 struct atp867x_priv *dp = ap->private_data;
125 u8 speed = adev->dma_mode;
126 u8 b;
127 u8 mode = speed - XFER_UDMA_0 + 1;
128
129 /*
130 * Doc 6.6.9: decrease the udma mode value by 1 for safer UDMA speed
131 * on 66MHz bus
132 * rev-A: UDMA_1~4 (5, 6 no change)
133 * rev-B: all UDMA modes
134 * UDMA_0 stays not to disable UDMA
135 */
136 if (dp->pci66mhz && mode > ATP867X_IO_DMAMODE_UDMA_0 &&
137 (pdev->device == PCI_DEVICE_ID_ARTOP_ATP867B ||
138 mode < ATP867X_IO_DMAMODE_UDMA_5))
139 mode--;
140
141 b = ioread8(dp->dma_mode);
142 if (adev->devno & 1) {
143 b = (b & ~ATP867X_IO_DMAMODE_SLAVE_MASK) |
144 (mode << ATP867X_IO_DMAMODE_SLAVE_SHIFT);
145 } else {
146 b = (b & ~ATP867X_IO_DMAMODE_MSTR_MASK) |
147 (mode << ATP867X_IO_DMAMODE_MSTR_SHIFT);
148 }
149 iowrite8(b, dp->dma_mode);
150 }
151
152 static int atp867x_get_active_clocks_shifted(struct ata_port *ap,
153 unsigned int clk)
154 {
155 struct atp867x_priv *dp = ap->private_data;
156 unsigned char clocks = clk;
157
158 /*
159 * Doc 6.6.9: increase the clock value by 1 for safer PIO speed
160 * on 66MHz bus
161 */
162 if (dp->pci66mhz)
163 clocks++;
164
165 switch (clocks) {
166 case 0:
167 clocks = 1;
168 break;
169 case 1 ... 6:
170 break;
171 default:
172 printk(KERN_WARNING "ATP867X: active %dclk is invalid. "
173 "Using 12clk.\n", clk);
174 case 9 ... 12:
175 clocks = 7; /* 12 clk */
176 break;
177 case 7:
178 case 8: /* default 8 clk */
179 clocks = 0;
180 goto active_clock_shift_done;
181 }
182
183 active_clock_shift_done:
184 return clocks << ATP867X_IO_PIOSPD_ACTIVE_SHIFT;
185 }
186
187 static int atp867x_get_recover_clocks_shifted(unsigned int clk)
188 {
189 unsigned char clocks = clk;
190
191 switch (clocks) {
192 case 0:
193 clocks = 1;
194 break;
195 case 1 ... 11:
196 break;
197 case 13:
198 case 14:
199 --clocks; /* by the spec */
200 break;
201 case 15:
202 break;
203 default:
204 printk(KERN_WARNING "ATP867X: recover %dclk is invalid. "
205 "Using default 12clk.\n", clk);
206 case 12: /* default 12 clk */
207 clocks = 0;
208 break;
209 }
210
211 return clocks << ATP867X_IO_PIOSPD_RECOVER_SHIFT;
212 }
213
214 static void atp867x_set_piomode(struct ata_port *ap, struct ata_device *adev)
215 {
216 struct ata_device *peer = ata_dev_pair(adev);
217 struct atp867x_priv *dp = ap->private_data;
218 u8 speed = adev->pio_mode;
219 struct ata_timing t, p;
220 int T, UT;
221 u8 b;
222
223 T = 1000000000 / 33333;
224 UT = T / 4;
225
226 ata_timing_compute(adev, speed, &t, T, UT);
227 if (peer && peer->pio_mode) {
228 ata_timing_compute(peer, peer->pio_mode, &p, T, UT);
229 ata_timing_merge(&p, &t, &t, ATA_TIMING_8BIT);
230 }
231
232 b = ioread8(dp->dma_mode);
233 if (adev->devno & 1)
234 b = (b & ~ATP867X_IO_DMAMODE_SLAVE_MASK);
235 else
236 b = (b & ~ATP867X_IO_DMAMODE_MSTR_MASK);
237 iowrite8(b, dp->dma_mode);
238
239 b = atp867x_get_active_clocks_shifted(ap, t.active) |
240 atp867x_get_recover_clocks_shifted(t.recover);
241
242 if (adev->devno & 1)
243 iowrite8(b, dp->slave_piospd);
244 else
245 iowrite8(b, dp->mstr_piospd);
246
247 b = atp867x_get_active_clocks_shifted(ap, t.act8b) |
248 atp867x_get_recover_clocks_shifted(t.rec8b);
249
250 iowrite8(b, dp->eightb_piospd);
251 }
252
253 static int atp867x_cable_override(struct pci_dev *pdev)
254 {
255 if (pdev->subsystem_vendor == PCI_VENDOR_ID_ARTOP &&
256 (pdev->subsystem_device == PCI_DEVICE_ID_ARTOP_ATP867A ||
257 pdev->subsystem_device == PCI_DEVICE_ID_ARTOP_ATP867B)) {
258 return 1;
259 }
260 return 0;
261 }
262
263 static int atp867x_cable_detect(struct ata_port *ap)
264 {
265 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
266
267 if (atp867x_cable_override(pdev))
268 return ATA_CBL_PATA40_SHORT;
269
270 return ATA_CBL_PATA_UNK;
271 }
272
273 static struct scsi_host_template atp867x_sht = {
274 ATA_BMDMA_SHT(DRV_NAME),
275 };
276
277 static struct ata_port_operations atp867x_ops = {
278 .inherits = &ata_bmdma_port_ops,
279 .cable_detect = atp867x_cable_detect,
280 .set_piomode = atp867x_set_piomode,
281 .set_dmamode = atp867x_set_dmamode,
282 };
283
284
285 #ifdef ATP867X_DEBUG
286 static void atp867x_check_res(struct pci_dev *pdev)
287 {
288 int i;
289 unsigned long start, len;
290
291 /* Check the PCI resources for this channel are enabled */
292 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
293 start = pci_resource_start(pdev, i);
294 len = pci_resource_len(pdev, i);
295 printk(KERN_DEBUG "ATP867X: resource start:len=%lx:%lx\n",
296 start, len);
297 }
298 }
299
300 static void atp867x_check_ports(struct ata_port *ap, int port)
301 {
302 struct ata_ioports *ioaddr = &ap->ioaddr;
303 struct atp867x_priv *dp = ap->private_data;
304
305 printk(KERN_DEBUG "ATP867X: port[%d] addresses\n"
306 " cmd_addr =0x%llx, 0x%llx\n"
307 " ctl_addr =0x%llx, 0x%llx\n"
308 " bmdma_addr =0x%llx, 0x%llx\n"
309 " data_addr =0x%llx\n"
310 " error_addr =0x%llx\n"
311 " feature_addr =0x%llx\n"
312 " nsect_addr =0x%llx\n"
313 " lbal_addr =0x%llx\n"
314 " lbam_addr =0x%llx\n"
315 " lbah_addr =0x%llx\n"
316 " device_addr =0x%llx\n"
317 " status_addr =0x%llx\n"
318 " command_addr =0x%llx\n"
319 " dp->dma_mode =0x%llx\n"
320 " dp->mstr_piospd =0x%llx\n"
321 " dp->slave_piospd =0x%llx\n"
322 " dp->eightb_piospd =0x%llx\n"
323 " dp->pci66mhz =0x%lx\n",
324 port,
325 (unsigned long long)ioaddr->cmd_addr,
326 (unsigned long long)ATP867X_IO_PORTBASE(ap, port),
327 (unsigned long long)ioaddr->ctl_addr,
328 (unsigned long long)ATP867X_IO_ALTSTATUS(ap, port),
329 (unsigned long long)ioaddr->bmdma_addr,
330 (unsigned long long)ATP867X_IO_DMABASE(ap, port),
331 (unsigned long long)ioaddr->data_addr,
332 (unsigned long long)ioaddr->error_addr,
333 (unsigned long long)ioaddr->feature_addr,
334 (unsigned long long)ioaddr->nsect_addr,
335 (unsigned long long)ioaddr->lbal_addr,
336 (unsigned long long)ioaddr->lbam_addr,
337 (unsigned long long)ioaddr->lbah_addr,
338 (unsigned long long)ioaddr->device_addr,
339 (unsigned long long)ioaddr->status_addr,
340 (unsigned long long)ioaddr->command_addr,
341 (unsigned long long)dp->dma_mode,
342 (unsigned long long)dp->mstr_piospd,
343 (unsigned long long)dp->slave_piospd,
344 (unsigned long long)dp->eightb_piospd,
345 (unsigned long)dp->pci66mhz);
346 }
347 #endif
348
349 static int atp867x_set_priv(struct ata_port *ap)
350 {
351 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
352 struct atp867x_priv *dp;
353 int port = ap->port_no;
354
355 dp = ap->private_data =
356 devm_kzalloc(&pdev->dev, sizeof(*dp), GFP_KERNEL);
357 if (dp == NULL)
358 return -ENOMEM;
359
360 dp->dma_mode = ATP867X_IO_DMAMODE(ap, port);
361 dp->mstr_piospd = ATP867X_IO_MSTRPIOSPD(ap, port);
362 dp->slave_piospd = ATP867X_IO_SLAVPIOSPD(ap, port);
363 dp->eightb_piospd = ATP867X_IO_8BPIOSPD(ap, port);
364
365 dp->pci66mhz =
366 ioread8(ATP867X_SYS_INFO(ap)) & ATP867X_IO_SYS_INFO_66MHZ;
367
368 return 0;
369 }
370
371 static void atp867x_fixup(struct ata_host *host)
372 {
373 struct pci_dev *pdev = to_pci_dev(host->dev);
374 struct ata_port *ap = host->ports[0];
375 int i;
376 u8 v;
377
378 /*
379 * Broken BIOS might not set latency high enough
380 */
381 pci_read_config_byte(pdev, PCI_LATENCY_TIMER, &v);
382 if (v < 0x80) {
383 v = 0x80;
384 pci_write_config_byte(pdev, PCI_LATENCY_TIMER, v);
385 printk(KERN_DEBUG "ATP867X: set latency timer of device %s"
386 " to %d\n", pci_name(pdev), v);
387 }
388
389 /*
390 * init 8bit io ports speed(0aaarrrr) to 43h and
391 * init udma modes of master/slave to 0/0(11h)
392 */
393 for (i = 0; i < ATP867X_NUM_PORTS; i++)
394 iowrite16(ATP867X_IO_PORTSPD_VAL, ATP867X_IO_PORTSPD(ap, i));
395
396 /*
397 * init PreREAD counts
398 */
399 for (i = 0; i < ATP867X_NUM_PORTS; i++)
400 iowrite16(ATP867X_PREREAD_VAL, ATP867X_IO_PREREAD(ap, i));
401
402 v = ioread8(ATP867X_IOBASE(ap) + 0x28);
403 v &= 0xcf; /* Enable INTA#: bit4=0 means enable */
404 v |= 0xc0; /* Enable PCI burst, MRM & not immediate interrupts */
405 iowrite8(v, ATP867X_IOBASE(ap) + 0x28);
406
407 /*
408 * Turn off the over clocked udma5 mode, only for Rev-B
409 */
410 v = ioread8(ATP867X_SYS_INFO(ap));
411 v &= ATP867X_IO_SYS_MASK_RESERVED;
412 if (pdev->device == PCI_DEVICE_ID_ARTOP_ATP867B)
413 v |= ATP867X_IO_SYS_INFO_SLOW_UDMA5;
414 iowrite8(v, ATP867X_SYS_INFO(ap));
415 }
416
417 static int atp867x_ata_pci_sff_init_host(struct ata_host *host)
418 {
419 struct device *gdev = host->dev;
420 struct pci_dev *pdev = to_pci_dev(gdev);
421 unsigned int mask = 0;
422 int i, rc;
423
424 /*
425 * do not map rombase
426 */
427 rc = pcim_iomap_regions(pdev, 1 << ATP867X_BAR_IOBASE, DRV_NAME);
428 if (rc == -EBUSY)
429 pcim_pin_device(pdev);
430 if (rc)
431 return rc;
432 host->iomap = pcim_iomap_table(pdev);
433
434 #ifdef ATP867X_DEBUG
435 atp867x_check_res(pdev);
436
437 for (i = 0; i < PCI_ROM_RESOURCE; i++)
438 printk(KERN_DEBUG "ATP867X: iomap[%d]=0x%llx\n", i,
439 (unsigned long long)(host->iomap[i]));
440 #endif
441
442 /*
443 * request, iomap BARs and init port addresses accordingly
444 */
445 for (i = 0; i < host->n_ports; i++) {
446 struct ata_port *ap = host->ports[i];
447 struct ata_ioports *ioaddr = &ap->ioaddr;
448
449 ioaddr->cmd_addr = ATP867X_IO_PORTBASE(ap, i);
450 ioaddr->ctl_addr = ioaddr->altstatus_addr
451 = ATP867X_IO_ALTSTATUS(ap, i);
452 ioaddr->bmdma_addr = ATP867X_IO_DMABASE(ap, i);
453
454 ata_sff_std_ports(ioaddr);
455 rc = atp867x_set_priv(ap);
456 if (rc)
457 return rc;
458
459 #ifdef ATP867X_DEBUG
460 atp867x_check_ports(ap, i);
461 #endif
462 ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx",
463 (unsigned long)ioaddr->cmd_addr,
464 (unsigned long)ioaddr->ctl_addr);
465 ata_port_desc(ap, "bmdma 0x%lx",
466 (unsigned long)ioaddr->bmdma_addr);
467
468 mask |= 1 << i;
469 }
470
471 if (!mask) {
472 dev_err(gdev, "no available native port\n");
473 return -ENODEV;
474 }
475
476 atp867x_fixup(host);
477
478 rc = dma_set_mask(&pdev->dev, ATA_DMA_MASK);
479 if (rc)
480 return rc;
481
482 rc = dma_set_coherent_mask(&pdev->dev, ATA_DMA_MASK);
483 return rc;
484 }
485
486 static int atp867x_init_one(struct pci_dev *pdev,
487 const struct pci_device_id *id)
488 {
489 static const struct ata_port_info info_867x = {
490 .flags = ATA_FLAG_SLAVE_POSS,
491 .pio_mask = ATA_PIO4,
492 .udma_mask = ATA_UDMA6,
493 .port_ops = &atp867x_ops,
494 };
495
496 struct ata_host *host;
497 const struct ata_port_info *ppi[] = { &info_867x, NULL };
498 int rc;
499
500 ata_print_version_once(&pdev->dev, DRV_VERSION);
501
502 rc = pcim_enable_device(pdev);
503 if (rc)
504 return rc;
505
506 printk(KERN_INFO "ATP867X: ATP867 ATA UDMA133 controller (rev %02X)",
507 pdev->device);
508
509 host = ata_host_alloc_pinfo(&pdev->dev, ppi, ATP867X_NUM_PORTS);
510 if (!host) {
511 dev_err(&pdev->dev, "failed to allocate ATA host\n");
512 rc = -ENOMEM;
513 goto err_out;
514 }
515
516 rc = atp867x_ata_pci_sff_init_host(host);
517 if (rc) {
518 dev_err(&pdev->dev, "failed to init host\n");
519 goto err_out;
520 }
521
522 pci_set_master(pdev);
523
524 rc = ata_host_activate(host, pdev->irq, ata_bmdma_interrupt,
525 IRQF_SHARED, &atp867x_sht);
526 if (rc)
527 dev_err(&pdev->dev, "failed to activate host\n");
528
529 err_out:
530 return rc;
531 }
532
533 #ifdef CONFIG_PM_SLEEP
534 static int atp867x_reinit_one(struct pci_dev *pdev)
535 {
536 struct ata_host *host = pci_get_drvdata(pdev);
537 int rc;
538
539 rc = ata_pci_device_do_resume(pdev);
540 if (rc)
541 return rc;
542
543 atp867x_fixup(host);
544
545 ata_host_resume(host);
546 return 0;
547 }
548 #endif
549
550 static struct pci_device_id atp867x_pci_tbl[] = {
551 { PCI_VDEVICE(ARTOP, PCI_DEVICE_ID_ARTOP_ATP867A), 0 },
552 { PCI_VDEVICE(ARTOP, PCI_DEVICE_ID_ARTOP_ATP867B), 0 },
553 { },
554 };
555
556 static struct pci_driver atp867x_driver = {
557 .name = DRV_NAME,
558 .id_table = atp867x_pci_tbl,
559 .probe = atp867x_init_one,
560 .remove = ata_pci_remove_one,
561 #ifdef CONFIG_PM_SLEEP
562 .suspend = ata_pci_device_suspend,
563 .resume = atp867x_reinit_one,
564 #endif
565 };
566
567 module_pci_driver(atp867x_driver);
568
569 MODULE_AUTHOR("John(Jung-Ik) Lee, Google Inc.");
570 MODULE_DESCRIPTION("low level driver for Artop/Acard 867x ATA controller");
571 MODULE_LICENSE("GPL");
572 MODULE_DEVICE_TABLE(pci, atp867x_pci_tbl);
573 MODULE_VERSION(DRV_VERSION);
Linux with added FPC-III support