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