2 .\" Copyright (c) 1998, 1999, 2000, 2002 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.3 2004/03/11 12:28:53 hmp Exp $
31 .Dd September 14, 1998
36 .Nd CAM control program
50 .Op Fl u Ar unit_number
76 .Aq all | bus Ns Op :target:lun
79 .Aq all | bus Ns Op :target:lun
99 .Aq Fl c Ar cmd Op args
100 .Op Fl i Ar len Ar fmt
102 .Op Fl o Ar len Ar fmt Op args
112 .Aq all|off|bus Ns Op :target Ns Op :lun
125 .Op Fl D Ar enable|disable
129 .Op Fl T Ar enable|disable
131 .Op Fl W Ar bus_width
145 utility is designed to provide a way for users to access and control the
152 can cause a loss of data and/or system crashes if used improperly. Even
153 expert users are encouraged to exercise caution when using this command.
154 Novice users should stay away from this utility.
158 utility has a number of primary functions, many of which support an optional
159 device identifier. A device identifier can take one of three forms:
162 Specify a device name and unit number combination, like "da5" or "cd3".
163 Note that character device node names (e.g. /dev/da0) are
167 Specify a bus number and target id. The bus number can be determined from
169 .Dq camcontrol devlist .
170 The lun defaults to 0.
172 Specify the bus, target and lun for a device. (e.g. 1:2:0)
175 The device identifier, if it is specified,
177 come immediately after the function name, and before any generic or
178 function-specific arguments. Note that the
182 arguments described below will override any device name or unit number
183 specified beforehand. The
189 override a specified bus:target or bus:target:lun, however.
193 primary functions support these generic arguments:
196 SCSI command retry count. In order for this to work, error recovery
200 Instruct the kernel to perform generic SCSI error recovery for the given
201 command. This is needed in order for the retry count
203 to be honored. Other than retrying commands, the generic error recovery in
204 the code will generally attempt to spin up drives that are not spinning.
205 It may take some other actions, depending upon the sense code returned from
208 Specify the device type to operate on, e.g. "da", "cd".
210 SCSI command timeout in seconds. This overrides the default timeout for
212 .It Fl u Ar unit_number
213 Specify the device unit number, e.g. "1", "5".
215 Be verbose, print out sense information for failed SCSI commands.
218 Primary command functions:
219 .Bl -tag -width periphlist
221 List all physical devices (logical units) attached to the CAM subsystem.
222 This also includes a list of peripheral drivers attached to each device.
225 argument, SCSI bus number, adapter name and unit numbers are printed as
228 List all peripheral drivers attached to a given physical device (logical
231 Send the SCSI test unit ready (0x00) command to the given device.
234 utility will report whether the device is ready or not.
236 Send a SCSI inquiry command (0x12) to a device. By default,
238 will print out the standard inquiry data, device serial number, and
239 transfer rate information. The user can specify that only certain types of
240 inquiry data be printed:
243 Get the standard inquiry data.
245 Print out the serial number. If this flag is the only one specified,
247 will not print out "Serial Number" before the value returned by the drive.
248 This is to aid in script writing.
250 Print out transfer rate information.
253 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
256 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
259 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
260 start bit cleared and the eject bit set.
262 Tell the kernel to scan all busses in the system (with the
264 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
265 (XPT_SCAN_LUN) for new devices or devices that have gone away. The user
266 may specify a scan of all busses, a single bus, or a lun. Scanning all luns
267 on a target isn't supported.
269 Tell the kernel to reset all busses in the system (with the
271 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
272 reset for that bus, or to reset the given bus:target:lun
273 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
274 connecting to that device.
275 Note that this can have a destructive impact
278 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
279 print out any combination of: the total number of defects, the primary
280 defect list (PLIST), and the grown defect list (GLIST).
283 The three format options are:
285 to print out the list as logical blocks,
287 to print out the list in bytes from index format, and
289 to print out the list in physical sector format. The format argument is
290 required. Most drives support the physical sector format. Some drives
291 support the logical block format. Many drives, if they don't support the
292 requested format, return the data in an alternate format, along with sense
293 information indicating that the requested data format isn't supported.
297 attempts to detect this, and print out whatever format the drive returns.
298 If the drive uses a non-standard sense code to report that it doesn't
299 support the requested format,
301 will probably see the error as a failure to complete the request.
303 Print out the grown defect list. This is a list of bad blocks that have
304 been remapped since the disk left the factory.
306 Print out the primary defect list.
315 will print out the number of defects given in the READ DEFECT DATA header
316 returned from the drive.
318 Allows the user to display and optionally edit a SCSI mode page. The mode
319 page formats are located in
320 .Pa /usr/share/misc/scsi_modes .
321 This can be overridden by specifying a different file in the
323 environment variable.
326 command takes several arguments:
329 Disable block descriptors for mode sense.
331 This flag allows the user to edit values in the mode page.
332 .It Fl m Ar mode_page
333 This specifies the number of the mode page the user would like to view
334 and/or edit. This argument is mandatory.
336 This allows the user to specify the page control field. Possible values are:
337 .Bl -tag -width xxx -compact
349 Allows the user to send an arbitrary SCSI CDB to any device.
352 function requires the
354 argument to specify the CDB. Other arguments are optional, depending on
355 the command type. The command and data specification syntax is documented
358 NOTE: If the CDB specified causes data to be transfered to or from the
359 SCSI device in question, you MUST specify either
364 .It Fl c Ar cmd Op args
365 This specifies the SCSI CDB. CDBs may be 6, 10, 12 or 16 bytes.
366 .It Fl i Ar len Ar fmt
367 This specifies the amount of data to read, and how it should be displayed.
371 bytes of data will be read from the device and written to standard output.
372 .It Fl o Ar len Ar fmt Op args
373 This specifies the amount of data to be written to a device, and the data
374 that is to be written. If the format is
377 bytes of data will be read from standard input and written to the device.
380 Turn on CAM debugging printfs in the kernel. This requires options CAMDEBUG
381 in your kernel config file. WARNING: enabling debugging printfs currently
382 causes an EXTREME number of kernel printfs. You may have difficulty
383 turning off the debugging printfs once they start, since the kernel will be
384 busy printing messages and unable to service other requests quickly.
387 function takes a number of arguments:
390 Enable CAM_DEBUG_INFO printfs.
392 Enable CAM_DEBUG_PERIPH printfs.
394 Enable CAM_DEBUG_TRACE printfs.
396 Enable CAM_DEBUG_SUBTRACE printfs.
398 Enable CAM_DEBUG_XPT printfs.
400 Enable CAM_DEBUG_CDB printfs. This will cause the kernel to print out the
401 SCSI CDBs sent to the specified device(s).
403 Enable debugging for all devices.
405 Turn off debugging for all devices
406 .It bus Ns Op :target Ns Op :lun
407 Turn on debugging for the given bus, target or lun. If the lun or target
408 and lun are not specified, they are wildcarded. (i.e., just specifying a
409 bus turns on debugging printfs for all devices on that bus.)
412 Show or set the number of "tagged openings" or simultaneous transactions
413 we attempt to queue to a particular device. By default, the
415 command, with no command-specific arguments (i.e. only generic arguments)
416 prints out the "soft" maximum number of transactions that can be queued to
417 the device in question. For more detailed information, use the
419 argument described below.
422 Set the number of tags for the given device. This must be between the
423 minimum and maximum number set in the kernel quirk table. The default for
424 most devices that support tagged queueing is a minimum of 2 and a maximum
425 of 255. The minimum and maximum values for a given device may be
426 determined by using the
428 switch. The meaning of the
432 subcommand is described below.
434 Be quiet, and don't report the number of tags. This is generally used when
435 setting the number of tags.
437 The verbose flag has special functionality for the
441 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
444 This is the amount of capacity for transactions queued to a given device.
446 This is the number of transactions currently queued to a device.
448 This is the kernel queue space for transactions. This count usually mirrors
449 dev_openings except during error recovery operations when
450 the device queue is frozen (device is not allowed to receive
451 commands), the number of dev_openings is reduced, or transaction
454 This is the number of transactions waiting in the kernel queue for capacity
455 on the device. This number is usually zero unless error recovery is in
458 The held count is the number of CCBs held by peripheral drivers that have
459 either just been completed or are about to be released to the transport
460 layer for service by a device. Held CCBs reserve capacity on a given
463 This is the current "hard" minimum number of transactions that can be
464 queued to a device at once. The
466 value above cannot go below this number. The default value for
468 is 2, although it may be set higher or lower for various devices.
470 This is the "hard" maximum number of transactions that can be queued to a
471 device at one time. The
473 value cannot go above this number. The default value for
475 is 255, although it may be set higher or lower for various devices.
479 Show or negotiate various communication parameters. Some controllers may
480 not support setting or changing some of these values. For instance, the
481 Adaptec 174x controllers do not support changing a device's sync rate or
486 will not attempt to set the parameter if the controller indicates that it
487 does not support setting the parameter. To find out what the controller
490 flag. The meaning of the
494 command is described below. Also, some controller drivers don't support
495 setting negotiation parameters, even if the underlying controller supports
496 negotiation changes. Some controllers, such as the Advansys wide
497 controllers, support enabling and disabling synchronous negotiation for
498 a device, but do not support setting the synchronous negotiation rate.
501 Attempt to make the negotiation settings take effect immediately by sending
502 a Test Unit Ready command to the device.
504 Show or set current negotiation settings. This is the default.
505 .It Fl D Ar enable|disable
506 Enable or disable disconnection.
508 Set the command delay offset.
510 Be quiet, don't print anything. This is generally useful when you want to
511 set a parameter, but don't want any status information.
513 Change the synchronization rate for a device. The sync rate is a floating
514 point value specified in MHz. So, for instance,
516 is a legal value, as is
518 .It Fl T Ar enable|disable
519 Enable or disable tagged queueing for a device.
521 Show or set user negotiation settings. The default is to show or set
522 current negotiation settings.
524 The verbose switch has special meaning for the
526 subcommand. It causes
528 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
530 .It Fl W Ar bus_width
531 Specify the bus width to negotiate with a device. The bus width is
532 specified in bits. The only useful values to specify are 8, 16, and 32
533 bits. The controller must support the bus width in question in order for
534 the setting to take effect.
537 In general, sync rate and offset settings will not take effect for a
538 device until a command has been sent to the device. The
540 switch above will automatically send a Test Unit Ready to the device so
541 negotiation parameters will take effect.
545 FORMAT UNIT command to the named device.
547 .Em WARNING! WARNING! WARNING!
549 Low level formatting a disk will destroy ALL data on the disk. Use
550 extreme caution when issuing this command. Many users low-level format
551 disks that do not really need to be low-level formatted. There are
552 relatively few scenarios that call for low-level formatting a disk.
554 low-level formatting a disk is to initialize the disk after changing
555 its physical sector size. Another reason for low-level formatting a disk
556 is to revive the disk if you are getting "medium format corrupted" errors
557 from the disk in response to read and write requests.
559 Some disks take longer than others to format. Users should specify a
560 timeout long enough to allow the format to complete. The default format
561 timeout is 3 hours, which should be long enough for most disks. Some hard
562 disks will complete a format operation in a very short period of time
563 (on the order of 5 minutes or less). This is often because the drive
564 doesn't really support the FORMAT UNIT command -- it just accepts the
565 command, waits a few minutes and then returns it.
569 subcommand takes several arguments that modify its default behavior. The
573 arguments can be useful for scripts.
577 Be quiet, don't print any status messages. This option will not disable
578 the questions, however. To disable questions, use the
582 Issue a non-immediate format command. By default,
584 issues the FORMAT UNIT command with the immediate bit set. This tells the
585 device to immediately return the format command, before the format has
586 actually completed. Then,
590 sense information from the device every second to determine how far along
591 in the format process it is. If the
593 argument is specified,
595 will issue a non-immediate format command, and will be unable to print any
596 information to let the user know what percentage of the disk has been
599 Don't ask any questions. By default,
601 will ask the user if he/she really wants to format the disk in question,
602 and also if the default format command timeout is acceptable. The user
603 will not be asked about the timeout if a timeout is specified on the
607 Print out verbose usage information.
612 variable allows the user to specify an alternate mode page format file.
616 variable determines which text editor
618 starts when editing mode pages.
620 .Bl -tag -width /usr/share/misc/scsi_modes -compact
621 .It Pa /usr/share/misc/scsi_modes
622 is the SCSI mode format database.
624 is the transport layer device.
626 are the CAM application passthrough devices.
629 .Dl camcontrol eject -n cd -u 1 -v
631 Eject the CD from cd1, and print SCSI sense information if the command
634 .Dl camcontrol tur da0
636 Send the SCSI test unit ready command to da0.
639 utility will report whether the disk is ready, but will not display sense
640 information if the command fails since the
642 switch was not specified.
644 .Bd -literal -offset indent
645 camcontrol tur da1 -E -C 4 -t 50 -v
648 Send a test unit ready command to da1. Enable kernel error recovery.
649 Specify a retry count of 4, and a timeout of 50 seconds. Enable sense
652 flag) if the command fails. Since error recovery is turned on, the
653 disk will be spun up if it is not currently spinning.
656 utility will report whether the disk is ready.
657 .Bd -literal -offset indent
658 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
659 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
662 Issue a READ BUFFER command (0x3C) to cd1. Display the buffer size of cd1,
663 and display the first 10 bytes from the cache on cd1. Display SCSI sense
664 information if the command fails.
666 .Bd -literal -offset indent
667 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
668 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
671 Issue a WRITE BUFFER (0x3B) command to cd1. Write out 10 bytes of data,
672 not including the (reserved) 4 byte header. Print out sense information if
673 the command fails. Be very careful with this command, improper use may
674 cause data corruption.
676 .Bd -literal -offset indent
677 camcontrol modepage da3 -m 1 -e -P 3
680 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
681 settings on the drive. Mode page 1 contains a disk drive's auto read and
682 write reallocation settings, among other things.
684 .Dl camcontrol rescan all
686 Rescan all SCSI busses in the system for devices that have been added,
689 .Dl camcontrol rescan 0
691 Rescan SCSI bus 0 for devices that have been added, removed or changed.
693 .Dl camcontrol rescan 0:1:0
695 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
698 .Dl camcontrol tags da5 -N 24
700 Set the number of concurrent transactions for da5 to 24.
702 .Bd -literal -offset indent
703 camcontrol negotiate -n da -u 4 -T disable
706 Disable tagged queueing for da4.
708 .Bd -literal -offset indent
709 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
712 Negotiate a sync rate of 20MHz and an offset of 15 with da3. Then send a
713 Test Unit Ready command to make the settings take effect.
723 utility first appeared in
726 The mode page editing code and arbitrary SCSI command code are based upon
731 library, written by Julian Elischer and Peter Dufault. The
733 program first appeared in
735 and first appeared in
740 .An Kenneth Merry Aq ken@FreeBSD.org
742 The code that parses the generic command line arguments doesn't know that
743 some of the subcommands take multiple arguments. So if, for instance, you
744 tried something like this:
745 .Bd -literal -offset indent
746 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
749 The sense information from the test unit ready command would not get
750 printed out, since the first
754 bails out when it sees the second argument to
757 above. Fixing this behavior would take some gross code, or changes to the
759 interface. The best way to circumvent this problem is to always make sure
762 arguments before any command-specific arguments.
projects / dragonfly.git / blob