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