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 c Ar cmd Op args
124 .Op Fl i Ar len Ar fmt
126 .Op Fl o Ar len Ar fmt Op args
136 .Aq all|off|bus Ns Op :target Ns Op :lun
149 .Op Fl D Ar enable|disable
153 .Op Fl T Ar enable|disable
155 .Op Fl W Ar bus_width
170 utility is designed to provide a way for users to access and control the
177 can cause a loss of data and/or system crashes if used improperly.
179 expert users are encouraged to exercise caution when using this command.
180 Novice users should stay away from this utility.
184 utility has a number of primary functions, many of which support an optional
186 A device identifier can take one of three forms:
189 Specify a device name and unit number combination, like "da5" or "cd3".
190 Note that character device node names (e.g.\& /dev/da0) are
194 Specify a bus number and target id.
195 The bus number can be determined from
197 .Dq camcontrol devlist .
198 The lun defaults to 0.
200 Specify the bus, target and lun for a device.
204 The device identifier, if it is specified,
206 come immediately after the function name, and before any generic or
207 function-specific arguments.
212 arguments described below will override any device name or unit number
213 specified beforehand.
220 override a specified bus:target or bus:target:lun, however.
224 primary functions support these generic arguments:
227 SCSI command retry count.
228 In order for this to work, error recovery
232 Instruct the kernel to perform generic SCSI error recovery for the given
234 This is needed in order for the retry count
237 Other than retrying commands, the generic error recovery in
238 the code will generally attempt to spin up drives that are not spinning.
239 It may take some other actions, depending upon the sense code returned from
242 Specify the device type to operate on, e.g.\& "da", "cd".
244 SCSI command timeout in seconds.
245 This overrides the default timeout for
247 .It Fl u Ar unit_number
248 Specify the device unit number, e.g.\& "1", "5".
250 Be verbose, print out sense information for failed SCSI commands.
253 Primary command functions:
254 .Bl -tag -width periphlist
256 List all physical devices (logical units) attached to the CAM subsystem.
257 This also includes a list of peripheral drivers attached to each device.
260 argument, SCSI bus number, adapter name and unit numbers are printed as
263 List all peripheral drivers attached to a given physical device (logical
266 Send the SCSI test unit ready (0x00) command to the given device.
269 utility will report whether the device is ready or not.
271 Send a SCSI inquiry command (0x12) to a device.
274 will print out the standard inquiry data, device serial number, and
275 transfer rate information.
276 The user can specify that only certain types of
277 inquiry data be printed:
280 Get the standard inquiry data.
282 Print out the serial number.
283 If this flag is the only one specified,
285 will not print out "Serial Number" before the value returned by the drive.
286 This is to aid in script writing.
288 Print out transfer rate information.
291 Send a ATA identify command (0xec) to a device.
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:
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.
381 may specify a scan of all busses, a single bus, or a lun.
383 on a target is not supported.
385 Tell the kernel to reset all busses in the system (with the
387 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
388 reset for that bus, or to reset the given bus:target:lun
389 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
390 connecting to that device.
391 Note that this can have a destructive impact
394 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
395 print out any combination of: the total number of defects, the primary
396 defect list (PLIST), and the grown defect list (GLIST).
399 The three format options are:
401 to print out the list as logical blocks,
403 to print out the list in bytes from index format, and
405 to print out the list in physical sector format.
406 The format argument is
408 Most drives support the physical sector format.
410 support the logical block format.
411 Many drives, if they do not support the
412 requested format, return the data in an alternate format, along with sense
413 information indicating that the requested data format is not supported.
417 attempts to detect this, and print out whatever format the drive returns.
418 If the drive uses a non-standard sense code to report that it does not
419 support the requested format,
421 will probably see the error as a failure to complete the request.
423 Print out the grown defect list.
424 This is a list of bad blocks that have
425 been remapped since the disk left the factory.
427 Print out the primary defect list.
436 will print out the number of defects given in the READ DEFECT DATA header
437 returned from the drive.
439 Allows the user to display and optionally edit a SCSI mode page.
441 page formats are located in
442 .Pa /usr/share/misc/scsi_modes .
443 This can be overridden by specifying a different file in the
445 environment variable.
448 command takes several arguments:
451 Disable block descriptors for mode sense.
453 Displays mode page data in binary format.
455 This flag allows the user to edit values in the mode page.
457 either edit mode page values with the text editor pointed to by his
459 environment variable, or supply mode page values via standard input, using
462 uses to display mode page values.
463 The editor will be invoked if
465 detects that standard input is terminal.
467 Lists all available mode pages.
468 .It Fl m Ar mode_page
469 This specifies the number of the mode page the user would like to view
471 This argument is mandatory unless
475 This allows the user to specify the page control field.
477 .Bl -tag -width xxx -compact
489 Allows the user to send an arbitrary SCSI CDB to any device.
492 function requires the
494 argument to specify the CDB.
495 Other arguments are optional, depending on
497 The command and data specification syntax is documented
500 NOTE: If the CDB specified causes data to be transfered to or from the
501 SCSI device in question, you MUST specify either
506 .It Fl c Ar cmd Op args
507 This specifies the SCSI CDB.
508 CDBs may be 6, 10, 12 or 16 bytes.
509 .It Fl i Ar len Ar fmt
510 This specifies the amount of data to read, and how it should be displayed.
514 bytes of data will be read from the device and written to standard output.
515 .It Fl o Ar len Ar fmt Op args
516 This specifies the amount of data to be written to a device, and the data
517 that is to be written.
521 bytes of data will be read from standard input and written to the device.
524 Turn on CAM debugging printfs in the kernel.
525 This requires options CAMDEBUG
526 in your kernel config file.
527 WARNING: enabling debugging printfs currently
528 causes an EXTREME number of kernel printfs.
529 You may have difficulty
530 turning off the debugging printfs once they start, since the kernel will be
531 busy printing messages and unable to service other requests quickly.
534 function takes a number of arguments:
537 Enable CAM_DEBUG_INFO printfs.
539 Enable CAM_DEBUG_PERIPH printfs.
541 Enable CAM_DEBUG_TRACE printfs.
543 Enable CAM_DEBUG_SUBTRACE printfs.
545 Enable CAM_DEBUG_XPT printfs.
547 Enable CAM_DEBUG_CDB printfs.
548 This will cause the kernel to print out the
549 SCSI CDBs sent to the specified device(s).
551 Enable debugging for all devices.
553 Turn off debugging for all devices
554 .It bus Ns Op :target Ns Op :lun
555 Turn on debugging for the given bus, target or lun.
557 and lun are not specified, they are wildcarded.
558 (i.e., just specifying a
559 bus turns on debugging printfs for all devices on that bus.)
562 Show or set the number of "tagged openings" or simultaneous transactions
563 we attempt to queue to a particular device.
566 command, with no command-specific arguments (i.e., only generic arguments)
567 prints out the "soft" maximum number of transactions that can be queued to
568 the device in question.
569 For more detailed information, use the
571 argument described below.
574 Set the number of tags for the given device.
575 This must be between the
576 minimum and maximum number set in the kernel quirk table.
578 most devices that support tagged queueing is a minimum of 2 and a maximum
580 The minimum and maximum values for a given device may be
581 determined by using the
588 subcommand is described below.
590 Be quiet, and do not report the number of tags.
591 This is generally used when
592 setting the number of tags.
594 The verbose flag has special functionality for the
599 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
602 This is the amount of capacity for transactions queued to a given device.
604 This is the number of transactions currently queued to a device.
606 This is the kernel queue space for transactions.
607 This count usually mirrors
608 dev_openings except during error recovery operations when
609 the device queue is frozen (device is not allowed to receive
610 commands), the number of dev_openings is reduced, or transaction
613 This is the number of transactions waiting in the kernel queue for capacity
615 This number is usually zero unless error recovery is in
618 The held count is the number of CCBs held by peripheral drivers that have
619 either just been completed or are about to be released to the transport
620 layer for service by a device.
621 Held CCBs reserve capacity on a given
624 This is the current "hard" minimum number of transactions that can be
625 queued to a device at once.
628 value above cannot go below this number.
629 The default value for
631 is 2, although it may be set higher or lower for various devices.
633 This is the "hard" maximum number of transactions that can be queued to a
637 value cannot go above this number.
638 The default value for
640 is 255, although it may be set higher or lower for various devices.
644 Show or negotiate various communication parameters.
646 not support setting or changing some of these values.
648 Adaptec 174x controllers do not support changing a device's sync rate or
653 will not attempt to set the parameter if the controller indicates that it
654 does not support setting the parameter.
655 To find out what the controller
663 command is described below.
664 Also, some controller drivers do not support
665 setting negotiation parameters, even if the underlying controller supports
667 Some controllers, such as the Advansys wide
668 controllers, support enabling and disabling synchronous negotiation for
669 a device, but do not support setting the synchronous negotiation rate.
672 Attempt to make the negotiation settings take effect immediately by sending
673 a Test Unit Ready command to the device.
675 Show or set current negotiation settings.
677 .It Fl D Ar enable|disable
678 Enable or disable disconnection.
680 Set the command delay offset.
682 Be quiet, do not print anything.
683 This is generally useful when you want to
684 set a parameter, but do not want any status information.
686 Change the synchronization rate for a device.
687 The sync rate is a floating
688 point value specified in MHz.
691 is a legal value, as is
693 .It Fl T Ar enable|disable
694 Enable or disable tagged queueing for a device.
696 Show or set user negotiation settings.
697 The default is to show or set
698 current negotiation settings.
700 The verbose switch has special meaning for the
705 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
707 .It Fl W Ar bus_width
708 Specify the bus width to negotiate with a device.
711 The only useful values to specify are 8, 16, and 32
713 The controller must support the bus width in question in order for
714 the setting to take effect.
717 In general, sync rate and offset settings will not take effect for a
718 device until a command has been sent to the device.
721 switch above will automatically send a Test Unit Ready to the device so
722 negotiation parameters will take effect.
726 FORMAT UNIT command to the named device.
728 .Em WARNING! WARNING! WARNING!
730 Low level formatting a disk will destroy ALL data on the disk.
732 extreme caution when issuing this command.
733 Many users low-level format
734 disks that do not really need to be low-level formatted.
736 relatively few scenarios that call for low-level formatting a disk.
738 low-level formatting a disk is to initialize the disk after changing
739 its physical sector size.
740 Another reason for low-level formatting a disk
741 is to revive the disk if you are getting "medium format corrupted" errors
742 from the disk in response to read and write requests.
744 Some disks take longer than others to format.
745 Users should specify a
746 timeout long enough to allow the format to complete.
748 timeout is 3 hours, which should be long enough for most disks.
750 disks will complete a format operation in a very short period of time
751 (on the order of 5 minutes or less).
752 This is often because the drive
753 does not really support the FORMAT UNIT command -- it just accepts the
754 command, waits a few minutes and then returns it.
758 subcommand takes several arguments that modify its default behavior.
763 arguments can be useful for scripts.
767 Be quiet, do not print any status messages.
768 This option will not disable
769 the questions, however.
770 To disable questions, use the
777 This will report status on a format that is already running on the drive.
779 Issue a non-immediate format command.
782 issues the FORMAT UNIT command with the immediate bit set.
784 device to immediately return the format command, before the format has
790 sense information from the device every second to determine how far along
791 in the format process it is.
794 argument is specified,
796 will issue a non-immediate format command, and will be unable to print any
797 information to let the user know what percentage of the disk has been
800 Do not ask any questions.
803 will ask the user if he/she really wants to format the disk in question,
804 and also if the default format command timeout is acceptable.
806 will not be asked about the timeout if a timeout is specified on the
810 Print out verbose usage information.
815 variable allows the user to specify an alternate mode page format file.
819 variable determines which text editor
821 starts when editing mode pages.
823 .Bl -tag -width /usr/share/misc/scsi_modes -compact
824 .It Pa /usr/share/misc/scsi_modes
825 is the SCSI mode format database.
827 is the transport layer device.
829 are the CAM application passthrough devices.
832 .Dl camcontrol eject -n cd -u 1 -v
834 Eject the CD from cd1, and print SCSI sense information if the command
837 .Dl camcontrol tur da0
839 Send the SCSI test unit ready command to da0.
842 utility will report whether the disk is ready, but will not display sense
843 information if the command fails since the
845 switch was not specified.
847 .Bd -literal -offset indent
848 camcontrol tur da1 -E -C 4 -t 50 -v
851 Send a test unit ready command to da1.
852 Enable kernel error recovery.
853 Specify a retry count of 4, and a timeout of 50 seconds.
857 flag) if the command fails.
858 Since error recovery is turned on, the
859 disk will be spun up if it is not currently spinning.
862 utility will report whether the disk is ready.
863 .Bd -literal -offset indent
864 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
865 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
868 Issue a READ BUFFER command (0x3C) to cd1.
869 Display the buffer size of cd1,
870 and display the first 10 bytes from the cache on cd1.
872 information if the command fails.
874 .Bd -literal -offset indent
875 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
876 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
879 Issue a WRITE BUFFER (0x3B) command to cd1.
880 Write out 10 bytes of data,
881 not including the (reserved) 4 byte header.
882 Print out sense information if
884 Be very careful with this command, improper use may
885 cause data corruption.
887 .Bd -literal -offset indent
888 camcontrol modepage da3 -m 1 -e -P 3
891 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
892 settings on the drive.
893 Mode page 1 contains a disk drive's auto read and
894 write reallocation settings, among other things.
896 .Dl camcontrol rescan all
898 Rescan all SCSI busses in the system for devices that have been added,
901 .Dl camcontrol rescan 0
903 Rescan SCSI bus 0 for devices that have been added, removed or changed.
905 .Dl camcontrol rescan 0:1:0
907 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
910 .Dl camcontrol tags da5 -N 24
912 Set the number of concurrent transactions for da5 to 24.
914 .Bd -literal -offset indent
915 camcontrol negotiate -n da -u 4 -T disable
918 Disable tagged queueing for da4.
920 .Bd -literal -offset indent
921 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
924 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
926 Test Unit Ready command to make the settings take effect.
936 utility first appeared in
939 The mode page editing code and arbitrary SCSI command code are based upon
944 library, written by Julian Elischer and Peter Dufault.
947 program first appeared in
949 and first appeared in
954 .An Kenneth Merry Aq ken@FreeBSD.org
956 The code that parses the generic command line arguments does not know that
957 some of the subcommands take multiple arguments.
958 So if, for instance, you
959 tried something like this:
960 .Bd -literal -offset indent
961 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
964 The sense information from the test unit ready command would not get
965 printed out, since the first
969 bails out when it sees the second argument to
973 Fixing this behavior would take some gross code, or changes to the
976 The best way to circumvent this problem is to always make sure
979 arguments before any command-specific arguments.
projects / FreeBSD / stable / 8.git / blob