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