2 .\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006 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
86 .Aq all | bus Ns Op :target:lun
89 .Aq all | bus Ns Op :target:lun
101 .Aq Fl m Ar page | Fl l
109 .Aq Fl c Ar cmd Op args
110 .Op Fl i Ar len Ar fmt
112 .Op Fl o Ar len Ar fmt Op args
122 .Aq all|off|bus Ns Op :target Ns Op :lun
135 .Op Fl D Ar enable|disable
139 .Op Fl T Ar enable|disable
141 .Op Fl W Ar bus_width
156 utility is designed to provide a way for users to access and control the
163 can cause a loss of data and/or system crashes if used improperly.
165 expert users are encouraged to exercise caution when using this command.
166 Novice users should stay away from this utility.
170 utility has a number of primary functions, many of which support an optional
172 A device identifier can take one of three forms:
175 Specify a device name and unit number combination, like "da5" or "cd3".
176 Note that character device node names (e.g.\& /dev/da0) are
180 Specify a bus number and target id.
181 The bus number can be determined from
183 .Dq camcontrol devlist .
184 The lun defaults to 0.
186 Specify the bus, target and lun for a device.
190 The device identifier, if it is specified,
192 come immediately after the function name, and before any generic or
193 function-specific arguments.
198 arguments described below will override any device name or unit number
199 specified beforehand.
206 override a specified bus:target or bus:target:lun, however.
210 primary functions support these generic arguments:
213 SCSI command retry count.
214 In order for this to work, error recovery
218 Instruct the kernel to perform generic SCSI error recovery for the given
220 This is needed in order for the retry count
223 Other than retrying commands, the generic error recovery in
224 the code will generally attempt to spin up drives that are not spinning.
225 It may take some other actions, depending upon the sense code returned from
228 Specify the device type to operate on, e.g.\& "da", "cd".
230 SCSI command timeout in seconds.
231 This overrides the default timeout for
233 .It Fl u Ar unit_number
234 Specify the device unit number, e.g.\& "1", "5".
236 Be verbose, print out sense information for failed SCSI commands.
239 Primary command functions:
240 .Bl -tag -width periphlist
242 List all physical devices (logical units) attached to the CAM subsystem.
243 This also includes a list of peripheral drivers attached to each device.
246 argument, SCSI bus number, adapter name and unit numbers are printed as
249 List all peripheral drivers attached to a given physical device (logical
252 Send the SCSI test unit ready (0x00) command to the given device.
255 utility will report whether the device is ready or not.
257 Send a SCSI inquiry command (0x12) to a device.
260 will print out the standard inquiry data, device serial number, and
261 transfer rate information.
262 The user can specify that only certain types of
263 inquiry data be printed:
266 Get the standard inquiry data.
268 Print out the serial number.
269 If this flag is the only one specified,
271 will not print out "Serial Number" before the value returned by the drive.
272 This is to aid in script writing.
274 Print out transfer rate information.
277 Send the SCSI REPORT LUNS (0xA0) command to the given device.
280 will print out the list of logical units (LUNs) supported by the target device.
281 There are a couple of options to modify the output:
284 Just print out a count of LUNs, not the actual LUN numbers.
286 Just print out the LUNs, and don't print out the count.
287 .It Fl r Ar reporttype
288 Specify the type of report to request from the target:
289 .Bl -tag -width 012345678
291 Return the default report.
295 Most targets will support this report if they support the REPORT LUNS
298 Return only well known LUNs.
300 Return all available LUNs.
305 will try to print out LUN numbers in a reasonable format.
306 It can understand the peripheral, flat, LUN and extended LUN formats.
308 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
311 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
314 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
315 start bit set and the load/eject bit set.
317 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
318 start bit cleared and the load/eject bit set.
320 Tell the kernel to scan all busses in the system (with the
322 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
323 (XPT_SCAN_LUN) for new devices or devices that have gone away.
325 may specify a scan of all busses, a single bus, or a lun.
327 on a target is not supported.
329 Tell the kernel to reset all busses in the system (with the
331 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
332 reset for that bus, or to reset the given bus:target:lun
333 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
334 connecting to that device.
335 Note that this can have a destructive impact
338 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
339 print out any combination of: the total number of defects, the primary
340 defect list (PLIST), and the grown defect list (GLIST).
343 The three format options are:
345 to print out the list as logical blocks,
347 to print out the list in bytes from index format, and
349 to print out the list in physical sector format.
350 The format argument is
352 Most drives support the physical sector format.
354 support the logical block format.
355 Many drives, if they do not support the
356 requested format, return the data in an alternate format, along with sense
357 information indicating that the requested data format is not supported.
361 attempts to detect this, and print out whatever format the drive returns.
362 If the drive uses a non-standard sense code to report that it does not
363 support the requested format,
365 will probably see the error as a failure to complete the request.
367 Print out the grown defect list.
368 This is a list of bad blocks that have
369 been remapped since the disk left the factory.
371 Print out the primary defect list.
380 will print out the number of defects given in the READ DEFECT DATA header
381 returned from the drive.
383 Allows the user to display and optionally edit a SCSI mode page.
385 page formats are located in
386 .Pa /usr/share/misc/scsi_modes .
387 This can be overridden by specifying a different file in the
389 environment variable.
392 command takes several arguments:
395 Disable block descriptors for mode sense.
397 Displays mode page data in binary format.
399 This flag allows the user to edit values in the mode page.
401 either edit mode page values with the text editor pointed to by his
403 environment variable, or supply mode page values via standard input, using
406 uses to display mode page values.
407 The editor will be invoked if
409 detects that standard input is terminal.
411 Lists all available mode pages.
412 .It Fl m Ar mode_page
413 This specifies the number of the mode page the user would like to view
415 This argument is mandatory unless
419 This allows the user to specify the page control field.
421 .Bl -tag -width xxx -compact
433 Allows the user to send an arbitrary SCSI CDB to any device.
436 function requires the
438 argument to specify the CDB.
439 Other arguments are optional, depending on
441 The command and data specification syntax is documented
444 NOTE: If the CDB specified causes data to be transfered to or from the
445 SCSI device in question, you MUST specify either
450 .It Fl c Ar cmd Op args
451 This specifies the SCSI CDB.
452 CDBs may be 6, 10, 12 or 16 bytes.
453 .It Fl i Ar len Ar fmt
454 This specifies the amount of data to read, and how it should be displayed.
458 bytes of data will be read from the device and written to standard output.
459 .It Fl o Ar len Ar fmt Op args
460 This specifies the amount of data to be written to a device, and the data
461 that is to be written.
465 bytes of data will be read from standard input and written to the device.
468 Turn on CAM debugging printfs in the kernel.
469 This requires options CAMDEBUG
470 in your kernel config file.
471 WARNING: enabling debugging printfs currently
472 causes an EXTREME number of kernel printfs.
473 You may have difficulty
474 turning off the debugging printfs once they start, since the kernel will be
475 busy printing messages and unable to service other requests quickly.
478 function takes a number of arguments:
481 Enable CAM_DEBUG_INFO printfs.
483 Enable CAM_DEBUG_PERIPH printfs.
485 Enable CAM_DEBUG_TRACE printfs.
487 Enable CAM_DEBUG_SUBTRACE printfs.
489 Enable CAM_DEBUG_XPT printfs.
491 Enable CAM_DEBUG_CDB printfs.
492 This will cause the kernel to print out the
493 SCSI CDBs sent to the specified device(s).
495 Enable debugging for all devices.
497 Turn off debugging for all devices
498 .It bus Ns Op :target Ns Op :lun
499 Turn on debugging for the given bus, target or lun.
501 and lun are not specified, they are wildcarded.
502 (i.e., just specifying a
503 bus turns on debugging printfs for all devices on that bus.)
506 Show or set the number of "tagged openings" or simultaneous transactions
507 we attempt to queue to a particular device.
510 command, with no command-specific arguments (i.e., only generic arguments)
511 prints out the "soft" maximum number of transactions that can be queued to
512 the device in question.
513 For more detailed information, use the
515 argument described below.
518 Set the number of tags for the given device.
519 This must be between the
520 minimum and maximum number set in the kernel quirk table.
522 most devices that support tagged queueing is a minimum of 2 and a maximum
524 The minimum and maximum values for a given device may be
525 determined by using the
532 subcommand is described below.
534 Be quiet, and do not report the number of tags.
535 This is generally used when
536 setting the number of tags.
538 The verbose flag has special functionality for the
543 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
546 This is the amount of capacity for transactions queued to a given device.
548 This is the number of transactions currently queued to a device.
550 This is the kernel queue space for transactions.
551 This count usually mirrors
552 dev_openings except during error recovery operations when
553 the device queue is frozen (device is not allowed to receive
554 commands), the number of dev_openings is reduced, or transaction
557 This is the number of transactions waiting in the kernel queue for capacity
559 This number is usually zero unless error recovery is in
562 The held count is the number of CCBs held by peripheral drivers that have
563 either just been completed or are about to be released to the transport
564 layer for service by a device.
565 Held CCBs reserve capacity on a given
568 This is the current "hard" minimum number of transactions that can be
569 queued to a device at once.
572 value above cannot go below this number.
573 The default value for
575 is 2, although it may be set higher or lower for various devices.
577 This is the "hard" maximum number of transactions that can be queued to a
581 value cannot go above this number.
582 The default value for
584 is 255, although it may be set higher or lower for various devices.
588 Show or negotiate various communication parameters.
590 not support setting or changing some of these values.
592 Adaptec 174x controllers do not support changing a device's sync rate or
597 will not attempt to set the parameter if the controller indicates that it
598 does not support setting the parameter.
599 To find out what the controller
607 command is described below.
608 Also, some controller drivers do not support
609 setting negotiation parameters, even if the underlying controller supports
611 Some controllers, such as the Advansys wide
612 controllers, support enabling and disabling synchronous negotiation for
613 a device, but do not support setting the synchronous negotiation rate.
616 Attempt to make the negotiation settings take effect immediately by sending
617 a Test Unit Ready command to the device.
619 Show or set current negotiation settings.
621 .It Fl D Ar enable|disable
622 Enable or disable disconnection.
624 Set the command delay offset.
626 Be quiet, do not print anything.
627 This is generally useful when you want to
628 set a parameter, but do not want any status information.
630 Change the synchronization rate for a device.
631 The sync rate is a floating
632 point value specified in MHz.
635 is a legal value, as is
637 .It Fl T Ar enable|disable
638 Enable or disable tagged queueing for a device.
640 Show or set user negotiation settings.
641 The default is to show or set
642 current negotiation settings.
644 The verbose switch has special meaning for the
649 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
651 .It Fl W Ar bus_width
652 Specify the bus width to negotiate with a device.
655 The only useful values to specify are 8, 16, and 32
657 The controller must support the bus width in question in order for
658 the setting to take effect.
661 In general, sync rate and offset settings will not take effect for a
662 device until a command has been sent to the device.
665 switch above will automatically send a Test Unit Ready to the device so
666 negotiation parameters will take effect.
670 FORMAT UNIT command to the named device.
672 .Em WARNING! WARNING! WARNING!
674 Low level formatting a disk will destroy ALL data on the disk.
676 extreme caution when issuing this command.
677 Many users low-level format
678 disks that do not really need to be low-level formatted.
680 relatively few scenarios that call for low-level formatting a disk.
682 low-level formatting a disk is to initialize the disk after changing
683 its physical sector size.
684 Another reason for low-level formatting a disk
685 is to revive the disk if you are getting "medium format corrupted" errors
686 from the disk in response to read and write requests.
688 Some disks take longer than others to format.
689 Users should specify a
690 timeout long enough to allow the format to complete.
692 timeout is 3 hours, which should be long enough for most disks.
694 disks will complete a format operation in a very short period of time
695 (on the order of 5 minutes or less).
696 This is often because the drive
697 does not really support the FORMAT UNIT command -- it just accepts the
698 command, waits a few minutes and then returns it.
702 subcommand takes several arguments that modify its default behavior.
707 arguments can be useful for scripts.
711 Be quiet, do not print any status messages.
712 This option will not disable
713 the questions, however.
714 To disable questions, use the
721 This will report status on a format that is already running on the drive.
723 Issue a non-immediate format command.
726 issues the FORMAT UNIT command with the immediate bit set.
728 device to immediately return the format command, before the format has
734 sense information from the device every second to determine how far along
735 in the format process it is.
738 argument is specified,
740 will issue a non-immediate format command, and will be unable to print any
741 information to let the user know what percentage of the disk has been
744 Do not ask any questions.
747 will ask the user if he/she really wants to format the disk in question,
748 and also if the default format command timeout is acceptable.
750 will not be asked about the timeout if a timeout is specified on the
754 Print out verbose usage information.
759 variable allows the user to specify an alternate mode page format file.
763 variable determines which text editor
765 starts when editing mode pages.
767 .Bl -tag -width /usr/share/misc/scsi_modes -compact
768 .It Pa /usr/share/misc/scsi_modes
769 is the SCSI mode format database.
771 is the transport layer device.
773 are the CAM application passthrough devices.
776 .Dl camcontrol eject -n cd -u 1 -v
778 Eject the CD from cd1, and print SCSI sense information if the command
781 .Dl camcontrol tur da0
783 Send the SCSI test unit ready command to da0.
786 utility will report whether the disk is ready, but will not display sense
787 information if the command fails since the
789 switch was not specified.
791 .Bd -literal -offset indent
792 camcontrol tur da1 -E -C 4 -t 50 -v
795 Send a test unit ready command to da1.
796 Enable kernel error recovery.
797 Specify a retry count of 4, and a timeout of 50 seconds.
801 flag) if the command fails.
802 Since error recovery is turned on, the
803 disk will be spun up if it is not currently spinning.
806 utility will report whether the disk is ready.
807 .Bd -literal -offset indent
808 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
809 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
812 Issue a READ BUFFER command (0x3C) to cd1.
813 Display the buffer size of cd1,
814 and display the first 10 bytes from the cache on cd1.
816 information if the command fails.
818 .Bd -literal -offset indent
819 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
820 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
823 Issue a WRITE BUFFER (0x3B) command to cd1.
824 Write out 10 bytes of data,
825 not including the (reserved) 4 byte header.
826 Print out sense information if
828 Be very careful with this command, improper use may
829 cause data corruption.
831 .Bd -literal -offset indent
832 camcontrol modepage da3 -m 1 -e -P 3
835 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
836 settings on the drive.
837 Mode page 1 contains a disk drive's auto read and
838 write reallocation settings, among other things.
840 .Dl camcontrol rescan all
842 Rescan all SCSI busses in the system for devices that have been added,
845 .Dl camcontrol rescan 0
847 Rescan SCSI bus 0 for devices that have been added, removed or changed.
849 .Dl camcontrol rescan 0:1:0
851 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
854 .Dl camcontrol tags da5 -N 24
856 Set the number of concurrent transactions for da5 to 24.
858 .Bd -literal -offset indent
859 camcontrol negotiate -n da -u 4 -T disable
862 Disable tagged queueing for da4.
864 .Bd -literal -offset indent
865 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
868 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
870 Test Unit Ready command to make the settings take effect.
880 utility first appeared in
883 The mode page editing code and arbitrary SCSI command code are based upon
888 library, written by Julian Elischer and Peter Dufault.
891 program first appeared in
893 and first appeared in
898 .An Kenneth Merry Aq ken@FreeBSD.org
900 The code that parses the generic command line arguments does not know that
901 some of the subcommands take multiple arguments.
902 So if, for instance, you
903 tried something like this:
904 .Bd -literal -offset indent
905 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
908 The sense information from the test unit ready command would not get
909 printed out, since the first
913 bails out when it sees the second argument to
917 Fixing this behavior would take some gross code, or changes to the
920 The best way to circumvent this problem is to always make sure
923 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob