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
141 .Aq all|off|bus Ns Op :target Ns Op :lun
154 .Op Fl D Ar enable|disable
159 .Op Fl T Ar enable|disable
161 .Op Fl W Ar bus_width
190 utility is designed to provide a way for users to access and control the
197 can cause a loss of data and/or system crashes if used improperly.
199 expert users are encouraged to exercise caution when using this command.
200 Novice users should stay away from this utility.
204 utility has a number of primary functions, many of which support an optional
206 A device identifier can take one of three forms:
209 Specify a device name and unit number combination, like "da5" or "cd3".
210 Note that character device node names (e.g.\& /dev/da0) are
214 Specify a bus number and target id.
215 The bus number can be determined from
217 .Dq camcontrol devlist .
218 The lun defaults to 0.
220 Specify the bus, target and lun for a device.
224 The device identifier, if it is specified,
226 come immediately after the function name, and before any generic or
227 function-specific arguments.
232 arguments described below will override any device name or unit number
233 specified beforehand.
240 override a specified bus:target or bus:target:lun, however.
244 primary functions support these generic arguments:
247 SCSI command retry count.
248 In order for this to work, error recovery
252 Instruct the kernel to perform generic SCSI error recovery for the given
254 This is needed in order for the retry count
257 Other than retrying commands, the generic error recovery in
258 the code will generally attempt to spin up drives that are not spinning.
259 It may take some other actions, depending upon the sense code returned from
262 Specify the device type to operate on, e.g.\& "da", "cd".
264 SCSI command timeout in seconds.
265 This overrides the default timeout for
267 .It Fl u Ar unit_number
268 Specify the device unit number, e.g.\& "1", "5".
270 Be verbose, print out sense information for failed SCSI commands.
273 Primary command functions:
274 .Bl -tag -width periphlist
276 List all physical devices (logical units) attached to the CAM subsystem.
277 This also includes a list of peripheral drivers attached to each device.
280 argument, SCSI bus number, adapter name and unit numbers are printed as
283 List all peripheral drivers attached to a given physical device (logical
286 Send the SCSI test unit ready (0x00) command to the given device.
289 utility will report whether the device is ready or not.
291 Send a SCSI inquiry command (0x12) to a device.
294 will print out the standard inquiry data, device serial number, and
295 transfer rate information.
296 The user can specify that only certain types of
297 inquiry data be printed:
300 Get the standard inquiry data.
302 Print out the serial number.
303 If this flag is the only one specified,
305 will not print out "Serial Number" before the value returned by the drive.
306 This is to aid in script writing.
308 Print out transfer rate information.
311 Send a ATA identify command (0xec) to a device.
313 Send the SCSI REPORT LUNS (0xA0) command to the given device.
316 will print out the list of logical units (LUNs) supported by the target device.
317 There are a couple of options to modify the output:
320 Just print out a count of LUNs, not the actual LUN numbers.
322 Just print out the LUNs, and don't print out the count.
323 .It Fl r Ar reporttype
324 Specify the type of report to request from the target:
325 .Bl -tag -width 012345678
327 Return the default report.
331 Most targets will support this report if they support the REPORT LUNS
334 Return only well known LUNs.
336 Return all available LUNs.
341 will try to print out LUN numbers in a reasonable format.
342 It can understand the peripheral, flat, LUN and extended LUN formats.
344 Send the SCSI READ CAPACITY command to the given device and display
346 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
347 action will be sent to obtain the full size of the device.
350 will print out the last logical block of the device, and the blocksize of
352 To modify the output format, use the following options:
355 Just print out the blocksize, not the last block or device size.
356 This cannot be used with
361 Print out the device size in human readable (base 2, 1K == 1024) format.
364 and cannot be used with
369 Print out the device size in human readable (base 10, 1K == 1000) format.
371 Print out the number of blocks in the device instead of the last logical
374 Quiet, print out the numbers only (separated by a comma if
380 Print out the last logical block or the size of the device only, and omit
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
390 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
391 start bit set and the load/eject bit set.
393 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
394 start bit cleared and the load/eject bit set.
396 Tell the kernel to scan all busses in the system (with the
398 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
399 (XPT_SCAN_LUN) for new devices or devices that have gone away.
401 may specify a scan of all busses, a single bus, or a lun.
403 on a target is not supported.
405 Tell the kernel to reset all busses in the system (with the
407 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
408 reset for that bus, or to reset the given bus:target:lun
409 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
410 connecting to that device.
411 Note that this can have a destructive impact
414 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
415 print out any combination of: the total number of defects, the primary
416 defect list (PLIST), and the grown defect list (GLIST).
419 The three format options are:
421 to print out the list as logical blocks,
423 to print out the list in bytes from index format, and
425 to print out the list in physical sector format.
426 The format argument is
428 Most drives support the physical sector format.
430 support the logical block format.
431 Many drives, if they do not support the
432 requested format, return the data in an alternate format, along with sense
433 information indicating that the requested data format is not supported.
437 attempts to detect this, and print out whatever format the drive returns.
438 If the drive uses a non-standard sense code to report that it does not
439 support the requested format,
441 will probably see the error as a failure to complete the request.
443 Print out the grown defect list.
444 This is a list of bad blocks that have
445 been remapped since the disk left the factory.
447 Print out the primary defect list.
456 will print out the number of defects given in the READ DEFECT DATA header
457 returned from the drive.
459 Allows the user to display and optionally edit a SCSI mode page.
461 page formats are located in
462 .Pa /usr/share/misc/scsi_modes .
463 This can be overridden by specifying a different file in the
465 environment variable.
468 command takes several arguments:
471 Disable block descriptors for mode sense.
473 Displays mode page data in binary format.
475 This flag allows the user to edit values in the mode page.
477 either edit mode page values with the text editor pointed to by his
479 environment variable, or supply mode page values via standard input, using
482 uses to display mode page values.
483 The editor will be invoked if
485 detects that standard input is terminal.
487 Lists all available mode pages.
488 .It Fl m Ar mode_page
489 This specifies the number of the mode page the user would like to view
491 This argument is mandatory unless
495 This allows the user to specify the page control field.
497 .Bl -tag -width xxx -compact
509 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
512 function requires the
514 argument to specify SCSI CDB or the
516 argument to specify ATA Command Block registers values.
517 Other arguments are optional, depending on
519 The command and data specification syntax is documented
522 NOTE: If the CDB specified causes data to be transfered to or from the
523 SCSI device in question, you MUST specify either
528 .It Fl a Ar cmd Op args
529 This specifies the content of 12 ATA Command Block registers (command,
530 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
531 lba_high_exp, features_exp, sector_count, sector_count_exp).
532 .It Fl c Ar cmd Op args
533 This specifies the SCSI CDB.
534 SCSI CDBs may be 6, 10, 12 or 16 bytes.
536 Specifies DMA protocol to be used for ATA command.
538 Specifies FPDMA (NCQ) protocol to be used for ATA command.
539 .It Fl i Ar len Ar fmt
540 This specifies the amount of data to read, and how it should be displayed.
544 bytes of data will be read from the device and written to standard output.
545 .It Fl o Ar len Ar fmt Op args
546 This specifies the amount of data to be written to a device, and the data
547 that is to be written.
551 bytes of data will be read from standard input and written to the device.
553 This specifies that 11 result ATA Command Block registers should be displayed
554 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
555 lba_high_exp, sector_count, sector_count_exp), and how.
558 11 result registers will be written to standard output in hex.
561 Turn on CAM debugging printfs in the kernel.
562 This requires options CAMDEBUG
563 in your kernel config file.
564 WARNING: enabling debugging printfs currently
565 causes an EXTREME number of kernel printfs.
566 You may have difficulty
567 turning off the debugging printfs once they start, since the kernel will be
568 busy printing messages and unable to service other requests quickly.
571 function takes a number of arguments:
574 Enable CAM_DEBUG_INFO printfs.
576 Enable CAM_DEBUG_PERIPH printfs.
578 Enable CAM_DEBUG_TRACE printfs.
580 Enable CAM_DEBUG_SUBTRACE printfs.
582 Enable CAM_DEBUG_XPT printfs.
584 Enable CAM_DEBUG_CDB printfs.
585 This will cause the kernel to print out the
586 SCSI CDBs sent to the specified device(s).
588 Enable debugging for all devices.
590 Turn off debugging for all devices
591 .It bus Ns Op :target Ns Op :lun
592 Turn on debugging for the given bus, target or lun.
594 and lun are not specified, they are wildcarded.
595 (i.e., just specifying a
596 bus turns on debugging printfs for all devices on that bus.)
599 Show or set the number of "tagged openings" or simultaneous transactions
600 we attempt to queue to a particular device.
603 command, with no command-specific arguments (i.e., only generic arguments)
604 prints out the "soft" maximum number of transactions that can be queued to
605 the device in question.
606 For more detailed information, use the
608 argument described below.
611 Set the number of tags for the given device.
612 This must be between the
613 minimum and maximum number set in the kernel quirk table.
615 most devices that support tagged queueing is a minimum of 2 and a maximum
617 The minimum and maximum values for a given device may be
618 determined by using the
625 subcommand is described below.
627 Be quiet, and do not report the number of tags.
628 This is generally used when
629 setting the number of tags.
631 The verbose flag has special functionality for the
636 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
639 This is the amount of capacity for transactions queued to a given device.
641 This is the number of transactions currently queued to a device.
643 This is the kernel queue space for transactions.
644 This count usually mirrors
645 dev_openings except during error recovery operations when
646 the device queue is frozen (device is not allowed to receive
647 commands), the number of dev_openings is reduced, or transaction
650 This is the number of transactions waiting in the kernel queue for capacity
652 This number is usually zero unless error recovery is in
655 The held count is the number of CCBs held by peripheral drivers that have
656 either just been completed or are about to be released to the transport
657 layer for service by a device.
658 Held CCBs reserve capacity on a given
661 This is the current "hard" minimum number of transactions that can be
662 queued to a device at once.
665 value above cannot go below this number.
666 The default value for
668 is 2, although it may be set higher or lower for various devices.
670 This is the "hard" maximum number of transactions that can be queued to a
674 value cannot go above this number.
675 The default value for
677 is 255, although it may be set higher or lower for various devices.
681 Show or negotiate various communication parameters.
683 not support setting or changing some of these values.
685 Adaptec 174x controllers do not support changing a device's sync rate or
690 will not attempt to set the parameter if the controller indicates that it
691 does not support setting the parameter.
692 To find out what the controller
700 command is described below.
701 Also, some controller drivers do not support
702 setting negotiation parameters, even if the underlying controller supports
704 Some controllers, such as the Advansys wide
705 controllers, support enabling and disabling synchronous negotiation for
706 a device, but do not support setting the synchronous negotiation rate.
709 Attempt to make the negotiation settings take effect immediately by sending
710 a Test Unit Ready command to the device.
712 Show or set current negotiation settings.
714 .It Fl D Ar enable|disable
715 Enable or disable disconnection.
719 Set the command delay offset.
721 Be quiet, do not print anything.
722 This is generally useful when you want to
723 set a parameter, but do not want any status information.
725 Change the synchronization rate for a device.
726 The sync rate is a floating
727 point value specified in MHz.
730 is a legal value, as is
732 .It Fl T Ar enable|disable
733 Enable or disable tagged queueing for a device.
735 Show or set user negotiation settings.
736 The default is to show or set
737 current negotiation settings.
739 The verbose switch has special meaning for the
744 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
746 .It Fl W Ar bus_width
747 Specify the bus width to negotiate with a device.
750 The only useful values to specify are 8, 16, and 32
752 The controller must support the bus width in question in order for
753 the setting to take effect.
756 In general, sync rate and offset settings will not take effect for a
757 device until a command has been sent to the device.
760 switch above will automatically send a Test Unit Ready to the device so
761 negotiation parameters will take effect.
765 FORMAT UNIT command to the named device.
767 .Em WARNING! WARNING! WARNING!
769 Low level formatting a disk will destroy ALL data on the disk.
771 extreme caution when issuing this command.
772 Many users low-level format
773 disks that do not really need to be low-level formatted.
775 relatively few scenarios that call for low-level formatting a disk.
777 low-level formatting a disk is to initialize the disk after changing
778 its physical sector size.
779 Another reason for low-level formatting a disk
780 is to revive the disk if you are getting "medium format corrupted" errors
781 from the disk in response to read and write requests.
783 Some disks take longer than others to format.
784 Users should specify a
785 timeout long enough to allow the format to complete.
787 timeout is 3 hours, which should be long enough for most disks.
789 disks will complete a format operation in a very short period of time
790 (on the order of 5 minutes or less).
791 This is often because the drive
792 does not really support the FORMAT UNIT command -- it just accepts the
793 command, waits a few minutes and then returns it.
797 subcommand takes several arguments that modify its default behavior.
802 arguments can be useful for scripts.
806 Be quiet, do not print any status messages.
807 This option will not disable
808 the questions, however.
809 To disable questions, use the
816 This will report status on a format that is already running on the drive.
818 Issue a non-immediate format command.
821 issues the FORMAT UNIT command with the immediate bit set.
823 device to immediately return the format command, before the format has
829 sense information from the device every second to determine how far along
830 in the format process it is.
833 argument is specified,
835 will issue a non-immediate format command, and will be unable to print any
836 information to let the user know what percentage of the disk has been
839 Do not ask any questions.
842 will ask the user if he/she really wants to format the disk in question,
843 and also if the default format command timeout is acceptable.
845 will not be asked about the timeout if a timeout is specified on the
849 Put ATA device into IDLE state. Optional parameter specifies automatic
850 idle timer value in seconds.
852 Put ATA device into STANDBY state. Optional parameter specifies automatic
853 standby timer value in seconds.
855 Put ATA device into SLEEP state. Note that the only way get device out of
856 this state may be reset.
858 Print out verbose usage information.
863 variable allows the user to specify an alternate mode page format file.
867 variable determines which text editor
869 starts when editing mode pages.
871 .Bl -tag -width /usr/share/misc/scsi_modes -compact
872 .It Pa /usr/share/misc/scsi_modes
873 is the SCSI mode format database.
875 is the transport layer device.
877 are the CAM application passthrough devices.
880 .Dl camcontrol eject -n cd -u 1 -v
882 Eject the CD from cd1, and print SCSI sense information if the command
885 .Dl camcontrol tur da0
887 Send the SCSI test unit ready command to da0.
890 utility will report whether the disk is ready, but will not display sense
891 information if the command fails since the
893 switch was not specified.
895 .Bd -literal -offset indent
896 camcontrol tur da1 -E -C 4 -t 50 -v
899 Send a test unit ready command to da1.
900 Enable kernel error recovery.
901 Specify a retry count of 4, and a timeout of 50 seconds.
905 flag) if the command fails.
906 Since error recovery is turned on, the
907 disk will be spun up if it is not currently spinning.
910 utility will report whether the disk is ready.
911 .Bd -literal -offset indent
912 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
913 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
916 Issue a READ BUFFER command (0x3C) to cd1.
917 Display the buffer size of cd1,
918 and display the first 10 bytes from the cache on cd1.
920 information if the command fails.
922 .Bd -literal -offset indent
923 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
924 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
927 Issue a WRITE BUFFER (0x3B) command to cd1.
928 Write out 10 bytes of data,
929 not including the (reserved) 4 byte header.
930 Print out sense information if
932 Be very careful with this command, improper use may
933 cause data corruption.
935 .Bd -literal -offset indent
936 camcontrol modepage da3 -m 1 -e -P 3
939 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
940 settings on the drive.
941 Mode page 1 contains a disk drive's auto read and
942 write reallocation settings, among other things.
944 .Dl camcontrol rescan all
946 Rescan all SCSI busses in the system for devices that have been added,
949 .Dl camcontrol rescan 0
951 Rescan SCSI bus 0 for devices that have been added, removed or changed.
953 .Dl camcontrol rescan 0:1:0
955 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
958 .Dl camcontrol tags da5 -N 24
960 Set the number of concurrent transactions for da5 to 24.
962 .Bd -literal -offset indent
963 camcontrol negotiate -n da -u 4 -T disable
966 Disable tagged queueing for da4.
968 .Bd -literal -offset indent
969 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
972 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
974 Test Unit Ready command to make the settings take effect.
984 utility first appeared in
987 The mode page editing code and arbitrary SCSI command code are based upon
992 library, written by Julian Elischer and Peter Dufault.
995 program first appeared in
997 and first appeared in
1002 .An Kenneth Merry Aq ken@FreeBSD.org
1004 The code that parses the generic command line arguments does not know that
1005 some of the subcommands take multiple arguments.
1006 So if, for instance, you
1007 tried something like this:
1008 .Bd -literal -offset indent
1009 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
1012 The sense information from the test unit ready command would not get
1013 printed out, since the first
1017 bails out when it sees the second argument to
1021 Fixing this behavior would take some gross code, or changes to the
1024 The best way to circumvent this problem is to always make sure
1027 arguments before any command-specific arguments.
projects / FreeBSD / releng / 8.1.git / blob