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
67 .Op Fl r Ar reporttype
96 .Aq all | bus Ns Op :target:lun
99 .Aq all | bus Ns Op :target:lun
111 .Aq Fl m Ar page | Fl l
119 .Aq Fl c Ar cmd Op args
120 .Op Fl i Ar len Ar fmt
122 .Op Fl o Ar len Ar fmt Op args
132 .Aq all|off|bus Ns Op :target Ns Op :lun
145 .Op Fl D Ar enable|disable
149 .Op Fl T Ar enable|disable
151 .Op Fl W Ar bus_width
166 utility is designed to provide a way for users to access and control the
173 can cause a loss of data and/or system crashes if used improperly.
175 expert users are encouraged to exercise caution when using this command.
176 Novice users should stay away from this utility.
180 utility has a number of primary functions, many of which support an optional
182 A device identifier can take one of three forms:
185 Specify a device name and unit number combination, like "da5" or "cd3".
186 Note that character device node names (e.g.\& /dev/da0) are
190 Specify a bus number and target id.
191 The bus number can be determined from
193 .Dq camcontrol devlist .
194 The lun defaults to 0.
196 Specify the bus, target and lun for a device.
200 The device identifier, if it is specified,
202 come immediately after the function name, and before any generic or
203 function-specific arguments.
208 arguments described below will override any device name or unit number
209 specified beforehand.
216 override a specified bus:target or bus:target:lun, however.
220 primary functions support these generic arguments:
223 SCSI command retry count.
224 In order for this to work, error recovery
228 Instruct the kernel to perform generic SCSI error recovery for the given
230 This is needed in order for the retry count
233 Other than retrying commands, the generic error recovery in
234 the code will generally attempt to spin up drives that are not spinning.
235 It may take some other actions, depending upon the sense code returned from
238 Specify the device type to operate on, e.g.\& "da", "cd".
240 SCSI command timeout in seconds.
241 This overrides the default timeout for
243 .It Fl u Ar unit_number
244 Specify the device unit number, e.g.\& "1", "5".
246 Be verbose, print out sense information for failed SCSI commands.
249 Primary command functions:
250 .Bl -tag -width periphlist
252 List all physical devices (logical units) attached to the CAM subsystem.
253 This also includes a list of peripheral drivers attached to each device.
256 argument, SCSI bus number, adapter name and unit numbers are printed as
259 List all peripheral drivers attached to a given physical device (logical
262 Send the SCSI test unit ready (0x00) command to the given device.
265 utility will report whether the device is ready or not.
267 Send a SCSI inquiry command (0x12) to a device.
270 will print out the standard inquiry data, device serial number, and
271 transfer rate information.
272 The user can specify that only certain types of
273 inquiry data be printed:
276 Get the standard inquiry data.
278 Print out the serial number.
279 If this flag is the only one specified,
281 will not print out "Serial Number" before the value returned by the drive.
282 This is to aid in script writing.
284 Print out transfer rate information.
287 Send the SCSI REPORT LUNS (0xA0) command to the given device.
290 will print out the list of logical units (LUNs) supported by the target device.
291 There are a couple of options to modify the output:
294 Just print out a count of LUNs, not the actual LUN numbers.
296 Just print out the LUNs, and don't print out the count.
297 .It Fl r Ar reporttype
298 Specify the type of report to request from the target:
299 .Bl -tag -width 012345678
301 Return the default report.
305 Most targets will support this report if they support the REPORT LUNS
308 Return only well known LUNs.
310 Return all available LUNs.
315 will try to print out LUN numbers in a reasonable format.
316 It can understand the peripheral, flat, LUN and extended LUN formats.
318 Send the SCSI READ CAPACITY command to the given device and display
320 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
321 action will be sent to obtain the full size of the device.
324 will print out the last logical block of the device, and the blocksize of
326 To modify the output format, use the following options:
329 Just print out the blocksize, not the last block or device size.
330 This cannot be used with
335 Print out the device size in human readable (base 2, 1K == 1024) format.
338 and cannot be used with
343 Print out the device size in human readable (base 10, 1K == 1000) format.
345 Print out the number of blocks in the device instead of the last logical
348 Quiet, print out the numbers only (separated by a comma if
354 Print out the last logical block or the size of the device only, and omit
358 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
361 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
364 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
365 start bit set and the load/eject bit set.
367 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
368 start bit cleared and the load/eject bit set.
370 Tell the kernel to scan all busses in the system (with the
372 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
373 (XPT_SCAN_LUN) for new devices or devices that have gone away.
375 may specify a scan of all busses, a single bus, or a lun.
377 on a target is not supported.
379 Tell the kernel to reset all busses in the system (with the
381 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
382 reset for that bus, or to reset the given bus:target:lun
383 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
384 connecting to that device.
385 Note that this can have a destructive impact
388 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
389 print out any combination of: the total number of defects, the primary
390 defect list (PLIST), and the grown defect list (GLIST).
393 The three format options are:
395 to print out the list as logical blocks,
397 to print out the list in bytes from index format, and
399 to print out the list in physical sector format.
400 The format argument is
402 Most drives support the physical sector format.
404 support the logical block format.
405 Many drives, if they do not support the
406 requested format, return the data in an alternate format, along with sense
407 information indicating that the requested data format is not supported.
411 attempts to detect this, and print out whatever format the drive returns.
412 If the drive uses a non-standard sense code to report that it does not
413 support the requested format,
415 will probably see the error as a failure to complete the request.
417 Print out the grown defect list.
418 This is a list of bad blocks that have
419 been remapped since the disk left the factory.
421 Print out the primary defect list.
430 will print out the number of defects given in the READ DEFECT DATA header
431 returned from the drive.
433 Allows the user to display and optionally edit a SCSI mode page.
435 page formats are located in
436 .Pa /usr/share/misc/scsi_modes .
437 This can be overridden by specifying a different file in the
439 environment variable.
442 command takes several arguments:
445 Disable block descriptors for mode sense.
447 Displays mode page data in binary format.
449 This flag allows the user to edit values in the mode page.
451 either edit mode page values with the text editor pointed to by his
453 environment variable, or supply mode page values via standard input, using
456 uses to display mode page values.
457 The editor will be invoked if
459 detects that standard input is terminal.
461 Lists all available mode pages.
462 .It Fl m Ar mode_page
463 This specifies the number of the mode page the user would like to view
465 This argument is mandatory unless
469 This allows the user to specify the page control field.
471 .Bl -tag -width xxx -compact
483 Allows the user to send an arbitrary SCSI CDB to any device.
486 function requires the
488 argument to specify the CDB.
489 Other arguments are optional, depending on
491 The command and data specification syntax is documented
494 NOTE: If the CDB specified causes data to be transfered to or from the
495 SCSI device in question, you MUST specify either
500 .It Fl c Ar cmd Op args
501 This specifies the SCSI CDB.
502 CDBs may be 6, 10, 12 or 16 bytes.
503 .It Fl i Ar len Ar fmt
504 This specifies the amount of data to read, and how it should be displayed.
508 bytes of data will be read from the device and written to standard output.
509 .It Fl o Ar len Ar fmt Op args
510 This specifies the amount of data to be written to a device, and the data
511 that is to be written.
515 bytes of data will be read from standard input and written to the device.
518 Turn on CAM debugging printfs in the kernel.
519 This requires options CAMDEBUG
520 in your kernel config file.
521 WARNING: enabling debugging printfs currently
522 causes an EXTREME number of kernel printfs.
523 You may have difficulty
524 turning off the debugging printfs once they start, since the kernel will be
525 busy printing messages and unable to service other requests quickly.
528 function takes a number of arguments:
531 Enable CAM_DEBUG_INFO printfs.
533 Enable CAM_DEBUG_PERIPH printfs.
535 Enable CAM_DEBUG_TRACE printfs.
537 Enable CAM_DEBUG_SUBTRACE printfs.
539 Enable CAM_DEBUG_XPT printfs.
541 Enable CAM_DEBUG_CDB printfs.
542 This will cause the kernel to print out the
543 SCSI CDBs sent to the specified device(s).
545 Enable debugging for all devices.
547 Turn off debugging for all devices
548 .It bus Ns Op :target Ns Op :lun
549 Turn on debugging for the given bus, target or lun.
551 and lun are not specified, they are wildcarded.
552 (i.e., just specifying a
553 bus turns on debugging printfs for all devices on that bus.)
556 Show or set the number of "tagged openings" or simultaneous transactions
557 we attempt to queue to a particular device.
560 command, with no command-specific arguments (i.e., only generic arguments)
561 prints out the "soft" maximum number of transactions that can be queued to
562 the device in question.
563 For more detailed information, use the
565 argument described below.
568 Set the number of tags for the given device.
569 This must be between the
570 minimum and maximum number set in the kernel quirk table.
572 most devices that support tagged queueing is a minimum of 2 and a maximum
574 The minimum and maximum values for a given device may be
575 determined by using the
582 subcommand is described below.
584 Be quiet, and do not report the number of tags.
585 This is generally used when
586 setting the number of tags.
588 The verbose flag has special functionality for the
593 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
596 This is the amount of capacity for transactions queued to a given device.
598 This is the number of transactions currently queued to a device.
600 This is the kernel queue space for transactions.
601 This count usually mirrors
602 dev_openings except during error recovery operations when
603 the device queue is frozen (device is not allowed to receive
604 commands), the number of dev_openings is reduced, or transaction
607 This is the number of transactions waiting in the kernel queue for capacity
609 This number is usually zero unless error recovery is in
612 The held count is the number of CCBs held by peripheral drivers that have
613 either just been completed or are about to be released to the transport
614 layer for service by a device.
615 Held CCBs reserve capacity on a given
618 This is the current "hard" minimum number of transactions that can be
619 queued to a device at once.
622 value above cannot go below this number.
623 The default value for
625 is 2, although it may be set higher or lower for various devices.
627 This is the "hard" maximum number of transactions that can be queued to a
631 value cannot go above this number.
632 The default value for
634 is 255, although it may be set higher or lower for various devices.
638 Show or negotiate various communication parameters.
640 not support setting or changing some of these values.
642 Adaptec 174x controllers do not support changing a device's sync rate or
647 will not attempt to set the parameter if the controller indicates that it
648 does not support setting the parameter.
649 To find out what the controller
657 command is described below.
658 Also, some controller drivers do not support
659 setting negotiation parameters, even if the underlying controller supports
661 Some controllers, such as the Advansys wide
662 controllers, support enabling and disabling synchronous negotiation for
663 a device, but do not support setting the synchronous negotiation rate.
666 Attempt to make the negotiation settings take effect immediately by sending
667 a Test Unit Ready command to the device.
669 Show or set current negotiation settings.
671 .It Fl D Ar enable|disable
672 Enable or disable disconnection.
674 Set the command delay offset.
676 Be quiet, do not print anything.
677 This is generally useful when you want to
678 set a parameter, but do not want any status information.
680 Change the synchronization rate for a device.
681 The sync rate is a floating
682 point value specified in MHz.
685 is a legal value, as is
687 .It Fl T Ar enable|disable
688 Enable or disable tagged queueing for a device.
690 Show or set user negotiation settings.
691 The default is to show or set
692 current negotiation settings.
694 The verbose switch has special meaning for the
699 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
701 .It Fl W Ar bus_width
702 Specify the bus width to negotiate with a device.
705 The only useful values to specify are 8, 16, and 32
707 The controller must support the bus width in question in order for
708 the setting to take effect.
711 In general, sync rate and offset settings will not take effect for a
712 device until a command has been sent to the device.
715 switch above will automatically send a Test Unit Ready to the device so
716 negotiation parameters will take effect.
720 FORMAT UNIT command to the named device.
722 .Em WARNING! WARNING! WARNING!
724 Low level formatting a disk will destroy ALL data on the disk.
726 extreme caution when issuing this command.
727 Many users low-level format
728 disks that do not really need to be low-level formatted.
730 relatively few scenarios that call for low-level formatting a disk.
732 low-level formatting a disk is to initialize the disk after changing
733 its physical sector size.
734 Another reason for low-level formatting a disk
735 is to revive the disk if you are getting "medium format corrupted" errors
736 from the disk in response to read and write requests.
738 Some disks take longer than others to format.
739 Users should specify a
740 timeout long enough to allow the format to complete.
742 timeout is 3 hours, which should be long enough for most disks.
744 disks will complete a format operation in a very short period of time
745 (on the order of 5 minutes or less).
746 This is often because the drive
747 does not really support the FORMAT UNIT command -- it just accepts the
748 command, waits a few minutes and then returns it.
752 subcommand takes several arguments that modify its default behavior.
757 arguments can be useful for scripts.
761 Be quiet, do not print any status messages.
762 This option will not disable
763 the questions, however.
764 To disable questions, use the
771 This will report status on a format that is already running on the drive.
773 Issue a non-immediate format command.
776 issues the FORMAT UNIT command with the immediate bit set.
778 device to immediately return the format command, before the format has
784 sense information from the device every second to determine how far along
785 in the format process it is.
788 argument is specified,
790 will issue a non-immediate format command, and will be unable to print any
791 information to let the user know what percentage of the disk has been
794 Do not ask any questions.
797 will ask the user if he/she really wants to format the disk in question,
798 and also if the default format command timeout is acceptable.
800 will not be asked about the timeout if a timeout is specified on the
804 Print out verbose usage information.
809 variable allows the user to specify an alternate mode page format file.
813 variable determines which text editor
815 starts when editing mode pages.
817 .Bl -tag -width /usr/share/misc/scsi_modes -compact
818 .It Pa /usr/share/misc/scsi_modes
819 is the SCSI mode format database.
821 is the transport layer device.
823 are the CAM application passthrough devices.
826 .Dl camcontrol eject -n cd -u 1 -v
828 Eject the CD from cd1, and print SCSI sense information if the command
831 .Dl camcontrol tur da0
833 Send the SCSI test unit ready command to da0.
836 utility will report whether the disk is ready, but will not display sense
837 information if the command fails since the
839 switch was not specified.
841 .Bd -literal -offset indent
842 camcontrol tur da1 -E -C 4 -t 50 -v
845 Send a test unit ready command to da1.
846 Enable kernel error recovery.
847 Specify a retry count of 4, and a timeout of 50 seconds.
851 flag) if the command fails.
852 Since error recovery is turned on, the
853 disk will be spun up if it is not currently spinning.
856 utility will report whether the disk is ready.
857 .Bd -literal -offset indent
858 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
859 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
862 Issue a READ BUFFER command (0x3C) to cd1.
863 Display the buffer size of cd1,
864 and display the first 10 bytes from the cache on cd1.
866 information if the command fails.
868 .Bd -literal -offset indent
869 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
870 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
873 Issue a WRITE BUFFER (0x3B) command to cd1.
874 Write out 10 bytes of data,
875 not including the (reserved) 4 byte header.
876 Print out sense information if
878 Be very careful with this command, improper use may
879 cause data corruption.
881 .Bd -literal -offset indent
882 camcontrol modepage da3 -m 1 -e -P 3
885 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
886 settings on the drive.
887 Mode page 1 contains a disk drive's auto read and
888 write reallocation settings, among other things.
890 .Dl camcontrol rescan all
892 Rescan all SCSI busses in the system for devices that have been added,
895 .Dl camcontrol rescan 0
897 Rescan SCSI bus 0 for devices that have been added, removed or changed.
899 .Dl camcontrol rescan 0:1:0
901 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
904 .Dl camcontrol tags da5 -N 24
906 Set the number of concurrent transactions for da5 to 24.
908 .Bd -literal -offset indent
909 camcontrol negotiate -n da -u 4 -T disable
912 Disable tagged queueing for da4.
914 .Bd -literal -offset indent
915 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
918 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
920 Test Unit Ready command to make the settings take effect.
930 utility first appeared in
933 The mode page editing code and arbitrary SCSI command code are based upon
938 library, written by Julian Elischer and Peter Dufault.
941 program first appeared in
943 and first appeared in
948 .An Kenneth Merry Aq ken@FreeBSD.org
950 The code that parses the generic command line arguments does not know that
951 some of the subcommands take multiple arguments.
952 So if, for instance, you
953 tried something like this:
954 .Bd -literal -offset indent
955 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
958 The sense information from the test unit ready command would not get
959 printed out, since the first
963 bails out when it sees the second argument to
967 Fixing this behavior would take some gross code, or changes to the
970 The best way to circumvent this problem is to always make sure
973 arguments before any command-specific arguments.
projects / FreeBSD / releng / 7.2.git / blob