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
28 .\" $FreeBSD: src/sbin/camcontrol/camcontrol.8,v 1.19.2.12 2003/01/08 17:55:02 njl Exp $
29 .\" $DragonFly: src/sbin/camcontrol/camcontrol.8,v 1.10 2008/05/02 02:05:05 swildner Exp $
31 .Dd September 14, 1998
36 .Nd CAM control program
50 .Op Fl u Ar unit_number
68 .Op Fl r Ar reporttype
97 .Aq all | bus Ns Op :target:lun
100 .Aq all | bus Ns Op :target:lun
120 .Aq Fl c Ar cmd Op args
121 .Op Fl i Ar len Ar fmt
123 .Op Fl o Ar len Ar fmt Op args
133 .Aq all|off|bus Ns Op :target Ns Op :lun
146 .Op Fl D Ar enable|disable
150 .Op Fl T Ar enable|disable
152 .Op Fl W Ar bus_width
167 utility is designed to provide a way for users to access and control the
174 can cause a loss of data and/or system crashes if used improperly. Even
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
181 device identifier. A device identifier can take one of three forms:
184 Specify a device name and unit number combination, like "da5" or "cd3".
185 Note that character device node names (e.g. /dev/da0) are
189 Specify a bus number and target id. The bus number can be determined from
191 .Dq camcontrol devlist .
192 The lun defaults to 0.
194 Specify the bus, target and lun for a device. (e.g. 1:2:0)
197 The device identifier, if it is specified,
199 come immediately after the function name, and before any generic or
200 function-specific arguments. Note that the
204 arguments described below will override any device name or unit number
205 specified beforehand. The
211 override a specified bus:target or bus:target:lun, however.
215 primary functions support these generic arguments:
218 SCSI command retry count. In order for this to work, error recovery
222 Instruct the kernel to perform generic SCSI error recovery for the given
223 command. This is needed in order for the retry count
225 to be honored. Other than retrying commands, the generic error recovery in
226 the code will generally attempt to spin up drives that are not spinning.
227 It may take some other actions, depending upon the sense code returned from
230 Specify the device type to operate on, e.g. "da", "cd".
232 SCSI command timeout in seconds. This overrides the default timeout for
234 .It Fl u Ar unit_number
235 Specify the device unit number, e.g. "1", "5".
237 Be verbose, print out sense information for failed SCSI commands.
240 Primary command functions:
241 .Bl -tag -width periphlist
243 List all physical devices (logical units) attached to the CAM subsystem.
244 This also includes a list of peripheral drivers attached to each device.
247 argument, SCSI bus number, adapter name and unit numbers are printed as
250 List all peripheral drivers attached to a given physical device (logical
253 Send the SCSI test unit ready (0x00) command to the given device.
256 utility will report whether the device is ready or not.
258 Send a SCSI inquiry command (0x12) to a device. By default,
260 will print out the standard inquiry data, device serial number, and
261 transfer rate information. The user can specify that only certain types of
262 inquiry data be printed:
265 Get the standard inquiry data.
267 Print out the serial number. If this flag is the only one specified,
269 will not print out "Serial Number" before the value returned by the drive.
270 This is to aid in script writing.
272 Print out transfer rate information.
275 Send the SCSI REPORT LUNS (0xA0) command to the given device.
278 will print out the list of logical units (LUNs) supported by the target device.
279 There are a couple of options to modify the output:
280 .Bl -tag -width 01234567890123
282 Just print out a count of LUNs, not the actual LUN numbers.
284 Just print out the LUNs, and don't print out the count.
285 .It Fl r Ar reporttype
286 Specify the type of report to request from the target:
287 .Bl -tag -width 012345678
289 Return the default report.
293 Most targets will support this report if they support the REPORT LUNS
296 Return only well known LUNs.
298 Return all available LUNs.
303 will try to print out LUN numbers in a reasonable format.
304 It can understand the peripheral, flat, LUN and extended LUN formats.
306 Send the SCSI READ CAPACITY command to the given device and display
308 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
309 action will be sent to obtain the full size of the device.
312 will print out the last logical block of the device, and the blocksize of
314 To modify the output format, use the following options:
317 Just print out the blocksize, not the last block or device size.
318 This cannot be used with
323 Print out the device size in human readable (base 2, 1K == 1024) format.
326 and cannot be used with
331 Print out the device size in human readable (base 10, 1K == 1000) format.
333 Print out the number of blocks in the device instead of the last logical
336 Quiet, print out the numbers only (separated by a comma if
342 Print out the last logical block or the size of the device only, and omit
346 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
349 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
352 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
353 start bit set and the load/eject bit set.
355 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
356 start bit cleared and the load/eject bit set.
358 Tell the kernel to scan all busses in the system (with the
360 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
361 (XPT_SCAN_LUN) for new devices or devices that have gone away. The user
362 may specify a scan of all busses, a single bus, or a lun. Scanning all luns
363 on a target isn't supported.
365 Tell the kernel to reset all busses in the system (with the
367 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
368 reset for that bus, or to reset the given bus:target:lun
369 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
370 connecting to that device.
371 Note that this can have a destructive impact
374 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
375 print out any combination of: the total number of defects, the primary
376 defect list (PLIST), and the grown defect list (GLIST).
379 The three format options are:
381 to print out the list as logical blocks,
383 to print out the list in bytes from index format, and
385 to print out the list in physical sector format. The format argument is
386 required. Most drives support the physical sector format. Some drives
387 support the logical block format. Many drives, if they don't support the
388 requested format, return the data in an alternate format, along with sense
389 information indicating that the requested data format isn't supported.
393 attempts to detect this, and print out whatever format the drive returns.
394 If the drive uses a non-standard sense code to report that it doesn't
395 support the requested format,
397 will probably see the error as a failure to complete the request.
399 Print out the grown defect list. This is a list of bad blocks that have
400 been remapped since the disk left the factory.
402 Print out the primary defect list.
411 will print out the number of defects given in the READ DEFECT DATA header
412 returned from the drive.
414 Allows the user to display and optionally edit a SCSI mode page. The mode
415 page formats are located in
416 .Pa /usr/share/misc/scsi_modes .
417 This can be overridden by specifying a different file in the
419 environment variable.
422 command takes several arguments:
425 Disable block descriptors for mode sense.
427 This flag allows the user to edit values in the mode page.
428 .It Fl m Ar mode_page
429 This specifies the number of the mode page the user would like to view
430 and/or edit. This argument is mandatory.
432 This allows the user to specify the page control field. Possible values are:
433 .Bl -tag -width xxx -compact
445 Allows the user to send an arbitrary SCSI CDB to any device.
448 function requires the
450 argument to specify the CDB. Other arguments are optional, depending on
451 the command type. The command and data specification syntax is documented
454 NOTE: If the CDB specified causes data to be transferred to or from the
455 SCSI device in question, you MUST specify either
460 .It Fl c Ar cmd Op args
461 This specifies the SCSI CDB. CDBs may be 6, 10, 12 or 16 bytes.
462 .It Fl i Ar len Ar fmt
463 This specifies the amount of data to read, and how it should be displayed.
467 bytes of data will be read from the device and written to standard output.
468 .It Fl o Ar len Ar fmt Op args
469 This specifies the amount of data to be written to a device, and the data
470 that is to be written. If the format is
473 bytes of data will be read from standard input and written to the device.
476 Turn on CAM debugging printfs in the kernel. This requires
478 in your kernel config file. WARNING: enabling debugging printfs currently
479 causes an EXTREME number of kernel printfs. You may have difficulty
480 turning off the debugging printfs once they start, since the kernel will be
481 busy printing messages and unable to service other requests quickly.
484 function takes a number of arguments:
487 Enable CAM_DEBUG_INFO printfs.
489 Enable CAM_DEBUG_PERIPH printfs.
491 Enable CAM_DEBUG_TRACE printfs.
493 Enable CAM_DEBUG_SUBTRACE printfs.
495 Enable CAM_DEBUG_XPT printfs.
497 Enable CAM_DEBUG_CDB printfs. This will cause the kernel to print out the
498 SCSI CDBs sent to the specified device(s).
500 Enable debugging for all devices.
502 Turn off debugging for all devices
503 .It bus Ns Op :target Ns Op :lun
504 Turn on debugging for the given bus, target or lun. If the lun or target
505 and lun are not specified, they are wildcarded. (i.e., just specifying a
506 bus turns on debugging printfs for all devices on that bus.)
509 Show or set the number of "tagged openings" or simultaneous transactions
510 we attempt to queue to a particular device. By default, the
512 command, with no command-specific arguments (i.e. only generic arguments)
513 prints out the "soft" maximum number of transactions that can be queued to
514 the device in question. For more detailed information, use the
516 argument described below.
519 Set the number of tags for the given device. This must be between the
520 minimum and maximum number set in the kernel quirk table. The default for
521 most devices that support tagged queueing is a minimum of 2 and a maximum
522 of 255. The minimum and maximum values for a given device may be
523 determined by using the
525 switch. The meaning of the
529 subcommand is described below.
531 Be quiet, and don't report the number of tags. This is generally used when
532 setting the number of tags.
534 The verbose flag has special functionality for the
538 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
541 This is the amount of capacity for transactions queued to a given device.
543 This is the number of transactions currently queued to a device.
545 This is the kernel queue space for transactions. This count usually mirrors
546 dev_openings except during error recovery operations when
547 the device queue is frozen (device is not allowed to receive
548 commands), the number of dev_openings is reduced, or transaction
551 This is the number of transactions waiting in the kernel queue for capacity
552 on the device. This number is usually zero unless error recovery is in
555 The held count is the number of CCBs held by peripheral drivers that have
556 either just been completed or are about to be released to the transport
557 layer for service by a device. Held CCBs reserve capacity on a given
560 This is the current "hard" minimum number of transactions that can be
561 queued to a device at once. The
563 value above cannot go below this number. The default value for
565 is 2, although it may be set higher or lower for various devices.
567 This is the "hard" maximum number of transactions that can be queued to a
568 device at one time. The
570 value cannot go above this number. The default value for
572 is 255, although it may be set higher or lower for various devices.
576 Show or negotiate various communication parameters. Some controllers may
577 not support setting or changing some of these values. For instance, the
578 Adaptec 174x controllers do not support changing a device's sync rate or
583 will not attempt to set the parameter if the controller indicates that it
584 does not support setting the parameter. To find out what the controller
587 flag. The meaning of the
591 command is described below. Also, some controller drivers don't support
592 setting negotiation parameters, even if the underlying controller supports
593 negotiation changes. Some controllers, such as the Advansys wide
594 controllers, support enabling and disabling synchronous negotiation for
595 a device, but do not support setting the synchronous negotiation rate.
598 Attempt to make the negotiation settings take effect immediately by sending
599 a Test Unit Ready command to the device.
601 Show or set current negotiation settings. This is the default.
602 .It Fl D Ar enable|disable
603 Enable or disable disconnection.
605 Set the command delay offset.
607 Be quiet, don't print anything. This is generally useful when you want to
608 set a parameter, but don't want any status information.
610 Change the synchronization rate for a device. The sync rate is a floating
611 point value specified in MHz. So, for instance,
613 is a legal value, as is
615 .It Fl T Ar enable|disable
616 Enable or disable tagged queueing for a device.
618 Show or set user negotiation settings. The default is to show or set
619 current negotiation settings.
621 The verbose switch has special meaning for the
623 subcommand. It causes
625 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
627 .It Fl W Ar bus_width
628 Specify the bus width to negotiate with a device. The bus width is
629 specified in bits. The only useful values to specify are 8, 16, and 32
630 bits. The controller must support the bus width in question in order for
631 the setting to take effect.
634 In general, sync rate and offset settings will not take effect for a
635 device until a command has been sent to the device. The
637 switch above will automatically send a Test Unit Ready to the device so
638 negotiation parameters will take effect.
642 FORMAT UNIT command to the named device.
644 .Em WARNING! WARNING! WARNING!
646 Low level formatting a disk will destroy ALL data on the disk. Use
647 extreme caution when issuing this command. Many users low-level format
648 disks that do not really need to be low-level formatted. There are
649 relatively few scenarios that call for low-level formatting a disk.
651 low-level formatting a disk is to initialize the disk after changing
652 its physical sector size. Another reason for low-level formatting a disk
653 is to revive the disk if you are getting "medium format corrupted" errors
654 from the disk in response to read and write requests.
656 Some disks take longer than others to format. Users should specify a
657 timeout long enough to allow the format to complete. The default format
658 timeout is 3 hours, which should be long enough for most disks. Some hard
659 disks will complete a format operation in a very short period of time
660 (on the order of 5 minutes or less). This is often because the drive
661 doesn't really support the FORMAT UNIT command -- it just accepts the
662 command, waits a few minutes and then returns it.
666 subcommand takes several arguments that modify its default behavior. The
670 arguments can be useful for scripts.
673 Be quiet, don't print any status messages. This option will not disable
674 the questions, however. To disable questions, use the
681 This will report status on a format that is already running on the drive.
683 Issue a non-immediate format command. By default,
685 issues the FORMAT UNIT command with the immediate bit set. This tells the
686 device to immediately return the format command, before the format has
687 actually completed. Then,
691 sense information from the device every second to determine how far along
692 in the format process it is. If the
694 argument is specified,
696 will issue a non-immediate format command, and will be unable to print any
697 information to let the user know what percentage of the disk has been
700 Don't ask any questions. By default,
702 will ask the user if he/she really wants to format the disk in question,
703 and also if the default format command timeout is acceptable. The user
704 will not be asked about the timeout if a timeout is specified on the
708 Print out verbose usage information.
713 variable allows the user to specify an alternate mode page format file.
717 variable determines which text editor
719 starts when editing mode pages.
721 .Bl -tag -width /usr/share/misc/scsi_modes -compact
722 .It Pa /usr/share/misc/scsi_modes
723 is the SCSI mode format database.
725 is the transport layer device.
727 are the CAM application passthrough devices.
730 .Dl camcontrol eject -n cd -u 1 -v
732 Eject the CD from cd1, and print SCSI sense information if the command
735 .Dl camcontrol tur da0
737 Send the SCSI test unit ready command to da0.
740 utility will report whether the disk is ready, but will not display sense
741 information if the command fails since the
743 switch was not specified.
744 .Bd -literal -offset indent
745 camcontrol tur da1 -E -C 4 -t 50 -v
748 Send a test unit ready command to da1. Enable kernel error recovery.
749 Specify a retry count of 4, and a timeout of 50 seconds. Enable sense
752 flag) if the command fails. Since error recovery is turned on, the
753 disk will be spun up if it is not currently spinning.
756 utility will report whether the disk is ready.
757 .Bd -literal -offset indent
758 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
759 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
762 Issue a READ BUFFER command (0x3C) to cd1. Display the buffer size of cd1,
763 and display the first 10 bytes from the cache on cd1. Display SCSI sense
764 information if the command fails.
765 .Bd -literal -offset indent
766 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
767 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
770 Issue a WRITE BUFFER (0x3B) command to cd1. Write out 10 bytes of data,
771 not including the (reserved) 4 byte header. Print out sense information if
772 the command fails. Be very careful with this command, improper use may
773 cause data corruption.
774 .Bd -literal -offset indent
775 camcontrol modepage da3 -m 1 -e -P 3
778 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
779 settings on the drive. Mode page 1 contains a disk drive's auto read and
780 write reallocation settings, among other things.
782 .Dl camcontrol rescan all
784 Rescan all SCSI busses in the system for devices that have been added,
787 .Dl camcontrol rescan 0
789 Rescan SCSI bus 0 for devices that have been added, removed or changed.
791 .Dl camcontrol rescan 0:1:0
793 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
796 .Dl camcontrol tags da5 -N 24
798 Set the number of concurrent transactions for da5 to 24.
799 .Bd -literal -offset indent
800 camcontrol negotiate -n da -u 4 -T disable
803 Disable tagged queueing for da4.
804 .Bd -literal -offset indent
805 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
808 Negotiate a sync rate of 20MHz and an offset of 15 with da3. Then send a
809 Test Unit Ready command to make the settings take effect.
819 utility first appeared in
822 The mode page editing code and arbitrary SCSI command code are based upon
827 library, written by Julian Elischer and Peter Dufault. The
829 program first appeared in
831 and first appeared in
836 .An Kenneth Merry Aq ken@FreeBSD.org
838 The code that parses the generic command line arguments doesn't know that
839 some of the subcommands take multiple arguments. So if, for instance, you
840 tried something like this:
841 .Bd -literal -offset indent
842 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
845 The sense information from the test unit ready command would not get
846 printed out, since the first
850 bails out when it sees the second argument to
853 above. Fixing this behavior would take some gross code, or changes to the
855 interface. The best way to circumvent this problem is to always make sure
858 arguments before any command-specific arguments.
lentferj's projects / dragonfly.git / blob