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
125 .Aq Fl m Ar page[,subpage] | Fl l
133 .Aq Fl a Ar cmd Op args
134 .Aq Fl c Ar cmd Op args
137 .Op Fl i Ar len Ar fmt
139 .Op Fl o Ar len Ar fmt Op args
146 .Aq Fl r Ar len Ar fmt Op args
147 .Aq Fl R Ar len Ar fmt Op args
159 .Op Fl o Ar operation
163 .Op Fl T Ar pp_timeout
164 .Op Fl a Ar enable|disable
165 .Op Fl A Ar enable|disable
166 .Op Fl s Ar enable|disable
167 .Op Fl S Ar enable|disable
188 .Aq all | off | device id | bus Ns Op :target Ns Op :lun
201 .Op Fl D Ar enable|disable
206 .Op Fl T Ar enable|disable
208 .Op Fl W Ar bus_width
222 .Aq Fl a Ar overwrite | block | crypto | exitfailure
276 .Op Fl l Ar high|maximum
280 .Op Fl U Ar user|master
291 .Op Fl s Ar max_sectors
300 .Op Fl s Ar max_sectors
305 .Aq Fl i Ar action | Fl o Ar action
311 .Op Fl R Ar rel_tgt_port
320 .Aq Fl r Ar action | Fl w Ar attrib
323 .Op Fl e Ar elem_addr
324 .Op Fl F Ar form1,form2
326 .Op Fl s Ar start_addr
327 .Op Fl T Ar elem_type
334 .Op Fl s Ar service_action
343 .Op Fl P Ar print_opts
351 .Op Fl p Ar power_cond
353 .Op Fl r Ar restore_src
355 .Op Fl S Ar power_src
361 .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
370 utility is designed to provide a way for users to access and control the
377 can cause a loss of data and/or system crashes if used improperly.
379 expert users are encouraged to exercise caution when using this command.
380 Novice users should stay away from this utility.
384 utility has a number of primary functions, many of which support an optional
386 A device identifier can take one of three forms:
389 Specify a device name and unit number combination, like "da5" or "cd3".
391 Specify a bus number and target id.
392 The bus number can be determined from
394 .Dq camcontrol devlist .
395 The lun defaults to 0.
397 Specify the bus, target and lun for a device.
401 The device identifier, if it is specified,
403 come immediately after the function name, and before any generic or
404 function-specific arguments.
409 arguments described below will override any device name or unit number
410 specified beforehand.
417 override a specified bus:target or bus:target:lun, however.
421 primary functions support these generic arguments:
424 SCSI command retry count.
425 In order for this to work, error recovery
429 Instruct the kernel to perform generic SCSI error recovery for the given
431 This is needed in order for the retry count
434 Other than retrying commands, the generic error recovery in
435 the code will generally attempt to spin up drives that are not spinning.
436 It may take some other actions, depending upon the sense code returned from
439 Specify the device type to operate on, e.g.\& "da", "cd".
440 .It Fl Q Ar task_attr
442 task attribute for the command, if it is a
445 This may be ordered, simple, head, or aca.
446 In most cases this is not needed.
447 The default is simple, which works with all
450 The task attribute may also be specified numerically.
452 SCSI command timeout in seconds.
453 This overrides the default timeout for
455 .It Fl u Ar unit_number
456 Specify the device unit number, e.g.\& "1", "5".
458 Be verbose, print out sense information for failed SCSI commands.
461 Primary command functions:
462 .Bl -tag -width periphlist
464 List all physical devices (logical units) attached to the CAM subsystem.
465 This also includes a list of peripheral drivers attached to each device.
468 argument, SCSI bus number, adapter name and unit numbers are printed as
470 On the other hand, with the
472 argument, only the bus adapter, and unit information will be printed, and
473 device information will be omitted.
475 List all peripheral drivers attached to a given physical device (logical
478 Send the SCSI test unit ready (0x00) command to the given device.
481 utility will report whether the device is ready or not.
483 Send a SCSI inquiry command (0x12) to a device.
486 will print out the standard inquiry data, device serial number, and
487 transfer rate information.
488 The user can specify that only certain types of
489 inquiry data be printed:
492 Get the standard inquiry data.
494 Print out the serial number.
495 If this flag is the only one specified,
497 will not print out "Serial Number" before the value returned by the drive.
498 This is to aid in script writing.
500 Print out transfer rate information.
503 Send a ATA identify command (0xec) to a device.
505 Send the SCSI REPORT LUNS (0xA0) command to the given device.
508 will print out the list of logical units (LUNs) supported by the target device.
509 There are a couple of options to modify the output:
512 Just print out a count of LUNs, not the actual LUN numbers.
514 Just print out the LUNs, and do not print out the count.
515 .It Fl r Ar reporttype
516 Specify the type of report to request from the target:
517 .Bl -tag -width 012345678
519 Return the default report.
523 Most targets will support this report if they support the REPORT LUNS
526 Return only well known LUNs.
528 Return all available LUNs.
533 will try to print out LUN numbers in a reasonable format.
534 It can understand the peripheral, flat, LUN and extended LUN formats.
536 Send the SCSI READ CAPACITY command to the given device and display
538 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
539 action will be sent to obtain the full size of the device.
542 will print out the last logical block of the device, and the blocksize of
544 To modify the output format, use the following options:
547 Just print out the blocksize, not the last block or device size.
548 This cannot be used with
553 Print out the device size in human readable (base 2, 1K == 1024) format.
556 and cannot be used with
561 Print out the device size in human readable (base 10, 1K == 1000) format.
563 Skip sending the SCSI READ CAPACITY (10) command.
564 Send only the SCSI READ CAPACITY (16) service action and report
566 When the two do not match, a quirk is needed to resolve the ambiguity.
568 Print out the number of blocks in the device instead of the last logical
571 Quiet, print out the numbers only (separated by a comma if
577 Print out the last logical block or the size of the device only, and omit
581 Note that this command only displays the information, it does not update
582 the kernel data structures.
585 reprobe subcommand to do that.
587 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
590 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
593 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
594 start bit set and the load/eject bit set.
596 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
597 start bit cleared and the load/eject bit set.
599 Tell the kernel to scan all buses in the system (with the
601 argument), the given bus (XPT_SCAN_BUS), bus:target:lun or device
602 (XPT_SCAN_LUN) for new devices or devices that have gone away.
604 may specify a scan of all buses, a single bus, or a lun.
606 on a target is not supported.
608 If a device is specified by peripheral name and unit number, for instance
609 da4, it may only be rescanned if that device currently exists in the CAM EDT
610 (Existing Device Table).
611 If the device is no longer there (see
614 you must use the bus:target:lun form to rescan it.
616 Tell the kernel to refresh the information about the device and
617 notify the upper layer,
619 This includes sending the SCSI READ CAPACITY command and updating
620 the disk size visible to the rest of the system.
622 Tell the kernel to reset all buses in the system (with the
624 argument), the given bus (XPT_RESET_BUS) by issuing a SCSI bus
625 reset for that bus, or to reset the given bus:target:lun or device
626 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
627 connecting to that device.
628 Note that this can have a destructive impact
633 READ DEFECT DATA (10) command (0x37) or the
635 READ DEFECT DATA (12) command (0xB7) to the given device, and
636 print out any combination of: the total number of defects, the primary
637 defect list (PLIST), and the grown defect list (GLIST).
640 Specify the requested format of the defect list.
641 The format argument is
643 Most drives support the physical sector format.
645 support the logical block format.
646 Many drives, if they do not support the
647 requested format, return the data in an alternate format, along with sense
648 information indicating that the requested data format is not supported.
652 attempts to detect this, and print out whatever format the drive returns.
653 If the drive uses a non-standard sense code to report that it does not
654 support the requested format,
656 will probably see the error as a failure to complete the request.
658 The format options are:
661 Print out the list as logical blocks.
662 This is limited to 32-bit block sizes, and isn't supported by many modern
665 Print out the list as logical blocks.
666 This option uses a 64-bit block size.
668 Print out the list in bytes from index format.
670 Print out the list in extended bytes from index format.
671 The extended format allows for ranges of blocks to be printed.
673 Print out the list in physical sector format.
674 Most drives support this format.
676 Print out the list in extended physical sector format.
677 The extended format allows for ranges of blocks to be printed.
680 Print out the grown defect list.
681 This is a list of bad blocks that have
682 been remapped since the disk left the factory.
684 Print out the primary defect list.
685 This is the list of defects that were present in the factory.
687 When printing status information with
689 only print the number of defects.
691 Just print the number of defects, not the list of defects.
693 Specify the starting offset into the defect list.
694 This implies using the
696 READ DEFECT DATA (12) command, as the 10 byte version of the command
697 doesn't support the address descriptor index field.
698 Not all drives support the 12 byte command, and some drives that support
699 the 12 byte command don't support the address descriptor index field.
701 Print out defects in hexadecimal (base 16) form instead of base 10 form.
710 will print out the number of defects given in the READ DEFECT DATA header
711 returned from the drive.
712 Some drives will report 0 defects if neither the primary or grown defect
715 Allows the user to display and optionally edit a SCSI mode page.
717 page formats are located in
718 .Pa /usr/share/misc/scsi_modes .
719 This can be overridden by specifying a different file in the
721 environment variable.
724 command takes several arguments:
727 Disable block descriptors for mode sense.
729 Displays mode page data in binary format.
731 This flag allows the user to edit values in the mode page.
733 either edit mode page values with the text editor pointed to by his
735 environment variable, or supply mode page values via standard input, using
738 uses to display mode page values.
739 The editor will be invoked if
741 detects that standard input is terminal.
743 Lists all available mode pages.
744 If specified more then once, also lists subpages.
745 .It Fl m Ar page[,subpage]
746 This specifies the number of the mode page and optionally subpage the user
747 would like to view and/or edit.
748 This argument is mandatory unless
752 This allows the user to specify the page control field.
754 .Bl -tag -width xxx -compact
766 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
769 function requires the
771 argument to specify SCSI CDB or the
773 argument to specify ATA Command Block registers values.
774 Other arguments are optional, depending on
776 The command and data specification syntax is documented
779 NOTE: If the CDB specified causes data to be transferred to or from the
780 SCSI device in question, you MUST specify either
785 .It Fl a Ar cmd Op args
786 This specifies the content of 12 ATA Command Block registers (command,
787 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
788 lba_high_exp, features_exp, sector_count, sector_count_exp).
789 .It Fl c Ar cmd Op args
790 This specifies the SCSI CDB.
791 SCSI CDBs may be 6, 10, 12 or 16 bytes.
793 Specifies DMA protocol to be used for ATA command.
795 Specifies FPDMA (NCQ) protocol to be used for ATA command.
796 .It Fl i Ar len Ar fmt
797 This specifies the amount of data to read, and how it should be displayed.
801 bytes of data will be read from the device and written to standard output.
802 .It Fl o Ar len Ar fmt Op args
803 This specifies the amount of data to be written to a device, and the data
804 that is to be written.
808 bytes of data will be read from standard input and written to the device.
810 This specifies that 11 result ATA Command Block registers should be displayed
811 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
812 lba_high_exp, sector_count, sector_count_exp), and how.
815 11 result registers will be written to standard output in hex.
818 Allows the user to send an arbitrary Serial
819 Management Protocol (SMP) command to a device.
822 function requires the
824 argument to specify the SMP request to be sent, and the
826 argument to specify the format of the SMP response.
827 The syntax for the SMP request and response arguments is documented in
830 Note that SAS adapters that support SMP passthrough (at least the currently
831 known adapters) do not accept CRC bytes from the user in the request and do
832 not pass CRC bytes back to the user in the response.
833 Therefore users should not include the CRC bytes in the length of the
834 request and not expect CRC bytes to be returned in the response.
836 .It Fl r Ar len Ar fmt Op args
837 This specifies the size of the SMP request, without the CRC bytes, and the
842 bytes of data will be read from standard input and written as the SMP
844 .It Fl R Ar len Ar fmt Op args
845 This specifies the size of the buffer allocated for the SMP response, and
846 the SMP response format.
850 bytes of data will be allocated for the response and the response will be
851 written to standard output.
854 Allows the user to send the Serial Management Protocol (SMP) Report General
857 will display the data returned by the Report General command.
858 If the SMP target supports the long response format, the additional data
859 will be requested and displayed automatically.
862 Request the long response format only.
863 Not all SMP targets support the long response format.
866 to skip sending the initial report general request without the long bit set
867 and only issue a report general request with the long bit set.
870 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
872 This function should be used with some caution, as it can render devices
873 inaccessible, and could potentially cause data corruption as well.
876 argument is required to specify the PHY to operate on.
879 Specify the PHY to operate on.
880 This argument is required.
882 Request the long request/response format.
883 Not all SMP targets support the long response format.
884 For the PHY Control command, this currently only affects whether the
885 request length is set to a value other than 0.
886 .It Fl o Ar operation
887 Specify a PHY control operation.
890 operation may be specified.
891 The operation may be specified numerically (in decimal, hexadecimal, or octal)
892 or one of the following operation names may be specified:
896 It is not necessary to specify this argument.
898 Send the LINK RESET command to the phy.
900 Send the HARD RESET command to the phy.
902 Send the DISABLE command to the phy.
903 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
905 Send the CLEAR ERROR LOG command.
906 This clears the error log counters for the specified phy.
908 Send the CLEAR AFFILIATION command.
909 This clears the affiliation from the STP initiator port with the same SAS
910 address as the SMP initiator that requests the clear operation.
912 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
913 This will cause a SATA port selector to use the given phy as its active phy
914 and make the other phy inactive.
916 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
918 Send the SET ATTACHED DEVICE NAME command to the PHY.
921 argument to specify the device name.
924 Specify the attached device name.
925 This option is needed with the
928 The name is a 64-bit number, and can be specified in decimal, hexadecimal
931 Set the minimum physical link rate for the phy.
932 This is a numeric argument.
933 Currently known link rates are:
936 Do not change current value.
945 Other values may be specified for newer physical link rates.
947 Set the maximum physical link rate for the phy.
948 This is a numeric argument.
951 argument description for known link rate arguments.
952 .It Fl T Ar pp_timeout
953 Set the partial pathway timeout value, in microseconds.
958 specification for more information on this field.
959 .It Fl a Ar enable|disable
960 Enable or disable SATA slumber phy power conditions.
961 .It Fl A Ar enable|disable
962 Enable or disable SATA partial power conditions.
963 .It Fl s Ar enable|disable
964 Enable or disable SAS slumber phy power conditions.
965 .It Fl S Ar enable|disable
966 Enable or disable SAS partial phy power conditions.
969 List phys attached to a SAS expander, the address of the end device
970 attached to the phy, and the inquiry data for that device and peripheral
971 devices attached to that device.
972 The inquiry data and peripheral devices are displayed if available.
975 Turn on the long response format for the underlying SMP commands used for
978 Only print out phys that are attached to a device in the CAM EDT (Existing
982 Send the SMP Report Manufacturer Information command to the device and
983 display the response.
986 Turn on the long response format for the underlying SMP commands used for
990 Turn on CAM debugging printfs in the kernel.
991 This requires options CAMDEBUG
992 in your kernel config file.
993 WARNING: enabling debugging printfs currently
994 causes an EXTREME number of kernel printfs.
995 You may have difficulty
996 turning off the debugging printfs once they start, since the kernel will be
997 busy printing messages and unable to service other requests quickly.
1000 function takes a number of arguments:
1003 Enable CAM_DEBUG_INFO printfs.
1005 Enable CAM_DEBUG_PERIPH printfs.
1007 Enable CAM_DEBUG_TRACE printfs.
1009 Enable CAM_DEBUG_SUBTRACE printfs.
1011 Enable CAM_DEBUG_XPT printfs.
1013 Enable CAM_DEBUG_CDB printfs.
1014 This will cause the kernel to print out the
1015 SCSI CDBs sent to the specified device(s).
1017 Enable CAM_DEBUG_PROBE printfs.
1019 Enable debugging for all devices.
1021 Turn off debugging for all devices
1022 .It bus Ns Op :target Ns Op :lun
1023 Turn on debugging for the given bus, target or lun.
1024 If the lun or target
1025 and lun are not specified, they are wildcarded.
1026 (i.e., just specifying a
1027 bus turns on debugging printfs for all devices on that bus.)
1030 Show or set the number of "tagged openings" or simultaneous transactions
1031 we attempt to queue to a particular device.
1034 command, with no command-specific arguments (i.e., only generic arguments)
1035 prints out the "soft" maximum number of transactions that can be queued to
1036 the device in question.
1037 For more detailed information, use the
1039 argument described below.
1042 Set the number of tags for the given device.
1043 This must be between the
1044 minimum and maximum number set in the kernel quirk table.
1046 most devices that support tagged queueing is a minimum of 2 and a maximum
1048 The minimum and maximum values for a given device may be
1049 determined by using the
1056 subcommand is described below.
1058 Be quiet, and do not report the number of tags.
1059 This is generally used when
1060 setting the number of tags.
1062 The verbose flag has special functionality for the
1067 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1070 This is the amount of capacity for transactions queued to a given device.
1072 This is the number of transactions currently queued to a device.
1074 This is the kernel queue space for transactions.
1075 This count usually mirrors
1076 dev_openings except during error recovery operations when
1077 the device queue is frozen (device is not allowed to receive
1078 commands), the number of dev_openings is reduced, or transaction
1079 replay is occurring.
1081 This is the number of transactions waiting in the kernel queue for capacity
1083 This number is usually zero unless error recovery is in
1086 The held count is the number of CCBs held by peripheral drivers that have
1087 either just been completed or are about to be released to the transport
1088 layer for service by a device.
1089 Held CCBs reserve capacity on a given
1092 This is the current "hard" minimum number of transactions that can be
1093 queued to a device at once.
1096 value above cannot go below this number.
1097 The default value for
1099 is 2, although it may be set higher or lower for various devices.
1101 This is the "hard" maximum number of transactions that can be queued to a
1105 value cannot go above this number.
1106 The default value for
1108 is 255, although it may be set higher or lower for various devices.
1112 Show or negotiate various communication parameters.
1113 Some controllers may
1114 not support setting or changing some of these values.
1116 Adaptec 174x controllers do not support changing a device's sync rate or
1121 will not attempt to set the parameter if the controller indicates that it
1122 does not support setting the parameter.
1123 To find out what the controller
1131 command is described below.
1132 Also, some controller drivers do not support
1133 setting negotiation parameters, even if the underlying controller supports
1134 negotiation changes.
1135 Some controllers, such as the Advansys wide
1136 controllers, support enabling and disabling synchronous negotiation for
1137 a device, but do not support setting the synchronous negotiation rate.
1140 Attempt to make the negotiation settings take effect immediately by sending
1141 a Test Unit Ready command to the device.
1143 Show or set current negotiation settings.
1144 This is the default.
1145 .It Fl D Ar enable|disable
1146 Enable or disable disconnection.
1150 Set the command delay offset.
1152 Be quiet, do not print anything.
1153 This is generally useful when you want to
1154 set a parameter, but do not want any status information.
1155 .It Fl R Ar syncrate
1156 Change the synchronization rate for a device.
1157 The sync rate is a floating
1158 point value specified in MHz.
1161 is a legal value, as is
1163 .It Fl T Ar enable|disable
1164 Enable or disable tagged queueing for a device.
1166 Show or set user negotiation settings.
1167 The default is to show or set
1168 current negotiation settings.
1170 The verbose switch has special meaning for the
1175 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1177 .It Fl W Ar bus_width
1178 Specify the bus width to negotiate with a device.
1181 The only useful values to specify are 8, 16, and 32
1183 The controller must support the bus width in question in order for
1184 the setting to take effect.
1187 In general, sync rate and offset settings will not take effect for a
1188 device until a command has been sent to the device.
1191 switch above will automatically send a Test Unit Ready to the device so
1192 negotiation parameters will take effect.
1196 FORMAT UNIT command to the named device.
1198 .Em WARNING! WARNING! WARNING!
1200 Low level formatting a disk will destroy ALL data on the disk.
1202 extreme caution when issuing this command.
1203 Many users low-level format
1204 disks that do not really need to be low-level formatted.
1206 relatively few scenarios that call for low-level formatting a disk.
1208 low-level formatting a disk is to initialize the disk after changing
1209 its physical sector size.
1210 Another reason for low-level formatting a disk
1211 is to revive the disk if you are getting "medium format corrupted" errors
1212 from the disk in response to read and write requests.
1214 Some disks take longer than others to format.
1215 Users should specify a
1216 timeout long enough to allow the format to complete.
1218 timeout is 3 hours, which should be long enough for most disks.
1220 disks will complete a format operation in a very short period of time
1221 (on the order of 5 minutes or less).
1222 This is often because the drive
1223 does not really support the FORMAT UNIT command -- it just accepts the
1224 command, waits a few minutes and then returns it.
1228 subcommand takes several arguments that modify its default behavior.
1233 arguments can be useful for scripts.
1236 Be quiet, do not print any status messages.
1237 This option will not disable
1238 the questions, however.
1239 To disable questions, use the
1246 This will report status on a format that is already running on the drive.
1248 Issue a non-immediate format command.
1251 issues the FORMAT UNIT command with the immediate bit set.
1253 device to immediately return the format command, before the format has
1259 sense information from the device every second to determine how far along
1260 in the format process it is.
1263 argument is specified,
1265 will issue a non-immediate format command, and will be unable to print any
1266 information to let the user know what percentage of the disk has been
1269 Do not ask any questions.
1272 will ask the user if he/she really wants to format the disk in question,
1273 and also if the default format command timeout is acceptable.
1275 will not be asked about the timeout if a timeout is specified on the
1281 SANITIZE command to the named device.
1283 .Em WARNING! WARNING! WARNING!
1285 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1286 Recovery of the data is not possible.
1287 Use extreme caution when issuing this command.
1291 subcommand takes several arguments that modify its default behavior.
1296 arguments can be useful for scripts.
1298 .It Fl a Ar operation
1299 Specify the sanitize operation to perform.
1302 Perform an overwrite operation by writing a user supplied
1303 data pattern to the device one or more times.
1304 The pattern is given by the
1307 The number of times is given by the
1311 Perform a block erase operation.
1312 All the device's blocks are set to a vendor defined
1313 value, typically zero.
1315 Perform a cryptographic erase operation.
1316 The encryption keys are changed to prevent the decryption
1319 Exits a previously failed sanitize operation.
1320 A failed sanitize operation can only be exited if it was
1321 run in the unrestricted completion mode, as provided by the
1326 The number of passes when performing an
1329 Valid values are between 1 and 31.
1334 operation, the pattern is inverted between consecutive passes.
1336 Path to the file containing the pattern to use when
1340 The pattern is repeated as needed to fill each block.
1342 Be quiet, do not print any status messages.
1343 This option will not disable
1344 the questions, however.
1345 To disable questions, use the
1349 Perform the sanitize in the unrestricted completion mode.
1350 If the operation fails, it can later be exited with the
1357 This will report status on a sanitize that is already running on the drive.
1359 Issue a non-immediate sanitize command.
1362 issues the SANITIZE command with the immediate bit set.
1364 device to immediately return the sanitize command, before
1365 the sanitize has actually completed.
1370 sense information from the device every second to determine how far along
1371 in the sanitize process it is.
1374 argument is specified,
1376 will issue a non-immediate sanitize command, and will be unable to print any
1377 information to let the user know what percentage of the disk has been
1380 Do not ask any questions.
1383 will ask the user if he/she really wants to sanitize the disk in question,
1384 and also if the default sanitize command timeout is acceptable.
1386 will not be asked about the timeout if a timeout is specified on the
1390 Put ATA device into IDLE state.
1393 specifies automatic standby timer value in seconds.
1394 Value 0 disables timer.
1396 Put ATA device into STANDBY state.
1399 specifies automatic standby timer value in seconds.
1400 Value 0 disables timer.
1402 Put ATA device into SLEEP state.
1403 Note that the only way get device out of
1404 this state may be reset.
1406 Report ATA device power mode.
1408 It optional parameter
1410 specified, enables and sets advanced power management level, where
1411 1 -- minimum power, 127 -- maximum performance with standby,
1412 128 -- minimum power without standby, 254 -- maximum performance.
1413 If not specified -- APM is disabled.
1415 It optional parameter
1417 specified, enables and sets automatic acoustic management level, where
1418 1 -- minimum noise, 254 -- maximum performance.
1419 If not specified -- AAM is disabled.
1421 Update or report security settings, using an ATA identify command (0xec).
1424 will print out the security support and associated settings of the device.
1427 command takes several arguments:
1431 Disable device security using the given password for the selected user according
1432 to the devices configured security level.
1435 Erase the device using the given password for the selected user.
1437 .Em WARNING! WARNING! WARNING!
1439 Issuing a secure erase will
1441 user data on the device and may take several hours to complete.
1443 When this command is used against an SSD drive all its cells will be marked as
1444 empty, restoring it to factory default write performance.
1445 For SSD's this action
1446 usually takes just a few seconds.
1449 Freeze the security configuration of the specified device.
1451 After command completion any other commands that update the device lock mode
1452 shall be command aborted.
1453 Frozen mode is disabled by power-off or hardware reset.
1456 Enhanced erase the device using the given password for the selected user.
1458 .Em WARNING! WARNING! WARNING!
1460 Issuing an enhanced secure erase will
1462 user data on the device and may take several hours to complete.
1464 An enhanced erase writes predetermined data patterns to all user data areas,
1465 all previously written user data shall be overwritten, including sectors that
1466 are no longer in use due to reallocation.
1469 Unlock the device using the given password for the selected user according to
1470 the devices configured security level.
1471 .It Fl l Ar high|maximum
1473 Specifies which security level to set when issuing a
1476 The security level determines device behavior when the master
1477 password is used to unlock the device.
1478 When the security level is set to high
1479 the device requires the unlock command and the master password to unlock.
1480 When the security level is set to maximum the device requires a secure erase
1481 with the master password to unlock.
1483 This option must be used in conjunction with one of the security action commands.
1489 Be quiet, do not print any status messages.
1490 This option will not disable the questions, however.
1491 To disable questions, use the
1496 Password the device (enable security) using the given password for the selected
1498 This option can be combined with other options such as
1501 A master password may be set in a addition to the user password. The purpose of
1502 the master password is to allow an administrator to establish a password that
1503 is kept secret from the user, and which may be used to unlock the device if the
1504 user password is lost.
1507 Setting the master password does not enable device security.
1509 If the master password is set and the drive supports a Master Revision Code
1510 feature the Master Password Revision Code will be decremented.
1513 Overrides the default timeout, specified in seconds, used for both
1517 this is useful if your system has problems processing long timeouts correctly.
1519 Usually the timeout is calculated from the information stored on the drive if
1520 present, otherwise it defaults to 2 hours.
1521 .It Fl U Ar user|master
1523 Specifies which user to set / use for the running action command, valid values
1524 are user or master and defaults to master if not set.
1526 This option must be used in conjunction with one of the security action commands.
1532 Confirm yes to dangerous options such as
1534 without prompting for confirmation.
1537 If the password specified for any action commands does not match the configured
1538 password for the specified user the command will fail.
1540 The password in all cases is limited to 32 characters, longer passwords will
1543 Update or report Host Protected Area details.
1546 will print out the HPA support and associated settings of the device.
1549 command takes several optional arguments:
1553 Freeze the HPA configuration of the specified device.
1555 After command completion any other commands that update the HPA configuration
1556 shall be command aborted.
1557 Frozen mode is disabled by power-off or hardware reset.
1560 Lock the HPA configuration of the device until a successful call to unlock or
1561 the next power-on reset occurs.
1564 Make the HPA max sectors persist across power-on reset or a hardware reset.
1565 This must be used in combination with
1566 .Fl s Ar max_sectors
1570 Set the HPA configuration password required for unlock calls.
1573 Be quiet, do not print any status messages.
1574 This option will not disable the questions.
1575 To disable questions, use the
1578 .It Fl s Ar max_sectors
1580 Configures the maximum user accessible sectors of the device.
1581 This will change the number of sectors the device reports.
1583 .Em WARNING! WARNING! WARNING!
1585 Changing the max sectors of a device using this option will make the data on
1586 the device beyond the specified value inaccessible.
1589 .Fl s Ar max_sectors
1590 call can be made without a power-on reset or a hardware reset of the device.
1593 Unlock the HPA configuration of the specified device using the given password.
1594 If the password specified does not match the password configured via
1596 the command will fail.
1598 After 5 failed unlock calls, due to password miss-match, the device will refuse
1599 additional unlock calls until after a power-on reset.
1602 Confirm yes to dangerous options such as
1604 without prompting for confirmation
1607 The password for all HPA commands is limited to 32 characters, longer passwords
1610 Update or report Accessible Max Address Configuration.
1613 will print out the Accessible Max Address Configuration support and associated
1614 settings of the device.
1617 command takes several optional arguments:
1621 Freeze the Accessible Max Address Configuration of the specified device.
1623 After command completion any other commands that update the configuration
1624 shall be command aborted.
1625 Frozen mode is disabled by power-off.
1628 Be quiet, do not print any status messages.
1629 .It Fl s Ar max_sectors
1631 Configures the maximum user accessible sectors of the device.
1632 This will change the number of sectors the device reports.
1634 .Em WARNING! WARNING! WARNING!
1636 Changing the max sectors of a device using this option will make the data on
1637 the device beyond the specified value indeterminate.
1640 .Fl s Ar max_sectors
1641 call can be made without a power-on reset of the device.
1644 Program firmware of the named
1646 or ATA device using the image file provided.
1650 device and it provides a recommended timeout for the WRITE BUFFER command
1653 opcodes subcommand), that timeout will be used for the firmware download.
1654 The drive-recommended timeout value may be overridden on the command line
1659 Current list of supported vendors for SCSI/SAS drives:
1662 Tested with 4TB SAS drives, model number HUS724040ALS640.
1666 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1667 There is a separate table entry for hard drives, because the update method
1668 for hard drives is different than the method for tape drives.
1673 Tested with SM1625 SSDs.
1675 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1676 ES.3 (ST1000NM0023) drives.
1678 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1681 .Em WARNING! WARNING! WARNING!
1683 Little testing has been done to make sure that different device models from
1684 each vendor work correctly with the fwdownload command.
1685 A vendor name appearing in the supported list means only that firmware of at
1686 least one device type from that vendor has successfully been programmed with
1687 the fwdownload command.
1688 Extra caution should be taken when using this command since there is no
1689 guarantee it will not break a device from the listed vendors.
1690 Ensure that you have a recent backup of the data on the device before
1691 performing a firmware update.
1695 protocol devices will not be programmed, since there is little chance of
1696 the firmware download succeeding.
1699 will currently attempt a firmware download to any
1703 device, since the standard
1705 DOWNLOAD MICROCODE command may work.
1706 Firmware downloads to
1710 devices are supported for devices connected
1715 controllers, and devices connected to SAS controllers
1720 translation capability.
1726 PASS-THROUGH command to send the
1728 DOWNLOAD MICROCODE command to the drive.
1733 translation implementations don't work fully when translating
1735 WRITE BUFFER commands to
1737 DOWNLOAD MICROCODE commands, but do support
1739 passthrough well enough to do a firmware download.
1741 .It Fl f Ar fw_image
1742 Path to the firmware image file to be downloaded to the specified device.
1744 Do not print informational messages, only print errors.
1745 This option should be used with the
1747 option to suppress all output.
1749 Run in simulation mode.
1750 Device checks are run and the confirmation dialog is shown, but no firmware
1751 download will occur.
1757 errors in the event of a failure.
1759 In simulation mode, print out the
1764 register values that would be used for the firmware download command.
1766 Do not ask for confirmation.
1769 Persistent reservation support.
1770 Persistent reservations are a way to reserve a particular
1772 LUN for use by one or more
1777 option is specified,
1781 PERSISTENT RESERVE IN
1782 command using the requested service action.
1785 option is specified,
1789 PERSISTENT RESERVE OUT
1790 command using the requested service action.
1791 One of those two options is required.
1793 Persistent reservations are complex, and fully explaining them is outside
1794 the scope of this manual.
1797 and download the latest SPC spec for a full explanation of persistent
1801 Specify the service action for the PERSISTENT RESERVE IN command.
1802 Supported service actions:
1805 Report the current persistent reservation generation (PRgeneration) and any
1807 .It read_reservation
1808 Report the persistent reservation, if any.
1809 .It report_capabilities
1810 Report the persistent reservation capabilities of the LUN.
1811 .It read_full_status
1812 Report the full status of persistent reservations on the LUN.
1815 Specify the service action for the PERSISTENT RESERVE OUT command.
1816 For service actions like register that are components of other service
1817 action names, the entire name must be specified.
1818 Otherwise, enough of the service action name must be specified to
1819 distinguish it from other possible service actions.
1820 Supported service actions:
1823 Register a reservation key with the LUN or unregister a reservation key.
1824 To register a key, specify the requested key as the Service Action
1826 To unregister a key, specify the previously registered key as the
1828 To change a key, specify the old key as the Reservation Key and the new
1829 key as the Service Action Reservation Key.
1831 This is similar to the register subcommand, except that the Reservation Key
1833 The Service Action Reservation Key will overwrite any previous key
1834 registered for the initiator.
1836 Create a reservation.
1837 A key must be registered with the LUN before the LUN can be reserved, and
1838 it must be specified as the Reservation Key.
1839 The type of reservation must also be specified.
1840 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1842 Release a reservation.
1843 The Reservation Key must be specified.
1845 Release a reservation and remove all keys from the device.
1846 The Reservation Key must be specified.
1848 Remove a reservation belonging to another initiator.
1849 The Reservation Key must be specified.
1850 The Service Action Reservation Key may be specified, depending on the
1851 operation being performed.
1853 Remove a reservation belonging to another initiator and abort all
1854 outstanding commands from that 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 Register another initiator with the LUN, and establish a reservation on the
1860 LUN for that initiator.
1861 The Reservation Key and Service Action Reservation Key must be specified.
1863 Replace Lost Reservation information.
1866 Set the All Target Ports (ALL_TG_PT) bit.
1867 This requests that the key registration be applied to all target ports and
1868 not just the particular target port that receives the command.
1869 This only applies to the register and register_ignore actions.
1871 Specify a Transport ID.
1872 This only applies to the Register and Register and Move service actions for
1873 Persistent Reserve Out.
1874 Multiple Transport IDs may be specified with multiple
1877 With the Register service action, specifying one or more Transport IDs
1878 implicitly enables the
1880 option which turns on the SPEC_I_PT bit.
1881 Transport IDs generally have the format protocol,id.
1884 A SAS Transport ID consists of
1886 followed by a 64-bit SAS address.
1889 .Dl sas,0x1234567812345678
1891 A Fibre Channel Transport ID consists of
1893 followed by a 64-bit Fibre Channel World Wide Name.
1896 .Dl fcp,0x1234567812345678
1898 A Parallel SCSI address consists of
1900 followed by a SCSI target ID and a relative target port identifier.
1905 An IEEE 1394 (Firewire) Transport ID consists of
1907 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1910 .Dl sbp,0x1234567812345678
1912 A SCSI over RDMA Transport ID consists of
1914 followed by a 128-bit RDMA initiator port identifier.
1915 The port identifier must be exactly 32 or 34 (if the leading 0x is
1916 included) hexadecimal digits.
1917 Only hexadecimal (base 16) numbers are supported.
1920 .Dl srp,0x12345678123456781234567812345678
1922 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1924 For example, if only the iSCSI name is specified:
1926 .Dl iqn.2012-06.com.example:target0
1928 If the iSCSI separator and initiator session ID are specified:
1930 .Dl iqn.2012-06.com.example:target0,i,0x123
1932 A SCSI over PCIe Transport ID consists of
1934 followed by a PCIe Routing ID.
1935 The Routing ID consists of a bus, device and function or in the alternate
1936 form, a bus and function.
1937 The bus must be in the range of 0 to 255 inclusive and the device must be
1938 in the range of 0 to 31 inclusive.
1939 The function must be in the range of 0 to 7 inclusive if the standard form
1940 is used, and in the range of 0 to 255 inclusive if the alternate form is
1942 For example, if a bus, device and function are specified for the standard
1947 If the alternate Routing ID form is used:
1952 Specify the Reservation Key.
1953 This may be in decimal, octal or hexadecimal format.
1954 The value is zero by default if not otherwise specified.
1955 The value must be between 0 and 2^64 - 1, inclusive.
1957 Specify the Service Action Reservation Key.
1958 This may be in decimal, octal or hexadecimal format.
1959 The value is zero by default if not otherwise specified.
1960 The value must be between 0 and 2^64 - 1, inclusive.
1962 Enable the Activate Persist Through Power Loss bit.
1963 This is only used for the register and register_ignore actions.
1964 This requests that the reservation persist across power loss events.
1966 Specify the scope of the reservation.
1967 The scope may be specified by name or by number.
1968 The scope is ignored for register, register_ignore and clear.
1969 If the desired scope isn't available by name, you may specify the number.
1973 This encompasses the entire LUN.
1975 Extent scope (0x01).
1977 Element scope (0x02).
1980 Specify the Relative Target Port.
1981 This only applies to the Register and Move service action of the Persistent
1982 Reserve Out command.
1984 Enable the SPEC_I_PT bit.
1985 This only applies to the Register service action of Persistent Reserve Out.
1986 You must also specify at least one Transport ID with
1988 if this option is set.
1989 If you specify a Transport ID, this option is automatically set.
1990 It is an error to specify this option for any service action other than
1993 Specify the reservation type.
1994 The reservation type may be specified by name or by number.
1995 If the desired reservation type isn't available by name, you may specify
1997 Supported reservation type names:
2002 Write Exclusive mode.
2003 May also be specified as
2004 .Dq write_exclusive .
2006 Read Exclusive mode.
2007 May also be specified as
2008 .Dq read_exclusive .
2010 Exclusive access mode.
2011 May also be specified as
2012 .Dq exclusive_access .
2014 Write Exclusive Registrants Only mode.
2015 May also be specified as
2016 .Dq write_exclusive_reg_only .
2018 Exclusive Access Registrants Only mode.
2019 May also be specified as
2020 .Dq exclusive_access_reg_only .
2022 Write Exclusive All Registrants mode.
2023 May also be specified as
2024 .Dq write_exclusive_all_regs .
2026 Exclusive Access All Registrants mode.
2027 May also be specified as
2028 .Dq exclusive_access_all_regs .
2031 Specify that the target should unregister the initiator that sent
2032 the Register and Move request.
2033 By default, the target will not unregister the initiator that sends the
2034 Register and Move request.
2035 This option only applies to the Register and Move service action of the
2036 Persistent Reserve Out command.
2041 READ or WRITE ATTRIBUTE commands.
2042 These commands are used to read and write attributes in Medium Auxiliary
2044 The most common place Medium Auxiliary Memory is found is small flash chips
2045 included tape cartriges.
2053 option must be specified.
2056 Specify the READ ATTRIBUTE service action.
2059 Issue the ATTRIBUTE VALUES service action.
2060 Read and decode the available attributes and their values.
2062 Issue the ATTRIBUTE LIST service action.
2063 List the attributes that are available to read and write.
2065 Issue the LOGICAL VOLUME LIST service action.
2066 List the available logical volumes in the MAM.
2068 Issue the PARTITION LIST service action.
2069 List the available partitions in the MAM.
2071 Issue the SUPPORTED ATTRIBUTES service action.
2072 List attributes that are supported for reading or writing.
2073 These attributes may or may not be currently present in the MAM.
2076 Specify an attribute to write to the MAM.
2077 This option is not yet implemented.
2079 Specify the attribute number to display.
2080 This option only works with the attr_values, attr_list and supp_attr
2084 Display cached attributes.
2085 If the device supports this flag, it allows displaying attributes for the
2086 last piece of media loaded in the drive.
2088 Specify the element address.
2089 This is used for specifying which element number in a medium changer to
2090 access when reading attributes.
2091 The element number could be for a picker, portal, slot or drive.
2092 .It Fl F Ar form1,form2
2093 Specify the output format for the attribute values (attr_val) display as a
2094 comma separated list of options.
2095 The default output is currently set to field_all,nonascii_trim,text_raw.
2096 Once this code is ported to FreeBSD 10, any text fields will be converted
2097 from their codeset to the user's native codeset with
2100 The text options are mutually exclusive; if you specify more than one, you
2101 will get unpredictable results.
2102 The nonascii options are also mutually exclusive.
2103 Most of the field options may be logically ORed together.
2106 Print text fields with non-ASCII characters escaped.
2108 Print text fields natively, with no codeset conversion.
2110 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2111 escape the non-ASCII characters.
2113 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2114 omit the non-ASCII characters.
2116 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2117 print them as they are.
2119 Print all of the prefix fields: description, attribute number, attribute
2120 size, and the attribute's readonly status.
2121 If field_all is specified, specifying any other field options will not have
2124 Print none of the prefix fields, and only print out the attribute value.
2125 If field_none is specified, specifying any other field options will result
2126 in those fields being printed.
2128 Print out the attribute description.
2130 Print out the attribute number.
2132 Print out the attribute size.
2134 Print out the attribute's readonly status.
2137 Specify the partition.
2138 When the media has multiple partitions, specifying different partition
2139 numbers allows seeing the values for each individual partition.
2140 .It Fl s Ar start_num
2141 Specify the starting attribute number.
2142 This requests that the target device return attribute information starting
2143 at the given number.
2144 .It Fl T Ar elem_type
2145 Specify the element type.
2146 For medium changer devices, this allows specifying the type the element
2147 referenced in the element address (
2157 Specify the number of the logical volume to operate on.
2158 If the media has multiple logical volumes, this will allow displaying
2159 or writing attributes on the given logical volume.
2162 Issue the REPORT SUPPORTED OPCODES service action of the
2166 Without arguments, this command will return a list of all
2168 commands supported by the device, including service actions of commands
2169 that support service actions.
2170 It will also include the
2172 CDB (Command Data Block) length for each command, and the description of
2173 each command if it is known.
2176 Request information on a specific opcode instead of the list of supported
2178 If supported, the target will return a CDB-like structure that indicates
2179 the opcode, service action (if any), and a mask of bits that are supported
2181 .It Fl s Ar service_action
2182 For commands that support a service action, specify the service action to
2185 If a service action is specified for a given opcode, and the device does
2186 not support the given service action, the device should not return a
2188 error, but rather indicate in the returned parameter data that the command
2190 By default, if a service action is specified for an opcode, and service
2191 actions are not supported for the opcode in question, the device will
2194 Include timeout values.
2195 This option works with the default display, which includes all commands
2196 supported by the device, and with the
2200 options, which request information on a specific command and service
2202 This requests that the device report Nominal and Recommended timeout values
2203 for the given command or commands.
2204 The timeout values are in seconds.
2205 The timeout descriptor also includes a command-specific
2212 Zoned Block devices.
2213 This allows managing devices that conform to the
2215 Zoned Block Commands (ZBC) and
2217 Zoned ATA Command Set (ZAC)
2219 Devices using these command sets are usually hard drives using Shingled
2220 Magnetic Recording (SMR).
2221 There are three types of SMR drives:
2224 Drive Managed drives look and act just like a standard random access block
2225 device, but underneath, the drive reads and writes the bulk of its capacity
2227 Sequential writes will yield better performance, but writing sequentially
2230 Host Aware drives expose the underlying zone layout via
2234 commands and allow the host to manage the zone conditions.
2235 The host is not required to manage the zones on the drive, though.
2236 Sequential writes will yield better performance in Sequential Write
2237 Preferred zones, but the host can write randomly in those zones.
2239 Host Managed drives expose the underlying zone layout via
2244 The host is required to access the zones according to the rules described
2246 Any commands that violate the rules will be returned with an error.
2249 SMR drives are divided into zones (typically in the range of 256MB each)
2250 that fall into three general categories:
2253 These are also known as Non Write Pointer zones.
2254 These zones can be randomly written without an unexpected performance penalty.
2255 .It Sequential Preferred
2256 These zones should be written sequentially starting at the write pointer
2258 They may be written randomly.
2259 Writes that do not conform to the zone layout may be significantly slower
2261 .It Sequential Required
2262 These zones must be written sequentially.
2263 If they are not written sequentially, starting at the write pointer, the
2269 Specify the zone subcommand:
2272 Issue the Report Zones command.
2273 All zones are returned by default.
2274 Specify report options with
2276 and printing options with
2278 Specify the starting LBA with
2282 is also accepted as a command argument.
2284 Explicitly open the zone specified by the starting LBA.
2286 Close the zone specified by starting LBA.
2288 Finish the zone specified by the starting LBA.
2290 Reset the write pointer for the zone specified by the starting LBA.
2293 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2294 operation to all zones on the drive.
2296 Specify the starting LBA.
2297 For the Report Zones command, this tells the drive to report starting with
2298 the zone that starts at the given LBA.
2299 For the other commands, this allows the user to identify the zone requested
2300 by its starting LBA.
2301 The LBA may be specified in decimal, hexadecimal or octal notation.
2303 For the Report Zones command, specify a subset of zones to report.
2307 This is the default.
2309 Report only empty zones.
2311 Report zones that are implicitly open.
2312 This means that the host has sent a write to the zone without explicitly
2315 Report zones that are explicitly open.
2317 Report zones that have been closed by the host.
2319 Report zones that are full.
2321 Report zones that are in the read only state.
2324 is also accepted as an argument.
2326 Report zones that are in the offline state.
2328 Report zones where the device recommends resetting write pointers.
2330 Report zones that have the Non Sequential Resources Active flag set.
2331 These are zones that are Sequential Write Preferred, but have been written
2334 Report Non Write Pointer zones, also known as Conventional zones.
2336 .It Fl P Ar print_opt
2337 Specify a printing option for Report Zones:
2340 Normal Report Zones output.
2341 This is the default.
2342 The summary and column headings are printed, fields are separated by spaces
2343 and the fields themselves may contain spaces.
2345 Just print the summary: the number of zones, the maximum LBA (LBA of the
2346 last logical block on the drive), and the value of the
2351 field describes whether the zones on the drive are all identical, all
2352 different, or whether they are the same except for the last zone, etc.
2354 Print the zones in a script friendly format.
2355 The summary and column headings are omitted, the fields are separated by
2356 commas, and the fields do not contain spaces.
2357 The fields contain underscores where spaces would normally be used.
2363 Extended Power Conditions (EPC) feature set commands.
2366 protocol drives, and will not work on
2375 translation layer (SAT).
2376 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2377 the Extended Power Conditions feature set, available at t13.org, to
2378 understand the details of this particular
2383 Specify the epc subcommand
2386 Restore drive power condition settings.
2389 Specify the source for the restored power settings, either
2393 This argument is required.
2396 This only makes sense to specify when restoring from defaults.
2399 Go to the specified power condition.
2402 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2403 This argument is required.
2405 Specify delayed entry to the power condition.
2406 The drive, if it supports this, can enter the power condition after the
2409 Hold the power condition.
2410 If the drive supports this option, it will hold the power condition and
2411 reject all commands that would normally cause it to exit that power
2415 Set the timer value for a power condition and enable or disable the
2419 display described below to see what the current timer settings are for each
2420 Idle and Standby mode supported by the drive.
2423 Enable the power condition.
2430 Disable the power condition.
2437 Specify the timer in seconds.
2438 The user may specify a timer as a floating point number with a maximum
2439 supported resolution of tenths of a second.
2440 Drives may or may not support sub-second timer values.
2442 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2443 This argument is required.
2445 Save the timer and power condition enable/disable state.
2446 By default, if this option is not specified, only the current values for
2447 this power condition will be affected.
2450 Enable or disable a particular power condition.
2453 Enable the power condition.
2460 Disable the power condition.
2467 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2468 This argument is required.
2470 Save the power condition enable/disable state.
2471 By default, if this option is not specified, only the current values for
2472 this power condition will be affected.
2475 Enable the Extended Power Condition (EPC) feature set.
2477 Disable the Extended Power Condition (EPC) feature set.
2479 Specify the EPC power source.
2482 Specify the power source, either
2488 Get the current status of several parameters related to the Extended Power
2489 Condition (EPC) feature set, including whether APM and EPC are supported
2490 and enabled, whether Low Power Standby is supported, whether setting the
2491 EPC power source is supported, whether Low Power Standby is supported and
2492 the current power condition.
2495 Only report the current power condition.
2496 Some drives will exit their current power condition if a command other than
2499 CHECK POWER MODE command is received.
2500 If this flag is specified,
2504 CHECK POWER MODE command to the drive.
2509 Power Conditions log (Log Address 0x08).
2510 This shows the list of Idle and Standby power conditions the drive
2511 supports, and a number of parameters about each condition, including
2512 whether it is enabled and what the timer value is.
2516 Issue REPORT TIMESTAMP or SET TIMESTAMP
2518 commands. Either the
2522 option must be specified.
2525 Report the device's timestamp.
2526 If no more arguments are specified, the timestamp will be reported using
2527 the national representation of the date and time, followed by the time
2531 Specify the strftime format string, as documented in strftime(3), to be used
2532 to format the reported timestamp.
2534 Report the timestamp as milliseconds since the epoch.
2536 Report the timestamp using the national representation of the date and
2537 time, but override the system time zone and use UTC instead.
2542 Set the device's timestamp. Either the
2548 option must be specified.
2551 Specify the strptime format string, as documented in strptime(3).
2552 The time must also be specified with the
2556 Provide the time in the format specified with the
2560 Set the timestamp to the host system's time in UTC.
2564 Print out the device type for specified device.
2567 An ATA device attached directly to an ATA controller
2569 An SATA device attached behind a SAS controller via SCSI-ATA Translation Layer (SATL)
2573 An directly attached NVMe device
2575 An MMC or SD device attached via a mmcsd bus
2577 No device type reported
2579 Device type is unknown
2581 A programming error occurred
2584 Print out verbose usage information.
2589 variable allows the user to specify an alternate mode page format file.
2593 variable determines which text editor
2595 starts when editing mode pages.
2597 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2598 .It Pa /usr/share/misc/scsi_modes
2599 is the SCSI mode format database.
2601 is the transport layer device.
2603 are the CAM application passthrough devices.
2606 .Dl camcontrol eject -n cd -u 1 -v
2608 Eject the CD from cd1, and print SCSI sense information if the command
2611 .Dl camcontrol tur da0
2613 Send the SCSI test unit ready command to da0.
2616 utility will report whether the disk is ready, but will not display sense
2617 information if the command fails since the
2619 switch was not specified.
2620 .Bd -literal -offset indent
2621 camcontrol tur da1 -E -C 4 -t 50 -Q head -v
2624 Send a test unit ready command to da1.
2625 Enable kernel error recovery.
2626 Specify a retry count of 4, and a timeout of 50 seconds.
2630 flag) if the command fails.
2631 Since error recovery is turned on, the
2632 disk will be spun up if it is not currently spinning.
2635 task attribute for the command will be set to Head of Queue.
2638 utility will report whether the disk is ready.
2639 .Bd -literal -offset indent
2640 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2641 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2644 Issue a READ BUFFER command (0x3C) to cd1.
2645 Display the buffer size of cd1,
2646 and display the first 10 bytes from the cache on cd1.
2648 information if the command fails.
2649 .Bd -literal -offset indent
2650 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2651 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2654 Issue a WRITE BUFFER (0x3B) command to cd1.
2655 Write out 10 bytes of data,
2656 not including the (reserved) 4 byte header.
2657 Print out sense information if
2659 Be very careful with this command, improper use may
2660 cause data corruption.
2661 .Bd -literal -offset indent
2662 camcontrol modepage da3 -m 1 -e -P 3
2665 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2666 settings on the drive.
2667 Mode page 1 contains a disk drive's auto read and
2668 write reallocation settings, among other things.
2670 .Dl camcontrol rescan all
2672 Rescan all SCSI buses in the system for devices that have been added,
2675 .Dl camcontrol rescan 0
2677 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2679 .Dl camcontrol rescan 0:1:0
2681 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2684 .Dl camcontrol tags da5 -N 24
2686 Set the number of concurrent transactions for da5 to 24.
2687 .Bd -literal -offset indent
2688 camcontrol negotiate -n da -u 4 -T disable
2691 Disable tagged queueing for da4.
2692 .Bd -literal -offset indent
2693 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2696 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2698 Test Unit Ready command to make the settings take effect.
2699 .Bd -literal -offset indent
2700 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2703 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2705 Display SMP errors if the command fails.
2706 .Bd -literal -offset indent
2707 camcontrol security ada0
2710 Report security support and settings for ada0
2711 .Bd -literal -offset indent
2712 camcontrol security ada0 -U user -s MyPass
2715 Enable security on device ada0 with the password MyPass
2716 .Bd -literal -offset indent
2717 camcontrol security ada0 -U user -e MyPass
2720 Secure erase ada0 which has had security enabled with user password MyPass
2722 .Em WARNING! WARNING! WARNING!
2726 data from the device, so backup your data before using!
2728 This command can be used against an SSD drive to restoring it to
2729 factory default write performance.
2730 .Bd -literal -offset indent
2734 Report HPA support and settings for ada0 (also reported via
2736 .Bd -literal -offset indent
2737 camcontrol hpa ada0 -s 10240
2740 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2742 .Em WARNING! WARNING! WARNING!
2746 to all data on the device beyond this limit until HPA is disabled by setting
2747 HPA to native max sectors of the device, which can only be done after a
2748 power-on or hardware reset!
2751 use this on a device which has an active filesystem!
2752 .Bd -literal -offset indent
2753 camcontrol persist da0 -v -i read_keys
2756 This will read any persistent reservation keys registered with da0, and
2757 display any errors encountered when sending the PERSISTENT RESERVE IN
2760 .Bd -literal -offset indent
2761 camcontrol persist da0 -v -o register -a -K 0x12345678
2764 This will register the persistent reservation key 0x12345678 with da0,
2765 apply that registration to all ports on da0, and display any errors that
2766 occur when sending the PERSISTENT RESERVE OUT command.
2767 .Bd -literal -offset indent
2768 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2771 This will reserve da0 for the exlusive use of the initiator issuing the
2773 The scope of the reservation is the entire LUN.
2774 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2775 .Bd -literal -offset indent
2776 camcontrol persist da0 -v -i read_full
2779 This will display the full status of all reservations on da0 and print out
2780 status if there are any errors.
2781 .Bd -literal -offset indent
2782 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2785 This will release a reservation on da0 of the type ex_ac
2787 The Reservation Key for this registration is 0x12345678.
2788 Any errors that occur will be displayed.
2789 .Bd -literal -offset indent
2790 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2791 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2794 This will register the key 0x12345678 with da0, specifying that it applies
2795 to the SAS initiators with SAS addresses 0x1234567812345678 and
2797 .Bd -literal -offset indent
2798 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2799 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2802 This will move the registration from the current initiator, whose
2803 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2804 Fiber Channel World Wide Node Name 0x1234567812345678.
2805 A new registration key, 0x12345678, will be registered for the initiator
2806 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2807 current initiator will be unregistered from the target.
2808 The reservation will be moved to relative target port 2 on the target
2810 The registration will persist across power losses.
2811 .Bd -literal -offset indent
2812 camcontrol attrib sa0 -v -i attr_values -p 1
2815 This will read and decode the attribute values from partition 1 on the tape
2816 in tape drive sa0, and will display any
2820 .Bd -literal -offset indent
2821 camcontrol zone da0 -v -c rz -P summary
2824 This will request the SMR zone list from disk da0, and print out a
2825 summary of the zone parameters, and display any
2831 .Bd -literal -offset indent
2832 camcontrol zone da0 -v -c rz -o reset
2835 This will request the list of SMR zones that should have their write
2836 pointer reset from the disk da0, and display any
2842 .Bd -literal -offset indent
2843 camcontrol zone da0 -v -c rwp -l 0x2c80000
2846 This will issue the Reset Write Pointer command to disk da0 for the zone
2847 that starts at LBA 0x2c80000 and display any
2853 .Bd -literal -offset indent
2854 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2857 Set the timer for the Idle_a power condition on drive
2859 to 60.1 seconds, enable that particular power condition, and save the timer
2860 value and the enabled state of the power condition.
2862 .Bd -literal -offset indent
2863 camcontrol epc da4 -c goto -p Standby_z -H
2868 to go to the Standby_z power state (which is
2869 the drive's lowest power state) and hold in that state until it is
2870 explicitly released by another
2874 .Bd -literal -offset indent
2875 camcontrol epc da2 -c status -P
2878 Report only the power state of
2881 Some drives will power up in response to the commands sent by the
2889 CHECK POWER MODE command, which should not trigger a change in the drive's
2892 .Bd -literal -offset indent
2893 camcontrol epc ada0 -c list
2896 Display the ATA Power Conditions log (Log Address 0x08) for
2900 .Bd -literal -offset indent
2901 camcontrol timestamp sa0 -s -f "%a, %d %b %Y %T %z" \e
2902 -T "Wed, 26 Oct 2016 21:43:57 -0600"
2905 Set the timestamp of drive
2909 format string followed by a time string
2910 that was created using this format string.
2913 .Xr cam_cdbparse 3 ,
2920 utility first appeared in
2923 The mode page editing code and arbitrary SCSI command code are based upon
2928 library, written by Julian Elischer and Peter Dufault.
2931 program first appeared in
2933 and first appeared in
2938 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2940 The code that parses the generic command line arguments does not know that
2941 some of the subcommands take multiple arguments.
2942 So if, for instance, you
2943 tried something like this:
2944 .Bd -literal -offset indent
2945 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2948 The sense information from the test unit ready command would not get
2949 printed out, since the first
2953 bails out when it sees the second argument to
2957 Fixing this behavior would take some gross code, or changes to the
2960 The best way to circumvent this problem is to always make sure
2963 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob