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
136 .Aq Fl a Ar cmd Op args
137 .Aq Fl c Ar cmd Op args
140 .Op Fl i Ar len Ar fmt
142 .Op Fl o Ar len Ar fmt Op args
149 .Aq Fl r Ar len Ar fmt Op args
150 .Aq Fl R Ar len Ar fmt Op args
162 .Op Fl o Ar operation
166 .Op Fl T Ar pp_timeout
167 .Op Fl a Ar enable|disable
168 .Op Fl A Ar enable|disable
169 .Op Fl s Ar enable|disable
170 .Op Fl S Ar enable|disable
191 .Aq all | off | device id | bus Ns Op :target Ns Op :lun
204 .Op Fl D Ar enable|disable
209 .Op Fl T Ar enable|disable
211 .Op Fl W Ar bus_width
225 .Aq Fl a Ar overwrite | block | crypto | exitfailure
279 .Op Fl l Ar high|maximum
283 .Op Fl U Ar user|master
294 .Op Fl s Ar max_sectors
303 .Op Fl s Ar max_sectors
308 .Aq Fl i Ar action | Fl o Ar action
314 .Op Fl R Ar rel_tgt_port
323 .Aq Fl r Ar action | Fl w Ar attrib
326 .Op Fl e Ar elem_addr
327 .Op Fl F Ar form1,form2
329 .Op Fl s Ar start_addr
330 .Op Fl T Ar elem_type
337 .Op Fl s Ar service_action
346 .Op Fl P Ar print_opts
354 .Op Fl p Ar power_cond
356 .Op Fl r Ar restore_src
358 .Op Fl S Ar power_src
364 .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
372 .Ao Fl l | Fl d | Fl r Ac
380 utility allows users to access and control the
382 CAM subsystem described in
388 can cause a loss of data and/or system crashes if used improperly.
390 expert users are encouraged to exercise caution when using this command.
391 Novice users should stay away from this utility.
395 utility has a number of primary functions, many of which support an optional
397 A device identifier can take one of three forms:
400 Specify a device name and unit number combination, like "da5" or "cd3".
402 Specify a bus number and target id.
403 The bus number can be determined from
405 .Dq camcontrol devlist .
406 The lun defaults to 0.
408 Specify the bus, target and lun for a device.
412 The device identifier, if it is specified,
414 come immediately after the function name, and before any generic or
415 function-specific arguments.
420 arguments described below will override any device name or unit number
421 specified beforehand.
428 override a specified bus:target or bus:target:lun, however.
432 primary functions support these generic arguments:
435 SCSI command retry count.
436 In order for this to work, error recovery
440 Instruct the kernel to perform generic SCSI error recovery for the given
442 This is needed in order for the retry count
445 Other than retrying commands, the generic error recovery in
446 the code will generally attempt to spin up drives that are not spinning.
447 It may take some other actions, depending upon the sense code returned from
450 Specify the device type to operate on, e.g.\& "da", "cd".
451 .It Fl Q Ar task_attr
453 task attribute for the command, if it is a
456 This may be ordered, simple, head, or aca.
457 In most cases this is not needed.
458 The default is simple, which works with all
461 The task attribute may also be specified numerically.
463 SCSI command timeout in seconds.
464 This overrides the default timeout for
466 .It Fl u Ar unit_number
467 Specify the device unit number, e.g.\& "1", "5".
469 Be verbose, print out sense information for failed SCSI commands.
472 Primary command functions:
473 .Bl -tag -width periphlist
475 List all physical devices (logical units) attached to the CAM subsystem.
476 This also includes a list of peripheral drivers attached to each device.
479 argument, SCSI bus number, adapter name and unit numbers are printed as
481 On the other hand, with the
483 argument, only the bus adapter, and unit information will be printed, and
484 device information will be omitted.
486 List all peripheral drivers attached to a given physical device (logical
489 Send the SCSI test unit ready (0x00) command to the given device.
492 utility will report whether the device is ready or not.
494 Send a SCSI inquiry command (0x12) to a device.
497 will print out the standard inquiry data, device serial number, and
498 transfer rate information.
499 The user can specify that only certain types of
500 inquiry data be printed:
503 Get the standard inquiry data.
505 Print out the serial number.
506 If this flag is the only one specified,
508 will not print out "Serial Number" before the value returned by the drive.
509 This is to aid in script writing.
511 Print out transfer rate information.
514 Send a ATA identify command (0xec) to a device.
516 Send the SCSI REPORT LUNS (0xA0) command to the given device.
519 will print out the list of logical units (LUNs) supported by the target device.
520 There are a couple of options to modify the output:
523 Just print out a count of LUNs, not the actual LUN numbers.
525 Just print out the LUNs, and do not print out the count.
526 .It Fl r Ar reporttype
527 Specify the type of report to request from the target:
528 .Bl -tag -width 012345678
530 Return the default report.
534 Most targets will support this report if they support the REPORT LUNS
537 Return only well known LUNs.
539 Return all available LUNs.
544 will try to print out LUN numbers in a reasonable format.
545 It can understand the peripheral, flat, LUN and extended LUN formats.
547 Send the SCSI READ CAPACITY command to the given device and display
549 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
550 action will be sent to obtain the full size of the device.
553 will print out the last logical block of the device, and the blocksize of
555 To modify the output format, use the following options:
558 Just print out the blocksize, not the last block or device size.
559 This cannot be used with
564 Print out the device size in human readable (base 2, 1K == 1024) format.
567 and cannot be used with
572 Print out the device size in human readable (base 10, 1K == 1000) format.
574 Skip sending the SCSI READ CAPACITY (10) command.
575 Send only the SCSI READ CAPACITY (16) service action and report
577 When the two do not match, a quirk is needed to resolve the ambiguity.
579 Print out the number of blocks in the device instead of the last logical
582 Quiet, print out the numbers only (separated by a comma if
588 Print out the last logical block or the size of the device only, and omit
592 Note that this command only displays the information, it does not update
593 the kernel data structures.
596 reprobe subcommand to do that.
598 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
601 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
604 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
605 start bit set and the load/eject bit set.
607 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
608 start bit cleared and the load/eject bit set.
610 Tell the kernel to scan all buses in the system (with the
612 argument), the given bus (XPT_SCAN_BUS), bus:target:lun or device
613 (XPT_SCAN_LUN) for new devices or devices that have gone away.
615 may specify a scan of all buses, a single bus, or a lun.
617 on a target is not supported.
619 If a device is specified by peripheral name and unit number, for instance
620 da4, it may only be rescanned if that device currently exists in the CAM EDT
621 (Existing Device Table).
622 If the device is no longer there (see
625 you must use the bus:target:lun form to rescan it.
627 Tell the kernel to refresh the information about the device and
628 notify the upper layer,
630 This includes sending the SCSI READ CAPACITY command and updating
631 the disk size visible to the rest of the system.
633 Tell the kernel to reset all buses in the system (with the
635 argument), the given bus (XPT_RESET_BUS) by issuing a SCSI bus
636 reset for that bus, or to reset the given bus:target:lun or device
637 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
638 connecting to that device.
639 Note that this can have a destructive impact
644 READ DEFECT DATA (10) command (0x37) or the
646 READ DEFECT DATA (12) command (0xB7) to the given device, and
647 print out any combination of: the total number of defects, the primary
648 defect list (PLIST), and the grown defect list (GLIST).
651 Specify the requested format of the defect list.
652 The format argument is
654 Most drives support the physical sector format.
656 support the logical block format.
657 Many drives, if they do not support the
658 requested format, return the data in an alternate format, along with sense
659 information indicating that the requested data format is not supported.
663 attempts to detect this, and print out whatever format the drive returns.
664 If the drive uses a non-standard sense code to report that it does not
665 support the requested format,
667 will probably see the error as a failure to complete the request.
669 The format options are:
672 Print out the list as logical blocks.
673 This is limited to 32-bit block sizes, and isn't supported by many modern
676 Print out the list as logical blocks.
677 This option uses a 64-bit block size.
679 Print out the list in bytes from index format.
681 Print out the list in extended bytes from index format.
682 The extended format allows for ranges of blocks to be printed.
684 Print out the list in physical sector format.
685 Most drives support this format.
687 Print out the list in extended physical sector format.
688 The extended format allows for ranges of blocks to be printed.
691 Print out the grown defect list.
692 This is a list of bad blocks that have
693 been remapped since the disk left the factory.
695 Print out the primary defect list.
696 This is the list of defects that were present in the factory.
698 When printing status information with
700 only print the number of defects.
702 Just print the number of defects, not the list of defects.
704 Specify the starting offset into the defect list.
705 This implies using the
707 READ DEFECT DATA (12) command, as the 10 byte version of the command
708 doesn't support the address descriptor index field.
709 Not all drives support the 12 byte command, and some drives that support
710 the 12 byte command don't support the address descriptor index field.
712 Print out defects in hexadecimal (base 16) form instead of base 10 form.
721 will print out the number of defects given in the READ DEFECT DATA header
722 returned from the drive.
723 Some drives will report 0 defects if neither the primary or grown defect
726 Allows the user to display and optionally edit a SCSI mode page.
728 page formats are located in
729 .Pa /usr/share/misc/scsi_modes .
730 This can be overridden by specifying a different file in the
732 environment variable.
735 command takes several arguments:
738 Use 6 byte MODE commands instead of default 10 byte.
739 Old devices may not support 10 byte MODE commands, while new devices may
740 not be able to report all mode pages with 6 byte commands.
743 starts with 10 byte commands and falls back to 6 byte on error.
745 Disable block descriptors for mode sense.
747 Display/edit block descriptors instead of mode page.
749 Use long LBA block descriptors.
750 Allows number of LBAs bigger then 2^^32.
752 Displays mode page data in binary format.
754 This flag allows the user to edit values in the mode page.
756 either edit mode page values with the text editor pointed to by his
758 environment variable, or supply mode page values via standard input, using
761 uses to display mode page values.
762 The editor will be invoked if
764 detects that standard input is terminal.
766 Lists all available mode pages.
767 If specified more then once, also lists subpages.
768 .It Fl m Ar page[,subpage]
769 This specifies the number of the mode page and optionally subpage the user
770 would like to view and/or edit.
771 This argument is mandatory unless
775 This allows the user to specify the page control field.
777 .Bl -tag -width xxx -compact
789 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
792 function requires the
794 argument to specify SCSI CDB or the
796 argument to specify ATA Command Block registers values.
797 Other arguments are optional, depending on
799 The command and data specification syntax is documented
802 NOTE: If the CDB specified causes data to be transferred to or from the
803 SCSI device in question, you MUST specify either
808 .It Fl a Ar cmd Op args
809 This specifies the content of 12 ATA Command Block registers (command,
810 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
811 lba_high_exp, features_exp, sector_count, sector_count_exp).
812 .It Fl c Ar cmd Op args
813 This specifies the SCSI CDB.
814 SCSI CDBs may be 6, 10, 12 or 16 bytes.
816 Specifies DMA protocol to be used for ATA command.
818 Specifies FPDMA (NCQ) protocol to be used for ATA command.
819 .It Fl i Ar len Ar fmt
820 This specifies the amount of data to read, and how it should be displayed.
824 bytes of data will be read from the device and written to standard output.
825 .It Fl o Ar len Ar fmt Op args
826 This specifies the amount of data to be written to a device, and the data
827 that is to be written.
831 bytes of data will be read from standard input and written to the device.
833 This specifies that 11 result ATA Command Block registers should be displayed
834 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
835 lba_high_exp, sector_count, sector_count_exp), and how.
838 11 result registers will be written to standard output in hex.
841 Allows the user to send an arbitrary Serial
842 Management Protocol (SMP) command to a device.
845 function requires the
847 argument to specify the SMP request to be sent, and the
849 argument to specify the format of the SMP response.
850 The syntax for the SMP request and response arguments is documented in
853 Note that SAS adapters that support SMP passthrough (at least the currently
854 known adapters) do not accept CRC bytes from the user in the request and do
855 not pass CRC bytes back to the user in the response.
856 Therefore users should not include the CRC bytes in the length of the
857 request and not expect CRC bytes to be returned in the response.
859 .It Fl r Ar len Ar fmt Op args
860 This specifies the size of the SMP request, without the CRC bytes, and the
865 bytes of data will be read from standard input and written as the SMP
867 .It Fl R Ar len Ar fmt Op args
868 This specifies the size of the buffer allocated for the SMP response, and
869 the SMP response format.
873 bytes of data will be allocated for the response and the response will be
874 written to standard output.
877 Allows the user to send the Serial Management Protocol (SMP) Report General
880 will display the data returned by the Report General command.
881 If the SMP target supports the long response format, the additional data
882 will be requested and displayed automatically.
885 Request the long response format only.
886 Not all SMP targets support the long response format.
889 to skip sending the initial report general request without the long bit set
890 and only issue a report general request with the long bit set.
893 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
895 This function should be used with some caution, as it can render devices
896 inaccessible, and could potentially cause data corruption as well.
899 argument is required to specify the PHY to operate on.
902 Specify the PHY to operate on.
903 This argument is required.
905 Request the long request/response format.
906 Not all SMP targets support the long response format.
907 For the PHY Control command, this currently only affects whether the
908 request length is set to a value other than 0.
909 .It Fl o Ar operation
910 Specify a PHY control operation.
913 operation may be specified.
914 The operation may be specified numerically (in decimal, hexadecimal, or octal)
915 or one of the following operation names may be specified:
919 It is not necessary to specify this argument.
921 Send the LINK RESET command to the phy.
923 Send the HARD RESET command to the phy.
925 Send the DISABLE command to the phy.
926 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
928 Send the CLEAR ERROR LOG command.
929 This clears the error log counters for the specified phy.
931 Send the CLEAR AFFILIATION command.
932 This clears the affiliation from the STP initiator port with the same SAS
933 address as the SMP initiator that requests the clear operation.
935 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
936 This will cause a SATA port selector to use the given phy as its active phy
937 and make the other phy inactive.
939 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
941 Send the SET ATTACHED DEVICE NAME command to the PHY.
944 argument to specify the device name.
947 Specify the attached device name.
948 This option is needed with the
951 The name is a 64-bit number, and can be specified in decimal, hexadecimal
954 Set the minimum physical link rate for the phy.
955 This is a numeric argument.
956 Currently known link rates are:
959 Do not change current value.
968 Other values may be specified for newer physical link rates.
970 Set the maximum physical link rate for the phy.
971 This is a numeric argument.
974 argument description for known link rate arguments.
975 .It Fl T Ar pp_timeout
976 Set the partial pathway timeout value, in microseconds.
981 specification for more information on this field.
982 .It Fl a Ar enable|disable
983 Enable or disable SATA slumber phy power conditions.
984 .It Fl A Ar enable|disable
985 Enable or disable SATA partial power conditions.
986 .It Fl s Ar enable|disable
987 Enable or disable SAS slumber phy power conditions.
988 .It Fl S Ar enable|disable
989 Enable or disable SAS partial phy power conditions.
992 List phys attached to a SAS expander, the address of the end device
993 attached to the phy, and the inquiry data for that device and peripheral
994 devices attached to that device.
995 The inquiry data and peripheral devices are displayed if available.
998 Turn on the long response format for the underlying SMP commands used for
1001 Only print out phys that are attached to a device in the CAM EDT (Existing
1005 Send the SMP Report Manufacturer Information command to the device and
1006 display the response.
1009 Turn on the long response format for the underlying SMP commands used for
1013 Turn on CAM debugging printfs in the kernel.
1014 This requires options CAMDEBUG
1015 in your kernel config file.
1016 WARNING: enabling debugging printfs currently
1017 causes an EXTREME number of kernel printfs.
1018 You may have difficulty
1019 turning off the debugging printfs once they start, since the kernel will be
1020 busy printing messages and unable to service other requests quickly.
1023 function takes a number of arguments:
1026 Enable CAM_DEBUG_INFO printfs.
1028 Enable CAM_DEBUG_PERIPH printfs.
1030 Enable CAM_DEBUG_TRACE printfs.
1032 Enable CAM_DEBUG_SUBTRACE printfs.
1034 Enable CAM_DEBUG_XPT printfs.
1036 Enable CAM_DEBUG_CDB printfs.
1037 This will cause the kernel to print out the
1038 SCSI CDBs sent to the specified device(s).
1040 Enable CAM_DEBUG_PROBE printfs.
1042 Enable debugging for all devices.
1044 Turn off debugging for all devices
1045 .It bus Ns Op :target Ns Op :lun
1046 Turn on debugging for the given bus, target or lun.
1047 If the lun or target
1048 and lun are not specified, they are wildcarded.
1049 (i.e., just specifying a
1050 bus turns on debugging printfs for all devices on that bus.)
1053 Show or set the number of "tagged openings" or simultaneous transactions
1054 we attempt to queue to a particular device.
1057 command, with no command-specific arguments (i.e., only generic arguments)
1058 prints out the "soft" maximum number of transactions that can be queued to
1059 the device in question.
1060 For more detailed information, use the
1062 argument described below.
1065 Set the number of tags for the given device.
1066 This must be between the
1067 minimum and maximum number set in the kernel quirk table.
1069 most devices that support tagged queueing is a minimum of 2 and a maximum
1071 The minimum and maximum values for a given device may be
1072 determined by using the
1079 subcommand is described below.
1081 Be quiet, and do not report the number of tags.
1082 This is generally used when
1083 setting the number of tags.
1085 The verbose flag has special functionality for the
1090 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1093 This is the amount of capacity for transactions queued to a given device.
1095 This is the number of transactions currently queued to a device.
1097 This is the number of CCBs allocated for the device.
1099 The held count is the number of CCBs held by peripheral drivers that have
1100 either just been completed or are about to be released to the transport
1101 layer for service by a device.
1102 Held CCBs reserve capacity on a given
1105 This is the current "hard" minimum number of transactions that can be
1106 queued to a device at once.
1109 value above cannot go below this number.
1110 The default value for
1112 is 2, although it may be set higher or lower for various devices.
1114 This is the "hard" maximum number of transactions that can be queued to a
1118 value cannot go above this number.
1119 The default value for
1121 is 255, although it may be set higher or lower for various devices.
1125 Show or negotiate various communication parameters.
1126 Some controllers may
1127 not support setting or changing some of these values.
1129 Adaptec 174x controllers do not support changing a device's sync rate or
1134 will not attempt to set the parameter if the controller indicates that it
1135 does not support setting the parameter.
1136 To find out what the controller
1144 command is described below.
1145 Also, some controller drivers do not support
1146 setting negotiation parameters, even if the underlying controller supports
1147 negotiation changes.
1148 Some controllers, such as the Advansys wide
1149 controllers, support enabling and disabling synchronous negotiation for
1150 a device, but do not support setting the synchronous negotiation rate.
1153 Attempt to make the negotiation settings take effect immediately by sending
1154 a Test Unit Ready command to the device.
1156 Show or set current negotiation settings.
1157 This is the default.
1158 .It Fl D Ar enable|disable
1159 Enable or disable disconnection.
1163 Set the command delay offset.
1165 Be quiet, do not print anything.
1166 This is generally useful when you want to
1167 set a parameter, but do not want any status information.
1168 .It Fl R Ar syncrate
1169 Change the synchronization rate for a device.
1170 The sync rate is a floating
1171 point value specified in MHz.
1174 is a legal value, as is
1176 .It Fl T Ar enable|disable
1177 Enable or disable tagged queueing for a device.
1179 Show or set user negotiation settings.
1180 The default is to show or set
1181 current negotiation settings.
1183 The verbose switch has special meaning for the
1188 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1190 .It Fl W Ar bus_width
1191 Specify the bus width to negotiate with a device.
1194 The only useful values to specify are 8, 16, and 32
1196 The controller must support the bus width in question in order for
1197 the setting to take effect.
1200 In general, sync rate and offset settings will not take effect for a
1201 device until a command has been sent to the device.
1204 switch above will automatically send a Test Unit Ready to the device so
1205 negotiation parameters will take effect.
1209 FORMAT UNIT command to the named device.
1211 .Em WARNING! WARNING! WARNING!
1213 Low level formatting a disk will destroy ALL data on the disk.
1215 extreme caution when issuing this command.
1216 Many users low-level format
1217 disks that do not really need to be low-level formatted.
1219 relatively few scenarios that call for low-level formatting a disk.
1221 low-level formatting a disk is to initialize the disk after changing
1222 its physical sector size.
1223 Another reason for low-level formatting a disk
1224 is to revive the disk if you are getting "medium format corrupted" errors
1225 from the disk in response to read and write requests.
1227 Some disks take longer than others to format.
1228 Users should specify a
1229 timeout long enough to allow the format to complete.
1231 timeout is 3 hours, which should be long enough for most disks.
1233 disks will complete a format operation in a very short period of time
1234 (on the order of 5 minutes or less).
1235 This is often because the drive
1236 does not really support the FORMAT UNIT command -- it just accepts the
1237 command, waits a few minutes and then returns it.
1241 subcommand takes several arguments that modify its default behavior.
1246 arguments can be useful for scripts.
1249 Be quiet, do not print any status messages.
1250 This option will not disable
1251 the questions, however.
1252 To disable questions, use the
1259 This will report status on a format that is already running on the drive.
1261 Issue a non-immediate format command.
1264 issues the FORMAT UNIT command with the immediate bit set.
1266 device to immediately return the format command, before the format has
1272 sense information from the device every second to determine how far along
1273 in the format process it is.
1276 argument is specified,
1278 will issue a non-immediate format command, and will be unable to print any
1279 information to let the user know what percentage of the disk has been
1282 Do not ask any questions.
1285 will ask the user if he/she really wants to format the disk in question,
1286 and also if the default format command timeout is acceptable.
1288 will not be asked about the timeout if a timeout is specified on the
1292 Issue the SANITIZE command to the named device.
1294 .Em WARNING! WARNING! WARNING!
1296 ALL data on the disk will be destroyed or made inaccessible.
1297 Recovery of the data is not possible.
1298 Use extreme caution when issuing this command.
1302 subcommand takes several arguments that modify its default behavior.
1307 arguments can be useful for scripts.
1309 .It Fl a Ar operation
1310 Specify the sanitize operation to perform.
1313 Perform an overwrite operation by writing a user supplied
1314 data pattern to the device one or more times.
1315 The pattern is given by the
1318 The number of times is given by the
1322 Perform a block erase operation.
1323 All the device's blocks are set to a vendor defined
1324 value, typically zero.
1326 Perform a cryptographic erase operation.
1327 The encryption keys are changed to prevent the decryption
1330 Exits a previously failed sanitize operation.
1331 A failed sanitize operation can only be exited if it was
1332 run in the unrestricted completion mode, as provided by the
1337 The number of passes when performing an
1340 Valid values are between 1 and 31.
1345 operation, the pattern is inverted between consecutive passes.
1347 Path to the file containing the pattern to use when
1351 The pattern is repeated as needed to fill each block.
1353 Be quiet, do not print any status messages.
1354 This option will not disable
1355 the questions, however.
1356 To disable questions, use the
1360 Perform the sanitize in the unrestricted completion mode.
1361 If the operation fails, it can later be exited with the
1368 This will report status on a sanitize that is already running on the drive.
1370 Issue a non-immediate sanitize command.
1373 issues the SANITIZE command with the immediate bit set.
1375 device to immediately return the sanitize command, before
1376 the sanitize has actually completed.
1381 sense information from the device every second to determine how far along
1382 in the sanitize process it is.
1385 argument is specified,
1387 will issue a non-immediate sanitize command, and will be unable to print any
1388 information to let the user know what percentage of the disk has been
1391 Do not ask any questions.
1394 will ask the user if he/she really wants to sanitize the disk in question,
1395 and also if the default sanitize command timeout is acceptable.
1397 will not be asked about the timeout if a timeout is specified on the
1401 Put ATA device into IDLE state.
1404 specifies automatic standby timer value in seconds.
1405 Value 0 disables timer.
1407 Put ATA device into STANDBY state.
1410 specifies automatic standby timer value in seconds.
1411 Value 0 disables timer.
1413 Put ATA device into SLEEP state.
1414 Note that the only way get device out of
1415 this state may be reset.
1417 Report ATA device power mode.
1419 It optional parameter
1421 specified, enables and sets advanced power management level, where
1422 1 -- minimum power, 127 -- maximum performance with standby,
1423 128 -- minimum power without standby, 254 -- maximum performance.
1424 If not specified -- APM is disabled.
1426 It optional parameter
1428 specified, enables and sets automatic acoustic management level, where
1429 1 -- minimum noise, 254 -- maximum performance.
1430 If not specified -- AAM is disabled.
1432 Update or report security settings, using an ATA identify command (0xec).
1435 will print out the security support and associated settings of the device.
1438 command takes several arguments:
1442 Disable device security using the given password for the selected user according
1443 to the devices configured security level.
1446 Erase the device using the given password for the selected user.
1448 .Em WARNING! WARNING! WARNING!
1450 Issuing a secure erase will
1452 user data on the device and may take several hours to complete.
1454 When this command is used against an SSD drive all its cells will be marked as
1455 empty, restoring it to factory default write performance.
1456 For SSD's this action
1457 usually takes just a few seconds.
1460 Freeze the security configuration of the specified device.
1462 After command completion any other commands that update the device lock mode
1463 shall be command aborted.
1464 Frozen mode is disabled by power-off or hardware reset.
1467 Enhanced erase the device using the given password for the selected user.
1469 .Em WARNING! WARNING! WARNING!
1471 Issuing an enhanced secure erase will
1473 user data on the device and may take several hours to complete.
1475 An enhanced erase writes predetermined data patterns to all user data areas,
1476 all previously written user data shall be overwritten, including sectors that
1477 are no longer in use due to reallocation.
1480 Unlock the device using the given password for the selected user according to
1481 the devices configured security level.
1482 .It Fl l Ar high|maximum
1484 Specifies which security level to set when issuing a
1487 The security level determines device behavior when the master
1488 password is used to unlock the device.
1489 When the security level is set to high
1490 the device requires the unlock command and the master password to unlock.
1491 When the security level is set to maximum the device requires a secure erase
1492 with the master password to unlock.
1494 This option must be used in conjunction with one of the security action commands.
1500 Be quiet, do not print any status messages.
1501 This option will not disable the questions, however.
1502 To disable questions, use the
1507 Password the device (enable security) using the given password for the selected
1509 This option can be combined with other options such as
1512 A master password may be set in a addition to the user password.
1513 The purpose of the master password is to allow an administrator to establish
1514 a password that is kept secret from the user, and which may be used to unlock
1515 the device if the user password is lost.
1518 Setting the master password does not enable device security.
1520 If the master password is set and the drive supports a Master Revision Code
1521 feature the Master Password Revision Code will be decremented.
1524 Overrides the default timeout, specified in seconds, used for both
1528 this is useful if your system has problems processing long timeouts correctly.
1530 Usually the timeout is calculated from the information stored on the drive if
1531 present, otherwise it defaults to 2 hours.
1532 .It Fl U Ar user|master
1534 Specifies which user to set / use for the running action command, valid values
1535 are user or master and defaults to master if not set.
1537 This option must be used in conjunction with one of the security action commands.
1543 Confirm yes to dangerous options such as
1545 without prompting for confirmation.
1548 If the password specified for any action commands does not match the configured
1549 password for the specified user the command will fail.
1551 The password in all cases is limited to 32 characters, longer passwords will
1554 Update or report Host Protected Area details.
1557 will print out the HPA support and associated settings of the device.
1560 command takes several optional arguments:
1564 Freeze the HPA configuration of the specified device.
1566 After command completion any other commands that update the HPA configuration
1567 shall be command aborted.
1568 Frozen mode is disabled by power-off or hardware reset.
1571 Lock the HPA configuration of the device until a successful call to unlock or
1572 the next power-on reset occurs.
1575 Make the HPA max sectors persist across power-on reset or a hardware reset.
1576 This must be used in combination with
1577 .Fl s Ar max_sectors
1581 Set the HPA configuration password required for unlock calls.
1584 Be quiet, do not print any status messages.
1585 This option will not disable the questions.
1586 To disable questions, use the
1589 .It Fl s Ar max_sectors
1591 Configures the maximum user accessible sectors of the device.
1592 This will change the number of sectors the device reports.
1594 .Em WARNING! WARNING! WARNING!
1596 Changing the max sectors of a device using this option will make the data on
1597 the device beyond the specified value inaccessible.
1600 .Fl s Ar max_sectors
1601 call can be made without a power-on reset or a hardware reset of the device.
1604 Unlock the HPA configuration of the specified device using the given password.
1605 If the password specified does not match the password configured via
1607 the command will fail.
1609 After 5 failed unlock calls, due to password miss-match, the device will refuse
1610 additional unlock calls until after a power-on reset.
1613 Confirm yes to dangerous options such as
1615 without prompting for confirmation
1618 The password for all HPA commands is limited to 32 characters, longer passwords
1621 Update or report Accessible Max Address Configuration.
1624 will print out the Accessible Max Address Configuration support and associated
1625 settings of the device.
1628 command takes several optional arguments:
1632 Freeze the Accessible Max Address Configuration of the specified device.
1634 After command completion any other commands that update the configuration
1635 shall be command aborted.
1636 Frozen mode is disabled by power-off.
1639 Be quiet, do not print any status messages.
1640 .It Fl s Ar max_sectors
1642 Configures the maximum user accessible sectors of the device.
1643 This will change the number of sectors the device reports.
1645 .Em WARNING! WARNING! WARNING!
1647 Changing the max sectors of a device using this option will make the data on
1648 the device beyond the specified value indeterminate.
1651 .Fl s Ar max_sectors
1652 call can be made without a power-on reset of the device.
1655 Program firmware of the named
1657 or ATA device using the image file provided.
1661 device and it provides a recommended timeout for the WRITE BUFFER command
1664 opcodes subcommand), that timeout will be used for the firmware download.
1665 The drive-recommended timeout value may be overridden on the command line
1670 Current list of supported vendors for SCSI/SAS drives:
1673 Tested with 4TB SAS drives, model number HUS724040ALS640.
1677 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1678 There is a separate table entry for hard drives, because the update method
1679 for hard drives is different than the method for tape drives.
1684 Tested with SM1625 SSDs.
1686 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1687 ES.3 (ST1000NM0023) drives.
1689 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1692 .Em WARNING! WARNING! WARNING!
1694 Little testing has been done to make sure that different device models from
1695 each vendor work correctly with the fwdownload command.
1696 A vendor name appearing in the supported list means only that firmware of at
1697 least one device type from that vendor has successfully been programmed with
1698 the fwdownload command.
1699 Extra caution should be taken when using this command since there is no
1700 guarantee it will not break a device from the listed vendors.
1701 Ensure that you have a recent backup of the data on the device before
1702 performing a firmware update.
1706 protocol devices will not be programmed, since there is little chance of
1707 the firmware download succeeding.
1710 will currently attempt a firmware download to any
1714 device, since the standard
1716 DOWNLOAD MICROCODE command may work.
1717 Firmware downloads to
1721 devices are supported for devices connected
1726 controllers, and devices connected to SAS controllers
1731 translation capability.
1737 PASS-THROUGH command to send the
1739 DOWNLOAD MICROCODE command to the drive.
1744 translation implementations don't work fully when translating
1746 WRITE BUFFER commands to
1748 DOWNLOAD MICROCODE commands, but do support
1750 passthrough well enough to do a firmware download.
1752 .It Fl f Ar fw_image
1753 Path to the firmware image file to be downloaded to the specified device.
1755 Do not print informational messages, only print errors.
1756 This option should be used with the
1758 option to suppress all output.
1760 Run in simulation mode.
1761 Device checks are run and the confirmation dialog is shown, but no firmware
1762 download will occur.
1768 errors in the event of a failure.
1770 In simulation mode, print out the
1775 register values that would be used for the firmware download command.
1777 Do not ask for confirmation.
1780 Persistent reservation support.
1781 Persistent reservations are a way to reserve a particular
1783 LUN for use by one or more
1788 option is specified,
1792 PERSISTENT RESERVE IN
1793 command using the requested service action.
1796 option is specified,
1800 PERSISTENT RESERVE OUT
1801 command using the requested service action.
1802 One of those two options is required.
1804 Persistent reservations are complex, and fully explaining them is outside
1805 the scope of this manual.
1808 and download the latest SPC spec for a full explanation of persistent
1812 Specify the service action for the PERSISTENT RESERVE IN command.
1813 Supported service actions:
1816 Report the current persistent reservation generation (PRgeneration) and any
1818 .It read_reservation
1819 Report the persistent reservation, if any.
1820 .It report_capabilities
1821 Report the persistent reservation capabilities of the LUN.
1822 .It read_full_status
1823 Report the full status of persistent reservations on the LUN.
1826 Specify the service action for the PERSISTENT RESERVE OUT command.
1827 For service actions like register that are components of other service
1828 action names, the entire name must be specified.
1829 Otherwise, enough of the service action name must be specified to
1830 distinguish it from other possible service actions.
1831 Supported service actions:
1834 Register a reservation key with the LUN or unregister a reservation key.
1835 To register a key, specify the requested key as the Service Action
1837 To unregister a key, specify the previously registered key as the
1839 To change a key, specify the old key as the Reservation Key and the new
1840 key as the Service Action Reservation Key.
1842 This is similar to the register subcommand, except that the Reservation Key
1844 The Service Action Reservation Key will overwrite any previous key
1845 registered for the initiator.
1847 Create a reservation.
1848 A key must be registered with the LUN before the LUN can be reserved, and
1849 it must be specified as the Reservation Key.
1850 The type of reservation must also be specified.
1851 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1853 Release a reservation.
1854 The Reservation Key must be specified.
1856 Release a reservation and remove all keys from the device.
1857 The Reservation Key must be specified.
1859 Remove a reservation belonging to another initiator.
1860 The Reservation Key must be specified.
1861 The Service Action Reservation Key may be specified, depending on the
1862 operation being performed.
1864 Remove a reservation belonging to another initiator and abort all
1865 outstanding commands from that initiator.
1866 The Reservation Key must be specified.
1867 The Service Action Reservation Key may be specified, depending on the
1868 operation being performed.
1870 Register another initiator with the LUN, and establish a reservation on the
1871 LUN for that initiator.
1872 The Reservation Key and Service Action Reservation Key must be specified.
1874 Replace Lost Reservation information.
1877 Set the All Target Ports (ALL_TG_PT) bit.
1878 This requests that the key registration be applied to all target ports and
1879 not just the particular target port that receives the command.
1880 This only applies to the register and register_ignore actions.
1882 Specify a Transport ID.
1883 This only applies to the Register and Register and Move service actions for
1884 Persistent Reserve Out.
1885 Multiple Transport IDs may be specified with multiple
1888 With the Register service action, specifying one or more Transport IDs
1889 implicitly enables the
1891 option which turns on the SPEC_I_PT bit.
1892 Transport IDs generally have the format protocol,id.
1895 A SAS Transport ID consists of
1897 followed by a 64-bit SAS address.
1900 .Dl sas,0x1234567812345678
1902 A Fibre Channel Transport ID consists of
1904 followed by a 64-bit Fibre Channel World Wide Name.
1907 .Dl fcp,0x1234567812345678
1909 A Parallel SCSI address consists of
1911 followed by a SCSI target ID and a relative target port identifier.
1916 An IEEE 1394 (Firewire) Transport ID consists of
1918 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1921 .Dl sbp,0x1234567812345678
1923 A SCSI over RDMA Transport ID consists of
1925 followed by a 128-bit RDMA initiator port identifier.
1926 The port identifier must be exactly 32 or 34 (if the leading 0x is
1927 included) hexadecimal digits.
1928 Only hexadecimal (base 16) numbers are supported.
1931 .Dl srp,0x12345678123456781234567812345678
1933 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1935 For example, if only the iSCSI name is specified:
1937 .Dl iqn.2012-06.com.example:target0
1939 If the iSCSI separator and initiator session ID are specified:
1941 .Dl iqn.2012-06.com.example:target0,i,0x123
1943 A SCSI over PCIe Transport ID consists of
1945 followed by a PCIe Routing ID.
1946 The Routing ID consists of a bus, device and function or in the alternate
1947 form, a bus and function.
1948 The bus must be in the range of 0 to 255 inclusive and the device must be
1949 in the range of 0 to 31 inclusive.
1950 The function must be in the range of 0 to 7 inclusive if the standard form
1951 is used, and in the range of 0 to 255 inclusive if the alternate form is
1953 For example, if a bus, device and function are specified for the standard
1958 If the alternate Routing ID form is used:
1963 Specify the 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 Specify the Service Action Reservation Key.
1969 This may be in decimal, octal or hexadecimal format.
1970 The value is zero by default if not otherwise specified.
1971 The value must be between 0 and 2^64 - 1, inclusive.
1973 Enable the Activate Persist Through Power Loss bit.
1974 This is only used for the register and register_ignore actions.
1975 This requests that the reservation persist across power loss events.
1977 Specify the scope of the reservation.
1978 The scope may be specified by name or by number.
1979 The scope is ignored for register, register_ignore and clear.
1980 If the desired scope isn't available by name, you may specify the number.
1984 This encompasses the entire LUN.
1986 Extent scope (0x01).
1988 Element scope (0x02).
1991 Specify the Relative Target Port.
1992 This only applies to the Register and Move service action of the Persistent
1993 Reserve Out command.
1995 Enable the SPEC_I_PT bit.
1996 This only applies to the Register service action of Persistent Reserve Out.
1997 You must also specify at least one Transport ID with
1999 if this option is set.
2000 If you specify a Transport ID, this option is automatically set.
2001 It is an error to specify this option for any service action other than
2004 Specify the reservation type.
2005 The reservation type may be specified by name or by number.
2006 If the desired reservation type isn't available by name, you may specify
2008 Supported reservation type names:
2013 Write Exclusive mode.
2014 May also be specified as
2015 .Dq write_exclusive .
2017 Read Exclusive mode.
2018 May also be specified as
2019 .Dq read_exclusive .
2021 Exclusive access mode.
2022 May also be specified as
2023 .Dq exclusive_access .
2025 Write Exclusive Registrants Only mode.
2026 May also be specified as
2027 .Dq write_exclusive_reg_only .
2029 Exclusive Access Registrants Only mode.
2030 May also be specified as
2031 .Dq exclusive_access_reg_only .
2033 Write Exclusive All Registrants mode.
2034 May also be specified as
2035 .Dq write_exclusive_all_regs .
2037 Exclusive Access All Registrants mode.
2038 May also be specified as
2039 .Dq exclusive_access_all_regs .
2042 Specify that the target should unregister the initiator that sent
2043 the Register and Move request.
2044 By default, the target will not unregister the initiator that sends the
2045 Register and Move request.
2046 This option only applies to the Register and Move service action of the
2047 Persistent Reserve Out command.
2052 READ or WRITE ATTRIBUTE commands.
2053 These commands are used to read and write attributes in Medium Auxiliary
2055 The most common place Medium Auxiliary Memory is found is small flash chips
2056 included tape cartriges.
2064 option must be specified.
2067 Specify the READ ATTRIBUTE service action.
2070 Issue the ATTRIBUTE VALUES service action.
2071 Read and decode the available attributes and their values.
2073 Issue the ATTRIBUTE LIST service action.
2074 List the attributes that are available to read and write.
2076 Issue the LOGICAL VOLUME LIST service action.
2077 List the available logical volumes in the MAM.
2079 Issue the PARTITION LIST service action.
2080 List the available partitions in the MAM.
2082 Issue the SUPPORTED ATTRIBUTES service action.
2083 List attributes that are supported for reading or writing.
2084 These attributes may or may not be currently present in the MAM.
2087 Specify an attribute to write to the MAM.
2088 This option is not yet implemented.
2090 Specify the attribute number to display.
2091 This option only works with the attr_values, attr_list and supp_attr
2095 Display cached attributes.
2096 If the device supports this flag, it allows displaying attributes for the
2097 last piece of media loaded in the drive.
2099 Specify the element address.
2100 This is used for specifying which element number in a medium changer to
2101 access when reading attributes.
2102 The element number could be for a picker, portal, slot or drive.
2103 .It Fl F Ar form1,form2
2104 Specify the output format for the attribute values (attr_val) display as a
2105 comma separated list of options.
2106 The default output is currently set to field_all,nonascii_trim,text_raw.
2107 Once this code is ported to FreeBSD 10, any text fields will be converted
2108 from their codeset to the user's native codeset with
2111 The text options are mutually exclusive; if you specify more than one, you
2112 will get unpredictable results.
2113 The nonascii options are also mutually exclusive.
2114 Most of the field options may be logically ORed together.
2117 Print text fields with non-ASCII characters escaped.
2119 Print text fields natively, with no codeset conversion.
2121 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2122 escape the non-ASCII characters.
2124 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2125 omit the non-ASCII characters.
2127 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2128 print them as they are.
2130 Print all of the prefix fields: description, attribute number, attribute
2131 size, and the attribute's readonly status.
2132 If field_all is specified, specifying any other field options will not have
2135 Print none of the prefix fields, and only print out the attribute value.
2136 If field_none is specified, specifying any other field options will result
2137 in those fields being printed.
2139 Print out the attribute description.
2141 Print out the attribute number.
2143 Print out the attribute size.
2145 Print out the attribute's readonly status.
2148 Specify the partition.
2149 When the media has multiple partitions, specifying different partition
2150 numbers allows seeing the values for each individual partition.
2151 .It Fl s Ar start_num
2152 Specify the starting attribute number.
2153 This requests that the target device return attribute information starting
2154 at the given number.
2155 .It Fl T Ar elem_type
2156 Specify the element type.
2157 For medium changer devices, this allows specifying the type the element
2158 referenced in the element address (
2168 Specify the number of the logical volume to operate on.
2169 If the media has multiple logical volumes, this will allow displaying
2170 or writing attributes on the given logical volume.
2173 Issue the REPORT SUPPORTED OPCODES service action of the
2177 Without arguments, this command will return a list of all
2179 commands supported by the device, including service actions of commands
2180 that support service actions.
2181 It will also include the
2183 CDB (Command Data Block) length for each command, and the description of
2184 each command if it is known.
2187 Request information on a specific opcode instead of the list of supported
2189 If supported, the target will return a CDB-like structure that indicates
2190 the opcode, service action (if any), and a mask of bits that are supported
2192 .It Fl s Ar service_action
2193 For commands that support a service action, specify the service action to
2196 If a service action is specified for a given opcode, and the device does
2197 not support the given service action, the device should not return a
2199 error, but rather indicate in the returned parameter data that the command
2201 By default, if a service action is specified for an opcode, and service
2202 actions are not supported for the opcode in question, the device will
2205 Include timeout values.
2206 This option works with the default display, which includes all commands
2207 supported by the device, and with the
2211 options, which request information on a specific command and service
2213 This requests that the device report Nominal and Recommended timeout values
2214 for the given command or commands.
2215 The timeout values are in seconds.
2216 The timeout descriptor also includes a command-specific
2223 Zoned Block devices.
2224 This allows managing devices that conform to the
2226 Zoned Block Commands (ZBC) and
2228 Zoned ATA Command Set (ZAC)
2230 Devices using these command sets are usually hard drives using Shingled
2231 Magnetic Recording (SMR).
2232 There are three types of SMR drives:
2235 Drive Managed drives look and act just like a standard random access block
2236 device, but underneath, the drive reads and writes the bulk of its capacity
2238 Sequential writes will yield better performance, but writing sequentially
2241 Host Aware drives expose the underlying zone layout via
2245 commands and allow the host to manage the zone conditions.
2246 The host is not required to manage the zones on the drive, though.
2247 Sequential writes will yield better performance in Sequential Write
2248 Preferred zones, but the host can write randomly in those zones.
2250 Host Managed drives expose the underlying zone layout via
2255 The host is required to access the zones according to the rules described
2257 Any commands that violate the rules will be returned with an error.
2260 SMR drives are divided into zones (typically in the range of 256MB each)
2261 that fall into three general categories:
2264 These are also known as Non Write Pointer zones.
2265 These zones can be randomly written without an unexpected performance penalty.
2266 .It Sequential Preferred
2267 These zones should be written sequentially starting at the write pointer
2269 They may be written randomly.
2270 Writes that do not conform to the zone layout may be significantly slower
2272 .It Sequential Required
2273 These zones must be written sequentially.
2274 If they are not written sequentially, starting at the write pointer, the
2279 Specify the zone subcommand:
2282 Issue the Report Zones command.
2283 All zones are returned by default.
2284 Specify report options with
2286 and printing options with
2288 Specify the starting LBA with
2292 is also accepted as a command argument.
2294 Explicitly open the zone specified by the starting LBA.
2296 Close the zone specified by starting LBA.
2298 Finish the zone specified by the starting LBA.
2300 Reset the write pointer for the zone specified by the starting LBA.
2303 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2304 operation to all zones on the drive.
2306 Specify the starting LBA.
2307 For the Report Zones command, this tells the drive to report starting with
2308 the zone that starts at the given LBA.
2309 For the other commands, this allows the user to identify the zone requested
2310 by its starting LBA.
2311 The LBA may be specified in decimal, hexadecimal or octal notation.
2313 For the Report Zones command, specify a subset of zones to report.
2317 This is the default.
2319 Report only empty zones.
2321 Report zones that are implicitly open.
2322 This means that the host has sent a write to the zone without explicitly
2325 Report zones that are explicitly open.
2327 Report zones that have been closed by the host.
2329 Report zones that are full.
2331 Report zones that are in the read only state.
2334 is also accepted as an argument.
2336 Report zones that are in the offline state.
2338 Report zones where the device recommends resetting write pointers.
2340 Report zones that have the Non Sequential Resources Active flag set.
2341 These are zones that are Sequential Write Preferred, but have been written
2344 Report Non Write Pointer zones, also known as Conventional zones.
2346 .It Fl P Ar print_opt
2347 Specify a printing option for Report Zones:
2350 Normal Report Zones output.
2351 This is the default.
2352 The summary and column headings are printed, fields are separated by spaces
2353 and the fields themselves may contain spaces.
2355 Just print the summary: the number of zones, the maximum LBA (LBA of the
2356 last logical block on the drive), and the value of the
2361 field describes whether the zones on the drive are all identical, all
2362 different, or whether they are the same except for the last zone, etc.
2364 Print the zones in a script friendly format.
2365 The summary and column headings are omitted, the fields are separated by
2366 commas, and the fields do not contain spaces.
2367 The fields contain underscores where spaces would normally be used.
2373 Extended Power Conditions (EPC) feature set commands.
2376 protocol drives, and will not work on
2385 translation layer (SAT).
2386 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2387 the Extended Power Conditions feature set, available at t13.org, to
2388 understand the details of this particular
2393 Specify the epc subcommand
2396 Restore drive power condition settings.
2399 Specify the source for the restored power settings, either
2403 This argument is required.
2406 This only makes sense to specify when restoring from defaults.
2409 Go to the specified power condition.
2412 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2413 This argument is required.
2415 Specify delayed entry to the power condition.
2416 The drive, if it supports this, can enter the power condition after the
2419 Hold the power condition.
2420 If the drive supports this option, it will hold the power condition and
2421 reject all commands that would normally cause it to exit that power
2425 Set the timer value for a power condition and enable or disable the
2429 display described below to see what the current timer settings are for each
2430 Idle and Standby mode supported by the drive.
2433 Enable the power condition.
2440 Disable the power condition.
2447 Specify the timer in seconds.
2448 The user may specify a timer as a floating point number with a maximum
2449 supported resolution of tenths of a second.
2450 Drives may or may not support sub-second timer values.
2452 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2453 This argument is required.
2455 Save the timer and power condition enable/disable state.
2456 By default, if this option is not specified, only the current values for
2457 this power condition will be affected.
2460 Enable or disable a particular power condition.
2463 Enable the power condition.
2470 Disable the power condition.
2477 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2478 This argument is required.
2480 Save the power condition enable/disable state.
2481 By default, if this option is not specified, only the current values for
2482 this power condition will be affected.
2485 Enable the Extended Power Condition (EPC) feature set.
2487 Disable the Extended Power Condition (EPC) feature set.
2489 Specify the EPC power source.
2492 Specify the power source, either
2498 Get the current status of several parameters related to the Extended Power
2499 Condition (EPC) feature set, including whether APM and EPC are supported
2500 and enabled, whether Low Power Standby is supported, whether setting the
2501 EPC power source is supported, whether Low Power Standby is supported and
2502 the current power condition.
2505 Only report the current power condition.
2506 Some drives will exit their current power condition if a command other than
2509 CHECK POWER MODE command is received.
2510 If this flag is specified,
2514 CHECK POWER MODE command to the drive.
2519 Power Conditions log (Log Address 0x08).
2520 This shows the list of Idle and Standby power conditions the drive
2521 supports, and a number of parameters about each condition, including
2522 whether it is enabled and what the timer value is.
2526 Issue REPORT TIMESTAMP or SET TIMESTAMP
2533 option must be specified.
2536 Report the device's timestamp.
2537 If no more arguments are specified, the timestamp will be reported using
2538 the national representation of the date and time, followed by the time
2542 Specify the strftime format string, as documented in strftime(3), to be used
2543 to format the reported timestamp.
2545 Report the timestamp as milliseconds since the epoch.
2547 Report the timestamp using the national representation of the date and
2548 time, but override the system time zone and use UTC instead.
2553 Set the device's timestamp.
2560 option must be specified.
2563 Specify the strptime format string, as documented in strptime(3).
2564 The time must also be specified with the
2568 Provide the time in the format specified with the
2572 Set the timestamp to the host system's time in UTC.
2576 Print out the device type for specified device.
2579 An ATA device attached directly to an ATA controller
2581 An SATA device attached behind a SAS controller via SCSI-ATA Translation Layer (SATL)
2585 An directly attached NVMe device
2587 An MMC or SD device attached via a mmcsd bus
2589 No device type reported
2591 Device type is unknown
2593 A programming error occurred
2596 Commands necessary to support the depopulation (depop) of defective elements of a device
2597 (typically heads for hard drives) or setting capacity point (typically used on
2599 Issues either GET PHYSICAL ELEMENT STATUS, REMOVE ELEMENT AND TRUNCATE, or RESTORE
2600 ELEMENT AND REBUILD command to manage storage elements of a drive.
2601 Removal or restoration of elements may take up to a day to complete.
2607 options must be specified.
2608 These options are mutually exclusive.
2609 Only SCSI drives are supported.
2610 Changing the storage elements of a storage drive may result in the loss of all
2611 data on that storage drive.
2612 The drive may need to reinitialize after
2617 The data on the drive is inaccessible until one of these commands complete.
2618 Once one of these commands start, the drive is format corrupt until the
2619 operation successfully completes.
2620 While format corrupt, no read or write I/O is possible to the drive.
2621 If the drive power cycles, it will remain format corrupt and the operation
2625 can monitor an in-progress depop operation.
2627 .It Fl c Ar capacity
2628 Specify the desired capacity point for the drive.
2633 Remove the physical element from service or set the capacity point specified by the
2638 The drive's capacity may be reduced by this operation.
2640 Specify the physical element to remove from service.
2645 Report the current status of the physical elements of a drive.
2647 Restore all the eligible physical elements to service.
2650 Print out verbose usage information.
2655 variable allows the user to specify an alternate mode page format file.
2659 variable determines which text editor
2661 starts when editing mode pages.
2663 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2664 .It Pa /usr/share/misc/scsi_modes
2665 is the SCSI mode format database.
2667 is the transport layer device.
2669 are the CAM application passthrough devices.
2672 .Dl camcontrol eject -n cd -u 1 -v
2674 Eject the CD from cd1, and print SCSI sense information if the command
2677 .Dl camcontrol tur da0
2679 Send the SCSI test unit ready command to da0.
2682 utility will report whether the disk is ready, but will not display sense
2683 information if the command fails since the
2685 switch was not specified.
2686 .Bd -literal -offset indent
2687 camcontrol tur da1 -E -C 4 -t 50 -Q head -v
2690 Send a test unit ready command to da1.
2691 Enable kernel error recovery.
2692 Specify a retry count of 4, and a timeout of 50 seconds.
2696 flag) if the command fails.
2697 Since error recovery is turned on, the
2698 disk will be spun up if it is not currently spinning.
2701 task attribute for the command will be set to Head of Queue.
2704 utility will report whether the disk is ready.
2705 .Bd -literal -offset indent
2706 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2707 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2710 Issue a READ BUFFER command (0x3C) to cd1.
2711 Display the buffer size of cd1,
2712 and display the first 10 bytes from the cache on cd1.
2714 information if the command fails.
2715 .Bd -literal -offset indent
2716 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2717 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2720 Issue a WRITE BUFFER (0x3B) command to cd1.
2721 Write out 10 bytes of data,
2722 not including the (reserved) 4 byte header.
2723 Print out sense information if
2725 Be very careful with this command, improper use may
2726 cause data corruption.
2727 .Bd -literal -offset indent
2728 camcontrol modepage da3 -m 1 -e -P 3
2731 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2732 settings on the drive.
2733 Mode page 1 contains a disk drive's auto read and
2734 write reallocation settings, among other things.
2736 .Dl camcontrol rescan all
2738 Rescan all SCSI buses in the system for devices that have been added,
2741 .Dl camcontrol rescan 0
2743 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2745 .Dl camcontrol rescan 0:1:0
2747 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2750 .Dl camcontrol tags da5 -N 24
2752 Set the number of concurrent transactions for da5 to 24.
2753 .Bd -literal -offset indent
2754 camcontrol negotiate -n da -u 4 -T disable
2757 Disable tagged queueing for da4.
2758 .Bd -literal -offset indent
2759 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2762 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2764 Test Unit Ready command to make the settings take effect.
2765 .Bd -literal -offset indent
2766 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2769 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2771 Display SMP errors if the command fails.
2772 .Bd -literal -offset indent
2773 camcontrol security ada0
2776 Report security support and settings for ada0
2777 .Bd -literal -offset indent
2778 camcontrol security ada0 -U user -s MyPass
2781 Enable security on device ada0 with the password MyPass
2782 .Bd -literal -offset indent
2783 camcontrol security ada0 -U user -e MyPass
2786 Secure erase ada0 which has had security enabled with user password MyPass
2788 .Em WARNING! WARNING! WARNING!
2792 data from the device, so backup your data before using!
2794 This command can be used against an SSD drive to restoring it to
2795 factory default write performance.
2796 .Bd -literal -offset indent
2800 Report HPA support and settings for ada0 (also reported via
2802 .Bd -literal -offset indent
2803 camcontrol hpa ada0 -s 10240
2806 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2808 .Em WARNING! WARNING! WARNING!
2812 to all data on the device beyond this limit until HPA is disabled by setting
2813 HPA to native max sectors of the device, which can only be done after a
2814 power-on or hardware reset!
2817 use this on a device which has an active filesystem!
2818 .Bd -literal -offset indent
2819 camcontrol persist da0 -v -i read_keys
2822 This will read any persistent reservation keys registered with da0, and
2823 display any errors encountered when sending the PERSISTENT RESERVE IN
2826 .Bd -literal -offset indent
2827 camcontrol persist da0 -v -o register -a -K 0x12345678
2830 This will register the persistent reservation key 0x12345678 with da0,
2831 apply that registration to all ports on da0, and display any errors that
2832 occur when sending the PERSISTENT RESERVE OUT command.
2833 .Bd -literal -offset indent
2834 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2837 This will reserve da0 for the exlusive use of the initiator issuing the
2839 The scope of the reservation is the entire LUN.
2840 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2841 .Bd -literal -offset indent
2842 camcontrol persist da0 -v -i read_full
2845 This will display the full status of all reservations on da0 and print out
2846 status if there are any errors.
2847 .Bd -literal -offset indent
2848 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2851 This will release a reservation on da0 of the type ex_ac
2853 The Reservation Key for this registration is 0x12345678.
2854 Any errors that occur will be displayed.
2855 .Bd -literal -offset indent
2856 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2857 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2860 This will register the key 0x12345678 with da0, specifying that it applies
2861 to the SAS initiators with SAS addresses 0x1234567812345678 and
2863 .Bd -literal -offset indent
2864 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2865 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2868 This will move the registration from the current initiator, whose
2869 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2870 Fiber Channel World Wide Node Name 0x1234567812345678.
2871 A new registration key, 0x12345678, will be registered for the initiator
2872 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2873 current initiator will be unregistered from the target.
2874 The reservation will be moved to relative target port 2 on the target
2876 The registration will persist across power losses.
2877 .Bd -literal -offset indent
2878 camcontrol attrib sa0 -v -i attr_values -p 1
2881 This will read and decode the attribute values from partition 1 on the tape
2882 in tape drive sa0, and will display any
2885 .Bd -literal -offset indent
2886 camcontrol zone da0 -v -c rz -P summary
2889 This will request the SMR zone list from disk da0, and print out a
2890 summary of the zone parameters, and display any
2895 .Bd -literal -offset indent
2896 camcontrol zone da0 -v -c rz -o reset
2899 This will request the list of SMR zones that should have their write
2900 pointer reset from the disk da0, and display any
2905 .Bd -literal -offset indent
2906 camcontrol zone da0 -v -c rwp -l 0x2c80000
2909 This will issue the Reset Write Pointer command to disk da0 for the zone
2910 that starts at LBA 0x2c80000 and display any
2915 .Bd -literal -offset indent
2916 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2919 Set the timer for the Idle_a power condition on drive
2921 to 60.1 seconds, enable that particular power condition, and save the timer
2922 value and the enabled state of the power condition.
2923 .Bd -literal -offset indent
2924 camcontrol epc da4 -c goto -p Standby_z -H
2929 to go to the Standby_z power state (which is
2930 the drive's lowest power state) and hold in that state until it is
2931 explicitly released by another
2934 .Bd -literal -offset indent
2935 camcontrol epc da2 -c status -P
2938 Report only the power state of
2941 Some drives will power up in response to the commands sent by the
2949 CHECK POWER MODE command, which should not trigger a change in the drive's
2951 .Bd -literal -offset indent
2952 camcontrol epc ada0 -c list
2955 Display the ATA Power Conditions log (Log Address 0x08) for
2958 .Bd -literal -offset indent
2959 camcontrol timestamp sa0 -s -f "%a, %d %b %Y %T %z" \e
2960 -T "Wed, 26 Oct 2016 21:43:57 -0600"
2963 Set the timestamp of drive
2967 format string followed by a time string
2968 that was created using this format string.
2971 .Xr cam_cdbparse 3 ,
2981 utility first appeared in
2984 The mode page editing code and arbitrary SCSI command code are based upon
2989 library, written by Julian Elischer and Peter Dufault.
2992 program first appeared in
2994 and first appeared in
2999 .An Kenneth Merry Aq Mt ken@FreeBSD.org
3001 The code that parses the generic command line arguments does not know that
3002 some of the subcommands take multiple arguments.
3003 So if, for instance, you
3004 tried something like this:
3005 .Bd -literal -offset indent
3006 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
3009 The sense information from the test unit ready command would not get
3010 printed out, since the first
3014 bails out when it sees the second argument to
3018 Fixing this behavior would take some gross code, or changes to the
3021 The best way to circumvent this problem is to always make sure
3024 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob