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