blob: 1b84d5526d77a40ff5451e26c6d6b37cf26d94ef [file] [log] [blame]
Thomas Gleixnerc82ee6d2019-05-19 15:51:48 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04003 * libata-scsi.c - helper library for ATA
4 *
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04005 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
6 * Copyright 2003-2004 Jeff Garzik
7 *
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04008 * libata documentation is available via 'make {ps|pdf}docs',
Mauro Carvalho Chehab9bb9a392017-05-16 09:16:37 -03009 * as Documentation/driver-api/libata.rst
Jeff Garzikaf36d7f2005-08-28 20:18:39 -040010 *
11 * Hardware documentation available from
12 * - http://www.t10.org/
13 * - http://www.t13.org/
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 */
15
Arnd Bergmann75c0b0e2019-11-30 20:28:12 +010016#include <linux/compat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090017#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/kernel.h>
19#include <linux/blkdev.h>
20#include <linux/spinlock.h>
Paul Gortmaker38789fd2011-07-17 15:33:58 -040021#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <scsi/scsi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <scsi/scsi_host.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020024#include <scsi/scsi_cmnd.h>
Mike Christie85837eb2005-11-11 16:38:53 -060025#include <scsi/scsi_eh.h>
Jeff Garzik005a5a02005-10-30 23:31:48 -050026#include <scsi/scsi_device.h>
Tejun Heoa6e6ce82006-05-15 21:03:48 +090027#include <scsi/scsi_tcq.h>
Tejun Heo30afc842006-03-18 18:40:14 +090028#include <scsi/scsi_transport.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/libata.h>
Jeff Garzikb0955182005-05-12 15:45:22 -040030#include <linux/hdreg.h>
Jeff Garzik2dcb4072007-10-19 06:42:56 -040031#include <linux/uaccess.h>
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +010032#include <linux/suspend.h>
Christoph Hellwig18f0f972009-11-17 10:00:47 -050033#include <asm/unaligned.h>
Adam Manzanares8e061782016-10-17 11:27:29 -070034#include <linux/ioprio.h>
Linus Walleij45b80842020-02-22 12:20:57 +010035#include <linux/of.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37#include "libata.h"
Gwendal Grignoud9027472010-05-25 12:31:38 -070038#include "libata-transport.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Bartlomiej Zolnierkiewiczc8fa4f82020-03-26 16:58:03 +010040#define ATA_SCSI_RBUF_SIZE 576
Tejun Heo87340e92008-04-28 17:48:51 +090041
42static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
43static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
Jeff Garzikb0955182005-05-12 15:45:22 -040044
Tejun Heoad706992006-12-17 10:45:57 +090045typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
Tejun Heoab5b3a52006-05-31 18:27:34 +090046
Jeff Garzik2dcb4072007-10-19 06:42:56 -040047static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
Tejun Heoab5b3a52006-05-31 18:27:34 +090048 const struct scsi_device *scsidev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040050#define RW_RECOVERY_MPAGE 0x1
51#define RW_RECOVERY_MPAGE_LEN 12
52#define CACHE_MPAGE 0x8
53#define CACHE_MPAGE_LEN 20
54#define CONTROL_MPAGE 0xa
55#define CONTROL_MPAGE_LEN 12
56#define ALL_MPAGES 0x3f
57#define ALL_SUB_MPAGES 0xff
58
59
Jeff Garzik24f75682007-09-21 07:54:49 -040060static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040061 RW_RECOVERY_MPAGE,
62 RW_RECOVERY_MPAGE_LEN - 2,
Jeff Garzik24f75682007-09-21 07:54:49 -040063 (1 << 7), /* AWRE */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040064 0, /* read retry count */
65 0, 0, 0, 0,
66 0, /* write retry count */
67 0, 0, 0
68};
69
70static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
71 CACHE_MPAGE,
72 CACHE_MPAGE_LEN - 2,
73 0, /* contains WCE, needs to be 0 for logic */
74 0, 0, 0, 0, 0, 0, 0, 0, 0,
75 0, /* contains DRA, needs to be 0 for logic */
76 0, 0, 0, 0, 0, 0, 0
77};
78
79static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
80 CONTROL_MPAGE,
81 CONTROL_MPAGE_LEN - 2,
82 2, /* DSENSE=0, GLTSD=1 */
83 0, /* [QAM+QERR may be 1, see 05-359r1] */
84 0, 0, 0, 0, 0xff, 0xff,
85 0, 30 /* extended self test time, see 05-359r1 */
86};
87
Elias Oltmanns45fabbb2008-09-21 11:54:08 +020088static ssize_t ata_scsi_park_show(struct device *device,
89 struct device_attribute *attr, char *buf)
90{
91 struct scsi_device *sdev = to_scsi_device(device);
92 struct ata_port *ap;
93 struct ata_link *link;
94 struct ata_device *dev;
Tejun Heo3948b6f2016-02-18 11:50:37 -050095 unsigned long now;
Kees Cook3f649ab2020-06-03 13:09:38 -070096 unsigned int msecs;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +020097 int rc = 0;
98
99 ap = ata_shost_to_port(sdev->host);
100
Tejun Heo3948b6f2016-02-18 11:50:37 -0500101 spin_lock_irq(ap->lock);
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200102 dev = ata_scsi_find_dev(ap, sdev);
103 if (!dev) {
104 rc = -ENODEV;
105 goto unlock;
106 }
107 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
108 rc = -EOPNOTSUPP;
109 goto unlock;
110 }
111
112 link = dev->link;
Elias Oltmannsa4641892008-11-03 19:01:08 +0900113 now = jiffies;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200114 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
115 link->eh_context.unloaded_mask & (1 << dev->devno) &&
Elias Oltmannsa4641892008-11-03 19:01:08 +0900116 time_after(dev->unpark_deadline, now))
117 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200118 else
119 msecs = 0;
120
121unlock:
122 spin_unlock_irq(ap->lock);
123
124 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
125}
126
127static ssize_t ata_scsi_park_store(struct device *device,
128 struct device_attribute *attr,
129 const char *buf, size_t len)
130{
131 struct scsi_device *sdev = to_scsi_device(device);
132 struct ata_port *ap;
133 struct ata_device *dev;
134 long int input;
135 unsigned long flags;
136 int rc;
137
Jingoo Han42b9ab72013-07-19 15:56:41 +0900138 rc = kstrtol(buf, 10, &input);
139 if (rc)
140 return rc;
141 if (input < -2)
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200142 return -EINVAL;
143 if (input > ATA_TMOUT_MAX_PARK) {
144 rc = -EOVERFLOW;
145 input = ATA_TMOUT_MAX_PARK;
146 }
147
148 ap = ata_shost_to_port(sdev->host);
149
150 spin_lock_irqsave(ap->lock, flags);
151 dev = ata_scsi_find_dev(ap, sdev);
152 if (unlikely(!dev)) {
153 rc = -ENODEV;
154 goto unlock;
155 }
Hannes Reinecke9162c652014-11-05 13:08:21 +0100156 if (dev->class != ATA_DEV_ATA &&
157 dev->class != ATA_DEV_ZAC) {
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200158 rc = -EOPNOTSUPP;
159 goto unlock;
160 }
161
162 if (input >= 0) {
163 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
164 rc = -EOPNOTSUPP;
165 goto unlock;
166 }
167
168 dev->unpark_deadline = ata_deadline(jiffies, input);
169 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
170 ata_port_schedule_eh(ap);
171 complete(&ap->park_req_pending);
172 } else {
173 switch (input) {
174 case -1:
175 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
176 break;
177 case -2:
178 dev->flags |= ATA_DFLAG_NO_UNLOAD;
179 break;
180 }
181 }
182unlock:
183 spin_unlock_irqrestore(ap->lock, flags);
184
185 return rc ? rc : len;
186}
187DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
188 ata_scsi_park_show, ata_scsi_park_store);
189EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
190
Hannes Reinecke06dbde52016-04-04 11:44:03 +0200191void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
192 u8 sk, u8 asc, u8 ascq)
Tejun Heof0761be2008-04-28 17:16:52 +0900193{
Hannes Reinecke06dbde52016-04-04 11:44:03 +0200194 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
195
Hannes Reinecke5b01e4b2016-04-04 11:43:54 +0200196 if (!cmd)
197 return;
198
Hannes Reineckef2b1e9c2021-04-27 10:30:13 +0200199 scsi_build_sense(cmd, d_sense, sk, asc, ascq);
Tejun Heof0761be2008-04-28 17:16:52 +0900200}
201
Hannes Reinecke492bf622016-04-04 11:43:59 +0200202void ata_scsi_set_sense_information(struct ata_device *dev,
203 struct scsi_cmnd *cmd,
204 const struct ata_taskfile *tf)
205{
206 u64 information;
207
208 if (!cmd)
209 return;
210
211 information = ata_tf_read_block(tf, dev);
212 if (information == U64_MAX)
213 return;
214
215 scsi_set_sense_information(cmd->sense_buffer,
216 SCSI_SENSE_BUFFERSIZE, information);
217}
218
Hannes Reineckebcfc8672016-04-04 11:44:05 +0200219static void ata_scsi_set_invalid_field(struct ata_device *dev,
Hannes Reinecke0df10b82016-04-04 11:44:06 +0200220 struct scsi_cmnd *cmd, u16 field, u8 bit)
Hannes Reineckebcfc8672016-04-04 11:44:05 +0200221{
222 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
Tom Yan8554e5e2016-07-07 01:13:09 +0800223 /* "Invalid field in CDB" */
Hannes Reineckebcfc8672016-04-04 11:44:05 +0200224 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
Hannes Reinecke0df10b82016-04-04 11:44:06 +0200225 field, bit, 1);
Hannes Reineckebcfc8672016-04-04 11:44:05 +0200226}
227
Hannes Reinecke77800812016-04-04 11:44:07 +0200228static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
229 struct scsi_cmnd *cmd, u16 field)
230{
231 /* "Invalid field in parameter list" */
232 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
233 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
234 field, 0xff, 0);
Tony Jonesee959b02008-02-22 00:13:36 +0100235}
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400236
Bart Van Asschec3f69c72021-10-12 16:35:14 -0700237static struct attribute *ata_common_sdev_attrs[] = {
238 &dev_attr_unload_heads.attr,
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200239 NULL
240};
Bart Van Asschec3f69c72021-10-12 16:35:14 -0700241
242static const struct attribute_group ata_common_sdev_attr_group = {
243 .attrs = ata_common_sdev_attrs
244};
245
246const struct attribute_group *ata_common_sdev_groups[] = {
247 &ata_common_sdev_attr_group,
248 NULL
249};
250EXPORT_SYMBOL_GPL(ata_common_sdev_groups);
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252/**
253 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
254 * @sdev: SCSI device for which BIOS geometry is to be determined
255 * @bdev: block device associated with @sdev
256 * @capacity: capacity of SCSI device
257 * @geom: location to which geometry will be output
258 *
259 * Generic bios head/sector/cylinder calculator
260 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
261 * mapping. Some situations may arise where the disk is not
262 * bootable if this is not used.
263 *
264 * LOCKING:
265 * Defined by the SCSI layer. We don't really care.
266 *
267 * RETURNS:
268 * Zero.
269 */
270int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
271 sector_t capacity, int geom[])
272{
273 geom[0] = 255;
274 geom[1] = 63;
275 sector_div(capacity, 255*63);
276 geom[2] = capacity;
277
278 return 0;
279}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100280EXPORT_SYMBOL_GPL(ata_std_bios_param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Jeff Garzikb0955182005-05-12 15:45:22 -0400282/**
Tejun Heod8d91292010-05-15 20:09:34 +0200283 * ata_scsi_unlock_native_capacity - unlock native capacity
284 * @sdev: SCSI device to adjust device capacity for
285 *
286 * This function is called if a partition on @sdev extends beyond
287 * the end of the device. It requests EH to unlock HPA.
288 *
289 * LOCKING:
290 * Defined by the SCSI layer. Might sleep.
291 */
292void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
293{
294 struct ata_port *ap = ata_shost_to_port(sdev->host);
295 struct ata_device *dev;
296 unsigned long flags;
297
298 spin_lock_irqsave(ap->lock, flags);
299
300 dev = ata_scsi_find_dev(ap, sdev);
301 if (dev && dev->n_sectors < dev->n_native_sectors) {
302 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
303 dev->link->eh_info.action |= ATA_EH_RESET;
304 ata_port_schedule_eh(ap);
305 }
306
307 spin_unlock_irqrestore(ap->lock, flags);
308 ata_port_wait_eh(ap);
309}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100310EXPORT_SYMBOL_GPL(ata_scsi_unlock_native_capacity);
Tejun Heod8d91292010-05-15 20:09:34 +0200311
312/**
Tejun Heo5924b742007-01-02 20:20:07 +0900313 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
Randy Dunlap5eb66fe2009-01-20 16:28:59 -0800314 * @ap: target port
Tejun Heo5924b742007-01-02 20:20:07 +0900315 * @sdev: SCSI device to get identify data for
316 * @arg: User buffer area for identify data
317 *
318 * LOCKING:
319 * Defined by the SCSI layer. We don't really care.
320 *
321 * RETURNS:
322 * Zero on success, negative errno on error.
323 */
Jeff Garzik94be9a52009-01-16 10:17:09 -0500324static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
325 void __user *arg)
Tejun Heo5924b742007-01-02 20:20:07 +0900326{
Tejun Heo5924b742007-01-02 20:20:07 +0900327 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
328 u16 __user *dst = arg;
329 char buf[40];
330
331 if (!dev)
332 return -ENOMSG;
333
334 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
335 return -EFAULT;
336
337 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
338 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
339 return -EFAULT;
340
341 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
342 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
343 return -EFAULT;
344
345 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
346 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
347 return -EFAULT;
348
349 return 0;
350}
351
352/**
Jeff Garzikb0955182005-05-12 15:45:22 -0400353 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800354 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400355 * @arg: User provided data for issuing command
356 *
357 * LOCKING:
358 * Defined by the SCSI layer. We don't really care.
359 *
360 * RETURNS:
361 * Zero on success, negative errno on error.
362 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400363int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
364{
365 int rc = 0;
Kees Cook429296c2018-07-31 12:51:53 -0700366 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
Jeff Garzikb0955182005-05-12 15:45:22 -0400367 u8 scsi_cmd[MAX_COMMAND_SIZE];
Kees Cook429296c2018-07-31 12:51:53 -0700368 u8 args[4], *argbuf = NULL;
Jeff Garzikb0955182005-05-12 15:45:22 -0400369 int argsize = 0;
Mike Christie85837eb2005-11-11 16:38:53 -0600370 enum dma_data_direction data_dir;
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100371 struct scsi_sense_hdr sshdr;
Eran Tromerbbe1fe72006-10-10 14:29:25 -0700372 int cmd_result;
Jeff Garzikb0955182005-05-12 15:45:22 -0400373
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500374 if (arg == NULL)
Jeff Garzikb0955182005-05-12 15:45:22 -0400375 return -EINVAL;
376
377 if (copy_from_user(args, arg, sizeof(args)))
378 return -EFAULT;
379
Kees Cook429296c2018-07-31 12:51:53 -0700380 memset(sensebuf, 0, sizeof(sensebuf));
Jeff Garzikb0955182005-05-12 15:45:22 -0400381 memset(scsi_cmd, 0, sizeof(scsi_cmd));
382
383 if (args[3]) {
Grant Grundler295124d2010-08-17 10:56:53 -0700384 argsize = ATA_SECT_SIZE * args[3];
Jeff Garzikb0955182005-05-12 15:45:22 -0400385 argbuf = kmalloc(argsize, GFP_KERNEL);
Jeff Raubitschek54dac832005-10-04 10:21:19 -0400386 if (argbuf == NULL) {
387 rc = -ENOMEM;
388 goto error;
389 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400390
391 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
392 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400393 block count in sector count field */
Mike Christie85837eb2005-11-11 16:38:53 -0600394 data_dir = DMA_FROM_DEVICE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400395 } else {
396 scsi_cmd[1] = (3 << 1); /* Non-data */
Eran Tromerbbe1fe72006-10-10 14:29:25 -0700397 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
Mike Christie85837eb2005-11-11 16:38:53 -0600398 data_dir = DMA_NONE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400399 }
400
401 scsi_cmd[0] = ATA_16;
402
403 scsi_cmd[4] = args[2];
Bartlomiej Zolnierkiewicza4f19042008-10-10 22:39:20 +0200404 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
Jeff Garzikb0955182005-05-12 15:45:22 -0400405 scsi_cmd[6] = args[3];
406 scsi_cmd[8] = args[1];
Linus Walleijf355eec2018-08-30 11:06:36 +0200407 scsi_cmd[10] = ATA_SMART_LBAM_PASS;
408 scsi_cmd[12] = ATA_SMART_LBAH_PASS;
Jeff Garzikb0955182005-05-12 15:45:22 -0400409 } else {
410 scsi_cmd[6] = args[1];
411 }
412 scsi_cmd[14] = args[0];
413
414 /* Good values for timeout and retries? Values below
415 from scsi_ioctl_send_command() for default case... */
Eran Tromerbbe1fe72006-10-10 14:29:25 -0700416 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100417 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
Eran Tromerbbe1fe72006-10-10 14:29:25 -0700418
Hannes Reineckeced202f72021-04-27 10:30:12 +0200419 if (cmd_result < 0) {
420 rc = cmd_result;
421 goto error;
422 }
Hannes Reinecke464a00c2021-04-27 10:30:15 +0200423 if (scsi_sense_valid(&sshdr)) {/* sense data available */
Eran Tromerbbe1fe72006-10-10 14:29:25 -0700424 u8 *desc = sensebuf + 8;
Eran Tromerbbe1fe72006-10-10 14:29:25 -0700425
426 /* If we set cc then ATA pass-through will cause a
427 * check condition even if no error. Filter that. */
Hannes Reinecke464a00c2021-04-27 10:30:15 +0200428 if (scsi_status_is_check_condition(cmd_result)) {
Krzysztof Mazur6d3bfc72013-03-27 13:51:14 +0100429 if (sshdr.sense_key == RECOVERED_ERROR &&
430 sshdr.asc == 0 && sshdr.ascq == 0x1d)
Eran Tromerbbe1fe72006-10-10 14:29:25 -0700431 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
432 }
433
434 /* Send userspace a few ATA registers (same as drivers/ide) */
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400435 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
436 desc[0] == 0x09) { /* code is "ATA Descriptor" */
437 args[0] = desc[13]; /* status */
438 args[1] = desc[3]; /* error */
439 args[2] = desc[5]; /* sector count (0:7) */
Eran Tromerbbe1fe72006-10-10 14:29:25 -0700440 if (copy_to_user(arg, args, sizeof(args)))
441 rc = -EFAULT;
442 }
443 }
444
445
446 if (cmd_result) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400447 rc = -EIO;
448 goto error;
449 }
450
Jeff Garzikb0955182005-05-12 15:45:22 -0400451 if ((argbuf)
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500452 && copy_to_user(arg + sizeof(args), argbuf, argsize))
Jeff Garzikb0955182005-05-12 15:45:22 -0400453 rc = -EFAULT;
454error:
Jesper Juhl8f760782006-06-27 02:55:06 -0700455 kfree(argbuf);
Jeff Garzikb0955182005-05-12 15:45:22 -0400456 return rc;
457}
458
459/**
460 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800461 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400462 * @arg: User provided data for issuing command
463 *
464 * LOCKING:
465 * Defined by the SCSI layer. We don't really care.
466 *
467 * RETURNS:
468 * Zero on success, negative errno on error.
469 */
470int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
471{
472 int rc = 0;
Kees Cook429296c2018-07-31 12:51:53 -0700473 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
Jeff Garzikb0955182005-05-12 15:45:22 -0400474 u8 scsi_cmd[MAX_COMMAND_SIZE];
Kees Cook429296c2018-07-31 12:51:53 -0700475 u8 args[7];
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100476 struct scsi_sense_hdr sshdr;
David Milburnaf068bd2007-01-30 00:59:15 -0800477 int cmd_result;
Jeff Garzikb0955182005-05-12 15:45:22 -0400478
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500479 if (arg == NULL)
Jeff Garzikb0955182005-05-12 15:45:22 -0400480 return -EINVAL;
481
482 if (copy_from_user(args, arg, sizeof(args)))
483 return -EFAULT;
484
Kees Cook429296c2018-07-31 12:51:53 -0700485 memset(sensebuf, 0, sizeof(sensebuf));
Jeff Garzikb0955182005-05-12 15:45:22 -0400486 memset(scsi_cmd, 0, sizeof(scsi_cmd));
487 scsi_cmd[0] = ATA_16;
488 scsi_cmd[1] = (3 << 1); /* Non-data */
David Milburnaf068bd2007-01-30 00:59:15 -0800489 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
Jeff Garzikb0955182005-05-12 15:45:22 -0400490 scsi_cmd[4] = args[1];
491 scsi_cmd[6] = args[2];
492 scsi_cmd[8] = args[3];
493 scsi_cmd[10] = args[4];
494 scsi_cmd[12] = args[5];
Mark Lord277239f2007-03-30 17:45:52 -0400495 scsi_cmd[13] = args[6] & 0x4f;
Jeff Garzikb0955182005-05-12 15:45:22 -0400496 scsi_cmd[14] = args[0];
497
Jeff Garzikb0955182005-05-12 15:45:22 -0400498 /* Good values for timeout and retries? Values below
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500499 from scsi_ioctl_send_command() for default case... */
David Milburnaf068bd2007-01-30 00:59:15 -0800500 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100501 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
Jeff Garzikb0955182005-05-12 15:45:22 -0400502
Hannes Reineckeced202f72021-04-27 10:30:12 +0200503 if (cmd_result < 0) {
504 rc = cmd_result;
505 goto error;
506 }
Hannes Reinecke464a00c2021-04-27 10:30:15 +0200507 if (scsi_sense_valid(&sshdr)) {/* sense data available */
David Milburnaf068bd2007-01-30 00:59:15 -0800508 u8 *desc = sensebuf + 8;
David Milburnaf068bd2007-01-30 00:59:15 -0800509
510 /* If we set cc then ATA pass-through will cause a
511 * check condition even if no error. Filter that. */
512 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
Krzysztof Mazur6d3bfc72013-03-27 13:51:14 +0100513 if (sshdr.sense_key == RECOVERED_ERROR &&
514 sshdr.asc == 0 && sshdr.ascq == 0x1d)
David Milburnaf068bd2007-01-30 00:59:15 -0800515 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
516 }
517
518 /* Send userspace ATA registers */
519 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
520 desc[0] == 0x09) {/* code is "ATA Descriptor" */
521 args[0] = desc[13]; /* status */
522 args[1] = desc[3]; /* error */
523 args[2] = desc[5]; /* sector count (0:7) */
524 args[3] = desc[7]; /* lbal */
525 args[4] = desc[9]; /* lbam */
526 args[5] = desc[11]; /* lbah */
527 args[6] = desc[12]; /* select */
528 if (copy_to_user(arg, args, sizeof(args)))
529 rc = -EFAULT;
530 }
531 }
532
533 if (cmd_result) {
534 rc = -EIO;
535 goto error;
536 }
537
538 error:
Jeff Garzikb0955182005-05-12 15:45:22 -0400539 return rc;
540}
541
Alan Coxe3cf95d2009-04-09 17:31:17 +0100542static int ata_ioc32(struct ata_port *ap)
543{
544 if (ap->flags & ATA_FLAG_PIO_DMA)
545 return 1;
546 if (ap->pflags & ATA_PFLAG_PIO32)
547 return 1;
548 return 0;
549}
550
Arnd Bergmann75c0b0e2019-11-30 20:28:12 +0100551/*
552 * This handles both native and compat commands, so anything added
553 * here must have a compatible argument, or check in_compat_syscall()
554 */
Jeff Garzik94be9a52009-01-16 10:17:09 -0500555int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
Nathan Chancellor6f4e6262019-02-07 09:07:20 -0700556 unsigned int cmd, void __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557{
Arnd Bergmann287e6612016-02-11 14:16:27 +0100558 unsigned long val;
559 int rc = -EINVAL;
Alan Coxe3cf95d2009-04-09 17:31:17 +0100560 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 switch (cmd) {
Arnd Bergmann287e6612016-02-11 14:16:27 +0100563 case HDIO_GET_32BIT:
Alan Coxe3cf95d2009-04-09 17:31:17 +0100564 spin_lock_irqsave(ap->lock, flags);
565 val = ata_ioc32(ap);
566 spin_unlock_irqrestore(ap->lock, flags);
Arnd Bergmann75c0b0e2019-11-30 20:28:12 +0100567#ifdef CONFIG_COMPAT
568 if (in_compat_syscall())
569 return put_user(val, (compat_ulong_t __user *)arg);
570#endif
Arnd Bergmann287e6612016-02-11 14:16:27 +0100571 return put_user(val, (unsigned long __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Arnd Bergmann287e6612016-02-11 14:16:27 +0100573 case HDIO_SET_32BIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 val = (unsigned long) arg;
Alan Coxe3cf95d2009-04-09 17:31:17 +0100575 rc = 0;
576 spin_lock_irqsave(ap->lock, flags);
577 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
578 if (val)
579 ap->pflags |= ATA_PFLAG_PIO32;
580 else
581 ap->pflags &= ~ATA_PFLAG_PIO32;
582 } else {
583 if (val != ata_ioc32(ap))
584 rc = -EINVAL;
585 }
586 spin_unlock_irqrestore(ap->lock, flags);
587 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Tejun Heo5924b742007-01-02 20:20:07 +0900589 case HDIO_GET_IDENTITY:
Jeff Garzik94be9a52009-01-16 10:17:09 -0500590 return ata_get_identity(ap, scsidev, arg);
Tejun Heo5924b742007-01-02 20:20:07 +0900591
Jeff Garzikb0955182005-05-12 15:45:22 -0400592 case HDIO_DRIVE_CMD:
593 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
594 return -EACCES;
595 return ata_cmd_ioctl(scsidev, arg);
596
597 case HDIO_DRIVE_TASK:
598 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
599 return -EACCES;
600 return ata_task_ioctl(scsidev, arg);
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 default:
603 rc = -ENOTTY;
604 break;
605 }
606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 return rc;
608}
Jeff Garzik94be9a52009-01-16 10:17:09 -0500609EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
610
Nathan Chancellor6f4e6262019-02-07 09:07:20 -0700611int ata_scsi_ioctl(struct scsi_device *scsidev, unsigned int cmd,
612 void __user *arg)
Jeff Garzik94be9a52009-01-16 10:17:09 -0500613{
614 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
615 scsidev, cmd, arg);
616}
617EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619/**
620 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 * @dev: ATA device to which the new command is attached
622 * @cmd: SCSI command that originated this ATA command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 *
624 * Obtain a reference to an unused ata_queued_cmd structure,
625 * which is the basic libata structure representing a single
626 * ATA command sent to the hardware.
627 *
628 * If a command was available, fill in the SCSI-specific
629 * portions of the structure with information on the
630 * current command.
631 *
632 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -0400633 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 *
635 * RETURNS:
636 * Command allocated, or %NULL if none available.
637 */
Adrian Bunk7102d232007-01-04 00:09:36 +0100638static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
Jeff Garzikb27dcfb2010-11-17 22:56:48 -0500639 struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
641 struct ata_queued_cmd *qc;
642
Bart Van Asschec8329cd2021-08-09 16:03:10 -0700643 qc = ata_qc_new_init(dev, scsi_cmd_to_rq(cmd)->tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 if (qc) {
645 qc->scsicmd = cmd;
Bart Van Assche58bf2012021-10-07 13:27:58 -0700646 qc->scsidone = scsi_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Tejun Heoff2aeb12007-12-05 16:43:11 +0900648 qc->sg = scsi_sglist(cmd);
Boaz Harrosh71201652007-09-18 17:48:50 +0200649 qc->n_elem = scsi_sg_count(cmd);
Damien Le Moal7eb49502018-05-09 09:28:11 +0900650
Bart Van Asschec8329cd2021-08-09 16:03:10 -0700651 if (scsi_cmd_to_rq(cmd)->rq_flags & RQF_QUIET)
Damien Le Moal7eb49502018-05-09 09:28:11 +0900652 qc->flags |= ATA_QCFLAG_QUIET;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 } else {
Hannes Reinecke3d45cefc2021-04-27 10:30:46 +0200654 cmd->result = (DID_OK << 16) | SAM_STAT_TASK_SET_FULL;
Bart Van Assche58bf2012021-10-07 13:27:58 -0700655 scsi_done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 }
657
658 return qc;
659}
660
Tejun Heoaacda372008-03-18 17:47:43 +0900661static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
662{
663 struct scsi_cmnd *scmd = qc->scsicmd;
664
Christoph Hellwigbdf87102020-04-14 09:42:25 +0200665 qc->extrabytes = scmd->extra_len;
Tejun Heoaacda372008-03-18 17:47:43 +0900666 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
667}
668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669/**
Jeff Garzikb0955182005-05-12 15:45:22 -0400670 * ata_dump_status - user friendly display of error info
671 * @id: id of the port in question
672 * @tf: ptr to filled out taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 *
Jeff Garzikb0955182005-05-12 15:45:22 -0400674 * Decode and dump the ATA error/status registers for the user so
675 * that they have some idea what really happened at the non
676 * make-believe layer.
677 *
678 * LOCKING:
679 * inherited from caller
680 */
Adrian Bunk7102d232007-01-04 00:09:36 +0100681static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
Jeff Garzikb0955182005-05-12 15:45:22 -0400682{
683 u8 stat = tf->command, err = tf->feature;
684
Joe Perches6ef56322017-06-12 12:17:39 -0700685 pr_warn("ata%u: status=0x%02x { ", id, stat);
Jeff Garzikb0955182005-05-12 15:45:22 -0400686 if (stat & ATA_BUSY) {
Joe Perches6ef56322017-06-12 12:17:39 -0700687 pr_cont("Busy }\n"); /* Data is not valid in this case */
Jeff Garzikb0955182005-05-12 15:45:22 -0400688 } else {
Joe Perches6ef56322017-06-12 12:17:39 -0700689 if (stat & ATA_DRDY) pr_cont("DriveReady ");
690 if (stat & ATA_DF) pr_cont("DeviceFault ");
691 if (stat & ATA_DSC) pr_cont("SeekComplete ");
692 if (stat & ATA_DRQ) pr_cont("DataRequest ");
693 if (stat & ATA_CORR) pr_cont("CorrectedError ");
694 if (stat & ATA_SENSE) pr_cont("Sense ");
695 if (stat & ATA_ERR) pr_cont("Error ");
696 pr_cont("}\n");
Jeff Garzikb0955182005-05-12 15:45:22 -0400697
698 if (err) {
Joe Perches6ef56322017-06-12 12:17:39 -0700699 pr_warn("ata%u: error=0x%02x { ", id, err);
700 if (err & ATA_ABORTED) pr_cont("DriveStatusError ");
Hannes Reinecke1308d7f2015-03-27 16:46:34 +0100701 if (err & ATA_ICRC) {
702 if (err & ATA_ABORTED)
Joe Perches6ef56322017-06-12 12:17:39 -0700703 pr_cont("BadCRC ");
704 else pr_cont("Sector ");
Jeff Garzikb0955182005-05-12 15:45:22 -0400705 }
Joe Perches6ef56322017-06-12 12:17:39 -0700706 if (err & ATA_UNC) pr_cont("UncorrectableError ");
707 if (err & ATA_IDNF) pr_cont("SectorIdNotFound ");
708 if (err & ATA_TRK0NF) pr_cont("TrackZeroNotFound ");
709 if (err & ATA_AMNF) pr_cont("AddrMarkNotFound ");
710 pr_cont("}\n");
Jeff Garzikb0955182005-05-12 15:45:22 -0400711 }
712 }
713}
714
715/**
716 * ata_to_sense_error - convert ATA error to SCSI error
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800717 * @id: ATA device number
Jeff Garzikb0955182005-05-12 15:45:22 -0400718 * @drv_stat: value contained in ATA status register
719 * @drv_err: value contained in ATA error register
720 * @sk: the sense key we'll fill out
721 * @asc: the additional sense code we'll fill out
722 * @ascq: the additional sense code qualifier we'll fill out
Tejun Heo246619d2006-05-15 20:58:16 +0900723 * @verbose: be verbose
Jeff Garzikb0955182005-05-12 15:45:22 -0400724 *
725 * Converts an ATA error into a SCSI error. Fill out pointers to
726 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
727 * format sense blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 *
729 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -0400730 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 */
Adrian Bunk7102d232007-01-04 00:09:36 +0100732static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
733 u8 *asc, u8 *ascq, int verbose)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
Jeff Garzikb0955182005-05-12 15:45:22 -0400735 int i;
Jeff Garzikffe75ef2005-10-09 10:40:44 -0400736
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 /* Based on the 3ware driver translation table */
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100738 static const unsigned char sense_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 /* BBD|ECC|ID|MAR */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100740 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
741 // Device busy Aborted command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 /* BBD|ECC|ID */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100743 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
744 // Device busy Aborted command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 /* ECC|MC|MARK */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100746 {0x61, HARDWARE_ERROR, 0x00, 0x00},
747 // Device fault Hardware error
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100749 {0x84, ABORTED_COMMAND, 0x47, 0x00},
750 // Data CRC error SCSI parity error
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 /* MC|ID|ABRT|TRK0|MARK */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100752 {0x37, NOT_READY, 0x04, 0x00},
753 // Unit offline Not ready
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 /* MCR|MARK */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100755 {0x09, NOT_READY, 0x04, 0x00},
756 // Unrecovered disk error Not ready
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 /* Bad address mark */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100758 {0x01, MEDIUM_ERROR, 0x13, 0x00},
759 // Address mark not found for data field
760 /* TRK0 - Track 0 not found */
761 {0x02, HARDWARE_ERROR, 0x00, 0x00},
762 // Hardware error
Gwendal Grignou78062c52013-06-18 10:54:48 -0700763 /* Abort: 0x04 is not translated here, see below */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 /* Media change request */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100765 {0x08, NOT_READY, 0x04, 0x00},
766 // FIXME: faking offline
767 /* SRV/IDNF - ID not found */
768 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
769 // Logical address out of range
770 /* MC - Media Changed */
771 {0x20, UNIT_ATTENTION, 0x28, 0x00},
772 // Not ready to ready change, medium may have changed
773 /* ECC - Uncorrectable ECC error */
774 {0x40, MEDIUM_ERROR, 0x11, 0x04},
775 // Unrecovered read error
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 /* BBD - block marked bad */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100777 {0x80, MEDIUM_ERROR, 0x11, 0x04},
778 // Block marked bad Medium error, unrecovered read error
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
780 };
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100781 static const unsigned char stat_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 /* Must be first because BUSY means no other bits valid */
Hannes Reinecke8ae72042015-03-27 16:46:32 +0100783 {0x80, ABORTED_COMMAND, 0x47, 0x00},
784 // Busy, fake parity for now
785 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
786 // Device ready, unaligned write command
787 {0x20, HARDWARE_ERROR, 0x44, 0x00},
788 // Device fault, internal target failure
789 {0x08, ABORTED_COMMAND, 0x47, 0x00},
790 // Timed out in xfer, fake parity for now
791 {0x04, RECOVERED_ERROR, 0x11, 0x00},
792 // Recovered ECC error Medium error, recovered
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
794 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 /*
797 * Is this an error we can process/parse
798 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400799 if (drv_stat & ATA_BUSY) {
800 drv_err = 0; /* Ignore the err bits, they're invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Jeff Garzikb0955182005-05-12 15:45:22 -0400803 if (drv_err) {
804 /* Look for drv_err */
805 for (i = 0; sense_table[i][0] != 0xFF; i++) {
806 /* Look for best matches first */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500807 if ((sense_table[i][0] & drv_err) ==
Jeff Garzikb0955182005-05-12 15:45:22 -0400808 sense_table[i][0]) {
809 *sk = sense_table[i][1];
810 *asc = sense_table[i][2];
811 *ascq = sense_table[i][3];
812 goto translate_done;
813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 }
816
Gwendal Grignou78062c52013-06-18 10:54:48 -0700817 /*
818 * Fall back to interpreting status bits. Note that if the drv_err
819 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
820 * is not descriptive enough.
821 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400822 for (i = 0; stat_table[i][0] != 0xFF; i++) {
823 if (stat_table[i][0] & drv_stat) {
824 *sk = stat_table[i][1];
825 *asc = stat_table[i][2];
826 *ascq = stat_table[i][3];
827 goto translate_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Gwendal Grignou78062c52013-06-18 10:54:48 -0700831 /*
832 * We need a sensible error return here, which is tricky, and one
833 * that won't cause people to do things like return a disk wrongly.
834 */
Alan Cox2d202022006-03-21 15:53:46 +0000835 *sk = ABORTED_COMMAND;
836 *asc = 0x00;
837 *ascq = 0x00;
Jeff Garzikb0955182005-05-12 15:45:22 -0400838
839 translate_done:
Tejun Heo246619d2006-05-15 20:58:16 +0900840 if (verbose)
Joe Perches6ef56322017-06-12 12:17:39 -0700841 pr_err("ata%u: translated ATA stat/err 0x%02x/%02x to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
Tejun Heo246619d2006-05-15 20:58:16 +0900842 id, drv_stat, drv_err, *sk, *asc, *ascq);
Jeff Garzikb0955182005-05-12 15:45:22 -0400843 return;
844}
845
846/*
Tejun Heo750426a2006-11-14 22:37:35 +0900847 * ata_gen_passthru_sense - Generate check condition sense block.
Jeff Garzikb0955182005-05-12 15:45:22 -0400848 * @qc: Command that completed.
849 *
850 * This function is specific to the ATA descriptor format sense
851 * block specified for the ATA pass through commands. Regardless
852 * of whether the command errored or not, return a sense
853 * block. Copy all controller registers into the sense
Gwendal Grignou84a9a8c2013-01-18 10:56:43 -0800854 * block. If there was no error, we get the request from an ATA
855 * passthrough command, so we use the following sense data:
856 * sk = RECOVERED ERROR
857 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
858 *
Jeff Garzikb0955182005-05-12 15:45:22 -0400859 *
860 * LOCKING:
Tejun Heo750426a2006-11-14 22:37:35 +0900861 * None.
Jeff Garzikb0955182005-05-12 15:45:22 -0400862 */
Tejun Heo750426a2006-11-14 22:37:35 +0900863static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
Jeff Garzikb0955182005-05-12 15:45:22 -0400864{
865 struct scsi_cmnd *cmd = qc->scsicmd;
Tejun Heoe61e0672006-05-15 20:57:40 +0900866 struct ata_taskfile *tf = &qc->result_tf;
Jeff Garzikb0955182005-05-12 15:45:22 -0400867 unsigned char *sb = cmd->sense_buffer;
868 unsigned char *desc = sb + 8;
Tejun Heo246619d2006-05-15 20:58:16 +0900869 int verbose = qc->ap->ops->error_handler == NULL;
Hannes Reineckeb525e772016-04-04 11:44:00 +0200870 u8 sense_key, asc, ascq;
Jeff Garzikb0955182005-05-12 15:45:22 -0400871
872 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
873
Jeff Garzikb0955182005-05-12 15:45:22 -0400874 /*
Jeff Garzikb0955182005-05-12 15:45:22 -0400875 * Use ata_to_sense_error() to map status register bits
876 * onto sense key, asc & ascq.
877 */
Tejun Heo058e55e2006-04-02 18:51:53 +0900878 if (qc->err_mask ||
879 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Tejun Heo44877b42007-02-21 01:06:51 +0900880 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
Hannes Reineckeb525e772016-04-04 11:44:00 +0200881 &sense_key, &asc, &ascq, verbose);
Hannes Reinecke06dbde52016-04-04 11:44:03 +0200882 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
Gwendal Grignou84a9a8c2013-01-18 10:56:43 -0800883 } else {
Hannes Reinecke11093cb2016-04-04 11:44:02 +0200884 /*
885 * ATA PASS-THROUGH INFORMATION AVAILABLE
886 * Always in descriptor format sense.
887 */
Hannes Reineckef2b1e9c2021-04-27 10:30:13 +0200888 scsi_build_sense(cmd, 1, RECOVERED_ERROR, 0, 0x1D);
Jeff Garzikb0955182005-05-12 15:45:22 -0400889 }
890
Hannes Reinecke11093cb2016-04-04 11:44:02 +0200891 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
892 u8 len;
Jeff Garzikb0955182005-05-12 15:45:22 -0400893
Hannes Reinecke11093cb2016-04-04 11:44:02 +0200894 /* descriptor format */
895 len = sb[7];
896 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
897 if (!desc) {
898 if (SCSI_SENSE_BUFFERSIZE < len + 14)
899 return;
900 sb[7] = len + 14;
901 desc = sb + 8 + len;
902 }
903 desc[0] = 9;
904 desc[1] = 12;
905 /*
906 * Copy registers into sense buffer.
907 */
908 desc[2] = 0x00;
909 desc[3] = tf->feature; /* == error reg */
910 desc[5] = tf->nsect;
911 desc[7] = tf->lbal;
912 desc[9] = tf->lbam;
913 desc[11] = tf->lbah;
914 desc[12] = tf->device;
915 desc[13] = tf->command; /* == status reg */
Jeff Garzikb0955182005-05-12 15:45:22 -0400916
Hannes Reinecke11093cb2016-04-04 11:44:02 +0200917 /*
918 * Fill in Extend bit, and the high order bytes
919 * if applicable.
920 */
921 if (tf->flags & ATA_TFLAG_LBA48) {
922 desc[2] |= 0x01;
923 desc[4] = tf->hob_nsect;
924 desc[6] = tf->hob_lbal;
925 desc[8] = tf->hob_lbam;
926 desc[10] = tf->hob_lbah;
927 }
928 } else {
929 /* Fixed sense format */
930 desc[0] = tf->feature;
931 desc[1] = tf->command; /* status */
932 desc[2] = tf->device;
933 desc[3] = tf->nsect;
Hannes Reineckee0029dc2016-10-31 21:06:58 +0100934 desc[7] = 0;
Hannes Reinecke11093cb2016-04-04 11:44:02 +0200935 if (tf->flags & ATA_TFLAG_LBA48) {
936 desc[8] |= 0x80;
937 if (tf->hob_nsect)
938 desc[8] |= 0x40;
939 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
940 desc[8] |= 0x20;
941 }
942 desc[9] = tf->lbal;
943 desc[10] = tf->lbam;
944 desc[11] = tf->lbah;
Jeff Garzikb0955182005-05-12 15:45:22 -0400945 }
946}
947
948/**
Tejun Heo750426a2006-11-14 22:37:35 +0900949 * ata_gen_ata_sense - generate a SCSI fixed sense block
Jeff Garzikb0955182005-05-12 15:45:22 -0400950 * @qc: Command that we are erroring out
951 *
Tejun Heod25614b2006-11-14 22:37:35 +0900952 * Generate sense block for a failed ATA command @qc. Descriptor
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300953 * format is used to accommodate LBA48 block address.
Jeff Garzikb0955182005-05-12 15:45:22 -0400954 *
955 * LOCKING:
Tejun Heo750426a2006-11-14 22:37:35 +0900956 * None.
Jeff Garzikb0955182005-05-12 15:45:22 -0400957 */
Tejun Heo750426a2006-11-14 22:37:35 +0900958static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
Jeff Garzikb0955182005-05-12 15:45:22 -0400959{
Tejun Heod25614b2006-11-14 22:37:35 +0900960 struct ata_device *dev = qc->dev;
Jeff Garzikb0955182005-05-12 15:45:22 -0400961 struct scsi_cmnd *cmd = qc->scsicmd;
Tejun Heoe61e0672006-05-15 20:57:40 +0900962 struct ata_taskfile *tf = &qc->result_tf;
Jeff Garzikb0955182005-05-12 15:45:22 -0400963 unsigned char *sb = cmd->sense_buffer;
Tejun Heo246619d2006-05-15 20:58:16 +0900964 int verbose = qc->ap->ops->error_handler == NULL;
Tejun Heod25614b2006-11-14 22:37:35 +0900965 u64 block;
Hannes Reineckeb525e772016-04-04 11:44:00 +0200966 u8 sense_key, asc, ascq;
Jeff Garzikb0955182005-05-12 15:45:22 -0400967
968 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
969
Hannes Reinecke59f68472016-04-25 12:45:50 +0200970 if (ata_dev_disabled(dev)) {
971 /* Device disabled after error recovery */
972 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
973 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
974 return;
975 }
Tejun Heod25614b2006-11-14 22:37:35 +0900976 /* Use ata_to_sense_error() to map status register bits
Jeff Garzikb0955182005-05-12 15:45:22 -0400977 * onto sense key, asc & ascq.
978 */
Tejun Heo058e55e2006-04-02 18:51:53 +0900979 if (qc->err_mask ||
980 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Tejun Heo44877b42007-02-21 01:06:51 +0900981 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
Hannes Reineckeb525e772016-04-04 11:44:00 +0200982 &sense_key, &asc, &ascq, verbose);
Hannes Reinecke06dbde52016-04-04 11:44:03 +0200983 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
Hannes Reinecke5e6acd12016-04-04 11:43:56 +0200984 } else {
985 /* Could not decode error */
986 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
987 tf->command, qc->err_mask);
Hannes Reinecke06dbde52016-04-04 11:44:03 +0200988 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
Hannes Reinecke5e6acd12016-04-04 11:43:56 +0200989 return;
Jeff Garzikb0955182005-05-12 15:45:22 -0400990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Tejun Heod25614b2006-11-14 22:37:35 +0900992 block = ata_tf_read_block(&qc->result_tf, dev);
Hannes Reineckecffd1ee2016-04-04 11:43:57 +0200993 if (block == U64_MAX)
994 return;
Jeff Garzik0274aa22005-06-22 13:50:56 -0400995
Hannes Reineckecf8b49b2016-04-04 11:43:58 +0200996 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997}
998
Bartlomiej Zolnierkiewicz15964ff2020-03-26 16:58:19 +0100999void ata_scsi_sdev_config(struct scsi_device *sdev)
Brian Kinga6cce2a2006-03-17 17:04:15 -06001000{
1001 sdev->use_10_for_rw = 1;
1002 sdev->use_10_for_ms = 1;
Nicolai Stangee1859342016-12-07 22:21:33 +01001003 sdev->no_write_same = 1;
Tejun Heo31cc23b2007-09-23 13:14:12 +09001004
1005 /* Schedule policy is determined by ->qc_defer() callback and
1006 * it needs to see every deferred qc. Set dev_blocked to 1 to
1007 * prevent SCSI midlayer from automatically deferring
1008 * requests.
1009 */
1010 sdev->max_device_blocked = 1;
Brian Kinga6cce2a2006-03-17 17:04:15 -06001011}
1012
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001013/**
Mauro Carvalho Chehab94bd5712020-10-23 18:32:55 +02001014 * ata_scsi_dma_need_drain - Check whether data transfer may overflow
Randy Dunlap73fd8b62008-02-19 13:43:21 -08001015 * @rq: request to be checked
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001016 *
1017 * ATAPI commands which transfer variable length data to host
Masanari Iidac9b55602016-04-13 23:36:27 +09001018 * might overflow due to application error or hardware bug. This
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001019 * function checks whether overflow should be drained and ignored
1020 * for @request.
1021 *
1022 * LOCKING:
1023 * None.
1024 *
1025 * RETURNS:
1026 * 1 if ; otherwise, 0.
1027 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001028bool ata_scsi_dma_need_drain(struct request *rq)
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001029{
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001030 return atapi_cmd_type(scsi_req(rq)->cmd[0]) == ATAPI_MISC;
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001031}
Christoph Hellwigcc979232020-04-14 09:42:24 +02001032EXPORT_SYMBOL_GPL(ata_scsi_dma_need_drain);
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001033
Bartlomiej Zolnierkiewicz15964ff2020-03-26 16:58:19 +01001034int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev)
Brian Kinga6cce2a2006-03-17 17:04:15 -06001035{
shaohua.li@intel.com900e5992011-05-06 11:35:31 -06001036 struct request_queue *q = sdev->request_queue;
1037
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001038 if (!ata_id_has_unload(dev->id))
1039 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1040
Tejun Heo914ed352006-11-01 18:39:55 +09001041 /* configure max sectors */
shaohua.li@intel.com900e5992011-05-06 11:35:31 -06001042 blk_queue_max_hw_sectors(q, dev->max_sectors);
Brian Kinga6cce2a2006-03-17 17:04:15 -06001043
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001044 if (dev->class == ATA_DEV_ATAPI) {
Tejun Heo729a6a32011-01-20 13:59:06 +01001045 sdev->sector_size = ATA_SECT_SIZE;
1046
1047 /* set DMA padding */
shaohua.li@intel.com900e5992011-05-06 11:35:31 -06001048 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001049
Christoph Hellwigcc979232020-04-14 09:42:24 +02001050 /* make room for appending the drain */
1051 blk_queue_max_segments(q, queue_max_segments(q) - 1);
1052
1053 sdev->dma_drain_len = ATAPI_MAX_DRAIN;
Christoph Hellwigce288e02021-03-31 09:29:59 +02001054 sdev->dma_drain_buf = kmalloc(sdev->dma_drain_len, GFP_NOIO);
Christoph Hellwigcc979232020-04-14 09:42:24 +02001055 if (!sdev->dma_drain_buf) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07001056 ata_dev_err(dev, "drain buffer allocation failed\n");
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001057 return -ENOMEM;
1058 }
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001059 } else {
Grant Grundler295124d2010-08-17 10:56:53 -07001060 sdev->sector_size = ata_id_logical_sector_size(dev->id);
Tejun Heod8cf5382008-01-15 08:46:59 +09001061 sdev->manage_start_stop = 1;
James Bottomleydde20202008-02-19 11:36:56 +01001062 }
Tejun Heod8cf5382008-01-15 08:46:59 +09001063
Tejun Heo729a6a32011-01-20 13:59:06 +01001064 /*
1065 * ata_pio_sectors() expects buffer for each sector to not cross
1066 * page boundary. Enforce it by requiring buffers to be sector
1067 * aligned, which works iff sector_size is not larger than
1068 * PAGE_SIZE. ATAPI devices also need the alignment as
1069 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1070 */
1071 if (sdev->sector_size > PAGE_SIZE)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001072 ata_dev_warn(dev,
Tejun Heo729a6a32011-01-20 13:59:06 +01001073 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1074 sdev->sector_size);
1075
shaohua.li@intel.com900e5992011-05-06 11:35:31 -06001076 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
Tejun Heo729a6a32011-01-20 13:59:06 +01001077
Jeff Garzikf26792d2007-10-29 17:18:39 -04001078 if (dev->flags & ATA_DFLAG_AN)
1079 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1080
Tejun Heoa6e6ce82006-05-15 21:03:48 +09001081 if (dev->flags & ATA_DFLAG_NCQ) {
1082 int depth;
1083
1084 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
Jens Axboe69278f72018-05-11 12:51:10 -06001085 depth = min(ATA_MAX_QUEUE, depth);
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001086 scsi_change_queue_depth(sdev, depth);
Tejun Heoa6e6ce82006-05-15 21:03:48 +09001087 }
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001088
Christoph Hellwigd80210f2017-06-19 14:26:46 +02001089 if (dev->flags & ATA_DFLAG_TRUSTED)
1090 sdev->security_supported = 1;
1091
Grant Grundler295124d2010-08-17 10:56:53 -07001092 dev->sdev = sdev;
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001093 return 0;
Brian Kinga6cce2a2006-03-17 17:04:15 -06001094}
1095
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096/**
1097 * ata_scsi_slave_config - Set SCSI device attributes
1098 * @sdev: SCSI device to examine
1099 *
1100 * This is called before we actually start reading
1101 * and writing to the device, to configure certain
1102 * SCSI mid-layer behaviors.
1103 *
1104 * LOCKING:
1105 * Defined by SCSI layer. We don't really care.
1106 */
1107
1108int ata_scsi_slave_config(struct scsi_device *sdev)
1109{
Tejun Heo31534362006-05-31 18:27:36 +09001110 struct ata_port *ap = ata_shost_to_port(sdev->host);
1111 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001112 int rc = 0;
Tejun Heo31534362006-05-31 18:27:36 +09001113
Brian Kinga6cce2a2006-03-17 17:04:15 -06001114 ata_scsi_sdev_config(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115
Tejun Heo31534362006-05-31 18:27:36 +09001116 if (dev)
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001117 rc = ata_scsi_dev_config(sdev, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001119 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01001121EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122
1123/**
Tejun Heo83c47bc2006-05-31 18:28:07 +09001124 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1125 * @sdev: SCSI device to be destroyed
1126 *
1127 * @sdev is about to be destroyed for hot/warm unplugging. If
1128 * this unplugging was initiated by libata as indicated by NULL
1129 * dev->sdev, this function doesn't have to do anything.
1130 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1131 * Clear dev->sdev, schedule the device for ATA detach and invoke
1132 * EH.
1133 *
1134 * LOCKING:
1135 * Defined by SCSI layer. We don't really care.
1136 */
1137void ata_scsi_slave_destroy(struct scsi_device *sdev)
1138{
1139 struct ata_port *ap = ata_shost_to_port(sdev->host);
1140 unsigned long flags;
1141 struct ata_device *dev;
1142
1143 if (!ap->ops->error_handler)
1144 return;
1145
Jeff Garzikba6a1302006-06-22 23:46:10 -04001146 spin_lock_irqsave(ap->lock, flags);
Tejun Heo83c47bc2006-05-31 18:28:07 +09001147 dev = __ata_scsi_find_dev(ap, sdev);
1148 if (dev && dev->sdev) {
1149 /* SCSI device already in CANCEL state, no need to offline it */
1150 dev->sdev = NULL;
1151 dev->flags |= ATA_DFLAG_DETACH;
1152 ata_port_schedule_eh(ap);
1153 }
Jeff Garzikba6a1302006-06-22 23:46:10 -04001154 spin_unlock_irqrestore(ap->lock, flags);
James Bottomleyfa2fc7f2008-02-19 11:36:57 +01001155
Christoph Hellwigcc979232020-04-14 09:42:24 +02001156 kfree(sdev->dma_drain_buf);
Tejun Heo83c47bc2006-05-31 18:28:07 +09001157}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01001158EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
Tejun Heo83c47bc2006-05-31 18:28:07 +09001159
1160/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001161 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1162 * @qc: Storage for translated ATA taskfile
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001163 *
1164 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1165 * (to start). Perhaps these commands should be preceded by
1166 * CHECK POWER MODE to see what power mode the device is already in.
1167 * [See SAT revision 5 at www.t10.org]
1168 *
1169 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001170 * spin_lock_irqsave(host lock)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001171 *
1172 * RETURNS:
1173 * Zero on success, non-zero on error.
1174 */
Tejun Heoad706992006-12-17 10:45:57 +09001175static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001176{
Tejun Heo542b1442006-12-17 10:45:08 +09001177 struct scsi_cmnd *scmd = qc->scsicmd;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001178 struct ata_taskfile *tf = &qc->tf;
Tejun Heoad706992006-12-17 10:45:57 +09001179 const u8 *cdb = scmd->cmnd;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001180 u16 fp;
Hannes Reinecke0df10b82016-04-04 11:44:06 +02001181 u8 bp = 0xff;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001182
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001183 if (scmd->cmd_len < 5) {
1184 fp = 4;
Tejun Heo2e5704f2006-12-17 10:46:33 +09001185 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001186 }
Tejun Heo2e5704f2006-12-17 10:46:33 +09001187
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001188 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1189 tf->protocol = ATA_PROT_NODATA;
Tejun Heo542b1442006-12-17 10:45:08 +09001190 if (cdb[1] & 0x1) {
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001191 ; /* ignore IMMED bit, violates sat-r05 */
1192 }
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001193 if (cdb[4] & 0x2) {
1194 fp = 4;
Hannes Reinecke0df10b82016-04-04 11:44:06 +02001195 bp = 1;
Douglas Gilbertae006512005-10-09 09:09:35 -04001196 goto invalid_fld; /* LOEJ bit set not supported */
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001197 }
1198 if (((cdb[4] >> 4) & 0xf) != 0) {
1199 fp = 4;
Hannes Reinecke0df10b82016-04-04 11:44:06 +02001200 bp = 3;
Douglas Gilbertae006512005-10-09 09:09:35 -04001201 goto invalid_fld; /* power conditions not supported */
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001202 }
Tejun Heoe31e85312007-09-23 13:14:13 +09001203
Tejun Heo542b1442006-12-17 10:45:08 +09001204 if (cdb[4] & 0x1) {
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001205 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -04001206
1207 if (qc->dev->flags & ATA_DFLAG_LBA) {
Tejun Heoc44078c2006-05-15 20:57:21 +09001208 tf->flags |= ATA_TFLAG_LBA;
Albert Lee9d5b1302005-10-04 08:48:17 -04001209
1210 tf->lbah = 0x0;
1211 tf->lbam = 0x0;
1212 tf->lbal = 0x0;
1213 tf->device |= ATA_LBA;
1214 } else {
1215 /* CHS */
1216 tf->lbal = 0x1; /* sect */
1217 tf->lbam = 0x0; /* cyl low */
1218 tf->lbah = 0x0; /* cyl high */
1219 }
1220
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001221 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
Tejun Heo920a4b12007-05-04 21:28:48 +02001222 } else {
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +01001223 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1224 * or S5) causing some drives to spin up and down again.
1225 */
1226 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1227 system_state == SYSTEM_POWER_OFF)
1228 goto skip;
1229
1230 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1231 system_entering_hibernation())
1232 goto skip;
1233
Robert Hancock78981a72007-01-30 00:59:18 -08001234 /* Issue ATA STANDBY IMMEDIATE command */
1235 tf->command = ATA_CMD_STANDBYNOW1;
Tejun Heo920a4b12007-05-04 21:28:48 +02001236 }
Robert Hancock78981a72007-01-30 00:59:18 -08001237
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001238 /*
1239 * Standby and Idle condition timers could be implemented but that
1240 * would require libata to implement the Power condition mode page
1241 * and allow the user to change it. Changing mode pages requires
1242 * MODE SELECT to be implemented.
1243 */
1244
1245 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001246
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +01001247 invalid_fld:
Hannes Reinecke0df10b82016-04-04 11:44:06 +02001248 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
Douglas Gilbertae006512005-10-09 09:09:35 -04001249 return 1;
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +01001250 skip:
1251 scmd->result = SAM_STAT_GOOD;
1252 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001253}
1254
1255
1256/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1258 * @qc: Storage for translated ATA taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 *
1260 * Sets up an ATA taskfile to issue FLUSH CACHE or
1261 * FLUSH CACHE EXT.
1262 *
1263 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001264 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 *
1266 * RETURNS:
1267 * Zero on success, non-zero on error.
1268 */
Tejun Heoad706992006-12-17 10:45:57 +09001269static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270{
1271 struct ata_taskfile *tf = &qc->tf;
1272
1273 tf->flags |= ATA_TFLAG_DEVICE;
1274 tf->protocol = ATA_PROT_NODATA;
1275
Tejun Heo6fc49ad2006-11-11 20:10:45 +09001276 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 tf->command = ATA_CMD_FLUSH_EXT;
1278 else
1279 tf->command = ATA_CMD_FLUSH;
1280
Tejun Heob666da32007-10-26 15:53:59 +09001281 /* flush is critical for IO integrity, consider it an IO command */
1282 qc->flags |= ATA_QCFLAG_IO;
1283
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 return 0;
1285}
1286
1287/**
Albert Lee3aef5232005-10-04 08:47:43 -04001288 * scsi_6_lba_len - Get LBA and transfer length
Tejun Heo542b1442006-12-17 10:45:08 +09001289 * @cdb: SCSI command to translate
Albert Lee3aef5232005-10-04 08:47:43 -04001290 *
1291 * Calculate LBA and transfer length for 6-byte commands.
1292 *
1293 * RETURNS:
1294 * @plba: the LBA
1295 * @plen: the transfer length
1296 */
Tejun Heo542b1442006-12-17 10:45:08 +09001297static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001298{
1299 u64 lba = 0;
Jeff Garzik6c7b7d22007-05-25 04:39:39 -04001300 u32 len;
Albert Lee3aef5232005-10-04 08:47:43 -04001301
1302 VPRINTK("six-byte command\n");
1303
Jeff Garzik6c7b7d22007-05-25 04:39:39 -04001304 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
Tejun Heo542b1442006-12-17 10:45:08 +09001305 lba |= ((u64)cdb[2]) << 8;
1306 lba |= ((u64)cdb[3]);
Albert Lee3aef5232005-10-04 08:47:43 -04001307
Jeff Garzik6c7b7d22007-05-25 04:39:39 -04001308 len = cdb[4];
Albert Lee3aef5232005-10-04 08:47:43 -04001309
1310 *plba = lba;
1311 *plen = len;
1312}
1313
1314/**
1315 * scsi_10_lba_len - Get LBA and transfer length
Tejun Heo542b1442006-12-17 10:45:08 +09001316 * @cdb: SCSI command to translate
Albert Lee3aef5232005-10-04 08:47:43 -04001317 *
1318 * Calculate LBA and transfer length for 10-byte commands.
1319 *
1320 * RETURNS:
1321 * @plba: the LBA
1322 * @plen: the transfer length
1323 */
Tejun Heo542b1442006-12-17 10:45:08 +09001324static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001325{
1326 u64 lba = 0;
1327 u32 len = 0;
1328
1329 VPRINTK("ten-byte command\n");
1330
Tejun Heo542b1442006-12-17 10:45:08 +09001331 lba |= ((u64)cdb[2]) << 24;
1332 lba |= ((u64)cdb[3]) << 16;
1333 lba |= ((u64)cdb[4]) << 8;
1334 lba |= ((u64)cdb[5]);
Albert Lee3aef5232005-10-04 08:47:43 -04001335
Tejun Heo542b1442006-12-17 10:45:08 +09001336 len |= ((u32)cdb[7]) << 8;
1337 len |= ((u32)cdb[8]);
Albert Lee3aef5232005-10-04 08:47:43 -04001338
1339 *plba = lba;
1340 *plen = len;
1341}
1342
1343/**
1344 * scsi_16_lba_len - Get LBA and transfer length
Tejun Heo542b1442006-12-17 10:45:08 +09001345 * @cdb: SCSI command to translate
Albert Lee3aef5232005-10-04 08:47:43 -04001346 *
1347 * Calculate LBA and transfer length for 16-byte commands.
1348 *
1349 * RETURNS:
1350 * @plba: the LBA
1351 * @plen: the transfer length
1352 */
Tejun Heo542b1442006-12-17 10:45:08 +09001353static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001354{
1355 u64 lba = 0;
1356 u32 len = 0;
1357
1358 VPRINTK("sixteen-byte command\n");
1359
Tejun Heo542b1442006-12-17 10:45:08 +09001360 lba |= ((u64)cdb[2]) << 56;
1361 lba |= ((u64)cdb[3]) << 48;
1362 lba |= ((u64)cdb[4]) << 40;
1363 lba |= ((u64)cdb[5]) << 32;
1364 lba |= ((u64)cdb[6]) << 24;
1365 lba |= ((u64)cdb[7]) << 16;
1366 lba |= ((u64)cdb[8]) << 8;
1367 lba |= ((u64)cdb[9]);
Albert Lee3aef5232005-10-04 08:47:43 -04001368
Tejun Heo542b1442006-12-17 10:45:08 +09001369 len |= ((u32)cdb[10]) << 24;
1370 len |= ((u32)cdb[11]) << 16;
1371 len |= ((u32)cdb[12]) << 8;
1372 len |= ((u32)cdb[13]);
Albert Lee3aef5232005-10-04 08:47:43 -04001373
1374 *plba = lba;
1375 *plen = len;
1376}
1377
1378/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1380 * @qc: Storage for translated ATA taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 *
1382 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1383 *
1384 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001385 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 *
1387 * RETURNS:
1388 * Zero on success, non-zero on error.
1389 */
Tejun Heoad706992006-12-17 10:45:57 +09001390static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391{
Tejun Heo542b1442006-12-17 10:45:08 +09001392 struct scsi_cmnd *scmd = qc->scsicmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001394 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 u64 dev_sectors = qc->dev->n_sectors;
Tejun Heoad706992006-12-17 10:45:57 +09001396 const u8 *cdb = scmd->cmnd;
Albert Lee3aef5232005-10-04 08:47:43 -04001397 u64 block;
1398 u32 n_block;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001399 u16 fp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
1401 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1402 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
Tejun Heo2e5704f2006-12-17 10:46:33 +09001404 if (cdb[0] == VERIFY) {
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001405 if (scmd->cmd_len < 10) {
1406 fp = 9;
Tejun Heo2e5704f2006-12-17 10:46:33 +09001407 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001408 }
Tejun Heo542b1442006-12-17 10:45:08 +09001409 scsi_10_lba_len(cdb, &block, &n_block);
Tejun Heo2e5704f2006-12-17 10:46:33 +09001410 } else if (cdb[0] == VERIFY_16) {
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001411 if (scmd->cmd_len < 16) {
1412 fp = 15;
Tejun Heo2e5704f2006-12-17 10:46:33 +09001413 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001414 }
Tejun Heo542b1442006-12-17 10:45:08 +09001415 scsi_16_lba_len(cdb, &block, &n_block);
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001416 } else {
1417 fp = 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001418 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001419 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Albert Lee8bf62ece2005-05-12 15:29:42 -04001421 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -04001422 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001423 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001424 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001425 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001426 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Albert Lee07506692005-10-12 15:04:18 +08001428 if (dev->flags & ATA_DFLAG_LBA) {
1429 tf->flags |= ATA_TFLAG_LBA;
1430
Albert Leec6a33e22005-10-12 15:12:26 +08001431 if (lba_28_ok(block, n_block)) {
1432 /* use LBA28 */
1433 tf->command = ATA_CMD_VERIFY;
1434 tf->device |= (block >> 24) & 0xf;
1435 } else if (lba_48_ok(block, n_block)) {
1436 if (!(dev->flags & ATA_DFLAG_LBA48))
1437 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001438
1439 /* use LBA48 */
1440 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001441 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Albert Lee8bf62ece2005-05-12 15:29:42 -04001443 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444
Albert Lee8bf62ece2005-05-12 15:29:42 -04001445 tf->hob_lbah = (block >> 40) & 0xff;
1446 tf->hob_lbam = (block >> 32) & 0xff;
1447 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001448 } else
1449 /* request too large even for LBA48 */
1450 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001451
1452 tf->nsect = n_block & 0xff;
1453
1454 tf->lbah = (block >> 16) & 0xff;
1455 tf->lbam = (block >> 8) & 0xff;
1456 tf->lbal = block & 0xff;
1457
1458 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001460 /* CHS */
1461 u32 sect, head, cyl, track;
1462
Albert Leec6a33e22005-10-12 15:12:26 +08001463 if (!lba_28_ok(block, n_block))
1464 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001465
Albert Lee8bf62ece2005-05-12 15:29:42 -04001466 /* Convert LBA to CHS */
1467 track = (u32)block / dev->sectors;
1468 cyl = track / dev->heads;
1469 head = track % dev->heads;
1470 sect = (u32)block % dev->sectors + 1;
1471
Albert Leec187c4b2005-10-04 08:46:51 -04001472 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1473 (u32)block, track, cyl, head, sect);
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001474
1475 /* Check whether the converted CHS can fit.
1476 Cylinder: 0-65535
Albert Lee8bf62ece2005-05-12 15:29:42 -04001477 Head: 0-15
1478 Sector: 1-255*/
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001479 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001480 goto out_of_range;
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001481
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001483 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1484 tf->lbal = sect;
1485 tf->lbam = cyl;
1486 tf->lbah = cyl >> 8;
1487 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 }
1489
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001491
1492invalid_fld:
Hannes Reinecke0df10b82016-04-04 11:44:06 +02001493 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
Douglas Gilbertae006512005-10-09 09:09:35 -04001494 return 1;
1495
1496out_of_range:
Hannes Reinecke06dbde52016-04-04 11:44:03 +02001497 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
Douglas Gilbertae006512005-10-09 09:09:35 -04001498 /* "Logical Block Address out of range" */
1499 return 1;
1500
1501nothing_to_do:
Tejun Heo542b1442006-12-17 10:45:08 +09001502 scmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001503 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504}
1505
Jens Axboe2d727152019-08-07 12:20:52 -06001506static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1507{
Bart Van Asschec8329cd2021-08-09 16:03:10 -07001508 struct request *rq = scsi_cmd_to_rq(scmd);
Jens Axboe2d727152019-08-07 12:20:52 -06001509 u32 req_blocks;
1510
1511 if (!blk_rq_is_passthrough(rq))
1512 return true;
1513
1514 req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1515 if (n_blocks > req_blocks)
1516 return false;
1517
1518 return true;
1519}
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521/**
1522 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1523 * @qc: Storage for translated ATA taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 *
1525 * Converts any of six SCSI read/write commands into the
1526 * ATA counterpart, including starting sector (LBA),
1527 * sector count, and taking into account the device's LBA48
1528 * support.
1529 *
1530 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1531 * %WRITE_16 are currently supported.
1532 *
1533 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001534 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 *
1536 * RETURNS:
1537 * Zero on success, non-zero on error.
1538 */
Tejun Heoad706992006-12-17 10:45:57 +09001539static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540{
Tejun Heo542b1442006-12-17 10:45:08 +09001541 struct scsi_cmnd *scmd = qc->scsicmd;
Tejun Heoad706992006-12-17 10:45:57 +09001542 const u8 *cdb = scmd->cmnd;
Bart Van Asschec8329cd2021-08-09 16:03:10 -07001543 struct request *rq = scsi_cmd_to_rq(scmd);
Adam Manzanares8e061782016-10-17 11:27:29 -07001544 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
Tejun Heobd056d72006-11-14 22:47:10 +09001545 unsigned int tf_flags = 0;
Albert Lee3aef5232005-10-04 08:47:43 -04001546 u64 block;
1547 u32 n_block;
Tejun Heobd056d72006-11-14 22:47:10 +09001548 int rc;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001549 u16 fp = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550
Tejun Heo542b1442006-12-17 10:45:08 +09001551 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
Tejun Heobd056d72006-11-14 22:47:10 +09001552 tf_flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001554 /* Calculate the SCSI LBA, transfer length and FUA. */
Tejun Heo542b1442006-12-17 10:45:08 +09001555 switch (cdb[0]) {
Albert Lee3aef5232005-10-04 08:47:43 -04001556 case READ_10:
1557 case WRITE_10:
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001558 if (unlikely(scmd->cmd_len < 10)) {
1559 fp = 9;
Tejun Heo2e5704f2006-12-17 10:46:33 +09001560 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001561 }
Tejun Heo542b1442006-12-17 10:45:08 +09001562 scsi_10_lba_len(cdb, &block, &n_block);
Jeff Garzik3e451a42012-08-17 14:04:50 -04001563 if (cdb[1] & (1 << 3))
Tejun Heobd056d72006-11-14 22:47:10 +09001564 tf_flags |= ATA_TFLAG_FUA;
Jens Axboe2d727152019-08-07 12:20:52 -06001565 if (!ata_check_nblocks(scmd, n_block))
1566 goto invalid_fld;
Albert Lee3aef5232005-10-04 08:47:43 -04001567 break;
1568 case READ_6:
1569 case WRITE_6:
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001570 if (unlikely(scmd->cmd_len < 6)) {
1571 fp = 5;
Tejun Heo2e5704f2006-12-17 10:46:33 +09001572 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001573 }
Tejun Heo542b1442006-12-17 10:45:08 +09001574 scsi_6_lba_len(cdb, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -04001575
1576 /* for 6-byte r/w commands, transfer length 0
1577 * means 256 blocks of data, not 0 block.
1578 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -04001579 if (!n_block)
1580 n_block = 256;
Jens Axboe2d727152019-08-07 12:20:52 -06001581 if (!ata_check_nblocks(scmd, n_block))
1582 goto invalid_fld;
Albert Lee3aef5232005-10-04 08:47:43 -04001583 break;
1584 case READ_16:
1585 case WRITE_16:
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001586 if (unlikely(scmd->cmd_len < 16)) {
1587 fp = 15;
Tejun Heo2e5704f2006-12-17 10:46:33 +09001588 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001589 }
Tejun Heo542b1442006-12-17 10:45:08 +09001590 scsi_16_lba_len(cdb, &block, &n_block);
Jeff Garzik3e451a42012-08-17 14:04:50 -04001591 if (cdb[1] & (1 << 3))
Tejun Heobd056d72006-11-14 22:47:10 +09001592 tf_flags |= ATA_TFLAG_FUA;
Jens Axboe2d727152019-08-07 12:20:52 -06001593 if (!ata_check_nblocks(scmd, n_block))
1594 goto invalid_fld;
Albert Lee3aef5232005-10-04 08:47:43 -04001595 break;
1596 default:
Albert Lee8bf62ece2005-05-12 15:29:42 -04001597 DPRINTK("no-byte command\n");
Hannes Reineckebcfc8672016-04-04 11:44:05 +02001598 fp = 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001599 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 }
1601
Albert Lee8bf62ece2005-05-12 15:29:42 -04001602 /* Check and compose ATA command */
1603 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -04001604 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1605 * length 0 means transfer 0 block of data.
1606 * However, for ATA R/W commands, sector count 0 means
1607 * 256 or 65536 sectors, not 0 sectors as in SCSI.
Alan Coxf51750d2005-11-07 17:06:33 +00001608 *
1609 * WARNING: one or two older ATA drives treat 0 as 0...
Albert Leec187c4b2005-10-04 08:46:51 -04001610 */
Douglas Gilbertae006512005-10-09 09:09:35 -04001611 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001612
Tejun Heobd056d72006-11-14 22:47:10 +09001613 qc->flags |= ATA_QCFLAG_IO;
Grant Grundler295124d2010-08-17 10:56:53 -07001614 qc->nbytes = n_block * scmd->device->sector_size;
Tejun Heo3dc1d882006-05-15 21:03:45 +09001615
Tejun Heobd056d72006-11-14 22:47:10 +09001616 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
Jens Axboe4e5b6262018-05-11 12:51:04 -06001617 qc->hw_tag, class);
Adam Manzanares8e061782016-10-17 11:27:29 -07001618
Tejun Heobd056d72006-11-14 22:47:10 +09001619 if (likely(rc == 0))
1620 return 0;
Tejun Heo3dc1d882006-05-15 21:03:45 +09001621
Tejun Heobd056d72006-11-14 22:47:10 +09001622 if (rc == -ERANGE)
1623 goto out_of_range;
1624 /* treat all other errors as -EINVAL, fall through */
Douglas Gilbertae006512005-10-09 09:09:35 -04001625invalid_fld:
Hannes Reinecke0df10b82016-04-04 11:44:06 +02001626 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
Douglas Gilbertae006512005-10-09 09:09:35 -04001627 return 1;
1628
1629out_of_range:
Hannes Reinecke06dbde52016-04-04 11:44:03 +02001630 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
Douglas Gilbertae006512005-10-09 09:09:35 -04001631 /* "Logical Block Address out of range" */
1632 return 1;
1633
1634nothing_to_do:
Tejun Heo542b1442006-12-17 10:45:08 +09001635 scmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001636 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637}
1638
Christoph Hellwig2aa8f5d2015-10-08 10:25:41 +02001639static void ata_qc_done(struct ata_queued_cmd *qc)
1640{
1641 struct scsi_cmnd *cmd = qc->scsicmd;
1642 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1643
1644 ata_qc_free(qc);
1645 done(cmd);
1646}
1647
Tejun Heo77853bf2006-01-23 13:09:36 +09001648static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649{
Tejun Heoc31f5712006-11-22 12:39:43 +09001650 struct ata_port *ap = qc->ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika7dac442005-10-30 04:44:42 -05001652 u8 *cdb = cmd->cmnd;
Jeff Garzik2dcb4072007-10-19 06:42:56 -04001653 int need_sense = (qc->err_mask != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Jeff Garzikb0955182005-05-12 15:45:22 -04001655 /* For ATA pass thru (SAT) commands, generate a sense block if
1656 * user mandated it or if there's an error. Note that if we
Gwendal Grignou84a9a8c2013-01-18 10:56:43 -08001657 * generate because the user forced us to [CK_COND =1], a check
1658 * condition is generated and the ATA register values are returned
Jeff Garzikb0955182005-05-12 15:45:22 -04001659 * whether the command completed successfully or not. If there
Gwendal Grignou84a9a8c2013-01-18 10:56:43 -08001660 * was no error, we use the following sense data:
1661 * sk = RECOVERED ERROR
1662 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
Jeff Garzikb0955182005-05-12 15:45:22 -04001663 */
Jeff Garzika7dac442005-10-30 04:44:42 -05001664 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
Christoph Hellwig25c7ce72015-10-03 19:21:11 +02001665 ((cdb[2] & 0x20) || need_sense))
Tejun Heo750426a2006-11-14 22:37:35 +09001666 ata_gen_passthru_sense(qc);
Hannes Reinecke5b01e4b2016-04-04 11:43:54 +02001667 else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1668 cmd->result = SAM_STAT_CHECK_CONDITION;
Christoph Hellwig25c7ce72015-10-03 19:21:11 +02001669 else if (need_sense)
1670 ata_gen_ata_sense(qc);
1671 else
1672 cmd->result = SAM_STAT_GOOD;
Jeff Garzikb0955182005-05-12 15:45:22 -04001673
Tejun Heoc31f5712006-11-22 12:39:43 +09001674 if (need_sense && !ap->ops->error_handler)
Tejun Heo44877b42007-02-21 01:06:51 +09001675 ata_dump_status(ap->print_id, &qc->result_tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
Christoph Hellwig2aa8f5d2015-10-08 10:25:41 +02001677 ata_qc_done(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
1680/**
1681 * ata_scsi_translate - Translate then issue SCSI command to ATA device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 * @dev: ATA device to which the command is addressed
1683 * @cmd: SCSI command to execute
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1685 *
1686 * Our ->queuecommand() function has decided that the SCSI
1687 * command issued can be directly translated into an ATA
1688 * command, rather than handled internally.
1689 *
1690 * This function sets up an ata_queued_cmd structure for the
1691 * SCSI command, and sends that ata_queued_cmd to the hardware.
1692 *
Douglas Gilbertae006512005-10-09 09:09:35 -04001693 * The xlat_func argument (actor) returns 0 if ready to execute
1694 * ATA command, else 1 to finish translation. If 1 is returned
1695 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1696 * to be set reflecting an error condition or clean (early)
1697 * termination.
1698 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001700 * spin_lock_irqsave(host lock)
Tejun Heo2115ea92006-05-15 21:03:39 +09001701 *
1702 * RETURNS:
1703 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1704 * needs to be deferred.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 */
Tejun Heo2115ea92006-05-15 21:03:39 +09001706static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
Tejun Heo2115ea92006-05-15 21:03:39 +09001707 ata_xlat_func_t xlat_func)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708{
Tejun Heo31cc23b2007-09-23 13:14:12 +09001709 struct ata_port *ap = dev->link->ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 struct ata_queued_cmd *qc;
Tejun Heo31cc23b2007-09-23 13:14:12 +09001711 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712
1713 VPRINTK("ENTER\n");
1714
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05001715 qc = ata_scsi_qc_new(dev, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -04001717 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718
1719 /* data is present; dma-map it */
be7db052005-04-17 15:26:13 -05001720 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1721 cmd->sc_data_direction == DMA_TO_DEVICE) {
Boaz Harrosh71201652007-09-18 17:48:50 +02001722 if (unlikely(scsi_bufflen(cmd) < 1)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07001723 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001724 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 }
1726
Boaz Harrosh71201652007-09-18 17:48:50 +02001727 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728
1729 qc->dma_dir = cmd->sc_data_direction;
1730 }
1731
1732 qc->complete_fn = ata_scsi_qc_complete;
1733
Tejun Heoad706992006-12-17 10:45:57 +09001734 if (xlat_func(qc))
Douglas Gilbertae006512005-10-09 09:09:35 -04001735 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
Tejun Heo31cc23b2007-09-23 13:14:12 +09001737 if (ap->ops->qc_defer) {
1738 if ((rc = ap->ops->qc_defer(qc)))
1739 goto defer;
1740 }
1741
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 /* select device, send command to hardware */
Tejun Heo8e0e6942006-03-31 20:41:11 +09001743 ata_qc_issue(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744
1745 VPRINTK("EXIT\n");
Tejun Heo2115ea92006-05-15 21:03:39 +09001746 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747
Douglas Gilbertae006512005-10-09 09:09:35 -04001748early_finish:
Jeff Garzik2dcb4072007-10-19 06:42:56 -04001749 ata_qc_free(qc);
Bart Van Assche58bf2012021-10-07 13:27:58 -07001750 scsi_done(cmd);
Douglas Gilbertae006512005-10-09 09:09:35 -04001751 DPRINTK("EXIT - early finish (good or error)\n");
Tejun Heo2115ea92006-05-15 21:03:39 +09001752 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001753
1754err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -04001756 cmd->result = (DID_ERROR << 16);
Bart Van Assche58bf2012021-10-07 13:27:58 -07001757 scsi_done(cmd);
Darrick J. Wong253b92e2006-11-14 09:55:41 -05001758err_mem:
Douglas Gilbertae006512005-10-09 09:09:35 -04001759 DPRINTK("EXIT - internal\n");
Tejun Heo2115ea92006-05-15 21:03:39 +09001760 return 0;
Tejun Heo3dc1d882006-05-15 21:03:45 +09001761
1762defer:
Tejun Heo31cc23b2007-09-23 13:14:12 +09001763 ata_qc_free(qc);
Tejun Heo3dc1d882006-05-15 21:03:45 +09001764 DPRINTK("EXIT - defer\n");
Tejun Heo31cc23b2007-09-23 13:14:12 +09001765 if (rc == ATA_DEFER_LINK)
1766 return SCSI_MLQUEUE_DEVICE_BUSY;
1767 else
1768 return SCSI_MLQUEUE_HOST_BUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769}
1770
Christoph Hellwigf0a37d12017-01-10 09:41:44 +01001771struct ata_scsi_args {
1772 struct ata_device *dev;
1773 u16 *id;
1774 struct scsi_cmnd *cmd;
Christoph Hellwigf0a37d12017-01-10 09:41:44 +01001775};
1776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1779 * @args: device IDENTIFY data / SCSI command of interest.
1780 * @actor: Callback hook for desired SCSI command simulator
1781 *
1782 * Takes care of the hard work of simulating a SCSI command...
1783 * Mapping the response buffer, calling the command's handler,
1784 * and handling the handler's return value. This return value
1785 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001786 * completed successfully (0), or not (in which case cmd->result
1787 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 *
1789 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001790 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 */
Tejun Heof0761be2008-04-28 17:16:52 +09001792static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
Tejun Heo87340e92008-04-28 17:48:51 +09001793 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794{
Tejun Heo87340e92008-04-28 17:48:51 +09001795 unsigned int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 struct scsi_cmnd *cmd = args->cmd;
Jeff Garzikb445c562008-02-29 19:10:51 -05001797 unsigned long flags;
1798
Damien Le Moal56b4f062021-08-16 10:44:48 +09001799 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
1800
1801 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1802 rc = actor(args, ata_scsi_rbuf);
1803 if (rc == 0)
1804 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1805 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1806
1807 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
Jeff Garzikb445c562008-02-29 19:10:51 -05001808
Douglas Gilbertae006512005-10-09 09:09:35 -04001809 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 cmd->result = SAM_STAT_GOOD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811}
1812
1813/**
1814 * ata_scsiop_inq_std - Simulate INQUIRY command
1815 * @args: device IDENTIFY data / SCSI command of interest.
1816 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 *
1818 * Returns standard device identification data associated
Jeff Garzikb142eb62006-03-21 20:37:47 -05001819 * with non-VPD INQUIRY command output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 *
1821 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001822 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 */
Tejun Heo87340e92008-04-28 17:48:51 +09001824static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825{
Colin Ian Kinge94f79142017-09-19 09:39:52 +01001826 static const u8 versions[] = {
Hannes Reineckef9ca5ab2014-11-05 13:08:22 +01001827 0x00,
Tejun Heo87340e92008-04-28 17:48:51 +09001828 0x60, /* SAM-3 (no version claimed) */
1829
1830 0x03,
1831 0x20, /* SBC-2 (no version claimed) */
1832
Tom Yan29a37ea2016-07-12 21:29:35 +08001833 0x03,
1834 0x00 /* SPC-3 (no version claimed) */
Tejun Heo87340e92008-04-28 17:48:51 +09001835 };
Colin Ian Kinge94f79142017-09-19 09:39:52 +01001836 static const u8 versions_zbc[] = {
Hannes Reineckef9ca5ab2014-11-05 13:08:22 +01001837 0x00,
1838 0xA0, /* SAM-5 (no version claimed) */
1839
Hannes Reinecke856c4662016-04-25 12:45:55 +02001840 0x06,
1841 0x00, /* SBC-4 (no version claimed) */
Hannes Reineckef9ca5ab2014-11-05 13:08:22 +01001842
Hannes Reinecke856c4662016-04-25 12:45:55 +02001843 0x05,
1844 0xC0, /* SPC-5 (no version claimed) */
Hannes Reineckef9ca5ab2014-11-05 13:08:22 +01001845
1846 0x60,
Hannes Reinecke856c4662016-04-25 12:45:55 +02001847 0x24, /* ZBC r05 */
Hannes Reineckef9ca5ab2014-11-05 13:08:22 +01001848 };
1849
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 u8 hdr[] = {
1851 TYPE_DISK,
1852 0,
1853 0x5, /* claim SPC-3 version compatibility */
1854 2,
Tom Yan415ffdd2016-07-12 21:29:34 +08001855 95 - 4,
1856 0,
1857 0,
1858 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 };
1860
Tejun Heo87340e92008-04-28 17:48:51 +09001861 VPRINTK("ENTER\n");
1862
Manuel Lauss8a3e33c2015-09-30 21:10:25 +02001863 /* set scsi removable (RMB) bit per ata bit, or if the
1864 * AHCI port says it's external (Hotplug-capable, eSATA).
1865 */
1866 if (ata_id_removable(args->id) ||
1867 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 hdr[1] |= (1 << 7);
1869
Tom Yan56b8cba2016-07-12 22:12:01 +08001870 if (args->dev->class == ATA_DEV_ZAC) {
Hannes Reineckef9ca5ab2014-11-05 13:08:22 +01001871 hdr[0] = TYPE_ZBC;
Tom Yan56b8cba2016-07-12 22:12:01 +08001872 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
1873 }
Hannes Reineckef9ca5ab2014-11-05 13:08:22 +01001874
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 memcpy(rbuf, hdr, sizeof(hdr));
Tejun Heo87340e92008-04-28 17:48:51 +09001876 memcpy(&rbuf[8], "ATA ", 8);
1877 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
Keith Buschc49a6bf2014-05-01 11:12:03 -06001878
1879 /* From SAT, use last 2 words from fw rev unless they are spaces */
1880 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
1881 if (strncmp(&rbuf[32], " ", 4) == 0)
1882 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883
Tejun Heo87340e92008-04-28 17:48:51 +09001884 if (rbuf[32] == 0 || rbuf[32] == ' ')
1885 memcpy(&rbuf[32], "n/a ", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886
Hannes Reinecke856c4662016-04-25 12:45:55 +02001887 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
Hannes Reineckef9ca5ab2014-11-05 13:08:22 +01001888 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
1889 else
1890 memcpy(rbuf + 58, versions, sizeof(versions));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
1892 return 0;
1893}
1894
1895/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001896 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 * @args: device IDENTIFY data / SCSI command of interest.
1898 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001900 * Returns list of inquiry VPD pages available.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 *
1902 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001903 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 */
Tejun Heo87340e92008-04-28 17:48:51 +09001905static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906{
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09001907 int i, num_pages = 0;
Colin Ian Kinge94f79142017-09-19 09:39:52 +01001908 static const u8 pages[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 0x00, /* page 0x00, this page */
1910 0x80, /* page 0x80, unit serial no page */
Matthew Wilcox1e9dbc92008-06-19 13:13:38 -06001911 0x83, /* page 0x83, device ident page */
1912 0x89, /* page 0x89, ata info page */
Christoph Hellwig18f0f972009-11-17 10:00:47 -05001913 0xb0, /* page 0xb0, block limits page */
Matthew Wilcox1e9dbc92008-06-19 13:13:38 -06001914 0xb1, /* page 0xb1, block device characteristics page */
Martin K. Petersen02e0a602010-09-10 01:23:18 -04001915 0xb2, /* page 0xb2, thin provisioning page */
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02001916 0xb6, /* page 0xb6, zoned block device characteristics */
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09001917 0xb9, /* page 0xb9, concurrent positioning ranges */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 };
Tejun Heo87340e92008-04-28 17:48:51 +09001919
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09001920 for (i = 0; i < sizeof(pages); i++) {
1921 if (pages[i] == 0xb6 &&
1922 !(args->dev->flags & ATA_DFLAG_ZAC))
1923 continue;
1924 rbuf[num_pages + 4] = pages[i];
1925 num_pages++;
1926 }
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02001927 rbuf[3] = num_pages; /* number of supported VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 return 0;
1929}
1930
1931/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001932 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 * @args: device IDENTIFY data / SCSI command of interest.
1934 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 *
1936 * Returns ATA device serial number.
1937 *
1938 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001939 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 */
Tejun Heo87340e92008-04-28 17:48:51 +09001941static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942{
Colin Ian Kinge94f79142017-09-19 09:39:52 +01001943 static const u8 hdr[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 0,
1945 0x80, /* this page code */
1946 0,
Tejun Heoa0cf7332007-01-02 20:18:49 +09001947 ATA_ID_SERNO_LEN, /* page len */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 };
Tejun Heo87340e92008-04-28 17:48:51 +09001949
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 memcpy(rbuf, hdr, sizeof(hdr));
Tejun Heo87340e92008-04-28 17:48:51 +09001951 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1952 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 return 0;
1954}
1955
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001957 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 * @args: device IDENTIFY data / SCSI command of interest.
1959 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001961 * Yields two logical unit device identification designators:
1962 * - vendor specific ASCII containing the ATA serial number
1963 * - SAT defined "t10 vendor id based" containing ASCII vendor
1964 * name ("ATA "), model and serial numbers.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 *
1966 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04001967 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 */
Tejun Heo87340e92008-04-28 17:48:51 +09001969static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970{
Jeff Garzikb142eb62006-03-21 20:37:47 -05001971 const int sat_model_serial_desc_len = 68;
Tejun Heo87340e92008-04-28 17:48:51 +09001972 int num;
Jeff Garzikb142eb62006-03-21 20:37:47 -05001973
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 rbuf[1] = 0x83; /* this page code */
Jeff Garzikb142eb62006-03-21 20:37:47 -05001975 num = 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976
Tejun Heo87340e92008-04-28 17:48:51 +09001977 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1978 rbuf[num + 0] = 2;
1979 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1980 num += 4;
1981 ata_id_string(args->id, (unsigned char *) rbuf + num,
1982 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1983 num += ATA_ID_SERNO_LEN;
1984
1985 /* SAT defined lu model and serial numbers descriptor */
1986 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1987 rbuf[num + 0] = 2;
1988 rbuf[num + 1] = 1;
1989 rbuf[num + 3] = sat_model_serial_desc_len;
1990 num += 4;
1991 memcpy(rbuf + num, "ATA ", 8);
1992 num += 8;
1993 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
1994 ATA_ID_PROD_LEN);
1995 num += ATA_ID_PROD_LEN;
1996 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
1997 ATA_ID_SERNO_LEN);
1998 num += ATA_ID_SERNO_LEN;
1999
Hannes Reinecke6b3b9d72011-03-07 08:56:44 +01002000 if (ata_id_has_wwn(args->id)) {
2001 /* SAT defined lu world wide name */
2002 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2003 rbuf[num + 0] = 1;
2004 rbuf[num + 1] = 3;
2005 rbuf[num + 3] = ATA_ID_WWN_LEN;
2006 num += 4;
2007 ata_id_string(args->id, (unsigned char *) rbuf + num,
2008 ATA_ID_WWN, ATA_ID_WWN_LEN);
2009 num += ATA_ID_WWN_LEN;
2010 }
Jeff Garzikb142eb62006-03-21 20:37:47 -05002011 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 return 0;
2013}
2014
2015/**
Jeff Garzikad355b42007-09-21 20:38:03 -04002016 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2017 * @args: device IDENTIFY data / SCSI command of interest.
2018 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
Jeff Garzikad355b42007-09-21 20:38:03 -04002019 *
2020 * Yields SAT-specified ATA VPD page.
2021 *
2022 * LOCKING:
2023 * spin_lock_irqsave(host lock)
2024 */
Tejun Heo87340e92008-04-28 17:48:51 +09002025static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
Jeff Garzikad355b42007-09-21 20:38:03 -04002026{
Tejun Heo87340e92008-04-28 17:48:51 +09002027 rbuf[1] = 0x89; /* our page code */
2028 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2029 rbuf[3] = (0x238 & 0xff);
Jeff Garzikad355b42007-09-21 20:38:03 -04002030
Tejun Heo87340e92008-04-28 17:48:51 +09002031 memcpy(&rbuf[8], "linux ", 8);
2032 memcpy(&rbuf[16], "libata ", 16);
2033 memcpy(&rbuf[32], DRV_VERSION, 4);
Jeff Garzikad355b42007-09-21 20:38:03 -04002034
Tejun Heo87340e92008-04-28 17:48:51 +09002035 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
Bartlomiej Zolnierkiewicz33531002020-03-26 16:58:00 +01002036 rbuf[37] = (1 << 7); /* bit 7 indicates Command FIS */
2037 /* TODO: PMP? */
2038
2039 /* we don't store the ATA device signature, so we fake it */
2040 rbuf[38] = ATA_DRDY; /* really, this is Status reg */
2041 rbuf[40] = 0x1;
2042 rbuf[48] = 0x1;
Jeff Garzikad355b42007-09-21 20:38:03 -04002043
Tejun Heo87340e92008-04-28 17:48:51 +09002044 rbuf[56] = ATA_CMD_ID_ATA;
Jeff Garzikad355b42007-09-21 20:38:03 -04002045
Tejun Heo87340e92008-04-28 17:48:51 +09002046 memcpy(&rbuf[60], &args->id[0], 512);
Jeff Garzikad355b42007-09-21 20:38:03 -04002047 return 0;
2048}
2049
Christoph Hellwig18f0f972009-11-17 10:00:47 -05002050static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2051{
Tejun Heo3b545562020-09-02 12:32:45 -04002052 struct ata_device *dev = args->dev;
Grant Grundler295124d2010-08-17 10:56:53 -07002053 u16 min_io_sectors;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05002054
2055 rbuf[1] = 0xb0;
2056 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2057
2058 /*
2059 * Optimal transfer length granularity.
2060 *
2061 * This is always one physical block, but for disks with a smaller
2062 * logical than physical sector size we need to figure out what the
2063 * latter is.
2064 */
Grant Grundler295124d2010-08-17 10:56:53 -07002065 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
Christoph Hellwig18f0f972009-11-17 10:00:47 -05002066 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2067
2068 /*
2069 * Optimal unmap granularity.
2070 *
2071 * The ATA spec doesn't even know about a granularity or alignment
2072 * for the TRIM command. We can leave away most of the unmap related
2073 * VPD page entries, but we have specifify a granularity to signal
2074 * that we support some form of unmap - in thise case via WRITE SAME
2075 * with the unmap bit set.
2076 */
Martin K. Petersene78db4d2009-11-26 22:46:03 -05002077 if (ata_id_has_trim(args->id)) {
Tejun Heo3b545562020-09-02 12:32:45 -04002078 u64 max_blocks = 65535 * ATA_MAX_TRIM_RNUM;
2079
2080 if (dev->horkage & ATA_HORKAGE_MAX_TRIM_128M)
2081 max_blocks = 128 << (20 - SECTOR_SHIFT);
2082
2083 put_unaligned_be64(max_blocks, &rbuf[36]);
Christoph Hellwig18f0f972009-11-17 10:00:47 -05002084 put_unaligned_be32(1, &rbuf[28]);
Martin K. Petersene78db4d2009-11-26 22:46:03 -05002085 }
Christoph Hellwig18f0f972009-11-17 10:00:47 -05002086
2087 return 0;
2088}
2089
Matthew Wilcox1e9dbc92008-06-19 13:13:38 -06002090static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2091{
Martin K. Petersen4bca3282009-05-15 00:40:35 -04002092 int form_factor = ata_id_form_factor(args->id);
2093 int media_rotation_rate = ata_id_rotation_rate(args->id);
Hannes Reinecke856c4662016-04-25 12:45:55 +02002094 u8 zoned = ata_id_zoned_cap(args->id);
Martin K. Petersen4bca3282009-05-15 00:40:35 -04002095
Matthew Wilcox1e9dbc92008-06-19 13:13:38 -06002096 rbuf[1] = 0xb1;
2097 rbuf[3] = 0x3c;
Martin K. Petersen4bca3282009-05-15 00:40:35 -04002098 rbuf[4] = media_rotation_rate >> 8;
2099 rbuf[5] = media_rotation_rate;
2100 rbuf[7] = form_factor;
Hannes Reinecke856c4662016-04-25 12:45:55 +02002101 if (zoned)
2102 rbuf[8] = (zoned << 4);
Matthew Wilcox1e9dbc92008-06-19 13:13:38 -06002103
2104 return 0;
2105}
2106
Martin K. Petersen02e0a602010-09-10 01:23:18 -04002107static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2108{
2109 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2110 rbuf[1] = 0xb2;
2111 rbuf[3] = 0x4;
2112 rbuf[5] = 1 << 6; /* TPWS */
2113
2114 return 0;
2115}
2116
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02002117static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2118{
2119 /*
2120 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2121 */
2122 rbuf[1] = 0xb6;
2123 rbuf[3] = 0x3C;
2124
2125 /*
2126 * URSWRZ bit is only meaningful for host-managed ZAC drives
2127 */
2128 if (args->dev->zac_zoned_cap & 1)
2129 rbuf[4] |= 1;
2130 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2131 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2132 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2133
2134 return 0;
2135}
2136
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09002137static unsigned int ata_scsiop_inq_b9(struct ata_scsi_args *args, u8 *rbuf)
2138{
2139 struct ata_cpr_log *cpr_log = args->dev->cpr_log;
2140 u8 *desc = &rbuf[64];
2141 int i;
2142
2143 /* SCSI Concurrent Positioning Ranges VPD page: SBC-5 rev 1 or later */
2144 rbuf[1] = 0xb9;
2145 put_unaligned_be16(64 + (int)cpr_log->nr_cpr * 32 - 4, &rbuf[3]);
2146
2147 for (i = 0; i < cpr_log->nr_cpr; i++, desc += 32) {
2148 desc[0] = cpr_log->cpr[i].num;
2149 desc[1] = cpr_log->cpr[i].num_storage_elements;
2150 put_unaligned_be64(cpr_log->cpr[i].start_lba, &desc[8]);
2151 put_unaligned_be64(cpr_log->cpr[i].num_lbas, &desc[16]);
2152 }
2153
2154 return 0;
2155}
2156
Jeff Garzikad355b42007-09-21 20:38:03 -04002157/**
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002158 * modecpy - Prepare response for MODE SENSE
2159 * @dest: output buffer
2160 * @src: data being copied
2161 * @n: length of mode page
2162 * @changeable: whether changeable parameters are requested
2163 *
2164 * Generate a generic MODE SENSE page for either current or changeable
2165 * parameters.
2166 *
2167 * LOCKING:
2168 * None.
2169 */
2170static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2171{
2172 if (changeable) {
2173 memcpy(dest, src, 2);
2174 memset(dest + 2, 0, n - 2);
2175 } else {
2176 memcpy(dest, src, n);
2177 }
2178}
2179
2180/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 * ata_msense_caching - Simulate MODE SENSE caching info page
2182 * @id: device IDENTIFY data
Tejun Heo87340e92008-04-28 17:48:51 +09002183 * @buf: output buffer
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002184 * @changeable: whether changeable parameters are requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 *
2186 * Generate a caching info page, which conditionally indicates
2187 * write caching to the SCSI layer, depending on device
2188 * capabilities.
2189 *
2190 * LOCKING:
2191 * None.
2192 */
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002193static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194{
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002195 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
Tom Yan737bee92016-07-20 04:39:28 +08002196 if (changeable) {
2197 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2198 } else {
2199 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2200 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2201 }
Tejun Heo87340e92008-04-28 17:48:51 +09002202 return sizeof(def_cache_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203}
2204
2205/**
Tom Yanf086b742016-07-13 02:54:12 +08002206 * ata_msense_control - Simulate MODE SENSE control mode page
Hannes Reinecke06dbde52016-04-04 11:44:03 +02002207 * @dev: ATA device of interest
Tejun Heo87340e92008-04-28 17:48:51 +09002208 * @buf: output buffer
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002209 * @changeable: whether changeable parameters are requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 *
2211 * Generate a generic MODE SENSE control mode page.
2212 *
2213 * LOCKING:
2214 * None.
2215 */
Tom Yanf086b742016-07-13 02:54:12 +08002216static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
Hannes Reinecke06dbde52016-04-04 11:44:03 +02002217 bool changeable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218{
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002219 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
Tom Yan737bee92016-07-20 04:39:28 +08002220 if (changeable) {
2221 buf[2] |= (1 << 2); /* ata_mselect_control() */
2222 } else {
2223 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2224
2225 buf[2] |= (d_sense << 2); /* descriptor format sense data */
2226 }
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002227 return sizeof(def_control_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228}
2229
2230/**
2231 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
Randy Dunlapec2a20e2008-04-30 12:57:00 -07002232 * @buf: output buffer
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002233 * @changeable: whether changeable parameters are requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 *
2235 * Generate a generic MODE SENSE r/w error recovery page.
2236 *
2237 * LOCKING:
2238 * None.
2239 */
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002240static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241{
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002242 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2243 changeable);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002244 return sizeof(def_rw_recovery_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245}
2246
Jens Axboe48bdc8e2006-01-30 16:09:35 +01002247/*
2248 * We can turn this into a real blacklist if it's needed, for now just
2249 * blacklist any Maxtor BANC1G10 revision firmware
2250 */
2251static int ata_dev_supports_fua(u16 *id)
2252{
Tejun Heoa0cf7332007-01-02 20:18:49 +09002253 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
Jens Axboe48bdc8e2006-01-30 16:09:35 +01002254
Jeff Garzikc3c013a2006-02-27 22:31:19 -05002255 if (!libata_fua)
2256 return 0;
Jens Axboe48bdc8e2006-01-30 16:09:35 +01002257 if (!ata_id_has_fua(id))
2258 return 0;
2259
Tejun Heoa0cf7332007-01-02 20:18:49 +09002260 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2261 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
Jens Axboe48bdc8e2006-01-30 16:09:35 +01002262
Tejun Heo2e026712006-02-12 22:47:04 +09002263 if (strcmp(model, "Maxtor"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01002264 return 1;
Tejun Heo2e026712006-02-12 22:47:04 +09002265 if (strcmp(fw, "BANC1G10"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01002266 return 1;
2267
2268 return 0; /* blacklisted */
2269}
2270
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271/**
2272 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2273 * @args: device IDENTIFY data / SCSI command of interest.
2274 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 *
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002276 * Simulate MODE SENSE commands. Assume this is invoked for direct
2277 * access devices (e.g. disks) only. There should be no block
2278 * descriptor for other device types.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 *
2280 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04002281 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 */
Tejun Heo87340e92008-04-28 17:48:51 +09002283static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284{
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002285 struct ata_device *dev = args->dev;
Tejun Heo87340e92008-04-28 17:48:51 +09002286 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
Colin Ian Kinge94f79142017-09-19 09:39:52 +01002287 static const u8 sat_blk_desc[] = {
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002288 0, 0, 0, 0, /* number of blocks: sat unspecified */
2289 0,
2290 0, 0x2, 0x0 /* block length: 512 bytes */
2291 };
2292 u8 pg, spg;
Tejun Heo87340e92008-04-28 17:48:51 +09002293 unsigned int ebd, page_control, six_byte;
Hannes Reinecke0df10b82016-04-04 11:44:06 +02002294 u8 dpofua, bp = 0xff;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002295 u16 fp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296
2297 VPRINTK("ENTER\n");
2298
2299 six_byte = (scsicmd[0] == MODE_SENSE);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002300 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2301 /*
2302 * LLBA bit in msense(10) ignored (compliant)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002304
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04002306 switch (page_control) {
2307 case 0: /* current */
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002308 case 1: /* changeable */
2309 case 2: /* defaults */
Douglas Gilbertae006512005-10-09 09:09:35 -04002310 break; /* supported */
2311 case 3: /* saved */
2312 goto saving_not_supp;
Douglas Gilbertae006512005-10-09 09:09:35 -04002313 default:
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002314 fp = 2;
Hannes Reinecke0df10b82016-04-04 11:44:06 +02002315 bp = 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04002316 goto invalid_fld;
2317 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318
Tejun Heo87340e92008-04-28 17:48:51 +09002319 if (six_byte)
2320 p += 4 + (ebd ? 8 : 0);
2321 else
2322 p += 8 + (ebd ? 8 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002324 pg = scsicmd[2] & 0x3f;
2325 spg = scsicmd[3];
2326 /*
2327 * No mode subpages supported (yet) but asking for _all_
2328 * subpages may be valid
2329 */
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002330 if (spg && (spg != ALL_SUB_MPAGES)) {
2331 fp = 3;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002332 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002333 }
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002334
2335 switch(pg) {
2336 case RW_RECOVERY_MPAGE:
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002337 p += ata_msense_rw_recovery(p, page_control == 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 break;
2339
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002340 case CACHE_MPAGE:
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002341 p += ata_msense_caching(args->id, p, page_control == 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 break;
2343
Tejun Heo87340e92008-04-28 17:48:51 +09002344 case CONTROL_MPAGE:
Tom Yanf086b742016-07-13 02:54:12 +08002345 p += ata_msense_control(args->dev, p, page_control == 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002348 case ALL_MPAGES:
Paolo Bonzini6ca8e792012-07-05 14:18:20 +02002349 p += ata_msense_rw_recovery(p, page_control == 1);
2350 p += ata_msense_caching(args->id, p, page_control == 1);
Tom Yanf086b742016-07-13 02:54:12 +08002351 p += ata_msense_control(args->dev, p, page_control == 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 break;
2353
2354 default: /* invalid page code */
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002355 fp = 2;
Douglas Gilbertae006512005-10-09 09:09:35 -04002356 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 }
2358
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002359 dpofua = 0;
Alan Coxf79d4092006-05-22 16:55:11 +01002360 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002361 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2362 dpofua = 1 << 4;
2363
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 if (six_byte) {
Tejun Heo87340e92008-04-28 17:48:51 +09002365 rbuf[0] = p - rbuf - 1;
2366 rbuf[2] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002367 if (ebd) {
Tejun Heo87340e92008-04-28 17:48:51 +09002368 rbuf[3] = sizeof(sat_blk_desc);
2369 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002370 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 } else {
Tejun Heo87340e92008-04-28 17:48:51 +09002372 unsigned int output_len = p - rbuf - 2;
2373
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 rbuf[0] = output_len >> 8;
Tejun Heo87340e92008-04-28 17:48:51 +09002375 rbuf[1] = output_len;
2376 rbuf[3] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002377 if (ebd) {
Tejun Heo87340e92008-04-28 17:48:51 +09002378 rbuf[7] = sizeof(sat_blk_desc);
2379 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002380 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04002383
2384invalid_fld:
Hannes Reinecke0df10b82016-04-04 11:44:06 +02002385 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
Douglas Gilbertae006512005-10-09 09:09:35 -04002386 return 1;
2387
2388saving_not_supp:
Hannes Reinecke06dbde52016-04-04 11:44:03 +02002389 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
Douglas Gilbertae006512005-10-09 09:09:35 -04002390 /* "Saving parameters not supported" */
2391 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392}
2393
2394/**
2395 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2396 * @args: device IDENTIFY data / SCSI command of interest.
2397 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 *
2399 * Simulate READ CAPACITY commands.
2400 *
2401 * LOCKING:
Tejun Heo6a362612006-11-20 11:15:47 +09002402 * None.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 */
Tejun Heo87340e92008-04-28 17:48:51 +09002404static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405{
Martin K. Petersen61d79a82009-05-15 00:40:34 -04002406 struct ata_device *dev = args->dev;
2407 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
Grant Grundler295124d2010-08-17 10:56:53 -07002408 u32 sector_size; /* physical sector size in bytes */
2409 u8 log2_per_phys;
2410 u16 lowest_aligned;
Martin K. Petersen61d79a82009-05-15 00:40:34 -04002411
Grant Grundler295124d2010-08-17 10:56:53 -07002412 sector_size = ata_id_logical_sector_size(dev->id);
2413 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2414 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415
2416 VPRINTK("ENTER\n");
2417
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Tejun Heo6a362612006-11-20 11:15:47 +09002419 if (last_lba >= 0xffffffffULL)
2420 last_lba = 0xffffffff;
Philip Pokorny0c144d02005-05-28 01:24:47 -07002421
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 /* sector count, 32-bit */
Tejun Heo87340e92008-04-28 17:48:51 +09002423 rbuf[0] = last_lba >> (8 * 3);
2424 rbuf[1] = last_lba >> (8 * 2);
2425 rbuf[2] = last_lba >> (8 * 1);
2426 rbuf[3] = last_lba;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427
2428 /* sector size */
Grant Grundler295124d2010-08-17 10:56:53 -07002429 rbuf[4] = sector_size >> (8 * 3);
2430 rbuf[5] = sector_size >> (8 * 2);
2431 rbuf[6] = sector_size >> (8 * 1);
2432 rbuf[7] = sector_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433 } else {
2434 /* sector count, 64-bit */
Tejun Heo87340e92008-04-28 17:48:51 +09002435 rbuf[0] = last_lba >> (8 * 7);
2436 rbuf[1] = last_lba >> (8 * 6);
2437 rbuf[2] = last_lba >> (8 * 5);
2438 rbuf[3] = last_lba >> (8 * 4);
2439 rbuf[4] = last_lba >> (8 * 3);
2440 rbuf[5] = last_lba >> (8 * 2);
2441 rbuf[6] = last_lba >> (8 * 1);
2442 rbuf[7] = last_lba;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443
2444 /* sector size */
Grant Grundler295124d2010-08-17 10:56:53 -07002445 rbuf[ 8] = sector_size >> (8 * 3);
2446 rbuf[ 9] = sector_size >> (8 * 2);
2447 rbuf[10] = sector_size >> (8 * 1);
2448 rbuf[11] = sector_size;
Martin K. Petersen61d79a82009-05-15 00:40:34 -04002449
2450 rbuf[12] = 0;
Grant Grundler295124d2010-08-17 10:56:53 -07002451 rbuf[13] = log2_per_phys;
Martin K. Petersen61d79a82009-05-15 00:40:34 -04002452 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2453 rbuf[15] = lowest_aligned;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05002454
Arne Fitzenreiter71d126f2015-07-15 13:54:36 +02002455 if (ata_id_has_trim(args->id) &&
2456 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
Martin K. Petersene61f7d12015-01-08 10:34:27 -05002457 rbuf[14] |= 0x80; /* LBPME */
Martin K. Petersene78db4d2009-11-26 22:46:03 -05002458
Martin K. Petersene61f7d12015-01-08 10:34:27 -05002459 if (ata_id_has_zero_after_trim(args->id) &&
2460 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2461 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2462 rbuf[14] |= 0x40; /* LBPRZ */
2463 }
Martin K. Petersene78db4d2009-11-26 22:46:03 -05002464 }
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02002465 if (ata_id_zoned_cap(args->id) ||
2466 args->dev->class == ATA_DEV_ZAC)
2467 rbuf[12] = (1 << 4); /* RC_BASIS */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 return 0;
2470}
2471
2472/**
2473 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2474 * @args: device IDENTIFY data / SCSI command of interest.
2475 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 *
2477 * Simulate REPORT LUNS command.
2478 *
2479 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04002480 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481 */
Tejun Heo87340e92008-04-28 17:48:51 +09002482static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483{
2484 VPRINTK("ENTER\n");
2485 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2486
2487 return 0;
2488}
2489
Tejun Heo77853bf2006-01-23 13:09:36 +09002490static void atapi_sense_complete(struct ata_queued_cmd *qc)
Jeff Garzika939c962005-10-05 17:09:16 -04002491{
Tejun Heo74e6c8c2006-04-02 18:51:53 +09002492 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002493 /* FIXME: not quite right; we don't want the
2494 * translation of taskfile registers into
2495 * a sense descriptors, since that's only
2496 * correct for ATA, not ATAPI
2497 */
Tejun Heo750426a2006-11-14 22:37:35 +09002498 ata_gen_passthru_sense(qc);
Tejun Heo74e6c8c2006-04-02 18:51:53 +09002499 }
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002500
Christoph Hellwig2aa8f5d2015-10-08 10:25:41 +02002501 ata_qc_done(qc);
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002502}
2503
2504/* is it pointless to prefer PIO for "safety reasons"? */
2505static inline int ata_pio_use_silly(struct ata_port *ap)
2506{
2507 return (ap->flags & ATA_FLAG_PIO_DMA);
2508}
2509
2510static void atapi_request_sense(struct ata_queued_cmd *qc)
2511{
2512 struct ata_port *ap = qc->ap;
2513 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika939c962005-10-05 17:09:16 -04002514
2515 DPRINTK("ATAPI request sense\n");
2516
James Bottomley7ccd7202008-01-17 11:56:24 -06002517 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Jeff Garzika939c962005-10-05 17:09:16 -04002518
Tejun Heo127102a2008-04-07 22:47:21 +09002519#ifdef CONFIG_ATA_SFF
James Bottomley855d8542008-04-18 13:18:48 -05002520 if (ap->ops->sff_tf_read)
2521 ap->ops->sff_tf_read(ap, &qc->tf);
Tejun Heo127102a2008-04-07 22:47:21 +09002522#endif
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002523
2524 /* fill these in, for the case where they are -not- overwritten */
2525 cmd->sense_buffer[0] = 0x70;
2526 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2527
2528 ata_qc_reinit(qc);
2529
Tejun Heo93f8fec2007-12-05 16:43:01 +09002530 /* setup sg table and init transfer direction */
akpm@linux-foundation.orgcadb7342008-01-15 16:01:52 -08002531 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
Tejun Heo93f8fec2007-12-05 16:43:01 +09002532 ata_sg_init(qc, &qc->sgent, 1);
Jeff Garzika939c962005-10-05 17:09:16 -04002533 qc->dma_dir = DMA_FROM_DEVICE;
2534
Tejun Heo6e7846e2006-02-12 23:32:58 +09002535 memset(&qc->cdb, 0, qc->dev->cdb_len);
Jeff Garzika939c962005-10-05 17:09:16 -04002536 qc->cdb[0] = REQUEST_SENSE;
2537 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2538
2539 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2540 qc->tf.command = ATA_CMD_PACKET;
2541
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002542 if (ata_pio_use_silly(ap)) {
Tejun Heo0dc36882007-12-18 16:34:43 -05002543 qc->tf.protocol = ATAPI_PROT_DMA;
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002544 qc->tf.feature |= ATAPI_PKT_DMA;
2545 } else {
Tejun Heo0dc36882007-12-18 16:34:43 -05002546 qc->tf.protocol = ATAPI_PROT_PIO;
Alan Cox2db78dd2007-10-02 13:53:04 -07002547 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2548 qc->tf.lbah = 0;
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002549 }
Jeff Garzika939c962005-10-05 17:09:16 -04002550 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2551
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002552 qc->complete_fn = atapi_sense_complete;
Jeff Garzika939c962005-10-05 17:09:16 -04002553
Tejun Heo8e0e6942006-03-31 20:41:11 +09002554 ata_qc_issue(qc);
Jeff Garzika939c962005-10-05 17:09:16 -04002555
2556 DPRINTK("EXIT\n");
2557}
2558
Christoph Hellwigaa18da82017-01-10 09:41:43 +01002559/*
2560 * ATAPI devices typically report zero for their SCSI version, and sometimes
2561 * deviate from the spec WRT response data format. If SCSI version is
2562 * reported as zero like normal, then we make the following fixups:
2563 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2564 * modern device.
2565 * 2) Ensure response data format / ATAPI information are always correct.
2566 */
2567static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2568{
2569 u8 buf[4];
2570
2571 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2572 if (buf[2] == 0) {
2573 buf[2] = 0x5;
2574 buf[3] = 0x32;
2575 }
2576 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2577}
2578
Tejun Heo77853bf2006-01-23 13:09:36 +09002579static void atapi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580{
2581 struct scsi_cmnd *cmd = qc->scsicmd;
Albert Leea22e2eb2005-12-05 15:38:02 +08002582 unsigned int err_mask = qc->err_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583
Jeff Garzika7dac442005-10-30 04:44:42 -05002584 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
Jeff Garzike12669e2005-10-05 18:39:23 -04002585
Tejun Heo246619d2006-05-15 20:58:16 +09002586 /* handle completion from new EH */
2587 if (unlikely(qc->ap->ops->error_handler &&
2588 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2589
2590 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2591 /* FIXME: not quite right; we don't want the
2592 * translation of taskfile registers into a
2593 * sense descriptors, since that's only
2594 * correct for ATA, not ATAPI
2595 */
Tejun Heo750426a2006-11-14 22:37:35 +09002596 ata_gen_passthru_sense(qc);
Tejun Heo246619d2006-05-15 20:58:16 +09002597 }
2598
Tejun Heo22aac082006-08-08 14:08:59 +09002599 /* SCSI EH automatically locks door if sdev->locked is
2600 * set. Sometimes door lock request continues to
2601 * fail, for example, when no media is present. This
2602 * creates a loop - SCSI EH issues door lock which
2603 * fails and gets invoked again to acquire sense data
2604 * for the failed command.
2605 *
2606 * If door lock fails, always clear sdev->locked to
2607 * avoid this infinite loop.
Tejun Heo2a5f07b2010-11-01 11:39:19 +01002608 *
2609 * This may happen before SCSI scan is complete. Make
2610 * sure qc->dev->sdev isn't NULL before dereferencing.
Tejun Heo22aac082006-08-08 14:08:59 +09002611 */
Tejun Heo2a5f07b2010-11-01 11:39:19 +01002612 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
Tejun Heo22aac082006-08-08 14:08:59 +09002613 qc->dev->sdev->locked = 0;
2614
Tejun Heo246619d2006-05-15 20:58:16 +09002615 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
Christoph Hellwig2aa8f5d2015-10-08 10:25:41 +02002616 ata_qc_done(qc);
Tejun Heo246619d2006-05-15 20:58:16 +09002617 return;
2618 }
2619
2620 /* successful completion or old EH failure path */
Jeff Garzika7dac442005-10-30 04:44:42 -05002621 if (unlikely(err_mask & AC_ERR_DEV)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 cmd->result = SAM_STAT_CHECK_CONDITION;
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002623 atapi_request_sense(qc);
Tejun Heo77853bf2006-01-23 13:09:36 +09002624 return;
Tejun Heo74e6c8c2006-04-02 18:51:53 +09002625 } else if (unlikely(err_mask)) {
Jeff Garzika7dac442005-10-30 04:44:42 -05002626 /* FIXME: not quite right; we don't want the
2627 * translation of taskfile registers into
2628 * a sense descriptors, since that's only
2629 * correct for ATA, not ATAPI
2630 */
Tejun Heo750426a2006-11-14 22:37:35 +09002631 ata_gen_passthru_sense(qc);
Tejun Heo74e6c8c2006-04-02 18:51:53 +09002632 } else {
Christoph Hellwigaa18da82017-01-10 09:41:43 +01002633 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2634 atapi_fixup_inquiry(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635 cmd->result = SAM_STAT_GOOD;
2636 }
2637
Christoph Hellwig2aa8f5d2015-10-08 10:25:41 +02002638 ata_qc_done(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639}
2640/**
2641 * atapi_xlat - Initialize PACKET taskfile
2642 * @qc: command structure to be initialized
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 *
2644 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04002645 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646 *
2647 * RETURNS:
2648 * Zero on success, non-zero on failure.
2649 */
Tejun Heoad706992006-12-17 10:45:57 +09002650static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651{
Tejun Heo542b1442006-12-17 10:45:08 +09002652 struct scsi_cmnd *scmd = qc->scsicmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653 struct ata_device *dev = qc->dev;
Tejun Heo542b1442006-12-17 10:45:08 +09002654 int nodata = (scmd->sc_data_direction == DMA_NONE);
Tejun Heo5895ef92008-06-17 12:36:26 +09002655 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
Alan Cox2db78dd2007-10-02 13:53:04 -07002656 unsigned int nbytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657
Tejun Heo2e5704f2006-12-17 10:46:33 +09002658 memset(qc->cdb, 0, dev->cdb_len);
2659 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660
2661 qc->complete_fn = atapi_qc_complete;
2662
2663 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Tejun Heo542b1442006-12-17 10:45:08 +09002664 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 qc->tf.flags |= ATA_TFLAG_WRITE;
2666 DPRINTK("direction: write\n");
2667 }
2668
2669 qc->tf.command = ATA_CMD_PACKET;
Tejun Heoaacda372008-03-18 17:47:43 +09002670 ata_qc_set_pc_nbytes(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671
Tejun Heoe00f1ff2007-06-27 02:47:35 +09002672 /* check whether ATAPI DMA is safe */
Tejun Heo5895ef92008-06-17 12:36:26 +09002673 if (!nodata && !using_pio && atapi_check_dma(qc))
Tejun Heoe00f1ff2007-06-27 02:47:35 +09002674 using_pio = 1;
2675
Tejun Heoe1902222007-11-26 20:58:02 +09002676 /* Some controller variants snoop this value for Packet
2677 * transfers to do state machine and FIFO management. Thus we
2678 * want to set it properly, and for DMA where it is
2679 * effectively meaningless.
2680 */
Tejun Heoaacda372008-03-18 17:47:43 +09002681 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
Alan Cox2db78dd2007-10-02 13:53:04 -07002682
Tejun Heoe1902222007-11-26 20:58:02 +09002683 /* Most ATAPI devices which honor transfer chunk size don't
2684 * behave according to the spec when odd chunk size which
2685 * matches the transfer length is specified. If the number of
2686 * bytes to transfer is 2n+1. According to the spec, what
2687 * should happen is to indicate that 2n+1 is going to be
2688 * transferred and transfer 2n+2 bytes where the last byte is
2689 * padding.
2690 *
2691 * In practice, this doesn't happen. ATAPI devices first
2692 * indicate and transfer 2n bytes and then indicate and
2693 * transfer 2 bytes where the last byte is padding.
2694 *
2695 * This inconsistency confuses several controllers which
2696 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2697 * These controllers use actual number of transferred bytes to
Chengguang Xu8d1e02d2019-02-10 23:19:01 +08002698 * update DMA pointer and transfer of 4n+2 bytes make those
Tejun Heoe1902222007-11-26 20:58:02 +09002699 * controller push DMA pointer by 4n+4 bytes because SATA data
2700 * FISes are aligned to 4 bytes. This causes data corruption
2701 * and buffer overrun.
2702 *
2703 * Always setting nbytes to even number solves this problem
2704 * because then ATAPI devices don't have to split data at 2n
2705 * boundaries.
2706 */
2707 if (nbytes & 0x1)
2708 nbytes++;
2709
Alan Cox2db78dd2007-10-02 13:53:04 -07002710 qc->tf.lbam = (nbytes & 0xFF);
2711 qc->tf.lbah = (nbytes >> 8);
2712
Tejun Heo5895ef92008-06-17 12:36:26 +09002713 if (nodata)
2714 qc->tf.protocol = ATAPI_PROT_NODATA;
2715 else if (using_pio)
2716 qc->tf.protocol = ATAPI_PROT_PIO;
2717 else {
Tejun Heoe00f1ff2007-06-27 02:47:35 +09002718 /* DMA data xfer */
Tejun Heo0dc36882007-12-18 16:34:43 -05002719 qc->tf.protocol = ATAPI_PROT_DMA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720 qc->tf.feature |= ATAPI_PKT_DMA;
2721
Tejun Heo91163002008-02-21 13:25:50 +09002722 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2723 (scmd->sc_data_direction != DMA_TO_DEVICE))
Albert Lee95de7192006-04-04 10:57:18 +08002724 /* some SATA bridges need us to indicate data xfer direction */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 qc->tf.feature |= ATAPI_DMADIR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726 }
2727
Alan Cox2db78dd2007-10-02 13:53:04 -07002728
2729 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2730 as ATAPI tape drives don't get this right otherwise */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 return 0;
2732}
2733
Jeff Garzik2dcb4072007-10-19 06:42:56 -04002734static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
Tejun Heoab5b3a52006-05-31 18:27:34 +09002735{
Tejun Heo071f44b2008-04-07 22:47:22 +09002736 if (!sata_pmp_attached(ap)) {
Dan Carpenter59a5e262017-07-19 13:06:41 +03002737 if (likely(devno >= 0 &&
2738 devno < ata_link_max_devices(&ap->link)))
Tejun Heo41bda9c2007-08-06 18:36:24 +09002739 return &ap->link.device[devno];
2740 } else {
Dan Carpenter59a5e262017-07-19 13:06:41 +03002741 if (likely(devno >= 0 &&
2742 devno < ap->nr_pmp_links))
Tejun Heo41bda9c2007-08-06 18:36:24 +09002743 return &ap->pmp_link[devno].device[0];
2744 }
2745
Tejun Heoab5b3a52006-05-31 18:27:34 +09002746 return NULL;
2747}
2748
Jeff Garzik2dcb4072007-10-19 06:42:56 -04002749static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2750 const struct scsi_device *scsidev)
Tejun Heoab5b3a52006-05-31 18:27:34 +09002751{
Tejun Heo41bda9c2007-08-06 18:36:24 +09002752 int devno;
Tejun Heoab5b3a52006-05-31 18:27:34 +09002753
Tejun Heo41bda9c2007-08-06 18:36:24 +09002754 /* skip commands not addressed to targets we simulate */
Tejun Heo071f44b2008-04-07 22:47:22 +09002755 if (!sata_pmp_attached(ap)) {
Tejun Heo41bda9c2007-08-06 18:36:24 +09002756 if (unlikely(scsidev->channel || scsidev->lun))
2757 return NULL;
2758 devno = scsidev->id;
2759 } else {
2760 if (unlikely(scsidev->id || scsidev->lun))
2761 return NULL;
2762 devno = scsidev->channel;
2763 }
2764
2765 return ata_find_dev(ap, devno);
Tejun Heoab5b3a52006-05-31 18:27:34 +09002766}
2767
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768/**
2769 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2770 * @ap: ATA port to which the device is attached
2771 * @scsidev: SCSI device from which we derive the ATA device
2772 *
2773 * Given various information provided in struct scsi_cmnd,
2774 * map that onto an ATA bus, and using that mapping
2775 * determine which ata_device is associated with the
2776 * SCSI command to be sent.
2777 *
2778 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04002779 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780 *
2781 * RETURNS:
2782 * Associated ATA device, or %NULL if not found.
2783 */
Bartlomiej Zolnierkiewiczec811a92020-03-26 16:58:18 +01002784struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -04002785ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786{
Tejun Heoab5b3a52006-05-31 18:27:34 +09002787 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788
Tejun Heo2486fa52008-07-31 07:52:40 +09002789 if (unlikely(!dev || !ata_dev_enabled(dev)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 return NULL;
2791
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 return dev;
2793}
2794
Jeff Garzikb0955182005-05-12 15:45:22 -04002795/*
2796 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2797 * @byte1: Byte 1 from pass-thru CDB.
2798 *
2799 * RETURNS:
2800 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2801 */
2802static u8
2803ata_scsi_map_proto(u8 byte1)
2804{
2805 switch((byte1 & 0x1e) >> 1) {
Jeff Garzik2dcb4072007-10-19 06:42:56 -04002806 case 3: /* Non-data */
2807 return ATA_PROT_NODATA;
Jeff Garzikb0955182005-05-12 15:45:22 -04002808
Jeff Garzik2dcb4072007-10-19 06:42:56 -04002809 case 6: /* DMA */
2810 case 10: /* UDMA Data-in */
2811 case 11: /* UDMA Data-Out */
2812 return ATA_PROT_DMA;
Jeff Garzikb0955182005-05-12 15:45:22 -04002813
Jeff Garzik2dcb4072007-10-19 06:42:56 -04002814 case 4: /* PIO Data-in */
2815 case 5: /* PIO Data-out */
2816 return ATA_PROT_PIO;
Jeff Garzikb0955182005-05-12 15:45:22 -04002817
Vinayak Kaleee7fb332015-10-27 11:19:15 +05302818 case 12: /* FPDMA */
2819 return ATA_PROT_NCQ;
2820
Jeff Garzik2dcb4072007-10-19 06:42:56 -04002821 case 0: /* Hard Reset */
2822 case 1: /* SRST */
2823 case 8: /* Device Diagnostic */
2824 case 9: /* Device Reset */
2825 case 7: /* DMA Queued */
Jeff Garzik2dcb4072007-10-19 06:42:56 -04002826 case 15: /* Return Response Info */
2827 default: /* Reserved */
2828 break;
Jeff Garzikb0955182005-05-12 15:45:22 -04002829 }
2830
2831 return ATA_PROT_UNKNOWN;
2832}
2833
2834/**
2835 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2836 * @qc: command structure to be initialized
Jeff Garzikb0955182005-05-12 15:45:22 -04002837 *
Minwoo Imb1ffbf82017-06-24 03:41:10 +09002838 * Handles either 12, 16, or 32-byte versions of the CDB.
Jeff Garzikb0955182005-05-12 15:45:22 -04002839 *
2840 * RETURNS:
2841 * Zero on success, non-zero on failure.
2842 */
Tejun Heoad706992006-12-17 10:45:57 +09002843static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
Jeff Garzikb0955182005-05-12 15:45:22 -04002844{
2845 struct ata_taskfile *tf = &(qc->tf);
Tejun Heo542b1442006-12-17 10:45:08 +09002846 struct scsi_cmnd *scmd = qc->scsicmd;
Alan Coxf79d4092006-05-22 16:55:11 +01002847 struct ata_device *dev = qc->dev;
Tejun Heoad706992006-12-17 10:45:57 +09002848 const u8 *cdb = scmd->cmnd;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002849 u16 fp;
Minwoo Imb1ffbf82017-06-24 03:41:10 +09002850 u16 cdb_offset = 0;
Jeff Garzikb0955182005-05-12 15:45:22 -04002851
Minwoo Imb1ffbf82017-06-24 03:41:10 +09002852 /* 7Fh variable length cmd means a ata pass-thru(32) */
2853 if (cdb[0] == VARIABLE_LENGTH_CMD)
2854 cdb_offset = 9;
2855
2856 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
2857 if (tf->protocol == ATA_PROT_UNKNOWN) {
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002858 fp = 1;
Tejun Heo9a405252005-12-02 11:49:11 +09002859 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002860 }
Jeff Garzik8190bdb2006-05-24 01:53:39 -04002861
Minwoo Imb1ffbf82017-06-24 03:41:10 +09002862 if (ata_is_ncq(tf->protocol) && (cdb[2 + cdb_offset] & 0x3) == 0)
Hannes Reinecke5b844b62016-07-14 09:05:48 +09002863 tf->protocol = ATA_PROT_NCQ_NODATA;
2864
Vinayak Kale5f8e7f12015-10-27 13:11:46 +05302865 /* enable LBA */
2866 tf->flags |= ATA_TFLAG_LBA;
2867
Alan Coxae8d4ee2007-11-04 22:05:49 -05002868 /*
Jeff Garzikb0955182005-05-12 15:45:22 -04002869 * 12 and 16 byte CDBs use different offsets to
2870 * provide the various register values.
2871 */
Tejun Heo542b1442006-12-17 10:45:08 +09002872 if (cdb[0] == ATA_16) {
Jeff Garzikb0955182005-05-12 15:45:22 -04002873 /*
2874 * 16-byte CDB - may contain extended commands.
2875 *
2876 * If that is the case, copy the upper byte register values.
2877 */
Tejun Heo542b1442006-12-17 10:45:08 +09002878 if (cdb[1] & 0x01) {
2879 tf->hob_feature = cdb[3];
2880 tf->hob_nsect = cdb[5];
2881 tf->hob_lbal = cdb[7];
2882 tf->hob_lbam = cdb[9];
2883 tf->hob_lbah = cdb[11];
Jeff Garzikb0955182005-05-12 15:45:22 -04002884 tf->flags |= ATA_TFLAG_LBA48;
2885 } else
2886 tf->flags &= ~ATA_TFLAG_LBA48;
2887
2888 /*
2889 * Always copy low byte, device and command registers.
2890 */
Tejun Heo542b1442006-12-17 10:45:08 +09002891 tf->feature = cdb[4];
2892 tf->nsect = cdb[6];
2893 tf->lbal = cdb[8];
2894 tf->lbam = cdb[10];
2895 tf->lbah = cdb[12];
2896 tf->device = cdb[13];
2897 tf->command = cdb[14];
Minwoo Imb1ffbf82017-06-24 03:41:10 +09002898 } else if (cdb[0] == ATA_12) {
Jeff Garzikb0955182005-05-12 15:45:22 -04002899 /*
2900 * 12-byte CDB - incapable of extended commands.
2901 */
2902 tf->flags &= ~ATA_TFLAG_LBA48;
2903
Tejun Heo542b1442006-12-17 10:45:08 +09002904 tf->feature = cdb[3];
2905 tf->nsect = cdb[4];
2906 tf->lbal = cdb[5];
2907 tf->lbam = cdb[6];
2908 tf->lbah = cdb[7];
2909 tf->device = cdb[8];
2910 tf->command = cdb[9];
Minwoo Imb1ffbf82017-06-24 03:41:10 +09002911 } else {
2912 /*
2913 * 32-byte CDB - may contain extended command fields.
2914 *
2915 * If that is the case, copy the upper byte register values.
2916 */
2917 if (cdb[10] & 0x01) {
2918 tf->hob_feature = cdb[20];
2919 tf->hob_nsect = cdb[22];
2920 tf->hob_lbal = cdb[16];
2921 tf->hob_lbam = cdb[15];
2922 tf->hob_lbah = cdb[14];
2923 tf->flags |= ATA_TFLAG_LBA48;
2924 } else
2925 tf->flags &= ~ATA_TFLAG_LBA48;
2926
2927 tf->feature = cdb[21];
2928 tf->nsect = cdb[23];
2929 tf->lbal = cdb[19];
2930 tf->lbam = cdb[18];
2931 tf->lbah = cdb[17];
2932 tf->device = cdb[24];
2933 tf->command = cdb[25];
2934 tf->auxiliary = get_unaligned_be32(&cdb[28]);
Jeff Garzikb0955182005-05-12 15:45:22 -04002935 }
Albert Leefa4453c2007-06-07 15:52:07 +08002936
Hannes Reinecke179b3102016-07-14 09:05:43 +09002937 /* For NCQ commands copy the tag value */
2938 if (ata_is_ncq(tf->protocol))
Jens Axboe4e5b6262018-05-11 12:51:04 -06002939 tf->nsect = qc->hw_tag << 3;
Vinayak Kaleee7fb332015-10-27 11:19:15 +05302940
Albert Leefa4453c2007-06-07 15:52:07 +08002941 /* enforce correct master/slave bit */
2942 tf->device = dev->devno ?
2943 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002944
Tejun Heobd30add2009-09-03 16:08:11 +09002945 switch (tf->command) {
Grant Grundler295124d2010-08-17 10:56:53 -07002946 /* READ/WRITE LONG use a non-standard sect_size */
Tejun Heobd30add2009-09-03 16:08:11 +09002947 case ATA_CMD_READ_LONG:
2948 case ATA_CMD_READ_LONG_ONCE:
2949 case ATA_CMD_WRITE_LONG:
2950 case ATA_CMD_WRITE_LONG_ONCE:
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002951 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
2952 fp = 1;
Tejun Heobd30add2009-09-03 16:08:11 +09002953 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02002954 }
Tejun Heobd30add2009-09-03 16:08:11 +09002955 qc->sect_size = scsi_bufflen(scmd);
Grant Grundler295124d2010-08-17 10:56:53 -07002956 break;
2957
2958 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2959 case ATA_CMD_CFA_WRITE_NE:
2960 case ATA_CMD_CFA_TRANS_SECT:
2961 case ATA_CMD_CFA_WRITE_MULT_NE:
2962 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2963 case ATA_CMD_READ:
2964 case ATA_CMD_READ_EXT:
2965 case ATA_CMD_READ_QUEUED:
2966 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2967 case ATA_CMD_FPDMA_READ:
2968 case ATA_CMD_READ_MULTI:
2969 case ATA_CMD_READ_MULTI_EXT:
2970 case ATA_CMD_PIO_READ:
2971 case ATA_CMD_PIO_READ_EXT:
2972 case ATA_CMD_READ_STREAM_DMA_EXT:
2973 case ATA_CMD_READ_STREAM_EXT:
2974 case ATA_CMD_VERIFY:
2975 case ATA_CMD_VERIFY_EXT:
2976 case ATA_CMD_WRITE:
2977 case ATA_CMD_WRITE_EXT:
2978 case ATA_CMD_WRITE_FUA_EXT:
2979 case ATA_CMD_WRITE_QUEUED:
2980 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
2981 case ATA_CMD_FPDMA_WRITE:
2982 case ATA_CMD_WRITE_MULTI:
2983 case ATA_CMD_WRITE_MULTI_EXT:
2984 case ATA_CMD_WRITE_MULTI_FUA_EXT:
2985 case ATA_CMD_PIO_WRITE:
2986 case ATA_CMD_PIO_WRITE_EXT:
2987 case ATA_CMD_WRITE_STREAM_DMA_EXT:
2988 case ATA_CMD_WRITE_STREAM_EXT:
2989 qc->sect_size = scmd->device->sector_size;
2990 break;
2991
2992 /* Everything else uses 512 byte "sectors" */
2993 default:
2994 qc->sect_size = ATA_SECT_SIZE;
Tejun Heobd30add2009-09-03 16:08:11 +09002995 }
2996
2997 /*
2998 * Set flags so that all registers will be written, pass on
2999 * write indication (used for PIO/DMA setup), result TF is
3000 * copied back and we don't whine too much about its failure.
3001 */
Douglas Gilbertbc496ed2010-02-01 13:11:38 -05003002 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Tejun Heobd30add2009-09-03 16:08:11 +09003003 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3004 tf->flags |= ATA_TFLAG_WRITE;
3005
3006 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3007
3008 /*
3009 * Set transfer length.
3010 *
3011 * TODO: find out if we need to do more here to
3012 * cover scatter/gather case.
3013 */
3014 ata_qc_set_pc_nbytes(qc);
3015
3016 /* We may not issue DMA commands if no DMA mode is set */
Reimar Döffinger6ac586f2021-10-12 08:27:45 +02003017 if (tf->protocol == ATA_PROT_DMA && !ata_dma_enabled(dev)) {
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003018 fp = 1;
Tejun Heobd30add2009-09-03 16:08:11 +09003019 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003020 }
Tejun Heobd30add2009-09-03 16:08:11 +09003021
Eric Biggers2c1ec6f2018-02-03 20:33:51 -08003022 /* We may not issue NCQ commands to devices not supporting NCQ */
3023 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3024 fp = 1;
3025 goto invalid_fld;
3026 }
3027
Albert Lee1dce5892007-06-07 15:49:22 +08003028 /* sanity check for pio multi commands */
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003029 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3030 fp = 1;
Albert Lee1dce5892007-06-07 15:49:22 +08003031 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003032 }
Albert Lee1dce5892007-06-07 15:49:22 +08003033
3034 if (is_multi_taskfile(tf)) {
3035 unsigned int multi_count = 1 << (cdb[1] >> 5);
3036
3037 /* compare the passed through multi_count
3038 * with the cached multi_count of libata
3039 */
3040 if (multi_count != dev->multi_count)
Joe Perchesa9a79df2011-04-15 15:51:59 -07003041 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3042 multi_count);
Alan Coxd26fc952007-07-06 19:13:52 -04003043 }
Albert Lee1dce5892007-06-07 15:49:22 +08003044
Jeff Garzikb0955182005-05-12 15:45:22 -04003045 /*
3046 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3047 * SET_FEATURES - XFER MODE must be preceded/succeeded
3048 * by an update to hardware-specific registers for each
3049 * controller (i.e. the reason for ->set_piomode(),
3050 * ->set_dmamode(), and ->post_set_mode() hooks).
3051 */
Tejun Heobd30add2009-09-03 16:08:11 +09003052 if (tf->command == ATA_CMD_SET_FEATURES &&
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003053 tf->feature == SETFEATURES_XFER) {
3054 fp = (cdb[0] == ATA_16) ? 4 : 3;
Tejun Heo9a405252005-12-02 11:49:11 +09003055 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003056 }
Jeff Garzikb0955182005-05-12 15:45:22 -04003057
3058 /*
Tejun Heobd30add2009-09-03 16:08:11 +09003059 * Filter TPM commands by default. These provide an
3060 * essentially uncontrolled encrypted "back door" between
3061 * applications and the disk. Set libata.allow_tpm=1 if you
3062 * have a real reason for wanting to use them. This ensures
3063 * that installed software cannot easily mess stuff up without
3064 * user intent. DVR type users will probably ship with this enabled
3065 * for movie content management.
Jeff Garzikb0955182005-05-12 15:45:22 -04003066 *
Tejun Heobd30add2009-09-03 16:08:11 +09003067 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3068 * for this and should do in future but that it is not sufficient as
3069 * DCS is an optional feature set. Thus we also do the software filter
3070 * so that we comply with the TC consortium stated goal that the user
3071 * can turn off TC features of their system.
Jeff Garzikb0955182005-05-12 15:45:22 -04003072 */
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003073 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3074 fp = (cdb[0] == ATA_16) ? 14 : 9;
Tejun Heobd30add2009-09-03 16:08:11 +09003075 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003076 }
Tejun Heoe61e0672006-05-15 20:57:40 +09003077
Jeff Garzikb0955182005-05-12 15:45:22 -04003078 return 0;
Tejun Heo9a405252005-12-02 11:49:11 +09003079
3080 invalid_fld:
Hannes Reinecke0df10b82016-04-04 11:44:06 +02003081 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
Tejun Heo9a405252005-12-02 11:49:11 +09003082 return 1;
Jeff Garzikb0955182005-05-12 15:45:22 -04003083}
3084
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003085/**
3086 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3087 * @cmd: SCSI command being translated
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003088 * @trmax: Maximum number of entries that will fit in sector_size bytes.
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003089 * @sector: Starting sector
Shaun Tancheff7b203092016-08-21 23:23:19 -05003090 * @count: Total Range of request in logical sectors
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003091 *
3092 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3093 * descriptor.
3094 *
3095 * Upto 64 entries of the format:
3096 * 63:48 Range Length
3097 * 47:0 LBA
3098 *
3099 * Range Length of 0 is ignored.
3100 * LBA's should be sorted order and not overlap.
3101 *
3102 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003103 *
3104 * Return: Number of bytes copied into sglist.
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003105 */
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003106static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3107 u64 sector, u32 count)
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003108{
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003109 struct scsi_device *sdp = cmd->device;
3110 size_t len = sdp->sector_size;
3111 size_t r;
3112 __le64 *buf;
3113 u32 i = 0;
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003114 unsigned long flags;
3115
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003116 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3117
3118 if (len > ATA_SCSI_RBUF_SIZE)
3119 len = ATA_SCSI_RBUF_SIZE;
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003120
3121 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003122 buf = ((void *)ata_scsi_rbuf);
3123 memset(buf, 0, len);
3124 while (i < trmax) {
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003125 u64 entry = sector |
3126 ((u64)(count > 0xffff ? 0xffff : count) << 48);
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003127 buf[i++] = __cpu_to_le64(entry);
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003128 if (count <= 0xffff)
3129 break;
3130 count -= 0xffff;
3131 sector += 0xffff;
3132 }
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003133 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003134 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3135
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003136 return r;
Shaun Tancheff9379e6b2016-08-21 23:23:18 -05003137}
3138
Shaun Tancheff7b203092016-08-21 23:23:19 -05003139/**
Shaun Tancheff7b203092016-08-21 23:23:19 -05003140 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3141 * @qc: Command to be translated
3142 *
3143 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3144 * an SCT Write Same command.
Mauro Carvalho Chehab6baf20b2017-05-16 09:16:18 -03003145 * Based on WRITE SAME has the UNMAP flag:
3146 *
3147 * - When set translate to DSM TRIM
3148 * - When clear translate to SCT Write Same
Shaun Tancheff7b203092016-08-21 23:23:19 -05003149 */
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003150static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3151{
3152 struct ata_taskfile *tf = &qc->tf;
3153 struct scsi_cmnd *scmd = qc->scsicmd;
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003154 struct scsi_device *sdp = scmd->device;
3155 size_t len = sdp->sector_size;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003156 struct ata_device *dev = qc->dev;
3157 const u8 *cdb = scmd->cmnd;
3158 u64 block;
3159 u32 n_block;
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003160 const u32 trmax = len >> 3;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003161 u32 size;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003162 u16 fp;
Hannes Reinecke0df10b82016-04-04 11:44:06 +02003163 u8 bp = 0xff;
Shaun Tancheff7b203092016-08-21 23:23:19 -05003164 u8 unmap = cdb[1] & 0x8;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003165
3166 /* we may not issue DMA commands if no DMA mode is set */
Reimar Döffinger6ac586f2021-10-12 08:27:45 +02003167 if (unlikely(!ata_dma_enabled(dev)))
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003168 goto invalid_opcode;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003169
Christoph Hellwigc6ade202017-04-25 13:39:54 +02003170 /*
3171 * We only allow sending this command through the block layer,
3172 * as it modifies the DATA OUT buffer, which would corrupt user
3173 * memory for SG_IO commands.
3174 */
Bart Van Asschec8329cd2021-08-09 16:03:10 -07003175 if (unlikely(blk_rq_is_passthrough(scsi_cmd_to_rq(scmd))))
Christoph Hellwigc6ade202017-04-25 13:39:54 +02003176 goto invalid_opcode;
3177
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003178 if (unlikely(scmd->cmd_len < 16)) {
3179 fp = 15;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003180 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003181 }
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003182 scsi_16_lba_len(cdb, &block, &n_block);
3183
Christoph Hellwig63ccc192017-04-25 14:26:52 +02003184 if (!unmap ||
3185 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3186 !ata_id_has_trim(dev->id)) {
3187 fp = 1;
3188 bp = 3;
3189 goto invalid_fld;
3190 }
3191 /* If the request is too large the cmd is invalid */
3192 if (n_block > 0xffff * trmax) {
3193 fp = 2;
3194 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003195 }
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003196
3197 /*
3198 * WRITE SAME always has a sector sized buffer as payload, this
3199 * should never be a multiple entry S/G list.
3200 */
3201 if (!scsi_sg_count(scmd))
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003202 goto invalid_param_len;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003203
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003204 /*
3205 * size must match sector size in bytes
3206 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3207 * is defined as number of 512 byte blocks to be transferred.
3208 */
Shaun Tancheffef2d7392016-08-24 13:08:14 -05003209
Christoph Hellwig63ccc192017-04-25 14:26:52 +02003210 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3211 if (size != len)
3212 goto invalid_param_len;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003213
Christoph Hellwig63ccc192017-04-25 14:26:52 +02003214 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3215 /* Newer devices support queued TRIM commands */
3216 tf->protocol = ATA_PROT_NCQ;
3217 tf->command = ATA_CMD_FPDMA_SEND;
3218 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
Jens Axboe4e5b6262018-05-11 12:51:04 -06003219 tf->nsect = qc->hw_tag << 3;
Christoph Hellwig63ccc192017-04-25 14:26:52 +02003220 tf->hob_feature = (size / 512) >> 8;
3221 tf->feature = size / 512;
3222
3223 tf->auxiliary = 1;
Marc Carino87fb6c32013-08-24 23:22:51 -07003224 } else {
Shaun Tancheff7b203092016-08-21 23:23:19 -05003225 tf->protocol = ATA_PROT_DMA;
Christoph Hellwig63ccc192017-04-25 14:26:52 +02003226 tf->hob_feature = 0;
3227 tf->feature = ATA_DSM_TRIM;
3228 tf->hob_nsect = (size / 512) >> 8;
3229 tf->nsect = size / 512;
3230 tf->command = ATA_CMD_DSM;
Marc Carino87fb6c32013-08-24 23:22:51 -07003231 }
3232
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003233 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3234 ATA_TFLAG_WRITE;
3235
3236 ata_qc_set_pc_nbytes(qc);
3237
3238 return 0;
3239
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003240invalid_fld:
Hannes Reinecke0df10b82016-04-04 11:44:06 +02003241 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003242 return 1;
3243invalid_param_len:
3244 /* "Parameter list length error" */
3245 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3246 return 1;
3247invalid_opcode:
3248 /* "Invalid command operation code" */
3249 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003250 return 1;
3251}
3252
Linus Torvalds1da177e2005-04-16 15:20:36 -07003253/**
Shaun Tancheff7b203092016-08-21 23:23:19 -05003254 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3255 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3256 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3257 *
3258 * Yields a subset to satisfy scsi_report_opcode()
3259 *
3260 * LOCKING:
3261 * spin_lock_irqsave(host lock)
3262 */
3263static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3264{
3265 struct ata_device *dev = args->dev;
3266 u8 *cdb = args->cmd->cmnd;
3267 u8 supported = 0;
3268 unsigned int err = 0;
3269
3270 if (cdb[2] != 1) {
3271 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3272 err = 2;
3273 goto out;
3274 }
3275 switch (cdb[3]) {
3276 case INQUIRY:
3277 case MODE_SENSE:
3278 case MODE_SENSE_10:
3279 case READ_CAPACITY:
3280 case SERVICE_ACTION_IN_16:
3281 case REPORT_LUNS:
3282 case REQUEST_SENSE:
3283 case SYNCHRONIZE_CACHE:
3284 case REZERO_UNIT:
3285 case SEEK_6:
3286 case SEEK_10:
3287 case TEST_UNIT_READY:
3288 case SEND_DIAGNOSTIC:
3289 case MAINTENANCE_IN:
3290 case READ_6:
3291 case READ_10:
3292 case READ_16:
3293 case WRITE_6:
3294 case WRITE_10:
3295 case WRITE_16:
3296 case ATA_12:
3297 case ATA_16:
3298 case VERIFY:
3299 case VERIFY_16:
3300 case MODE_SELECT:
3301 case MODE_SELECT_10:
3302 case START_STOP:
3303 supported = 3;
3304 break;
Shaun Tancheff7b203092016-08-21 23:23:19 -05003305 case ZBC_IN:
3306 case ZBC_OUT:
3307 if (ata_id_zoned_cap(dev->id) ||
3308 dev->class == ATA_DEV_ZAC)
3309 supported = 3;
3310 break;
Christoph Hellwig818831c2017-06-04 14:42:24 +02003311 case SECURITY_PROTOCOL_IN:
3312 case SECURITY_PROTOCOL_OUT:
3313 if (dev->flags & ATA_DFLAG_TRUSTED)
3314 supported = 3;
3315 break;
Shaun Tancheff7b203092016-08-21 23:23:19 -05003316 default:
3317 break;
3318 }
3319out:
3320 rbuf[1] = supported; /* supported */
3321 return err;
3322}
3323
3324/**
Hannes Reinecke28a3fc22016-04-25 12:45:52 +02003325 * ata_scsi_report_zones_complete - convert ATA output
3326 * @qc: command structure returning the data
3327 *
3328 * Convert T-13 little-endian field representation into
3329 * T-10 big-endian field representation.
3330 * What a mess.
3331 */
3332static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3333{
3334 struct scsi_cmnd *scmd = qc->scsicmd;
3335 struct sg_mapping_iter miter;
3336 unsigned long flags;
3337 unsigned int bytes = 0;
3338
3339 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3340 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3341
3342 local_irq_save(flags);
3343 while (sg_miter_next(&miter)) {
3344 unsigned int offset = 0;
3345
3346 if (bytes == 0) {
3347 char *hdr;
3348 u32 list_length;
3349 u64 max_lba, opt_lba;
3350 u16 same;
3351
3352 /* Swizzle header */
3353 hdr = miter.addr;
3354 list_length = get_unaligned_le32(&hdr[0]);
3355 same = get_unaligned_le16(&hdr[4]);
3356 max_lba = get_unaligned_le64(&hdr[8]);
3357 opt_lba = get_unaligned_le64(&hdr[16]);
3358 put_unaligned_be32(list_length, &hdr[0]);
3359 hdr[4] = same & 0xf;
3360 put_unaligned_be64(max_lba, &hdr[8]);
3361 put_unaligned_be64(opt_lba, &hdr[16]);
3362 offset += 64;
3363 bytes += 64;
3364 }
3365 while (offset < miter.length) {
3366 char *rec;
3367 u8 cond, type, non_seq, reset;
3368 u64 size, start, wp;
3369
3370 /* Swizzle zone descriptor */
3371 rec = miter.addr + offset;
3372 type = rec[0] & 0xf;
3373 cond = (rec[1] >> 4) & 0xf;
3374 non_seq = (rec[1] & 2);
3375 reset = (rec[1] & 1);
3376 size = get_unaligned_le64(&rec[8]);
3377 start = get_unaligned_le64(&rec[16]);
3378 wp = get_unaligned_le64(&rec[24]);
3379 rec[0] = type;
3380 rec[1] = (cond << 4) | non_seq | reset;
3381 put_unaligned_be64(size, &rec[8]);
3382 put_unaligned_be64(start, &rec[16]);
3383 put_unaligned_be64(wp, &rec[24]);
3384 WARN_ON(offset + 64 > miter.length);
3385 offset += 64;
3386 bytes += 64;
3387 }
3388 }
3389 sg_miter_stop(&miter);
3390 local_irq_restore(flags);
3391
3392 ata_scsi_qc_complete(qc);
3393}
3394
3395static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3396{
3397 struct ata_taskfile *tf = &qc->tf;
3398 struct scsi_cmnd *scmd = qc->scsicmd;
3399 const u8 *cdb = scmd->cmnd;
3400 u16 sect, fp = (u16)-1;
3401 u8 sa, options, bp = 0xff;
3402 u64 block;
3403 u32 n_block;
3404
3405 if (unlikely(scmd->cmd_len < 16)) {
3406 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3407 scmd->cmd_len);
3408 fp = 15;
3409 goto invalid_fld;
3410 }
3411 scsi_16_lba_len(cdb, &block, &n_block);
3412 if (n_block != scsi_bufflen(scmd)) {
3413 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3414 n_block, scsi_bufflen(scmd));
3415 goto invalid_param_len;
3416 }
3417 sa = cdb[1] & 0x1f;
3418 if (sa != ZI_REPORT_ZONES) {
3419 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3420 fp = 1;
3421 goto invalid_fld;
3422 }
3423 /*
3424 * ZAC allows only for transfers in 512 byte blocks,
3425 * and uses a 16 bit value for the transfer count.
3426 */
3427 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3428 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3429 goto invalid_param_len;
3430 }
3431 sect = n_block / 512;
Damien Le Moal3f174222016-07-14 09:05:49 +09003432 options = cdb[14] & 0xbf;
Hannes Reinecke28a3fc22016-04-25 12:45:52 +02003433
3434 if (ata_ncq_enabled(qc->dev) &&
3435 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3436 tf->protocol = ATA_PROT_NCQ;
3437 tf->command = ATA_CMD_FPDMA_RECV;
3438 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
Jens Axboe4e5b6262018-05-11 12:51:04 -06003439 tf->nsect = qc->hw_tag << 3;
Hannes Reinecke28a3fc22016-04-25 12:45:52 +02003440 tf->feature = sect & 0xff;
3441 tf->hob_feature = (sect >> 8) & 0xff;
Damien Le Moal3f174222016-07-14 09:05:49 +09003442 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
Hannes Reinecke28a3fc22016-04-25 12:45:52 +02003443 } else {
3444 tf->command = ATA_CMD_ZAC_MGMT_IN;
3445 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3446 tf->protocol = ATA_PROT_DMA;
3447 tf->hob_feature = options;
3448 tf->hob_nsect = (sect >> 8) & 0xff;
3449 tf->nsect = sect & 0xff;
3450 }
3451 tf->device = ATA_LBA;
3452 tf->lbah = (block >> 16) & 0xff;
3453 tf->lbam = (block >> 8) & 0xff;
3454 tf->lbal = block & 0xff;
3455 tf->hob_lbah = (block >> 40) & 0xff;
3456 tf->hob_lbam = (block >> 32) & 0xff;
3457 tf->hob_lbal = (block >> 24) & 0xff;
3458
3459 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3460 qc->flags |= ATA_QCFLAG_RESULT_TF;
3461
3462 ata_qc_set_pc_nbytes(qc);
3463
3464 qc->complete_fn = ata_scsi_report_zones_complete;
3465
3466 return 0;
3467
3468invalid_fld:
3469 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3470 return 1;
3471
3472invalid_param_len:
3473 /* "Parameter list length error" */
3474 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3475 return 1;
3476}
3477
Hannes Reinecke27708a92016-04-25 12:45:53 +02003478static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3479{
3480 struct ata_taskfile *tf = &qc->tf;
3481 struct scsi_cmnd *scmd = qc->scsicmd;
3482 struct ata_device *dev = qc->dev;
3483 const u8 *cdb = scmd->cmnd;
Damien Le Moal2950cef2016-07-14 09:05:51 +09003484 u8 all, sa;
Hannes Reinecke27708a92016-04-25 12:45:53 +02003485 u64 block;
3486 u32 n_block;
3487 u16 fp = (u16)-1;
3488
3489 if (unlikely(scmd->cmd_len < 16)) {
3490 fp = 15;
3491 goto invalid_fld;
3492 }
3493
3494 sa = cdb[1] & 0x1f;
3495 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3496 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3497 fp = 1;
3498 goto invalid_fld;
3499 }
3500
3501 scsi_16_lba_len(cdb, &block, &n_block);
3502 if (n_block) {
3503 /*
3504 * ZAC MANAGEMENT OUT doesn't define any length
3505 */
3506 goto invalid_param_len;
3507 }
Hannes Reinecke27708a92016-04-25 12:45:53 +02003508
Damien Le Moal2950cef2016-07-14 09:05:51 +09003509 all = cdb[14] & 0x1;
Damien Le Moal6edf1d42018-06-26 20:56:55 +09003510 if (all) {
3511 /*
3512 * Ignore the block address (zone ID) as defined by ZBC.
3513 */
3514 block = 0;
3515 } else if (block >= dev->n_sectors) {
Damien Le Moalb320a0a2018-06-26 20:56:54 +09003516 /*
3517 * Block must be a valid zone ID (a zone start LBA).
3518 */
3519 fp = 2;
3520 goto invalid_fld;
3521 }
Hannes Reinecke27708a92016-04-25 12:45:53 +02003522
Hannes Reinecke284b3b72016-04-25 12:45:54 +02003523 if (ata_ncq_enabled(qc->dev) &&
3524 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
Hannes Reinecke5b844b62016-07-14 09:05:48 +09003525 tf->protocol = ATA_PROT_NCQ_NODATA;
Hannes Reinecke284b3b72016-04-25 12:45:54 +02003526 tf->command = ATA_CMD_NCQ_NON_DATA;
Damien Le Moalee194b72016-07-14 09:05:50 +09003527 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
Jens Axboe4e5b6262018-05-11 12:51:04 -06003528 tf->nsect = qc->hw_tag << 3;
Damien Le Moal2950cef2016-07-14 09:05:51 +09003529 tf->auxiliary = sa | ((u16)all << 8);
Hannes Reinecke284b3b72016-04-25 12:45:54 +02003530 } else {
3531 tf->protocol = ATA_PROT_NODATA;
3532 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3533 tf->feature = sa;
Damien Le Moal2950cef2016-07-14 09:05:51 +09003534 tf->hob_feature = all;
Hannes Reinecke284b3b72016-04-25 12:45:54 +02003535 }
Hannes Reinecke27708a92016-04-25 12:45:53 +02003536 tf->lbah = (block >> 16) & 0xff;
3537 tf->lbam = (block >> 8) & 0xff;
3538 tf->lbal = block & 0xff;
3539 tf->hob_lbah = (block >> 40) & 0xff;
3540 tf->hob_lbam = (block >> 32) & 0xff;
3541 tf->hob_lbal = (block >> 24) & 0xff;
3542 tf->device = ATA_LBA;
3543 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3544
3545 return 0;
3546
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547 invalid_fld:
Hannes Reinecke27708a92016-04-25 12:45:53 +02003548 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3549 return 1;
Hannes Reinecke27708a92016-04-25 12:45:53 +02003550invalid_param_len:
3551 /* "Parameter list length error" */
3552 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003553 return 1;
3554}
3555
3556/**
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003557 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3558 * @qc: Storage for translated ATA taskfile
3559 * @buf: input buffer
3560 * @len: number of valid bytes in the input buffer
Hannes Reinecke77800812016-04-04 11:44:07 +02003561 * @fp: out parameter for the failed field on error
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003562 *
3563 * Prepare a taskfile to modify caching information for the device.
3564 *
3565 * LOCKING:
3566 * None.
3567 */
3568static int ata_mselect_caching(struct ata_queued_cmd *qc,
Hannes Reinecke77800812016-04-04 11:44:07 +02003569 const u8 *buf, int len, u16 *fp)
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003570{
3571 struct ata_taskfile *tf = &qc->tf;
3572 struct ata_device *dev = qc->dev;
Tom Yand7372cb2016-07-23 02:34:08 +08003573 u8 mpage[CACHE_MPAGE_LEN];
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003574 u8 wce;
Hannes Reinecke77800812016-04-04 11:44:07 +02003575 int i;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003576
3577 /*
3578 * The first two bytes of def_cache_mpage are a header, so offsets
3579 * in mpage are off by 2 compared to buf. Same for len.
3580 */
3581
Hannes Reinecke77800812016-04-04 11:44:07 +02003582 if (len != CACHE_MPAGE_LEN - 2) {
3583 if (len < CACHE_MPAGE_LEN - 2)
3584 *fp = len;
3585 else
3586 *fp = CACHE_MPAGE_LEN - 2;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003587 return -EINVAL;
Hannes Reinecke77800812016-04-04 11:44:07 +02003588 }
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003589
3590 wce = buf[0] & (1 << 2);
3591
3592 /*
3593 * Check that read-only bits are not modified.
3594 */
3595 ata_msense_caching(dev->id, mpage, false);
Hannes Reinecke77800812016-04-04 11:44:07 +02003596 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3597 if (i == 0)
3598 continue;
3599 if (mpage[i + 2] != buf[i]) {
3600 *fp = i;
3601 return -EINVAL;
3602 }
3603 }
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003604
3605 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3606 tf->protocol = ATA_PROT_NODATA;
3607 tf->nsect = 0;
3608 tf->command = ATA_CMD_SET_FEATURES;
3609 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3610 return 0;
3611}
3612
3613/**
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003614 * ata_mselect_control - Simulate MODE SELECT for control page
3615 * @qc: Storage for translated ATA taskfile
3616 * @buf: input buffer
3617 * @len: number of valid bytes in the input buffer
Hannes Reinecke77800812016-04-04 11:44:07 +02003618 * @fp: out parameter for the failed field on error
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003619 *
3620 * Prepare a taskfile to modify caching information for the device.
3621 *
3622 * LOCKING:
3623 * None.
3624 */
3625static int ata_mselect_control(struct ata_queued_cmd *qc,
Hannes Reinecke77800812016-04-04 11:44:07 +02003626 const u8 *buf, int len, u16 *fp)
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003627{
3628 struct ata_device *dev = qc->dev;
Tom Yand7372cb2016-07-23 02:34:08 +08003629 u8 mpage[CONTROL_MPAGE_LEN];
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003630 u8 d_sense;
Hannes Reinecke77800812016-04-04 11:44:07 +02003631 int i;
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003632
3633 /*
3634 * The first two bytes of def_control_mpage are a header, so offsets
3635 * in mpage are off by 2 compared to buf. Same for len.
3636 */
3637
Hannes Reinecke77800812016-04-04 11:44:07 +02003638 if (len != CONTROL_MPAGE_LEN - 2) {
3639 if (len < CONTROL_MPAGE_LEN - 2)
3640 *fp = len;
3641 else
3642 *fp = CONTROL_MPAGE_LEN - 2;
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003643 return -EINVAL;
Hannes Reinecke77800812016-04-04 11:44:07 +02003644 }
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003645
3646 d_sense = buf[0] & (1 << 2);
3647
3648 /*
3649 * Check that read-only bits are not modified.
3650 */
Tom Yanf086b742016-07-13 02:54:12 +08003651 ata_msense_control(dev, mpage, false);
Hannes Reinecke77800812016-04-04 11:44:07 +02003652 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3653 if (i == 0)
3654 continue;
3655 if (mpage[2 + i] != buf[i]) {
3656 *fp = i;
3657 return -EINVAL;
3658 }
3659 }
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003660 if (d_sense & (1 << 2))
3661 dev->flags |= ATA_DFLAG_D_SENSE;
3662 else
3663 dev->flags &= ~ATA_DFLAG_D_SENSE;
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003664 return 0;
3665}
3666
3667/**
Minwoo Im01efd602017-06-20 19:21:30 +09003668 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003669 * @qc: Storage for translated ATA taskfile
3670 *
3671 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3672 * Assume this is invoked for direct access devices (e.g. disks) only.
3673 * There should be no block descriptor for other device types.
3674 *
3675 * LOCKING:
3676 * spin_lock_irqsave(host lock)
3677 */
3678static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3679{
3680 struct scsi_cmnd *scmd = qc->scsicmd;
3681 const u8 *cdb = scmd->cmnd;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003682 u8 pg, spg;
3683 unsigned six_byte, pg_len, hdr_len, bd_len;
3684 int len;
Hannes Reinecke77800812016-04-04 11:44:07 +02003685 u16 fp = (u16)-1;
3686 u8 bp = 0xff;
Ye Binf650ef62020-06-05 09:41:49 +08003687 u8 buffer[64];
3688 const u8 *p = buffer;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003689
3690 VPRINTK("ENTER\n");
3691
3692 six_byte = (cdb[0] == MODE_SELECT);
3693 if (six_byte) {
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003694 if (scmd->cmd_len < 5) {
3695 fp = 4;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003696 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003697 }
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003698
3699 len = cdb[4];
3700 hdr_len = 4;
3701 } else {
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003702 if (scmd->cmd_len < 9) {
3703 fp = 8;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003704 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003705 }
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003706
3707 len = (cdb[7] << 8) + cdb[8];
3708 hdr_len = 8;
3709 }
3710
3711 /* We only support PF=1, SP=0. */
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003712 if ((cdb[1] & 0x11) != 0x10) {
3713 fp = 1;
Hannes Reinecke0df10b82016-04-04 11:44:06 +02003714 bp = (cdb[1] & 0x01) ? 1 : 5;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003715 goto invalid_fld;
Hannes Reineckebcfc8672016-04-04 11:44:05 +02003716 }
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003717
3718 /* Test early for possible overrun. */
3719 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3720 goto invalid_param_len;
3721
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003722 /* Move past header and block descriptors. */
3723 if (len < hdr_len)
3724 goto invalid_param_len;
3725
Ye Binf650ef62020-06-05 09:41:49 +08003726 if (!sg_copy_to_buffer(scsi_sglist(scmd), scsi_sg_count(scmd),
3727 buffer, sizeof(buffer)))
3728 goto invalid_param_len;
3729
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003730 if (six_byte)
3731 bd_len = p[3];
3732 else
3733 bd_len = (p[6] << 8) + p[7];
3734
3735 len -= hdr_len;
3736 p += hdr_len;
3737 if (len < bd_len)
3738 goto invalid_param_len;
Hannes Reinecke77800812016-04-04 11:44:07 +02003739 if (bd_len != 0 && bd_len != 8) {
3740 fp = (six_byte) ? 3 : 6;
3741 fp += bd_len + hdr_len;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003742 goto invalid_param;
Hannes Reinecke77800812016-04-04 11:44:07 +02003743 }
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003744
3745 len -= bd_len;
3746 p += bd_len;
3747 if (len == 0)
3748 goto skip;
3749
3750 /* Parse both possible formats for the mode page headers. */
3751 pg = p[0] & 0x3f;
3752 if (p[0] & 0x40) {
3753 if (len < 4)
3754 goto invalid_param_len;
3755
3756 spg = p[1];
3757 pg_len = (p[2] << 8) | p[3];
3758 p += 4;
3759 len -= 4;
3760 } else {
3761 if (len < 2)
3762 goto invalid_param_len;
3763
3764 spg = 0;
3765 pg_len = p[1];
3766 p += 2;
3767 len -= 2;
3768 }
3769
3770 /*
3771 * No mode subpages supported (yet) but asking for _all_
3772 * subpages may be valid
3773 */
Hannes Reinecke77800812016-04-04 11:44:07 +02003774 if (spg && (spg != ALL_SUB_MPAGES)) {
3775 fp = (p[0] & 0x40) ? 1 : 0;
3776 fp += hdr_len + bd_len;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003777 goto invalid_param;
Hannes Reinecke77800812016-04-04 11:44:07 +02003778 }
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003779 if (pg_len > len)
3780 goto invalid_param_len;
3781
3782 switch (pg) {
3783 case CACHE_MPAGE:
Hannes Reinecke77800812016-04-04 11:44:07 +02003784 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
3785 fp += hdr_len + bd_len;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003786 goto invalid_param;
Hannes Reinecke77800812016-04-04 11:44:07 +02003787 }
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003788 break;
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003789 case CONTROL_MPAGE:
Hannes Reinecke77800812016-04-04 11:44:07 +02003790 if (ata_mselect_control(qc, p, pg_len, &fp) < 0) {
3791 fp += hdr_len + bd_len;
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003792 goto invalid_param;
Tom Yan535fd072016-07-22 02:41:54 +08003793 } else {
3794 goto skip; /* No ATA command to send */
Hannes Reinecke77800812016-04-04 11:44:07 +02003795 }
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003796 break;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003797 default: /* invalid page code */
Hannes Reinecke77800812016-04-04 11:44:07 +02003798 fp = bd_len + hdr_len;
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003799 goto invalid_param;
3800 }
3801
3802 /*
3803 * Only one page has changeable data, so we only support setting one
3804 * page at a time.
3805 */
3806 if (len > pg_len)
3807 goto invalid_param;
3808
3809 return 0;
3810
3811 invalid_fld:
Hannes Reinecke0df10b82016-04-04 11:44:06 +02003812 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003813 return 1;
3814
3815 invalid_param:
Hannes Reinecke77800812016-04-04 11:44:07 +02003816 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003817 return 1;
3818
3819 invalid_param_len:
3820 /* "Parameter list length error" */
Hannes Reinecke06dbde52016-04-04 11:44:03 +02003821 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003822 return 1;
3823
3824 skip:
3825 scmd->result = SAM_STAT_GOOD;
3826 return 1;
3827}
3828
Christoph Hellwig818831c2017-06-04 14:42:24 +02003829static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
3830{
3831 if (len == 0)
3832 return ATA_CMD_TRUSTED_NONDATA;
3833 else if (send)
3834 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
3835 else
3836 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
3837}
3838
3839static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
3840{
3841 struct scsi_cmnd *scmd = qc->scsicmd;
3842 const u8 *cdb = scmd->cmnd;
3843 struct ata_taskfile *tf = &qc->tf;
3844 u8 secp = cdb[1];
3845 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
3846 u16 spsp = get_unaligned_be16(&cdb[2]);
3847 u32 len = get_unaligned_be32(&cdb[6]);
3848 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
3849
3850 /*
3851 * We don't support the ATA "security" protocol.
3852 */
3853 if (secp == 0xef) {
3854 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
3855 return 1;
3856 }
3857
3858 if (cdb[4] & 7) { /* INC_512 */
3859 if (len > 0xffff) {
3860 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
3861 return 1;
3862 }
3863 } else {
3864 if (len > 0x01fffe00) {
3865 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
3866 return 1;
3867 }
3868
3869 /* convert to the sector-based ATA addressing */
3870 len = (len + 511) / 512;
3871 }
3872
3873 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
3874 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
3875 if (send)
3876 tf->flags |= ATA_TFLAG_WRITE;
3877 tf->command = ata_scsi_trusted_op(len, send, dma);
3878 tf->feature = secp;
3879 tf->lbam = spsp & 0xff;
3880 tf->lbah = spsp >> 8;
3881
3882 if (len) {
3883 tf->nsect = len & 0xff;
3884 tf->lbal = len >> 8;
3885 } else {
3886 if (!send)
3887 tf->lbah = (1 << 7);
3888 }
3889
3890 ata_qc_set_pc_nbytes(qc);
3891 return 0;
3892}
3893
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003894/**
Minwoo Imb1ffbf82017-06-24 03:41:10 +09003895 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
3896 * @qc: Command to be translated
3897 *
3898 * Translate a SCSI variable length CDB to specified commands.
3899 * It checks a service action value in CDB to call corresponding handler.
3900 *
3901 * RETURNS:
3902 * Zero on success, non-zero on failure
3903 *
3904 */
3905static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
3906{
3907 struct scsi_cmnd *scmd = qc->scsicmd;
3908 const u8 *cdb = scmd->cmnd;
3909 const u16 sa = get_unaligned_be16(&cdb[8]);
3910
3911 /*
3912 * if service action represents a ata pass-thru(32) command,
3913 * then pass it to ata_scsi_pass_thru handler.
3914 */
3915 if (sa == ATA_32)
3916 return ata_scsi_pass_thru(qc);
3917
Minwoo Imb1ffbf82017-06-24 03:41:10 +09003918 /* unsupported service action */
3919 return 1;
3920}
3921
3922/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07003923 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3924 * @dev: ATA device
3925 * @cmd: SCSI command opcode to consider
3926 *
3927 * Look up the SCSI command given, and determine whether the
3928 * SCSI command is to be translated or simulated.
3929 *
3930 * RETURNS:
3931 * Pointer to translation function if possible, %NULL if not.
3932 */
3933
3934static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3935{
3936 switch (cmd) {
3937 case READ_6:
3938 case READ_10:
3939 case READ_16:
3940
3941 case WRITE_6:
3942 case WRITE_10:
3943 case WRITE_16:
3944 return ata_scsi_rw_xlat;
3945
Christoph Hellwig0cdd6eb2009-12-10 10:36:01 +01003946 case WRITE_SAME_16:
Christoph Hellwig18f0f972009-11-17 10:00:47 -05003947 return ata_scsi_write_same_xlat;
3948
Linus Torvalds1da177e2005-04-16 15:20:36 -07003949 case SYNCHRONIZE_CACHE:
3950 if (ata_try_flush_cache(dev))
3951 return ata_scsi_flush_xlat;
3952 break;
3953
3954 case VERIFY:
3955 case VERIFY_16:
3956 return ata_scsi_verify_xlat;
Jeff Garzikb0955182005-05-12 15:45:22 -04003957
3958 case ATA_12:
3959 case ATA_16:
3960 return ata_scsi_pass_thru;
Jeff Garzikda613962005-08-29 19:01:43 -04003961
Minwoo Imb1ffbf82017-06-24 03:41:10 +09003962 case VARIABLE_LENGTH_CMD:
3963 return ata_scsi_var_len_cdb_xlat;
3964
Paolo Bonzini1b26d292012-07-05 14:18:21 +02003965 case MODE_SELECT:
3966 case MODE_SELECT_10:
3967 return ata_scsi_mode_select_xlat;
3968 break;
3969
Hannes Reinecke28a3fc22016-04-25 12:45:52 +02003970 case ZBC_IN:
3971 return ata_scsi_zbc_in_xlat;
3972
Hannes Reinecke27708a92016-04-25 12:45:53 +02003973 case ZBC_OUT:
3974 return ata_scsi_zbc_out_xlat;
3975
Christoph Hellwig818831c2017-06-04 14:42:24 +02003976 case SECURITY_PROTOCOL_IN:
3977 case SECURITY_PROTOCOL_OUT:
3978 if (!(dev->flags & ATA_DFLAG_TRUSTED))
3979 break;
3980 return ata_scsi_security_inout_xlat;
3981
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04003982 case START_STOP:
3983 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003984 }
3985
3986 return NULL;
3987}
3988
3989/**
3990 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3991 * @ap: ATA port to which the command was being sent
3992 * @cmd: SCSI command to dump
3993 *
3994 * Prints the contents of a SCSI command via printk().
3995 */
3996
Bartlomiej Zolnierkiewicz15964ff2020-03-26 16:58:19 +01003997void ata_scsi_dump_cdb(struct ata_port *ap, struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003998{
Paul Menzel32a53422018-07-08 09:11:34 +02003999#ifdef ATA_VERBOSE_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -07004000 struct scsi_device *scsidev = cmd->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004001
Paul Menzel32a53422018-07-08 09:11:34 +02004002 VPRINTK("CDB (%u:%d,%d,%lld) %9ph\n",
Tejun Heo44877b42007-02-21 01:06:51 +09004003 ap->print_id,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004004 scsidev->channel, scsidev->id, scsidev->lun,
Andy Shevchenko26f58832016-05-06 21:40:40 +03004005 cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004006#endif
4007}
4008
Bartlomiej Zolnierkiewicz15964ff2020-03-26 16:58:19 +01004009int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev)
Brian Kingeb3f0f92006-03-23 17:30:02 -06004010{
Mark Lordbaf4fdf2007-08-08 01:08:45 +09004011 u8 scsi_op = scmd->cmnd[0];
4012 ata_xlat_func_t xlat_func;
Tejun Heo2115ea92006-05-15 21:03:39 +09004013 int rc = 0;
4014
Hannes Reinecke9162c652014-11-05 13:08:21 +01004015 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
Mark Lordbaf4fdf2007-08-08 01:08:45 +09004016 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
4017 goto bad_cdb_len;
4018
4019 xlat_func = ata_get_xlat_func(dev, scsi_op);
4020 } else {
4021 if (unlikely(!scmd->cmd_len))
4022 goto bad_cdb_len;
4023
4024 xlat_func = NULL;
4025 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4026 /* relay SCSI command to ATAPI device */
Mark Lord607126c2007-11-15 13:13:59 +09004027 int len = COMMAND_SIZE(scsi_op);
Eric Biggers058f58e2018-02-03 20:30:56 -08004028 if (unlikely(len > scmd->cmd_len ||
4029 len > dev->cdb_len ||
4030 scmd->cmd_len > ATAPI_CDB_LEN))
Mark Lordbaf4fdf2007-08-08 01:08:45 +09004031 goto bad_cdb_len;
4032
4033 xlat_func = atapi_xlat;
4034 } else {
4035 /* ATA_16 passthru, treat as an ATA command */
4036 if (unlikely(scmd->cmd_len > 16))
4037 goto bad_cdb_len;
4038
4039 xlat_func = ata_get_xlat_func(dev, scsi_op);
4040 }
Tejun Heo2e5704f2006-12-17 10:46:33 +09004041 }
4042
Mark Lordbaf4fdf2007-08-08 01:08:45 +09004043 if (xlat_func)
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05004044 rc = ata_scsi_translate(dev, scmd, xlat_func);
Mark Lordbaf4fdf2007-08-08 01:08:45 +09004045 else
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05004046 ata_scsi_simulate(dev, scmd);
Tejun Heo2115ea92006-05-15 21:03:39 +09004047
4048 return rc;
Mark Lordbaf4fdf2007-08-08 01:08:45 +09004049
4050 bad_cdb_len:
4051 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
4052 scmd->cmd_len, scsi_op, dev->cdb_len);
4053 scmd->result = DID_ERROR << 16;
Bart Van Assche58bf2012021-10-07 13:27:58 -07004054 scsi_done(scmd);
Mark Lordbaf4fdf2007-08-08 01:08:45 +09004055 return 0;
Brian Kingeb3f0f92006-03-23 17:30:02 -06004056}
4057
Linus Torvalds1da177e2005-04-16 15:20:36 -07004058/**
4059 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
Jeff Garzik23e701e2010-11-17 12:03:58 -05004060 * @shost: SCSI host of command to be sent
Linus Torvalds1da177e2005-04-16 15:20:36 -07004061 * @cmd: SCSI command to be sent
Linus Torvalds1da177e2005-04-16 15:20:36 -07004062 *
4063 * In some cases, this function translates SCSI commands into
4064 * ATA taskfiles, and queues the taskfiles to be sent to
4065 * hardware. In other cases, this function simulates a
4066 * SCSI device by evaluating and responding to certain
4067 * SCSI commands. This creates the overall effect of
4068 * ATA and ATAPI devices appearing as SCSI devices.
4069 *
4070 * LOCKING:
Jeff Garzik23e701e2010-11-17 12:03:58 -05004071 * ATA host lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07004072 *
4073 * RETURNS:
Tejun Heo2115ea92006-05-15 21:03:39 +09004074 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4075 * 0 otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004076 */
Jeff Garzik23e701e2010-11-17 12:03:58 -05004077int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004078{
4079 struct ata_port *ap;
4080 struct ata_device *dev;
4081 struct scsi_device *scsidev = cmd->device;
Tejun Heo2115ea92006-05-15 21:03:39 +09004082 int rc = 0;
Jeff Garzik23e701e2010-11-17 12:03:58 -05004083 unsigned long irq_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004084
Jeff Garzik35bb94b2006-04-11 13:12:34 -04004085 ap = ata_shost_to_port(shost);
Jeff Garzik005a5a02005-10-30 23:31:48 -05004086
Jeff Garzik23e701e2010-11-17 12:03:58 -05004087 spin_lock_irqsave(ap->lock, irq_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004088
4089 ata_scsi_dump_cdb(ap, cmd);
4090
4091 dev = ata_scsi_find_dev(ap, scsidev);
Brian Kingeb3f0f92006-03-23 17:30:02 -06004092 if (likely(dev))
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05004093 rc = __ata_scsi_queuecmd(cmd, dev);
Brian Kingeb3f0f92006-03-23 17:30:02 -06004094 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004095 cmd->result = (DID_BAD_TARGET << 16);
Bart Van Assche58bf2012021-10-07 13:27:58 -07004096 scsi_done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004097 }
4098
Jeff Garzik23e701e2010-11-17 12:03:58 -05004099 spin_unlock_irqrestore(ap->lock, irq_flags);
4100
Tejun Heo2115ea92006-05-15 21:03:39 +09004101 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004102}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01004103EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004104
4105/**
4106 * ata_scsi_simulate - simulate SCSI command on ATA device
Randy Dunlapc893a3a2006-01-28 13:15:32 -05004107 * @dev: the target device
Linus Torvalds1da177e2005-04-16 15:20:36 -07004108 * @cmd: SCSI command being sent to device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004109 *
4110 * Interprets and directly executes a select list of SCSI commands
4111 * that can be handled internally.
4112 *
4113 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04004114 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004115 */
4116
Jeff Garzikb27dcfb2010-11-17 22:56:48 -05004117void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004118{
4119 struct ata_scsi_args args;
Jeff Garzik057ace52005-10-22 14:27:05 -04004120 const u8 *scsicmd = cmd->cmnd;
Jeff Garzik45394142007-09-21 06:23:42 -04004121 u8 tmp8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004122
Tejun Heo9a3dccc2006-01-06 09:56:18 +01004123 args.dev = dev;
4124 args.id = dev->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004125 args.cmd = cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004126
4127 switch(scsicmd[0]) {
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004128 case INQUIRY:
Hannes Reineckebcfc8672016-04-04 11:44:05 +02004129 if (scsicmd[1] & 2) /* is CmdDt set? */
Christoph Hellwig8fc6c062017-01-10 09:41:46 +01004130 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004131 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4132 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4133 else switch (scsicmd[2]) {
4134 case 0x00:
4135 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004136 break;
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004137 case 0x80:
4138 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004139 break;
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004140 case 0x83:
4141 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004142 break;
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004143 case 0x89:
4144 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004145 break;
Christoph Hellwig18f0f972009-11-17 10:00:47 -05004146 case 0xb0:
4147 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4148 break;
Matthew Wilcox1e9dbc92008-06-19 13:13:38 -06004149 case 0xb1:
4150 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4151 break;
Martin K. Petersen02e0a602010-09-10 01:23:18 -04004152 case 0xb2:
4153 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4154 break;
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02004155 case 0xb6:
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09004156 if (dev->flags & ATA_DFLAG_ZAC)
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02004157 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09004158 else
4159 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4160 break;
4161 case 0xb9:
4162 if (dev->cpr_log)
4163 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b9);
4164 else
4165 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4166 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004167 default:
Christoph Hellwig8fc6c062017-01-10 09:41:46 +01004168 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004169 break;
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004170 }
4171 break;
4172
4173 case MODE_SENSE:
4174 case MODE_SENSE_10:
4175 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4176 break;
4177
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004178 case READ_CAPACITY:
4179 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4180 break;
4181
Hannes Reineckeeb846d92014-11-17 14:25:19 +01004182 case SERVICE_ACTION_IN_16:
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004183 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4184 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4185 else
Christoph Hellwig8fc6c062017-01-10 09:41:46 +01004186 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004187 break;
4188
4189 case REPORT_LUNS:
4190 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4191 break;
4192
4193 case REQUEST_SENSE:
Hannes Reinecke06dbde52016-04-04 11:44:03 +02004194 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004195 break;
4196
4197 /* if we reach this, then writeback caching is disabled,
4198 * turning this into a no-op.
4199 */
4200 case SYNCHRONIZE_CACHE:
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05004201 fallthrough;
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004202
4203 /* no-op's, complete with success */
4204 case REZERO_UNIT:
4205 case SEEK_6:
4206 case SEEK_10:
4207 case TEST_UNIT_READY:
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004208 break;
4209
4210 case SEND_DIAGNOSTIC:
4211 tmp8 = scsicmd[1] & ~(1 << 3);
Christoph Hellwiga0c0b0e2017-01-10 09:41:47 +01004212 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
Christoph Hellwig8fc6c062017-01-10 09:41:46 +01004213 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004214 break;
4215
Shaun Tancheff7b203092016-08-21 23:23:19 -05004216 case MAINTENANCE_IN:
4217 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4218 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4219 else
Christoph Hellwig8fc6c062017-01-10 09:41:46 +01004220 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
Shaun Tancheff7b203092016-08-21 23:23:19 -05004221 break;
4222
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004223 /* all other commands */
4224 default:
Hannes Reinecke06dbde52016-04-04 11:44:03 +02004225 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004226 /* "Invalid command operation code" */
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004227 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004228 }
Christoph Hellwig8fc6c062017-01-10 09:41:46 +01004229
Bart Van Assche58bf2012021-10-07 13:27:58 -07004230 scsi_done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004231}
4232
Tejun Heof3187192007-04-17 23:44:07 +09004233int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
4234{
4235 int i, rc;
4236
4237 for (i = 0; i < host->n_ports; i++) {
4238 struct ata_port *ap = host->ports[i];
4239 struct Scsi_Host *shost;
4240
4241 rc = -ENOMEM;
4242 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4243 if (!shost)
4244 goto err_alloc;
4245
Lin Ming9ee4f392011-12-05 09:20:28 +08004246 shost->eh_noresume = 1;
Tejun Heof3187192007-04-17 23:44:07 +09004247 *(struct ata_port **)&shost->hostdata[0] = ap;
4248 ap->scsi_host = shost;
4249
Gwendal Grignoud9027472010-05-25 12:31:38 -07004250 shost->transportt = ata_scsi_transport_template;
Tejun Heof3187192007-04-17 23:44:07 +09004251 shost->unique_id = ap->print_id;
4252 shost->max_id = 16;
4253 shost->max_lun = 1;
4254 shost->max_channel = 1;
Minwoo Imb1ffbf82017-06-24 03:41:10 +09004255 shost->max_cmd_len = 32;
Tejun Heof3187192007-04-17 23:44:07 +09004256
Tejun Heo31cc23b2007-09-23 13:14:12 +09004257 /* Schedule policy is determined by ->qc_defer()
4258 * callback and it needs to see every deferred qc.
4259 * Set host_blocked to 1 to prevent SCSI midlayer from
4260 * automatically deferring requests.
4261 */
4262 shost->max_host_blocked = 1;
4263
John Garry1d72f7a2020-02-28 19:33:35 +08004264 rc = scsi_add_host_with_dma(shost, &ap->tdev, ap->host->dev);
Tejun Heof3187192007-04-17 23:44:07 +09004265 if (rc)
John Garry1d72f7a2020-02-28 19:33:35 +08004266 goto err_alloc;
Tejun Heof3187192007-04-17 23:44:07 +09004267 }
4268
4269 return 0;
4270
Tejun Heof3187192007-04-17 23:44:07 +09004271 err_alloc:
4272 while (--i >= 0) {
4273 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4274
John Garry1d72f7a2020-02-28 19:33:35 +08004275 /* scsi_host_put() is in ata_devres_release() */
Tejun Heof3187192007-04-17 23:44:07 +09004276 scsi_remove_host(shost);
Tejun Heof3187192007-04-17 23:44:07 +09004277 }
4278 return rc;
4279}
4280
Linus Walleij45b80842020-02-22 12:20:57 +01004281#ifdef CONFIG_OF
4282static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4283{
4284 struct scsi_device *sdev = dev->sdev;
4285 struct device *d = ap->host->dev;
4286 struct device_node *np = d->of_node;
4287 struct device_node *child;
4288
4289 for_each_available_child_of_node(np, child) {
4290 int ret;
4291 u32 val;
4292
4293 ret = of_property_read_u32(child, "reg", &val);
4294 if (ret)
4295 continue;
4296 if (val == dev->devno) {
4297 dev_dbg(d, "found matching device node\n");
4298 sdev->sdev_gendev.of_node = child;
4299 return;
4300 }
4301 }
4302}
4303#else
4304static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4305{
4306}
4307#endif
4308
Tejun Heo1ae46312007-07-16 14:29:40 +09004309void ata_scsi_scan_host(struct ata_port *ap, int sync)
Jeff Garzik644dd0c2005-10-03 15:55:19 -04004310{
Tejun Heo1ae46312007-07-16 14:29:40 +09004311 int tries = 5;
4312 struct ata_device *last_failed_dev = NULL;
Tejun Heo41bda9c2007-08-06 18:36:24 +09004313 struct ata_link *link;
Tejun Heo1ae46312007-07-16 14:29:40 +09004314 struct ata_device *dev;
Jeff Garzik644dd0c2005-10-03 15:55:19 -04004315
Tejun Heo1ae46312007-07-16 14:29:40 +09004316 repeat:
Tejun Heo1eca4362008-11-03 20:03:17 +09004317 ata_for_each_link(link, ap, EDGE) {
4318 ata_for_each_dev(dev, link, ENABLED) {
Tejun Heo41bda9c2007-08-06 18:36:24 +09004319 struct scsi_device *sdev;
4320 int channel = 0, id = 0;
Jeff Garzik3f19ee82005-10-03 21:36:41 -04004321
Tejun Heo1eca4362008-11-03 20:03:17 +09004322 if (dev->sdev)
Tejun Heo41bda9c2007-08-06 18:36:24 +09004323 continue;
Tejun Heo3edebac2006-05-31 18:27:40 +09004324
Tejun Heo41bda9c2007-08-06 18:36:24 +09004325 if (ata_is_host_link(link))
4326 id = dev->devno;
4327 else
4328 channel = link->pmp;
4329
4330 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4331 NULL);
4332 if (!IS_ERR(sdev)) {
4333 dev->sdev = sdev;
Linus Walleij45b80842020-02-22 12:20:57 +01004334 ata_scsi_assign_ofnode(dev, ap);
Tejun Heo41bda9c2007-08-06 18:36:24 +09004335 scsi_device_put(sdev);
Grant Grundler295124d2010-08-17 10:56:53 -07004336 } else {
4337 dev->sdev = NULL;
Tejun Heo41bda9c2007-08-06 18:36:24 +09004338 }
Tejun Heo3edebac2006-05-31 18:27:40 +09004339 }
Jeff Garzik3f19ee82005-10-03 21:36:41 -04004340 }
Tejun Heo1ae46312007-07-16 14:29:40 +09004341
4342 /* If we scanned while EH was in progress or allocation
4343 * failure occurred, scan would have failed silently. Check
4344 * whether all devices are attached.
4345 */
Tejun Heo1eca4362008-11-03 20:03:17 +09004346 ata_for_each_link(link, ap, EDGE) {
4347 ata_for_each_dev(dev, link, ENABLED) {
4348 if (!dev->sdev)
Tejun Heo41bda9c2007-08-06 18:36:24 +09004349 goto exit_loop;
4350 }
Tejun Heo1ae46312007-07-16 14:29:40 +09004351 }
Tejun Heo41bda9c2007-08-06 18:36:24 +09004352 exit_loop:
4353 if (!link)
Tejun Heo1ae46312007-07-16 14:29:40 +09004354 return;
4355
4356 /* we're missing some SCSI devices */
4357 if (sync) {
4358 /* If caller requested synchrnous scan && we've made
4359 * any progress, sleep briefly and repeat.
4360 */
4361 if (dev != last_failed_dev) {
4362 msleep(100);
4363 last_failed_dev = dev;
4364 goto repeat;
4365 }
4366
4367 /* We might be failing to detect boot device, give it
4368 * a few more chances.
4369 */
4370 if (--tries) {
4371 msleep(100);
4372 goto repeat;
4373 }
4374
Joe Perchesa9a79df2011-04-15 15:51:59 -07004375 ata_port_err(ap,
4376 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
Tejun Heo1ae46312007-07-16 14:29:40 +09004377 }
4378
Tejun Heoad72cf92010-07-02 10:03:52 +02004379 queue_delayed_work(system_long_wq, &ap->hotplug_task,
Tejun Heo1ae46312007-07-16 14:29:40 +09004380 round_jiffies_relative(HZ));
Jeff Garzik644dd0c2005-10-03 15:55:19 -04004381}
Tejun Heo0ea035a2006-05-31 18:28:01 +09004382
4383/**
4384 * ata_scsi_offline_dev - offline attached SCSI device
4385 * @dev: ATA device to offline attached SCSI device for
4386 *
4387 * This function is called from ata_eh_hotplug() and responsible
4388 * for taking the SCSI device attached to @dev offline. This
Jeff Garzikcca39742006-08-24 03:19:22 -04004389 * function is called with host lock which protects dev->sdev
Tejun Heo0ea035a2006-05-31 18:28:01 +09004390 * against clearing.
4391 *
4392 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04004393 * spin_lock_irqsave(host lock)
Tejun Heo0ea035a2006-05-31 18:28:01 +09004394 *
4395 * RETURNS:
4396 * 1 if attached SCSI device exists, 0 otherwise.
4397 */
4398int ata_scsi_offline_dev(struct ata_device *dev)
4399{
4400 if (dev->sdev) {
4401 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4402 return 1;
4403 }
4404 return 0;
4405}
Tejun Heo580b21022006-05-31 18:28:05 +09004406
4407/**
4408 * ata_scsi_remove_dev - remove attached SCSI device
4409 * @dev: ATA device to remove attached SCSI device for
4410 *
4411 * This function is called from ata_eh_scsi_hotplug() and
4412 * responsible for removing the SCSI device attached to @dev.
4413 *
4414 * LOCKING:
4415 * Kernel thread context (may sleep).
4416 */
4417static void ata_scsi_remove_dev(struct ata_device *dev)
4418{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09004419 struct ata_port *ap = dev->link->ap;
Tejun Heo580b21022006-05-31 18:28:05 +09004420 struct scsi_device *sdev;
4421 unsigned long flags;
4422
4423 /* Alas, we need to grab scan_mutex to ensure SCSI device
4424 * state doesn't change underneath us and thus
4425 * scsi_device_get() always succeeds. The mutex locking can
4426 * be removed if there is __scsi_device_get() interface which
4427 * increments reference counts regardless of device state.
4428 */
Jeff Garzikcca39742006-08-24 03:19:22 -04004429 mutex_lock(&ap->scsi_host->scan_mutex);
Jeff Garzikba6a1302006-06-22 23:46:10 -04004430 spin_lock_irqsave(ap->lock, flags);
Tejun Heo580b21022006-05-31 18:28:05 +09004431
Jeff Garzikcca39742006-08-24 03:19:22 -04004432 /* clearing dev->sdev is protected by host lock */
Tejun Heo580b21022006-05-31 18:28:05 +09004433 sdev = dev->sdev;
4434 dev->sdev = NULL;
4435
4436 if (sdev) {
4437 /* If user initiated unplug races with us, sdev can go
Jeff Garzikcca39742006-08-24 03:19:22 -04004438 * away underneath us after the host lock and
Tejun Heo580b21022006-05-31 18:28:05 +09004439 * scan_mutex are released. Hold onto it.
4440 */
4441 if (scsi_device_get(sdev) == 0) {
4442 /* The following ensures the attached sdev is
4443 * offline on return from ata_scsi_offline_dev()
4444 * regardless it wins or loses the race
4445 * against this function.
4446 */
4447 scsi_device_set_state(sdev, SDEV_OFFLINE);
4448 } else {
4449 WARN_ON(1);
4450 sdev = NULL;
4451 }
4452 }
4453
Jeff Garzikba6a1302006-06-22 23:46:10 -04004454 spin_unlock_irqrestore(ap->lock, flags);
Jeff Garzikcca39742006-08-24 03:19:22 -04004455 mutex_unlock(&ap->scsi_host->scan_mutex);
Tejun Heo580b21022006-05-31 18:28:05 +09004456
4457 if (sdev) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07004458 ata_dev_info(dev, "detaching (SCSI %s)\n",
4459 dev_name(&sdev->sdev_gendev));
Tejun Heo580b21022006-05-31 18:28:05 +09004460
4461 scsi_remove_device(sdev);
4462 scsi_device_put(sdev);
4463 }
4464}
4465
Tejun Heo41bda9c2007-08-06 18:36:24 +09004466static void ata_scsi_handle_link_detach(struct ata_link *link)
4467{
4468 struct ata_port *ap = link->ap;
4469 struct ata_device *dev;
4470
Tejun Heo1eca4362008-11-03 20:03:17 +09004471 ata_for_each_dev(dev, link, ALL) {
Tejun Heo41bda9c2007-08-06 18:36:24 +09004472 unsigned long flags;
4473
4474 if (!(dev->flags & ATA_DFLAG_DETACHED))
4475 continue;
4476
4477 spin_lock_irqsave(ap->lock, flags);
4478 dev->flags &= ~ATA_DFLAG_DETACHED;
4479 spin_unlock_irqrestore(ap->lock, flags);
4480
Aaron Luf1bc1e42013-08-23 10:17:54 +08004481 if (zpodd_dev_enabled(dev))
4482 zpodd_exit(dev);
4483
Tejun Heo41bda9c2007-08-06 18:36:24 +09004484 ata_scsi_remove_dev(dev);
4485 }
4486}
4487
Tejun Heo580b21022006-05-31 18:28:05 +09004488/**
Kristen Carlson Accardi2f294962007-08-15 04:11:25 -04004489 * ata_scsi_media_change_notify - send media change event
Randy Dunlapc5d0e6a2007-10-15 17:29:46 -07004490 * @dev: Pointer to the disk device with media change event
Kristen Carlson Accardi2f294962007-08-15 04:11:25 -04004491 *
4492 * Tell the block layer to send a media change notification
4493 * event.
4494 *
4495 * LOCKING:
Tejun Heo854c73a2007-09-23 13:14:11 +09004496 * spin_lock_irqsave(host lock)
Kristen Carlson Accardi2f294962007-08-15 04:11:25 -04004497 */
Tejun Heo854c73a2007-09-23 13:14:11 +09004498void ata_scsi_media_change_notify(struct ata_device *dev)
Kristen Carlson Accardi2f294962007-08-15 04:11:25 -04004499{
Tejun Heo854c73a2007-09-23 13:14:11 +09004500 if (dev->sdev)
Jeff Garzikf26792d2007-10-29 17:18:39 -04004501 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4502 GFP_ATOMIC);
Kristen Carlson Accardi2f294962007-08-15 04:11:25 -04004503}
Kristen Carlson Accardi2f294962007-08-15 04:11:25 -04004504
4505/**
Tejun Heo580b21022006-05-31 18:28:05 +09004506 * ata_scsi_hotplug - SCSI part of hotplug
David Howells65f27f32006-11-22 14:55:48 +00004507 * @work: Pointer to ATA port to perform SCSI hotplug on
Tejun Heo580b21022006-05-31 18:28:05 +09004508 *
4509 * Perform SCSI part of hotplug. It's executed from a separate
4510 * workqueue after EH completes. This is necessary because SCSI
4511 * hot plugging requires working EH and hot unplugging is
4512 * synchronized with hot plugging with a mutex.
4513 *
4514 * LOCKING:
4515 * Kernel thread context (may sleep).
4516 */
David Howells65f27f32006-11-22 14:55:48 +00004517void ata_scsi_hotplug(struct work_struct *work)
Tejun Heo580b21022006-05-31 18:28:05 +09004518{
David Howells65f27f32006-11-22 14:55:48 +00004519 struct ata_port *ap =
4520 container_of(work, struct ata_port, hotplug_task.work);
Tejun Heo41bda9c2007-08-06 18:36:24 +09004521 int i;
Tejun Heo580b21022006-05-31 18:28:05 +09004522
Tejun Heob51e9e52006-06-29 01:29:30 +09004523 if (ap->pflags & ATA_PFLAG_UNLOADING) {
Tejun Heo580b21022006-05-31 18:28:05 +09004524 DPRINTK("ENTER/EXIT - unloading\n");
4525 return;
4526 }
4527
4528 DPRINTK("ENTER\n");
Tejun Heoad72cf92010-07-02 10:03:52 +02004529 mutex_lock(&ap->scsi_scan_mutex);
Tejun Heo580b21022006-05-31 18:28:05 +09004530
Tejun Heo41bda9c2007-08-06 18:36:24 +09004531 /* Unplug detached devices. We cannot use link iterator here
4532 * because PMP links have to be scanned even if PMP is
4533 * currently not attached. Iterate manually.
4534 */
4535 ata_scsi_handle_link_detach(&ap->link);
4536 if (ap->pmp_link)
4537 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4538 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
Tejun Heo580b21022006-05-31 18:28:05 +09004539
4540 /* scan for new ones */
Tejun Heo1ae46312007-07-16 14:29:40 +09004541 ata_scsi_scan_host(ap, 0);
Tejun Heo580b21022006-05-31 18:28:05 +09004542
Tejun Heoad72cf92010-07-02 10:03:52 +02004543 mutex_unlock(&ap->scsi_scan_mutex);
Tejun Heo580b21022006-05-31 18:28:05 +09004544 DPRINTK("EXIT\n");
4545}
Tejun Heo83c47bc2006-05-31 18:28:07 +09004546
4547/**
4548 * ata_scsi_user_scan - indication for user-initiated bus scan
4549 * @shost: SCSI host to scan
4550 * @channel: Channel to scan
4551 * @id: ID to scan
4552 * @lun: LUN to scan
4553 *
4554 * This function is called when user explicitly requests bus
4555 * scan. Set probe pending flag and invoke EH.
4556 *
4557 * LOCKING:
4558 * SCSI layer (we don't care)
4559 *
4560 * RETURNS:
4561 * Zero.
4562 */
Gwendal Grignoud9027472010-05-25 12:31:38 -07004563int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02004564 unsigned int id, u64 lun)
Tejun Heo83c47bc2006-05-31 18:28:07 +09004565{
4566 struct ata_port *ap = ata_shost_to_port(shost);
4567 unsigned long flags;
Tejun Heo41bda9c2007-08-06 18:36:24 +09004568 int devno, rc = 0;
Tejun Heo83c47bc2006-05-31 18:28:07 +09004569
4570 if (!ap->ops->error_handler)
4571 return -EOPNOTSUPP;
4572
Tejun Heo41bda9c2007-08-06 18:36:24 +09004573 if (lun != SCAN_WILD_CARD && lun)
Tejun Heo83c47bc2006-05-31 18:28:07 +09004574 return -EINVAL;
4575
Tejun Heo071f44b2008-04-07 22:47:22 +09004576 if (!sata_pmp_attached(ap)) {
Tejun Heo41bda9c2007-08-06 18:36:24 +09004577 if (channel != SCAN_WILD_CARD && channel)
4578 return -EINVAL;
4579 devno = id;
4580 } else {
4581 if (id != SCAN_WILD_CARD && id)
4582 return -EINVAL;
4583 devno = channel;
4584 }
4585
Jeff Garzikba6a1302006-06-22 23:46:10 -04004586 spin_lock_irqsave(ap->lock, flags);
Tejun Heo83c47bc2006-05-31 18:28:07 +09004587
Tejun Heo41bda9c2007-08-06 18:36:24 +09004588 if (devno == SCAN_WILD_CARD) {
4589 struct ata_link *link;
4590
Tejun Heo1eca4362008-11-03 20:03:17 +09004591 ata_for_each_link(link, ap, EDGE) {
Tejun Heo41bda9c2007-08-06 18:36:24 +09004592 struct ata_eh_info *ehi = &link->eh_info;
Tejun Heob558edd2008-01-24 00:05:14 +09004593 ehi->probe_mask |= ATA_ALL_DEVICES;
Tejun Heocf480622008-01-24 00:05:14 +09004594 ehi->action |= ATA_EH_RESET;
Tejun Heo41bda9c2007-08-06 18:36:24 +09004595 }
Tejun Heo83c47bc2006-05-31 18:28:07 +09004596 } else {
Tejun Heo41bda9c2007-08-06 18:36:24 +09004597 struct ata_device *dev = ata_find_dev(ap, devno);
Tejun Heo83c47bc2006-05-31 18:28:07 +09004598
4599 if (dev) {
Tejun Heo41bda9c2007-08-06 18:36:24 +09004600 struct ata_eh_info *ehi = &dev->link->eh_info;
Tejun Heo9af5c9c2007-08-06 18:36:22 +09004601 ehi->probe_mask |= 1 << dev->devno;
Tejun Heocf480622008-01-24 00:05:14 +09004602 ehi->action |= ATA_EH_RESET;
Tejun Heo83c47bc2006-05-31 18:28:07 +09004603 } else
4604 rc = -EINVAL;
4605 }
4606
Tejun Heo309afcb2006-09-30 18:07:17 +09004607 if (rc == 0) {
Tejun Heo83c47bc2006-05-31 18:28:07 +09004608 ata_port_schedule_eh(ap);
Tejun Heo309afcb2006-09-30 18:07:17 +09004609 spin_unlock_irqrestore(ap->lock, flags);
4610 ata_port_wait_eh(ap);
4611 } else
4612 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo83c47bc2006-05-31 18:28:07 +09004613
4614 return rc;
4615}
zhao, forrest3057ac32006-06-12 12:01:34 +08004616
4617/**
Tejun Heod0171262006-06-12 22:51:14 +09004618 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
David Howells65f27f32006-11-22 14:55:48 +00004619 * @work: Pointer to ATA port to perform scsi_rescan_device()
zhao, forrest3057ac32006-06-12 12:01:34 +08004620 *
Tejun Heod0171262006-06-12 22:51:14 +09004621 * After ATA pass thru (SAT) commands are executed successfully,
Tejun Heoad72cf92010-07-02 10:03:52 +02004622 * libata need to propagate the changes to SCSI layer.
zhao, forrest3057ac32006-06-12 12:01:34 +08004623 *
Tejun Heod0171262006-06-12 22:51:14 +09004624 * LOCKING:
4625 * Kernel thread context (may sleep).
zhao, forrest3057ac32006-06-12 12:01:34 +08004626 */
David Howells65f27f32006-11-22 14:55:48 +00004627void ata_scsi_dev_rescan(struct work_struct *work)
zhao, forrest3057ac32006-06-12 12:01:34 +08004628{
David Howells65f27f32006-11-22 14:55:48 +00004629 struct ata_port *ap =
4630 container_of(work, struct ata_port, scsi_rescan_task);
Tejun Heo41bda9c2007-08-06 18:36:24 +09004631 struct ata_link *link;
Tejun Heof58229f2007-08-06 18:36:23 +09004632 struct ata_device *dev;
Tejun Heof84e7e42006-11-22 11:21:31 +09004633 unsigned long flags;
zhao, forrest3057ac32006-06-12 12:01:34 +08004634
Tejun Heoad72cf92010-07-02 10:03:52 +02004635 mutex_lock(&ap->scsi_scan_mutex);
Tejun Heof84e7e42006-11-22 11:21:31 +09004636 spin_lock_irqsave(ap->lock, flags);
zhao, forrest3057ac32006-06-12 12:01:34 +08004637
Tejun Heo1eca4362008-11-03 20:03:17 +09004638 ata_for_each_link(link, ap, EDGE) {
4639 ata_for_each_dev(dev, link, ENABLED) {
Tejun Heo41bda9c2007-08-06 18:36:24 +09004640 struct scsi_device *sdev = dev->sdev;
Tejun Heof84e7e42006-11-22 11:21:31 +09004641
Tejun Heo1eca4362008-11-03 20:03:17 +09004642 if (!sdev)
Tejun Heo41bda9c2007-08-06 18:36:24 +09004643 continue;
4644 if (scsi_device_get(sdev))
4645 continue;
Tejun Heof84e7e42006-11-22 11:21:31 +09004646
Tejun Heo41bda9c2007-08-06 18:36:24 +09004647 spin_unlock_irqrestore(ap->lock, flags);
4648 scsi_rescan_device(&(sdev->sdev_gendev));
4649 scsi_device_put(sdev);
4650 spin_lock_irqsave(ap->lock, flags);
4651 }
zhao, forrest3057ac32006-06-12 12:01:34 +08004652 }
Tejun Heof84e7e42006-11-22 11:21:31 +09004653
4654 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heoad72cf92010-07-02 10:03:52 +02004655 mutex_unlock(&ap->scsi_scan_mutex);
zhao, forrest3057ac32006-06-12 12:01:34 +08004656}