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
172 utility is designed to provide a way for users to access and control the
179 can cause a loss of data and/or system crashes if used improperly.
181 expert users are encouraged to exercise caution when using this command.
182 Novice users should stay away from this utility.
186 utility has a number of primary functions, many of which support an optional
188 A device identifier can take one of three forms:
191 Specify a device name and unit number combination, like "da5" or "cd3".
192 Note that character device node names (e.g.\& /dev/da0) are
196 Specify a bus number and target id.
197 The bus number can be determined from
199 .Dq camcontrol devlist .
200 The lun defaults to 0.
202 Specify the bus, target and lun for a device.
206 The device identifier, if it is specified,
208 come immediately after the function name, and before any generic or
209 function-specific arguments.
214 arguments described below will override any device name or unit number
215 specified beforehand.
222 override a specified bus:target or bus:target:lun, however.
226 primary functions support these generic arguments:
229 SCSI command retry count.
230 In order for this to work, error recovery
234 Instruct the kernel to perform generic SCSI error recovery for the given
236 This is needed in order for the retry count
239 Other than retrying commands, the generic error recovery in
240 the code will generally attempt to spin up drives that are not spinning.
241 It may take some other actions, depending upon the sense code returned from
244 Specify the device type to operate on, e.g.\& "da", "cd".
246 SCSI command timeout in seconds.
247 This overrides the default timeout for
249 .It Fl u Ar unit_number
250 Specify the device unit number, e.g.\& "1", "5".
252 Be verbose, print out sense information for failed SCSI commands.
255 Primary command functions:
256 .Bl -tag -width periphlist
258 List all physical devices (logical units) attached to the CAM subsystem.
259 This also includes a list of peripheral drivers attached to each device.
262 argument, SCSI bus number, adapter name and unit numbers are printed as
265 List all peripheral drivers attached to a given physical device (logical
268 Send the SCSI test unit ready (0x00) command to the given device.
271 utility will report whether the device is ready or not.
273 Send a SCSI inquiry command (0x12) to a device.
276 will print out the standard inquiry data, device serial number, and
277 transfer rate information.
278 The user can specify that only certain types of
279 inquiry data be printed:
282 Get the standard inquiry data.
284 Print out the serial number.
285 If this flag is the only one specified,
287 will not print out "Serial Number" before the value returned by the drive.
288 This is to aid in script writing.
290 Print out transfer rate information.
293 Send a ATA identify command (0xec) to a device.
295 Send the SCSI REPORT LUNS (0xA0) command to the given device.
298 will print out the list of logical units (LUNs) supported by the target device.
299 There are a couple of options to modify the output:
302 Just print out a count of LUNs, not the actual LUN numbers.
304 Just print out the LUNs, and don't print out the count.
305 .It Fl r Ar reporttype
306 Specify the type of report to request from the target:
307 .Bl -tag -width 012345678
309 Return the default report.
313 Most targets will support this report if they support the REPORT LUNS
316 Return only well known LUNs.
318 Return all available LUNs.
323 will try to print out LUN numbers in a reasonable format.
324 It can understand the peripheral, flat, LUN and extended LUN formats.
326 Send the SCSI READ CAPACITY command to the given device and display
328 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
329 action will be sent to obtain the full size of the device.
332 will print out the last logical block of the device, and the blocksize of
334 To modify the output format, use the following options:
337 Just print out the blocksize, not the last block or device size.
338 This cannot be used with
343 Print out the device size in human readable (base 2, 1K == 1024) format.
346 and cannot be used with
351 Print out the device size in human readable (base 10, 1K == 1000) format.
353 Print out the number of blocks in the device instead of the last logical
356 Quiet, print out the numbers only (separated by a comma if
362 Print out the last logical block or the size of the device only, and omit
366 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
369 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
372 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
373 start bit set and the load/eject bit set.
375 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
376 start bit cleared and the load/eject bit set.
378 Tell the kernel to scan all busses in the system (with the
380 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
381 (XPT_SCAN_LUN) for new devices or devices that have gone away.
383 may specify a scan of all busses, a single bus, or a lun.
385 on a target is not supported.
387 Tell the kernel to reset all busses in the system (with the
389 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
390 reset for that bus, or to reset the given bus:target:lun
391 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
392 connecting to that device.
393 Note that this can have a destructive impact
396 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
397 print out any combination of: the total number of defects, the primary
398 defect list (PLIST), and the grown defect list (GLIST).
401 The three format options are:
403 to print out the list as logical blocks,
405 to print out the list in bytes from index format, and
407 to print out the list in physical sector format.
408 The format argument is
410 Most drives support the physical sector format.
412 support the logical block format.
413 Many drives, if they do not support the
414 requested format, return the data in an alternate format, along with sense
415 information indicating that the requested data format is not supported.
419 attempts to detect this, and print out whatever format the drive returns.
420 If the drive uses a non-standard sense code to report that it does not
421 support the requested format,
423 will probably see the error as a failure to complete the request.
425 Print out the grown defect list.
426 This is a list of bad blocks that have
427 been remapped since the disk left the factory.
429 Print out the primary defect list.
438 will print out the number of defects given in the READ DEFECT DATA header
439 returned from the drive.
441 Allows the user to display and optionally edit a SCSI mode page.
443 page formats are located in
444 .Pa /usr/share/misc/scsi_modes .
445 This can be overridden by specifying a different file in the
447 environment variable.
450 command takes several arguments:
453 Disable block descriptors for mode sense.
455 Displays mode page data in binary format.
457 This flag allows the user to edit values in the mode page.
459 either edit mode page values with the text editor pointed to by his
461 environment variable, or supply mode page values via standard input, using
464 uses to display mode page values.
465 The editor will be invoked if
467 detects that standard input is terminal.
469 Lists all available mode pages.
470 .It Fl m Ar mode_page
471 This specifies the number of the mode page the user would like to view
473 This argument is mandatory unless
477 This allows the user to specify the page control field.
479 .Bl -tag -width xxx -compact
491 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
494 function requires the
496 argument to specify SCSI CDB or the
498 argument to specify ATA Command Block registers values.
499 Other arguments are optional, depending on
501 The command and data specification syntax is documented
504 NOTE: If the CDB specified causes data to be transfered to or from the
505 SCSI device in question, you MUST specify either
510 .It Fl a Ar cmd Op args
511 This specifies the content of 12 ATA Command Block registers (command,
512 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
513 lba_high_exp, features_exp, sector_count, sector_count_exp).
514 .It Fl c Ar cmd Op args
515 This specifies the SCSI CDB.
516 SCSI CDBs may be 6, 10, 12 or 16 bytes.
517 .It Fl i Ar len Ar fmt
518 This specifies the amount of data to read, and how it should be displayed.
522 bytes of data will be read from the device and written to standard output.
523 .It Fl o Ar len Ar fmt Op args
524 This specifies the amount of data to be written to a device, and the data
525 that is to be written.
529 bytes of data will be read from standard input and written to the device.
531 This specifies that 11 result ATA Command Block registers should be displayed
532 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
533 lba_high_exp, sector_count, sector_count_exp), and how.
536 11 result registers will be written to standard output in hex.
539 Turn on CAM debugging printfs in the kernel.
540 This requires options CAMDEBUG
541 in your kernel config file.
542 WARNING: enabling debugging printfs currently
543 causes an EXTREME number of kernel printfs.
544 You may have difficulty
545 turning off the debugging printfs once they start, since the kernel will be
546 busy printing messages and unable to service other requests quickly.
549 function takes a number of arguments:
552 Enable CAM_DEBUG_INFO printfs.
554 Enable CAM_DEBUG_PERIPH printfs.
556 Enable CAM_DEBUG_TRACE printfs.
558 Enable CAM_DEBUG_SUBTRACE printfs.
560 Enable CAM_DEBUG_XPT printfs.
562 Enable CAM_DEBUG_CDB printfs.
563 This will cause the kernel to print out the
564 SCSI CDBs sent to the specified device(s).
566 Enable debugging for all devices.
568 Turn off debugging for all devices
569 .It bus Ns Op :target Ns Op :lun
570 Turn on debugging for the given bus, target or lun.
572 and lun are not specified, they are wildcarded.
573 (i.e., just specifying a
574 bus turns on debugging printfs for all devices on that bus.)
577 Show or set the number of "tagged openings" or simultaneous transactions
578 we attempt to queue to a particular device.
581 command, with no command-specific arguments (i.e., only generic arguments)
582 prints out the "soft" maximum number of transactions that can be queued to
583 the device in question.
584 For more detailed information, use the
586 argument described below.
589 Set the number of tags for the given device.
590 This must be between the
591 minimum and maximum number set in the kernel quirk table.
593 most devices that support tagged queueing is a minimum of 2 and a maximum
595 The minimum and maximum values for a given device may be
596 determined by using the
603 subcommand is described below.
605 Be quiet, and do not report the number of tags.
606 This is generally used when
607 setting the number of tags.
609 The verbose flag has special functionality for the
614 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
617 This is the amount of capacity for transactions queued to a given device.
619 This is the number of transactions currently queued to a device.
621 This is the kernel queue space for transactions.
622 This count usually mirrors
623 dev_openings except during error recovery operations when
624 the device queue is frozen (device is not allowed to receive
625 commands), the number of dev_openings is reduced, or transaction
628 This is the number of transactions waiting in the kernel queue for capacity
630 This number is usually zero unless error recovery is in
633 The held count is the number of CCBs held by peripheral drivers that have
634 either just been completed or are about to be released to the transport
635 layer for service by a device.
636 Held CCBs reserve capacity on a given
639 This is the current "hard" minimum number of transactions that can be
640 queued to a device at once.
643 value above cannot go below this number.
644 The default value for
646 is 2, although it may be set higher or lower for various devices.
648 This is the "hard" maximum number of transactions that can be queued to a
652 value cannot go above this number.
653 The default value for
655 is 255, although it may be set higher or lower for various devices.
659 Show or negotiate various communication parameters.
661 not support setting or changing some of these values.
663 Adaptec 174x controllers do not support changing a device's sync rate or
668 will not attempt to set the parameter if the controller indicates that it
669 does not support setting the parameter.
670 To find out what the controller
678 command is described below.
679 Also, some controller drivers do not support
680 setting negotiation parameters, even if the underlying controller supports
682 Some controllers, such as the Advansys wide
683 controllers, support enabling and disabling synchronous negotiation for
684 a device, but do not support setting the synchronous negotiation rate.
687 Attempt to make the negotiation settings take effect immediately by sending
688 a Test Unit Ready command to the device.
690 Show or set current negotiation settings.
692 .It Fl D Ar enable|disable
693 Enable or disable disconnection.
695 Set the command delay offset.
697 Be quiet, do not print anything.
698 This is generally useful when you want to
699 set a parameter, but do not want any status information.
701 Change the synchronization rate for a device.
702 The sync rate is a floating
703 point value specified in MHz.
706 is a legal value, as is
708 .It Fl T Ar enable|disable
709 Enable or disable tagged queueing for a device.
711 Show or set user negotiation settings.
712 The default is to show or set
713 current negotiation settings.
715 The verbose switch has special meaning for the
720 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
722 .It Fl W Ar bus_width
723 Specify the bus width to negotiate with a device.
726 The only useful values to specify are 8, 16, and 32
728 The controller must support the bus width in question in order for
729 the setting to take effect.
732 In general, sync rate and offset settings will not take effect for a
733 device until a command has been sent to the device.
736 switch above will automatically send a Test Unit Ready to the device so
737 negotiation parameters will take effect.
741 FORMAT UNIT command to the named device.
743 .Em WARNING! WARNING! WARNING!
745 Low level formatting a disk will destroy ALL data on the disk.
747 extreme caution when issuing this command.
748 Many users low-level format
749 disks that do not really need to be low-level formatted.
751 relatively few scenarios that call for low-level formatting a disk.
753 low-level formatting a disk is to initialize the disk after changing
754 its physical sector size.
755 Another reason for low-level formatting a disk
756 is to revive the disk if you are getting "medium format corrupted" errors
757 from the disk in response to read and write requests.
759 Some disks take longer than others to format.
760 Users should specify a
761 timeout long enough to allow the format to complete.
763 timeout is 3 hours, which should be long enough for most disks.
765 disks will complete a format operation in a very short period of time
766 (on the order of 5 minutes or less).
767 This is often because the drive
768 does not really support the FORMAT UNIT command -- it just accepts the
769 command, waits a few minutes and then returns it.
773 subcommand takes several arguments that modify its default behavior.
778 arguments can be useful for scripts.
782 Be quiet, do not print any status messages.
783 This option will not disable
784 the questions, however.
785 To disable questions, use the
792 This will report status on a format that is already running on the drive.
794 Issue a non-immediate format command.
797 issues the FORMAT UNIT command with the immediate bit set.
799 device to immediately return the format command, before the format has
805 sense information from the device every second to determine how far along
806 in the format process it is.
809 argument is specified,
811 will issue a non-immediate format command, and will be unable to print any
812 information to let the user know what percentage of the disk has been
815 Do not ask any questions.
818 will ask the user if he/she really wants to format the disk in question,
819 and also if the default format command timeout is acceptable.
821 will not be asked about the timeout if a timeout is specified on the
825 Print out verbose usage information.
830 variable allows the user to specify an alternate mode page format file.
834 variable determines which text editor
836 starts when editing mode pages.
838 .Bl -tag -width /usr/share/misc/scsi_modes -compact
839 .It Pa /usr/share/misc/scsi_modes
840 is the SCSI mode format database.
842 is the transport layer device.
844 are the CAM application passthrough devices.
847 .Dl camcontrol eject -n cd -u 1 -v
849 Eject the CD from cd1, and print SCSI sense information if the command
852 .Dl camcontrol tur da0
854 Send the SCSI test unit ready command to da0.
857 utility will report whether the disk is ready, but will not display sense
858 information if the command fails since the
860 switch was not specified.
862 .Bd -literal -offset indent
863 camcontrol tur da1 -E -C 4 -t 50 -v
866 Send a test unit ready command to da1.
867 Enable kernel error recovery.
868 Specify a retry count of 4, and a timeout of 50 seconds.
872 flag) if the command fails.
873 Since error recovery is turned on, the
874 disk will be spun up if it is not currently spinning.
877 utility will report whether the disk is ready.
878 .Bd -literal -offset indent
879 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
880 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
883 Issue a READ BUFFER command (0x3C) to cd1.
884 Display the buffer size of cd1,
885 and display the first 10 bytes from the cache on cd1.
887 information if the command fails.
889 .Bd -literal -offset indent
890 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
891 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
894 Issue a WRITE BUFFER (0x3B) command to cd1.
895 Write out 10 bytes of data,
896 not including the (reserved) 4 byte header.
897 Print out sense information if
899 Be very careful with this command, improper use may
900 cause data corruption.
902 .Bd -literal -offset indent
903 camcontrol modepage da3 -m 1 -e -P 3
906 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
907 settings on the drive.
908 Mode page 1 contains a disk drive's auto read and
909 write reallocation settings, among other things.
911 .Dl camcontrol rescan all
913 Rescan all SCSI busses in the system for devices that have been added,
916 .Dl camcontrol rescan 0
918 Rescan SCSI bus 0 for devices that have been added, removed or changed.
920 .Dl camcontrol rescan 0:1:0
922 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
925 .Dl camcontrol tags da5 -N 24
927 Set the number of concurrent transactions for da5 to 24.
929 .Bd -literal -offset indent
930 camcontrol negotiate -n da -u 4 -T disable
933 Disable tagged queueing for da4.
935 .Bd -literal -offset indent
936 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
939 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
941 Test Unit Ready command to make the settings take effect.
951 utility first appeared in
954 The mode page editing code and arbitrary SCSI command code are based upon
959 library, written by Julian Elischer and Peter Dufault.
962 program first appeared in
964 and first appeared in
969 .An Kenneth Merry Aq ken@FreeBSD.org
971 The code that parses the generic command line arguments does not know that
972 some of the subcommands take multiple arguments.
973 So if, for instance, you
974 tried something like this:
975 .Bd -literal -offset indent
976 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
979 The sense information from the test unit ready command would not get
980 printed out, since the first
984 bails out when it sees the second argument to
988 Fixing this behavior would take some gross code, or changes to the
991 The best way to circumvent this problem is to always make sure
994 arguments before any command-specific arguments.
projects / FreeBSD / releng / 8.0.git / blob