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 | device id | bus Ns Op :target:lun
108 .Aq all | device id | bus Ns Op :target:lun
124 .Aq Fl m Ar page[,subpage] | 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".
425 .It Fl Q Ar task_attr
427 task attribute for the command, if it is a
430 This may be ordered, simple, head, or aca.
431 In most cases this is not needed.
432 The default is simple, which works with all
435 The task attribute may also be specified numerically.
437 SCSI command timeout in seconds.
438 This overrides the default timeout for
440 .It Fl u Ar unit_number
441 Specify the device unit number, e.g.\& "1", "5".
443 Be verbose, print out sense information for failed SCSI commands.
446 Primary command functions:
447 .Bl -tag -width periphlist
449 List all physical devices (logical units) attached to the CAM subsystem.
450 This also includes a list of peripheral drivers attached to each device.
453 argument, SCSI bus number, adapter name and unit numbers are printed as
455 On the other hand, with the
457 argument, only the bus adapter, and unit information will be printed, and
458 device information will be omitted.
460 List all peripheral drivers attached to a given physical device (logical
463 Send the SCSI test unit ready (0x00) command to the given device.
466 utility will report whether the device is ready or not.
468 Send a SCSI inquiry command (0x12) to a device.
471 will print out the standard inquiry data, device serial number, and
472 transfer rate information.
473 The user can specify that only certain types of
474 inquiry data be printed:
477 Get the standard inquiry data.
479 Print out the serial number.
480 If this flag is the only one specified,
482 will not print out "Serial Number" before the value returned by the drive.
483 This is to aid in script writing.
485 Print out transfer rate information.
488 Send a ATA identify command (0xec) to a device.
490 Send the SCSI REPORT LUNS (0xA0) command to the given device.
493 will print out the list of logical units (LUNs) supported by the target device.
494 There are a couple of options to modify the output:
497 Just print out a count of LUNs, not the actual LUN numbers.
499 Just print out the LUNs, and do not print out the count.
500 .It Fl r Ar reporttype
501 Specify the type of report to request from the target:
502 .Bl -tag -width 012345678
504 Return the default report.
508 Most targets will support this report if they support the REPORT LUNS
511 Return only well known LUNs.
513 Return all available LUNs.
518 will try to print out LUN numbers in a reasonable format.
519 It can understand the peripheral, flat, LUN and extended LUN formats.
521 Send the SCSI READ CAPACITY command to the given device and display
523 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
524 action will be sent to obtain the full size of the device.
527 will print out the last logical block of the device, and the blocksize of
529 To modify the output format, use the following options:
532 Just print out the blocksize, not the last block or device size.
533 This cannot be used with
538 Print out the device size in human readable (base 2, 1K == 1024) format.
541 and cannot be used with
546 Print out the device size in human readable (base 10, 1K == 1000) format.
548 Print out the number of blocks in the device instead of the last logical
551 Quiet, print out the numbers only (separated by a comma if
557 Print out the last logical block or the size of the device only, and omit
561 Note that this command only displays the information, it does not update
562 the kernel data structures.
565 reprobe subcommand to do that.
567 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
570 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
573 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
574 start bit set and the load/eject bit set.
576 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
577 start bit cleared and the load/eject bit set.
579 Tell the kernel to scan all buses in the system (with the
581 argument), the given bus (XPT_SCAN_BUS), bus:target:lun or device
582 (XPT_SCAN_LUN) for new devices or devices that have gone away.
584 may specify a scan of all buses, a single bus, or a lun.
586 on a target is not supported.
588 If a device is specified by peripheral name and unit number, for instance
589 da4, it may only be rescanned if that device currently exists in the CAM EDT
590 (Existing Device Table).
591 If the device is no longer there (see
594 you must use the bus:target:lun form to rescan it.
596 Tell the kernel to refresh the information about the device and
597 notify the upper layer,
599 This includes sending the SCSI READ CAPACITY command and updating
600 the disk size visible to the rest of the system.
602 Tell the kernel to reset all buses in the system (with the
604 argument), the given bus (XPT_RESET_BUS) by issuing a SCSI bus
605 reset for that bus, or to reset the given bus:target:lun or device
606 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
607 connecting to that device.
608 Note that this can have a destructive impact
613 READ DEFECT DATA (10) command (0x37) or the
615 READ DEFECT DATA (12) command (0xB7) to the given device, and
616 print out any combination of: the total number of defects, the primary
617 defect list (PLIST), and the grown defect list (GLIST).
620 Specify the requested format of the defect list.
621 The format argument is
623 Most drives support the physical sector format.
625 support the logical block format.
626 Many drives, if they do not support the
627 requested format, return the data in an alternate format, along with sense
628 information indicating that the requested data format is not supported.
632 attempts to detect this, and print out whatever format the drive returns.
633 If the drive uses a non-standard sense code to report that it does not
634 support the requested format,
636 will probably see the error as a failure to complete the request.
638 The format options are:
641 Print out the list as logical blocks.
642 This is limited to 32-bit block sizes, and isn't supported by many modern
645 Print out the list as logical blocks.
646 This option uses a 64-bit block size.
648 Print out the list in bytes from index format.
650 Print out the list in extended bytes from index format.
651 The extended format allows for ranges of blocks to be printed.
653 Print out the list in physical sector format.
654 Most drives support this format.
656 Print out the list in extended physical sector format.
657 The extended format allows for ranges of blocks to be printed.
660 Print out the grown defect list.
661 This is a list of bad blocks that have
662 been remapped since the disk left the factory.
664 Print out the primary defect list.
665 This is the list of defects that were present in the factory.
667 When printing status information with
669 only print the number of defects.
671 Just print the number of defects, not the list of defects.
673 Specify the starting offset into the defect list.
674 This implies using the
676 READ DEFECT DATA (12) command, as the 10 byte version of the command
677 doesn't support the address descriptor index field.
678 Not all drives support the 12 byte command, and some drives that support
679 the 12 byte command don't support the address descriptor index field.
681 Print out defects in hexadecimal (base 16) form instead of base 10 form.
690 will print out the number of defects given in the READ DEFECT DATA header
691 returned from the drive.
692 Some drives will report 0 defects if neither the primary or grown defect
695 Allows the user to display and optionally edit a SCSI mode page.
697 page formats are located in
698 .Pa /usr/share/misc/scsi_modes .
699 This can be overridden by specifying a different file in the
701 environment variable.
704 command takes several arguments:
707 Disable block descriptors for mode sense.
709 Displays mode page data in binary format.
711 This flag allows the user to edit values in the mode page.
713 either edit mode page values with the text editor pointed to by his
715 environment variable, or supply mode page values via standard input, using
718 uses to display mode page values.
719 The editor will be invoked if
721 detects that standard input is terminal.
723 Lists all available mode pages.
724 If specified more then once, also lists subpages.
725 .It Fl m Ar page[,subpage]
726 This specifies the number of the mode page and optionally subpage the user
727 would like to view and/or edit.
728 This argument is mandatory unless
732 This allows the user to specify the page control field.
734 .Bl -tag -width xxx -compact
746 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
749 function requires the
751 argument to specify SCSI CDB or the
753 argument to specify ATA Command Block registers values.
754 Other arguments are optional, depending on
756 The command and data specification syntax is documented
759 NOTE: If the CDB specified causes data to be transferred to or from the
760 SCSI device in question, you MUST specify either
765 .It Fl a Ar cmd Op args
766 This specifies the content of 12 ATA Command Block registers (command,
767 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
768 lba_high_exp, features_exp, sector_count, sector_count_exp).
769 .It Fl c Ar cmd Op args
770 This specifies the SCSI CDB.
771 SCSI CDBs may be 6, 10, 12 or 16 bytes.
773 Specifies DMA protocol to be used for ATA command.
775 Specifies FPDMA (NCQ) protocol to be used for ATA command.
776 .It Fl i Ar len Ar fmt
777 This specifies the amount of data to read, and how it should be displayed.
781 bytes of data will be read from the device and written to standard output.
782 .It Fl o Ar len Ar fmt Op args
783 This specifies the amount of data to be written to a device, and the data
784 that is to be written.
788 bytes of data will be read from standard input and written to the device.
790 This specifies that 11 result ATA Command Block registers should be displayed
791 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
792 lba_high_exp, sector_count, sector_count_exp), and how.
795 11 result registers will be written to standard output in hex.
798 Allows the user to send an arbitrary Serial
799 Management Protocol (SMP) command to a device.
802 function requires the
804 argument to specify the SMP request to be sent, and the
806 argument to specify the format of the SMP response.
807 The syntax for the SMP request and response arguments is documented in
810 Note that SAS adapters that support SMP passthrough (at least the currently
811 known adapters) do not accept CRC bytes from the user in the request and do
812 not pass CRC bytes back to the user in the response.
813 Therefore users should not include the CRC bytes in the length of the
814 request and not expect CRC bytes to be returned in the response.
816 .It Fl r Ar len Ar fmt Op args
817 This specifies the size of the SMP request, without the CRC bytes, and the
822 bytes of data will be read from standard input and written as the SMP
824 .It Fl R Ar len Ar fmt Op args
825 This specifies the size of the buffer allocated for the SMP response, and
826 the SMP response format.
830 bytes of data will be allocated for the response and the response will be
831 written to standard output.
834 Allows the user to send the Serial Management Protocol (SMP) Report General
837 will display the data returned by the Report General command.
838 If the SMP target supports the long response format, the additional data
839 will be requested and displayed automatically.
842 Request the long response format only.
843 Not all SMP targets support the long response format.
846 to skip sending the initial report general request without the long bit set
847 and only issue a report general request with the long bit set.
850 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
852 This function should be used with some caution, as it can render devices
853 inaccessible, and could potentially cause data corruption as well.
856 argument is required to specify the PHY to operate on.
859 Specify the PHY to operate on.
860 This argument is required.
862 Request the long request/response format.
863 Not all SMP targets support the long response format.
864 For the PHY Control command, this currently only affects whether the
865 request length is set to a value other than 0.
866 .It Fl o Ar operation
867 Specify a PHY control operation.
870 operation may be specified.
871 The operation may be specified numerically (in decimal, hexadecimal, or octal)
872 or one of the following operation names may be specified:
876 It is not necessary to specify this argument.
878 Send the LINK RESET command to the phy.
880 Send the HARD RESET command to the phy.
882 Send the DISABLE command to the phy.
883 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
885 Send the CLEAR ERROR LOG command.
886 This clears the error log counters for the specified phy.
888 Send the CLEAR AFFILIATION command.
889 This clears the affiliation from the STP initiator port with the same SAS
890 address as the SMP initiator that requests the clear operation.
892 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
893 This will cause a SATA port selector to use the given phy as its active phy
894 and make the other phy inactive.
896 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
898 Send the SET ATTACHED DEVICE NAME command to the PHY.
901 argument to specify the device name.
904 Specify the attached device name.
905 This option is needed with the
908 The name is a 64-bit number, and can be specified in decimal, hexadecimal
911 Set the minimum physical link rate for the phy.
912 This is a numeric argument.
913 Currently known link rates are:
916 Do not change current value.
925 Other values may be specified for newer physical link rates.
927 Set the maximum physical link rate for the phy.
928 This is a numeric argument.
931 argument description for known link rate arguments.
932 .It Fl T Ar pp_timeout
933 Set the partial pathway timeout value, in microseconds.
938 specification for more information on this field.
939 .It Fl a Ar enable|disable
940 Enable or disable SATA slumber phy power conditions.
941 .It Fl A Ar enable|disable
942 Enable or disable SATA partial power conditions.
943 .It Fl s Ar enable|disable
944 Enable or disable SAS slumber phy power conditions.
945 .It Fl S Ar enable|disable
946 Enable or disable SAS partial phy power conditions.
949 List phys attached to a SAS expander, the address of the end device
950 attached to the phy, and the inquiry data for that device and peripheral
951 devices attached to that device.
952 The inquiry data and peripheral devices are displayed if available.
955 Turn on the long response format for the underlying SMP commands used for
958 Only print out phys that are attached to a device in the CAM EDT (Existing
962 Send the SMP Report Manufacturer Information command to the device and
963 display the response.
966 Turn on the long response format for the underlying SMP commands used for
970 Turn on CAM debugging printfs in the kernel.
971 This requires options CAMDEBUG
972 in your kernel config file.
973 WARNING: enabling debugging printfs currently
974 causes an EXTREME number of kernel printfs.
975 You may have difficulty
976 turning off the debugging printfs once they start, since the kernel will be
977 busy printing messages and unable to service other requests quickly.
980 function takes a number of arguments:
983 Enable CAM_DEBUG_INFO printfs.
985 Enable CAM_DEBUG_PERIPH printfs.
987 Enable CAM_DEBUG_TRACE printfs.
989 Enable CAM_DEBUG_SUBTRACE printfs.
991 Enable CAM_DEBUG_XPT printfs.
993 Enable CAM_DEBUG_CDB printfs.
994 This will cause the kernel to print out the
995 SCSI CDBs sent to the specified device(s).
997 Enable CAM_DEBUG_PROBE printfs.
999 Enable debugging for all devices.
1001 Turn off debugging for all devices
1002 .It bus Ns Op :target Ns Op :lun
1003 Turn on debugging for the given bus, target or lun.
1004 If the lun or target
1005 and lun are not specified, they are wildcarded.
1006 (i.e., just specifying a
1007 bus turns on debugging printfs for all devices on that bus.)
1010 Show or set the number of "tagged openings" or simultaneous transactions
1011 we attempt to queue to a particular device.
1014 command, with no command-specific arguments (i.e., only generic arguments)
1015 prints out the "soft" maximum number of transactions that can be queued to
1016 the device in question.
1017 For more detailed information, use the
1019 argument described below.
1022 Set the number of tags for the given device.
1023 This must be between the
1024 minimum and maximum number set in the kernel quirk table.
1026 most devices that support tagged queueing is a minimum of 2 and a maximum
1028 The minimum and maximum values for a given device may be
1029 determined by using the
1036 subcommand is described below.
1038 Be quiet, and do not report the number of tags.
1039 This is generally used when
1040 setting the number of tags.
1042 The verbose flag has special functionality for the
1047 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1050 This is the amount of capacity for transactions queued to a given device.
1052 This is the number of transactions currently queued to a device.
1054 This is the kernel queue space for transactions.
1055 This count usually mirrors
1056 dev_openings except during error recovery operations when
1057 the device queue is frozen (device is not allowed to receive
1058 commands), the number of dev_openings is reduced, or transaction
1059 replay is occurring.
1061 This is the number of transactions waiting in the kernel queue for capacity
1063 This number is usually zero unless error recovery is in
1066 The held count is the number of CCBs held by peripheral drivers that have
1067 either just been completed or are about to be released to the transport
1068 layer for service by a device.
1069 Held CCBs reserve capacity on a given
1072 This is the current "hard" minimum number of transactions that can be
1073 queued to a device at once.
1076 value above cannot go below this number.
1077 The default value for
1079 is 2, although it may be set higher or lower for various devices.
1081 This is the "hard" maximum number of transactions that can be queued to a
1085 value cannot go above this number.
1086 The default value for
1088 is 255, although it may be set higher or lower for various devices.
1092 Show or negotiate various communication parameters.
1093 Some controllers may
1094 not support setting or changing some of these values.
1096 Adaptec 174x controllers do not support changing a device's sync rate or
1101 will not attempt to set the parameter if the controller indicates that it
1102 does not support setting the parameter.
1103 To find out what the controller
1111 command is described below.
1112 Also, some controller drivers do not support
1113 setting negotiation parameters, even if the underlying controller supports
1114 negotiation changes.
1115 Some controllers, such as the Advansys wide
1116 controllers, support enabling and disabling synchronous negotiation for
1117 a device, but do not support setting the synchronous negotiation rate.
1120 Attempt to make the negotiation settings take effect immediately by sending
1121 a Test Unit Ready command to the device.
1123 Show or set current negotiation settings.
1124 This is the default.
1125 .It Fl D Ar enable|disable
1126 Enable or disable disconnection.
1130 Set the command delay offset.
1132 Be quiet, do not print anything.
1133 This is generally useful when you want to
1134 set a parameter, but do not want any status information.
1135 .It Fl R Ar syncrate
1136 Change the synchronization rate for a device.
1137 The sync rate is a floating
1138 point value specified in MHz.
1141 is a legal value, as is
1143 .It Fl T Ar enable|disable
1144 Enable or disable tagged queueing for a device.
1146 Show or set user negotiation settings.
1147 The default is to show or set
1148 current negotiation settings.
1150 The verbose switch has special meaning for the
1155 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1157 .It Fl W Ar bus_width
1158 Specify the bus width to negotiate with a device.
1161 The only useful values to specify are 8, 16, and 32
1163 The controller must support the bus width in question in order for
1164 the setting to take effect.
1167 In general, sync rate and offset settings will not take effect for a
1168 device until a command has been sent to the device.
1171 switch above will automatically send a Test Unit Ready to the device so
1172 negotiation parameters will take effect.
1176 FORMAT UNIT command to the named device.
1178 .Em WARNING! WARNING! WARNING!
1180 Low level formatting a disk will destroy ALL data on the disk.
1182 extreme caution when issuing this command.
1183 Many users low-level format
1184 disks that do not really need to be low-level formatted.
1186 relatively few scenarios that call for low-level formatting a disk.
1188 low-level formatting a disk is to initialize the disk after changing
1189 its physical sector size.
1190 Another reason for low-level formatting a disk
1191 is to revive the disk if you are getting "medium format corrupted" errors
1192 from the disk in response to read and write requests.
1194 Some disks take longer than others to format.
1195 Users should specify a
1196 timeout long enough to allow the format to complete.
1198 timeout is 3 hours, which should be long enough for most disks.
1200 disks will complete a format operation in a very short period of time
1201 (on the order of 5 minutes or less).
1202 This is often because the drive
1203 does not really support the FORMAT UNIT command -- it just accepts the
1204 command, waits a few minutes and then returns it.
1208 subcommand takes several arguments that modify its default behavior.
1213 arguments can be useful for scripts.
1216 Be quiet, do not print any status messages.
1217 This option will not disable
1218 the questions, however.
1219 To disable questions, use the
1226 This will report status on a format that is already running on the drive.
1228 Issue a non-immediate format command.
1231 issues the FORMAT UNIT command with the immediate bit set.
1233 device to immediately return the format command, before the format has
1239 sense information from the device every second to determine how far along
1240 in the format process it is.
1243 argument is specified,
1245 will issue a non-immediate format command, and will be unable to print any
1246 information to let the user know what percentage of the disk has been
1249 Do not ask any questions.
1252 will ask the user if he/she really wants to format the disk in question,
1253 and also if the default format command timeout is acceptable.
1255 will not be asked about the timeout if a timeout is specified on the
1261 SANITIZE command to the named device.
1263 .Em WARNING! WARNING! WARNING!
1265 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1266 Recovery of the data is not possible.
1267 Use extreme caution when issuing this command.
1271 subcommand takes several arguments that modify its default behavior.
1276 arguments can be useful for scripts.
1278 .It Fl a Ar operation
1279 Specify the sanitize operation to perform.
1282 Perform an overwrite operation by writing a user supplied
1283 data pattern to the device one or more times.
1284 The pattern is given by the
1287 The number of times is given by the
1291 Perform a block erase operation.
1292 All the device's blocks are set to a vendor defined
1293 value, typically zero.
1295 Perform a cryptographic erase operation.
1296 The encryption keys are changed to prevent the decryption
1299 Exits a previously failed sanitize operation.
1300 A failed sanitize operation can only be exited if it was
1301 run in the unrestricted completion mode, as provided by the
1306 The number of passes when performing an
1309 Valid values are between 1 and 31.
1314 operation, the pattern is inverted between consecutive passes.
1316 Path to the file containing the pattern to use when
1320 The pattern is repeated as needed to fill each block.
1322 Be quiet, do not print any status messages.
1323 This option will not disable
1324 the questions, however.
1325 To disable questions, use the
1329 Perform the sanitize in the unrestricted completion mode.
1330 If the operation fails, it can later be exited with the
1337 This will report status on a sanitize that is already running on the drive.
1339 Issue a non-immediate sanitize command.
1342 issues the SANITIZE command with the immediate bit set.
1344 device to immediately return the sanitize command, before
1345 the sanitize has actually completed.
1350 sense information from the device every second to determine how far along
1351 in the sanitize process it is.
1354 argument is specified,
1356 will issue a non-immediate sanitize command, and will be unable to print any
1357 information to let the user know what percentage of the disk has been
1360 Do not ask any questions.
1363 will ask the user if he/she really wants to sanitize the disk in question,
1364 and also if the default sanitize command timeout is acceptable.
1366 will not be asked about the timeout if a timeout is specified on the
1370 Put ATA device into IDLE state.
1373 specifies automatic standby timer value in seconds.
1374 Value 0 disables timer.
1376 Put ATA device into STANDBY state.
1379 specifies automatic standby timer value in seconds.
1380 Value 0 disables timer.
1382 Put ATA device into SLEEP state.
1383 Note that the only way get device out of
1384 this state may be reset.
1386 It optional parameter
1388 specified, enables and sets advanced power management level, where
1389 1 -- minimum power, 127 -- maximum performance with standby,
1390 128 -- minimum power without standby, 254 -- maximum performance.
1391 If not specified -- APM is disabled.
1393 It optional parameter
1395 specified, enables and sets automatic acoustic management level, where
1396 1 -- minimum noise, 254 -- maximum performance.
1397 If not specified -- AAM is disabled.
1399 Update or report security settings, using an ATA identify command (0xec).
1402 will print out the security support and associated settings of the device.
1405 command takes several arguments:
1409 Disable device security using the given password for the selected user according
1410 to the devices configured security level.
1413 Erase the device using the given password for the selected user.
1415 .Em WARNING! WARNING! WARNING!
1417 Issuing a secure erase will
1419 user data on the device and may take several hours to complete.
1421 When this command is used against an SSD drive all its cells will be marked as
1422 empty, restoring it to factory default write performance.
1423 For SSD's this action
1424 usually takes just a few seconds.
1427 Freeze the security configuration of the specified device.
1429 After command completion any other commands that update the device lock mode
1430 shall be command aborted.
1431 Frozen mode is disabled by power-off or hardware reset.
1434 Enhanced erase the device using the given password for the selected user.
1436 .Em WARNING! WARNING! WARNING!
1438 Issuing an enhanced secure erase will
1440 user data on the device and may take several hours to complete.
1442 An enhanced erase writes predetermined data patterns to all user data areas,
1443 all previously written user data shall be overwritten, including sectors that
1444 are no longer in use due to reallocation.
1447 Unlock the device using the given password for the selected user according to
1448 the devices configured security level.
1449 .It Fl l Ar high|maximum
1451 Specifies which security level to set when issuing a
1454 The security level determines device behavior when the master
1455 password is used to unlock the device.
1456 When the security level is set to high
1457 the device requires the unlock command and the master password to unlock.
1458 When the security level is set to maximum the device requires a secure erase
1459 with the master password to unlock.
1461 This option must be used in conjunction with one of the security action commands.
1467 Be quiet, do not print any status messages.
1468 This option will not disable the questions, however.
1469 To disable questions, use the
1474 Password the device (enable security) using the given password for the selected
1476 This option can be combined with other options such as
1479 A master password may be set in a addition to the user password. The purpose of
1480 the master password is to allow an administrator to establish a password that
1481 is kept secret from the user, and which may be used to unlock the device if the
1482 user password is lost.
1485 Setting the master password does not enable device security.
1487 If the master password is set and the drive supports a Master Revision Code
1488 feature the Master Password Revision Code will be decremented.
1491 Overrides the default timeout, specified in seconds, used for both
1495 this is useful if your system has problems processing long timeouts correctly.
1497 Usually the timeout is calculated from the information stored on the drive if
1498 present, otherwise it defaults to 2 hours.
1499 .It Fl U Ar user|master
1501 Specifies which user to set / use for the running action command, valid values
1502 are user or master and defaults to master if not set.
1504 This option must be used in conjunction with one of the security action commands.
1510 Confirm yes to dangerous options such as
1512 without prompting for confirmation.
1515 If the password specified for any action commands does not match the configured
1516 password for the specified user the command will fail.
1518 The password in all cases is limited to 32 characters, longer passwords will
1521 Update or report Host Protected Area details.
1524 will print out the HPA support and associated settings of the device.
1527 command takes several optional arguments:
1531 Freeze the HPA configuration of the specified device.
1533 After command completion any other commands that update the HPA configuration
1534 shall be command aborted.
1535 Frozen mode is disabled by power-off or hardware reset.
1538 Lock the HPA configuration of the device until a successful call to unlock or
1539 the next power-on reset occurs.
1542 Make the HPA max sectors persist across power-on reset or a hardware reset.
1543 This must be used in combination with
1544 .Fl s Ar max_sectors
1548 Set the HPA configuration password required for unlock calls.
1551 Be quiet, do not print any status messages.
1552 This option will not disable the questions.
1553 To disable questions, use the
1556 .It Fl s Ar max_sectors
1558 Configures the maximum user accessible sectors of the device.
1559 This will change the number of sectors the device reports.
1561 .Em WARNING! WARNING! WARNING!
1563 Changing the max sectors of a device using this option will make the data on
1564 the device beyond the specified value inaccessible.
1567 .Fl s Ar max_sectors
1568 call can be made without a power-on reset or a hardware reset of the device.
1571 Unlock the HPA configuration of the specified device using the given password.
1572 If the password specified does not match the password configured via
1574 the command will fail.
1576 After 5 failed unlock calls, due to password miss-match, the device will refuse
1577 additional unlock calls until after a power-on reset.
1580 Confirm yes to dangerous options such as
1582 without prompting for confirmation
1585 The password for all HPA commands is limited to 32 characters, longer passwords
1588 Program firmware of the named
1590 or ATA device using the image file provided.
1594 device and it provides a recommended timeout for the WRITE BUFFER command
1597 opcodes subcommand), that timeout will be used for the firmware download.
1598 The drive-recommended timeout value may be overridden on the command line
1603 Current list of supported vendors for SCSI/SAS drives:
1606 Tested with 4TB SAS drives, model number HUS724040ALS640.
1610 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1611 There is a separate table entry for hard drives, because the update method
1612 for hard drives is different than the method for tape drives.
1617 Tested with SM1625 SSDs.
1619 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1620 ES.3 (ST1000NM0023) drives.
1622 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1625 .Em WARNING! WARNING! WARNING!
1627 Little testing has been done to make sure that different device models from
1628 each vendor work correctly with the fwdownload command.
1629 A vendor name appearing in the supported list means only that firmware of at
1630 least one device type from that vendor has successfully been programmed with
1631 the fwdownload command.
1632 Extra caution should be taken when using this command since there is no
1633 guarantee it will not break a device from the listed vendors.
1634 Ensure that you have a recent backup of the data on the device before
1635 performing a firmware update.
1639 protocol devices will not be programmed, since there is little chance of
1640 the firmware download succeeding.
1643 will currently attempt a firmware download to any
1647 device, since the standard
1649 DOWNLOAD MICROCODE command may work.
1650 Firmware downloads to
1654 devices are supported for devices connected
1659 controllers, and devices connected to SAS controllers
1664 translation capability.
1670 PASS-THROUGH command to send the
1672 DOWNLOAD MICROCODE command to the drive.
1677 translation implementations don't work fully when translating
1679 WRITE BUFFER commands to
1681 DOWNLOAD MICROCODE commands, but do support
1683 passthrough well enough to do a firmware download.
1685 .It Fl f Ar fw_image
1686 Path to the firmware image file to be downloaded to the specified device.
1688 Do not print informational messages, only print errors.
1689 This option should be used with the
1691 option to suppress all output.
1693 Run in simulation mode.
1694 Device checks are run and the confirmation dialog is shown, but no firmware
1695 download will occur.
1701 errors in the event of a failure.
1703 In simulation mode, print out the
1708 register values that would be used for the firmware download command.
1710 Do not ask for confirmation.
1713 Persistent reservation support.
1714 Persistent reservations are a way to reserve a particular
1716 LUN for use by one or more
1721 option is specified,
1725 PERSISTENT RESERVE IN
1726 command using the requested service action.
1729 option is specified,
1733 PERSISTENT RESERVE OUT
1734 command using the requested service action.
1735 One of those two options is required.
1737 Persistent reservations are complex, and fully explaining them is outside
1738 the scope of this manual.
1741 and download the latest SPC spec for a full explanation of persistent
1745 Specify the service action for the PERSISTENT RESERVE IN command.
1746 Supported service actions:
1749 Report the current persistent reservation generation (PRgeneration) and any
1751 .It read_reservation
1752 Report the persistent reservation, if any.
1753 .It report_capabilities
1754 Report the persistent reservation capabilities of the LUN.
1755 .It read_full_status
1756 Report the full status of persistent reservations on the LUN.
1759 Specify the service action for the PERSISTENT RESERVE OUT command.
1760 For service actions like register that are components of other service
1761 action names, the entire name must be specified.
1762 Otherwise, enough of the service action name must be specified to
1763 distinguish it from other possible service actions.
1764 Supported service actions:
1767 Register a reservation key with the LUN or unregister a reservation key.
1768 To register a key, specify the requested key as the Service Action
1770 To unregister a key, specify the previously registered key as the
1772 To change a key, specify the old key as the Reservation Key and the new
1773 key as the Service Action Reservation Key.
1775 This is similar to the register subcommand, except that the Reservation Key
1777 The Service Action Reservation Key will overwrite any previous key
1778 registered for the initiator.
1780 Create a reservation.
1781 A key must be registered with the LUN before the LUN can be reserved, and
1782 it must be specified as the Reservation Key.
1783 The type of reservation must also be specified.
1784 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1786 Release a reservation.
1787 The Reservation Key must be specified.
1789 Release a reservation and remove all keys from the device.
1790 The Reservation Key must be specified.
1792 Remove a reservation belonging to another initiator.
1793 The Reservation Key must be specified.
1794 The Service Action Reservation Key may be specified, depending on the
1795 operation being performed.
1797 Remove a reservation belonging to another initiator and abort all
1798 outstanding commands from that 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 Register another initiator with the LUN, and establish a reservation on the
1804 LUN for that initiator.
1805 The Reservation Key and Service Action Reservation Key must be specified.
1807 Replace Lost Reservation information.
1810 Set the All Target Ports (ALL_TG_PT) bit.
1811 This requests that the key registration be applied to all target ports and
1812 not just the particular target port that receives the command.
1813 This only applies to the register and register_ignore actions.
1815 Specify a Transport ID.
1816 This only applies to the Register and Register and Move service actions for
1817 Persistent Reserve Out.
1818 Multiple Transport IDs may be specified with multiple
1821 With the Register service action, specifying one or more Transport IDs
1822 implicitly enables the
1824 option which turns on the SPEC_I_PT bit.
1825 Transport IDs generally have the format protocol,id.
1828 A SAS Transport ID consists of
1830 followed by a 64-bit SAS address.
1833 .Dl sas,0x1234567812345678
1835 A Fibre Channel Transport ID consists of
1837 followed by a 64-bit Fibre Channel World Wide Name.
1840 .Dl fcp,0x1234567812345678
1842 A Parallel SCSI address consists of
1844 followed by a SCSI target ID and a relative target port identifier.
1849 An IEEE 1394 (Firewire) Transport ID consists of
1851 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1854 .Dl sbp,0x1234567812345678
1856 A SCSI over RDMA Transport ID consists of
1858 followed by a 128-bit RDMA initiator port identifier.
1859 The port identifier must be exactly 32 or 34 (if the leading 0x is
1860 included) hexadecimal digits.
1861 Only hexadecimal (base 16) numbers are supported.
1864 .Dl srp,0x12345678123456781234567812345678
1866 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1868 For example, if only the iSCSI name is specified:
1870 .Dl iqn.2012-06.com.example:target0
1872 If the iSCSI separator and initiator session ID are specified:
1874 .Dl iqn.2012-06.com.example:target0,i,0x123
1876 A SCSI over PCIe Transport ID consists of
1878 followed by a PCIe Routing ID.
1879 The Routing ID consists of a bus, device and function or in the alternate
1880 form, a bus and function.
1881 The bus must be in the range of 0 to 255 inclusive and the device must be
1882 in the range of 0 to 31 inclusive.
1883 The function must be in the range of 0 to 7 inclusive if the standard form
1884 is used, and in the range of 0 to 255 inclusive if the alternate form is
1886 For example, if a bus, device and function are specified for the standard
1891 If the alternate Routing ID form is used:
1896 Specify the Reservation Key.
1897 This may be in decimal, octal or hexadecimal format.
1898 The value is zero by default if not otherwise specified.
1899 The value must be between 0 and 2^64 - 1, inclusive.
1901 Specify the Service Action Reservation Key.
1902 This may be in decimal, octal or hexadecimal format.
1903 The value is zero by default if not otherwise specified.
1904 The value must be between 0 and 2^64 - 1, inclusive.
1906 Enable the Activate Persist Through Power Loss bit.
1907 This is only used for the register and register_ignore actions.
1908 This requests that the reservation persist across power loss events.
1910 Specify the scope of the reservation.
1911 The scope may be specified by name or by number.
1912 The scope is ignored for register, register_ignore and clear.
1913 If the desired scope isn't available by name, you may specify the number.
1917 This encompasses the entire LUN.
1919 Extent scope (0x01).
1921 Element scope (0x02).
1924 Specify the Relative Target Port.
1925 This only applies to the Register and Move service action of the Persistent
1926 Reserve Out command.
1928 Enable the SPEC_I_PT bit.
1929 This only applies to the Register service action of Persistent Reserve Out.
1930 You must also specify at least one Transport ID with
1932 if this option is set.
1933 If you specify a Transport ID, this option is automatically set.
1934 It is an error to specify this option for any service action other than
1937 Specify the reservation type.
1938 The reservation type may be specified by name or by number.
1939 If the desired reservation type isn't available by name, you may specify
1941 Supported reservation type names:
1946 Write Exclusive mode.
1947 May also be specified as
1948 .Dq write_exclusive .
1950 Read Exclusive mode.
1951 May also be specified as
1952 .Dq read_exclusive .
1954 Exclusive access mode.
1955 May also be specified as
1956 .Dq exclusive_access .
1958 Write Exclusive Registrants Only mode.
1959 May also be specified as
1960 .Dq write_exclusive_reg_only .
1962 Exclusive Access Registrants Only mode.
1963 May also be specified as
1964 .Dq exclusive_access_reg_only .
1966 Write Exclusive All Registrants mode.
1967 May also be specified as
1968 .Dq write_exclusive_all_regs .
1970 Exclusive Access All Registrants mode.
1971 May also be specified as
1972 .Dq exclusive_access_all_regs .
1975 Specify that the target should unregister the initiator that sent
1976 the Register and Move request.
1977 By default, the target will not unregister the initiator that sends the
1978 Register and Move request.
1979 This option only applies to the Register and Move service action of the
1980 Persistent Reserve Out command.
1985 READ or WRITE ATTRIBUTE commands.
1986 These commands are used to read and write attributes in Medium Auxiliary
1988 The most common place Medium Auxiliary Memory is found is small flash chips
1989 included tape cartriges.
1997 option must be specified.
2000 Specify the READ ATTRIBUTE service action.
2003 Issue the ATTRIBUTE VALUES service action.
2004 Read and decode the available attributes and their values.
2006 Issue the ATTRIBUTE LIST service action.
2007 List the attributes that are available to read and write.
2009 Issue the LOGICAL VOLUME LIST service action.
2010 List the available logical volumes in the MAM.
2012 Issue the PARTITION LIST service action.
2013 List the available partitions in the MAM.
2015 Issue the SUPPORTED ATTRIBUTES service action.
2016 List attributes that are supported for reading or writing.
2017 These attributes may or may not be currently present in the MAM.
2020 Specify an attribute to write to the MAM.
2021 This option is not yet implemented.
2023 Specify the attribute number to display.
2024 This option only works with the attr_values, attr_list and supp_attr
2028 Display cached attributes.
2029 If the device supports this flag, it allows displaying attributes for the
2030 last piece of media loaded in the drive.
2032 Specify the element address.
2033 This is used for specifying which element number in a medium changer to
2034 access when reading attributes.
2035 The element number could be for a picker, portal, slot or drive.
2036 .It Fl F Ar form1,form2
2037 Specify the output format for the attribute values (attr_val) display as a
2038 comma separated list of options.
2039 The default output is currently set to field_all,nonascii_trim,text_raw.
2040 Once this code is ported to FreeBSD 10, any text fields will be converted
2041 from their codeset to the user's native codeset with
2044 The text options are mutually exclusive; if you specify more than one, you
2045 will get unpredictable results.
2046 The nonascii options are also mutually exclusive.
2047 Most of the field options may be logically ORed together.
2050 Print text fields with non-ASCII characters escaped.
2052 Print text fields natively, with no codeset conversion.
2054 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2055 escape the non-ASCII characters.
2057 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2058 omit the non-ASCII characters.
2060 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2061 print them as they are.
2063 Print all of the prefix fields: description, attribute number, attribute
2064 size, and the attribute's readonly status.
2065 If field_all is specified, specifying any other field options will not have
2068 Print none of the prefix fields, and only print out the attribute value.
2069 If field_none is specified, specifying any other field options will result
2070 in those fields being printed.
2072 Print out the attribute description.
2074 Print out the attribute number.
2076 Print out the attribute size.
2078 Print out the attribute's readonly status.
2081 Specify the partition.
2082 When the media has multiple partitions, specifying different partition
2083 numbers allows seeing the values for each individual partition.
2084 .It Fl s Ar start_num
2085 Specify the starting attribute number.
2086 This requests that the target device return attribute information starting
2087 at the given number.
2088 .It Fl T Ar elem_type
2089 Specify the element type.
2090 For medium changer devices, this allows specifying the type the element
2091 referenced in the element address (
2101 Specify the number of the logical volume to operate on.
2102 If the media has multiple logical volumes, this will allow displaying
2103 or writing attributes on the given logical volume.
2106 Issue the REPORT SUPPORTED OPCODES service action of the
2110 Without arguments, this command will return a list of all
2112 commands supported by the device, including service actions of commands
2113 that support service actions.
2114 It will also include the
2116 CDB (Command Data Block) length for each command, and the description of
2117 each command if it is known.
2120 Request information on a specific opcode instead of the list of supported
2122 If supported, the target will return a CDB-like structure that indicates
2123 the opcode, service action (if any), and a mask of bits that are supported
2125 .It Fl s Ar service_action
2126 For commands that support a service action, specify the service action to
2129 If a service action is specified for a given opcode, and the device does
2130 not support the given service action, the device should not return a
2132 error, but rather indicate in the returned parameter data that the command
2134 By default, if a service action is specified for an opcode, and service
2135 actions are not supported for the opcode in question, the device will
2138 Include timeout values.
2139 This option works with the default display, which includes all commands
2140 supported by the device, and with the
2144 options, which request information on a specific command and service
2146 This requests that the device report Nominal and Recommended timeout values
2147 for the given command or commands.
2148 The timeout values are in seconds.
2149 The timeout descriptor also includes a command-specific
2156 Zoned Block devices.
2157 This allows managing devices that conform to the
2159 Zoned Block Commands (ZBC) and
2161 Zoned ATA Command Set (ZAC)
2163 Devices using these command sets are usually hard drives using Shingled
2164 Magnetic Recording (SMR).
2165 There are three types of SMR drives:
2168 Drive Managed drives look and act just like a standard random access block
2169 device, but underneath, the drive reads and writes the bulk of its capacity
2171 Sequential writes will yield better performance, but writing sequentially
2174 Host Aware drives expose the underlying zone layout via
2178 commands and allow the host to manage the zone conditions.
2179 The host is not required to manage the zones on the drive, though.
2180 Sequential writes will yield better performance in Sequential Write
2181 Preferred zones, but the host can write randomly in those zones.
2183 Host Managed drives expose the underlying zone layout via
2188 The host is required to access the zones according to the rules described
2190 Any commands that violate the rules will be returned with an error.
2193 SMR drives are divided into zones (typically in the range of 256MB each)
2194 that fall into three general categories:
2197 These are also known as Non Write Pointer zones.
2198 These zones can be randomly written without an unexpected performance penalty.
2199 .It Sequential Preferred
2200 These zones should be written sequentially starting at the write pointer
2202 They may be written randomly.
2203 Writes that do not conform to the zone layout may be significantly slower
2205 .It Sequential Required
2206 These zones must be written sequentially.
2207 If they are not written sequentially, starting at the write pointer, the
2213 Specify the zone subcommand:
2216 Issue the Report Zones command.
2217 All zones are returned by default.
2218 Specify report options with
2220 and printing options with
2222 Specify the starting LBA with
2226 is also accepted as a command argument.
2228 Explicitly open the zone specified by the starting LBA.
2230 Close the zone specified by starting LBA.
2232 Finish the zone specified by the starting LBA.
2234 Reset the write pointer for the zone specified by the starting LBA.
2237 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2238 operation to all zones on the drive.
2240 Specify the starting LBA.
2241 For the Report Zones command, this tells the drive to report starting with
2242 the zone that starts at the given LBA.
2243 For the other commands, this allows the user to identify the zone requested
2244 by its starting LBA.
2245 The LBA may be specified in decimal, hexadecimal or octal notation.
2247 For the Report Zones command, specify a subset of zones to report.
2251 This is the default.
2253 Report only empty zones.
2255 Report zones that are implicitly open.
2256 This means that the host has sent a write to the zone without explicitly
2259 Report zones that are explicitly open.
2261 Report zones that have been closed by the host.
2263 Report zones that are full.
2265 Report zones that are in the read only state.
2268 is also accepted as an argument.
2270 Report zones that are in the offline state.
2272 Report zones where the device recommends resetting write pointers.
2274 Report zones that have the Non Sequential Resources Active flag set.
2275 These are zones that are Sequential Write Preferred, but have been written
2278 Report Non Write Pointer zones, also known as Conventional zones.
2280 .It Fl P Ar print_opt
2281 Specify a printing option for Report Zones:
2284 Normal Report Zones output.
2285 This is the default.
2286 The summary and column headings are printed, fields are separated by spaces
2287 and the fields themselves may contain spaces.
2289 Just print the summary: the number of zones, the maximum LBA (LBA of the
2290 last logical block on the drive), and the value of the
2295 field describes whether the zones on the drive are all identical, all
2296 different, or whether they are the same except for the last zone, etc.
2298 Print the zones in a script friendly format.
2299 The summary and column headings are omitted, the fields are separated by
2300 commas, and the fields do not contain spaces.
2301 The fields contain underscores where spaces would normally be used.
2307 Extended Power Conditions (EPC) feature set commands.
2310 protocol drives, and will not work on
2319 translation layer (SAT).
2320 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2321 the Extended Power Conditions feature set, available at t13.org, to
2322 understand the details of this particular
2327 Specify the epc subcommand
2330 Restore drive power condition settings.
2333 Specify the source for the restored power settings, either
2337 This argument is required.
2340 This only makes sense to specify when restoring from defaults.
2343 Go to the specified power condition.
2346 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2347 This argument is required.
2349 Specify delayed entry to the power condition.
2350 The drive, if it supports this, can enter the power condition after the
2353 Hold the power condition.
2354 If the drive supports this option, it will hold the power condition and
2355 reject all commands that would normally cause it to exit that power
2359 Set the timer value for a power condition and enable or disable the
2363 display described below to see what the current timer settings are for each
2364 Idle and Standby mode supported by the drive.
2367 Enable the power condition.
2374 Disable the power condition.
2381 Specify the timer in seconds.
2382 The user may specify a timer as a floating point number with a maximum
2383 supported resolution of tenths of a second.
2384 Drives may or may not support sub-second timer values.
2386 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2387 This argument is required.
2389 Save the timer and power condition enable/disable state.
2390 By default, if this option is not specified, only the current values for
2391 this power condition will be affected.
2394 Enable or disable a particular power condition.
2397 Enable the power condition.
2404 Disable the power condition.
2411 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2412 This argument is required.
2414 Save the power condition enable/disable state.
2415 By default, if this option is not specified, only the current values for
2416 this power condition will be affected.
2419 Enable the Extended Power Condition (EPC) feature set.
2421 Disable the Extended Power Condition (EPC) feature set.
2423 Specify the EPC power source.
2426 Specify the power source, either
2432 Get the current status of several parameters related to the Extended Power
2433 Condition (EPC) feature set, including whether APM and EPC are supported
2434 and enabled, whether Low Power Standby is supported, whether setting the
2435 EPC power source is supported, whether Low Power Standby is supported and
2436 the current power condition.
2439 Only report the current power condition.
2440 Some drives will exit their current power condition if a command other than
2443 CHECK POWER MODE command is received.
2444 If this flag is specified,
2448 CHECK POWER MODE command to the drive.
2453 Power Conditions log (Log Address 0x08).
2454 This shows the list of Idle and Standby power conditions the drive
2455 supports, and a number of parameters about each condition, including
2456 whether it is enabled and what the timer value is.
2460 Issue REPORT TIMESTAMP or SET TIMESTAMP
2462 commands. Either the
2466 option must be specified.
2469 Report the device's timestamp.
2470 If no more arguments are specified, the timestamp will be reported using
2471 the national representation of the date and time, followed by the time
2475 Specify the strftime format string, as documented in strftime(3), to be used
2476 to format the reported timestamp.
2478 Report the timestamp as milliseconds since the epoch.
2480 Report the timestamp using the national representation of the date and
2481 time, but override the system time zone and use UTC instead.
2486 Set the device's timestamp. Either the
2492 option must be specified.
2495 Specify the strptime format string, as documented in strptime(3).
2496 The time must also be specified with the
2500 Provide the time in the format specified with the
2504 Set the timestamp to the host system's time in UTC.
2508 Print out verbose usage information.
2513 variable allows the user to specify an alternate mode page format file.
2517 variable determines which text editor
2519 starts when editing mode pages.
2521 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2522 .It Pa /usr/share/misc/scsi_modes
2523 is the SCSI mode format database.
2525 is the transport layer device.
2527 are the CAM application passthrough devices.
2530 .Dl camcontrol eject -n cd -u 1 -v
2532 Eject the CD from cd1, and print SCSI sense information if the command
2535 .Dl camcontrol tur da0
2537 Send the SCSI test unit ready command to da0.
2540 utility will report whether the disk is ready, but will not display sense
2541 information if the command fails since the
2543 switch was not specified.
2544 .Bd -literal -offset indent
2545 camcontrol tur da1 -E -C 4 -t 50 -Q head -v
2548 Send a test unit ready command to da1.
2549 Enable kernel error recovery.
2550 Specify a retry count of 4, and a timeout of 50 seconds.
2554 flag) if the command fails.
2555 Since error recovery is turned on, the
2556 disk will be spun up if it is not currently spinning.
2559 task attribute for the command will be set to Head of Queue.
2562 utility will report whether the disk is ready.
2563 .Bd -literal -offset indent
2564 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2565 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2568 Issue a READ BUFFER command (0x3C) to cd1.
2569 Display the buffer size of cd1,
2570 and display the first 10 bytes from the cache on cd1.
2572 information if the command fails.
2573 .Bd -literal -offset indent
2574 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2575 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2578 Issue a WRITE BUFFER (0x3B) command to cd1.
2579 Write out 10 bytes of data,
2580 not including the (reserved) 4 byte header.
2581 Print out sense information if
2583 Be very careful with this command, improper use may
2584 cause data corruption.
2585 .Bd -literal -offset indent
2586 camcontrol modepage da3 -m 1 -e -P 3
2589 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2590 settings on the drive.
2591 Mode page 1 contains a disk drive's auto read and
2592 write reallocation settings, among other things.
2594 .Dl camcontrol rescan all
2596 Rescan all SCSI buses in the system for devices that have been added,
2599 .Dl camcontrol rescan 0
2601 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2603 .Dl camcontrol rescan 0:1:0
2605 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2608 .Dl camcontrol tags da5 -N 24
2610 Set the number of concurrent transactions for da5 to 24.
2611 .Bd -literal -offset indent
2612 camcontrol negotiate -n da -u 4 -T disable
2615 Disable tagged queueing for da4.
2616 .Bd -literal -offset indent
2617 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2620 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2622 Test Unit Ready command to make the settings take effect.
2623 .Bd -literal -offset indent
2624 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2627 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2629 Display SMP errors if the command fails.
2630 .Bd -literal -offset indent
2631 camcontrol security ada0
2634 Report security support and settings for ada0
2635 .Bd -literal -offset indent
2636 camcontrol security ada0 -U user -s MyPass
2639 Enable security on device ada0 with the password MyPass
2640 .Bd -literal -offset indent
2641 camcontrol security ada0 -U user -e MyPass
2644 Secure erase ada0 which has had security enabled with user password MyPass
2646 .Em WARNING! WARNING! WARNING!
2650 data from the device, so backup your data before using!
2652 This command can be used against an SSD drive to restoring it to
2653 factory default write performance.
2654 .Bd -literal -offset indent
2658 Report HPA support and settings for ada0 (also reported via
2660 .Bd -literal -offset indent
2661 camcontrol hpa ada0 -s 10240
2664 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2666 .Em WARNING! WARNING! WARNING!
2670 to all data on the device beyond this limit until HPA is disabled by setting
2671 HPA to native max sectors of the device, which can only be done after a
2672 power-on or hardware reset!
2675 use this on a device which has an active filesystem!
2676 .Bd -literal -offset indent
2677 camcontrol persist da0 -v -i read_keys
2680 This will read any persistent reservation keys registered with da0, and
2681 display any errors encountered when sending the PERSISTENT RESERVE IN
2684 .Bd -literal -offset indent
2685 camcontrol persist da0 -v -o register -a -K 0x12345678
2688 This will register the persistent reservation key 0x12345678 with da0,
2689 apply that registration to all ports on da0, and display any errors that
2690 occur when sending the PERSISTENT RESERVE OUT command.
2691 .Bd -literal -offset indent
2692 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2695 This will reserve da0 for the exlusive use of the initiator issuing the
2697 The scope of the reservation is the entire LUN.
2698 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2699 .Bd -literal -offset indent
2700 camcontrol persist da0 -v -i read_full
2703 This will display the full status of all reservations on da0 and print out
2704 status if there are any errors.
2705 .Bd -literal -offset indent
2706 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2709 This will release a reservation on da0 of the type ex_ac
2711 The Reservation Key for this registration is 0x12345678.
2712 Any errors that occur will be displayed.
2713 .Bd -literal -offset indent
2714 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2715 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2718 This will register the key 0x12345678 with da0, specifying that it applies
2719 to the SAS initiators with SAS addresses 0x1234567812345678 and
2721 .Bd -literal -offset indent
2722 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2723 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2726 This will move the registration from the current initiator, whose
2727 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2728 Fiber Channel World Wide Node Name 0x1234567812345678.
2729 A new registration key, 0x12345678, will be registered for the initiator
2730 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2731 current initiator will be unregistered from the target.
2732 The reservation will be moved to relative target port 2 on the target
2734 The registration will persist across power losses.
2735 .Bd -literal -offset indent
2736 camcontrol attrib sa0 -v -i attr_values -p 1
2739 This will read and decode the attribute values from partition 1 on the tape
2740 in tape drive sa0, and will display any
2744 .Bd -literal -offset indent
2745 camcontrol zone da0 -v -c rz -P summary
2748 This will request the SMR zone list from disk da0, and print out a
2749 summary of the zone parameters, and display any
2755 .Bd -literal -offset indent
2756 camcontrol zone da0 -v -c rz -o reset
2759 This will request the list of SMR zones that should have their write
2760 pointer reset from the disk da0, and display any
2766 .Bd -literal -offset indent
2767 camcontrol zone da0 -v -c rwp -l 0x2c80000
2770 This will issue the Reset Write Pointer command to disk da0 for the zone
2771 that starts at LBA 0x2c80000 and display any
2777 .Bd -literal -offset indent
2778 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2781 Set the timer for the Idle_a power condition on drive
2783 to 60.1 seconds, enable that particular power condition, and save the timer
2784 value and the enabled state of the power condition.
2786 .Bd -literal -offset indent
2787 camcontrol epc da4 -c goto -p Standby_z -H
2792 to go to the Standby_z power state (which is
2793 the drive's lowest power state) and hold in that state until it is
2794 explicitly released by another
2798 .Bd -literal -offset indent
2799 camcontrol epc da2 -c status -P
2802 Report only the power state of
2805 Some drives will power up in response to the commands sent by the
2813 CHECK POWER MODE command, which should not trigger a change in the drive's
2816 .Bd -literal -offset indent
2817 camcontrol epc ada0 -c list
2820 Display the ATA Power Conditions log (Log Address 0x08) for
2824 .Bd -literal -offset indent
2825 camcontrol timestamp sa0 -s -f "%a, %d %b %Y %T %z" \e
2826 -T "Wed, 26 Oct 2016 21:43:57 -0600"
2829 Set the timestamp of drive
2833 format string followed by a time string
2834 that was created using this format string.
2837 .Xr cam_cdbparse 3 ,
2844 utility first appeared in
2847 The mode page editing code and arbitrary SCSI command code are based upon
2852 library, written by Julian Elischer and Peter Dufault.
2855 program first appeared in
2857 and first appeared in
2862 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2864 The code that parses the generic command line arguments does not know that
2865 some of the subcommands take multiple arguments.
2866 So if, for instance, you
2867 tried something like this:
2868 .Bd -literal -offset indent
2869 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2872 The sense information from the test unit ready command would not get
2873 printed out, since the first
2877 bails out when it sees the second argument to
2881 Fixing this behavior would take some gross code, or changes to the
2884 The best way to circumvent this problem is to always make sure
2887 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob