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
49 .Op Fl u Ar unit_number
72 .Op Fl r Ar reporttype
101 .Aq all | bus Ns Op :target:lun
104 .Aq all | bus Ns Op :target:lun
116 .Aq Fl m Ar page | Fl l
124 .Aq Fl a Ar cmd Op args
125 .Aq Fl c Ar cmd Op args
128 .Op Fl i Ar len Ar fmt
130 .Op Fl o Ar len Ar fmt Op args
142 .Aq all|off|bus Ns Op :target Ns Op :lun
155 .Op Fl D Ar enable|disable
160 .Op Fl T Ar enable|disable
162 .Op Fl W Ar bus_width
195 .Op Fl l Ar high|maximum
199 .Op Fl U Ar user|master
206 utility is designed to provide a way for users to access and control the
213 can cause a loss of data and/or system crashes if used improperly.
215 expert users are encouraged to exercise caution when using this command.
216 Novice users should stay away from this utility.
220 utility has a number of primary functions, many of which support an optional
222 A device identifier can take one of three forms:
225 Specify a device name and unit number combination, like "da5" or "cd3".
227 Specify a bus number and target id.
228 The bus number can be determined from
230 .Dq camcontrol devlist .
231 The lun defaults to 0.
233 Specify the bus, target and lun for a device.
237 The device identifier, if it is specified,
239 come immediately after the function name, and before any generic or
240 function-specific arguments.
245 arguments described below will override any device name or unit number
246 specified beforehand.
253 override a specified bus:target or bus:target:lun, however.
257 primary functions support these generic arguments:
260 SCSI command retry count.
261 In order for this to work, error recovery
265 Instruct the kernel to perform generic SCSI error recovery for the given
267 This is needed in order for the retry count
270 Other than retrying commands, the generic error recovery in
271 the code will generally attempt to spin up drives that are not spinning.
272 It may take some other actions, depending upon the sense code returned from
275 Specify the device type to operate on, e.g.\& "da", "cd".
277 SCSI command timeout in seconds.
278 This overrides the default timeout for
280 .It Fl u Ar unit_number
281 Specify the device unit number, e.g.\& "1", "5".
283 Be verbose, print out sense information for failed SCSI commands.
286 Primary command functions:
287 .Bl -tag -width periphlist
289 List all physical devices (logical units) attached to the CAM subsystem.
290 This also includes a list of peripheral drivers attached to each device.
293 argument, SCSI bus number, adapter name and unit numbers are printed as
296 List all peripheral drivers attached to a given physical device (logical
299 Send the SCSI test unit ready (0x00) command to the given device.
302 utility will report whether the device is ready or not.
304 Send a SCSI inquiry command (0x12) to a device.
307 will print out the standard inquiry data, device serial number, and
308 transfer rate information.
309 The user can specify that only certain types of
310 inquiry data be printed:
313 Get the standard inquiry data.
315 Print out the serial number.
316 If this flag is the only one specified,
318 will not print out "Serial Number" before the value returned by the drive.
319 This is to aid in script writing.
321 Print out transfer rate information.
324 Send a ATA identify command (0xec) to a device.
326 Send the SCSI REPORT LUNS (0xA0) command to the given device.
329 will print out the list of logical units (LUNs) supported by the target device.
330 There are a couple of options to modify the output:
333 Just print out a count of LUNs, not the actual LUN numbers.
335 Just print out the LUNs, and don't print out the count.
336 .It Fl r Ar reporttype
337 Specify the type of report to request from the target:
338 .Bl -tag -width 012345678
340 Return the default report.
344 Most targets will support this report if they support the REPORT LUNS
347 Return only well known LUNs.
349 Return all available LUNs.
354 will try to print out LUN numbers in a reasonable format.
355 It can understand the peripheral, flat, LUN and extended LUN formats.
357 Send the SCSI READ CAPACITY command to the given device and display
359 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
360 action will be sent to obtain the full size of the device.
363 will print out the last logical block of the device, and the blocksize of
365 To modify the output format, use the following options:
368 Just print out the blocksize, not the last block or device size.
369 This cannot be used with
374 Print out the device size in human readable (base 2, 1K == 1024) format.
377 and cannot be used with
382 Print out the device size in human readable (base 10, 1K == 1000) format.
384 Print out the number of blocks in the device instead of the last logical
387 Quiet, print out the numbers only (separated by a comma if
393 Print out the last logical block or the size of the device only, and omit
397 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
400 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
403 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
404 start bit set and the load/eject bit set.
406 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
407 start bit cleared and the load/eject bit set.
409 Tell the kernel to scan all busses in the system (with the
411 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
412 (XPT_SCAN_LUN) for new devices or devices that have gone away.
414 may specify a scan of all busses, a single bus, or a lun.
416 on a target is not supported.
418 Tell the kernel to reset all busses in the system (with the
420 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
421 reset for that bus, or to reset the given bus:target:lun
422 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
423 connecting to that device.
424 Note that this can have a destructive impact
427 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
428 print out any combination of: the total number of defects, the primary
429 defect list (PLIST), and the grown defect list (GLIST).
432 The three format options are:
434 to print out the list as logical blocks,
436 to print out the list in bytes from index format, and
438 to print out the list in physical sector format.
439 The format argument is
441 Most drives support the physical sector format.
443 support the logical block format.
444 Many drives, if they do not support the
445 requested format, return the data in an alternate format, along with sense
446 information indicating that the requested data format is not supported.
450 attempts to detect this, and print out whatever format the drive returns.
451 If the drive uses a non-standard sense code to report that it does not
452 support the requested format,
454 will probably see the error as a failure to complete the request.
456 Print out the grown defect list.
457 This is a list of bad blocks that have
458 been remapped since the disk left the factory.
460 Print out the primary defect list.
469 will print out the number of defects given in the READ DEFECT DATA header
470 returned from the drive.
472 Allows the user to display and optionally edit a SCSI mode page.
474 page formats are located in
475 .Pa /usr/share/misc/scsi_modes .
476 This can be overridden by specifying a different file in the
478 environment variable.
481 command takes several arguments:
484 Disable block descriptors for mode sense.
486 Displays mode page data in binary format.
488 This flag allows the user to edit values in the mode page.
490 either edit mode page values with the text editor pointed to by his
492 environment variable, or supply mode page values via standard input, using
495 uses to display mode page values.
496 The editor will be invoked if
498 detects that standard input is terminal.
500 Lists all available mode pages.
501 .It Fl m Ar mode_page
502 This specifies the number of the mode page the user would like to view
504 This argument is mandatory unless
508 This allows the user to specify the page control field.
510 .Bl -tag -width xxx -compact
522 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
525 function requires the
527 argument to specify SCSI CDB or the
529 argument to specify ATA Command Block registers values.
530 Other arguments are optional, depending on
532 The command and data specification syntax is documented
535 NOTE: If the CDB specified causes data to be transfered to or from the
536 SCSI device in question, you MUST specify either
541 .It Fl a Ar cmd Op args
542 This specifies the content of 12 ATA Command Block registers (command,
543 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
544 lba_high_exp, features_exp, sector_count, sector_count_exp).
545 .It Fl c Ar cmd Op args
546 This specifies the SCSI CDB.
547 SCSI CDBs may be 6, 10, 12 or 16 bytes.
549 Specifies DMA protocol to be used for ATA command.
551 Specifies FPDMA (NCQ) protocol to be used for ATA command.
552 .It Fl i Ar len Ar fmt
553 This specifies the amount of data to read, and how it should be displayed.
557 bytes of data will be read from the device and written to standard output.
558 .It Fl o Ar len Ar fmt Op args
559 This specifies the amount of data to be written to a device, and the data
560 that is to be written.
564 bytes of data will be read from standard input and written to the device.
566 This specifies that 11 result ATA Command Block registers should be displayed
567 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
568 lba_high_exp, sector_count, sector_count_exp), and how.
571 11 result registers will be written to standard output in hex.
574 Turn on CAM debugging printfs in the kernel.
575 This requires options CAMDEBUG
576 in your kernel config file.
577 WARNING: enabling debugging printfs currently
578 causes an EXTREME number of kernel printfs.
579 You may have difficulty
580 turning off the debugging printfs once they start, since the kernel will be
581 busy printing messages and unable to service other requests quickly.
584 function takes a number of arguments:
587 Enable CAM_DEBUG_INFO printfs.
589 Enable CAM_DEBUG_PERIPH printfs.
591 Enable CAM_DEBUG_TRACE printfs.
593 Enable CAM_DEBUG_SUBTRACE printfs.
595 Enable CAM_DEBUG_XPT printfs.
597 Enable CAM_DEBUG_CDB printfs.
598 This will cause the kernel to print out the
599 SCSI CDBs sent to the specified device(s).
601 Enable CAM_DEBUG_PROBE printfs.
603 Enable debugging for all devices.
605 Turn off debugging for all devices
606 .It bus Ns Op :target Ns Op :lun
607 Turn on debugging for the given bus, target or lun.
609 and lun are not specified, they are wildcarded.
610 (i.e., just specifying a
611 bus turns on debugging printfs for all devices on that bus.)
614 Show or set the number of "tagged openings" or simultaneous transactions
615 we attempt to queue to a particular device.
618 command, with no command-specific arguments (i.e., only generic arguments)
619 prints out the "soft" maximum number of transactions that can be queued to
620 the device in question.
621 For more detailed information, use the
623 argument described below.
626 Set the number of tags for the given device.
627 This must be between the
628 minimum and maximum number set in the kernel quirk table.
630 most devices that support tagged queueing is a minimum of 2 and a maximum
632 The minimum and maximum values for a given device may be
633 determined by using the
640 subcommand is described below.
642 Be quiet, and do not report the number of tags.
643 This is generally used when
644 setting the number of tags.
646 The verbose flag has special functionality for the
651 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
654 This is the amount of capacity for transactions queued to a given device.
656 This is the number of transactions currently queued to a device.
658 This is the kernel queue space for transactions.
659 This count usually mirrors
660 dev_openings except during error recovery operations when
661 the device queue is frozen (device is not allowed to receive
662 commands), the number of dev_openings is reduced, or transaction
665 This is the number of transactions waiting in the kernel queue for capacity
667 This number is usually zero unless error recovery is in
670 The held count is the number of CCBs held by peripheral drivers that have
671 either just been completed or are about to be released to the transport
672 layer for service by a device.
673 Held CCBs reserve capacity on a given
676 This is the current "hard" minimum number of transactions that can be
677 queued to a device at once.
680 value above cannot go below this number.
681 The default value for
683 is 2, although it may be set higher or lower for various devices.
685 This is the "hard" maximum number of transactions that can be queued to a
689 value cannot go above this number.
690 The default value for
692 is 255, although it may be set higher or lower for various devices.
696 Show or negotiate various communication parameters.
698 not support setting or changing some of these values.
700 Adaptec 174x controllers do not support changing a device's sync rate or
705 will not attempt to set the parameter if the controller indicates that it
706 does not support setting the parameter.
707 To find out what the controller
715 command is described below.
716 Also, some controller drivers do not support
717 setting negotiation parameters, even if the underlying controller supports
719 Some controllers, such as the Advansys wide
720 controllers, support enabling and disabling synchronous negotiation for
721 a device, but do not support setting the synchronous negotiation rate.
724 Attempt to make the negotiation settings take effect immediately by sending
725 a Test Unit Ready command to the device.
727 Show or set current negotiation settings.
729 .It Fl D Ar enable|disable
730 Enable or disable disconnection.
734 Set the command delay offset.
736 Be quiet, do not print anything.
737 This is generally useful when you want to
738 set a parameter, but do not want any status information.
740 Change the synchronization rate for a device.
741 The sync rate is a floating
742 point value specified in MHz.
745 is a legal value, as is
747 .It Fl T Ar enable|disable
748 Enable or disable tagged queueing for a device.
750 Show or set user negotiation settings.
751 The default is to show or set
752 current negotiation settings.
754 The verbose switch has special meaning for the
759 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
761 .It Fl W Ar bus_width
762 Specify the bus width to negotiate with a device.
765 The only useful values to specify are 8, 16, and 32
767 The controller must support the bus width in question in order for
768 the setting to take effect.
771 In general, sync rate and offset settings will not take effect for a
772 device until a command has been sent to the device.
775 switch above will automatically send a Test Unit Ready to the device so
776 negotiation parameters will take effect.
780 FORMAT UNIT command to the named device.
782 .Em WARNING! WARNING! WARNING!
784 Low level formatting a disk will destroy ALL data on the disk.
786 extreme caution when issuing this command.
787 Many users low-level format
788 disks that do not really need to be low-level formatted.
790 relatively few scenarios that call for low-level formatting a disk.
792 low-level formatting a disk is to initialize the disk after changing
793 its physical sector size.
794 Another reason for low-level formatting a disk
795 is to revive the disk if you are getting "medium format corrupted" errors
796 from the disk in response to read and write requests.
798 Some disks take longer than others to format.
799 Users should specify a
800 timeout long enough to allow the format to complete.
802 timeout is 3 hours, which should be long enough for most disks.
804 disks will complete a format operation in a very short period of time
805 (on the order of 5 minutes or less).
806 This is often because the drive
807 does not really support the FORMAT UNIT command -- it just accepts the
808 command, waits a few minutes and then returns it.
812 subcommand takes several arguments that modify its default behavior.
817 arguments can be useful for scripts.
821 Be quiet, do not print any status messages.
822 This option will not disable
823 the questions, however.
824 To disable questions, use the
831 This will report status on a format that is already running on the drive.
833 Issue a non-immediate format command.
836 issues the FORMAT UNIT command with the immediate bit set.
838 device to immediately return the format command, before the format has
844 sense information from the device every second to determine how far along
845 in the format process it is.
848 argument is specified,
850 will issue a non-immediate format command, and will be unable to print any
851 information to let the user know what percentage of the disk has been
854 Do not ask any questions.
857 will ask the user if he/she really wants to format the disk in question,
858 and also if the default format command timeout is acceptable.
860 will not be asked about the timeout if a timeout is specified on the
864 Put ATA device into IDLE state. Optional parameter
866 specifies automatic standby timer value in seconds. Value 0 disables timer.
868 Put ATA device into STANDBY state. Optional parameter
870 specifies automatic standby timer value in seconds. Value 0 disables timer.
872 Put ATA device into SLEEP state. Note that the only way get device out of
873 this state may be reset.
875 Update or report security settings, using an ATA identify command (0xec).
878 will print out the security support and associated settings of the device.
881 command takes several arguments:
885 Disable device security using the given password for the selected user according
886 to the devices configured security level.
889 Erase the device using the given password for the selected user.
891 .Em WARNING! WARNING! WARNING!
893 Issuing a secure erase will
895 user data on the device and may take several hours to complete.
897 When this command is used against an SSD drive all its cells will be marked as
898 empty, restoring it to factory default write performance. For SSD's this action
899 usually takes just a few seconds.
902 Freeze the security configuration of the specified device.
904 After command completion any other commands that update the device lock mode
905 shall be command aborted. Frozen mode is disabled by power-off or hardware reset.
908 Enhanced erase the device using the given password for the selected user.
910 .Em WARNING! WARNING! WARNING!
912 Issuing an enhanced secure erase will
914 user data on the device and may take several hours to complete.
916 An enhanced erase writes predetermined data patterns to all user data areas,
917 all previously written user data shall be overwritten, including sectors that
918 are no longer in use due to reallocation.
921 Unlock the device using the given password for the selected user according to
922 the devices configured security level.
923 .It Fl l Ar high|maximum
925 Specifies which security level to set when issuing a
927 command. The security level determines device behavior when the master
928 password is used to unlock the device. When the security level is set to high
929 the device requires the unlock command and the master password to unlock.
930 When the security level is set to maximum the device requires a secure erase
931 with the master password to unlock.
933 This option must be used in conjunction with one of the security action commands.
939 Be quiet, do not print any status messages.
940 This option will not disable the questions, however.
941 To disable questions, use the
946 Password the device (enable security) using the given password for the selected
947 user. This option can be combined with other options such as
950 A master password may be set in a addition to the user password. The purpose of
951 the master password is to allow an administrator to establish a password that
952 is kept secret from the user, and which may be used to unlock the device if the
953 user password is lost.
956 Setting the master password does not enable device security.
958 If the master password is set and the drive supports a Master Revision Code
959 feature the Master Password Revision Code will be decremented.
962 Overrides the default timeout, specified in seconds, used for both
966 this is useful if your system has problems processing long timeouts correctly.
968 Usually the timeout is calculated from the information stored on the drive if
969 present, otherwise it defaults to 2 hours.
970 .It Fl U Ar user|master
972 Specifies which user to set / use for the running action command, valid values
973 are user or master and defaults to master if not set.
975 This option must be used in conjunction with one of the security action commands.
981 Confirm yes to dangerous options such as
983 without prompting for confirmation.
986 If the password specified for any action commands doesn't match the configured
987 password for the specified user the command will fail.
989 The password in all cases is limited to 32 characters, longer passwords will
992 Print out verbose usage information.
997 variable allows the user to specify an alternate mode page format file.
1001 variable determines which text editor
1003 starts when editing mode pages.
1005 .Bl -tag -width /usr/share/misc/scsi_modes -compact
1006 .It Pa /usr/share/misc/scsi_modes
1007 is the SCSI mode format database.
1009 is the transport layer device.
1011 are the CAM application passthrough devices.
1014 .Dl camcontrol eject -n cd -u 1 -v
1016 Eject the CD from cd1, and print SCSI sense information if the command
1019 .Dl camcontrol tur da0
1021 Send the SCSI test unit ready command to da0.
1024 utility will report whether the disk is ready, but will not display sense
1025 information if the command fails since the
1027 switch was not specified.
1029 .Bd -literal -offset indent
1030 camcontrol tur da1 -E -C 4 -t 50 -v
1033 Send a test unit ready command to da1.
1034 Enable kernel error recovery.
1035 Specify a retry count of 4, and a timeout of 50 seconds.
1039 flag) if the command fails.
1040 Since error recovery is turned on, the
1041 disk will be spun up if it is not currently spinning.
1044 utility will report whether the disk is ready.
1045 .Bd -literal -offset indent
1046 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
1047 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
1050 Issue a READ BUFFER command (0x3C) to cd1.
1051 Display the buffer size of cd1,
1052 and display the first 10 bytes from the cache on cd1.
1054 information if the command fails.
1056 .Bd -literal -offset indent
1057 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
1058 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
1061 Issue a WRITE BUFFER (0x3B) command to cd1.
1062 Write out 10 bytes of data,
1063 not including the (reserved) 4 byte header.
1064 Print out sense information if
1066 Be very careful with this command, improper use may
1067 cause data corruption.
1069 .Bd -literal -offset indent
1070 camcontrol modepage da3 -m 1 -e -P 3
1073 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
1074 settings on the drive.
1075 Mode page 1 contains a disk drive's auto read and
1076 write reallocation settings, among other things.
1078 .Dl camcontrol rescan all
1080 Rescan all SCSI busses in the system for devices that have been added,
1083 .Dl camcontrol rescan 0
1085 Rescan SCSI bus 0 for devices that have been added, removed or changed.
1087 .Dl camcontrol rescan 0:1:0
1089 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
1092 .Dl camcontrol tags da5 -N 24
1094 Set the number of concurrent transactions for da5 to 24.
1096 .Bd -literal -offset indent
1097 camcontrol negotiate -n da -u 4 -T disable
1100 Disable tagged queueing for da4.
1102 .Bd -literal -offset indent
1103 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
1106 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
1108 Test Unit Ready command to make the settings take effect.
1109 .Bd -literal -offset indent
1110 camcontrol security ada0
1113 Report security support and settings for ada0
1114 .Bd -literal -offset indent
1115 camcontrol security ada0 -u user -s MyPass
1118 Enable security on device ada0 with the password MyPass
1119 .Bd -literal -offset indent
1120 camcontrol security ada0 -u user -e MyPass
1123 Secure erase ada0 which has had security enabled with user password MyPass
1125 .Em WARNING! WARNING! WARNING!
1129 data from the device, so backup your data before using!
1131 This command can be used used against an SSD drive to restoring it to
1132 factory default write performance.
1135 .Xr cam_cdbparse 3 ,
1142 utility first appeared in
1145 The mode page editing code and arbitrary SCSI command code are based upon
1150 library, written by Julian Elischer and Peter Dufault.
1153 program first appeared in
1155 and first appeared in
1160 .An Kenneth Merry Aq ken@FreeBSD.org
1162 The code that parses the generic command line arguments does not know that
1163 some of the subcommands take multiple arguments.
1164 So if, for instance, you
1165 tried something like this:
1166 .Bd -literal -offset indent
1167 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
1170 The sense information from the test unit ready command would not get
1171 printed out, since the first
1175 bails out when it sees the second argument to
1179 Fixing this behavior would take some gross code, or changes to the
1182 The best way to circumvent this problem is to always make sure
1185 arguments before any command-specific arguments.
projects / FreeBSD / stable / 8.git / blob