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
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.8 2007/12/02 04:44:03 pavalos Exp $
31 .Dd September 14, 1998
36 .Nd CAM control program
50 .Op Fl u Ar unit_number
68 .Op Fl r Ar reporttype
87 .Aq all | bus Ns Op :target:lun
90 .Aq all | bus Ns Op :target:lun
110 .Aq Fl c Ar cmd Op args
111 .Op Fl i Ar len Ar fmt
113 .Op Fl o Ar len Ar fmt Op args
123 .Aq all|off|bus Ns Op :target Ns Op :lun
136 .Op Fl D Ar enable|disable
140 .Op Fl T Ar enable|disable
142 .Op Fl W Ar bus_width
157 utility is designed to provide a way for users to access and control the
164 can cause a loss of data and/or system crashes if used improperly. Even
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
171 device identifier. A device identifier can take one of three forms:
174 Specify a device name and unit number combination, like "da5" or "cd3".
175 Note that character device node names (e.g. /dev/da0) are
179 Specify a bus number and target id. The bus number can be determined from
181 .Dq camcontrol devlist .
182 The lun defaults to 0.
184 Specify the bus, target and lun for a device. (e.g. 1:2:0)
187 The device identifier, if it is specified,
189 come immediately after the function name, and before any generic or
190 function-specific arguments. Note that the
194 arguments described below will override any device name or unit number
195 specified beforehand. The
201 override a specified bus:target or bus:target:lun, however.
205 primary functions support these generic arguments:
208 SCSI command retry count. In order for this to work, error recovery
212 Instruct the kernel to perform generic SCSI error recovery for the given
213 command. This is needed in order for the retry count
215 to be honored. Other than retrying commands, the generic error recovery in
216 the code will generally attempt to spin up drives that are not spinning.
217 It may take some other actions, depending upon the sense code returned from
220 Specify the device type to operate on, e.g. "da", "cd".
222 SCSI command timeout in seconds. This overrides the default timeout for
224 .It Fl u Ar unit_number
225 Specify the device unit number, e.g. "1", "5".
227 Be verbose, print out sense information for failed SCSI commands.
230 Primary command functions:
231 .Bl -tag -width periphlist
233 List all physical devices (logical units) attached to the CAM subsystem.
234 This also includes a list of peripheral drivers attached to each device.
237 argument, SCSI bus number, adapter name and unit numbers are printed as
240 List all peripheral drivers attached to a given physical device (logical
243 Send the SCSI test unit ready (0x00) command to the given device.
246 utility will report whether the device is ready or not.
248 Send a SCSI inquiry command (0x12) to a device. By default,
250 will print out the standard inquiry data, device serial number, and
251 transfer rate information. The user can specify that only certain types of
252 inquiry data be printed:
255 Get the standard inquiry data.
257 Print out the serial number. If this flag is the only one specified,
259 will not print out "Serial Number" before the value returned by the drive.
260 This is to aid in script writing.
262 Print out transfer rate information.
265 Send the SCSI REPORT LUNS (0xA0) command to the given device.
268 will print out the list of logical units (LUNs) supported by the target device.
269 There are a couple of options to modify the output:
270 .Bl -tag -width 01234567890123
272 Just print out a count of LUNs, not the actual LUN numbers.
274 Just print out the LUNs, and don't print out the count.
275 .It Fl r Ar reporttype
276 Specify the type of report to request from the target:
277 .Bl -tag -width 012345678
279 Return the default report.
283 Most targets will support this report if they support the REPORT LUNS
286 Return only well known LUNs.
288 Return all available LUNs.
293 will try to print out LUN numbers in a reasonable format.
294 It can understand the peripheral, flat, LUN and extended LUN formats.
296 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
299 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
302 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
303 start bit set and the load/eject bit set.
305 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
306 start bit cleared and the load/eject bit set.
308 Tell the kernel to scan all busses in the system (with the
310 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
311 (XPT_SCAN_LUN) for new devices or devices that have gone away. The user
312 may specify a scan of all busses, a single bus, or a lun. Scanning all luns
313 on a target isn't supported.
315 Tell the kernel to reset all busses in the system (with the
317 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
318 reset for that bus, or to reset the given bus:target:lun
319 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
320 connecting to that device.
321 Note that this can have a destructive impact
324 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
325 print out any combination of: the total number of defects, the primary
326 defect list (PLIST), and the grown defect list (GLIST).
329 The three format options are:
331 to print out the list as logical blocks,
333 to print out the list in bytes from index format, and
335 to print out the list in physical sector format. The format argument is
336 required. Most drives support the physical sector format. Some drives
337 support the logical block format. Many drives, if they don't support the
338 requested format, return the data in an alternate format, along with sense
339 information indicating that the requested data format isn't supported.
343 attempts to detect this, and print out whatever format the drive returns.
344 If the drive uses a non-standard sense code to report that it doesn't
345 support the requested format,
347 will probably see the error as a failure to complete the request.
349 Print out the grown defect list. This is a list of bad blocks that have
350 been remapped since the disk left the factory.
352 Print out the primary defect list.
361 will print out the number of defects given in the READ DEFECT DATA header
362 returned from the drive.
364 Allows the user to display and optionally edit a SCSI mode page. The mode
365 page formats are located in
366 .Pa /usr/share/misc/scsi_modes .
367 This can be overridden by specifying a different file in the
369 environment variable.
372 command takes several arguments:
375 Disable block descriptors for mode sense.
377 This flag allows the user to edit values in the mode page.
378 .It Fl m Ar mode_page
379 This specifies the number of the mode page the user would like to view
380 and/or edit. This argument is mandatory.
382 This allows the user to specify the page control field. Possible values are:
383 .Bl -tag -width xxx -compact
395 Allows the user to send an arbitrary SCSI CDB to any device.
398 function requires the
400 argument to specify the CDB. Other arguments are optional, depending on
401 the command type. The command and data specification syntax is documented
404 NOTE: If the CDB specified causes data to be transferred to or from the
405 SCSI device in question, you MUST specify either
410 .It Fl c Ar cmd Op args
411 This specifies the SCSI CDB. CDBs may be 6, 10, 12 or 16 bytes.
412 .It Fl i Ar len Ar fmt
413 This specifies the amount of data to read, and how it should be displayed.
417 bytes of data will be read from the device and written to standard output.
418 .It Fl o Ar len Ar fmt Op args
419 This specifies the amount of data to be written to a device, and the data
420 that is to be written. If the format is
423 bytes of data will be read from standard input and written to the device.
426 Turn on CAM debugging printfs in the kernel. This requires
428 in your kernel config file. WARNING: enabling debugging printfs currently
429 causes an EXTREME number of kernel printfs. You may have difficulty
430 turning off the debugging printfs once they start, since the kernel will be
431 busy printing messages and unable to service other requests quickly.
434 function takes a number of arguments:
437 Enable CAM_DEBUG_INFO printfs.
439 Enable CAM_DEBUG_PERIPH printfs.
441 Enable CAM_DEBUG_TRACE printfs.
443 Enable CAM_DEBUG_SUBTRACE printfs.
445 Enable CAM_DEBUG_XPT printfs.
447 Enable CAM_DEBUG_CDB printfs. This will cause the kernel to print out the
448 SCSI CDBs sent to the specified device(s).
450 Enable debugging for all devices.
452 Turn off debugging for all devices
453 .It bus Ns Op :target Ns Op :lun
454 Turn on debugging for the given bus, target or lun. If the lun or target
455 and lun are not specified, they are wildcarded. (i.e., just specifying a
456 bus turns on debugging printfs for all devices on that bus.)
459 Show or set the number of "tagged openings" or simultaneous transactions
460 we attempt to queue to a particular device. By default, the
462 command, with no command-specific arguments (i.e. only generic arguments)
463 prints out the "soft" maximum number of transactions that can be queued to
464 the device in question. For more detailed information, use the
466 argument described below.
469 Set the number of tags for the given device. This must be between the
470 minimum and maximum number set in the kernel quirk table. The default for
471 most devices that support tagged queueing is a minimum of 2 and a maximum
472 of 255. The minimum and maximum values for a given device may be
473 determined by using the
475 switch. The meaning of the
479 subcommand is described below.
481 Be quiet, and don't report the number of tags. This is generally used when
482 setting the number of tags.
484 The verbose flag has special functionality for the
488 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
491 This is the amount of capacity for transactions queued to a given device.
493 This is the number of transactions currently queued to a device.
495 This is the kernel queue space for transactions. This count usually mirrors
496 dev_openings except during error recovery operations when
497 the device queue is frozen (device is not allowed to receive
498 commands), the number of dev_openings is reduced, or transaction
501 This is the number of transactions waiting in the kernel queue for capacity
502 on the device. This number is usually zero unless error recovery is in
505 The held count is the number of CCBs held by peripheral drivers that have
506 either just been completed or are about to be released to the transport
507 layer for service by a device. Held CCBs reserve capacity on a given
510 This is the current "hard" minimum number of transactions that can be
511 queued to a device at once. The
513 value above cannot go below this number. The default value for
515 is 2, although it may be set higher or lower for various devices.
517 This is the "hard" maximum number of transactions that can be queued to a
518 device at one time. The
520 value cannot go above this number. The default value for
522 is 255, although it may be set higher or lower for various devices.
526 Show or negotiate various communication parameters. Some controllers may
527 not support setting or changing some of these values. For instance, the
528 Adaptec 174x controllers do not support changing a device's sync rate or
533 will not attempt to set the parameter if the controller indicates that it
534 does not support setting the parameter. To find out what the controller
537 flag. The meaning of the
541 command is described below. Also, some controller drivers don't support
542 setting negotiation parameters, even if the underlying controller supports
543 negotiation changes. Some controllers, such as the Advansys wide
544 controllers, support enabling and disabling synchronous negotiation for
545 a device, but do not support setting the synchronous negotiation rate.
548 Attempt to make the negotiation settings take effect immediately by sending
549 a Test Unit Ready command to the device.
551 Show or set current negotiation settings. This is the default.
552 .It Fl D Ar enable|disable
553 Enable or disable disconnection.
555 Set the command delay offset.
557 Be quiet, don't print anything. This is generally useful when you want to
558 set a parameter, but don't want any status information.
560 Change the synchronization rate for a device. The sync rate is a floating
561 point value specified in MHz. So, for instance,
563 is a legal value, as is
565 .It Fl T Ar enable|disable
566 Enable or disable tagged queueing for a device.
568 Show or set user negotiation settings. The default is to show or set
569 current negotiation settings.
571 The verbose switch has special meaning for the
573 subcommand. It causes
575 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
577 .It Fl W Ar bus_width
578 Specify the bus width to negotiate with a device. The bus width is
579 specified in bits. The only useful values to specify are 8, 16, and 32
580 bits. The controller must support the bus width in question in order for
581 the setting to take effect.
584 In general, sync rate and offset settings will not take effect for a
585 device until a command has been sent to the device. The
587 switch above will automatically send a Test Unit Ready to the device so
588 negotiation parameters will take effect.
592 FORMAT UNIT command to the named device.
594 .Em WARNING! WARNING! WARNING!
596 Low level formatting a disk will destroy ALL data on the disk. Use
597 extreme caution when issuing this command. Many users low-level format
598 disks that do not really need to be low-level formatted. There are
599 relatively few scenarios that call for low-level formatting a disk.
601 low-level formatting a disk is to initialize the disk after changing
602 its physical sector size. Another reason for low-level formatting a disk
603 is to revive the disk if you are getting "medium format corrupted" errors
604 from the disk in response to read and write requests.
606 Some disks take longer than others to format. Users should specify a
607 timeout long enough to allow the format to complete. The default format
608 timeout is 3 hours, which should be long enough for most disks. Some hard
609 disks will complete a format operation in a very short period of time
610 (on the order of 5 minutes or less). This is often because the drive
611 doesn't really support the FORMAT UNIT command -- it just accepts the
612 command, waits a few minutes and then returns it.
616 subcommand takes several arguments that modify its default behavior. The
620 arguments can be useful for scripts.
624 Be quiet, don't print any status messages. This option will not disable
625 the questions, however. To disable questions, use the
632 This will report status on a format that is already running on the drive.
634 Issue a non-immediate format command. By default,
636 issues the FORMAT UNIT command with the immediate bit set. This tells the
637 device to immediately return the format command, before the format has
638 actually completed. Then,
642 sense information from the device every second to determine how far along
643 in the format process it is. If the
645 argument is specified,
647 will issue a non-immediate format command, and will be unable to print any
648 information to let the user know what percentage of the disk has been
651 Don't ask any questions. By default,
653 will ask the user if he/she really wants to format the disk in question,
654 and also if the default format command timeout is acceptable. The user
655 will not be asked about the timeout if a timeout is specified on the
659 Print out verbose usage information.
664 variable allows the user to specify an alternate mode page format file.
668 variable determines which text editor
670 starts when editing mode pages.
672 .Bl -tag -width /usr/share/misc/scsi_modes -compact
673 .It Pa /usr/share/misc/scsi_modes
674 is the SCSI mode format database.
676 is the transport layer device.
678 are the CAM application passthrough devices.
681 .Dl camcontrol eject -n cd -u 1 -v
683 Eject the CD from cd1, and print SCSI sense information if the command
686 .Dl camcontrol tur da0
688 Send the SCSI test unit ready command to da0.
691 utility will report whether the disk is ready, but will not display sense
692 information if the command fails since the
694 switch was not specified.
696 .Bd -literal -offset indent
697 camcontrol tur da1 -E -C 4 -t 50 -v
700 Send a test unit ready command to da1. Enable kernel error recovery.
701 Specify a retry count of 4, and a timeout of 50 seconds. Enable sense
704 flag) if the command fails. Since error recovery is turned on, the
705 disk will be spun up if it is not currently spinning.
708 utility will report whether the disk is ready.
709 .Bd -literal -offset indent
710 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
711 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
714 Issue a READ BUFFER command (0x3C) to cd1. Display the buffer size of cd1,
715 and display the first 10 bytes from the cache on cd1. Display SCSI sense
716 information if the command fails.
718 .Bd -literal -offset indent
719 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
720 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
723 Issue a WRITE BUFFER (0x3B) command to cd1. Write out 10 bytes of data,
724 not including the (reserved) 4 byte header. Print out sense information if
725 the command fails. Be very careful with this command, improper use may
726 cause data corruption.
728 .Bd -literal -offset indent
729 camcontrol modepage da3 -m 1 -e -P 3
732 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
733 settings on the drive. Mode page 1 contains a disk drive's auto read and
734 write reallocation settings, among other things.
736 .Dl camcontrol rescan all
738 Rescan all SCSI busses in the system for devices that have been added,
741 .Dl camcontrol rescan 0
743 Rescan SCSI bus 0 for devices that have been added, removed or changed.
745 .Dl camcontrol rescan 0:1:0
747 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
750 .Dl camcontrol tags da5 -N 24
752 Set the number of concurrent transactions for da5 to 24.
754 .Bd -literal -offset indent
755 camcontrol negotiate -n da -u 4 -T disable
758 Disable tagged queueing for da4.
760 .Bd -literal -offset indent
761 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
764 Negotiate a sync rate of 20MHz and an offset of 15 with da3. Then send a
765 Test Unit Ready command to make the settings take effect.
775 utility first appeared in
778 The mode page editing code and arbitrary SCSI command code are based upon
783 library, written by Julian Elischer and Peter Dufault. The
785 program first appeared in
787 and first appeared in
792 .An Kenneth Merry Aq ken@FreeBSD.org
794 The code that parses the generic command line arguments doesn't know that
795 some of the subcommands take multiple arguments. So if, for instance, you
796 tried something like this:
797 .Bd -literal -offset indent
798 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
801 The sense information from the test unit ready command would not get
802 printed out, since the first
806 bails out when it sees the second argument to
809 above. Fixing this behavior would take some gross code, or changes to the
811 interface. The best way to circumvent this problem is to always make sure
814 arguments before any command-specific arguments.
lentferj's projects / dragonfly.git / blob