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|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
272 .Op Fl l Ar high|maximum
276 .Op Fl U Ar user|master
287 .Op Fl s Ar max_sectors
294 .Aq Fl i Ar action | Fl o Ar action
300 .Op Fl R Ar rel_tgt_port
309 .Aq Fl r Ar action | Fl w Ar attrib
312 .Op Fl e Ar elem_addr
313 .Op Fl F Ar form1,form2
315 .Op Fl s Ar start_addr
316 .Op Fl T Ar elem_type
323 .Op Fl s Ar service_action
332 .Op Fl P Ar print_opts
340 .Op Fl p Ar power_cond
342 .Op Fl r Ar restore_src
344 .Op Fl S Ar power_src
350 .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
356 utility is designed to provide a way for users to access and control the
363 can cause a loss of data and/or system crashes if used improperly.
365 expert users are encouraged to exercise caution when using this command.
366 Novice users should stay away from this utility.
370 utility has a number of primary functions, many of which support an optional
372 A device identifier can take one of three forms:
375 Specify a device name and unit number combination, like "da5" or "cd3".
377 Specify a bus number and target id.
378 The bus number can be determined from
380 .Dq camcontrol devlist .
381 The lun defaults to 0.
383 Specify the bus, target and lun for a device.
387 The device identifier, if it is specified,
389 come immediately after the function name, and before any generic or
390 function-specific arguments.
395 arguments described below will override any device name or unit number
396 specified beforehand.
403 override a specified bus:target or bus:target:lun, however.
407 primary functions support these generic arguments:
410 SCSI command retry count.
411 In order for this to work, error recovery
415 Instruct the kernel to perform generic SCSI error recovery for the given
417 This is needed in order for the retry count
420 Other than retrying commands, the generic error recovery in
421 the code will generally attempt to spin up drives that are not spinning.
422 It may take some other actions, depending upon the sense code returned from
425 Specify the device type to operate on, e.g.\& "da", "cd".
426 .It Fl Q Ar task_attr
428 task attribute for the command, if it is a
431 This may be ordered, simple, head, or aca.
432 In most cases this is not needed.
433 The default is simple, which works with all
436 The task attribute may also be specified numerically.
438 SCSI command timeout in seconds.
439 This overrides the default timeout for
441 .It Fl u Ar unit_number
442 Specify the device unit number, e.g.\& "1", "5".
444 Be verbose, print out sense information for failed SCSI commands.
447 Primary command functions:
448 .Bl -tag -width periphlist
450 List all physical devices (logical units) attached to the CAM subsystem.
451 This also includes a list of peripheral drivers attached to each device.
454 argument, SCSI bus number, adapter name and unit numbers are printed as
456 On the other hand, with the
458 argument, only the bus adapter, and unit information will be printed, and
459 device information will be omitted.
461 List all peripheral drivers attached to a given physical device (logical
464 Send the SCSI test unit ready (0x00) command to the given device.
467 utility will report whether the device is ready or not.
469 Send a SCSI inquiry command (0x12) to a device.
472 will print out the standard inquiry data, device serial number, and
473 transfer rate information.
474 The user can specify that only certain types of
475 inquiry data be printed:
478 Get the standard inquiry data.
480 Print out the serial number.
481 If this flag is the only one specified,
483 will not print out "Serial Number" before the value returned by the drive.
484 This is to aid in script writing.
486 Print out transfer rate information.
489 Send a ATA identify command (0xec) to a device.
491 Send the SCSI REPORT LUNS (0xA0) command to the given device.
494 will print out the list of logical units (LUNs) supported by the target device.
495 There are a couple of options to modify the output:
498 Just print out a count of LUNs, not the actual LUN numbers.
500 Just print out the LUNs, and do not print out the count.
501 .It Fl r Ar reporttype
502 Specify the type of report to request from the target:
503 .Bl -tag -width 012345678
505 Return the default report.
509 Most targets will support this report if they support the REPORT LUNS
512 Return only well known LUNs.
514 Return all available LUNs.
519 will try to print out LUN numbers in a reasonable format.
520 It can understand the peripheral, flat, LUN and extended LUN formats.
522 Send the SCSI READ CAPACITY command to the given device and display
524 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
525 action will be sent to obtain the full size of the device.
528 will print out the last logical block of the device, and the blocksize of
530 To modify the output format, use the following options:
533 Just print out the blocksize, not the last block or device size.
534 This cannot be used with
539 Print out the device size in human readable (base 2, 1K == 1024) format.
542 and cannot be used with
547 Print out the device size in human readable (base 10, 1K == 1000) format.
549 Skip sending the SCSI READ CAPACITY (10) command.
550 Send only the SCSI READ CAPACITY (16) service action and report
552 When the two do not match, a quirk is needed to resolve the ambiguity.
554 Print out the number of blocks in the device instead of the last logical
557 Quiet, print out the numbers only (separated by a comma if
563 Print out the last logical block or the size of the device only, and omit
567 Note that this command only displays the information, it does not update
568 the kernel data structures.
571 reprobe subcommand to do that.
573 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
576 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
579 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
580 start bit set and the load/eject bit set.
582 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
583 start bit cleared and the load/eject bit set.
585 Tell the kernel to scan all buses in the system (with the
587 argument), the given bus (XPT_SCAN_BUS), bus:target:lun or device
588 (XPT_SCAN_LUN) for new devices or devices that have gone away.
590 may specify a scan of all buses, a single bus, or a lun.
592 on a target is not supported.
594 If a device is specified by peripheral name and unit number, for instance
595 da4, it may only be rescanned if that device currently exists in the CAM EDT
596 (Existing Device Table).
597 If the device is no longer there (see
600 you must use the bus:target:lun form to rescan it.
602 Tell the kernel to refresh the information about the device and
603 notify the upper layer,
605 This includes sending the SCSI READ CAPACITY command and updating
606 the disk size visible to the rest of the system.
608 Tell the kernel to reset all buses in the system (with the
610 argument), the given bus (XPT_RESET_BUS) by issuing a SCSI bus
611 reset for that bus, or to reset the given bus:target:lun or device
612 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
613 connecting to that device.
614 Note that this can have a destructive impact
619 READ DEFECT DATA (10) command (0x37) or the
621 READ DEFECT DATA (12) command (0xB7) to the given device, and
622 print out any combination of: the total number of defects, the primary
623 defect list (PLIST), and the grown defect list (GLIST).
626 Specify the requested format of the defect list.
627 The format argument is
629 Most drives support the physical sector format.
631 support the logical block format.
632 Many drives, if they do not support the
633 requested format, return the data in an alternate format, along with sense
634 information indicating that the requested data format is not supported.
638 attempts to detect this, and print out whatever format the drive returns.
639 If the drive uses a non-standard sense code to report that it does not
640 support the requested format,
642 will probably see the error as a failure to complete the request.
644 The format options are:
647 Print out the list as logical blocks.
648 This is limited to 32-bit block sizes, and isn't supported by many modern
651 Print out the list as logical blocks.
652 This option uses a 64-bit block size.
654 Print out the list in bytes from index format.
656 Print out the list in extended bytes from index format.
657 The extended format allows for ranges of blocks to be printed.
659 Print out the list in physical sector format.
660 Most drives support this format.
662 Print out the list in extended physical sector format.
663 The extended format allows for ranges of blocks to be printed.
666 Print out the grown defect list.
667 This is a list of bad blocks that have
668 been remapped since the disk left the factory.
670 Print out the primary defect list.
671 This is the list of defects that were present in the factory.
673 When printing status information with
675 only print the number of defects.
677 Just print the number of defects, not the list of defects.
679 Specify the starting offset into the defect list.
680 This implies using the
682 READ DEFECT DATA (12) command, as the 10 byte version of the command
683 doesn't support the address descriptor index field.
684 Not all drives support the 12 byte command, and some drives that support
685 the 12 byte command don't support the address descriptor index field.
687 Print out defects in hexadecimal (base 16) form instead of base 10 form.
696 will print out the number of defects given in the READ DEFECT DATA header
697 returned from the drive.
698 Some drives will report 0 defects if neither the primary or grown defect
701 Allows the user to display and optionally edit a SCSI mode page.
703 page formats are located in
704 .Pa /usr/share/misc/scsi_modes .
705 This can be overridden by specifying a different file in the
707 environment variable.
710 command takes several arguments:
713 Disable block descriptors for mode sense.
715 Displays mode page data in binary format.
717 This flag allows the user to edit values in the mode page.
719 either edit mode page values with the text editor pointed to by his
721 environment variable, or supply mode page values via standard input, using
724 uses to display mode page values.
725 The editor will be invoked if
727 detects that standard input is terminal.
729 Lists all available mode pages.
730 If specified more then once, also lists subpages.
731 .It Fl m Ar page[,subpage]
732 This specifies the number of the mode page and optionally subpage the user
733 would like to view and/or edit.
734 This argument is mandatory unless
738 This allows the user to specify the page control field.
740 .Bl -tag -width xxx -compact
752 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
755 function requires the
757 argument to specify SCSI CDB or the
759 argument to specify ATA Command Block registers values.
760 Other arguments are optional, depending on
762 The command and data specification syntax is documented
765 NOTE: If the CDB specified causes data to be transferred to or from the
766 SCSI device in question, you MUST specify either
771 .It Fl a Ar cmd Op args
772 This specifies the content of 12 ATA Command Block registers (command,
773 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
774 lba_high_exp, features_exp, sector_count, sector_count_exp).
775 .It Fl c Ar cmd Op args
776 This specifies the SCSI CDB.
777 SCSI CDBs may be 6, 10, 12 or 16 bytes.
779 Specifies DMA protocol to be used for ATA command.
781 Specifies FPDMA (NCQ) protocol to be used for ATA command.
782 .It Fl i Ar len Ar fmt
783 This specifies the amount of data to read, and how it should be displayed.
787 bytes of data will be read from the device and written to standard output.
788 .It Fl o Ar len Ar fmt Op args
789 This specifies the amount of data to be written to a device, and the data
790 that is to be written.
794 bytes of data will be read from standard input and written to the device.
796 This specifies that 11 result ATA Command Block registers should be displayed
797 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
798 lba_high_exp, sector_count, sector_count_exp), and how.
801 11 result registers will be written to standard output in hex.
804 Allows the user to send an arbitrary Serial
805 Management Protocol (SMP) command to a device.
808 function requires the
810 argument to specify the SMP request to be sent, and the
812 argument to specify the format of the SMP response.
813 The syntax for the SMP request and response arguments is documented in
816 Note that SAS adapters that support SMP passthrough (at least the currently
817 known adapters) do not accept CRC bytes from the user in the request and do
818 not pass CRC bytes back to the user in the response.
819 Therefore users should not include the CRC bytes in the length of the
820 request and not expect CRC bytes to be returned in the response.
822 .It Fl r Ar len Ar fmt Op args
823 This specifies the size of the SMP request, without the CRC bytes, and the
828 bytes of data will be read from standard input and written as the SMP
830 .It Fl R Ar len Ar fmt Op args
831 This specifies the size of the buffer allocated for the SMP response, and
832 the SMP response format.
836 bytes of data will be allocated for the response and the response will be
837 written to standard output.
840 Allows the user to send the Serial Management Protocol (SMP) Report General
843 will display the data returned by the Report General command.
844 If the SMP target supports the long response format, the additional data
845 will be requested and displayed automatically.
848 Request the long response format only.
849 Not all SMP targets support the long response format.
852 to skip sending the initial report general request without the long bit set
853 and only issue a report general request with the long bit set.
856 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
858 This function should be used with some caution, as it can render devices
859 inaccessible, and could potentially cause data corruption as well.
862 argument is required to specify the PHY to operate on.
865 Specify the PHY to operate on.
866 This argument is required.
868 Request the long request/response format.
869 Not all SMP targets support the long response format.
870 For the PHY Control command, this currently only affects whether the
871 request length is set to a value other than 0.
872 .It Fl o Ar operation
873 Specify a PHY control operation.
876 operation may be specified.
877 The operation may be specified numerically (in decimal, hexadecimal, or octal)
878 or one of the following operation names may be specified:
882 It is not necessary to specify this argument.
884 Send the LINK RESET command to the phy.
886 Send the HARD RESET command to the phy.
888 Send the DISABLE command to the phy.
889 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
891 Send the CLEAR ERROR LOG command.
892 This clears the error log counters for the specified phy.
894 Send the CLEAR AFFILIATION command.
895 This clears the affiliation from the STP initiator port with the same SAS
896 address as the SMP initiator that requests the clear operation.
898 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
899 This will cause a SATA port selector to use the given phy as its active phy
900 and make the other phy inactive.
902 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
904 Send the SET ATTACHED DEVICE NAME command to the PHY.
907 argument to specify the device name.
910 Specify the attached device name.
911 This option is needed with the
914 The name is a 64-bit number, and can be specified in decimal, hexadecimal
917 Set the minimum physical link rate for the phy.
918 This is a numeric argument.
919 Currently known link rates are:
922 Do not change current value.
931 Other values may be specified for newer physical link rates.
933 Set the maximum physical link rate for the phy.
934 This is a numeric argument.
937 argument description for known link rate arguments.
938 .It Fl T Ar pp_timeout
939 Set the partial pathway timeout value, in microseconds.
944 specification for more information on this field.
945 .It Fl a Ar enable|disable
946 Enable or disable SATA slumber phy power conditions.
947 .It Fl A Ar enable|disable
948 Enable or disable SATA partial power conditions.
949 .It Fl s Ar enable|disable
950 Enable or disable SAS slumber phy power conditions.
951 .It Fl S Ar enable|disable
952 Enable or disable SAS partial phy power conditions.
955 List phys attached to a SAS expander, the address of the end device
956 attached to the phy, and the inquiry data for that device and peripheral
957 devices attached to that device.
958 The inquiry data and peripheral devices are displayed if available.
961 Turn on the long response format for the underlying SMP commands used for
964 Only print out phys that are attached to a device in the CAM EDT (Existing
968 Send the SMP Report Manufacturer Information command to the device and
969 display the response.
972 Turn on the long response format for the underlying SMP commands used for
976 Turn on CAM debugging printfs in the kernel.
977 This requires options CAMDEBUG
978 in your kernel config file.
979 WARNING: enabling debugging printfs currently
980 causes an EXTREME number of kernel printfs.
981 You may have difficulty
982 turning off the debugging printfs once they start, since the kernel will be
983 busy printing messages and unable to service other requests quickly.
986 function takes a number of arguments:
989 Enable CAM_DEBUG_INFO printfs.
991 Enable CAM_DEBUG_PERIPH printfs.
993 Enable CAM_DEBUG_TRACE printfs.
995 Enable CAM_DEBUG_SUBTRACE printfs.
997 Enable CAM_DEBUG_XPT printfs.
999 Enable CAM_DEBUG_CDB printfs.
1000 This will cause the kernel to print out the
1001 SCSI CDBs sent to the specified device(s).
1003 Enable CAM_DEBUG_PROBE printfs.
1005 Enable debugging for all devices.
1007 Turn off debugging for all devices
1008 .It bus Ns Op :target Ns Op :lun
1009 Turn on debugging for the given bus, target or lun.
1010 If the lun or target
1011 and lun are not specified, they are wildcarded.
1012 (i.e., just specifying a
1013 bus turns on debugging printfs for all devices on that bus.)
1016 Show or set the number of "tagged openings" or simultaneous transactions
1017 we attempt to queue to a particular device.
1020 command, with no command-specific arguments (i.e., only generic arguments)
1021 prints out the "soft" maximum number of transactions that can be queued to
1022 the device in question.
1023 For more detailed information, use the
1025 argument described below.
1028 Set the number of tags for the given device.
1029 This must be between the
1030 minimum and maximum number set in the kernel quirk table.
1032 most devices that support tagged queueing is a minimum of 2 and a maximum
1034 The minimum and maximum values for a given device may be
1035 determined by using the
1042 subcommand is described below.
1044 Be quiet, and do not report the number of tags.
1045 This is generally used when
1046 setting the number of tags.
1048 The verbose flag has special functionality for the
1053 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1056 This is the amount of capacity for transactions queued to a given device.
1058 This is the number of transactions currently queued to a device.
1060 This is the kernel queue space for transactions.
1061 This count usually mirrors
1062 dev_openings except during error recovery operations when
1063 the device queue is frozen (device is not allowed to receive
1064 commands), the number of dev_openings is reduced, or transaction
1065 replay is occurring.
1067 This is the number of transactions waiting in the kernel queue for capacity
1069 This number is usually zero unless error recovery is in
1072 The held count is the number of CCBs held by peripheral drivers that have
1073 either just been completed or are about to be released to the transport
1074 layer for service by a device.
1075 Held CCBs reserve capacity on a given
1078 This is the current "hard" minimum number of transactions that can be
1079 queued to a device at once.
1082 value above cannot go below this number.
1083 The default value for
1085 is 2, although it may be set higher or lower for various devices.
1087 This is the "hard" maximum number of transactions that can be queued to a
1091 value cannot go above this number.
1092 The default value for
1094 is 255, although it may be set higher or lower for various devices.
1098 Show or negotiate various communication parameters.
1099 Some controllers may
1100 not support setting or changing some of these values.
1102 Adaptec 174x controllers do not support changing a device's sync rate or
1107 will not attempt to set the parameter if the controller indicates that it
1108 does not support setting the parameter.
1109 To find out what the controller
1117 command is described below.
1118 Also, some controller drivers do not support
1119 setting negotiation parameters, even if the underlying controller supports
1120 negotiation changes.
1121 Some controllers, such as the Advansys wide
1122 controllers, support enabling and disabling synchronous negotiation for
1123 a device, but do not support setting the synchronous negotiation rate.
1126 Attempt to make the negotiation settings take effect immediately by sending
1127 a Test Unit Ready command to the device.
1129 Show or set current negotiation settings.
1130 This is the default.
1131 .It Fl D Ar enable|disable
1132 Enable or disable disconnection.
1136 Set the command delay offset.
1138 Be quiet, do not print anything.
1139 This is generally useful when you want to
1140 set a parameter, but do not want any status information.
1141 .It Fl R Ar syncrate
1142 Change the synchronization rate for a device.
1143 The sync rate is a floating
1144 point value specified in MHz.
1147 is a legal value, as is
1149 .It Fl T Ar enable|disable
1150 Enable or disable tagged queueing for a device.
1152 Show or set user negotiation settings.
1153 The default is to show or set
1154 current negotiation settings.
1156 The verbose switch has special meaning for the
1161 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1163 .It Fl W Ar bus_width
1164 Specify the bus width to negotiate with a device.
1167 The only useful values to specify are 8, 16, and 32
1169 The controller must support the bus width in question in order for
1170 the setting to take effect.
1173 In general, sync rate and offset settings will not take effect for a
1174 device until a command has been sent to the device.
1177 switch above will automatically send a Test Unit Ready to the device so
1178 negotiation parameters will take effect.
1182 FORMAT UNIT command to the named device.
1184 .Em WARNING! WARNING! WARNING!
1186 Low level formatting a disk will destroy ALL data on the disk.
1188 extreme caution when issuing this command.
1189 Many users low-level format
1190 disks that do not really need to be low-level formatted.
1192 relatively few scenarios that call for low-level formatting a disk.
1194 low-level formatting a disk is to initialize the disk after changing
1195 its physical sector size.
1196 Another reason for low-level formatting a disk
1197 is to revive the disk if you are getting "medium format corrupted" errors
1198 from the disk in response to read and write requests.
1200 Some disks take longer than others to format.
1201 Users should specify a
1202 timeout long enough to allow the format to complete.
1204 timeout is 3 hours, which should be long enough for most disks.
1206 disks will complete a format operation in a very short period of time
1207 (on the order of 5 minutes or less).
1208 This is often because the drive
1209 does not really support the FORMAT UNIT command -- it just accepts the
1210 command, waits a few minutes and then returns it.
1214 subcommand takes several arguments that modify its default behavior.
1219 arguments can be useful for scripts.
1222 Be quiet, do not print any status messages.
1223 This option will not disable
1224 the questions, however.
1225 To disable questions, use the
1232 This will report status on a format that is already running on the drive.
1234 Issue a non-immediate format command.
1237 issues the FORMAT UNIT command with the immediate bit set.
1239 device to immediately return the format command, before the format has
1245 sense information from the device every second to determine how far along
1246 in the format process it is.
1249 argument is specified,
1251 will issue a non-immediate format command, and will be unable to print any
1252 information to let the user know what percentage of the disk has been
1255 Do not ask any questions.
1258 will ask the user if he/she really wants to format the disk in question,
1259 and also if the default format command timeout is acceptable.
1261 will not be asked about the timeout if a timeout is specified on the
1267 SANITIZE command to the named device.
1269 .Em WARNING! WARNING! WARNING!
1271 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1272 Recovery of the data is not possible.
1273 Use extreme caution when issuing this command.
1277 subcommand takes several arguments that modify its default behavior.
1282 arguments can be useful for scripts.
1284 .It Fl a Ar operation
1285 Specify the sanitize operation to perform.
1288 Perform an overwrite operation by writing a user supplied
1289 data pattern to the device one or more times.
1290 The pattern is given by the
1293 The number of times is given by the
1297 Perform a block erase operation.
1298 All the device's blocks are set to a vendor defined
1299 value, typically zero.
1301 Perform a cryptographic erase operation.
1302 The encryption keys are changed to prevent the decryption
1305 Exits a previously failed sanitize operation.
1306 A failed sanitize operation can only be exited if it was
1307 run in the unrestricted completion mode, as provided by the
1312 The number of passes when performing an
1315 Valid values are between 1 and 31.
1320 operation, the pattern is inverted between consecutive passes.
1322 Path to the file containing the pattern to use when
1326 The pattern is repeated as needed to fill each block.
1328 Be quiet, do not print any status messages.
1329 This option will not disable
1330 the questions, however.
1331 To disable questions, use the
1335 Perform the sanitize in the unrestricted completion mode.
1336 If the operation fails, it can later be exited with the
1343 This will report status on a sanitize that is already running on the drive.
1345 Issue a non-immediate sanitize command.
1348 issues the SANITIZE command with the immediate bit set.
1350 device to immediately return the sanitize command, before
1351 the sanitize has actually completed.
1356 sense information from the device every second to determine how far along
1357 in the sanitize process it is.
1360 argument is specified,
1362 will issue a non-immediate sanitize command, and will be unable to print any
1363 information to let the user know what percentage of the disk has been
1366 Do not ask any questions.
1369 will ask the user if he/she really wants to sanitize the disk in question,
1370 and also if the default sanitize command timeout is acceptable.
1372 will not be asked about the timeout if a timeout is specified on the
1376 Put ATA device into IDLE state.
1379 specifies automatic standby timer value in seconds.
1380 Value 0 disables timer.
1382 Put ATA device into STANDBY state.
1385 specifies automatic standby timer value in seconds.
1386 Value 0 disables timer.
1388 Put ATA device into SLEEP state.
1389 Note that the only way get device out of
1390 this state may be reset.
1392 It optional parameter
1394 specified, enables and sets advanced power management level, where
1395 1 -- minimum power, 127 -- maximum performance with standby,
1396 128 -- minimum power without standby, 254 -- maximum performance.
1397 If not specified -- APM is disabled.
1399 It optional parameter
1401 specified, enables and sets automatic acoustic management level, where
1402 1 -- minimum noise, 254 -- maximum performance.
1403 If not specified -- AAM is disabled.
1405 Update or report security settings, using an ATA identify command (0xec).
1408 will print out the security support and associated settings of the device.
1411 command takes several arguments:
1415 Disable device security using the given password for the selected user according
1416 to the devices configured security level.
1419 Erase the device using the given password for the selected user.
1421 .Em WARNING! WARNING! WARNING!
1423 Issuing a secure erase will
1425 user data on the device and may take several hours to complete.
1427 When this command is used against an SSD drive all its cells will be marked as
1428 empty, restoring it to factory default write performance.
1429 For SSD's this action
1430 usually takes just a few seconds.
1433 Freeze the security configuration of the specified device.
1435 After command completion any other commands that update the device lock mode
1436 shall be command aborted.
1437 Frozen mode is disabled by power-off or hardware reset.
1440 Enhanced erase the device using the given password for the selected user.
1442 .Em WARNING! WARNING! WARNING!
1444 Issuing an enhanced secure erase will
1446 user data on the device and may take several hours to complete.
1448 An enhanced erase writes predetermined data patterns to all user data areas,
1449 all previously written user data shall be overwritten, including sectors that
1450 are no longer in use due to reallocation.
1453 Unlock the device using the given password for the selected user according to
1454 the devices configured security level.
1455 .It Fl l Ar high|maximum
1457 Specifies which security level to set when issuing a
1460 The security level determines device behavior when the master
1461 password is used to unlock the device.
1462 When the security level is set to high
1463 the device requires the unlock command and the master password to unlock.
1464 When the security level is set to maximum the device requires a secure erase
1465 with the master password to unlock.
1467 This option must be used in conjunction with one of the security action commands.
1473 Be quiet, do not print any status messages.
1474 This option will not disable the questions, however.
1475 To disable questions, use the
1480 Password the device (enable security) using the given password for the selected
1482 This option can be combined with other options such as
1485 A master password may be set in a addition to the user password. The purpose of
1486 the master password is to allow an administrator to establish a password that
1487 is kept secret from the user, and which may be used to unlock the device if the
1488 user password is lost.
1491 Setting the master password does not enable device security.
1493 If the master password is set and the drive supports a Master Revision Code
1494 feature the Master Password Revision Code will be decremented.
1497 Overrides the default timeout, specified in seconds, used for both
1501 this is useful if your system has problems processing long timeouts correctly.
1503 Usually the timeout is calculated from the information stored on the drive if
1504 present, otherwise it defaults to 2 hours.
1505 .It Fl U Ar user|master
1507 Specifies which user to set / use for the running action command, valid values
1508 are user or master and defaults to master if not set.
1510 This option must be used in conjunction with one of the security action commands.
1516 Confirm yes to dangerous options such as
1518 without prompting for confirmation.
1521 If the password specified for any action commands does not match the configured
1522 password for the specified user the command will fail.
1524 The password in all cases is limited to 32 characters, longer passwords will
1527 Update or report Host Protected Area details.
1530 will print out the HPA support and associated settings of the device.
1533 command takes several optional arguments:
1537 Freeze the HPA configuration of the specified device.
1539 After command completion any other commands that update the HPA configuration
1540 shall be command aborted.
1541 Frozen mode is disabled by power-off or hardware reset.
1544 Lock the HPA configuration of the device until a successful call to unlock or
1545 the next power-on reset occurs.
1548 Make the HPA max sectors persist across power-on reset or a hardware reset.
1549 This must be used in combination with
1550 .Fl s Ar max_sectors
1554 Set the HPA configuration password required for unlock calls.
1557 Be quiet, do not print any status messages.
1558 This option will not disable the questions.
1559 To disable questions, use the
1562 .It Fl s Ar max_sectors
1564 Configures the maximum user accessible sectors of the device.
1565 This will change the number of sectors the device reports.
1567 .Em WARNING! WARNING! WARNING!
1569 Changing the max sectors of a device using this option will make the data on
1570 the device beyond the specified value inaccessible.
1573 .Fl s Ar max_sectors
1574 call can be made without a power-on reset or a hardware reset of the device.
1577 Unlock the HPA configuration of the specified device using the given password.
1578 If the password specified does not match the password configured via
1580 the command will fail.
1582 After 5 failed unlock calls, due to password miss-match, the device will refuse
1583 additional unlock calls until after a power-on reset.
1586 Confirm yes to dangerous options such as
1588 without prompting for confirmation
1591 The password for all HPA commands is limited to 32 characters, longer passwords
1594 Program firmware of the named
1596 or ATA device using the image file provided.
1600 device and it provides a recommended timeout for the WRITE BUFFER command
1603 opcodes subcommand), that timeout will be used for the firmware download.
1604 The drive-recommended timeout value may be overridden on the command line
1609 Current list of supported vendors for SCSI/SAS drives:
1612 Tested with 4TB SAS drives, model number HUS724040ALS640.
1616 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1617 There is a separate table entry for hard drives, because the update method
1618 for hard drives is different than the method for tape drives.
1623 Tested with SM1625 SSDs.
1625 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1626 ES.3 (ST1000NM0023) drives.
1628 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1631 .Em WARNING! WARNING! WARNING!
1633 Little testing has been done to make sure that different device models from
1634 each vendor work correctly with the fwdownload command.
1635 A vendor name appearing in the supported list means only that firmware of at
1636 least one device type from that vendor has successfully been programmed with
1637 the fwdownload command.
1638 Extra caution should be taken when using this command since there is no
1639 guarantee it will not break a device from the listed vendors.
1640 Ensure that you have a recent backup of the data on the device before
1641 performing a firmware update.
1645 protocol devices will not be programmed, since there is little chance of
1646 the firmware download succeeding.
1649 will currently attempt a firmware download to any
1653 device, since the standard
1655 DOWNLOAD MICROCODE command may work.
1656 Firmware downloads to
1660 devices are supported for devices connected
1665 controllers, and devices connected to SAS controllers
1670 translation capability.
1676 PASS-THROUGH command to send the
1678 DOWNLOAD MICROCODE command to the drive.
1683 translation implementations don't work fully when translating
1685 WRITE BUFFER commands to
1687 DOWNLOAD MICROCODE commands, but do support
1689 passthrough well enough to do a firmware download.
1691 .It Fl f Ar fw_image
1692 Path to the firmware image file to be downloaded to the specified device.
1694 Do not print informational messages, only print errors.
1695 This option should be used with the
1697 option to suppress all output.
1699 Run in simulation mode.
1700 Device checks are run and the confirmation dialog is shown, but no firmware
1701 download will occur.
1707 errors in the event of a failure.
1709 In simulation mode, print out the
1714 register values that would be used for the firmware download command.
1716 Do not ask for confirmation.
1719 Persistent reservation support.
1720 Persistent reservations are a way to reserve a particular
1722 LUN for use by one or more
1727 option is specified,
1731 PERSISTENT RESERVE IN
1732 command using the requested service action.
1735 option is specified,
1739 PERSISTENT RESERVE OUT
1740 command using the requested service action.
1741 One of those two options is required.
1743 Persistent reservations are complex, and fully explaining them is outside
1744 the scope of this manual.
1747 and download the latest SPC spec for a full explanation of persistent
1751 Specify the service action for the PERSISTENT RESERVE IN command.
1752 Supported service actions:
1755 Report the current persistent reservation generation (PRgeneration) and any
1757 .It read_reservation
1758 Report the persistent reservation, if any.
1759 .It report_capabilities
1760 Report the persistent reservation capabilities of the LUN.
1761 .It read_full_status
1762 Report the full status of persistent reservations on the LUN.
1765 Specify the service action for the PERSISTENT RESERVE OUT command.
1766 For service actions like register that are components of other service
1767 action names, the entire name must be specified.
1768 Otherwise, enough of the service action name must be specified to
1769 distinguish it from other possible service actions.
1770 Supported service actions:
1773 Register a reservation key with the LUN or unregister a reservation key.
1774 To register a key, specify the requested key as the Service Action
1776 To unregister a key, specify the previously registered key as the
1778 To change a key, specify the old key as the Reservation Key and the new
1779 key as the Service Action Reservation Key.
1781 This is similar to the register subcommand, except that the Reservation Key
1783 The Service Action Reservation Key will overwrite any previous key
1784 registered for the initiator.
1786 Create a reservation.
1787 A key must be registered with the LUN before the LUN can be reserved, and
1788 it must be specified as the Reservation Key.
1789 The type of reservation must also be specified.
1790 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1792 Release a reservation.
1793 The Reservation Key must be specified.
1795 Release a reservation and remove all keys from the device.
1796 The Reservation Key must be specified.
1798 Remove a reservation belonging to another initiator.
1799 The Reservation Key must be specified.
1800 The Service Action Reservation Key may be specified, depending on the
1801 operation being performed.
1803 Remove a reservation belonging to another initiator and abort all
1804 outstanding commands from that initiator.
1805 The Reservation Key must be specified.
1806 The Service Action Reservation Key may be specified, depending on the
1807 operation being performed.
1809 Register another initiator with the LUN, and establish a reservation on the
1810 LUN for that initiator.
1811 The Reservation Key and Service Action Reservation Key must be specified.
1813 Replace Lost Reservation information.
1816 Set the All Target Ports (ALL_TG_PT) bit.
1817 This requests that the key registration be applied to all target ports and
1818 not just the particular target port that receives the command.
1819 This only applies to the register and register_ignore actions.
1821 Specify a Transport ID.
1822 This only applies to the Register and Register and Move service actions for
1823 Persistent Reserve Out.
1824 Multiple Transport IDs may be specified with multiple
1827 With the Register service action, specifying one or more Transport IDs
1828 implicitly enables the
1830 option which turns on the SPEC_I_PT bit.
1831 Transport IDs generally have the format protocol,id.
1834 A SAS Transport ID consists of
1836 followed by a 64-bit SAS address.
1839 .Dl sas,0x1234567812345678
1841 A Fibre Channel Transport ID consists of
1843 followed by a 64-bit Fibre Channel World Wide Name.
1846 .Dl fcp,0x1234567812345678
1848 A Parallel SCSI address consists of
1850 followed by a SCSI target ID and a relative target port identifier.
1855 An IEEE 1394 (Firewire) Transport ID consists of
1857 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1860 .Dl sbp,0x1234567812345678
1862 A SCSI over RDMA Transport ID consists of
1864 followed by a 128-bit RDMA initiator port identifier.
1865 The port identifier must be exactly 32 or 34 (if the leading 0x is
1866 included) hexadecimal digits.
1867 Only hexadecimal (base 16) numbers are supported.
1870 .Dl srp,0x12345678123456781234567812345678
1872 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1874 For example, if only the iSCSI name is specified:
1876 .Dl iqn.2012-06.com.example:target0
1878 If the iSCSI separator and initiator session ID are specified:
1880 .Dl iqn.2012-06.com.example:target0,i,0x123
1882 A SCSI over PCIe Transport ID consists of
1884 followed by a PCIe Routing ID.
1885 The Routing ID consists of a bus, device and function or in the alternate
1886 form, a bus and function.
1887 The bus must be in the range of 0 to 255 inclusive and the device must be
1888 in the range of 0 to 31 inclusive.
1889 The function must be in the range of 0 to 7 inclusive if the standard form
1890 is used, and in the range of 0 to 255 inclusive if the alternate form is
1892 For example, if a bus, device and function are specified for the standard
1897 If the alternate Routing ID form is used:
1902 Specify the Reservation Key.
1903 This may be in decimal, octal or hexadecimal format.
1904 The value is zero by default if not otherwise specified.
1905 The value must be between 0 and 2^64 - 1, inclusive.
1907 Specify the Service Action Reservation Key.
1908 This may be in decimal, octal or hexadecimal format.
1909 The value is zero by default if not otherwise specified.
1910 The value must be between 0 and 2^64 - 1, inclusive.
1912 Enable the Activate Persist Through Power Loss bit.
1913 This is only used for the register and register_ignore actions.
1914 This requests that the reservation persist across power loss events.
1916 Specify the scope of the reservation.
1917 The scope may be specified by name or by number.
1918 The scope is ignored for register, register_ignore and clear.
1919 If the desired scope isn't available by name, you may specify the number.
1923 This encompasses the entire LUN.
1925 Extent scope (0x01).
1927 Element scope (0x02).
1930 Specify the Relative Target Port.
1931 This only applies to the Register and Move service action of the Persistent
1932 Reserve Out command.
1934 Enable the SPEC_I_PT bit.
1935 This only applies to the Register service action of Persistent Reserve Out.
1936 You must also specify at least one Transport ID with
1938 if this option is set.
1939 If you specify a Transport ID, this option is automatically set.
1940 It is an error to specify this option for any service action other than
1943 Specify the reservation type.
1944 The reservation type may be specified by name or by number.
1945 If the desired reservation type isn't available by name, you may specify
1947 Supported reservation type names:
1952 Write Exclusive mode.
1953 May also be specified as
1954 .Dq write_exclusive .
1956 Read Exclusive mode.
1957 May also be specified as
1958 .Dq read_exclusive .
1960 Exclusive access mode.
1961 May also be specified as
1962 .Dq exclusive_access .
1964 Write Exclusive Registrants Only mode.
1965 May also be specified as
1966 .Dq write_exclusive_reg_only .
1968 Exclusive Access Registrants Only mode.
1969 May also be specified as
1970 .Dq exclusive_access_reg_only .
1972 Write Exclusive All Registrants mode.
1973 May also be specified as
1974 .Dq write_exclusive_all_regs .
1976 Exclusive Access All Registrants mode.
1977 May also be specified as
1978 .Dq exclusive_access_all_regs .
1981 Specify that the target should unregister the initiator that sent
1982 the Register and Move request.
1983 By default, the target will not unregister the initiator that sends the
1984 Register and Move request.
1985 This option only applies to the Register and Move service action of the
1986 Persistent Reserve Out command.
1991 READ or WRITE ATTRIBUTE commands.
1992 These commands are used to read and write attributes in Medium Auxiliary
1994 The most common place Medium Auxiliary Memory is found is small flash chips
1995 included tape cartriges.
2003 option must be specified.
2006 Specify the READ ATTRIBUTE service action.
2009 Issue the ATTRIBUTE VALUES service action.
2010 Read and decode the available attributes and their values.
2012 Issue the ATTRIBUTE LIST service action.
2013 List the attributes that are available to read and write.
2015 Issue the LOGICAL VOLUME LIST service action.
2016 List the available logical volumes in the MAM.
2018 Issue the PARTITION LIST service action.
2019 List the available partitions in the MAM.
2021 Issue the SUPPORTED ATTRIBUTES service action.
2022 List attributes that are supported for reading or writing.
2023 These attributes may or may not be currently present in the MAM.
2026 Specify an attribute to write to the MAM.
2027 This option is not yet implemented.
2029 Specify the attribute number to display.
2030 This option only works with the attr_values, attr_list and supp_attr
2034 Display cached attributes.
2035 If the device supports this flag, it allows displaying attributes for the
2036 last piece of media loaded in the drive.
2038 Specify the element address.
2039 This is used for specifying which element number in a medium changer to
2040 access when reading attributes.
2041 The element number could be for a picker, portal, slot or drive.
2042 .It Fl F Ar form1,form2
2043 Specify the output format for the attribute values (attr_val) display as a
2044 comma separated list of options.
2045 The default output is currently set to field_all,nonascii_trim,text_raw.
2046 Once this code is ported to FreeBSD 10, any text fields will be converted
2047 from their codeset to the user's native codeset with
2050 The text options are mutually exclusive; if you specify more than one, you
2051 will get unpredictable results.
2052 The nonascii options are also mutually exclusive.
2053 Most of the field options may be logically ORed together.
2056 Print text fields with non-ASCII characters escaped.
2058 Print text fields natively, with no codeset conversion.
2060 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2061 escape the non-ASCII characters.
2063 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2064 omit the non-ASCII characters.
2066 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2067 print them as they are.
2069 Print all of the prefix fields: description, attribute number, attribute
2070 size, and the attribute's readonly status.
2071 If field_all is specified, specifying any other field options will not have
2074 Print none of the prefix fields, and only print out the attribute value.
2075 If field_none is specified, specifying any other field options will result
2076 in those fields being printed.
2078 Print out the attribute description.
2080 Print out the attribute number.
2082 Print out the attribute size.
2084 Print out the attribute's readonly status.
2087 Specify the partition.
2088 When the media has multiple partitions, specifying different partition
2089 numbers allows seeing the values for each individual partition.
2090 .It Fl s Ar start_num
2091 Specify the starting attribute number.
2092 This requests that the target device return attribute information starting
2093 at the given number.
2094 .It Fl T Ar elem_type
2095 Specify the element type.
2096 For medium changer devices, this allows specifying the type the element
2097 referenced in the element address (
2107 Specify the number of the logical volume to operate on.
2108 If the media has multiple logical volumes, this will allow displaying
2109 or writing attributes on the given logical volume.
2112 Issue the REPORT SUPPORTED OPCODES service action of the
2116 Without arguments, this command will return a list of all
2118 commands supported by the device, including service actions of commands
2119 that support service actions.
2120 It will also include the
2122 CDB (Command Data Block) length for each command, and the description of
2123 each command if it is known.
2126 Request information on a specific opcode instead of the list of supported
2128 If supported, the target will return a CDB-like structure that indicates
2129 the opcode, service action (if any), and a mask of bits that are supported
2131 .It Fl s Ar service_action
2132 For commands that support a service action, specify the service action to
2135 If a service action is specified for a given opcode, and the device does
2136 not support the given service action, the device should not return a
2138 error, but rather indicate in the returned parameter data that the command
2140 By default, if a service action is specified for an opcode, and service
2141 actions are not supported for the opcode in question, the device will
2144 Include timeout values.
2145 This option works with the default display, which includes all commands
2146 supported by the device, and with the
2150 options, which request information on a specific command and service
2152 This requests that the device report Nominal and Recommended timeout values
2153 for the given command or commands.
2154 The timeout values are in seconds.
2155 The timeout descriptor also includes a command-specific
2162 Zoned Block devices.
2163 This allows managing devices that conform to the
2165 Zoned Block Commands (ZBC) and
2167 Zoned ATA Command Set (ZAC)
2169 Devices using these command sets are usually hard drives using Shingled
2170 Magnetic Recording (SMR).
2171 There are three types of SMR drives:
2174 Drive Managed drives look and act just like a standard random access block
2175 device, but underneath, the drive reads and writes the bulk of its capacity
2177 Sequential writes will yield better performance, but writing sequentially
2180 Host Aware drives expose the underlying zone layout via
2184 commands and allow the host to manage the zone conditions.
2185 The host is not required to manage the zones on the drive, though.
2186 Sequential writes will yield better performance in Sequential Write
2187 Preferred zones, but the host can write randomly in those zones.
2189 Host Managed drives expose the underlying zone layout via
2194 The host is required to access the zones according to the rules described
2196 Any commands that violate the rules will be returned with an error.
2199 SMR drives are divided into zones (typically in the range of 256MB each)
2200 that fall into three general categories:
2203 These are also known as Non Write Pointer zones.
2204 These zones can be randomly written without an unexpected performance penalty.
2205 .It Sequential Preferred
2206 These zones should be written sequentially starting at the write pointer
2208 They may be written randomly.
2209 Writes that do not conform to the zone layout may be significantly slower
2211 .It Sequential Required
2212 These zones must be written sequentially.
2213 If they are not written sequentially, starting at the write pointer, the
2219 Specify the zone subcommand:
2222 Issue the Report Zones command.
2223 All zones are returned by default.
2224 Specify report options with
2226 and printing options with
2228 Specify the starting LBA with
2232 is also accepted as a command argument.
2234 Explicitly open the zone specified by the starting LBA.
2236 Close the zone specified by starting LBA.
2238 Finish the zone specified by the starting LBA.
2240 Reset the write pointer for the zone specified by the starting LBA.
2243 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2244 operation to all zones on the drive.
2246 Specify the starting LBA.
2247 For the Report Zones command, this tells the drive to report starting with
2248 the zone that starts at the given LBA.
2249 For the other commands, this allows the user to identify the zone requested
2250 by its starting LBA.
2251 The LBA may be specified in decimal, hexadecimal or octal notation.
2253 For the Report Zones command, specify a subset of zones to report.
2257 This is the default.
2259 Report only empty zones.
2261 Report zones that are implicitly open.
2262 This means that the host has sent a write to the zone without explicitly
2265 Report zones that are explicitly open.
2267 Report zones that have been closed by the host.
2269 Report zones that are full.
2271 Report zones that are in the read only state.
2274 is also accepted as an argument.
2276 Report zones that are in the offline state.
2278 Report zones where the device recommends resetting write pointers.
2280 Report zones that have the Non Sequential Resources Active flag set.
2281 These are zones that are Sequential Write Preferred, but have been written
2284 Report Non Write Pointer zones, also known as Conventional zones.
2286 .It Fl P Ar print_opt
2287 Specify a printing option for Report Zones:
2290 Normal Report Zones output.
2291 This is the default.
2292 The summary and column headings are printed, fields are separated by spaces
2293 and the fields themselves may contain spaces.
2295 Just print the summary: the number of zones, the maximum LBA (LBA of the
2296 last logical block on the drive), and the value of the
2301 field describes whether the zones on the drive are all identical, all
2302 different, or whether they are the same except for the last zone, etc.
2304 Print the zones in a script friendly format.
2305 The summary and column headings are omitted, the fields are separated by
2306 commas, and the fields do not contain spaces.
2307 The fields contain underscores where spaces would normally be used.
2313 Extended Power Conditions (EPC) feature set commands.
2316 protocol drives, and will not work on
2325 translation layer (SAT).
2326 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2327 the Extended Power Conditions feature set, available at t13.org, to
2328 understand the details of this particular
2333 Specify the epc subcommand
2336 Restore drive power condition settings.
2339 Specify the source for the restored power settings, either
2343 This argument is required.
2346 This only makes sense to specify when restoring from defaults.
2349 Go to the specified power condition.
2352 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2353 This argument is required.
2355 Specify delayed entry to the power condition.
2356 The drive, if it supports this, can enter the power condition after the
2359 Hold the power condition.
2360 If the drive supports this option, it will hold the power condition and
2361 reject all commands that would normally cause it to exit that power
2365 Set the timer value for a power condition and enable or disable the
2369 display described below to see what the current timer settings are for each
2370 Idle and Standby mode supported by the drive.
2373 Enable the power condition.
2380 Disable the power condition.
2387 Specify the timer in seconds.
2388 The user may specify a timer as a floating point number with a maximum
2389 supported resolution of tenths of a second.
2390 Drives may or may not support sub-second timer values.
2392 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2393 This argument is required.
2395 Save the timer and power condition enable/disable state.
2396 By default, if this option is not specified, only the current values for
2397 this power condition will be affected.
2400 Enable or disable a particular power condition.
2403 Enable the power condition.
2410 Disable the power condition.
2417 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2418 This argument is required.
2420 Save the power condition enable/disable state.
2421 By default, if this option is not specified, only the current values for
2422 this power condition will be affected.
2425 Enable the Extended Power Condition (EPC) feature set.
2427 Disable the Extended Power Condition (EPC) feature set.
2429 Specify the EPC power source.
2432 Specify the power source, either
2438 Get the current status of several parameters related to the Extended Power
2439 Condition (EPC) feature set, including whether APM and EPC are supported
2440 and enabled, whether Low Power Standby is supported, whether setting the
2441 EPC power source is supported, whether Low Power Standby is supported and
2442 the current power condition.
2445 Only report the current power condition.
2446 Some drives will exit their current power condition if a command other than
2449 CHECK POWER MODE command is received.
2450 If this flag is specified,
2454 CHECK POWER MODE command to the drive.
2459 Power Conditions log (Log Address 0x08).
2460 This shows the list of Idle and Standby power conditions the drive
2461 supports, and a number of parameters about each condition, including
2462 whether it is enabled and what the timer value is.
2466 Issue REPORT TIMESTAMP or SET TIMESTAMP
2468 commands. Either the
2472 option must be specified.
2475 Report the device's timestamp.
2476 If no more arguments are specified, the timestamp will be reported using
2477 the national representation of the date and time, followed by the time
2481 Specify the strftime format string, as documented in strftime(3), to be used
2482 to format the reported timestamp.
2484 Report the timestamp as milliseconds since the epoch.
2486 Report the timestamp using the national representation of the date and
2487 time, but override the system time zone and use UTC instead.
2492 Set the device's timestamp. Either the
2498 option must be specified.
2501 Specify the strptime format string, as documented in strptime(3).
2502 The time must also be specified with the
2506 Provide the time in the format specified with the
2510 Set the timestamp to the host system's time in UTC.
2514 Print out verbose usage information.
2519 variable allows the user to specify an alternate mode page format file.
2523 variable determines which text editor
2525 starts when editing mode pages.
2527 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2528 .It Pa /usr/share/misc/scsi_modes
2529 is the SCSI mode format database.
2531 is the transport layer device.
2533 are the CAM application passthrough devices.
2536 .Dl camcontrol eject -n cd -u 1 -v
2538 Eject the CD from cd1, and print SCSI sense information if the command
2541 .Dl camcontrol tur da0
2543 Send the SCSI test unit ready command to da0.
2546 utility will report whether the disk is ready, but will not display sense
2547 information if the command fails since the
2549 switch was not specified.
2550 .Bd -literal -offset indent
2551 camcontrol tur da1 -E -C 4 -t 50 -Q head -v
2554 Send a test unit ready command to da1.
2555 Enable kernel error recovery.
2556 Specify a retry count of 4, and a timeout of 50 seconds.
2560 flag) if the command fails.
2561 Since error recovery is turned on, the
2562 disk will be spun up if it is not currently spinning.
2565 task attribute for the command will be set to Head of Queue.
2568 utility will report whether the disk is ready.
2569 .Bd -literal -offset indent
2570 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2571 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2574 Issue a READ BUFFER command (0x3C) to cd1.
2575 Display the buffer size of cd1,
2576 and display the first 10 bytes from the cache on cd1.
2578 information if the command fails.
2579 .Bd -literal -offset indent
2580 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2581 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2584 Issue a WRITE BUFFER (0x3B) command to cd1.
2585 Write out 10 bytes of data,
2586 not including the (reserved) 4 byte header.
2587 Print out sense information if
2589 Be very careful with this command, improper use may
2590 cause data corruption.
2591 .Bd -literal -offset indent
2592 camcontrol modepage da3 -m 1 -e -P 3
2595 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2596 settings on the drive.
2597 Mode page 1 contains a disk drive's auto read and
2598 write reallocation settings, among other things.
2600 .Dl camcontrol rescan all
2602 Rescan all SCSI buses in the system for devices that have been added,
2605 .Dl camcontrol rescan 0
2607 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2609 .Dl camcontrol rescan 0:1:0
2611 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2614 .Dl camcontrol tags da5 -N 24
2616 Set the number of concurrent transactions for da5 to 24.
2617 .Bd -literal -offset indent
2618 camcontrol negotiate -n da -u 4 -T disable
2621 Disable tagged queueing for da4.
2622 .Bd -literal -offset indent
2623 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2626 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2628 Test Unit Ready command to make the settings take effect.
2629 .Bd -literal -offset indent
2630 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2633 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2635 Display SMP errors if the command fails.
2636 .Bd -literal -offset indent
2637 camcontrol security ada0
2640 Report security support and settings for ada0
2641 .Bd -literal -offset indent
2642 camcontrol security ada0 -U user -s MyPass
2645 Enable security on device ada0 with the password MyPass
2646 .Bd -literal -offset indent
2647 camcontrol security ada0 -U user -e MyPass
2650 Secure erase ada0 which has had security enabled with user password MyPass
2652 .Em WARNING! WARNING! WARNING!
2656 data from the device, so backup your data before using!
2658 This command can be used against an SSD drive to restoring it to
2659 factory default write performance.
2660 .Bd -literal -offset indent
2664 Report HPA support and settings for ada0 (also reported via
2666 .Bd -literal -offset indent
2667 camcontrol hpa ada0 -s 10240
2670 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2672 .Em WARNING! WARNING! WARNING!
2676 to all data on the device beyond this limit until HPA is disabled by setting
2677 HPA to native max sectors of the device, which can only be done after a
2678 power-on or hardware reset!
2681 use this on a device which has an active filesystem!
2682 .Bd -literal -offset indent
2683 camcontrol persist da0 -v -i read_keys
2686 This will read any persistent reservation keys registered with da0, and
2687 display any errors encountered when sending the PERSISTENT RESERVE IN
2690 .Bd -literal -offset indent
2691 camcontrol persist da0 -v -o register -a -K 0x12345678
2694 This will register the persistent reservation key 0x12345678 with da0,
2695 apply that registration to all ports on da0, and display any errors that
2696 occur when sending the PERSISTENT RESERVE OUT command.
2697 .Bd -literal -offset indent
2698 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2701 This will reserve da0 for the exlusive use of the initiator issuing the
2703 The scope of the reservation is the entire LUN.
2704 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2705 .Bd -literal -offset indent
2706 camcontrol persist da0 -v -i read_full
2709 This will display the full status of all reservations on da0 and print out
2710 status if there are any errors.
2711 .Bd -literal -offset indent
2712 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2715 This will release a reservation on da0 of the type ex_ac
2717 The Reservation Key for this registration is 0x12345678.
2718 Any errors that occur will be displayed.
2719 .Bd -literal -offset indent
2720 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2721 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2724 This will register the key 0x12345678 with da0, specifying that it applies
2725 to the SAS initiators with SAS addresses 0x1234567812345678 and
2727 .Bd -literal -offset indent
2728 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2729 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2732 This will move the registration from the current initiator, whose
2733 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2734 Fiber Channel World Wide Node Name 0x1234567812345678.
2735 A new registration key, 0x12345678, will be registered for the initiator
2736 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2737 current initiator will be unregistered from the target.
2738 The reservation will be moved to relative target port 2 on the target
2740 The registration will persist across power losses.
2741 .Bd -literal -offset indent
2742 camcontrol attrib sa0 -v -i attr_values -p 1
2745 This will read and decode the attribute values from partition 1 on the tape
2746 in tape drive sa0, and will display any
2750 .Bd -literal -offset indent
2751 camcontrol zone da0 -v -c rz -P summary
2754 This will request the SMR zone list from disk da0, and print out a
2755 summary of the zone parameters, and display any
2761 .Bd -literal -offset indent
2762 camcontrol zone da0 -v -c rz -o reset
2765 This will request the list of SMR zones that should have their write
2766 pointer reset from the disk da0, and display any
2772 .Bd -literal -offset indent
2773 camcontrol zone da0 -v -c rwp -l 0x2c80000
2776 This will issue the Reset Write Pointer command to disk da0 for the zone
2777 that starts at LBA 0x2c80000 and display any
2783 .Bd -literal -offset indent
2784 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2787 Set the timer for the Idle_a power condition on drive
2789 to 60.1 seconds, enable that particular power condition, and save the timer
2790 value and the enabled state of the power condition.
2792 .Bd -literal -offset indent
2793 camcontrol epc da4 -c goto -p Standby_z -H
2798 to go to the Standby_z power state (which is
2799 the drive's lowest power state) and hold in that state until it is
2800 explicitly released by another
2804 .Bd -literal -offset indent
2805 camcontrol epc da2 -c status -P
2808 Report only the power state of
2811 Some drives will power up in response to the commands sent by the
2819 CHECK POWER MODE command, which should not trigger a change in the drive's
2822 .Bd -literal -offset indent
2823 camcontrol epc ada0 -c list
2826 Display the ATA Power Conditions log (Log Address 0x08) for
2830 .Bd -literal -offset indent
2831 camcontrol timestamp sa0 -s -f "%a, %d %b %Y %T %z" \e
2832 -T "Wed, 26 Oct 2016 21:43:57 -0600"
2835 Set the timestamp of drive
2839 format string followed by a time string
2840 that was created using this format string.
2843 .Xr cam_cdbparse 3 ,
2850 utility first appeared in
2853 The mode page editing code and arbitrary SCSI command code are based upon
2858 library, written by Julian Elischer and Peter Dufault.
2861 program first appeared in
2863 and first appeared in
2868 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2870 The code that parses the generic command line arguments does not know that
2871 some of the subcommands take multiple arguments.
2872 So if, for instance, you
2873 tried something like this:
2874 .Bd -literal -offset indent
2875 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2878 The sense information from the test unit ready command would not get
2879 printed out, since the first
2883 bails out when it sees the second argument to
2887 Fixing this behavior would take some gross code, or changes to the
2890 The best way to circumvent this problem is to always make sure
2893 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob