2 .\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006, 2007 Kenneth D. Merry.
3 .\" All rights reserved.
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 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. The name of the author may not be used to endorse or promote products
14 .\" derived from this software without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd CAM control program
50 .Op Fl u Ar unit_number
73 .Op Fl r Ar reporttype
106 .Aq all | device id | bus Ns Op :target:lun
109 .Aq all | device id | bus Ns Op :target:lun
126 .Aq Fl m Ar page[,subpage] | Fl l
134 .Aq Fl a Ar cmd Op args
135 .Aq Fl c Ar cmd Op args
138 .Op Fl i Ar len Ar fmt
140 .Op Fl o Ar len Ar fmt Op args
147 .Aq Fl r Ar len Ar fmt Op args
148 .Aq Fl R Ar len Ar fmt Op args
160 .Op Fl o Ar operation
164 .Op Fl T Ar pp_timeout
165 .Op Fl a Ar enable|disable
166 .Op Fl A Ar enable|disable
167 .Op Fl s Ar enable|disable
168 .Op Fl S Ar enable|disable
189 .Aq all | off | device id | bus Ns Op :target Ns Op :lun
202 .Op Fl D Ar enable|disable
207 .Op Fl T Ar enable|disable
209 .Op Fl W Ar bus_width
223 .Aq Fl a Ar overwrite | block | crypto | exitfailure
277 .Op Fl l Ar high|maximum
281 .Op Fl U Ar user|master
292 .Op Fl s Ar max_sectors
301 .Op Fl s Ar max_sectors
306 .Aq Fl i Ar action | Fl o Ar action
312 .Op Fl R Ar rel_tgt_port
321 .Aq Fl r Ar action | Fl w Ar attrib
324 .Op Fl e Ar elem_addr
325 .Op Fl F Ar form1,form2
327 .Op Fl s Ar start_addr
328 .Op Fl T Ar elem_type
335 .Op Fl s Ar service_action
344 .Op Fl P Ar print_opts
352 .Op Fl p Ar power_cond
354 .Op Fl r Ar restore_src
356 .Op Fl S Ar power_src
362 .Ao Fl r Oo Ns Fl f Ar format | Fl m | Fl U Oc | Fl s Ao Fl f Ar format Fl T Ar time | Fl U Ac Ac
371 utility is designed to provide a way for users to access and control the
378 can cause a loss of data and/or system crashes if used improperly.
380 expert users are encouraged to exercise caution when using this command.
381 Novice users should stay away from this utility.
385 utility has a number of primary functions, many of which support an optional
387 A device identifier can take one of three forms:
390 Specify a device name and unit number combination, like "da5" or "cd3".
392 Specify a bus number and target id.
393 The bus number can be determined from
395 .Dq camcontrol devlist .
396 The lun defaults to 0.
398 Specify the bus, target and lun for a device.
402 The device identifier, if it is specified,
404 come immediately after the function name, and before any generic or
405 function-specific arguments.
410 arguments described below will override any device name or unit number
411 specified beforehand.
418 override a specified bus:target or bus:target:lun, however.
422 primary functions support these generic arguments:
425 SCSI command retry count.
426 In order for this to work, error recovery
430 Instruct the kernel to perform generic SCSI error recovery for the given
432 This is needed in order for the retry count
435 Other than retrying commands, the generic error recovery in
436 the code will generally attempt to spin up drives that are not spinning.
437 It may take some other actions, depending upon the sense code returned from
440 Specify the device type to operate on, e.g.\& "da", "cd".
441 .It Fl Q Ar task_attr
443 task attribute for the command, if it is a
446 This may be ordered, simple, head, or aca.
447 In most cases this is not needed.
448 The default is simple, which works with all
451 The task attribute may also be specified numerically.
453 SCSI command timeout in seconds.
454 This overrides the default timeout for
456 .It Fl u Ar unit_number
457 Specify the device unit number, e.g.\& "1", "5".
459 Be verbose, print out sense information for failed SCSI commands.
462 Primary command functions:
463 .Bl -tag -width periphlist
465 List all physical devices (logical units) attached to the CAM subsystem.
466 This also includes a list of peripheral drivers attached to each device.
469 argument, SCSI bus number, adapter name and unit numbers are printed as
471 On the other hand, with the
473 argument, only the bus adapter, and unit information will be printed, and
474 device information will be omitted.
476 List all peripheral drivers attached to a given physical device (logical
479 Send the SCSI test unit ready (0x00) command to the given device.
482 utility will report whether the device is ready or not.
484 Send a SCSI inquiry command (0x12) to a device.
487 will print out the standard inquiry data, device serial number, and
488 transfer rate information.
489 The user can specify that only certain types of
490 inquiry data be printed:
493 Get the standard inquiry data.
495 Print out the serial number.
496 If this flag is the only one specified,
498 will not print out "Serial Number" before the value returned by the drive.
499 This is to aid in script writing.
501 Print out transfer rate information.
504 Send a ATA identify command (0xec) to a device.
506 Send the SCSI REPORT LUNS (0xA0) command to the given device.
509 will print out the list of logical units (LUNs) supported by the target device.
510 There are a couple of options to modify the output:
513 Just print out a count of LUNs, not the actual LUN numbers.
515 Just print out the LUNs, and do not print out the count.
516 .It Fl r Ar reporttype
517 Specify the type of report to request from the target:
518 .Bl -tag -width 012345678
520 Return the default report.
524 Most targets will support this report if they support the REPORT LUNS
527 Return only well known LUNs.
529 Return all available LUNs.
534 will try to print out LUN numbers in a reasonable format.
535 It can understand the peripheral, flat, LUN and extended LUN formats.
537 Send the SCSI READ CAPACITY command to the given device and display
539 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
540 action will be sent to obtain the full size of the device.
543 will print out the last logical block of the device, and the blocksize of
545 To modify the output format, use the following options:
548 Just print out the blocksize, not the last block or device size.
549 This cannot be used with
554 Print out the device size in human readable (base 2, 1K == 1024) format.
557 and cannot be used with
562 Print out the device size in human readable (base 10, 1K == 1000) format.
564 Skip sending the SCSI READ CAPACITY (10) command.
565 Send only the SCSI READ CAPACITY (16) service action and report
567 When the two do not match, a quirk is needed to resolve the ambiguity.
569 Print out the number of blocks in the device instead of the last logical
572 Quiet, print out the numbers only (separated by a comma if
578 Print out the last logical block or the size of the device only, and omit
582 Note that this command only displays the information, it does not update
583 the kernel data structures.
586 reprobe subcommand to do that.
588 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
591 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
594 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
595 start bit set and the load/eject bit set.
597 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
598 start bit cleared and the load/eject bit set.
600 Tell the kernel to scan all buses in the system (with the
602 argument), the given bus (XPT_SCAN_BUS), bus:target:lun or device
603 (XPT_SCAN_LUN) for new devices or devices that have gone away.
605 may specify a scan of all buses, a single bus, or a lun.
607 on a target is not supported.
609 If a device is specified by peripheral name and unit number, for instance
610 da4, it may only be rescanned if that device currently exists in the CAM EDT
611 (Existing Device Table).
612 If the device is no longer there (see
615 you must use the bus:target:lun form to rescan it.
617 Tell the kernel to refresh the information about the device and
618 notify the upper layer,
620 This includes sending the SCSI READ CAPACITY command and updating
621 the disk size visible to the rest of the system.
623 Tell the kernel to reset all buses in the system (with the
625 argument), the given bus (XPT_RESET_BUS) by issuing a SCSI bus
626 reset for that bus, or to reset the given bus:target:lun or device
627 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
628 connecting to that device.
629 Note that this can have a destructive impact
634 READ DEFECT DATA (10) command (0x37) or the
636 READ DEFECT DATA (12) command (0xB7) to the given device, and
637 print out any combination of: the total number of defects, the primary
638 defect list (PLIST), and the grown defect list (GLIST).
641 Specify the requested format of the defect list.
642 The format argument is
644 Most drives support the physical sector format.
646 support the logical block format.
647 Many drives, if they do not support the
648 requested format, return the data in an alternate format, along with sense
649 information indicating that the requested data format is not supported.
653 attempts to detect this, and print out whatever format the drive returns.
654 If the drive uses a non-standard sense code to report that it does not
655 support the requested format,
657 will probably see the error as a failure to complete the request.
659 The format options are:
662 Print out the list as logical blocks.
663 This is limited to 32-bit block sizes, and isn't supported by many modern
666 Print out the list as logical blocks.
667 This option uses a 64-bit block size.
669 Print out the list in bytes from index format.
671 Print out the list in extended bytes from index format.
672 The extended format allows for ranges of blocks to be printed.
674 Print out the list in physical sector format.
675 Most drives support this format.
677 Print out the list in extended physical sector format.
678 The extended format allows for ranges of blocks to be printed.
681 Print out the grown defect list.
682 This is a list of bad blocks that have
683 been remapped since the disk left the factory.
685 Print out the primary defect list.
686 This is the list of defects that were present in the factory.
688 When printing status information with
690 only print the number of defects.
692 Just print the number of defects, not the list of defects.
694 Specify the starting offset into the defect list.
695 This implies using the
697 READ DEFECT DATA (12) command, as the 10 byte version of the command
698 doesn't support the address descriptor index field.
699 Not all drives support the 12 byte command, and some drives that support
700 the 12 byte command don't support the address descriptor index field.
702 Print out defects in hexadecimal (base 16) form instead of base 10 form.
711 will print out the number of defects given in the READ DEFECT DATA header
712 returned from the drive.
713 Some drives will report 0 defects if neither the primary or grown defect
716 Allows the user to display and optionally edit a SCSI mode page.
718 page formats are located in
719 .Pa /usr/share/misc/scsi_modes .
720 This can be overridden by specifying a different file in the
722 environment variable.
725 command takes several arguments:
728 Use 6 byte MODE commands instead of default 10 byte.
729 Old devices may not support 10 byte MODE commands, while new devices may
730 not be able to report all mode pages with 6 byte commands.
733 starts with 10 byte commands and falls back to 6 byte on error.
735 Disable block descriptors for mode sense.
737 Displays mode page data in binary format.
739 This flag allows the user to edit values in the mode page.
741 either edit mode page values with the text editor pointed to by his
743 environment variable, or supply mode page values via standard input, using
746 uses to display mode page values.
747 The editor will be invoked if
749 detects that standard input is terminal.
751 Lists all available mode pages.
752 If specified more then once, also lists subpages.
753 .It Fl m Ar page[,subpage]
754 This specifies the number of the mode page and optionally subpage the user
755 would like to view and/or edit.
756 This argument is mandatory unless
760 This allows the user to specify the page control field.
762 .Bl -tag -width xxx -compact
774 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
777 function requires the
779 argument to specify SCSI CDB or the
781 argument to specify ATA Command Block registers values.
782 Other arguments are optional, depending on
784 The command and data specification syntax is documented
787 NOTE: If the CDB specified causes data to be transferred to or from the
788 SCSI device in question, you MUST specify either
793 .It Fl a Ar cmd Op args
794 This specifies the content of 12 ATA Command Block registers (command,
795 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
796 lba_high_exp, features_exp, sector_count, sector_count_exp).
797 .It Fl c Ar cmd Op args
798 This specifies the SCSI CDB.
799 SCSI CDBs may be 6, 10, 12 or 16 bytes.
801 Specifies DMA protocol to be used for ATA command.
803 Specifies FPDMA (NCQ) protocol to be used for ATA command.
804 .It Fl i Ar len Ar fmt
805 This specifies the amount of data to read, and how it should be displayed.
809 bytes of data will be read from the device and written to standard output.
810 .It Fl o Ar len Ar fmt Op args
811 This specifies the amount of data to be written to a device, and the data
812 that is to be written.
816 bytes of data will be read from standard input and written to the device.
818 This specifies that 11 result ATA Command Block registers should be displayed
819 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
820 lba_high_exp, sector_count, sector_count_exp), and how.
823 11 result registers will be written to standard output in hex.
826 Allows the user to send an arbitrary Serial
827 Management Protocol (SMP) command to a device.
830 function requires the
832 argument to specify the SMP request to be sent, and the
834 argument to specify the format of the SMP response.
835 The syntax for the SMP request and response arguments is documented in
838 Note that SAS adapters that support SMP passthrough (at least the currently
839 known adapters) do not accept CRC bytes from the user in the request and do
840 not pass CRC bytes back to the user in the response.
841 Therefore users should not include the CRC bytes in the length of the
842 request and not expect CRC bytes to be returned in the response.
844 .It Fl r Ar len Ar fmt Op args
845 This specifies the size of the SMP request, without the CRC bytes, and the
850 bytes of data will be read from standard input and written as the SMP
852 .It Fl R Ar len Ar fmt Op args
853 This specifies the size of the buffer allocated for the SMP response, and
854 the SMP response format.
858 bytes of data will be allocated for the response and the response will be
859 written to standard output.
862 Allows the user to send the Serial Management Protocol (SMP) Report General
865 will display the data returned by the Report General command.
866 If the SMP target supports the long response format, the additional data
867 will be requested and displayed automatically.
870 Request the long response format only.
871 Not all SMP targets support the long response format.
874 to skip sending the initial report general request without the long bit set
875 and only issue a report general request with the long bit set.
878 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
880 This function should be used with some caution, as it can render devices
881 inaccessible, and could potentially cause data corruption as well.
884 argument is required to specify the PHY to operate on.
887 Specify the PHY to operate on.
888 This argument is required.
890 Request the long request/response format.
891 Not all SMP targets support the long response format.
892 For the PHY Control command, this currently only affects whether the
893 request length is set to a value other than 0.
894 .It Fl o Ar operation
895 Specify a PHY control operation.
898 operation may be specified.
899 The operation may be specified numerically (in decimal, hexadecimal, or octal)
900 or one of the following operation names may be specified:
904 It is not necessary to specify this argument.
906 Send the LINK RESET command to the phy.
908 Send the HARD RESET command to the phy.
910 Send the DISABLE command to the phy.
911 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
913 Send the CLEAR ERROR LOG command.
914 This clears the error log counters for the specified phy.
916 Send the CLEAR AFFILIATION command.
917 This clears the affiliation from the STP initiator port with the same SAS
918 address as the SMP initiator that requests the clear operation.
920 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
921 This will cause a SATA port selector to use the given phy as its active phy
922 and make the other phy inactive.
924 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
926 Send the SET ATTACHED DEVICE NAME command to the PHY.
929 argument to specify the device name.
932 Specify the attached device name.
933 This option is needed with the
936 The name is a 64-bit number, and can be specified in decimal, hexadecimal
939 Set the minimum physical link rate for the phy.
940 This is a numeric argument.
941 Currently known link rates are:
944 Do not change current value.
953 Other values may be specified for newer physical link rates.
955 Set the maximum physical link rate for the phy.
956 This is a numeric argument.
959 argument description for known link rate arguments.
960 .It Fl T Ar pp_timeout
961 Set the partial pathway timeout value, in microseconds.
966 specification for more information on this field.
967 .It Fl a Ar enable|disable
968 Enable or disable SATA slumber phy power conditions.
969 .It Fl A Ar enable|disable
970 Enable or disable SATA partial power conditions.
971 .It Fl s Ar enable|disable
972 Enable or disable SAS slumber phy power conditions.
973 .It Fl S Ar enable|disable
974 Enable or disable SAS partial phy power conditions.
977 List phys attached to a SAS expander, the address of the end device
978 attached to the phy, and the inquiry data for that device and peripheral
979 devices attached to that device.
980 The inquiry data and peripheral devices are displayed if available.
983 Turn on the long response format for the underlying SMP commands used for
986 Only print out phys that are attached to a device in the CAM EDT (Existing
990 Send the SMP Report Manufacturer Information command to the device and
991 display the response.
994 Turn on the long response format for the underlying SMP commands used for
998 Turn on CAM debugging printfs in the kernel.
999 This requires options CAMDEBUG
1000 in your kernel config file.
1001 WARNING: enabling debugging printfs currently
1002 causes an EXTREME number of kernel printfs.
1003 You may have difficulty
1004 turning off the debugging printfs once they start, since the kernel will be
1005 busy printing messages and unable to service other requests quickly.
1008 function takes a number of arguments:
1011 Enable CAM_DEBUG_INFO printfs.
1013 Enable CAM_DEBUG_PERIPH printfs.
1015 Enable CAM_DEBUG_TRACE printfs.
1017 Enable CAM_DEBUG_SUBTRACE printfs.
1019 Enable CAM_DEBUG_XPT printfs.
1021 Enable CAM_DEBUG_CDB printfs.
1022 This will cause the kernel to print out the
1023 SCSI CDBs sent to the specified device(s).
1025 Enable CAM_DEBUG_PROBE printfs.
1027 Enable debugging for all devices.
1029 Turn off debugging for all devices
1030 .It bus Ns Op :target Ns Op :lun
1031 Turn on debugging for the given bus, target or lun.
1032 If the lun or target
1033 and lun are not specified, they are wildcarded.
1034 (i.e., just specifying a
1035 bus turns on debugging printfs for all devices on that bus.)
1038 Show or set the number of "tagged openings" or simultaneous transactions
1039 we attempt to queue to a particular device.
1042 command, with no command-specific arguments (i.e., only generic arguments)
1043 prints out the "soft" maximum number of transactions that can be queued to
1044 the device in question.
1045 For more detailed information, use the
1047 argument described below.
1050 Set the number of tags for the given device.
1051 This must be between the
1052 minimum and maximum number set in the kernel quirk table.
1054 most devices that support tagged queueing is a minimum of 2 and a maximum
1056 The minimum and maximum values for a given device may be
1057 determined by using the
1064 subcommand is described below.
1066 Be quiet, and do not report the number of tags.
1067 This is generally used when
1068 setting the number of tags.
1070 The verbose flag has special functionality for the
1075 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1078 This is the amount of capacity for transactions queued to a given device.
1080 This is the number of transactions currently queued to a device.
1082 This is the kernel queue space for transactions.
1083 This count usually mirrors
1084 dev_openings except during error recovery operations when
1085 the device queue is frozen (device is not allowed to receive
1086 commands), the number of dev_openings is reduced, or transaction
1087 replay is occurring.
1089 This is the number of transactions waiting in the kernel queue for capacity
1091 This number is usually zero unless error recovery is in
1094 The held count is the number of CCBs held by peripheral drivers that have
1095 either just been completed or are about to be released to the transport
1096 layer for service by a device.
1097 Held CCBs reserve capacity on a given
1100 This is the current "hard" minimum number of transactions that can be
1101 queued to a device at once.
1104 value above cannot go below this number.
1105 The default value for
1107 is 2, although it may be set higher or lower for various devices.
1109 This is the "hard" maximum number of transactions that can be queued to a
1113 value cannot go above this number.
1114 The default value for
1116 is 255, although it may be set higher or lower for various devices.
1120 Show or negotiate various communication parameters.
1121 Some controllers may
1122 not support setting or changing some of these values.
1124 Adaptec 174x controllers do not support changing a device's sync rate or
1129 will not attempt to set the parameter if the controller indicates that it
1130 does not support setting the parameter.
1131 To find out what the controller
1139 command is described below.
1140 Also, some controller drivers do not support
1141 setting negotiation parameters, even if the underlying controller supports
1142 negotiation changes.
1143 Some controllers, such as the Advansys wide
1144 controllers, support enabling and disabling synchronous negotiation for
1145 a device, but do not support setting the synchronous negotiation rate.
1148 Attempt to make the negotiation settings take effect immediately by sending
1149 a Test Unit Ready command to the device.
1151 Show or set current negotiation settings.
1152 This is the default.
1153 .It Fl D Ar enable|disable
1154 Enable or disable disconnection.
1158 Set the command delay offset.
1160 Be quiet, do not print anything.
1161 This is generally useful when you want to
1162 set a parameter, but do not want any status information.
1163 .It Fl R Ar syncrate
1164 Change the synchronization rate for a device.
1165 The sync rate is a floating
1166 point value specified in MHz.
1169 is a legal value, as is
1171 .It Fl T Ar enable|disable
1172 Enable or disable tagged queueing for a device.
1174 Show or set user negotiation settings.
1175 The default is to show or set
1176 current negotiation settings.
1178 The verbose switch has special meaning for the
1183 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1185 .It Fl W Ar bus_width
1186 Specify the bus width to negotiate with a device.
1189 The only useful values to specify are 8, 16, and 32
1191 The controller must support the bus width in question in order for
1192 the setting to take effect.
1195 In general, sync rate and offset settings will not take effect for a
1196 device until a command has been sent to the device.
1199 switch above will automatically send a Test Unit Ready to the device so
1200 negotiation parameters will take effect.
1204 FORMAT UNIT command to the named device.
1206 .Em WARNING! WARNING! WARNING!
1208 Low level formatting a disk will destroy ALL data on the disk.
1210 extreme caution when issuing this command.
1211 Many users low-level format
1212 disks that do not really need to be low-level formatted.
1214 relatively few scenarios that call for low-level formatting a disk.
1216 low-level formatting a disk is to initialize the disk after changing
1217 its physical sector size.
1218 Another reason for low-level formatting a disk
1219 is to revive the disk if you are getting "medium format corrupted" errors
1220 from the disk in response to read and write requests.
1222 Some disks take longer than others to format.
1223 Users should specify a
1224 timeout long enough to allow the format to complete.
1226 timeout is 3 hours, which should be long enough for most disks.
1228 disks will complete a format operation in a very short period of time
1229 (on the order of 5 minutes or less).
1230 This is often because the drive
1231 does not really support the FORMAT UNIT command -- it just accepts the
1232 command, waits a few minutes and then returns it.
1236 subcommand takes several arguments that modify its default behavior.
1241 arguments can be useful for scripts.
1244 Be quiet, do not print any status messages.
1245 This option will not disable
1246 the questions, however.
1247 To disable questions, use the
1254 This will report status on a format that is already running on the drive.
1256 Issue a non-immediate format command.
1259 issues the FORMAT UNIT command with the immediate bit set.
1261 device to immediately return the format command, before the format has
1267 sense information from the device every second to determine how far along
1268 in the format process it is.
1271 argument is specified,
1273 will issue a non-immediate format command, and will be unable to print any
1274 information to let the user know what percentage of the disk has been
1277 Do not ask any questions.
1280 will ask the user if he/she really wants to format the disk in question,
1281 and also if the default format command timeout is acceptable.
1283 will not be asked about the timeout if a timeout is specified on the
1287 Issue the SANITIZE command to the named device.
1289 .Em WARNING! WARNING! WARNING!
1291 ALL data on the disk will be destroyed or made inaccessible.
1292 Recovery of the data is not possible.
1293 Use extreme caution when issuing this command.
1297 subcommand takes several arguments that modify its default behavior.
1302 arguments can be useful for scripts.
1304 .It Fl a Ar operation
1305 Specify the sanitize operation to perform.
1308 Perform an overwrite operation by writing a user supplied
1309 data pattern to the device one or more times.
1310 The pattern is given by the
1313 The number of times is given by the
1317 Perform a block erase operation.
1318 All the device's blocks are set to a vendor defined
1319 value, typically zero.
1321 Perform a cryptographic erase operation.
1322 The encryption keys are changed to prevent the decryption
1325 Exits a previously failed sanitize operation.
1326 A failed sanitize operation can only be exited if it was
1327 run in the unrestricted completion mode, as provided by the
1332 The number of passes when performing an
1335 Valid values are between 1 and 31.
1340 operation, the pattern is inverted between consecutive passes.
1342 Path to the file containing the pattern to use when
1346 The pattern is repeated as needed to fill each block.
1348 Be quiet, do not print any status messages.
1349 This option will not disable
1350 the questions, however.
1351 To disable questions, use the
1355 Perform the sanitize in the unrestricted completion mode.
1356 If the operation fails, it can later be exited with the
1363 This will report status on a sanitize that is already running on the drive.
1365 Issue a non-immediate sanitize command.
1368 issues the SANITIZE command with the immediate bit set.
1370 device to immediately return the sanitize command, before
1371 the sanitize has actually completed.
1376 sense information from the device every second to determine how far along
1377 in the sanitize process it is.
1380 argument is specified,
1382 will issue a non-immediate sanitize command, and will be unable to print any
1383 information to let the user know what percentage of the disk has been
1386 Do not ask any questions.
1389 will ask the user if he/she really wants to sanitize the disk in question,
1390 and also if the default sanitize command timeout is acceptable.
1392 will not be asked about the timeout if a timeout is specified on the
1396 Put ATA device into IDLE state.
1399 specifies automatic standby timer value in seconds.
1400 Value 0 disables timer.
1402 Put ATA device into STANDBY state.
1405 specifies automatic standby timer value in seconds.
1406 Value 0 disables timer.
1408 Put ATA device into SLEEP state.
1409 Note that the only way get device out of
1410 this state may be reset.
1412 Report ATA device power mode.
1414 It optional parameter
1416 specified, enables and sets advanced power management level, where
1417 1 -- minimum power, 127 -- maximum performance with standby,
1418 128 -- minimum power without standby, 254 -- maximum performance.
1419 If not specified -- APM is disabled.
1421 It optional parameter
1423 specified, enables and sets automatic acoustic management level, where
1424 1 -- minimum noise, 254 -- maximum performance.
1425 If not specified -- AAM is disabled.
1427 Update or report security settings, using an ATA identify command (0xec).
1430 will print out the security support and associated settings of the device.
1433 command takes several arguments:
1437 Disable device security using the given password for the selected user according
1438 to the devices configured security level.
1441 Erase the device using the given password for the selected user.
1443 .Em WARNING! WARNING! WARNING!
1445 Issuing a secure erase will
1447 user data on the device and may take several hours to complete.
1449 When this command is used against an SSD drive all its cells will be marked as
1450 empty, restoring it to factory default write performance.
1451 For SSD's this action
1452 usually takes just a few seconds.
1455 Freeze the security configuration of the specified device.
1457 After command completion any other commands that update the device lock mode
1458 shall be command aborted.
1459 Frozen mode is disabled by power-off or hardware reset.
1462 Enhanced erase the device using the given password for the selected user.
1464 .Em WARNING! WARNING! WARNING!
1466 Issuing an enhanced secure erase will
1468 user data on the device and may take several hours to complete.
1470 An enhanced erase writes predetermined data patterns to all user data areas,
1471 all previously written user data shall be overwritten, including sectors that
1472 are no longer in use due to reallocation.
1475 Unlock the device using the given password for the selected user according to
1476 the devices configured security level.
1477 .It Fl l Ar high|maximum
1479 Specifies which security level to set when issuing a
1482 The security level determines device behavior when the master
1483 password is used to unlock the device.
1484 When the security level is set to high
1485 the device requires the unlock command and the master password to unlock.
1486 When the security level is set to maximum the device requires a secure erase
1487 with the master password to unlock.
1489 This option must be used in conjunction with one of the security action commands.
1495 Be quiet, do not print any status messages.
1496 This option will not disable the questions, however.
1497 To disable questions, use the
1502 Password the device (enable security) using the given password for the selected
1504 This option can be combined with other options such as
1507 A master password may be set in a addition to the user password. The purpose of
1508 the master password is to allow an administrator to establish a password that
1509 is kept secret from the user, and which may be used to unlock the device if the
1510 user password is lost.
1513 Setting the master password does not enable device security.
1515 If the master password is set and the drive supports a Master Revision Code
1516 feature the Master Password Revision Code will be decremented.
1519 Overrides the default timeout, specified in seconds, used for both
1523 this is useful if your system has problems processing long timeouts correctly.
1525 Usually the timeout is calculated from the information stored on the drive if
1526 present, otherwise it defaults to 2 hours.
1527 .It Fl U Ar user|master
1529 Specifies which user to set / use for the running action command, valid values
1530 are user or master and defaults to master if not set.
1532 This option must be used in conjunction with one of the security action commands.
1538 Confirm yes to dangerous options such as
1540 without prompting for confirmation.
1543 If the password specified for any action commands does not match the configured
1544 password for the specified user the command will fail.
1546 The password in all cases is limited to 32 characters, longer passwords will
1549 Update or report Host Protected Area details.
1552 will print out the HPA support and associated settings of the device.
1555 command takes several optional arguments:
1559 Freeze the HPA configuration of the specified device.
1561 After command completion any other commands that update the HPA configuration
1562 shall be command aborted.
1563 Frozen mode is disabled by power-off or hardware reset.
1566 Lock the HPA configuration of the device until a successful call to unlock or
1567 the next power-on reset occurs.
1570 Make the HPA max sectors persist across power-on reset or a hardware reset.
1571 This must be used in combination with
1572 .Fl s Ar max_sectors
1576 Set the HPA configuration password required for unlock calls.
1579 Be quiet, do not print any status messages.
1580 This option will not disable the questions.
1581 To disable questions, use the
1584 .It Fl s Ar max_sectors
1586 Configures the maximum user accessible sectors of the device.
1587 This will change the number of sectors the device reports.
1589 .Em WARNING! WARNING! WARNING!
1591 Changing the max sectors of a device using this option will make the data on
1592 the device beyond the specified value inaccessible.
1595 .Fl s Ar max_sectors
1596 call can be made without a power-on reset or a hardware reset of the device.
1599 Unlock the HPA configuration of the specified device using the given password.
1600 If the password specified does not match the password configured via
1602 the command will fail.
1604 After 5 failed unlock calls, due to password miss-match, the device will refuse
1605 additional unlock calls until after a power-on reset.
1608 Confirm yes to dangerous options such as
1610 without prompting for confirmation
1613 The password for all HPA commands is limited to 32 characters, longer passwords
1616 Update or report Accessible Max Address Configuration.
1619 will print out the Accessible Max Address Configuration support and associated
1620 settings of the device.
1623 command takes several optional arguments:
1627 Freeze the Accessible Max Address Configuration of the specified device.
1629 After command completion any other commands that update the configuration
1630 shall be command aborted.
1631 Frozen mode is disabled by power-off.
1634 Be quiet, do not print any status messages.
1635 .It Fl s Ar max_sectors
1637 Configures the maximum user accessible sectors of the device.
1638 This will change the number of sectors the device reports.
1640 .Em WARNING! WARNING! WARNING!
1642 Changing the max sectors of a device using this option will make the data on
1643 the device beyond the specified value indeterminate.
1646 .Fl s Ar max_sectors
1647 call can be made without a power-on reset of the device.
1650 Program firmware of the named
1652 or ATA device using the image file provided.
1656 device and it provides a recommended timeout for the WRITE BUFFER command
1659 opcodes subcommand), that timeout will be used for the firmware download.
1660 The drive-recommended timeout value may be overridden on the command line
1665 Current list of supported vendors for SCSI/SAS drives:
1668 Tested with 4TB SAS drives, model number HUS724040ALS640.
1672 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1673 There is a separate table entry for hard drives, because the update method
1674 for hard drives is different than the method for tape drives.
1679 Tested with SM1625 SSDs.
1681 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1682 ES.3 (ST1000NM0023) drives.
1684 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1687 .Em WARNING! WARNING! WARNING!
1689 Little testing has been done to make sure that different device models from
1690 each vendor work correctly with the fwdownload command.
1691 A vendor name appearing in the supported list means only that firmware of at
1692 least one device type from that vendor has successfully been programmed with
1693 the fwdownload command.
1694 Extra caution should be taken when using this command since there is no
1695 guarantee it will not break a device from the listed vendors.
1696 Ensure that you have a recent backup of the data on the device before
1697 performing a firmware update.
1701 protocol devices will not be programmed, since there is little chance of
1702 the firmware download succeeding.
1705 will currently attempt a firmware download to any
1709 device, since the standard
1711 DOWNLOAD MICROCODE command may work.
1712 Firmware downloads to
1716 devices are supported for devices connected
1721 controllers, and devices connected to SAS controllers
1726 translation capability.
1732 PASS-THROUGH command to send the
1734 DOWNLOAD MICROCODE command to the drive.
1739 translation implementations don't work fully when translating
1741 WRITE BUFFER commands to
1743 DOWNLOAD MICROCODE commands, but do support
1745 passthrough well enough to do a firmware download.
1747 .It Fl f Ar fw_image
1748 Path to the firmware image file to be downloaded to the specified device.
1750 Do not print informational messages, only print errors.
1751 This option should be used with the
1753 option to suppress all output.
1755 Run in simulation mode.
1756 Device checks are run and the confirmation dialog is shown, but no firmware
1757 download will occur.
1763 errors in the event of a failure.
1765 In simulation mode, print out the
1770 register values that would be used for the firmware download command.
1772 Do not ask for confirmation.
1775 Persistent reservation support.
1776 Persistent reservations are a way to reserve a particular
1778 LUN for use by one or more
1783 option is specified,
1787 PERSISTENT RESERVE IN
1788 command using the requested service action.
1791 option is specified,
1795 PERSISTENT RESERVE OUT
1796 command using the requested service action.
1797 One of those two options is required.
1799 Persistent reservations are complex, and fully explaining them is outside
1800 the scope of this manual.
1803 and download the latest SPC spec for a full explanation of persistent
1807 Specify the service action for the PERSISTENT RESERVE IN command.
1808 Supported service actions:
1811 Report the current persistent reservation generation (PRgeneration) and any
1813 .It read_reservation
1814 Report the persistent reservation, if any.
1815 .It report_capabilities
1816 Report the persistent reservation capabilities of the LUN.
1817 .It read_full_status
1818 Report the full status of persistent reservations on the LUN.
1821 Specify the service action for the PERSISTENT RESERVE OUT command.
1822 For service actions like register that are components of other service
1823 action names, the entire name must be specified.
1824 Otherwise, enough of the service action name must be specified to
1825 distinguish it from other possible service actions.
1826 Supported service actions:
1829 Register a reservation key with the LUN or unregister a reservation key.
1830 To register a key, specify the requested key as the Service Action
1832 To unregister a key, specify the previously registered key as the
1834 To change a key, specify the old key as the Reservation Key and the new
1835 key as the Service Action Reservation Key.
1837 This is similar to the register subcommand, except that the Reservation Key
1839 The Service Action Reservation Key will overwrite any previous key
1840 registered for the initiator.
1842 Create a reservation.
1843 A key must be registered with the LUN before the LUN can be reserved, and
1844 it must be specified as the Reservation Key.
1845 The type of reservation must also be specified.
1846 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1848 Release a reservation.
1849 The Reservation Key must be specified.
1851 Release a reservation and remove all keys from the device.
1852 The Reservation Key must be specified.
1854 Remove a reservation belonging to another initiator.
1855 The Reservation Key must be specified.
1856 The Service Action Reservation Key may be specified, depending on the
1857 operation being performed.
1859 Remove a reservation belonging to another initiator and abort all
1860 outstanding commands from that initiator.
1861 The Reservation Key must be specified.
1862 The Service Action Reservation Key may be specified, depending on the
1863 operation being performed.
1865 Register another initiator with the LUN, and establish a reservation on the
1866 LUN for that initiator.
1867 The Reservation Key and Service Action Reservation Key must be specified.
1869 Replace Lost Reservation information.
1872 Set the All Target Ports (ALL_TG_PT) bit.
1873 This requests that the key registration be applied to all target ports and
1874 not just the particular target port that receives the command.
1875 This only applies to the register and register_ignore actions.
1877 Specify a Transport ID.
1878 This only applies to the Register and Register and Move service actions for
1879 Persistent Reserve Out.
1880 Multiple Transport IDs may be specified with multiple
1883 With the Register service action, specifying one or more Transport IDs
1884 implicitly enables the
1886 option which turns on the SPEC_I_PT bit.
1887 Transport IDs generally have the format protocol,id.
1890 A SAS Transport ID consists of
1892 followed by a 64-bit SAS address.
1895 .Dl sas,0x1234567812345678
1897 A Fibre Channel Transport ID consists of
1899 followed by a 64-bit Fibre Channel World Wide Name.
1902 .Dl fcp,0x1234567812345678
1904 A Parallel SCSI address consists of
1906 followed by a SCSI target ID and a relative target port identifier.
1911 An IEEE 1394 (Firewire) Transport ID consists of
1913 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1916 .Dl sbp,0x1234567812345678
1918 A SCSI over RDMA Transport ID consists of
1920 followed by a 128-bit RDMA initiator port identifier.
1921 The port identifier must be exactly 32 or 34 (if the leading 0x is
1922 included) hexadecimal digits.
1923 Only hexadecimal (base 16) numbers are supported.
1926 .Dl srp,0x12345678123456781234567812345678
1928 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1930 For example, if only the iSCSI name is specified:
1932 .Dl iqn.2012-06.com.example:target0
1934 If the iSCSI separator and initiator session ID are specified:
1936 .Dl iqn.2012-06.com.example:target0,i,0x123
1938 A SCSI over PCIe Transport ID consists of
1940 followed by a PCIe Routing ID.
1941 The Routing ID consists of a bus, device and function or in the alternate
1942 form, a bus and function.
1943 The bus must be in the range of 0 to 255 inclusive and the device must be
1944 in the range of 0 to 31 inclusive.
1945 The function must be in the range of 0 to 7 inclusive if the standard form
1946 is used, and in the range of 0 to 255 inclusive if the alternate form is
1948 For example, if a bus, device and function are specified for the standard
1953 If the alternate Routing ID form is used:
1958 Specify the Reservation Key.
1959 This may be in decimal, octal or hexadecimal format.
1960 The value is zero by default if not otherwise specified.
1961 The value must be between 0 and 2^64 - 1, inclusive.
1963 Specify the Service Action Reservation Key.
1964 This may be in decimal, octal or hexadecimal format.
1965 The value is zero by default if not otherwise specified.
1966 The value must be between 0 and 2^64 - 1, inclusive.
1968 Enable the Activate Persist Through Power Loss bit.
1969 This is only used for the register and register_ignore actions.
1970 This requests that the reservation persist across power loss events.
1972 Specify the scope of the reservation.
1973 The scope may be specified by name or by number.
1974 The scope is ignored for register, register_ignore and clear.
1975 If the desired scope isn't available by name, you may specify the number.
1979 This encompasses the entire LUN.
1981 Extent scope (0x01).
1983 Element scope (0x02).
1986 Specify the Relative Target Port.
1987 This only applies to the Register and Move service action of the Persistent
1988 Reserve Out command.
1990 Enable the SPEC_I_PT bit.
1991 This only applies to the Register service action of Persistent Reserve Out.
1992 You must also specify at least one Transport ID with
1994 if this option is set.
1995 If you specify a Transport ID, this option is automatically set.
1996 It is an error to specify this option for any service action other than
1999 Specify the reservation type.
2000 The reservation type may be specified by name or by number.
2001 If the desired reservation type isn't available by name, you may specify
2003 Supported reservation type names:
2008 Write Exclusive mode.
2009 May also be specified as
2010 .Dq write_exclusive .
2012 Read Exclusive mode.
2013 May also be specified as
2014 .Dq read_exclusive .
2016 Exclusive access mode.
2017 May also be specified as
2018 .Dq exclusive_access .
2020 Write Exclusive Registrants Only mode.
2021 May also be specified as
2022 .Dq write_exclusive_reg_only .
2024 Exclusive Access Registrants Only mode.
2025 May also be specified as
2026 .Dq exclusive_access_reg_only .
2028 Write Exclusive All Registrants mode.
2029 May also be specified as
2030 .Dq write_exclusive_all_regs .
2032 Exclusive Access All Registrants mode.
2033 May also be specified as
2034 .Dq exclusive_access_all_regs .
2037 Specify that the target should unregister the initiator that sent
2038 the Register and Move request.
2039 By default, the target will not unregister the initiator that sends the
2040 Register and Move request.
2041 This option only applies to the Register and Move service action of the
2042 Persistent Reserve Out command.
2047 READ or WRITE ATTRIBUTE commands.
2048 These commands are used to read and write attributes in Medium Auxiliary
2050 The most common place Medium Auxiliary Memory is found is small flash chips
2051 included tape cartriges.
2059 option must be specified.
2062 Specify the READ ATTRIBUTE service action.
2065 Issue the ATTRIBUTE VALUES service action.
2066 Read and decode the available attributes and their values.
2068 Issue the ATTRIBUTE LIST service action.
2069 List the attributes that are available to read and write.
2071 Issue the LOGICAL VOLUME LIST service action.
2072 List the available logical volumes in the MAM.
2074 Issue the PARTITION LIST service action.
2075 List the available partitions in the MAM.
2077 Issue the SUPPORTED ATTRIBUTES service action.
2078 List attributes that are supported for reading or writing.
2079 These attributes may or may not be currently present in the MAM.
2082 Specify an attribute to write to the MAM.
2083 This option is not yet implemented.
2085 Specify the attribute number to display.
2086 This option only works with the attr_values, attr_list and supp_attr
2090 Display cached attributes.
2091 If the device supports this flag, it allows displaying attributes for the
2092 last piece of media loaded in the drive.
2094 Specify the element address.
2095 This is used for specifying which element number in a medium changer to
2096 access when reading attributes.
2097 The element number could be for a picker, portal, slot or drive.
2098 .It Fl F Ar form1,form2
2099 Specify the output format for the attribute values (attr_val) display as a
2100 comma separated list of options.
2101 The default output is currently set to field_all,nonascii_trim,text_raw.
2102 Once this code is ported to FreeBSD 10, any text fields will be converted
2103 from their codeset to the user's native codeset with
2106 The text options are mutually exclusive; if you specify more than one, you
2107 will get unpredictable results.
2108 The nonascii options are also mutually exclusive.
2109 Most of the field options may be logically ORed together.
2112 Print text fields with non-ASCII characters escaped.
2114 Print text fields natively, with no codeset conversion.
2116 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2117 escape the non-ASCII characters.
2119 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2120 omit the non-ASCII characters.
2122 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2123 print them as they are.
2125 Print all of the prefix fields: description, attribute number, attribute
2126 size, and the attribute's readonly status.
2127 If field_all is specified, specifying any other field options will not have
2130 Print none of the prefix fields, and only print out the attribute value.
2131 If field_none is specified, specifying any other field options will result
2132 in those fields being printed.
2134 Print out the attribute description.
2136 Print out the attribute number.
2138 Print out the attribute size.
2140 Print out the attribute's readonly status.
2143 Specify the partition.
2144 When the media has multiple partitions, specifying different partition
2145 numbers allows seeing the values for each individual partition.
2146 .It Fl s Ar start_num
2147 Specify the starting attribute number.
2148 This requests that the target device return attribute information starting
2149 at the given number.
2150 .It Fl T Ar elem_type
2151 Specify the element type.
2152 For medium changer devices, this allows specifying the type the element
2153 referenced in the element address (
2163 Specify the number of the logical volume to operate on.
2164 If the media has multiple logical volumes, this will allow displaying
2165 or writing attributes on the given logical volume.
2168 Issue the REPORT SUPPORTED OPCODES service action of the
2172 Without arguments, this command will return a list of all
2174 commands supported by the device, including service actions of commands
2175 that support service actions.
2176 It will also include the
2178 CDB (Command Data Block) length for each command, and the description of
2179 each command if it is known.
2182 Request information on a specific opcode instead of the list of supported
2184 If supported, the target will return a CDB-like structure that indicates
2185 the opcode, service action (if any), and a mask of bits that are supported
2187 .It Fl s Ar service_action
2188 For commands that support a service action, specify the service action to
2191 If a service action is specified for a given opcode, and the device does
2192 not support the given service action, the device should not return a
2194 error, but rather indicate in the returned parameter data that the command
2196 By default, if a service action is specified for an opcode, and service
2197 actions are not supported for the opcode in question, the device will
2200 Include timeout values.
2201 This option works with the default display, which includes all commands
2202 supported by the device, and with the
2206 options, which request information on a specific command and service
2208 This requests that the device report Nominal and Recommended timeout values
2209 for the given command or commands.
2210 The timeout values are in seconds.
2211 The timeout descriptor also includes a command-specific
2218 Zoned Block devices.
2219 This allows managing devices that conform to the
2221 Zoned Block Commands (ZBC) and
2223 Zoned ATA Command Set (ZAC)
2225 Devices using these command sets are usually hard drives using Shingled
2226 Magnetic Recording (SMR).
2227 There are three types of SMR drives:
2230 Drive Managed drives look and act just like a standard random access block
2231 device, but underneath, the drive reads and writes the bulk of its capacity
2233 Sequential writes will yield better performance, but writing sequentially
2236 Host Aware drives expose the underlying zone layout via
2240 commands and allow the host to manage the zone conditions.
2241 The host is not required to manage the zones on the drive, though.
2242 Sequential writes will yield better performance in Sequential Write
2243 Preferred zones, but the host can write randomly in those zones.
2245 Host Managed drives expose the underlying zone layout via
2250 The host is required to access the zones according to the rules described
2252 Any commands that violate the rules will be returned with an error.
2255 SMR drives are divided into zones (typically in the range of 256MB each)
2256 that fall into three general categories:
2259 These are also known as Non Write Pointer zones.
2260 These zones can be randomly written without an unexpected performance penalty.
2261 .It Sequential Preferred
2262 These zones should be written sequentially starting at the write pointer
2264 They may be written randomly.
2265 Writes that do not conform to the zone layout may be significantly slower
2267 .It Sequential Required
2268 These zones must be written sequentially.
2269 If they are not written sequentially, starting at the write pointer, the
2275 Specify the zone subcommand:
2278 Issue the Report Zones command.
2279 All zones are returned by default.
2280 Specify report options with
2282 and printing options with
2284 Specify the starting LBA with
2288 is also accepted as a command argument.
2290 Explicitly open the zone specified by the starting LBA.
2292 Close the zone specified by starting LBA.
2294 Finish the zone specified by the starting LBA.
2296 Reset the write pointer for the zone specified by the starting LBA.
2299 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2300 operation to all zones on the drive.
2302 Specify the starting LBA.
2303 For the Report Zones command, this tells the drive to report starting with
2304 the zone that starts at the given LBA.
2305 For the other commands, this allows the user to identify the zone requested
2306 by its starting LBA.
2307 The LBA may be specified in decimal, hexadecimal or octal notation.
2309 For the Report Zones command, specify a subset of zones to report.
2313 This is the default.
2315 Report only empty zones.
2317 Report zones that are implicitly open.
2318 This means that the host has sent a write to the zone without explicitly
2321 Report zones that are explicitly open.
2323 Report zones that have been closed by the host.
2325 Report zones that are full.
2327 Report zones that are in the read only state.
2330 is also accepted as an argument.
2332 Report zones that are in the offline state.
2334 Report zones where the device recommends resetting write pointers.
2336 Report zones that have the Non Sequential Resources Active flag set.
2337 These are zones that are Sequential Write Preferred, but have been written
2340 Report Non Write Pointer zones, also known as Conventional zones.
2342 .It Fl P Ar print_opt
2343 Specify a printing option for Report Zones:
2346 Normal Report Zones output.
2347 This is the default.
2348 The summary and column headings are printed, fields are separated by spaces
2349 and the fields themselves may contain spaces.
2351 Just print the summary: the number of zones, the maximum LBA (LBA of the
2352 last logical block on the drive), and the value of the
2357 field describes whether the zones on the drive are all identical, all
2358 different, or whether they are the same except for the last zone, etc.
2360 Print the zones in a script friendly format.
2361 The summary and column headings are omitted, the fields are separated by
2362 commas, and the fields do not contain spaces.
2363 The fields contain underscores where spaces would normally be used.
2369 Extended Power Conditions (EPC) feature set commands.
2372 protocol drives, and will not work on
2381 translation layer (SAT).
2382 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2383 the Extended Power Conditions feature set, available at t13.org, to
2384 understand the details of this particular
2389 Specify the epc subcommand
2392 Restore drive power condition settings.
2395 Specify the source for the restored power settings, either
2399 This argument is required.
2402 This only makes sense to specify when restoring from defaults.
2405 Go to the specified power condition.
2408 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2409 This argument is required.
2411 Specify delayed entry to the power condition.
2412 The drive, if it supports this, can enter the power condition after the
2415 Hold the power condition.
2416 If the drive supports this option, it will hold the power condition and
2417 reject all commands that would normally cause it to exit that power
2421 Set the timer value for a power condition and enable or disable the
2425 display described below to see what the current timer settings are for each
2426 Idle and Standby mode supported by the drive.
2429 Enable the power condition.
2436 Disable the power condition.
2443 Specify the timer in seconds.
2444 The user may specify a timer as a floating point number with a maximum
2445 supported resolution of tenths of a second.
2446 Drives may or may not support sub-second timer values.
2448 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2449 This argument is required.
2451 Save the timer and power condition enable/disable state.
2452 By default, if this option is not specified, only the current values for
2453 this power condition will be affected.
2456 Enable or disable a particular power condition.
2459 Enable the power condition.
2466 Disable the power condition.
2473 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2474 This argument is required.
2476 Save the power condition enable/disable state.
2477 By default, if this option is not specified, only the current values for
2478 this power condition will be affected.
2481 Enable the Extended Power Condition (EPC) feature set.
2483 Disable the Extended Power Condition (EPC) feature set.
2485 Specify the EPC power source.
2488 Specify the power source, either
2494 Get the current status of several parameters related to the Extended Power
2495 Condition (EPC) feature set, including whether APM and EPC are supported
2496 and enabled, whether Low Power Standby is supported, whether setting the
2497 EPC power source is supported, whether Low Power Standby is supported and
2498 the current power condition.
2501 Only report the current power condition.
2502 Some drives will exit their current power condition if a command other than
2505 CHECK POWER MODE command is received.
2506 If this flag is specified,
2510 CHECK POWER MODE command to the drive.
2515 Power Conditions log (Log Address 0x08).
2516 This shows the list of Idle and Standby power conditions the drive
2517 supports, and a number of parameters about each condition, including
2518 whether it is enabled and what the timer value is.
2522 Issue REPORT TIMESTAMP or SET TIMESTAMP
2524 commands. Either the
2528 option must be specified.
2531 Report the device's timestamp.
2532 If no more arguments are specified, the timestamp will be reported using
2533 the national representation of the date and time, followed by the time
2537 Specify the strftime format string, as documented in strftime(3), to be used
2538 to format the reported timestamp.
2540 Report the timestamp as milliseconds since the epoch.
2542 Report the timestamp using the national representation of the date and
2543 time, but override the system time zone and use UTC instead.
2548 Set the device's timestamp. Either the
2554 option must be specified.
2557 Specify the strptime format string, as documented in strptime(3).
2558 The time must also be specified with the
2562 Provide the time in the format specified with the
2566 Set the timestamp to the host system's time in UTC.
2570 Print out the device type for specified device.
2573 An ATA device attached directly to an ATA controller
2575 An SATA device attached behind a SAS controller via SCSI-ATA Translation Layer (SATL)
2579 An directly attached NVMe device
2581 An MMC or SD device attached via a mmcsd bus
2583 No device type reported
2585 Device type is unknown
2587 A programming error occurred
2590 Print out verbose usage information.
2595 variable allows the user to specify an alternate mode page format file.
2599 variable determines which text editor
2601 starts when editing mode pages.
2603 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2604 .It Pa /usr/share/misc/scsi_modes
2605 is the SCSI mode format database.
2607 is the transport layer device.
2609 are the CAM application passthrough devices.
2612 .Dl camcontrol eject -n cd -u 1 -v
2614 Eject the CD from cd1, and print SCSI sense information if the command
2617 .Dl camcontrol tur da0
2619 Send the SCSI test unit ready command to da0.
2622 utility will report whether the disk is ready, but will not display sense
2623 information if the command fails since the
2625 switch was not specified.
2626 .Bd -literal -offset indent
2627 camcontrol tur da1 -E -C 4 -t 50 -Q head -v
2630 Send a test unit ready command to da1.
2631 Enable kernel error recovery.
2632 Specify a retry count of 4, and a timeout of 50 seconds.
2636 flag) if the command fails.
2637 Since error recovery is turned on, the
2638 disk will be spun up if it is not currently spinning.
2641 task attribute for the command will be set to Head of Queue.
2644 utility will report whether the disk is ready.
2645 .Bd -literal -offset indent
2646 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2647 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2650 Issue a READ BUFFER command (0x3C) to cd1.
2651 Display the buffer size of cd1,
2652 and display the first 10 bytes from the cache on cd1.
2654 information if the command fails.
2655 .Bd -literal -offset indent
2656 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2657 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2660 Issue a WRITE BUFFER (0x3B) command to cd1.
2661 Write out 10 bytes of data,
2662 not including the (reserved) 4 byte header.
2663 Print out sense information if
2665 Be very careful with this command, improper use may
2666 cause data corruption.
2667 .Bd -literal -offset indent
2668 camcontrol modepage da3 -m 1 -e -P 3
2671 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2672 settings on the drive.
2673 Mode page 1 contains a disk drive's auto read and
2674 write reallocation settings, among other things.
2676 .Dl camcontrol rescan all
2678 Rescan all SCSI buses in the system for devices that have been added,
2681 .Dl camcontrol rescan 0
2683 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2685 .Dl camcontrol rescan 0:1:0
2687 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2690 .Dl camcontrol tags da5 -N 24
2692 Set the number of concurrent transactions for da5 to 24.
2693 .Bd -literal -offset indent
2694 camcontrol negotiate -n da -u 4 -T disable
2697 Disable tagged queueing for da4.
2698 .Bd -literal -offset indent
2699 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2702 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2704 Test Unit Ready command to make the settings take effect.
2705 .Bd -literal -offset indent
2706 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2709 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2711 Display SMP errors if the command fails.
2712 .Bd -literal -offset indent
2713 camcontrol security ada0
2716 Report security support and settings for ada0
2717 .Bd -literal -offset indent
2718 camcontrol security ada0 -U user -s MyPass
2721 Enable security on device ada0 with the password MyPass
2722 .Bd -literal -offset indent
2723 camcontrol security ada0 -U user -e MyPass
2726 Secure erase ada0 which has had security enabled with user password MyPass
2728 .Em WARNING! WARNING! WARNING!
2732 data from the device, so backup your data before using!
2734 This command can be used against an SSD drive to restoring it to
2735 factory default write performance.
2736 .Bd -literal -offset indent
2740 Report HPA support and settings for ada0 (also reported via
2742 .Bd -literal -offset indent
2743 camcontrol hpa ada0 -s 10240
2746 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2748 .Em WARNING! WARNING! WARNING!
2752 to all data on the device beyond this limit until HPA is disabled by setting
2753 HPA to native max sectors of the device, which can only be done after a
2754 power-on or hardware reset!
2757 use this on a device which has an active filesystem!
2758 .Bd -literal -offset indent
2759 camcontrol persist da0 -v -i read_keys
2762 This will read any persistent reservation keys registered with da0, and
2763 display any errors encountered when sending the PERSISTENT RESERVE IN
2766 .Bd -literal -offset indent
2767 camcontrol persist da0 -v -o register -a -K 0x12345678
2770 This will register the persistent reservation key 0x12345678 with da0,
2771 apply that registration to all ports on da0, and display any errors that
2772 occur when sending the PERSISTENT RESERVE OUT command.
2773 .Bd -literal -offset indent
2774 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2777 This will reserve da0 for the exlusive use of the initiator issuing the
2779 The scope of the reservation is the entire LUN.
2780 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2781 .Bd -literal -offset indent
2782 camcontrol persist da0 -v -i read_full
2785 This will display the full status of all reservations on da0 and print out
2786 status if there are any errors.
2787 .Bd -literal -offset indent
2788 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2791 This will release a reservation on da0 of the type ex_ac
2793 The Reservation Key for this registration is 0x12345678.
2794 Any errors that occur will be displayed.
2795 .Bd -literal -offset indent
2796 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2797 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2800 This will register the key 0x12345678 with da0, specifying that it applies
2801 to the SAS initiators with SAS addresses 0x1234567812345678 and
2803 .Bd -literal -offset indent
2804 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2805 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2808 This will move the registration from the current initiator, whose
2809 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2810 Fiber Channel World Wide Node Name 0x1234567812345678.
2811 A new registration key, 0x12345678, will be registered for the initiator
2812 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2813 current initiator will be unregistered from the target.
2814 The reservation will be moved to relative target port 2 on the target
2816 The registration will persist across power losses.
2817 .Bd -literal -offset indent
2818 camcontrol attrib sa0 -v -i attr_values -p 1
2821 This will read and decode the attribute values from partition 1 on the tape
2822 in tape drive sa0, and will display any
2826 .Bd -literal -offset indent
2827 camcontrol zone da0 -v -c rz -P summary
2830 This will request the SMR zone list from disk da0, and print out a
2831 summary of the zone parameters, and display any
2837 .Bd -literal -offset indent
2838 camcontrol zone da0 -v -c rz -o reset
2841 This will request the list of SMR zones that should have their write
2842 pointer reset from the disk da0, and display any
2848 .Bd -literal -offset indent
2849 camcontrol zone da0 -v -c rwp -l 0x2c80000
2852 This will issue the Reset Write Pointer command to disk da0 for the zone
2853 that starts at LBA 0x2c80000 and display any
2859 .Bd -literal -offset indent
2860 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2863 Set the timer for the Idle_a power condition on drive
2865 to 60.1 seconds, enable that particular power condition, and save the timer
2866 value and the enabled state of the power condition.
2868 .Bd -literal -offset indent
2869 camcontrol epc da4 -c goto -p Standby_z -H
2874 to go to the Standby_z power state (which is
2875 the drive's lowest power state) and hold in that state until it is
2876 explicitly released by another
2880 .Bd -literal -offset indent
2881 camcontrol epc da2 -c status -P
2884 Report only the power state of
2887 Some drives will power up in response to the commands sent by the
2895 CHECK POWER MODE command, which should not trigger a change in the drive's
2898 .Bd -literal -offset indent
2899 camcontrol epc ada0 -c list
2902 Display the ATA Power Conditions log (Log Address 0x08) for
2906 .Bd -literal -offset indent
2907 camcontrol timestamp sa0 -s -f "%a, %d %b %Y %T %z" \e
2908 -T "Wed, 26 Oct 2016 21:43:57 -0600"
2911 Set the timestamp of drive
2915 format string followed by a time string
2916 that was created using this format string.
2919 .Xr cam_cdbparse 3 ,
2926 utility first appeared in
2929 The mode page editing code and arbitrary SCSI command code are based upon
2934 library, written by Julian Elischer and Peter Dufault.
2937 program first appeared in
2939 and first appeared in
2944 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2946 The code that parses the generic command line arguments does not know that
2947 some of the subcommands take multiple arguments.
2948 So if, for instance, you
2949 tried something like this:
2950 .Bd -literal -offset indent
2951 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2954 The sense information from the test unit ready command would not get
2955 printed out, since the first
2959 bails out when it sees the second argument to
2963 Fixing this behavior would take some gross code, or changes to the
2966 The best way to circumvent this problem is to always make sure
2969 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob