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
155 .Op Fl T Ar enable|disable
157 .Op Fl W Ar bus_width
186 utility is designed to provide a way for users to access and control the
193 can cause a loss of data and/or system crashes if used improperly.
195 expert users are encouraged to exercise caution when using this command.
196 Novice users should stay away from this utility.
200 utility has a number of primary functions, many of which support an optional
202 A device identifier can take one of three forms:
205 Specify a device name and unit number combination, like "da5" or "cd3".
206 Note that character device node names (e.g.\& /dev/da0) are
210 Specify a bus number and target id.
211 The bus number can be determined from
213 .Dq camcontrol devlist .
214 The lun defaults to 0.
216 Specify the bus, target and lun for a device.
220 The device identifier, if it is specified,
222 come immediately after the function name, and before any generic or
223 function-specific arguments.
228 arguments described below will override any device name or unit number
229 specified beforehand.
236 override a specified bus:target or bus:target:lun, however.
240 primary functions support these generic arguments:
243 SCSI command retry count.
244 In order for this to work, error recovery
248 Instruct the kernel to perform generic SCSI error recovery for the given
250 This is needed in order for the retry count
253 Other than retrying commands, the generic error recovery in
254 the code will generally attempt to spin up drives that are not spinning.
255 It may take some other actions, depending upon the sense code returned from
258 Specify the device type to operate on, e.g.\& "da", "cd".
260 SCSI command timeout in seconds.
261 This overrides the default timeout for
263 .It Fl u Ar unit_number
264 Specify the device unit number, e.g.\& "1", "5".
266 Be verbose, print out sense information for failed SCSI commands.
269 Primary command functions:
270 .Bl -tag -width periphlist
272 List all physical devices (logical units) attached to the CAM subsystem.
273 This also includes a list of peripheral drivers attached to each device.
276 argument, SCSI bus number, adapter name and unit numbers are printed as
279 List all peripheral drivers attached to a given physical device (logical
282 Send the SCSI test unit ready (0x00) command to the given device.
285 utility will report whether the device is ready or not.
287 Send a SCSI inquiry command (0x12) to a device.
290 will print out the standard inquiry data, device serial number, and
291 transfer rate information.
292 The user can specify that only certain types of
293 inquiry data be printed:
296 Get the standard inquiry data.
298 Print out the serial number.
299 If this flag is the only one specified,
301 will not print out "Serial Number" before the value returned by the drive.
302 This is to aid in script writing.
304 Print out transfer rate information.
307 Send a ATA identify command (0xec) to a device.
309 Send the SCSI REPORT LUNS (0xA0) command to the given device.
312 will print out the list of logical units (LUNs) supported by the target device.
313 There are a couple of options to modify the output:
316 Just print out a count of LUNs, not the actual LUN numbers.
318 Just print out the LUNs, and don't print out the count.
319 .It Fl r Ar reporttype
320 Specify the type of report to request from the target:
321 .Bl -tag -width 012345678
323 Return the default report.
327 Most targets will support this report if they support the REPORT LUNS
330 Return only well known LUNs.
332 Return all available LUNs.
337 will try to print out LUN numbers in a reasonable format.
338 It can understand the peripheral, flat, LUN and extended LUN formats.
340 Send the SCSI READ CAPACITY command to the given device and display
342 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
343 action will be sent to obtain the full size of the device.
346 will print out the last logical block of the device, and the blocksize of
348 To modify the output format, use the following options:
351 Just print out the blocksize, not the last block or device size.
352 This cannot be used with
357 Print out the device size in human readable (base 2, 1K == 1024) format.
360 and cannot be used with
365 Print out the device size in human readable (base 10, 1K == 1000) format.
367 Print out the number of blocks in the device instead of the last logical
370 Quiet, print out the numbers only (separated by a comma if
376 Print out the last logical block or the size of the device only, and omit
380 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
383 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
386 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
387 start bit set and the load/eject bit set.
389 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
390 start bit cleared and the load/eject bit set.
392 Tell the kernel to scan all busses in the system (with the
394 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
395 (XPT_SCAN_LUN) for new devices or devices that have gone away.
397 may specify a scan of all busses, a single bus, or a lun.
399 on a target is not supported.
401 Tell the kernel to reset all busses in the system (with the
403 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
404 reset for that bus, or to reset the given bus:target:lun
405 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
406 connecting to that device.
407 Note that this can have a destructive impact
410 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
411 print out any combination of: the total number of defects, the primary
412 defect list (PLIST), and the grown defect list (GLIST).
415 The three format options are:
417 to print out the list as logical blocks,
419 to print out the list in bytes from index format, and
421 to print out the list in physical sector format.
422 The format argument is
424 Most drives support the physical sector format.
426 support the logical block format.
427 Many drives, if they do not support the
428 requested format, return the data in an alternate format, along with sense
429 information indicating that the requested data format is not supported.
433 attempts to detect this, and print out whatever format the drive returns.
434 If the drive uses a non-standard sense code to report that it does not
435 support the requested format,
437 will probably see the error as a failure to complete the request.
439 Print out the grown defect list.
440 This is a list of bad blocks that have
441 been remapped since the disk left the factory.
443 Print out the primary defect list.
452 will print out the number of defects given in the READ DEFECT DATA header
453 returned from the drive.
455 Allows the user to display and optionally edit a SCSI mode page.
457 page formats are located in
458 .Pa /usr/share/misc/scsi_modes .
459 This can be overridden by specifying a different file in the
461 environment variable.
464 command takes several arguments:
467 Disable block descriptors for mode sense.
469 Displays mode page data in binary format.
471 This flag allows the user to edit values in the mode page.
473 either edit mode page values with the text editor pointed to by his
475 environment variable, or supply mode page values via standard input, using
478 uses to display mode page values.
479 The editor will be invoked if
481 detects that standard input is terminal.
483 Lists all available mode pages.
484 .It Fl m Ar mode_page
485 This specifies the number of the mode page the user would like to view
487 This argument is mandatory unless
491 This allows the user to specify the page control field.
493 .Bl -tag -width xxx -compact
505 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
508 function requires the
510 argument to specify SCSI CDB or the
512 argument to specify ATA Command Block registers values.
513 Other arguments are optional, depending on
515 The command and data specification syntax is documented
518 NOTE: If the CDB specified causes data to be transfered to or from the
519 SCSI device in question, you MUST specify either
524 .It Fl a Ar cmd Op args
525 This specifies the content of 12 ATA Command Block registers (command,
526 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
527 lba_high_exp, features_exp, sector_count, sector_count_exp).
528 .It Fl c Ar cmd Op args
529 This specifies the SCSI CDB.
530 SCSI CDBs may be 6, 10, 12 or 16 bytes.
531 .It Fl i Ar len Ar fmt
532 This specifies the amount of data to read, and how it should be displayed.
536 bytes of data will be read from the device and written to standard output.
537 .It Fl o Ar len Ar fmt Op args
538 This specifies the amount of data to be written to a device, and the data
539 that is to be written.
543 bytes of data will be read from standard input and written to the device.
545 This specifies that 11 result ATA Command Block registers should be displayed
546 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
547 lba_high_exp, sector_count, sector_count_exp), and how.
550 11 result registers will be written to standard output in hex.
553 Turn on CAM debugging printfs in the kernel.
554 This requires options CAMDEBUG
555 in your kernel config file.
556 WARNING: enabling debugging printfs currently
557 causes an EXTREME number of kernel printfs.
558 You may have difficulty
559 turning off the debugging printfs once they start, since the kernel will be
560 busy printing messages and unable to service other requests quickly.
563 function takes a number of arguments:
566 Enable CAM_DEBUG_INFO printfs.
568 Enable CAM_DEBUG_PERIPH printfs.
570 Enable CAM_DEBUG_TRACE printfs.
572 Enable CAM_DEBUG_SUBTRACE printfs.
574 Enable CAM_DEBUG_XPT printfs.
576 Enable CAM_DEBUG_CDB printfs.
577 This will cause the kernel to print out the
578 SCSI CDBs sent to the specified device(s).
580 Enable debugging for all devices.
582 Turn off debugging for all devices
583 .It bus Ns Op :target Ns Op :lun
584 Turn on debugging for the given bus, target or lun.
586 and lun are not specified, they are wildcarded.
587 (i.e., just specifying a
588 bus turns on debugging printfs for all devices on that bus.)
591 Show or set the number of "tagged openings" or simultaneous transactions
592 we attempt to queue to a particular device.
595 command, with no command-specific arguments (i.e., only generic arguments)
596 prints out the "soft" maximum number of transactions that can be queued to
597 the device in question.
598 For more detailed information, use the
600 argument described below.
603 Set the number of tags for the given device.
604 This must be between the
605 minimum and maximum number set in the kernel quirk table.
607 most devices that support tagged queueing is a minimum of 2 and a maximum
609 The minimum and maximum values for a given device may be
610 determined by using the
617 subcommand is described below.
619 Be quiet, and do not report the number of tags.
620 This is generally used when
621 setting the number of tags.
623 The verbose flag has special functionality for the
628 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
631 This is the amount of capacity for transactions queued to a given device.
633 This is the number of transactions currently queued to a device.
635 This is the kernel queue space for transactions.
636 This count usually mirrors
637 dev_openings except during error recovery operations when
638 the device queue is frozen (device is not allowed to receive
639 commands), the number of dev_openings is reduced, or transaction
642 This is the number of transactions waiting in the kernel queue for capacity
644 This number is usually zero unless error recovery is in
647 The held count is the number of CCBs held by peripheral drivers that have
648 either just been completed or are about to be released to the transport
649 layer for service by a device.
650 Held CCBs reserve capacity on a given
653 This is the current "hard" minimum number of transactions that can be
654 queued to a device at once.
657 value above cannot go below this number.
658 The default value for
660 is 2, although it may be set higher or lower for various devices.
662 This is the "hard" maximum number of transactions that can be queued to a
666 value cannot go above this number.
667 The default value for
669 is 255, although it may be set higher or lower for various devices.
673 Show or negotiate various communication parameters.
675 not support setting or changing some of these values.
677 Adaptec 174x controllers do not support changing a device's sync rate or
682 will not attempt to set the parameter if the controller indicates that it
683 does not support setting the parameter.
684 To find out what the controller
692 command is described below.
693 Also, some controller drivers do not support
694 setting negotiation parameters, even if the underlying controller supports
696 Some controllers, such as the Advansys wide
697 controllers, support enabling and disabling synchronous negotiation for
698 a device, but do not support setting the synchronous negotiation rate.
701 Attempt to make the negotiation settings take effect immediately by sending
702 a Test Unit Ready command to the device.
704 Show or set current negotiation settings.
706 .It Fl D Ar enable|disable
707 Enable or disable disconnection.
709 Set the command delay offset.
711 Be quiet, do not print anything.
712 This is generally useful when you want to
713 set a parameter, but do not want any status information.
715 Change the synchronization rate for a device.
716 The sync rate is a floating
717 point value specified in MHz.
720 is a legal value, as is
722 .It Fl T Ar enable|disable
723 Enable or disable tagged queueing for a device.
725 Show or set user negotiation settings.
726 The default is to show or set
727 current negotiation settings.
729 The verbose switch has special meaning for the
734 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
736 .It Fl W Ar bus_width
737 Specify the bus width to negotiate with a device.
740 The only useful values to specify are 8, 16, and 32
742 The controller must support the bus width in question in order for
743 the setting to take effect.
746 In general, sync rate and offset settings will not take effect for a
747 device until a command has been sent to the device.
750 switch above will automatically send a Test Unit Ready to the device so
751 negotiation parameters will take effect.
755 FORMAT UNIT command to the named device.
757 .Em WARNING! WARNING! WARNING!
759 Low level formatting a disk will destroy ALL data on the disk.
761 extreme caution when issuing this command.
762 Many users low-level format
763 disks that do not really need to be low-level formatted.
765 relatively few scenarios that call for low-level formatting a disk.
767 low-level formatting a disk is to initialize the disk after changing
768 its physical sector size.
769 Another reason for low-level formatting a disk
770 is to revive the disk if you are getting "medium format corrupted" errors
771 from the disk in response to read and write requests.
773 Some disks take longer than others to format.
774 Users should specify a
775 timeout long enough to allow the format to complete.
777 timeout is 3 hours, which should be long enough for most disks.
779 disks will complete a format operation in a very short period of time
780 (on the order of 5 minutes or less).
781 This is often because the drive
782 does not really support the FORMAT UNIT command -- it just accepts the
783 command, waits a few minutes and then returns it.
787 subcommand takes several arguments that modify its default behavior.
792 arguments can be useful for scripts.
796 Be quiet, do not print any status messages.
797 This option will not disable
798 the questions, however.
799 To disable questions, use the
806 This will report status on a format that is already running on the drive.
808 Issue a non-immediate format command.
811 issues the FORMAT UNIT command with the immediate bit set.
813 device to immediately return the format command, before the format has
819 sense information from the device every second to determine how far along
820 in the format process it is.
823 argument is specified,
825 will issue a non-immediate format command, and will be unable to print any
826 information to let the user know what percentage of the disk has been
829 Do not ask any questions.
832 will ask the user if he/she really wants to format the disk in question,
833 and also if the default format command timeout is acceptable.
835 will not be asked about the timeout if a timeout is specified on the
839 Put ATA device into IDLE state. Optional parameter specifies automatic
840 idle timer value in seconds.
842 Put ATA device into STANDBY state. Optional parameter specifies automatic
843 standby timer value in seconds.
845 Put ATA device into SLEEP state. Note that the only way get device out of
846 this state may be reset.
848 Print out verbose usage information.
853 variable allows the user to specify an alternate mode page format file.
857 variable determines which text editor
859 starts when editing mode pages.
861 .Bl -tag -width /usr/share/misc/scsi_modes -compact
862 .It Pa /usr/share/misc/scsi_modes
863 is the SCSI mode format database.
865 is the transport layer device.
867 are the CAM application passthrough devices.
870 .Dl camcontrol eject -n cd -u 1 -v
872 Eject the CD from cd1, and print SCSI sense information if the command
875 .Dl camcontrol tur da0
877 Send the SCSI test unit ready command to da0.
880 utility will report whether the disk is ready, but will not display sense
881 information if the command fails since the
883 switch was not specified.
885 .Bd -literal -offset indent
886 camcontrol tur da1 -E -C 4 -t 50 -v
889 Send a test unit ready command to da1.
890 Enable kernel error recovery.
891 Specify a retry count of 4, and a timeout of 50 seconds.
895 flag) if the command fails.
896 Since error recovery is turned on, the
897 disk will be spun up if it is not currently spinning.
900 utility will report whether the disk is ready.
901 .Bd -literal -offset indent
902 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
903 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
906 Issue a READ BUFFER command (0x3C) to cd1.
907 Display the buffer size of cd1,
908 and display the first 10 bytes from the cache on cd1.
910 information if the command fails.
912 .Bd -literal -offset indent
913 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
914 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
917 Issue a WRITE BUFFER (0x3B) command to cd1.
918 Write out 10 bytes of data,
919 not including the (reserved) 4 byte header.
920 Print out sense information if
922 Be very careful with this command, improper use may
923 cause data corruption.
925 .Bd -literal -offset indent
926 camcontrol modepage da3 -m 1 -e -P 3
929 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
930 settings on the drive.
931 Mode page 1 contains a disk drive's auto read and
932 write reallocation settings, among other things.
934 .Dl camcontrol rescan all
936 Rescan all SCSI busses in the system for devices that have been added,
939 .Dl camcontrol rescan 0
941 Rescan SCSI bus 0 for devices that have been added, removed or changed.
943 .Dl camcontrol rescan 0:1:0
945 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
948 .Dl camcontrol tags da5 -N 24
950 Set the number of concurrent transactions for da5 to 24.
952 .Bd -literal -offset indent
953 camcontrol negotiate -n da -u 4 -T disable
956 Disable tagged queueing for da4.
958 .Bd -literal -offset indent
959 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
962 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
964 Test Unit Ready command to make the settings take effect.
974 utility first appeared in
977 The mode page editing code and arbitrary SCSI command code are based upon
982 library, written by Julian Elischer and Peter Dufault.
985 program first appeared in
987 and first appeared in
992 .An Kenneth Merry Aq ken@FreeBSD.org
994 The code that parses the generic command line arguments does not know that
995 some of the subcommands take multiple arguments.
996 So if, for instance, you
997 tried something like this:
998 .Bd -literal -offset indent
999 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
1002 The sense information from the test unit ready command would not get
1003 printed out, since the first
1007 bails out when it sees the second argument to
1011 Fixing this behavior would take some gross code, or changes to the
1014 The best way to circumvent this problem is to always make sure
1017 arguments before any command-specific arguments.
projects / FreeBSD / stable / 8.git / blob