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 $
35 .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
181 utility is designed to provide a way for users to access and control the
188 can cause a loss of data and/or system crashes if used improperly. Even
189 expert users are encouraged to exercise caution when using this command.
190 Novice users should stay away from this utility.
194 utility has a number of primary functions, many of which support an optional
195 device identifier. A device identifier can take one of three forms:
198 Specify a device name and unit number combination, like "da5" or "cd3".
199 Note that character device node names (e.g. /dev/da0) are
203 Specify a bus number and target id. The bus number can be determined from
205 .Dq camcontrol devlist .
206 The lun defaults to 0.
208 Specify the bus, target and lun for a device. (e.g. 1:2:0)
211 The device identifier, if it is specified,
213 come immediately after the function name, and before any generic or
214 function-specific arguments. Note that the
218 arguments described below will override any device name or unit number
219 specified beforehand. The
225 override a specified bus:target or bus:target:lun, however.
229 primary functions support these generic arguments:
232 SCSI command retry count. In order for this to work, error recovery
236 Instruct the kernel to perform generic SCSI error recovery for the given
237 command. This is needed in order for the retry count
239 to be honored. 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. This overrides the default timeout for
248 .It Fl u Ar unit_number
249 Specify the device unit number, e.g. "1", "5".
251 Be verbose, print out sense information for failed SCSI commands.
254 Primary command functions:
255 .Bl -tag -width periphlist
257 List all physical devices (logical units) attached to the CAM subsystem.
258 This also includes a list of peripheral drivers attached to each device.
261 argument, SCSI bus number, adapter name and unit numbers are printed as
263 On the other hand, with the
265 argument, only the bus adapter, and unit information will be printed, and
266 device information will be omited.
268 List all peripheral drivers attached to a given physical device (logical
271 Send the SCSI test unit ready (0x00) command to the given device.
274 utility will report whether the device is ready or not.
276 Send a SCSI inquiry command (0x12) to a device. By default,
278 will print out the standard inquiry data, device serial number, and
279 transfer rate information. The user can specify that only certain types of
280 inquiry data be printed:
283 Get the standard inquiry data.
285 Print out the serial number. 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 the SCSI REPORT LUNS (0xA0) command to the given device.
296 will print out the list of logical units (LUNs) supported by the target device.
297 There are a couple of options to modify the output:
298 .Bl -tag -width 01234567890123
300 Just print out a count of LUNs, not the actual LUN numbers.
302 Just print out the LUNs, and don't print out the count.
303 .It Fl r Ar reporttype
304 Specify the type of report to request from the target:
305 .Bl -tag -width 012345678
307 Return the default report.
311 Most targets will support this report if they support the REPORT LUNS
314 Return only well known LUNs.
316 Return all available LUNs.
321 will try to print out LUN numbers in a reasonable format.
322 It can understand the peripheral, flat, LUN and extended LUN formats.
324 Send the SCSI READ CAPACITY command to the given device and display
326 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
327 action will be sent to obtain the full size of the device.
330 will print out the last logical block of the device, and the blocksize of
332 To modify the output format, use the following options:
335 Just print out the blocksize, not the last block or device size.
336 This cannot be used with
341 Print out the device size in human readable (base 2, 1K == 1024) format.
344 and cannot be used with
349 Print out the device size in human readable (base 10, 1K == 1000) format.
351 Print out the number of blocks in the device instead of the last logical
354 Quiet, print out the numbers only (separated by a comma if
360 Print out the last logical block or the size of the device only, and omit
364 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
367 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
370 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
371 start bit set and the load/eject bit set.
373 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
374 start bit cleared and the load/eject bit set.
376 Tell the kernel to scan all busses in the system (with the
378 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
379 (XPT_SCAN_LUN) for new devices or devices that have gone away. The user
380 may specify a scan of all busses, a single bus, or a lun. Scanning all luns
381 on a target isn't supported.
383 Tell the kernel to reset all busses in the system (with the
385 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
386 reset for that bus, or to reset the given bus:target:lun
387 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
388 connecting to that device.
389 Note that this can have a destructive impact
392 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
393 print out any combination of: the total number of defects, the primary
394 defect list (PLIST), and the grown defect list (GLIST).
397 The three format options are:
399 to print out the list as logical blocks,
401 to print out the list in bytes from index format, and
403 to print out the list in physical sector format. The format argument is
404 required. Most drives support the physical sector format. Some drives
405 support the logical block format. Many drives, if they don't support the
406 requested format, return the data in an alternate format, along with sense
407 information indicating that the requested data format isn't 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 doesn't
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. This is a list of bad blocks that have
418 been remapped since the disk left the factory.
420 Print out the primary defect list.
429 will print out the number of defects given in the READ DEFECT DATA header
430 returned from the drive.
432 Allows the user to display and optionally edit a SCSI mode page. The mode
433 page formats are located in
434 .Pa /usr/share/misc/scsi_modes .
435 This can be overridden by specifying a different file in the
437 environment variable.
440 command takes several arguments:
443 Disable block descriptors for mode sense.
445 This flag allows the user to edit values in the mode page.
446 .It Fl m Ar mode_page
447 This specifies the number of the mode page the user would like to view
448 and/or edit. This argument is mandatory.
450 This allows the user to specify the page control field. Possible values are:
451 .Bl -tag -width xxx -compact
463 Allows the user to send an arbitrary SCSI CDB to any device.
466 function requires the
468 argument to specify the CDB. Other arguments are optional, depending on
469 the command type. The command and data specification syntax is documented
472 NOTE: If the CDB specified causes data to be transferred to or from the
473 SCSI device in question, you MUST specify either
478 .It Fl c Ar cmd Op args
479 This specifies the SCSI CDB. CDBs may be 6, 10, 12 or 16 bytes.
480 .It Fl i Ar len Ar fmt
481 This specifies the amount of data to read, and how it should be displayed.
485 bytes of data will be read from the device and written to standard output.
486 .It Fl o Ar len Ar fmt Op args
487 This specifies the amount of data to be written to a device, and the data
488 that is to be written. If the format is
491 bytes of data will be read from standard input and written to the device.
494 Turn on CAM debugging printfs in the kernel. This requires
496 in your kernel config file. WARNING: enabling debugging printfs currently
497 causes an EXTREME number of kernel printfs. You may have difficulty
498 turning off the debugging printfs once they start, since the kernel will be
499 busy printing messages and unable to service other requests quickly.
502 function takes a number of arguments:
505 Enable CAM_DEBUG_INFO printfs.
507 Enable CAM_DEBUG_PERIPH printfs.
509 Enable CAM_DEBUG_TRACE printfs.
511 Enable CAM_DEBUG_SUBTRACE printfs.
513 Enable CAM_DEBUG_XPT printfs.
515 Enable CAM_DEBUG_CDB printfs. This will cause the kernel to print out the
516 SCSI CDBs sent to the specified device(s).
518 Enable debugging for all devices.
520 Turn off debugging for all devices
521 .It bus Ns Op :target Ns Op :lun
522 Turn on debugging for the given bus, target or lun. If the lun or target
523 and lun are not specified, they are wildcarded. (i.e., just specifying a
524 bus turns on debugging printfs for all devices on that bus.)
527 Show or set the number of "tagged openings" or simultaneous transactions
528 we attempt to queue to a particular device. By default, the
530 command, with no command-specific arguments (i.e. only generic arguments)
531 prints out the "soft" maximum number of transactions that can be queued to
532 the device in question. For more detailed information, use the
534 argument described below.
537 Set the number of tags for the given device. This must be between the
538 minimum and maximum number set in the kernel quirk table. The default for
539 most devices that support tagged queueing is a minimum of 2 and a maximum
540 of 255. The minimum and maximum values for a given device may be
541 determined by using the
543 switch. The meaning of the
547 subcommand is described below.
549 Be quiet, and don't report the number of tags. This is generally used when
550 setting the number of tags.
552 The verbose flag has special functionality for the
556 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
559 This is the amount of capacity for transactions queued to a given device.
561 This is the number of transactions currently queued to a device.
563 This is the kernel queue space for transactions. This count usually mirrors
564 dev_openings except during error recovery operations when
565 the device queue is frozen (device is not allowed to receive
566 commands), the number of dev_openings is reduced, or transaction
569 This is the number of transactions waiting in the kernel queue for capacity
570 on the device. This number is usually zero unless error recovery is in
573 The held count is the number of CCBs held by peripheral drivers that have
574 either just been completed or are about to be released to the transport
575 layer for service by a device. Held CCBs reserve capacity on a given
578 This is the current "hard" minimum number of transactions that can be
579 queued to a device at once. The
581 value above cannot go below this number. The default value for
583 is 2, although it may be set higher or lower for various devices.
585 This is the "hard" maximum number of transactions that can be queued to a
586 device at one time. The
588 value cannot go above this number. The default value for
590 is 255, although it may be set higher or lower for various devices.
594 Show or negotiate various communication parameters. Some controllers may
595 not support setting or changing some of these values. For instance, the
596 Adaptec 174x controllers do not support changing a device's sync rate or
601 will not attempt to set the parameter if the controller indicates that it
602 does not support setting the parameter. To find out what the controller
605 flag. The meaning of the
609 command is described below. Also, some controller drivers don't support
610 setting negotiation parameters, even if the underlying controller supports
611 negotiation changes. 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. This is the default.
620 .It Fl D Ar enable|disable
621 Enable or disable disconnection.
623 Set the command delay offset.
625 Be quiet, don't print anything. This is generally useful when you want to
626 set a parameter, but don't want any status information.
628 Change the synchronization rate for a device. The sync rate is a floating
629 point value specified in MHz. So, for instance,
631 is a legal value, as is
633 .It Fl T Ar enable|disable
634 Enable or disable tagged queueing for a device.
636 Show or set user negotiation settings. The default is to show or set
637 current negotiation settings.
639 The verbose switch has special meaning for the
641 subcommand. It causes
643 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
645 .It Fl W Ar bus_width
646 Specify the bus width to negotiate with a device. The bus width is
647 specified in bits. The only useful values to specify are 8, 16, and 32
648 bits. The controller must support the bus width in question in order for
649 the setting to take effect.
652 In general, sync rate and offset settings will not take effect for a
653 device until a command has been sent to the device. The
655 switch above will automatically send a Test Unit Ready to the device so
656 negotiation parameters will take effect.
660 FORMAT UNIT command to the named device.
662 .Em WARNING! WARNING! WARNING!
664 Low level formatting a disk will destroy ALL data on the disk. Use
665 extreme caution when issuing this command. Many users low-level format
666 disks that do not really need to be low-level formatted. There are
667 relatively few scenarios that call for low-level formatting a disk.
669 low-level formatting a disk is to initialize the disk after changing
670 its physical sector size. Another reason for low-level formatting a disk
671 is to revive the disk if you are getting "medium format corrupted" errors
672 from the disk in response to read and write requests.
674 Some disks take longer than others to format. Users should specify a
675 timeout long enough to allow the format to complete. The default format
676 timeout is 3 hours, which should be long enough for most disks. Some hard
677 disks will complete a format operation in a very short period of time
678 (on the order of 5 minutes or less). This is often because the drive
679 doesn't really support the FORMAT UNIT command -- it just accepts the
680 command, waits a few minutes and then returns it.
684 subcommand takes several arguments that modify its default behavior. The
688 arguments can be useful for scripts.
691 Be quiet, don't print any status messages. This option will not disable
692 the questions, however. To disable questions, use the
699 This will report status on a format that is already running on the drive.
701 Issue a non-immediate format command. By default,
703 issues the FORMAT UNIT command with the immediate bit set. This tells the
704 device to immediately return the format command, before the format has
705 actually completed. Then,
709 sense information from the device every second to determine how far along
710 in the format process it is. If the
712 argument is specified,
714 will issue a non-immediate format command, and will be unable to print any
715 information to let the user know what percentage of the disk has been
718 Don't ask any questions. By default,
720 will ask the user if he/she really wants to format the disk in question,
721 and also if the default format command timeout is acceptable. The user
722 will not be asked about the timeout if a timeout is specified on the
726 Put ATA device into IDLE state.
729 specifies automatic standby timer value in seconds.
730 Value 0 disables timer.
732 Put ATA device into STANDBY state.
735 specifies automatic standby timer value in seconds.
736 Value 0 disables timer.
738 Put ATA device into SLEEP state.
739 Note that the only way get device out of
740 this state may be reset.
742 Print out verbose usage information.
747 variable allows the user to specify an alternate mode page format file.
751 variable determines which text editor
753 starts when editing mode pages.
755 .Bl -tag -width /usr/share/misc/scsi_modes -compact
756 .It Pa /usr/share/misc/scsi_modes
757 is the SCSI mode format database.
759 is the transport layer device.
761 are the CAM application passthrough devices.
764 .Dl camcontrol eject -n cd -u 1 -v
766 Eject the CD from cd1, and print SCSI sense information if the command
769 .Dl camcontrol tur da0
771 Send the SCSI test unit ready command to da0.
774 utility will report whether the disk is ready, but will not display sense
775 information if the command fails since the
777 switch was not specified.
778 .Bd -literal -offset indent
779 camcontrol tur da1 -E -C 4 -t 50 -v
782 Send a test unit ready command to da1. Enable kernel error recovery.
783 Specify a retry count of 4, and a timeout of 50 seconds. Enable sense
786 flag) if the command fails. Since error recovery is turned on, the
787 disk will be spun up if it is not currently spinning.
790 utility will report whether the disk is ready.
791 .Bd -literal -offset indent
792 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
793 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
796 Issue a READ BUFFER command (0x3C) to cd1. Display the buffer size of cd1,
797 and display the first 10 bytes from the cache on cd1. Display SCSI sense
798 information if the command fails.
799 .Bd -literal -offset indent
800 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
801 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
804 Issue a WRITE BUFFER (0x3B) command to cd1. Write out 10 bytes of data,
805 not including the (reserved) 4 byte header. Print out sense information if
806 the command fails. Be very careful with this command, improper use may
807 cause data corruption.
808 .Bd -literal -offset indent
809 camcontrol modepage da3 -m 1 -e -P 3
812 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
813 settings on the drive. Mode page 1 contains a disk drive's auto read and
814 write reallocation settings, among other things.
816 .Dl camcontrol rescan all
818 Rescan all SCSI busses in the system for devices that have been added,
821 .Dl camcontrol rescan 0
823 Rescan SCSI bus 0 for devices that have been added, removed or changed.
825 .Dl camcontrol rescan 0:1:0
827 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
830 .Dl camcontrol tags da5 -N 24
832 Set the number of concurrent transactions for da5 to 24.
833 .Bd -literal -offset indent
834 camcontrol negotiate -n da -u 4 -T disable
837 Disable tagged queueing for da4.
838 .Bd -literal -offset indent
839 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
842 Negotiate a sync rate of 20MHz and an offset of 15 with da3. Then send a
843 Test Unit Ready command to make the settings take effect.
853 utility first appeared in
856 The mode page editing code and arbitrary SCSI command code are based upon
861 library, written by Julian Elischer and Peter Dufault. The
863 program first appeared in
865 and first appeared in
870 .An Kenneth Merry Aq Mt ken@FreeBSD.org
872 The code that parses the generic command line arguments doesn't know that
873 some of the subcommands take multiple arguments. So if, for instance, you
874 tried something like this:
875 .Bd -literal -offset indent
876 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
879 The sense information from the test unit ready command would not get
880 printed out, since the first
884 bails out when it sees the second argument to
887 above. Fixing this behavior would take some gross code, or changes to the
889 interface. The best way to circumvent this problem is to always make sure
892 arguments before any command-specific arguments.
projects / dragonfly.git / blob