projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
libata: Implement support for sense data reporting
[linux-2.6-block.git] / drivers / ata / libata-scsi.c
CommitLineData
1da177e4 1/*
af36d7f0
JG		 2 * libata-scsi.c - helper library for ATA
3 *
8c3d3d4b 4 * Maintained by: Tejun Heo <tj@kernel.org>
af36d7f0
JG		 5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
7 *
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 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
31 * - http://www.t10.org/
32 * - http://www.t13.org/
33 *
1da177e4
LT		 34 */
35
5a0e3ad6 36#include <linux/slab.h>
1da177e4
LT		 37#include <linux/kernel.h>
38#include <linux/blkdev.h>
39#include <linux/spinlock.h>
38789fda 40#include <linux/export.h>
1da177e4 41#include <scsi/scsi.h>
1da177e4 42#include <scsi/scsi_host.h>
beb40487 43#include <scsi/scsi_cmnd.h>
85837ebd 44#include <scsi/scsi_eh.h>
005a5a06 45#include <scsi/scsi_device.h>
a6e6ce8e 46#include <scsi/scsi_tcq.h>
30afc84c 47#include <scsi/scsi_transport.h>
1da177e4 48#include <linux/libata.h>
b095518e 49#include <linux/hdreg.h>
2dcb407e 50#include <linux/uaccess.h>
2a6e58d2 51#include <linux/suspend.h>
18f0f978 52#include <asm/unaligned.h>
1da177e4
LT		 53
54#include "libata.h"
d9027470 55#include "libata-transport.h"
1da177e4 56
87340e98
TH		 57#define ATA_SCSI_RBUF_SIZE 4096
58
59static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
60static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
b095518e 61
ad706991 62typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
ab5b3a5b 63
2dcb407e 64static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
ab5b3a5b 65 const struct scsi_device *scsidev);
2dcb407e 66static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
ab5b3a5b 67 const struct scsi_device *scsidev);
1da177e4 68
00ac37f5
DG		 69#define RW_RECOVERY_MPAGE 0x1
70#define RW_RECOVERY_MPAGE_LEN 12
71#define CACHE_MPAGE 0x8
72#define CACHE_MPAGE_LEN 20
73#define CONTROL_MPAGE 0xa
74#define CONTROL_MPAGE_LEN 12
75#define ALL_MPAGES 0x3f
76#define ALL_SUB_MPAGES 0xff
77
78
24f75686 79static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
00ac37f5
DG		 80 RW_RECOVERY_MPAGE,
81 RW_RECOVERY_MPAGE_LEN - 2,
24f75686 82 (1 << 7), /* AWRE */
00ac37f5
DG		 83 0, /* read retry count */
84 0, 0, 0, 0,
85 0, /* write retry count */
86 0, 0, 0
87};
88
89static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
90 CACHE_MPAGE,
91 CACHE_MPAGE_LEN - 2,
92 0, /* contains WCE, needs to be 0 for logic */
93 0, 0, 0, 0, 0, 0, 0, 0, 0,
94 0, /* contains DRA, needs to be 0 for logic */
95 0, 0, 0, 0, 0, 0, 0
96};
97
98static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
99 CONTROL_MPAGE,
100 CONTROL_MPAGE_LEN - 2,
101 2, /* DSENSE=0, GLTSD=1 */
102 0, /* [QAM+QERR may be 1, see 05-359r1] */
103 0, 0, 0, 0, 0xff, 0xff,
104 0, 30 /* extended self test time, see 05-359r1 */
105};
106
c93b263e
TH		 107static const char *ata_lpm_policy_names[] = {
108 [ATA_LPM_UNKNOWN] = "max_performance",
109 [ATA_LPM_MAX_POWER] = "max_performance",
110 [ATA_LPM_MED_POWER] = "medium_power",
111 [ATA_LPM_MIN_POWER] = "min_power",
ca77329f
KCA		 112};
113
ecd75ad5 114static ssize_t ata_scsi_lpm_store(struct device *device,
c93b263e
TH		 115 struct device_attribute *attr,
116 const char *buf, size_t count)
ca77329f 117{
ecd75ad5 118 struct Scsi_Host *shost = class_to_shost(device);
ca77329f 119 struct ata_port *ap = ata_shost_to_port(shost);
ecd75ad5
TH		 120 struct ata_link *link;
121 struct ata_device *dev;
c93b263e 122 enum ata_lpm_policy policy;
6b7ae954 123 unsigned long flags;
c93b263e
TH		 124
125 /* UNKNOWN is internal state, iterate from MAX_POWER */
126 for (policy = ATA_LPM_MAX_POWER;
127 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
128 const char *name = ata_lpm_policy_names[policy];
129
130 if (strncmp(name, buf, strlen(name)) == 0)
ca77329f 131 break;
ca77329f 132 }
c93b263e 133 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
ca77329f
KCA		 134 return -EINVAL;
135
6b7ae954 136 spin_lock_irqsave(ap->lock, flags);
ecd75ad5
TH		 137
138 ata_for_each_link(link, ap, EDGE) {
139 ata_for_each_dev(dev, &ap->link, ENABLED) {
140 if (dev->horkage & ATA_HORKAGE_NOLPM) {
141 count = -EOPNOTSUPP;
142 goto out_unlock;
143 }
144 }
145 }
146
6b7ae954
TH		 147 ap->target_lpm_policy = policy;
148 ata_port_schedule_eh(ap);
ecd75ad5 149out_unlock:
6b7ae954 150 spin_unlock_irqrestore(ap->lock, flags);
ca77329f
KCA		 151 return count;
152}
153
c93b263e
TH		 154static ssize_t ata_scsi_lpm_show(struct device *dev,
155 struct device_attribute *attr, char *buf)
ca77329f 156{
ee959b00 157 struct Scsi_Host *shost = class_to_shost(dev);
ca77329f 158 struct ata_port *ap = ata_shost_to_port(shost);
ca77329f 159
6b7ae954 160 if (ap->target_lpm_policy >= ARRAY_SIZE(ata_lpm_policy_names))
ca77329f
KCA		 161 return -EINVAL;
162
c93b263e 163 return snprintf(buf, PAGE_SIZE, "%s\n",
6b7ae954 164 ata_lpm_policy_names[ap->target_lpm_policy]);
ca77329f 165}
ee959b00 166DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
c93b263e 167 ata_scsi_lpm_show, ata_scsi_lpm_store);
ee959b00 168EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
ca77329f 169
45fabbb7
EO		 170static ssize_t ata_scsi_park_show(struct device *device,
171 struct device_attribute *attr, char *buf)
172{
173 struct scsi_device *sdev = to_scsi_device(device);
174 struct ata_port *ap;
175 struct ata_link *link;
176 struct ata_device *dev;
a464189d 177 unsigned long flags, now;
45fabbb7
EO		 178 unsigned int uninitialized_var(msecs);
179 int rc = 0;
180
181 ap = ata_shost_to_port(sdev->host);
182
183 spin_lock_irqsave(ap->lock, flags);
184 dev = ata_scsi_find_dev(ap, sdev);
185 if (!dev) {
186 rc = -ENODEV;
187 goto unlock;
188 }
189 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
190 rc = -EOPNOTSUPP;
191 goto unlock;
192 }
193
194 link = dev->link;
a464189d 195 now = jiffies;
45fabbb7
EO		 196 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
197 link->eh_context.unloaded_mask & (1 << dev->devno) &&
a464189d
EO		 198 time_after(dev->unpark_deadline, now))
199 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
45fabbb7
EO		 200 else
201 msecs = 0;
202
203unlock:
204 spin_unlock_irq(ap->lock);
205
206 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
207}
208
209static ssize_t ata_scsi_park_store(struct device *device,
210 struct device_attribute *attr,
211 const char *buf, size_t len)
212{
213 struct scsi_device *sdev = to_scsi_device(device);
214 struct ata_port *ap;
215 struct ata_device *dev;
216 long int input;
217 unsigned long flags;
218 int rc;
219
42b9ab7a
JH		 220 rc = kstrtol(buf, 10, &input);
221 if (rc)
222 return rc;
223 if (input < -2)
45fabbb7
EO		 224 return -EINVAL;
225 if (input > ATA_TMOUT_MAX_PARK) {
226 rc = -EOVERFLOW;
227 input = ATA_TMOUT_MAX_PARK;
228 }
229
230 ap = ata_shost_to_port(sdev->host);
231
232 spin_lock_irqsave(ap->lock, flags);
233 dev = ata_scsi_find_dev(ap, sdev);
234 if (unlikely(!dev)) {
235 rc = -ENODEV;
236 goto unlock;
237 }
9162c657
HR		 238 if (dev->class != ATA_DEV_ATA &&
239 dev->class != ATA_DEV_ZAC) {
45fabbb7
EO		 240 rc = -EOPNOTSUPP;
241 goto unlock;
242 }
243
244 if (input >= 0) {
245 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
246 rc = -EOPNOTSUPP;
247 goto unlock;
248 }
249
250 dev->unpark_deadline = ata_deadline(jiffies, input);
251 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
252 ata_port_schedule_eh(ap);
253 complete(&ap->park_req_pending);
254 } else {
255 switch (input) {
256 case -1:
257 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
258 break;
259 case -2:
260 dev->flags |= ATA_DFLAG_NO_UNLOAD;
261 break;
262 }
263 }
264unlock:
265 spin_unlock_irqrestore(ap->lock, flags);
266
267 return rc ? rc : len;
268}
269DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
270 ata_scsi_park_show, ata_scsi_park_store);
271EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
272
42b966fb 273void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
f0761be3 274{
42b966fb
HR		 275 if (!cmd)
276 return;
277
f0761be3
TH		 278 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
279
280 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
281}
282
18f7ba4c
KCA		 283static ssize_t
284ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
285 const char *buf, size_t count)
286{
287 struct Scsi_Host *shost = class_to_shost(dev);
288 struct ata_port *ap = ata_shost_to_port(shost);
289 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
290 return ap->ops->em_store(ap, buf, count);
291 return -EINVAL;
292}
293
294static ssize_t
295ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
296 char *buf)
297{
298 struct Scsi_Host *shost = class_to_shost(dev);
299 struct ata_port *ap = ata_shost_to_port(shost);
300
301 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
302 return ap->ops->em_show(ap, buf);
303 return -EINVAL;
304}
ea7a5ed5 305DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
18f7ba4c
KCA		 306 ata_scsi_em_message_show, ata_scsi_em_message_store);
307EXPORT_SYMBOL_GPL(dev_attr_em_message);
308
309static ssize_t
310ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
311 char *buf)
312{
313 struct Scsi_Host *shost = class_to_shost(dev);
314 struct ata_port *ap = ata_shost_to_port(shost);
315
316 return snprintf(buf, 23, "%d\n", ap->em_message_type);
317}
318DEVICE_ATTR(em_message_type, S_IRUGO,
319 ata_scsi_em_message_type_show, NULL);
320EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
321
322static ssize_t
323ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
324 char *buf)
325{
326 struct scsi_device *sdev = to_scsi_device(dev);
327 struct ata_port *ap = ata_shost_to_port(sdev->host);
328 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
329
26cd4d65
XF		 330 if (atadev && ap->ops->sw_activity_show &&
331 (ap->flags & ATA_FLAG_SW_ACTIVITY))
18f7ba4c
KCA		 332 return ap->ops->sw_activity_show(atadev, buf);
333 return -EINVAL;
334}
335
336static ssize_t
337ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
338 const char *buf, size_t count)
339{
340 struct scsi_device *sdev = to_scsi_device(dev);
341 struct ata_port *ap = ata_shost_to_port(sdev->host);
342 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
343 enum sw_activity val;
344 int rc;
345
26cd4d65
XF		 346 if (atadev && ap->ops->sw_activity_store &&
347 (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
18f7ba4c
KCA		 348 val = simple_strtoul(buf, NULL, 0);
349 switch (val) {
350 case OFF: case BLINK_ON: case BLINK_OFF:
351 rc = ap->ops->sw_activity_store(atadev, val);
352 if (!rc)
353 return count;
354 else
355 return rc;
356 }
357 }
358 return -EINVAL;
359}
ea7a5ed5 360DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
18f7ba4c
KCA		 361 ata_scsi_activity_store);
362EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
363
45fabbb7
EO		 364struct device_attribute *ata_common_sdev_attrs[] = {
365 &dev_attr_unload_heads,
366 NULL
367};
368EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
369
b27dcfb0 370static void ata_scsi_invalid_field(struct scsi_cmnd *cmd)
ae006510
DG		 371{
372 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
373 /* "Invalid field in cbd" */
b27dcfb0 374 cmd->scsi_done(cmd);
ae006510
DG		 375}
376
1da177e4
LT		 377/**
378 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
379 * @sdev: SCSI device for which BIOS geometry is to be determined
380 * @bdev: block device associated with @sdev
381 * @capacity: capacity of SCSI device
382 * @geom: location to which geometry will be output
383 *
384 * Generic bios head/sector/cylinder calculator
385 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
386 * mapping. Some situations may arise where the disk is not
387 * bootable if this is not used.
388 *
389 * LOCKING:
390 * Defined by the SCSI layer. We don't really care.
391 *
392 * RETURNS:
393 * Zero.
394 */
395int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
396 sector_t capacity, int geom[])
397{
398 geom[0] = 255;
399 geom[1] = 63;
400 sector_div(capacity, 255*63);
401 geom[2] = capacity;
402
403 return 0;
404}
405
d8d9129e
TH		 406/**
407 * ata_scsi_unlock_native_capacity - unlock native capacity
408 * @sdev: SCSI device to adjust device capacity for
409 *
410 * This function is called if a partition on @sdev extends beyond
411 * the end of the device. It requests EH to unlock HPA.
412 *
413 * LOCKING:
414 * Defined by the SCSI layer. Might sleep.
415 */
416void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
417{
418 struct ata_port *ap = ata_shost_to_port(sdev->host);
419 struct ata_device *dev;
420 unsigned long flags;
421
422 spin_lock_irqsave(ap->lock, flags);
423
424 dev = ata_scsi_find_dev(ap, sdev);
425 if (dev && dev->n_sectors < dev->n_native_sectors) {
426 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
427 dev->link->eh_info.action |= ATA_EH_RESET;
428 ata_port_schedule_eh(ap);
429 }
430
431 spin_unlock_irqrestore(ap->lock, flags);
432 ata_port_wait_eh(ap);
433}
434
5924b74c
TH		 435/**
436 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
5eb66fe0 437 * @ap: target port
5924b74c
TH		 438 * @sdev: SCSI device to get identify data for
439 * @arg: User buffer area for identify data
440 *
441 * LOCKING:
442 * Defined by the SCSI layer. We don't really care.
443 *
444 * RETURNS:
445 * Zero on success, negative errno on error.
446 */
94be9a58
JG		 447static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
448 void __user *arg)
5924b74c 449{
5924b74c
TH		 450 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
451 u16 __user *dst = arg;
452 char buf[40];
453
454 if (!dev)
455 return -ENOMSG;
456
457 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
458 return -EFAULT;
459
460 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
461 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
462 return -EFAULT;
463
464 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
465 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
466 return -EFAULT;
467
468 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
469 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
470 return -EFAULT;
471
472 return 0;
473}
474
b095518e
JG		 475/**
476 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
8e8b77dd 477 * @scsidev: Device to which we are issuing command
b095518e
JG		 478 * @arg: User provided data for issuing command
479 *
480 * LOCKING:
481 * Defined by the SCSI layer. We don't really care.
482 *
483 * RETURNS:
484 * Zero on success, negative errno on error.
485 */
b095518e
JG		 486int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
487{
488 int rc = 0;
489 u8 scsi_cmd[MAX_COMMAND_SIZE];
bbe1fe7e 490 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
b095518e 491 int argsize = 0;
85837ebd 492 enum dma_data_direction data_dir;
bbe1fe7e 493 int cmd_result;
b095518e 494
c893a3ae 495 if (arg == NULL)
b095518e
JG		 496 return -EINVAL;
497
498 if (copy_from_user(args, arg, sizeof(args)))
499 return -EFAULT;
500
bbe1fe7e
ET		 501 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
502 if (!sensebuf)
503 return -ENOMEM;
504
b095518e
JG		 505 memset(scsi_cmd, 0, sizeof(scsi_cmd));
506
507 if (args[3]) {
295124dc 508 argsize = ATA_SECT_SIZE * args[3];
b095518e 509 argbuf = kmalloc(argsize, GFP_KERNEL);
54dac83c
JR		 510 if (argbuf == NULL) {
511 rc = -ENOMEM;
512 goto error;
513 }
b095518e
JG		 514
515 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
516 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
2dcb407e 517 block count in sector count field */
85837ebd 518 data_dir = DMA_FROM_DEVICE;
b095518e
JG		 519 } else {
520 scsi_cmd[1] = (3 << 1); /* Non-data */
bbe1fe7e 521 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
85837ebd 522 data_dir = DMA_NONE;
b095518e
JG		 523 }
524
525 scsi_cmd[0] = ATA_16;
526
527 scsi_cmd[4] = args[2];
a4f19040 528 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
b095518e
JG		 529 scsi_cmd[6] = args[3];
530 scsi_cmd[8] = args[1];
531 scsi_cmd[10] = 0x4f;
532 scsi_cmd[12] = 0xc2;
533 } else {
534 scsi_cmd[6] = args[1];
535 }
536 scsi_cmd[14] = args[0];
537
538 /* Good values for timeout and retries? Values below
539 from scsi_ioctl_send_command() for default case... */
bbe1fe7e 540 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
f4f4e47e 541 sensebuf, (10*HZ), 5, 0, NULL);
bbe1fe7e
ET		 542
543 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
544 u8 *desc = sensebuf + 8;
545 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
546
547 /* If we set cc then ATA pass-through will cause a
548 * check condition even if no error. Filter that. */
549 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
550 struct scsi_sense_hdr sshdr;
551 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
2dcb407e 552 &sshdr);
6d3bfc7b
KM		 553 if (sshdr.sense_key == RECOVERED_ERROR &&
554 sshdr.asc == 0 && sshdr.ascq == 0x1d)
bbe1fe7e
ET		 555 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
556 }
557
558 /* Send userspace a few ATA registers (same as drivers/ide) */
2dcb407e
JG		 559 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
560 desc[0] == 0x09) { /* code is "ATA Descriptor" */
561 args[0] = desc[13]; /* status */
562 args[1] = desc[3]; /* error */
563 args[2] = desc[5]; /* sector count (0:7) */
bbe1fe7e
ET		 564 if (copy_to_user(arg, args, sizeof(args)))
565 rc = -EFAULT;
566 }
567 }
568
569
570 if (cmd_result) {
b095518e
JG		 571 rc = -EIO;
572 goto error;
573 }
574
b095518e 575 if ((argbuf)
c893a3ae 576 && copy_to_user(arg + sizeof(args), argbuf, argsize))
b095518e
JG		 577 rc = -EFAULT;
578error:
bbe1fe7e 579 kfree(sensebuf);
8f760780 580 kfree(argbuf);
b095518e
JG		 581 return rc;
582}
583
584/**
585 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
8e8b77dd 586 * @scsidev: Device to which we are issuing command
b095518e
JG		 587 * @arg: User provided data for issuing command
588 *
589 * LOCKING:
590 * Defined by the SCSI layer. We don't really care.
591 *
592 * RETURNS:
593 * Zero on success, negative errno on error.
594 */
595int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
596{
597 int rc = 0;
598 u8 scsi_cmd[MAX_COMMAND_SIZE];
af068bd1
DM		 599 u8 args[7], *sensebuf = NULL;
600 int cmd_result;
b095518e 601
c893a3ae 602 if (arg == NULL)
b095518e
JG		 603 return -EINVAL;
604
605 if (copy_from_user(args, arg, sizeof(args)))
606 return -EFAULT;
607
af068bd1
DM		 608 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
609 if (!sensebuf)
610 return -ENOMEM;
611
b095518e
JG		 612 memset(scsi_cmd, 0, sizeof(scsi_cmd));
613 scsi_cmd[0] = ATA_16;
614 scsi_cmd[1] = (3 << 1); /* Non-data */
af068bd1 615 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
b095518e
JG		 616 scsi_cmd[4] = args[1];
617 scsi_cmd[6] = args[2];
618 scsi_cmd[8] = args[3];
619 scsi_cmd[10] = args[4];
620 scsi_cmd[12] = args[5];
277239f2 621 scsi_cmd[13] = args[6] & 0x4f;
b095518e
JG		 622 scsi_cmd[14] = args[0];
623
b095518e 624 /* Good values for timeout and retries? Values below
2e9edbf8 625 from scsi_ioctl_send_command() for default case... */
af068bd1 626 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
f4f4e47e 627 sensebuf, (10*HZ), 5, 0, NULL);
af068bd1
DM		 628
629 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
630 u8 *desc = sensebuf + 8;
631 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
632
633 /* If we set cc then ATA pass-through will cause a
634 * check condition even if no error. Filter that. */
635 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
636 struct scsi_sense_hdr sshdr;
637 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
638 &sshdr);
6d3bfc7b
KM		 639 if (sshdr.sense_key == RECOVERED_ERROR &&
640 sshdr.asc == 0 && sshdr.ascq == 0x1d)
af068bd1
DM		 641 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
642 }
643
644 /* Send userspace ATA registers */
645 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
646 desc[0] == 0x09) {/* code is "ATA Descriptor" */
647 args[0] = desc[13]; /* status */
648 args[1] = desc[3]; /* error */
649 args[2] = desc[5]; /* sector count (0:7) */
650 args[3] = desc[7]; /* lbal */
651 args[4] = desc[9]; /* lbam */
652 args[5] = desc[11]; /* lbah */
653 args[6] = desc[12]; /* select */
654 if (copy_to_user(arg, args, sizeof(args)))
655 rc = -EFAULT;
656 }
657 }
658
659 if (cmd_result) {
b095518e 660 rc = -EIO;
af068bd1
DM		 661 goto error;
662 }
b095518e 663
af068bd1
DM		 664 error:
665 kfree(sensebuf);
b095518e
JG		 666 return rc;
667}
668
e3cf95dd
AC		 669static int ata_ioc32(struct ata_port *ap)
670{
671 if (ap->flags & ATA_FLAG_PIO_DMA)
672 return 1;
673 if (ap->pflags & ATA_PFLAG_PIO32)
674 return 1;
675 return 0;
676}
677
94be9a58
JG		 678int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
679 int cmd, void __user *arg)
1da177e4 680{
1da177e4 681 int val = -EINVAL, rc = -EINVAL;
e3cf95dd 682 unsigned long flags;
1da177e4 683
1da177e4
LT		 684 switch (cmd) {
685 case ATA_IOC_GET_IO32:
e3cf95dd
AC		 686 spin_lock_irqsave(ap->lock, flags);
687 val = ata_ioc32(ap);
688 spin_unlock_irqrestore(ap->lock, flags);
1da177e4
LT		 689 if (copy_to_user(arg, &val, 1))
690 return -EFAULT;
691 return 0;
692
693 case ATA_IOC_SET_IO32:
694 val = (unsigned long) arg;
e3cf95dd
AC		 695 rc = 0;
696 spin_lock_irqsave(ap->lock, flags);
697 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
698 if (val)
699 ap->pflags |= ATA_PFLAG_PIO32;
700 else
701 ap->pflags &= ~ATA_PFLAG_PIO32;
702 } else {
703 if (val != ata_ioc32(ap))
704 rc = -EINVAL;
705 }
706 spin_unlock_irqrestore(ap->lock, flags);
707 return rc;
1da177e4 708
5924b74c 709 case HDIO_GET_IDENTITY:
94be9a58 710 return ata_get_identity(ap, scsidev, arg);
5924b74c 711
b095518e
JG		 712 case HDIO_DRIVE_CMD:
713 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
714 return -EACCES;
715 return ata_cmd_ioctl(scsidev, arg);
716
717 case HDIO_DRIVE_TASK:
718 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
719 return -EACCES;
720 return ata_task_ioctl(scsidev, arg);
721
1da177e4
LT		 722 default:
723 rc = -ENOTTY;
724 break;
725 }
726
1da177e4
LT		 727 return rc;
728}
94be9a58
JG		 729EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
730
731int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
732{
733 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
734 scsidev, cmd, arg);
735}
736EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
1da177e4
LT		 737
738/**
739 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
1da177e4
LT		 740 * @dev: ATA device to which the new command is attached
741 * @cmd: SCSI command that originated this ATA command
1da177e4
LT		 742 *
743 * Obtain a reference to an unused ata_queued_cmd structure,
744 * which is the basic libata structure representing a single
745 * ATA command sent to the hardware.
746 *
747 * If a command was available, fill in the SCSI-specific
748 * portions of the structure with information on the
749 * current command.
750 *
751 * LOCKING:
cca3974e 752 * spin_lock_irqsave(host lock)
1da177e4
LT		 753 *
754 * RETURNS:
755 * Command allocated, or %NULL if none available.
756 */
7102d230 757static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
b27dcfb0 758 struct scsi_cmnd *cmd)
1da177e4
LT		 759{
760 struct ata_queued_cmd *qc;
761
12cb5ce1 762 qc = ata_qc_new_init(dev, cmd->request->tag);
1da177e4
LT		 763 if (qc) {
764 qc->scsicmd = cmd;
b27dcfb0 765 qc->scsidone = cmd->scsi_done;
1da177e4 766
ff2aeb1e 767 qc->sg = scsi_sglist(cmd);
7120165c 768 qc->n_elem = scsi_sg_count(cmd);
1da177e4
LT		 769 } else {
770 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
b27dcfb0 771 cmd->scsi_done(cmd);
1da177e4
LT		 772 }
773
774 return qc;
775}
776
aacda375
TH		 777static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
778{
779 struct scsi_cmnd *scmd = qc->scsicmd;
780
781 qc->extrabytes = scmd->request->extra_len;
782 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
783}
784
b095518e
JG		 785/**
786 * ata_dump_status - user friendly display of error info
787 * @id: id of the port in question
788 * @tf: ptr to filled out taskfile
789 *
790 * Decode and dump the ATA error/status registers for the user so
791 * that they have some idea what really happened at the non
792 * make-believe layer.
793 *
794 * LOCKING:
795 * inherited from caller
796 */
7102d230 797static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
b095518e
JG		 798{
799 u8 stat = tf->command, err = tf->feature;
800
801 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
802 if (stat & ATA_BUSY) {
803 printk("Busy }\n"); /* Data is not valid in this case */
804 } else {
1308d7f0
HR		 805 if (stat & ATA_DRDY) printk("DriveReady ");
806 if (stat & ATA_DF) printk("DeviceFault ");
807 if (stat & ATA_DSC) printk("SeekComplete ");
808 if (stat & ATA_DRQ) printk("DataRequest ");
809 if (stat & ATA_CORR) printk("CorrectedError ");
810 if (stat & ATA_SENSE) printk("Sense ");
811 if (stat & ATA_ERR) printk("Error ");
b095518e
JG		 812 printk("}\n");
813
814 if (err) {
815 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
1308d7f0
HR		 816 if (err & ATA_ABORTED) printk("DriveStatusError ");
817 if (err & ATA_ICRC) {
818 if (err & ATA_ABORTED)
819 printk("BadCRC ");
b095518e
JG		 820 else printk("Sector ");
821 }
1308d7f0
HR		 822 if (err & ATA_UNC) printk("UncorrectableError ");
823 if (err & ATA_IDNF) printk("SectorIdNotFound ");
824 if (err & ATA_TRK0NF) printk("TrackZeroNotFound ");
825 if (err & ATA_AMNF) printk("AddrMarkNotFound ");
b095518e
JG		 826 printk("}\n");
827 }
828 }
829}
830
1da177e4
LT		 831/**
832 * ata_to_sense_error - convert ATA error to SCSI error
8e8b77dd 833 * @id: ATA device number
1da177e4 834 * @drv_stat: value contained in ATA status register
b095518e
JG		 835 * @drv_err: value contained in ATA error register
836 * @sk: the sense key we'll fill out
837 * @asc: the additional sense code we'll fill out
838 * @ascq: the additional sense code qualifier we'll fill out
246619da 839 * @verbose: be verbose
1da177e4 840 *
b095518e
JG		 841 * Converts an ATA error into a SCSI error. Fill out pointers to
842 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
843 * format sense blocks.
1da177e4
LT		 844 *
845 * LOCKING:
cca3974e 846 * spin_lock_irqsave(host lock)
1da177e4 847 */
7102d230
AB		 848static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
849 u8 *asc, u8 *ascq, int verbose)
1da177e4 850{
b095518e 851 int i;
ffe75ef6 852
1da177e4 853 /* Based on the 3ware driver translation table */
98ac62de 854 static const unsigned char sense_table[][4] = {
1da177e4 855 /* BBD|ECC|ID|MAR */
8ae72044
HR		 856 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
857 // Device busy Aborted command
1da177e4 858 /* BBD|ECC|ID */
8ae72044
HR		 859 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
860 // Device busy Aborted command
1da177e4 861 /* ECC|MC|MARK */
8ae72044
HR		 862 {0x61, HARDWARE_ERROR, 0x00, 0x00},
863 // Device fault Hardware error
1da177e4 864 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
8ae72044
HR		 865 {0x84, ABORTED_COMMAND, 0x47, 0x00},
866 // Data CRC error SCSI parity error
1da177e4 867 /* MC|ID|ABRT|TRK0|MARK */
8ae72044
HR		 868 {0x37, NOT_READY, 0x04, 0x00},
869 // Unit offline Not ready
1da177e4 870 /* MCR|MARK */
8ae72044
HR		 871 {0x09, NOT_READY, 0x04, 0x00},
872 // Unrecovered disk error Not ready
1da177e4 873 /* Bad address mark */
8ae72044
HR		 874 {0x01, MEDIUM_ERROR, 0x13, 0x00},
875 // Address mark not found for data field
876 /* TRK0 - Track 0 not found */
877 {0x02, HARDWARE_ERROR, 0x00, 0x00},
878 // Hardware error
78062c50 879 /* Abort: 0x04 is not translated here, see below */
1da177e4 880 /* Media change request */
8ae72044
HR		 881 {0x08, NOT_READY, 0x04, 0x00},
882 // FIXME: faking offline
883 /* SRV/IDNF - ID not found */
884 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
885 // Logical address out of range
886 /* MC - Media Changed */
887 {0x20, UNIT_ATTENTION, 0x28, 0x00},
888 // Not ready to ready change, medium may have changed
889 /* ECC - Uncorrectable ECC error */
890 {0x40, MEDIUM_ERROR, 0x11, 0x04},
891 // Unrecovered read error
1da177e4 892 /* BBD - block marked bad */
8ae72044
HR		 893 {0x80, MEDIUM_ERROR, 0x11, 0x04},
894 // Block marked bad Medium error, unrecovered read error
1da177e4
LT		 895 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
896 };
98ac62de 897 static const unsigned char stat_table[][4] = {
1da177e4 898 /* Must be first because BUSY means no other bits valid */
8ae72044
HR		 899 {0x80, ABORTED_COMMAND, 0x47, 0x00},
900 // Busy, fake parity for now
901 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
902 // Device ready, unaligned write command
903 {0x20, HARDWARE_ERROR, 0x44, 0x00},
904 // Device fault, internal target failure
905 {0x08, ABORTED_COMMAND, 0x47, 0x00},
906 // Timed out in xfer, fake parity for now
907 {0x04, RECOVERED_ERROR, 0x11, 0x00},
908 // Recovered ECC error Medium error, recovered
1da177e4
LT		 909 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
910 };
1da177e4 911
1da177e4
LT		 912 /*
913 * Is this an error we can process/parse
914 */
b095518e
JG		 915 if (drv_stat & ATA_BUSY) {
916 drv_err = 0; /* Ignore the err bits, they're invalid */
1da177e4 917 }
b095518e
JG		 918
919 if (drv_err) {
920 /* Look for drv_err */
921 for (i = 0; sense_table[i][0] != 0xFF; i++) {
922 /* Look for best matches first */
2e9edbf8 923 if ((sense_table[i][0] & drv_err) ==
b095518e
JG		 924 sense_table[i][0]) {
925 *sk = sense_table[i][1];
926 *asc = sense_table[i][2];
927 *ascq = sense_table[i][3];
928 goto translate_done;
929 }
930 }
1da177e4 931 }
b095518e 932
78062c50
GG		 933 /*
934 * Fall back to interpreting status bits. Note that if the drv_err
935 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
936 * is not descriptive enough.
937 */
b095518e
JG		 938 for (i = 0; stat_table[i][0] != 0xFF; i++) {
939 if (stat_table[i][0] & drv_stat) {
940 *sk = stat_table[i][1];
941 *asc = stat_table[i][2];
942 *ascq = stat_table[i][3];
943 goto translate_done;
1da177e4 944 }
b095518e 945 }
b095518e 946
78062c50
GG		 947 /*
948 * We need a sensible error return here, which is tricky, and one
949 * that won't cause people to do things like return a disk wrongly.
950 */
2d202024
AC		 951 *sk = ABORTED_COMMAND;
952 *asc = 0x00;
953 *ascq = 0x00;
b095518e
JG		 954
955 translate_done:
246619da
TH		 956 if (verbose)
957 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
958 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
959 id, drv_stat, drv_err, *sk, *asc, *ascq);
b095518e
JG		 960 return;
961}
962
963/*
750426aa 964 * ata_gen_passthru_sense - Generate check condition sense block.
b095518e
JG		 965 * @qc: Command that completed.
966 *
967 * This function is specific to the ATA descriptor format sense
968 * block specified for the ATA pass through commands. Regardless
969 * of whether the command errored or not, return a sense
970 * block. Copy all controller registers into the sense
84a9a8cd
GG		 971 * block. If there was no error, we get the request from an ATA
972 * passthrough command, so we use the following sense data:
973 * sk = RECOVERED ERROR
974 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
975 *
b095518e
JG		 976 *
977 * LOCKING:
750426aa 978 * None.
b095518e 979 */
750426aa 980static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
b095518e
JG		 981{
982 struct scsi_cmnd *cmd = qc->scsicmd;
e61e0672 983 struct ata_taskfile *tf = &qc->result_tf;
b095518e
JG		 984 unsigned char *sb = cmd->sense_buffer;
985 unsigned char *desc = sb + 8;
246619da 986 int verbose = qc->ap->ops->error_handler == NULL;
b095518e
JG		 987
988 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
989
0e5dec47 990 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
b095518e 991
b095518e
JG		 992 /*
993 * Use ata_to_sense_error() to map status register bits
994 * onto sense key, asc & ascq.
995 */
058e55e1
TH		 996 if (qc->err_mask ||
997 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
44877b4e 998 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
246619da 999 &sb[1], &sb[2], &sb[3], verbose);
b095518e 1000 sb[1] &= 0x0f;
84a9a8cd
GG		 1001 } else {
1002 sb[1] = RECOVERED_ERROR;
1003 sb[2] = 0;
1004 sb[3] = 0x1D;
1da177e4
LT		 1005 }
1006
b095518e
JG		 1007 /*
1008 * Sense data is current and format is descriptor.
1009 */
1010 sb[0] = 0x72;
1da177e4 1011
b095518e
JG		 1012 desc[0] = 0x09;
1013
f38621b3
TH		 1014 /* set length of additional sense data */
1015 sb[7] = 14;
1016 desc[1] = 12;
b095518e
JG		 1017
1018 /*
1019 * Copy registers into sense buffer.
1020 */
1021 desc[2] = 0x00;
1022 desc[3] = tf->feature; /* == error reg */
1023 desc[5] = tf->nsect;
1024 desc[7] = tf->lbal;
1025 desc[9] = tf->lbam;
1026 desc[11] = tf->lbah;
1027 desc[12] = tf->device;
1028 desc[13] = tf->command; /* == status reg */
1029
1030 /*
1031 * Fill in Extend bit, and the high order bytes
1032 * if applicable.
1033 */
1034 if (tf->flags & ATA_TFLAG_LBA48) {
1035 desc[2] |= 0x01;
1036 desc[4] = tf->hob_nsect;
1037 desc[6] = tf->hob_lbal;
1038 desc[8] = tf->hob_lbam;
1039 desc[10] = tf->hob_lbah;
1da177e4 1040 }
b095518e 1041}
1da177e4 1042
b095518e 1043/**
750426aa 1044 * ata_gen_ata_sense - generate a SCSI fixed sense block
b095518e
JG		 1045 * @qc: Command that we are erroring out
1046 *
d25614ba 1047 * Generate sense block for a failed ATA command @qc. Descriptor
25985edc 1048 * format is used to accommodate LBA48 block address.
b095518e
JG		 1049 *
1050 * LOCKING:
750426aa 1051 * None.
b095518e 1052 */
750426aa 1053static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
b095518e 1054{
d25614ba 1055 struct ata_device *dev = qc->dev;
b095518e 1056 struct scsi_cmnd *cmd = qc->scsicmd;
e61e0672 1057 struct ata_taskfile *tf = &qc->result_tf;
b095518e 1058 unsigned char *sb = cmd->sense_buffer;
d25614ba 1059 unsigned char *desc = sb + 8;
246619da 1060 int verbose = qc->ap->ops->error_handler == NULL;
d25614ba 1061 u64 block;
b095518e
JG		 1062
1063 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1064
0e5dec47 1065 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
b095518e 1066
d25614ba
TH		 1067 /* sense data is current and format is descriptor */
1068 sb[0] = 0x72;
1069
1070 /* Use ata_to_sense_error() to map status register bits
b095518e
JG		 1071 * onto sense key, asc & ascq.
1072 */
058e55e1
TH		 1073 if (qc->err_mask ||
1074 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
44877b4e 1075 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
d25614ba
TH		 1076 &sb[1], &sb[2], &sb[3], verbose);
1077 sb[1] &= 0x0f;
1da177e4 1078 }
1da177e4 1079
d25614ba 1080 block = ata_tf_read_block(&qc->result_tf, dev);
a7dac447 1081
d25614ba
TH		 1082 /* information sense data descriptor */
1083 sb[7] = 12;
1084 desc[0] = 0x00;
1085 desc[1] = 10;
a7dac447 1086
d25614ba
TH		 1087 desc[2] |= 0x80; /* valid */
1088 desc[6] = block >> 40;
1089 desc[7] = block >> 32;
1090 desc[8] = block >> 24;
1091 desc[9] = block >> 16;
1092 desc[10] = block >> 8;
1093 desc[11] = block;
1da177e4
LT		 1094}
1095
a6cce2a7
BK		 1096static void ata_scsi_sdev_config(struct scsi_device *sdev)
1097{
1098 sdev->use_10_for_rw = 1;
1099 sdev->use_10_for_ms = 1;
3c6bdaea 1100 sdev->no_report_opcodes = 1;
5db44863 1101 sdev->no_write_same = 1;
31cc23b3
TH		 1102
1103 /* Schedule policy is determined by ->qc_defer() callback and
1104 * it needs to see every deferred qc. Set dev_blocked to 1 to
1105 * prevent SCSI midlayer from automatically deferring
1106 * requests.
1107 */
1108 sdev->max_device_blocked = 1;
a6cce2a7
BK		 1109}
1110
fa2fc7f4
JB		 1111/**
1112 * atapi_drain_needed - Check whether data transfer may overflow
73fd8b6d 1113 * @rq: request to be checked
fa2fc7f4
JB		 1114 *
1115 * ATAPI commands which transfer variable length data to host
1116 * might overflow due to application error or hardare bug. This
1117 * function checks whether overflow should be drained and ignored
1118 * for @request.
1119 *
1120 * LOCKING:
1121 * None.
1122 *
1123 * RETURNS:
1124 * 1 if ; otherwise, 0.
1125 */
1126static int atapi_drain_needed(struct request *rq)
1127{
33659ebb 1128 if (likely(rq->cmd_type != REQ_TYPE_BLOCK_PC))
fa2fc7f4
JB		 1129 return 0;
1130
7b6d91da 1131 if (!blk_rq_bytes(rq) || (rq->cmd_flags & REQ_WRITE))
fa2fc7f4
JB		 1132 return 0;
1133
1134 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1135}
1136
1137static int ata_scsi_dev_config(struct scsi_device *sdev,
1138 struct ata_device *dev)
a6cce2a7 1139{
900e599e 1140 struct request_queue *q = sdev->request_queue;
1141
45fabbb7
EO		 1142 if (!ata_id_has_unload(dev->id))
1143 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1144
914ed354 1145 /* configure max sectors */
900e599e 1146 blk_queue_max_hw_sectors(q, dev->max_sectors);
a6cce2a7 1147
fa2fc7f4 1148 if (dev->class == ATA_DEV_ATAPI) {
fa2fc7f4
JB		 1149 void *buf;
1150
729a6a30
TH		 1151 sdev->sector_size = ATA_SECT_SIZE;
1152
1153 /* set DMA padding */
900e599e 1154 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
fa2fc7f4
JB		 1155
1156 /* configure draining */
1157 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1158 if (!buf) {
a9a79dfe 1159 ata_dev_err(dev, "drain buffer allocation failed\n");
fa2fc7f4
JB		 1160 return -ENOMEM;
1161 }
1162
1163 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1164 } else {
295124dc 1165 sdev->sector_size = ata_id_logical_sector_size(dev->id);
d8cf5389 1166 sdev->manage_start_stop = 1;
dde20207 1167 }
d8cf5389 1168
729a6a30
TH		 1169 /*
1170 * ata_pio_sectors() expects buffer for each sector to not cross
1171 * page boundary. Enforce it by requiring buffers to be sector
1172 * aligned, which works iff sector_size is not larger than
1173 * PAGE_SIZE. ATAPI devices also need the alignment as
1174 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1175 */
1176 if (sdev->sector_size > PAGE_SIZE)
a9a79dfe 1177 ata_dev_warn(dev,
729a6a30
TH		 1178 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1179 sdev->sector_size);
1180
900e599e 1181 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
729a6a30 1182
f26792d5
JG		 1183 if (dev->flags & ATA_DFLAG_AN)
1184 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1185
a6e6ce8e
TH		 1186 if (dev->flags & ATA_DFLAG_NCQ) {
1187 int depth;
1188
1189 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1190 depth = min(ATA_MAX_QUEUE - 1, depth);
db5ed4df 1191 scsi_change_queue_depth(sdev, depth);
a6e6ce8e 1192 }
fa2fc7f4 1193
900e599e 1194 blk_queue_flush_queueable(q, false);
1195
295124dc 1196 dev->sdev = sdev;
fa2fc7f4 1197 return 0;
a6cce2a7
BK		 1198}
1199
1da177e4
LT		 1200/**
1201 * ata_scsi_slave_config - Set SCSI device attributes
1202 * @sdev: SCSI device to examine
1203 *
1204 * This is called before we actually start reading
1205 * and writing to the device, to configure certain
1206 * SCSI mid-layer behaviors.
1207 *
1208 * LOCKING:
1209 * Defined by SCSI layer. We don't really care.
1210 */
1211
1212int ata_scsi_slave_config(struct scsi_device *sdev)
1213{
31534363
TH		 1214 struct ata_port *ap = ata_shost_to_port(sdev->host);
1215 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
fa2fc7f4 1216 int rc = 0;
31534363 1217
a6cce2a7 1218 ata_scsi_sdev_config(sdev);
1da177e4 1219
31534363 1220 if (dev)
fa2fc7f4 1221 rc = ata_scsi_dev_config(sdev, dev);
1da177e4 1222
fa2fc7f4 1223 return rc;
1da177e4
LT		 1224}
1225
83c47bcb
TH		 1226/**
1227 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1228 * @sdev: SCSI device to be destroyed
1229 *
1230 * @sdev is about to be destroyed for hot/warm unplugging. If
1231 * this unplugging was initiated by libata as indicated by NULL
1232 * dev->sdev, this function doesn't have to do anything.
1233 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1234 * Clear dev->sdev, schedule the device for ATA detach and invoke
1235 * EH.
1236 *
1237 * LOCKING:
1238 * Defined by SCSI layer. We don't really care.
1239 */
1240void ata_scsi_slave_destroy(struct scsi_device *sdev)
1241{
1242 struct ata_port *ap = ata_shost_to_port(sdev->host);
fa2fc7f4 1243 struct request_queue *q = sdev->request_queue;
83c47bcb
TH		 1244 unsigned long flags;
1245 struct ata_device *dev;
1246
1247 if (!ap->ops->error_handler)
1248 return;
1249
ba6a1308 1250 spin_lock_irqsave(ap->lock, flags);
83c47bcb
TH		 1251 dev = __ata_scsi_find_dev(ap, sdev);
1252 if (dev && dev->sdev) {
1253 /* SCSI device already in CANCEL state, no need to offline it */
1254 dev->sdev = NULL;
1255 dev->flags |= ATA_DFLAG_DETACH;
1256 ata_port_schedule_eh(ap);
1257 }
ba6a1308 1258 spin_unlock_irqrestore(ap->lock, flags);
fa2fc7f4
JB		 1259
1260 kfree(q->dma_drain_buffer);
1261 q->dma_drain_buffer = NULL;
1262 q->dma_drain_size = 0;
83c47bcb
TH		 1263}
1264
a6e6ce8e 1265/**
f6e67035 1266 * __ata_change_queue_depth - helper for ata_scsi_change_queue_depth
6d2dd054
MPS		 1267 * @ap: ATA port to which the device change the queue depth
1268 * @sdev: SCSI device to configure queue depth for
1269 * @queue_depth: new queue depth
a6e6ce8e 1270 *
f6e67035
DW		 1271 * libsas and libata have different approaches for associating a sdev to
1272 * its ata_port.
a6e6ce8e 1273 *
a6e6ce8e 1274 */
f6e67035 1275int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
db5ed4df 1276 int queue_depth)
a6e6ce8e 1277{
a6e6ce8e 1278 struct ata_device *dev;
360f654e 1279 unsigned long flags;
a6e6ce8e 1280
c3c70c44 1281 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
a6e6ce8e
TH		 1282 return sdev->queue_depth;
1283
1284 dev = ata_scsi_find_dev(ap, sdev);
1285 if (!dev || !ata_dev_enabled(dev))
1286 return sdev->queue_depth;
1287
c3c70c44 1288 /* NCQ enabled? */
360f654e 1289 spin_lock_irqsave(ap->lock, flags);
c3c70c44
TH		 1290 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1291 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
360f654e 1292 dev->flags |= ATA_DFLAG_NCQ_OFF;
c3c70c44
TH		 1293 queue_depth = 1;
1294 }
360f654e
TH		 1295 spin_unlock_irqrestore(ap->lock, flags);
1296
c3c70c44
TH		 1297 /* limit and apply queue depth */
1298 queue_depth = min(queue_depth, sdev->host->can_queue);
1299 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1300 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1301
1302 if (sdev->queue_depth == queue_depth)
1303 return -EINVAL;
1304
db5ed4df 1305 return scsi_change_queue_depth(sdev, queue_depth);
a6e6ce8e
TH		 1306}
1307
f6e67035
DW		 1308/**
1309 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1310 * @sdev: SCSI device to configure queue depth for
1311 * @queue_depth: new queue depth
f6e67035
DW		 1312 *
1313 * This is libata standard hostt->change_queue_depth callback.
1314 * SCSI will call into this callback when user tries to set queue
1315 * depth via sysfs.
1316 *
1317 * LOCKING:
1318 * SCSI layer (we don't care)
1319 *
1320 * RETURNS:
1321 * Newly configured queue depth.
1322 */
db5ed4df 1323int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
f6e67035
DW		 1324{
1325 struct ata_port *ap = ata_shost_to_port(sdev->host);
1326
db5ed4df 1327 return __ata_change_queue_depth(ap, sdev, queue_depth);
f6e67035
DW		 1328}
1329
972dcafb
DG		 1330/**
1331 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1332 * @qc: Storage for translated ATA taskfile
972dcafb
DG		 1333 *
1334 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1335 * (to start). Perhaps these commands should be preceded by
1336 * CHECK POWER MODE to see what power mode the device is already in.
1337 * [See SAT revision 5 at www.t10.org]
1338 *
1339 * LOCKING:
cca3974e 1340 * spin_lock_irqsave(host lock)
972dcafb
DG		 1341 *
1342 * RETURNS:
1343 * Zero on success, non-zero on error.
1344 */
ad706991 1345static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
972dcafb 1346{
542b1444 1347 struct scsi_cmnd *scmd = qc->scsicmd;
972dcafb 1348 struct ata_taskfile *tf = &qc->tf;
ad706991 1349 const u8 *cdb = scmd->cmnd;
972dcafb 1350
2e5704f6
TH		 1351 if (scmd->cmd_len < 5)
1352 goto invalid_fld;
1353
972dcafb
DG		 1354 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1355 tf->protocol = ATA_PROT_NODATA;
542b1444 1356 if (cdb[1] & 0x1) {
972dcafb
DG		 1357 ; /* ignore IMMED bit, violates sat-r05 */
1358 }
542b1444 1359 if (cdb[4] & 0x2)
ae006510 1360 goto invalid_fld; /* LOEJ bit set not supported */
542b1444 1361 if (((cdb[4] >> 4) & 0xf) != 0)
ae006510 1362 goto invalid_fld; /* power conditions not supported */
e31e8531 1363
542b1444 1364 if (cdb[4] & 0x1) {
972dcafb 1365 tf->nsect = 1; /* 1 sector, lba=0 */
9d5b1302
AL		 1366
1367 if (qc->dev->flags & ATA_DFLAG_LBA) {
c44078c0 1368 tf->flags |= ATA_TFLAG_LBA;
9d5b1302
AL		 1369
1370 tf->lbah = 0x0;
1371 tf->lbam = 0x0;
1372 tf->lbal = 0x0;
1373 tf->device |= ATA_LBA;
1374 } else {
1375 /* CHS */
1376 tf->lbal = 0x1; /* sect */
1377 tf->lbam = 0x0; /* cyl low */
1378 tf->lbah = 0x0; /* cyl high */
1379 }
1380
972dcafb 1381 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
920a4b10 1382 } else {
2a6e58d2
RW		 1383 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1384 * or S5) causing some drives to spin up and down again.
1385 */
1386 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1387 system_state == SYSTEM_POWER_OFF)
1388 goto skip;
1389
1390 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1391 system_entering_hibernation())
1392 goto skip;
1393
78981a7c
RH		 1394 /* Issue ATA STANDBY IMMEDIATE command */
1395 tf->command = ATA_CMD_STANDBYNOW1;
920a4b10 1396 }
78981a7c 1397
972dcafb
DG		 1398 /*
1399 * Standby and Idle condition timers could be implemented but that
1400 * would require libata to implement the Power condition mode page
1401 * and allow the user to change it. Changing mode pages requires
1402 * MODE SELECT to be implemented.
1403 */
1404
1405 return 0;
ae006510 1406
2a6e58d2 1407 invalid_fld:
542b1444 1408 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
ae006510
DG		 1409 /* "Invalid field in cbd" */
1410 return 1;
2a6e58d2
RW		 1411 skip:
1412 scmd->result = SAM_STAT_GOOD;
1413 return 1;
972dcafb
DG		 1414}
1415
1416
1da177e4
LT		 1417/**
1418 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1419 * @qc: Storage for translated ATA taskfile
1da177e4
LT		 1420 *
1421 * Sets up an ATA taskfile to issue FLUSH CACHE or
1422 * FLUSH CACHE EXT.
1423 *
1424 * LOCKING:
cca3974e 1425 * spin_lock_irqsave(host lock)
1da177e4
LT		 1426 *
1427 * RETURNS:
1428 * Zero on success, non-zero on error.
1429 */
ad706991 1430static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1da177e4
LT		 1431{
1432 struct ata_taskfile *tf = &qc->tf;
1433
1434 tf->flags |= ATA_TFLAG_DEVICE;
1435 tf->protocol = ATA_PROT_NODATA;
1436
6fc49adb 1437 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1da177e4
LT		 1438 tf->command = ATA_CMD_FLUSH_EXT;
1439 else
1440 tf->command = ATA_CMD_FLUSH;
1441
b666da35
TH		 1442 /* flush is critical for IO integrity, consider it an IO command */
1443 qc->flags |= ATA_QCFLAG_IO;
1444
1da177e4
LT		 1445 return 0;
1446}
1447
3aef5231
AL		 1448/**
1449 * scsi_6_lba_len - Get LBA and transfer length
542b1444 1450 * @cdb: SCSI command to translate
3aef5231
AL		 1451 *
1452 * Calculate LBA and transfer length for 6-byte commands.
1453 *
1454 * RETURNS:
1455 * @plba: the LBA
1456 * @plen: the transfer length
1457 */
542b1444 1458static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
3aef5231
AL		 1459{
1460 u64 lba = 0;
6c7b7d2b 1461 u32 len;
3aef5231
AL		 1462
1463 VPRINTK("six-byte command\n");
1464
6c7b7d2b 1465 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
542b1444
TH		 1466 lba |= ((u64)cdb[2]) << 8;
1467 lba |= ((u64)cdb[3]);
3aef5231 1468
6c7b7d2b 1469 len = cdb[4];
3aef5231
AL		 1470
1471 *plba = lba;
1472 *plen = len;
1473}
1474
1475/**
1476 * scsi_10_lba_len - Get LBA and transfer length
542b1444 1477 * @cdb: SCSI command to translate
3aef5231
AL		 1478 *
1479 * Calculate LBA and transfer length for 10-byte commands.
1480 *
1481 * RETURNS:
1482 * @plba: the LBA
1483 * @plen: the transfer length
1484 */
542b1444 1485static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
3aef5231
AL		 1486{
1487 u64 lba = 0;
1488 u32 len = 0;
1489
1490 VPRINTK("ten-byte command\n");
1491
542b1444
TH		 1492 lba |= ((u64)cdb[2]) << 24;
1493 lba |= ((u64)cdb[3]) << 16;
1494 lba |= ((u64)cdb[4]) << 8;
1495 lba |= ((u64)cdb[5]);
3aef5231 1496
542b1444
TH		 1497 len |= ((u32)cdb[7]) << 8;
1498 len |= ((u32)cdb[8]);
3aef5231
AL		 1499
1500 *plba = lba;
1501 *plen = len;
1502}
1503
1504/**
1505 * scsi_16_lba_len - Get LBA and transfer length
542b1444 1506 * @cdb: SCSI command to translate
3aef5231
AL		 1507 *
1508 * Calculate LBA and transfer length for 16-byte commands.
1509 *
1510 * RETURNS:
1511 * @plba: the LBA
1512 * @plen: the transfer length
1513 */
542b1444 1514static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
3aef5231
AL		 1515{
1516 u64 lba = 0;
1517 u32 len = 0;
1518
1519 VPRINTK("sixteen-byte command\n");
1520
542b1444
TH		 1521 lba |= ((u64)cdb[2]) << 56;
1522 lba |= ((u64)cdb[3]) << 48;
1523 lba |= ((u64)cdb[4]) << 40;
1524 lba |= ((u64)cdb[5]) << 32;
1525 lba |= ((u64)cdb[6]) << 24;
1526 lba |= ((u64)cdb[7]) << 16;
1527 lba |= ((u64)cdb[8]) << 8;
1528 lba |= ((u64)cdb[9]);
3aef5231 1529
542b1444
TH		 1530 len |= ((u32)cdb[10]) << 24;
1531 len |= ((u32)cdb[11]) << 16;
1532 len |= ((u32)cdb[12]) << 8;
1533 len |= ((u32)cdb[13]);
3aef5231
AL		 1534
1535 *plba = lba;
1536 *plen = len;
1537}
1538
1da177e4
LT		 1539/**
1540 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1541 * @qc: Storage for translated ATA taskfile
1da177e4
LT		 1542 *
1543 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1544 *
1545 * LOCKING:
cca3974e 1546 * spin_lock_irqsave(host lock)
1da177e4
LT		 1547 *
1548 * RETURNS:
1549 * Zero on success, non-zero on error.
1550 */
ad706991 1551static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1da177e4 1552{
542b1444 1553 struct scsi_cmnd *scmd = qc->scsicmd;
1da177e4 1554 struct ata_taskfile *tf = &qc->tf;
8bf62ece 1555 struct ata_device *dev = qc->dev;
1da177e4 1556 u64 dev_sectors = qc->dev->n_sectors;
ad706991 1557 const u8 *cdb = scmd->cmnd;
3aef5231
AL		 1558 u64 block;
1559 u32 n_block;
1da177e4
LT		 1560
1561 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1562 tf->protocol = ATA_PROT_NODATA;
1da177e4 1563
2e5704f6
TH		 1564 if (cdb[0] == VERIFY) {
1565 if (scmd->cmd_len < 10)
1566 goto invalid_fld;
542b1444 1567 scsi_10_lba_len(cdb, &block, &n_block);
2e5704f6
TH		 1568 } else if (cdb[0] == VERIFY_16) {
1569 if (scmd->cmd_len < 16)
1570 goto invalid_fld;
542b1444 1571 scsi_16_lba_len(cdb, &block, &n_block);
2e5704f6 1572 } else
ae006510 1573 goto invalid_fld;
1da177e4 1574
8bf62ece 1575 if (!n_block)
ae006510 1576 goto nothing_to_do;
8bf62ece 1577 if (block >= dev_sectors)
ae006510 1578 goto out_of_range;
8bf62ece 1579 if ((block + n_block) > dev_sectors)
ae006510 1580 goto out_of_range;
1da177e4 1581
07506697
AL		 1582 if (dev->flags & ATA_DFLAG_LBA) {
1583 tf->flags |= ATA_TFLAG_LBA;
1584
c6a33e24
AL		 1585 if (lba_28_ok(block, n_block)) {
1586 /* use LBA28 */
1587 tf->command = ATA_CMD_VERIFY;
1588 tf->device |= (block >> 24) & 0xf;
1589 } else if (lba_48_ok(block, n_block)) {
1590 if (!(dev->flags & ATA_DFLAG_LBA48))
1591 goto out_of_range;
07506697
AL		 1592
1593 /* use LBA48 */
1594 tf->flags |= ATA_TFLAG_LBA48;
8bf62ece 1595 tf->command = ATA_CMD_VERIFY_EXT;
1da177e4 1596
8bf62ece 1597 tf->hob_nsect = (n_block >> 8) & 0xff;
1da177e4 1598
8bf62ece
AL		 1599 tf->hob_lbah = (block >> 40) & 0xff;
1600 tf->hob_lbam = (block >> 32) & 0xff;
1601 tf->hob_lbal = (block >> 24) & 0xff;
c6a33e24
AL		 1602 } else
1603 /* request too large even for LBA48 */
1604 goto out_of_range;
8bf62ece
AL		 1605
1606 tf->nsect = n_block & 0xff;
1da177e4 1607
8bf62ece
AL		 1608 tf->lbah = (block >> 16) & 0xff;
1609 tf->lbam = (block >> 8) & 0xff;
1610 tf->lbal = block & 0xff;
1da177e4 1611
8bf62ece
AL		 1612 tf->device |= ATA_LBA;
1613 } else {
1614 /* CHS */
1615 u32 sect, head, cyl, track;
1616
c6a33e24
AL		 1617 if (!lba_28_ok(block, n_block))
1618 goto out_of_range;
07506697 1619
8bf62ece
AL		 1620 /* Convert LBA to CHS */
1621 track = (u32)block / dev->sectors;
1622 cyl = track / dev->heads;
1623 head = track % dev->heads;
1624 sect = (u32)block % dev->sectors + 1;
1625
c187c4b5
AL		 1626 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1627 (u32)block, track, cyl, head, sect);
2e9edbf8
JG		 1628
1629 /* Check whether the converted CHS can fit.
1630 Cylinder: 0-65535
8bf62ece
AL		 1631 Head: 0-15
1632 Sector: 1-255*/
2e9edbf8 1633 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
ae006510 1634 goto out_of_range;
2e9edbf8 1635
8bf62ece
AL		 1636 tf->command = ATA_CMD_VERIFY;
1637 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1638 tf->lbal = sect;
1639 tf->lbam = cyl;
1640 tf->lbah = cyl >> 8;
1641 tf->device |= head;
1642 }
1da177e4
LT		 1643
1644 return 0;
ae006510
DG		 1645
1646invalid_fld:
542b1444 1647 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
ae006510
DG		 1648 /* "Invalid field in cbd" */
1649 return 1;
1650
1651out_of_range:
542b1444 1652 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
ae006510
DG		 1653 /* "Logical Block Address out of range" */
1654 return 1;
1655
1656nothing_to_do:
542b1444 1657 scmd->result = SAM_STAT_GOOD;
ae006510 1658 return 1;
1da177e4
LT		 1659}
1660
1661/**
1662 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1663 * @qc: Storage for translated ATA taskfile
1da177e4
LT		 1664 *
1665 * Converts any of six SCSI read/write commands into the
1666 * ATA counterpart, including starting sector (LBA),
1667 * sector count, and taking into account the device's LBA48
1668 * support.
1669 *
1670 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1671 * %WRITE_16 are currently supported.
1672 *
1673 * LOCKING:
cca3974e 1674 * spin_lock_irqsave(host lock)
1da177e4
LT		 1675 *
1676 * RETURNS:
1677 * Zero on success, non-zero on error.
1678 */
ad706991 1679static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1da177e4 1680{
542b1444 1681 struct scsi_cmnd *scmd = qc->scsicmd;
ad706991 1682 const u8 *cdb = scmd->cmnd;
bd056d7e 1683 unsigned int tf_flags = 0;
3aef5231
AL		 1684 u64 block;
1685 u32 n_block;
bd056d7e 1686 int rc;
1da177e4 1687
542b1444 1688 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
bd056d7e 1689 tf_flags |= ATA_TFLAG_WRITE;
1da177e4 1690
9a3dccc4 1691 /* Calculate the SCSI LBA, transfer length and FUA. */
542b1444 1692 switch (cdb[0]) {
3aef5231
AL		 1693 case READ_10:
1694 case WRITE_10:
2e5704f6
TH		 1695 if (unlikely(scmd->cmd_len < 10))
1696 goto invalid_fld;
542b1444 1697 scsi_10_lba_len(cdb, &block, &n_block);
3e451a49 1698 if (cdb[1] & (1 << 3))
bd056d7e 1699 tf_flags |= ATA_TFLAG_FUA;
3aef5231
AL		 1700 break;
1701 case READ_6:
1702 case WRITE_6:
2e5704f6
TH		 1703 if (unlikely(scmd->cmd_len < 6))
1704 goto invalid_fld;
542b1444 1705 scsi_6_lba_len(cdb, &block, &n_block);
c187c4b5
AL		 1706
1707 /* for 6-byte r/w commands, transfer length 0
1708 * means 256 blocks of data, not 0 block.
1709 */
76b2bf9b
JG		 1710 if (!n_block)
1711 n_block = 256;
3aef5231
AL		 1712 break;
1713 case READ_16:
1714 case WRITE_16:
2e5704f6
TH		 1715 if (unlikely(scmd->cmd_len < 16))
1716 goto invalid_fld;
542b1444 1717 scsi_16_lba_len(cdb, &block, &n_block);
3e451a49 1718 if (cdb[1] & (1 << 3))
bd056d7e 1719 tf_flags |= ATA_TFLAG_FUA;
3aef5231
AL		 1720 break;
1721 default:
8bf62ece 1722 DPRINTK("no-byte command\n");
ae006510 1723 goto invalid_fld;
1da177e4
LT		 1724 }
1725
8bf62ece
AL		 1726 /* Check and compose ATA command */
1727 if (!n_block)
c187c4b5
AL		 1728 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1729 * length 0 means transfer 0 block of data.
1730 * However, for ATA R/W commands, sector count 0 means
1731 * 256 or 65536 sectors, not 0 sectors as in SCSI.
f51750d5
AC		 1732 *
1733 * WARNING: one or two older ATA drives treat 0 as 0...
c187c4b5 1734 */
ae006510 1735 goto nothing_to_do;
1da177e4 1736
bd056d7e 1737 qc->flags |= ATA_QCFLAG_IO;
295124dc 1738 qc->nbytes = n_block * scmd->device->sector_size;
1da177e4 1739
bd056d7e
TH		 1740 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1741 qc->tag);
1742 if (likely(rc == 0))
1743 return 0;
ae006510 1744
bd056d7e
TH		 1745 if (rc == -ERANGE)
1746 goto out_of_range;
1747 /* treat all other errors as -EINVAL, fall through */
ae006510 1748invalid_fld:
542b1444 1749 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
ae006510
DG		 1750 /* "Invalid field in cbd" */
1751 return 1;
1752
1753out_of_range:
542b1444 1754 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
ae006510
DG		 1755 /* "Logical Block Address out of range" */
1756 return 1;
1757
1758nothing_to_do:
542b1444 1759 scmd->result = SAM_STAT_GOOD;
ae006510 1760 return 1;
1da177e4
LT		 1761}
1762
77853bf2 1763static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1da177e4 1764{
c31f571d 1765 struct ata_port *ap = qc->ap;
1da177e4 1766 struct scsi_cmnd *cmd = qc->scsicmd;
a7dac447 1767 u8 *cdb = cmd->cmnd;
2dcb407e 1768 int need_sense = (qc->err_mask != 0);
b095518e
JG		 1769
1770 /* For ATA pass thru (SAT) commands, generate a sense block if
1771 * user mandated it or if there's an error. Note that if we
84a9a8cd
GG		 1772 * generate because the user forced us to [CK_COND =1], a check
1773 * condition is generated and the ATA register values are returned
b095518e 1774 * whether the command completed successfully or not. If there
84a9a8cd
GG		 1775 * was no error, we use the following sense data:
1776 * sk = RECOVERED ERROR
1777 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
b095518e 1778 */
a7dac447 1779 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
2dcb407e 1780 ((cdb[2] & 0x20) || need_sense)) {
750426aa 1781 ata_gen_passthru_sense(qc);
b095518e 1782 } else {
42b966fb
HR		 1783 if (qc->flags & ATA_QCFLAG_SENSE_VALID) {
1784 cmd->result = SAM_STAT_CHECK_CONDITION;
1785 } else if (!need_sense) {
b095518e
JG		 1786 cmd->result = SAM_STAT_GOOD;
1787 } else {
1788 /* TODO: decide which descriptor format to use
1789 * for 48b LBA devices and call that here
1790 * instead of the fixed desc, which is only
1791 * good for smaller LBA (and maybe CHS?)
1792 * devices.
1793 */
750426aa 1794 ata_gen_ata_sense(qc);
b095518e
JG		 1795 }
1796 }
1da177e4 1797
c31f571d 1798 if (need_sense && !ap->ops->error_handler)
44877b4e 1799 ata_dump_status(ap->print_id, &qc->result_tf);
1da177e4
LT		 1800
1801 qc->scsidone(cmd);
1802
77853bf2 1803 ata_qc_free(qc);
1da177e4
LT		 1804}
1805
1806/**
1807 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1da177e4
LT		 1808 * @dev: ATA device to which the command is addressed
1809 * @cmd: SCSI command to execute
1da177e4
LT		 1810 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1811 *
1812 * Our ->queuecommand() function has decided that the SCSI
1813 * command issued can be directly translated into an ATA
1814 * command, rather than handled internally.
1815 *
1816 * This function sets up an ata_queued_cmd structure for the
1817 * SCSI command, and sends that ata_queued_cmd to the hardware.
1818 *
ae006510
DG		 1819 * The xlat_func argument (actor) returns 0 if ready to execute
1820 * ATA command, else 1 to finish translation. If 1 is returned
1821 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1822 * to be set reflecting an error condition or clean (early)
1823 * termination.
1824 *
1da177e4 1825 * LOCKING:
cca3974e 1826 * spin_lock_irqsave(host lock)
2115ea94
TH		 1827 *
1828 * RETURNS:
1829 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1830 * needs to be deferred.
1da177e4 1831 */
2115ea94 1832static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
2115ea94 1833 ata_xlat_func_t xlat_func)
1da177e4 1834{
31cc23b3 1835 struct ata_port *ap = dev->link->ap;
1da177e4 1836 struct ata_queued_cmd *qc;
31cc23b3 1837 int rc;
1da177e4
LT		 1838
1839 VPRINTK("ENTER\n");
1840
b27dcfb0 1841 qc = ata_scsi_qc_new(dev, cmd);
1da177e4 1842 if (!qc)
ae006510 1843 goto err_mem;
1da177e4
LT		 1844
1845 /* data is present; dma-map it */
be7db055 1846 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1847 cmd->sc_data_direction == DMA_TO_DEVICE) {
7120165c 1848 if (unlikely(scsi_bufflen(cmd) < 1)) {
a9a79dfe 1849 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
ae006510 1850 goto err_did;
1da177e4
LT		 1851 }
1852
7120165c 1853 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1da177e4
LT		 1854
1855 qc->dma_dir = cmd->sc_data_direction;
1856 }
1857
1858 qc->complete_fn = ata_scsi_qc_complete;
1859
ad706991 1860 if (xlat_func(qc))
ae006510 1861 goto early_finish;
1da177e4 1862
31cc23b3
TH		 1863 if (ap->ops->qc_defer) {
1864 if ((rc = ap->ops->qc_defer(qc)))
1865 goto defer;
1866 }
1867
1da177e4 1868 /* select device, send command to hardware */
8e0e694a 1869 ata_qc_issue(qc);
1da177e4
LT		 1870
1871 VPRINTK("EXIT\n");
2115ea94 1872 return 0;
1da177e4 1873
ae006510 1874early_finish:
2dcb407e 1875 ata_qc_free(qc);
b27dcfb0 1876 cmd->scsi_done(cmd);
ae006510 1877 DPRINTK("EXIT - early finish (good or error)\n");
2115ea94 1878 return 0;
ae006510
DG		 1879
1880err_did:
1da177e4 1881 ata_qc_free(qc);
ae006510 1882 cmd->result = (DID_ERROR << 16);
b27dcfb0 1883 cmd->scsi_done(cmd);
253b92ec 1884err_mem:
ae006510 1885 DPRINTK("EXIT - internal\n");
2115ea94 1886 return 0;
3dc1d881
TH		 1887
1888defer:
31cc23b3 1889 ata_qc_free(qc);
3dc1d881 1890 DPRINTK("EXIT - defer\n");
31cc23b3
TH		 1891 if (rc == ATA_DEFER_LINK)
1892 return SCSI_MLQUEUE_DEVICE_BUSY;
1893 else
1894 return SCSI_MLQUEUE_HOST_BUSY;
1da177e4
LT		 1895}
1896
1897/**
1898 * ata_scsi_rbuf_get - Map response buffer.
ec2a20e6 1899 * @cmd: SCSI command containing buffer to be mapped.
87340e98
TH		 1900 * @flags: unsigned long variable to store irq enable status
1901 * @copy_in: copy in from user buffer
1da177e4 1902 *
87340e98 1903 * Prepare buffer for simulated SCSI commands.
1da177e4
LT		 1904 *
1905 * LOCKING:
87340e98 1906 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1da177e4
LT		 1907 *
1908 * RETURNS:
87340e98 1909 * Pointer to response buffer.
1da177e4 1910 */
87340e98
TH		 1911static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1912 unsigned long *flags)
1da177e4 1913{
87340e98 1914 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1da177e4 1915
87340e98
TH		 1916 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1917 if (copy_in)
1918 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1919 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1920 return ata_scsi_rbuf;
1da177e4
LT		 1921}
1922
1923/**
1924 * ata_scsi_rbuf_put - Unmap response buffer.
1925 * @cmd: SCSI command containing buffer to be unmapped.
87340e98
TH		 1926 * @copy_out: copy out result
1927 * @flags: @flags passed to ata_scsi_rbuf_get()
1da177e4 1928 *
87340e98
TH		 1929 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1930 * @copy_back is true.
1da177e4
LT		 1931 *
1932 * LOCKING:
87340e98 1933 * Unlocks ata_scsi_rbuf_lock.
1da177e4 1934 */
87340e98
TH		 1935static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1936 unsigned long *flags)
1da177e4 1937{
87340e98
TH		 1938 if (copy_out)
1939 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1940 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1941 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1da177e4
LT		 1942}
1943
1944/**
1945 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1946 * @args: device IDENTIFY data / SCSI command of interest.
1947 * @actor: Callback hook for desired SCSI command simulator
1948 *
1949 * Takes care of the hard work of simulating a SCSI command...
1950 * Mapping the response buffer, calling the command's handler,
1951 * and handling the handler's return value. This return value
1952 * indicates whether the handler wishes the SCSI command to be
ae006510
DG		 1953 * completed successfully (0), or not (in which case cmd->result
1954 * and sense buffer are assumed to be set).
1da177e4
LT		 1955 *
1956 * LOCKING:
cca3974e 1957 * spin_lock_irqsave(host lock)
1da177e4 1958 */
f0761be3 1959static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
87340e98 1960 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1da177e4
LT		 1961{
1962 u8 *rbuf;
87340e98 1963 unsigned int rc;
1da177e4 1964 struct scsi_cmnd *cmd = args->cmd;
b445c568
JG		 1965 unsigned long flags;
1966
87340e98
TH		 1967 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1968 rc = actor(args, rbuf);
1969 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
b445c568 1970
ae006510 1971 if (rc == 0)
1da177e4 1972 cmd->result = SAM_STAT_GOOD;
ae006510 1973 args->done(cmd);
1da177e4
LT		 1974}
1975
1976/**
1977 * ata_scsiop_inq_std - Simulate INQUIRY command
1978 * @args: device IDENTIFY data / SCSI command of interest.
1979 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1da177e4
LT		 1980 *
1981 * Returns standard device identification data associated
b142eb65 1982 * with non-VPD INQUIRY command output.
1da177e4
LT		 1983 *
1984 * LOCKING:
cca3974e 1985 * spin_lock_irqsave(host lock)
1da177e4 1986 */
87340e98 1987static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1da177e4 1988{
87340e98 1989 const u8 versions[] = {
f9ca5ab8 1990 0x00,
87340e98
TH		 1991 0x60, /* SAM-3 (no version claimed) */
1992
1993 0x03,
1994 0x20, /* SBC-2 (no version claimed) */
1995
1996 0x02,
1997 0x60 /* SPC-3 (no version claimed) */
1998 };
f9ca5ab8
HR		 1999 const u8 versions_zbc[] = {
2000 0x00,
2001 0xA0, /* SAM-5 (no version claimed) */
2002
2003 0x04,
2004 0xC0, /* SBC-3 (no version claimed) */
2005
2006 0x04,
2007 0x60, /* SPC-4 (no version claimed) */
2008
2009 0x60,
2010 0x20, /* ZBC (no version claimed) */
2011 };
2012
1da177e4
LT		 2013 u8 hdr[] = {
2014 TYPE_DISK,
2015 0,
2016 0x5, /* claim SPC-3 version compatibility */
2017 2,
2018 95 - 4
2019 };
2020
87340e98
TH		 2021 VPRINTK("ENTER\n");
2022
0628ee7c
NK		 2023 /* set scsi removable (RMB) bit per ata bit */
2024 if (ata_id_removable(args->id))
1da177e4
LT		 2025 hdr[1] |= (1 << 7);
2026
f9ca5ab8
HR		 2027 if (args->dev->class == ATA_DEV_ZAC) {
2028 hdr[0] = TYPE_ZBC;
2029 hdr[2] = 0x6; /* ZBC is defined in SPC-4 */
2030 }
2031
1da177e4 2032 memcpy(rbuf, hdr, sizeof(hdr));
87340e98
TH		 2033 memcpy(&rbuf[8], "ATA ", 8);
2034 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
c49a6bf5
KB		 2035
2036 /* From SAT, use last 2 words from fw rev unless they are spaces */
2037 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2038 if (strncmp(&rbuf[32], " ", 4) == 0)
2039 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1da177e4 2040
87340e98
TH		 2041 if (rbuf[32] == 0 || rbuf[32] == ' ')
2042 memcpy(&rbuf[32], "n/a ", 4);
1da177e4 2043
f9ca5ab8
HR		 2044 if (args->dev->class == ATA_DEV_ZAC)
2045 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2046 else
2047 memcpy(rbuf + 58, versions, sizeof(versions));
1da177e4
LT		 2048
2049 return 0;
2050}
2051
2052/**
b142eb65 2053 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1da177e4
LT		 2054 * @args: device IDENTIFY data / SCSI command of interest.
2055 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1da177e4 2056 *
b142eb65 2057 * Returns list of inquiry VPD pages available.
1da177e4
LT		 2058 *
2059 * LOCKING:
cca3974e 2060 * spin_lock_irqsave(host lock)
1da177e4 2061 */
87340e98 2062static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1da177e4
LT		 2063{
2064 const u8 pages[] = {
2065 0x00, /* page 0x00, this page */
2066 0x80, /* page 0x80, unit serial no page */
1e9dbc92
MW		 2067 0x83, /* page 0x83, device ident page */
2068 0x89, /* page 0x89, ata info page */
18f0f978 2069 0xb0, /* page 0xb0, block limits page */
1e9dbc92 2070 0xb1, /* page 0xb1, block device characteristics page */
02e0a604 2071 0xb2, /* page 0xb2, thin provisioning page */
1da177e4 2072 };
1da177e4 2073
87340e98
TH		 2074 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
2075 memcpy(rbuf + 4, pages, sizeof(pages));
1da177e4
LT		 2076 return 0;
2077}
2078
2079/**
b142eb65 2080 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1da177e4
LT		 2081 * @args: device IDENTIFY data / SCSI command of interest.
2082 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1da177e4
LT		 2083 *
2084 * Returns ATA device serial number.
2085 *
2086 * LOCKING:
cca3974e 2087 * spin_lock_irqsave(host lock)
1da177e4 2088 */
87340e98 2089static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1da177e4
LT		 2090{
2091 const u8 hdr[] = {
2092 0,
2093 0x80, /* this page code */
2094 0,
a0cf733b 2095 ATA_ID_SERNO_LEN, /* page len */
1da177e4 2096 };
1da177e4 2097
87340e98
TH		 2098 memcpy(rbuf, hdr, sizeof(hdr));
2099 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2100 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1da177e4
LT		 2101 return 0;
2102}
2103
1da177e4 2104/**
b142eb65 2105 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1da177e4
LT		 2106 * @args: device IDENTIFY data / SCSI command of interest.
2107 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1da177e4 2108 *
b142eb65
JG		 2109 * Yields two logical unit device identification designators:
2110 * - vendor specific ASCII containing the ATA serial number
2111 * - SAT defined "t10 vendor id based" containing ASCII vendor
2112 * name ("ATA "), model and serial numbers.
1da177e4
LT		 2113 *
2114 * LOCKING:
cca3974e 2115 * spin_lock_irqsave(host lock)
1da177e4 2116 */
87340e98 2117static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
1da177e4 2118{
b142eb65 2119 const int sat_model_serial_desc_len = 68;
87340e98 2120 int num;
1da177e4 2121
b142eb65
JG		 2122 rbuf[1] = 0x83; /* this page code */
2123 num = 4;
2124
87340e98
TH		 2125 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2126 rbuf[num + 0] = 2;
2127 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2128 num += 4;
2129 ata_id_string(args->id, (unsigned char *) rbuf + num,
2130 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2131 num += ATA_ID_SERNO_LEN;
2132
2133 /* SAT defined lu model and serial numbers descriptor */
2134 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2135 rbuf[num + 0] = 2;
2136 rbuf[num + 1] = 1;
2137 rbuf[num + 3] = sat_model_serial_desc_len;
2138 num += 4;
2139 memcpy(rbuf + num, "ATA ", 8);
2140 num += 8;
2141 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2142 ATA_ID_PROD_LEN);
2143 num += ATA_ID_PROD_LEN;
2144 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2145 ATA_ID_SERNO_LEN);
2146 num += ATA_ID_SERNO_LEN;
2147
6b3b9d73
HR		 2148 if (ata_id_has_wwn(args->id)) {
2149 /* SAT defined lu world wide name */
2150 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2151 rbuf[num + 0] = 1;
2152 rbuf[num + 1] = 3;
2153 rbuf[num + 3] = ATA_ID_WWN_LEN;
2154 num += 4;
2155 ata_id_string(args->id, (unsigned char *) rbuf + num,
2156 ATA_ID_WWN, ATA_ID_WWN_LEN);
2157 num += ATA_ID_WWN_LEN;
2158 }
b142eb65 2159 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1da177e4
LT		 2160 return 0;
2161}
2162
ad355b46
JG		 2163/**
2164 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2165 * @args: device IDENTIFY data / SCSI command of interest.
2166 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
ad355b46
JG		 2167 *
2168 * Yields SAT-specified ATA VPD page.
2169 *
2170 * LOCKING:
2171 * spin_lock_irqsave(host lock)
2172 */
87340e98 2173static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
ad355b46 2174{
ad355b46 2175 struct ata_taskfile tf;
ad355b46 2176
ad355b46
JG		 2177 memset(&tf, 0, sizeof(tf));
2178
87340e98
TH		 2179 rbuf[1] = 0x89; /* our page code */
2180 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2181 rbuf[3] = (0x238 & 0xff);
ad355b46 2182
87340e98
TH		 2183 memcpy(&rbuf[8], "linux ", 8);
2184 memcpy(&rbuf[16], "libata ", 16);
2185 memcpy(&rbuf[32], DRV_VERSION, 4);
ad355b46
JG		 2186
2187 /* we don't store the ATA device signature, so we fake it */
2188
2189 tf.command = ATA_DRDY; /* really, this is Status reg */
2190 tf.lbal = 0x1;
2191 tf.nsect = 0x1;
2192
87340e98
TH		 2193 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2194 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
ad355b46 2195
87340e98 2196 rbuf[56] = ATA_CMD_ID_ATA;
ad355b46 2197
87340e98 2198 memcpy(&rbuf[60], &args->id[0], 512);
ad355b46
JG		 2199 return 0;
2200}
2201
18f0f978
CH		 2202static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2203{
295124dc 2204 u16 min_io_sectors;
18f0f978
CH		 2205
2206 rbuf[1] = 0xb0;
2207 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2208
2209 /*
2210 * Optimal transfer length granularity.
2211 *
2212 * This is always one physical block, but for disks with a smaller
2213 * logical than physical sector size we need to figure out what the
2214 * latter is.
2215 */
295124dc 2216 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
18f0f978
CH		 2217 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2218
2219 /*
2220 * Optimal unmap granularity.
2221 *
2222 * The ATA spec doesn't even know about a granularity or alignment
2223 * for the TRIM command. We can leave away most of the unmap related
2224 * VPD page entries, but we have specifify a granularity to signal
2225 * that we support some form of unmap - in thise case via WRITE SAME
2226 * with the unmap bit set.
2227 */
e78db4df 2228 if (ata_id_has_trim(args->id)) {
5f4e2066 2229 put_unaligned_be64(65535 * 512 / 8, &rbuf[36]);
18f0f978 2230 put_unaligned_be32(1, &rbuf[28]);
e78db4df 2231 }
18f0f978
CH		 2232
2233 return 0;
2234}
2235
1e9dbc92
MW		 2236static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2237{
4bca3286
MP		 2238 int form_factor = ata_id_form_factor(args->id);
2239 int media_rotation_rate = ata_id_rotation_rate(args->id);
2240
1e9dbc92
MW		 2241 rbuf[1] = 0xb1;
2242 rbuf[3] = 0x3c;
4bca3286
MP		 2243 rbuf[4] = media_rotation_rate >> 8;
2244 rbuf[5] = media_rotation_rate;
2245 rbuf[7] = form_factor;
1e9dbc92
MW		 2246
2247 return 0;
2248}
2249
02e0a604
MP		 2250static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2251{
2252 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2253 rbuf[1] = 0xb2;
2254 rbuf[3] = 0x4;
2255 rbuf[5] = 1 << 6; /* TPWS */
2256
2257 return 0;
2258}
2259
1da177e4 2260/**
0cba632b 2261 * ata_scsiop_noop - Command handler that simply returns success.
1da177e4
LT		 2262 * @args: device IDENTIFY data / SCSI command of interest.
2263 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1da177e4
LT		 2264 *
2265 * No operation. Simply returns success to caller, to indicate
2266 * that the caller should successfully complete this SCSI command.
2267 *
2268 * LOCKING:
cca3974e 2269 * spin_lock_irqsave(host lock)
1da177e4 2270 */
87340e98 2271static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
1da177e4
LT		 2272{
2273 VPRINTK("ENTER\n");
2274 return 0;
2275}
2276
6ca8e794
PB		 2277/**
2278 * modecpy - Prepare response for MODE SENSE
2279 * @dest: output buffer
2280 * @src: data being copied
2281 * @n: length of mode page
2282 * @changeable: whether changeable parameters are requested
2283 *
2284 * Generate a generic MODE SENSE page for either current or changeable
2285 * parameters.
2286 *
2287 * LOCKING:
2288 * None.
2289 */
2290static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2291{
2292 if (changeable) {
2293 memcpy(dest, src, 2);
2294 memset(dest + 2, 0, n - 2);
2295 } else {
2296 memcpy(dest, src, n);
2297 }
2298}
2299
1da177e4
LT		 2300/**
2301 * ata_msense_caching - Simulate MODE SENSE caching info page
2302 * @id: device IDENTIFY data
87340e98 2303 * @buf: output buffer
6ca8e794 2304 * @changeable: whether changeable parameters are requested
1da177e4
LT		 2305 *
2306 * Generate a caching info page, which conditionally indicates
2307 * write caching to the SCSI layer, depending on device
2308 * capabilities.
2309 *
2310 * LOCKING:
2311 * None.
2312 */
6ca8e794 2313static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
1da177e4 2314{
6ca8e794 2315 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
1b26d29c 2316 if (changeable || ata_id_wcache_enabled(id))
87340e98 2317 buf[2] |= (1 << 2); /* write cache enable */
6ca8e794 2318 if (!changeable && !ata_id_rahead_enabled(id))
87340e98
TH		 2319 buf[12] |= (1 << 5); /* disable read ahead */
2320 return sizeof(def_cache_mpage);
1da177e4
LT		 2321}
2322
2323/**
2324 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
87340e98 2325 * @buf: output buffer
6ca8e794 2326 * @changeable: whether changeable parameters are requested
1da177e4
LT		 2327 *
2328 * Generate a generic MODE SENSE control mode page.
2329 *
2330 * LOCKING:
2331 * None.
2332 */
6ca8e794 2333static unsigned int ata_msense_ctl_mode(u8 *buf, bool changeable)
1da177e4 2334{
6ca8e794 2335 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
00ac37f5 2336 return sizeof(def_control_mpage);
1da177e4
LT		 2337}
2338
2339/**
2340 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
ec2a20e6 2341 * @buf: output buffer
6ca8e794 2342 * @changeable: whether changeable parameters are requested
1da177e4
LT		 2343 *
2344 * Generate a generic MODE SENSE r/w error recovery page.
2345 *
2346 * LOCKING:
2347 * None.
2348 */
6ca8e794 2349static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
1da177e4 2350{
6ca8e794
PB		 2351 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2352 changeable);
00ac37f5 2353 return sizeof(def_rw_recovery_mpage);
1da177e4
LT		 2354}
2355
48bdc8ec
JA		 2356/*
2357 * We can turn this into a real blacklist if it's needed, for now just
2358 * blacklist any Maxtor BANC1G10 revision firmware
2359 */
2360static int ata_dev_supports_fua(u16 *id)
2361{
a0cf733b 2362 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
48bdc8ec 2363
c3c013a2
JG		 2364 if (!libata_fua)
2365 return 0;
48bdc8ec
JA		 2366 if (!ata_id_has_fua(id))
2367 return 0;
2368
a0cf733b
TH		 2369 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2370 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
48bdc8ec 2371
2e02671d 2372 if (strcmp(model, "Maxtor"))
48bdc8ec 2373 return 1;
2e02671d 2374 if (strcmp(fw, "BANC1G10"))
48bdc8ec
JA		 2375 return 1;
2376
2377 return 0; /* blacklisted */
2378}
2379
1da177e4
LT		 2380/**
2381 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2382 * @args: device IDENTIFY data / SCSI command of interest.
2383 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1da177e4 2384 *
00ac37f5
DG		 2385 * Simulate MODE SENSE commands. Assume this is invoked for direct
2386 * access devices (e.g. disks) only. There should be no block
2387 * descriptor for other device types.
1da177e4
LT		 2388 *
2389 * LOCKING:
cca3974e 2390 * spin_lock_irqsave(host lock)
1da177e4 2391 */
87340e98 2392static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
1da177e4 2393{
9a3dccc4 2394 struct ata_device *dev = args->dev;
87340e98 2395 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
00ac37f5
DG		 2396 const u8 sat_blk_desc[] = {
2397 0, 0, 0, 0, /* number of blocks: sat unspecified */
2398 0,
2399 0, 0x2, 0x0 /* block length: 512 bytes */
2400 };
2401 u8 pg, spg;
87340e98 2402 unsigned int ebd, page_control, six_byte;
9a3dccc4 2403 u8 dpofua;
1da177e4
LT		 2404
2405 VPRINTK("ENTER\n");
2406
2407 six_byte = (scsicmd[0] == MODE_SENSE);
00ac37f5
DG		 2408 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2409 /*
2410 * LLBA bit in msense(10) ignored (compliant)
1da177e4 2411 */
00ac37f5 2412
1da177e4 2413 page_control = scsicmd[2] >> 6;
ae006510
DG		 2414 switch (page_control) {
2415 case 0: /* current */
6ca8e794
PB		 2416 case 1: /* changeable */
2417 case 2: /* defaults */
ae006510
DG		 2418 break; /* supported */
2419 case 3: /* saved */
2420 goto saving_not_supp;
ae006510
DG		 2421 default:
2422 goto invalid_fld;
2423 }
1da177e4 2424
87340e98
TH		 2425 if (six_byte)
2426 p += 4 + (ebd ? 8 : 0);
2427 else
2428 p += 8 + (ebd ? 8 : 0);
1da177e4 2429
00ac37f5
DG		 2430 pg = scsicmd[2] & 0x3f;
2431 spg = scsicmd[3];
2432 /*
2433 * No mode subpages supported (yet) but asking for _all_
2434 * subpages may be valid
2435 */
2436 if (spg && (spg != ALL_SUB_MPAGES))
2437 goto invalid_fld;
2438
2439 switch(pg) {
2440 case RW_RECOVERY_MPAGE:
6ca8e794 2441 p += ata_msense_rw_recovery(p, page_control == 1);
1da177e4
LT		 2442 break;
2443
00ac37f5 2444 case CACHE_MPAGE:
6ca8e794 2445 p += ata_msense_caching(args->id, p, page_control == 1);
1da177e4
LT		 2446 break;
2447
87340e98 2448 case CONTROL_MPAGE:
6ca8e794 2449 p += ata_msense_ctl_mode(p, page_control == 1);
1da177e4 2450 break;
1da177e4 2451
00ac37f5 2452 case ALL_MPAGES:
6ca8e794
PB		 2453 p += ata_msense_rw_recovery(p, page_control == 1);
2454 p += ata_msense_caching(args->id, p, page_control == 1);
2455 p += ata_msense_ctl_mode(p, page_control == 1);
1da177e4
LT		 2456 break;
2457
2458 default: /* invalid page code */
ae006510 2459 goto invalid_fld;
1da177e4
LT		 2460 }
2461
9a3dccc4 2462 dpofua = 0;
f79d409f 2463 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
9a3dccc4
TH		 2464 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2465 dpofua = 1 << 4;
2466
1da177e4 2467 if (six_byte) {
87340e98
TH		 2468 rbuf[0] = p - rbuf - 1;
2469 rbuf[2] |= dpofua;
00ac37f5 2470 if (ebd) {
87340e98
TH		 2471 rbuf[3] = sizeof(sat_blk_desc);
2472 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
00ac37f5 2473 }
1da177e4 2474 } else {
87340e98
TH		 2475 unsigned int output_len = p - rbuf - 2;
2476
1da177e4 2477 rbuf[0] = output_len >> 8;
87340e98
TH		 2478 rbuf[1] = output_len;
2479 rbuf[3] |= dpofua;
00ac37f5 2480 if (ebd) {
87340e98
TH		 2481 rbuf[7] = sizeof(sat_blk_desc);
2482 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
00ac37f5 2483 }
1da177e4 2484 }
1da177e4 2485 return 0;
ae006510
DG		 2486
2487invalid_fld:
2488 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2489 /* "Invalid field in cbd" */
2490 return 1;
2491
2492saving_not_supp:
2493 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2494 /* "Saving parameters not supported" */
2495 return 1;
1da177e4
LT		 2496}
2497
2498/**
2499 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2500 * @args: device IDENTIFY data / SCSI command of interest.
2501 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1da177e4
LT		 2502 *
2503 * Simulate READ CAPACITY commands.
2504 *
2505 * LOCKING:
6a36261e 2506 * None.
1da177e4 2507 */
87340e98 2508static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
1da177e4 2509{
61d79a8e
MP		 2510 struct ata_device *dev = args->dev;
2511 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
295124dc
GG		 2512 u32 sector_size; /* physical sector size in bytes */
2513 u8 log2_per_phys;
2514 u16 lowest_aligned;
2515
2516 sector_size = ata_id_logical_sector_size(dev->id);
2517 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2518 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
1da177e4
LT		 2519
2520 VPRINTK("ENTER\n");
2521
1da177e4 2522 if (args->cmd->cmnd[0] == READ_CAPACITY) {
6a36261e
TH		 2523 if (last_lba >= 0xffffffffULL)
2524 last_lba = 0xffffffff;
0c144d0d 2525
1da177e4 2526 /* sector count, 32-bit */
87340e98
TH		 2527 rbuf[0] = last_lba >> (8 * 3);
2528 rbuf[1] = last_lba >> (8 * 2);
2529 rbuf[2] = last_lba >> (8 * 1);
2530 rbuf[3] = last_lba;
1da177e4
LT		 2531
2532 /* sector size */
295124dc
GG		 2533 rbuf[4] = sector_size >> (8 * 3);
2534 rbuf[5] = sector_size >> (8 * 2);
2535 rbuf[6] = sector_size >> (8 * 1);
2536 rbuf[7] = sector_size;
1da177e4
LT		 2537 } else {
2538 /* sector count, 64-bit */
87340e98
TH		 2539 rbuf[0] = last_lba >> (8 * 7);
2540 rbuf[1] = last_lba >> (8 * 6);
2541 rbuf[2] = last_lba >> (8 * 5);
2542 rbuf[3] = last_lba >> (8 * 4);
2543 rbuf[4] = last_lba >> (8 * 3);
2544 rbuf[5] = last_lba >> (8 * 2);
2545 rbuf[6] = last_lba >> (8 * 1);
2546 rbuf[7] = last_lba;
1da177e4
LT		 2547
2548 /* sector size */
295124dc
GG		 2549 rbuf[ 8] = sector_size >> (8 * 3);
2550 rbuf[ 9] = sector_size >> (8 * 2);
2551 rbuf[10] = sector_size >> (8 * 1);
2552 rbuf[11] = sector_size;
61d79a8e
MP		 2553
2554 rbuf[12] = 0;
295124dc 2555 rbuf[13] = log2_per_phys;
61d79a8e
MP		 2556 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2557 rbuf[15] = lowest_aligned;
18f0f978 2558
e78db4df 2559 if (ata_id_has_trim(args->id)) {
e61f7d1c 2560 rbuf[14] |= 0x80; /* LBPME */
e78db4df 2561
e61f7d1c
MP		 2562 if (ata_id_has_zero_after_trim(args->id) &&
2563 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2564 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2565 rbuf[14] |= 0x40; /* LBPRZ */
2566 }
e78db4df 2567 }
1da177e4 2568 }
1da177e4
LT		 2569 return 0;
2570}
2571
2572/**
2573 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2574 * @args: device IDENTIFY data / SCSI command of interest.
2575 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1da177e4
LT		 2576 *
2577 * Simulate REPORT LUNS command.
2578 *
2579 * LOCKING:
cca3974e 2580 * spin_lock_irqsave(host lock)
1da177e4 2581 */
87340e98 2582static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
1da177e4
LT		 2583{
2584 VPRINTK("ENTER\n");
2585 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2586
2587 return 0;
2588}
2589
77853bf2 2590static void atapi_sense_complete(struct ata_queued_cmd *qc)
a939c963 2591{
74e6c8c3 2592 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
c6e6e666
JG		 2593 /* FIXME: not quite right; we don't want the
2594 * translation of taskfile registers into
2595 * a sense descriptors, since that's only
2596 * correct for ATA, not ATAPI
2597 */
750426aa 2598 ata_gen_passthru_sense(qc);
74e6c8c3 2599 }
a939c963 2600
c6e6e666 2601 qc->scsidone(qc->scsicmd);
77853bf2 2602 ata_qc_free(qc);
c6e6e666 2603}
a939c963 2604
c6e6e666
JG		 2605/* is it pointless to prefer PIO for "safety reasons"? */
2606static inline int ata_pio_use_silly(struct ata_port *ap)
2607{
2608 return (ap->flags & ATA_FLAG_PIO_DMA);
2609}
2610
2611static void atapi_request_sense(struct ata_queued_cmd *qc)
2612{
2613 struct ata_port *ap = qc->ap;
2614 struct scsi_cmnd *cmd = qc->scsicmd;
2615
2616 DPRINTK("ATAPI request sense\n");
a939c963 2617
7ccd720d 2618 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
a939c963 2619
127102ae 2620#ifdef CONFIG_ATA_SFF
855d854a
JB		 2621 if (ap->ops->sff_tf_read)
2622 ap->ops->sff_tf_read(ap, &qc->tf);
127102ae 2623#endif
c6e6e666
JG		 2624
2625 /* fill these in, for the case where they are -not- overwritten */
2626 cmd->sense_buffer[0] = 0x70;
2627 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2628
2629 ata_qc_reinit(qc);
2630
93f8fecb 2631 /* setup sg table and init transfer direction */
cadb7345 2632 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
93f8fecb 2633 ata_sg_init(qc, &qc->sgent, 1);
a939c963
JG		 2634 qc->dma_dir = DMA_FROM_DEVICE;
2635
6e7846e9 2636 memset(&qc->cdb, 0, qc->dev->cdb_len);
a939c963
JG		 2637 qc->cdb[0] = REQUEST_SENSE;
2638 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2639
2640 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2641 qc->tf.command = ATA_CMD_PACKET;
2642
c6e6e666 2643 if (ata_pio_use_silly(ap)) {
0dc36888 2644 qc->tf.protocol = ATAPI_PROT_DMA;
c6e6e666
JG		 2645 qc->tf.feature |= ATAPI_PKT_DMA;
2646 } else {
0dc36888 2647 qc->tf.protocol = ATAPI_PROT_PIO;
2db78dd3
AC		 2648 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2649 qc->tf.lbah = 0;
c6e6e666 2650 }
a939c963
JG		 2651 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2652
c6e6e666 2653 qc->complete_fn = atapi_sense_complete;
a939c963 2654
8e0e694a 2655 ata_qc_issue(qc);
a939c963
JG		 2656
2657 DPRINTK("EXIT\n");
2658}
2659
77853bf2 2660static void atapi_qc_complete(struct ata_queued_cmd *qc)
1da177e4
LT		 2661{
2662 struct scsi_cmnd *cmd = qc->scsicmd;
a22e2eb0 2663 unsigned int err_mask = qc->err_mask;
1da177e4 2664
a7dac447 2665 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
e12669e7 2666
246619da
TH		 2667 /* handle completion from new EH */
2668 if (unlikely(qc->ap->ops->error_handler &&
2669 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2670
2671 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2672 /* FIXME: not quite right; we don't want the
2673 * translation of taskfile registers into a
2674 * sense descriptors, since that's only
2675 * correct for ATA, not ATAPI
2676 */
750426aa 2677 ata_gen_passthru_sense(qc);
246619da
TH		 2678 }
2679
22aac089
TH		 2680 /* SCSI EH automatically locks door if sdev->locked is
2681 * set. Sometimes door lock request continues to
2682 * fail, for example, when no media is present. This
2683 * creates a loop - SCSI EH issues door lock which
2684 * fails and gets invoked again to acquire sense data
2685 * for the failed command.
2686 *
2687 * If door lock fails, always clear sdev->locked to
2688 * avoid this infinite loop.
2a5f07b5
TH		 2689 *
2690 * This may happen before SCSI scan is complete. Make
2691 * sure qc->dev->sdev isn't NULL before dereferencing.
22aac089 2692 */
2a5f07b5 2693 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
22aac089
TH		 2694 qc->dev->sdev->locked = 0;
2695
246619da
TH		 2696 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2697 qc->scsidone(cmd);
2698 ata_qc_free(qc);
2699 return;
2700 }
2701
2702 /* successful completion or old EH failure path */
a7dac447 2703 if (unlikely(err_mask & AC_ERR_DEV)) {
1da177e4 2704 cmd->result = SAM_STAT_CHECK_CONDITION;
c6e6e666 2705 atapi_request_sense(qc);
77853bf2 2706 return;
74e6c8c3 2707 } else if (unlikely(err_mask)) {
a7dac447
JG		 2708 /* FIXME: not quite right; we don't want the
2709 * translation of taskfile registers into
2710 * a sense descriptors, since that's only
2711 * correct for ATA, not ATAPI
2712 */
750426aa 2713 ata_gen_passthru_sense(qc);
74e6c8c3 2714 } else {
1da177e4
LT		 2715 u8 *scsicmd = cmd->cmnd;
2716
fd71da46 2717 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
b445c568 2718 unsigned long flags;
87340e98 2719 u8 *buf;
b445c568 2720
87340e98 2721 buf = ata_scsi_rbuf_get(cmd, true, &flags);
a15dbeb4
JG		 2722
2723 /* ATAPI devices typically report zero for their SCSI version,
2724 * and sometimes deviate from the spec WRT response data
2725 * format. If SCSI version is reported as zero like normal,
2726 * then we make the following fixups: 1) Fake MMC-5 version,
2727 * to indicate to the Linux scsi midlayer this is a modern
2728 * device. 2) Ensure response data format / ATAPI information
2729 * are always correct.
a15dbeb4
JG		 2730 */
2731 if (buf[2] == 0) {
2732 buf[2] = 0x5;
2733 buf[3] = 0x32;
2734 }
2735
87340e98 2736 ata_scsi_rbuf_put(cmd, true, &flags);
1da177e4 2737 }
a15dbeb4 2738
1da177e4
LT		 2739 cmd->result = SAM_STAT_GOOD;
2740 }
2741
2742 qc->scsidone(cmd);
77853bf2 2743 ata_qc_free(qc);
1da177e4
LT		 2744}
2745/**
2746 * atapi_xlat - Initialize PACKET taskfile
2747 * @qc: command structure to be initialized
1da177e4
LT		 2748 *
2749 * LOCKING:
cca3974e 2750 * spin_lock_irqsave(host lock)
1da177e4
LT		 2751 *
2752 * RETURNS:
2753 * Zero on success, non-zero on failure.
2754 */
ad706991 2755static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
1da177e4 2756{
542b1444 2757 struct scsi_cmnd *scmd = qc->scsicmd;
1da177e4 2758 struct ata_device *dev = qc->dev;
542b1444 2759 int nodata = (scmd->sc_data_direction == DMA_NONE);
5895ef9a 2760 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2db78dd3 2761 unsigned int nbytes;
1da177e4 2762
2e5704f6
TH		 2763 memset(qc->cdb, 0, dev->cdb_len);
2764 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
1da177e4
LT		 2765
2766 qc->complete_fn = atapi_qc_complete;
2767
2768 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
542b1444 2769 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
1da177e4
LT		 2770 qc->tf.flags |= ATA_TFLAG_WRITE;
2771 DPRINTK("direction: write\n");
2772 }
2773
2774 qc->tf.command = ATA_CMD_PACKET;
aacda375 2775 ata_qc_set_pc_nbytes(qc);
e00f1ff3
TH		 2776
2777 /* check whether ATAPI DMA is safe */
5895ef9a 2778 if (!nodata && !using_pio && atapi_check_dma(qc))
e00f1ff3 2779 using_pio = 1;
1da177e4 2780
e190222d
TH		 2781 /* Some controller variants snoop this value for Packet
2782 * transfers to do state machine and FIFO management. Thus we
2783 * want to set it properly, and for DMA where it is
2784 * effectively meaningless.
2785 */
aacda375 2786 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2db78dd3 2787
e190222d
TH		 2788 /* Most ATAPI devices which honor transfer chunk size don't
2789 * behave according to the spec when odd chunk size which
2790 * matches the transfer length is specified. If the number of
2791 * bytes to transfer is 2n+1. According to the spec, what
2792 * should happen is to indicate that 2n+1 is going to be
2793 * transferred and transfer 2n+2 bytes where the last byte is
2794 * padding.
2795 *
2796 * In practice, this doesn't happen. ATAPI devices first
2797 * indicate and transfer 2n bytes and then indicate and
2798 * transfer 2 bytes where the last byte is padding.
2799 *
2800 * This inconsistency confuses several controllers which
2801 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2802 * These controllers use actual number of transferred bytes to
2803 * update DMA poitner and transfer of 4n+2 bytes make those
2804 * controller push DMA pointer by 4n+4 bytes because SATA data
2805 * FISes are aligned to 4 bytes. This causes data corruption
2806 * and buffer overrun.
2807 *
2808 * Always setting nbytes to even number solves this problem
2809 * because then ATAPI devices don't have to split data at 2n
2810 * boundaries.
2811 */
2812 if (nbytes & 0x1)
2813 nbytes++;
2814
2db78dd3
AC		 2815 qc->tf.lbam = (nbytes & 0xFF);
2816 qc->tf.lbah = (nbytes >> 8);
2817
5895ef9a
TH		 2818 if (nodata)
2819 qc->tf.protocol = ATAPI_PROT_NODATA;
2820 else if (using_pio)
2821 qc->tf.protocol = ATAPI_PROT_PIO;
2822 else {
e00f1ff3 2823 /* DMA data xfer */
0dc36888 2824 qc->tf.protocol = ATAPI_PROT_DMA;
1da177e4
LT		 2825 qc->tf.feature |= ATAPI_PKT_DMA;
2826
91163006
TH		 2827 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2828 (scmd->sc_data_direction != DMA_TO_DEVICE))
95de719a 2829 /* some SATA bridges need us to indicate data xfer direction */
1da177e4 2830 qc->tf.feature |= ATAPI_DMADIR;
1da177e4
LT		 2831 }
2832
2db78dd3
AC		 2833
2834 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2835 as ATAPI tape drives don't get this right otherwise */
1da177e4
LT		 2836 return 0;
2837}
2838
2dcb407e 2839static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
ab5b3a5b 2840{
071f44b1 2841 if (!sata_pmp_attached(ap)) {
41bda9c9
TH		 2842 if (likely(devno < ata_link_max_devices(&ap->link)))
2843 return &ap->link.device[devno];
2844 } else {
2845 if (likely(devno < ap->nr_pmp_links))
2846 return &ap->pmp_link[devno].device[0];
2847 }
2848
ab5b3a5b
TH		 2849 return NULL;
2850}
2851
2dcb407e
JG		 2852static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2853 const struct scsi_device *scsidev)
ab5b3a5b 2854{
41bda9c9
TH		 2855 int devno;
2856
ab5b3a5b 2857 /* skip commands not addressed to targets we simulate */
071f44b1 2858 if (!sata_pmp_attached(ap)) {
41bda9c9
TH		 2859 if (unlikely(scsidev->channel || scsidev->lun))
2860 return NULL;
2861 devno = scsidev->id;
2862 } else {
2863 if (unlikely(scsidev->id || scsidev->lun))
2864 return NULL;
2865 devno = scsidev->channel;
2866 }
ab5b3a5b 2867
41bda9c9 2868 return ata_find_dev(ap, devno);
ab5b3a5b
TH		 2869}
2870
1da177e4
LT		 2871/**
2872 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2873 * @ap: ATA port to which the device is attached
2874 * @scsidev: SCSI device from which we derive the ATA device
2875 *
2876 * Given various information provided in struct scsi_cmnd,
2877 * map that onto an ATA bus, and using that mapping
2878 * determine which ata_device is associated with the
2879 * SCSI command to be sent.
2880 *
2881 * LOCKING:
cca3974e 2882 * spin_lock_irqsave(host lock)
1da177e4
LT		 2883 *
2884 * RETURNS:
2885 * Associated ATA device, or %NULL if not found.
2886 */
1da177e4 2887static struct ata_device *
057ace5e 2888ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
1da177e4 2889{
ab5b3a5b 2890 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
1da177e4 2891
2486fa56 2892 if (unlikely(!dev || !ata_dev_enabled(dev)))
1da177e4
LT		 2893 return NULL;
2894
1da177e4
LT		 2895 return dev;
2896}
2897
b095518e
JG		 2898/*
2899 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2900 * @byte1: Byte 1 from pass-thru CDB.
2901 *
2902 * RETURNS:
2903 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2904 */
2905static u8
2906ata_scsi_map_proto(u8 byte1)
2907{
2908 switch((byte1 & 0x1e) >> 1) {
2dcb407e
JG		 2909 case 3: /* Non-data */
2910 return ATA_PROT_NODATA;
2911
2912 case 6: /* DMA */
2913 case 10: /* UDMA Data-in */
2914 case 11: /* UDMA Data-Out */
2915 return ATA_PROT_DMA;
2916
2917 case 4: /* PIO Data-in */
2918 case 5: /* PIO Data-out */
2919 return ATA_PROT_PIO;
2920
2921 case 0: /* Hard Reset */
2922 case 1: /* SRST */
2923 case 8: /* Device Diagnostic */
2924 case 9: /* Device Reset */
2925 case 7: /* DMA Queued */
2926 case 12: /* FPDMA */
2927 case 15: /* Return Response Info */
2928 default: /* Reserved */
2929 break;
b095518e
JG		 2930 }
2931
2932 return ATA_PROT_UNKNOWN;
2933}
2934
2935/**
2936 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2937 * @qc: command structure to be initialized
b095518e
JG		 2938 *
2939 * Handles either 12 or 16-byte versions of the CDB.
2940 *
2941 * RETURNS:
2942 * Zero on success, non-zero on failure.
2943 */
ad706991 2944static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
b095518e
JG		 2945{
2946 struct ata_taskfile *tf = &(qc->tf);
542b1444 2947 struct scsi_cmnd *scmd = qc->scsicmd;
f79d409f 2948 struct ata_device *dev = qc->dev;
ad706991 2949 const u8 *cdb = scmd->cmnd;
b095518e 2950
542b1444 2951 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
9a405257 2952 goto invalid_fld;
8190bdb9 2953
b095518e
JG		 2954 /*
2955 * 12 and 16 byte CDBs use different offsets to
2956 * provide the various register values.
2957 */
542b1444 2958 if (cdb[0] == ATA_16) {
b095518e
JG		 2959 /*
2960 * 16-byte CDB - may contain extended commands.
2961 *
2962 * If that is the case, copy the upper byte register values.
2963 */
542b1444
TH		 2964 if (cdb[1] & 0x01) {
2965 tf->hob_feature = cdb[3];
2966 tf->hob_nsect = cdb[5];
2967 tf->hob_lbal = cdb[7];
2968 tf->hob_lbam = cdb[9];
2969 tf->hob_lbah = cdb[11];
b095518e
JG		 2970 tf->flags |= ATA_TFLAG_LBA48;
2971 } else
2972 tf->flags &= ~ATA_TFLAG_LBA48;
2973
2974 /*
2975 * Always copy low byte, device and command registers.
2976 */
542b1444
TH		 2977 tf->feature = cdb[4];
2978 tf->nsect = cdb[6];
2979 tf->lbal = cdb[8];
2980 tf->lbam = cdb[10];
2981 tf->lbah = cdb[12];
2982 tf->device = cdb[13];
2983 tf->command = cdb[14];
b095518e
JG		 2984 } else {
2985 /*
2986 * 12-byte CDB - incapable of extended commands.
2987 */
2988 tf->flags &= ~ATA_TFLAG_LBA48;
2989
542b1444
TH		 2990 tf->feature = cdb[3];
2991 tf->nsect = cdb[4];
2992 tf->lbal = cdb[5];
2993 tf->lbam = cdb[6];
2994 tf->lbah = cdb[7];
2995 tf->device = cdb[8];
2996 tf->command = cdb[9];
b095518e 2997 }
fa4453c4
AL		 2998
2999 /* enforce correct master/slave bit */
3000 tf->device = dev->devno ?
3001 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
b095518e 3002
bd30add8 3003 switch (tf->command) {
295124dc 3004 /* READ/WRITE LONG use a non-standard sect_size */
bd30add8
TH		 3005 case ATA_CMD_READ_LONG:
3006 case ATA_CMD_READ_LONG_ONCE:
3007 case ATA_CMD_WRITE_LONG:
3008 case ATA_CMD_WRITE_LONG_ONCE:
3009 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
3010 goto invalid_fld;
3011 qc->sect_size = scsi_bufflen(scmd);
295124dc
GG		 3012 break;
3013
3014 /* commands using reported Logical Block size (e.g. 512 or 4K) */
3015 case ATA_CMD_CFA_WRITE_NE:
3016 case ATA_CMD_CFA_TRANS_SECT:
3017 case ATA_CMD_CFA_WRITE_MULT_NE:
3018 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3019 case ATA_CMD_READ:
3020 case ATA_CMD_READ_EXT:
3021 case ATA_CMD_READ_QUEUED:
3022 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3023 case ATA_CMD_FPDMA_READ:
3024 case ATA_CMD_READ_MULTI:
3025 case ATA_CMD_READ_MULTI_EXT:
3026 case ATA_CMD_PIO_READ:
3027 case ATA_CMD_PIO_READ_EXT:
3028 case ATA_CMD_READ_STREAM_DMA_EXT:
3029 case ATA_CMD_READ_STREAM_EXT:
3030 case ATA_CMD_VERIFY:
3031 case ATA_CMD_VERIFY_EXT:
3032 case ATA_CMD_WRITE:
3033 case ATA_CMD_WRITE_EXT:
3034 case ATA_CMD_WRITE_FUA_EXT:
3035 case ATA_CMD_WRITE_QUEUED:
3036 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3037 case ATA_CMD_FPDMA_WRITE:
3038 case ATA_CMD_WRITE_MULTI:
3039 case ATA_CMD_WRITE_MULTI_EXT:
3040 case ATA_CMD_WRITE_MULTI_FUA_EXT:
3041 case ATA_CMD_PIO_WRITE:
3042 case ATA_CMD_PIO_WRITE_EXT:
3043 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3044 case ATA_CMD_WRITE_STREAM_EXT:
3045 qc->sect_size = scmd->device->sector_size;
3046 break;
3047
3048 /* Everything else uses 512 byte "sectors" */
3049 default:
3050 qc->sect_size = ATA_SECT_SIZE;
bd30add8
TH		 3051 }
3052
3053 /*
3054 * Set flags so that all registers will be written, pass on
3055 * write indication (used for PIO/DMA setup), result TF is
3056 * copied back and we don't whine too much about its failure.
3057 */
bc496ed0 3058 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
bd30add8
TH		 3059 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3060 tf->flags |= ATA_TFLAG_WRITE;
3061
3062 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3063
3064 /*
3065 * Set transfer length.
3066 *
3067 * TODO: find out if we need to do more here to
3068 * cover scatter/gather case.
3069 */
3070 ata_qc_set_pc_nbytes(qc);
3071
3072 /* We may not issue DMA commands if no DMA mode is set */
3073 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
3074 goto invalid_fld;
3075
1dce589c
AL		 3076 /* sanity check for pio multi commands */
3077 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
3078 goto invalid_fld;
3079
3080 if (is_multi_taskfile(tf)) {
3081 unsigned int multi_count = 1 << (cdb[1] >> 5);
3082
3083 /* compare the passed through multi_count
3084 * with the cached multi_count of libata
3085 */
3086 if (multi_count != dev->multi_count)
a9a79dfe
JP		 3087 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3088 multi_count);
d26fc955 3089 }
1dce589c 3090
b095518e
JG		 3091 /*
3092 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3093 * SET_FEATURES - XFER MODE must be preceded/succeeded
3094 * by an update to hardware-specific registers for each
3095 * controller (i.e. the reason for ->set_piomode(),
3096 * ->set_dmamode(), and ->post_set_mode() hooks).
3097 */
bd30add8
TH		 3098 if (tf->command == ATA_CMD_SET_FEATURES &&
3099 tf->feature == SETFEATURES_XFER)
9a405257 3100 goto invalid_fld;
b095518e
JG		 3101
3102 /*
bd30add8
TH		 3103 * Filter TPM commands by default. These provide an
3104 * essentially uncontrolled encrypted "back door" between
3105 * applications and the disk. Set libata.allow_tpm=1 if you
3106 * have a real reason for wanting to use them. This ensures
3107 * that installed software cannot easily mess stuff up without
3108 * user intent. DVR type users will probably ship with this enabled
3109 * for movie content management.
b095518e 3110 *
bd30add8
TH		 3111 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3112 * for this and should do in future but that it is not sufficient as
3113 * DCS is an optional feature set. Thus we also do the software filter
3114 * so that we comply with the TC consortium stated goal that the user
3115 * can turn off TC features of their system.
b095518e 3116 */
bd30add8
TH		 3117 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
3118 goto invalid_fld;
e61e0672 3119
b095518e 3120 return 0;
9a405257
TH		 3121
3122 invalid_fld:
542b1444 3123 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
9a405257
TH		 3124 /* "Invalid field in cdb" */
3125 return 1;
b095518e
JG		 3126}
3127
18f0f978
CH		 3128static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3129{
3130 struct ata_taskfile *tf = &qc->tf;
3131 struct scsi_cmnd *scmd = qc->scsicmd;
3132 struct ata_device *dev = qc->dev;
3133 const u8 *cdb = scmd->cmnd;
3134 u64 block;
3135 u32 n_block;
3136 u32 size;
3137 void *buf;
3138
3139 /* we may not issue DMA commands if no DMA mode is set */
3140 if (unlikely(!dev->dma_mode))
3141 goto invalid_fld;
3142
3143 if (unlikely(scmd->cmd_len < 16))
3144 goto invalid_fld;
3145 scsi_16_lba_len(cdb, &block, &n_block);
3146
3147 /* for now we only support WRITE SAME with the unmap bit set */
3148 if (unlikely(!(cdb[1] & 0x8)))
3149 goto invalid_fld;
3150
3151 /*
3152 * WRITE SAME always has a sector sized buffer as payload, this
3153 * should never be a multiple entry S/G list.
3154 */
3155 if (!scsi_sg_count(scmd))
3156 goto invalid_fld;
3157
3158 buf = page_address(sg_page(scsi_sglist(scmd)));
d0634c4a 3159 size = ata_set_lba_range_entries(buf, 512, block, n_block);
18f0f978 3160
87fb6c31
MC		 3161 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3162 /* Newer devices support queued TRIM commands */
3163 tf->protocol = ATA_PROT_NCQ;
3164 tf->command = ATA_CMD_FPDMA_SEND;
3165 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3166 tf->nsect = qc->tag << 3;
3167 tf->hob_feature = (size / 512) >> 8;
3168 tf->feature = size / 512;
3169
3170 tf->auxiliary = 1;
3171 } else {
3172 tf->protocol = ATA_PROT_DMA;
3173 tf->hob_feature = 0;
3174 tf->feature = ATA_DSM_TRIM;
3175 tf->hob_nsect = (size / 512) >> 8;
3176 tf->nsect = size / 512;
3177 tf->command = ATA_CMD_DSM;
3178 }
3179
18f0f978
CH		 3180 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3181 ATA_TFLAG_WRITE;
3182
3183 ata_qc_set_pc_nbytes(qc);
3184
3185 return 0;
3186
3187 invalid_fld:
3188 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3189 /* "Invalid field in cdb" */
3190 return 1;
3191}
3192
1b26d29c
PB		 3193/**
3194 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3195 * @qc: Storage for translated ATA taskfile
3196 * @buf: input buffer
3197 * @len: number of valid bytes in the input buffer
3198 *
3199 * Prepare a taskfile to modify caching information for the device.
3200 *
3201 * LOCKING:
3202 * None.
3203 */
3204static int ata_mselect_caching(struct ata_queued_cmd *qc,
3205 const u8 *buf, int len)
3206{
3207 struct ata_taskfile *tf = &qc->tf;
3208 struct ata_device *dev = qc->dev;
3209 char mpage[CACHE_MPAGE_LEN];
3210 u8 wce;
3211
3212 /*
3213 * The first two bytes of def_cache_mpage are a header, so offsets
3214 * in mpage are off by 2 compared to buf. Same for len.
3215 */
3216
3217 if (len != CACHE_MPAGE_LEN - 2)
3218 return -EINVAL;
3219
3220 wce = buf[0] & (1 << 2);
3221
3222 /*
3223 * Check that read-only bits are not modified.
3224 */
3225 ata_msense_caching(dev->id, mpage, false);
3226 mpage[2] &= ~(1 << 2);
3227 mpage[2] |= wce;
3228 if (memcmp(mpage + 2, buf, CACHE_MPAGE_LEN - 2) != 0)
3229 return -EINVAL;
3230
3231 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3232 tf->protocol = ATA_PROT_NODATA;
3233 tf->nsect = 0;
3234 tf->command = ATA_CMD_SET_FEATURES;
3235 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3236 return 0;
3237}
3238
3239/**
3240 * ata_scsiop_mode_select - Simulate MODE SELECT 6, 10 commands
3241 * @qc: Storage for translated ATA taskfile
3242 *
3243 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3244 * Assume this is invoked for direct access devices (e.g. disks) only.
3245 * There should be no block descriptor for other device types.
3246 *
3247 * LOCKING:
3248 * spin_lock_irqsave(host lock)
3249 */
3250static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3251{
3252 struct scsi_cmnd *scmd = qc->scsicmd;
3253 const u8 *cdb = scmd->cmnd;
3254 const u8 *p;
3255 u8 pg, spg;
3256 unsigned six_byte, pg_len, hdr_len, bd_len;
3257 int len;
3258
3259 VPRINTK("ENTER\n");
3260
3261 six_byte = (cdb[0] == MODE_SELECT);
3262 if (six_byte) {
3263 if (scmd->cmd_len < 5)
3264 goto invalid_fld;
3265
3266 len = cdb[4];
3267 hdr_len = 4;
3268 } else {
3269 if (scmd->cmd_len < 9)
3270 goto invalid_fld;
3271
3272 len = (cdb[7] << 8) + cdb[8];
3273 hdr_len = 8;
3274 }
3275
3276 /* We only support PF=1, SP=0. */
3277 if ((cdb[1] & 0x11) != 0x10)
3278 goto invalid_fld;
3279
3280 /* Test early for possible overrun. */
3281 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3282 goto invalid_param_len;
3283
3284 p = page_address(sg_page(scsi_sglist(scmd)));
3285
3286 /* Move past header and block descriptors. */
3287 if (len < hdr_len)
3288 goto invalid_param_len;
3289
3290 if (six_byte)
3291 bd_len = p[3];
3292 else
3293 bd_len = (p[6] << 8) + p[7];
3294
3295 len -= hdr_len;
3296 p += hdr_len;
3297 if (len < bd_len)
3298 goto invalid_param_len;
3299 if (bd_len != 0 && bd_len != 8)
3300 goto invalid_param;
3301
3302 len -= bd_len;
3303 p += bd_len;
3304 if (len == 0)
3305 goto skip;
3306
3307 /* Parse both possible formats for the mode page headers. */
3308 pg = p[0] & 0x3f;
3309 if (p[0] & 0x40) {
3310 if (len < 4)
3311 goto invalid_param_len;
3312
3313 spg = p[1];
3314 pg_len = (p[2] << 8) | p[3];
3315 p += 4;
3316 len -= 4;
3317 } else {
3318 if (len < 2)
3319 goto invalid_param_len;
3320
3321 spg = 0;
3322 pg_len = p[1];
3323 p += 2;
3324 len -= 2;
3325 }
3326
3327 /*
3328 * No mode subpages supported (yet) but asking for _all_
3329 * subpages may be valid
3330 */
3331 if (spg && (spg != ALL_SUB_MPAGES))
3332 goto invalid_param;
3333 if (pg_len > len)
3334 goto invalid_param_len;
3335
3336 switch (pg) {
3337 case CACHE_MPAGE:
3338 if (ata_mselect_caching(qc, p, pg_len) < 0)
3339 goto invalid_param;
3340 break;
3341
3342 default: /* invalid page code */
3343 goto invalid_param;
3344 }
3345
3346 /*
3347 * Only one page has changeable data, so we only support setting one
3348 * page at a time.
3349 */
3350 if (len > pg_len)
3351 goto invalid_param;
3352
3353 return 0;
3354
3355 invalid_fld:
3356 /* "Invalid field in CDB" */
3357 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
3358 return 1;
3359
3360 invalid_param:
3361 /* "Invalid field in parameter list" */
3362 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x26, 0x0);
3363 return 1;
3364
3365 invalid_param_len:
3366 /* "Parameter list length error" */
3367 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3368 return 1;
3369
3370 skip:
3371 scmd->result = SAM_STAT_GOOD;
3372 return 1;
3373}
3374
1da177e4
LT		 3375/**
3376 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3377 * @dev: ATA device
3378 * @cmd: SCSI command opcode to consider
3379 *
3380 * Look up the SCSI command given, and determine whether the
3381 * SCSI command is to be translated or simulated.
3382 *
3383 * RETURNS:
3384 * Pointer to translation function if possible, %NULL if not.
3385 */
3386
3387static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3388{
3389 switch (cmd) {
3390 case READ_6:
3391 case READ_10:
3392 case READ_16:
3393
3394 case WRITE_6:
3395 case WRITE_10:
3396 case WRITE_16:
3397 return ata_scsi_rw_xlat;
3398
0cdd6eb7 3399 case WRITE_SAME_16:
18f0f978
CH		 3400 return ata_scsi_write_same_xlat;
3401
1da177e4
LT		 3402 case SYNCHRONIZE_CACHE:
3403 if (ata_try_flush_cache(dev))
3404 return ata_scsi_flush_xlat;
3405 break;
3406
3407 case VERIFY:
3408 case VERIFY_16:
3409 return ata_scsi_verify_xlat;
b095518e
JG		 3410
3411 case ATA_12:
3412 case ATA_16:
3413 return ata_scsi_pass_thru;
da61396d 3414
1b26d29c
PB		 3415 case MODE_SELECT:
3416 case MODE_SELECT_10:
3417 return ata_scsi_mode_select_xlat;
3418 break;
3419
972dcafb
DG		 3420 case START_STOP:
3421 return ata_scsi_start_stop_xlat;
1da177e4
LT		 3422 }
3423
3424 return NULL;
3425}
3426
3427/**
3428 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3429 * @ap: ATA port to which the command was being sent
3430 * @cmd: SCSI command to dump
3431 *
3432 * Prints the contents of a SCSI command via printk().
3433 */
3434
3435static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3436 struct scsi_cmnd *cmd)
3437{
3438#ifdef ATA_DEBUG
3439 struct scsi_device *scsidev = cmd->device;
3440 u8 *scsicmd = cmd->cmnd;
3441
3442 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
44877b4e 3443 ap->print_id,
1da177e4
LT		 3444 scsidev->channel, scsidev->id, scsidev->lun,
3445 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3446 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3447 scsicmd[8]);
3448#endif
3449}
3450
542b1444 3451static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2115ea94 3452 struct ata_device *dev)
eb3f0f9c 3453{
baf4fdfa
ML		 3454 u8 scsi_op = scmd->cmnd[0];
3455 ata_xlat_func_t xlat_func;
2115ea94
TH		 3456 int rc = 0;
3457
9162c657 3458 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
baf4fdfa
ML		 3459 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3460 goto bad_cdb_len;
eb3f0f9c 3461
baf4fdfa
ML		 3462 xlat_func = ata_get_xlat_func(dev, scsi_op);
3463 } else {
3464 if (unlikely(!scmd->cmd_len))
3465 goto bad_cdb_len;
3466
3467 xlat_func = NULL;
3468 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3469 /* relay SCSI command to ATAPI device */
607126c2
ML		 3470 int len = COMMAND_SIZE(scsi_op);
3471 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
baf4fdfa
ML		 3472 goto bad_cdb_len;
3473
3474 xlat_func = atapi_xlat;
3475 } else {
3476 /* ATA_16 passthru, treat as an ATA command */
3477 if (unlikely(scmd->cmd_len > 16))
3478 goto bad_cdb_len;
3479
3480 xlat_func = ata_get_xlat_func(dev, scsi_op);
3481 }
3482 }
3483
3484 if (xlat_func)
b27dcfb0 3485 rc = ata_scsi_translate(dev, scmd, xlat_func);
baf4fdfa 3486 else
b27dcfb0 3487 ata_scsi_simulate(dev, scmd);
2115ea94
TH		 3488
3489 return rc;
baf4fdfa
ML		 3490
3491 bad_cdb_len:
3492 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3493 scmd->cmd_len, scsi_op, dev->cdb_len);
3494 scmd->result = DID_ERROR << 16;
b27dcfb0 3495 scmd->scsi_done(scmd);
baf4fdfa 3496 return 0;
eb3f0f9c
BK		 3497}
3498
1da177e4
LT		 3499/**
3500 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
23e701e6 3501 * @shost: SCSI host of command to be sent
1da177e4 3502 * @cmd: SCSI command to be sent
1da177e4
LT		 3503 *
3504 * In some cases, this function translates SCSI commands into
3505 * ATA taskfiles, and queues the taskfiles to be sent to
3506 * hardware. In other cases, this function simulates a
3507 * SCSI device by evaluating and responding to certain
3508 * SCSI commands. This creates the overall effect of
3509 * ATA and ATAPI devices appearing as SCSI devices.
3510 *
3511 * LOCKING:
23e701e6 3512 * ATA host lock
1da177e4
LT		 3513 *
3514 * RETURNS:
2115ea94
TH		 3515 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3516 * 0 otherwise.
1da177e4 3517 */
23e701e6 3518int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
1da177e4
LT		 3519{
3520 struct ata_port *ap;
3521 struct ata_device *dev;
3522 struct scsi_device *scsidev = cmd->device;
2115ea94 3523 int rc = 0;
23e701e6 3524 unsigned long irq_flags;
1da177e4 3525
35bb94b1 3526 ap = ata_shost_to_port(shost);
005a5a06 3527
23e701e6 3528 spin_lock_irqsave(ap->lock, irq_flags);
1da177e4
LT		 3529
3530 ata_scsi_dump_cdb(ap, cmd);
3531
3532 dev = ata_scsi_find_dev(ap, scsidev);
eb3f0f9c 3533 if (likely(dev))
b27dcfb0 3534 rc = __ata_scsi_queuecmd(cmd, dev);
eb3f0f9c 3535 else {
1da177e4 3536 cmd->result = (DID_BAD_TARGET << 16);
23e701e6 3537 cmd->scsi_done(cmd);
1da177e4
LT		 3538 }
3539
23e701e6
JG		 3540 spin_unlock_irqrestore(ap->lock, irq_flags);
3541
2115ea94 3542 return rc;
1da177e4
LT		 3543}
3544
3545/**
3546 * ata_scsi_simulate - simulate SCSI command on ATA device
c893a3ae 3547 * @dev: the target device
1da177e4 3548 * @cmd: SCSI command being sent to device.
1da177e4
LT		 3549 *
3550 * Interprets and directly executes a select list of SCSI commands
3551 * that can be handled internally.
3552 *
3553 * LOCKING:
cca3974e 3554 * spin_lock_irqsave(host lock)
1da177e4
LT		 3555 */
3556
b27dcfb0 3557void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
1da177e4
LT		 3558{
3559 struct ata_scsi_args args;
057ace5e 3560 const u8 *scsicmd = cmd->cmnd;
45394145 3561 u8 tmp8;
1da177e4 3562
9a3dccc4
TH		 3563 args.dev = dev;
3564 args.id = dev->id;
1da177e4 3565 args.cmd = cmd;
b27dcfb0 3566 args.done = cmd->scsi_done;
1da177e4
LT		 3567
3568 switch(scsicmd[0]) {
2dcb407e
JG		 3569 /* TODO: worth improving? */
3570 case FORMAT_UNIT:
b27dcfb0 3571 ata_scsi_invalid_field(cmd);
2dcb407e
JG		 3572 break;
3573
3574 case INQUIRY:
3575 if (scsicmd[1] & 2) /* is CmdDt set? */
b27dcfb0 3576 ata_scsi_invalid_field(cmd);
2dcb407e
JG		 3577 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3578 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3579 else switch (scsicmd[2]) {
3580 case 0x00:
3581 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
1da177e4 3582 break;
2dcb407e
JG		 3583 case 0x80:
3584 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
1da177e4 3585 break;
2dcb407e
JG		 3586 case 0x83:
3587 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
1da177e4 3588 break;
2dcb407e
JG		 3589 case 0x89:
3590 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3591 break;
18f0f978
CH		 3592 case 0xb0:
3593 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3594 break;
1e9dbc92
MW		 3595 case 0xb1:
3596 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3597 break;
02e0a604
MP		 3598 case 0xb2:
3599 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
3600 break;
2dcb407e 3601 default:
b27dcfb0 3602 ata_scsi_invalid_field(cmd);
1da177e4 3603 break;
2dcb407e
JG		 3604 }
3605 break;
3606
3607 case MODE_SENSE:
3608 case MODE_SENSE_10:
3609 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3610 break;
3611
2dcb407e
JG		 3612 case READ_CAPACITY:
3613 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3614 break;
3615
eb846d9f 3616 case SERVICE_ACTION_IN_16:
2dcb407e 3617 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
1da177e4 3618 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2dcb407e 3619 else
b27dcfb0 3620 ata_scsi_invalid_field(cmd);
2dcb407e 3621 break;
1da177e4 3622
2dcb407e
JG		 3623 case REPORT_LUNS:
3624 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3625 break;
1da177e4 3626
2dcb407e
JG		 3627 case REQUEST_SENSE:
3628 ata_scsi_set_sense(cmd, 0, 0, 0);
3629 cmd->result = (DRIVER_SENSE << 24);
b27dcfb0 3630 cmd->scsi_done(cmd);
2dcb407e 3631 break;
1da177e4 3632
2dcb407e
JG		 3633 /* if we reach this, then writeback caching is disabled,
3634 * turning this into a no-op.
3635 */
3636 case SYNCHRONIZE_CACHE:
3637 /* fall through */
3638
3639 /* no-op's, complete with success */
3640 case REZERO_UNIT:
3641 case SEEK_6:
3642 case SEEK_10:
3643 case TEST_UNIT_READY:
3644 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3645 break;
45394145 3646
2dcb407e
JG		 3647 case SEND_DIAGNOSTIC:
3648 tmp8 = scsicmd[1] & ~(1 << 3);
3649 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
00bd0202 3650 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2dcb407e 3651 else
b27dcfb0 3652 ata_scsi_invalid_field(cmd);
2dcb407e 3653 break;
1da177e4 3654
2dcb407e
JG		 3655 /* all other commands */
3656 default:
3657 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3658 /* "Invalid command operation code" */
b27dcfb0 3659 cmd->scsi_done(cmd);
2dcb407e 3660 break;
1da177e4
LT		 3661 }
3662}
3663
f3187195
TH		 3664int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3665{
3666 int i, rc;
3667
3668 for (i = 0; i < host->n_ports; i++) {
3669 struct ata_port *ap = host->ports[i];
3670 struct Scsi_Host *shost;
3671
3672 rc = -ENOMEM;
3673 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3674 if (!shost)
3675 goto err_alloc;
3676
9ee4f393 3677 shost->eh_noresume = 1;
f3187195
TH		 3678 *(struct ata_port **)&shost->hostdata[0] = ap;
3679 ap->scsi_host = shost;
3680
d9027470 3681 shost->transportt = ata_scsi_transport_template;
f3187195
TH		 3682 shost->unique_id = ap->print_id;
3683 shost->max_id = 16;
3684 shost->max_lun = 1;
3685 shost->max_channel = 1;
3686 shost->max_cmd_len = 16;
54b2b50c 3687 shost->no_write_same = 1;
f3187195 3688
31cc23b3
TH		 3689 /* Schedule policy is determined by ->qc_defer()
3690 * callback and it needs to see every deferred qc.
3691 * Set host_blocked to 1 to prevent SCSI midlayer from
3692 * automatically deferring requests.
3693 */
3694 shost->max_host_blocked = 1;
3695
98bd4be1
SL		 3696 if (scsi_init_shared_tag_map(shost, host->n_tags))
3697 goto err_add;
12cb5ce1 3698
f8fc75dc
LM		 3699 rc = scsi_add_host_with_dma(ap->scsi_host,
3700 &ap->tdev, ap->host->dev);
f3187195
TH		 3701 if (rc)
3702 goto err_add;
3703 }
3704
3705 return 0;
3706
3707 err_add:
3708 scsi_host_put(host->ports[i]->scsi_host);
3709 err_alloc:
3710 while (--i >= 0) {
3711 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3712
3713 scsi_remove_host(shost);
3714 scsi_host_put(shost);
3715 }
3716 return rc;
3717}
3718
1ae46317 3719void ata_scsi_scan_host(struct ata_port *ap, int sync)
644dd0cc 3720{
1ae46317
TH		 3721 int tries = 5;
3722 struct ata_device *last_failed_dev = NULL;
41bda9c9 3723 struct ata_link *link;
1ae46317 3724 struct ata_device *dev;
644dd0cc 3725
1ae46317 3726 repeat:
1eca4365
TH		 3727 ata_for_each_link(link, ap, EDGE) {
3728 ata_for_each_dev(dev, link, ENABLED) {
41bda9c9
TH		 3729 struct scsi_device *sdev;
3730 int channel = 0, id = 0;
3edebac4 3731
1eca4365 3732 if (dev->sdev)
41bda9c9 3733 continue;
3f19ee8c 3734
41bda9c9
TH		 3735 if (ata_is_host_link(link))
3736 id = dev->devno;
3737 else
3738 channel = link->pmp;
3739
3740 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3741 NULL);
3742 if (!IS_ERR(sdev)) {
3743 dev->sdev = sdev;
3744 scsi_device_put(sdev);
295124dc
GG		 3745 } else {
3746 dev->sdev = NULL;
41bda9c9 3747 }
3edebac4 3748 }
3f19ee8c 3749 }
1ae46317
TH		 3750
3751 /* If we scanned while EH was in progress or allocation
3752 * failure occurred, scan would have failed silently. Check
3753 * whether all devices are attached.
3754 */
1eca4365
TH		 3755 ata_for_each_link(link, ap, EDGE) {
3756 ata_for_each_dev(dev, link, ENABLED) {
3757 if (!dev->sdev)
41bda9c9
TH		 3758 goto exit_loop;
3759 }
1ae46317 3760 }
41bda9c9
TH		 3761 exit_loop:
3762 if (!link)
1ae46317
TH		 3763 return;
3764
3765 /* we're missing some SCSI devices */
3766 if (sync) {
3767 /* If caller requested synchrnous scan && we've made
3768 * any progress, sleep briefly and repeat.
3769 */
3770 if (dev != last_failed_dev) {
3771 msleep(100);
3772 last_failed_dev = dev;
3773 goto repeat;
3774 }
3775
3776 /* We might be failing to detect boot device, give it
3777 * a few more chances.
3778 */
3779 if (--tries) {
3780 msleep(100);
3781 goto repeat;
3782 }
3783
a9a79dfe
JP		 3784 ata_port_err(ap,
3785 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
1ae46317
TH		 3786 }
3787
ad72cf98 3788 queue_delayed_work(system_long_wq, &ap->hotplug_task,
1ae46317 3789 round_jiffies_relative(HZ));
644dd0cc 3790}
0ea035a3
TH		 3791
3792/**
3793 * ata_scsi_offline_dev - offline attached SCSI device
3794 * @dev: ATA device to offline attached SCSI device for
3795 *
3796 * This function is called from ata_eh_hotplug() and responsible
3797 * for taking the SCSI device attached to @dev offline. This
cca3974e 3798 * function is called with host lock which protects dev->sdev
0ea035a3
TH		 3799 * against clearing.
3800 *
3801 * LOCKING:
cca3974e 3802 * spin_lock_irqsave(host lock)
0ea035a3
TH		 3803 *
3804 * RETURNS:
3805 * 1 if attached SCSI device exists, 0 otherwise.
3806 */
3807int ata_scsi_offline_dev(struct ata_device *dev)
3808{
3809 if (dev->sdev) {
3810 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3811 return 1;
3812 }
3813 return 0;
3814}
580b2102
TH		 3815
3816/**
3817 * ata_scsi_remove_dev - remove attached SCSI device
3818 * @dev: ATA device to remove attached SCSI device for
3819 *
3820 * This function is called from ata_eh_scsi_hotplug() and
3821 * responsible for removing the SCSI device attached to @dev.
3822 *
3823 * LOCKING:
3824 * Kernel thread context (may sleep).
3825 */
3826static void ata_scsi_remove_dev(struct ata_device *dev)
3827{
9af5c9c9 3828 struct ata_port *ap = dev->link->ap;
580b2102
TH		 3829 struct scsi_device *sdev;
3830 unsigned long flags;
3831
3832 /* Alas, we need to grab scan_mutex to ensure SCSI device
3833 * state doesn't change underneath us and thus
3834 * scsi_device_get() always succeeds. The mutex locking can
3835 * be removed if there is __scsi_device_get() interface which
3836 * increments reference counts regardless of device state.
3837 */
cca3974e 3838 mutex_lock(&ap->scsi_host->scan_mutex);
ba6a1308 3839 spin_lock_irqsave(ap->lock, flags);
580b2102 3840
cca3974e 3841 /* clearing dev->sdev is protected by host lock */
580b2102
TH		 3842 sdev = dev->sdev;
3843 dev->sdev = NULL;
3844
3845 if (sdev) {
3846 /* If user initiated unplug races with us, sdev can go
cca3974e 3847 * away underneath us after the host lock and
580b2102
TH		 3848 * scan_mutex are released. Hold onto it.
3849 */
3850 if (scsi_device_get(sdev) == 0) {
3851 /* The following ensures the attached sdev is
3852 * offline on return from ata_scsi_offline_dev()
3853 * regardless it wins or loses the race
3854 * against this function.
3855 */
3856 scsi_device_set_state(sdev, SDEV_OFFLINE);
3857 } else {
3858 WARN_ON(1);
3859 sdev = NULL;
3860 }
3861 }
3862
ba6a1308 3863 spin_unlock_irqrestore(ap->lock, flags);
cca3974e 3864 mutex_unlock(&ap->scsi_host->scan_mutex);
580b2102
TH		 3865
3866 if (sdev) {
a9a79dfe
JP		 3867 ata_dev_info(dev, "detaching (SCSI %s)\n",
3868 dev_name(&sdev->sdev_gendev));
580b2102
TH		 3869
3870 scsi_remove_device(sdev);
3871 scsi_device_put(sdev);
3872 }
3873}
3874
41bda9c9
TH		 3875static void ata_scsi_handle_link_detach(struct ata_link *link)
3876{
3877 struct ata_port *ap = link->ap;
3878 struct ata_device *dev;
3879
1eca4365 3880 ata_for_each_dev(dev, link, ALL) {
41bda9c9
TH		 3881 unsigned long flags;
3882
3883 if (!(dev->flags & ATA_DFLAG_DETACHED))
3884 continue;
3885
3886 spin_lock_irqsave(ap->lock, flags);
3887 dev->flags &= ~ATA_DFLAG_DETACHED;
3888 spin_unlock_irqrestore(ap->lock, flags);
3889
f1bc1e4c
AL		 3890 if (zpodd_dev_enabled(dev))
3891 zpodd_exit(dev);
3892
41bda9c9
TH		 3893 ata_scsi_remove_dev(dev);
3894 }
3895}
3896
2f294968
KCA		 3897/**
3898 * ata_scsi_media_change_notify - send media change event
c5d0e6a0 3899 * @dev: Pointer to the disk device with media change event
2f294968
KCA		 3900 *
3901 * Tell the block layer to send a media change notification
3902 * event.
3903 *
3904 * LOCKING:
854c73a2 3905 * spin_lock_irqsave(host lock)
2f294968 3906 */
854c73a2 3907void ata_scsi_media_change_notify(struct ata_device *dev)
2f294968 3908{
854c73a2 3909 if (dev->sdev)
f26792d5
JG		 3910 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3911 GFP_ATOMIC);
2f294968 3912}
2f294968 3913
580b2102
TH		 3914/**
3915 * ata_scsi_hotplug - SCSI part of hotplug
65f27f38 3916 * @work: Pointer to ATA port to perform SCSI hotplug on
580b2102
TH		 3917 *
3918 * Perform SCSI part of hotplug. It's executed from a separate
3919 * workqueue after EH completes. This is necessary because SCSI
3920 * hot plugging requires working EH and hot unplugging is
3921 * synchronized with hot plugging with a mutex.
3922 *
3923 * LOCKING:
3924 * Kernel thread context (may sleep).
3925 */
65f27f38 3926void ata_scsi_hotplug(struct work_struct *work)
580b2102 3927{
65f27f38
DH		 3928 struct ata_port *ap =
3929 container_of(work, struct ata_port, hotplug_task.work);
41bda9c9 3930 int i;
580b2102 3931
b51e9e5d 3932 if (ap->pflags & ATA_PFLAG_UNLOADING) {
580b2102
TH		 3933 DPRINTK("ENTER/EXIT - unloading\n");
3934 return;
3935 }
3936
85fbd722
TH		 3937 /*
3938 * XXX - UGLY HACK
3939 *
3940 * The block layer suspend/resume path is fundamentally broken due
3941 * to freezable kthreads and workqueue and may deadlock if a block
3942 * device gets removed while resume is in progress. I don't know
3943 * what the solution is short of removing freezable kthreads and
3944 * workqueues altogether.
3945 *
3946 * The following is an ugly hack to avoid kicking off device
3947 * removal while freezer is active. This is a joke but does avoid
3948 * this particular deadlock scenario.
3949 *
3950 * https://bugzilla.kernel.org/show_bug.cgi?id=62801
3951 * http://marc.info/?l=linux-kernel&m=138695698516487
3952 */
3953#ifdef CONFIG_FREEZER
3954 while (pm_freezing)
3955 msleep(10);
3956#endif
3957
580b2102 3958 DPRINTK("ENTER\n");
ad72cf98 3959 mutex_lock(&ap->scsi_scan_mutex);
580b2102 3960
41bda9c9
TH		 3961 /* Unplug detached devices. We cannot use link iterator here
3962 * because PMP links have to be scanned even if PMP is
3963 * currently not attached. Iterate manually.
3964 */
3965 ata_scsi_handle_link_detach(&ap->link);
3966 if (ap->pmp_link)
3967 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3968 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
580b2102
TH		 3969
3970 /* scan for new ones */
1ae46317 3971 ata_scsi_scan_host(ap, 0);
580b2102 3972
ad72cf98 3973 mutex_unlock(&ap->scsi_scan_mutex);
580b2102
TH		 3974 DPRINTK("EXIT\n");
3975}
83c47bcb
TH		 3976
3977/**
3978 * ata_scsi_user_scan - indication for user-initiated bus scan
3979 * @shost: SCSI host to scan
3980 * @channel: Channel to scan
3981 * @id: ID to scan
3982 * @lun: LUN to scan
3983 *
3984 * This function is called when user explicitly requests bus
3985 * scan. Set probe pending flag and invoke EH.
3986 *
3987 * LOCKING:
3988 * SCSI layer (we don't care)
3989 *
3990 * RETURNS:
3991 * Zero.
3992 */
d9027470 3993int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
9cb78c16 3994 unsigned int id, u64 lun)
83c47bcb
TH		 3995{
3996 struct ata_port *ap = ata_shost_to_port(shost);
3997 unsigned long flags;
41bda9c9 3998 int devno, rc = 0;
83c47bcb
TH		 3999
4000 if (!ap->ops->error_handler)
4001 return -EOPNOTSUPP;
4002
41bda9c9 4003 if (lun != SCAN_WILD_CARD && lun)
83c47bcb
TH		 4004 return -EINVAL;
4005
071f44b1 4006 if (!sata_pmp_attached(ap)) {
41bda9c9
TH		 4007 if (channel != SCAN_WILD_CARD && channel)
4008 return -EINVAL;
4009 devno = id;
4010 } else {
4011 if (id != SCAN_WILD_CARD && id)
4012 return -EINVAL;
4013 devno = channel;
4014 }
4015
ba6a1308 4016 spin_lock_irqsave(ap->lock, flags);
83c47bcb 4017
41bda9c9
TH		 4018 if (devno == SCAN_WILD_CARD) {
4019 struct ata_link *link;
4020
1eca4365 4021 ata_for_each_link(link, ap, EDGE) {
41bda9c9 4022 struct ata_eh_info *ehi = &link->eh_info;
b558eddd 4023 ehi->probe_mask |= ATA_ALL_DEVICES;
cf480626 4024 ehi->action |= ATA_EH_RESET;
41bda9c9 4025 }
83c47bcb 4026 } else {
41bda9c9 4027 struct ata_device *dev = ata_find_dev(ap, devno);
83c47bcb
TH		 4028
4029 if (dev) {
41bda9c9 4030 struct ata_eh_info *ehi = &dev->link->eh_info;
9af5c9c9 4031 ehi->probe_mask |= 1 << dev->devno;
cf480626 4032 ehi->action |= ATA_EH_RESET;
83c47bcb
TH		 4033 } else
4034 rc = -EINVAL;
4035 }
4036
309afcb5 4037 if (rc == 0) {
83c47bcb 4038 ata_port_schedule_eh(ap);
309afcb5
TH		 4039 spin_unlock_irqrestore(ap->lock, flags);
4040 ata_port_wait_eh(ap);
4041 } else
4042 spin_unlock_irqrestore(ap->lock, flags);
83c47bcb
TH		 4043
4044 return rc;
4045}
3057ac3c 4046
4047/**
d0171269 4048 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
65f27f38 4049 * @work: Pointer to ATA port to perform scsi_rescan_device()
3057ac3c 4050 *
d0171269 4051 * After ATA pass thru (SAT) commands are executed successfully,
ad72cf98 4052 * libata need to propagate the changes to SCSI layer.
3057ac3c 4053 *
d0171269
TH		 4054 * LOCKING:
4055 * Kernel thread context (may sleep).
3057ac3c 4056 */
65f27f38 4057void ata_scsi_dev_rescan(struct work_struct *work)
3057ac3c 4058{
65f27f38
DH		 4059 struct ata_port *ap =
4060 container_of(work, struct ata_port, scsi_rescan_task);
41bda9c9 4061 struct ata_link *link;
f58229f8 4062 struct ata_device *dev;
f84e7e41 4063 unsigned long flags;
3057ac3c 4064
ad72cf98 4065 mutex_lock(&ap->scsi_scan_mutex);
f84e7e41
TH		 4066 spin_lock_irqsave(ap->lock, flags);
4067
1eca4365
TH		 4068 ata_for_each_link(link, ap, EDGE) {
4069 ata_for_each_dev(dev, link, ENABLED) {
41bda9c9 4070 struct scsi_device *sdev = dev->sdev;
3057ac3c 4071
1eca4365 4072 if (!sdev)
41bda9c9
TH		 4073 continue;
4074 if (scsi_device_get(sdev))
4075 continue;
f84e7e41 4076
41bda9c9
TH		 4077 spin_unlock_irqrestore(ap->lock, flags);
4078 scsi_rescan_device(&(sdev->sdev_gendev));
4079 scsi_device_put(sdev);
4080 spin_lock_irqsave(ap->lock, flags);
4081 }
3057ac3c 4082 }
f84e7e41
TH		 4083
4084 spin_unlock_irqrestore(ap->lock, flags);
ad72cf98 4085 mutex_unlock(&ap->scsi_scan_mutex);
3057ac3c 4086}
80289167
BK		 4087
4088/**
4089 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
4f931374 4090 * @host: ATA host container for all SAS ports
80289167 4091 * @port_info: Information from low-level host driver
cca3974e 4092 * @shost: SCSI host that the scsi device is attached to
80289167
BK		 4093 *
4094 * LOCKING:
4095 * PCI/etc. bus probe sem.
4096 *
4097 * RETURNS:
4098 * ata_port pointer on success / NULL on failure.
4099 */
4100
cca3974e 4101struct ata_port *ata_sas_port_alloc(struct ata_host *host,
80289167 4102 struct ata_port_info *port_info,
cca3974e 4103 struct Scsi_Host *shost)
80289167 4104{
f3187195 4105 struct ata_port *ap;
80289167 4106
f3187195 4107 ap = ata_port_alloc(host);
80289167
BK		 4108 if (!ap)
4109 return NULL;
4110
f3187195 4111 ap->port_no = 0;
a29b5dad 4112 ap->lock = &host->lock;
f3187195
TH		 4113 ap->pio_mask = port_info->pio_mask;
4114 ap->mwdma_mask = port_info->mwdma_mask;
4115 ap->udma_mask = port_info->udma_mask;
4116 ap->flags |= port_info->flags;
4117 ap->ops = port_info->port_ops;
4118 ap->cbl = ATA_CBL_SATA;
4119
80289167
BK		 4120 return ap;
4121}
4122EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
4123
4124/**
4125 * ata_sas_port_start - Set port up for dma.
4126 * @ap: Port to initialize
4127 *
4128 * Called just after data structures for each port are
dde20207 4129 * initialized.
80289167
BK		 4130 *
4131 * May be used as the port_start() entry in ata_port_operations.
4132 *
4133 * LOCKING:
4134 * Inherited from caller.
4135 */
4136int ata_sas_port_start(struct ata_port *ap)
4137{
3f1e046a
NA		 4138 /*
4139 * the port is marked as frozen at allocation time, but if we don't
4140 * have new eh, we won't thaw it
4141 */
4142 if (!ap->ops->error_handler)
4143 ap->pflags &= ~ATA_PFLAG_FROZEN;
dde20207 4144 return 0;
80289167
BK		 4145}
4146EXPORT_SYMBOL_GPL(ata_sas_port_start);
4147
4148/**
4149 * ata_port_stop - Undo ata_sas_port_start()
4150 * @ap: Port to shut down
4151 *
80289167
BK		 4152 * May be used as the port_stop() entry in ata_port_operations.
4153 *
4154 * LOCKING:
4155 * Inherited from caller.
4156 */
4157
4158void ata_sas_port_stop(struct ata_port *ap)
4159{
80289167
BK		 4160}
4161EXPORT_SYMBOL_GPL(ata_sas_port_stop);
4162
b2024459
DW		 4163/**
4164 * ata_sas_async_probe - simply schedule probing and return
4165 * @ap: Port to probe
4166 *
4167 * For batch scheduling of probe for sas attached ata devices, assumes
4168 * the port has already been through ata_sas_port_init()
4169 */
4170void ata_sas_async_probe(struct ata_port *ap)
9508a66f 4171{
b2024459
DW		 4172 __ata_port_probe(ap);
4173}
4174EXPORT_SYMBOL_GPL(ata_sas_async_probe);
9508a66f 4175
b2024459
DW		 4176int ata_sas_sync_probe(struct ata_port *ap)
4177{
4178 return ata_port_probe(ap);
9508a66f 4179}
b2024459
DW		 4180EXPORT_SYMBOL_GPL(ata_sas_sync_probe);
4181
9508a66f 4182
80289167
BK		 4183/**
4184 * ata_sas_port_init - Initialize a SATA device
4185 * @ap: SATA port to initialize
4186 *
4187 * LOCKING:
4188 * PCI/etc. bus probe sem.
4189 *
4190 * RETURNS:
4191 * Zero on success, non-zero on error.
4192 */
4193
4194int ata_sas_port_init(struct ata_port *ap)
4195{
4196 int rc = ap->ops->port_start(ap);
4197
b2024459
DW		 4198 if (rc)
4199 return rc;
4200 ap->print_id = atomic_inc_return(&ata_print_id);
4201 return 0;
80289167
BK		 4202}
4203EXPORT_SYMBOL_GPL(ata_sas_port_init);
4204
4205/**
4206 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
4207 * @ap: SATA port to destroy
4208 *
4209 */
4210
4211void ata_sas_port_destroy(struct ata_port *ap)
4212{
f0d36efd
TH		 4213 if (ap->ops->port_stop)
4214 ap->ops->port_stop(ap);
80289167
BK		 4215 kfree(ap);
4216}
4217EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
4218
4219/**
4220 * ata_sas_slave_configure - Default slave_config routine for libata devices
4221 * @sdev: SCSI device to configure
4222 * @ap: ATA port to which SCSI device is attached
4223 *
4224 * RETURNS:
4225 * Zero.
4226 */
4227
4228int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
4229{
4230 ata_scsi_sdev_config(sdev);
9af5c9c9 4231 ata_scsi_dev_config(sdev, ap->link.device);
80289167
BK		 4232 return 0;
4233}
4234EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
4235
4236/**
4237 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
4238 * @cmd: SCSI command to be sent
80289167
BK		 4239 * @ap: ATA port to which the command is being sent
4240 *
4241 * RETURNS:
08475a19
BK		 4242 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4243 * 0 otherwise.
80289167
BK		 4244 */
4245
b27dcfb0 4246int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
80289167 4247{
08475a19
BK		 4248 int rc = 0;
4249
80289167
BK		 4250 ata_scsi_dump_cdb(ap, cmd);
4251
2486fa56 4252 if (likely(ata_dev_enabled(ap->link.device)))
b27dcfb0 4253 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
80289167
BK		 4254 else {
4255 cmd->result = (DID_BAD_TARGET << 16);
b27dcfb0 4256 cmd->scsi_done(cmd);
80289167 4257 }
08475a19 4258 return rc;
80289167
BK		 4259}
4260EXPORT_SYMBOL_GPL(ata_sas_queuecmd);
98bd4be1
SL		 4261
4262int ata_sas_allocate_tag(struct ata_port *ap)
4263{
4264 unsigned int max_queue = ap->host->n_tags;
4265 unsigned int i, tag;
4266
4267 for (i = 0, tag = ap->sas_last_tag + 1; i < max_queue; i++, tag++) {
3a028243 4268 tag = tag < max_queue ? tag : 0;
98bd4be1
SL		 4269
4270 /* the last tag is reserved for internal command. */
4271 if (tag == ATA_TAG_INTERNAL)
4272 continue;
4273
4274 if (!test_and_set_bit(tag, &ap->sas_tag_allocated)) {
4275 ap->sas_last_tag = tag;
4276 return tag;
4277 }
4278 }
4279 return -1;
4280}
4281
4282void ata_sas_free_tag(unsigned int tag, struct ata_port *ap)
4283{
4284 clear_bit(tag, &ap->sas_tag_allocated);
4285}
Linux 6.x block layer and io_uring tree(s)