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
330 utility is designed to provide a way for users to access and control the
337 can cause a loss of data and/or system crashes if used improperly.
339 expert users are encouraged to exercise caution when using this command.
340 Novice users should stay away from this utility.
344 utility has a number of primary functions, many of which support an optional
346 A device identifier can take one of three forms:
349 Specify a device name and unit number combination, like "da5" or "cd3".
351 Specify a bus number and target id.
352 The bus number can be determined from
354 .Dq camcontrol devlist .
355 The lun defaults to 0.
357 Specify the bus, target and lun for a device.
361 The device identifier, if it is specified,
363 come immediately after the function name, and before any generic or
364 function-specific arguments.
369 arguments described below will override any device name or unit number
370 specified beforehand.
377 override a specified bus:target or bus:target:lun, however.
381 primary functions support these generic arguments:
384 SCSI command retry count.
385 In order for this to work, error recovery
389 Instruct the kernel to perform generic SCSI error recovery for the given
391 This is needed in order for the retry count
394 Other than retrying commands, the generic error recovery in
395 the code will generally attempt to spin up drives that are not spinning.
396 It may take some other actions, depending upon the sense code returned from
399 Specify the device type to operate on, e.g.\& "da", "cd".
400 .It Fl Q Ar task_attr
402 task attribute for the command, if it is a
405 This may be ordered, simple, head, or aca.
406 In most cases this is not needed.
407 The default is simple, which works with all
410 The task attribute may also be specified numerically.
412 SCSI command timeout in seconds.
413 This overrides the default timeout for
415 .It Fl u Ar unit_number
416 Specify the device unit number, e.g.\& "1", "5".
418 Be verbose, print out sense information for failed SCSI commands.
421 Primary command functions:
422 .Bl -tag -width periphlist
424 List all physical devices (logical units) attached to the CAM subsystem.
425 This also includes a list of peripheral drivers attached to each device.
428 argument, SCSI bus number, adapter name and unit numbers are printed as
430 On the other hand, with the
432 argument, only the bus adapter, and unit information will be printed, and
433 device information will be omitted.
435 List all peripheral drivers attached to a given physical device (logical
438 Send the SCSI test unit ready (0x00) command to the given device.
441 utility will report whether the device is ready or not.
443 Send a SCSI inquiry command (0x12) to a device.
446 will print out the standard inquiry data, device serial number, and
447 transfer rate information.
448 The user can specify that only certain types of
449 inquiry data be printed:
452 Get the standard inquiry data.
454 Print out the serial number.
455 If this flag is the only one specified,
457 will not print out "Serial Number" before the value returned by the drive.
458 This is to aid in script writing.
460 Print out transfer rate information.
463 Send a ATA identify command (0xec) to a device.
465 Send the SCSI REPORT LUNS (0xA0) command to the given device.
468 will print out the list of logical units (LUNs) supported by the target device.
469 There are a couple of options to modify the output:
472 Just print out a count of LUNs, not the actual LUN numbers.
474 Just print out the LUNs, and do not print out the count.
475 .It Fl r Ar reporttype
476 Specify the type of report to request from the target:
477 .Bl -tag -width 012345678
479 Return the default report.
483 Most targets will support this report if they support the REPORT LUNS
486 Return only well known LUNs.
488 Return all available LUNs.
493 will try to print out LUN numbers in a reasonable format.
494 It can understand the peripheral, flat, LUN and extended LUN formats.
496 Send the SCSI READ CAPACITY command to the given device and display
498 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
499 action will be sent to obtain the full size of the device.
502 will print out the last logical block of the device, and the blocksize of
504 To modify the output format, use the following options:
507 Just print out the blocksize, not the last block or device size.
508 This cannot be used with
513 Print out the device size in human readable (base 2, 1K == 1024) format.
516 and cannot be used with
521 Print out the device size in human readable (base 10, 1K == 1000) format.
523 Print out the number of blocks in the device instead of the last logical
526 Quiet, print out the numbers only (separated by a comma if
532 Print out the last logical block or the size of the device only, and omit
536 Note that this command only displays the information, it does not update
537 the kernel data structures.
540 reprobe subcommand to do that.
542 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
545 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
548 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
549 start bit set and the load/eject bit set.
551 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
552 start bit cleared and the load/eject bit set.
554 Tell the kernel to scan all busses in the system (with the
556 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
557 (XPT_SCAN_LUN) for new devices or devices that have gone away.
559 may specify a scan of all busses, a single bus, or a lun.
561 on a target is not supported.
563 Tell the kernel to refresh the information about the device and
564 notify the upper layer,
566 This includes sending the SCSI READ CAPACITY command and updating
567 the disk size visible to the rest of the system.
569 Tell the kernel to reset all busses in the system (with the
571 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
572 reset for that bus, or to reset the given bus:target:lun
573 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
574 connecting to that device.
575 Note that this can have a destructive impact
580 READ DEFECT DATA (10) command (0x37) or the
582 READ DEFECT DATA (12) command (0xB7) to the given device, and
583 print out any combination of: the total number of defects, the primary
584 defect list (PLIST), and the grown defect list (GLIST).
587 Specify the requested format of the defect list.
588 The format argument is
590 Most drives support the physical sector format.
592 support the logical block format.
593 Many drives, if they do not support the
594 requested format, return the data in an alternate format, along with sense
595 information indicating that the requested data format is not supported.
599 attempts to detect this, and print out whatever format the drive returns.
600 If the drive uses a non-standard sense code to report that it does not
601 support the requested format,
603 will probably see the error as a failure to complete the request.
605 The format options are:
608 Print out the list as logical blocks.
609 This is limited to 32-bit block sizes, and isn't supported by many modern
612 Print out the list as logical blocks.
613 This option uses a 64-bit block size.
615 Print out the list in bytes from index format.
617 Print out the list in extended bytes from index format.
618 The extended format allows for ranges of blocks to be printed.
620 Print out the list in physical sector format.
621 Most drives support this format.
623 Print out the list in extended physical sector format.
624 The extended format allows for ranges of blocks to be printed.
628 Print out the grown defect list.
629 This is a list of bad blocks that have
630 been remapped since the disk left the factory.
632 Print out the primary defect list.
633 This is the list of defects that were present in the factory.
635 When printing status information with
637 only print the number of defects.
639 Just print the number of defects, not the list of defects.
641 Specify the starting offset into the defect list.
642 This implies using the
644 READ DEFECT DATA (12) command, as the 10 byte version of the command
645 doesn't support the address descriptor index field.
646 Not all drives support the 12 byte command, and some drives that support
647 the 12 byte command don't support the address descriptor index field.
649 Print out defects in hexadecimal (base 16) form instead of base 10 form.
658 will print out the number of defects given in the READ DEFECT DATA header
659 returned from the drive.
660 Some drives will report 0 defects if neither the primary or grown defect
663 Allows the user to display and optionally edit a SCSI mode page.
665 page formats are located in
666 .Pa /usr/share/misc/scsi_modes .
667 This can be overridden by specifying a different file in the
669 environment variable.
672 command takes several arguments:
675 Disable block descriptors for mode sense.
677 Displays mode page data in binary format.
679 This flag allows the user to edit values in the mode page.
681 either edit mode page values with the text editor pointed to by his
683 environment variable, or supply mode page values via standard input, using
686 uses to display mode page values.
687 The editor will be invoked if
689 detects that standard input is terminal.
691 Lists all available mode pages.
692 If specified more then once, also lists subpages.
693 .It Fl m Ar page[,subpage]
694 This specifies the number of the mode page and optionally subpage the user
695 would like to view and/or edit.
696 This argument is mandatory unless
700 This allows the user to specify the page control field.
702 .Bl -tag -width xxx -compact
714 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
717 function requires the
719 argument to specify SCSI CDB or the
721 argument to specify ATA Command Block registers values.
722 Other arguments are optional, depending on
724 The command and data specification syntax is documented
727 NOTE: If the CDB specified causes data to be transferred to or from the
728 SCSI device in question, you MUST specify either
733 .It Fl a Ar cmd Op args
734 This specifies the content of 12 ATA Command Block registers (command,
735 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
736 lba_high_exp, features_exp, sector_count, sector_count_exp).
737 .It Fl c Ar cmd Op args
738 This specifies the SCSI CDB.
739 SCSI CDBs may be 6, 10, 12 or 16 bytes.
741 Specifies DMA protocol to be used for ATA command.
743 Specifies FPDMA (NCQ) protocol to be used for ATA command.
744 .It Fl i Ar len Ar fmt
745 This specifies the amount of data to read, and how it should be displayed.
749 bytes of data will be read from the device and written to standard output.
750 .It Fl o Ar len Ar fmt Op args
751 This specifies the amount of data to be written to a device, and the data
752 that is to be written.
756 bytes of data will be read from standard input and written to the device.
758 This specifies that 11 result ATA Command Block registers should be displayed
759 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
760 lba_high_exp, sector_count, sector_count_exp), and how.
763 11 result registers will be written to standard output in hex.
766 Allows the user to send an arbitrary Serial
767 Management Protocol (SMP) command to a device.
770 function requires the
772 argument to specify the SMP request to be sent, and the
774 argument to specify the format of the SMP response.
775 The syntax for the SMP request and response arguments is documented in
778 Note that SAS adapters that support SMP passthrough (at least the currently
779 known adapters) do not accept CRC bytes from the user in the request and do
780 not pass CRC bytes back to the user in the response.
781 Therefore users should not include the CRC bytes in the length of the
782 request and not expect CRC bytes to be returned in the response.
784 .It Fl r Ar len Ar fmt Op args
785 This specifies the size of the SMP request, without the CRC bytes, and the
790 bytes of data will be read from standard input and written as the SMP
792 .It Fl R Ar len Ar fmt Op args
793 This specifies the size of the buffer allocated for the SMP response, and
794 the SMP response format.
798 bytes of data will be allocated for the response and the response will be
799 written to standard output.
802 Allows the user to send the Serial Management Protocol (SMP) Report General
805 will display the data returned by the Report General command.
806 If the SMP target supports the long response format, the additional data
807 will be requested and displayed automatically.
810 Request the long response format only.
811 Not all SMP targets support the long response format.
814 to skip sending the initial report general request without the long bit set
815 and only issue a report general request with the long bit set.
818 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
820 This function should be used with some caution, as it can render devices
821 inaccessible, and could potentially cause data corruption as well.
824 argument is required to specify the PHY to operate on.
827 Specify the PHY to operate on.
828 This argument is required.
830 Request the long request/response format.
831 Not all SMP targets support the long response format.
832 For the PHY Control command, this currently only affects whether the
833 request length is set to a value other than 0.
834 .It Fl o Ar operation
835 Specify a PHY control operation.
838 operation may be specified.
839 The operation may be specified numerically (in decimal, hexadecimal, or octal)
840 or one of the following operation names may be specified:
844 It is not necessary to specify this argument.
846 Send the LINK RESET command to the phy.
848 Send the HARD RESET command to the phy.
850 Send the DISABLE command to the phy.
851 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
853 Send the CLEAR ERROR LOG command.
854 This clears the error log counters for the specified phy.
856 Send the CLEAR AFFILIATION command.
857 This clears the affiliation from the STP initiator port with the same SAS
858 address as the SMP initiator that requests the clear operation.
860 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
861 This will cause a SATA port selector to use the given phy as its active phy
862 and make the other phy inactive.
864 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
866 Send the SET ATTACHED DEVICE NAME command to the PHY.
869 argument to specify the device name.
872 Specify the attached device name.
873 This option is needed with the
876 The name is a 64-bit number, and can be specified in decimal, hexadecimal
879 Set the minimum physical link rate for the phy.
880 This is a numeric argument.
881 Currently known link rates are:
884 Do not change current value.
893 Other values may be specified for newer physical link rates.
895 Set the maximum physical link rate for the phy.
896 This is a numeric argument.
899 argument description for known link rate arguments.
900 .It Fl T Ar pp_timeout
901 Set the partial pathway timeout value, in microseconds.
906 specification for more information on this field.
907 .It Fl a Ar enable|disable
908 Enable or disable SATA slumber phy power conditions.
909 .It Fl A Ar enable|disable
910 Enable or disable SATA partial power conditions.
911 .It Fl s Ar enable|disable
912 Enable or disable SAS slumber phy power conditions.
913 .It Fl S Ar enable|disable
914 Enable or disable SAS partial phy power conditions.
917 List phys attached to a SAS expander, the address of the end device
918 attached to the phy, and the inquiry data for that device and peripheral
919 devices attached to that device.
920 The inquiry data and peripheral devices are displayed if available.
923 Turn on the long response format for the underlying SMP commands used for
926 Only print out phys that are attached to a device in the CAM EDT (Existing
930 Send the SMP Report Manufacturer Information command to the device and
931 display the response.
934 Turn on the long response format for the underlying SMP commands used for
938 Turn on CAM debugging printfs in the kernel.
939 This requires options CAMDEBUG
940 in your kernel config file.
941 WARNING: enabling debugging printfs currently
942 causes an EXTREME number of kernel printfs.
943 You may have difficulty
944 turning off the debugging printfs once they start, since the kernel will be
945 busy printing messages and unable to service other requests quickly.
948 function takes a number of arguments:
951 Enable CAM_DEBUG_INFO printfs.
953 Enable CAM_DEBUG_PERIPH printfs.
955 Enable CAM_DEBUG_TRACE printfs.
957 Enable CAM_DEBUG_SUBTRACE printfs.
959 Enable CAM_DEBUG_XPT printfs.
961 Enable CAM_DEBUG_CDB printfs.
962 This will cause the kernel to print out the
963 SCSI CDBs sent to the specified device(s).
965 Enable CAM_DEBUG_PROBE printfs.
967 Enable debugging for all devices.
969 Turn off debugging for all devices
970 .It bus Ns Op :target Ns Op :lun
971 Turn on debugging for the given bus, target or lun.
973 and lun are not specified, they are wildcarded.
974 (i.e., just specifying a
975 bus turns on debugging printfs for all devices on that bus.)
978 Show or set the number of "tagged openings" or simultaneous transactions
979 we attempt to queue to a particular device.
982 command, with no command-specific arguments (i.e., only generic arguments)
983 prints out the "soft" maximum number of transactions that can be queued to
984 the device in question.
985 For more detailed information, use the
987 argument described below.
990 Set the number of tags for the given device.
991 This must be between the
992 minimum and maximum number set in the kernel quirk table.
994 most devices that support tagged queueing is a minimum of 2 and a maximum
996 The minimum and maximum values for a given device may be
997 determined by using the
1004 subcommand is described below.
1006 Be quiet, and do not report the number of tags.
1007 This is generally used when
1008 setting the number of tags.
1010 The verbose flag has special functionality for the
1015 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1018 This is the amount of capacity for transactions queued to a given device.
1020 This is the number of transactions currently queued to a device.
1022 This is the kernel queue space for transactions.
1023 This count usually mirrors
1024 dev_openings except during error recovery operations when
1025 the device queue is frozen (device is not allowed to receive
1026 commands), the number of dev_openings is reduced, or transaction
1027 replay is occurring.
1029 This is the number of transactions waiting in the kernel queue for capacity
1031 This number is usually zero unless error recovery is in
1034 The held count is the number of CCBs held by peripheral drivers that have
1035 either just been completed or are about to be released to the transport
1036 layer for service by a device.
1037 Held CCBs reserve capacity on a given
1040 This is the current "hard" minimum number of transactions that can be
1041 queued to a device at once.
1044 value above cannot go below this number.
1045 The default value for
1047 is 2, although it may be set higher or lower for various devices.
1049 This is the "hard" maximum number of transactions that can be queued to a
1053 value cannot go above this number.
1054 The default value for
1056 is 255, although it may be set higher or lower for various devices.
1060 Show or negotiate various communication parameters.
1061 Some controllers may
1062 not support setting or changing some of these values.
1064 Adaptec 174x controllers do not support changing a device's sync rate or
1069 will not attempt to set the parameter if the controller indicates that it
1070 does not support setting the parameter.
1071 To find out what the controller
1079 command is described below.
1080 Also, some controller drivers do not support
1081 setting negotiation parameters, even if the underlying controller supports
1082 negotiation changes.
1083 Some controllers, such as the Advansys wide
1084 controllers, support enabling and disabling synchronous negotiation for
1085 a device, but do not support setting the synchronous negotiation rate.
1088 Attempt to make the negotiation settings take effect immediately by sending
1089 a Test Unit Ready command to the device.
1091 Show or set current negotiation settings.
1092 This is the default.
1093 .It Fl D Ar enable|disable
1094 Enable or disable disconnection.
1098 Set the command delay offset.
1100 Be quiet, do not print anything.
1101 This is generally useful when you want to
1102 set a parameter, but do not want any status information.
1103 .It Fl R Ar syncrate
1104 Change the synchronization rate for a device.
1105 The sync rate is a floating
1106 point value specified in MHz.
1109 is a legal value, as is
1111 .It Fl T Ar enable|disable
1112 Enable or disable tagged queueing for a device.
1114 Show or set user negotiation settings.
1115 The default is to show or set
1116 current negotiation settings.
1118 The verbose switch has special meaning for the
1123 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1125 .It Fl W Ar bus_width
1126 Specify the bus width to negotiate with a device.
1129 The only useful values to specify are 8, 16, and 32
1131 The controller must support the bus width in question in order for
1132 the setting to take effect.
1135 In general, sync rate and offset settings will not take effect for a
1136 device until a command has been sent to the device.
1139 switch above will automatically send a Test Unit Ready to the device so
1140 negotiation parameters will take effect.
1144 FORMAT UNIT command to the named device.
1146 .Em WARNING! WARNING! WARNING!
1148 Low level formatting a disk will destroy ALL data on the disk.
1150 extreme caution when issuing this command.
1151 Many users low-level format
1152 disks that do not really need to be low-level formatted.
1154 relatively few scenarios that call for low-level formatting a disk.
1156 low-level formatting a disk is to initialize the disk after changing
1157 its physical sector size.
1158 Another reason for low-level formatting a disk
1159 is to revive the disk if you are getting "medium format corrupted" errors
1160 from the disk in response to read and write requests.
1162 Some disks take longer than others to format.
1163 Users should specify a
1164 timeout long enough to allow the format to complete.
1166 timeout is 3 hours, which should be long enough for most disks.
1168 disks will complete a format operation in a very short period of time
1169 (on the order of 5 minutes or less).
1170 This is often because the drive
1171 does not really support the FORMAT UNIT command -- it just accepts the
1172 command, waits a few minutes and then returns it.
1176 subcommand takes several arguments that modify its default behavior.
1181 arguments can be useful for scripts.
1184 Be quiet, do not print any status messages.
1185 This option will not disable
1186 the questions, however.
1187 To disable questions, use the
1194 This will report status on a format that is already running on the drive.
1196 Issue a non-immediate format command.
1199 issues the FORMAT UNIT command with the immediate bit set.
1201 device to immediately return the format command, before the format has
1207 sense information from the device every second to determine how far along
1208 in the format process it is.
1211 argument is specified,
1213 will issue a non-immediate format command, and will be unable to print any
1214 information to let the user know what percentage of the disk has been
1217 Do not ask any questions.
1220 will ask the user if he/she really wants to format the disk in question,
1221 and also if the default format command timeout is acceptable.
1223 will not be asked about the timeout if a timeout is specified on the
1229 SANITIZE command to the named device.
1231 .Em WARNING! WARNING! WARNING!
1233 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1234 Recovery of the data is not possible.
1235 Use extreme caution when issuing this command.
1239 subcommand takes several arguments that modify its default behavior.
1244 arguments can be useful for scripts.
1246 .It Fl a Ar operation
1247 Specify the sanitize operation to perform.
1250 Perform an overwrite operation by writing a user supplied
1251 data pattern to the device one or more times.
1252 The pattern is given by the
1255 The number of times is given by the
1259 Perform a block erase operation.
1260 All the device's blocks are set to a vendor defined
1261 value, typically zero.
1263 Perform a cryptographic erase operation.
1264 The encryption keys are changed to prevent the decryption
1267 Exits a previously failed sanitize operation.
1268 A failed sanitize operation can only be exited if it was
1269 run in the unrestricted completion mode, as provided by the
1274 The number of passes when performing an
1277 Valid values are between 1 and 31.
1282 operation, the pattern is inverted between consecutive passes.
1284 Path to the file containing the pattern to use when
1288 The pattern is repeated as needed to fill each block.
1290 Be quiet, do not print any status messages.
1291 This option will not disable
1292 the questions, however.
1293 To disable questions, use the
1297 Perform the sanitize in the unrestricted completion mode.
1298 If the operation fails, it can later be exited with the
1305 This will report status on a sanitize that is already running on the drive.
1307 Issue a non-immediate sanitize command.
1310 issues the SANITIZE command with the immediate bit set.
1312 device to immediately return the sanitize command, before
1313 the sanitize has actually completed.
1318 sense information from the device every second to determine how far along
1319 in the sanitize process it is.
1322 argument is specified,
1324 will issue a non-immediate sanitize command, and will be unable to print any
1325 information to let the user know what percentage of the disk has been
1328 Do not ask any questions.
1331 will ask the user if he/she really wants to sanitize the disk in question,
1332 and also if the default sanitize command timeout is acceptable.
1334 will not be asked about the timeout if a timeout is specified on the
1338 Put ATA device into IDLE state.
1341 specifies automatic standby timer value in seconds.
1342 Value 0 disables timer.
1344 Put ATA device into STANDBY state.
1347 specifies automatic standby timer value in seconds.
1348 Value 0 disables timer.
1350 Put ATA device into SLEEP state.
1351 Note that the only way get device out of
1352 this state may be reset.
1354 It optional parameter
1356 specified, enables and sets advanced power management level, where
1357 1 -- minimum power, 127 -- maximum performance with standby,
1358 128 -- minimum power without standby, 254 -- maximum performance.
1359 If not specified -- APM is disabled.
1361 It optional parameter
1363 specified, enables and sets automatic acoustic management level, where
1364 1 -- minimum noise, 254 -- maximum performance.
1365 If not specified -- AAM is disabled.
1367 Update or report security settings, using an ATA identify command (0xec).
1370 will print out the security support and associated settings of the device.
1373 command takes several arguments:
1377 Disable device security using the given password for the selected user according
1378 to the devices configured security level.
1381 Erase the device using the given password for the selected user.
1383 .Em WARNING! WARNING! WARNING!
1385 Issuing a secure erase will
1387 user data on the device and may take several hours to complete.
1389 When this command is used against an SSD drive all its cells will be marked as
1390 empty, restoring it to factory default write performance.
1391 For SSD's this action
1392 usually takes just a few seconds.
1395 Freeze the security configuration of the specified device.
1397 After command completion any other commands that update the device lock mode
1398 shall be command aborted.
1399 Frozen mode is disabled by power-off or hardware reset.
1402 Enhanced erase the device using the given password for the selected user.
1404 .Em WARNING! WARNING! WARNING!
1406 Issuing an enhanced secure erase will
1408 user data on the device and may take several hours to complete.
1410 An enhanced erase writes predetermined data patterns to all user data areas,
1411 all previously written user data shall be overwritten, including sectors that
1412 are no longer in use due to reallocation.
1415 Unlock the device using the given password for the selected user according to
1416 the devices configured security level.
1417 .It Fl l Ar high|maximum
1419 Specifies which security level to set when issuing a
1422 The security level determines device behavior when the master
1423 password is used to unlock the device.
1424 When the security level is set to high
1425 the device requires the unlock command and the master password to unlock.
1426 When the security level is set to maximum the device requires a secure erase
1427 with the master password to unlock.
1429 This option must be used in conjunction with one of the security action commands.
1435 Be quiet, do not print any status messages.
1436 This option will not disable the questions, however.
1437 To disable questions, use the
1442 Password the device (enable security) using the given password for the selected
1444 This option can be combined with other options such as
1447 A master password may be set in a addition to the user password. The purpose of
1448 the master password is to allow an administrator to establish a password that
1449 is kept secret from the user, and which may be used to unlock the device if the
1450 user password is lost.
1453 Setting the master password does not enable device security.
1455 If the master password is set and the drive supports a Master Revision Code
1456 feature the Master Password Revision Code will be decremented.
1459 Overrides the default timeout, specified in seconds, used for both
1463 this is useful if your system has problems processing long timeouts correctly.
1465 Usually the timeout is calculated from the information stored on the drive if
1466 present, otherwise it defaults to 2 hours.
1467 .It Fl U Ar user|master
1469 Specifies which user to set / use for the running action command, valid values
1470 are user or master and defaults to master if not set.
1472 This option must be used in conjunction with one of the security action commands.
1478 Confirm yes to dangerous options such as
1480 without prompting for confirmation.
1483 If the password specified for any action commands does not match the configured
1484 password for the specified user the command will fail.
1486 The password in all cases is limited to 32 characters, longer passwords will
1489 Update or report Host Protected Area details.
1492 will print out the HPA support and associated settings of the device.
1495 command takes several optional arguments:
1499 Freeze the HPA configuration of the specified device.
1501 After command completion any other commands that update the HPA configuration
1502 shall be command aborted.
1503 Frozen mode is disabled by power-off or hardware reset.
1506 Lock the HPA configuration of the device until a successful call to unlock or
1507 the next power-on reset occurs.
1510 Make the HPA max sectors persist across power-on reset or a hardware reset.
1511 This must be used in combination with
1512 .Fl s Ar max_sectors
1516 Set the HPA configuration password required for unlock calls.
1519 Be quiet, do not print any status messages.
1520 This option will not disable the questions.
1521 To disable questions, use the
1524 .It Fl s Ar max_sectors
1526 Configures the maximum user accessible sectors of the device.
1527 This will change the number of sectors the device reports.
1529 .Em WARNING! WARNING! WARNING!
1531 Changing the max sectors of a device using this option will make the data on
1532 the device beyond the specified value inaccessible.
1535 .Fl s Ar max_sectors
1536 call can be made without a power-on reset or a hardware reset of the device.
1539 Unlock the HPA configuration of the specified device using the given password.
1540 If the password specified does not match the password configured via
1542 the command will fail.
1544 After 5 failed unlock calls, due to password miss-match, the device will refuse
1545 additional unlock calls until after a power-on reset.
1548 Confirm yes to dangerous options such as
1550 without prompting for confirmation
1553 The password for all HPA commands is limited to 32 characters, longer passwords
1556 Program firmware of the named
1558 or ATA device using the image file provided.
1562 device and it provides a recommended timeout for the WRITE BUFFER command
1565 opcodes subcommand), that timeout will be used for the firmware download.
1566 The drive-recommended timeout value may be overridden on the command line
1571 Current list of supported vendors for SCSI/SAS drives:
1574 Tested with 4TB SAS drives, model number HUS724040ALS640.
1578 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1579 There is a separate table entry for hard drives, because the update method
1580 for hard drives is different than the method for tape drives.
1585 Tested with SM1625 SSDs.
1587 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1588 ES.3 (ST1000NM0023) drives.
1590 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1593 .Em WARNING! WARNING! WARNING!
1595 Little testing has been done to make sure that different device models from
1596 each vendor work correctly with the fwdownload command.
1597 A vendor name appearing in the supported list means only that firmware of at
1598 least one device type from that vendor has successfully been programmed with
1599 the fwdownload command.
1600 Extra caution should be taken when using this command since there is no
1601 guarantee it will not break a device from the listed vendors.
1602 Ensure that you have a recent backup of the data on the device before
1603 performing a firmware update.
1607 protocol devices will not be programmed, since there is little chance of
1608 the firmware download succeeding.
1611 will currently attempt a firmware download to any
1615 device, since the standard
1617 DOWNLOAD MICROCODE command may work.
1618 Firmware downloads to
1622 devices are supported for devices connected
1627 controllers, and devices connected to SAS controllers
1632 translation capability.
1638 PASS-THROUGH command to send the
1640 DOWNLOAD MICROCODE command to the drive.
1645 translation implementations don't work fully when translating
1647 WRITE BUFFER commands to
1649 DOWNLOAD MICROCODE commands, but do support
1651 passthrough well enough to do a firmware download.
1653 .It Fl f Ar fw_image
1654 Path to the firmware image file to be downloaded to the specified device.
1656 Do not print informational messages, only print errors.
1657 This option should be used with the
1659 option to suppress all output.
1661 Run in simulation mode.
1662 Device checks are run and the confirmation dialog is shown, but no firmware
1663 download will occur.
1669 errors in the event of a failure.
1671 In simulation mode, print out the
1676 register values that would be used for the firmware download command.
1678 Do not ask for confirmation.
1681 Persistent reservation support.
1682 Persistent reservations are a way to reserve a particular
1684 LUN for use by one or more
1689 option is specified,
1693 PERSISTENT RESERVE IN
1694 command using the requested service action.
1697 option is specified,
1701 PERSISTENT RESERVE OUT
1702 command using the requested service action.
1703 One of those two options is required.
1705 Persistent reservations are complex, and fully explaining them is outside
1706 the scope of this manual.
1709 and download the latest SPC spec for a full explanation of persistent
1713 Specify the service action for the PERSISTENT RESERVE IN command.
1714 Supported service actions:
1717 Report the current persistent reservation generation (PRgeneration) and any
1719 .It read_reservation
1720 Report the persistent reservation, if any.
1721 .It report_capabilities
1722 Report the persistent reservation capabilities of the LUN.
1723 .It read_full_status
1724 Report the full status of persistent reservations on the LUN.
1727 Specify the service action for the PERSISTENT RESERVE OUT command.
1728 For service actions like register that are components of other service
1729 action names, the entire name must be specified.
1730 Otherwise, enough of the service action name must be specified to
1731 distinguish it from other possible service actions.
1732 Supported service actions:
1735 Register a reservation key with the LUN or unregister a reservation key.
1736 To register a key, specify the requested key as the Service Action
1738 To unregister a key, specify the previously registered key as the
1740 To change a key, specify the old key as the Reservation Key and the new
1741 key as the Service Action Reservation Key.
1743 This is similar to the register subcommand, except that the Reservation Key
1745 The Service Action Reservation Key will overwrite any previous key
1746 registered for the initiator.
1748 Create a reservation.
1749 A key must be registered with the LUN before the LUN can be reserved, and
1750 it must be specified as the Reservation Key.
1751 The type of reservation must also be specified.
1752 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1754 Release a reservation.
1755 The Reservation Key must be specified.
1757 Release a reservation and remove all keys from the device.
1758 The Reservation Key must be specified.
1760 Remove a reservation belonging to another initiator.
1761 The Reservation Key must be specified.
1762 The Service Action Reservation Key may be specified, depending on the
1763 operation being performed.
1765 Remove a reservation belonging to another initiator and abort all
1766 outstanding commands from that initiator.
1767 The Reservation Key must be specified.
1768 The Service Action Reservation Key may be specified, depending on the
1769 operation being performed.
1771 Register another initiator with the LUN, and establish a reservation on the
1772 LUN for that initiator.
1773 The Reservation Key and Service Action Reservation Key must be specified.
1775 Replace Lost Reservation information.
1778 Set the All Target Ports (ALL_TG_PT) bit.
1779 This requests that the key registration be applied to all target ports and
1780 not just the particular target port that receives the command.
1781 This only applies to the register and register_ignore actions.
1783 Specify a Transport ID.
1784 This only applies to the Register and Register and Move service actions for
1785 Persistent Reserve Out.
1786 Multiple Transport IDs may be specified with multiple
1789 With the Register service action, specifying one or more Transport IDs
1790 implicitly enables the
1792 option which turns on the SPEC_I_PT bit.
1793 Transport IDs generally have the format protocol,id.
1796 A SAS Transport ID consists of
1798 followed by a 64-bit SAS address.
1801 .Dl sas,0x1234567812345678
1803 A Fibre Channel Transport ID consists of
1805 followed by a 64-bit Fibre Channel World Wide Name.
1808 .Dl fcp,0x1234567812345678
1810 A Parallel SCSI address consists of
1812 followed by a SCSI target ID and a relative target port identifier.
1817 An IEEE 1394 (Firewire) Transport ID consists of
1819 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1822 .Dl sbp,0x1234567812345678
1824 A SCSI over RDMA Transport ID consists of
1826 followed by a 128-bit RDMA initiator port identifier.
1827 The port identifier must be exactly 32 or 34 (if the leading 0x is
1828 included) hexadecimal digits.
1829 Only hexadecimal (base 16) numbers are supported.
1832 .Dl srp,0x12345678123456781234567812345678
1834 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1836 For example, if only the iSCSI name is specified:
1838 .Dl iqn.2012-06.com.example:target0
1840 If the iSCSI separator and initiator session ID are specified:
1842 .Dl iqn.2012-06.com.example:target0,i,0x123
1844 A SCSI over PCIe Transport ID consists of
1846 followed by a PCIe Routing ID.
1847 The Routing ID consists of a bus, device and function or in the alternate
1848 form, a bus and function.
1849 The bus must be in the range of 0 to 255 inclusive and the device must be
1850 in the range of 0 to 31 inclusive.
1851 The function must be in the range of 0 to 7 inclusive if the standard form
1852 is used, and in the range of 0 to 255 inclusive if the alternate form is
1854 For example, if a bus, device and function are specified for the standard
1859 If the alternate Routing ID form is used:
1864 Specify the Reservation Key.
1865 This may be in decimal, octal or hexadecimal format.
1866 The value is zero by default if not otherwise specified.
1867 The value must be between 0 and 2^64 - 1, inclusive.
1869 Specify the Service Action Reservation Key.
1870 This may be in decimal, octal or hexadecimal format.
1871 The value is zero by default if not otherwise specified.
1872 The value must be between 0 and 2^64 - 1, inclusive.
1874 Enable the Activate Persist Through Power Loss bit.
1875 This is only used for the register and register_ignore actions.
1876 This requests that the reservation persist across power loss events.
1878 Specify the scope of the reservation.
1879 The scope may be specified by name or by number.
1880 The scope is ignored for register, register_ignore and clear.
1881 If the desired scope isn't available by name, you may specify the number.
1885 This encompasses the entire LUN.
1887 Extent scope (0x01).
1889 Element scope (0x02).
1892 Specify the Relative Target Port.
1893 This only applies to the Register and Move service action of the Persistent
1894 Reserve Out command.
1896 Enable the SPEC_I_PT bit.
1897 This only applies to the Register service action of Persistent Reserve Out.
1898 You must also specify at least one Transport ID with
1900 if this option is set.
1901 If you specify a Transport ID, this option is automatically set.
1902 It is an error to specify this option for any service action other than
1905 Specify the reservation type.
1906 The reservation type may be specified by name or by number.
1907 If the desired reservation type isn't available by name, you may specify
1909 Supported reservation type names:
1914 Write Exclusive mode.
1915 May also be specified as
1916 .Dq write_exclusive .
1918 Read Exclusive mode.
1919 May also be specified as
1920 .Dq read_exclusive .
1922 Exclusive access mode.
1923 May also be specified as
1924 .Dq exclusive_access .
1926 Write Exclusive Registrants Only mode.
1927 May also be specified as
1928 .Dq write_exclusive_reg_only .
1930 Exclusive Access Registrants Only mode.
1931 May also be specified as
1932 .Dq exclusive_access_reg_only .
1934 Write Exclusive All Registrants mode.
1935 May also be specified as
1936 .Dq write_exclusive_all_regs .
1938 Exclusive Access All Registrants mode.
1939 May also be specified as
1940 .Dq exclusive_access_all_regs .
1943 Specify that the target should unregister the initiator that sent
1944 the Register and Move request.
1945 By default, the target will not unregister the initiator that sends the
1946 Register and Move request.
1947 This option only applies to the Register and Move service action of the
1948 Persistent Reserve Out command.
1953 READ or WRITE ATTRIBUTE commands.
1954 These commands are used to read and write attributes in Medium Auxiliary
1956 The most common place Medium Auxiliary Memory is found is small flash chips
1957 included tape cartriges.
1965 option must be specified.
1968 Specify the READ ATTRIBUTE service action.
1971 Issue the ATTRIBUTE VALUES service action.
1972 Read and decode the available attributes and their values.
1974 Issue the ATTRIBUTE LIST service action.
1975 List the attributes that are available to read and write.
1977 Issue the LOGICAL VOLUME LIST service action.
1978 List the available logical volumes in the MAM.
1980 Issue the PARTITION LIST service action.
1981 List the available partitions in the MAM.
1983 Issue the SUPPORTED ATTRIBUTES service action.
1984 List attributes that are supported for reading or writing.
1985 These attributes may or may not be currently present in the MAM.
1988 Specify an attribute to write to the MAM.
1989 This option is not yet implemented.
1991 Specify the attribute number to display.
1992 This option only works with the attr_values, attr_list and supp_attr
1996 Display cached attributes.
1997 If the device supports this flag, it allows displaying attributes for the
1998 last piece of media loaded in the drive.
2000 Specify the element address.
2001 This is used for specifying which element number in a medium changer to
2002 access when reading attributes.
2003 The element number could be for a picker, portal, slot or drive.
2004 .It Fl F Ar form1,form2
2005 Specify the output format for the attribute values (attr_val) display as a
2006 comma separated list of options.
2007 The default output is currently set to field_all,nonascii_trim,text_raw.
2008 Once this code is ported to FreeBSD 10, any text fields will be converted
2009 from their codeset to the user's native codeset with
2012 The text options are mutually exclusive; if you specify more than one, you
2013 will get unpredictable results.
2014 The nonascii options are also mutually exclusive.
2015 Most of the field options may be logically ORed together.
2018 Print text fields with non-ASCII characters escaped.
2020 Print text fields natively, with no codeset conversion.
2022 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2023 escape the non-ASCII characters.
2025 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2026 omit the non-ASCII characters.
2028 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2029 print them as they are.
2031 Print all of the prefix fields: description, attribute number, attribute
2032 size, and the attribute's readonly status.
2033 If field_all is specified, specifying any other field options will not have
2036 Print none of the prefix fields, and only print out the attribute value.
2037 If field_none is specified, specifying any other field options will result
2038 in those fields being printed.
2040 Print out the attribute description.
2042 Print out the attribute number.
2044 Print out the attribute size.
2046 Print out the attribute's readonly status.
2049 Specify the partition.
2050 When the media has multiple partitions, specifying different partition
2051 numbers allows seeing the values for each individual partition.
2052 .It Fl s Ar start_num
2053 Specify the starting attribute number.
2054 This requests that the target device return attribute information starting
2055 at the given number.
2056 .It Fl T Ar elem_type
2057 Specify the element type.
2058 For medium changer devices, this allows specifying the type the element
2059 referenced in the element address (
2070 Specify the number of the logical volume to operate on.
2071 If the media has multiple logical volumes, this will allow displaying
2072 or writing attributes on the given logical volume.
2074 Issue the REPORT SUPPORTED OPCODES service action of the
2078 Without arguments, this command will return a list of all
2080 commands supported by the device, including service actions of commands
2081 that support service actions.
2082 It will also include the
2084 CDB (Command Data Block) length for each command, and the description of
2085 each command if it is known.
2088 Request information on a specific opcode instead of the list of supported
2090 If supported, the target will return a CDB-like structure that indicates
2091 the opcode, service action (if any), and a mask of bits that are supported
2093 .It Fl s Ar service_action
2094 For commands that support a service action, specify the service action to
2097 If a service action is specified for a given opcode, and the device does
2098 not support the given service action, the device should not return a
2100 error, but rather indicate in the returned parameter data that the command
2102 By default, if a service action is specified for an opcode, and service
2103 actions are not supported for the opcode in question, the device will
2106 Include timeout values.
2107 This option works with the default display, which includes all commands
2108 supported by the device, and with the
2112 options, which request information on a specific command and service
2114 This requests that the device report Nominal and Recommended timeout values
2115 for the given command or commands.
2116 The timeout values are in seconds.
2117 The timeout descriptor also includes a command-specific
2120 Print out verbose usage information.
2125 variable allows the user to specify an alternate mode page format file.
2129 variable determines which text editor
2131 starts when editing mode pages.
2133 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2134 .It Pa /usr/share/misc/scsi_modes
2135 is the SCSI mode format database.
2137 is the transport layer device.
2139 are the CAM application passthrough devices.
2142 .Dl camcontrol eject -n cd -u 1 -v
2144 Eject the CD from cd1, and print SCSI sense information if the command
2147 .Dl camcontrol tur da0
2149 Send the SCSI test unit ready command to da0.
2152 utility will report whether the disk is ready, but will not display sense
2153 information if the command fails since the
2155 switch was not specified.
2156 .Bd -literal -offset indent
2157 camcontrol tur da1 -E -C 4 -t 50 -Q head -v
2160 Send a test unit ready command to da1.
2161 Enable kernel error recovery.
2162 Specify a retry count of 4, and a timeout of 50 seconds.
2166 flag) if the command fails.
2167 Since error recovery is turned on, the
2168 disk will be spun up if it is not currently spinning.
2171 task attribute for the command will be set to Head of Queue.
2174 utility will report whether the disk is ready.
2175 .Bd -literal -offset indent
2176 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2177 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2180 Issue a READ BUFFER command (0x3C) to cd1.
2181 Display the buffer size of cd1,
2182 and display the first 10 bytes from the cache on cd1.
2184 information if the command fails.
2185 .Bd -literal -offset indent
2186 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2187 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2190 Issue a WRITE BUFFER (0x3B) command to cd1.
2191 Write out 10 bytes of data,
2192 not including the (reserved) 4 byte header.
2193 Print out sense information if
2195 Be very careful with this command, improper use may
2196 cause data corruption.
2197 .Bd -literal -offset indent
2198 camcontrol modepage da3 -m 1 -e -P 3
2201 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2202 settings on the drive.
2203 Mode page 1 contains a disk drive's auto read and
2204 write reallocation settings, among other things.
2206 .Dl camcontrol rescan all
2208 Rescan all SCSI busses in the system for devices that have been added,
2211 .Dl camcontrol rescan 0
2213 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2215 .Dl camcontrol rescan 0:1:0
2217 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2220 .Dl camcontrol tags da5 -N 24
2222 Set the number of concurrent transactions for da5 to 24.
2223 .Bd -literal -offset indent
2224 camcontrol negotiate -n da -u 4 -T disable
2227 Disable tagged queueing for da4.
2228 .Bd -literal -offset indent
2229 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2232 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2234 Test Unit Ready command to make the settings take effect.
2235 .Bd -literal -offset indent
2236 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2239 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2241 Display SMP errors if the command fails.
2242 .Bd -literal -offset indent
2243 camcontrol security ada0
2246 Report security support and settings for ada0
2247 .Bd -literal -offset indent
2248 camcontrol security ada0 -U user -s MyPass
2251 Enable security on device ada0 with the password MyPass
2252 .Bd -literal -offset indent
2253 camcontrol security ada0 -U user -e MyPass
2256 Secure erase ada0 which has had security enabled with user password MyPass
2258 .Em WARNING! WARNING! WARNING!
2262 data from the device, so backup your data before using!
2264 This command can be used against an SSD drive to restoring it to
2265 factory default write performance.
2266 .Bd -literal -offset indent
2270 Report HPA support and settings for ada0 (also reported via
2272 .Bd -literal -offset indent
2273 camcontrol hpa ada0 -s 10240
2276 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2278 .Em WARNING! WARNING! WARNING!
2282 to all data on the device beyond this limit until HPA is disabled by setting
2283 HPA to native max sectors of the device, which can only be done after a
2284 power-on or hardware reset!
2287 use this on a device which has an active filesystem!
2289 .Bd -literal -offset indent
2290 camcontrol persist da0 -v -i read_keys
2293 This will read any persistent reservation keys registered with da0, and
2294 display any errors encountered when sending the PERSISTENT RESERVE IN
2297 .Bd -literal -offset indent
2298 camcontrol persist da0 -v -o register -a -K 0x12345678
2301 This will register the persistent reservation key 0x12345678 with da0,
2302 apply that registration to all ports on da0, and display any errors that
2303 occur when sending the PERSISTENT RESERVE OUT command.
2304 .Bd -literal -offset indent
2305 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2308 This will reserve da0 for the exlusive use of the initiator issuing the
2310 The scope of the reservation is the entire LUN.
2311 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2312 .Bd -literal -offset indent
2313 camcontrol persist da0 -v -i read_full
2316 This will display the full status of all reservations on da0 and print out
2317 status if there are any errors.
2318 .Bd -literal -offset indent
2319 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2322 This will release a reservation on da0 of the type ex_ac
2324 The Reservation Key for this registration is 0x12345678.
2325 Any errors that occur will be displayed.
2326 .Bd -literal -offset indent
2327 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2328 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2331 This will register the key 0x12345678 with da0, specifying that it applies
2332 to the SAS initiators with SAS addresses 0x1234567812345678 and
2334 .Bd -literal -offset indent
2335 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2336 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2339 This will move the registration from the current initiator, whose
2340 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2341 Fiber Channel World Wide Node Name 0x1234567812345678.
2342 A new registration key, 0x12345678, will be registered for the initiator
2343 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2344 current initiator will be unregistered from the target.
2345 The reservation will be moved to relative target port 2 on the target
2347 The registration will persist across power losses.
2349 .Bd -literal -offset indent
2350 camcontrol attrib sa0 -v -i attr_values -p 1
2353 This will read and decode the attribute values from partition 1 on the tape
2354 in tape drive sa0, and will display any
2359 .Xr cam_cdbparse 3 ,
2366 utility first appeared in
2369 The mode page editing code and arbitrary SCSI command code are based upon
2374 library, written by Julian Elischer and Peter Dufault.
2377 program first appeared in
2379 and first appeared in
2384 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2386 The code that parses the generic command line arguments does not know that
2387 some of the subcommands take multiple arguments.
2388 So if, for instance, you
2389 tried something like this:
2390 .Bd -literal -offset indent
2391 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2394 The sense information from the test unit ready command would not get
2395 printed out, since the first
2399 bails out when it sees the second argument to
2403 Fixing this behavior would take some gross code, or changes to the
2406 The best way to circumvent this problem is to always make sure
2409 arguments before any command-specific arguments.
projects / FreeBSD / stable / 10.git / blob