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