Merge branch 'for-next-merge' of git://git.kernel.org/pub/scm/linux/kernel/git/nab...
[linux-2.6-block.git] / drivers / ata / sata_inic162x.c
CommitLineData
1fd7a697
TH
1/*
2 * sata_inic162x.c - Driver for Initio 162x SATA controllers
3 *
4 * Copyright 2006 SUSE Linux Products GmbH
5 * Copyright 2006 Tejun Heo <teheo@novell.com>
6 *
7 * This file is released under GPL v2.
8 *
bb969619
TH
9 * **** WARNING ****
10 *
11 * This driver never worked properly and unfortunately data corruption is
12 * relatively common. There isn't anyone working on the driver and there's
13 * no support from the vendor. Do not use this driver in any production
14 * environment.
15 *
16 * http://thread.gmane.org/gmane.linux.debian.devel.bugs.rc/378525/focus=54491
17 * https://bugzilla.kernel.org/show_bug.cgi?id=60565
18 *
19 * *****************
20 *
1fd7a697
TH
21 * This controller is eccentric and easily locks up if something isn't
22 * right. Documentation is available at initio's website but it only
23 * documents registers (not programming model).
24 *
22bfc6d5
TH
25 * This driver has interesting history. The first version was written
26 * from the documentation and a 2.4 IDE driver posted on a Taiwan
27 * company, which didn't use any IDMA features and couldn't handle
28 * LBA48. The resulting driver couldn't handle LBA48 devices either
29 * making it pretty useless.
30 *
31 * After a while, initio picked the driver up, renamed it to
32 * sata_initio162x, updated it to use IDMA for ATA DMA commands and
33 * posted it on their website. It only used ATA_PROT_DMA for IDMA and
34 * attaching both devices and issuing IDMA and !IDMA commands
35 * simultaneously broke it due to PIRQ masking interaction but it did
36 * show how to use the IDMA (ADMA + some initio specific twists)
37 * engine.
38 *
39 * Then, I picked up their changes again and here's the usable driver
40 * which uses IDMA for everything. Everything works now including
41 * LBA48, CD/DVD burning, suspend/resume and hotplug. There are some
42 * issues tho. Result Tf is not resported properly, NCQ isn't
43 * supported yet and CD/DVD writing works with DMA assisted PIO
44 * protocol (which, for native SATA devices, shouldn't cause any
45 * noticeable difference).
46 *
47 * Anyways, so, here's finally a working driver for inic162x. Enjoy!
48 *
49 * initio: If you guys wanna improve the driver regarding result TF
50 * access and other stuff, please feel free to contact me. I'll be
51 * happy to assist.
1fd7a697
TH
52 */
53
5a0e3ad6 54#include <linux/gfp.h>
1fd7a697
TH
55#include <linux/kernel.h>
56#include <linux/module.h>
57#include <linux/pci.h>
58#include <scsi/scsi_host.h>
59#include <linux/libata.h>
60#include <linux/blkdev.h>
61#include <scsi/scsi_device.h>
62
63#define DRV_NAME "sata_inic162x"
22bfc6d5 64#define DRV_VERSION "0.4"
1fd7a697
TH
65
66enum {
ba66b242
TH
67 MMIO_BAR_PCI = 5,
68 MMIO_BAR_CARDBUS = 1,
1fd7a697
TH
69
70 NR_PORTS = 2,
71
3ad400a9
TH
72 IDMA_CPB_TBL_SIZE = 4 * 32,
73
74 INIC_DMA_BOUNDARY = 0xffffff,
75
b0dd9b8e 76 HOST_ACTRL = 0x08,
1fd7a697
TH
77 HOST_CTL = 0x7c,
78 HOST_STAT = 0x7e,
79 HOST_IRQ_STAT = 0xbc,
80 HOST_IRQ_MASK = 0xbe,
81
82 PORT_SIZE = 0x40,
83
84 /* registers for ATA TF operation */
b0dd9b8e
TH
85 PORT_TF_DATA = 0x00,
86 PORT_TF_FEATURE = 0x01,
87 PORT_TF_NSECT = 0x02,
88 PORT_TF_LBAL = 0x03,
89 PORT_TF_LBAM = 0x04,
90 PORT_TF_LBAH = 0x05,
91 PORT_TF_DEVICE = 0x06,
92 PORT_TF_COMMAND = 0x07,
93 PORT_TF_ALT_STAT = 0x08,
1fd7a697
TH
94 PORT_IRQ_STAT = 0x09,
95 PORT_IRQ_MASK = 0x0a,
96 PORT_PRD_CTL = 0x0b,
97 PORT_PRD_ADDR = 0x0c,
98 PORT_PRD_XFERLEN = 0x10,
b0dd9b8e
TH
99 PORT_CPB_CPBLAR = 0x18,
100 PORT_CPB_PTQFIFO = 0x1c,
1fd7a697
TH
101
102 /* IDMA register */
103 PORT_IDMA_CTL = 0x14,
b0dd9b8e
TH
104 PORT_IDMA_STAT = 0x16,
105
106 PORT_RPQ_FIFO = 0x1e,
107 PORT_RPQ_CNT = 0x1f,
1fd7a697
TH
108
109 PORT_SCR = 0x20,
110
111 /* HOST_CTL bits */
99580664 112 HCTL_LEDEN = (1 << 3), /* enable LED operation */
1fd7a697 113 HCTL_IRQOFF = (1 << 8), /* global IRQ off */
b0dd9b8e
TH
114 HCTL_FTHD0 = (1 << 10), /* fifo threshold 0 */
115 HCTL_FTHD1 = (1 << 11), /* fifo threshold 1*/
116 HCTL_PWRDWN = (1 << 12), /* power down PHYs */
1fd7a697
TH
117 HCTL_SOFTRST = (1 << 13), /* global reset (no phy reset) */
118 HCTL_RPGSEL = (1 << 15), /* register page select */
119
120 HCTL_KNOWN_BITS = HCTL_IRQOFF | HCTL_PWRDWN | HCTL_SOFTRST |
121 HCTL_RPGSEL,
122
123 /* HOST_IRQ_(STAT|MASK) bits */
124 HIRQ_PORT0 = (1 << 0),
125 HIRQ_PORT1 = (1 << 1),
126 HIRQ_SOFT = (1 << 14),
127 HIRQ_GLOBAL = (1 << 15), /* STAT only */
128
129 /* PORT_IRQ_(STAT|MASK) bits */
130 PIRQ_OFFLINE = (1 << 0), /* device unplugged */
131 PIRQ_ONLINE = (1 << 1), /* device plugged */
132 PIRQ_COMPLETE = (1 << 2), /* completion interrupt */
133 PIRQ_FATAL = (1 << 3), /* fatal error */
134 PIRQ_ATA = (1 << 4), /* ATA interrupt */
135 PIRQ_REPLY = (1 << 5), /* reply FIFO not empty */
136 PIRQ_PENDING = (1 << 7), /* port IRQ pending (STAT only) */
137
138 PIRQ_ERR = PIRQ_OFFLINE | PIRQ_ONLINE | PIRQ_FATAL,
f8b0685a 139 PIRQ_MASK_DEFAULT = PIRQ_REPLY | PIRQ_ATA,
1fd7a697
TH
140 PIRQ_MASK_FREEZE = 0xff,
141
142 /* PORT_PRD_CTL bits */
143 PRD_CTL_START = (1 << 0),
144 PRD_CTL_WR = (1 << 3),
145 PRD_CTL_DMAEN = (1 << 7), /* DMA enable */
146
147 /* PORT_IDMA_CTL bits */
148 IDMA_CTL_RST_ATA = (1 << 2), /* hardreset ATA bus */
149 IDMA_CTL_RST_IDMA = (1 << 5), /* reset IDMA machinary */
150 IDMA_CTL_GO = (1 << 7), /* IDMA mode go */
151 IDMA_CTL_ATA_NIEN = (1 << 8), /* ATA IRQ disable */
b0dd9b8e
TH
152
153 /* PORT_IDMA_STAT bits */
154 IDMA_STAT_PERR = (1 << 0), /* PCI ERROR MODE */
155 IDMA_STAT_CPBERR = (1 << 1), /* ADMA CPB error */
156 IDMA_STAT_LGCY = (1 << 3), /* ADMA legacy */
157 IDMA_STAT_UIRQ = (1 << 4), /* ADMA unsolicited irq */
158 IDMA_STAT_STPD = (1 << 5), /* ADMA stopped */
159 IDMA_STAT_PSD = (1 << 6), /* ADMA pause */
160 IDMA_STAT_DONE = (1 << 7), /* ADMA done */
161
162 IDMA_STAT_ERR = IDMA_STAT_PERR | IDMA_STAT_CPBERR,
163
164 /* CPB Control Flags*/
165 CPB_CTL_VALID = (1 << 0), /* CPB valid */
166 CPB_CTL_QUEUED = (1 << 1), /* queued command */
167 CPB_CTL_DATA = (1 << 2), /* data, rsvd in datasheet */
168 CPB_CTL_IEN = (1 << 3), /* PCI interrupt enable */
169 CPB_CTL_DEVDIR = (1 << 4), /* device direction control */
170
171 /* CPB Response Flags */
172 CPB_RESP_DONE = (1 << 0), /* ATA command complete */
173 CPB_RESP_REL = (1 << 1), /* ATA release */
174 CPB_RESP_IGNORED = (1 << 2), /* CPB ignored */
175 CPB_RESP_ATA_ERR = (1 << 3), /* ATA command error */
176 CPB_RESP_SPURIOUS = (1 << 4), /* ATA spurious interrupt error */
177 CPB_RESP_UNDERFLOW = (1 << 5), /* APRD deficiency length error */
178 CPB_RESP_OVERFLOW = (1 << 6), /* APRD exccess length error */
179 CPB_RESP_CPB_ERR = (1 << 7), /* CPB error flag */
180
181 /* PRD Control Flags */
182 PRD_DRAIN = (1 << 1), /* ignore data excess */
183 PRD_CDB = (1 << 2), /* atapi packet command pointer */
184 PRD_DIRECT_INTR = (1 << 3), /* direct interrupt */
185 PRD_DMA = (1 << 4), /* data transfer method */
186 PRD_WRITE = (1 << 5), /* data dir, rsvd in datasheet */
187 PRD_IOM = (1 << 6), /* io/memory transfer */
188 PRD_END = (1 << 7), /* APRD chain end */
1fd7a697
TH
189};
190
3ad400a9
TH
191/* Comman Parameter Block */
192struct inic_cpb {
193 u8 resp_flags; /* Response Flags */
194 u8 error; /* ATA Error */
195 u8 status; /* ATA Status */
196 u8 ctl_flags; /* Control Flags */
197 __le32 len; /* Total Transfer Length */
198 __le32 prd; /* First PRD pointer */
199 u8 rsvd[4];
200 /* 16 bytes */
201 u8 feature; /* ATA Feature */
202 u8 hob_feature; /* ATA Ex. Feature */
203 u8 device; /* ATA Device/Head */
204 u8 mirctl; /* Mirror Control */
205 u8 nsect; /* ATA Sector Count */
206 u8 hob_nsect; /* ATA Ex. Sector Count */
207 u8 lbal; /* ATA Sector Number */
208 u8 hob_lbal; /* ATA Ex. Sector Number */
209 u8 lbam; /* ATA Cylinder Low */
210 u8 hob_lbam; /* ATA Ex. Cylinder Low */
211 u8 lbah; /* ATA Cylinder High */
212 u8 hob_lbah; /* ATA Ex. Cylinder High */
213 u8 command; /* ATA Command */
214 u8 ctl; /* ATA Control */
215 u8 slave_error; /* Slave ATA Error */
216 u8 slave_status; /* Slave ATA Status */
217 /* 32 bytes */
218} __packed;
219
220/* Physical Region Descriptor */
221struct inic_prd {
222 __le32 mad; /* Physical Memory Address */
223 __le16 len; /* Transfer Length */
224 u8 rsvd;
225 u8 flags; /* Control Flags */
226} __packed;
227
228struct inic_pkt {
229 struct inic_cpb cpb;
b3f677e5
TH
230 struct inic_prd prd[LIBATA_MAX_PRD + 1]; /* + 1 for cdb */
231 u8 cdb[ATAPI_CDB_LEN];
3ad400a9
TH
232} __packed;
233
1fd7a697 234struct inic_host_priv {
ba66b242 235 void __iomem *mmio_base;
36f674d9 236 u16 cached_hctl;
1fd7a697
TH
237};
238
239struct inic_port_priv {
3ad400a9
TH
240 struct inic_pkt *pkt;
241 dma_addr_t pkt_dma;
242 u32 *cpb_tbl;
243 dma_addr_t cpb_tbl_dma;
1fd7a697
TH
244};
245
1fd7a697 246static struct scsi_host_template inic_sht = {
ab5b0235
TH
247 ATA_BASE_SHT(DRV_NAME),
248 .sg_tablesize = LIBATA_MAX_PRD, /* maybe it can be larger? */
3ad400a9 249 .dma_boundary = INIC_DMA_BOUNDARY,
1fd7a697
TH
250};
251
252static const int scr_map[] = {
253 [SCR_STATUS] = 0,
254 [SCR_ERROR] = 1,
255 [SCR_CONTROL] = 2,
256};
257
5796d1c4 258static void __iomem *inic_port_base(struct ata_port *ap)
1fd7a697 259{
ba66b242
TH
260 struct inic_host_priv *hpriv = ap->host->private_data;
261
262 return hpriv->mmio_base + ap->port_no * PORT_SIZE;
1fd7a697
TH
263}
264
1fd7a697
TH
265static void inic_reset_port(void __iomem *port_base)
266{
267 void __iomem *idma_ctl = port_base + PORT_IDMA_CTL;
1fd7a697 268
f8b0685a
TH
269 /* stop IDMA engine */
270 readw(idma_ctl); /* flush */
271 msleep(1);
1fd7a697
TH
272
273 /* mask IRQ and assert reset */
f8b0685a 274 writew(IDMA_CTL_RST_IDMA, idma_ctl);
1fd7a697 275 readw(idma_ctl); /* flush */
1fd7a697
TH
276 msleep(1);
277
278 /* release reset */
f8b0685a 279 writew(0, idma_ctl);
1fd7a697
TH
280
281 /* clear irq */
282 writeb(0xff, port_base + PORT_IRQ_STAT);
1fd7a697
TH
283}
284
82ef04fb 285static int inic_scr_read(struct ata_link *link, unsigned sc_reg, u32 *val)
1fd7a697 286{
82ef04fb 287 void __iomem *scr_addr = inic_port_base(link->ap) + PORT_SCR;
1fd7a697
TH
288
289 if (unlikely(sc_reg >= ARRAY_SIZE(scr_map)))
da3dbb17 290 return -EINVAL;
1fd7a697 291
da3dbb17 292 *val = readl(scr_addr + scr_map[sc_reg] * 4);
1fd7a697
TH
293
294 /* this controller has stuck DIAG.N, ignore it */
295 if (sc_reg == SCR_ERROR)
da3dbb17
TH
296 *val &= ~SERR_PHYRDY_CHG;
297 return 0;
1fd7a697
TH
298}
299
82ef04fb 300static int inic_scr_write(struct ata_link *link, unsigned sc_reg, u32 val)
1fd7a697 301{
82ef04fb 302 void __iomem *scr_addr = inic_port_base(link->ap) + PORT_SCR;
1fd7a697
TH
303
304 if (unlikely(sc_reg >= ARRAY_SIZE(scr_map)))
da3dbb17 305 return -EINVAL;
1fd7a697 306
1fd7a697 307 writel(val, scr_addr + scr_map[sc_reg] * 4);
da3dbb17 308 return 0;
1fd7a697
TH
309}
310
3ad400a9 311static void inic_stop_idma(struct ata_port *ap)
1fd7a697
TH
312{
313 void __iomem *port_base = inic_port_base(ap);
3ad400a9
TH
314
315 readb(port_base + PORT_RPQ_FIFO);
316 readb(port_base + PORT_RPQ_CNT);
317 writew(0, port_base + PORT_IDMA_CTL);
318}
319
320static void inic_host_err_intr(struct ata_port *ap, u8 irq_stat, u16 idma_stat)
321{
9af5c9c9 322 struct ata_eh_info *ehi = &ap->link.eh_info;
3ad400a9
TH
323 struct inic_port_priv *pp = ap->private_data;
324 struct inic_cpb *cpb = &pp->pkt->cpb;
325 bool freeze = false;
326
327 ata_ehi_clear_desc(ehi);
328 ata_ehi_push_desc(ehi, "irq_stat=0x%x idma_stat=0x%x",
329 irq_stat, idma_stat);
330
331 inic_stop_idma(ap);
332
333 if (irq_stat & (PIRQ_OFFLINE | PIRQ_ONLINE)) {
334 ata_ehi_push_desc(ehi, "hotplug");
335 ata_ehi_hotplugged(ehi);
336 freeze = true;
337 }
338
339 if (idma_stat & IDMA_STAT_PERR) {
340 ata_ehi_push_desc(ehi, "PCI error");
341 freeze = true;
342 }
343
344 if (idma_stat & IDMA_STAT_CPBERR) {
345 ata_ehi_push_desc(ehi, "CPB error");
346
347 if (cpb->resp_flags & CPB_RESP_IGNORED) {
348 __ata_ehi_push_desc(ehi, " ignored");
349 ehi->err_mask |= AC_ERR_INVALID;
350 freeze = true;
351 }
352
353 if (cpb->resp_flags & CPB_RESP_ATA_ERR)
354 ehi->err_mask |= AC_ERR_DEV;
355
356 if (cpb->resp_flags & CPB_RESP_SPURIOUS) {
357 __ata_ehi_push_desc(ehi, " spurious-intr");
358 ehi->err_mask |= AC_ERR_HSM;
359 freeze = true;
360 }
361
362 if (cpb->resp_flags &
363 (CPB_RESP_UNDERFLOW | CPB_RESP_OVERFLOW)) {
364 __ata_ehi_push_desc(ehi, " data-over/underflow");
365 ehi->err_mask |= AC_ERR_HSM;
366 freeze = true;
367 }
368 }
369
370 if (freeze)
371 ata_port_freeze(ap);
372 else
373 ata_port_abort(ap);
374}
375
376static void inic_host_intr(struct ata_port *ap)
377{
378 void __iomem *port_base = inic_port_base(ap);
379 struct ata_queued_cmd *qc = ata_qc_from_tag(ap, ap->link.active_tag);
1fd7a697 380 u8 irq_stat;
3ad400a9 381 u16 idma_stat;
1fd7a697 382
3ad400a9 383 /* read and clear IRQ status */
1fd7a697
TH
384 irq_stat = readb(port_base + PORT_IRQ_STAT);
385 writeb(irq_stat, port_base + PORT_IRQ_STAT);
3ad400a9
TH
386 idma_stat = readw(port_base + PORT_IDMA_STAT);
387
388 if (unlikely((irq_stat & PIRQ_ERR) || (idma_stat & IDMA_STAT_ERR)))
389 inic_host_err_intr(ap, irq_stat, idma_stat);
390
f8b0685a 391 if (unlikely(!qc))
3ad400a9 392 goto spurious;
3ad400a9 393
b3f677e5
TH
394 if (likely(idma_stat & IDMA_STAT_DONE)) {
395 inic_stop_idma(ap);
1fd7a697 396
b3f677e5
TH
397 /* Depending on circumstances, device error
398 * isn't reported by IDMA, check it explicitly.
399 */
400 if (unlikely(readb(port_base + PORT_TF_COMMAND) &
401 (ATA_DF | ATA_ERR)))
402 qc->err_mask |= AC_ERR_DEV;
1fd7a697 403
b3f677e5
TH
404 ata_qc_complete(qc);
405 return;
1fd7a697
TH
406 }
407
3ad400a9 408 spurious:
a9a79dfe
JP
409 ata_port_warn(ap, "unhandled interrupt: cmd=0x%x irq_stat=0x%x idma_stat=0x%x\n",
410 qc ? qc->tf.command : 0xff, irq_stat, idma_stat);
1fd7a697
TH
411}
412
413static irqreturn_t inic_interrupt(int irq, void *dev_instance)
414{
415 struct ata_host *host = dev_instance;
ba66b242 416 struct inic_host_priv *hpriv = host->private_data;
1fd7a697 417 u16 host_irq_stat;
87c8b22b 418 int i, handled = 0;
1fd7a697 419
ba66b242 420 host_irq_stat = readw(hpriv->mmio_base + HOST_IRQ_STAT);
1fd7a697
TH
421
422 if (unlikely(!(host_irq_stat & HIRQ_GLOBAL)))
423 goto out;
424
425 spin_lock(&host->lock);
426
3e4ec344
TH
427 for (i = 0; i < NR_PORTS; i++)
428 if (host_irq_stat & (HIRQ_PORT0 << i)) {
429 inic_host_intr(host->ports[i]);
1fd7a697 430 handled++;
1fd7a697 431 }
1fd7a697
TH
432
433 spin_unlock(&host->lock);
434
435 out:
436 return IRQ_RETVAL(handled);
437}
438
b3f677e5
TH
439static int inic_check_atapi_dma(struct ata_queued_cmd *qc)
440{
441 /* For some reason ATAPI_PROT_DMA doesn't work for some
442 * commands including writes and other misc ops. Use PIO
443 * protocol instead, which BTW is driven by the DMA engine
444 * anyway, so it shouldn't make much difference for native
445 * SATA devices.
446 */
447 if (atapi_cmd_type(qc->cdb[0]) == READ)
448 return 0;
449 return 1;
450}
451
3ad400a9
TH
452static void inic_fill_sg(struct inic_prd *prd, struct ata_queued_cmd *qc)
453{
454 struct scatterlist *sg;
455 unsigned int si;
049e8e04 456 u8 flags = 0;
3ad400a9
TH
457
458 if (qc->tf.flags & ATA_TFLAG_WRITE)
459 flags |= PRD_WRITE;
460
049e8e04
TH
461 if (ata_is_dma(qc->tf.protocol))
462 flags |= PRD_DMA;
463
3ad400a9
TH
464 for_each_sg(qc->sg, sg, qc->n_elem, si) {
465 prd->mad = cpu_to_le32(sg_dma_address(sg));
466 prd->len = cpu_to_le16(sg_dma_len(sg));
467 prd->flags = flags;
468 prd++;
469 }
470
471 WARN_ON(!si);
472 prd[-1].flags |= PRD_END;
473}
474
475static void inic_qc_prep(struct ata_queued_cmd *qc)
476{
477 struct inic_port_priv *pp = qc->ap->private_data;
478 struct inic_pkt *pkt = pp->pkt;
479 struct inic_cpb *cpb = &pkt->cpb;
480 struct inic_prd *prd = pkt->prd;
049e8e04
TH
481 bool is_atapi = ata_is_atapi(qc->tf.protocol);
482 bool is_data = ata_is_data(qc->tf.protocol);
b3f677e5 483 unsigned int cdb_len = 0;
3ad400a9
TH
484
485 VPRINTK("ENTER\n");
486
049e8e04 487 if (is_atapi)
b3f677e5 488 cdb_len = qc->dev->cdb_len;
3ad400a9
TH
489
490 /* prepare packet, based on initio driver */
491 memset(pkt, 0, sizeof(struct inic_pkt));
492
049e8e04 493 cpb->ctl_flags = CPB_CTL_VALID | CPB_CTL_IEN;
b3f677e5 494 if (is_atapi || is_data)
049e8e04 495 cpb->ctl_flags |= CPB_CTL_DATA;
3ad400a9 496
b3f677e5 497 cpb->len = cpu_to_le32(qc->nbytes + cdb_len);
3ad400a9
TH
498 cpb->prd = cpu_to_le32(pp->pkt_dma + offsetof(struct inic_pkt, prd));
499
500 cpb->device = qc->tf.device;
501 cpb->feature = qc->tf.feature;
502 cpb->nsect = qc->tf.nsect;
503 cpb->lbal = qc->tf.lbal;
504 cpb->lbam = qc->tf.lbam;
505 cpb->lbah = qc->tf.lbah;
506
507 if (qc->tf.flags & ATA_TFLAG_LBA48) {
508 cpb->hob_feature = qc->tf.hob_feature;
509 cpb->hob_nsect = qc->tf.hob_nsect;
510 cpb->hob_lbal = qc->tf.hob_lbal;
511 cpb->hob_lbam = qc->tf.hob_lbam;
512 cpb->hob_lbah = qc->tf.hob_lbah;
513 }
514
515 cpb->command = qc->tf.command;
516 /* don't load ctl - dunno why. it's like that in the initio driver */
517
b3f677e5
TH
518 /* setup PRD for CDB */
519 if (is_atapi) {
520 memcpy(pkt->cdb, qc->cdb, ATAPI_CDB_LEN);
521 prd->mad = cpu_to_le32(pp->pkt_dma +
522 offsetof(struct inic_pkt, cdb));
523 prd->len = cpu_to_le16(cdb_len);
524 prd->flags = PRD_CDB | PRD_WRITE;
525 if (!is_data)
526 prd->flags |= PRD_END;
527 prd++;
528 }
529
3ad400a9 530 /* setup sg table */
049e8e04
TH
531 if (is_data)
532 inic_fill_sg(prd, qc);
3ad400a9
TH
533
534 pp->cpb_tbl[0] = pp->pkt_dma;
535}
536
1fd7a697
TH
537static unsigned int inic_qc_issue(struct ata_queued_cmd *qc)
538{
539 struct ata_port *ap = qc->ap;
3ad400a9 540 void __iomem *port_base = inic_port_base(ap);
1fd7a697 541
b3f677e5 542 /* fire up the ADMA engine */
99580664 543 writew(HCTL_FTHD0 | HCTL_LEDEN, port_base + HOST_CTL);
b3f677e5
TH
544 writew(IDMA_CTL_GO, port_base + PORT_IDMA_CTL);
545 writeb(0, port_base + PORT_CPB_PTQFIFO);
1fd7a697 546
b3f677e5 547 return 0;
1fd7a697
TH
548}
549
364fac0e
TH
550static void inic_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
551{
552 void __iomem *port_base = inic_port_base(ap);
553
554 tf->feature = readb(port_base + PORT_TF_FEATURE);
555 tf->nsect = readb(port_base + PORT_TF_NSECT);
556 tf->lbal = readb(port_base + PORT_TF_LBAL);
557 tf->lbam = readb(port_base + PORT_TF_LBAM);
558 tf->lbah = readb(port_base + PORT_TF_LBAH);
559 tf->device = readb(port_base + PORT_TF_DEVICE);
560 tf->command = readb(port_base + PORT_TF_COMMAND);
561}
562
563static bool inic_qc_fill_rtf(struct ata_queued_cmd *qc)
564{
565 struct ata_taskfile *rtf = &qc->result_tf;
566 struct ata_taskfile tf;
567
568 /* FIXME: Except for status and error, result TF access
569 * doesn't work. I tried reading from BAR0/2, CPB and BAR5.
570 * None works regardless of which command interface is used.
571 * For now return true iff status indicates device error.
572 * This means that we're reporting bogus sector for RW
573 * failures. Eeekk....
574 */
575 inic_tf_read(qc->ap, &tf);
576
577 if (!(tf.command & ATA_ERR))
578 return false;
579
580 rtf->command = tf.command;
581 rtf->feature = tf.feature;
582 return true;
583}
584
1fd7a697
TH
585static void inic_freeze(struct ata_port *ap)
586{
587 void __iomem *port_base = inic_port_base(ap);
588
ab5b0235 589 writeb(PIRQ_MASK_FREEZE, port_base + PORT_IRQ_MASK);
1fd7a697 590 writeb(0xff, port_base + PORT_IRQ_STAT);
1fd7a697
TH
591}
592
593static void inic_thaw(struct ata_port *ap)
594{
595 void __iomem *port_base = inic_port_base(ap);
596
1fd7a697 597 writeb(0xff, port_base + PORT_IRQ_STAT);
ab5b0235 598 writeb(PIRQ_MASK_DEFAULT, port_base + PORT_IRQ_MASK);
1fd7a697
TH
599}
600
364fac0e
TH
601static int inic_check_ready(struct ata_link *link)
602{
603 void __iomem *port_base = inic_port_base(link->ap);
604
605 return ata_check_ready(readb(port_base + PORT_TF_COMMAND));
606}
607
1fd7a697
TH
608/*
609 * SRST and SControl hardreset don't give valid signature on this
610 * controller. Only controller specific hardreset mechanism works.
611 */
cc0680a5 612static int inic_hardreset(struct ata_link *link, unsigned int *class,
d4b2bab4 613 unsigned long deadline)
1fd7a697 614{
cc0680a5 615 struct ata_port *ap = link->ap;
1fd7a697
TH
616 void __iomem *port_base = inic_port_base(ap);
617 void __iomem *idma_ctl = port_base + PORT_IDMA_CTL;
cc0680a5 618 const unsigned long *timing = sata_ehc_deb_timing(&link->eh_context);
1fd7a697
TH
619 int rc;
620
621 /* hammer it into sane state */
622 inic_reset_port(port_base);
623
f8b0685a 624 writew(IDMA_CTL_RST_ATA, idma_ctl);
1fd7a697 625 readw(idma_ctl); /* flush */
97750ceb 626 ata_msleep(ap, 1);
f8b0685a 627 writew(0, idma_ctl);
1fd7a697 628
cc0680a5 629 rc = sata_link_resume(link, timing, deadline);
1fd7a697 630 if (rc) {
a9a79dfe
JP
631 ata_link_warn(link,
632 "failed to resume link after reset (errno=%d)\n",
633 rc);
1fd7a697
TH
634 return rc;
635 }
636
1fd7a697 637 *class = ATA_DEV_NONE;
cc0680a5 638 if (ata_link_online(link)) {
1fd7a697
TH
639 struct ata_taskfile tf;
640
705e76be 641 /* wait for link to become ready */
364fac0e 642 rc = ata_wait_after_reset(link, deadline, inic_check_ready);
9b89391c
TH
643 /* link occupied, -ENODEV too is an error */
644 if (rc) {
a9a79dfe
JP
645 ata_link_warn(link,
646 "device not ready after hardreset (errno=%d)\n",
647 rc);
d4b2bab4 648 return rc;
1fd7a697
TH
649 }
650
364fac0e 651 inic_tf_read(ap, &tf);
1fd7a697 652 *class = ata_dev_classify(&tf);
1fd7a697
TH
653 }
654
655 return 0;
656}
657
658static void inic_error_handler(struct ata_port *ap)
659{
660 void __iomem *port_base = inic_port_base(ap);
1fd7a697 661
1fd7a697 662 inic_reset_port(port_base);
a1efdaba 663 ata_std_error_handler(ap);
1fd7a697
TH
664}
665
666static void inic_post_internal_cmd(struct ata_queued_cmd *qc)
667{
668 /* make DMA engine forget about the failed command */
a51d644a 669 if (qc->flags & ATA_QCFLAG_FAILED)
1fd7a697
TH
670 inic_reset_port(inic_port_base(qc->ap));
671}
672
1fd7a697
TH
673static void init_port(struct ata_port *ap)
674{
675 void __iomem *port_base = inic_port_base(ap);
3ad400a9 676 struct inic_port_priv *pp = ap->private_data;
1fd7a697 677
3ad400a9
TH
678 /* clear packet and CPB table */
679 memset(pp->pkt, 0, sizeof(struct inic_pkt));
680 memset(pp->cpb_tbl, 0, IDMA_CPB_TBL_SIZE);
681
6bc0d390 682 /* setup CPB lookup table addresses */
3ad400a9 683 writel(pp->cpb_tbl_dma, port_base + PORT_CPB_CPBLAR);
1fd7a697
TH
684}
685
686static int inic_port_resume(struct ata_port *ap)
687{
688 init_port(ap);
689 return 0;
690}
691
692static int inic_port_start(struct ata_port *ap)
693{
3ad400a9 694 struct device *dev = ap->host->dev;
1fd7a697 695 struct inic_port_priv *pp;
1fd7a697
TH
696
697 /* alloc and initialize private data */
3ad400a9 698 pp = devm_kzalloc(dev, sizeof(*pp), GFP_KERNEL);
1fd7a697
TH
699 if (!pp)
700 return -ENOMEM;
701 ap->private_data = pp;
702
1fd7a697 703 /* Alloc resources */
3ad400a9
TH
704 pp->pkt = dmam_alloc_coherent(dev, sizeof(struct inic_pkt),
705 &pp->pkt_dma, GFP_KERNEL);
706 if (!pp->pkt)
707 return -ENOMEM;
708
709 pp->cpb_tbl = dmam_alloc_coherent(dev, IDMA_CPB_TBL_SIZE,
710 &pp->cpb_tbl_dma, GFP_KERNEL);
711 if (!pp->cpb_tbl)
712 return -ENOMEM;
713
1fd7a697
TH
714 init_port(ap);
715
716 return 0;
717}
718
1fd7a697 719static struct ata_port_operations inic_port_ops = {
f8b0685a 720 .inherits = &sata_port_ops,
1fd7a697 721
b3f677e5 722 .check_atapi_dma = inic_check_atapi_dma,
3ad400a9 723 .qc_prep = inic_qc_prep,
1fd7a697 724 .qc_issue = inic_qc_issue,
364fac0e 725 .qc_fill_rtf = inic_qc_fill_rtf,
1fd7a697
TH
726
727 .freeze = inic_freeze,
728 .thaw = inic_thaw,
a1efdaba 729 .hardreset = inic_hardreset,
1fd7a697
TH
730 .error_handler = inic_error_handler,
731 .post_internal_cmd = inic_post_internal_cmd,
1fd7a697 732
029cfd6b
TH
733 .scr_read = inic_scr_read,
734 .scr_write = inic_scr_write,
1fd7a697 735
029cfd6b 736 .port_resume = inic_port_resume,
1fd7a697 737 .port_start = inic_port_start,
1fd7a697
TH
738};
739
740static struct ata_port_info inic_port_info = {
1fd7a697 741 .flags = ATA_FLAG_SATA | ATA_FLAG_PIO_DMA,
14bdef98
EIB
742 .pio_mask = ATA_PIO4,
743 .mwdma_mask = ATA_MWDMA2,
bf6263a8 744 .udma_mask = ATA_UDMA6,
1fd7a697
TH
745 .port_ops = &inic_port_ops
746};
747
748static int init_controller(void __iomem *mmio_base, u16 hctl)
749{
750 int i;
751 u16 val;
752
753 hctl &= ~HCTL_KNOWN_BITS;
754
755 /* Soft reset whole controller. Spec says reset duration is 3
756 * PCI clocks, be generous and give it 10ms.
757 */
758 writew(hctl | HCTL_SOFTRST, mmio_base + HOST_CTL);
759 readw(mmio_base + HOST_CTL); /* flush */
760
761 for (i = 0; i < 10; i++) {
762 msleep(1);
763 val = readw(mmio_base + HOST_CTL);
764 if (!(val & HCTL_SOFTRST))
765 break;
766 }
767
768 if (val & HCTL_SOFTRST)
769 return -EIO;
770
771 /* mask all interrupts and reset ports */
772 for (i = 0; i < NR_PORTS; i++) {
773 void __iomem *port_base = mmio_base + i * PORT_SIZE;
774
775 writeb(0xff, port_base + PORT_IRQ_MASK);
776 inic_reset_port(port_base);
777 }
778
779 /* port IRQ is masked now, unmask global IRQ */
780 writew(hctl & ~HCTL_IRQOFF, mmio_base + HOST_CTL);
781 val = readw(mmio_base + HOST_IRQ_MASK);
782 val &= ~(HIRQ_PORT0 | HIRQ_PORT1);
783 writew(val, mmio_base + HOST_IRQ_MASK);
784
785 return 0;
786}
787
58eb8cd5 788#ifdef CONFIG_PM_SLEEP
1fd7a697
TH
789static int inic_pci_device_resume(struct pci_dev *pdev)
790{
0a86e1c8 791 struct ata_host *host = pci_get_drvdata(pdev);
1fd7a697 792 struct inic_host_priv *hpriv = host->private_data;
1fd7a697
TH
793 int rc;
794
5aea408d
DM
795 rc = ata_pci_device_do_resume(pdev);
796 if (rc)
797 return rc;
1fd7a697
TH
798
799 if (pdev->dev.power.power_state.event == PM_EVENT_SUSPEND) {
ba66b242 800 rc = init_controller(hpriv->mmio_base, hpriv->cached_hctl);
1fd7a697
TH
801 if (rc)
802 return rc;
803 }
804
805 ata_host_resume(host);
806
807 return 0;
808}
438ac6d5 809#endif
1fd7a697
TH
810
811static int inic_init_one(struct pci_dev *pdev, const struct pci_device_id *ent)
812{
4447d351
TH
813 const struct ata_port_info *ppi[] = { &inic_port_info, NULL };
814 struct ata_host *host;
1fd7a697 815 struct inic_host_priv *hpriv;
0d5ff566 816 void __iomem * const *iomap;
ba66b242 817 int mmio_bar;
1fd7a697
TH
818 int i, rc;
819
06296a1e 820 ata_print_version_once(&pdev->dev, DRV_VERSION);
1fd7a697 821
bb969619
TH
822 dev_alert(&pdev->dev, "inic162x support is broken with common data corruption issues and will be disabled by default, contact linux-ide@vger.kernel.org if in production use\n");
823
4447d351
TH
824 /* alloc host */
825 host = ata_host_alloc_pinfo(&pdev->dev, ppi, NR_PORTS);
826 hpriv = devm_kzalloc(&pdev->dev, sizeof(*hpriv), GFP_KERNEL);
827 if (!host || !hpriv)
828 return -ENOMEM;
829
830 host->private_data = hpriv;
831
ba66b242
TH
832 /* Acquire resources and fill host. Note that PCI and cardbus
833 * use different BARs.
834 */
24dc5f33 835 rc = pcim_enable_device(pdev);
1fd7a697
TH
836 if (rc)
837 return rc;
838
ba66b242
TH
839 if (pci_resource_flags(pdev, MMIO_BAR_PCI) & IORESOURCE_MEM)
840 mmio_bar = MMIO_BAR_PCI;
841 else
842 mmio_bar = MMIO_BAR_CARDBUS;
843
844 rc = pcim_iomap_regions(pdev, 1 << mmio_bar, DRV_NAME);
0d5ff566
TH
845 if (rc)
846 return rc;
4447d351 847 host->iomap = iomap = pcim_iomap_table(pdev);
ba66b242
TH
848 hpriv->mmio_base = iomap[mmio_bar];
849 hpriv->cached_hctl = readw(hpriv->mmio_base + HOST_CTL);
4447d351
TH
850
851 for (i = 0; i < NR_PORTS; i++) {
cbcdd875 852 struct ata_port *ap = host->ports[i];
cbcdd875 853
ba66b242
TH
854 ata_port_pbar_desc(ap, mmio_bar, -1, "mmio");
855 ata_port_pbar_desc(ap, mmio_bar, i * PORT_SIZE, "port");
4447d351
TH
856 }
857
1fd7a697 858 /* Set dma_mask. This devices doesn't support 64bit addressing. */
c54c719b 859 rc = dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
1fd7a697 860 if (rc) {
a44fec1f 861 dev_err(&pdev->dev, "32-bit DMA enable failed\n");
24dc5f33 862 return rc;
1fd7a697
TH
863 }
864
c54c719b 865 rc = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
1fd7a697 866 if (rc) {
a44fec1f 867 dev_err(&pdev->dev, "32-bit consistent DMA enable failed\n");
24dc5f33 868 return rc;
1fd7a697
TH
869 }
870
b7d8629f
FT
871 /*
872 * This controller is braindamaged. dma_boundary is 0xffff
873 * like others but it will lock up the whole machine HARD if
874 * 65536 byte PRD entry is fed. Reduce maximum segment size.
875 */
876 rc = pci_set_dma_max_seg_size(pdev, 65536 - 512);
877 if (rc) {
a44fec1f 878 dev_err(&pdev->dev, "failed to set the maximum segment size\n");
b7d8629f
FT
879 return rc;
880 }
881
ba66b242 882 rc = init_controller(hpriv->mmio_base, hpriv->cached_hctl);
1fd7a697 883 if (rc) {
a44fec1f 884 dev_err(&pdev->dev, "failed to initialize controller\n");
24dc5f33 885 return rc;
1fd7a697
TH
886 }
887
888 pci_set_master(pdev);
4447d351
TH
889 return ata_host_activate(host, pdev->irq, inic_interrupt, IRQF_SHARED,
890 &inic_sht);
1fd7a697
TH
891}
892
893static const struct pci_device_id inic_pci_tbl[] = {
894 { PCI_VDEVICE(INIT, 0x1622), },
895 { },
896};
897
898static struct pci_driver inic_pci_driver = {
899 .name = DRV_NAME,
900 .id_table = inic_pci_tbl,
58eb8cd5 901#ifdef CONFIG_PM_SLEEP
1fd7a697
TH
902 .suspend = ata_pci_device_suspend,
903 .resume = inic_pci_device_resume,
438ac6d5 904#endif
1fd7a697
TH
905 .probe = inic_init_one,
906 .remove = ata_pci_remove_one,
907};
908
2fc75da0 909module_pci_driver(inic_pci_driver);
1fd7a697
TH
910
911MODULE_AUTHOR("Tejun Heo");
912MODULE_DESCRIPTION("low-level driver for Initio 162x SATA");
913MODULE_LICENSE("GPL v2");
914MODULE_DEVICE_TABLE(pci, inic_pci_tbl);
915MODULE_VERSION(DRV_VERSION);