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