2 .\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006, 2007 Kenneth D. Merry.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. The name of the author may not be used to endorse or promote products
14 .\" derived from this software without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd CAM control program
50 .Op Fl u Ar unit_number
73 .Op Fl r Ar reporttype
106 .Aq all | device id | bus Ns Op :target:lun
109 .Aq all | device id | bus Ns Op :target:lun
125 .Aq Fl m Ar page[,subpage] | Fl l
133 .Aq Fl a Ar cmd Op args
134 .Aq Fl c Ar cmd Op args
137 .Op Fl i Ar len Ar fmt
139 .Op Fl o Ar len Ar fmt Op args
146 .Aq Fl r Ar len Ar fmt Op args
147 .Aq Fl R Ar len Ar fmt Op args
159 .Op Fl o Ar operation
163 .Op Fl T Ar pp_timeout
164 .Op Fl a Ar enable|disable
165 .Op Fl A Ar enable|disable
166 .Op Fl s Ar enable|disable
167 .Op Fl S Ar enable|disable
188 .Aq all|off|bus Ns Op :target Ns Op :lun
201 .Op Fl D Ar enable|disable
206 .Op Fl T Ar enable|disable
208 .Op Fl W Ar bus_width
222 .Aq Fl a Ar overwrite | block | crypto | exitfailure
276 .Op Fl l Ar high|maximum
280 .Op Fl U Ar user|master
291 .Op Fl s Ar max_sectors
298 .Aq Fl i Ar action | Fl o Ar action
304 .Op Fl R Ar rel_tgt_port
313 .Aq Fl r Ar action | Fl w Ar attrib
316 .Op Fl e Ar elem_addr
317 .Op Fl F Ar form1,form2
319 .Op Fl s Ar start_addr
320 .Op Fl T Ar elem_type
327 .Op Fl s Ar service_action
336 .Op Fl P Ar print_opts
344 .Op Fl p Ar power_cond
346 .Op Fl r Ar restore_src
348 .Op Fl S Ar power_src
354 .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
360 utility is designed to provide a way for users to access and control the
367 can cause a loss of data and/or system crashes if used improperly.
369 expert users are encouraged to exercise caution when using this command.
370 Novice users should stay away from this utility.
374 utility has a number of primary functions, many of which support an optional
376 A device identifier can take one of three forms:
379 Specify a device name and unit number combination, like "da5" or "cd3".
381 Specify a bus number and target id.
382 The bus number can be determined from
384 .Dq camcontrol devlist .
385 The lun defaults to 0.
387 Specify the bus, target and lun for a device.
391 The device identifier, if it is specified,
393 come immediately after the function name, and before any generic or
394 function-specific arguments.
399 arguments described below will override any device name or unit number
400 specified beforehand.
407 override a specified bus:target or bus:target:lun, however.
411 primary functions support these generic arguments:
414 SCSI command retry count.
415 In order for this to work, error recovery
419 Instruct the kernel to perform generic SCSI error recovery for the given
421 This is needed in order for the retry count
424 Other than retrying commands, the generic error recovery in
425 the code will generally attempt to spin up drives that are not spinning.
426 It may take some other actions, depending upon the sense code returned from
429 Specify the device type to operate on, e.g.\& "da", "cd".
430 .It Fl Q Ar task_attr
432 task attribute for the command, if it is a
435 This may be ordered, simple, head, or aca.
436 In most cases this is not needed.
437 The default is simple, which works with all
440 The task attribute may also be specified numerically.
442 SCSI command timeout in seconds.
443 This overrides the default timeout for
445 .It Fl u Ar unit_number
446 Specify the device unit number, e.g.\& "1", "5".
448 Be verbose, print out sense information for failed SCSI commands.
451 Primary command functions:
452 .Bl -tag -width periphlist
454 List all physical devices (logical units) attached to the CAM subsystem.
455 This also includes a list of peripheral drivers attached to each device.
458 argument, SCSI bus number, adapter name and unit numbers are printed as
460 On the other hand, with the
462 argument, only the bus adapter, and unit information will be printed, and
463 device information will be omitted.
465 List all peripheral drivers attached to a given physical device (logical
468 Send the SCSI test unit ready (0x00) command to the given device.
471 utility will report whether the device is ready or not.
473 Send a SCSI inquiry command (0x12) to a device.
476 will print out the standard inquiry data, device serial number, and
477 transfer rate information.
478 The user can specify that only certain types of
479 inquiry data be printed:
482 Get the standard inquiry data.
484 Print out the serial number.
485 If this flag is the only one specified,
487 will not print out "Serial Number" before the value returned by the drive.
488 This is to aid in script writing.
490 Print out transfer rate information.
493 Send a ATA identify command (0xec) to a device.
495 Send the SCSI REPORT LUNS (0xA0) command to the given device.
498 will print out the list of logical units (LUNs) supported by the target device.
499 There are a couple of options to modify the output:
502 Just print out a count of LUNs, not the actual LUN numbers.
504 Just print out the LUNs, and do not print out the count.
505 .It Fl r Ar reporttype
506 Specify the type of report to request from the target:
507 .Bl -tag -width 012345678
509 Return the default report.
513 Most targets will support this report if they support the REPORT LUNS
516 Return only well known LUNs.
518 Return all available LUNs.
523 will try to print out LUN numbers in a reasonable format.
524 It can understand the peripheral, flat, LUN and extended LUN formats.
526 Send the SCSI READ CAPACITY command to the given device and display
528 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
529 action will be sent to obtain the full size of the device.
532 will print out the last logical block of the device, and the blocksize of
534 To modify the output format, use the following options:
537 Just print out the blocksize, not the last block or device size.
538 This cannot be used with
543 Print out the device size in human readable (base 2, 1K == 1024) format.
546 and cannot be used with
551 Print out the device size in human readable (base 10, 1K == 1000) format.
553 Skip sending the SCSI READ CAPACITY (10) command.
554 Send only the SCSI READ CAPACITY (16) service action and report
556 When the two do not match, a quirk is needed to resolve the ambiguity.
558 Print out the number of blocks in the device instead of the last logical
561 Quiet, print out the numbers only (separated by a comma if
567 Print out the last logical block or the size of the device only, and omit
571 Note that this command only displays the information, it does not update
572 the kernel data structures.
575 reprobe subcommand to do that.
577 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
580 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
583 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
584 start bit set and the load/eject bit set.
586 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
587 start bit cleared and the load/eject bit set.
589 Tell the kernel to scan all buses in the system (with the
591 argument), the given bus (XPT_SCAN_BUS), bus:target:lun or device
592 (XPT_SCAN_LUN) for new devices or devices that have gone away.
594 may specify a scan of all buses, a single bus, or a lun.
596 on a target is not supported.
598 If a device is specified by peripheral name and unit number, for instance
599 da4, it may only be rescanned if that device currently exists in the CAM EDT
600 (Existing Device Table).
601 If the device is no longer there (see
604 you must use the bus:target:lun form to rescan it.
606 Tell the kernel to refresh the information about the device and
607 notify the upper layer,
609 This includes sending the SCSI READ CAPACITY command and updating
610 the disk size visible to the rest of the system.
612 Tell the kernel to reset all buses in the system (with the
614 argument), the given bus (XPT_RESET_BUS) by issuing a SCSI bus
615 reset for that bus, or to reset the given bus:target:lun or device
616 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
617 connecting to that device.
618 Note that this can have a destructive impact
623 READ DEFECT DATA (10) command (0x37) or the
625 READ DEFECT DATA (12) command (0xB7) to the given device, and
626 print out any combination of: the total number of defects, the primary
627 defect list (PLIST), and the grown defect list (GLIST).
630 Specify the requested format of the defect list.
631 The format argument is
633 Most drives support the physical sector format.
635 support the logical block format.
636 Many drives, if they do not support the
637 requested format, return the data in an alternate format, along with sense
638 information indicating that the requested data format is not supported.
642 attempts to detect this, and print out whatever format the drive returns.
643 If the drive uses a non-standard sense code to report that it does not
644 support the requested format,
646 will probably see the error as a failure to complete the request.
648 The format options are:
651 Print out the list as logical blocks.
652 This is limited to 32-bit block sizes, and isn't supported by many modern
655 Print out the list as logical blocks.
656 This option uses a 64-bit block size.
658 Print out the list in bytes from index format.
660 Print out the list in extended bytes from index format.
661 The extended format allows for ranges of blocks to be printed.
663 Print out the list in physical sector format.
664 Most drives support this format.
666 Print out the list in extended physical sector format.
667 The extended format allows for ranges of blocks to be printed.
670 Print out the grown defect list.
671 This is a list of bad blocks that have
672 been remapped since the disk left the factory.
674 Print out the primary defect list.
675 This is the list of defects that were present in the factory.
677 When printing status information with
679 only print the number of defects.
681 Just print the number of defects, not the list of defects.
683 Specify the starting offset into the defect list.
684 This implies using the
686 READ DEFECT DATA (12) command, as the 10 byte version of the command
687 doesn't support the address descriptor index field.
688 Not all drives support the 12 byte command, and some drives that support
689 the 12 byte command don't support the address descriptor index field.
691 Print out defects in hexadecimal (base 16) form instead of base 10 form.
700 will print out the number of defects given in the READ DEFECT DATA header
701 returned from the drive.
702 Some drives will report 0 defects if neither the primary or grown defect
705 Allows the user to display and optionally edit a SCSI mode page.
707 page formats are located in
708 .Pa /usr/share/misc/scsi_modes .
709 This can be overridden by specifying a different file in the
711 environment variable.
714 command takes several arguments:
717 Disable block descriptors for mode sense.
719 Displays mode page data in binary format.
721 This flag allows the user to edit values in the mode page.
723 either edit mode page values with the text editor pointed to by his
725 environment variable, or supply mode page values via standard input, using
728 uses to display mode page values.
729 The editor will be invoked if
731 detects that standard input is terminal.
733 Lists all available mode pages.
734 If specified more then once, also lists subpages.
735 .It Fl m Ar page[,subpage]
736 This specifies the number of the mode page and optionally subpage the user
737 would like to view and/or edit.
738 This argument is mandatory unless
742 This allows the user to specify the page control field.
744 .Bl -tag -width xxx -compact
756 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
759 function requires the
761 argument to specify SCSI CDB or the
763 argument to specify ATA Command Block registers values.
764 Other arguments are optional, depending on
766 The command and data specification syntax is documented
769 NOTE: If the CDB specified causes data to be transferred to or from the
770 SCSI device in question, you MUST specify either
775 .It Fl a Ar cmd Op args
776 This specifies the content of 12 ATA Command Block registers (command,
777 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
778 lba_high_exp, features_exp, sector_count, sector_count_exp).
779 .It Fl c Ar cmd Op args
780 This specifies the SCSI CDB.
781 SCSI CDBs may be 6, 10, 12 or 16 bytes.
783 Specifies DMA protocol to be used for ATA command.
785 Specifies FPDMA (NCQ) protocol to be used for ATA command.
786 .It Fl i Ar len Ar fmt
787 This specifies the amount of data to read, and how it should be displayed.
791 bytes of data will be read from the device and written to standard output.
792 .It Fl o Ar len Ar fmt Op args
793 This specifies the amount of data to be written to a device, and the data
794 that is to be written.
798 bytes of data will be read from standard input and written to the device.
800 This specifies that 11 result ATA Command Block registers should be displayed
801 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
802 lba_high_exp, sector_count, sector_count_exp), and how.
805 11 result registers will be written to standard output in hex.
808 Allows the user to send an arbitrary Serial
809 Management Protocol (SMP) command to a device.
812 function requires the
814 argument to specify the SMP request to be sent, and the
816 argument to specify the format of the SMP response.
817 The syntax for the SMP request and response arguments is documented in
820 Note that SAS adapters that support SMP passthrough (at least the currently
821 known adapters) do not accept CRC bytes from the user in the request and do
822 not pass CRC bytes back to the user in the response.
823 Therefore users should not include the CRC bytes in the length of the
824 request and not expect CRC bytes to be returned in the response.
826 .It Fl r Ar len Ar fmt Op args
827 This specifies the size of the SMP request, without the CRC bytes, and the
832 bytes of data will be read from standard input and written as the SMP
834 .It Fl R Ar len Ar fmt Op args
835 This specifies the size of the buffer allocated for the SMP response, and
836 the SMP response format.
840 bytes of data will be allocated for the response and the response will be
841 written to standard output.
844 Allows the user to send the Serial Management Protocol (SMP) Report General
847 will display the data returned by the Report General command.
848 If the SMP target supports the long response format, the additional data
849 will be requested and displayed automatically.
852 Request the long response format only.
853 Not all SMP targets support the long response format.
856 to skip sending the initial report general request without the long bit set
857 and only issue a report general request with the long bit set.
860 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
862 This function should be used with some caution, as it can render devices
863 inaccessible, and could potentially cause data corruption as well.
866 argument is required to specify the PHY to operate on.
869 Specify the PHY to operate on.
870 This argument is required.
872 Request the long request/response format.
873 Not all SMP targets support the long response format.
874 For the PHY Control command, this currently only affects whether the
875 request length is set to a value other than 0.
876 .It Fl o Ar operation
877 Specify a PHY control operation.
880 operation may be specified.
881 The operation may be specified numerically (in decimal, hexadecimal, or octal)
882 or one of the following operation names may be specified:
886 It is not necessary to specify this argument.
888 Send the LINK RESET command to the phy.
890 Send the HARD RESET command to the phy.
892 Send the DISABLE command to the phy.
893 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
895 Send the CLEAR ERROR LOG command.
896 This clears the error log counters for the specified phy.
898 Send the CLEAR AFFILIATION command.
899 This clears the affiliation from the STP initiator port with the same SAS
900 address as the SMP initiator that requests the clear operation.
902 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
903 This will cause a SATA port selector to use the given phy as its active phy
904 and make the other phy inactive.
906 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
908 Send the SET ATTACHED DEVICE NAME command to the PHY.
911 argument to specify the device name.
914 Specify the attached device name.
915 This option is needed with the
918 The name is a 64-bit number, and can be specified in decimal, hexadecimal
921 Set the minimum physical link rate for the phy.
922 This is a numeric argument.
923 Currently known link rates are:
926 Do not change current value.
935 Other values may be specified for newer physical link rates.
937 Set the maximum physical link rate for the phy.
938 This is a numeric argument.
941 argument description for known link rate arguments.
942 .It Fl T Ar pp_timeout
943 Set the partial pathway timeout value, in microseconds.
948 specification for more information on this field.
949 .It Fl a Ar enable|disable
950 Enable or disable SATA slumber phy power conditions.
951 .It Fl A Ar enable|disable
952 Enable or disable SATA partial power conditions.
953 .It Fl s Ar enable|disable
954 Enable or disable SAS slumber phy power conditions.
955 .It Fl S Ar enable|disable
956 Enable or disable SAS partial phy power conditions.
959 List phys attached to a SAS expander, the address of the end device
960 attached to the phy, and the inquiry data for that device and peripheral
961 devices attached to that device.
962 The inquiry data and peripheral devices are displayed if available.
965 Turn on the long response format for the underlying SMP commands used for
968 Only print out phys that are attached to a device in the CAM EDT (Existing
972 Send the SMP Report Manufacturer Information command to the device and
973 display the response.
976 Turn on the long response format for the underlying SMP commands used for
980 Turn on CAM debugging printfs in the kernel.
981 This requires options CAMDEBUG
982 in your kernel config file.
983 WARNING: enabling debugging printfs currently
984 causes an EXTREME number of kernel printfs.
985 You may have difficulty
986 turning off the debugging printfs once they start, since the kernel will be
987 busy printing messages and unable to service other requests quickly.
990 function takes a number of arguments:
993 Enable CAM_DEBUG_INFO printfs.
995 Enable CAM_DEBUG_PERIPH printfs.
997 Enable CAM_DEBUG_TRACE printfs.
999 Enable CAM_DEBUG_SUBTRACE printfs.
1001 Enable CAM_DEBUG_XPT printfs.
1003 Enable CAM_DEBUG_CDB printfs.
1004 This will cause the kernel to print out the
1005 SCSI CDBs sent to the specified device(s).
1007 Enable CAM_DEBUG_PROBE printfs.
1009 Enable debugging for all devices.
1011 Turn off debugging for all devices
1012 .It bus Ns Op :target Ns Op :lun
1013 Turn on debugging for the given bus, target or lun.
1014 If the lun or target
1015 and lun are not specified, they are wildcarded.
1016 (i.e., just specifying a
1017 bus turns on debugging printfs for all devices on that bus.)
1020 Show or set the number of "tagged openings" or simultaneous transactions
1021 we attempt to queue to a particular device.
1024 command, with no command-specific arguments (i.e., only generic arguments)
1025 prints out the "soft" maximum number of transactions that can be queued to
1026 the device in question.
1027 For more detailed information, use the
1029 argument described below.
1032 Set the number of tags for the given device.
1033 This must be between the
1034 minimum and maximum number set in the kernel quirk table.
1036 most devices that support tagged queueing is a minimum of 2 and a maximum
1038 The minimum and maximum values for a given device may be
1039 determined by using the
1046 subcommand is described below.
1048 Be quiet, and do not report the number of tags.
1049 This is generally used when
1050 setting the number of tags.
1052 The verbose flag has special functionality for the
1057 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1060 This is the amount of capacity for transactions queued to a given device.
1062 This is the number of transactions currently queued to a device.
1064 This is the kernel queue space for transactions.
1065 This count usually mirrors
1066 dev_openings except during error recovery operations when
1067 the device queue is frozen (device is not allowed to receive
1068 commands), the number of dev_openings is reduced, or transaction
1069 replay is occurring.
1071 This is the number of transactions waiting in the kernel queue for capacity
1073 This number is usually zero unless error recovery is in
1076 The held count is the number of CCBs held by peripheral drivers that have
1077 either just been completed or are about to be released to the transport
1078 layer for service by a device.
1079 Held CCBs reserve capacity on a given
1082 This is the current "hard" minimum number of transactions that can be
1083 queued to a device at once.
1086 value above cannot go below this number.
1087 The default value for
1089 is 2, although it may be set higher or lower for various devices.
1091 This is the "hard" maximum number of transactions that can be queued to a
1095 value cannot go above this number.
1096 The default value for
1098 is 255, although it may be set higher or lower for various devices.
1102 Show or negotiate various communication parameters.
1103 Some controllers may
1104 not support setting or changing some of these values.
1106 Adaptec 174x controllers do not support changing a device's sync rate or
1111 will not attempt to set the parameter if the controller indicates that it
1112 does not support setting the parameter.
1113 To find out what the controller
1121 command is described below.
1122 Also, some controller drivers do not support
1123 setting negotiation parameters, even if the underlying controller supports
1124 negotiation changes.
1125 Some controllers, such as the Advansys wide
1126 controllers, support enabling and disabling synchronous negotiation for
1127 a device, but do not support setting the synchronous negotiation rate.
1130 Attempt to make the negotiation settings take effect immediately by sending
1131 a Test Unit Ready command to the device.
1133 Show or set current negotiation settings.
1134 This is the default.
1135 .It Fl D Ar enable|disable
1136 Enable or disable disconnection.
1140 Set the command delay offset.
1142 Be quiet, do not print anything.
1143 This is generally useful when you want to
1144 set a parameter, but do not want any status information.
1145 .It Fl R Ar syncrate
1146 Change the synchronization rate for a device.
1147 The sync rate is a floating
1148 point value specified in MHz.
1151 is a legal value, as is
1153 .It Fl T Ar enable|disable
1154 Enable or disable tagged queueing for a device.
1156 Show or set user negotiation settings.
1157 The default is to show or set
1158 current negotiation settings.
1160 The verbose switch has special meaning for the
1165 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1167 .It Fl W Ar bus_width
1168 Specify the bus width to negotiate with a device.
1171 The only useful values to specify are 8, 16, and 32
1173 The controller must support the bus width in question in order for
1174 the setting to take effect.
1177 In general, sync rate and offset settings will not take effect for a
1178 device until a command has been sent to the device.
1181 switch above will automatically send a Test Unit Ready to the device so
1182 negotiation parameters will take effect.
1186 FORMAT UNIT command to the named device.
1188 .Em WARNING! WARNING! WARNING!
1190 Low level formatting a disk will destroy ALL data on the disk.
1192 extreme caution when issuing this command.
1193 Many users low-level format
1194 disks that do not really need to be low-level formatted.
1196 relatively few scenarios that call for low-level formatting a disk.
1198 low-level formatting a disk is to initialize the disk after changing
1199 its physical sector size.
1200 Another reason for low-level formatting a disk
1201 is to revive the disk if you are getting "medium format corrupted" errors
1202 from the disk in response to read and write requests.
1204 Some disks take longer than others to format.
1205 Users should specify a
1206 timeout long enough to allow the format to complete.
1208 timeout is 3 hours, which should be long enough for most disks.
1210 disks will complete a format operation in a very short period of time
1211 (on the order of 5 minutes or less).
1212 This is often because the drive
1213 does not really support the FORMAT UNIT command -- it just accepts the
1214 command, waits a few minutes and then returns it.
1218 subcommand takes several arguments that modify its default behavior.
1223 arguments can be useful for scripts.
1226 Be quiet, do not print any status messages.
1227 This option will not disable
1228 the questions, however.
1229 To disable questions, use the
1236 This will report status on a format that is already running on the drive.
1238 Issue a non-immediate format command.
1241 issues the FORMAT UNIT command with the immediate bit set.
1243 device to immediately return the format command, before the format has
1249 sense information from the device every second to determine how far along
1250 in the format process it is.
1253 argument is specified,
1255 will issue a non-immediate format command, and will be unable to print any
1256 information to let the user know what percentage of the disk has been
1259 Do not ask any questions.
1262 will ask the user if he/she really wants to format the disk in question,
1263 and also if the default format command timeout is acceptable.
1265 will not be asked about the timeout if a timeout is specified on the
1271 SANITIZE command to the named device.
1273 .Em WARNING! WARNING! WARNING!
1275 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1276 Recovery of the data is not possible.
1277 Use extreme caution when issuing this command.
1281 subcommand takes several arguments that modify its default behavior.
1286 arguments can be useful for scripts.
1288 .It Fl a Ar operation
1289 Specify the sanitize operation to perform.
1292 Perform an overwrite operation by writing a user supplied
1293 data pattern to the device one or more times.
1294 The pattern is given by the
1297 The number of times is given by the
1301 Perform a block erase operation.
1302 All the device's blocks are set to a vendor defined
1303 value, typically zero.
1305 Perform a cryptographic erase operation.
1306 The encryption keys are changed to prevent the decryption
1309 Exits a previously failed sanitize operation.
1310 A failed sanitize operation can only be exited if it was
1311 run in the unrestricted completion mode, as provided by the
1316 The number of passes when performing an
1319 Valid values are between 1 and 31.
1324 operation, the pattern is inverted between consecutive passes.
1326 Path to the file containing the pattern to use when
1330 The pattern is repeated as needed to fill each block.
1332 Be quiet, do not print any status messages.
1333 This option will not disable
1334 the questions, however.
1335 To disable questions, use the
1339 Perform the sanitize in the unrestricted completion mode.
1340 If the operation fails, it can later be exited with the
1347 This will report status on a sanitize that is already running on the drive.
1349 Issue a non-immediate sanitize command.
1352 issues the SANITIZE command with the immediate bit set.
1354 device to immediately return the sanitize command, before
1355 the sanitize has actually completed.
1360 sense information from the device every second to determine how far along
1361 in the sanitize process it is.
1364 argument is specified,
1366 will issue a non-immediate sanitize command, and will be unable to print any
1367 information to let the user know what percentage of the disk has been
1370 Do not ask any questions.
1373 will ask the user if he/she really wants to sanitize the disk in question,
1374 and also if the default sanitize command timeout is acceptable.
1376 will not be asked about the timeout if a timeout is specified on the
1380 Put ATA device into IDLE state.
1383 specifies automatic standby timer value in seconds.
1384 Value 0 disables timer.
1386 Put ATA device into STANDBY state.
1389 specifies automatic standby timer value in seconds.
1390 Value 0 disables timer.
1392 Put ATA device into SLEEP state.
1393 Note that the only way get device out of
1394 this state may be reset.
1396 Report ATA device power mode.
1398 It optional parameter
1400 specified, enables and sets advanced power management level, where
1401 1 -- minimum power, 127 -- maximum performance with standby,
1402 128 -- minimum power without standby, 254 -- maximum performance.
1403 If not specified -- APM is disabled.
1405 It optional parameter
1407 specified, enables and sets automatic acoustic management level, where
1408 1 -- minimum noise, 254 -- maximum performance.
1409 If not specified -- AAM is disabled.
1411 Update or report security settings, using an ATA identify command (0xec).
1414 will print out the security support and associated settings of the device.
1417 command takes several arguments:
1421 Disable device security using the given password for the selected user according
1422 to the devices configured security level.
1425 Erase the device using the given password for the selected user.
1427 .Em WARNING! WARNING! WARNING!
1429 Issuing a secure erase will
1431 user data on the device and may take several hours to complete.
1433 When this command is used against an SSD drive all its cells will be marked as
1434 empty, restoring it to factory default write performance.
1435 For SSD's this action
1436 usually takes just a few seconds.
1439 Freeze the security configuration of the specified device.
1441 After command completion any other commands that update the device lock mode
1442 shall be command aborted.
1443 Frozen mode is disabled by power-off or hardware reset.
1446 Enhanced erase the device using the given password for the selected user.
1448 .Em WARNING! WARNING! WARNING!
1450 Issuing an enhanced secure erase will
1452 user data on the device and may take several hours to complete.
1454 An enhanced erase writes predetermined data patterns to all user data areas,
1455 all previously written user data shall be overwritten, including sectors that
1456 are no longer in use due to reallocation.
1459 Unlock the device using the given password for the selected user according to
1460 the devices configured security level.
1461 .It Fl l Ar high|maximum
1463 Specifies which security level to set when issuing a
1466 The security level determines device behavior when the master
1467 password is used to unlock the device.
1468 When the security level is set to high
1469 the device requires the unlock command and the master password to unlock.
1470 When the security level is set to maximum the device requires a secure erase
1471 with the master password to unlock.
1473 This option must be used in conjunction with one of the security action commands.
1479 Be quiet, do not print any status messages.
1480 This option will not disable the questions, however.
1481 To disable questions, use the
1486 Password the device (enable security) using the given password for the selected
1488 This option can be combined with other options such as
1491 A master password may be set in a addition to the user password. The purpose of
1492 the master password is to allow an administrator to establish a password that
1493 is kept secret from the user, and which may be used to unlock the device if the
1494 user password is lost.
1497 Setting the master password does not enable device security.
1499 If the master password is set and the drive supports a Master Revision Code
1500 feature the Master Password Revision Code will be decremented.
1503 Overrides the default timeout, specified in seconds, used for both
1507 this is useful if your system has problems processing long timeouts correctly.
1509 Usually the timeout is calculated from the information stored on the drive if
1510 present, otherwise it defaults to 2 hours.
1511 .It Fl U Ar user|master
1513 Specifies which user to set / use for the running action command, valid values
1514 are user or master and defaults to master if not set.
1516 This option must be used in conjunction with one of the security action commands.
1522 Confirm yes to dangerous options such as
1524 without prompting for confirmation.
1527 If the password specified for any action commands does not match the configured
1528 password for the specified user the command will fail.
1530 The password in all cases is limited to 32 characters, longer passwords will
1533 Update or report Host Protected Area details.
1536 will print out the HPA support and associated settings of the device.
1539 command takes several optional arguments:
1543 Freeze the HPA configuration of the specified device.
1545 After command completion any other commands that update the HPA configuration
1546 shall be command aborted.
1547 Frozen mode is disabled by power-off or hardware reset.
1550 Lock the HPA configuration of the device until a successful call to unlock or
1551 the next power-on reset occurs.
1554 Make the HPA max sectors persist across power-on reset or a hardware reset.
1555 This must be used in combination with
1556 .Fl s Ar max_sectors
1560 Set the HPA configuration password required for unlock calls.
1563 Be quiet, do not print any status messages.
1564 This option will not disable the questions.
1565 To disable questions, use the
1568 .It Fl s Ar max_sectors
1570 Configures the maximum user accessible sectors of the device.
1571 This will change the number of sectors the device reports.
1573 .Em WARNING! WARNING! WARNING!
1575 Changing the max sectors of a device using this option will make the data on
1576 the device beyond the specified value inaccessible.
1579 .Fl s Ar max_sectors
1580 call can be made without a power-on reset or a hardware reset of the device.
1583 Unlock the HPA configuration of the specified device using the given password.
1584 If the password specified does not match the password configured via
1586 the command will fail.
1588 After 5 failed unlock calls, due to password miss-match, the device will refuse
1589 additional unlock calls until after a power-on reset.
1592 Confirm yes to dangerous options such as
1594 without prompting for confirmation
1597 The password for all HPA commands is limited to 32 characters, longer passwords
1600 Program firmware of the named
1602 or ATA device using the image file provided.
1606 device and it provides a recommended timeout for the WRITE BUFFER command
1609 opcodes subcommand), that timeout will be used for the firmware download.
1610 The drive-recommended timeout value may be overridden on the command line
1615 Current list of supported vendors for SCSI/SAS drives:
1618 Tested with 4TB SAS drives, model number HUS724040ALS640.
1622 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1623 There is a separate table entry for hard drives, because the update method
1624 for hard drives is different than the method for tape drives.
1629 Tested with SM1625 SSDs.
1631 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1632 ES.3 (ST1000NM0023) drives.
1634 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1637 .Em WARNING! WARNING! WARNING!
1639 Little testing has been done to make sure that different device models from
1640 each vendor work correctly with the fwdownload command.
1641 A vendor name appearing in the supported list means only that firmware of at
1642 least one device type from that vendor has successfully been programmed with
1643 the fwdownload command.
1644 Extra caution should be taken when using this command since there is no
1645 guarantee it will not break a device from the listed vendors.
1646 Ensure that you have a recent backup of the data on the device before
1647 performing a firmware update.
1651 protocol devices will not be programmed, since there is little chance of
1652 the firmware download succeeding.
1655 will currently attempt a firmware download to any
1659 device, since the standard
1661 DOWNLOAD MICROCODE command may work.
1662 Firmware downloads to
1666 devices are supported for devices connected
1671 controllers, and devices connected to SAS controllers
1676 translation capability.
1682 PASS-THROUGH command to send the
1684 DOWNLOAD MICROCODE command to the drive.
1689 translation implementations don't work fully when translating
1691 WRITE BUFFER commands to
1693 DOWNLOAD MICROCODE commands, but do support
1695 passthrough well enough to do a firmware download.
1697 .It Fl f Ar fw_image
1698 Path to the firmware image file to be downloaded to the specified device.
1700 Do not print informational messages, only print errors.
1701 This option should be used with the
1703 option to suppress all output.
1705 Run in simulation mode.
1706 Device checks are run and the confirmation dialog is shown, but no firmware
1707 download will occur.
1713 errors in the event of a failure.
1715 In simulation mode, print out the
1720 register values that would be used for the firmware download command.
1722 Do not ask for confirmation.
1725 Persistent reservation support.
1726 Persistent reservations are a way to reserve a particular
1728 LUN for use by one or more
1733 option is specified,
1737 PERSISTENT RESERVE IN
1738 command using the requested service action.
1741 option is specified,
1745 PERSISTENT RESERVE OUT
1746 command using the requested service action.
1747 One of those two options is required.
1749 Persistent reservations are complex, and fully explaining them is outside
1750 the scope of this manual.
1753 and download the latest SPC spec for a full explanation of persistent
1757 Specify the service action for the PERSISTENT RESERVE IN command.
1758 Supported service actions:
1761 Report the current persistent reservation generation (PRgeneration) and any
1763 .It read_reservation
1764 Report the persistent reservation, if any.
1765 .It report_capabilities
1766 Report the persistent reservation capabilities of the LUN.
1767 .It read_full_status
1768 Report the full status of persistent reservations on the LUN.
1771 Specify the service action for the PERSISTENT RESERVE OUT command.
1772 For service actions like register that are components of other service
1773 action names, the entire name must be specified.
1774 Otherwise, enough of the service action name must be specified to
1775 distinguish it from other possible service actions.
1776 Supported service actions:
1779 Register a reservation key with the LUN or unregister a reservation key.
1780 To register a key, specify the requested key as the Service Action
1782 To unregister a key, specify the previously registered key as the
1784 To change a key, specify the old key as the Reservation Key and the new
1785 key as the Service Action Reservation Key.
1787 This is similar to the register subcommand, except that the Reservation Key
1789 The Service Action Reservation Key will overwrite any previous key
1790 registered for the initiator.
1792 Create a reservation.
1793 A key must be registered with the LUN before the LUN can be reserved, and
1794 it must be specified as the Reservation Key.
1795 The type of reservation must also be specified.
1796 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1798 Release a reservation.
1799 The Reservation Key must be specified.
1801 Release a reservation and remove all keys from the device.
1802 The Reservation Key must be specified.
1804 Remove a reservation belonging to another initiator.
1805 The Reservation Key must be specified.
1806 The Service Action Reservation Key may be specified, depending on the
1807 operation being performed.
1809 Remove a reservation belonging to another initiator and abort all
1810 outstanding commands from that initiator.
1811 The Reservation Key must be specified.
1812 The Service Action Reservation Key may be specified, depending on the
1813 operation being performed.
1815 Register another initiator with the LUN, and establish a reservation on the
1816 LUN for that initiator.
1817 The Reservation Key and Service Action Reservation Key must be specified.
1819 Replace Lost Reservation information.
1822 Set the All Target Ports (ALL_TG_PT) bit.
1823 This requests that the key registration be applied to all target ports and
1824 not just the particular target port that receives the command.
1825 This only applies to the register and register_ignore actions.
1827 Specify a Transport ID.
1828 This only applies to the Register and Register and Move service actions for
1829 Persistent Reserve Out.
1830 Multiple Transport IDs may be specified with multiple
1833 With the Register service action, specifying one or more Transport IDs
1834 implicitly enables the
1836 option which turns on the SPEC_I_PT bit.
1837 Transport IDs generally have the format protocol,id.
1840 A SAS Transport ID consists of
1842 followed by a 64-bit SAS address.
1845 .Dl sas,0x1234567812345678
1847 A Fibre Channel Transport ID consists of
1849 followed by a 64-bit Fibre Channel World Wide Name.
1852 .Dl fcp,0x1234567812345678
1854 A Parallel SCSI address consists of
1856 followed by a SCSI target ID and a relative target port identifier.
1861 An IEEE 1394 (Firewire) Transport ID consists of
1863 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1866 .Dl sbp,0x1234567812345678
1868 A SCSI over RDMA Transport ID consists of
1870 followed by a 128-bit RDMA initiator port identifier.
1871 The port identifier must be exactly 32 or 34 (if the leading 0x is
1872 included) hexadecimal digits.
1873 Only hexadecimal (base 16) numbers are supported.
1876 .Dl srp,0x12345678123456781234567812345678
1878 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1880 For example, if only the iSCSI name is specified:
1882 .Dl iqn.2012-06.com.example:target0
1884 If the iSCSI separator and initiator session ID are specified:
1886 .Dl iqn.2012-06.com.example:target0,i,0x123
1888 A SCSI over PCIe Transport ID consists of
1890 followed by a PCIe Routing ID.
1891 The Routing ID consists of a bus, device and function or in the alternate
1892 form, a bus and function.
1893 The bus must be in the range of 0 to 255 inclusive and the device must be
1894 in the range of 0 to 31 inclusive.
1895 The function must be in the range of 0 to 7 inclusive if the standard form
1896 is used, and in the range of 0 to 255 inclusive if the alternate form is
1898 For example, if a bus, device and function are specified for the standard
1903 If the alternate Routing ID form is used:
1908 Specify the Reservation Key.
1909 This may be in decimal, octal or hexadecimal format.
1910 The value is zero by default if not otherwise specified.
1911 The value must be between 0 and 2^64 - 1, inclusive.
1913 Specify the Service Action Reservation Key.
1914 This may be in decimal, octal or hexadecimal format.
1915 The value is zero by default if not otherwise specified.
1916 The value must be between 0 and 2^64 - 1, inclusive.
1918 Enable the Activate Persist Through Power Loss bit.
1919 This is only used for the register and register_ignore actions.
1920 This requests that the reservation persist across power loss events.
1922 Specify the scope of the reservation.
1923 The scope may be specified by name or by number.
1924 The scope is ignored for register, register_ignore and clear.
1925 If the desired scope isn't available by name, you may specify the number.
1929 This encompasses the entire LUN.
1931 Extent scope (0x01).
1933 Element scope (0x02).
1936 Specify the Relative Target Port.
1937 This only applies to the Register and Move service action of the Persistent
1938 Reserve Out command.
1940 Enable the SPEC_I_PT bit.
1941 This only applies to the Register service action of Persistent Reserve Out.
1942 You must also specify at least one Transport ID with
1944 if this option is set.
1945 If you specify a Transport ID, this option is automatically set.
1946 It is an error to specify this option for any service action other than
1949 Specify the reservation type.
1950 The reservation type may be specified by name or by number.
1951 If the desired reservation type isn't available by name, you may specify
1953 Supported reservation type names:
1958 Write Exclusive mode.
1959 May also be specified as
1960 .Dq write_exclusive .
1962 Read Exclusive mode.
1963 May also be specified as
1964 .Dq read_exclusive .
1966 Exclusive access mode.
1967 May also be specified as
1968 .Dq exclusive_access .
1970 Write Exclusive Registrants Only mode.
1971 May also be specified as
1972 .Dq write_exclusive_reg_only .
1974 Exclusive Access Registrants Only mode.
1975 May also be specified as
1976 .Dq exclusive_access_reg_only .
1978 Write Exclusive All Registrants mode.
1979 May also be specified as
1980 .Dq write_exclusive_all_regs .
1982 Exclusive Access All Registrants mode.
1983 May also be specified as
1984 .Dq exclusive_access_all_regs .
1987 Specify that the target should unregister the initiator that sent
1988 the Register and Move request.
1989 By default, the target will not unregister the initiator that sends the
1990 Register and Move request.
1991 This option only applies to the Register and Move service action of the
1992 Persistent Reserve Out command.
1997 READ or WRITE ATTRIBUTE commands.
1998 These commands are used to read and write attributes in Medium Auxiliary
2000 The most common place Medium Auxiliary Memory is found is small flash chips
2001 included tape cartriges.
2009 option must be specified.
2012 Specify the READ ATTRIBUTE service action.
2015 Issue the ATTRIBUTE VALUES service action.
2016 Read and decode the available attributes and their values.
2018 Issue the ATTRIBUTE LIST service action.
2019 List the attributes that are available to read and write.
2021 Issue the LOGICAL VOLUME LIST service action.
2022 List the available logical volumes in the MAM.
2024 Issue the PARTITION LIST service action.
2025 List the available partitions in the MAM.
2027 Issue the SUPPORTED ATTRIBUTES service action.
2028 List attributes that are supported for reading or writing.
2029 These attributes may or may not be currently present in the MAM.
2032 Specify an attribute to write to the MAM.
2033 This option is not yet implemented.
2035 Specify the attribute number to display.
2036 This option only works with the attr_values, attr_list and supp_attr
2040 Display cached attributes.
2041 If the device supports this flag, it allows displaying attributes for the
2042 last piece of media loaded in the drive.
2044 Specify the element address.
2045 This is used for specifying which element number in a medium changer to
2046 access when reading attributes.
2047 The element number could be for a picker, portal, slot or drive.
2048 .It Fl F Ar form1,form2
2049 Specify the output format for the attribute values (attr_val) display as a
2050 comma separated list of options.
2051 The default output is currently set to field_all,nonascii_trim,text_raw.
2052 Once this code is ported to FreeBSD 10, any text fields will be converted
2053 from their codeset to the user's native codeset with
2056 The text options are mutually exclusive; if you specify more than one, you
2057 will get unpredictable results.
2058 The nonascii options are also mutually exclusive.
2059 Most of the field options may be logically ORed together.
2062 Print text fields with non-ASCII characters escaped.
2064 Print text fields natively, with no codeset conversion.
2066 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2067 escape the non-ASCII characters.
2069 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2070 omit the non-ASCII characters.
2072 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2073 print them as they are.
2075 Print all of the prefix fields: description, attribute number, attribute
2076 size, and the attribute's readonly status.
2077 If field_all is specified, specifying any other field options will not have
2080 Print none of the prefix fields, and only print out the attribute value.
2081 If field_none is specified, specifying any other field options will result
2082 in those fields being printed.
2084 Print out the attribute description.
2086 Print out the attribute number.
2088 Print out the attribute size.
2090 Print out the attribute's readonly status.
2093 Specify the partition.
2094 When the media has multiple partitions, specifying different partition
2095 numbers allows seeing the values for each individual partition.
2096 .It Fl s Ar start_num
2097 Specify the starting attribute number.
2098 This requests that the target device return attribute information starting
2099 at the given number.
2100 .It Fl T Ar elem_type
2101 Specify the element type.
2102 For medium changer devices, this allows specifying the type the element
2103 referenced in the element address (
2113 Specify the number of the logical volume to operate on.
2114 If the media has multiple logical volumes, this will allow displaying
2115 or writing attributes on the given logical volume.
2118 Issue the REPORT SUPPORTED OPCODES service action of the
2122 Without arguments, this command will return a list of all
2124 commands supported by the device, including service actions of commands
2125 that support service actions.
2126 It will also include the
2128 CDB (Command Data Block) length for each command, and the description of
2129 each command if it is known.
2132 Request information on a specific opcode instead of the list of supported
2134 If supported, the target will return a CDB-like structure that indicates
2135 the opcode, service action (if any), and a mask of bits that are supported
2137 .It Fl s Ar service_action
2138 For commands that support a service action, specify the service action to
2141 If a service action is specified for a given opcode, and the device does
2142 not support the given service action, the device should not return a
2144 error, but rather indicate in the returned parameter data that the command
2146 By default, if a service action is specified for an opcode, and service
2147 actions are not supported for the opcode in question, the device will
2150 Include timeout values.
2151 This option works with the default display, which includes all commands
2152 supported by the device, and with the
2156 options, which request information on a specific command and service
2158 This requests that the device report Nominal and Recommended timeout values
2159 for the given command or commands.
2160 The timeout values are in seconds.
2161 The timeout descriptor also includes a command-specific
2168 Zoned Block devices.
2169 This allows managing devices that conform to the
2171 Zoned Block Commands (ZBC) and
2173 Zoned ATA Command Set (ZAC)
2175 Devices using these command sets are usually hard drives using Shingled
2176 Magnetic Recording (SMR).
2177 There are three types of SMR drives:
2180 Drive Managed drives look and act just like a standard random access block
2181 device, but underneath, the drive reads and writes the bulk of its capacity
2183 Sequential writes will yield better performance, but writing sequentially
2186 Host Aware drives expose the underlying zone layout via
2190 commands and allow the host to manage the zone conditions.
2191 The host is not required to manage the zones on the drive, though.
2192 Sequential writes will yield better performance in Sequential Write
2193 Preferred zones, but the host can write randomly in those zones.
2195 Host Managed drives expose the underlying zone layout via
2200 The host is required to access the zones according to the rules described
2202 Any commands that violate the rules will be returned with an error.
2205 SMR drives are divided into zones (typically in the range of 256MB each)
2206 that fall into three general categories:
2209 These are also known as Non Write Pointer zones.
2210 These zones can be randomly written without an unexpected performance penalty.
2211 .It Sequential Preferred
2212 These zones should be written sequentially starting at the write pointer
2214 They may be written randomly.
2215 Writes that do not conform to the zone layout may be significantly slower
2217 .It Sequential Required
2218 These zones must be written sequentially.
2219 If they are not written sequentially, starting at the write pointer, the
2225 Specify the zone subcommand:
2228 Issue the Report Zones command.
2229 All zones are returned by default.
2230 Specify report options with
2232 and printing options with
2234 Specify the starting LBA with
2238 is also accepted as a command argument.
2240 Explicitly open the zone specified by the starting LBA.
2242 Close the zone specified by starting LBA.
2244 Finish the zone specified by the starting LBA.
2246 Reset the write pointer for the zone specified by the starting LBA.
2249 For the Open, Close, Finish, and Reset Write Pointer operations, apply the
2250 operation to all zones on the drive.
2252 Specify the starting LBA.
2253 For the Report Zones command, this tells the drive to report starting with
2254 the zone that starts at the given LBA.
2255 For the other commands, this allows the user to identify the zone requested
2256 by its starting LBA.
2257 The LBA may be specified in decimal, hexadecimal or octal notation.
2259 For the Report Zones command, specify a subset of zones to report.
2263 This is the default.
2265 Report only empty zones.
2267 Report zones that are implicitly open.
2268 This means that the host has sent a write to the zone without explicitly
2271 Report zones that are explicitly open.
2273 Report zones that have been closed by the host.
2275 Report zones that are full.
2277 Report zones that are in the read only state.
2280 is also accepted as an argument.
2282 Report zones that are in the offline state.
2284 Report zones where the device recommends resetting write pointers.
2286 Report zones that have the Non Sequential Resources Active flag set.
2287 These are zones that are Sequential Write Preferred, but have been written
2290 Report Non Write Pointer zones, also known as Conventional zones.
2292 .It Fl P Ar print_opt
2293 Specify a printing option for Report Zones:
2296 Normal Report Zones output.
2297 This is the default.
2298 The summary and column headings are printed, fields are separated by spaces
2299 and the fields themselves may contain spaces.
2301 Just print the summary: the number of zones, the maximum LBA (LBA of the
2302 last logical block on the drive), and the value of the
2307 field describes whether the zones on the drive are all identical, all
2308 different, or whether they are the same except for the last zone, etc.
2310 Print the zones in a script friendly format.
2311 The summary and column headings are omitted, the fields are separated by
2312 commas, and the fields do not contain spaces.
2313 The fields contain underscores where spaces would normally be used.
2319 Extended Power Conditions (EPC) feature set commands.
2322 protocol drives, and will not work on
2331 translation layer (SAT).
2332 It may be helpful to read the ATA Command Set - 4 (ACS-4) description of
2333 the Extended Power Conditions feature set, available at t13.org, to
2334 understand the details of this particular
2339 Specify the epc subcommand
2342 Restore drive power condition settings.
2345 Specify the source for the restored power settings, either
2349 This argument is required.
2352 This only makes sense to specify when restoring from defaults.
2355 Go to the specified power condition.
2358 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2359 This argument is required.
2361 Specify delayed entry to the power condition.
2362 The drive, if it supports this, can enter the power condition after the
2365 Hold the power condition.
2366 If the drive supports this option, it will hold the power condition and
2367 reject all commands that would normally cause it to exit that power
2371 Set the timer value for a power condition and enable or disable the
2375 display described below to see what the current timer settings are for each
2376 Idle and Standby mode supported by the drive.
2379 Enable the power condition.
2386 Disable the power condition.
2393 Specify the timer in seconds.
2394 The user may specify a timer as a floating point number with a maximum
2395 supported resolution of tenths of a second.
2396 Drives may or may not support sub-second timer values.
2398 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2399 This argument is required.
2401 Save the timer and power condition enable/disable state.
2402 By default, if this option is not specified, only the current values for
2403 this power condition will be affected.
2406 Enable or disable a particular power condition.
2409 Enable the power condition.
2416 Disable the power condition.
2423 Specify the power condition: Idle_a, Idle_b, Idle_c, Standby_y, Standby_z.
2424 This argument is required.
2426 Save the power condition enable/disable state.
2427 By default, if this option is not specified, only the current values for
2428 this power condition will be affected.
2431 Enable the Extended Power Condition (EPC) feature set.
2433 Disable the Extended Power Condition (EPC) feature set.
2435 Specify the EPC power source.
2438 Specify the power source, either
2444 Get the current status of several parameters related to the Extended Power
2445 Condition (EPC) feature set, including whether APM and EPC are supported
2446 and enabled, whether Low Power Standby is supported, whether setting the
2447 EPC power source is supported, whether Low Power Standby is supported and
2448 the current power condition.
2451 Only report the current power condition.
2452 Some drives will exit their current power condition if a command other than
2455 CHECK POWER MODE command is received.
2456 If this flag is specified,
2460 CHECK POWER MODE command to the drive.
2465 Power Conditions log (Log Address 0x08).
2466 This shows the list of Idle and Standby power conditions the drive
2467 supports, and a number of parameters about each condition, including
2468 whether it is enabled and what the timer value is.
2472 Issue REPORT TIMESTAMP or SET TIMESTAMP
2474 commands. Either the
2478 option must be specified.
2481 Report the device's timestamp.
2482 If no more arguments are specified, the timestamp will be reported using
2483 the national representation of the date and time, followed by the time
2487 Specify the strftime format string, as documented in strftime(3), to be used
2488 to format the reported timestamp.
2490 Report the timestamp as milliseconds since the epoch.
2492 Report the timestamp using the national representation of the date and
2493 time, but override the system time zone and use UTC instead.
2498 Set the device's timestamp. Either the
2504 option must be specified.
2507 Specify the strptime format string, as documented in strptime(3).
2508 The time must also be specified with the
2512 Provide the time in the format specified with the
2516 Set the timestamp to the host system's time in UTC.
2520 Print out verbose usage information.
2525 variable allows the user to specify an alternate mode page format file.
2529 variable determines which text editor
2531 starts when editing mode pages.
2533 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2534 .It Pa /usr/share/misc/scsi_modes
2535 is the SCSI mode format database.
2537 is the transport layer device.
2539 are the CAM application passthrough devices.
2542 .Dl camcontrol eject -n cd -u 1 -v
2544 Eject the CD from cd1, and print SCSI sense information if the command
2547 .Dl camcontrol tur da0
2549 Send the SCSI test unit ready command to da0.
2552 utility will report whether the disk is ready, but will not display sense
2553 information if the command fails since the
2555 switch was not specified.
2556 .Bd -literal -offset indent
2557 camcontrol tur da1 -E -C 4 -t 50 -Q head -v
2560 Send a test unit ready command to da1.
2561 Enable kernel error recovery.
2562 Specify a retry count of 4, and a timeout of 50 seconds.
2566 flag) if the command fails.
2567 Since error recovery is turned on, the
2568 disk will be spun up if it is not currently spinning.
2571 task attribute for the command will be set to Head of Queue.
2574 utility will report whether the disk is ready.
2575 .Bd -literal -offset indent
2576 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2577 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2580 Issue a READ BUFFER command (0x3C) to cd1.
2581 Display the buffer size of cd1,
2582 and display the first 10 bytes from the cache on cd1.
2584 information if the command fails.
2585 .Bd -literal -offset indent
2586 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2587 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2590 Issue a WRITE BUFFER (0x3B) command to cd1.
2591 Write out 10 bytes of data,
2592 not including the (reserved) 4 byte header.
2593 Print out sense information if
2595 Be very careful with this command, improper use may
2596 cause data corruption.
2597 .Bd -literal -offset indent
2598 camcontrol modepage da3 -m 1 -e -P 3
2601 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2602 settings on the drive.
2603 Mode page 1 contains a disk drive's auto read and
2604 write reallocation settings, among other things.
2606 .Dl camcontrol rescan all
2608 Rescan all SCSI buses in the system for devices that have been added,
2611 .Dl camcontrol rescan 0
2613 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2615 .Dl camcontrol rescan 0:1:0
2617 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2620 .Dl camcontrol tags da5 -N 24
2622 Set the number of concurrent transactions for da5 to 24.
2623 .Bd -literal -offset indent
2624 camcontrol negotiate -n da -u 4 -T disable
2627 Disable tagged queueing for da4.
2628 .Bd -literal -offset indent
2629 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2632 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2634 Test Unit Ready command to make the settings take effect.
2635 .Bd -literal -offset indent
2636 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2639 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2641 Display SMP errors if the command fails.
2642 .Bd -literal -offset indent
2643 camcontrol security ada0
2646 Report security support and settings for ada0
2647 .Bd -literal -offset indent
2648 camcontrol security ada0 -U user -s MyPass
2651 Enable security on device ada0 with the password MyPass
2652 .Bd -literal -offset indent
2653 camcontrol security ada0 -U user -e MyPass
2656 Secure erase ada0 which has had security enabled with user password MyPass
2658 .Em WARNING! WARNING! WARNING!
2662 data from the device, so backup your data before using!
2664 This command can be used against an SSD drive to restoring it to
2665 factory default write performance.
2666 .Bd -literal -offset indent
2670 Report HPA support and settings for ada0 (also reported via
2672 .Bd -literal -offset indent
2673 camcontrol hpa ada0 -s 10240
2676 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2678 .Em WARNING! WARNING! WARNING!
2682 to all data on the device beyond this limit until HPA is disabled by setting
2683 HPA to native max sectors of the device, which can only be done after a
2684 power-on or hardware reset!
2687 use this on a device which has an active filesystem!
2688 .Bd -literal -offset indent
2689 camcontrol persist da0 -v -i read_keys
2692 This will read any persistent reservation keys registered with da0, and
2693 display any errors encountered when sending the PERSISTENT RESERVE IN
2696 .Bd -literal -offset indent
2697 camcontrol persist da0 -v -o register -a -K 0x12345678
2700 This will register the persistent reservation key 0x12345678 with da0,
2701 apply that registration to all ports on da0, and display any errors that
2702 occur when sending the PERSISTENT RESERVE OUT command.
2703 .Bd -literal -offset indent
2704 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2707 This will reserve da0 for the exlusive use of the initiator issuing the
2709 The scope of the reservation is the entire LUN.
2710 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2711 .Bd -literal -offset indent
2712 camcontrol persist da0 -v -i read_full
2715 This will display the full status of all reservations on da0 and print out
2716 status if there are any errors.
2717 .Bd -literal -offset indent
2718 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2721 This will release a reservation on da0 of the type ex_ac
2723 The Reservation Key for this registration is 0x12345678.
2724 Any errors that occur will be displayed.
2725 .Bd -literal -offset indent
2726 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2727 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2730 This will register the key 0x12345678 with da0, specifying that it applies
2731 to the SAS initiators with SAS addresses 0x1234567812345678 and
2733 .Bd -literal -offset indent
2734 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2735 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2738 This will move the registration from the current initiator, whose
2739 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2740 Fiber Channel World Wide Node Name 0x1234567812345678.
2741 A new registration key, 0x12345678, will be registered for the initiator
2742 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2743 current initiator will be unregistered from the target.
2744 The reservation will be moved to relative target port 2 on the target
2746 The registration will persist across power losses.
2747 .Bd -literal -offset indent
2748 camcontrol attrib sa0 -v -i attr_values -p 1
2751 This will read and decode the attribute values from partition 1 on the tape
2752 in tape drive sa0, and will display any
2756 .Bd -literal -offset indent
2757 camcontrol zone da0 -v -c rz -P summary
2760 This will request the SMR zone list from disk da0, and print out a
2761 summary of the zone parameters, and display any
2767 .Bd -literal -offset indent
2768 camcontrol zone da0 -v -c rz -o reset
2771 This will request the list of SMR zones that should have their write
2772 pointer reset from the disk da0, and display any
2778 .Bd -literal -offset indent
2779 camcontrol zone da0 -v -c rwp -l 0x2c80000
2782 This will issue the Reset Write Pointer command to disk da0 for the zone
2783 that starts at LBA 0x2c80000 and display any
2789 .Bd -literal -offset indent
2790 camcontrol epc ada0 -c timer -T 60.1 -p Idle_a -e -s
2793 Set the timer for the Idle_a power condition on drive
2795 to 60.1 seconds, enable that particular power condition, and save the timer
2796 value and the enabled state of the power condition.
2798 .Bd -literal -offset indent
2799 camcontrol epc da4 -c goto -p Standby_z -H
2804 to go to the Standby_z power state (which is
2805 the drive's lowest power state) and hold in that state until it is
2806 explicitly released by another
2810 .Bd -literal -offset indent
2811 camcontrol epc da2 -c status -P
2814 Report only the power state of
2817 Some drives will power up in response to the commands sent by the
2825 CHECK POWER MODE command, which should not trigger a change in the drive's
2828 .Bd -literal -offset indent
2829 camcontrol epc ada0 -c list
2832 Display the ATA Power Conditions log (Log Address 0x08) for
2836 .Bd -literal -offset indent
2837 camcontrol timestamp sa0 -s -f "%a, %d %b %Y %T %z" \e
2838 -T "Wed, 26 Oct 2016 21:43:57 -0600"
2841 Set the timestamp of drive
2845 format string followed by a time string
2846 that was created using this format string.
2849 .Xr cam_cdbparse 3 ,
2856 utility first appeared in
2859 The mode page editing code and arbitrary SCSI command code are based upon
2864 library, written by Julian Elischer and Peter Dufault.
2867 program first appeared in
2869 and first appeared in
2874 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2876 The code that parses the generic command line arguments does not know that
2877 some of the subcommands take multiple arguments.
2878 So if, for instance, you
2879 tried something like this:
2880 .Bd -literal -offset indent
2881 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2884 The sense information from the test unit ready command would not get
2885 printed out, since the first
2889 bails out when it sees the second argument to
2893 Fixing this behavior would take some gross code, or changes to the
2896 The best way to circumvent this problem is to always make sure
2899 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob