blob: dee3c2c5256206028c82a1c91733aa61635805a5 [file] [log] [blame]
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05001/*
Dave Jonesf3a03b02007-07-16 11:23:03 -04002 * libata-sff.c - helper library for PCI IDE BMDMA
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05003 *
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
7 *
8 * Copyright 2003-2006 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2006 Jeff Garzik
10 *
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 *
26 *
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
29 *
30 * Hardware documentation available from http://www.t13.org/ and
31 * http://www.sata-io.org/
32 *
33 */
34
Jeff Garzik1fdffbc2006-02-09 05:15:27 -050035#include <linux/kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090036#include <linux/gfp.h>
Jeff Garzik1fdffbc2006-02-09 05:15:27 -050037#include <linux/pci.h>
38#include <linux/libata.h>
Tejun Heo624d5c52008-03-25 22:16:41 +090039#include <linux/highmem.h>
Jeff Garzik1fdffbc2006-02-09 05:15:27 -050040
41#include "libata.h"
42
Tejun Heoc4291372010-05-10 21:41:38 +020043static struct workqueue_struct *ata_sff_wq;
44
Tejun Heo624d5c52008-03-25 22:16:41 +090045const struct ata_port_operations ata_sff_port_ops = {
46 .inherits = &ata_base_port_ops,
47
Tejun Heof47451c2010-05-10 21:41:40 +020048 .qc_prep = ata_noop_qc_prep,
Tejun Heo9363c382008-04-07 22:47:16 +090049 .qc_issue = ata_sff_qc_issue,
Tejun Heo4c9bf4e2008-04-07 22:47:20 +090050 .qc_fill_rtf = ata_sff_qc_fill_rtf,
Tejun Heo624d5c52008-03-25 22:16:41 +090051
Tejun Heo9363c382008-04-07 22:47:16 +090052 .freeze = ata_sff_freeze,
53 .thaw = ata_sff_thaw,
Tejun Heo0aa11132008-04-07 22:47:18 +090054 .prereset = ata_sff_prereset,
Tejun Heo9363c382008-04-07 22:47:16 +090055 .softreset = ata_sff_softreset,
Tejun Heo57c9efd2008-04-07 22:47:19 +090056 .hardreset = sata_sff_hardreset,
Tejun Heo203c75b2008-04-07 22:47:18 +090057 .postreset = ata_sff_postreset,
Tejun Heo9363c382008-04-07 22:47:16 +090058 .error_handler = ata_sff_error_handler,
Tejun Heo624d5c52008-03-25 22:16:41 +090059
Tejun Heo5682ed32008-04-07 22:47:16 +090060 .sff_dev_select = ata_sff_dev_select,
61 .sff_check_status = ata_sff_check_status,
62 .sff_tf_load = ata_sff_tf_load,
63 .sff_tf_read = ata_sff_tf_read,
64 .sff_exec_command = ata_sff_exec_command,
65 .sff_data_xfer = ata_sff_data_xfer,
Tejun Heo8244cd02010-05-10 21:41:36 +020066 .sff_drain_fifo = ata_sff_drain_fifo,
Tejun Heo624d5c52008-03-25 22:16:41 +090067
Alan Coxc96f1732009-03-24 10:23:46 +000068 .lost_interrupt = ata_sff_lost_interrupt,
Tejun Heo624d5c52008-03-25 22:16:41 +090069};
Alan Cox0fe40ff2009-01-05 14:16:13 +000070EXPORT_SYMBOL_GPL(ata_sff_port_ops);
Tejun Heo624d5c52008-03-25 22:16:41 +090071
Tejun Heo624d5c52008-03-25 22:16:41 +090072/**
Tejun Heo9363c382008-04-07 22:47:16 +090073 * ata_sff_check_status - Read device status reg & clear interrupt
Tejun Heo272f7882008-03-25 22:16:40 +090074 * @ap: port where the device is
75 *
76 * Reads ATA taskfile status register for currently-selected device
77 * and return its value. This also clears pending interrupts
78 * from this device
79 *
80 * LOCKING:
81 * Inherited from caller.
82 */
Tejun Heo9363c382008-04-07 22:47:16 +090083u8 ata_sff_check_status(struct ata_port *ap)
Tejun Heo272f7882008-03-25 22:16:40 +090084{
85 return ioread8(ap->ioaddr.status_addr);
86}
Alan Cox0fe40ff2009-01-05 14:16:13 +000087EXPORT_SYMBOL_GPL(ata_sff_check_status);
Tejun Heo272f7882008-03-25 22:16:40 +090088
89/**
Tejun Heo9363c382008-04-07 22:47:16 +090090 * ata_sff_altstatus - Read device alternate status reg
Tejun Heo272f7882008-03-25 22:16:40 +090091 * @ap: port where the device is
92 *
93 * Reads ATA taskfile alternate status register for
94 * currently-selected device and return its value.
95 *
96 * Note: may NOT be used as the check_altstatus() entry in
97 * ata_port_operations.
98 *
99 * LOCKING:
100 * Inherited from caller.
101 */
Alan Coxa57c1ba2008-05-29 22:10:58 +0100102static u8 ata_sff_altstatus(struct ata_port *ap)
Tejun Heo272f7882008-03-25 22:16:40 +0900103{
Tejun Heo5682ed32008-04-07 22:47:16 +0900104 if (ap->ops->sff_check_altstatus)
105 return ap->ops->sff_check_altstatus(ap);
Tejun Heo272f7882008-03-25 22:16:40 +0900106
107 return ioread8(ap->ioaddr.altstatus_addr);
108}
109
110/**
Alan Coxa57c1ba2008-05-29 22:10:58 +0100111 * ata_sff_irq_status - Check if the device is busy
112 * @ap: port where the device is
113 *
114 * Determine if the port is currently busy. Uses altstatus
115 * if available in order to avoid clearing shared IRQ status
116 * when finding an IRQ source. Non ctl capable devices don't
117 * share interrupt lines fortunately for us.
118 *
119 * LOCKING:
120 * Inherited from caller.
121 */
122static u8 ata_sff_irq_status(struct ata_port *ap)
123{
124 u8 status;
125
126 if (ap->ops->sff_check_altstatus || ap->ioaddr.altstatus_addr) {
127 status = ata_sff_altstatus(ap);
128 /* Not us: We are busy */
129 if (status & ATA_BUSY)
Alan Cox0fe40ff2009-01-05 14:16:13 +0000130 return status;
Alan Coxa57c1ba2008-05-29 22:10:58 +0100131 }
132 /* Clear INTRQ latch */
Hugh Dickins6311c902008-06-05 14:44:39 +0100133 status = ap->ops->sff_check_status(ap);
Alan Coxa57c1ba2008-05-29 22:10:58 +0100134 return status;
135}
136
137/**
138 * ata_sff_sync - Flush writes
139 * @ap: Port to wait for.
140 *
141 * CAUTION:
142 * If we have an mmio device with no ctl and no altstatus
143 * method this will fail. No such devices are known to exist.
144 *
145 * LOCKING:
146 * Inherited from caller.
147 */
148
149static void ata_sff_sync(struct ata_port *ap)
150{
151 if (ap->ops->sff_check_altstatus)
152 ap->ops->sff_check_altstatus(ap);
153 else if (ap->ioaddr.altstatus_addr)
154 ioread8(ap->ioaddr.altstatus_addr);
155}
156
157/**
158 * ata_sff_pause - Flush writes and wait 400nS
159 * @ap: Port to pause for.
160 *
161 * CAUTION:
162 * If we have an mmio device with no ctl and no altstatus
163 * method this will fail. No such devices are known to exist.
164 *
165 * LOCKING:
166 * Inherited from caller.
167 */
168
169void ata_sff_pause(struct ata_port *ap)
170{
171 ata_sff_sync(ap);
172 ndelay(400);
173}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000174EXPORT_SYMBOL_GPL(ata_sff_pause);
Alan Coxa57c1ba2008-05-29 22:10:58 +0100175
176/**
177 * ata_sff_dma_pause - Pause before commencing DMA
178 * @ap: Port to pause for.
179 *
180 * Perform I/O fencing and ensure sufficient cycle delays occur
181 * for the HDMA1:0 transition
182 */
Alan Cox0fe40ff2009-01-05 14:16:13 +0000183
Alan Coxa57c1ba2008-05-29 22:10:58 +0100184void ata_sff_dma_pause(struct ata_port *ap)
185{
186 if (ap->ops->sff_check_altstatus || ap->ioaddr.altstatus_addr) {
187 /* An altstatus read will cause the needed delay without
188 messing up the IRQ status */
189 ata_sff_altstatus(ap);
190 return;
191 }
192 /* There are no DMA controllers without ctl. BUG here to ensure
193 we never violate the HDMA1:0 transition timing and risk
194 corruption. */
195 BUG();
196}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000197EXPORT_SYMBOL_GPL(ata_sff_dma_pause);
Alan Coxa57c1ba2008-05-29 22:10:58 +0100198
199/**
Tejun Heo9363c382008-04-07 22:47:16 +0900200 * ata_sff_busy_sleep - sleep until BSY clears, or timeout
Tejun Heo624d5c52008-03-25 22:16:41 +0900201 * @ap: port containing status register to be polled
Tejun Heo341c2c92008-05-20 02:17:51 +0900202 * @tmout_pat: impatience timeout in msecs
203 * @tmout: overall timeout in msecs
Tejun Heo624d5c52008-03-25 22:16:41 +0900204 *
205 * Sleep until ATA Status register bit BSY clears,
206 * or a timeout occurs.
207 *
208 * LOCKING:
209 * Kernel thread context (may sleep).
210 *
211 * RETURNS:
212 * 0 on success, -errno otherwise.
213 */
Tejun Heo9363c382008-04-07 22:47:16 +0900214int ata_sff_busy_sleep(struct ata_port *ap,
215 unsigned long tmout_pat, unsigned long tmout)
Tejun Heo624d5c52008-03-25 22:16:41 +0900216{
217 unsigned long timer_start, timeout;
218 u8 status;
219
Tejun Heo9363c382008-04-07 22:47:16 +0900220 status = ata_sff_busy_wait(ap, ATA_BUSY, 300);
Tejun Heo624d5c52008-03-25 22:16:41 +0900221 timer_start = jiffies;
Tejun Heo341c2c92008-05-20 02:17:51 +0900222 timeout = ata_deadline(timer_start, tmout_pat);
Tejun Heo624d5c52008-03-25 22:16:41 +0900223 while (status != 0xff && (status & ATA_BUSY) &&
224 time_before(jiffies, timeout)) {
225 msleep(50);
Tejun Heo9363c382008-04-07 22:47:16 +0900226 status = ata_sff_busy_wait(ap, ATA_BUSY, 3);
Tejun Heo624d5c52008-03-25 22:16:41 +0900227 }
228
229 if (status != 0xff && (status & ATA_BUSY))
230 ata_port_printk(ap, KERN_WARNING,
231 "port is slow to respond, please be patient "
232 "(Status 0x%x)\n", status);
233
Tejun Heo341c2c92008-05-20 02:17:51 +0900234 timeout = ata_deadline(timer_start, tmout);
Tejun Heo624d5c52008-03-25 22:16:41 +0900235 while (status != 0xff && (status & ATA_BUSY) &&
236 time_before(jiffies, timeout)) {
237 msleep(50);
Tejun Heo5682ed32008-04-07 22:47:16 +0900238 status = ap->ops->sff_check_status(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +0900239 }
240
241 if (status == 0xff)
242 return -ENODEV;
243
244 if (status & ATA_BUSY) {
245 ata_port_printk(ap, KERN_ERR, "port failed to respond "
246 "(%lu secs, Status 0x%x)\n",
Tejun Heo341c2c92008-05-20 02:17:51 +0900247 DIV_ROUND_UP(tmout, 1000), status);
Tejun Heo624d5c52008-03-25 22:16:41 +0900248 return -EBUSY;
249 }
250
251 return 0;
252}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000253EXPORT_SYMBOL_GPL(ata_sff_busy_sleep);
Tejun Heo624d5c52008-03-25 22:16:41 +0900254
Tejun Heoaa2731a2008-04-07 22:47:19 +0900255static int ata_sff_check_ready(struct ata_link *link)
256{
257 u8 status = link->ap->ops->sff_check_status(link->ap);
258
Tejun Heo78ab88f2008-05-01 23:41:41 +0900259 return ata_check_ready(status);
Tejun Heoaa2731a2008-04-07 22:47:19 +0900260}
261
Tejun Heo624d5c52008-03-25 22:16:41 +0900262/**
Tejun Heo9363c382008-04-07 22:47:16 +0900263 * ata_sff_wait_ready - sleep until BSY clears, or timeout
Tejun Heo705e76b2008-04-07 22:47:19 +0900264 * @link: SFF link to wait ready status for
Tejun Heo624d5c52008-03-25 22:16:41 +0900265 * @deadline: deadline jiffies for the operation
266 *
267 * Sleep until ATA Status register bit BSY clears, or timeout
268 * occurs.
269 *
270 * LOCKING:
271 * Kernel thread context (may sleep).
272 *
273 * RETURNS:
274 * 0 on success, -errno otherwise.
275 */
Tejun Heo705e76b2008-04-07 22:47:19 +0900276int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline)
Tejun Heo624d5c52008-03-25 22:16:41 +0900277{
Tejun Heoaa2731a2008-04-07 22:47:19 +0900278 return ata_wait_ready(link, deadline, ata_sff_check_ready);
Tejun Heo624d5c52008-03-25 22:16:41 +0900279}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000280EXPORT_SYMBOL_GPL(ata_sff_wait_ready);
Tejun Heo624d5c52008-03-25 22:16:41 +0900281
282/**
Sergei Shtylyov41dec292010-05-07 22:47:50 +0400283 * ata_sff_set_devctl - Write device control reg
284 * @ap: port where the device is
285 * @ctl: value to write
286 *
287 * Writes ATA taskfile device control register.
288 *
289 * Note: may NOT be used as the sff_set_devctl() entry in
290 * ata_port_operations.
291 *
292 * LOCKING:
293 * Inherited from caller.
294 */
295static void ata_sff_set_devctl(struct ata_port *ap, u8 ctl)
296{
297 if (ap->ops->sff_set_devctl)
298 ap->ops->sff_set_devctl(ap, ctl);
299 else
300 iowrite8(ctl, ap->ioaddr.ctl_addr);
301}
302
303/**
Tejun Heo9363c382008-04-07 22:47:16 +0900304 * ata_sff_dev_select - Select device 0/1 on ATA bus
Tejun Heo624d5c52008-03-25 22:16:41 +0900305 * @ap: ATA channel to manipulate
306 * @device: ATA device (numbered from zero) to select
307 *
308 * Use the method defined in the ATA specification to
309 * make either device 0, or device 1, active on the
310 * ATA channel. Works with both PIO and MMIO.
311 *
312 * May be used as the dev_select() entry in ata_port_operations.
313 *
314 * LOCKING:
315 * caller.
316 */
Tejun Heo9363c382008-04-07 22:47:16 +0900317void ata_sff_dev_select(struct ata_port *ap, unsigned int device)
Tejun Heo624d5c52008-03-25 22:16:41 +0900318{
319 u8 tmp;
320
321 if (device == 0)
322 tmp = ATA_DEVICE_OBS;
323 else
324 tmp = ATA_DEVICE_OBS | ATA_DEV1;
325
326 iowrite8(tmp, ap->ioaddr.device_addr);
Tejun Heo9363c382008-04-07 22:47:16 +0900327 ata_sff_pause(ap); /* needed; also flushes, for mmio */
Tejun Heo624d5c52008-03-25 22:16:41 +0900328}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000329EXPORT_SYMBOL_GPL(ata_sff_dev_select);
Tejun Heo624d5c52008-03-25 22:16:41 +0900330
331/**
332 * ata_dev_select - Select device 0/1 on ATA bus
333 * @ap: ATA channel to manipulate
334 * @device: ATA device (numbered from zero) to select
335 * @wait: non-zero to wait for Status register BSY bit to clear
336 * @can_sleep: non-zero if context allows sleeping
337 *
338 * Use the method defined in the ATA specification to
339 * make either device 0, or device 1, active on the
340 * ATA channel.
341 *
Tejun Heo9363c382008-04-07 22:47:16 +0900342 * This is a high-level version of ata_sff_dev_select(), which
343 * additionally provides the services of inserting the proper
344 * pauses and status polling, where needed.
Tejun Heo624d5c52008-03-25 22:16:41 +0900345 *
346 * LOCKING:
347 * caller.
348 */
Tejun Heoc7a82092010-05-10 21:41:29 +0200349static void ata_dev_select(struct ata_port *ap, unsigned int device,
Tejun Heo624d5c52008-03-25 22:16:41 +0900350 unsigned int wait, unsigned int can_sleep)
351{
352 if (ata_msg_probe(ap))
353 ata_port_printk(ap, KERN_INFO, "ata_dev_select: ENTER, "
354 "device %u, wait %u\n", device, wait);
355
356 if (wait)
357 ata_wait_idle(ap);
358
Tejun Heo5682ed32008-04-07 22:47:16 +0900359 ap->ops->sff_dev_select(ap, device);
Tejun Heo624d5c52008-03-25 22:16:41 +0900360
361 if (wait) {
362 if (can_sleep && ap->link.device[device].class == ATA_DEV_ATAPI)
363 msleep(150);
364 ata_wait_idle(ap);
365 }
366}
367
368/**
Tejun Heo9363c382008-04-07 22:47:16 +0900369 * ata_sff_irq_on - Enable interrupts on a port.
Tejun Heo90088bb2006-10-09 11:10:26 +0900370 * @ap: Port on which interrupts are enabled.
371 *
372 * Enable interrupts on a legacy IDE device using MMIO or PIO,
373 * wait for idle, clear any pending interrupts.
374 *
Sergei Shtylyove42a5422010-05-07 22:49:02 +0400375 * Note: may NOT be used as the sff_irq_on() entry in
376 * ata_port_operations.
377 *
Tejun Heo90088bb2006-10-09 11:10:26 +0900378 * LOCKING:
379 * Inherited from caller.
380 */
Sergei Shtylyove42a5422010-05-07 22:49:02 +0400381void ata_sff_irq_on(struct ata_port *ap)
Tejun Heo90088bb2006-10-09 11:10:26 +0900382{
383 struct ata_ioports *ioaddr = &ap->ioaddr;
Sergei Shtylyove42a5422010-05-07 22:49:02 +0400384
385 if (ap->ops->sff_irq_on) {
386 ap->ops->sff_irq_on(ap);
387 return;
388 }
Tejun Heo90088bb2006-10-09 11:10:26 +0900389
390 ap->ctl &= ~ATA_NIEN;
391 ap->last_ctl = ap->ctl;
392
Sergei Shtylyove42a5422010-05-07 22:49:02 +0400393 if (ap->ops->sff_set_devctl || ioaddr->ctl_addr)
394 ata_sff_set_devctl(ap, ap->ctl);
395 ata_wait_idle(ap);
Tejun Heo90088bb2006-10-09 11:10:26 +0900396
Tejun Heo37f65b82010-05-19 22:10:20 +0200397 if (ap->ops->sff_irq_clear)
398 ap->ops->sff_irq_clear(ap);
Tejun Heo90088bb2006-10-09 11:10:26 +0900399}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000400EXPORT_SYMBOL_GPL(ata_sff_irq_on);
Tejun Heo90088bb2006-10-09 11:10:26 +0900401
402/**
Tejun Heo9363c382008-04-07 22:47:16 +0900403 * ata_sff_tf_load - send taskfile registers to host controller
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500404 * @ap: Port to which output is sent
405 * @tf: ATA taskfile register set
406 *
407 * Outputs ATA taskfile to standard ATA host controller.
408 *
409 * LOCKING:
410 * Inherited from caller.
411 */
Tejun Heo9363c382008-04-07 22:47:16 +0900412void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf)
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500413{
Tejun Heo0d5ff562007-02-01 15:06:36 +0900414 struct ata_ioports *ioaddr = &ap->ioaddr;
415 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
416
417 if (tf->ctl != ap->last_ctl) {
Tejun Heof659f0e42008-03-06 13:12:54 +0900418 if (ioaddr->ctl_addr)
419 iowrite8(tf->ctl, ioaddr->ctl_addr);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900420 ap->last_ctl = tf->ctl;
Tejun Heo40c60232010-09-09 17:13:31 +0200421 ata_wait_idle(ap);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900422 }
423
424 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
Tejun Heoefcb3cf2009-01-09 19:19:14 +0900425 WARN_ON_ONCE(!ioaddr->ctl_addr);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900426 iowrite8(tf->hob_feature, ioaddr->feature_addr);
427 iowrite8(tf->hob_nsect, ioaddr->nsect_addr);
428 iowrite8(tf->hob_lbal, ioaddr->lbal_addr);
429 iowrite8(tf->hob_lbam, ioaddr->lbam_addr);
430 iowrite8(tf->hob_lbah, ioaddr->lbah_addr);
431 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
432 tf->hob_feature,
433 tf->hob_nsect,
434 tf->hob_lbal,
435 tf->hob_lbam,
436 tf->hob_lbah);
437 }
438
439 if (is_addr) {
440 iowrite8(tf->feature, ioaddr->feature_addr);
441 iowrite8(tf->nsect, ioaddr->nsect_addr);
442 iowrite8(tf->lbal, ioaddr->lbal_addr);
443 iowrite8(tf->lbam, ioaddr->lbam_addr);
444 iowrite8(tf->lbah, ioaddr->lbah_addr);
445 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
446 tf->feature,
447 tf->nsect,
448 tf->lbal,
449 tf->lbam,
450 tf->lbah);
451 }
452
453 if (tf->flags & ATA_TFLAG_DEVICE) {
454 iowrite8(tf->device, ioaddr->device_addr);
455 VPRINTK("device 0x%X\n", tf->device);
456 }
Tejun Heo40c60232010-09-09 17:13:31 +0200457
458 ata_wait_idle(ap);
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500459}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000460EXPORT_SYMBOL_GPL(ata_sff_tf_load);
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500461
462/**
Tejun Heo9363c382008-04-07 22:47:16 +0900463 * ata_sff_tf_read - input device's ATA taskfile shadow registers
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500464 * @ap: Port from which input is read
465 * @tf: ATA taskfile register set for storing input
466 *
467 * Reads ATA taskfile registers for currently-selected device
Alan Cox76548ed2007-11-19 14:34:56 +0000468 * into @tf. Assumes the device has a fully SFF compliant task file
469 * layout and behaviour. If you device does not (eg has a different
470 * status method) then you will need to provide a replacement tf_read
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500471 *
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500472 * LOCKING:
473 * Inherited from caller.
474 */
Tejun Heo9363c382008-04-07 22:47:16 +0900475void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500476{
Tejun Heo0d5ff562007-02-01 15:06:36 +0900477 struct ata_ioports *ioaddr = &ap->ioaddr;
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500478
Tejun Heo9363c382008-04-07 22:47:16 +0900479 tf->command = ata_sff_check_status(ap);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900480 tf->feature = ioread8(ioaddr->error_addr);
481 tf->nsect = ioread8(ioaddr->nsect_addr);
482 tf->lbal = ioread8(ioaddr->lbal_addr);
483 tf->lbam = ioread8(ioaddr->lbam_addr);
484 tf->lbah = ioread8(ioaddr->lbah_addr);
485 tf->device = ioread8(ioaddr->device_addr);
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500486
Tejun Heo0d5ff562007-02-01 15:06:36 +0900487 if (tf->flags & ATA_TFLAG_LBA48) {
Tejun Heof659f0e42008-03-06 13:12:54 +0900488 if (likely(ioaddr->ctl_addr)) {
489 iowrite8(tf->ctl | ATA_HOB, ioaddr->ctl_addr);
490 tf->hob_feature = ioread8(ioaddr->error_addr);
491 tf->hob_nsect = ioread8(ioaddr->nsect_addr);
492 tf->hob_lbal = ioread8(ioaddr->lbal_addr);
493 tf->hob_lbam = ioread8(ioaddr->lbam_addr);
494 tf->hob_lbah = ioread8(ioaddr->lbah_addr);
495 iowrite8(tf->ctl, ioaddr->ctl_addr);
496 ap->last_ctl = tf->ctl;
497 } else
Tejun Heoefcb3cf2009-01-09 19:19:14 +0900498 WARN_ON_ONCE(1);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900499 }
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500500}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000501EXPORT_SYMBOL_GPL(ata_sff_tf_read);
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500502
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500503/**
Tejun Heo9363c382008-04-07 22:47:16 +0900504 * ata_sff_exec_command - issue ATA command to host controller
Tejun Heo272f7882008-03-25 22:16:40 +0900505 * @ap: port to which command is being issued
506 * @tf: ATA taskfile register set
Jeff Garzik1fdffbc2006-02-09 05:15:27 -0500507 *
Tejun Heo272f7882008-03-25 22:16:40 +0900508 * Issues ATA command, with proper synchronization with interrupt
509 * handler / other threads.
Jeff Garzik2cc432e2006-03-23 00:32:03 -0500510 *
511 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -0400512 * spin_lock_irqsave(host lock)
Jeff Garzik2cc432e2006-03-23 00:32:03 -0500513 */
Tejun Heo9363c382008-04-07 22:47:16 +0900514void ata_sff_exec_command(struct ata_port *ap, const struct ata_taskfile *tf)
Jeff Garzik2cc432e2006-03-23 00:32:03 -0500515{
Tejun Heo272f7882008-03-25 22:16:40 +0900516 DPRINTK("ata%u: cmd 0x%X\n", ap->print_id, tf->command);
Jeff Garzik2cc432e2006-03-23 00:32:03 -0500517
Tejun Heo272f7882008-03-25 22:16:40 +0900518 iowrite8(tf->command, ap->ioaddr.command_addr);
Tejun Heo9363c382008-04-07 22:47:16 +0900519 ata_sff_pause(ap);
Jeff Garzik2cc432e2006-03-23 00:32:03 -0500520}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000521EXPORT_SYMBOL_GPL(ata_sff_exec_command);
Jeff Garzik2cc432e2006-03-23 00:32:03 -0500522
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900523/**
Tejun Heo624d5c52008-03-25 22:16:41 +0900524 * ata_tf_to_host - issue ATA taskfile to host controller
525 * @ap: port to which command is being issued
526 * @tf: ATA taskfile register set
527 *
528 * Issues ATA taskfile register set to ATA host controller,
529 * with proper synchronization with interrupt handler and
530 * other threads.
531 *
532 * LOCKING:
533 * spin_lock_irqsave(host lock)
534 */
535static inline void ata_tf_to_host(struct ata_port *ap,
536 const struct ata_taskfile *tf)
537{
Tejun Heo5682ed32008-04-07 22:47:16 +0900538 ap->ops->sff_tf_load(ap, tf);
539 ap->ops->sff_exec_command(ap, tf);
Tejun Heo624d5c52008-03-25 22:16:41 +0900540}
541
542/**
Tejun Heo9363c382008-04-07 22:47:16 +0900543 * ata_sff_data_xfer - Transfer data by PIO
Tejun Heo624d5c52008-03-25 22:16:41 +0900544 * @dev: device to target
545 * @buf: data buffer
546 * @buflen: buffer length
547 * @rw: read/write
548 *
549 * Transfer data from/to the device data register by PIO.
550 *
551 * LOCKING:
552 * Inherited from caller.
553 *
554 * RETURNS:
555 * Bytes consumed.
556 */
Tejun Heo9363c382008-04-07 22:47:16 +0900557unsigned int ata_sff_data_xfer(struct ata_device *dev, unsigned char *buf,
558 unsigned int buflen, int rw)
Tejun Heo624d5c52008-03-25 22:16:41 +0900559{
560 struct ata_port *ap = dev->link->ap;
561 void __iomem *data_addr = ap->ioaddr.data_addr;
562 unsigned int words = buflen >> 1;
563
564 /* Transfer multiple of 2 bytes */
565 if (rw == READ)
566 ioread16_rep(data_addr, buf, words);
567 else
568 iowrite16_rep(data_addr, buf, words);
569
Sergei Shtylyov2102d742009-02-15 23:30:38 +0400570 /* Transfer trailing byte, if any. */
Tejun Heo624d5c52008-03-25 22:16:41 +0900571 if (unlikely(buflen & 0x01)) {
Sergei Shtylyov2102d742009-02-15 23:30:38 +0400572 unsigned char pad[2];
Tejun Heo624d5c52008-03-25 22:16:41 +0900573
Sergei Shtylyov2102d742009-02-15 23:30:38 +0400574 /* Point buf to the tail of buffer */
575 buf += buflen - 1;
576
577 /*
578 * Use io*16_rep() accessors here as well to avoid pointlessly
Krzysztof Halasa972b94f2009-11-11 00:55:27 +0100579 * swapping bytes to and from on the big endian machines...
Sergei Shtylyov2102d742009-02-15 23:30:38 +0400580 */
Tejun Heo624d5c52008-03-25 22:16:41 +0900581 if (rw == READ) {
Sergei Shtylyov2102d742009-02-15 23:30:38 +0400582 ioread16_rep(data_addr, pad, 1);
583 *buf = pad[0];
Tejun Heo624d5c52008-03-25 22:16:41 +0900584 } else {
Sergei Shtylyov2102d742009-02-15 23:30:38 +0400585 pad[0] = *buf;
586 iowrite16_rep(data_addr, pad, 1);
Tejun Heo624d5c52008-03-25 22:16:41 +0900587 }
588 words++;
589 }
590
591 return words << 1;
592}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000593EXPORT_SYMBOL_GPL(ata_sff_data_xfer);
Tejun Heo624d5c52008-03-25 22:16:41 +0900594
595/**
Alan Cox871af122009-01-05 14:16:39 +0000596 * ata_sff_data_xfer32 - Transfer data by PIO
597 * @dev: device to target
598 * @buf: data buffer
599 * @buflen: buffer length
600 * @rw: read/write
601 *
602 * Transfer data from/to the device data register by PIO using 32bit
603 * I/O operations.
604 *
605 * LOCKING:
606 * Inherited from caller.
607 *
608 * RETURNS:
609 * Bytes consumed.
610 */
611
612unsigned int ata_sff_data_xfer32(struct ata_device *dev, unsigned char *buf,
613 unsigned int buflen, int rw)
614{
615 struct ata_port *ap = dev->link->ap;
616 void __iomem *data_addr = ap->ioaddr.data_addr;
617 unsigned int words = buflen >> 2;
618 int slop = buflen & 3;
Krzysztof Halasa972b94f2009-11-11 00:55:27 +0100619
Alan Coxe3cf95d2009-04-09 17:31:17 +0100620 if (!(ap->pflags & ATA_PFLAG_PIO32))
621 return ata_sff_data_xfer(dev, buf, buflen, rw);
Alan Cox871af122009-01-05 14:16:39 +0000622
623 /* Transfer multiple of 4 bytes */
624 if (rw == READ)
625 ioread32_rep(data_addr, buf, words);
626 else
627 iowrite32_rep(data_addr, buf, words);
628
Sergei Shtylyovd1b35252009-02-15 23:24:24 +0400629 /* Transfer trailing bytes, if any */
Alan Cox871af122009-01-05 14:16:39 +0000630 if (unlikely(slop)) {
Sergei Shtylyovd1b35252009-02-15 23:24:24 +0400631 unsigned char pad[4];
632
633 /* Point buf to the tail of buffer */
634 buf += buflen - slop;
635
636 /*
637 * Use io*_rep() accessors here as well to avoid pointlessly
Krzysztof Halasa972b94f2009-11-11 00:55:27 +0100638 * swapping bytes to and from on the big endian machines...
Sergei Shtylyovd1b35252009-02-15 23:24:24 +0400639 */
Alan Cox871af122009-01-05 14:16:39 +0000640 if (rw == READ) {
Sergei Shtylyovd1b35252009-02-15 23:24:24 +0400641 if (slop < 3)
642 ioread16_rep(data_addr, pad, 1);
643 else
644 ioread32_rep(data_addr, pad, 1);
645 memcpy(buf, pad, slop);
Alan Cox871af122009-01-05 14:16:39 +0000646 } else {
Sergei Shtylyovd1b35252009-02-15 23:24:24 +0400647 memcpy(pad, buf, slop);
648 if (slop < 3)
649 iowrite16_rep(data_addr, pad, 1);
650 else
651 iowrite32_rep(data_addr, pad, 1);
Alan Cox871af122009-01-05 14:16:39 +0000652 }
Alan Cox871af122009-01-05 14:16:39 +0000653 }
Sergei Shtylyovd1b35252009-02-15 23:24:24 +0400654 return (buflen + 1) & ~1;
Alan Cox871af122009-01-05 14:16:39 +0000655}
656EXPORT_SYMBOL_GPL(ata_sff_data_xfer32);
657
658/**
Tejun Heo9363c382008-04-07 22:47:16 +0900659 * ata_sff_data_xfer_noirq - Transfer data by PIO
Tejun Heo624d5c52008-03-25 22:16:41 +0900660 * @dev: device to target
661 * @buf: data buffer
662 * @buflen: buffer length
663 * @rw: read/write
664 *
665 * Transfer data from/to the device data register by PIO. Do the
666 * transfer with interrupts disabled.
667 *
668 * LOCKING:
669 * Inherited from caller.
670 *
671 * RETURNS:
672 * Bytes consumed.
673 */
Tejun Heo9363c382008-04-07 22:47:16 +0900674unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev, unsigned char *buf,
675 unsigned int buflen, int rw)
Tejun Heo624d5c52008-03-25 22:16:41 +0900676{
677 unsigned long flags;
678 unsigned int consumed;
679
680 local_irq_save(flags);
Tejun Heo9363c382008-04-07 22:47:16 +0900681 consumed = ata_sff_data_xfer(dev, buf, buflen, rw);
Tejun Heo624d5c52008-03-25 22:16:41 +0900682 local_irq_restore(flags);
683
684 return consumed;
685}
Alan Cox0fe40ff2009-01-05 14:16:13 +0000686EXPORT_SYMBOL_GPL(ata_sff_data_xfer_noirq);
Tejun Heo624d5c52008-03-25 22:16:41 +0900687
688/**
689 * ata_pio_sector - Transfer a sector of data.
690 * @qc: Command on going
691 *
692 * Transfer qc->sect_size bytes of data from/to the ATA device.
693 *
694 * LOCKING:
695 * Inherited from caller.
696 */
697static void ata_pio_sector(struct ata_queued_cmd *qc)
698{
699 int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
700 struct ata_port *ap = qc->ap;
701 struct page *page;
702 unsigned int offset;
703 unsigned char *buf;
704
705 if (qc->curbytes == qc->nbytes - qc->sect_size)
706 ap->hsm_task_state = HSM_ST_LAST;
707
708 page = sg_page(qc->cursg);
709 offset = qc->cursg->offset + qc->cursg_ofs;
710
711 /* get the current page and offset */
712 page = nth_page(page, (offset >> PAGE_SHIFT));
713 offset %= PAGE_SIZE;
714
715 DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
716
717 if (PageHighMem(page)) {
718 unsigned long flags;
719
720 /* FIXME: use a bounce buffer */
721 local_irq_save(flags);
722 buf = kmap_atomic(page, KM_IRQ0);
723
724 /* do the actual data transfer */
Tejun Heo5682ed32008-04-07 22:47:16 +0900725 ap->ops->sff_data_xfer(qc->dev, buf + offset, qc->sect_size,
726 do_write);
Tejun Heo624d5c52008-03-25 22:16:41 +0900727
728 kunmap_atomic(buf, KM_IRQ0);
729 local_irq_restore(flags);
730 } else {
731 buf = page_address(page);
Tejun Heo5682ed32008-04-07 22:47:16 +0900732 ap->ops->sff_data_xfer(qc->dev, buf + offset, qc->sect_size,
733 do_write);
Tejun Heo624d5c52008-03-25 22:16:41 +0900734 }
735
Sebastian Andrzej Siewior3842e832010-03-21 22:52:23 +0100736 if (!do_write && !PageSlab(page))
Catalin Marinas2d68b7f2010-02-04 01:04:50 -0500737 flush_dcache_page(page);
738
Tejun Heo624d5c52008-03-25 22:16:41 +0900739 qc->curbytes += qc->sect_size;
740 qc->cursg_ofs += qc->sect_size;
741
742 if (qc->cursg_ofs == qc->cursg->length) {
743 qc->cursg = sg_next(qc->cursg);
744 qc->cursg_ofs = 0;
745 }
746}
747
748/**
749 * ata_pio_sectors - Transfer one or many sectors.
750 * @qc: Command on going
751 *
752 * Transfer one or many sectors of data from/to the
753 * ATA device for the DRQ request.
754 *
755 * LOCKING:
756 * Inherited from caller.
757 */
758static void ata_pio_sectors(struct ata_queued_cmd *qc)
759{
760 if (is_multi_taskfile(&qc->tf)) {
761 /* READ/WRITE MULTIPLE */
762 unsigned int nsect;
763
Tejun Heoefcb3cf2009-01-09 19:19:14 +0900764 WARN_ON_ONCE(qc->dev->multi_count == 0);
Tejun Heo624d5c52008-03-25 22:16:41 +0900765
766 nsect = min((qc->nbytes - qc->curbytes) / qc->sect_size,
767 qc->dev->multi_count);
768 while (nsect--)
769 ata_pio_sector(qc);
770 } else
771 ata_pio_sector(qc);
772
Alan Coxa57c1ba2008-05-29 22:10:58 +0100773 ata_sff_sync(qc->ap); /* flush */
Tejun Heo624d5c52008-03-25 22:16:41 +0900774}
775
776/**
777 * atapi_send_cdb - Write CDB bytes to hardware
778 * @ap: Port to which ATAPI device is attached.
779 * @qc: Taskfile currently active
780 *
781 * When device has indicated its readiness to accept
782 * a CDB, this function is called. Send the CDB.
783 *
784 * LOCKING:
785 * caller.
786 */
787static void atapi_send_cdb(struct ata_port *ap, struct ata_queued_cmd *qc)
788{
789 /* send SCSI cdb */
790 DPRINTK("send cdb\n");
Tejun Heoefcb3cf2009-01-09 19:19:14 +0900791 WARN_ON_ONCE(qc->dev->cdb_len < 12);
Tejun Heo624d5c52008-03-25 22:16:41 +0900792
Tejun Heo5682ed32008-04-07 22:47:16 +0900793 ap->ops->sff_data_xfer(qc->dev, qc->cdb, qc->dev->cdb_len, 1);
Alan Coxa57c1ba2008-05-29 22:10:58 +0100794 ata_sff_sync(ap);
795 /* FIXME: If the CDB is for DMA do we need to do the transition delay
796 or is bmdma_start guaranteed to do it ? */
Tejun Heo624d5c52008-03-25 22:16:41 +0900797 switch (qc->tf.protocol) {
798 case ATAPI_PROT_PIO:
799 ap->hsm_task_state = HSM_ST;
800 break;
801 case ATAPI_PROT_NODATA:
802 ap->hsm_task_state = HSM_ST_LAST;
803 break;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200804#ifdef CONFIG_ATA_BMDMA
Tejun Heo624d5c52008-03-25 22:16:41 +0900805 case ATAPI_PROT_DMA:
806 ap->hsm_task_state = HSM_ST_LAST;
807 /* initiate bmdma */
808 ap->ops->bmdma_start(qc);
809 break;
Tejun Heo9a7780c2010-05-19 22:10:24 +0200810#endif /* CONFIG_ATA_BMDMA */
811 default:
812 BUG();
Tejun Heo624d5c52008-03-25 22:16:41 +0900813 }
814}
815
816/**
817 * __atapi_pio_bytes - Transfer data from/to the ATAPI device.
818 * @qc: Command on going
819 * @bytes: number of bytes
820 *
821 * Transfer Transfer data from/to the ATAPI device.
822 *
823 * LOCKING:
824 * Inherited from caller.
825 *
826 */
827static int __atapi_pio_bytes(struct ata_queued_cmd *qc, unsigned int bytes)
828{
829 int rw = (qc->tf.flags & ATA_TFLAG_WRITE) ? WRITE : READ;
830 struct ata_port *ap = qc->ap;
831 struct ata_device *dev = qc->dev;
832 struct ata_eh_info *ehi = &dev->link->eh_info;
833 struct scatterlist *sg;
834 struct page *page;
835 unsigned char *buf;
836 unsigned int offset, count, consumed;
837
838next_sg:
839 sg = qc->cursg;
840 if (unlikely(!sg)) {
841 ata_ehi_push_desc(ehi, "unexpected or too much trailing data "
842 "buf=%u cur=%u bytes=%u",
843 qc->nbytes, qc->curbytes, bytes);
844 return -1;
845 }
846
847 page = sg_page(sg);
848 offset = sg->offset + qc->cursg_ofs;
849
850 /* get the current page and offset */
851 page = nth_page(page, (offset >> PAGE_SHIFT));
852 offset %= PAGE_SIZE;
853
854 /* don't overrun current sg */
855 count = min(sg->length - qc->cursg_ofs, bytes);
856
857 /* don't cross page boundaries */
858 count = min(count, (unsigned int)PAGE_SIZE - offset);
859
860 DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
861
862 if (PageHighMem(page)) {
863 unsigned long flags;
864
865 /* FIXME: use bounce buffer */
866 local_irq_save(flags);
867 buf = kmap_atomic(page, KM_IRQ0);
868
869 /* do the actual data transfer */
Alan Cox0fe40ff2009-01-05 14:16:13 +0000870 consumed = ap->ops->sff_data_xfer(dev, buf + offset,
871 count, rw);
Tejun Heo624d5c52008-03-25 22:16:41 +0900872
873 kunmap_atomic(buf, KM_IRQ0);
874 local_irq_restore(flags);
875 } else {
876 buf = page_address(page);
Alan Cox0fe40ff2009-01-05 14:16:13 +0000877 consumed = ap->ops->sff_data_xfer(dev, buf + offset,
878 count, rw);
Tejun Heo624d5c52008-03-25 22:16:41 +0900879 }
880
881 bytes -= min(bytes, consumed);
882 qc->curbytes += count;
883 qc->cursg_ofs += count;
884
885 if (qc->cursg_ofs == sg->length) {
886 qc->cursg = sg_next(qc->cursg);
887 qc->cursg_ofs = 0;
888 }
889
Christian Borntraegera0f79f72009-01-13 10:38:36 +0100890 /*
891 * There used to be a WARN_ON_ONCE(qc->cursg && count != consumed);
892 * Unfortunately __atapi_pio_bytes doesn't know enough to do the WARN
893 * check correctly as it doesn't know if it is the last request being
894 * made. Somebody should implement a proper sanity check.
895 */
Tejun Heo624d5c52008-03-25 22:16:41 +0900896 if (bytes)
897 goto next_sg;
898 return 0;
899}
900
901/**
902 * atapi_pio_bytes - Transfer data from/to the ATAPI device.
903 * @qc: Command on going
904 *
905 * Transfer Transfer data from/to the ATAPI device.
906 *
907 * LOCKING:
908 * Inherited from caller.
909 */
910static void atapi_pio_bytes(struct ata_queued_cmd *qc)
911{
912 struct ata_port *ap = qc->ap;
913 struct ata_device *dev = qc->dev;
914 struct ata_eh_info *ehi = &dev->link->eh_info;
915 unsigned int ireason, bc_lo, bc_hi, bytes;
916 int i_write, do_write = (qc->tf.flags & ATA_TFLAG_WRITE) ? 1 : 0;
917
918 /* Abuse qc->result_tf for temp storage of intermediate TF
919 * here to save some kernel stack usage.
920 * For normal completion, qc->result_tf is not relevant. For
921 * error, qc->result_tf is later overwritten by ata_qc_complete().
922 * So, the correctness of qc->result_tf is not affected.
923 */
Tejun Heo5682ed32008-04-07 22:47:16 +0900924 ap->ops->sff_tf_read(ap, &qc->result_tf);
Tejun Heo624d5c52008-03-25 22:16:41 +0900925 ireason = qc->result_tf.nsect;
926 bc_lo = qc->result_tf.lbam;
927 bc_hi = qc->result_tf.lbah;
928 bytes = (bc_hi << 8) | bc_lo;
929
930 /* shall be cleared to zero, indicating xfer of data */
931 if (unlikely(ireason & (1 << 0)))
932 goto atapi_check;
933
934 /* make sure transfer direction matches expected */
935 i_write = ((ireason & (1 << 1)) == 0) ? 1 : 0;
936 if (unlikely(do_write != i_write))
937 goto atapi_check;
938
939 if (unlikely(!bytes))
940 goto atapi_check;
941
942 VPRINTK("ata%u: xfering %d bytes\n", ap->print_id, bytes);
943
944 if (unlikely(__atapi_pio_bytes(qc, bytes)))
945 goto err_out;
Alan Coxa57c1ba2008-05-29 22:10:58 +0100946 ata_sff_sync(ap); /* flush */
Tejun Heo624d5c52008-03-25 22:16:41 +0900947
948 return;
949
950 atapi_check:
951 ata_ehi_push_desc(ehi, "ATAPI check failed (ireason=0x%x bytes=%u)",
952 ireason, bytes);
953 err_out:
954 qc->err_mask |= AC_ERR_HSM;
955 ap->hsm_task_state = HSM_ST_ERR;
956}
957
958/**
959 * ata_hsm_ok_in_wq - Check if the qc can be handled in the workqueue.
960 * @ap: the target ata_port
961 * @qc: qc on going
962 *
963 * RETURNS:
964 * 1 if ok in workqueue, 0 otherwise.
965 */
Alan Cox0fe40ff2009-01-05 14:16:13 +0000966static inline int ata_hsm_ok_in_wq(struct ata_port *ap,
967 struct ata_queued_cmd *qc)
Tejun Heo624d5c52008-03-25 22:16:41 +0900968{
969 if (qc->tf.flags & ATA_TFLAG_POLLING)
970 return 1;
971
972 if (ap->hsm_task_state == HSM_ST_FIRST) {
973 if (qc->tf.protocol == ATA_PROT_PIO &&
Alan Cox0fe40ff2009-01-05 14:16:13 +0000974 (qc->tf.flags & ATA_TFLAG_WRITE))
Tejun Heo624d5c52008-03-25 22:16:41 +0900975 return 1;
976
977 if (ata_is_atapi(qc->tf.protocol) &&
Alan Cox0fe40ff2009-01-05 14:16:13 +0000978 !(qc->dev->flags & ATA_DFLAG_CDB_INTR))
Tejun Heo624d5c52008-03-25 22:16:41 +0900979 return 1;
980 }
981
982 return 0;
983}
984
985/**
986 * ata_hsm_qc_complete - finish a qc running on standard HSM
987 * @qc: Command to complete
988 * @in_wq: 1 if called from workqueue, 0 otherwise
989 *
990 * Finish @qc which is running on standard HSM.
991 *
992 * LOCKING:
993 * If @in_wq is zero, spin_lock_irqsave(host lock).
994 * Otherwise, none on entry and grabs host lock.
995 */
996static void ata_hsm_qc_complete(struct ata_queued_cmd *qc, int in_wq)
997{
998 struct ata_port *ap = qc->ap;
999 unsigned long flags;
1000
1001 if (ap->ops->error_handler) {
1002 if (in_wq) {
1003 spin_lock_irqsave(ap->lock, flags);
1004
1005 /* EH might have kicked in while host lock is
1006 * released.
1007 */
1008 qc = ata_qc_from_tag(ap, qc->tag);
1009 if (qc) {
1010 if (likely(!(qc->err_mask & AC_ERR_HSM))) {
Sergei Shtylyove42a5422010-05-07 22:49:02 +04001011 ata_sff_irq_on(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001012 ata_qc_complete(qc);
1013 } else
1014 ata_port_freeze(ap);
1015 }
1016
1017 spin_unlock_irqrestore(ap->lock, flags);
1018 } else {
1019 if (likely(!(qc->err_mask & AC_ERR_HSM)))
1020 ata_qc_complete(qc);
1021 else
1022 ata_port_freeze(ap);
1023 }
1024 } else {
1025 if (in_wq) {
1026 spin_lock_irqsave(ap->lock, flags);
Sergei Shtylyove42a5422010-05-07 22:49:02 +04001027 ata_sff_irq_on(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001028 ata_qc_complete(qc);
1029 spin_unlock_irqrestore(ap->lock, flags);
1030 } else
1031 ata_qc_complete(qc);
1032 }
1033}
1034
1035/**
Tejun Heo9363c382008-04-07 22:47:16 +09001036 * ata_sff_hsm_move - move the HSM to the next state.
Tejun Heo624d5c52008-03-25 22:16:41 +09001037 * @ap: the target ata_port
1038 * @qc: qc on going
1039 * @status: current device status
1040 * @in_wq: 1 if called from workqueue, 0 otherwise
1041 *
1042 * RETURNS:
1043 * 1 when poll next status needed, 0 otherwise.
1044 */
Tejun Heo9363c382008-04-07 22:47:16 +09001045int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1046 u8 status, int in_wq)
Tejun Heo624d5c52008-03-25 22:16:41 +09001047{
Tejun Heoa836d3e2008-06-28 01:39:43 +09001048 struct ata_eh_info *ehi = &ap->link.eh_info;
Tejun Heo624d5c52008-03-25 22:16:41 +09001049 unsigned long flags = 0;
1050 int poll_next;
1051
Tejun Heoefcb3cf2009-01-09 19:19:14 +09001052 WARN_ON_ONCE((qc->flags & ATA_QCFLAG_ACTIVE) == 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09001053
Tejun Heo9363c382008-04-07 22:47:16 +09001054 /* Make sure ata_sff_qc_issue() does not throw things
Tejun Heo624d5c52008-03-25 22:16:41 +09001055 * like DMA polling into the workqueue. Notice that
1056 * in_wq is not equivalent to (qc->tf.flags & ATA_TFLAG_POLLING).
1057 */
Tejun Heoefcb3cf2009-01-09 19:19:14 +09001058 WARN_ON_ONCE(in_wq != ata_hsm_ok_in_wq(ap, qc));
Tejun Heo624d5c52008-03-25 22:16:41 +09001059
1060fsm_start:
1061 DPRINTK("ata%u: protocol %d task_state %d (dev_stat 0x%X)\n",
1062 ap->print_id, qc->tf.protocol, ap->hsm_task_state, status);
1063
1064 switch (ap->hsm_task_state) {
1065 case HSM_ST_FIRST:
1066 /* Send first data block or PACKET CDB */
1067
1068 /* If polling, we will stay in the work queue after
1069 * sending the data. Otherwise, interrupt handler
1070 * takes over after sending the data.
1071 */
1072 poll_next = (qc->tf.flags & ATA_TFLAG_POLLING);
1073
1074 /* check device status */
1075 if (unlikely((status & ATA_DRQ) == 0)) {
1076 /* handle BSY=0, DRQ=0 as error */
1077 if (likely(status & (ATA_ERR | ATA_DF)))
1078 /* device stops HSM for abort/error */
1079 qc->err_mask |= AC_ERR_DEV;
Tejun Heoa836d3e2008-06-28 01:39:43 +09001080 else {
Tejun Heo624d5c52008-03-25 22:16:41 +09001081 /* HSM violation. Let EH handle this */
Tejun Heoa836d3e2008-06-28 01:39:43 +09001082 ata_ehi_push_desc(ehi,
1083 "ST_FIRST: !(DRQ|ERR|DF)");
Tejun Heo624d5c52008-03-25 22:16:41 +09001084 qc->err_mask |= AC_ERR_HSM;
Tejun Heoa836d3e2008-06-28 01:39:43 +09001085 }
Tejun Heo624d5c52008-03-25 22:16:41 +09001086
1087 ap->hsm_task_state = HSM_ST_ERR;
1088 goto fsm_start;
1089 }
1090
1091 /* Device should not ask for data transfer (DRQ=1)
1092 * when it finds something wrong.
1093 * We ignore DRQ here and stop the HSM by
1094 * changing hsm_task_state to HSM_ST_ERR and
1095 * let the EH abort the command or reset the device.
1096 */
1097 if (unlikely(status & (ATA_ERR | ATA_DF))) {
1098 /* Some ATAPI tape drives forget to clear the ERR bit
1099 * when doing the next command (mostly request sense).
1100 * We ignore ERR here to workaround and proceed sending
1101 * the CDB.
1102 */
1103 if (!(qc->dev->horkage & ATA_HORKAGE_STUCK_ERR)) {
Tejun Heoa836d3e2008-06-28 01:39:43 +09001104 ata_ehi_push_desc(ehi, "ST_FIRST: "
1105 "DRQ=1 with device error, "
1106 "dev_stat 0x%X", status);
Tejun Heo624d5c52008-03-25 22:16:41 +09001107 qc->err_mask |= AC_ERR_HSM;
1108 ap->hsm_task_state = HSM_ST_ERR;
1109 goto fsm_start;
1110 }
1111 }
1112
1113 /* Send the CDB (atapi) or the first data block (ata pio out).
1114 * During the state transition, interrupt handler shouldn't
1115 * be invoked before the data transfer is complete and
1116 * hsm_task_state is changed. Hence, the following locking.
1117 */
1118 if (in_wq)
1119 spin_lock_irqsave(ap->lock, flags);
1120
1121 if (qc->tf.protocol == ATA_PROT_PIO) {
1122 /* PIO data out protocol.
1123 * send first data block.
1124 */
1125
1126 /* ata_pio_sectors() might change the state
1127 * to HSM_ST_LAST. so, the state is changed here
1128 * before ata_pio_sectors().
1129 */
1130 ap->hsm_task_state = HSM_ST;
1131 ata_pio_sectors(qc);
1132 } else
1133 /* send CDB */
1134 atapi_send_cdb(ap, qc);
1135
1136 if (in_wq)
1137 spin_unlock_irqrestore(ap->lock, flags);
1138
Tejun Heoc4291372010-05-10 21:41:38 +02001139 /* if polling, ata_sff_pio_task() handles the rest.
Tejun Heo624d5c52008-03-25 22:16:41 +09001140 * otherwise, interrupt handler takes over from here.
1141 */
1142 break;
1143
1144 case HSM_ST:
1145 /* complete command or read/write the data register */
1146 if (qc->tf.protocol == ATAPI_PROT_PIO) {
1147 /* ATAPI PIO protocol */
1148 if ((status & ATA_DRQ) == 0) {
1149 /* No more data to transfer or device error.
1150 * Device error will be tagged in HSM_ST_LAST.
1151 */
1152 ap->hsm_task_state = HSM_ST_LAST;
1153 goto fsm_start;
1154 }
1155
1156 /* Device should not ask for data transfer (DRQ=1)
1157 * when it finds something wrong.
1158 * We ignore DRQ here and stop the HSM by
1159 * changing hsm_task_state to HSM_ST_ERR and
1160 * let the EH abort the command or reset the device.
1161 */
1162 if (unlikely(status & (ATA_ERR | ATA_DF))) {
Tejun Heoa836d3e2008-06-28 01:39:43 +09001163 ata_ehi_push_desc(ehi, "ST-ATAPI: "
1164 "DRQ=1 with device error, "
1165 "dev_stat 0x%X", status);
Tejun Heo624d5c52008-03-25 22:16:41 +09001166 qc->err_mask |= AC_ERR_HSM;
1167 ap->hsm_task_state = HSM_ST_ERR;
1168 goto fsm_start;
1169 }
1170
1171 atapi_pio_bytes(qc);
1172
1173 if (unlikely(ap->hsm_task_state == HSM_ST_ERR))
1174 /* bad ireason reported by device */
1175 goto fsm_start;
1176
1177 } else {
1178 /* ATA PIO protocol */
1179 if (unlikely((status & ATA_DRQ) == 0)) {
1180 /* handle BSY=0, DRQ=0 as error */
Tejun Heo6a6b97d2008-11-13 10:04:46 +09001181 if (likely(status & (ATA_ERR | ATA_DF))) {
Tejun Heo624d5c52008-03-25 22:16:41 +09001182 /* device stops HSM for abort/error */
1183 qc->err_mask |= AC_ERR_DEV;
Tejun Heo6a6b97d2008-11-13 10:04:46 +09001184
1185 /* If diagnostic failed and this is
1186 * IDENTIFY, it's likely a phantom
1187 * device. Mark hint.
1188 */
1189 if (qc->dev->horkage &
1190 ATA_HORKAGE_DIAGNOSTIC)
1191 qc->err_mask |=
1192 AC_ERR_NODEV_HINT;
1193 } else {
Tejun Heo624d5c52008-03-25 22:16:41 +09001194 /* HSM violation. Let EH handle this.
1195 * Phantom devices also trigger this
1196 * condition. Mark hint.
1197 */
Tejun Heoa836d3e2008-06-28 01:39:43 +09001198 ata_ehi_push_desc(ehi, "ST-ATA: "
Tejun Heo80ee6f52009-01-23 14:12:59 +09001199 "DRQ=0 without device error, "
Tejun Heoa836d3e2008-06-28 01:39:43 +09001200 "dev_stat 0x%X", status);
Tejun Heo624d5c52008-03-25 22:16:41 +09001201 qc->err_mask |= AC_ERR_HSM |
1202 AC_ERR_NODEV_HINT;
Tejun Heoa836d3e2008-06-28 01:39:43 +09001203 }
Tejun Heo624d5c52008-03-25 22:16:41 +09001204
1205 ap->hsm_task_state = HSM_ST_ERR;
1206 goto fsm_start;
1207 }
1208
1209 /* For PIO reads, some devices may ask for
1210 * data transfer (DRQ=1) alone with ERR=1.
1211 * We respect DRQ here and transfer one
1212 * block of junk data before changing the
1213 * hsm_task_state to HSM_ST_ERR.
1214 *
1215 * For PIO writes, ERR=1 DRQ=1 doesn't make
1216 * sense since the data block has been
1217 * transferred to the device.
1218 */
1219 if (unlikely(status & (ATA_ERR | ATA_DF))) {
1220 /* data might be corrputed */
1221 qc->err_mask |= AC_ERR_DEV;
1222
1223 if (!(qc->tf.flags & ATA_TFLAG_WRITE)) {
1224 ata_pio_sectors(qc);
1225 status = ata_wait_idle(ap);
1226 }
1227
Tejun Heoa836d3e2008-06-28 01:39:43 +09001228 if (status & (ATA_BUSY | ATA_DRQ)) {
1229 ata_ehi_push_desc(ehi, "ST-ATA: "
1230 "BUSY|DRQ persists on ERR|DF, "
1231 "dev_stat 0x%X", status);
Tejun Heo624d5c52008-03-25 22:16:41 +09001232 qc->err_mask |= AC_ERR_HSM;
Tejun Heoa836d3e2008-06-28 01:39:43 +09001233 }
Tejun Heo624d5c52008-03-25 22:16:41 +09001234
Tejun Heob9199302009-01-25 10:26:00 +09001235 /* There are oddball controllers with
1236 * status register stuck at 0x7f and
1237 * lbal/m/h at zero which makes it
1238 * pass all other presence detection
1239 * mechanisms we have. Set NODEV_HINT
1240 * for it. Kernel bz#7241.
1241 */
1242 if (status == 0x7f)
1243 qc->err_mask |= AC_ERR_NODEV_HINT;
1244
Tejun Heo624d5c52008-03-25 22:16:41 +09001245 /* ata_pio_sectors() might change the
1246 * state to HSM_ST_LAST. so, the state
1247 * is changed after ata_pio_sectors().
1248 */
1249 ap->hsm_task_state = HSM_ST_ERR;
1250 goto fsm_start;
1251 }
1252
1253 ata_pio_sectors(qc);
1254
1255 if (ap->hsm_task_state == HSM_ST_LAST &&
1256 (!(qc->tf.flags & ATA_TFLAG_WRITE))) {
1257 /* all data read */
1258 status = ata_wait_idle(ap);
1259 goto fsm_start;
1260 }
1261 }
1262
1263 poll_next = 1;
1264 break;
1265
1266 case HSM_ST_LAST:
1267 if (unlikely(!ata_ok(status))) {
1268 qc->err_mask |= __ac_err_mask(status);
1269 ap->hsm_task_state = HSM_ST_ERR;
1270 goto fsm_start;
1271 }
1272
1273 /* no more data to transfer */
1274 DPRINTK("ata%u: dev %u command complete, drv_stat 0x%x\n",
1275 ap->print_id, qc->dev->devno, status);
1276
Tejun Heoefcb3cf2009-01-09 19:19:14 +09001277 WARN_ON_ONCE(qc->err_mask & (AC_ERR_DEV | AC_ERR_HSM));
Tejun Heo624d5c52008-03-25 22:16:41 +09001278
1279 ap->hsm_task_state = HSM_ST_IDLE;
1280
1281 /* complete taskfile transaction */
1282 ata_hsm_qc_complete(qc, in_wq);
1283
1284 poll_next = 0;
1285 break;
1286
1287 case HSM_ST_ERR:
Tejun Heo624d5c52008-03-25 22:16:41 +09001288 ap->hsm_task_state = HSM_ST_IDLE;
1289
1290 /* complete taskfile transaction */
1291 ata_hsm_qc_complete(qc, in_wq);
1292
1293 poll_next = 0;
1294 break;
1295 default:
1296 poll_next = 0;
1297 BUG();
1298 }
1299
1300 return poll_next;
1301}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001302EXPORT_SYMBOL_GPL(ata_sff_hsm_move);
Tejun Heo624d5c52008-03-25 22:16:41 +09001303
Tejun Heoc4291372010-05-10 21:41:38 +02001304void ata_sff_queue_pio_task(struct ata_port *ap, unsigned long delay)
1305{
1306 /* may fail if ata_sff_flush_pio_task() in progress */
1307 queue_delayed_work(ata_sff_wq, &ap->sff_pio_task,
1308 msecs_to_jiffies(delay));
1309}
1310EXPORT_SYMBOL_GPL(ata_sff_queue_pio_task);
1311
1312void ata_sff_flush_pio_task(struct ata_port *ap)
1313{
1314 DPRINTK("ENTER\n");
1315
1316 cancel_rearming_delayed_work(&ap->sff_pio_task);
1317 ap->hsm_task_state = HSM_ST_IDLE;
1318
1319 if (ata_msg_ctl(ap))
1320 ata_port_printk(ap, KERN_DEBUG, "%s: EXIT\n", __func__);
1321}
1322
1323static void ata_sff_pio_task(struct work_struct *work)
Tejun Heo624d5c52008-03-25 22:16:41 +09001324{
1325 struct ata_port *ap =
Tejun Heoc4291372010-05-10 21:41:38 +02001326 container_of(work, struct ata_port, sff_pio_task.work);
1327 struct ata_queued_cmd *qc;
Tejun Heo624d5c52008-03-25 22:16:41 +09001328 u8 status;
1329 int poll_next;
1330
Tejun Heoc4291372010-05-10 21:41:38 +02001331 /* qc can be NULL if timeout occurred */
1332 qc = ata_qc_from_tag(ap, ap->link.active_tag);
1333 if (!qc)
1334 return;
1335
Tejun Heo624d5c52008-03-25 22:16:41 +09001336fsm_start:
Tejun Heoefcb3cf2009-01-09 19:19:14 +09001337 WARN_ON_ONCE(ap->hsm_task_state == HSM_ST_IDLE);
Tejun Heo624d5c52008-03-25 22:16:41 +09001338
1339 /*
1340 * This is purely heuristic. This is a fast path.
1341 * Sometimes when we enter, BSY will be cleared in
1342 * a chk-status or two. If not, the drive is probably seeking
1343 * or something. Snooze for a couple msecs, then
1344 * chk-status again. If still busy, queue delayed work.
1345 */
Tejun Heo9363c382008-04-07 22:47:16 +09001346 status = ata_sff_busy_wait(ap, ATA_BUSY, 5);
Tejun Heo624d5c52008-03-25 22:16:41 +09001347 if (status & ATA_BUSY) {
1348 msleep(2);
Tejun Heo9363c382008-04-07 22:47:16 +09001349 status = ata_sff_busy_wait(ap, ATA_BUSY, 10);
Tejun Heo624d5c52008-03-25 22:16:41 +09001350 if (status & ATA_BUSY) {
Tejun Heoc4291372010-05-10 21:41:38 +02001351 ata_sff_queue_pio_task(ap, ATA_SHORT_PAUSE);
Tejun Heo624d5c52008-03-25 22:16:41 +09001352 return;
1353 }
1354 }
1355
1356 /* move the HSM */
Tejun Heo9363c382008-04-07 22:47:16 +09001357 poll_next = ata_sff_hsm_move(ap, qc, status, 1);
Tejun Heo624d5c52008-03-25 22:16:41 +09001358
1359 /* another command or interrupt handler
1360 * may be running at this point.
1361 */
1362 if (poll_next)
1363 goto fsm_start;
1364}
1365
1366/**
Tejun Heo360ff782010-05-10 21:41:42 +02001367 * ata_sff_qc_issue - issue taskfile to a SFF controller
Tejun Heo624d5c52008-03-25 22:16:41 +09001368 * @qc: command to issue to device
1369 *
Tejun Heo360ff782010-05-10 21:41:42 +02001370 * This function issues a PIO or NODATA command to a SFF
1371 * controller.
Tejun Heo624d5c52008-03-25 22:16:41 +09001372 *
1373 * LOCKING:
1374 * spin_lock_irqsave(host lock)
1375 *
1376 * RETURNS:
1377 * Zero on success, AC_ERR_* mask on failure
1378 */
Tejun Heo9363c382008-04-07 22:47:16 +09001379unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc)
Tejun Heo624d5c52008-03-25 22:16:41 +09001380{
1381 struct ata_port *ap = qc->ap;
1382
1383 /* Use polling pio if the LLD doesn't handle
1384 * interrupt driven pio and atapi CDB interrupt.
1385 */
Tejun Heo360ff782010-05-10 21:41:42 +02001386 if (ap->flags & ATA_FLAG_PIO_POLLING)
1387 qc->tf.flags |= ATA_TFLAG_POLLING;
Tejun Heo624d5c52008-03-25 22:16:41 +09001388
1389 /* select the device */
1390 ata_dev_select(ap, qc->dev->devno, 1, 0);
1391
1392 /* start the command */
1393 switch (qc->tf.protocol) {
1394 case ATA_PROT_NODATA:
1395 if (qc->tf.flags & ATA_TFLAG_POLLING)
1396 ata_qc_set_polling(qc);
1397
1398 ata_tf_to_host(ap, &qc->tf);
1399 ap->hsm_task_state = HSM_ST_LAST;
1400
1401 if (qc->tf.flags & ATA_TFLAG_POLLING)
Tejun Heoc4291372010-05-10 21:41:38 +02001402 ata_sff_queue_pio_task(ap, 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09001403
1404 break;
1405
Tejun Heo624d5c52008-03-25 22:16:41 +09001406 case ATA_PROT_PIO:
1407 if (qc->tf.flags & ATA_TFLAG_POLLING)
1408 ata_qc_set_polling(qc);
1409
1410 ata_tf_to_host(ap, &qc->tf);
1411
1412 if (qc->tf.flags & ATA_TFLAG_WRITE) {
1413 /* PIO data out protocol */
1414 ap->hsm_task_state = HSM_ST_FIRST;
Tejun Heoc4291372010-05-10 21:41:38 +02001415 ata_sff_queue_pio_task(ap, 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09001416
Tejun Heoc4291372010-05-10 21:41:38 +02001417 /* always send first data block using the
1418 * ata_sff_pio_task() codepath.
Tejun Heo624d5c52008-03-25 22:16:41 +09001419 */
1420 } else {
1421 /* PIO data in protocol */
1422 ap->hsm_task_state = HSM_ST;
1423
1424 if (qc->tf.flags & ATA_TFLAG_POLLING)
Tejun Heoc4291372010-05-10 21:41:38 +02001425 ata_sff_queue_pio_task(ap, 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09001426
Tejun Heoc4291372010-05-10 21:41:38 +02001427 /* if polling, ata_sff_pio_task() handles the
1428 * rest. otherwise, interrupt handler takes
1429 * over from here.
Tejun Heo624d5c52008-03-25 22:16:41 +09001430 */
1431 }
1432
1433 break;
1434
1435 case ATAPI_PROT_PIO:
1436 case ATAPI_PROT_NODATA:
1437 if (qc->tf.flags & ATA_TFLAG_POLLING)
1438 ata_qc_set_polling(qc);
1439
1440 ata_tf_to_host(ap, &qc->tf);
1441
1442 ap->hsm_task_state = HSM_ST_FIRST;
1443
1444 /* send cdb by polling if no cdb interrupt */
1445 if ((!(qc->dev->flags & ATA_DFLAG_CDB_INTR)) ||
1446 (qc->tf.flags & ATA_TFLAG_POLLING))
Tejun Heoc4291372010-05-10 21:41:38 +02001447 ata_sff_queue_pio_task(ap, 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09001448 break;
1449
Tejun Heo624d5c52008-03-25 22:16:41 +09001450 default:
Tejun Heoefcb3cf2009-01-09 19:19:14 +09001451 WARN_ON_ONCE(1);
Tejun Heo624d5c52008-03-25 22:16:41 +09001452 return AC_ERR_SYSTEM;
1453 }
1454
1455 return 0;
1456}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001457EXPORT_SYMBOL_GPL(ata_sff_qc_issue);
Tejun Heo624d5c52008-03-25 22:16:41 +09001458
1459/**
Tejun Heo22183bf2008-04-07 22:47:20 +09001460 * ata_sff_qc_fill_rtf - fill result TF using ->sff_tf_read
1461 * @qc: qc to fill result TF for
1462 *
1463 * @qc is finished and result TF needs to be filled. Fill it
1464 * using ->sff_tf_read.
1465 *
1466 * LOCKING:
1467 * spin_lock_irqsave(host lock)
1468 *
1469 * RETURNS:
1470 * true indicating that result TF is successfully filled.
1471 */
1472bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc)
1473{
1474 qc->ap->ops->sff_tf_read(qc->ap, &qc->result_tf);
1475 return true;
1476}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001477EXPORT_SYMBOL_GPL(ata_sff_qc_fill_rtf);
Tejun Heo22183bf2008-04-07 22:47:20 +09001478
Tejun Heoc3b28892010-05-19 22:10:21 +02001479static unsigned int ata_sff_idle_irq(struct ata_port *ap)
Tejun Heo624d5c52008-03-25 22:16:41 +09001480{
Tejun Heoc3b28892010-05-19 22:10:21 +02001481 ap->stats.idle_irq++;
1482
1483#ifdef ATA_IRQ_TRAP
1484 if ((ap->stats.idle_irq % 1000) == 0) {
1485 ap->ops->sff_check_status(ap);
1486 if (ap->ops->sff_irq_clear)
1487 ap->ops->sff_irq_clear(ap);
1488 ata_port_printk(ap, KERN_WARNING, "irq trap\n");
1489 return 1;
1490 }
1491#endif
1492 return 0; /* irq not handled */
1493}
1494
1495static unsigned int __ata_sff_port_intr(struct ata_port *ap,
1496 struct ata_queued_cmd *qc,
1497 bool hsmv_on_idle)
1498{
1499 u8 status;
Tejun Heo624d5c52008-03-25 22:16:41 +09001500
1501 VPRINTK("ata%u: protocol %d task_state %d\n",
1502 ap->print_id, qc->tf.protocol, ap->hsm_task_state);
1503
1504 /* Check whether we are expecting interrupt in this state */
1505 switch (ap->hsm_task_state) {
1506 case HSM_ST_FIRST:
1507 /* Some pre-ATAPI-4 devices assert INTRQ
1508 * at this state when ready to receive CDB.
1509 */
1510
1511 /* Check the ATA_DFLAG_CDB_INTR flag is enough here.
1512 * The flag was turned on only for atapi devices. No
1513 * need to check ata_is_atapi(qc->tf.protocol) again.
1514 */
1515 if (!(qc->dev->flags & ATA_DFLAG_CDB_INTR))
Tejun Heoc3b28892010-05-19 22:10:21 +02001516 return ata_sff_idle_irq(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001517 break;
1518 case HSM_ST:
Tejun Heoc3b28892010-05-19 22:10:21 +02001519 case HSM_ST_LAST:
Tejun Heo624d5c52008-03-25 22:16:41 +09001520 break;
1521 default:
Tejun Heoc3b28892010-05-19 22:10:21 +02001522 return ata_sff_idle_irq(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001523 }
1524
Alan Coxa57c1ba2008-05-29 22:10:58 +01001525 /* check main status, clearing INTRQ if needed */
1526 status = ata_sff_irq_status(ap);
Tejun Heo332ac7f2010-03-23 12:24:08 +09001527 if (status & ATA_BUSY) {
Tejun Heoc3b28892010-05-19 22:10:21 +02001528 if (hsmv_on_idle) {
Tejun Heo332ac7f2010-03-23 12:24:08 +09001529 /* BMDMA engine is already stopped, we're screwed */
1530 qc->err_mask |= AC_ERR_HSM;
1531 ap->hsm_task_state = HSM_ST_ERR;
1532 } else
Tejun Heoc3b28892010-05-19 22:10:21 +02001533 return ata_sff_idle_irq(ap);
Tejun Heo332ac7f2010-03-23 12:24:08 +09001534 }
Tejun Heo624d5c52008-03-25 22:16:41 +09001535
Tejun Heo9f2f7212010-05-10 21:41:32 +02001536 /* clear irq events */
Tejun Heo37f65b82010-05-19 22:10:20 +02001537 if (ap->ops->sff_irq_clear)
1538 ap->ops->sff_irq_clear(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001539
Tejun Heo9363c382008-04-07 22:47:16 +09001540 ata_sff_hsm_move(ap, qc, status, 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09001541
Tejun Heo624d5c52008-03-25 22:16:41 +09001542 return 1; /* irq handled */
Tejun Heo624d5c52008-03-25 22:16:41 +09001543}
1544
1545/**
Tejun Heoc3b28892010-05-19 22:10:21 +02001546 * ata_sff_port_intr - Handle SFF port interrupt
1547 * @ap: Port on which interrupt arrived (possibly...)
1548 * @qc: Taskfile currently active in engine
Tejun Heo624d5c52008-03-25 22:16:41 +09001549 *
Tejun Heoc3b28892010-05-19 22:10:21 +02001550 * Handle port interrupt for given queued command.
Tejun Heo624d5c52008-03-25 22:16:41 +09001551 *
1552 * LOCKING:
Tejun Heoc3b28892010-05-19 22:10:21 +02001553 * spin_lock_irqsave(host lock)
Tejun Heo624d5c52008-03-25 22:16:41 +09001554 *
1555 * RETURNS:
Tejun Heoc3b28892010-05-19 22:10:21 +02001556 * One if interrupt was handled, zero if not (shared irq).
Tejun Heo624d5c52008-03-25 22:16:41 +09001557 */
Tejun Heoc3b28892010-05-19 22:10:21 +02001558unsigned int ata_sff_port_intr(struct ata_port *ap, struct ata_queued_cmd *qc)
1559{
1560 return __ata_sff_port_intr(ap, qc, false);
1561}
1562EXPORT_SYMBOL_GPL(ata_sff_port_intr);
1563
1564static inline irqreturn_t __ata_sff_interrupt(int irq, void *dev_instance,
1565 unsigned int (*port_intr)(struct ata_port *, struct ata_queued_cmd *))
Tejun Heo624d5c52008-03-25 22:16:41 +09001566{
1567 struct ata_host *host = dev_instance;
Tejun Heo332ac7f2010-03-23 12:24:08 +09001568 bool retried = false;
Tejun Heo624d5c52008-03-25 22:16:41 +09001569 unsigned int i;
Tejun Heo332ac7f2010-03-23 12:24:08 +09001570 unsigned int handled, idle, polling;
Tejun Heo624d5c52008-03-25 22:16:41 +09001571 unsigned long flags;
1572
1573 /* TODO: make _irqsave conditional on x86 PCI IDE legacy mode */
1574 spin_lock_irqsave(&host->lock, flags);
1575
Tejun Heo332ac7f2010-03-23 12:24:08 +09001576retry:
1577 handled = idle = polling = 0;
Tejun Heo624d5c52008-03-25 22:16:41 +09001578 for (i = 0; i < host->n_ports; i++) {
Tejun Heod88ec2e2010-01-19 10:46:32 +09001579 struct ata_port *ap = host->ports[i];
1580 struct ata_queued_cmd *qc;
Tejun Heo624d5c52008-03-25 22:16:41 +09001581
Tejun Heod88ec2e2010-01-19 10:46:32 +09001582 qc = ata_qc_from_tag(ap, ap->link.active_tag);
Tejun Heo27943622010-01-19 10:49:19 +09001583 if (qc) {
1584 if (!(qc->tf.flags & ATA_TFLAG_POLLING))
Tejun Heoc3b28892010-05-19 22:10:21 +02001585 handled |= port_intr(ap, qc);
Tejun Heo27943622010-01-19 10:49:19 +09001586 else
1587 polling |= 1 << i;
Tejun Heo332ac7f2010-03-23 12:24:08 +09001588 } else
1589 idle |= 1 << i;
Tejun Heo27943622010-01-19 10:49:19 +09001590 }
1591
1592 /*
1593 * If no port was expecting IRQ but the controller is actually
1594 * asserting IRQ line, nobody cared will ensue. Check IRQ
1595 * pending status if available and clear spurious IRQ.
1596 */
Tejun Heo332ac7f2010-03-23 12:24:08 +09001597 if (!handled && !retried) {
1598 bool retry = false;
1599
Tejun Heo27943622010-01-19 10:49:19 +09001600 for (i = 0; i < host->n_ports; i++) {
1601 struct ata_port *ap = host->ports[i];
1602
1603 if (polling & (1 << i))
1604 continue;
1605
1606 if (!ap->ops->sff_irq_check ||
1607 !ap->ops->sff_irq_check(ap))
1608 continue;
1609
Tejun Heo332ac7f2010-03-23 12:24:08 +09001610 if (idle & (1 << i)) {
1611 ap->ops->sff_check_status(ap);
Tejun Heo37f65b82010-05-19 22:10:20 +02001612 if (ap->ops->sff_irq_clear)
1613 ap->ops->sff_irq_clear(ap);
Tejun Heo332ac7f2010-03-23 12:24:08 +09001614 } else {
1615 /* clear INTRQ and check if BUSY cleared */
1616 if (!(ap->ops->sff_check_status(ap) & ATA_BUSY))
1617 retry |= true;
1618 /*
1619 * With command in flight, we can't do
1620 * sff_irq_clear() w/o racing with completion.
1621 */
1622 }
1623 }
1624
1625 if (retry) {
1626 retried = true;
1627 goto retry;
Tejun Heo27943622010-01-19 10:49:19 +09001628 }
Tejun Heo624d5c52008-03-25 22:16:41 +09001629 }
1630
1631 spin_unlock_irqrestore(&host->lock, flags);
1632
1633 return IRQ_RETVAL(handled);
1634}
Tejun Heoc3b28892010-05-19 22:10:21 +02001635
1636/**
1637 * ata_sff_interrupt - Default SFF ATA host interrupt handler
1638 * @irq: irq line (unused)
1639 * @dev_instance: pointer to our ata_host information structure
1640 *
1641 * Default interrupt handler for PCI IDE devices. Calls
1642 * ata_sff_port_intr() for each port that is not disabled.
1643 *
1644 * LOCKING:
1645 * Obtains host lock during operation.
1646 *
1647 * RETURNS:
1648 * IRQ_NONE or IRQ_HANDLED.
1649 */
1650irqreturn_t ata_sff_interrupt(int irq, void *dev_instance)
1651{
1652 return __ata_sff_interrupt(irq, dev_instance, ata_sff_port_intr);
1653}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001654EXPORT_SYMBOL_GPL(ata_sff_interrupt);
Tejun Heo624d5c52008-03-25 22:16:41 +09001655
1656/**
Alan Coxc96f1732009-03-24 10:23:46 +00001657 * ata_sff_lost_interrupt - Check for an apparent lost interrupt
1658 * @ap: port that appears to have timed out
1659 *
1660 * Called from the libata error handlers when the core code suspects
1661 * an interrupt has been lost. If it has complete anything we can and
1662 * then return. Interface must support altstatus for this faster
1663 * recovery to occur.
1664 *
1665 * Locking:
1666 * Caller holds host lock
1667 */
1668
1669void ata_sff_lost_interrupt(struct ata_port *ap)
1670{
1671 u8 status;
1672 struct ata_queued_cmd *qc;
1673
1674 /* Only one outstanding command per SFF channel */
1675 qc = ata_qc_from_tag(ap, ap->link.active_tag);
Tejun Heo3e4ec342010-05-10 21:41:30 +02001676 /* We cannot lose an interrupt on a non-existent or polled command */
1677 if (!qc || qc->tf.flags & ATA_TFLAG_POLLING)
Alan Coxc96f1732009-03-24 10:23:46 +00001678 return;
1679 /* See if the controller thinks it is still busy - if so the command
1680 isn't a lost IRQ but is still in progress */
1681 status = ata_sff_altstatus(ap);
1682 if (status & ATA_BUSY)
1683 return;
1684
1685 /* There was a command running, we are no longer busy and we have
1686 no interrupt. */
1687 ata_port_printk(ap, KERN_WARNING, "lost interrupt (Status 0x%x)\n",
1688 status);
1689 /* Run the host interrupt logic as if the interrupt had not been
1690 lost */
Tejun Heoc3b28892010-05-19 22:10:21 +02001691 ata_sff_port_intr(ap, qc);
Alan Coxc96f1732009-03-24 10:23:46 +00001692}
1693EXPORT_SYMBOL_GPL(ata_sff_lost_interrupt);
1694
1695/**
Tejun Heo9363c382008-04-07 22:47:16 +09001696 * ata_sff_freeze - Freeze SFF controller port
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001697 * @ap: port to freeze
1698 *
Tejun Heo9f2f7212010-05-10 21:41:32 +02001699 * Freeze SFF controller port.
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001700 *
1701 * LOCKING:
1702 * Inherited from caller.
1703 */
Tejun Heo9363c382008-04-07 22:47:16 +09001704void ata_sff_freeze(struct ata_port *ap)
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001705{
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001706 ap->ctl |= ATA_NIEN;
1707 ap->last_ctl = ap->ctl;
1708
Sergei Shtylyov41dec292010-05-07 22:47:50 +04001709 if (ap->ops->sff_set_devctl || ap->ioaddr.ctl_addr)
1710 ata_sff_set_devctl(ap, ap->ctl);
Tejun Heo0f0a3ad2006-11-17 12:24:22 +09001711
1712 /* Under certain circumstances, some controllers raise IRQ on
1713 * ATA_NIEN manipulation. Also, many controllers fail to mask
1714 * previously pending IRQ on ATA_NIEN assertion. Clear it.
1715 */
Tejun Heo5682ed32008-04-07 22:47:16 +09001716 ap->ops->sff_check_status(ap);
Tejun Heo0f0a3ad2006-11-17 12:24:22 +09001717
Tejun Heo37f65b82010-05-19 22:10:20 +02001718 if (ap->ops->sff_irq_clear)
1719 ap->ops->sff_irq_clear(ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001720}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001721EXPORT_SYMBOL_GPL(ata_sff_freeze);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001722
1723/**
Tejun Heo9363c382008-04-07 22:47:16 +09001724 * ata_sff_thaw - Thaw SFF controller port
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001725 * @ap: port to thaw
1726 *
Tejun Heo9363c382008-04-07 22:47:16 +09001727 * Thaw SFF controller port.
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001728 *
1729 * LOCKING:
1730 * Inherited from caller.
1731 */
Tejun Heo9363c382008-04-07 22:47:16 +09001732void ata_sff_thaw(struct ata_port *ap)
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001733{
1734 /* clear & re-enable interrupts */
Tejun Heo5682ed32008-04-07 22:47:16 +09001735 ap->ops->sff_check_status(ap);
Tejun Heo37f65b82010-05-19 22:10:20 +02001736 if (ap->ops->sff_irq_clear)
1737 ap->ops->sff_irq_clear(ap);
Sergei Shtylyove42a5422010-05-07 22:49:02 +04001738 ata_sff_irq_on(ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001739}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001740EXPORT_SYMBOL_GPL(ata_sff_thaw);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09001741
1742/**
Tejun Heo0aa11132008-04-07 22:47:18 +09001743 * ata_sff_prereset - prepare SFF link for reset
1744 * @link: SFF link to be reset
1745 * @deadline: deadline jiffies for the operation
1746 *
1747 * SFF link @link is about to be reset. Initialize it. It first
1748 * calls ata_std_prereset() and wait for !BSY if the port is
1749 * being softreset.
1750 *
1751 * LOCKING:
1752 * Kernel thread context (may sleep)
1753 *
1754 * RETURNS:
1755 * 0 on success, -errno otherwise.
1756 */
1757int ata_sff_prereset(struct ata_link *link, unsigned long deadline)
1758{
Tejun Heo0aa11132008-04-07 22:47:18 +09001759 struct ata_eh_context *ehc = &link->eh_context;
1760 int rc;
1761
1762 rc = ata_std_prereset(link, deadline);
1763 if (rc)
1764 return rc;
1765
1766 /* if we're about to do hardreset, nothing more to do */
1767 if (ehc->i.action & ATA_EH_HARDRESET)
1768 return 0;
1769
1770 /* wait for !BSY if we don't know that no device is attached */
1771 if (!ata_link_offline(link)) {
Tejun Heo705e76b2008-04-07 22:47:19 +09001772 rc = ata_sff_wait_ready(link, deadline);
Tejun Heo0aa11132008-04-07 22:47:18 +09001773 if (rc && rc != -ENODEV) {
1774 ata_link_printk(link, KERN_WARNING, "device not ready "
1775 "(errno=%d), forcing hardreset\n", rc);
1776 ehc->i.action |= ATA_EH_HARDRESET;
1777 }
1778 }
1779
1780 return 0;
1781}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001782EXPORT_SYMBOL_GPL(ata_sff_prereset);
Tejun Heo0aa11132008-04-07 22:47:18 +09001783
1784/**
Tejun Heo624d5c52008-03-25 22:16:41 +09001785 * ata_devchk - PATA device presence detection
1786 * @ap: ATA channel to examine
1787 * @device: Device to examine (starting at zero)
1788 *
1789 * This technique was originally described in
1790 * Hale Landis's ATADRVR (www.ata-atapi.com), and
1791 * later found its way into the ATA/ATAPI spec.
1792 *
1793 * Write a pattern to the ATA shadow registers,
1794 * and if a device is present, it will respond by
1795 * correctly storing and echoing back the
1796 * ATA shadow register contents.
1797 *
1798 * LOCKING:
1799 * caller.
1800 */
1801static unsigned int ata_devchk(struct ata_port *ap, unsigned int device)
1802{
1803 struct ata_ioports *ioaddr = &ap->ioaddr;
1804 u8 nsect, lbal;
1805
Tejun Heo5682ed32008-04-07 22:47:16 +09001806 ap->ops->sff_dev_select(ap, device);
Tejun Heo624d5c52008-03-25 22:16:41 +09001807
1808 iowrite8(0x55, ioaddr->nsect_addr);
1809 iowrite8(0xaa, ioaddr->lbal_addr);
1810
1811 iowrite8(0xaa, ioaddr->nsect_addr);
1812 iowrite8(0x55, ioaddr->lbal_addr);
1813
1814 iowrite8(0x55, ioaddr->nsect_addr);
1815 iowrite8(0xaa, ioaddr->lbal_addr);
1816
1817 nsect = ioread8(ioaddr->nsect_addr);
1818 lbal = ioread8(ioaddr->lbal_addr);
1819
1820 if ((nsect == 0x55) && (lbal == 0xaa))
1821 return 1; /* we found a device */
1822
1823 return 0; /* nothing found */
1824}
1825
1826/**
Tejun Heo9363c382008-04-07 22:47:16 +09001827 * ata_sff_dev_classify - Parse returned ATA device signature
Tejun Heo624d5c52008-03-25 22:16:41 +09001828 * @dev: ATA device to classify (starting at zero)
1829 * @present: device seems present
1830 * @r_err: Value of error register on completion
1831 *
1832 * After an event -- SRST, E.D.D., or SATA COMRESET -- occurs,
1833 * an ATA/ATAPI-defined set of values is placed in the ATA
1834 * shadow registers, indicating the results of device detection
1835 * and diagnostics.
1836 *
1837 * Select the ATA device, and read the values from the ATA shadow
1838 * registers. Then parse according to the Error register value,
1839 * and the spec-defined values examined by ata_dev_classify().
1840 *
1841 * LOCKING:
1842 * caller.
1843 *
1844 * RETURNS:
1845 * Device type - %ATA_DEV_ATA, %ATA_DEV_ATAPI or %ATA_DEV_NONE.
1846 */
Tejun Heo9363c382008-04-07 22:47:16 +09001847unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
Tejun Heo624d5c52008-03-25 22:16:41 +09001848 u8 *r_err)
1849{
1850 struct ata_port *ap = dev->link->ap;
1851 struct ata_taskfile tf;
1852 unsigned int class;
1853 u8 err;
1854
Tejun Heo5682ed32008-04-07 22:47:16 +09001855 ap->ops->sff_dev_select(ap, dev->devno);
Tejun Heo624d5c52008-03-25 22:16:41 +09001856
1857 memset(&tf, 0, sizeof(tf));
1858
Tejun Heo5682ed32008-04-07 22:47:16 +09001859 ap->ops->sff_tf_read(ap, &tf);
Tejun Heo624d5c52008-03-25 22:16:41 +09001860 err = tf.feature;
1861 if (r_err)
1862 *r_err = err;
1863
1864 /* see if device passed diags: continue and warn later */
1865 if (err == 0)
1866 /* diagnostic fail : do nothing _YET_ */
1867 dev->horkage |= ATA_HORKAGE_DIAGNOSTIC;
1868 else if (err == 1)
1869 /* do nothing */ ;
1870 else if ((dev->devno == 0) && (err == 0x81))
1871 /* do nothing */ ;
1872 else
1873 return ATA_DEV_NONE;
1874
1875 /* determine if device is ATA or ATAPI */
1876 class = ata_dev_classify(&tf);
1877
1878 if (class == ATA_DEV_UNKNOWN) {
1879 /* If the device failed diagnostic, it's likely to
1880 * have reported incorrect device signature too.
1881 * Assume ATA device if the device seems present but
1882 * device signature is invalid with diagnostic
1883 * failure.
1884 */
1885 if (present && (dev->horkage & ATA_HORKAGE_DIAGNOSTIC))
1886 class = ATA_DEV_ATA;
1887 else
1888 class = ATA_DEV_NONE;
Tejun Heo5682ed32008-04-07 22:47:16 +09001889 } else if ((class == ATA_DEV_ATA) &&
1890 (ap->ops->sff_check_status(ap) == 0))
Tejun Heo624d5c52008-03-25 22:16:41 +09001891 class = ATA_DEV_NONE;
1892
1893 return class;
1894}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001895EXPORT_SYMBOL_GPL(ata_sff_dev_classify);
Tejun Heo624d5c52008-03-25 22:16:41 +09001896
Tejun Heo705e76b2008-04-07 22:47:19 +09001897/**
1898 * ata_sff_wait_after_reset - wait for devices to become ready after reset
1899 * @link: SFF link which is just reset
1900 * @devmask: mask of present devices
1901 * @deadline: deadline jiffies for the operation
1902 *
1903 * Wait devices attached to SFF @link to become ready after
1904 * reset. It contains preceding 150ms wait to avoid accessing TF
1905 * status register too early.
1906 *
1907 * LOCKING:
1908 * Kernel thread context (may sleep).
1909 *
1910 * RETURNS:
1911 * 0 on success, -ENODEV if some or all of devices in @devmask
1912 * don't seem to exist. -errno on other errors.
1913 */
1914int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1915 unsigned long deadline)
Tejun Heo624d5c52008-03-25 22:16:41 +09001916{
Tejun Heo705e76b2008-04-07 22:47:19 +09001917 struct ata_port *ap = link->ap;
Tejun Heo624d5c52008-03-25 22:16:41 +09001918 struct ata_ioports *ioaddr = &ap->ioaddr;
1919 unsigned int dev0 = devmask & (1 << 0);
1920 unsigned int dev1 = devmask & (1 << 1);
1921 int rc, ret = 0;
1922
Tejun Heo341c2c92008-05-20 02:17:51 +09001923 msleep(ATA_WAIT_AFTER_RESET);
Tejun Heo705e76b2008-04-07 22:47:19 +09001924
1925 /* always check readiness of the master device */
1926 rc = ata_sff_wait_ready(link, deadline);
1927 /* -ENODEV means the odd clown forgot the D7 pulldown resistor
1928 * and TF status is 0xff, bail out on it too.
Tejun Heo624d5c52008-03-25 22:16:41 +09001929 */
Tejun Heo705e76b2008-04-07 22:47:19 +09001930 if (rc)
1931 return rc;
Tejun Heo624d5c52008-03-25 22:16:41 +09001932
1933 /* if device 1 was found in ata_devchk, wait for register
1934 * access briefly, then wait for BSY to clear.
1935 */
1936 if (dev1) {
1937 int i;
1938
Tejun Heo5682ed32008-04-07 22:47:16 +09001939 ap->ops->sff_dev_select(ap, 1);
Tejun Heo624d5c52008-03-25 22:16:41 +09001940
1941 /* Wait for register access. Some ATAPI devices fail
1942 * to set nsect/lbal after reset, so don't waste too
1943 * much time on it. We're gonna wait for !BSY anyway.
1944 */
1945 for (i = 0; i < 2; i++) {
1946 u8 nsect, lbal;
1947
1948 nsect = ioread8(ioaddr->nsect_addr);
1949 lbal = ioread8(ioaddr->lbal_addr);
1950 if ((nsect == 1) && (lbal == 1))
1951 break;
1952 msleep(50); /* give drive a breather */
1953 }
1954
Tejun Heo705e76b2008-04-07 22:47:19 +09001955 rc = ata_sff_wait_ready(link, deadline);
Tejun Heo624d5c52008-03-25 22:16:41 +09001956 if (rc) {
1957 if (rc != -ENODEV)
1958 return rc;
1959 ret = rc;
1960 }
1961 }
1962
1963 /* is all this really necessary? */
Tejun Heo5682ed32008-04-07 22:47:16 +09001964 ap->ops->sff_dev_select(ap, 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09001965 if (dev1)
Tejun Heo5682ed32008-04-07 22:47:16 +09001966 ap->ops->sff_dev_select(ap, 1);
Tejun Heo624d5c52008-03-25 22:16:41 +09001967 if (dev0)
Tejun Heo5682ed32008-04-07 22:47:16 +09001968 ap->ops->sff_dev_select(ap, 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09001969
1970 return ret;
1971}
Alan Cox0fe40ff2009-01-05 14:16:13 +00001972EXPORT_SYMBOL_GPL(ata_sff_wait_after_reset);
Tejun Heo624d5c52008-03-25 22:16:41 +09001973
Tejun Heo624d5c52008-03-25 22:16:41 +09001974static int ata_bus_softreset(struct ata_port *ap, unsigned int devmask,
1975 unsigned long deadline)
1976{
1977 struct ata_ioports *ioaddr = &ap->ioaddr;
1978
1979 DPRINTK("ata%u: bus reset via SRST\n", ap->print_id);
1980
1981 /* software reset. causes dev0 to be selected */
1982 iowrite8(ap->ctl, ioaddr->ctl_addr);
1983 udelay(20); /* FIXME: flush */
1984 iowrite8(ap->ctl | ATA_SRST, ioaddr->ctl_addr);
1985 udelay(20); /* FIXME: flush */
1986 iowrite8(ap->ctl, ioaddr->ctl_addr);
Stuart MENEFYe3e43852009-03-10 11:38:13 +00001987 ap->last_ctl = ap->ctl;
Tejun Heo624d5c52008-03-25 22:16:41 +09001988
Tejun Heo705e76b2008-04-07 22:47:19 +09001989 /* wait the port to become ready */
1990 return ata_sff_wait_after_reset(&ap->link, devmask, deadline);
Tejun Heo624d5c52008-03-25 22:16:41 +09001991}
1992
1993/**
Tejun Heo9363c382008-04-07 22:47:16 +09001994 * ata_sff_softreset - reset host port via ATA SRST
Tejun Heo624d5c52008-03-25 22:16:41 +09001995 * @link: ATA link to reset
1996 * @classes: resulting classes of attached devices
1997 * @deadline: deadline jiffies for the operation
1998 *
1999 * Reset host port using ATA SRST.
2000 *
2001 * LOCKING:
2002 * Kernel thread context (may sleep)
2003 *
2004 * RETURNS:
2005 * 0 on success, -errno otherwise.
2006 */
Tejun Heo9363c382008-04-07 22:47:16 +09002007int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
Tejun Heo624d5c52008-03-25 22:16:41 +09002008 unsigned long deadline)
2009{
2010 struct ata_port *ap = link->ap;
2011 unsigned int slave_possible = ap->flags & ATA_FLAG_SLAVE_POSS;
2012 unsigned int devmask = 0;
2013 int rc;
2014 u8 err;
2015
2016 DPRINTK("ENTER\n");
2017
Tejun Heo624d5c52008-03-25 22:16:41 +09002018 /* determine if device 0/1 are present */
2019 if (ata_devchk(ap, 0))
2020 devmask |= (1 << 0);
2021 if (slave_possible && ata_devchk(ap, 1))
2022 devmask |= (1 << 1);
2023
2024 /* select device 0 again */
Tejun Heo5682ed32008-04-07 22:47:16 +09002025 ap->ops->sff_dev_select(ap, 0);
Tejun Heo624d5c52008-03-25 22:16:41 +09002026
2027 /* issue bus reset */
2028 DPRINTK("about to softreset, devmask=%x\n", devmask);
2029 rc = ata_bus_softreset(ap, devmask, deadline);
2030 /* if link is occupied, -ENODEV too is an error */
2031 if (rc && (rc != -ENODEV || sata_scr_valid(link))) {
2032 ata_link_printk(link, KERN_ERR, "SRST failed (errno=%d)\n", rc);
2033 return rc;
2034 }
2035
2036 /* determine by signature whether we have ATA or ATAPI devices */
Tejun Heo9363c382008-04-07 22:47:16 +09002037 classes[0] = ata_sff_dev_classify(&link->device[0],
Tejun Heo624d5c52008-03-25 22:16:41 +09002038 devmask & (1 << 0), &err);
2039 if (slave_possible && err != 0x81)
Tejun Heo9363c382008-04-07 22:47:16 +09002040 classes[1] = ata_sff_dev_classify(&link->device[1],
Tejun Heo624d5c52008-03-25 22:16:41 +09002041 devmask & (1 << 1), &err);
2042
Tejun Heo624d5c52008-03-25 22:16:41 +09002043 DPRINTK("EXIT, classes[0]=%u [1]=%u\n", classes[0], classes[1]);
2044 return 0;
2045}
Alan Cox0fe40ff2009-01-05 14:16:13 +00002046EXPORT_SYMBOL_GPL(ata_sff_softreset);
Tejun Heo624d5c52008-03-25 22:16:41 +09002047
2048/**
Tejun Heo9363c382008-04-07 22:47:16 +09002049 * sata_sff_hardreset - reset host port via SATA phy reset
Tejun Heo624d5c52008-03-25 22:16:41 +09002050 * @link: link to reset
2051 * @class: resulting class of attached device
2052 * @deadline: deadline jiffies for the operation
2053 *
2054 * SATA phy-reset host port using DET bits of SControl register,
2055 * wait for !BSY and classify the attached device.
2056 *
2057 * LOCKING:
2058 * Kernel thread context (may sleep)
2059 *
2060 * RETURNS:
2061 * 0 on success, -errno otherwise.
2062 */
Tejun Heo9363c382008-04-07 22:47:16 +09002063int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
Tejun Heo624d5c52008-03-25 22:16:41 +09002064 unsigned long deadline)
2065{
Tejun Heo9dadd452008-04-07 22:47:19 +09002066 struct ata_eh_context *ehc = &link->eh_context;
2067 const unsigned long *timing = sata_ehc_deb_timing(ehc);
2068 bool online;
Tejun Heo624d5c52008-03-25 22:16:41 +09002069 int rc;
2070
Tejun Heo9dadd452008-04-07 22:47:19 +09002071 rc = sata_link_hardreset(link, timing, deadline, &online,
2072 ata_sff_check_ready);
Tejun Heo9dadd452008-04-07 22:47:19 +09002073 if (online)
2074 *class = ata_sff_dev_classify(link->device, 1, NULL);
Tejun Heo624d5c52008-03-25 22:16:41 +09002075
2076 DPRINTK("EXIT, class=%u\n", *class);
Tejun Heo9dadd452008-04-07 22:47:19 +09002077 return rc;
Tejun Heo624d5c52008-03-25 22:16:41 +09002078}
Alan Cox0fe40ff2009-01-05 14:16:13 +00002079EXPORT_SYMBOL_GPL(sata_sff_hardreset);
Tejun Heo624d5c52008-03-25 22:16:41 +09002080
2081/**
Tejun Heo203c75b2008-04-07 22:47:18 +09002082 * ata_sff_postreset - SFF postreset callback
2083 * @link: the target SFF ata_link
2084 * @classes: classes of attached devices
2085 *
2086 * This function is invoked after a successful reset. It first
2087 * calls ata_std_postreset() and performs SFF specific postreset
2088 * processing.
2089 *
2090 * LOCKING:
2091 * Kernel thread context (may sleep)
2092 */
2093void ata_sff_postreset(struct ata_link *link, unsigned int *classes)
2094{
2095 struct ata_port *ap = link->ap;
2096
2097 ata_std_postreset(link, classes);
2098
2099 /* is double-select really necessary? */
2100 if (classes[0] != ATA_DEV_NONE)
2101 ap->ops->sff_dev_select(ap, 1);
2102 if (classes[1] != ATA_DEV_NONE)
2103 ap->ops->sff_dev_select(ap, 0);
2104
2105 /* bail out if no device is present */
2106 if (classes[0] == ATA_DEV_NONE && classes[1] == ATA_DEV_NONE) {
2107 DPRINTK("EXIT, no device\n");
2108 return;
2109 }
2110
2111 /* set up device control */
Sergei Shtylyov41dec292010-05-07 22:47:50 +04002112 if (ap->ops->sff_set_devctl || ap->ioaddr.ctl_addr) {
2113 ata_sff_set_devctl(ap, ap->ctl);
Stuart MENEFYe3e43852009-03-10 11:38:13 +00002114 ap->last_ctl = ap->ctl;
2115 }
Tejun Heo203c75b2008-04-07 22:47:18 +09002116}
Alan Cox0fe40ff2009-01-05 14:16:13 +00002117EXPORT_SYMBOL_GPL(ata_sff_postreset);
Tejun Heo203c75b2008-04-07 22:47:18 +09002118
2119/**
Alan Cox3d47aa82009-03-24 10:23:19 +00002120 * ata_sff_drain_fifo - Stock FIFO drain logic for SFF controllers
2121 * @qc: command
2122 *
2123 * Drain the FIFO and device of any stuck data following a command
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002124 * failing to complete. In some cases this is necessary before a
Alan Cox3d47aa82009-03-24 10:23:19 +00002125 * reset will recover the device.
2126 *
2127 */
2128
2129void ata_sff_drain_fifo(struct ata_queued_cmd *qc)
2130{
2131 int count;
2132 struct ata_port *ap;
2133
2134 /* We only need to flush incoming data when a command was running */
2135 if (qc == NULL || qc->dma_dir == DMA_TO_DEVICE)
2136 return;
2137
2138 ap = qc->ap;
2139 /* Drain up to 64K of data before we give up this recovery method */
2140 for (count = 0; (ap->ops->sff_check_status(ap) & ATA_DRQ)
Robert Hancock9a8fd682009-12-08 20:48:10 -06002141 && count < 65536; count += 2)
Alan Cox3d47aa82009-03-24 10:23:19 +00002142 ioread16(ap->ioaddr.data_addr);
2143
2144 /* Can become DEBUG later */
2145 if (count)
2146 ata_port_printk(ap, KERN_DEBUG,
2147 "drained %d bytes to clear DRQ.\n", count);
2148
2149}
2150EXPORT_SYMBOL_GPL(ata_sff_drain_fifo);
2151
2152/**
Tejun Heofe06e5f2010-05-10 21:41:39 +02002153 * ata_sff_error_handler - Stock error handler for SFF controller
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002154 * @ap: port to handle error for
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002155 *
Tejun Heo9363c382008-04-07 22:47:16 +09002156 * Stock error handler for SFF controller. It can handle both
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002157 * PATA and SATA controllers. Many controllers should be able to
2158 * use this EH as-is or with some added handling before and
2159 * after.
2160 *
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002161 * LOCKING:
2162 * Kernel thread context (may sleep)
2163 */
Tejun Heo9363c382008-04-07 22:47:16 +09002164void ata_sff_error_handler(struct ata_port *ap)
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002165{
Tejun Heoa1efdab2008-03-25 12:22:50 +09002166 ata_reset_fn_t softreset = ap->ops->softreset;
2167 ata_reset_fn_t hardreset = ap->ops->hardreset;
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002168 struct ata_queued_cmd *qc;
2169 unsigned long flags;
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002170
Tejun Heo9af5c9c2007-08-06 18:36:22 +09002171 qc = __ata_qc_from_tag(ap, ap->link.active_tag);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002172 if (qc && !(qc->flags & ATA_QCFLAG_FAILED))
2173 qc = NULL;
2174
Jeff Garzikba6a1302006-06-22 23:46:10 -04002175 spin_lock_irqsave(ap->lock, flags);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002176
Tejun Heofe06e5f2010-05-10 21:41:39 +02002177 /*
2178 * We *MUST* do FIFO draining before we issue a reset as
2179 * several devices helpfully clear their internal state and
2180 * will lock solid if we touch the data port post reset. Pass
2181 * qc in case anyone wants to do different PIO/DMA recovery or
2182 * has per command fixups
Alan Cox3d47aa82009-03-24 10:23:19 +00002183 */
Tejun Heo8244cd02010-05-10 21:41:36 +02002184 if (ap->ops->sff_drain_fifo)
2185 ap->ops->sff_drain_fifo(qc);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002186
Jeff Garzikba6a1302006-06-22 23:46:10 -04002187 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002188
Tejun Heofe06e5f2010-05-10 21:41:39 +02002189 /* ignore ata_sff_softreset if ctl isn't accessible */
Tejun Heo9363c382008-04-07 22:47:16 +09002190 if (softreset == ata_sff_softreset && !ap->ioaddr.ctl_addr)
Tejun Heoa1efdab2008-03-25 12:22:50 +09002191 softreset = NULL;
Tejun Heofe06e5f2010-05-10 21:41:39 +02002192
2193 /* ignore built-in hardresets if SCR access is not available */
2194 if ((hardreset == sata_std_hardreset ||
2195 hardreset == sata_sff_hardreset) && !sata_scr_valid(&ap->link))
Tejun Heoa1efdab2008-03-25 12:22:50 +09002196 hardreset = NULL;
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002197
Tejun Heoa1efdab2008-03-25 12:22:50 +09002198 ata_do_eh(ap, ap->ops->prereset, softreset, hardreset,
2199 ap->ops->postreset);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002200}
Alan Cox0fe40ff2009-01-05 14:16:13 +00002201EXPORT_SYMBOL_GPL(ata_sff_error_handler);
Tejun Heo6d97dbd2006-05-15 20:58:24 +09002202
2203/**
Tejun Heo9363c382008-04-07 22:47:16 +09002204 * ata_sff_std_ports - initialize ioaddr with standard port offsets.
Tejun Heo624d5c52008-03-25 22:16:41 +09002205 * @ioaddr: IO address structure to be initialized
2206 *
2207 * Utility function which initializes data_addr, error_addr,
2208 * feature_addr, nsect_addr, lbal_addr, lbam_addr, lbah_addr,
2209 * device_addr, status_addr, and command_addr to standard offsets
2210 * relative to cmd_addr.
2211 *
2212 * Does not set ctl_addr, altstatus_addr, bmdma_addr, or scr_addr.
2213 */
Tejun Heo9363c382008-04-07 22:47:16 +09002214void ata_sff_std_ports(struct ata_ioports *ioaddr)
Tejun Heo624d5c52008-03-25 22:16:41 +09002215{
2216 ioaddr->data_addr = ioaddr->cmd_addr + ATA_REG_DATA;
2217 ioaddr->error_addr = ioaddr->cmd_addr + ATA_REG_ERR;
2218 ioaddr->feature_addr = ioaddr->cmd_addr + ATA_REG_FEATURE;
2219 ioaddr->nsect_addr = ioaddr->cmd_addr + ATA_REG_NSECT;
2220 ioaddr->lbal_addr = ioaddr->cmd_addr + ATA_REG_LBAL;
2221 ioaddr->lbam_addr = ioaddr->cmd_addr + ATA_REG_LBAM;
2222 ioaddr->lbah_addr = ioaddr->cmd_addr + ATA_REG_LBAH;
2223 ioaddr->device_addr = ioaddr->cmd_addr + ATA_REG_DEVICE;
2224 ioaddr->status_addr = ioaddr->cmd_addr + ATA_REG_STATUS;
2225 ioaddr->command_addr = ioaddr->cmd_addr + ATA_REG_CMD;
2226}
Alan Cox0fe40ff2009-01-05 14:16:13 +00002227EXPORT_SYMBOL_GPL(ata_sff_std_ports);
Tejun Heo624d5c52008-03-25 22:16:41 +09002228
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002229#ifdef CONFIG_PCI
Alan4112e162007-01-08 12:10:05 +00002230
Tejun Heo272f7882008-03-25 22:16:40 +09002231static int ata_resources_present(struct pci_dev *pdev, int port)
2232{
2233 int i;
2234
2235 /* Check the PCI resources for this channel are enabled */
2236 port = port * 2;
Alan Cox0fe40ff2009-01-05 14:16:13 +00002237 for (i = 0; i < 2; i++) {
Tejun Heo272f7882008-03-25 22:16:40 +09002238 if (pci_resource_start(pdev, port + i) == 0 ||
2239 pci_resource_len(pdev, port + i) == 0)
2240 return 0;
2241 }
2242 return 1;
2243}
2244
Tejun Heod491b272007-04-17 23:44:07 +09002245/**
Tejun Heo9363c382008-04-07 22:47:16 +09002246 * ata_pci_sff_init_host - acquire native PCI ATA resources and init host
Tejun Heod491b272007-04-17 23:44:07 +09002247 * @host: target ATA host
Tejun Heod491b272007-04-17 23:44:07 +09002248 *
Tejun Heo1626aeb2007-05-04 12:43:58 +02002249 * Acquire native PCI ATA resources for @host and initialize the
2250 * first two ports of @host accordingly. Ports marked dummy are
2251 * skipped and allocation failure makes the port dummy.
Tejun Heod491b272007-04-17 23:44:07 +09002252 *
Tejun Heod583bc12007-07-04 18:02:07 +09002253 * Note that native PCI resources are valid even for legacy hosts
2254 * as we fix up pdev resources array early in boot, so this
2255 * function can be used for both native and legacy SFF hosts.
2256 *
Tejun Heod491b272007-04-17 23:44:07 +09002257 * LOCKING:
2258 * Inherited from calling layer (may sleep).
2259 *
2260 * RETURNS:
Tejun Heo1626aeb2007-05-04 12:43:58 +02002261 * 0 if at least one port is initialized, -ENODEV if no port is
2262 * available.
Tejun Heod491b272007-04-17 23:44:07 +09002263 */
Tejun Heo9363c382008-04-07 22:47:16 +09002264int ata_pci_sff_init_host(struct ata_host *host)
Tejun Heod491b272007-04-17 23:44:07 +09002265{
2266 struct device *gdev = host->dev;
2267 struct pci_dev *pdev = to_pci_dev(gdev);
Tejun Heo1626aeb2007-05-04 12:43:58 +02002268 unsigned int mask = 0;
Tejun Heod491b272007-04-17 23:44:07 +09002269 int i, rc;
2270
Tejun Heod491b272007-04-17 23:44:07 +09002271 /* request, iomap BARs and init port addresses accordingly */
2272 for (i = 0; i < 2; i++) {
2273 struct ata_port *ap = host->ports[i];
2274 int base = i * 2;
2275 void __iomem * const *iomap;
2276
Tejun Heo1626aeb2007-05-04 12:43:58 +02002277 if (ata_port_is_dummy(ap))
Tejun Heod491b272007-04-17 23:44:07 +09002278 continue;
2279
Tejun Heo1626aeb2007-05-04 12:43:58 +02002280 /* Discard disabled ports. Some controllers show
2281 * their unused channels this way. Disabled ports are
2282 * made dummy.
2283 */
2284 if (!ata_resources_present(pdev, i)) {
2285 ap->ops = &ata_dummy_port_ops;
2286 continue;
2287 }
2288
Tejun Heo35a10a82008-01-04 18:42:21 +09002289 rc = pcim_iomap_regions(pdev, 0x3 << base,
2290 dev_driver_string(gdev));
Tejun Heod491b272007-04-17 23:44:07 +09002291 if (rc) {
Tejun Heo1626aeb2007-05-04 12:43:58 +02002292 dev_printk(KERN_WARNING, gdev,
2293 "failed to request/iomap BARs for port %d "
2294 "(errno=%d)\n", i, rc);
Tejun Heod491b272007-04-17 23:44:07 +09002295 if (rc == -EBUSY)
2296 pcim_pin_device(pdev);
Tejun Heo1626aeb2007-05-04 12:43:58 +02002297 ap->ops = &ata_dummy_port_ops;
2298 continue;
Tejun Heod491b272007-04-17 23:44:07 +09002299 }
2300 host->iomap = iomap = pcim_iomap_table(pdev);
2301
2302 ap->ioaddr.cmd_addr = iomap[base];
2303 ap->ioaddr.altstatus_addr =
2304 ap->ioaddr.ctl_addr = (void __iomem *)
2305 ((unsigned long)iomap[base + 1] | ATA_PCI_CTL_OFS);
Tejun Heo9363c382008-04-07 22:47:16 +09002306 ata_sff_std_ports(&ap->ioaddr);
Tejun Heo1626aeb2007-05-04 12:43:58 +02002307
Tejun Heocbcdd872007-08-18 13:14:55 +09002308 ata_port_desc(ap, "cmd 0x%llx ctl 0x%llx",
2309 (unsigned long long)pci_resource_start(pdev, base),
2310 (unsigned long long)pci_resource_start(pdev, base + 1));
2311
Tejun Heo1626aeb2007-05-04 12:43:58 +02002312 mask |= 1 << i;
2313 }
2314
2315 if (!mask) {
2316 dev_printk(KERN_ERR, gdev, "no available native port\n");
2317 return -ENODEV;
Tejun Heod491b272007-04-17 23:44:07 +09002318 }
2319
2320 return 0;
2321}
Alan Cox0fe40ff2009-01-05 14:16:13 +00002322EXPORT_SYMBOL_GPL(ata_pci_sff_init_host);
Tejun Heod491b272007-04-17 23:44:07 +09002323
Tejun Heo21b0ad42007-04-17 23:44:07 +09002324/**
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002325 * ata_pci_sff_prepare_host - helper to prepare PCI PIO-only SFF ATA host
Tejun Heo21b0ad42007-04-17 23:44:07 +09002326 * @pdev: target PCI device
Tejun Heo1626aeb2007-05-04 12:43:58 +02002327 * @ppi: array of port_info, must be enough for two ports
Tejun Heo21b0ad42007-04-17 23:44:07 +09002328 * @r_host: out argument for the initialized ATA host
2329 *
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002330 * Helper to allocate PIO-only SFF ATA host for @pdev, acquire
2331 * all PCI resources and initialize it accordingly in one go.
Tejun Heo21b0ad42007-04-17 23:44:07 +09002332 *
2333 * LOCKING:
2334 * Inherited from calling layer (may sleep).
2335 *
2336 * RETURNS:
2337 * 0 on success, -errno otherwise.
2338 */
Tejun Heo9363c382008-04-07 22:47:16 +09002339int ata_pci_sff_prepare_host(struct pci_dev *pdev,
Alan Cox0fe40ff2009-01-05 14:16:13 +00002340 const struct ata_port_info * const *ppi,
Tejun Heod583bc12007-07-04 18:02:07 +09002341 struct ata_host **r_host)
Tejun Heo21b0ad42007-04-17 23:44:07 +09002342{
2343 struct ata_host *host;
Tejun Heo21b0ad42007-04-17 23:44:07 +09002344 int rc;
2345
2346 if (!devres_open_group(&pdev->dev, NULL, GFP_KERNEL))
2347 return -ENOMEM;
2348
2349 host = ata_host_alloc_pinfo(&pdev->dev, ppi, 2);
2350 if (!host) {
2351 dev_printk(KERN_ERR, &pdev->dev,
2352 "failed to allocate ATA host\n");
2353 rc = -ENOMEM;
2354 goto err_out;
2355 }
2356
Tejun Heo9363c382008-04-07 22:47:16 +09002357 rc = ata_pci_sff_init_host(host);
Tejun Heo21b0ad42007-04-17 23:44:07 +09002358 if (rc)
2359 goto err_out;
2360
Tejun Heo21b0ad42007-04-17 23:44:07 +09002361 devres_remove_group(&pdev->dev, NULL);
2362 *r_host = host;
2363 return 0;
2364
Alan Cox0fe40ff2009-01-05 14:16:13 +00002365err_out:
Tejun Heo21b0ad42007-04-17 23:44:07 +09002366 devres_release_group(&pdev->dev, NULL);
2367 return rc;
2368}
Alan Cox0fe40ff2009-01-05 14:16:13 +00002369EXPORT_SYMBOL_GPL(ata_pci_sff_prepare_host);
Tejun Heo21b0ad42007-04-17 23:44:07 +09002370
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002371/**
Tejun Heo9363c382008-04-07 22:47:16 +09002372 * ata_pci_sff_activate_host - start SFF host, request IRQ and register it
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002373 * @host: target SFF ATA host
2374 * @irq_handler: irq_handler used when requesting IRQ(s)
2375 * @sht: scsi_host_template to use when registering the host
2376 *
2377 * This is the counterpart of ata_host_activate() for SFF ATA
2378 * hosts. This separate helper is necessary because SFF hosts
2379 * use two separate interrupts in legacy mode.
2380 *
2381 * LOCKING:
2382 * Inherited from calling layer (may sleep).
2383 *
2384 * RETURNS:
2385 * 0 on success, -errno otherwise.
2386 */
Tejun Heo9363c382008-04-07 22:47:16 +09002387int ata_pci_sff_activate_host(struct ata_host *host,
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002388 irq_handler_t irq_handler,
2389 struct scsi_host_template *sht)
2390{
2391 struct device *dev = host->dev;
2392 struct pci_dev *pdev = to_pci_dev(dev);
2393 const char *drv_name = dev_driver_string(host->dev);
2394 int legacy_mode = 0, rc;
2395
2396 rc = ata_host_start(host);
2397 if (rc)
2398 return rc;
2399
2400 if ((pdev->class >> 8) == PCI_CLASS_STORAGE_IDE) {
2401 u8 tmp8, mask;
2402
2403 /* TODO: What if one channel is in native mode ... */
2404 pci_read_config_byte(pdev, PCI_CLASS_PROG, &tmp8);
2405 mask = (1 << 2) | (1 << 0);
2406 if ((tmp8 & mask) != mask)
2407 legacy_mode = 1;
2408#if defined(CONFIG_NO_ATA_LEGACY)
2409 /* Some platforms with PCI limits cannot address compat
2410 port space. In that case we punt if their firmware has
2411 left a device in compatibility mode */
2412 if (legacy_mode) {
2413 printk(KERN_ERR "ata: Compatibility mode ATA is not supported on this platform, skipping.\n");
2414 return -EOPNOTSUPP;
2415 }
2416#endif
2417 }
2418
2419 if (!devres_open_group(dev, NULL, GFP_KERNEL))
2420 return -ENOMEM;
2421
2422 if (!legacy_mode && pdev->irq) {
2423 rc = devm_request_irq(dev, pdev->irq, irq_handler,
2424 IRQF_SHARED, drv_name, host);
2425 if (rc)
2426 goto out;
2427
2428 ata_port_desc(host->ports[0], "irq %d", pdev->irq);
2429 ata_port_desc(host->ports[1], "irq %d", pdev->irq);
2430 } else if (legacy_mode) {
2431 if (!ata_port_is_dummy(host->ports[0])) {
2432 rc = devm_request_irq(dev, ATA_PRIMARY_IRQ(pdev),
2433 irq_handler, IRQF_SHARED,
2434 drv_name, host);
2435 if (rc)
2436 goto out;
2437
2438 ata_port_desc(host->ports[0], "irq %d",
2439 ATA_PRIMARY_IRQ(pdev));
2440 }
2441
2442 if (!ata_port_is_dummy(host->ports[1])) {
2443 rc = devm_request_irq(dev, ATA_SECONDARY_IRQ(pdev),
2444 irq_handler, IRQF_SHARED,
2445 drv_name, host);
2446 if (rc)
2447 goto out;
2448
2449 ata_port_desc(host->ports[1], "irq %d",
2450 ATA_SECONDARY_IRQ(pdev));
2451 }
2452 }
2453
2454 rc = ata_host_register(host, sht);
Alan Cox0fe40ff2009-01-05 14:16:13 +00002455out:
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002456 if (rc == 0)
2457 devres_remove_group(dev, NULL);
2458 else
2459 devres_release_group(dev, NULL);
2460
2461 return rc;
2462}
Alan Cox0fe40ff2009-01-05 14:16:13 +00002463EXPORT_SYMBOL_GPL(ata_pci_sff_activate_host);
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002464
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002465static const struct ata_port_info *ata_sff_find_valid_pi(
2466 const struct ata_port_info * const *ppi)
2467{
2468 int i;
2469
2470 /* look up the first valid port_info */
2471 for (i = 0; i < 2 && ppi[i]; i++)
2472 if (ppi[i]->port_ops != &ata_dummy_port_ops)
2473 return ppi[i];
2474
2475 return NULL;
2476}
2477
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002478/**
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002479 * ata_pci_sff_init_one - Initialize/register PIO-only PCI IDE controller
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002480 * @pdev: Controller to be initialized
Tejun Heo1626aeb2007-05-04 12:43:58 +02002481 * @ppi: array of port_info, must be enough for two ports
Tejun Heo1bd5b712008-03-25 12:22:49 +09002482 * @sht: scsi_host_template to use when registering the host
Tejun Heo887125e2008-03-25 12:22:49 +09002483 * @host_priv: host private_data
Alan Cox16ea0fc2010-02-23 02:26:06 -05002484 * @hflag: host flags
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002485 *
2486 * This is a helper function which can be called from a driver's
2487 * xxx_init_one() probe function if the hardware uses traditional
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002488 * IDE taskfile registers and is PIO only.
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002489 *
Alan Cox2ec7df02006-08-10 16:59:10 +09002490 * ASSUMPTION:
2491 * Nobody makes a single channel controller that appears solely as
2492 * the secondary legacy port on PCI.
2493 *
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002494 * LOCKING:
2495 * Inherited from PCI layer (may sleep).
2496 *
2497 * RETURNS:
2498 * Zero on success, negative on errno-based value on error.
2499 */
Tejun Heo9363c382008-04-07 22:47:16 +09002500int ata_pci_sff_init_one(struct pci_dev *pdev,
Alan Cox16ea0fc2010-02-23 02:26:06 -05002501 const struct ata_port_info * const *ppi,
2502 struct scsi_host_template *sht, void *host_priv, int hflag)
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002503{
Tejun Heof0d36ef2007-01-20 16:00:28 +09002504 struct device *dev = &pdev->dev;
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002505 const struct ata_port_info *pi;
Tejun Heo0f834de2007-04-17 23:44:07 +09002506 struct ata_host *host = NULL;
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002507 int rc;
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002508
2509 DPRINTK("ENTER\n");
2510
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002511 pi = ata_sff_find_valid_pi(ppi);
Tejun Heo1626aeb2007-05-04 12:43:58 +02002512 if (!pi) {
2513 dev_printk(KERN_ERR, &pdev->dev,
2514 "no valid port_info specified\n");
2515 return -EINVAL;
2516 }
2517
Tejun Heof0d36ef2007-01-20 16:00:28 +09002518 if (!devres_open_group(dev, NULL, GFP_KERNEL))
2519 return -ENOMEM;
2520
Tejun Heof0d36ef2007-01-20 16:00:28 +09002521 rc = pcim_enable_device(pdev);
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002522 if (rc)
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002523 goto out;
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002524
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002525 /* prepare and activate SFF host */
Tejun Heo9363c382008-04-07 22:47:16 +09002526 rc = ata_pci_sff_prepare_host(pdev, ppi, &host);
Tejun Heod583bc12007-07-04 18:02:07 +09002527 if (rc)
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002528 goto out;
Tejun Heo887125e2008-03-25 12:22:49 +09002529 host->private_data = host_priv;
Alan Cox16ea0fc2010-02-23 02:26:06 -05002530 host->flags |= hflag;
Tejun Heod491b272007-04-17 23:44:07 +09002531
Tejun Heo1c5afdf2010-05-19 22:10:22 +02002532 rc = ata_pci_sff_activate_host(host, ata_sff_interrupt, sht);
Alan Cox0fe40ff2009-01-05 14:16:13 +00002533out:
Tejun Heo4e6b79f2008-01-18 18:36:28 +09002534 if (rc == 0)
2535 devres_remove_group(&pdev->dev, NULL);
2536 else
2537 devres_release_group(&pdev->dev, NULL);
Tejun Heod491b272007-04-17 23:44:07 +09002538
Jeff Garzik1fdffbc2006-02-09 05:15:27 -05002539 return rc;
2540}
Tejun Heo9363c382008-04-07 22:47:16 +09002541EXPORT_SYMBOL_GPL(ata_pci_sff_init_one);
Alan Cox0fe40ff2009-01-05 14:16:13 +00002542
Tejun Heo624d5c52008-03-25 22:16:41 +09002543#endif /* CONFIG_PCI */
Tejun Heo9f2f7212010-05-10 21:41:32 +02002544
Tejun Heo9a7780c2010-05-19 22:10:24 +02002545/*
2546 * BMDMA support
2547 */
2548
2549#ifdef CONFIG_ATA_BMDMA
2550
Tejun Heo9f2f7212010-05-10 21:41:32 +02002551const struct ata_port_operations ata_bmdma_port_ops = {
2552 .inherits = &ata_sff_port_ops,
2553
Tejun Heofe06e5f2010-05-10 21:41:39 +02002554 .error_handler = ata_bmdma_error_handler,
2555 .post_internal_cmd = ata_bmdma_post_internal_cmd,
2556
Tejun Heof47451c2010-05-10 21:41:40 +02002557 .qc_prep = ata_bmdma_qc_prep,
Tejun Heo360ff782010-05-10 21:41:42 +02002558 .qc_issue = ata_bmdma_qc_issue,
Tejun Heof47451c2010-05-10 21:41:40 +02002559
Tejun Heo37f65b82010-05-19 22:10:20 +02002560 .sff_irq_clear = ata_bmdma_irq_clear,
Tejun Heo9f2f7212010-05-10 21:41:32 +02002561 .bmdma_setup = ata_bmdma_setup,
2562 .bmdma_start = ata_bmdma_start,
2563 .bmdma_stop = ata_bmdma_stop,
2564 .bmdma_status = ata_bmdma_status,
Tejun Heoc7087652010-05-10 21:41:34 +02002565
2566 .port_start = ata_bmdma_port_start,
Tejun Heo9f2f7212010-05-10 21:41:32 +02002567};
2568EXPORT_SYMBOL_GPL(ata_bmdma_port_ops);
2569
2570const struct ata_port_operations ata_bmdma32_port_ops = {
2571 .inherits = &ata_bmdma_port_ops,
2572
2573 .sff_data_xfer = ata_sff_data_xfer32,
Tejun Heoc7087652010-05-10 21:41:34 +02002574 .port_start = ata_bmdma_port_start32,
Tejun Heo9f2f7212010-05-10 21:41:32 +02002575};
2576EXPORT_SYMBOL_GPL(ata_bmdma32_port_ops);
2577
Tejun Heo9f2f7212010-05-10 21:41:32 +02002578/**
Tejun Heof47451c2010-05-10 21:41:40 +02002579 * ata_bmdma_fill_sg - Fill PCI IDE PRD table
2580 * @qc: Metadata associated with taskfile to be transferred
2581 *
2582 * Fill PCI IDE PRD (scatter-gather) table with segments
2583 * associated with the current disk command.
2584 *
2585 * LOCKING:
2586 * spin_lock_irqsave(host lock)
2587 *
2588 */
2589static void ata_bmdma_fill_sg(struct ata_queued_cmd *qc)
2590{
2591 struct ata_port *ap = qc->ap;
Tejun Heof60d7012010-05-10 21:41:41 +02002592 struct ata_bmdma_prd *prd = ap->bmdma_prd;
Tejun Heof47451c2010-05-10 21:41:40 +02002593 struct scatterlist *sg;
2594 unsigned int si, pi;
2595
2596 pi = 0;
2597 for_each_sg(qc->sg, sg, qc->n_elem, si) {
2598 u32 addr, offset;
2599 u32 sg_len, len;
2600
2601 /* determine if physical DMA addr spans 64K boundary.
2602 * Note h/w doesn't support 64-bit, so we unconditionally
2603 * truncate dma_addr_t to u32.
2604 */
2605 addr = (u32) sg_dma_address(sg);
2606 sg_len = sg_dma_len(sg);
2607
2608 while (sg_len) {
2609 offset = addr & 0xffff;
2610 len = sg_len;
2611 if ((offset + sg_len) > 0x10000)
2612 len = 0x10000 - offset;
2613
Tejun Heof60d7012010-05-10 21:41:41 +02002614 prd[pi].addr = cpu_to_le32(addr);
2615 prd[pi].flags_len = cpu_to_le32(len & 0xffff);
Tejun Heof47451c2010-05-10 21:41:40 +02002616 VPRINTK("PRD[%u] = (0x%X, 0x%X)\n", pi, addr, len);
2617
2618 pi++;
2619 sg_len -= len;
2620 addr += len;
2621 }
2622 }
2623
Tejun Heof60d7012010-05-10 21:41:41 +02002624 prd[pi - 1].flags_len |= cpu_to_le32(ATA_PRD_EOT);
Tejun Heof47451c2010-05-10 21:41:40 +02002625}
2626
2627/**
2628 * ata_bmdma_fill_sg_dumb - Fill PCI IDE PRD table
2629 * @qc: Metadata associated with taskfile to be transferred
2630 *
2631 * Fill PCI IDE PRD (scatter-gather) table with segments
2632 * associated with the current disk command. Perform the fill
2633 * so that we avoid writing any length 64K records for
2634 * controllers that don't follow the spec.
2635 *
2636 * LOCKING:
2637 * spin_lock_irqsave(host lock)
2638 *
2639 */
2640static void ata_bmdma_fill_sg_dumb(struct ata_queued_cmd *qc)
2641{
2642 struct ata_port *ap = qc->ap;
Tejun Heof60d7012010-05-10 21:41:41 +02002643 struct ata_bmdma_prd *prd = ap->bmdma_prd;
Tejun Heof47451c2010-05-10 21:41:40 +02002644 struct scatterlist *sg;
2645 unsigned int si, pi;
2646
2647 pi = 0;
2648 for_each_sg(qc->sg, sg, qc->n_elem, si) {
2649 u32 addr, offset;
2650 u32 sg_len, len, blen;
2651
2652 /* determine if physical DMA addr spans 64K boundary.
2653 * Note h/w doesn't support 64-bit, so we unconditionally
2654 * truncate dma_addr_t to u32.
2655 */
2656 addr = (u32) sg_dma_address(sg);
2657 sg_len = sg_dma_len(sg);
2658
2659 while (sg_len) {
2660 offset = addr & 0xffff;
2661 len = sg_len;
2662 if ((offset + sg_len) > 0x10000)
2663 len = 0x10000 - offset;
2664
2665 blen = len & 0xffff;
Tejun Heof60d7012010-05-10 21:41:41 +02002666 prd[pi].addr = cpu_to_le32(addr);
Tejun Heof47451c2010-05-10 21:41:40 +02002667 if (blen == 0) {
2668 /* Some PATA chipsets like the CS5530 can't
2669 cope with 0x0000 meaning 64K as the spec
2670 says */
Tejun Heof60d7012010-05-10 21:41:41 +02002671 prd[pi].flags_len = cpu_to_le32(0x8000);
Tejun Heof47451c2010-05-10 21:41:40 +02002672 blen = 0x8000;
Tejun Heof60d7012010-05-10 21:41:41 +02002673 prd[++pi].addr = cpu_to_le32(addr + 0x8000);
Tejun Heof47451c2010-05-10 21:41:40 +02002674 }
Tejun Heof60d7012010-05-10 21:41:41 +02002675 prd[pi].flags_len = cpu_to_le32(blen);
Tejun Heof47451c2010-05-10 21:41:40 +02002676 VPRINTK("PRD[%u] = (0x%X, 0x%X)\n", pi, addr, len);
2677
2678 pi++;
2679 sg_len -= len;
2680 addr += len;
2681 }
2682 }
2683
Tejun Heof60d7012010-05-10 21:41:41 +02002684 prd[pi - 1].flags_len |= cpu_to_le32(ATA_PRD_EOT);
Tejun Heof47451c2010-05-10 21:41:40 +02002685}
2686
2687/**
2688 * ata_bmdma_qc_prep - Prepare taskfile for submission
2689 * @qc: Metadata associated with taskfile to be prepared
2690 *
2691 * Prepare ATA taskfile for submission.
2692 *
2693 * LOCKING:
2694 * spin_lock_irqsave(host lock)
2695 */
2696void ata_bmdma_qc_prep(struct ata_queued_cmd *qc)
2697{
2698 if (!(qc->flags & ATA_QCFLAG_DMAMAP))
2699 return;
2700
2701 ata_bmdma_fill_sg(qc);
2702}
2703EXPORT_SYMBOL_GPL(ata_bmdma_qc_prep);
2704
2705/**
2706 * ata_bmdma_dumb_qc_prep - Prepare taskfile for submission
2707 * @qc: Metadata associated with taskfile to be prepared
2708 *
2709 * Prepare ATA taskfile for submission.
2710 *
2711 * LOCKING:
2712 * spin_lock_irqsave(host lock)
2713 */
2714void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc)
2715{
2716 if (!(qc->flags & ATA_QCFLAG_DMAMAP))
2717 return;
2718
2719 ata_bmdma_fill_sg_dumb(qc);
2720}
2721EXPORT_SYMBOL_GPL(ata_bmdma_dumb_qc_prep);
2722
2723/**
Tejun Heo360ff782010-05-10 21:41:42 +02002724 * ata_bmdma_qc_issue - issue taskfile to a BMDMA controller
2725 * @qc: command to issue to device
2726 *
2727 * This function issues a PIO, NODATA or DMA command to a
2728 * SFF/BMDMA controller. PIO and NODATA are handled by
2729 * ata_sff_qc_issue().
2730 *
2731 * LOCKING:
2732 * spin_lock_irqsave(host lock)
2733 *
2734 * RETURNS:
2735 * Zero on success, AC_ERR_* mask on failure
2736 */
2737unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc)
2738{
2739 struct ata_port *ap = qc->ap;
2740
Tejun Heo360ff782010-05-10 21:41:42 +02002741 /* defer PIO handling to sff_qc_issue */
2742 if (!ata_is_dma(qc->tf.protocol))
2743 return ata_sff_qc_issue(qc);
2744
2745 /* select the device */
2746 ata_dev_select(ap, qc->dev->devno, 1, 0);
2747
2748 /* start the command */
2749 switch (qc->tf.protocol) {
2750 case ATA_PROT_DMA:
2751 WARN_ON_ONCE(qc->tf.flags & ATA_TFLAG_POLLING);
2752
2753 ap->ops->sff_tf_load(ap, &qc->tf); /* load tf registers */
2754 ap->ops->bmdma_setup(qc); /* set up bmdma */
2755 ap->ops->bmdma_start(qc); /* initiate bmdma */
2756 ap->hsm_task_state = HSM_ST_LAST;
2757 break;
2758
2759 case ATAPI_PROT_DMA:
2760 WARN_ON_ONCE(qc->tf.flags & ATA_TFLAG_POLLING);
2761
2762 ap->ops->sff_tf_load(ap, &qc->tf); /* load tf registers */
2763 ap->ops->bmdma_setup(qc); /* set up bmdma */
2764 ap->hsm_task_state = HSM_ST_FIRST;
2765
2766 /* send cdb by polling if no cdb interrupt */
2767 if (!(qc->dev->flags & ATA_DFLAG_CDB_INTR))
2768 ata_sff_queue_pio_task(ap, 0);
2769 break;
2770
2771 default:
2772 WARN_ON(1);
2773 return AC_ERR_SYSTEM;
2774 }
2775
2776 return 0;
2777}
2778EXPORT_SYMBOL_GPL(ata_bmdma_qc_issue);
2779
2780/**
Tejun Heoc3b28892010-05-19 22:10:21 +02002781 * ata_bmdma_port_intr - Handle BMDMA port interrupt
2782 * @ap: Port on which interrupt arrived (possibly...)
2783 * @qc: Taskfile currently active in engine
2784 *
2785 * Handle port interrupt for given queued command.
2786 *
2787 * LOCKING:
2788 * spin_lock_irqsave(host lock)
2789 *
2790 * RETURNS:
2791 * One if interrupt was handled, zero if not (shared irq).
2792 */
2793unsigned int ata_bmdma_port_intr(struct ata_port *ap, struct ata_queued_cmd *qc)
2794{
2795 struct ata_eh_info *ehi = &ap->link.eh_info;
2796 u8 host_stat = 0;
2797 bool bmdma_stopped = false;
2798 unsigned int handled;
2799
2800 if (ap->hsm_task_state == HSM_ST_LAST && ata_is_dma(qc->tf.protocol)) {
2801 /* check status of DMA engine */
2802 host_stat = ap->ops->bmdma_status(ap);
2803 VPRINTK("ata%u: host_stat 0x%X\n", ap->print_id, host_stat);
2804
2805 /* if it's not our irq... */
2806 if (!(host_stat & ATA_DMA_INTR))
2807 return ata_sff_idle_irq(ap);
2808
2809 /* before we do anything else, clear DMA-Start bit */
2810 ap->ops->bmdma_stop(qc);
2811 bmdma_stopped = true;
2812
2813 if (unlikely(host_stat & ATA_DMA_ERR)) {
2814 /* error when transfering data to/from memory */
2815 qc->err_mask |= AC_ERR_HOST_BUS;
2816 ap->hsm_task_state = HSM_ST_ERR;
2817 }
2818 }
2819
2820 handled = __ata_sff_port_intr(ap, qc, bmdma_stopped);
2821
2822 if (unlikely(qc->err_mask) && ata_is_dma(qc->tf.protocol))
2823 ata_ehi_push_desc(ehi, "BMDMA stat 0x%x", host_stat);
2824
2825 return handled;
2826}
2827EXPORT_SYMBOL_GPL(ata_bmdma_port_intr);
2828
2829/**
2830 * ata_bmdma_interrupt - Default BMDMA ATA host interrupt handler
2831 * @irq: irq line (unused)
2832 * @dev_instance: pointer to our ata_host information structure
2833 *
2834 * Default interrupt handler for PCI IDE devices. Calls
2835 * ata_bmdma_port_intr() for each port that is not disabled.
2836 *
2837 * LOCKING:
2838 * Obtains host lock during operation.
2839 *
2840 * RETURNS:
2841 * IRQ_NONE or IRQ_HANDLED.
2842 */
2843irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance)
2844{
2845 return __ata_sff_interrupt(irq, dev_instance, ata_bmdma_port_intr);
2846}
2847EXPORT_SYMBOL_GPL(ata_bmdma_interrupt);
2848
2849/**
Tejun Heofe06e5f2010-05-10 21:41:39 +02002850 * ata_bmdma_error_handler - Stock error handler for BMDMA controller
2851 * @ap: port to handle error for
2852 *
2853 * Stock error handler for BMDMA controller. It can handle both
2854 * PATA and SATA controllers. Most BMDMA controllers should be
2855 * able to use this EH as-is or with some added handling before
2856 * and after.
2857 *
2858 * LOCKING:
2859 * Kernel thread context (may sleep)
2860 */
2861void ata_bmdma_error_handler(struct ata_port *ap)
2862{
2863 struct ata_queued_cmd *qc;
2864 unsigned long flags;
2865 bool thaw = false;
2866
2867 qc = __ata_qc_from_tag(ap, ap->link.active_tag);
2868 if (qc && !(qc->flags & ATA_QCFLAG_FAILED))
2869 qc = NULL;
2870
2871 /* reset PIO HSM and stop DMA engine */
2872 spin_lock_irqsave(ap->lock, flags);
2873
2874 if (qc && ata_is_dma(qc->tf.protocol)) {
2875 u8 host_stat;
2876
2877 host_stat = ap->ops->bmdma_status(ap);
2878
2879 /* BMDMA controllers indicate host bus error by
2880 * setting DMA_ERR bit and timing out. As it wasn't
2881 * really a timeout event, adjust error mask and
2882 * cancel frozen state.
2883 */
2884 if (qc->err_mask == AC_ERR_TIMEOUT && (host_stat & ATA_DMA_ERR)) {
2885 qc->err_mask = AC_ERR_HOST_BUS;
2886 thaw = true;
2887 }
2888
2889 ap->ops->bmdma_stop(qc);
2890
2891 /* if we're gonna thaw, make sure IRQ is clear */
2892 if (thaw) {
2893 ap->ops->sff_check_status(ap);
Tejun Heo37f65b82010-05-19 22:10:20 +02002894 if (ap->ops->sff_irq_clear)
2895 ap->ops->sff_irq_clear(ap);
Tejun Heofe06e5f2010-05-10 21:41:39 +02002896 }
2897 }
2898
2899 spin_unlock_irqrestore(ap->lock, flags);
2900
2901 if (thaw)
2902 ata_eh_thaw_port(ap);
2903
2904 ata_sff_error_handler(ap);
2905}
2906EXPORT_SYMBOL_GPL(ata_bmdma_error_handler);
2907
2908/**
2909 * ata_bmdma_post_internal_cmd - Stock post_internal_cmd for BMDMA
2910 * @qc: internal command to clean up
2911 *
2912 * LOCKING:
2913 * Kernel thread context (may sleep)
2914 */
2915void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc)
2916{
2917 struct ata_port *ap = qc->ap;
2918 unsigned long flags;
2919
2920 if (ata_is_dma(qc->tf.protocol)) {
2921 spin_lock_irqsave(ap->lock, flags);
2922 ap->ops->bmdma_stop(qc);
2923 spin_unlock_irqrestore(ap->lock, flags);
2924 }
2925}
2926EXPORT_SYMBOL_GPL(ata_bmdma_post_internal_cmd);
2927
2928/**
Tejun Heo37f65b82010-05-19 22:10:20 +02002929 * ata_bmdma_irq_clear - Clear PCI IDE BMDMA interrupt.
2930 * @ap: Port associated with this ATA transaction.
2931 *
2932 * Clear interrupt and error flags in DMA status register.
2933 *
2934 * May be used as the irq_clear() entry in ata_port_operations.
2935 *
2936 * LOCKING:
2937 * spin_lock_irqsave(host lock)
2938 */
2939void ata_bmdma_irq_clear(struct ata_port *ap)
2940{
2941 void __iomem *mmio = ap->ioaddr.bmdma_addr;
2942
2943 if (!mmio)
2944 return;
2945
2946 iowrite8(ioread8(mmio + ATA_DMA_STATUS), mmio + ATA_DMA_STATUS);
2947}
2948EXPORT_SYMBOL_GPL(ata_bmdma_irq_clear);
2949
2950/**
Tejun Heo9f2f7212010-05-10 21:41:32 +02002951 * ata_bmdma_setup - Set up PCI IDE BMDMA transaction
2952 * @qc: Info associated with this ATA transaction.
2953 *
2954 * LOCKING:
2955 * spin_lock_irqsave(host lock)
2956 */
2957void ata_bmdma_setup(struct ata_queued_cmd *qc)
2958{
2959 struct ata_port *ap = qc->ap;
2960 unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
2961 u8 dmactl;
2962
2963 /* load PRD table addr. */
2964 mb(); /* make sure PRD table writes are visible to controller */
Tejun Heof60d7012010-05-10 21:41:41 +02002965 iowrite32(ap->bmdma_prd_dma, ap->ioaddr.bmdma_addr + ATA_DMA_TABLE_OFS);
Tejun Heo9f2f7212010-05-10 21:41:32 +02002966
2967 /* specify data direction, triple-check start bit is clear */
2968 dmactl = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
2969 dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
2970 if (!rw)
2971 dmactl |= ATA_DMA_WR;
2972 iowrite8(dmactl, ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
2973
2974 /* issue r/w command */
2975 ap->ops->sff_exec_command(ap, &qc->tf);
2976}
2977EXPORT_SYMBOL_GPL(ata_bmdma_setup);
2978
2979/**
2980 * ata_bmdma_start - Start a PCI IDE BMDMA transaction
2981 * @qc: Info associated with this ATA transaction.
2982 *
2983 * LOCKING:
2984 * spin_lock_irqsave(host lock)
2985 */
2986void ata_bmdma_start(struct ata_queued_cmd *qc)
2987{
2988 struct ata_port *ap = qc->ap;
2989 u8 dmactl;
2990
2991 /* start host DMA transaction */
2992 dmactl = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
2993 iowrite8(dmactl | ATA_DMA_START, ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
2994
2995 /* Strictly, one may wish to issue an ioread8() here, to
2996 * flush the mmio write. However, control also passes
2997 * to the hardware at this point, and it will interrupt
2998 * us when we are to resume control. So, in effect,
2999 * we don't care when the mmio write flushes.
3000 * Further, a read of the DMA status register _immediately_
3001 * following the write may not be what certain flaky hardware
3002 * is expected, so I think it is best to not add a readb()
3003 * without first all the MMIO ATA cards/mobos.
3004 * Or maybe I'm just being paranoid.
3005 *
3006 * FIXME: The posting of this write means I/O starts are
3007 * unneccessarily delayed for MMIO
3008 */
3009}
3010EXPORT_SYMBOL_GPL(ata_bmdma_start);
3011
3012/**
3013 * ata_bmdma_stop - Stop PCI IDE BMDMA transfer
3014 * @qc: Command we are ending DMA for
3015 *
3016 * Clears the ATA_DMA_START flag in the dma control register
3017 *
3018 * May be used as the bmdma_stop() entry in ata_port_operations.
3019 *
3020 * LOCKING:
3021 * spin_lock_irqsave(host lock)
3022 */
3023void ata_bmdma_stop(struct ata_queued_cmd *qc)
3024{
3025 struct ata_port *ap = qc->ap;
3026 void __iomem *mmio = ap->ioaddr.bmdma_addr;
3027
3028 /* clear start/stop bit */
3029 iowrite8(ioread8(mmio + ATA_DMA_CMD) & ~ATA_DMA_START,
3030 mmio + ATA_DMA_CMD);
3031
3032 /* one-PIO-cycle guaranteed wait, per spec, for HDMA1:0 transition */
3033 ata_sff_dma_pause(ap);
3034}
3035EXPORT_SYMBOL_GPL(ata_bmdma_stop);
3036
3037/**
3038 * ata_bmdma_status - Read PCI IDE BMDMA status
3039 * @ap: Port associated with this ATA transaction.
3040 *
3041 * Read and return BMDMA status register.
3042 *
3043 * May be used as the bmdma_status() entry in ata_port_operations.
3044 *
3045 * LOCKING:
3046 * spin_lock_irqsave(host lock)
3047 */
3048u8 ata_bmdma_status(struct ata_port *ap)
3049{
3050 return ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
3051}
3052EXPORT_SYMBOL_GPL(ata_bmdma_status);
3053
Tejun Heoc7087652010-05-10 21:41:34 +02003054
3055/**
3056 * ata_bmdma_port_start - Set port up for bmdma.
3057 * @ap: Port to initialize
3058 *
3059 * Called just after data structures for each port are
3060 * initialized. Allocates space for PRD table.
3061 *
3062 * May be used as the port_start() entry in ata_port_operations.
3063 *
3064 * LOCKING:
3065 * Inherited from caller.
3066 */
3067int ata_bmdma_port_start(struct ata_port *ap)
3068{
3069 if (ap->mwdma_mask || ap->udma_mask) {
Tejun Heof60d7012010-05-10 21:41:41 +02003070 ap->bmdma_prd =
3071 dmam_alloc_coherent(ap->host->dev, ATA_PRD_TBL_SZ,
3072 &ap->bmdma_prd_dma, GFP_KERNEL);
3073 if (!ap->bmdma_prd)
Tejun Heoc7087652010-05-10 21:41:34 +02003074 return -ENOMEM;
3075 }
3076
3077 return 0;
3078}
3079EXPORT_SYMBOL_GPL(ata_bmdma_port_start);
3080
3081/**
3082 * ata_bmdma_port_start32 - Set port up for dma.
3083 * @ap: Port to initialize
3084 *
3085 * Called just after data structures for each port are
3086 * initialized. Enables 32bit PIO and allocates space for PRD
3087 * table.
3088 *
3089 * May be used as the port_start() entry in ata_port_operations for
3090 * devices that are capable of 32bit PIO.
3091 *
3092 * LOCKING:
3093 * Inherited from caller.
3094 */
3095int ata_bmdma_port_start32(struct ata_port *ap)
3096{
3097 ap->pflags |= ATA_PFLAG_PIO32 | ATA_PFLAG_PIO32CHANGE;
3098 return ata_bmdma_port_start(ap);
3099}
3100EXPORT_SYMBOL_GPL(ata_bmdma_port_start32);
3101
Tejun Heo9f2f7212010-05-10 21:41:32 +02003102#ifdef CONFIG_PCI
3103
3104/**
3105 * ata_pci_bmdma_clear_simplex - attempt to kick device out of simplex
3106 * @pdev: PCI device
3107 *
3108 * Some PCI ATA devices report simplex mode but in fact can be told to
3109 * enter non simplex mode. This implements the necessary logic to
3110 * perform the task on such devices. Calling it on other devices will
3111 * have -undefined- behaviour.
3112 */
3113int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev)
3114{
3115 unsigned long bmdma = pci_resource_start(pdev, 4);
3116 u8 simplex;
3117
3118 if (bmdma == 0)
3119 return -ENOENT;
3120
3121 simplex = inb(bmdma + 0x02);
3122 outb(simplex & 0x60, bmdma + 0x02);
3123 simplex = inb(bmdma + 0x02);
3124 if (simplex & 0x80)
3125 return -EOPNOTSUPP;
3126 return 0;
3127}
3128EXPORT_SYMBOL_GPL(ata_pci_bmdma_clear_simplex);
3129
Tejun Heoc7087652010-05-10 21:41:34 +02003130static void ata_bmdma_nodma(struct ata_host *host, const char *reason)
3131{
3132 int i;
3133
3134 dev_printk(KERN_ERR, host->dev, "BMDMA: %s, falling back to PIO\n",
3135 reason);
3136
3137 for (i = 0; i < 2; i++) {
3138 host->ports[i]->mwdma_mask = 0;
3139 host->ports[i]->udma_mask = 0;
3140 }
3141}
3142
Tejun Heo9f2f7212010-05-10 21:41:32 +02003143/**
3144 * ata_pci_bmdma_init - acquire PCI BMDMA resources and init ATA host
3145 * @host: target ATA host
3146 *
3147 * Acquire PCI BMDMA resources and initialize @host accordingly.
3148 *
3149 * LOCKING:
3150 * Inherited from calling layer (may sleep).
Tejun Heo9f2f7212010-05-10 21:41:32 +02003151 */
Tejun Heoc7087652010-05-10 21:41:34 +02003152void ata_pci_bmdma_init(struct ata_host *host)
Tejun Heo9f2f7212010-05-10 21:41:32 +02003153{
3154 struct device *gdev = host->dev;
3155 struct pci_dev *pdev = to_pci_dev(gdev);
3156 int i, rc;
3157
3158 /* No BAR4 allocation: No DMA */
Tejun Heoc7087652010-05-10 21:41:34 +02003159 if (pci_resource_start(pdev, 4) == 0) {
3160 ata_bmdma_nodma(host, "BAR4 is zero");
3161 return;
3162 }
Tejun Heo9f2f7212010-05-10 21:41:32 +02003163
Tejun Heoc7087652010-05-10 21:41:34 +02003164 /*
3165 * Some controllers require BMDMA region to be initialized
3166 * even if DMA is not in use to clear IRQ status via
3167 * ->sff_irq_clear method. Try to initialize bmdma_addr
3168 * regardless of dma masks.
3169 */
Tejun Heo9f2f7212010-05-10 21:41:32 +02003170 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
3171 if (rc)
Tejun Heoc7087652010-05-10 21:41:34 +02003172 ata_bmdma_nodma(host, "failed to set dma mask");
3173 if (!rc) {
3174 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
3175 if (rc)
3176 ata_bmdma_nodma(host,
3177 "failed to set consistent dma mask");
3178 }
Tejun Heo9f2f7212010-05-10 21:41:32 +02003179
3180 /* request and iomap DMA region */
3181 rc = pcim_iomap_regions(pdev, 1 << 4, dev_driver_string(gdev));
3182 if (rc) {
Tejun Heoc7087652010-05-10 21:41:34 +02003183 ata_bmdma_nodma(host, "failed to request/iomap BAR4");
3184 return;
Tejun Heo9f2f7212010-05-10 21:41:32 +02003185 }
3186 host->iomap = pcim_iomap_table(pdev);
3187
3188 for (i = 0; i < 2; i++) {
3189 struct ata_port *ap = host->ports[i];
3190 void __iomem *bmdma = host->iomap[4] + 8 * i;
3191
3192 if (ata_port_is_dummy(ap))
3193 continue;
3194
3195 ap->ioaddr.bmdma_addr = bmdma;
3196 if ((!(ap->flags & ATA_FLAG_IGN_SIMPLEX)) &&
3197 (ioread8(bmdma + 2) & 0x80))
3198 host->flags |= ATA_HOST_SIMPLEX;
3199
3200 ata_port_desc(ap, "bmdma 0x%llx",
3201 (unsigned long long)pci_resource_start(pdev, 4) + 8 * i);
3202 }
Tejun Heo9f2f7212010-05-10 21:41:32 +02003203}
3204EXPORT_SYMBOL_GPL(ata_pci_bmdma_init);
3205
Tejun Heo1c5afdf2010-05-19 22:10:22 +02003206/**
3207 * ata_pci_bmdma_prepare_host - helper to prepare PCI BMDMA ATA host
3208 * @pdev: target PCI device
3209 * @ppi: array of port_info, must be enough for two ports
3210 * @r_host: out argument for the initialized ATA host
3211 *
3212 * Helper to allocate BMDMA ATA host for @pdev, acquire all PCI
3213 * resources and initialize it accordingly in one go.
3214 *
3215 * LOCKING:
3216 * Inherited from calling layer (may sleep).
3217 *
3218 * RETURNS:
3219 * 0 on success, -errno otherwise.
3220 */
3221int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
3222 const struct ata_port_info * const * ppi,
3223 struct ata_host **r_host)
3224{
3225 int rc;
3226
3227 rc = ata_pci_sff_prepare_host(pdev, ppi, r_host);
3228 if (rc)
3229 return rc;
3230
3231 ata_pci_bmdma_init(*r_host);
3232 return 0;
3233}
3234EXPORT_SYMBOL_GPL(ata_pci_bmdma_prepare_host);
3235
3236/**
3237 * ata_pci_bmdma_init_one - Initialize/register BMDMA PCI IDE controller
3238 * @pdev: Controller to be initialized
3239 * @ppi: array of port_info, must be enough for two ports
3240 * @sht: scsi_host_template to use when registering the host
3241 * @host_priv: host private_data
3242 * @hflags: host flags
3243 *
3244 * This function is similar to ata_pci_sff_init_one() but also
3245 * takes care of BMDMA initialization.
3246 *
3247 * LOCKING:
3248 * Inherited from PCI layer (may sleep).
3249 *
3250 * RETURNS:
3251 * Zero on success, negative on errno-based value on error.
3252 */
3253int ata_pci_bmdma_init_one(struct pci_dev *pdev,
3254 const struct ata_port_info * const * ppi,
3255 struct scsi_host_template *sht, void *host_priv,
3256 int hflags)
3257{
3258 struct device *dev = &pdev->dev;
3259 const struct ata_port_info *pi;
3260 struct ata_host *host = NULL;
3261 int rc;
3262
3263 DPRINTK("ENTER\n");
3264
3265 pi = ata_sff_find_valid_pi(ppi);
3266 if (!pi) {
3267 dev_printk(KERN_ERR, &pdev->dev,
3268 "no valid port_info specified\n");
3269 return -EINVAL;
3270 }
3271
3272 if (!devres_open_group(dev, NULL, GFP_KERNEL))
3273 return -ENOMEM;
3274
3275 rc = pcim_enable_device(pdev);
3276 if (rc)
3277 goto out;
3278
3279 /* prepare and activate BMDMA host */
3280 rc = ata_pci_bmdma_prepare_host(pdev, ppi, &host);
3281 if (rc)
3282 goto out;
3283 host->private_data = host_priv;
3284 host->flags |= hflags;
3285
3286 pci_set_master(pdev);
3287 rc = ata_pci_sff_activate_host(host, ata_bmdma_interrupt, sht);
3288 out:
3289 if (rc == 0)
3290 devres_remove_group(&pdev->dev, NULL);
3291 else
3292 devres_release_group(&pdev->dev, NULL);
3293
3294 return rc;
3295}
3296EXPORT_SYMBOL_GPL(ata_pci_bmdma_init_one);
3297
Tejun Heo9f2f7212010-05-10 21:41:32 +02003298#endif /* CONFIG_PCI */
Tejun Heo9a7780c2010-05-19 22:10:24 +02003299#endif /* CONFIG_ATA_BMDMA */
Tejun Heo270390e2010-05-10 21:41:35 +02003300
3301/**
3302 * ata_sff_port_init - Initialize SFF/BMDMA ATA port
3303 * @ap: Port to initialize
3304 *
3305 * Called on port allocation to initialize SFF/BMDMA specific
3306 * fields.
3307 *
3308 * LOCKING:
3309 * None.
3310 */
3311void ata_sff_port_init(struct ata_port *ap)
3312{
Tejun Heoc4291372010-05-10 21:41:38 +02003313 INIT_DELAYED_WORK(&ap->sff_pio_task, ata_sff_pio_task);
Tejun Heo5fe74542010-05-10 21:41:37 +02003314 ap->ctl = ATA_DEVCTL_OBS;
3315 ap->last_ctl = 0xFF;
Tejun Heo270390e2010-05-10 21:41:35 +02003316}
3317
3318int __init ata_sff_init(void)
3319{
Tejun Heoad72cf92010-07-02 10:03:52 +02003320 ata_sff_wq = alloc_workqueue("ata_sff", WQ_RESCUER, WQ_MAX_ACTIVE);
Tejun Heoc4291372010-05-10 21:41:38 +02003321 if (!ata_sff_wq)
3322 return -ENOMEM;
3323
Tejun Heo270390e2010-05-10 21:41:35 +02003324 return 0;
3325}
3326
3327void __exit ata_sff_exit(void)
3328{
Tejun Heoc4291372010-05-10 21:41:38 +02003329 destroy_workqueue(ata_sff_wq);
Tejun Heo270390e2010-05-10 21:41:35 +02003330}