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.6 2007/11/24 19:22:51 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
149 utility is designed to provide a way for users to access and control the
156 can cause a loss of data and/or system crashes if used improperly. Even
157 expert users are encouraged to exercise caution when using this command.
158 Novice users should stay away from this utility.
162 utility has a number of primary functions, many of which support an optional
163 device identifier. A device identifier can take one of three forms:
166 Specify a device name and unit number combination, like "da5" or "cd3".
167 Note that character device node names (e.g. /dev/da0) are
171 Specify a bus number and target id. The bus number can be determined from
173 .Dq camcontrol devlist .
174 The lun defaults to 0.
176 Specify the bus, target and lun for a device. (e.g. 1:2:0)
179 The device identifier, if it is specified,
181 come immediately after the function name, and before any generic or
182 function-specific arguments. Note that the
186 arguments described below will override any device name or unit number
187 specified beforehand. The
193 override a specified bus:target or bus:target:lun, however.
197 primary functions support these generic arguments:
200 SCSI command retry count. In order for this to work, error recovery
204 Instruct the kernel to perform generic SCSI error recovery for the given
205 command. This is needed in order for the retry count
207 to be honored. Other than retrying commands, the generic error recovery in
208 the code will generally attempt to spin up drives that are not spinning.
209 It may take some other actions, depending upon the sense code returned from
212 Specify the device type to operate on, e.g. "da", "cd".
214 SCSI command timeout in seconds. This overrides the default timeout for
216 .It Fl u Ar unit_number
217 Specify the device unit number, e.g. "1", "5".
219 Be verbose, print out sense information for failed SCSI commands.
222 Primary command functions:
223 .Bl -tag -width periphlist
225 List all physical devices (logical units) attached to the CAM subsystem.
226 This also includes a list of peripheral drivers attached to each device.
229 argument, SCSI bus number, adapter name and unit numbers are printed as
232 List all peripheral drivers attached to a given physical device (logical
235 Send the SCSI test unit ready (0x00) command to the given device.
238 utility will report whether the device is ready or not.
240 Send a SCSI inquiry command (0x12) to a device. By default,
242 will print out the standard inquiry data, device serial number, and
243 transfer rate information. The user can specify that only certain types of
244 inquiry data be printed:
247 Get the standard inquiry data.
249 Print out the serial number. If this flag is the only one specified,
251 will not print out "Serial Number" before the value returned by the drive.
252 This is to aid in script writing.
254 Print out transfer rate information.
257 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
260 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
263 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
264 start bit set and the load/eject bit set.
266 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
267 start bit cleared and the load/eject bit set.
269 Tell the kernel to scan all busses in the system (with the
271 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
272 (XPT_SCAN_LUN) for new devices or devices that have gone away. The user
273 may specify a scan of all busses, a single bus, or a lun. Scanning all luns
274 on a target isn't supported.
276 Tell the kernel to reset all busses in the system (with the
278 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
279 reset for that bus, or to reset the given bus:target:lun
280 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
281 connecting to that device.
282 Note that this can have a destructive impact
285 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
286 print out any combination of: the total number of defects, the primary
287 defect list (PLIST), and the grown defect list (GLIST).
290 The three format options are:
292 to print out the list as logical blocks,
294 to print out the list in bytes from index format, and
296 to print out the list in physical sector format. The format argument is
297 required. Most drives support the physical sector format. Some drives
298 support the logical block format. Many drives, if they don't support the
299 requested format, return the data in an alternate format, along with sense
300 information indicating that the requested data format isn't supported.
304 attempts to detect this, and print out whatever format the drive returns.
305 If the drive uses a non-standard sense code to report that it doesn't
306 support the requested format,
308 will probably see the error as a failure to complete the request.
310 Print out the grown defect list. This is a list of bad blocks that have
311 been remapped since the disk left the factory.
313 Print out the primary defect list.
322 will print out the number of defects given in the READ DEFECT DATA header
323 returned from the drive.
325 Allows the user to display and optionally edit a SCSI mode page. The mode
326 page formats are located in
327 .Pa /usr/share/misc/scsi_modes .
328 This can be overridden by specifying a different file in the
330 environment variable.
333 command takes several arguments:
336 Disable block descriptors for mode sense.
338 This flag allows the user to edit values in the mode page.
339 .It Fl m Ar mode_page
340 This specifies the number of the mode page the user would like to view
341 and/or edit. This argument is mandatory.
343 This allows the user to specify the page control field. Possible values are:
344 .Bl -tag -width xxx -compact
356 Allows the user to send an arbitrary SCSI CDB to any device.
359 function requires the
361 argument to specify the CDB. Other arguments are optional, depending on
362 the command type. The command and data specification syntax is documented
365 NOTE: If the CDB specified causes data to be transferred to or from the
366 SCSI device in question, you MUST specify either
371 .It Fl c Ar cmd Op args
372 This specifies the SCSI CDB. CDBs may be 6, 10, 12 or 16 bytes.
373 .It Fl i Ar len Ar fmt
374 This specifies the amount of data to read, and how it should be displayed.
378 bytes of data will be read from the device and written to standard output.
379 .It Fl o Ar len Ar fmt Op args
380 This specifies the amount of data to be written to a device, and the data
381 that is to be written. If the format is
384 bytes of data will be read from standard input and written to the device.
387 Turn on CAM debugging printfs in the kernel. This requires
389 in your kernel config file. WARNING: enabling debugging printfs currently
390 causes an EXTREME number of kernel printfs. You may have difficulty
391 turning off the debugging printfs once they start, since the kernel will be
392 busy printing messages and unable to service other requests quickly.
395 function takes a number of arguments:
398 Enable CAM_DEBUG_INFO printfs.
400 Enable CAM_DEBUG_PERIPH printfs.
402 Enable CAM_DEBUG_TRACE printfs.
404 Enable CAM_DEBUG_SUBTRACE printfs.
406 Enable CAM_DEBUG_XPT printfs.
408 Enable CAM_DEBUG_CDB printfs. This will cause the kernel to print out the
409 SCSI CDBs sent to the specified device(s).
411 Enable debugging for all devices.
413 Turn off debugging for all devices
414 .It bus Ns Op :target Ns Op :lun
415 Turn on debugging for the given bus, target or lun. If the lun or target
416 and lun are not specified, they are wildcarded. (i.e., just specifying a
417 bus turns on debugging printfs for all devices on that bus.)
420 Show or set the number of "tagged openings" or simultaneous transactions
421 we attempt to queue to a particular device. By default, the
423 command, with no command-specific arguments (i.e. only generic arguments)
424 prints out the "soft" maximum number of transactions that can be queued to
425 the device in question. For more detailed information, use the
427 argument described below.
430 Set the number of tags for the given device. This must be between the
431 minimum and maximum number set in the kernel quirk table. The default for
432 most devices that support tagged queueing is a minimum of 2 and a maximum
433 of 255. The minimum and maximum values for a given device may be
434 determined by using the
436 switch. The meaning of the
440 subcommand is described below.
442 Be quiet, and don't report the number of tags. This is generally used when
443 setting the number of tags.
445 The verbose flag has special functionality for the
449 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
452 This is the amount of capacity for transactions queued to a given device.
454 This is the number of transactions currently queued to a device.
456 This is the kernel queue space for transactions. This count usually mirrors
457 dev_openings except during error recovery operations when
458 the device queue is frozen (device is not allowed to receive
459 commands), the number of dev_openings is reduced, or transaction
462 This is the number of transactions waiting in the kernel queue for capacity
463 on the device. This number is usually zero unless error recovery is in
466 The held count is the number of CCBs held by peripheral drivers that have
467 either just been completed or are about to be released to the transport
468 layer for service by a device. Held CCBs reserve capacity on a given
471 This is the current "hard" minimum number of transactions that can be
472 queued to a device at once. The
474 value above cannot go below this number. The default value for
476 is 2, although it may be set higher or lower for various devices.
478 This is the "hard" maximum number of transactions that can be queued to a
479 device at one time. The
481 value cannot go above this number. The default value for
483 is 255, although it may be set higher or lower for various devices.
487 Show or negotiate various communication parameters. Some controllers may
488 not support setting or changing some of these values. For instance, the
489 Adaptec 174x controllers do not support changing a device's sync rate or
494 will not attempt to set the parameter if the controller indicates that it
495 does not support setting the parameter. To find out what the controller
498 flag. The meaning of the
502 command is described below. Also, some controller drivers don't support
503 setting negotiation parameters, even if the underlying controller supports
504 negotiation changes. Some controllers, such as the Advansys wide
505 controllers, support enabling and disabling synchronous negotiation for
506 a device, but do not support setting the synchronous negotiation rate.
509 Attempt to make the negotiation settings take effect immediately by sending
510 a Test Unit Ready command to the device.
512 Show or set current negotiation settings. This is the default.
513 .It Fl D Ar enable|disable
514 Enable or disable disconnection.
516 Set the command delay offset.
518 Be quiet, don't print anything. This is generally useful when you want to
519 set a parameter, but don't want any status information.
521 Change the synchronization rate for a device. The sync rate is a floating
522 point value specified in MHz. So, for instance,
524 is a legal value, as is
526 .It Fl T Ar enable|disable
527 Enable or disable tagged queueing for a device.
529 Show or set user negotiation settings. The default is to show or set
530 current negotiation settings.
532 The verbose switch has special meaning for the
534 subcommand. It causes
536 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
538 .It Fl W Ar bus_width
539 Specify the bus width to negotiate with a device. The bus width is
540 specified in bits. The only useful values to specify are 8, 16, and 32
541 bits. The controller must support the bus width in question in order for
542 the setting to take effect.
545 In general, sync rate and offset settings will not take effect for a
546 device until a command has been sent to the device. The
548 switch above will automatically send a Test Unit Ready to the device so
549 negotiation parameters will take effect.
553 FORMAT UNIT command to the named device.
555 .Em WARNING! WARNING! WARNING!
557 Low level formatting a disk will destroy ALL data on the disk. Use
558 extreme caution when issuing this command. Many users low-level format
559 disks that do not really need to be low-level formatted. There are
560 relatively few scenarios that call for low-level formatting a disk.
562 low-level formatting a disk is to initialize the disk after changing
563 its physical sector size. Another reason for low-level formatting a disk
564 is to revive the disk if you are getting "medium format corrupted" errors
565 from the disk in response to read and write requests.
567 Some disks take longer than others to format. Users should specify a
568 timeout long enough to allow the format to complete. The default format
569 timeout is 3 hours, which should be long enough for most disks. Some hard
570 disks will complete a format operation in a very short period of time
571 (on the order of 5 minutes or less). This is often because the drive
572 doesn't really support the FORMAT UNIT command -- it just accepts the
573 command, waits a few minutes and then returns it.
577 subcommand takes several arguments that modify its default behavior. The
581 arguments can be useful for scripts.
585 Be quiet, don't print any status messages. This option will not disable
586 the questions, however. To disable questions, use the
590 Issue a non-immediate format command. By default,
592 issues the FORMAT UNIT command with the immediate bit set. This tells the
593 device to immediately return the format command, before the format has
594 actually completed. Then,
598 sense information from the device every second to determine how far along
599 in the format process it is. If the
601 argument is specified,
603 will issue a non-immediate format command, and will be unable to print any
604 information to let the user know what percentage of the disk has been
607 Don't ask any questions. By default,
609 will ask the user if he/she really wants to format the disk in question,
610 and also if the default format command timeout is acceptable. The user
611 will not be asked about the timeout if a timeout is specified on the
615 Print out verbose usage information.
620 variable allows the user to specify an alternate mode page format file.
624 variable determines which text editor
626 starts when editing mode pages.
628 .Bl -tag -width /usr/share/misc/scsi_modes -compact
629 .It Pa /usr/share/misc/scsi_modes
630 is the SCSI mode format database.
632 is the transport layer device.
634 are the CAM application passthrough devices.
637 .Dl camcontrol eject -n cd -u 1 -v
639 Eject the CD from cd1, and print SCSI sense information if the command
642 .Dl camcontrol tur da0
644 Send the SCSI test unit ready command to da0.
647 utility will report whether the disk is ready, but will not display sense
648 information if the command fails since the
650 switch was not specified.
652 .Bd -literal -offset indent
653 camcontrol tur da1 -E -C 4 -t 50 -v
656 Send a test unit ready command to da1. Enable kernel error recovery.
657 Specify a retry count of 4, and a timeout of 50 seconds. Enable sense
660 flag) if the command fails. Since error recovery is turned on, the
661 disk will be spun up if it is not currently spinning.
664 utility will report whether the disk is ready.
665 .Bd -literal -offset indent
666 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
667 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
670 Issue a READ BUFFER command (0x3C) to cd1. Display the buffer size of cd1,
671 and display the first 10 bytes from the cache on cd1. Display SCSI sense
672 information if the command fails.
674 .Bd -literal -offset indent
675 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
676 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
679 Issue a WRITE BUFFER (0x3B) command to cd1. Write out 10 bytes of data,
680 not including the (reserved) 4 byte header. Print out sense information if
681 the command fails. Be very careful with this command, improper use may
682 cause data corruption.
684 .Bd -literal -offset indent
685 camcontrol modepage da3 -m 1 -e -P 3
688 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
689 settings on the drive. Mode page 1 contains a disk drive's auto read and
690 write reallocation settings, among other things.
692 .Dl camcontrol rescan all
694 Rescan all SCSI busses in the system for devices that have been added,
697 .Dl camcontrol rescan 0
699 Rescan SCSI bus 0 for devices that have been added, removed or changed.
701 .Dl camcontrol rescan 0:1:0
703 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
706 .Dl camcontrol tags da5 -N 24
708 Set the number of concurrent transactions for da5 to 24.
710 .Bd -literal -offset indent
711 camcontrol negotiate -n da -u 4 -T disable
714 Disable tagged queueing for da4.
716 .Bd -literal -offset indent
717 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
720 Negotiate a sync rate of 20MHz and an offset of 15 with da3. Then send a
721 Test Unit Ready command to make the settings take effect.
731 utility first appeared in
734 The mode page editing code and arbitrary SCSI command code are based upon
739 library, written by Julian Elischer and Peter Dufault. The
741 program first appeared in
743 and first appeared in
748 .An Kenneth Merry Aq ken@FreeBSD.org
750 The code that parses the generic command line arguments doesn't know that
751 some of the subcommands take multiple arguments. So if, for instance, you
752 tried something like this:
753 .Bd -literal -offset indent
754 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
757 The sense information from the test unit ready command would not get
758 printed out, since the first
762 bails out when it sees the second argument to
765 above. Fixing this behavior would take some gross code, or changes to the
767 interface. The best way to circumvent this problem is to always make sure
770 arguments before any command-specific arguments.
projects / dragonfly.git / blob