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
105 .Aq all | bus Ns Op :target:lun
108 .Aq all | bus Ns Op :target:lun
124 .Aq Fl m Ar page | Fl l
132 .Aq Fl a Ar cmd Op args
133 .Aq Fl c Ar cmd Op args
136 .Op Fl i Ar len Ar fmt
138 .Op Fl o Ar len Ar fmt Op args
145 .Aq Fl r Ar len Ar fmt Op args
146 .Aq Fl R Ar len Ar fmt Op args
158 .Op Fl o Ar operation
162 .Op Fl T Ar pp_timeout
163 .Op Fl a Ar enable|disable
164 .Op Fl A Ar enable|disable
165 .Op Fl s Ar enable|disable
166 .Op Fl S Ar enable|disable
187 .Aq all|off|bus Ns Op :target Ns Op :lun
200 .Op Fl D Ar enable|disable
205 .Op Fl T Ar enable|disable
207 .Op Fl W Ar bus_width
221 .Aq Fl a Ar overwrite | block | crypto | exitfailure
271 .Op Fl l Ar high|maximum
275 .Op Fl U Ar user|master
286 .Op Fl s Ar max_sectors
293 .Aq Fl i Ar action | Fl o Ar action
299 .Op Fl R Ar rel_tgt_port
308 .Aq Fl r Ar action | Fl w Ar attrib
311 .Op Fl e Ar elem_addr
312 .Op Fl F Ar form1,form2
314 .Op Fl s Ar start_addr
315 .Op Fl T Ar elem_type
322 .Op Fl s Ar service_action
331 .Op Fl P Ar print_opts
339 .Op Fl p Ar power_cond
341 .Op Fl r Ar restore_src
343 .Op Fl S Ar power_src
349 .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
355 utility is designed to provide a way for users to access and control the
362 can cause a loss of data and/or system crashes if used improperly.
364 expert users are encouraged to exercise caution when using this command.
365 Novice users should stay away from this utility.
369 utility has a number of primary functions, many of which support an optional
371 A device identifier can take one of three forms:
374 Specify a device name and unit number combination, like "da5" or "cd3".
376 Specify a bus number and target id.
377 The bus number can be determined from
379 .Dq camcontrol devlist .
380 The lun defaults to 0.
382 Specify the bus, target and lun for a device.
386 The device identifier, if it is specified,
388 come immediately after the function name, and before any generic or
389 function-specific arguments.
394 arguments described below will override any device name or unit number
395 specified beforehand.
402 override a specified bus:target or bus:target:lun, however.
406 primary functions support these generic arguments:
409 SCSI command retry count.
410 In order for this to work, error recovery
414 Instruct the kernel to perform generic SCSI error recovery for the given
416 This is needed in order for the retry count
419 Other than retrying commands, the generic error recovery in
420 the code will generally attempt to spin up drives that are not spinning.
421 It may take some other actions, depending upon the sense code returned from
424 Specify the device type to operate on, e.g.\& "da", "cd".
426 SCSI command timeout in seconds.
427 This overrides the default timeout for
429 .It Fl u Ar unit_number
430 Specify the device unit number, e.g.\& "1", "5".
432 Be verbose, print out sense information for failed SCSI commands.
435 Primary command functions:
436 .Bl -tag -width periphlist
438 List all physical devices (logical units) attached to the CAM subsystem.
439 This also includes a list of peripheral drivers attached to each device.
442 argument, SCSI bus number, adapter name and unit numbers are printed as
444 On the other hand, with the
446 argument, only the bus adapter, and unit information will be printed, and
447 device information will be omitted.
449 List all peripheral drivers attached to a given physical device (logical
452 Send the SCSI test unit ready (0x00) command to the given device.
455 utility will report whether the device is ready or not.
457 Send a SCSI inquiry command (0x12) to a device.
460 will print out the standard inquiry data, device serial number, and
461 transfer rate information.
462 The user can specify that only certain types of
463 inquiry data be printed:
466 Get the standard inquiry data.
468 Print out the serial number.
469 If this flag is the only one specified,
471 will not print out "Serial Number" before the value returned by the drive.
472 This is to aid in script writing.
474 Print out transfer rate information.
477 Send a ATA identify command (0xec) to a device.
479 Send the SCSI REPORT LUNS (0xA0) command to the given device.
482 will print out the list of logical units (LUNs) supported by the target device.
483 There are a couple of options to modify the output:
486 Just print out a count of LUNs, not the actual LUN numbers.
488 Just print out the LUNs, and do not print out the count.
489 .It Fl r Ar reporttype
490 Specify the type of report to request from the target:
491 .Bl -tag -width 012345678
493 Return the default report.
497 Most targets will support this report if they support the REPORT LUNS
500 Return only well known LUNs.
502 Return all available LUNs.
507 will try to print out LUN numbers in a reasonable format.
508 It can understand the peripheral, flat, LUN and extended LUN formats.
510 Send the SCSI READ CAPACITY command to the given device and display
512 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
513 action will be sent to obtain the full size of the device.
516 will print out the last logical block of the device, and the blocksize of
518 To modify the output format, use the following options:
521 Just print out the blocksize, not the last block or device size.
522 This cannot be used with
527 Print out the device size in human readable (base 2, 1K == 1024) format.
530 and cannot be used with
535 Print out the device size in human readable (base 10, 1K == 1000) format.
537 Print out the number of blocks in the device instead of the last logical
540 Quiet, print out the numbers only (separated by a comma if
546 Print out the last logical block or the size of the device only, and omit
550 Note that this command only displays the information, it does not update
551 the kernel data structures.
554 reprobe subcommand to do that.
556 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
559 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
562 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
563 start bit set and the load/eject bit set.
565 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
566 start bit cleared and the load/eject bit set.
568 Tell the kernel to scan all busses in the system (with the
570 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
571 (XPT_SCAN_LUN) for new devices or devices that have gone away.
573 may specify a scan of all busses, a single bus, or a lun.
575 on a target is not supported.
577 Tell the kernel to refresh the information about the device and
578 notify the upper layer,
580 This includes sending the SCSI READ CAPACITY command and updating
581 the disk size visible to the rest of the system.
583 Tell the kernel to reset all busses in the system (with the
585 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
586 reset for that bus, or to reset the given bus:target:lun
587 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
588 connecting to that device.
589 Note that this can have a destructive impact
594 READ DEFECT DATA (10) command (0x37) or the
596 READ DEFECT DATA (12) command (0xB7) to the given device, and
597 print out any combination of: the total number of defects, the primary
598 defect list (PLIST), and the grown defect list (GLIST).
601 Specify the requested format of the defect list.
602 The format argument is
604 Most drives support the physical sector format.
606 support the logical block format.
607 Many drives, if they do not support the
608 requested format, return the data in an alternate format, along with sense
609 information indicating that the requested data format is not supported.
613 attempts to detect this, and print out whatever format the drive returns.
614 If the drive uses a non-standard sense code to report that it does not
615 support the requested format,
617 will probably see the error as a failure to complete the request.
619 The format options are:
622 Print out the list as logical blocks.
623 This is limited to 32-bit block sizes, and isn't supported by many modern
626 Print out the list as logical blocks.
627 This option uses a 64-bit block size.
629 Print out the list in bytes from index format.
631 Print out the list in extended bytes from index format.
632 The extended format allows for ranges of blocks to be printed.
634 Print out the list in physical sector format.
635 Most drives support this format.
637 Print out the list in extended physical sector format.
638 The extended format allows for ranges of blocks to be printed.
641 Print out the grown defect list.
642 This is a list of bad blocks that have
643 been remapped since the disk left the factory.
645 Print out the primary defect list.
646 This is the list of defects that were present in the factory.
648 When printing status information with
650 only print the number of defects.
652 Just print the number of defects, not the list of defects.
654 Specify the starting offset into the defect list.
655 This implies using the
657 READ DEFECT DATA (12) command, as the 10 byte version of the command
658 doesn't support the address descriptor index field.
659 Not all drives support the 12 byte command, and some drives that support
660 the 12 byte command don't support the address descriptor index field.
662 Print out defects in hexadecimal (base 16) form instead of base 10 form.
671 will print out the number of defects given in the READ DEFECT DATA header
672 returned from the drive.
673 Some drives will report 0 defects if neither the primary or grown defect
676 Allows the user to display and optionally edit a SCSI mode page.
678 page formats are located in
679 .Pa /usr/share/misc/scsi_modes .
680 This can be overridden by specifying a different file in the
682 environment variable.
685 command takes several arguments:
688 Disable block descriptors for mode sense.
690 Displays mode page data in binary format.
692 This flag allows the user to edit values in the mode page.
694 either edit mode page values with the text editor pointed to by his
696 environment variable, or supply mode page values via standard input, using
699 uses to display mode page values.
700 The editor will be invoked if
702 detects that standard input is terminal.
704 Lists all available mode pages.
705 .It Fl m Ar mode_page
706 This specifies the number of the mode page the user would like to view
708 This argument is mandatory unless
712 This allows the user to specify the page control field.
714 .Bl -tag -width xxx -compact
726 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
729 function requires the
731 argument to specify SCSI CDB or the
733 argument to specify ATA Command Block registers values.
734 Other arguments are optional, depending on
736 The command and data specification syntax is documented
739 NOTE: If the CDB specified causes data to be transferred to or from the
740 SCSI device in question, you MUST specify either
745 .It Fl a Ar cmd Op args
746 This specifies the content of 12 ATA Command Block registers (command,
747 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
748 lba_high_exp, features_exp, sector_count, sector_count_exp).
749 .It Fl c Ar cmd Op args
750 This specifies the SCSI CDB.
751 SCSI CDBs may be 6, 10, 12 or 16 bytes.
753 Specifies DMA protocol to be used for ATA command.
755 Specifies FPDMA (NCQ) protocol to be used for ATA command.
756 .It Fl i Ar len Ar fmt
757 This specifies the amount of data to read, and how it should be displayed.
761 bytes of data will be read from the device and written to standard output.
762 .It Fl o Ar len Ar fmt Op args
763 This specifies the amount of data to be written to a device, and the data
764 that is to be written.
768 bytes of data will be read from standard input and written to the device.
770 This specifies that 11 result ATA Command Block registers should be displayed
771 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
772 lba_high_exp, sector_count, sector_count_exp), and how.
775 11 result registers will be written to standard output in hex.
778 Allows the user to send an arbitrary Serial
779 Management Protocol (SMP) command to a device.
782 function requires the
784 argument to specify the SMP request to be sent, and the
786 argument to specify the format of the SMP response.
787 The syntax for the SMP request and response arguments is documented in
790 Note that SAS adapters that support SMP passthrough (at least the currently
791 known adapters) do not accept CRC bytes from the user in the request and do
792 not pass CRC bytes back to the user in the response.
793 Therefore users should not include the CRC bytes in the length of the
794 request and not expect CRC bytes to be returned in the response.
796 .It Fl r Ar len Ar fmt Op args
797 This specifies the size of the SMP request, without the CRC bytes, and the
802 bytes of data will be read from standard input and written as the SMP
804 .It Fl R Ar len Ar fmt Op args
805 This specifies the size of the buffer allocated for the SMP response, and
806 the SMP response format.
810 bytes of data will be allocated for the response and the response will be
811 written to standard output.
814 Allows the user to send the Serial Management Protocol (SMP) Report General
817 will display the data returned by the Report General command.
818 If the SMP target supports the long response format, the additional data
819 will be requested and displayed automatically.
822 Request the long response format only.
823 Not all SMP targets support the long response format.
826 to skip sending the initial report general request without the long bit set
827 and only issue a report general request with the long bit set.
830 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
832 This function should be used with some caution, as it can render devices
833 inaccessible, and could potentially cause data corruption as well.
836 argument is required to specify the PHY to operate on.
839 Specify the PHY to operate on.
840 This argument is required.
842 Request the long request/response format.
843 Not all SMP targets support the long response format.
844 For the PHY Control command, this currently only affects whether the
845 request length is set to a value other than 0.
846 .It Fl o Ar operation
847 Specify a PHY control operation.
850 operation may be specified.
851 The operation may be specified numerically (in decimal, hexadecimal, or octal)
852 or one of the following operation names may be specified:
856 It is not necessary to specify this argument.
858 Send the LINK RESET command to the phy.
860 Send the HARD RESET command to the phy.
862 Send the DISABLE command to the phy.
863 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
865 Send the CLEAR ERROR LOG command.
866 This clears the error log counters for the specified phy.
868 Send the CLEAR AFFILIATION command.
869 This clears the affiliation from the STP initiator port with the same SAS
870 address as the SMP initiator that requests the clear operation.
872 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
873 This will cause a SATA port selector to use the given phy as its active phy
874 and make the other phy inactive.
876 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
878 Send the SET ATTACHED DEVICE NAME command to the PHY.
881 argument to specify the device name.
884 Specify the attached device name.
885 This option is needed with the
888 The name is a 64-bit number, and can be specified in decimal, hexadecimal
891 Set the minimum physical link rate for the phy.
892 This is a numeric argument.
893 Currently known link rates are:
896 Do not change current value.
905 Other values may be specified for newer physical link rates.
907 Set the maximum physical link rate for the phy.
908 This is a numeric argument.
911 argument description for known link rate arguments.
912 .It Fl T Ar pp_timeout
913 Set the partial pathway timeout value, in microseconds.
918 specification for more information on this field.
919 .It Fl a Ar enable|disable
920 Enable or disable SATA slumber phy power conditions.
921 .It Fl A Ar enable|disable
922 Enable or disable SATA partial power conditions.
923 .It Fl s Ar enable|disable
924 Enable or disable SAS slumber phy power conditions.
925 .It Fl S Ar enable|disable
926 Enable or disable SAS partial phy power conditions.
929 List phys attached to a SAS expander, the address of the end device
930 attached to the phy, and the inquiry data for that device and peripheral
931 devices attached to that device.
932 The inquiry data and peripheral devices are displayed if available.
935 Turn on the long response format for the underlying SMP commands used for
938 Only print out phys that are attached to a device in the CAM EDT (Existing
942 Send the SMP Report Manufacturer Information command to the device and
943 display the response.
946 Turn on the long response format for the underlying SMP commands used for
950 Turn on CAM debugging printfs in the kernel.
951 This requires options CAMDEBUG
952 in your kernel config file.
953 WARNING: enabling debugging printfs currently
954 causes an EXTREME number of kernel printfs.
955 You may have difficulty
956 turning off the debugging printfs once they start, since the kernel will be
957 busy printing messages and unable to service other requests quickly.
960 function takes a number of arguments:
963 Enable CAM_DEBUG_INFO printfs.
965 Enable CAM_DEBUG_PERIPH printfs.
967 Enable CAM_DEBUG_TRACE printfs.
969 Enable CAM_DEBUG_SUBTRACE printfs.
971 Enable CAM_DEBUG_XPT printfs.
973 Enable CAM_DEBUG_CDB printfs.
974 This will cause the kernel to print out the
975 SCSI CDBs sent to the specified device(s).
977 Enable CAM_DEBUG_PROBE printfs.
979 Enable debugging for all devices.
981 Turn off debugging for all devices
982 .It bus Ns Op :target Ns Op :lun
983 Turn on debugging for the given bus, target or lun.
985 and lun are not specified, they are wildcarded.
986 (i.e., just specifying a
987 bus turns on debugging printfs for all devices on that bus.)
990 Show or set the number of "tagged openings" or simultaneous transactions
991 we attempt to queue to a particular device.
994 command, with no command-specific arguments (i.e., only generic arguments)
995 prints out the "soft" maximum number of transactions that can be queued to
996 the device in question.
997 For more detailed information, use the
999 argument described below.
1002 Set the number of tags for the given device.
1003 This must be between the
1004 minimum and maximum number set in the kernel quirk table.
1006 most devices that support tagged queueing is a minimum of 2 and a maximum
1008 The minimum and maximum values for a given device may be
1009 determined by using the
1016 subcommand is described below.
1018 Be quiet, and do not report the number of tags.
1019 This is generally used when
1020 setting the number of tags.
1022 The verbose flag has special functionality for the
1027 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1030 This is the amount of capacity for transactions queued to a given device.
1032 This is the number of transactions currently queued to a device.
1034 This is the kernel queue space for transactions.
1035 This count usually mirrors
1036 dev_openings except during error recovery operations when
1037 the device queue is frozen (device is not allowed to receive
1038 commands), the number of dev_openings is reduced, or transaction
1039 replay is occurring.
1041 This is the number of transactions waiting in the kernel queue for capacity
1043 This number is usually zero unless error recovery is in
1046 The held count is the number of CCBs held by peripheral drivers that have
1047 either just been completed or are about to be released to the transport
1048 layer for service by a device.
1049 Held CCBs reserve capacity on a given
1052 This is the current "hard" minimum number of transactions that can be
1053 queued to a device at once.
1056 value above cannot go below this number.
1057 The default value for
1059 is 2, although it may be set higher or lower for various devices.
1061 This is the "hard" maximum number of transactions that can be queued to a
1065 value cannot go above this number.
1066 The default value for
1068 is 255, although it may be set higher or lower for various devices.
1072 Show or negotiate various communication parameters.
1073 Some controllers may
1074 not support setting or changing some of these values.
1076 Adaptec 174x controllers do not support changing a device's sync rate or
1081 will not attempt to set the parameter if the controller indicates that it
1082 does not support setting the parameter.
1083 To find out what the controller
1091 command is described below.
1092 Also, some controller drivers do not support
1093 setting negotiation parameters, even if the underlying controller supports
1094 negotiation changes.
1095 Some controllers, such as the Advansys wide
1096 controllers, support enabling and disabling synchronous negotiation for
1097 a device, but do not support setting the synchronous negotiation rate.
1100 Attempt to make the negotiation settings take effect immediately by sending
1101 a Test Unit Ready command to the device.
1103 Show or set current negotiation settings.
1104 This is the default.
1105 .It Fl D Ar enable|disable
1106 Enable or disable disconnection.
1110 Set the command delay offset.
1112 Be quiet, do not print anything.
1113 This is generally useful when you want to
1114 set a parameter, but do not want any status information.
1115 .It Fl R Ar syncrate
1116 Change the synchronization rate for a device.
1117 The sync rate is a floating
1118 point value specified in MHz.
1121 is a legal value, as is
1123 .It Fl T Ar enable|disable
1124 Enable or disable tagged queueing for a device.
1126 Show or set user negotiation settings.
1127 The default is to show or set
1128 current negotiation settings.
1130 The verbose switch has special meaning for the
1135 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1137 .It Fl W Ar bus_width
1138 Specify the bus width to negotiate with a device.
1141 The only useful values to specify are 8, 16, and 32
1143 The controller must support the bus width in question in order for
1144 the setting to take effect.
1147 In general, sync rate and offset settings will not take effect for a
1148 device until a command has been sent to the device.
1151 switch above will automatically send a Test Unit Ready to the device so
1152 negotiation parameters will take effect.
1156 FORMAT UNIT command to the named device.
1158 .Em WARNING! WARNING! WARNING!
1160 Low level formatting a disk will destroy ALL data on the disk.
1162 extreme caution when issuing this command.
1163 Many users low-level format
1164 disks that do not really need to be low-level formatted.
1166 relatively few scenarios that call for low-level formatting a disk.
1168 low-level formatting a disk is to initialize the disk after changing
1169 its physical sector size.
1170 Another reason for low-level formatting a disk
1171 is to revive the disk if you are getting "medium format corrupted" errors
1172 from the disk in response to read and write requests.
1174 Some disks take longer than others to format.
1175 Users should specify a
1176 timeout long enough to allow the format to complete.
1178 timeout is 3 hours, which should be long enough for most disks.
1180 disks will complete a format operation in a very short period of time
1181 (on the order of 5 minutes or less).
1182 This is often because the drive
1183 does not really support the FORMAT UNIT command -- it just accepts the
1184 command, waits a few minutes and then returns it.
1188 subcommand takes several arguments that modify its default behavior.
1193 arguments can be useful for scripts.
1196 Be quiet, do not print any status messages.
1197 This option will not disable
1198 the questions, however.
1199 To disable questions, use the
1206 This will report status on a format that is already running on the drive.
1208 Issue a non-immediate format command.
1211 issues the FORMAT UNIT command with the immediate bit set.
1213 device to immediately return the format command, before the format has
1219 sense information from the device every second to determine how far along
1220 in the format process it is.
1223 argument is specified,
1225 will issue a non-immediate format command, and will be unable to print any
1226 information to let the user know what percentage of the disk has been
1229 Do not ask any questions.
1232 will ask the user if he/she really wants to format the disk in question,
1233 and also if the default format command timeout is acceptable.
1235 will not be asked about the timeout if a timeout is specified on the
1241 SANITIZE command to the named device.
1243 .Em WARNING! WARNING! WARNING!
1245 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1246 Recovery of the data is not possible.
1247 Use extreme caution when issuing this command.
1251 subcommand takes several arguments that modify its default behavior.
1256 arguments can be useful for scripts.
1258 .It Fl a Ar operation
1259 Specify the sanitize operation to perform.
1262 Perform an overwrite operation by writing a user supplied
1263 data pattern to the device one or more times.
1264 The pattern is given by the
1267 The number of times is given by the
1271 Perform a block erase operation.
1272 All the device's blocks are set to a vendor defined
1273 value, typically zero.
1275 Perform a cryptographic erase operation.
1276 The encryption keys are changed to prevent the decryption
1279 Exits a previously failed sanitize operation.
1280 A failed sanitize operation can only be exited if it was
1281 run in the unrestricted completion mode, as provided by the
1286 The number of passes when performing an
1289 Valid values are between 1 and 31.
1294 operation, the pattern is inverted between consecutive passes.
1296 Path to the file containing the pattern to use when
1300 The pattern is repeated as needed to fill each block.
1302 Be quiet, do not print any status messages.
1303 This option will not disable
1304 the questions, however.
1305 To disable questions, use the
1309 Perform the sanitize in the unrestricted completion mode.
1310 If the operation fails, it can later be exited with the
1317 This will report status on a sanitize that is already running on the drive.
1319 Issue a non-immediate sanitize command.
1322 issues the SANITIZE command with the immediate bit set.
1324 device to immediately return the sanitize command, before
1325 the sanitize has actually completed.
1330 sense information from the device every second to determine how far along
1331 in the sanitize process it is.
1334 argument is specified,
1336 will issue a non-immediate sanitize command, and will be unable to print any
1337 information to let the user know what percentage of the disk has been
1340 Do not ask any questions.
1343 will ask the user if he/she really wants to sanitize the disk in question,
1344 and also if the default sanitize command timeout is acceptable.
1346 will not be asked about the timeout if a timeout is specified on the
1350 Put ATA device into IDLE state.
1353 specifies automatic standby timer value in seconds.
1354 Value 0 disables timer.
1356 Put ATA device into STANDBY state.
1359 specifies automatic standby timer value in seconds.
1360 Value 0 disables timer.
1362 Put ATA device into SLEEP state.
1363 Note that the only way get device out of
1364 this state may be reset.
1366 It optional parameter
1368 specified, enables and sets advanced power management level, where
1369 1 -- minimum power, 127 -- maximum performance with standby,
1370 128 -- minimum power without standby, 254 -- maximum performance.
1371 If not specified -- APM is disabled.
1373 It optional parameter
1375 specified, enables and sets automatic acoustic management level, where
1376 1 -- minimum noise, 254 -- maximum performance.
1377 If not specified -- AAM is disabled.
1379 Update or report security settings, using an ATA identify command (0xec).
1382 will print out the security support and associated settings of the device.
1385 command takes several arguments:
1389 Disable device security using the given password for the selected user according
1390 to the devices configured security level.
1393 Erase the device using the given password for the selected user.
1395 .Em WARNING! WARNING! WARNING!
1397 Issuing a secure erase will
1399 user data on the device and may take several hours to complete.
1401 When this command is used against an SSD drive all its cells will be marked as
1402 empty, restoring it to factory default write performance.
1403 For SSD's this action
1404 usually takes just a few seconds.
1407 Freeze the security configuration of the specified device.
1409 After command completion any other commands that update the device lock mode
1410 shall be command aborted.
1411 Frozen mode is disabled by power-off or hardware reset.
1414 Enhanced erase the device using the given password for the selected user.
1416 .Em WARNING! WARNING! WARNING!
1418 Issuing an enhanced secure erase will
1420 user data on the device and may take several hours to complete.
1422 An enhanced erase writes predetermined data patterns to all user data areas,
1423 all previously written user data shall be overwritten, including sectors that
1424 are no longer in use due to reallocation.
1427 Unlock the device using the given password for the selected user according to
1428 the devices configured security level.
1429 .It Fl l Ar high|maximum
1431 Specifies which security level to set when issuing a
1434 The security level determines device behavior when the master
1435 password is used to unlock the device.
1436 When the security level is set to high
1437 the device requires the unlock command and the master password to unlock.
1438 When the security level is set to maximum the device requires a secure erase
1439 with the master password to unlock.
1441 This option must be used in conjunction with one of the security action commands.
1447 Be quiet, do not print any status messages.
1448 This option will not disable the questions, however.
1449 To disable questions, use the
1454 Password the device (enable security) using the given password for the selected
1456 This option can be combined with other options such as
1459 A master password may be set in a addition to the user password. The purpose of
1460 the master password is to allow an administrator to establish a password that
1461 is kept secret from the user, and which may be used to unlock the device if the
1462 user password is lost.
1465 Setting the master password does not enable device security.
1467 If the master password is set and the drive supports a Master Revision Code
1468 feature the Master Password Revision Code will be decremented.
1471 Overrides the default timeout, specified in seconds, used for both
1475 this is useful if your system has problems processing long timeouts correctly.
1477 Usually the timeout is calculated from the information stored on the drive if
1478 present, otherwise it defaults to 2 hours.
1479 .It Fl U Ar user|master
1481 Specifies which user to set / use for the running action command, valid values
1482 are user or master and defaults to master if not set.
1484 This option must be used in conjunction with one of the security action commands.
1490 Confirm yes to dangerous options such as
1492 without prompting for confirmation.
1495 If the password specified for any action commands does not match the configured
1496 password for the specified user the command will fail.
1498 The password in all cases is limited to 32 characters, longer passwords will
1501 Update or report Host Protected Area details.
1504 will print out the HPA support and associated settings of the device.
1507 command takes several optional arguments:
1511 Freeze the HPA configuration of the specified device.
1513 After command completion any other commands that update the HPA configuration
1514 shall be command aborted.
1515 Frozen mode is disabled by power-off or hardware reset.
1518 Lock the HPA configuration of the device until a successful call to unlock or
1519 the next power-on reset occurs.
1522 Make the HPA max sectors persist across power-on reset or a hardware reset.
1523 This must be used in combination with
1524 .Fl s Ar max_sectors
1528 Set the HPA configuration password required for unlock calls.
1531 Be quiet, do not print any status messages.
1532 This option will not disable the questions.
1533 To disable questions, use the
1536 .It Fl s Ar max_sectors
1538 Configures the maximum user accessible sectors of the device.
1539 This will change the number of sectors the device reports.
1541 .Em WARNING! WARNING! WARNING!
1543 Changing the max sectors of a device using this option will make the data on
1544 the device beyond the specified value inaccessible.
1547 .Fl s Ar max_sectors
1548 call can be made without a power-on reset or a hardware reset of the device.
1551 Unlock the HPA configuration of the specified device using the given password.
1552 If the password specified does not match the password configured via
1554 the command will fail.
1556 After 5 failed unlock calls, due to password miss-match, the device will refuse
1557 additional unlock calls until after a power-on reset.
1560 Confirm yes to dangerous options such as
1562 without prompting for confirmation
1565 The password for all HPA commands is limited to 32 characters, longer passwords
1568 Program firmware of the named
1570 or ATA device using the image file provided.
1574 device and it provides a recommended timeout for the WRITE BUFFER command
1577 opcodes subcommand), that timeout will be used for the firmware download.
1578 The drive-recommended timeout value may be overridden on the command line
1583 Current list of supported vendors for SCSI/SAS drives:
1586 Tested with 4TB SAS drives, model number HUS724040ALS640.
1590 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1591 There is a separate table entry for hard drives, because the update method
1592 for hard drives is different than the method for tape drives.
1597 Tested with SM1625 SSDs.
1599 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1600 ES.3 (ST1000NM0023) drives.
1602 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1605 .Em WARNING! WARNING! WARNING!
1607 Little testing has been done to make sure that different device models from
1608 each vendor work correctly with the fwdownload command.
1609 A vendor name appearing in the supported list means only that firmware of at
1610 least one device type from that vendor has successfully been programmed with
1611 the fwdownload command.
1612 Extra caution should be taken when using this command since there is no
1613 guarantee it will not break a device from the listed vendors.
1614 Ensure that you have a recent backup of the data on the device before
1615 performing a firmware update.
1619 protocol devices will not be programmed, since there is little chance of
1620 the firmware download succeeding.
1623 will currently attempt a firmware download to any
1627 device, since the standard
1629 DOWNLOAD MICROCODE command may work.
1630 Firmware downloads to
1634 devices are supported for devices connected
1639 controllers, and devices connected to SAS controllers
1644 translation capability.
1650 PASS-THROUGH command to send the
1652 DOWNLOAD MICROCODE command to the drive.
1657 translation implementations don't work fully when translating
1659 WRITE BUFFER commands to
1661 DOWNLOAD MICROCODE commands, but do support
1663 passthrough well enough to do a firmware download.
1665 .It Fl f Ar fw_image
1666 Path to the firmware image file to be downloaded to the specified device.
1668 Do not print informational messages, only print errors.
1669 This option should be used with the
1671 option to suppress all output.
1673 Run in simulation mode.
1674 Device checks are run and the confirmation dialog is shown, but no firmware
1675 download will occur.
1681 errors in the event of a failure.
1683 In simulation mode, print out the
1688 register values that would be used for the firmware download command.
1690 Do not ask for confirmation.
1693 Persistent reservation support.
1694 Persistent reservations are a way to reserve a particular
1696 LUN for use by one or more
1701 option is specified,
1705 PERSISTENT RESERVE IN
1706 command using the requested service action.
1709 option is specified,
1713 PERSISTENT RESERVE OUT
1714 command using the requested service action.
1715 One of those two options is required.
1717 Persistent reservations are complex, and fully explaining them is outside
1718 the scope of this manual.
1721 and download the latest SPC spec for a full explanation of persistent
1725 Specify the service action for the PERSISTENT RESERVE IN command.
1726 Supported service actions:
1729 Report the current persistent reservation generation (PRgeneration) and any
1731 .It read_reservation
1732 Report the persistent reservation, if any.
1733 .It report_capabilities
1734 Report the persistent reservation capabilities of the LUN.
1735 .It read_full_status
1736 Report the full status of persistent reservations on the LUN.
1739 Specify the service action for the PERSISTENT RESERVE OUT command.
1740 For service actions like register that are components of other service
1741 action names, the entire name must be specified.
1742 Otherwise, enough of the service action name must be specified to
1743 distinguish it from other possible service actions.
1744 Supported service actions:
1747 Register a reservation key with the LUN or unregister a reservation key.
1748 To register a key, specify the requested key as the Service Action
1750 To unregister a key, specify the previously registered key as the
1752 To change a key, specify the old key as the Reservation Key and the new
1753 key as the Service Action Reservation Key.
1755 This is similar to the register subcommand, except that the Reservation Key
1757 The Service Action Reservation Key will overwrite any previous key
1758 registered for the initiator.
1760 Create a reservation.
1761 A key must be registered with the LUN before the LUN can be reserved, and
1762 it must be specified as the Reservation Key.
1763 The type of reservation must also be specified.
1764 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1766 Release a reservation.
1767 The Reservation Key must be specified.
1769 Release a reservation and remove all keys from the device.
1770 The Reservation Key must be specified.
1772 Remove a reservation belonging to another initiator.
1773 The Reservation Key must be specified.
1774 The Service Action Reservation Key may be specified, depending on the
1775 operation being performed.
1777 Remove a reservation belonging to another initiator and abort all
1778 outstanding commands from that initiator.
1779 The Reservation Key must be specified.
1780 The Service Action Reservation Key may be specified, depending on the
1781 operation being performed.
1783 Register another initiator with the LUN, and establish a reservation on the
1784 LUN for that initiator.
1785 The Reservation Key and Service Action Reservation Key must be specified.
1787 Replace Lost Reservation information.
1790 Set the All Target Ports (ALL_TG_PT) bit.
1791 This requests that the key registration be applied to all target ports and
1792 not just the particular target port that receives the command.
1793 This only applies to the register and register_ignore actions.
1795 Specify a Transport ID.
1796 This only applies to the Register and Register and Move service actions for
1797 Persistent Reserve Out.
1798 Multiple Transport IDs may be specified with multiple
1801 With the Register service action, specifying one or more Transport IDs
1802 implicitly enables the
1804 option which turns on the SPEC_I_PT bit.
1805 Transport IDs generally have the format protocol,id.
1808 A SAS Transport ID consists of
1810 followed by a 64-bit SAS address.
1813 .Dl sas,0x1234567812345678
1815 A Fibre Channel Transport ID consists of
1817 followed by a 64-bit Fibre Channel World Wide Name.
1820 .Dl fcp,0x1234567812345678
1822 A Parallel SCSI address consists of
1824 followed by a SCSI target ID and a relative target port identifier.
1829 An IEEE 1394 (Firewire) Transport ID consists of
1831 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1834 .Dl sbp,0x1234567812345678
1836 A SCSI over RDMA Transport ID consists of
1838 followed by a 128-bit RDMA initiator port identifier.
1839 The port identifier must be exactly 32 or 34 (if the leading 0x is
1840 included) hexadecimal digits.
1841 Only hexadecimal (base 16) numbers are supported.
1844 .Dl srp,0x12345678123456781234567812345678
1846 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1848 For example, if only the iSCSI name is specified:
1850 .Dl iqn.2012-06.com.example:target0
1852 If the iSCSI separator and initiator session ID are specified:
1854 .Dl iqn.2012-06.com.example:target0,i,0x123
1856 A SCSI over PCIe Transport ID consists of
1858 followed by a PCIe Routing ID.
1859 The Routing ID consists of a bus, device and function or in the alternate
1860 form, a bus and function.
1861 The bus must be in the range of 0 to 255 inclusive and the device must be
1862 in the range of 0 to 31 inclusive.
1863 The function must be in the range of 0 to 7 inclusive if the standard form
1864 is used, and in the range of 0 to 255 inclusive if the alternate form is
1866 For example, if a bus, device and function are specified for the standard
1871 If the alternate Routing ID form is used:
1876 Specify the Reservation Key.
1877 This may be in decimal, octal or hexadecimal format.
1878 The value is zero by default if not otherwise specified.
1879 The value must be between 0 and 2^64 - 1, inclusive.
1881 Specify the Service Action Reservation Key.
1882 This may be in decimal, octal or hexadecimal format.
1883 The value is zero by default if not otherwise specified.
1884 The value must be between 0 and 2^64 - 1, inclusive.
1886 Enable the Activate Persist Through Power Loss bit.
1887 This is only used for the register and register_ignore actions.
1888 This requests that the reservation persist across power loss events.
1890 Specify the scope of the reservation.
1891 The scope may be specified by name or by number.
1892 The scope is ignored for register, register_ignore and clear.
1893 If the desired scope isn't available by name, you may specify the number.
1897 This encompasses the entire LUN.
1899 Extent scope (0x01).
1901 Element scope (0x02).
1904 Specify the Relative Target Port.
1905 This only applies to the Register and Move service action of the Persistent
1906 Reserve Out command.
1908 Enable the SPEC_I_PT bit.
1909 This only applies to the Register service action of Persistent Reserve Out.
1910 You must also specify at least one Transport ID with
1912 if this option is set.
1913 If you specify a Transport ID, this option is automatically set.
1914 It is an error to specify this option for any service action other than
1917 Specify the reservation type.
1918 The reservation type may be specified by name or by number.
1919 If the desired reservation type isn't available by name, you may specify
1921 Supported reservation type names:
1926 Write Exclusive mode.
1927 May also be specified as
1928 .Dq write_exclusive .
1930 Read Exclusive mode.
1931 May also be specified as
1932 .Dq read_exclusive .
1934 Exclusive access mode.
1935 May also be specified as
1936 .Dq exclusive_access .
1938 Write Exclusive Registrants Only mode.
1939 May also be specified as
1940 .Dq write_exclusive_reg_only .
1942 Exclusive Access Registrants Only mode.
1943 May also be specified as
1944 .Dq exclusive_access_reg_only .
1946 Write Exclusive All Registrants mode.
1947 May also be specified as
1948 .Dq write_exclusive_all_regs .
1950 Exclusive Access All Registrants mode.
1951 May also be specified as
1952 .Dq exclusive_access_all_regs .
1955 Specify that the target should unregister the initiator that sent
1956 the Register and Move request.
1957 By default, the target will not unregister the initiator that sends the
1958 Register and Move request.
1959 This option only applies to the Register and Move service action of the
1960 Persistent Reserve Out command.
1965 READ or WRITE ATTRIBUTE commands.
1966 These commands are used to read and write attributes in Medium Auxiliary
1968 The most common place Medium Auxiliary Memory is found is small flash chips
1969 included tape cartriges.
1977 option must be specified.
1980 Specify the READ ATTRIBUTE service action.
1983 Issue the ATTRIBUTE VALUES service action.
1984 Read and decode the available attributes and their values.
1986 Issue the ATTRIBUTE LIST service action.
1987 List the attributes that are available to read and write.
1989 Issue the LOGICAL VOLUME LIST service action.
1990 List the available logical volumes in the MAM.
1992 Issue the PARTITION LIST service action.
1993 List the available partitions in the MAM.
1995 Issue the SUPPORTED ATTRIBUTES service action.
1996 List attributes that are supported for reading or writing.
1997 These attributes may or may not be currently present in the MAM.
2000 Specify an attribute to write to the MAM.
2001 This option is not yet implemented.
2003 Specify the attribute number to display.
2004 This option only works with the attr_values, attr_list and supp_attr
2008 Display cached attributes.
2009 If the device supports this flag, it allows displaying attributes for the
2010 last piece of media loaded in the drive.
2012 Specify the element address.
2013 This is used for specifying which element number in a medium changer to
2014 access when reading attributes.
2015 The element number could be for a picker, portal, slot or drive.
2016 .It Fl F Ar form1,form2
2017 Specify the output format for the attribute values (attr_val) display as a
2018 comma separated list of options.
2019 The default output is currently set to field_all,nonascii_trim,text_raw.
2020 Once this code is ported to FreeBSD 10, any text fields will be converted
2021 from their codeset to the user's native codeset with
2024 The text options are mutually exclusive; if you specify more than one, you
2025 will get unpredictable results.
2026 The nonascii options are also mutually exclusive.
2027 Most of the field options may be logically ORed together.
2030 Print text fields with non-ASCII characters escaped.
2032 Print text fields natively, with no codeset conversion.
2034 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2035 escape the non-ASCII characters.
2037 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2038 omit the non-ASCII characters.
2040 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2041 print them as they are.
2043 Print all of the prefix fields: description, attribute number, attribute
2044 size, and the attribute's readonly status.
2045 If field_all is specified, specifying any other field options will not have
2048 Print none of the prefix fields, and only print out the attribute value.
2049 If field_none is specified, specifying any other field options will result
2050 in those fields being printed.
2052 Print out the attribute description.
2054 Print out the attribute number.
2056 Print out the attribute size.
2058 Print out the attribute's readonly status.
2061 Specify the partition.
2062 When the media has multiple partitions, specifying different partition
2063 numbers allows seeing the values for each individual partition.
2064 .It Fl s Ar start_num
2065 Specify the starting attribute number.
2066 This requests that the target device return attribute information starting
2067 at the given number.
2068 .It Fl T Ar elem_type
2069 Specify the element type.
2070 For medium changer devices, this allows specifying the type the element
2071 referenced in the element address (
2081 Specify the number of the logical volume to operate on.
2082 If the media has multiple logical volumes, this will allow displaying
2083 or writing attributes on the given logical volume.
2086 Issue the REPORT SUPPORTED OPCODES service action of the
2090 Without arguments, this command will return a list of all
2092 commands supported by the device, including service actions of commands
2093 that support service actions.
2094 It will also include the
2096 CDB (Command Data Block) length for each command, and the description of
2097 each command if it is known.
2100 Request information on a specific opcode instead of the list of supported
2102 If supported, the target will return a CDB-like structure that indicates
2103 the opcode, service action (if any), and a mask of bits that are supported
2105 .It Fl s Ar service_action
2106 For commands that support a service action, specify the service action to
2109 If a service action is specified for a given opcode, and the device does
2110 not support the given service action, the device should not return a
2112 error, but rather indicate in the returned parameter data that the command
2114 By default, if a service action is specified for an opcode, and service
2115 actions are not supported for the opcode in question, the device will
2118 Include timeout values.
2119 This option works with the default display, which includes all commands
2120 supported by the device, and with the
2124 options, which request information on a specific command and service
2126 This requests that the device report Nominal and Recommended timeout values
2127 for the given command or commands.
2128 The timeout values are in seconds.
2129 The timeout descriptor also includes a command-specific
2136 Zoned Block devices.
2137 This allows managing devices that conform to the
2139 Zoned Block Commands (ZBC) and
2141 Zoned ATA Command Set (ZAC)
2143 Devices using these command sets are usually hard drives using Shingled
2144 Magnetic Recording (SMR).
2145 There are three types of SMR drives:
2148 Drive Managed drives look and act just like a standard random access block
2149 device, but underneath, the drive reads and writes the bulk of its capacity
2151 Sequential writes will yield better performance, but writing sequentially
2154 Host Aware drives expose the underlying zone layout via
2158 commands and allow the host to manage the zone conditions.
2159 The host is not required to manage the zones on the drive, though.
2160 Sequential writes will yield better performance in Sequential Write
2161 Preferred zones, but the host can write randomly in those zones.
2163 Host Managed drives expose the underlying zone layout via
2168 The host is required to access the zones according to the rules described
2170 Any commands that violate the rules will be returned with an error.
2173 SMR drives are divided into zones (typically in the range of 256MB each)
2174 that fall into three general categories:
2177 These are also known as Non Write Pointer zones.
2178 These zones can be randomly written without an unexpected performance penalty.
2179 .It Sequential Preferred
2180 These zones should be written sequentially starting at the write pointer
2182 They may be written randomly.
2183 Writes that do not conform to the zone layout may be significantly slower
2185 .It Sequential Required
2186 These zones must be written sequentially.
2187 If they are not written sequentially, starting at the write pointer, the
2193 Specify the zone subcommand:
2196 Issue the Report Zones command.
2197 All zones are returned by default.
2198 Specify report options with
2200 and printing options with
2202 Specify the starting LBA with
2206 is also accepted as a command argument.
2208 Explicitly open the zone specified by the starting LBA.
2210 Close the zone specified by starting LBA.
2212 Finish the zone specified by the starting LBA.
2214 Reset the write pointer for the zone specified by the starting LBA.
2217 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2218 operation to all zones on the drive.
2220 Specify the starting LBA.
2221 For the Report Zones command, this tells the drive to report starting with
2222 the zone that starts at the given LBA.
2223 For the other commands, this allows the user to identify the zone requested
2224 by its starting LBA.
2225 The LBA may be specified in decimal, hexadecimal or octal notation.
2227 For the Report Zones command, specify a subset of zones to report.
2231 This is the default.
2233 Report only empty zones.
2235 Report zones that are implicitly open.
2236 This means that the host has sent a write to the zone without explicitly
2239 Report zones that are explicitly open.
2241 Report zones that have been closed by the host.
2243 Report zones that are full.
2245 Report zones that are in the read only state.
2248 is also accepted as an argument.
2250 Report zones that are in the offline state.
2252 Report zones where the device recommends resetting write pointers.
2254 Report zones that have the Non Sequential Resources Active flag set.
2255 These are zones that are Sequential Write Preferred, but have been written
2258 Report Non Write Pointer zones, also known as Conventional zones.
2260 .It Fl P Ar print_opt
2261 Specify a printing option for Report Zones:
2264 Normal Report Zones output.
2265 This is the default.
2266 The summary and column headings are printed, fields are separated by spaces
2267 and the fields themselves may contain spaces.
2269 Just print the summary: the number of zones, the maximum LBA (LBA of the
2270 last logical block on the drive), and the value of the
2275 field describes whether the zones on the drive are all identical, all
2276 different, or whether they are the same except for the last zone, etc.
2278 Print the zones in a script friendly format.
2279 The summary and column headings are omitted, the fields are separated by
2280 commas, and the fields do not contain spaces.
2281 The fields contain underscores where spaces would normally be used.
2287 Extended Power Conditions (EPC) feature set commands.
2290 protocol drives, and will not work on
2299 translation layer (SAT).
2300 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2301 the Extended Power Conditions feature set, available at t13.org, to
2302 understand the details of this particular
2307 Specify the epc subcommand
2310 Restore drive power condition settings.
2313 Specify the source for the restored power settings, either
2317 This argument is required.
2320 This only makes sense to specify when restoring from defaults.
2323 Go to the specified power condition.
2326 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2327 This argument is required.
2329 Specify delayed entry to the power condition.
2330 The drive, if it supports this, can enter the power condition after the
2333 Hold the power condition.
2334 If the drive supports this option, it will hold the power condition and
2335 reject all commands that would normally cause it to exit that power
2339 Set the timer value for a power condition and enable or disable the
2343 display described below to see what the current timer settings are for each
2344 Idle and Standby mode supported by the drive.
2347 Enable the power condition.
2354 Disable the power condition.
2361 Specify the timer in seconds.
2362 The user may specify a timer as a floating point number with a maximum
2363 supported resolution of tenths of a second.
2364 Drives may or may not support sub-second timer values.
2366 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2367 This argument is required.
2369 Save the timer and power condition enable/disable state.
2370 By default, if this option is not specified, only the current values for
2371 this power condition will be affected.
2374 Enable or disable a particular power condition.
2377 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2378 This argument is required.
2380 Save the power condition enable/disable state.
2381 By default, if this option is not specified, only the current values for
2382 this power condition will be affected.
2385 Enable the Extended Power Condition (EPC) feature set.
2387 Disable the Extended Power Condition (EPC) feature set.
2389 Specify the EPC power source.
2392 Specify the power source, either
2398 Get the current status of several parameters related to the Extended Power
2399 Condition (EPC) feature set, including whether APM and EPC are supported
2400 and enabled, whether Low Power Standby is supported, whether setting the
2401 EPC power source is supported, whether Low Power Standby is supported and
2402 the current power condition.
2405 Only report the current power condition.
2406 Some drives will exit their current power condition if a command other than
2409 CHECK POWER MODE command is received.
2410 If this flag is specified,
2414 CHECK POWER MODE command to the drive.
2419 Power Conditions log (Log Address 0x08).
2420 This shows the list of Idle and Standby power conditions the drive
2421 supports, and a number of parameters about each condition, including
2422 whether it is enabled and what the timer value is.
2426 Issue REPORT TIMESTAMP or SET TIMESTAMP
2428 commands. Either the
2432 option must be specified.
2435 Report the device's timestamp.
2436 If no more arguments are specified, the timestamp will be reported using
2437 the national representation of the date and time, followed by the time
2441 Specify the strftime format string, as documented in strftime(3), to be used
2442 to format the reported timestamp.
2444 Report the timestamp as milliseconds since the epoch.
2446 Report the timestamp using the national representation of the date and
2447 time, but override the system time zone and use UTC instead.
2452 Set the device's timestamp. Either the
2458 option must be specified.
2461 Specify the strptime format string, as documented in strptime(3).
2462 The time must also be specified with the
2466 Provide the time in the format specified with the
2470 Set the timestamp to the host system's time in UTC.
2474 Print out verbose usage information.
2479 variable allows the user to specify an alternate mode page format file.
2483 variable determines which text editor
2485 starts when editing mode pages.
2487 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2488 .It Pa /usr/share/misc/scsi_modes
2489 is the SCSI mode format database.
2491 is the transport layer device.
2493 are the CAM application passthrough devices.
2496 .Dl camcontrol eject -n cd -u 1 -v
2498 Eject the CD from cd1, and print SCSI sense information if the command
2501 .Dl camcontrol tur da0
2503 Send the SCSI test unit ready command to da0.
2506 utility will report whether the disk is ready, but will not display sense
2507 information if the command fails since the
2509 switch was not specified.
2510 .Bd -literal -offset indent
2511 camcontrol tur da1 -E -C 4 -t 50 -v
2514 Send a test unit ready command to da1.
2515 Enable kernel error recovery.
2516 Specify a retry count of 4, and a timeout of 50 seconds.
2520 flag) if the command fails.
2521 Since error recovery is turned on, the
2522 disk will be spun up if it is not currently spinning.
2525 utility will report whether the disk is ready.
2526 .Bd -literal -offset indent
2527 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2528 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2531 Issue a READ BUFFER command (0x3C) to cd1.
2532 Display the buffer size of cd1,
2533 and display the first 10 bytes from the cache on cd1.
2535 information if the command fails.
2536 .Bd -literal -offset indent
2537 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2538 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2541 Issue a WRITE BUFFER (0x3B) command to cd1.
2542 Write out 10 bytes of data,
2543 not including the (reserved) 4 byte header.
2544 Print out sense information if
2546 Be very careful with this command, improper use may
2547 cause data corruption.
2548 .Bd -literal -offset indent
2549 camcontrol modepage da3 -m 1 -e -P 3
2552 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2553 settings on the drive.
2554 Mode page 1 contains a disk drive's auto read and
2555 write reallocation settings, among other things.
2557 .Dl camcontrol rescan all
2559 Rescan all SCSI busses in the system for devices that have been added,
2562 .Dl camcontrol rescan 0
2564 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2566 .Dl camcontrol rescan 0:1:0
2568 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2571 .Dl camcontrol tags da5 -N 24
2573 Set the number of concurrent transactions for da5 to 24.
2574 .Bd -literal -offset indent
2575 camcontrol negotiate -n da -u 4 -T disable
2578 Disable tagged queueing for da4.
2579 .Bd -literal -offset indent
2580 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2583 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2585 Test Unit Ready command to make the settings take effect.
2586 .Bd -literal -offset indent
2587 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2590 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2592 Display SMP errors if the command fails.
2593 .Bd -literal -offset indent
2594 camcontrol security ada0
2597 Report security support and settings for ada0
2598 .Bd -literal -offset indent
2599 camcontrol security ada0 -U user -s MyPass
2602 Enable security on device ada0 with the password MyPass
2603 .Bd -literal -offset indent
2604 camcontrol security ada0 -U user -e MyPass
2607 Secure erase ada0 which has had security enabled with user password MyPass
2609 .Em WARNING! WARNING! WARNING!
2613 data from the device, so backup your data before using!
2615 This command can be used against an SSD drive to restoring it to
2616 factory default write performance.
2617 .Bd -literal -offset indent
2621 Report HPA support and settings for ada0 (also reported via
2623 .Bd -literal -offset indent
2624 camcontrol hpa ada0 -s 10240
2627 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2629 .Em WARNING! WARNING! WARNING!
2633 to all data on the device beyond this limit until HPA is disabled by setting
2634 HPA to native max sectors of the device, which can only be done after a
2635 power-on or hardware reset!
2638 use this on a device which has an active filesystem!
2639 .Bd -literal -offset indent
2640 camcontrol persist da0 -v -i read_keys
2643 This will read any persistent reservation keys registered with da0, and
2644 display any errors encountered when sending the PERSISTENT RESERVE IN
2647 .Bd -literal -offset indent
2648 camcontrol persist da0 -v -o register -a -K 0x12345678
2651 This will register the persistent reservation key 0x12345678 with da0,
2652 apply that registration to all ports on da0, and display any errors that
2653 occur when sending the PERSISTENT RESERVE OUT command.
2654 .Bd -literal -offset indent
2655 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2658 This will reserve da0 for the exlusive use of the initiator issuing the
2660 The scope of the reservation is the entire LUN.
2661 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2662 .Bd -literal -offset indent
2663 camcontrol persist da0 -v -i read_full
2666 This will display the full status of all reservations on da0 and print out
2667 status if there are any errors.
2668 .Bd -literal -offset indent
2669 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2672 This will release a reservation on da0 of the type ex_ac
2674 The Reservation Key for this registration is 0x12345678.
2675 Any errors that occur will be displayed.
2676 .Bd -literal -offset indent
2677 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2678 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2681 This will register the key 0x12345678 with da0, specifying that it applies
2682 to the SAS initiators with SAS addresses 0x1234567812345678 and
2684 .Bd -literal -offset indent
2685 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2686 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2689 This will move the registration from the current initiator, whose
2690 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2691 Fiber Channel World Wide Node Name 0x1234567812345678.
2692 A new registration key, 0x12345678, will be registered for the initiator
2693 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2694 current initiator will be unregistered from the target.
2695 The reservation will be moved to relative target port 2 on the target
2697 The registration will persist across power losses.
2698 .Bd -literal -offset indent
2699 camcontrol attrib sa0 -v -i attr_values -p 1
2702 This will read and decode the attribute values from partition 1 on the tape
2703 in tape drive sa0, and will display any
2707 .Bd -literal -offset indent
2708 camcontrol zone da0 -v -c rz -P summary
2711 This will request the SMR zone list from disk da0, and print out a
2712 summary of the zone parameters, and display any
2718 .Bd -literal -offset indent
2719 camcontrol zone da0 -v -c rz -o reset
2722 This will request the list of SMR zones that should have their write
2723 pointer reset from the disk da0, and display any
2729 .Bd -literal -offset indent
2730 camcontrol zone da0 -v -c rwp -l 0x2c80000
2733 This will issue the Reset Write Pointer command to disk da0 for the zone
2734 that starts at LBA 0x2c80000 and display any
2740 .Bd -literal -offset indent
2741 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2744 Set the timer for the Idle_a power condition on drive
2746 to 60.1 seconds, enable that particular power condition, and save the timer
2747 value and the enabled state of the power condition.
2749 .Bd -literal -offset indent
2750 camcontrol epc da4 -c goto -p Standby_z -H
2755 to go to the Standby_z power state (which is
2756 the drive's lowest power state) and hold in that state until it is
2757 explicitly released by another
2761 .Bd -literal -offset indent
2762 camcontrol epc da2 -c status -P
2765 Report only the power state of
2768 Some drives will power up in response to the commands sent by the
2776 CHECK POWER MODE command, which should not trigger a change in the drive's
2779 .Bd -literal -offset indent
2780 camcontrol epc ada0 -c list
2783 Display the ATA Power Conditions log (Log Address 0x08) for
2787 .Bd -literal -offset indent
2788 camcontrol timestamp sa0 -s -f "%A %c" \e
2789 -T "Wednesday Wed Oct 26 21:43:57 2016"
2792 Set the timestamp of drive
2796 format string followed by a time string
2797 that was created using this format string.
2800 .Xr cam_cdbparse 3 ,
2807 utility first appeared in
2810 The mode page editing code and arbitrary SCSI command code are based upon
2815 library, written by Julian Elischer and Peter Dufault.
2818 program first appeared in
2820 and first appeared in
2825 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2827 The code that parses the generic command line arguments does not know that
2828 some of the subcommands take multiple arguments.
2829 So if, for instance, you
2830 tried something like this:
2831 .Bd -literal -offset indent
2832 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2835 The sense information from the test unit ready command would not get
2836 printed out, since the first
2840 bails out when it sees the second argument to
2844 Fixing this behavior would take some gross code, or changes to the
2847 The best way to circumvent this problem is to always make sure
2850 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob