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
71 .Op Fl r Ar reporttype
100 .Aq all | bus Ns Op :target:lun
103 .Aq all | bus Ns Op :target:lun
115 .Aq Fl m Ar page | Fl l
123 .Aq Fl a Ar cmd Op args
124 .Aq Fl c Ar cmd Op args
125 .Op Fl i Ar len Ar fmt
127 .Op Fl o Ar len Ar fmt Op args
138 .Aq all|off|bus Ns Op :target Ns Op :lun
151 .Op Fl D Ar enable|disable
156 .Op Fl T Ar enable|disable
158 .Op Fl W Ar bus_width
187 utility is designed to provide a way for users to access and control the
194 can cause a loss of data and/or system crashes if used improperly.
196 expert users are encouraged to exercise caution when using this command.
197 Novice users should stay away from this utility.
201 utility has a number of primary functions, many of which support an optional
203 A device identifier can take one of three forms:
206 Specify a device name and unit number combination, like "da5" or "cd3".
207 Note that character device node names (e.g.\& /dev/da0) are
211 Specify a bus number and target id.
212 The bus number can be determined from
214 .Dq camcontrol devlist .
215 The lun defaults to 0.
217 Specify the bus, target and lun for a device.
221 The device identifier, if it is specified,
223 come immediately after the function name, and before any generic or
224 function-specific arguments.
229 arguments described below will override any device name or unit number
230 specified beforehand.
237 override a specified bus:target or bus:target:lun, however.
241 primary functions support these generic arguments:
244 SCSI command retry count.
245 In order for this to work, error recovery
249 Instruct the kernel to perform generic SCSI error recovery for the given
251 This is needed in order for the retry count
254 Other than retrying commands, the generic error recovery in
255 the code will generally attempt to spin up drives that are not spinning.
256 It may take some other actions, depending upon the sense code returned from
259 Specify the device type to operate on, e.g.\& "da", "cd".
261 SCSI command timeout in seconds.
262 This overrides the default timeout for
264 .It Fl u Ar unit_number
265 Specify the device unit number, e.g.\& "1", "5".
267 Be verbose, print out sense information for failed SCSI commands.
270 Primary command functions:
271 .Bl -tag -width periphlist
273 List all physical devices (logical units) attached to the CAM subsystem.
274 This also includes a list of peripheral drivers attached to each device.
277 argument, SCSI bus number, adapter name and unit numbers are printed as
280 List all peripheral drivers attached to a given physical device (logical
283 Send the SCSI test unit ready (0x00) command to the given device.
286 utility will report whether the device is ready or not.
288 Send a SCSI inquiry command (0x12) to a device.
291 will print out the standard inquiry data, device serial number, and
292 transfer rate information.
293 The user can specify that only certain types of
294 inquiry data be printed:
297 Get the standard inquiry data.
299 Print out the serial number.
300 If this flag is the only one specified,
302 will not print out "Serial Number" before the value returned by the drive.
303 This is to aid in script writing.
305 Print out transfer rate information.
308 Send a ATA identify command (0xec) to a device.
310 Send the SCSI REPORT LUNS (0xA0) command to the given device.
313 will print out the list of logical units (LUNs) supported by the target device.
314 There are a couple of options to modify the output:
317 Just print out a count of LUNs, not the actual LUN numbers.
319 Just print out the LUNs, and don't print out the count.
320 .It Fl r Ar reporttype
321 Specify the type of report to request from the target:
322 .Bl -tag -width 012345678
324 Return the default report.
328 Most targets will support this report if they support the REPORT LUNS
331 Return only well known LUNs.
333 Return all available LUNs.
338 will try to print out LUN numbers in a reasonable format.
339 It can understand the peripheral, flat, LUN and extended LUN formats.
341 Send the SCSI READ CAPACITY command to the given device and display
343 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
344 action will be sent to obtain the full size of the device.
347 will print out the last logical block of the device, and the blocksize of
349 To modify the output format, use the following options:
352 Just print out the blocksize, not the last block or device size.
353 This cannot be used with
358 Print out the device size in human readable (base 2, 1K == 1024) format.
361 and cannot be used with
366 Print out the device size in human readable (base 10, 1K == 1000) format.
368 Print out the number of blocks in the device instead of the last logical
371 Quiet, print out the numbers only (separated by a comma if
377 Print out the last logical block or the size of the device only, and omit
381 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
384 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
387 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
388 start bit set and the load/eject bit set.
390 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
391 start bit cleared and the load/eject bit set.
393 Tell the kernel to scan all busses in the system (with the
395 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
396 (XPT_SCAN_LUN) for new devices or devices that have gone away.
398 may specify a scan of all busses, a single bus, or a lun.
400 on a target is not supported.
402 Tell the kernel to reset all busses in the system (with the
404 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
405 reset for that bus, or to reset the given bus:target:lun
406 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
407 connecting to that device.
408 Note that this can have a destructive impact
411 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
412 print out any combination of: the total number of defects, the primary
413 defect list (PLIST), and the grown defect list (GLIST).
416 The three format options are:
418 to print out the list as logical blocks,
420 to print out the list in bytes from index format, and
422 to print out the list in physical sector format.
423 The format argument is
425 Most drives support the physical sector format.
427 support the logical block format.
428 Many drives, if they do not support the
429 requested format, return the data in an alternate format, along with sense
430 information indicating that the requested data format is not supported.
434 attempts to detect this, and print out whatever format the drive returns.
435 If the drive uses a non-standard sense code to report that it does not
436 support the requested format,
438 will probably see the error as a failure to complete the request.
440 Print out the grown defect list.
441 This is a list of bad blocks that have
442 been remapped since the disk left the factory.
444 Print out the primary defect list.
453 will print out the number of defects given in the READ DEFECT DATA header
454 returned from the drive.
456 Allows the user to display and optionally edit a SCSI mode page.
458 page formats are located in
459 .Pa /usr/share/misc/scsi_modes .
460 This can be overridden by specifying a different file in the
462 environment variable.
465 command takes several arguments:
468 Disable block descriptors for mode sense.
470 Displays mode page data in binary format.
472 This flag allows the user to edit values in the mode page.
474 either edit mode page values with the text editor pointed to by his
476 environment variable, or supply mode page values via standard input, using
479 uses to display mode page values.
480 The editor will be invoked if
482 detects that standard input is terminal.
484 Lists all available mode pages.
485 .It Fl m Ar mode_page
486 This specifies the number of the mode page the user would like to view
488 This argument is mandatory unless
492 This allows the user to specify the page control field.
494 .Bl -tag -width xxx -compact
506 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
509 function requires the
511 argument to specify SCSI CDB or the
513 argument to specify ATA Command Block registers values.
514 Other arguments are optional, depending on
516 The command and data specification syntax is documented
519 NOTE: If the CDB specified causes data to be transfered to or from the
520 SCSI device in question, you MUST specify either
525 .It Fl a Ar cmd Op args
526 This specifies the content of 12 ATA Command Block registers (command,
527 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
528 lba_high_exp, features_exp, sector_count, sector_count_exp).
529 .It Fl c Ar cmd Op args
530 This specifies the SCSI CDB.
531 SCSI CDBs may be 6, 10, 12 or 16 bytes.
532 .It Fl i Ar len Ar fmt
533 This specifies the amount of data to read, and how it should be displayed.
537 bytes of data will be read from the device and written to standard output.
538 .It Fl o Ar len Ar fmt Op args
539 This specifies the amount of data to be written to a device, and the data
540 that is to be written.
544 bytes of data will be read from standard input and written to the device.
546 This specifies that 11 result ATA Command Block registers should be displayed
547 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
548 lba_high_exp, sector_count, sector_count_exp), and how.
551 11 result registers will be written to standard output in hex.
554 Turn on CAM debugging printfs in the kernel.
555 This requires options CAMDEBUG
556 in your kernel config file.
557 WARNING: enabling debugging printfs currently
558 causes an EXTREME number of kernel printfs.
559 You may have difficulty
560 turning off the debugging printfs once they start, since the kernel will be
561 busy printing messages and unable to service other requests quickly.
564 function takes a number of arguments:
567 Enable CAM_DEBUG_INFO printfs.
569 Enable CAM_DEBUG_PERIPH printfs.
571 Enable CAM_DEBUG_TRACE printfs.
573 Enable CAM_DEBUG_SUBTRACE printfs.
575 Enable CAM_DEBUG_XPT printfs.
577 Enable CAM_DEBUG_CDB printfs.
578 This will cause the kernel to print out the
579 SCSI CDBs sent to the specified device(s).
581 Enable debugging for all devices.
583 Turn off debugging for all devices
584 .It bus Ns Op :target Ns Op :lun
585 Turn on debugging for the given bus, target or lun.
587 and lun are not specified, they are wildcarded.
588 (i.e., just specifying a
589 bus turns on debugging printfs for all devices on that bus.)
592 Show or set the number of "tagged openings" or simultaneous transactions
593 we attempt to queue to a particular device.
596 command, with no command-specific arguments (i.e., only generic arguments)
597 prints out the "soft" maximum number of transactions that can be queued to
598 the device in question.
599 For more detailed information, use the
601 argument described below.
604 Set the number of tags for the given device.
605 This must be between the
606 minimum and maximum number set in the kernel quirk table.
608 most devices that support tagged queueing is a minimum of 2 and a maximum
610 The minimum and maximum values for a given device may be
611 determined by using the
618 subcommand is described below.
620 Be quiet, and do not report the number of tags.
621 This is generally used when
622 setting the number of tags.
624 The verbose flag has special functionality for the
629 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
632 This is the amount of capacity for transactions queued to a given device.
634 This is the number of transactions currently queued to a device.
636 This is the kernel queue space for transactions.
637 This count usually mirrors
638 dev_openings except during error recovery operations when
639 the device queue is frozen (device is not allowed to receive
640 commands), the number of dev_openings is reduced, or transaction
643 This is the number of transactions waiting in the kernel queue for capacity
645 This number is usually zero unless error recovery is in
648 The held count is the number of CCBs held by peripheral drivers that have
649 either just been completed or are about to be released to the transport
650 layer for service by a device.
651 Held CCBs reserve capacity on a given
654 This is the current "hard" minimum number of transactions that can be
655 queued to a device at once.
658 value above cannot go below this number.
659 The default value for
661 is 2, although it may be set higher or lower for various devices.
663 This is the "hard" maximum number of transactions that can be queued to a
667 value cannot go above this number.
668 The default value for
670 is 255, although it may be set higher or lower for various devices.
674 Show or negotiate various communication parameters.
676 not support setting or changing some of these values.
678 Adaptec 174x controllers do not support changing a device's sync rate or
683 will not attempt to set the parameter if the controller indicates that it
684 does not support setting the parameter.
685 To find out what the controller
693 command is described below.
694 Also, some controller drivers do not support
695 setting negotiation parameters, even if the underlying controller supports
697 Some controllers, such as the Advansys wide
698 controllers, support enabling and disabling synchronous negotiation for
699 a device, but do not support setting the synchronous negotiation rate.
702 Attempt to make the negotiation settings take effect immediately by sending
703 a Test Unit Ready command to the device.
705 Show or set current negotiation settings.
707 .It Fl D Ar enable|disable
708 Enable or disable disconnection.
712 Set the command delay offset.
714 Be quiet, do not print anything.
715 This is generally useful when you want to
716 set a parameter, but do not want any status information.
718 Change the synchronization rate for a device.
719 The sync rate is a floating
720 point value specified in MHz.
723 is a legal value, as is
725 .It Fl T Ar enable|disable
726 Enable or disable tagged queueing for a device.
728 Show or set user negotiation settings.
729 The default is to show or set
730 current negotiation settings.
732 The verbose switch has special meaning for the
737 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
739 .It Fl W Ar bus_width
740 Specify the bus width to negotiate with a device.
743 The only useful values to specify are 8, 16, and 32
745 The controller must support the bus width in question in order for
746 the setting to take effect.
749 In general, sync rate and offset settings will not take effect for a
750 device until a command has been sent to the device.
753 switch above will automatically send a Test Unit Ready to the device so
754 negotiation parameters will take effect.
758 FORMAT UNIT command to the named device.
760 .Em WARNING! WARNING! WARNING!
762 Low level formatting a disk will destroy ALL data on the disk.
764 extreme caution when issuing this command.
765 Many users low-level format
766 disks that do not really need to be low-level formatted.
768 relatively few scenarios that call for low-level formatting a disk.
770 low-level formatting a disk is to initialize the disk after changing
771 its physical sector size.
772 Another reason for low-level formatting a disk
773 is to revive the disk if you are getting "medium format corrupted" errors
774 from the disk in response to read and write requests.
776 Some disks take longer than others to format.
777 Users should specify a
778 timeout long enough to allow the format to complete.
780 timeout is 3 hours, which should be long enough for most disks.
782 disks will complete a format operation in a very short period of time
783 (on the order of 5 minutes or less).
784 This is often because the drive
785 does not really support the FORMAT UNIT command -- it just accepts the
786 command, waits a few minutes and then returns it.
790 subcommand takes several arguments that modify its default behavior.
795 arguments can be useful for scripts.
799 Be quiet, do not print any status messages.
800 This option will not disable
801 the questions, however.
802 To disable questions, use the
809 This will report status on a format that is already running on the drive.
811 Issue a non-immediate format command.
814 issues the FORMAT UNIT command with the immediate bit set.
816 device to immediately return the format command, before the format has
822 sense information from the device every second to determine how far along
823 in the format process it is.
826 argument is specified,
828 will issue a non-immediate format command, and will be unable to print any
829 information to let the user know what percentage of the disk has been
832 Do not ask any questions.
835 will ask the user if he/she really wants to format the disk in question,
836 and also if the default format command timeout is acceptable.
838 will not be asked about the timeout if a timeout is specified on the
842 Put ATA device into IDLE state. Optional parameter specifies automatic
843 idle timer value in seconds.
845 Put ATA device into STANDBY state. Optional parameter specifies automatic
846 standby timer value in seconds.
848 Put ATA device into SLEEP state. Note that the only way get device out of
849 this state may be reset.
851 Print out verbose usage information.
856 variable allows the user to specify an alternate mode page format file.
860 variable determines which text editor
862 starts when editing mode pages.
864 .Bl -tag -width /usr/share/misc/scsi_modes -compact
865 .It Pa /usr/share/misc/scsi_modes
866 is the SCSI mode format database.
868 is the transport layer device.
870 are the CAM application passthrough devices.
873 .Dl camcontrol eject -n cd -u 1 -v
875 Eject the CD from cd1, and print SCSI sense information if the command
878 .Dl camcontrol tur da0
880 Send the SCSI test unit ready command to da0.
883 utility will report whether the disk is ready, but will not display sense
884 information if the command fails since the
886 switch was not specified.
888 .Bd -literal -offset indent
889 camcontrol tur da1 -E -C 4 -t 50 -v
892 Send a test unit ready command to da1.
893 Enable kernel error recovery.
894 Specify a retry count of 4, and a timeout of 50 seconds.
898 flag) if the command fails.
899 Since error recovery is turned on, the
900 disk will be spun up if it is not currently spinning.
903 utility will report whether the disk is ready.
904 .Bd -literal -offset indent
905 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
906 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
909 Issue a READ BUFFER command (0x3C) to cd1.
910 Display the buffer size of cd1,
911 and display the first 10 bytes from the cache on cd1.
913 information if the command fails.
915 .Bd -literal -offset indent
916 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
917 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
920 Issue a WRITE BUFFER (0x3B) command to cd1.
921 Write out 10 bytes of data,
922 not including the (reserved) 4 byte header.
923 Print out sense information if
925 Be very careful with this command, improper use may
926 cause data corruption.
928 .Bd -literal -offset indent
929 camcontrol modepage da3 -m 1 -e -P 3
932 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
933 settings on the drive.
934 Mode page 1 contains a disk drive's auto read and
935 write reallocation settings, among other things.
937 .Dl camcontrol rescan all
939 Rescan all SCSI busses in the system for devices that have been added,
942 .Dl camcontrol rescan 0
944 Rescan SCSI bus 0 for devices that have been added, removed or changed.
946 .Dl camcontrol rescan 0:1:0
948 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
951 .Dl camcontrol tags da5 -N 24
953 Set the number of concurrent transactions for da5 to 24.
955 .Bd -literal -offset indent
956 camcontrol negotiate -n da -u 4 -T disable
959 Disable tagged queueing for da4.
961 .Bd -literal -offset indent
962 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
965 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
967 Test Unit Ready command to make the settings take effect.
977 utility first appeared in
980 The mode page editing code and arbitrary SCSI command code are based upon
985 library, written by Julian Elischer and Peter Dufault.
988 program first appeared in
990 and first appeared in
995 .An Kenneth Merry Aq ken@FreeBSD.org
997 The code that parses the generic command line arguments does not know that
998 some of the subcommands take multiple arguments.
999 So if, for instance, you
1000 tried something like this:
1001 .Bd -literal -offset indent
1002 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
1005 The sense information from the test unit ready command would not get
1006 printed out, since the first
1010 bails out when it sees the second argument to
1014 Fixing this behavior would take some gross code, or changes to the
1017 The best way to circumvent this problem is to always make sure
1020 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob