]> CyberLeo.Net >> Repos - FreeBSD/stable/8.git/blob - sbin/camcontrol/camcontrol.8
Add missed mergeinfo.
[FreeBSD/stable/8.git] / sbin / camcontrol / camcontrol.8
1 .\"
2 .\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006, 2007 Kenneth D. Merry.
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
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.
15 .\"
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
26 .\" SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD$
29 .\"
30 .Dd June 7, 2013
31 .Dt CAMCONTROL 8
32 .Os
33 .Sh NAME
34 .Nm camcontrol
35 .Nd CAM control program
36 .Sh SYNOPSIS
37 .Nm
38 .Aq Ar command
39 .Op device id
40 .Op generic args
41 .Op command args
42 .Nm
43 .Ic devlist
44 .Op Fl v
45 .Nm
46 .Ic periphlist
47 .Op device id
48 .Op Fl n Ar dev_name
49 .Op Fl u Ar unit_number
50 .Nm
51 .Ic tur
52 .Op device id
53 .Op generic args
54 .Nm
55 .Ic inquiry
56 .Op device id
57 .Op generic args
58 .Op Fl D
59 .Op Fl S
60 .Op Fl R
61 .Nm
62 .Ic identify
63 .Op device id
64 .Op generic args
65 .Op Fl v
66 .Nm
67 .Ic reportluns
68 .Op device id
69 .Op generic args
70 .Op Fl c
71 .Op Fl l
72 .Op Fl r Ar reporttype
73 .Nm
74 .Ic readcap
75 .Op device id
76 .Op generic args
77 .Op Fl b
78 .Op Fl h
79 .Op Fl H
80 .Op Fl N
81 .Op Fl q
82 .Op Fl s
83 .Nm
84 .Ic start
85 .Op device id
86 .Op generic args
87 .Nm
88 .Ic stop
89 .Op device id
90 .Op generic args
91 .Nm
92 .Ic load
93 .Op device id
94 .Op generic args
95 .Nm
96 .Ic eject
97 .Op device id
98 .Op generic args
99 .Nm
100 .Ic rescan
101 .Aq all | bus Ns Op :target:lun
102 .Nm
103 .Ic reset
104 .Aq all | bus Ns Op :target:lun
105 .Nm
106 .Ic defects
107 .Op device id
108 .Op generic args
109 .Aq Fl f Ar format
110 .Op Fl P
111 .Op Fl G
112 .Nm
113 .Ic modepage
114 .Op device id
115 .Op generic args
116 .Aq Fl m Ar page | Fl l
117 .Op Fl P Ar pgctl
118 .Op Fl b | Fl e
119 .Op Fl d
120 .Nm
121 .Ic cmd
122 .Op device id
123 .Op generic args
124 .Aq Fl a Ar cmd Op args
125 .Aq Fl c Ar cmd Op args
126 .Op Fl d
127 .Op Fl f
128 .Op Fl i Ar len Ar fmt
129 .Bk -words
130 .Op Fl o Ar len Ar fmt Op args
131 .Op Fl r Ar fmt
132 .Ek
133 .Nm
134 .Ic debug
135 .Op Fl I
136 .Op Fl P
137 .Op Fl T
138 .Op Fl S
139 .Op Fl X
140 .Op Fl c
141 .Op Fl p
142 .Aq all|off|bus Ns Op :target Ns Op :lun
143 .Nm
144 .Ic tags
145 .Op device id
146 .Op generic args
147 .Op Fl N Ar tags
148 .Op Fl q
149 .Op Fl v
150 .Nm
151 .Ic negotiate
152 .Op device id
153 .Op generic args
154 .Op Fl c
155 .Op Fl D Ar enable|disable
156 .Op Fl M Ar mode
157 .Op Fl O Ar offset
158 .Op Fl q
159 .Op Fl R Ar syncrate
160 .Op Fl T Ar enable|disable
161 .Op Fl U
162 .Op Fl W Ar bus_width
163 .Op Fl v
164 .Nm
165 .Ic format
166 .Op device id
167 .Op generic args
168 .Op Fl q
169 .Op Fl r
170 .Op Fl w
171 .Op Fl y
172 .Nm
173 .Ic idle
174 .Op device id
175 .Op generic args
176 .Op Fl t Ar time
177 .Nm
178 .Ic standby
179 .Op device id
180 .Op generic args
181 .Op Fl t Ar time
182 .Nm
183 .Ic sleep
184 .Op device id
185 .Op generic args
186 .Nm
187 .Ic security
188 .Op device id
189 .Op generic args
190 .Op Fl d Ar pwd
191 .Op Fl e Ar pwd
192 .Op Fl f
193 .Op Fl h Ar pwd
194 .Op Fl k Ar pwd
195 .Op Fl l Ar high|maximum
196 .Op Fl q
197 .Op Fl s Ar pwd
198 .Op Fl T Ar timeout
199 .Op Fl U Ar user|master
200 .Op Fl y
201 .Nm
202 .Ic hpa
203 .Op device id
204 .Op generic args
205 .Op Fl f
206 .Op Fl l
207 .Op Fl P
208 .Op Fl p Ar pwd
209 .Op Fl q
210 .Op Fl s Ar max_sectors
211 .Op Fl U Ar pwd
212 .Op Fl y
213 .Nm
214 .Ic help
215 .Sh DESCRIPTION
216 The
217 .Nm
218 utility is designed to provide a way for users to access and control the
219 .Fx
220 CAM subsystem.
221 .Pp
222 The
223 .Nm
224 utility
225 can cause a loss of data and/or system crashes if used improperly.
226 Even
227 expert users are encouraged to exercise caution when using this command.
228 Novice users should stay away from this utility.
229 .Pp
230 The
231 .Nm
232 utility has a number of primary functions, many of which support an optional
233 device identifier.
234 A device identifier can take one of three forms:
235 .Bl -tag -width 14n
236 .It deviceUNIT
237 Specify a device name and unit number combination, like "da5" or "cd3".
238 .It bus:target
239 Specify a bus number and target id.
240 The bus number can be determined from
241 the output of
242 .Dq camcontrol devlist .
243 The lun defaults to 0.
244 .It bus:target:lun
245 Specify the bus, target and lun for a device.
246 (e.g.\& 1:2:0)
247 .El
248 .Pp
249 The device identifier, if it is specified,
250 .Em must
251 come immediately after the function name, and before any generic or
252 function-specific arguments.
253 Note that the
254 .Fl n
255 and
256 .Fl u
257 arguments described below will override any device name or unit number
258 specified beforehand.
259 The
260 .Fl n
261 and
262 .Fl u
263 arguments will
264 .Em not
265 override a specified bus:target or bus:target:lun, however.
266 .Pp
267 Most of the
268 .Nm
269 primary functions support these generic arguments:
270 .Bl -tag -width 14n
271 .It Fl C Ar count
272 SCSI command retry count.
273 In order for this to work, error recovery
274 .Pq Fl E
275 must be turned on.
276 .It Fl E
277 Instruct the kernel to perform generic SCSI error recovery for the given
278 command.
279 This is needed in order for the retry count
280 .Pq Fl C
281 to be honored.
282 Other than retrying commands, the generic error recovery in
283 the code will generally attempt to spin up drives that are not spinning.
284 It may take some other actions, depending upon the sense code returned from
285 the command.
286 .It Fl n Ar dev_name
287 Specify the device type to operate on, e.g.\& "da", "cd".
288 .It Fl t Ar timeout
289 SCSI command timeout in seconds.
290 This overrides the default timeout for
291 any given command.
292 .It Fl u Ar unit_number
293 Specify the device unit number, e.g.\& "1", "5".
294 .It Fl v
295 Be verbose, print out sense information for failed SCSI commands.
296 .El
297 .Pp
298 Primary command functions:
299 .Bl -tag -width periphlist
300 .It Ic devlist
301 List all physical devices (logical units) attached to the CAM subsystem.
302 This also includes a list of peripheral drivers attached to each device.
303 With the
304 .Fl v
305 argument, SCSI bus number, adapter name and unit numbers are printed as
306 well.
307 .It Ic periphlist
308 List all peripheral drivers attached to a given physical device (logical
309 unit).
310 .It Ic tur
311 Send the SCSI test unit ready (0x00) command to the given device.
312 The
313 .Nm
314 utility will report whether the device is ready or not.
315 .It Ic inquiry
316 Send a SCSI inquiry command (0x12) to a device.
317 By default,
318 .Nm
319 will print out the standard inquiry data, device serial number, and
320 transfer rate information.
321 The user can specify that only certain types of
322 inquiry data be printed:
323 .Bl -tag -width 4n
324 .It Fl D
325 Get the standard inquiry data.
326 .It Fl S
327 Print out the serial number.
328 If this flag is the only one specified,
329 .Nm
330 will not print out "Serial Number" before the value returned by the drive.
331 This is to aid in script writing.
332 .It Fl R
333 Print out transfer rate information.
334 .El
335 .It Ic identify
336 Send a ATA identify command (0xec) to a device.
337 .It Ic reportluns
338 Send the SCSI REPORT LUNS (0xA0) command to the given device.
339 By default,
340 .Nm
341 will print out the list of logical units (LUNs) supported by the target device.
342 There are a couple of options to modify the output:
343 .Bl -tag -width 14n
344 .It Fl c
345 Just print out a count of LUNs, not the actual LUN numbers.
346 .It Fl l
347 Just print out the LUNs, and don't print out the count.
348 .It Fl r Ar reporttype
349 Specify the type of report to request from the target:
350 .Bl -tag -width 012345678
351 .It default
352 Return the default report.
353 This is the
354 .Nm
355 default.
356 Most targets will support this report if they support the REPORT LUNS
357 command.
358 .It wellknown
359 Return only well known LUNs.
360 .It all
361 Return all available LUNs.
362 .El
363 .El
364 .Pp
365 .Nm
366 will try to print out LUN numbers in a reasonable format.
367 It can understand the peripheral, flat, LUN and extended LUN formats.
368 .It Ic readcap
369 Send the SCSI READ CAPACITY command to the given device and display
370 the results.
371 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
372 action will be sent to obtain the full size of the device.
373 By default,
374 .Nm
375 will print out the last logical block of the device, and the blocksize of
376 the device in bytes.
377 To modify the output format, use the following options:
378 .Bl -tag -width 5n
379 .It Fl b
380 Just print out the blocksize, not the last block or device size.
381 This cannot be used with
382 .Fl N
383 or
384 .Fl s .
385 .It Fl h
386 Print out the device size in human readable (base 2, 1K == 1024) format.
387 This implies
388 .Fl N
389 and cannot be used with
390 .Fl q
391 or
392 .Fl b .
393 .It Fl H
394 Print out the device size in human readable (base 10, 1K == 1000) format.
395 .It Fl N
396 Print out the number of blocks in the device instead of the last logical
397 block.
398 .It Fl q
399 Quiet, print out the numbers only (separated by a comma if
400 .Fl b
401 or
402 .Fl s
403 are not specified).
404 .It Fl s
405 Print out the last logical block or the size of the device only, and omit
406 the blocksize.
407 .El
408 .It Ic start
409 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
410 start bit set.
411 .It Ic stop
412 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
413 start bit cleared.
414 .It Ic load
415 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
416 start bit set and the load/eject bit set.
417 .It Ic eject
418 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
419 start bit cleared and the load/eject bit set.
420 .It Ic rescan
421 Tell the kernel to scan all busses in the system (with the
422 .Ar all
423 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
424 (XPT_SCAN_LUN) for new devices or devices that have gone away.
425 The user
426 may specify a scan of all busses, a single bus, or a lun.
427 Scanning all luns
428 on a target is not supported.
429 .It Ic reset
430 Tell the kernel to reset all busses in the system (with the
431 .Ar all
432 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
433 reset for that bus, or to reset the given bus:target:lun
434 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
435 connecting to that device.
436 Note that this can have a destructive impact
437 on the system.
438 .It Ic defects
439 Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
440 print out any combination of: the total number of defects, the primary
441 defect list (PLIST), and the grown defect list (GLIST).
442 .Bl -tag -width 11n
443 .It Fl f Ar format
444 The three format options are:
445 .Em block ,
446 to print out the list as logical blocks,
447 .Em bfi ,
448 to print out the list in bytes from index format, and
449 .Em phys ,
450 to print out the list in physical sector format.
451 The format argument is
452 required.
453 Most drives support the physical sector format.
454 Some drives
455 support the logical block format.
456 Many drives, if they do not support the
457 requested format, return the data in an alternate format, along with sense
458 information indicating that the requested data format is not supported.
459 The
460 .Nm
461 utility
462 attempts to detect this, and print out whatever format the drive returns.
463 If the drive uses a non-standard sense code to report that it does not
464 support the requested format,
465 .Nm
466 will probably see the error as a failure to complete the request.
467 .It Fl G
468 Print out the grown defect list.
469 This is a list of bad blocks that have
470 been remapped since the disk left the factory.
471 .It Fl P
472 Print out the primary defect list.
473 .El
474 .Pp
475 If neither
476 .Fl P
477 nor
478 .Fl G
479 is specified,
480 .Nm
481 will print out the number of defects given in the READ DEFECT DATA header
482 returned from the drive.
483 .It Ic modepage
484 Allows the user to display and optionally edit a SCSI mode page.
485 The mode
486 page formats are located in
487 .Pa /usr/share/misc/scsi_modes .
488 This can be overridden by specifying a different file in the
489 .Ev SCSI_MODES
490 environment variable.
491 The
492 .Ic modepage
493 command takes several arguments:
494 .Bl -tag -width 12n
495 .It Fl d
496 Disable block descriptors for mode sense.
497 .It Fl b
498 Displays mode page data in binary format.
499 .It Fl e
500 This flag allows the user to edit values in the mode page.
501 The user may
502 either edit mode page values with the text editor pointed to by his
503 .Ev EDITOR
504 environment variable, or supply mode page values via standard input, using
505 the same format that
506 .Nm
507 uses to display mode page values.
508 The editor will be invoked if
509 .Nm
510 detects that standard input is terminal.
511 .It Fl l
512 Lists all available mode pages.
513 .It Fl m Ar mode_page
514 This specifies the number of the mode page the user would like to view
515 and/or edit.
516 This argument is mandatory unless
517 .Fl l
518 is specified.
519 .It Fl P Ar pgctl
520 This allows the user to specify the page control field.
521 Possible values are:
522 .Bl -tag -width xxx -compact
523 .It 0
524 Current values
525 .It 1
526 Changeable values
527 .It 2
528 Default values
529 .It 3
530 Saved values
531 .El
532 .El
533 .It Ic cmd
534 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
535 The
536 .Ic cmd
537 function requires the
538 .Fl c
539 argument to specify SCSI CDB or the
540 .Fl a
541 argument to specify ATA Command Block registers values.
542 Other arguments are optional, depending on
543 the command type.
544 The command and data specification syntax is documented
545 in
546 .Xr cam_cdbparse 3 .
547 NOTE: If the CDB specified causes data to be transfered to or from the
548 SCSI device in question, you MUST specify either
549 .Fl i
550 or
551 .Fl o .
552 .Bl -tag -width 17n
553 .It Fl a Ar cmd Op args
554 This specifies the content of 12 ATA Command Block registers (command,
555 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
556 lba_high_exp, features_exp, sector_count, sector_count_exp).
557 .It Fl c Ar cmd Op args
558 This specifies the SCSI CDB.
559 SCSI CDBs may be 6, 10, 12 or 16 bytes.
560 .It Fl d
561 Specifies DMA protocol to be used for ATA command.
562 .It Fl f
563 Specifies FPDMA (NCQ) protocol to be used for ATA command.
564 .It Fl i Ar len Ar fmt
565 This specifies the amount of data to read, and how it should be displayed.
566 If the format is
567 .Sq - ,
568 .Ar len
569 bytes of data will be read from the device and written to standard output.
570 .It Fl o Ar len Ar fmt Op args
571 This specifies the amount of data to be written to a device, and the data
572 that is to be written.
573 If the format is
574 .Sq - ,
575 .Ar len
576 bytes of data will be read from standard input and written to the device.
577 .It Fl r Ar fmt
578 This specifies that 11 result ATA Command Block registers should be displayed
579 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
580 lba_high_exp, sector_count, sector_count_exp), and how.
581 If the format is
582 .Sq - ,
583 11 result registers will be written to standard output in hex.
584 .El
585 .It Ic debug
586 Turn on CAM debugging printfs in the kernel.
587 This requires options CAMDEBUG
588 in your kernel config file.
589 WARNING: enabling debugging printfs currently
590 causes an EXTREME number of kernel printfs.
591 You may have difficulty
592 turning off the debugging printfs once they start, since the kernel will be
593 busy printing messages and unable to service other requests quickly.
594 The
595 .Ic debug
596 function takes a number of arguments:
597 .Bl -tag -width 18n
598 .It Fl I
599 Enable CAM_DEBUG_INFO printfs.
600 .It Fl P
601 Enable CAM_DEBUG_PERIPH printfs.
602 .It Fl T
603 Enable CAM_DEBUG_TRACE printfs.
604 .It Fl S
605 Enable CAM_DEBUG_SUBTRACE printfs.
606 .It Fl X
607 Enable CAM_DEBUG_XPT printfs.
608 .It Fl c
609 Enable CAM_DEBUG_CDB printfs.
610 This will cause the kernel to print out the
611 SCSI CDBs sent to the specified device(s).
612 .It Fl p
613 Enable CAM_DEBUG_PROBE printfs.
614 .It all
615 Enable debugging for all devices.
616 .It off
617 Turn off debugging for all devices
618 .It bus Ns Op :target Ns Op :lun
619 Turn on debugging for the given bus, target or lun.
620 If the lun or target
621 and lun are not specified, they are wildcarded.
622 (i.e., just specifying a
623 bus turns on debugging printfs for all devices on that bus.)
624 .El
625 .It Ic tags
626 Show or set the number of "tagged openings" or simultaneous transactions
627 we attempt to queue to a particular device.
628 By default, the
629 .Ic tags
630 command, with no command-specific arguments (i.e., only generic arguments)
631 prints out the "soft" maximum number of transactions that can be queued to
632 the device in question.
633 For more detailed information, use the
634 .Fl v
635 argument described below.
636 .Bl -tag -width 7n
637 .It Fl N Ar tags
638 Set the number of tags for the given device.
639 This must be between the
640 minimum and maximum number set in the kernel quirk table.
641 The default for
642 most devices that support tagged queueing is a minimum of 2 and a maximum
643 of 255.
644 The minimum and maximum values for a given device may be
645 determined by using the
646 .Fl v
647 switch.
648 The meaning of the
649 .Fl v
650 switch for this
651 .Nm
652 subcommand is described below.
653 .It Fl q
654 Be quiet, and do not report the number of tags.
655 This is generally used when
656 setting the number of tags.
657 .It Fl v
658 The verbose flag has special functionality for the
659 .Em tags
660 argument.
661 It causes
662 .Nm
663 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
664 .Bl -tag -width 13n
665 .It dev_openings
666 This is the amount of capacity for transactions queued to a given device.
667 .It dev_active
668 This is the number of transactions currently queued to a device.
669 .It devq_openings
670 This is the kernel queue space for transactions.
671 This count usually mirrors
672 dev_openings except during error recovery operations when
673 the device queue is frozen (device is not allowed to receive
674 commands), the number of dev_openings is reduced, or transaction
675 replay is occurring.
676 .It devq_queued
677 This is the number of transactions waiting in the kernel queue for capacity
678 on the device.
679 This number is usually zero unless error recovery is in
680 progress.
681 .It held
682 The held count is the number of CCBs held by peripheral drivers that have
683 either just been completed or are about to be released to the transport
684 layer for service by a device.
685 Held CCBs reserve capacity on a given
686 device.
687 .It mintags
688 This is the current "hard" minimum number of transactions that can be
689 queued to a device at once.
690 The
691 .Ar dev_openings
692 value above cannot go below this number.
693 The default value for
694 .Ar mintags
695 is 2, although it may be set higher or lower for various devices.
696 .It maxtags
697 This is the "hard" maximum number of transactions that can be queued to a
698 device at one time.
699 The
700 .Ar dev_openings
701 value cannot go above this number.
702 The default value for
703 .Ar maxtags
704 is 255, although it may be set higher or lower for various devices.
705 .El
706 .El
707 .It Ic negotiate
708 Show or negotiate various communication parameters.
709 Some controllers may
710 not support setting or changing some of these values.
711 For instance, the
712 Adaptec 174x controllers do not support changing a device's sync rate or
713 offset.
714 The
715 .Nm
716 utility
717 will not attempt to set the parameter if the controller indicates that it
718 does not support setting the parameter.
719 To find out what the controller
720 supports, use the
721 .Fl v
722 flag.
723 The meaning of the
724 .Fl v
725 flag for the
726 .Ic negotiate
727 command is described below.
728 Also, some controller drivers do not support
729 setting negotiation parameters, even if the underlying controller supports
730 negotiation changes.
731 Some controllers, such as the Advansys wide
732 controllers, support enabling and disabling synchronous negotiation for
733 a device, but do not support setting the synchronous negotiation rate.
734 .Bl -tag -width 17n
735 .It Fl a
736 Attempt to make the negotiation settings take effect immediately by sending
737 a Test Unit Ready command to the device.
738 .It Fl c
739 Show or set current negotiation settings.
740 This is the default.
741 .It Fl D Ar enable|disable
742 Enable or disable disconnection.
743 .It Fl M Ar mode
744 Set ATA mode.
745 .It Fl O Ar offset
746 Set the command delay offset.
747 .It Fl q
748 Be quiet, do not print anything.
749 This is generally useful when you want to
750 set a parameter, but do not want any status information.
751 .It Fl R Ar syncrate
752 Change the synchronization rate for a device.
753 The sync rate is a floating
754 point value specified in MHz.
755 So, for instance,
756 .Sq 20.000
757 is a legal value, as is
758 .Sq 20 .
759 .It Fl T Ar enable|disable
760 Enable or disable tagged queueing for a device.
761 .It Fl U
762 Show or set user negotiation settings.
763 The default is to show or set
764 current negotiation settings.
765 .It Fl v
766 The verbose switch has special meaning for the
767 .Ic negotiate
768 subcommand.
769 It causes
770 .Nm
771 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
772 controller driver.
773 .It Fl W Ar bus_width
774 Specify the bus width to negotiate with a device.
775 The bus width is
776 specified in bits.
777 The only useful values to specify are 8, 16, and 32
778 bits.
779 The controller must support the bus width in question in order for
780 the setting to take effect.
781 .El
782 .Pp
783 In general, sync rate and offset settings will not take effect for a
784 device until a command has been sent to the device.
785 The
786 .Fl a
787 switch above will automatically send a Test Unit Ready to the device so
788 negotiation parameters will take effect.
789 .It Ic format
790 Issue the
791 .Tn SCSI
792 FORMAT UNIT command to the named device.
793 .Pp
794 .Em WARNING! WARNING! WARNING!
795 .Pp
796 Low level formatting a disk will destroy ALL data on the disk.
797 Use
798 extreme caution when issuing this command.
799 Many users low-level format
800 disks that do not really need to be low-level formatted.
801 There are
802 relatively few scenarios that call for low-level formatting a disk.
803 One reason for
804 low-level formatting a disk is to initialize the disk after changing
805 its physical sector size.
806 Another reason for low-level formatting a disk
807 is to revive the disk if you are getting "medium format corrupted" errors
808 from the disk in response to read and write requests.
809 .Pp
810 Some disks take longer than others to format.
811 Users should specify a
812 timeout long enough to allow the format to complete.
813 The default format
814 timeout is 3 hours, which should be long enough for most disks.
815 Some hard
816 disks will complete a format operation in a very short period of time
817 (on the order of 5 minutes or less).
818 This is often because the drive
819 does not really support the FORMAT UNIT command -- it just accepts the
820 command, waits a few minutes and then returns it.
821 .Pp
822 The
823 .Sq format
824 subcommand takes several arguments that modify its default behavior.
825 The
826 .Fl q
827 and
828 .Fl y
829 arguments can be useful for scripts.
830 .Pp
831 .Bl -tag -width 6n
832 .It Fl q
833 Be quiet, do not print any status messages.
834 This option will not disable
835 the questions, however.
836 To disable questions, use the
837 .Fl y
838 argument, below.
839 .It Fl r
840 Run in
841 .Dq report only
842 mode.
843 This will report status on a format that is already running on the drive.
844 .It Fl w
845 Issue a non-immediate format command.
846 By default,
847 .Nm
848 issues the FORMAT UNIT command with the immediate bit set.
849 This tells the
850 device to immediately return the format command, before the format has
851 actually completed.
852 Then,
853 .Nm
854 gathers
855 .Tn SCSI
856 sense information from the device every second to determine how far along
857 in the format process it is.
858 If the
859 .Fl w
860 argument is specified,
861 .Nm
862 will issue a non-immediate format command, and will be unable to print any
863 information to let the user know what percentage of the disk has been
864 formatted.
865 .It Fl y
866 Do not ask any questions.
867 By default,
868 .Nm
869 will ask the user if he/she really wants to format the disk in question,
870 and also if the default format command timeout is acceptable.
871 The user
872 will not be asked about the timeout if a timeout is specified on the
873 command line.
874 .El
875 .It Ic idle
876 Put ATA device into IDLE state. Optional parameter
877 .Pq Fl t
878 specifies automatic standby timer value in seconds. Value 0 disables timer.
879 .It Ic standby
880 Put ATA device into STANDBY state. Optional parameter
881 .Pq Fl t
882 specifies automatic standby timer value in seconds. Value 0 disables timer.
883 .It Ic sleep
884 Put ATA device into SLEEP state. Note that the only way get device out of
885 this state may be reset.
886 .It Ic security
887 Update or report security settings, using an ATA identify command (0xec).
888 By default,
889 .Nm
890 will print out the security support and associated settings of the device.
891 The
892 .Ic security
893 command takes several arguments:
894 .Bl -tag -width 0n
895 .It Fl d Ar pwd
896 .Pp
897 Disable device security using the given password for the selected user according
898 to the devices configured security level.
899 .It Fl e Ar pwd
900 .Pp
901 Erase the device using the given password for the selected user.
902 .Pp
903 .Em WARNING! WARNING! WARNING!
904 .Pp
905 Issuing a secure erase will
906 .Em ERASE ALL
907 user data on the device and may take several hours to complete.
908 .Pp
909 When this command is used against an SSD drive all its cells will be marked as
910 empty, restoring it to factory default write performance. For SSD's this action
911 usually takes just a few seconds.
912 .It Fl f
913 .Pp
914 Freeze the security configuration of the specified device.
915 .Pp
916 After command completion any other commands that update the device lock mode
917 shall be command aborted. Frozen mode is disabled by power-off or hardware reset. 
918 .It Fl h Ar pwd
919 .Pp
920 Enhanced erase the device using the given password for the selected user.
921 .Pp
922 .Em WARNING! WARNING! WARNING!
923 .Pp
924 Issuing an enhanced secure erase will 
925 .Em ERASE ALL
926 user data on the device and may take several hours to complete.
927 .Pp
928 An enhanced erase writes predetermined data patterns to all user data areas,
929 all previously written user data shall be overwritten, including sectors that
930 are no longer in use due to reallocation.
931 .It Fl k Ar pwd
932 .Pp
933 Unlock the device using the given password for the selected user according to
934 the devices configured security level.
935 .It Fl l Ar high|maximum
936 .Pp
937 Specifies which security level to set when issuing a
938 .Fl s Ar pwd
939 command. The security level determines device behavior when the master
940 password is used to unlock the device. When the security level is set to high
941 the device requires the unlock command and the master password to unlock.
942 When the security level is set to maximum the device requires a secure erase
943 with the master password to unlock.
944 .Pp
945 This option must be used in conjunction with one of the security action commands.
946 .Pp
947 Defaults to
948 .Em high
949 .It Fl q
950 .Pp
951 Be quiet, do not print any status messages.
952 This option will not disable the questions, however.
953 To disable questions, use the
954 .Fl y
955 argument, below.
956 .It Fl s Ar pwd
957 .Pp
958 Password the device (enable security) using the given password for the selected
959 user. This option can be combined with other options such as
960 .Fl e Em pwd
961 .Pp
962 A master password may be set in a addition to the user password. The purpose of
963 the master password is to allow an administrator to establish a password that
964 is kept secret from the user, and which may be used to unlock the device if the
965 user password is lost.
966 .Pp
967 .Em Note:
968 Setting the master password does not enable device security.
969 .Pp
970 If the master password is set and the drive supports a Master Revision Code
971 feature the Master Password Revision Code will be decremented.
972 .It Fl T Ar timeout
973 .Pp
974 Overrides the default timeout, specified in seconds, used for both
975 .Fl e
976 and
977 .Fl h
978 this is useful if your system has problems processing long timeouts correctly.
979 .Pp
980 Usually the timeout is calculated from the information stored on the drive if
981 present, otherwise it defaults to 2 hours.
982 .It Fl U Ar user|master
983 .Pp
984 Specifies which user to set / use for the running action command, valid values
985 are user or master and defaults to master if not set.
986 .Pp
987 This option must be used in conjunction with one of the security action commands.
988 .Pp
989 Defaults to
990 .Em master
991 .It Fl y
992 .Pp
993 Confirm yes to dangerous options such as
994 .Fl e
995 without prompting for confirmation.
996 .Pp
997 .El
998 If the password specified for any action commands doesn't match the configured
999 password for the specified user the command will fail.
1000 .Pp
1001 The password in all cases is limited to 32 characters, longer passwords will
1002 fail.
1003 .It Ic hpa
1004 Update or report Host Protected Area details.
1005 By default
1006 .Nm
1007 will print out the HPA support and associated settings of the device.
1008 The
1009 .Ic hpa
1010 command takes several optional arguments:
1011 .Bl -tag -width 0n
1012 .It Fl f
1013 .Pp
1014 Freeze the HPA configuration of the specified device.
1015 .Pp
1016 After command completion any other commands that update the HPA configuration
1017 shall be command aborted.
1018 Frozen mode is disabled by power-off or hardware reset.
1019 .It Fl l
1020 .Pp
1021 Lock the HPA configuration of the device until a successful call to unlock or
1022 the next power-on reset occurs.
1023 .It Fl P
1024 .Pp
1025 Make the HPA max sectors persist across power-on reset or a hardware reset.
1026 This must be used in combination with
1027 .Fl s Ar max_sectors
1028 .
1029 .It Fl p Ar pwd
1030 .Pp
1031 Set the HPA configuration password required for unlock calls.
1032 .It Fl q
1033 .Pp
1034 Be quiet, do not print any status messages.
1035 This option will not disable the questions.
1036 To disable questions, use the
1037 .Fl y
1038 argument, below.
1039 .It Fl s Ar max_sectors
1040 .Pp
1041 Configures the maximum user accessible sectors of the device.
1042 This will change the number of sectors the device reports.
1043 .Pp
1044 .Em WARNING! WARNING! WARNING!
1045 .Pp
1046 Changing the max sectors of a device using this option will make the data on
1047 the device beyond the specified value inaccessible.
1048 .Pp
1049 Only one successful
1050 .Fl s Ar max_sectors
1051 call can be made without a power-on reset or a hardware reset of the device.
1052 .It Fl U Ar pwd
1053 .Pp
1054 Unlock the HPA configuration of the specified device using the given password.
1055 If the password specified doesn't match the password configured via
1056 .Fl p Ar pwd
1057 the command will fail.
1058 .Pp
1059 After 5 failed unlock calls, due to password miss-match, the device will refuse
1060 additional unlock calls until after a power-on reset.
1061 .It Fl y
1062 .Pp
1063 Confirm yes to dangerous options such as
1064 .Fl e
1065 without prompting for confirmation
1066 .Pp
1067 .El
1068 The password for all HPA commands is limited to 32 characters, longer passwords
1069 will fail.
1070 .It Ic help
1071 Print out verbose usage information.
1072 .El
1073 .Sh ENVIRONMENT
1074 The
1075 .Ev SCSI_MODES
1076 variable allows the user to specify an alternate mode page format file.
1077 .Pp
1078 The
1079 .Ev EDITOR
1080 variable determines which text editor
1081 .Nm
1082 starts when editing mode pages.
1083 .Sh FILES
1084 .Bl -tag -width /usr/share/misc/scsi_modes -compact
1085 .It Pa /usr/share/misc/scsi_modes
1086 is the SCSI mode format database.
1087 .It Pa /dev/xpt0
1088 is the transport layer device.
1089 .It Pa /dev/pass*
1090 are the CAM application passthrough devices.
1091 .El
1092 .Sh EXAMPLES
1093 .Dl camcontrol eject -n cd -u 1 -v
1094 .Pp
1095 Eject the CD from cd1, and print SCSI sense information if the command
1096 fails.
1097 .Pp
1098 .Dl camcontrol tur da0
1099 .Pp
1100 Send the SCSI test unit ready command to da0.
1101 The
1102 .Nm
1103 utility will report whether the disk is ready, but will not display sense
1104 information if the command fails since the
1105 .Fl v
1106 switch was not specified.
1107 .Pp
1108 .Bd -literal -offset indent
1109 camcontrol tur da1 -E -C 4 -t 50 -v
1110 .Ed
1111 .Pp
1112 Send a test unit ready command to da1.
1113 Enable kernel error recovery.
1114 Specify a retry count of 4, and a timeout of 50 seconds.
1115 Enable sense
1116 printing (with the
1117 .Fl v
1118 flag) if the command fails.
1119 Since error recovery is turned on, the
1120 disk will be spun up if it is not currently spinning.
1121 The
1122 .Nm
1123 utility will report whether the disk is ready.
1124 .Bd -literal -offset indent
1125 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
1126         -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
1127 .Ed
1128 .Pp
1129 Issue a READ BUFFER command (0x3C) to cd1.
1130 Display the buffer size of cd1,
1131 and display the first 10 bytes from the cache on cd1.
1132 Display SCSI sense
1133 information if the command fails.
1134 .Pp
1135 .Bd -literal -offset indent
1136 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
1137         -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
1138 .Ed
1139 .Pp
1140 Issue a WRITE BUFFER (0x3B) command to cd1.
1141 Write out 10 bytes of data,
1142 not including the (reserved) 4 byte header.
1143 Print out sense information if
1144 the command fails.
1145 Be very careful with this command, improper use may
1146 cause data corruption.
1147 .Pp
1148 .Bd -literal -offset indent
1149 camcontrol modepage da3 -m 1 -e -P 3
1150 .Ed
1151 .Pp
1152 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
1153 settings on the drive.
1154 Mode page 1 contains a disk drive's auto read and
1155 write reallocation settings, among other things.
1156 .Pp
1157 .Dl camcontrol rescan all
1158 .Pp
1159 Rescan all SCSI busses in the system for devices that have been added,
1160 removed or changed.
1161 .Pp
1162 .Dl camcontrol rescan 0
1163 .Pp
1164 Rescan SCSI bus 0 for devices that have been added, removed or changed.
1165 .Pp
1166 .Dl camcontrol rescan 0:1:0
1167 .Pp
1168 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
1169 changed.
1170 .Pp
1171 .Dl camcontrol tags da5 -N 24
1172 .Pp
1173 Set the number of concurrent transactions for da5 to 24.
1174 .Pp
1175 .Bd -literal -offset indent
1176 camcontrol negotiate -n da -u 4 -T disable
1177 .Ed
1178 .Pp
1179 Disable tagged queueing for da4.
1180 .Pp
1181 .Bd -literal -offset indent
1182 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
1183 .Ed
1184 .Pp
1185 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
1186 Then send a
1187 Test Unit Ready command to make the settings take effect.
1188 .Bd -literal -offset indent
1189 camcontrol security ada0
1190 .Ed
1191 .Pp
1192 Report security support and settings for ada0
1193 .Bd -literal -offset indent
1194 camcontrol security ada0 -u user -s MyPass 
1195 .Ed
1196 .Pp
1197 Enable security on device ada0 with the password MyPass
1198 .Bd -literal -offset indent
1199 camcontrol security ada0 -u user -e MyPass
1200 .Ed
1201 .Pp
1202 Secure erase ada0 which has had security enabled with user password MyPass
1203 .Pp
1204 .Em WARNING! WARNING! WARNING!
1205 .Pp
1206 This will
1207 .Em ERASE ALL
1208 data from the device, so backup your data before using!
1209 .Pp
1210 This command can be used used against an SSD drive to restoring it to
1211 factory default write performance.
1212 .Bd -literal -offset indent
1213 camcontrol hpa ada0
1214 .Ed
1215 .Pp
1216 Report HPA support and settings for ada0 (also reported via
1217 identify).
1218 .Bd -literal -offset indent
1219 camcontrol hpa ada0 -s 10240
1220 .Ed
1221 .Pp
1222 Enables HPA on ada0 setting the maximum reported sectors to 10240.
1223 .Pp
1224 .Em WARNING! WARNING! WARNING!
1225 .Pp
1226 This will
1227 .Em PREVENT ACCESS
1228 to all data on the device beyond this limit until HPA is disabled by setting
1229 HPA to native max sectors of the device, which can only be done after a
1230 power-on or hardware reset!
1231 .Pp
1232 .Em DO NOT
1233 use this on a device which has an active filesystem!
1234 .Sh SEE ALSO
1235 .Xr cam 3 ,
1236 .Xr cam_cdbparse 3 ,
1237 .Xr cam 4 ,
1238 .Xr pass 4 ,
1239 .Xr xpt 4
1240 .Sh HISTORY
1241 The
1242 .Nm
1243 utility first appeared in
1244 .Fx 3.0 .
1245 .Pp
1246 The mode page editing code and arbitrary SCSI command code are based upon
1247 code in the old
1248 .Xr scsi 8
1249 utility and
1250 .Xr scsi 3
1251 library, written by Julian Elischer and Peter Dufault.
1252 The
1253 .Xr scsi 8
1254 program first appeared in
1255 .Bx 386 0.1.2.4 ,
1256 and first appeared in
1257 .Fx
1258 in
1259 .Fx 2.0.5 .
1260 .Sh AUTHORS
1261 .An Kenneth Merry Aq ken@FreeBSD.org
1262 .Sh BUGS
1263 The code that parses the generic command line arguments does not know that
1264 some of the subcommands take multiple arguments.
1265 So if, for instance, you
1266 tried something like this:
1267 .Bd -literal -offset indent
1268 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
1269 .Ed
1270 .Pp
1271 The sense information from the test unit ready command would not get
1272 printed out, since the first
1273 .Xr getopt 3
1274 call in
1275 .Nm
1276 bails out when it sees the second argument to
1277 .Fl c
1278 (0x00),
1279 above.
1280 Fixing this behavior would take some gross code, or changes to the
1281 .Xr getopt 3
1282 interface.
1283 The best way to circumvent this problem is to always make sure
1284 to specify generic
1285 .Nm
1286 arguments before any command-specific arguments.