2 .\" Copyright (c) 1998, 1999, 2000, 2002, 2005 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.7 2007/11/29 01:57:29 pavalos Exp $
31 .Dd September 14, 1998
36 .Nd CAM control program
50 .Op Fl u Ar unit_number
80 .Aq all | bus Ns Op :target:lun
83 .Aq all | bus Ns Op :target:lun
103 .Aq Fl c Ar cmd Op args
104 .Op Fl i Ar len Ar fmt
106 .Op Fl o Ar len Ar fmt Op args
116 .Aq all|off|bus Ns Op :target Ns Op :lun
129 .Op Fl D Ar enable|disable
133 .Op Fl T Ar enable|disable
135 .Op Fl W Ar bus_width
150 utility is designed to provide a way for users to access and control the
157 can cause a loss of data and/or system crashes if used improperly. Even
158 expert users are encouraged to exercise caution when using this command.
159 Novice users should stay away from this utility.
163 utility has a number of primary functions, many of which support an optional
164 device identifier. A device identifier can take one of three forms:
167 Specify a device name and unit number combination, like "da5" or "cd3".
168 Note that character device node names (e.g. /dev/da0) are
172 Specify a bus number and target id. The bus number can be determined from
174 .Dq camcontrol devlist .
175 The lun defaults to 0.
177 Specify the bus, target and lun for a device. (e.g. 1:2:0)
180 The device identifier, if it is specified,
182 come immediately after the function name, and before any generic or
183 function-specific arguments. Note that the
187 arguments described below will override any device name or unit number
188 specified beforehand. The
194 override a specified bus:target or bus:target:lun, however.
198 primary functions support these generic arguments:
201 SCSI command retry count. In order for this to work, error recovery
205 Instruct the kernel to perform generic SCSI error recovery for the given
206 command. This is needed in order for the retry count
208 to be honored. Other than retrying commands, the generic error recovery in
209 the code will generally attempt to spin up drives that are not spinning.
210 It may take some other actions, depending upon the sense code returned from
213 Specify the device type to operate on, e.g. "da", "cd".
215 SCSI command timeout in seconds. This overrides the default timeout for
217 .It Fl u Ar unit_number
218 Specify the device unit number, e.g. "1", "5".
220 Be verbose, print out sense information for failed SCSI commands.
223 Primary command functions:
224 .Bl -tag -width periphlist
226 List all physical devices (logical units) attached to the CAM subsystem.
227 This also includes a list of peripheral drivers attached to each device.
230 argument, SCSI bus number, adapter name and unit numbers are printed as
233 List all peripheral drivers attached to a given physical device (logical
236 Send the SCSI test unit ready (0x00) command to the given device.
239 utility will report whether the device is ready or not.
241 Send a SCSI inquiry command (0x12) to a device. By default,
243 will print out the standard inquiry data, device serial number, and
244 transfer rate information. The user can specify that only certain types of
245 inquiry data be printed:
248 Get the standard inquiry data.
250 Print out the serial number. If this flag is the only one specified,
252 will not print out "Serial Number" before the value returned by the drive.
253 This is to aid in script writing.
255 Print out transfer rate information.
258 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
261 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
264 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
265 start bit set and the load/eject bit set.
267 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
268 start bit cleared and the load/eject bit set.
270 Tell the kernel to scan all busses in the system (with the
272 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
273 (XPT_SCAN_LUN) for new devices or devices that have gone away. The user
274 may specify a scan of all busses, a single bus, or a lun. Scanning all luns
275 on a target isn't supported.
277 Tell the kernel to reset all busses in the system (with the
279 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
280 reset for that bus, or to reset the given bus:target:lun
281 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
282 connecting to that device.
283 Note that this can have a destructive impact
286 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
287 print out any combination of: the total number of defects, the primary
288 defect list (PLIST), and the grown defect list (GLIST).
291 The three format options are:
293 to print out the list as logical blocks,
295 to print out the list in bytes from index format, and
297 to print out the list in physical sector format. The format argument is
298 required. Most drives support the physical sector format. Some drives
299 support the logical block format. Many drives, if they don't support the
300 requested format, return the data in an alternate format, along with sense
301 information indicating that the requested data format isn't supported.
305 attempts to detect this, and print out whatever format the drive returns.
306 If the drive uses a non-standard sense code to report that it doesn't
307 support the requested format,
309 will probably see the error as a failure to complete the request.
311 Print out the grown defect list. This is a list of bad blocks that have
312 been remapped since the disk left the factory.
314 Print out the primary defect list.
323 will print out the number of defects given in the READ DEFECT DATA header
324 returned from the drive.
326 Allows the user to display and optionally edit a SCSI mode page. The mode
327 page formats are located in
328 .Pa /usr/share/misc/scsi_modes .
329 This can be overridden by specifying a different file in the
331 environment variable.
334 command takes several arguments:
337 Disable block descriptors for mode sense.
339 This flag allows the user to edit values in the mode page.
340 .It Fl m Ar mode_page
341 This specifies the number of the mode page the user would like to view
342 and/or edit. This argument is mandatory.
344 This allows the user to specify the page control field. Possible values are:
345 .Bl -tag -width xxx -compact
357 Allows the user to send an arbitrary SCSI CDB to any device.
360 function requires the
362 argument to specify the CDB. Other arguments are optional, depending on
363 the command type. The command and data specification syntax is documented
366 NOTE: If the CDB specified causes data to be transferred to or from the
367 SCSI device in question, you MUST specify either
372 .It Fl c Ar cmd Op args
373 This specifies the SCSI CDB. CDBs may be 6, 10, 12 or 16 bytes.
374 .It Fl i Ar len Ar fmt
375 This specifies the amount of data to read, and how it should be displayed.
379 bytes of data will be read from the device and written to standard output.
380 .It Fl o Ar len Ar fmt Op args
381 This specifies the amount of data to be written to a device, and the data
382 that is to be written. If the format is
385 bytes of data will be read from standard input and written to the device.
388 Turn on CAM debugging printfs in the kernel. This requires
390 in your kernel config file. WARNING: enabling debugging printfs currently
391 causes an EXTREME number of kernel printfs. You may have difficulty
392 turning off the debugging printfs once they start, since the kernel will be
393 busy printing messages and unable to service other requests quickly.
396 function takes a number of arguments:
399 Enable CAM_DEBUG_INFO printfs.
401 Enable CAM_DEBUG_PERIPH printfs.
403 Enable CAM_DEBUG_TRACE printfs.
405 Enable CAM_DEBUG_SUBTRACE printfs.
407 Enable CAM_DEBUG_XPT printfs.
409 Enable CAM_DEBUG_CDB printfs. This will cause the kernel to print out the
410 SCSI CDBs sent to the specified device(s).
412 Enable debugging for all devices.
414 Turn off debugging for all devices
415 .It bus Ns Op :target Ns Op :lun
416 Turn on debugging for the given bus, target or lun. If the lun or target
417 and lun are not specified, they are wildcarded. (i.e., just specifying a
418 bus turns on debugging printfs for all devices on that bus.)
421 Show or set the number of "tagged openings" or simultaneous transactions
422 we attempt to queue to a particular device. By default, the
424 command, with no command-specific arguments (i.e. only generic arguments)
425 prints out the "soft" maximum number of transactions that can be queued to
426 the device in question. For more detailed information, use the
428 argument described below.
431 Set the number of tags for the given device. This must be between the
432 minimum and maximum number set in the kernel quirk table. The default for
433 most devices that support tagged queueing is a minimum of 2 and a maximum
434 of 255. The minimum and maximum values for a given device may be
435 determined by using the
437 switch. The meaning of the
441 subcommand is described below.
443 Be quiet, and don't report the number of tags. This is generally used when
444 setting the number of tags.
446 The verbose flag has special functionality for the
450 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
453 This is the amount of capacity for transactions queued to a given device.
455 This is the number of transactions currently queued to a device.
457 This is the kernel queue space for transactions. This count usually mirrors
458 dev_openings except during error recovery operations when
459 the device queue is frozen (device is not allowed to receive
460 commands), the number of dev_openings is reduced, or transaction
463 This is the number of transactions waiting in the kernel queue for capacity
464 on the device. This number is usually zero unless error recovery is in
467 The held count is the number of CCBs held by peripheral drivers that have
468 either just been completed or are about to be released to the transport
469 layer for service by a device. Held CCBs reserve capacity on a given
472 This is the current "hard" minimum number of transactions that can be
473 queued to a device at once. The
475 value above cannot go below this number. The default value for
477 is 2, although it may be set higher or lower for various devices.
479 This is the "hard" maximum number of transactions that can be queued to a
480 device at one time. The
482 value cannot go above this number. The default value for
484 is 255, although it may be set higher or lower for various devices.
488 Show or negotiate various communication parameters. Some controllers may
489 not support setting or changing some of these values. For instance, the
490 Adaptec 174x controllers do not support changing a device's sync rate or
495 will not attempt to set the parameter if the controller indicates that it
496 does not support setting the parameter. To find out what the controller
499 flag. The meaning of the
503 command is described below. Also, some controller drivers don't support
504 setting negotiation parameters, even if the underlying controller supports
505 negotiation changes. Some controllers, such as the Advansys wide
506 controllers, support enabling and disabling synchronous negotiation for
507 a device, but do not support setting the synchronous negotiation rate.
510 Attempt to make the negotiation settings take effect immediately by sending
511 a Test Unit Ready command to the device.
513 Show or set current negotiation settings. This is the default.
514 .It Fl D Ar enable|disable
515 Enable or disable disconnection.
517 Set the command delay offset.
519 Be quiet, don't print anything. This is generally useful when you want to
520 set a parameter, but don't want any status information.
522 Change the synchronization rate for a device. The sync rate is a floating
523 point value specified in MHz. So, for instance,
525 is a legal value, as is
527 .It Fl T Ar enable|disable
528 Enable or disable tagged queueing for a device.
530 Show or set user negotiation settings. The default is to show or set
531 current negotiation settings.
533 The verbose switch has special meaning for the
535 subcommand. It causes
537 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
539 .It Fl W Ar bus_width
540 Specify the bus width to negotiate with a device. The bus width is
541 specified in bits. The only useful values to specify are 8, 16, and 32
542 bits. The controller must support the bus width in question in order for
543 the setting to take effect.
546 In general, sync rate and offset settings will not take effect for a
547 device until a command has been sent to the device. The
549 switch above will automatically send a Test Unit Ready to the device so
550 negotiation parameters will take effect.
554 FORMAT UNIT command to the named device.
556 .Em WARNING! WARNING! WARNING!
558 Low level formatting a disk will destroy ALL data on the disk. Use
559 extreme caution when issuing this command. Many users low-level format
560 disks that do not really need to be low-level formatted. There are
561 relatively few scenarios that call for low-level formatting a disk.
563 low-level formatting a disk is to initialize the disk after changing
564 its physical sector size. Another reason for low-level formatting a disk
565 is to revive the disk if you are getting "medium format corrupted" errors
566 from the disk in response to read and write requests.
568 Some disks take longer than others to format. Users should specify a
569 timeout long enough to allow the format to complete. The default format
570 timeout is 3 hours, which should be long enough for most disks. Some hard
571 disks will complete a format operation in a very short period of time
572 (on the order of 5 minutes or less). This is often because the drive
573 doesn't really support the FORMAT UNIT command -- it just accepts the
574 command, waits a few minutes and then returns it.
578 subcommand takes several arguments that modify its default behavior. The
582 arguments can be useful for scripts.
586 Be quiet, don't print any status messages. This option will not disable
587 the questions, however. To disable questions, use the
594 This will report status on a format that is already running on the drive.
596 Issue a non-immediate format command. By default,
598 issues the FORMAT UNIT command with the immediate bit set. This tells the
599 device to immediately return the format command, before the format has
600 actually completed. Then,
604 sense information from the device every second to determine how far along
605 in the format process it is. If the
607 argument is specified,
609 will issue a non-immediate format command, and will be unable to print any
610 information to let the user know what percentage of the disk has been
613 Don't ask any questions. By default,
615 will ask the user if he/she really wants to format the disk in question,
616 and also if the default format command timeout is acceptable. The user
617 will not be asked about the timeout if a timeout is specified on the
621 Print out verbose usage information.
626 variable allows the user to specify an alternate mode page format file.
630 variable determines which text editor
632 starts when editing mode pages.
634 .Bl -tag -width /usr/share/misc/scsi_modes -compact
635 .It Pa /usr/share/misc/scsi_modes
636 is the SCSI mode format database.
638 is the transport layer device.
640 are the CAM application passthrough devices.
643 .Dl camcontrol eject -n cd -u 1 -v
645 Eject the CD from cd1, and print SCSI sense information if the command
648 .Dl camcontrol tur da0
650 Send the SCSI test unit ready command to da0.
653 utility will report whether the disk is ready, but will not display sense
654 information if the command fails since the
656 switch was not specified.
658 .Bd -literal -offset indent
659 camcontrol tur da1 -E -C 4 -t 50 -v
662 Send a test unit ready command to da1. Enable kernel error recovery.
663 Specify a retry count of 4, and a timeout of 50 seconds. Enable sense
666 flag) if the command fails. Since error recovery is turned on, the
667 disk will be spun up if it is not currently spinning.
670 utility will report whether the disk is ready.
671 .Bd -literal -offset indent
672 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
673 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
676 Issue a READ BUFFER command (0x3C) to cd1. Display the buffer size of cd1,
677 and display the first 10 bytes from the cache on cd1. Display SCSI sense
678 information if the command fails.
680 .Bd -literal -offset indent
681 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
682 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
685 Issue a WRITE BUFFER (0x3B) command to cd1. Write out 10 bytes of data,
686 not including the (reserved) 4 byte header. Print out sense information if
687 the command fails. Be very careful with this command, improper use may
688 cause data corruption.
690 .Bd -literal -offset indent
691 camcontrol modepage da3 -m 1 -e -P 3
694 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
695 settings on the drive. Mode page 1 contains a disk drive's auto read and
696 write reallocation settings, among other things.
698 .Dl camcontrol rescan all
700 Rescan all SCSI busses in the system for devices that have been added,
703 .Dl camcontrol rescan 0
705 Rescan SCSI bus 0 for devices that have been added, removed or changed.
707 .Dl camcontrol rescan 0:1:0
709 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
712 .Dl camcontrol tags da5 -N 24
714 Set the number of concurrent transactions for da5 to 24.
716 .Bd -literal -offset indent
717 camcontrol negotiate -n da -u 4 -T disable
720 Disable tagged queueing for da4.
722 .Bd -literal -offset indent
723 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
726 Negotiate a sync rate of 20MHz and an offset of 15 with da3. Then send a
727 Test Unit Ready command to make the settings take effect.
737 utility first appeared in
740 The mode page editing code and arbitrary SCSI command code are based upon
745 library, written by Julian Elischer and Peter Dufault. The
747 program first appeared in
749 and first appeared in
754 .An Kenneth Merry Aq ken@FreeBSD.org
756 The code that parses the generic command line arguments doesn't know that
757 some of the subcommands take multiple arguments. So if, for instance, you
758 tried something like this:
759 .Bd -literal -offset indent
760 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
763 The sense information from the test unit ready command would not get
764 printed out, since the first
768 bails out when it sees the second argument to
771 above. Fixing this behavior would take some gross code, or changes to the
773 interface. The best way to circumvent this problem is to always make sure
776 arguments before any command-specific arguments.
projects / dragonfly.git / blob