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[,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), or bus:target:lun
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 Tell the kernel to refresh the information about the device and
589 notify the upper layer,
591 This includes sending the SCSI READ CAPACITY command and updating
592 the disk size visible to the rest of the system.
594 Tell the kernel to reset all buses in the system (with the
596 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
597 reset for that bus, or to reset the given bus:target:lun
598 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
599 connecting to that device.
600 Note that this can have a destructive impact
605 READ DEFECT DATA (10) command (0x37) or the
607 READ DEFECT DATA (12) command (0xB7) to the given device, and
608 print out any combination of: the total number of defects, the primary
609 defect list (PLIST), and the grown defect list (GLIST).
612 Specify the requested format of the defect list.
613 The format argument is
615 Most drives support the physical sector format.
617 support the logical block format.
618 Many drives, if they do not support the
619 requested format, return the data in an alternate format, along with sense
620 information indicating that the requested data format is not supported.
624 attempts to detect this, and print out whatever format the drive returns.
625 If the drive uses a non-standard sense code to report that it does not
626 support the requested format,
628 will probably see the error as a failure to complete the request.
630 The format options are:
633 Print out the list as logical blocks.
634 This is limited to 32-bit block sizes, and isn't supported by many modern
637 Print out the list as logical blocks.
638 This option uses a 64-bit block size.
640 Print out the list in bytes from index format.
642 Print out the list in extended bytes from index format.
643 The extended format allows for ranges of blocks to be printed.
645 Print out the list in physical sector format.
646 Most drives support this format.
648 Print out the list in extended physical sector format.
649 The extended format allows for ranges of blocks to be printed.
652 Print out the grown defect list.
653 This is a list of bad blocks that have
654 been remapped since the disk left the factory.
656 Print out the primary defect list.
657 This is the list of defects that were present in the factory.
659 When printing status information with
661 only print the number of defects.
663 Just print the number of defects, not the list of defects.
665 Specify the starting offset into the defect list.
666 This implies using the
668 READ DEFECT DATA (12) command, as the 10 byte version of the command
669 doesn't support the address descriptor index field.
670 Not all drives support the 12 byte command, and some drives that support
671 the 12 byte command don't support the address descriptor index field.
673 Print out defects in hexadecimal (base 16) form instead of base 10 form.
682 will print out the number of defects given in the READ DEFECT DATA header
683 returned from the drive.
684 Some drives will report 0 defects if neither the primary or grown defect
687 Allows the user to display and optionally edit a SCSI mode page.
689 page formats are located in
690 .Pa /usr/share/misc/scsi_modes .
691 This can be overridden by specifying a different file in the
693 environment variable.
696 command takes several arguments:
699 Disable block descriptors for mode sense.
701 Displays mode page data in binary format.
703 This flag allows the user to edit values in the mode page.
705 either edit mode page values with the text editor pointed to by his
707 environment variable, or supply mode page values via standard input, using
710 uses to display mode page values.
711 The editor will be invoked if
713 detects that standard input is terminal.
715 Lists all available mode pages.
716 If specified more then once, also lists subpages.
717 .It Fl m Ar page[,subpage]
718 This specifies the number of the mode page and optionally subpage the user
719 would like to view and/or edit.
720 This argument is mandatory unless
724 This allows the user to specify the page control field.
726 .Bl -tag -width xxx -compact
738 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
741 function requires the
743 argument to specify SCSI CDB or the
745 argument to specify ATA Command Block registers values.
746 Other arguments are optional, depending on
748 The command and data specification syntax is documented
751 NOTE: If the CDB specified causes data to be transferred to or from the
752 SCSI device in question, you MUST specify either
757 .It Fl a Ar cmd Op args
758 This specifies the content of 12 ATA Command Block registers (command,
759 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
760 lba_high_exp, features_exp, sector_count, sector_count_exp).
761 .It Fl c Ar cmd Op args
762 This specifies the SCSI CDB.
763 SCSI CDBs may be 6, 10, 12 or 16 bytes.
765 Specifies DMA protocol to be used for ATA command.
767 Specifies FPDMA (NCQ) protocol to be used for ATA command.
768 .It Fl i Ar len Ar fmt
769 This specifies the amount of data to read, and how it should be displayed.
773 bytes of data will be read from the device and written to standard output.
774 .It Fl o Ar len Ar fmt Op args
775 This specifies the amount of data to be written to a device, and the data
776 that is to be written.
780 bytes of data will be read from standard input and written to the device.
782 This specifies that 11 result ATA Command Block registers should be displayed
783 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
784 lba_high_exp, sector_count, sector_count_exp), and how.
787 11 result registers will be written to standard output in hex.
790 Allows the user to send an arbitrary Serial
791 Management Protocol (SMP) command to a device.
794 function requires the
796 argument to specify the SMP request to be sent, and the
798 argument to specify the format of the SMP response.
799 The syntax for the SMP request and response arguments is documented in
802 Note that SAS adapters that support SMP passthrough (at least the currently
803 known adapters) do not accept CRC bytes from the user in the request and do
804 not pass CRC bytes back to the user in the response.
805 Therefore users should not include the CRC bytes in the length of the
806 request and not expect CRC bytes to be returned in the response.
808 .It Fl r Ar len Ar fmt Op args
809 This specifies the size of the SMP request, without the CRC bytes, and the
814 bytes of data will be read from standard input and written as the SMP
816 .It Fl R Ar len Ar fmt Op args
817 This specifies the size of the buffer allocated for the SMP response, and
818 the SMP response format.
822 bytes of data will be allocated for the response and the response will be
823 written to standard output.
826 Allows the user to send the Serial Management Protocol (SMP) Report General
829 will display the data returned by the Report General command.
830 If the SMP target supports the long response format, the additional data
831 will be requested and displayed automatically.
834 Request the long response format only.
835 Not all SMP targets support the long response format.
838 to skip sending the initial report general request without the long bit set
839 and only issue a report general request with the long bit set.
842 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
844 This function should be used with some caution, as it can render devices
845 inaccessible, and could potentially cause data corruption as well.
848 argument is required to specify the PHY to operate on.
851 Specify the PHY to operate on.
852 This argument is required.
854 Request the long request/response format.
855 Not all SMP targets support the long response format.
856 For the PHY Control command, this currently only affects whether the
857 request length is set to a value other than 0.
858 .It Fl o Ar operation
859 Specify a PHY control operation.
862 operation may be specified.
863 The operation may be specified numerically (in decimal, hexadecimal, or octal)
864 or one of the following operation names may be specified:
868 It is not necessary to specify this argument.
870 Send the LINK RESET command to the phy.
872 Send the HARD RESET command to the phy.
874 Send the DISABLE command to the phy.
875 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
877 Send the CLEAR ERROR LOG command.
878 This clears the error log counters for the specified phy.
880 Send the CLEAR AFFILIATION command.
881 This clears the affiliation from the STP initiator port with the same SAS
882 address as the SMP initiator that requests the clear operation.
884 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
885 This will cause a SATA port selector to use the given phy as its active phy
886 and make the other phy inactive.
888 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
890 Send the SET ATTACHED DEVICE NAME command to the PHY.
893 argument to specify the device name.
896 Specify the attached device name.
897 This option is needed with the
900 The name is a 64-bit number, and can be specified in decimal, hexadecimal
903 Set the minimum physical link rate for the phy.
904 This is a numeric argument.
905 Currently known link rates are:
908 Do not change current value.
917 Other values may be specified for newer physical link rates.
919 Set the maximum physical link rate for the phy.
920 This is a numeric argument.
923 argument description for known link rate arguments.
924 .It Fl T Ar pp_timeout
925 Set the partial pathway timeout value, in microseconds.
930 specification for more information on this field.
931 .It Fl a Ar enable|disable
932 Enable or disable SATA slumber phy power conditions.
933 .It Fl A Ar enable|disable
934 Enable or disable SATA partial power conditions.
935 .It Fl s Ar enable|disable
936 Enable or disable SAS slumber phy power conditions.
937 .It Fl S Ar enable|disable
938 Enable or disable SAS partial phy power conditions.
941 List phys attached to a SAS expander, the address of the end device
942 attached to the phy, and the inquiry data for that device and peripheral
943 devices attached to that device.
944 The inquiry data and peripheral devices are displayed if available.
947 Turn on the long response format for the underlying SMP commands used for
950 Only print out phys that are attached to a device in the CAM EDT (Existing
954 Send the SMP Report Manufacturer Information command to the device and
955 display the response.
958 Turn on the long response format for the underlying SMP commands used for
962 Turn on CAM debugging printfs in the kernel.
963 This requires options CAMDEBUG
964 in your kernel config file.
965 WARNING: enabling debugging printfs currently
966 causes an EXTREME number of kernel printfs.
967 You may have difficulty
968 turning off the debugging printfs once they start, since the kernel will be
969 busy printing messages and unable to service other requests quickly.
972 function takes a number of arguments:
975 Enable CAM_DEBUG_INFO printfs.
977 Enable CAM_DEBUG_PERIPH printfs.
979 Enable CAM_DEBUG_TRACE printfs.
981 Enable CAM_DEBUG_SUBTRACE printfs.
983 Enable CAM_DEBUG_XPT printfs.
985 Enable CAM_DEBUG_CDB printfs.
986 This will cause the kernel to print out the
987 SCSI CDBs sent to the specified device(s).
989 Enable CAM_DEBUG_PROBE printfs.
991 Enable debugging for all devices.
993 Turn off debugging for all devices
994 .It bus Ns Op :target Ns Op :lun
995 Turn on debugging for the given bus, target or lun.
997 and lun are not specified, they are wildcarded.
998 (i.e., just specifying a
999 bus turns on debugging printfs for all devices on that bus.)
1002 Show or set the number of "tagged openings" or simultaneous transactions
1003 we attempt to queue to a particular device.
1006 command, with no command-specific arguments (i.e., only generic arguments)
1007 prints out the "soft" maximum number of transactions that can be queued to
1008 the device in question.
1009 For more detailed information, use the
1011 argument described below.
1014 Set the number of tags for the given device.
1015 This must be between the
1016 minimum and maximum number set in the kernel quirk table.
1018 most devices that support tagged queueing is a minimum of 2 and a maximum
1020 The minimum and maximum values for a given device may be
1021 determined by using the
1028 subcommand is described below.
1030 Be quiet, and do not report the number of tags.
1031 This is generally used when
1032 setting the number of tags.
1034 The verbose flag has special functionality for the
1039 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1042 This is the amount of capacity for transactions queued to a given device.
1044 This is the number of transactions currently queued to a device.
1046 This is the kernel queue space for transactions.
1047 This count usually mirrors
1048 dev_openings except during error recovery operations when
1049 the device queue is frozen (device is not allowed to receive
1050 commands), the number of dev_openings is reduced, or transaction
1051 replay is occurring.
1053 This is the number of transactions waiting in the kernel queue for capacity
1055 This number is usually zero unless error recovery is in
1058 The held count is the number of CCBs held by peripheral drivers that have
1059 either just been completed or are about to be released to the transport
1060 layer for service by a device.
1061 Held CCBs reserve capacity on a given
1064 This is the current "hard" minimum number of transactions that can be
1065 queued to a device at once.
1068 value above cannot go below this number.
1069 The default value for
1071 is 2, although it may be set higher or lower for various devices.
1073 This is the "hard" maximum number of transactions that can be queued to a
1077 value cannot go above this number.
1078 The default value for
1080 is 255, although it may be set higher or lower for various devices.
1084 Show or negotiate various communication parameters.
1085 Some controllers may
1086 not support setting or changing some of these values.
1088 Adaptec 174x controllers do not support changing a device's sync rate or
1093 will not attempt to set the parameter if the controller indicates that it
1094 does not support setting the parameter.
1095 To find out what the controller
1103 command is described below.
1104 Also, some controller drivers do not support
1105 setting negotiation parameters, even if the underlying controller supports
1106 negotiation changes.
1107 Some controllers, such as the Advansys wide
1108 controllers, support enabling and disabling synchronous negotiation for
1109 a device, but do not support setting the synchronous negotiation rate.
1112 Attempt to make the negotiation settings take effect immediately by sending
1113 a Test Unit Ready command to the device.
1115 Show or set current negotiation settings.
1116 This is the default.
1117 .It Fl D Ar enable|disable
1118 Enable or disable disconnection.
1122 Set the command delay offset.
1124 Be quiet, do not print anything.
1125 This is generally useful when you want to
1126 set a parameter, but do not want any status information.
1127 .It Fl R Ar syncrate
1128 Change the synchronization rate for a device.
1129 The sync rate is a floating
1130 point value specified in MHz.
1133 is a legal value, as is
1135 .It Fl T Ar enable|disable
1136 Enable or disable tagged queueing for a device.
1138 Show or set user negotiation settings.
1139 The default is to show or set
1140 current negotiation settings.
1142 The verbose switch has special meaning for the
1147 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1149 .It Fl W Ar bus_width
1150 Specify the bus width to negotiate with a device.
1153 The only useful values to specify are 8, 16, and 32
1155 The controller must support the bus width in question in order for
1156 the setting to take effect.
1159 In general, sync rate and offset settings will not take effect for a
1160 device until a command has been sent to the device.
1163 switch above will automatically send a Test Unit Ready to the device so
1164 negotiation parameters will take effect.
1168 FORMAT UNIT command to the named device.
1170 .Em WARNING! WARNING! WARNING!
1172 Low level formatting a disk will destroy ALL data on the disk.
1174 extreme caution when issuing this command.
1175 Many users low-level format
1176 disks that do not really need to be low-level formatted.
1178 relatively few scenarios that call for low-level formatting a disk.
1180 low-level formatting a disk is to initialize the disk after changing
1181 its physical sector size.
1182 Another reason for low-level formatting a disk
1183 is to revive the disk if you are getting "medium format corrupted" errors
1184 from the disk in response to read and write requests.
1186 Some disks take longer than others to format.
1187 Users should specify a
1188 timeout long enough to allow the format to complete.
1190 timeout is 3 hours, which should be long enough for most disks.
1192 disks will complete a format operation in a very short period of time
1193 (on the order of 5 minutes or less).
1194 This is often because the drive
1195 does not really support the FORMAT UNIT command -- it just accepts the
1196 command, waits a few minutes and then returns it.
1200 subcommand takes several arguments that modify its default behavior.
1205 arguments can be useful for scripts.
1208 Be quiet, do not print any status messages.
1209 This option will not disable
1210 the questions, however.
1211 To disable questions, use the
1218 This will report status on a format that is already running on the drive.
1220 Issue a non-immediate format command.
1223 issues the FORMAT UNIT command with the immediate bit set.
1225 device to immediately return the format command, before the format has
1231 sense information from the device every second to determine how far along
1232 in the format process it is.
1235 argument is specified,
1237 will issue a non-immediate format command, and will be unable to print any
1238 information to let the user know what percentage of the disk has been
1241 Do not ask any questions.
1244 will ask the user if he/she really wants to format the disk in question,
1245 and also if the default format command timeout is acceptable.
1247 will not be asked about the timeout if a timeout is specified on the
1253 SANITIZE command to the named device.
1255 .Em WARNING! WARNING! WARNING!
1257 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1258 Recovery of the data is not possible.
1259 Use extreme caution when issuing this command.
1263 subcommand takes several arguments that modify its default behavior.
1268 arguments can be useful for scripts.
1270 .It Fl a Ar operation
1271 Specify the sanitize operation to perform.
1274 Perform an overwrite operation by writing a user supplied
1275 data pattern to the device one or more times.
1276 The pattern is given by the
1279 The number of times is given by the
1283 Perform a block erase operation.
1284 All the device's blocks are set to a vendor defined
1285 value, typically zero.
1287 Perform a cryptographic erase operation.
1288 The encryption keys are changed to prevent the decryption
1291 Exits a previously failed sanitize operation.
1292 A failed sanitize operation can only be exited if it was
1293 run in the unrestricted completion mode, as provided by the
1298 The number of passes when performing an
1301 Valid values are between 1 and 31.
1306 operation, the pattern is inverted between consecutive passes.
1308 Path to the file containing the pattern to use when
1312 The pattern is repeated as needed to fill each block.
1314 Be quiet, do not print any status messages.
1315 This option will not disable
1316 the questions, however.
1317 To disable questions, use the
1321 Perform the sanitize in the unrestricted completion mode.
1322 If the operation fails, it can later be exited with the
1329 This will report status on a sanitize that is already running on the drive.
1331 Issue a non-immediate sanitize command.
1334 issues the SANITIZE command with the immediate bit set.
1336 device to immediately return the sanitize command, before
1337 the sanitize has actually completed.
1342 sense information from the device every second to determine how far along
1343 in the sanitize process it is.
1346 argument is specified,
1348 will issue a non-immediate sanitize command, and will be unable to print any
1349 information to let the user know what percentage of the disk has been
1352 Do not ask any questions.
1355 will ask the user if he/she really wants to sanitize the disk in question,
1356 and also if the default sanitize command timeout is acceptable.
1358 will not be asked about the timeout if a timeout is specified on the
1362 Put ATA device into IDLE state.
1365 specifies automatic standby timer value in seconds.
1366 Value 0 disables timer.
1368 Put ATA device into STANDBY state.
1371 specifies automatic standby timer value in seconds.
1372 Value 0 disables timer.
1374 Put ATA device into SLEEP state.
1375 Note that the only way get device out of
1376 this state may be reset.
1378 It optional parameter
1380 specified, enables and sets advanced power management level, where
1381 1 -- minimum power, 127 -- maximum performance with standby,
1382 128 -- minimum power without standby, 254 -- maximum performance.
1383 If not specified -- APM is disabled.
1385 It optional parameter
1387 specified, enables and sets automatic acoustic management level, where
1388 1 -- minimum noise, 254 -- maximum performance.
1389 If not specified -- AAM is disabled.
1391 Update or report security settings, using an ATA identify command (0xec).
1394 will print out the security support and associated settings of the device.
1397 command takes several arguments:
1401 Disable device security using the given password for the selected user according
1402 to the devices configured security level.
1405 Erase the device using the given password for the selected user.
1407 .Em WARNING! WARNING! WARNING!
1409 Issuing a secure erase will
1411 user data on the device and may take several hours to complete.
1413 When this command is used against an SSD drive all its cells will be marked as
1414 empty, restoring it to factory default write performance.
1415 For SSD's this action
1416 usually takes just a few seconds.
1419 Freeze the security configuration of the specified device.
1421 After command completion any other commands that update the device lock mode
1422 shall be command aborted.
1423 Frozen mode is disabled by power-off or hardware reset.
1426 Enhanced erase the device using the given password for the selected user.
1428 .Em WARNING! WARNING! WARNING!
1430 Issuing an enhanced secure erase will
1432 user data on the device and may take several hours to complete.
1434 An enhanced erase writes predetermined data patterns to all user data areas,
1435 all previously written user data shall be overwritten, including sectors that
1436 are no longer in use due to reallocation.
1439 Unlock the device using the given password for the selected user according to
1440 the devices configured security level.
1441 .It Fl l Ar high|maximum
1443 Specifies which security level to set when issuing a
1446 The security level determines device behavior when the master
1447 password is used to unlock the device.
1448 When the security level is set to high
1449 the device requires the unlock command and the master password to unlock.
1450 When the security level is set to maximum the device requires a secure erase
1451 with the master password to unlock.
1453 This option must be used in conjunction with one of the security action commands.
1459 Be quiet, do not print any status messages.
1460 This option will not disable the questions, however.
1461 To disable questions, use the
1466 Password the device (enable security) using the given password for the selected
1468 This option can be combined with other options such as
1471 A master password may be set in a addition to the user password. The purpose of
1472 the master password is to allow an administrator to establish a password that
1473 is kept secret from the user, and which may be used to unlock the device if the
1474 user password is lost.
1477 Setting the master password does not enable device security.
1479 If the master password is set and the drive supports a Master Revision Code
1480 feature the Master Password Revision Code will be decremented.
1483 Overrides the default timeout, specified in seconds, used for both
1487 this is useful if your system has problems processing long timeouts correctly.
1489 Usually the timeout is calculated from the information stored on the drive if
1490 present, otherwise it defaults to 2 hours.
1491 .It Fl U Ar user|master
1493 Specifies which user to set / use for the running action command, valid values
1494 are user or master and defaults to master if not set.
1496 This option must be used in conjunction with one of the security action commands.
1502 Confirm yes to dangerous options such as
1504 without prompting for confirmation.
1507 If the password specified for any action commands does not match the configured
1508 password for the specified user the command will fail.
1510 The password in all cases is limited to 32 characters, longer passwords will
1513 Update or report Host Protected Area details.
1516 will print out the HPA support and associated settings of the device.
1519 command takes several optional arguments:
1523 Freeze the HPA configuration of the specified device.
1525 After command completion any other commands that update the HPA configuration
1526 shall be command aborted.
1527 Frozen mode is disabled by power-off or hardware reset.
1530 Lock the HPA configuration of the device until a successful call to unlock or
1531 the next power-on reset occurs.
1534 Make the HPA max sectors persist across power-on reset or a hardware reset.
1535 This must be used in combination with
1536 .Fl s Ar max_sectors
1540 Set the HPA configuration password required for unlock calls.
1543 Be quiet, do not print any status messages.
1544 This option will not disable the questions.
1545 To disable questions, use the
1548 .It Fl s Ar max_sectors
1550 Configures the maximum user accessible sectors of the device.
1551 This will change the number of sectors the device reports.
1553 .Em WARNING! WARNING! WARNING!
1555 Changing the max sectors of a device using this option will make the data on
1556 the device beyond the specified value inaccessible.
1559 .Fl s Ar max_sectors
1560 call can be made without a power-on reset or a hardware reset of the device.
1563 Unlock the HPA configuration of the specified device using the given password.
1564 If the password specified does not match the password configured via
1566 the command will fail.
1568 After 5 failed unlock calls, due to password miss-match, the device will refuse
1569 additional unlock calls until after a power-on reset.
1572 Confirm yes to dangerous options such as
1574 without prompting for confirmation
1577 The password for all HPA commands is limited to 32 characters, longer passwords
1580 Program firmware of the named
1582 or ATA device using the image file provided.
1586 device and it provides a recommended timeout for the WRITE BUFFER command
1589 opcodes subcommand), that timeout will be used for the firmware download.
1590 The drive-recommended timeout value may be overridden on the command line
1595 Current list of supported vendors for SCSI/SAS drives:
1598 Tested with 4TB SAS drives, model number HUS724040ALS640.
1602 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1603 There is a separate table entry for hard drives, because the update method
1604 for hard drives is different than the method for tape drives.
1609 Tested with SM1625 SSDs.
1611 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1612 ES.3 (ST1000NM0023) drives.
1614 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1617 .Em WARNING! WARNING! WARNING!
1619 Little testing has been done to make sure that different device models from
1620 each vendor work correctly with the fwdownload command.
1621 A vendor name appearing in the supported list means only that firmware of at
1622 least one device type from that vendor has successfully been programmed with
1623 the fwdownload command.
1624 Extra caution should be taken when using this command since there is no
1625 guarantee it will not break a device from the listed vendors.
1626 Ensure that you have a recent backup of the data on the device before
1627 performing a firmware update.
1631 protocol devices will not be programmed, since there is little chance of
1632 the firmware download succeeding.
1635 will currently attempt a firmware download to any
1639 device, since the standard
1641 DOWNLOAD MICROCODE command may work.
1642 Firmware downloads to
1646 devices are supported for devices connected
1651 controllers, and devices connected to SAS controllers
1656 translation capability.
1662 PASS-THROUGH command to send the
1664 DOWNLOAD MICROCODE command to the drive.
1669 translation implementations don't work fully when translating
1671 WRITE BUFFER commands to
1673 DOWNLOAD MICROCODE commands, but do support
1675 passthrough well enough to do a firmware download.
1677 .It Fl f Ar fw_image
1678 Path to the firmware image file to be downloaded to the specified device.
1680 Do not print informational messages, only print errors.
1681 This option should be used with the
1683 option to suppress all output.
1685 Run in simulation mode.
1686 Device checks are run and the confirmation dialog is shown, but no firmware
1687 download will occur.
1693 errors in the event of a failure.
1695 In simulation mode, print out the
1700 register values that would be used for the firmware download command.
1702 Do not ask for confirmation.
1705 Persistent reservation support.
1706 Persistent reservations are a way to reserve a particular
1708 LUN for use by one or more
1713 option is specified,
1717 PERSISTENT RESERVE IN
1718 command using the requested service action.
1721 option is specified,
1725 PERSISTENT RESERVE OUT
1726 command using the requested service action.
1727 One of those two options is required.
1729 Persistent reservations are complex, and fully explaining them is outside
1730 the scope of this manual.
1733 and download the latest SPC spec for a full explanation of persistent
1737 Specify the service action for the PERSISTENT RESERVE IN command.
1738 Supported service actions:
1741 Report the current persistent reservation generation (PRgeneration) and any
1743 .It read_reservation
1744 Report the persistent reservation, if any.
1745 .It report_capabilities
1746 Report the persistent reservation capabilities of the LUN.
1747 .It read_full_status
1748 Report the full status of persistent reservations on the LUN.
1751 Specify the service action for the PERSISTENT RESERVE OUT command.
1752 For service actions like register that are components of other service
1753 action names, the entire name must be specified.
1754 Otherwise, enough of the service action name must be specified to
1755 distinguish it from other possible service actions.
1756 Supported service actions:
1759 Register a reservation key with the LUN or unregister a reservation key.
1760 To register a key, specify the requested key as the Service Action
1762 To unregister a key, specify the previously registered key as the
1764 To change a key, specify the old key as the Reservation Key and the new
1765 key as the Service Action Reservation Key.
1767 This is similar to the register subcommand, except that the Reservation Key
1769 The Service Action Reservation Key will overwrite any previous key
1770 registered for the initiator.
1772 Create a reservation.
1773 A key must be registered with the LUN before the LUN can be reserved, and
1774 it must be specified as the Reservation Key.
1775 The type of reservation must also be specified.
1776 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1778 Release a reservation.
1779 The Reservation Key must be specified.
1781 Release a reservation and remove all keys from the device.
1782 The Reservation Key must be specified.
1784 Remove a reservation belonging to another initiator.
1785 The Reservation Key must be specified.
1786 The Service Action Reservation Key may be specified, depending on the
1787 operation being performed.
1789 Remove a reservation belonging to another initiator and abort all
1790 outstanding commands from that initiator.
1791 The Reservation Key must be specified.
1792 The Service Action Reservation Key may be specified, depending on the
1793 operation being performed.
1795 Register another initiator with the LUN, and establish a reservation on the
1796 LUN for that initiator.
1797 The Reservation Key and Service Action Reservation Key must be specified.
1799 Replace Lost Reservation information.
1802 Set the All Target Ports (ALL_TG_PT) bit.
1803 This requests that the key registration be applied to all target ports and
1804 not just the particular target port that receives the command.
1805 This only applies to the register and register_ignore actions.
1807 Specify a Transport ID.
1808 This only applies to the Register and Register and Move service actions for
1809 Persistent Reserve Out.
1810 Multiple Transport IDs may be specified with multiple
1813 With the Register service action, specifying one or more Transport IDs
1814 implicitly enables the
1816 option which turns on the SPEC_I_PT bit.
1817 Transport IDs generally have the format protocol,id.
1820 A SAS Transport ID consists of
1822 followed by a 64-bit SAS address.
1825 .Dl sas,0x1234567812345678
1827 A Fibre Channel Transport ID consists of
1829 followed by a 64-bit Fibre Channel World Wide Name.
1832 .Dl fcp,0x1234567812345678
1834 A Parallel SCSI address consists of
1836 followed by a SCSI target ID and a relative target port identifier.
1841 An IEEE 1394 (Firewire) Transport ID consists of
1843 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1846 .Dl sbp,0x1234567812345678
1848 A SCSI over RDMA Transport ID consists of
1850 followed by a 128-bit RDMA initiator port identifier.
1851 The port identifier must be exactly 32 or 34 (if the leading 0x is
1852 included) hexadecimal digits.
1853 Only hexadecimal (base 16) numbers are supported.
1856 .Dl srp,0x12345678123456781234567812345678
1858 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1860 For example, if only the iSCSI name is specified:
1862 .Dl iqn.2012-06.com.example:target0
1864 If the iSCSI separator and initiator session ID are specified:
1866 .Dl iqn.2012-06.com.example:target0,i,0x123
1868 A SCSI over PCIe Transport ID consists of
1870 followed by a PCIe Routing ID.
1871 The Routing ID consists of a bus, device and function or in the alternate
1872 form, a bus and function.
1873 The bus must be in the range of 0 to 255 inclusive and the device must be
1874 in the range of 0 to 31 inclusive.
1875 The function must be in the range of 0 to 7 inclusive if the standard form
1876 is used, and in the range of 0 to 255 inclusive if the alternate form is
1878 For example, if a bus, device and function are specified for the standard
1883 If the alternate Routing ID form is used:
1888 Specify the Reservation Key.
1889 This may be in decimal, octal or hexadecimal format.
1890 The value is zero by default if not otherwise specified.
1891 The value must be between 0 and 2^64 - 1, inclusive.
1893 Specify the Service Action Reservation Key.
1894 This may be in decimal, octal or hexadecimal format.
1895 The value is zero by default if not otherwise specified.
1896 The value must be between 0 and 2^64 - 1, inclusive.
1898 Enable the Activate Persist Through Power Loss bit.
1899 This is only used for the register and register_ignore actions.
1900 This requests that the reservation persist across power loss events.
1902 Specify the scope of the reservation.
1903 The scope may be specified by name or by number.
1904 The scope is ignored for register, register_ignore and clear.
1905 If the desired scope isn't available by name, you may specify the number.
1909 This encompasses the entire LUN.
1911 Extent scope (0x01).
1913 Element scope (0x02).
1916 Specify the Relative Target Port.
1917 This only applies to the Register and Move service action of the Persistent
1918 Reserve Out command.
1920 Enable the SPEC_I_PT bit.
1921 This only applies to the Register service action of Persistent Reserve Out.
1922 You must also specify at least one Transport ID with
1924 if this option is set.
1925 If you specify a Transport ID, this option is automatically set.
1926 It is an error to specify this option for any service action other than
1929 Specify the reservation type.
1930 The reservation type may be specified by name or by number.
1931 If the desired reservation type isn't available by name, you may specify
1933 Supported reservation type names:
1938 Write Exclusive mode.
1939 May also be specified as
1940 .Dq write_exclusive .
1942 Read Exclusive mode.
1943 May also be specified as
1944 .Dq read_exclusive .
1946 Exclusive access mode.
1947 May also be specified as
1948 .Dq exclusive_access .
1950 Write Exclusive Registrants Only mode.
1951 May also be specified as
1952 .Dq write_exclusive_reg_only .
1954 Exclusive Access Registrants Only mode.
1955 May also be specified as
1956 .Dq exclusive_access_reg_only .
1958 Write Exclusive All Registrants mode.
1959 May also be specified as
1960 .Dq write_exclusive_all_regs .
1962 Exclusive Access All Registrants mode.
1963 May also be specified as
1964 .Dq exclusive_access_all_regs .
1967 Specify that the target should unregister the initiator that sent
1968 the Register and Move request.
1969 By default, the target will not unregister the initiator that sends the
1970 Register and Move request.
1971 This option only applies to the Register and Move service action of the
1972 Persistent Reserve Out command.
1977 READ or WRITE ATTRIBUTE commands.
1978 These commands are used to read and write attributes in Medium Auxiliary
1980 The most common place Medium Auxiliary Memory is found is small flash chips
1981 included tape cartriges.
1989 option must be specified.
1992 Specify the READ ATTRIBUTE service action.
1995 Issue the ATTRIBUTE VALUES service action.
1996 Read and decode the available attributes and their values.
1998 Issue the ATTRIBUTE LIST service action.
1999 List the attributes that are available to read and write.
2001 Issue the LOGICAL VOLUME LIST service action.
2002 List the available logical volumes in the MAM.
2004 Issue the PARTITION LIST service action.
2005 List the available partitions in the MAM.
2007 Issue the SUPPORTED ATTRIBUTES service action.
2008 List attributes that are supported for reading or writing.
2009 These attributes may or may not be currently present in the MAM.
2012 Specify an attribute to write to the MAM.
2013 This option is not yet implemented.
2015 Specify the attribute number to display.
2016 This option only works with the attr_values, attr_list and supp_attr
2020 Display cached attributes.
2021 If the device supports this flag, it allows displaying attributes for the
2022 last piece of media loaded in the drive.
2024 Specify the element address.
2025 This is used for specifying which element number in a medium changer to
2026 access when reading attributes.
2027 The element number could be for a picker, portal, slot or drive.
2028 .It Fl F Ar form1,form2
2029 Specify the output format for the attribute values (attr_val) display as a
2030 comma separated list of options.
2031 The default output is currently set to field_all,nonascii_trim,text_raw.
2032 Once this code is ported to FreeBSD 10, any text fields will be converted
2033 from their codeset to the user's native codeset with
2036 The text options are mutually exclusive; if you specify more than one, you
2037 will get unpredictable results.
2038 The nonascii options are also mutually exclusive.
2039 Most of the field options may be logically ORed together.
2042 Print text fields with non-ASCII characters escaped.
2044 Print text fields natively, with no codeset conversion.
2046 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2047 escape the non-ASCII characters.
2049 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2050 omit the non-ASCII characters.
2052 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2053 print them as they are.
2055 Print all of the prefix fields: description, attribute number, attribute
2056 size, and the attribute's readonly status.
2057 If field_all is specified, specifying any other field options will not have
2060 Print none of the prefix fields, and only print out the attribute value.
2061 If field_none is specified, specifying any other field options will result
2062 in those fields being printed.
2064 Print out the attribute description.
2066 Print out the attribute number.
2068 Print out the attribute size.
2070 Print out the attribute's readonly status.
2073 Specify the partition.
2074 When the media has multiple partitions, specifying different partition
2075 numbers allows seeing the values for each individual partition.
2076 .It Fl s Ar start_num
2077 Specify the starting attribute number.
2078 This requests that the target device return attribute information starting
2079 at the given number.
2080 .It Fl T Ar elem_type
2081 Specify the element type.
2082 For medium changer devices, this allows specifying the type the element
2083 referenced in the element address (
2093 Specify the number of the logical volume to operate on.
2094 If the media has multiple logical volumes, this will allow displaying
2095 or writing attributes on the given logical volume.
2098 Issue the REPORT SUPPORTED OPCODES service action of the
2102 Without arguments, this command will return a list of all
2104 commands supported by the device, including service actions of commands
2105 that support service actions.
2106 It will also include the
2108 CDB (Command Data Block) length for each command, and the description of
2109 each command if it is known.
2112 Request information on a specific opcode instead of the list of supported
2114 If supported, the target will return a CDB-like structure that indicates
2115 the opcode, service action (if any), and a mask of bits that are supported
2117 .It Fl s Ar service_action
2118 For commands that support a service action, specify the service action to
2121 If a service action is specified for a given opcode, and the device does
2122 not support the given service action, the device should not return a
2124 error, but rather indicate in the returned parameter data that the command
2126 By default, if a service action is specified for an opcode, and service
2127 actions are not supported for the opcode in question, the device will
2130 Include timeout values.
2131 This option works with the default display, which includes all commands
2132 supported by the device, and with the
2136 options, which request information on a specific command and service
2138 This requests that the device report Nominal and Recommended timeout values
2139 for the given command or commands.
2140 The timeout values are in seconds.
2141 The timeout descriptor also includes a command-specific
2148 Zoned Block devices.
2149 This allows managing devices that conform to the
2151 Zoned Block Commands (ZBC) and
2153 Zoned ATA Command Set (ZAC)
2155 Devices using these command sets are usually hard drives using Shingled
2156 Magnetic Recording (SMR).
2157 There are three types of SMR drives:
2160 Drive Managed drives look and act just like a standard random access block
2161 device, but underneath, the drive reads and writes the bulk of its capacity
2163 Sequential writes will yield better performance, but writing sequentially
2166 Host Aware drives expose the underlying zone layout via
2170 commands and allow the host to manage the zone conditions.
2171 The host is not required to manage the zones on the drive, though.
2172 Sequential writes will yield better performance in Sequential Write
2173 Preferred zones, but the host can write randomly in those zones.
2175 Host Managed drives expose the underlying zone layout via
2180 The host is required to access the zones according to the rules described
2182 Any commands that violate the rules will be returned with an error.
2185 SMR drives are divided into zones (typically in the range of 256MB each)
2186 that fall into three general categories:
2189 These are also known as Non Write Pointer zones.
2190 These zones can be randomly written without an unexpected performance penalty.
2191 .It Sequential Preferred
2192 These zones should be written sequentially starting at the write pointer
2194 They may be written randomly.
2195 Writes that do not conform to the zone layout may be significantly slower
2197 .It Sequential Required
2198 These zones must be written sequentially.
2199 If they are not written sequentially, starting at the write pointer, the
2205 Specify the zone subcommand:
2208 Issue the Report Zones command.
2209 All zones are returned by default.
2210 Specify report options with
2212 and printing options with
2214 Specify the starting LBA with
2218 is also accepted as a command argument.
2220 Explicitly open the zone specified by the starting LBA.
2222 Close the zone specified by starting LBA.
2224 Finish the zone specified by the starting LBA.
2226 Reset the write pointer for the zone specified by the starting LBA.
2229 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2230 operation to all zones on the drive.
2232 Specify the starting LBA.
2233 For the Report Zones command, this tells the drive to report starting with
2234 the zone that starts at the given LBA.
2235 For the other commands, this allows the user to identify the zone requested
2236 by its starting LBA.
2237 The LBA may be specified in decimal, hexadecimal or octal notation.
2239 For the Report Zones command, specify a subset of zones to report.
2243 This is the default.
2245 Report only empty zones.
2247 Report zones that are implicitly open.
2248 This means that the host has sent a write to the zone without explicitly
2251 Report zones that are explicitly open.
2253 Report zones that have been closed by the host.
2255 Report zones that are full.
2257 Report zones that are in the read only state.
2260 is also accepted as an argument.
2262 Report zones that are in the offline state.
2264 Report zones where the device recommends resetting write pointers.
2266 Report zones that have the Non Sequential Resources Active flag set.
2267 These are zones that are Sequential Write Preferred, but have been written
2270 Report Non Write Pointer zones, also known as Conventional zones.
2272 .It Fl P Ar print_opt
2273 Specify a printing option for Report Zones:
2276 Normal Report Zones output.
2277 This is the default.
2278 The summary and column headings are printed, fields are separated by spaces
2279 and the fields themselves may contain spaces.
2281 Just print the summary: the number of zones, the maximum LBA (LBA of the
2282 last logical block on the drive), and the value of the
2287 field describes whether the zones on the drive are all identical, all
2288 different, or whether they are the same except for the last zone, etc.
2290 Print the zones in a script friendly format.
2291 The summary and column headings are omitted, the fields are separated by
2292 commas, and the fields do not contain spaces.
2293 The fields contain underscores where spaces would normally be used.
2299 Extended Power Conditions (EPC) feature set commands.
2302 protocol drives, and will not work on
2311 translation layer (SAT).
2312 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2313 the Extended Power Conditions feature set, available at t13.org, to
2314 understand the details of this particular
2319 Specify the epc subcommand
2322 Restore drive power condition settings.
2325 Specify the source for the restored power settings, either
2329 This argument is required.
2332 This only makes sense to specify when restoring from defaults.
2335 Go to the specified power condition.
2338 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2339 This argument is required.
2341 Specify delayed entry to the power condition.
2342 The drive, if it supports this, can enter the power condition after the
2345 Hold the power condition.
2346 If the drive supports this option, it will hold the power condition and
2347 reject all commands that would normally cause it to exit that power
2351 Set the timer value for a power condition and enable or disable the
2355 display described below to see what the current timer settings are for each
2356 Idle and Standby mode supported by the drive.
2359 Enable the power condition.
2366 Disable the power condition.
2373 Specify the timer in seconds.
2374 The user may specify a timer as a floating point number with a maximum
2375 supported resolution of tenths of a second.
2376 Drives may or may not support sub-second timer values.
2378 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2379 This argument is required.
2381 Save the timer and power condition enable/disable state.
2382 By default, if this option is not specified, only the current values for
2383 this power condition will be affected.
2386 Enable or disable a particular power condition.
2389 Enable the power condition.
2396 Disable the power condition.
2403 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2404 This argument is required.
2406 Save the power condition enable/disable state.
2407 By default, if this option is not specified, only the current values for
2408 this power condition will be affected.
2411 Enable the Extended Power Condition (EPC) feature set.
2413 Disable the Extended Power Condition (EPC) feature set.
2415 Specify the EPC power source.
2418 Specify the power source, either
2424 Get the current status of several parameters related to the Extended Power
2425 Condition (EPC) feature set, including whether APM and EPC are supported
2426 and enabled, whether Low Power Standby is supported, whether setting the
2427 EPC power source is supported, whether Low Power Standby is supported and
2428 the current power condition.
2431 Only report the current power condition.
2432 Some drives will exit their current power condition if a command other than
2435 CHECK POWER MODE command is received.
2436 If this flag is specified,
2440 CHECK POWER MODE command to the drive.
2445 Power Conditions log (Log Address 0x08).
2446 This shows the list of Idle and Standby power conditions the drive
2447 supports, and a number of parameters about each condition, including
2448 whether it is enabled and what the timer value is.
2452 Issue REPORT TIMESTAMP or SET TIMESTAMP
2454 commands. Either the
2458 option must be specified.
2461 Report the device's timestamp.
2462 If no more arguments are specified, the timestamp will be reported using
2463 the national representation of the date and time, followed by the time
2467 Specify the strftime format string, as documented in strftime(3), to be used
2468 to format the reported timestamp.
2470 Report the timestamp as milliseconds since the epoch.
2472 Report the timestamp using the national representation of the date and
2473 time, but override the system time zone and use UTC instead.
2478 Set the device's timestamp. Either the
2484 option must be specified.
2487 Specify the strptime format string, as documented in strptime(3).
2488 The time must also be specified with the
2492 Provide the time in the format specified with the
2496 Set the timestamp to the host system's time in UTC.
2500 Print out verbose usage information.
2505 variable allows the user to specify an alternate mode page format file.
2509 variable determines which text editor
2511 starts when editing mode pages.
2513 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2514 .It Pa /usr/share/misc/scsi_modes
2515 is the SCSI mode format database.
2517 is the transport layer device.
2519 are the CAM application passthrough devices.
2522 .Dl camcontrol eject -n cd -u 1 -v
2524 Eject the CD from cd1, and print SCSI sense information if the command
2527 .Dl camcontrol tur da0
2529 Send the SCSI test unit ready command to da0.
2532 utility will report whether the disk is ready, but will not display sense
2533 information if the command fails since the
2535 switch was not specified.
2536 .Bd -literal -offset indent
2537 camcontrol tur da1 -E -C 4 -t 50 -Q head -v
2540 Send a test unit ready command to da1.
2541 Enable kernel error recovery.
2542 Specify a retry count of 4, and a timeout of 50 seconds.
2546 flag) if the command fails.
2547 Since error recovery is turned on, the
2548 disk will be spun up if it is not currently spinning.
2551 task attribute for the command will be set to Head of Queue.
2554 utility will report whether the disk is ready.
2555 .Bd -literal -offset indent
2556 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2557 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2560 Issue a READ BUFFER command (0x3C) to cd1.
2561 Display the buffer size of cd1,
2562 and display the first 10 bytes from the cache on cd1.
2564 information if the command fails.
2565 .Bd -literal -offset indent
2566 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2567 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2570 Issue a WRITE BUFFER (0x3B) command to cd1.
2571 Write out 10 bytes of data,
2572 not including the (reserved) 4 byte header.
2573 Print out sense information if
2575 Be very careful with this command, improper use may
2576 cause data corruption.
2577 .Bd -literal -offset indent
2578 camcontrol modepage da3 -m 1 -e -P 3
2581 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2582 settings on the drive.
2583 Mode page 1 contains a disk drive's auto read and
2584 write reallocation settings, among other things.
2586 .Dl camcontrol rescan all
2588 Rescan all SCSI buses in the system for devices that have been added,
2591 .Dl camcontrol rescan 0
2593 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2595 .Dl camcontrol rescan 0:1:0
2597 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2600 .Dl camcontrol tags da5 -N 24
2602 Set the number of concurrent transactions for da5 to 24.
2603 .Bd -literal -offset indent
2604 camcontrol negotiate -n da -u 4 -T disable
2607 Disable tagged queueing for da4.
2608 .Bd -literal -offset indent
2609 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2612 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2614 Test Unit Ready command to make the settings take effect.
2615 .Bd -literal -offset indent
2616 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2619 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2621 Display SMP errors if the command fails.
2622 .Bd -literal -offset indent
2623 camcontrol security ada0
2626 Report security support and settings for ada0
2627 .Bd -literal -offset indent
2628 camcontrol security ada0 -U user -s MyPass
2631 Enable security on device ada0 with the password MyPass
2632 .Bd -literal -offset indent
2633 camcontrol security ada0 -U user -e MyPass
2636 Secure erase ada0 which has had security enabled with user password MyPass
2638 .Em WARNING! WARNING! WARNING!
2642 data from the device, so backup your data before using!
2644 This command can be used against an SSD drive to restoring it to
2645 factory default write performance.
2646 .Bd -literal -offset indent
2650 Report HPA support and settings for ada0 (also reported via
2652 .Bd -literal -offset indent
2653 camcontrol hpa ada0 -s 10240
2656 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2658 .Em WARNING! WARNING! WARNING!
2662 to all data on the device beyond this limit until HPA is disabled by setting
2663 HPA to native max sectors of the device, which can only be done after a
2664 power-on or hardware reset!
2667 use this on a device which has an active filesystem!
2668 .Bd -literal -offset indent
2669 camcontrol persist da0 -v -i read_keys
2672 This will read any persistent reservation keys registered with da0, and
2673 display any errors encountered when sending the PERSISTENT RESERVE IN
2676 .Bd -literal -offset indent
2677 camcontrol persist da0 -v -o register -a -K 0x12345678
2680 This will register the persistent reservation key 0x12345678 with da0,
2681 apply that registration to all ports on da0, and display any errors that
2682 occur when sending the PERSISTENT RESERVE OUT command.
2683 .Bd -literal -offset indent
2684 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2687 This will reserve da0 for the exlusive use of the initiator issuing the
2689 The scope of the reservation is the entire LUN.
2690 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2691 .Bd -literal -offset indent
2692 camcontrol persist da0 -v -i read_full
2695 This will display the full status of all reservations on da0 and print out
2696 status if there are any errors.
2697 .Bd -literal -offset indent
2698 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2701 This will release a reservation on da0 of the type ex_ac
2703 The Reservation Key for this registration is 0x12345678.
2704 Any errors that occur will be displayed.
2705 .Bd -literal -offset indent
2706 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2707 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2710 This will register the key 0x12345678 with da0, specifying that it applies
2711 to the SAS initiators with SAS addresses 0x1234567812345678 and
2713 .Bd -literal -offset indent
2714 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2715 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2718 This will move the registration from the current initiator, whose
2719 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2720 Fiber Channel World Wide Node Name 0x1234567812345678.
2721 A new registration key, 0x12345678, will be registered for the initiator
2722 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2723 current initiator will be unregistered from the target.
2724 The reservation will be moved to relative target port 2 on the target
2726 The registration will persist across power losses.
2727 .Bd -literal -offset indent
2728 camcontrol attrib sa0 -v -i attr_values -p 1
2731 This will read and decode the attribute values from partition 1 on the tape
2732 in tape drive sa0, and will display any
2736 .Bd -literal -offset indent
2737 camcontrol zone da0 -v -c rz -P summary
2740 This will request the SMR zone list from disk da0, and print out a
2741 summary of the zone parameters, and display any
2747 .Bd -literal -offset indent
2748 camcontrol zone da0 -v -c rz -o reset
2751 This will request the list of SMR zones that should have their write
2752 pointer reset from the disk da0, and display any
2758 .Bd -literal -offset indent
2759 camcontrol zone da0 -v -c rwp -l 0x2c80000
2762 This will issue the Reset Write Pointer command to disk da0 for the zone
2763 that starts at LBA 0x2c80000 and display any
2769 .Bd -literal -offset indent
2770 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2773 Set the timer for the Idle_a power condition on drive
2775 to 60.1 seconds, enable that particular power condition, and save the timer
2776 value and the enabled state of the power condition.
2778 .Bd -literal -offset indent
2779 camcontrol epc da4 -c goto -p Standby_z -H
2784 to go to the Standby_z power state (which is
2785 the drive's lowest power state) and hold in that state until it is
2786 explicitly released by another
2790 .Bd -literal -offset indent
2791 camcontrol epc da2 -c status -P
2794 Report only the power state of
2797 Some drives will power up in response to the commands sent by the
2805 CHECK POWER MODE command, which should not trigger a change in the drive's
2808 .Bd -literal -offset indent
2809 camcontrol epc ada0 -c list
2812 Display the ATA Power Conditions log (Log Address 0x08) for
2816 .Bd -literal -offset indent
2817 camcontrol timestamp sa0 -s -f "%A %c" \e
2818 -T "Wednesday Wed Oct 26 21:43:57 2016"
2821 Set the timestamp of drive
2825 format string followed by a time string
2826 that was created using this format string.
2829 .Xr cam_cdbparse 3 ,
2836 utility first appeared in
2839 The mode page editing code and arbitrary SCSI command code are based upon
2844 library, written by Julian Elischer and Peter Dufault.
2847 program first appeared in
2849 and first appeared in
2854 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2856 The code that parses the generic command line arguments does not know that
2857 some of the subcommands take multiple arguments.
2858 So if, for instance, you
2859 tried something like this:
2860 .Bd -literal -offset indent
2861 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2864 The sense information from the test unit ready command would not get
2865 printed out, since the first
2869 bails out when it sees the second argument to
2873 Fixing this behavior would take some gross code, or changes to the
2876 The best way to circumvent this problem is to always make sure
2879 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob