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 $
30 .Dd September 14, 1998
35 .Nd CAM control program
49 .Op Fl u Ar unit_number
75 .Aq all | bus Ns Op :target:lun
78 .Aq all | bus Ns Op :target:lun
98 .Aq Fl c Ar cmd Op args
99 .Op Fl i Ar len Ar fmt
101 .Op Fl o Ar len Ar fmt Op args
111 .Aq all|off|bus Ns Op :target Ns Op :lun
124 .Op Fl D Ar enable|disable
128 .Op Fl T Ar enable|disable
130 .Op Fl W Ar bus_width
144 utility is designed to provide a way for users to access and control the
151 can cause a loss of data and/or system crashes if used improperly. Even
152 expert users are encouraged to exercise caution when using this command.
153 Novice users should stay away from this utility.
157 utility has a number of primary functions, many of which support an optional
158 device identifier. A device identifier can take one of three forms:
161 Specify a device name and unit number combination, like "da5" or "cd3".
162 Note that character device node names (e.g. /dev/da0) are
166 Specify a bus number and target id. The bus number can be determined from
168 .Dq camcontrol devlist .
169 The lun defaults to 0.
171 Specify the bus, target and lun for a device. (e.g. 1:2:0)
174 The device identifier, if it is specified,
176 come immediately after the function name, and before any generic or
177 function-specific arguments. Note that the
181 arguments described below will override any device name or unit number
182 specified beforehand. The
188 override a specified bus:target or bus:target:lun, however.
192 primary functions support these generic arguments:
195 SCSI command retry count. In order for this to work, error recovery
199 Instruct the kernel to perform generic SCSI error recovery for the given
200 command. This is needed in order for the retry count
202 to be honored. Other than retrying commands, the generic error recovery in
203 the code will generally attempt to spin up drives that are not spinning.
204 It may take some other actions, depending upon the sense code returned from
207 Specify the device type to operate on, e.g. "da", "cd".
209 SCSI command timeout in seconds. This overrides the default timeout for
211 .It Fl u Ar unit_number
212 Specify the device unit number, e.g. "1", "5".
214 Be verbose, print out sense information for failed SCSI commands.
217 Primary command functions:
218 .Bl -tag -width periphlist
220 List all physical devices (logical units) attached to the CAM subsystem.
221 This also includes a list of peripheral drivers attached to each device.
224 argument, SCSI bus number, adapter name and unit numbers are printed as
227 List all peripheral drivers attached to a given physical device (logical
230 Send the SCSI test unit ready (0x00) command to the given device.
233 utility will report whether the device is ready or not.
235 Send a SCSI inquiry command (0x12) to a device. By default,
237 will print out the standard inquiry data, device serial number, and
238 transfer rate information. The user can specify that only certain types of
239 inquiry data be printed:
242 Get the standard inquiry data.
244 Print out the serial number. If this flag is the only one specified,
246 will not print out "Serial Number" before the value returned by the drive.
247 This is to aid in script writing.
249 Print out transfer rate information.
252 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
255 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
258 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
259 start bit cleared and the eject bit set.
261 Tell the kernel to scan all busses in the system (with the
263 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
264 (XPT_SCAN_LUN) for new devices or devices that have gone away. The user
265 may specify a scan of all busses, a single bus, or a lun. Scanning all luns
266 on a target isn't supported.
268 Tell the kernel to reset all busses in the system (with the
270 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
271 reset for that bus, or to reset the given bus:target:lun
272 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
273 connecting to that device.
274 Note that this can have a destructive impact
277 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
278 print out any combination of: the total number of defects, the primary
279 defect list (PLIST), and the grown defect list (GLIST).
282 The three format options are:
284 to print out the list as logical blocks,
286 to print out the list in bytes from index format, and
288 to print out the list in physical sector format. The format argument is
289 required. Most drives support the physical sector format. Some drives
290 support the logical block format. Many drives, if they don't support the
291 requested format, return the data in an alternate format, along with sense
292 information indicating that the requested data format isn't supported.
296 attempts to detect this, and print out whatever format the drive returns.
297 If the drive uses a non-standard sense code to report that it doesn't
298 support the requested format,
300 will probably see the error as a failure to complete the request.
302 Print out the grown defect list. This is a list of bad blocks that have
303 been remapped since the disk left the factory.
305 Print out the primary defect list.
314 will print out the number of defects given in the READ DEFECT DATA header
315 returned from the drive.
317 Allows the user to display and optionally edit a SCSI mode page. The mode
318 page formats are located in
319 .Pa /usr/share/misc/scsi_modes .
320 This can be overridden by specifying a different file in the
322 environment variable.
325 command takes several arguments:
328 Disable block descriptors for mode sense.
330 This flag allows the user to edit values in the mode page.
331 .It Fl m Ar mode_page
332 This specifies the number of the mode page the user would like to view
333 and/or edit. This argument is mandatory.
335 This allows the user to specify the page control field. Possible values are:
336 .Bl -tag -width xxx -compact
348 Allows the user to send an arbitrary SCSI CDB to any device.
351 function requires the
353 argument to specify the CDB. Other arguments are optional, depending on
354 the command type. The command and data specification syntax is documented
357 NOTE: If the CDB specified causes data to be transfered to or from the
358 SCSI device in question, you MUST specify either
363 .It Fl c Ar cmd Op args
364 This specifies the SCSI CDB. CDBs may be 6, 10, 12 or 16 bytes.
365 .It Fl i Ar len Ar fmt
366 This specifies the amount of data to read, and how it should be displayed.
370 bytes of data will be read from the device and written to standard output.
371 .It Fl o Ar len Ar fmt Op args
372 This specifies the amount of data to be written to a device, and the data
373 that is to be written. If the format is
376 bytes of data will be read from standard input and written to the device.
379 Turn on CAM debugging printfs in the kernel. This requires options CAMDEBUG
380 in your kernel config file. WARNING: enabling debugging printfs currently
381 causes an EXTREME number of kernel printfs. You may have difficulty
382 turning off the debugging printfs once they start, since the kernel will be
383 busy printing messages and unable to service other requests quickly.
386 function takes a number of arguments:
389 Enable CAM_DEBUG_INFO printfs.
391 Enable CAM_DEBUG_PERIPH printfs.
393 Enable CAM_DEBUG_TRACE printfs.
395 Enable CAM_DEBUG_SUBTRACE printfs.
397 Enable CAM_DEBUG_XPT printfs.
399 Enable CAM_DEBUG_CDB printfs. This will cause the kernel to print out the
400 SCSI CDBs sent to the specified device(s).
402 Enable debugging for all devices.
404 Turn off debugging for all devices
405 .It bus Ns Op :target Ns Op :lun
406 Turn on debugging for the given bus, target or lun. If the lun or target
407 and lun are not specified, they are wildcarded. (i.e., just specifying a
408 bus turns on debugging printfs for all devices on that bus.)
411 Show or set the number of "tagged openings" or simultaneous transactions
412 we attempt to queue to a particular device. By default, the
414 command, with no command-specific arguments (i.e. only generic arguments)
415 prints out the "soft" maximum number of transactions that can be queued to
416 the device in question. For more detailed information, use the
418 argument described below.
421 Set the number of tags for the given device. This must be between the
422 minimum and maximum number set in the kernel quirk table. The default for
423 most devices that support tagged queueing is a minimum of 2 and a maximum
424 of 255. The minimum and maximum values for a given device may be
425 determined by using the
427 switch. The meaning of the
431 subcommand is described below.
433 Be quiet, and don't report the number of tags. This is generally used when
434 setting the number of tags.
436 The verbose flag has special functionality for the
440 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
443 This is the amount of capacity for transactions queued to a given device.
445 This is the number of transactions currently queued to a device.
447 This is the kernel queue space for transactions. This count usually mirrors
448 dev_openings except during error recovery operations when
449 the device queue is frozen (device is not allowed to receive
450 commands), the number of dev_openings is reduced, or transaction
453 This is the number of transactions waiting in the kernel queue for capacity
454 on the device. This number is usually zero unless error recovery is in
457 The held count is the number of CCBs held by peripheral drivers that have
458 either just been completed or are about to be released to the transport
459 layer for service by a device. Held CCBs reserve capacity on a given
462 This is the current "hard" minimum number of transactions that can be
463 queued to a device at once. The
465 value above cannot go below this number. The default value for
467 is 2, although it may be set higher or lower for various devices.
469 This is the "hard" maximum number of transactions that can be queued to a
470 device at one time. The
472 value cannot go above this number. The default value for
474 is 255, although it may be set higher or lower for various devices.
478 Show or negotiate various communication parameters. Some controllers may
479 not support setting or changing some of these values. For instance, the
480 Adaptec 174x controllers do not support changing a device's sync rate or
485 will not attempt to set the parameter if the controller indicates that it
486 does not support setting the parameter. To find out what the controller
489 flag. The meaning of the
493 command is described below. Also, some controller drivers don't support
494 setting negotiation parameters, even if the underlying controller supports
495 negotiation changes. Some controllers, such as the Advansys wide
496 controllers, support enabling and disabling synchronous negotiation for
497 a device, but do not support setting the synchronous negotiation rate.
500 Attempt to make the negotiation settings take effect immediately by sending
501 a Test Unit Ready command to the device.
503 Show or set current negotiation settings. This is the default.
504 .It Fl D Ar enable|disable
505 Enable or disable disconnection.
507 Set the command delay offset.
509 Be quiet, don't print anything. This is generally useful when you want to
510 set a parameter, but don't want any status information.
512 Change the synchronization rate for a device. The sync rate is a floating
513 point value specified in MHz. So, for instance,
515 is a legal value, as is
517 .It Fl T Ar enable|disable
518 Enable or disable tagged queueing for a device.
520 Show or set user negotiation settings. The default is to show or set
521 current negotiation settings.
523 The verbose switch has special meaning for the
525 subcommand. It causes
527 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
529 .It Fl W Ar bus_width
530 Specify the bus width to negotiate with a device. The bus width is
531 specified in bits. The only useful values to specify are 8, 16, and 32
532 bits. The controller must support the bus width in question in order for
533 the setting to take effect.
536 In general, sync rate and offset settings will not take effect for a
537 device until a command has been sent to the device. The
539 switch above will automatically send a Test Unit Ready to the device so
540 negotiation parameters will take effect.
544 FORMAT UNIT command to the named device.
546 .Em WARNING! WARNING! WARNING!
548 Low level formatting a disk will destroy ALL data on the disk. Use
549 extreme caution when issuing this command. Many users low-level format
550 disks that do not really need to be low-level formatted. There are
551 relatively few scenarios that call for low-level formatting a disk.
553 low-level formatting a disk is to initialize the disk after changing
554 its physical sector size. Another reason for low-level formatting a disk
555 is to revive the disk if you are getting "medium format corrupted" errors
556 from the disk in response to read and write requests.
558 Some disks take longer than others to format. Users should specify a
559 timeout long enough to allow the format to complete. The default format
560 timeout is 3 hours, which should be long enough for most disks. Some hard
561 disks will complete a format operation in a very short period of time
562 (on the order of 5 minutes or less). This is often because the drive
563 doesn't really support the FORMAT UNIT command -- it just accepts the
564 command, waits a few minutes and then returns it.
568 subcommand takes several arguments that modify its default behavior. The
572 arguments can be useful for scripts.
576 Be quiet, don't print any status messages. This option will not disable
577 the questions, however. To disable questions, use the
581 Issue a non-immediate format command. By default,
583 issues the FORMAT UNIT command with the immediate bit set. This tells the
584 device to immediately return the format command, before the format has
585 actually completed. Then,
589 sense information from the device every second to determine how far along
590 in the format process it is. If the
592 argument is specified,
594 will issue a non-immediate format command, and will be unable to print any
595 information to let the user know what percentage of the disk has been
598 Don't ask any questions. By default,
600 will ask the user if he/she really wants to format the disk in question,
601 and also if the default format command timeout is acceptable. The user
602 will not be asked about the timeout if a timeout is specified on the
606 Print out verbose usage information.
611 variable allows the user to specify an alternate mode page format file.
615 variable determines which text editor
617 starts when editing mode pages.
619 .Bl -tag -width /usr/share/misc/scsi_modes -compact
620 .It Pa /usr/share/misc/scsi_modes
621 is the SCSI mode format database.
623 is the transport layer device.
625 are the CAM application passthrough devices.
628 .Dl camcontrol eject -n cd -u 1 -v
630 Eject the CD from cd1, and print SCSI sense information if the command
633 .Dl camcontrol tur da0
635 Send the SCSI test unit ready command to da0.
638 utility will report whether the disk is ready, but will not display sense
639 information if the command fails since the
641 switch was not specified.
643 .Bd -literal -offset indent
644 camcontrol tur da1 -E -C 4 -t 50 -v
647 Send a test unit ready command to da1. Enable kernel error recovery.
648 Specify a retry count of 4, and a timeout of 50 seconds. Enable sense
651 flag) if the command fails. Since error recovery is turned on, the
652 disk will be spun up if it is not currently spinning.
655 utility will report whether the disk is ready.
656 .Bd -literal -offset indent
657 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
658 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
661 Issue a READ BUFFER command (0x3C) to cd1. Display the buffer size of cd1,
662 and display the first 10 bytes from the cache on cd1. Display SCSI sense
663 information if the command fails.
665 .Bd -literal -offset indent
666 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
667 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
670 Issue a WRITE BUFFER (0x3B) command to cd1. Write out 10 bytes of data,
671 not including the (reserved) 4 byte header. Print out sense information if
672 the command fails. Be very careful with this command, improper use may
673 cause data corruption.
675 .Bd -literal -offset indent
676 camcontrol modepage da3 -m 1 -e -P 3
679 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
680 settings on the drive. Mode page 1 contains a disk drive's auto read and
681 write reallocation settings, among other things.
683 .Dl camcontrol rescan all
685 Rescan all SCSI busses in the system for devices that have been added,
688 .Dl camcontrol rescan 0
690 Rescan SCSI bus 0 for devices that have been added, removed or changed.
692 .Dl camcontrol rescan 0:1:0
694 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
697 .Dl camcontrol tags da5 -N 24
699 Set the number of concurrent transactions for da5 to 24.
701 .Bd -literal -offset indent
702 camcontrol negotiate -n da -u 4 -T disable
705 Disable tagged queueing for da4.
707 .Bd -literal -offset indent
708 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
711 Negotiate a sync rate of 20MHz and an offset of 15 with da3. Then send a
712 Test Unit Ready command to make the settings take effect.
722 utility first appeared in
725 The mode page editing code and arbitrary SCSI command code are based upon
730 library, written by Julian Elischer and Peter Dufault. The
732 program first appeared in
734 and first appeared in
739 .An Kenneth Merry Aq ken@FreeBSD.org
741 The code that parses the generic command line arguments doesn't know that
742 some of the subcommands take multiple arguments. So if, for instance, you
743 tried something like this:
744 .Bd -literal -offset indent
745 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
748 The sense information from the test unit ready command would not get
749 printed out, since the first
753 bails out when it sees the second argument to
756 above. Fixing this behavior would take some gross code, or changes to the
758 interface. The best way to circumvent this problem is to always make sure
761 arguments before any command-specific arguments.
projects / dragonfly.git / blob