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
350 utility is designed to provide a way for users to access and control the
357 can cause a loss of data and/or system crashes if used improperly.
359 expert users are encouraged to exercise caution when using this command.
360 Novice users should stay away from this utility.
364 utility has a number of primary functions, many of which support an optional
366 A device identifier can take one of three forms:
369 Specify a device name and unit number combination, like "da5" or "cd3".
371 Specify a bus number and target id.
372 The bus number can be determined from
374 .Dq camcontrol devlist .
375 The lun defaults to 0.
377 Specify the bus, target and lun for a device.
381 The device identifier, if it is specified,
383 come immediately after the function name, and before any generic or
384 function-specific arguments.
389 arguments described below will override any device name or unit number
390 specified beforehand.
397 override a specified bus:target or bus:target:lun, however.
401 primary functions support these generic arguments:
404 SCSI command retry count.
405 In order for this to work, error recovery
409 Instruct the kernel to perform generic SCSI error recovery for the given
411 This is needed in order for the retry count
414 Other than retrying commands, the generic error recovery in
415 the code will generally attempt to spin up drives that are not spinning.
416 It may take some other actions, depending upon the sense code returned from
419 Specify the device type to operate on, e.g.\& "da", "cd".
421 SCSI command timeout in seconds.
422 This overrides the default timeout for
424 .It Fl u Ar unit_number
425 Specify the device unit number, e.g.\& "1", "5".
427 Be verbose, print out sense information for failed SCSI commands.
430 Primary command functions:
431 .Bl -tag -width periphlist
433 List all physical devices (logical units) attached to the CAM subsystem.
434 This also includes a list of peripheral drivers attached to each device.
437 argument, SCSI bus number, adapter name and unit numbers are printed as
439 On the other hand, with the
441 argument, only the bus adapter, and unit information will be printed, and
442 device information will be omitted.
444 List all peripheral drivers attached to a given physical device (logical
447 Send the SCSI test unit ready (0x00) command to the given device.
450 utility will report whether the device is ready or not.
452 Send a SCSI inquiry command (0x12) to a device.
455 will print out the standard inquiry data, device serial number, and
456 transfer rate information.
457 The user can specify that only certain types of
458 inquiry data be printed:
461 Get the standard inquiry data.
463 Print out the serial number.
464 If this flag is the only one specified,
466 will not print out "Serial Number" before the value returned by the drive.
467 This is to aid in script writing.
469 Print out transfer rate information.
472 Send a ATA identify command (0xec) to a device.
474 Send the SCSI REPORT LUNS (0xA0) command to the given device.
477 will print out the list of logical units (LUNs) supported by the target device.
478 There are a couple of options to modify the output:
481 Just print out a count of LUNs, not the actual LUN numbers.
483 Just print out the LUNs, and do not print out the count.
484 .It Fl r Ar reporttype
485 Specify the type of report to request from the target:
486 .Bl -tag -width 012345678
488 Return the default report.
492 Most targets will support this report if they support the REPORT LUNS
495 Return only well known LUNs.
497 Return all available LUNs.
502 will try to print out LUN numbers in a reasonable format.
503 It can understand the peripheral, flat, LUN and extended LUN formats.
505 Send the SCSI READ CAPACITY command to the given device and display
507 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
508 action will be sent to obtain the full size of the device.
511 will print out the last logical block of the device, and the blocksize of
513 To modify the output format, use the following options:
516 Just print out the blocksize, not the last block or device size.
517 This cannot be used with
522 Print out the device size in human readable (base 2, 1K == 1024) format.
525 and cannot be used with
530 Print out the device size in human readable (base 10, 1K == 1000) format.
532 Print out the number of blocks in the device instead of the last logical
535 Quiet, print out the numbers only (separated by a comma if
541 Print out the last logical block or the size of the device only, and omit
545 Note that this command only displays the information, it does not update
546 the kernel data structures.
549 reprobe subcommand to do that.
551 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
554 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
557 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
558 start bit set and the load/eject bit set.
560 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
561 start bit cleared and the load/eject bit set.
563 Tell the kernel to scan all busses in the system (with the
565 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
566 (XPT_SCAN_LUN) for new devices or devices that have gone away.
568 may specify a scan of all busses, a single bus, or a lun.
570 on a target is not supported.
572 Tell the kernel to refresh the information about the device and
573 notify the upper layer,
575 This includes sending the SCSI READ CAPACITY command and updating
576 the disk size visible to the rest of the system.
578 Tell the kernel to reset all busses in the system (with the
580 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
581 reset for that bus, or to reset the given bus:target:lun
582 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
583 connecting to that device.
584 Note that this can have a destructive impact
589 READ DEFECT DATA (10) command (0x37) or the
591 READ DEFECT DATA (12) command (0xB7) to the given device, and
592 print out any combination of: the total number of defects, the primary
593 defect list (PLIST), and the grown defect list (GLIST).
596 Specify the requested format of the defect list.
597 The format argument is
599 Most drives support the physical sector format.
601 support the logical block format.
602 Many drives, if they do not support the
603 requested format, return the data in an alternate format, along with sense
604 information indicating that the requested data format is not supported.
608 attempts to detect this, and print out whatever format the drive returns.
609 If the drive uses a non-standard sense code to report that it does not
610 support the requested format,
612 will probably see the error as a failure to complete the request.
614 The format options are:
617 Print out the list as logical blocks.
618 This is limited to 32-bit block sizes, and isn't supported by many modern
621 Print out the list as logical blocks.
622 This option uses a 64-bit block size.
624 Print out the list in bytes from index format.
626 Print out the list in extended bytes from index format.
627 The extended format allows for ranges of blocks to be printed.
629 Print out the list in physical sector format.
630 Most drives support this format.
632 Print out the list in extended physical sector format.
633 The extended format allows for ranges of blocks to be printed.
636 Print out the grown defect list.
637 This is a list of bad blocks that have
638 been remapped since the disk left the factory.
640 Print out the primary defect list.
641 This is the list of defects that were present in the factory.
643 When printing status information with
645 only print the number of defects.
647 Just print the number of defects, not the list of defects.
649 Specify the starting offset into the defect list.
650 This implies using the
652 READ DEFECT DATA (12) command, as the 10 byte version of the command
653 doesn't support the address descriptor index field.
654 Not all drives support the 12 byte command, and some drives that support
655 the 12 byte command don't support the address descriptor index field.
657 Print out defects in hexadecimal (base 16) form instead of base 10 form.
666 will print out the number of defects given in the READ DEFECT DATA header
667 returned from the drive.
668 Some drives will report 0 defects if neither the primary or grown defect
671 Allows the user to display and optionally edit a SCSI mode page.
673 page formats are located in
674 .Pa /usr/share/misc/scsi_modes .
675 This can be overridden by specifying a different file in the
677 environment variable.
680 command takes several arguments:
683 Disable block descriptors for mode sense.
685 Displays mode page data in binary format.
687 This flag allows the user to edit values in the mode page.
689 either edit mode page values with the text editor pointed to by his
691 environment variable, or supply mode page values via standard input, using
694 uses to display mode page values.
695 The editor will be invoked if
697 detects that standard input is terminal.
699 Lists all available mode pages.
700 .It Fl m Ar mode_page
701 This specifies the number of the mode page the user would like to view
703 This argument is mandatory unless
707 This allows the user to specify the page control field.
709 .Bl -tag -width xxx -compact
721 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
724 function requires the
726 argument to specify SCSI CDB or the
728 argument to specify ATA Command Block registers values.
729 Other arguments are optional, depending on
731 The command and data specification syntax is documented
734 NOTE: If the CDB specified causes data to be transferred to or from the
735 SCSI device in question, you MUST specify either
740 .It Fl a Ar cmd Op args
741 This specifies the content of 12 ATA Command Block registers (command,
742 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
743 lba_high_exp, features_exp, sector_count, sector_count_exp).
744 .It Fl c Ar cmd Op args
745 This specifies the SCSI CDB.
746 SCSI CDBs may be 6, 10, 12 or 16 bytes.
748 Specifies DMA protocol to be used for ATA command.
750 Specifies FPDMA (NCQ) protocol to be used for ATA command.
751 .It Fl i Ar len Ar fmt
752 This specifies the amount of data to read, and how it should be displayed.
756 bytes of data will be read from the device and written to standard output.
757 .It Fl o Ar len Ar fmt Op args
758 This specifies the amount of data to be written to a device, and the data
759 that is to be written.
763 bytes of data will be read from standard input and written to the device.
765 This specifies that 11 result ATA Command Block registers should be displayed
766 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
767 lba_high_exp, sector_count, sector_count_exp), and how.
770 11 result registers will be written to standard output in hex.
773 Allows the user to send an arbitrary Serial
774 Management Protocol (SMP) command to a device.
777 function requires the
779 argument to specify the SMP request to be sent, and the
781 argument to specify the format of the SMP response.
782 The syntax for the SMP request and response arguments is documented in
785 Note that SAS adapters that support SMP passthrough (at least the currently
786 known adapters) do not accept CRC bytes from the user in the request and do
787 not pass CRC bytes back to the user in the response.
788 Therefore users should not include the CRC bytes in the length of the
789 request and not expect CRC bytes to be returned in the response.
791 .It Fl r Ar len Ar fmt Op args
792 This specifies the size of the SMP request, without the CRC bytes, and the
797 bytes of data will be read from standard input and written as the SMP
799 .It Fl R Ar len Ar fmt Op args
800 This specifies the size of the buffer allocated for the SMP response, and
801 the SMP response format.
805 bytes of data will be allocated for the response and the response will be
806 written to standard output.
809 Allows the user to send the Serial Management Protocol (SMP) Report General
812 will display the data returned by the Report General command.
813 If the SMP target supports the long response format, the additional data
814 will be requested and displayed automatically.
817 Request the long response format only.
818 Not all SMP targets support the long response format.
821 to skip sending the initial report general request without the long bit set
822 and only issue a report general request with the long bit set.
825 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
827 This function should be used with some caution, as it can render devices
828 inaccessible, and could potentially cause data corruption as well.
831 argument is required to specify the PHY to operate on.
834 Specify the PHY to operate on.
835 This argument is required.
837 Request the long request/response format.
838 Not all SMP targets support the long response format.
839 For the PHY Control command, this currently only affects whether the
840 request length is set to a value other than 0.
841 .It Fl o Ar operation
842 Specify a PHY control operation.
845 operation may be specified.
846 The operation may be specified numerically (in decimal, hexadecimal, or octal)
847 or one of the following operation names may be specified:
851 It is not necessary to specify this argument.
853 Send the LINK RESET command to the phy.
855 Send the HARD RESET command to the phy.
857 Send the DISABLE command to the phy.
858 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
860 Send the CLEAR ERROR LOG command.
861 This clears the error log counters for the specified phy.
863 Send the CLEAR AFFILIATION command.
864 This clears the affiliation from the STP initiator port with the same SAS
865 address as the SMP initiator that requests the clear operation.
867 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
868 This will cause a SATA port selector to use the given phy as its active phy
869 and make the other phy inactive.
871 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
873 Send the SET ATTACHED DEVICE NAME command to the PHY.
876 argument to specify the device name.
879 Specify the attached device name.
880 This option is needed with the
883 The name is a 64-bit number, and can be specified in decimal, hexadecimal
886 Set the minimum physical link rate for the phy.
887 This is a numeric argument.
888 Currently known link rates are:
891 Do not change current value.
900 Other values may be specified for newer physical link rates.
902 Set the maximum physical link rate for the phy.
903 This is a numeric argument.
906 argument description for known link rate arguments.
907 .It Fl T Ar pp_timeout
908 Set the partial pathway timeout value, in microseconds.
913 specification for more information on this field.
914 .It Fl a Ar enable|disable
915 Enable or disable SATA slumber phy power conditions.
916 .It Fl A Ar enable|disable
917 Enable or disable SATA partial power conditions.
918 .It Fl s Ar enable|disable
919 Enable or disable SAS slumber phy power conditions.
920 .It Fl S Ar enable|disable
921 Enable or disable SAS partial phy power conditions.
924 List phys attached to a SAS expander, the address of the end device
925 attached to the phy, and the inquiry data for that device and peripheral
926 devices attached to that device.
927 The inquiry data and peripheral devices are displayed if available.
930 Turn on the long response format for the underlying SMP commands used for
933 Only print out phys that are attached to a device in the CAM EDT (Existing
937 Send the SMP Report Manufacturer Information command to the device and
938 display the response.
941 Turn on the long response format for the underlying SMP commands used for
945 Turn on CAM debugging printfs in the kernel.
946 This requires options CAMDEBUG
947 in your kernel config file.
948 WARNING: enabling debugging printfs currently
949 causes an EXTREME number of kernel printfs.
950 You may have difficulty
951 turning off the debugging printfs once they start, since the kernel will be
952 busy printing messages and unable to service other requests quickly.
955 function takes a number of arguments:
958 Enable CAM_DEBUG_INFO printfs.
960 Enable CAM_DEBUG_PERIPH printfs.
962 Enable CAM_DEBUG_TRACE printfs.
964 Enable CAM_DEBUG_SUBTRACE printfs.
966 Enable CAM_DEBUG_XPT printfs.
968 Enable CAM_DEBUG_CDB printfs.
969 This will cause the kernel to print out the
970 SCSI CDBs sent to the specified device(s).
972 Enable CAM_DEBUG_PROBE printfs.
974 Enable debugging for all devices.
976 Turn off debugging for all devices
977 .It bus Ns Op :target Ns Op :lun
978 Turn on debugging for the given bus, target or lun.
980 and lun are not specified, they are wildcarded.
981 (i.e., just specifying a
982 bus turns on debugging printfs for all devices on that bus.)
985 Show or set the number of "tagged openings" or simultaneous transactions
986 we attempt to queue to a particular device.
989 command, with no command-specific arguments (i.e., only generic arguments)
990 prints out the "soft" maximum number of transactions that can be queued to
991 the device in question.
992 For more detailed information, use the
994 argument described below.
997 Set the number of tags for the given device.
998 This must be between the
999 minimum and maximum number set in the kernel quirk table.
1001 most devices that support tagged queueing is a minimum of 2 and a maximum
1003 The minimum and maximum values for a given device may be
1004 determined by using the
1011 subcommand is described below.
1013 Be quiet, and do not report the number of tags.
1014 This is generally used when
1015 setting the number of tags.
1017 The verbose flag has special functionality for the
1022 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1025 This is the amount of capacity for transactions queued to a given device.
1027 This is the number of transactions currently queued to a device.
1029 This is the kernel queue space for transactions.
1030 This count usually mirrors
1031 dev_openings except during error recovery operations when
1032 the device queue is frozen (device is not allowed to receive
1033 commands), the number of dev_openings is reduced, or transaction
1034 replay is occurring.
1036 This is the number of transactions waiting in the kernel queue for capacity
1038 This number is usually zero unless error recovery is in
1041 The held count is the number of CCBs held by peripheral drivers that have
1042 either just been completed or are about to be released to the transport
1043 layer for service by a device.
1044 Held CCBs reserve capacity on a given
1047 This is the current "hard" minimum number of transactions that can be
1048 queued to a device at once.
1051 value above cannot go below this number.
1052 The default value for
1054 is 2, although it may be set higher or lower for various devices.
1056 This is the "hard" maximum number of transactions that can be queued to a
1060 value cannot go above this number.
1061 The default value for
1063 is 255, although it may be set higher or lower for various devices.
1067 Show or negotiate various communication parameters.
1068 Some controllers may
1069 not support setting or changing some of these values.
1071 Adaptec 174x controllers do not support changing a device's sync rate or
1076 will not attempt to set the parameter if the controller indicates that it
1077 does not support setting the parameter.
1078 To find out what the controller
1086 command is described below.
1087 Also, some controller drivers do not support
1088 setting negotiation parameters, even if the underlying controller supports
1089 negotiation changes.
1090 Some controllers, such as the Advansys wide
1091 controllers, support enabling and disabling synchronous negotiation for
1092 a device, but do not support setting the synchronous negotiation rate.
1095 Attempt to make the negotiation settings take effect immediately by sending
1096 a Test Unit Ready command to the device.
1098 Show or set current negotiation settings.
1099 This is the default.
1100 .It Fl D Ar enable|disable
1101 Enable or disable disconnection.
1105 Set the command delay offset.
1107 Be quiet, do not print anything.
1108 This is generally useful when you want to
1109 set a parameter, but do not want any status information.
1110 .It Fl R Ar syncrate
1111 Change the synchronization rate for a device.
1112 The sync rate is a floating
1113 point value specified in MHz.
1116 is a legal value, as is
1118 .It Fl T Ar enable|disable
1119 Enable or disable tagged queueing for a device.
1121 Show or set user negotiation settings.
1122 The default is to show or set
1123 current negotiation settings.
1125 The verbose switch has special meaning for the
1130 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1132 .It Fl W Ar bus_width
1133 Specify the bus width to negotiate with a device.
1136 The only useful values to specify are 8, 16, and 32
1138 The controller must support the bus width in question in order for
1139 the setting to take effect.
1142 In general, sync rate and offset settings will not take effect for a
1143 device until a command has been sent to the device.
1146 switch above will automatically send a Test Unit Ready to the device so
1147 negotiation parameters will take effect.
1151 FORMAT UNIT command to the named device.
1153 .Em WARNING! WARNING! WARNING!
1155 Low level formatting a disk will destroy ALL data on the disk.
1157 extreme caution when issuing this command.
1158 Many users low-level format
1159 disks that do not really need to be low-level formatted.
1161 relatively few scenarios that call for low-level formatting a disk.
1163 low-level formatting a disk is to initialize the disk after changing
1164 its physical sector size.
1165 Another reason for low-level formatting a disk
1166 is to revive the disk if you are getting "medium format corrupted" errors
1167 from the disk in response to read and write requests.
1169 Some disks take longer than others to format.
1170 Users should specify a
1171 timeout long enough to allow the format to complete.
1173 timeout is 3 hours, which should be long enough for most disks.
1175 disks will complete a format operation in a very short period of time
1176 (on the order of 5 minutes or less).
1177 This is often because the drive
1178 does not really support the FORMAT UNIT command -- it just accepts the
1179 command, waits a few minutes and then returns it.
1183 subcommand takes several arguments that modify its default behavior.
1188 arguments can be useful for scripts.
1191 Be quiet, do not print any status messages.
1192 This option will not disable
1193 the questions, however.
1194 To disable questions, use the
1201 This will report status on a format that is already running on the drive.
1203 Issue a non-immediate format command.
1206 issues the FORMAT UNIT command with the immediate bit set.
1208 device to immediately return the format command, before the format has
1214 sense information from the device every second to determine how far along
1215 in the format process it is.
1218 argument is specified,
1220 will issue a non-immediate format command, and will be unable to print any
1221 information to let the user know what percentage of the disk has been
1224 Do not ask any questions.
1227 will ask the user if he/she really wants to format the disk in question,
1228 and also if the default format command timeout is acceptable.
1230 will not be asked about the timeout if a timeout is specified on the
1236 SANITIZE command to the named device.
1238 .Em WARNING! WARNING! WARNING!
1240 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1241 Recovery of the data is not possible.
1242 Use extreme caution when issuing this command.
1246 subcommand takes several arguments that modify its default behavior.
1251 arguments can be useful for scripts.
1253 .It Fl a Ar operation
1254 Specify the sanitize operation to perform.
1257 Perform an overwrite operation by writing a user supplied
1258 data pattern to the device one or more times.
1259 The pattern is given by the
1262 The number of times is given by the
1266 Perform a block erase operation.
1267 All the device's blocks are set to a vendor defined
1268 value, typically zero.
1270 Perform a cryptographic erase operation.
1271 The encryption keys are changed to prevent the decryption
1274 Exits a previously failed sanitize operation.
1275 A failed sanitize operation can only be exited if it was
1276 run in the unrestricted completion mode, as provided by the
1281 The number of passes when performing an
1284 Valid values are between 1 and 31.
1289 operation, the pattern is inverted between consecutive passes.
1291 Path to the file containing the pattern to use when
1295 The pattern is repeated as needed to fill each block.
1297 Be quiet, do not print any status messages.
1298 This option will not disable
1299 the questions, however.
1300 To disable questions, use the
1304 Perform the sanitize in the unrestricted completion mode.
1305 If the operation fails, it can later be exited with the
1312 This will report status on a sanitize that is already running on the drive.
1314 Issue a non-immediate sanitize command.
1317 issues the SANITIZE command with the immediate bit set.
1319 device to immediately return the sanitize command, before
1320 the sanitize has actually completed.
1325 sense information from the device every second to determine how far along
1326 in the sanitize process it is.
1329 argument is specified,
1331 will issue a non-immediate sanitize command, and will be unable to print any
1332 information to let the user know what percentage of the disk has been
1335 Do not ask any questions.
1338 will ask the user if he/she really wants to sanitize the disk in question,
1339 and also if the default sanitize command timeout is acceptable.
1341 will not be asked about the timeout if a timeout is specified on the
1345 Put ATA device into IDLE state.
1348 specifies automatic standby timer value in seconds.
1349 Value 0 disables timer.
1351 Put ATA device into STANDBY state.
1354 specifies automatic standby timer value in seconds.
1355 Value 0 disables timer.
1357 Put ATA device into SLEEP state.
1358 Note that the only way get device out of
1359 this state may be reset.
1361 It optional parameter
1363 specified, enables and sets advanced power management level, where
1364 1 -- minimum power, 127 -- maximum performance with standby,
1365 128 -- minimum power without standby, 254 -- maximum performance.
1366 If not specified -- APM is disabled.
1368 It optional parameter
1370 specified, enables and sets automatic acoustic management level, where
1371 1 -- minimum noise, 254 -- maximum performance.
1372 If not specified -- AAM is disabled.
1374 Update or report security settings, using an ATA identify command (0xec).
1377 will print out the security support and associated settings of the device.
1380 command takes several arguments:
1384 Disable device security using the given password for the selected user according
1385 to the devices configured security level.
1388 Erase the device using the given password for the selected user.
1390 .Em WARNING! WARNING! WARNING!
1392 Issuing a secure erase will
1394 user data on the device and may take several hours to complete.
1396 When this command is used against an SSD drive all its cells will be marked as
1397 empty, restoring it to factory default write performance.
1398 For SSD's this action
1399 usually takes just a few seconds.
1402 Freeze the security configuration of the specified device.
1404 After command completion any other commands that update the device lock mode
1405 shall be command aborted.
1406 Frozen mode is disabled by power-off or hardware reset.
1409 Enhanced erase the device using the given password for the selected user.
1411 .Em WARNING! WARNING! WARNING!
1413 Issuing an enhanced secure erase will
1415 user data on the device and may take several hours to complete.
1417 An enhanced erase writes predetermined data patterns to all user data areas,
1418 all previously written user data shall be overwritten, including sectors that
1419 are no longer in use due to reallocation.
1422 Unlock the device using the given password for the selected user according to
1423 the devices configured security level.
1424 .It Fl l Ar high|maximum
1426 Specifies which security level to set when issuing a
1429 The security level determines device behavior when the master
1430 password is used to unlock the device.
1431 When the security level is set to high
1432 the device requires the unlock command and the master password to unlock.
1433 When the security level is set to maximum the device requires a secure erase
1434 with the master password to unlock.
1436 This option must be used in conjunction with one of the security action commands.
1442 Be quiet, do not print any status messages.
1443 This option will not disable the questions, however.
1444 To disable questions, use the
1449 Password the device (enable security) using the given password for the selected
1451 This option can be combined with other options such as
1454 A master password may be set in a addition to the user password. The purpose of
1455 the master password is to allow an administrator to establish a password that
1456 is kept secret from the user, and which may be used to unlock the device if the
1457 user password is lost.
1460 Setting the master password does not enable device security.
1462 If the master password is set and the drive supports a Master Revision Code
1463 feature the Master Password Revision Code will be decremented.
1466 Overrides the default timeout, specified in seconds, used for both
1470 this is useful if your system has problems processing long timeouts correctly.
1472 Usually the timeout is calculated from the information stored on the drive if
1473 present, otherwise it defaults to 2 hours.
1474 .It Fl U Ar user|master
1476 Specifies which user to set / use for the running action command, valid values
1477 are user or master and defaults to master if not set.
1479 This option must be used in conjunction with one of the security action commands.
1485 Confirm yes to dangerous options such as
1487 without prompting for confirmation.
1490 If the password specified for any action commands does not match the configured
1491 password for the specified user the command will fail.
1493 The password in all cases is limited to 32 characters, longer passwords will
1496 Update or report Host Protected Area details.
1499 will print out the HPA support and associated settings of the device.
1502 command takes several optional arguments:
1506 Freeze the HPA configuration of the specified device.
1508 After command completion any other commands that update the HPA configuration
1509 shall be command aborted.
1510 Frozen mode is disabled by power-off or hardware reset.
1513 Lock the HPA configuration of the device until a successful call to unlock or
1514 the next power-on reset occurs.
1517 Make the HPA max sectors persist across power-on reset or a hardware reset.
1518 This must be used in combination with
1519 .Fl s Ar max_sectors
1523 Set the HPA configuration password required for unlock calls.
1526 Be quiet, do not print any status messages.
1527 This option will not disable the questions.
1528 To disable questions, use the
1531 .It Fl s Ar max_sectors
1533 Configures the maximum user accessible sectors of the device.
1534 This will change the number of sectors the device reports.
1536 .Em WARNING! WARNING! WARNING!
1538 Changing the max sectors of a device using this option will make the data on
1539 the device beyond the specified value inaccessible.
1542 .Fl s Ar max_sectors
1543 call can be made without a power-on reset or a hardware reset of the device.
1546 Unlock the HPA configuration of the specified device using the given password.
1547 If the password specified does not match the password configured via
1549 the command will fail.
1551 After 5 failed unlock calls, due to password miss-match, the device will refuse
1552 additional unlock calls until after a power-on reset.
1555 Confirm yes to dangerous options such as
1557 without prompting for confirmation
1560 The password for all HPA commands is limited to 32 characters, longer passwords
1563 Program firmware of the named
1565 or ATA device using the image file provided.
1569 device and it provides a recommended timeout for the WRITE BUFFER command
1572 opcodes subcommand), that timeout will be used for the firmware download.
1573 The drive-recommended timeout value may be overridden on the command line
1578 Current list of supported vendors for SCSI/SAS drives:
1581 Tested with 4TB SAS drives, model number HUS724040ALS640.
1585 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1586 There is a separate table entry for hard drives, because the update method
1587 for hard drives is different than the method for tape drives.
1592 Tested with SM1625 SSDs.
1594 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1595 ES.3 (ST1000NM0023) drives.
1597 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1600 .Em WARNING! WARNING! WARNING!
1602 Little testing has been done to make sure that different device models from
1603 each vendor work correctly with the fwdownload command.
1604 A vendor name appearing in the supported list means only that firmware of at
1605 least one device type from that vendor has successfully been programmed with
1606 the fwdownload command.
1607 Extra caution should be taken when using this command since there is no
1608 guarantee it will not break a device from the listed vendors.
1609 Ensure that you have a recent backup of the data on the device before
1610 performing a firmware update.
1614 protocol devices will not be programmed, since there is little chance of
1615 the firmware download succeeding.
1618 will currently attempt a firmware download to any
1622 device, since the standard
1624 DOWNLOAD MICROCODE command may work.
1625 Firmware downloads to
1629 devices are supported for devices connected
1634 controllers, and devices connected to SAS controllers
1639 translation capability.
1645 PASS-THROUGH command to send the
1647 DOWNLOAD MICROCODE command to the drive.
1652 translation implementations don't work fully when translating
1654 WRITE BUFFER commands to
1656 DOWNLOAD MICROCODE commands, but do support
1658 passthrough well enough to do a firmware download.
1660 .It Fl f Ar fw_image
1661 Path to the firmware image file to be downloaded to the specified device.
1663 Do not print informational messages, only print errors.
1664 This option should be used with the
1666 option to suppress all output.
1668 Run in simulation mode.
1669 Device checks are run and the confirmation dialog is shown, but no firmware
1670 download will occur.
1676 errors in the event of a failure.
1678 In simulation mode, print out the
1683 register values that would be used for the firmware download command.
1685 Do not ask for confirmation.
1688 Persistent reservation support.
1689 Persistent reservations are a way to reserve a particular
1691 LUN for use by one or more
1696 option is specified,
1700 PERSISTENT RESERVE IN
1701 command using the requested service action.
1704 option is specified,
1708 PERSISTENT RESERVE OUT
1709 command using the requested service action.
1710 One of those two options is required.
1712 Persistent reservations are complex, and fully explaining them is outside
1713 the scope of this manual.
1716 and download the latest SPC spec for a full explanation of persistent
1720 Specify the service action for the PERSISTENT RESERVE IN command.
1721 Supported service actions:
1724 Report the current persistent reservation generation (PRgeneration) and any
1726 .It read_reservation
1727 Report the persistent reservation, if any.
1728 .It report_capabilities
1729 Report the persistent reservation capabilities of the LUN.
1730 .It read_full_status
1731 Report the full status of persistent reservations on the LUN.
1734 Specify the service action for the PERSISTENT RESERVE OUT command.
1735 For service actions like register that are components of other service
1736 action names, the entire name must be specified.
1737 Otherwise, enough of the service action name must be specified to
1738 distinguish it from other possible service actions.
1739 Supported service actions:
1742 Register a reservation key with the LUN or unregister a reservation key.
1743 To register a key, specify the requested key as the Service Action
1745 To unregister a key, specify the previously registered key as the
1747 To change a key, specify the old key as the Reservation Key and the new
1748 key as the Service Action Reservation Key.
1750 This is similar to the register subcommand, except that the Reservation Key
1752 The Service Action Reservation Key will overwrite any previous key
1753 registered for the initiator.
1755 Create a reservation.
1756 A key must be registered with the LUN before the LUN can be reserved, and
1757 it must be specified as the Reservation Key.
1758 The type of reservation must also be specified.
1759 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1761 Release a reservation.
1762 The Reservation Key must be specified.
1764 Release a reservation and remove all keys from the device.
1765 The Reservation Key must be specified.
1767 Remove a reservation belonging to another initiator.
1768 The Reservation Key must be specified.
1769 The Service Action Reservation Key may be specified, depending on the
1770 operation being performed.
1772 Remove a reservation belonging to another initiator and abort all
1773 outstanding commands from that initiator.
1774 The Reservation Key must be specified.
1775 The Service Action Reservation Key may be specified, depending on the
1776 operation being performed.
1778 Register another initiator with the LUN, and establish a reservation on the
1779 LUN for that initiator.
1780 The Reservation Key and Service Action Reservation Key must be specified.
1782 Replace Lost Reservation information.
1785 Set the All Target Ports (ALL_TG_PT) bit.
1786 This requests that the key registration be applied to all target ports and
1787 not just the particular target port that receives the command.
1788 This only applies to the register and register_ignore actions.
1790 Specify a Transport ID.
1791 This only applies to the Register and Register and Move service actions for
1792 Persistent Reserve Out.
1793 Multiple Transport IDs may be specified with multiple
1796 With the Register service action, specifying one or more Transport IDs
1797 implicitly enables the
1799 option which turns on the SPEC_I_PT bit.
1800 Transport IDs generally have the format protocol,id.
1803 A SAS Transport ID consists of
1805 followed by a 64-bit SAS address.
1808 .Dl sas,0x1234567812345678
1810 A Fibre Channel Transport ID consists of
1812 followed by a 64-bit Fibre Channel World Wide Name.
1815 .Dl fcp,0x1234567812345678
1817 A Parallel SCSI address consists of
1819 followed by a SCSI target ID and a relative target port identifier.
1824 An IEEE 1394 (Firewire) Transport ID consists of
1826 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1829 .Dl sbp,0x1234567812345678
1831 A SCSI over RDMA Transport ID consists of
1833 followed by a 128-bit RDMA initiator port identifier.
1834 The port identifier must be exactly 32 or 34 (if the leading 0x is
1835 included) hexadecimal digits.
1836 Only hexadecimal (base 16) numbers are supported.
1839 .Dl srp,0x12345678123456781234567812345678
1841 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1843 For example, if only the iSCSI name is specified:
1845 .Dl iqn.2012-06.com.example:target0
1847 If the iSCSI separator and initiator session ID are specified:
1849 .Dl iqn.2012-06.com.example:target0,i,0x123
1851 A SCSI over PCIe Transport ID consists of
1853 followed by a PCIe Routing ID.
1854 The Routing ID consists of a bus, device and function or in the alternate
1855 form, a bus and function.
1856 The bus must be in the range of 0 to 255 inclusive and the device must be
1857 in the range of 0 to 31 inclusive.
1858 The function must be in the range of 0 to 7 inclusive if the standard form
1859 is used, and in the range of 0 to 255 inclusive if the alternate form is
1861 For example, if a bus, device and function are specified for the standard
1866 If the alternate Routing ID form is used:
1871 Specify the Reservation Key.
1872 This may be in decimal, octal or hexadecimal format.
1873 The value is zero by default if not otherwise specified.
1874 The value must be between 0 and 2^64 - 1, inclusive.
1876 Specify the Service Action 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 Enable the Activate Persist Through Power Loss bit.
1882 This is only used for the register and register_ignore actions.
1883 This requests that the reservation persist across power loss events.
1885 Specify the scope of the reservation.
1886 The scope may be specified by name or by number.
1887 The scope is ignored for register, register_ignore and clear.
1888 If the desired scope isn't available by name, you may specify the number.
1892 This encompasses the entire LUN.
1894 Extent scope (0x01).
1896 Element scope (0x02).
1899 Specify the Relative Target Port.
1900 This only applies to the Register and Move service action of the Persistent
1901 Reserve Out command.
1903 Enable the SPEC_I_PT bit.
1904 This only applies to the Register service action of Persistent Reserve Out.
1905 You must also specify at least one Transport ID with
1907 if this option is set.
1908 If you specify a Transport ID, this option is automatically set.
1909 It is an error to specify this option for any service action other than
1912 Specify the reservation type.
1913 The reservation type may be specified by name or by number.
1914 If the desired reservation type isn't available by name, you may specify
1916 Supported reservation type names:
1921 Write Exclusive mode.
1922 May also be specified as
1923 .Dq write_exclusive .
1925 Read Exclusive mode.
1926 May also be specified as
1927 .Dq read_exclusive .
1929 Exclusive access mode.
1930 May also be specified as
1931 .Dq exclusive_access .
1933 Write Exclusive Registrants Only mode.
1934 May also be specified as
1935 .Dq write_exclusive_reg_only .
1937 Exclusive Access Registrants Only mode.
1938 May also be specified as
1939 .Dq exclusive_access_reg_only .
1941 Write Exclusive All Registrants mode.
1942 May also be specified as
1943 .Dq write_exclusive_all_regs .
1945 Exclusive Access All Registrants mode.
1946 May also be specified as
1947 .Dq exclusive_access_all_regs .
1950 Specify that the target should unregister the initiator that sent
1951 the Register and Move request.
1952 By default, the target will not unregister the initiator that sends the
1953 Register and Move request.
1954 This option only applies to the Register and Move service action of the
1955 Persistent Reserve Out command.
1960 READ or WRITE ATTRIBUTE commands.
1961 These commands are used to read and write attributes in Medium Auxiliary
1963 The most common place Medium Auxiliary Memory is found is small flash chips
1964 included tape cartriges.
1972 option must be specified.
1975 Specify the READ ATTRIBUTE service action.
1978 Issue the ATTRIBUTE VALUES service action.
1979 Read and decode the available attributes and their values.
1981 Issue the ATTRIBUTE LIST service action.
1982 List the attributes that are available to read and write.
1984 Issue the LOGICAL VOLUME LIST service action.
1985 List the available logical volumes in the MAM.
1987 Issue the PARTITION LIST service action.
1988 List the available partitions in the MAM.
1990 Issue the SUPPORTED ATTRIBUTES service action.
1991 List attributes that are supported for reading or writing.
1992 These attributes may or may not be currently present in the MAM.
1995 Specify an attribute to write to the MAM.
1996 This option is not yet implemented.
1998 Specify the attribute number to display.
1999 This option only works with the attr_values, attr_list and supp_attr
2003 Display cached attributes.
2004 If the device supports this flag, it allows displaying attributes for the
2005 last piece of media loaded in the drive.
2007 Specify the element address.
2008 This is used for specifying which element number in a medium changer to
2009 access when reading attributes.
2010 The element number could be for a picker, portal, slot or drive.
2011 .It Fl F Ar form1,form2
2012 Specify the output format for the attribute values (attr_val) display as a
2013 comma separated list of options.
2014 The default output is currently set to field_all,nonascii_trim,text_raw.
2015 Once this code is ported to FreeBSD 10, any text fields will be converted
2016 from their codeset to the user's native codeset with
2019 The text options are mutually exclusive; if you specify more than one, you
2020 will get unpredictable results.
2021 The nonascii options are also mutually exclusive.
2022 Most of the field options may be logically ORed together.
2025 Print text fields with non-ASCII characters escaped.
2027 Print text fields natively, with no codeset conversion.
2029 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2030 escape the non-ASCII characters.
2032 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2033 omit the non-ASCII characters.
2035 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2036 print them as they are.
2038 Print all of the prefix fields: description, attribute number, attribute
2039 size, and the attribute's readonly status.
2040 If field_all is specified, specifying any other field options will not have
2043 Print none of the prefix fields, and only print out the attribute value.
2044 If field_none is specified, specifying any other field options will result
2045 in those fields being printed.
2047 Print out the attribute description.
2049 Print out the attribute number.
2051 Print out the attribute size.
2053 Print out the attribute's readonly status.
2056 Specify the partition.
2057 When the media has multiple partitions, specifying different partition
2058 numbers allows seeing the values for each individual partition.
2059 .It Fl s Ar start_num
2060 Specify the starting attribute number.
2061 This requests that the target device return attribute information starting
2062 at the given number.
2063 .It Fl T Ar elem_type
2064 Specify the element type.
2065 For medium changer devices, this allows specifying the type the element
2066 referenced in the element address (
2076 Specify the number of the logical volume to operate on.
2077 If the media has multiple logical volumes, this will allow displaying
2078 or writing attributes on the given logical volume.
2081 Issue the REPORT SUPPORTED OPCODES service action of the
2085 Without arguments, this command will return a list of all
2087 commands supported by the device, including service actions of commands
2088 that support service actions.
2089 It will also include the
2091 CDB (Command Data Block) length for each command, and the description of
2092 each command if it is known.
2095 Request information on a specific opcode instead of the list of supported
2097 If supported, the target will return a CDB-like structure that indicates
2098 the opcode, service action (if any), and a mask of bits that are supported
2100 .It Fl s Ar service_action
2101 For commands that support a service action, specify the service action to
2104 If a service action is specified for a given opcode, and the device does
2105 not support the given service action, the device should not return a
2107 error, but rather indicate in the returned parameter data that the command
2109 By default, if a service action is specified for an opcode, and service
2110 actions are not supported for the opcode in question, the device will
2113 Include timeout values.
2114 This option works with the default display, which includes all commands
2115 supported by the device, and with the
2119 options, which request information on a specific command and service
2121 This requests that the device report Nominal and Recommended timeout values
2122 for the given command or commands.
2123 The timeout values are in seconds.
2124 The timeout descriptor also includes a command-specific
2131 Zoned Block devices.
2132 This allows managing devices that conform to the
2134 Zoned Block Commands (ZBC) and
2136 Zoned ATA Command Set (ZAC)
2138 Devices using these command sets are usually hard drives using Shingled
2139 Magnetic Recording (SMR).
2140 There are three types of SMR drives:
2143 Drive Managed drives look and act just like a standard random access block
2144 device, but underneath, the drive reads and writes the bulk of its capacity
2146 Sequential writes will yield better performance, but writing sequentially
2149 Host Aware drives expose the underlying zone layout via
2153 commands and allow the host to manage the zone conditions.
2154 The host is not required to manage the zones on the drive, though.
2155 Sequential writes will yield better performance in Sequential Write
2156 Preferred zones, but the host can write randomly in those zones.
2158 Host Managed drives expose the underlying zone layout via
2163 The host is required to access the zones according to the rules described
2165 Any commands that violate the rules will be returned with an error.
2168 SMR drives are divided into zones (typically in the range of 256MB each)
2169 that fall into three general categories:
2172 These are also known as Non Write Pointer zones.
2173 These zones can be randomly written without an unexpected performance penalty.
2174 .It Sequential Preferred
2175 These zones should be written sequentially starting at the write pointer
2177 They may be written randomly.
2178 Writes that do not conform to the zone layout may be significantly slower
2180 .It Sequential Required
2181 These zones must be written sequentially.
2182 If they are not written sequentially, starting at the write pointer, the
2188 Specify the zone subcommand:
2191 Issue the Report Zones command.
2192 All zones are returned by default.
2193 Specify report options with
2195 and printing options with
2197 Specify the starting LBA with
2201 is also accepted as a command argument.
2203 Explicitly open the zone specified by the starting LBA.
2205 Close the zone specified by starting LBA.
2207 Finish the zone specified by the starting LBA.
2209 Reset the write pointer for the zone specified by the starting LBA.
2212 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2213 operation to all zones on the drive.
2215 Specify the starting LBA.
2216 For the Report Zones command, this tells the drive to report starting with
2217 the zone that starts at the given LBA.
2218 For the other commands, this allows the user to identify the zone requested
2219 by its starting LBA.
2220 The LBA may be specified in decimal, hexadecimal or octal notation.
2222 For the Report Zones command, specify a subset of zones to report.
2226 This is the default.
2228 Report only empty zones.
2230 Report zones that are implicitly open.
2231 This means that the host has sent a write to the zone without explicitly
2234 Report zones that are explicitly open.
2236 Report zones that have been closed by the host.
2238 Report zones that are full.
2240 Report zones that are in the read only state.
2243 is also accepted as an argument.
2245 Report zones that are in the offline state.
2247 Report zones where the device recommends resetting write pointers.
2249 Report zones that have the Non Sequential Resources Active flag set.
2250 These are zones that are Sequential Write Preferred, but have been written
2253 Report Non Write Pointer zones, also known as Conventional zones.
2255 .It Fl P Ar print_opt
2256 Specify a printing option for Report Zones:
2259 Normal Report Zones output.
2260 This is the default.
2261 The summary and column headings are printed, fields are separated by spaces
2262 and the fields themselves may contain spaces.
2264 Just print the summary: the number of zones, the maximum LBA (LBA of the
2265 last logical block on the drive), and the value of the
2270 field describes whether the zones on the drive are all identical, all
2271 different, or whether they are the same except for the last zone, etc.
2273 Print the zones in a script friendly format.
2274 The summary and column headings are omitted, the fields are separated by
2275 commas, and the fields do not contain spaces.
2276 The fields contain underscores where spaces would normally be used.
2282 Extended Power Conditions (EPC) feature set commands.
2285 protocol drives, and will not work on
2294 translation layer (SAT).
2295 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2296 the Extended Power Conditions feature set, available at t13.org, to
2297 understand the details of this particular
2302 Specify the epc subcommand
2305 Restore drive power condition settings.
2308 Specify the source for the restored power settings, either
2312 This argument is required.
2315 This only makes sense to specify when restoring from defaults.
2318 Go to the specified power condition.
2321 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2322 This argument is required.
2324 Specify delayed entry to the power condition.
2325 The drive, if it supports this, can enter the power condition after the
2328 Hold the power condition.
2329 If the drive supports this option, it will hold the power condition and
2330 reject all commands that would normally cause it to exit that power
2334 Set the timer value for a power condition and enable or disable the
2338 display described below to see what the current timer settings are for each
2339 Idle and Standby mode supported by the drive.
2342 Enable the power condition.
2349 Disable the power condition.
2356 Specify the timer in seconds.
2357 The user may specify a timer as a floating point number with a maximum
2358 supported resolution of tenths of a second.
2359 Drives may or may not support sub-second timer values.
2361 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2362 This argument is required.
2364 Save the timer and power condition enable/disable state.
2365 By default, if this option is not specified, only the current values for
2366 this power condition will be affected.
2369 Enable or disable a particular power condition.
2372 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2373 This argument is required.
2375 Save the power condition enable/disable state.
2376 By default, if this option is not specified, only the current values for
2377 this power condition will be affected.
2380 Enable the Extended Power Condition (EPC) feature set.
2382 Disable the Extended Power Condition (EPC) feature set.
2384 Specify the EPC power source.
2387 Specify the power source, either
2393 Get the current status of several parameters related to the Extended Power
2394 Condition (EPC) feature set, including whether APM and EPC are supported
2395 and enabled, whether Low Power Standby is supported, whether setting the
2396 EPC power source is supported, whether Low Power Standby is supported and
2397 the current power condition.
2400 Only report the current power condition.
2401 Some drives will exit their current power condition if a command other than
2404 CHECK POWER MODE command is received.
2405 If this flag is specified,
2409 CHECK POWER MODE command to the drive.
2414 Power Conditions log (Log Address 0x08).
2415 This shows the list of Idle and Standby power conditions the drive
2416 supports, and a number of parameters about each condition, including
2417 whether it is enabled and what the timer value is.
2421 Print out verbose usage information.
2426 variable allows the user to specify an alternate mode page format file.
2430 variable determines which text editor
2432 starts when editing mode pages.
2434 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2435 .It Pa /usr/share/misc/scsi_modes
2436 is the SCSI mode format database.
2438 is the transport layer device.
2440 are the CAM application passthrough devices.
2443 .Dl camcontrol eject -n cd -u 1 -v
2445 Eject the CD from cd1, and print SCSI sense information if the command
2448 .Dl camcontrol tur da0
2450 Send the SCSI test unit ready command to da0.
2453 utility will report whether the disk is ready, but will not display sense
2454 information if the command fails since the
2456 switch was not specified.
2457 .Bd -literal -offset indent
2458 camcontrol tur da1 -E -C 4 -t 50 -v
2461 Send a test unit ready command to da1.
2462 Enable kernel error recovery.
2463 Specify a retry count of 4, and a timeout of 50 seconds.
2467 flag) if the command fails.
2468 Since error recovery is turned on, the
2469 disk will be spun up if it is not currently spinning.
2472 utility will report whether the disk is ready.
2473 .Bd -literal -offset indent
2474 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2475 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2478 Issue a READ BUFFER command (0x3C) to cd1.
2479 Display the buffer size of cd1,
2480 and display the first 10 bytes from the cache on cd1.
2482 information if the command fails.
2483 .Bd -literal -offset indent
2484 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2485 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2488 Issue a WRITE BUFFER (0x3B) command to cd1.
2489 Write out 10 bytes of data,
2490 not including the (reserved) 4 byte header.
2491 Print out sense information if
2493 Be very careful with this command, improper use may
2494 cause data corruption.
2495 .Bd -literal -offset indent
2496 camcontrol modepage da3 -m 1 -e -P 3
2499 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2500 settings on the drive.
2501 Mode page 1 contains a disk drive's auto read and
2502 write reallocation settings, among other things.
2504 .Dl camcontrol rescan all
2506 Rescan all SCSI busses in the system for devices that have been added,
2509 .Dl camcontrol rescan 0
2511 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2513 .Dl camcontrol rescan 0:1:0
2515 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2518 .Dl camcontrol tags da5 -N 24
2520 Set the number of concurrent transactions for da5 to 24.
2521 .Bd -literal -offset indent
2522 camcontrol negotiate -n da -u 4 -T disable
2525 Disable tagged queueing for da4.
2526 .Bd -literal -offset indent
2527 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2530 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2532 Test Unit Ready command to make the settings take effect.
2533 .Bd -literal -offset indent
2534 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2537 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2539 Display SMP errors if the command fails.
2540 .Bd -literal -offset indent
2541 camcontrol security ada0
2544 Report security support and settings for ada0
2545 .Bd -literal -offset indent
2546 camcontrol security ada0 -U user -s MyPass
2549 Enable security on device ada0 with the password MyPass
2550 .Bd -literal -offset indent
2551 camcontrol security ada0 -U user -e MyPass
2554 Secure erase ada0 which has had security enabled with user password MyPass
2556 .Em WARNING! WARNING! WARNING!
2560 data from the device, so backup your data before using!
2562 This command can be used against an SSD drive to restoring it to
2563 factory default write performance.
2564 .Bd -literal -offset indent
2568 Report HPA support and settings for ada0 (also reported via
2570 .Bd -literal -offset indent
2571 camcontrol hpa ada0 -s 10240
2574 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2576 .Em WARNING! WARNING! WARNING!
2580 to all data on the device beyond this limit until HPA is disabled by setting
2581 HPA to native max sectors of the device, which can only be done after a
2582 power-on or hardware reset!
2585 use this on a device which has an active filesystem!
2586 .Bd -literal -offset indent
2587 camcontrol persist da0 -v -i read_keys
2590 This will read any persistent reservation keys registered with da0, and
2591 display any errors encountered when sending the PERSISTENT RESERVE IN
2594 .Bd -literal -offset indent
2595 camcontrol persist da0 -v -o register -a -K 0x12345678
2598 This will register the persistent reservation key 0x12345678 with da0,
2599 apply that registration to all ports on da0, and display any errors that
2600 occur when sending the PERSISTENT RESERVE OUT command.
2601 .Bd -literal -offset indent
2602 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2605 This will reserve da0 for the exlusive use of the initiator issuing the
2607 The scope of the reservation is the entire LUN.
2608 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2609 .Bd -literal -offset indent
2610 camcontrol persist da0 -v -i read_full
2613 This will display the full status of all reservations on da0 and print out
2614 status if there are any errors.
2615 .Bd -literal -offset indent
2616 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2619 This will release a reservation on da0 of the type ex_ac
2621 The Reservation Key for this registration is 0x12345678.
2622 Any errors that occur will be displayed.
2623 .Bd -literal -offset indent
2624 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2625 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2628 This will register the key 0x12345678 with da0, specifying that it applies
2629 to the SAS initiators with SAS addresses 0x1234567812345678 and
2631 .Bd -literal -offset indent
2632 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2633 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2636 This will move the registration from the current initiator, whose
2637 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2638 Fiber Channel World Wide Node Name 0x1234567812345678.
2639 A new registration key, 0x12345678, will be registered for the initiator
2640 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2641 current initiator will be unregistered from the target.
2642 The reservation will be moved to relative target port 2 on the target
2644 The registration will persist across power losses.
2645 .Bd -literal -offset indent
2646 camcontrol attrib sa0 -v -i attr_values -p 1
2649 This will read and decode the attribute values from partition 1 on the tape
2650 in tape drive sa0, and will display any
2654 .Bd -literal -offset indent
2655 camcontrol zone da0 -v -c rz -P summary
2658 This will request the SMR zone list from disk da0, and print out a
2659 summary of the zone parameters, and display any
2665 .Bd -literal -offset indent
2666 camcontrol zone da0 -v -c rz -o reset
2669 This will request the list of SMR zones that should have their write
2670 pointer reset from the disk da0, and display any
2676 .Bd -literal -offset indent
2677 camcontrol zone da0 -v -c rwp -l 0x2c80000
2680 This will issue the Reset Write Pointer command to disk da0 for the zone
2681 that starts at LBA 0x2c80000 and display any
2687 .Bd -literal -offset indent
2688 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2691 Set the timer for the Idle_a power condition on drive
2693 to 60.1 seconds, enable that particular power condition, and save the timer
2694 value and the enabled state of the power condition.
2696 .Bd -literal -offset indent
2697 camcontrol epc da4 -c goto -p Standby_z -H
2702 to go to the Standby_z power state (which is
2703 the drive's lowest power state) and hold in that state until it is
2704 explicitly released by another
2708 .Bd -literal -offset indent
2709 camcontrol epc da2 -c status -P
2712 Report only the power state of
2715 Some drives will power up in response to the commands sent by the
2723 CHECK POWER MODE command, which should not trigger a change in the drive's
2726 .Bd -literal -offset indent
2727 camcontrol epc ada0 -c list
2730 Display the ATA Power Conditions log (Log Address 0x08) for
2735 .Xr cam_cdbparse 3 ,
2742 utility first appeared in
2745 The mode page editing code and arbitrary SCSI command code are based upon
2750 library, written by Julian Elischer and Peter Dufault.
2753 program first appeared in
2755 and first appeared in
2760 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2762 The code that parses the generic command line arguments does not know that
2763 some of the subcommands take multiple arguments.
2764 So if, for instance, you
2765 tried something like this:
2766 .Bd -literal -offset indent
2767 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2770 The sense information from the test unit ready command would not get
2771 printed out, since the first
2775 bails out when it sees the second argument to
2779 Fixing this behavior would take some gross code, or changes to the
2782 The best way to circumvent this problem is to always make sure
2785 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob