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