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
191 utility is designed to provide a way for users to access and control the
198 can cause a loss of data and/or system crashes if used improperly.
200 expert users are encouraged to exercise caution when using this command.
201 Novice users should stay away from this utility.
205 utility has a number of primary functions, many of which support an optional
207 A device identifier can take one of three forms:
210 Specify a device name and unit number combination, like "da5" or "cd3".
212 Specify a bus number and target id.
213 The bus number can be determined from
215 .Dq camcontrol devlist .
216 The lun defaults to 0.
218 Specify the bus, target and lun for a device.
222 The device identifier, if it is specified,
224 come immediately after the function name, and before any generic or
225 function-specific arguments.
230 arguments described below will override any device name or unit number
231 specified beforehand.
238 override a specified bus:target or bus:target:lun, however.
242 primary functions support these generic arguments:
245 SCSI command retry count.
246 In order for this to work, error recovery
250 Instruct the kernel to perform generic SCSI error recovery for the given
252 This is needed in order for the retry count
255 Other than retrying commands, the generic error recovery in
256 the code will generally attempt to spin up drives that are not spinning.
257 It may take some other actions, depending upon the sense code returned from
260 Specify the device type to operate on, e.g.\& "da", "cd".
262 SCSI command timeout in seconds.
263 This overrides the default timeout for
265 .It Fl u Ar unit_number
266 Specify the device unit number, e.g.\& "1", "5".
268 Be verbose, print out sense information for failed SCSI commands.
271 Primary command functions:
272 .Bl -tag -width periphlist
274 List all physical devices (logical units) attached to the CAM subsystem.
275 This also includes a list of peripheral drivers attached to each device.
278 argument, SCSI bus number, adapter name and unit numbers are printed as
281 List all peripheral drivers attached to a given physical device (logical
284 Send the SCSI test unit ready (0x00) command to the given device.
287 utility will report whether the device is ready or not.
289 Send a SCSI inquiry command (0x12) to a device.
292 will print out the standard inquiry data, device serial number, and
293 transfer rate information.
294 The user can specify that only certain types of
295 inquiry data be printed:
298 Get the standard inquiry data.
300 Print out the serial number.
301 If this flag is the only one specified,
303 will not print out "Serial Number" before the value returned by the drive.
304 This is to aid in script writing.
306 Print out transfer rate information.
309 Send a ATA identify command (0xec) to a device.
311 Send the SCSI REPORT LUNS (0xA0) command to the given device.
314 will print out the list of logical units (LUNs) supported by the target device.
315 There are a couple of options to modify the output:
318 Just print out a count of LUNs, not the actual LUN numbers.
320 Just print out the LUNs, and don't print out the count.
321 .It Fl r Ar reporttype
322 Specify the type of report to request from the target:
323 .Bl -tag -width 012345678
325 Return the default report.
329 Most targets will support this report if they support the REPORT LUNS
332 Return only well known LUNs.
334 Return all available LUNs.
339 will try to print out LUN numbers in a reasonable format.
340 It can understand the peripheral, flat, LUN and extended LUN formats.
342 Send the SCSI READ CAPACITY command to the given device and display
344 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
345 action will be sent to obtain the full size of the device.
348 will print out the last logical block of the device, and the blocksize of
350 To modify the output format, use the following options:
353 Just print out the blocksize, not the last block or device size.
354 This cannot be used with
359 Print out the device size in human readable (base 2, 1K == 1024) format.
362 and cannot be used with
367 Print out the device size in human readable (base 10, 1K == 1000) format.
369 Print out the number of blocks in the device instead of the last logical
372 Quiet, print out the numbers only (separated by a comma if
378 Print out the last logical block or the size of the device only, and omit
382 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
385 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
388 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
389 start bit set and the load/eject bit set.
391 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
392 start bit cleared and the load/eject bit set.
394 Tell the kernel to scan all busses in the system (with the
396 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
397 (XPT_SCAN_LUN) for new devices or devices that have gone away.
399 may specify a scan of all busses, a single bus, or a lun.
401 on a target is not supported.
403 Tell the kernel to reset all busses in the system (with the
405 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
406 reset for that bus, or to reset the given bus:target:lun
407 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
408 connecting to that device.
409 Note that this can have a destructive impact
412 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
413 print out any combination of: the total number of defects, the primary
414 defect list (PLIST), and the grown defect list (GLIST).
417 The three format options are:
419 to print out the list as logical blocks,
421 to print out the list in bytes from index format, and
423 to print out the list in physical sector format.
424 The format argument is
426 Most drives support the physical sector format.
428 support the logical block format.
429 Many drives, if they do not support the
430 requested format, return the data in an alternate format, along with sense
431 information indicating that the requested data format is not supported.
435 attempts to detect this, and print out whatever format the drive returns.
436 If the drive uses a non-standard sense code to report that it does not
437 support the requested format,
439 will probably see the error as a failure to complete the request.
441 Print out the grown defect list.
442 This is a list of bad blocks that have
443 been remapped since the disk left the factory.
445 Print out the primary defect list.
454 will print out the number of defects given in the READ DEFECT DATA header
455 returned from the drive.
457 Allows the user to display and optionally edit a SCSI mode page.
459 page formats are located in
460 .Pa /usr/share/misc/scsi_modes .
461 This can be overridden by specifying a different file in the
463 environment variable.
466 command takes several arguments:
469 Disable block descriptors for mode sense.
471 Displays mode page data in binary format.
473 This flag allows the user to edit values in the mode page.
475 either edit mode page values with the text editor pointed to by his
477 environment variable, or supply mode page values via standard input, using
480 uses to display mode page values.
481 The editor will be invoked if
483 detects that standard input is terminal.
485 Lists all available mode pages.
486 .It Fl m Ar mode_page
487 This specifies the number of the mode page the user would like to view
489 This argument is mandatory unless
493 This allows the user to specify the page control field.
495 .Bl -tag -width xxx -compact
507 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
510 function requires the
512 argument to specify SCSI CDB or the
514 argument to specify ATA Command Block registers values.
515 Other arguments are optional, depending on
517 The command and data specification syntax is documented
520 NOTE: If the CDB specified causes data to be transfered to or from the
521 SCSI device in question, you MUST specify either
526 .It Fl a Ar cmd Op args
527 This specifies the content of 12 ATA Command Block registers (command,
528 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
529 lba_high_exp, features_exp, sector_count, sector_count_exp).
530 .It Fl c Ar cmd Op args
531 This specifies the SCSI CDB.
532 SCSI CDBs may be 6, 10, 12 or 16 bytes.
534 Specifies DMA protocol to be used for ATA command.
536 Specifies FPDMA (NCQ) protocol to be used for ATA command.
537 .It Fl i Ar len Ar fmt
538 This specifies the amount of data to read, and how it should be displayed.
542 bytes of data will be read from the device and written to standard output.
543 .It Fl o Ar len Ar fmt Op args
544 This specifies the amount of data to be written to a device, and the data
545 that is to be written.
549 bytes of data will be read from standard input and written to the device.
551 This specifies that 11 result ATA Command Block registers should be displayed
552 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
553 lba_high_exp, sector_count, sector_count_exp), and how.
556 11 result registers will be written to standard output in hex.
559 Turn on CAM debugging printfs in the kernel.
560 This requires options CAMDEBUG
561 in your kernel config file.
562 WARNING: enabling debugging printfs currently
563 causes an EXTREME number of kernel printfs.
564 You may have difficulty
565 turning off the debugging printfs once they start, since the kernel will be
566 busy printing messages and unable to service other requests quickly.
569 function takes a number of arguments:
572 Enable CAM_DEBUG_INFO printfs.
574 Enable CAM_DEBUG_PERIPH printfs.
576 Enable CAM_DEBUG_TRACE printfs.
578 Enable CAM_DEBUG_SUBTRACE printfs.
580 Enable CAM_DEBUG_XPT printfs.
582 Enable CAM_DEBUG_CDB printfs.
583 This will cause the kernel to print out the
584 SCSI CDBs sent to the specified device(s).
586 Enable CAM_DEBUG_PROBE printfs.
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
851 specifies automatic standby timer value in seconds. Value 0 disables timer.
853 Put ATA device into STANDBY state. Optional parameter
855 specifies automatic standby timer value in seconds. Value 0 disables timer.
857 Put ATA device into SLEEP state. Note that the only way get device out of
858 this state may be reset.
860 Print out verbose usage information.
865 variable allows the user to specify an alternate mode page format file.
869 variable determines which text editor
871 starts when editing mode pages.
873 .Bl -tag -width /usr/share/misc/scsi_modes -compact
874 .It Pa /usr/share/misc/scsi_modes
875 is the SCSI mode format database.
877 is the transport layer device.
879 are the CAM application passthrough devices.
882 .Dl camcontrol eject -n cd -u 1 -v
884 Eject the CD from cd1, and print SCSI sense information if the command
887 .Dl camcontrol tur da0
889 Send the SCSI test unit ready command to da0.
892 utility will report whether the disk is ready, but will not display sense
893 information if the command fails since the
895 switch was not specified.
897 .Bd -literal -offset indent
898 camcontrol tur da1 -E -C 4 -t 50 -v
901 Send a test unit ready command to da1.
902 Enable kernel error recovery.
903 Specify a retry count of 4, and a timeout of 50 seconds.
907 flag) if the command fails.
908 Since error recovery is turned on, the
909 disk will be spun up if it is not currently spinning.
912 utility will report whether the disk is ready.
913 .Bd -literal -offset indent
914 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
915 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
918 Issue a READ BUFFER command (0x3C) to cd1.
919 Display the buffer size of cd1,
920 and display the first 10 bytes from the cache on cd1.
922 information if the command fails.
924 .Bd -literal -offset indent
925 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
926 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
929 Issue a WRITE BUFFER (0x3B) command to cd1.
930 Write out 10 bytes of data,
931 not including the (reserved) 4 byte header.
932 Print out sense information if
934 Be very careful with this command, improper use may
935 cause data corruption.
937 .Bd -literal -offset indent
938 camcontrol modepage da3 -m 1 -e -P 3
941 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
942 settings on the drive.
943 Mode page 1 contains a disk drive's auto read and
944 write reallocation settings, among other things.
946 .Dl camcontrol rescan all
948 Rescan all SCSI busses in the system for devices that have been added,
951 .Dl camcontrol rescan 0
953 Rescan SCSI bus 0 for devices that have been added, removed or changed.
955 .Dl camcontrol rescan 0:1:0
957 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
960 .Dl camcontrol tags da5 -N 24
962 Set the number of concurrent transactions for da5 to 24.
964 .Bd -literal -offset indent
965 camcontrol negotiate -n da -u 4 -T disable
968 Disable tagged queueing for da4.
970 .Bd -literal -offset indent
971 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
974 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
976 Test Unit Ready command to make the settings take effect.
986 utility first appeared in
989 The mode page editing code and arbitrary SCSI command code are based upon
994 library, written by Julian Elischer and Peter Dufault.
997 program first appeared in
999 and first appeared in
1004 .An Kenneth Merry Aq ken@FreeBSD.org
1006 The code that parses the generic command line arguments does not know that
1007 some of the subcommands take multiple arguments.
1008 So if, for instance, you
1009 tried something like this:
1010 .Bd -literal -offset indent
1011 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
1014 The sense information from the test unit ready command would not get
1015 printed out, since the first
1019 bails out when it sees the second argument to
1023 Fixing this behavior would take some gross code, or changes to the
1026 The best way to circumvent this problem is to always make sure
1029 arguments before any command-specific arguments.
projects / FreeBSD / stable / 8.git / blob