2 * Copyright (c) 2015, 2016 Spectra Logic Corporation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification.
11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 * substantially similar to the "NO WARRANTY" disclaimer below
13 * ("Disclaimer") and any redistribution must be conditioned upon
14 * including a substantially similar Disclaimer requirement for further
15 * binary redistribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGES.
30 * Authors: Ken Merry (Spectra Logic Corporation)
33 * SCSI and ATA Shingled Media Recording (SMR) support for camcontrol(8).
34 * This is an implementation of the SCSI ZBC and ATA ZAC specs.
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/ioctl.h>
41 #include <sys/stdint.h>
42 #include <sys/types.h>
43 #include <sys/endian.h>
45 #include <sys/queue.h>
61 #include <cam/cam_debug.h>
62 #include <cam/cam_ccb.h>
63 #include <cam/scsi/scsi_all.h>
64 #include <cam/scsi/scsi_da.h>
65 #include <cam/scsi/scsi_pass.h>
66 #include <cam/scsi/scsi_ch.h>
67 #include <cam/scsi/scsi_message.h>
69 #include "camcontrol.h"
71 static struct scsi_nv zone_cmd_map[] = {
72 { "rz", ZBC_IN_SA_REPORT_ZONES },
73 { "reportzones", ZBC_IN_SA_REPORT_ZONES },
74 { "close", ZBC_OUT_SA_CLOSE },
75 { "finish", ZBC_OUT_SA_FINISH },
76 { "open", ZBC_OUT_SA_OPEN },
77 { "rwp", ZBC_OUT_SA_RWP }
80 static struct scsi_nv zone_rep_opts[] = {
81 { "all", ZBC_IN_REP_ALL_ZONES },
82 { "empty", ZBC_IN_REP_EMPTY },
83 { "imp_open", ZBC_IN_REP_IMP_OPEN },
84 { "exp_open", ZBC_IN_REP_EXP_OPEN },
85 { "closed", ZBC_IN_REP_CLOSED },
86 { "full", ZBC_IN_REP_FULL },
87 { "readonly", ZBC_IN_REP_READONLY },
88 { "ro", ZBC_IN_REP_READONLY },
89 { "offline", ZBC_IN_REP_OFFLINE },
90 { "rwp", ZBC_IN_REP_RESET },
91 { "reset", ZBC_IN_REP_RESET },
92 { "nonseq", ZBC_IN_REP_NON_SEQ },
93 { "nonwp", ZBC_IN_REP_NON_WP }
97 ZONE_OF_NORMAL = 0x00,
98 ZONE_OF_SUMMARY = 0x01,
102 static struct scsi_nv zone_print_opts[] = {
103 { "normal", ZONE_OF_NORMAL },
104 { "summary", ZONE_OF_SUMMARY },
105 { "script", ZONE_OF_SCRIPT }
108 #define ZAC_ATA_SECTOR_COUNT(bcount) (((bcount) / 512) & 0xffff)
112 ZONE_PRINT_MORE_DATA,
127 zone_print_status zone_rz_print(uint8_t *data_ptr, uint32_t valid_len,
128 int ata_format, zone_output_flags out_flags,
129 int first_pass, uint64_t *next_start_lba);
133 zone_rz_print(uint8_t *data_ptr, uint32_t valid_len, int ata_format,
134 zone_output_flags out_flags, int first_pass,
135 uint64_t *next_start_lba)
137 struct scsi_report_zones_hdr *hdr = NULL;
138 struct scsi_report_zones_desc *desc = NULL;
139 uint32_t hdr_len, len;
140 uint64_t max_lba, next_lba = 0;
142 zone_print_status status = ZONE_PRINT_OK;
144 int field_widths[ZONE_NUM_FIELDS];
147 if (valid_len < sizeof(*hdr)) {
148 status = ZONE_PRINT_ERROR;
152 hdr = (struct scsi_report_zones_hdr *)data_ptr;
154 field_widths[ZONE_FW_START] = 11;
155 field_widths[ZONE_FW_LEN] = 6;
156 field_widths[ZONE_FW_WP] = 11;
157 field_widths[ZONE_FW_TYPE] = 13;
158 field_widths[ZONE_FW_COND] = 13;
159 field_widths[ZONE_FW_SEQ] = 14;
160 field_widths[ZONE_FW_RESET] = 16;
162 if (ata_format == 0) {
163 hdr_len = scsi_4btoul(hdr->length);
164 max_lba = scsi_8btou64(hdr->maximum_lba);
166 hdr_len = le32dec(hdr->length);
167 max_lba = le64dec(hdr->maximum_lba);
170 if (hdr_len > (valid_len + sizeof(*hdr))) {
172 status = ZONE_PRINT_MORE_DATA;
175 len = MIN(valid_len - sizeof(*hdr), hdr_len);
177 if (out_flags == ZONE_OF_SCRIPT)
182 if ((out_flags != ZONE_OF_SCRIPT)
183 && (first_pass != 0)) {
184 printf("%zu zones, Maximum LBA %#jx (%ju)\n",
185 hdr_len / sizeof(*desc), (uintmax_t)max_lba,
188 switch (hdr->byte4 & SRZ_SAME_MASK) {
189 case SRZ_SAME_ALL_DIFFERENT:
190 printf("Zone lengths and types may vary\n");
192 case SRZ_SAME_ALL_SAME:
193 printf("Zone lengths and types are all the same\n");
195 case SRZ_SAME_LAST_DIFFERENT:
196 printf("Zone types are the same, last zone length "
199 case SRZ_SAME_TYPES_DIFFERENT:
200 printf("Zone lengths are the same, types vary\n");
203 printf("Unknown SAME field value %#x\n",
204 hdr->byte4 & SRZ_SAME_MASK);
208 if (out_flags == ZONE_OF_SUMMARY) {
209 status = ZONE_PRINT_OK;
213 if ((out_flags == ZONE_OF_NORMAL)
214 && (first_pass != 0)) {
215 printf("%*s %*s %*s %*s %*s %*s %*s\n",
216 field_widths[ZONE_FW_START], "Start LBA",
217 field_widths[ZONE_FW_LEN], "Length",
218 field_widths[ZONE_FW_WP], "WP LBA",
219 field_widths[ZONE_FW_TYPE], "Zone Type",
220 field_widths[ZONE_FW_COND], "Condition",
221 field_widths[ZONE_FW_SEQ], "Sequential",
222 field_widths[ZONE_FW_RESET], "Reset");
225 for (desc = &hdr->desc_list[0]; len >= sizeof(*desc);
226 len -= sizeof(*desc), desc++) {
227 uint64_t length, start_lba, wp_lba;
229 if (ata_format == 0) {
230 length = scsi_8btou64(desc->zone_length);
231 start_lba = scsi_8btou64(desc->zone_start_lba);
232 wp_lba = scsi_8btou64(desc->write_pointer_lba);
234 length = le64dec(desc->zone_length);
235 start_lba = le64dec(desc->zone_start_lba);
236 wp_lba = le64dec(desc->write_pointer_lba);
239 printf("%#*jx, %*ju, %#*jx, ", field_widths[ZONE_FW_START],
240 (uintmax_t)start_lba, field_widths[ZONE_FW_LEN],
241 (uintmax_t)length, field_widths[ZONE_FW_WP],
244 switch (desc->zone_type & SRZ_TYPE_MASK) {
245 case SRZ_TYPE_CONVENTIONAL:
246 snprintf(tmpstr, sizeof(tmpstr), "Conventional");
248 case SRZ_TYPE_SEQ_PREFERRED:
249 case SRZ_TYPE_SEQ_REQUIRED:
250 snprintf(tmpstr, sizeof(tmpstr), "Seq%c%s",
251 word_sep, ((desc->zone_type & SRZ_TYPE_MASK) ==
252 SRZ_TYPE_SEQ_PREFERRED) ? "Preferred" :
256 snprintf(tmpstr, sizeof(tmpstr), "Zone%ctype%c%#x",
257 word_sep, word_sep,desc->zone_type &
261 printf("%*s, ", field_widths[ZONE_FW_TYPE], tmpstr);
263 switch (desc->zone_flags & SRZ_ZONE_COND_MASK) {
264 case SRZ_ZONE_COND_NWP:
265 snprintf(tmpstr, sizeof(tmpstr), "NWP");
267 case SRZ_ZONE_COND_EMPTY:
268 snprintf(tmpstr, sizeof(tmpstr), "Empty");
270 case SRZ_ZONE_COND_IMP_OPEN:
271 snprintf(tmpstr, sizeof(tmpstr), "Implicit%cOpen",
274 case SRZ_ZONE_COND_EXP_OPEN:
275 snprintf(tmpstr, sizeof(tmpstr), "Explicit%cOpen",
278 case SRZ_ZONE_COND_CLOSED:
279 snprintf(tmpstr, sizeof(tmpstr), "Closed");
281 case SRZ_ZONE_COND_READONLY:
282 snprintf(tmpstr, sizeof(tmpstr), "Readonly");
284 case SRZ_ZONE_COND_FULL:
285 snprintf(tmpstr, sizeof(tmpstr), "Full");
287 case SRZ_ZONE_COND_OFFLINE:
288 snprintf(tmpstr, sizeof(tmpstr), "Offline");
291 snprintf(tmpstr, sizeof(tmpstr), "%#x",
292 desc->zone_flags & SRZ_ZONE_COND_MASK);
296 printf("%*s, ", field_widths[ZONE_FW_COND], tmpstr);
298 if (desc->zone_flags & SRZ_ZONE_NON_SEQ)
299 snprintf(tmpstr, sizeof(tmpstr), "Non%cSequential",
302 snprintf(tmpstr, sizeof(tmpstr), "Sequential");
304 printf("%*s, ", field_widths[ZONE_FW_SEQ], tmpstr);
306 if (desc->zone_flags & SRZ_ZONE_RESET)
307 snprintf(tmpstr, sizeof(tmpstr), "Reset%cNeeded",
310 snprintf(tmpstr, sizeof(tmpstr), "No%cReset%cNeeded",
313 printf("%*s\n", field_widths[ZONE_FW_RESET], tmpstr);
315 next_lba = start_lba + length;
318 *next_start_lba = next_lba;
324 zone(struct cam_device *device, int argc, char **argv, char *combinedopt,
325 int task_attr, int retry_count, int timeout, int verbosemode __unused)
327 union ccb *ccb = NULL;
328 int action = -1, rep_option = -1;
332 uint8_t *data_ptr = NULL;
333 uint32_t alloc_len = 65536, valid_len = 0;
334 camcontrol_devtype devtype;
335 int ata_format = 0, use_ncq = 0;
337 zone_print_status zp_status;
338 zone_output_flags out_flags = ZONE_OF_NORMAL;
339 uint8_t *cdb_storage = NULL;
340 int cdb_storage_len = 32;
343 ccb = cam_getccb(device);
345 warnx("%s: error allocating CCB", __func__);
350 CCB_CLEAR_ALL_EXCEPT_HDR(ccb);
352 while ((c = getopt(argc, argv, combinedopt)) != -1) {
358 scsi_nv_status status;
361 status = scsi_get_nv(zone_cmd_map,
362 (sizeof(zone_cmd_map) / sizeof(zone_cmd_map[0])),
363 optarg, &entry_num, SCSI_NV_FLAG_IG_CASE);
364 if (status == SCSI_NV_FOUND)
365 action = zone_cmd_map[entry_num].value;
367 warnx("%s: %s: %s option %s", __func__,
368 (status == SCSI_NV_AMBIGUOUS) ?
369 "ambiguous" : "invalid", "zone command",
379 lba = strtoull(optarg, &endptr, 0);
380 if (*endptr != '\0') {
381 warnx("%s: invalid lba argument %s", __func__,
392 scsi_nv_status status;
395 status = scsi_get_nv(zone_rep_opts,
396 (sizeof(zone_rep_opts) /sizeof(zone_rep_opts[0])),
397 optarg, &entry_num, SCSI_NV_FLAG_IG_CASE);
398 if (status == SCSI_NV_FOUND)
399 rep_option = zone_rep_opts[entry_num].value;
401 warnx("%s: %s: %s option %s", __func__,
402 (status == SCSI_NV_AMBIGUOUS) ?
403 "ambiguous" : "invalid", "report zones",
411 scsi_nv_status status;
414 status = scsi_get_nv(zone_print_opts,
415 (sizeof(zone_print_opts) /
416 sizeof(zone_print_opts[0])), optarg, &entry_num,
417 SCSI_NV_FLAG_IG_CASE);
418 if (status == SCSI_NV_FOUND)
419 out_flags = zone_print_opts[entry_num].value;
421 warnx("%s: %s: %s option %s", __func__,
422 (status == SCSI_NV_AMBIGUOUS) ?
423 "ambiguous" : "invalid", "print",
435 warnx("%s: must specify -c <zone_cmd>", __func__);
439 error = get_device_type(device, retry_count, timeout,
440 /*printerrors*/ 1, &devtype);
442 errx(1, "Unable to determine device type");
444 if (action == ZBC_IN_SA_REPORT_ZONES) {
446 data_ptr = malloc(alloc_len);
447 if (data_ptr == NULL)
448 err(1, "unable to allocate %u bytes", alloc_len);
451 bzero(data_ptr, alloc_len);
455 scsi_zbc_in(&ccb->csio,
456 /*retries*/ retry_count,
458 /*tag_action*/ task_attr,
459 /*service_action*/ action,
460 /*zone_start_lba*/ lba,
461 /*zone_options*/ (rep_option != -1) ?
463 /*data_ptr*/ data_ptr,
464 /*dxfer_len*/ alloc_len,
465 /*sense_len*/ SSD_FULL_SIZE,
466 /*timeout*/ timeout ? timeout : 60000);
471 uint8_t protocol = 0;
472 uint16_t features = 0, sector_count = 0;
473 uint32_t auxiliary = 0;
476 * XXX KDM support the partial bit?
479 command = ATA_ZAC_MANAGEMENT_IN;
481 if (rep_option != -1)
482 features |= (rep_option << 8);
483 sector_count = ZAC_ATA_SECTOR_COUNT(alloc_len);
484 protocol = AP_PROTO_DMA;
486 if (cdb_storage == NULL)
487 cdb_storage = calloc(cdb_storage_len, 1);
488 if (cdb_storage == NULL)
489 err(1, "couldn't allocate memory");
491 command = ATA_RECV_FPDMA_QUEUED;
492 features = ZAC_ATA_SECTOR_COUNT(alloc_len);
493 sector_count = ATA_RFPDMA_ZAC_MGMT_IN << 8;
494 auxiliary = action & 0xf;
495 if (rep_option != -1)
496 auxiliary |= rep_option << 8;
497 protocol = AP_PROTO_FPDMA;
500 error = build_ata_cmd(ccb,
501 /*retry_count*/ retry_count,
502 /*flags*/ CAM_DIR_IN | CAM_DEV_QFRZDIS,
503 /*tag_action*/ task_attr,
504 /*protocol*/ protocol,
505 /*ata_flags*/ AP_FLAG_BYT_BLOK_BLOCKS |
506 AP_FLAG_TLEN_SECT_CNT |
507 AP_FLAG_TDIR_FROM_DEV,
508 /*features*/ features,
509 /*sector_count*/ sector_count,
512 /*auxiliary*/ auxiliary,
513 /*data_ptr*/ data_ptr,
514 /*dxfer_len*/ ZAC_ATA_SECTOR_COUNT(alloc_len)*512,
515 /*cdb_storage*/ cdb_storage,
516 /*cdb_storage_len*/ cdb_storage_len,
517 /*sense_len*/ SSD_FULL_SIZE,
518 /*timeout*/ timeout ? timeout : 60000,
520 /*devtype*/ devtype);
523 warnx("%s: build_ata_cmd() failed, likely "
524 "programmer error", __func__);
533 warnx("%s: Unknown device type %d", __func__,devtype);
536 break; /*NOTREACHED*/
540 * XXX KDM the current methodology is to always send ATA
541 * commands to ATA devices. Need to figure out how to
542 * detect whether a SCSI to ATA translation layer will
543 * translate ZBC IN/OUT commands to the appropriate ZAC
548 scsi_zbc_out(&ccb->csio,
549 /*retries*/ retry_count,
551 /*tag_action*/ task_attr,
552 /*service_action*/ action,
554 /*zone_flags*/ (all_zones != 0) ? ZBC_OUT_ALL : 0,
557 /*sense_len*/ SSD_FULL_SIZE,
558 /*timeout*/ timeout ? timeout : 60000);
563 uint8_t protocol = 0;
564 uint16_t features = 0, sector_count = 0;
565 uint32_t auxiliary = 0;
568 * Note that we're taking advantage of the fact
569 * that the action numbers are the same between the
574 protocol = AP_PROTO_NON_DATA;
575 command = ATA_ZAC_MANAGEMENT_OUT;
576 features = action & 0xf;
578 features |= (ZBC_OUT_ALL << 8);
580 cdb_storage = calloc(cdb_storage_len, 1);
581 if (cdb_storage == NULL)
582 err(1, "couldn't allocate memory");
584 protocol = AP_PROTO_FPDMA;
585 command = ATA_NCQ_NON_DATA;
586 features = ATA_NCQ_ZAC_MGMT_OUT;
587 auxiliary = action & 0xf;
589 auxiliary |= (ZBC_OUT_ALL << 8);
593 error = build_ata_cmd(ccb,
594 /*retry_count*/ retry_count,
595 /*flags*/ CAM_DIR_NONE | CAM_DEV_QFRZDIS,
596 /*tag_action*/ task_attr,
597 /*protocol*/ AP_PROTO_NON_DATA,
598 /*ata_flags*/ AP_FLAG_BYT_BLOK_BYTES |
599 AP_FLAG_TLEN_NO_DATA,
600 /*features*/ features,
601 /*sector_count*/ sector_count,
604 /*auxiliary*/ auxiliary,
607 /*cdb_storage*/ cdb_storage,
608 /*cdb_storage_len*/ cdb_storage_len,
609 /*sense_len*/ SSD_FULL_SIZE,
610 /*timeout*/ timeout ? timeout : 60000,
612 /*devtype*/ devtype);
614 warnx("%s: build_ata_cmd() failed, likely "
615 "programmer error", __func__);
622 warnx("%s: Unknown device type %d", __func__,devtype);
625 break; /*NOTREACHED*/
629 ccb->ccb_h.flags |= CAM_DEV_QFRZDIS;
631 ccb->ccb_h.flags |= CAM_PASS_ERR_RECOVER;
633 error = cam_send_ccb(device, ccb);
635 warn("error sending %s %s CCB", (devtype == CC_DT_SCSI) ?
636 "ZBC" : "ZAC Management",
637 (action == ZBC_IN_SA_REPORT_ZONES) ? "In" : "Out");
642 if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
643 cam_error_print(device, ccb, CAM_ESF_ALL, CAM_EPF_ALL,stderr);
649 * If we aren't reading the list of zones, we're done.
651 if (action != ZBC_IN_SA_REPORT_ZONES)
654 if (ccb->ccb_h.func_code == XPT_SCSI_IO)
655 valid_len = ccb->csio.dxfer_len - ccb->csio.resid;
657 valid_len = ccb->ataio.dxfer_len - ccb->ataio.resid;
659 zp_status = zone_rz_print(data_ptr, valid_len, ata_format, out_flags,
662 if (zp_status == ZONE_PRINT_MORE_DATA) {
663 bzero(ccb, sizeof(*ccb));
665 if (cdb_storage != NULL)
666 bzero(cdb_storage, cdb_storage_len);
668 } else if (zp_status == ZONE_PRINT_ERROR)