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