xref: /freebsd/sbin/camcontrol/camcontrol.8 (revision 3157ba21)
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 May 2, 2010
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.Aq all|off|bus Ns Op :target Ns Op :lun
142.Nm
143.Ic tags
144.Op device id
145.Op generic args
146.Op Fl N Ar tags
147.Op Fl q
148.Op Fl v
149.Nm
150.Ic negotiate
151.Op device id
152.Op generic args
153.Op Fl c
154.Op Fl D Ar enable|disable
155.Op Fl M Ar mode
156.Op Fl O Ar offset
157.Op Fl q
158.Op Fl R Ar syncrate
159.Op Fl T Ar enable|disable
160.Op Fl U
161.Op Fl W Ar bus_width
162.Op Fl v
163.Nm
164.Ic format
165.Op device id
166.Op generic args
167.Op Fl q
168.Op Fl r
169.Op Fl w
170.Op Fl y
171.Nm
172.Ic idle
173.Op device id
174.Op generic args
175.Op Fl t Ar time
176.Nm
177.Ic standby
178.Op device id
179.Op generic args
180.Op Fl t Ar time
181.Nm
182.Ic sleep
183.Op device id
184.Op generic args
185.Nm
186.Ic help
187.Sh DESCRIPTION
188The
189.Nm
190utility is designed to provide a way for users to access and control the
191.Fx
192CAM subsystem.
193.Pp
194The
195.Nm
196utility
197can cause a loss of data and/or system crashes if used improperly.
198Even
199expert users are encouraged to exercise caution when using this command.
200Novice users should stay away from this utility.
201.Pp
202The
203.Nm
204utility has a number of primary functions, many of which support an optional
205device identifier.
206A device identifier can take one of three forms:
207.Bl -tag -width 14n
208.It deviceUNIT
209Specify a device name and unit number combination, like "da5" or "cd3".
210Note that character device node names (e.g.\& /dev/da0) are
211.Em not
212allowed here.
213.It bus:target
214Specify a bus number and target id.
215The bus number can be determined from
216the output of
217.Dq camcontrol devlist .
218The lun defaults to 0.
219.It bus:target:lun
220Specify the bus, target and lun for a device.
221(e.g.\& 1:2:0)
222.El
223.Pp
224The device identifier, if it is specified,
225.Em must
226come immediately after the function name, and before any generic or
227function-specific arguments.
228Note that the
229.Fl n
230and
231.Fl u
232arguments described below will override any device name or unit number
233specified beforehand.
234The
235.Fl n
236and
237.Fl u
238arguments will
239.Em not
240override a specified bus:target or bus:target:lun, however.
241.Pp
242Most of the
243.Nm
244primary functions support these generic arguments:
245.Bl -tag -width 14n
246.It Fl C Ar count
247SCSI command retry count.
248In order for this to work, error recovery
249.Pq Fl E
250must be turned on.
251.It Fl E
252Instruct the kernel to perform generic SCSI error recovery for the given
253command.
254This is needed in order for the retry count
255.Pq Fl C
256to be honored.
257Other than retrying commands, the generic error recovery in
258the code will generally attempt to spin up drives that are not spinning.
259It may take some other actions, depending upon the sense code returned from
260the command.
261.It Fl n Ar dev_name
262Specify the device type to operate on, e.g.\& "da", "cd".
263.It Fl t Ar timeout
264SCSI command timeout in seconds.
265This overrides the default timeout for
266any given command.
267.It Fl u Ar unit_number
268Specify the device unit number, e.g.\& "1", "5".
269.It Fl v
270Be verbose, print out sense information for failed SCSI commands.
271.El
272.Pp
273Primary command functions:
274.Bl -tag -width periphlist
275.It Ic devlist
276List all physical devices (logical units) attached to the CAM subsystem.
277This also includes a list of peripheral drivers attached to each device.
278With the
279.Fl v
280argument, SCSI bus number, adapter name and unit numbers are printed as
281well.
282.It Ic periphlist
283List all peripheral drivers attached to a given physical device (logical
284unit).
285.It Ic tur
286Send the SCSI test unit ready (0x00) command to the given device.
287The
288.Nm
289utility will report whether the device is ready or not.
290.It Ic inquiry
291Send a SCSI inquiry command (0x12) to a device.
292By default,
293.Nm
294will print out the standard inquiry data, device serial number, and
295transfer rate information.
296The user can specify that only certain types of
297inquiry data be printed:
298.Bl -tag -width 4n
299.It Fl D
300Get the standard inquiry data.
301.It Fl S
302Print out the serial number.
303If this flag is the only one specified,
304.Nm
305will not print out "Serial Number" before the value returned by the drive.
306This is to aid in script writing.
307.It Fl R
308Print out transfer rate information.
309.El
310.It Ic identify
311Send a ATA identify command (0xec) to a device.
312.It Ic reportluns
313Send the SCSI REPORT LUNS (0xA0) command to the given device.
314By default,
315.Nm
316will print out the list of logical units (LUNs) supported by the target device.
317There are a couple of options to modify the output:
318.Bl -tag -width 14n
319.It Fl c
320Just print out a count of LUNs, not the actual LUN numbers.
321.It Fl l
322Just print out the LUNs, and don't print out the count.
323.It Fl r Ar reporttype
324Specify the type of report to request from the target:
325.Bl -tag -width 012345678
326.It default
327Return the default report.
328This is the
329.Nm
330default.
331Most targets will support this report if they support the REPORT LUNS
332command.
333.It wellknown
334Return only well known LUNs.
335.It all
336Return all available LUNs.
337.El
338.El
339.Pp
340.Nm
341will try to print out LUN numbers in a reasonable format.
342It can understand the peripheral, flat, LUN and extended LUN formats.
343.It Ic readcap
344Send the SCSI READ CAPACITY command to the given device and display
345the results.
346If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
347action will be sent to obtain the full size of the device.
348By default,
349.Nm
350will print out the last logical block of the device, and the blocksize of
351the device in bytes.
352To modify the output format, use the following options:
353.Bl -tag -width 5n
354.It Fl b
355Just print out the blocksize, not the last block or device size.
356This cannot be used with
357.Fl N
358or
359.Fl s .
360.It Fl h
361Print out the device size in human readable (base 2, 1K == 1024) format.
362This implies
363.Fl N
364and cannot be used with
365.Fl q
366or
367.Fl b .
368.It Fl H
369Print out the device size in human readable (base 10, 1K == 1000) format.
370.It Fl N
371Print out the number of blocks in the device instead of the last logical
372block.
373.It Fl q
374Quiet, print out the numbers only (separated by a comma if
375.Fl b
376or
377.Fl s
378are not specified).
379.It Fl s
380Print out the last logical block or the size of the device only, and omit
381the blocksize.
382.El
383.It Ic start
384Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
385start bit set.
386.It Ic stop
387Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
388start bit cleared.
389.It Ic load
390Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
391start bit set and the load/eject bit set.
392.It Ic eject
393Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
394start bit cleared and the load/eject bit set.
395.It Ic rescan
396Tell the kernel to scan all busses in the system (with the
397.Ar all
398argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
399(XPT_SCAN_LUN) for new devices or devices that have gone away.
400The user
401may specify a scan of all busses, a single bus, or a lun.
402Scanning all luns
403on a target is not supported.
404.It Ic reset
405Tell the kernel to reset all busses in the system (with the
406.Ar all
407argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
408reset for that bus, or to reset the given bus:target:lun
409(XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
410connecting to that device.
411Note that this can have a destructive impact
412on the system.
413.It Ic defects
414Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and
415print out any combination of: the total number of defects, the primary
416defect list (PLIST), and the grown defect list (GLIST).
417.Bl -tag -width 11n
418.It Fl f Ar format
419The three format options are:
420.Em block ,
421to print out the list as logical blocks,
422.Em bfi ,
423to print out the list in bytes from index format, and
424.Em phys ,
425to print out the list in physical sector format.
426The format argument is
427required.
428Most drives support the physical sector format.
429Some drives
430support the logical block format.
431Many drives, if they do not support the
432requested format, return the data in an alternate format, along with sense
433information indicating that the requested data format is not supported.
434The
435.Nm
436utility
437attempts to detect this, and print out whatever format the drive returns.
438If the drive uses a non-standard sense code to report that it does not
439support the requested format,
440.Nm
441will probably see the error as a failure to complete the request.
442.It Fl G
443Print out the grown defect list.
444This is a list of bad blocks that have
445been remapped since the disk left the factory.
446.It Fl P
447Print out the primary defect list.
448.El
449.Pp
450If neither
451.Fl P
452nor
453.Fl G
454is specified,
455.Nm
456will print out the number of defects given in the READ DEFECT DATA header
457returned from the drive.
458.It Ic modepage
459Allows the user to display and optionally edit a SCSI mode page.
460The mode
461page formats are located in
462.Pa /usr/share/misc/scsi_modes .
463This can be overridden by specifying a different file in the
464.Ev SCSI_MODES
465environment variable.
466The
467.Ic modepage
468command takes several arguments:
469.Bl -tag -width 12n
470.It Fl d
471Disable block descriptors for mode sense.
472.It Fl b
473Displays mode page data in binary format.
474.It Fl e
475This flag allows the user to edit values in the mode page.
476The user may
477either edit mode page values with the text editor pointed to by his
478.Ev EDITOR
479environment variable, or supply mode page values via standard input, using
480the same format that
481.Nm
482uses to display mode page values.
483The editor will be invoked if
484.Nm
485detects that standard input is terminal.
486.It Fl l
487Lists all available mode pages.
488.It Fl m Ar mode_page
489This specifies the number of the mode page the user would like to view
490and/or edit.
491This argument is mandatory unless
492.Fl l
493is specified.
494.It Fl P Ar pgctl
495This allows the user to specify the page control field.
496Possible values are:
497.Bl -tag -width xxx -compact
498.It 0
499Current values
500.It 1
501Changeable values
502.It 2
503Default values
504.It 3
505Saved values
506.El
507.El
508.It Ic cmd
509Allows the user to send an arbitrary ATA or SCSI CDB to any device.
510The
511.Ic cmd
512function requires the
513.Fl c
514argument to specify SCSI CDB or the
515.Fl a
516argument to specify ATA Command Block registers values.
517Other arguments are optional, depending on
518the command type.
519The command and data specification syntax is documented
520in
521.Xr cam_cdbparse 3 .
522NOTE: If the CDB specified causes data to be transfered to or from the
523SCSI device in question, you MUST specify either
524.Fl i
525or
526.Fl o .
527.Bl -tag -width 17n
528.It Fl a Ar cmd Op args
529This specifies the content of 12 ATA Command Block registers (command,
530features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
531lba_high_exp, features_exp, sector_count, sector_count_exp).
532.It Fl c Ar cmd Op args
533This specifies the SCSI CDB.
534SCSI CDBs may be 6, 10, 12 or 16 bytes.
535.It Fl d
536Specifies DMA protocol to be used for ATA command.
537.It Fl f
538Specifies FPDMA (NCQ) protocol to be used for ATA command.
539.It Fl i Ar len Ar fmt
540This specifies the amount of data to read, and how it should be displayed.
541If the format is
542.Sq - ,
543.Ar len
544bytes of data will be read from the device and written to standard output.
545.It Fl o Ar len Ar fmt Op args
546This specifies the amount of data to be written to a device, and the data
547that is to be written.
548If the format is
549.Sq - ,
550.Ar len
551bytes of data will be read from standard input and written to the device.
552.It Fl r Ar fmt
553This specifies that 11 result ATA Command Block registers should be displayed
554(status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
555lba_high_exp, sector_count, sector_count_exp), and how.
556If the format is
557.Sq - ,
55811 result registers will be written to standard output in hex.
559.El
560.It Ic debug
561Turn on CAM debugging printfs in the kernel.
562This requires options CAMDEBUG
563in your kernel config file.
564WARNING: enabling debugging printfs currently
565causes an EXTREME number of kernel printfs.
566You may have difficulty
567turning off the debugging printfs once they start, since the kernel will be
568busy printing messages and unable to service other requests quickly.
569The
570.Ic debug
571function takes a number of arguments:
572.Bl -tag -width 18n
573.It Fl I
574Enable CAM_DEBUG_INFO printfs.
575.It Fl P
576Enable CAM_DEBUG_PERIPH printfs.
577.It Fl T
578Enable CAM_DEBUG_TRACE printfs.
579.It Fl S
580Enable CAM_DEBUG_SUBTRACE printfs.
581.It Fl X
582Enable CAM_DEBUG_XPT printfs.
583.It Fl c
584Enable CAM_DEBUG_CDB printfs.
585This will cause the kernel to print out the
586SCSI CDBs sent to the specified device(s).
587.It all
588Enable debugging for all devices.
589.It off
590Turn off debugging for all devices
591.It bus Ns Op :target Ns Op :lun
592Turn on debugging for the given bus, target or lun.
593If the lun or target
594and lun are not specified, they are wildcarded.
595(i.e., just specifying a
596bus turns on debugging printfs for all devices on that bus.)
597.El
598.It Ic tags
599Show or set the number of "tagged openings" or simultaneous transactions
600we attempt to queue to a particular device.
601By default, the
602.Ic tags
603command, with no command-specific arguments (i.e., only generic arguments)
604prints out the "soft" maximum number of transactions that can be queued to
605the device in question.
606For more detailed information, use the
607.Fl v
608argument described below.
609.Bl -tag -width 7n
610.It Fl N Ar tags
611Set the number of tags for the given device.
612This must be between the
613minimum and maximum number set in the kernel quirk table.
614The default for
615most devices that support tagged queueing is a minimum of 2 and a maximum
616of 255.
617The minimum and maximum values for a given device may be
618determined by using the
619.Fl v
620switch.
621The meaning of the
622.Fl v
623switch for this
624.Nm
625subcommand is described below.
626.It Fl q
627Be quiet, and do not report the number of tags.
628This is generally used when
629setting the number of tags.
630.It Fl v
631The verbose flag has special functionality for the
632.Em tags
633argument.
634It causes
635.Nm
636to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
637.Bl -tag -width 13n
638.It dev_openings
639This is the amount of capacity for transactions queued to a given device.
640.It dev_active
641This is the number of transactions currently queued to a device.
642.It devq_openings
643This is the kernel queue space for transactions.
644This count usually mirrors
645dev_openings except during error recovery operations when
646the device queue is frozen (device is not allowed to receive
647commands), the number of dev_openings is reduced, or transaction
648replay is occurring.
649.It devq_queued
650This is the number of transactions waiting in the kernel queue for capacity
651on the device.
652This number is usually zero unless error recovery is in
653progress.
654.It held
655The held count is the number of CCBs held by peripheral drivers that have
656either just been completed or are about to be released to the transport
657layer for service by a device.
658Held CCBs reserve capacity on a given
659device.
660.It mintags
661This is the current "hard" minimum number of transactions that can be
662queued to a device at once.
663The
664.Ar dev_openings
665value above cannot go below this number.
666The default value for
667.Ar mintags
668is 2, although it may be set higher or lower for various devices.
669.It maxtags
670This is the "hard" maximum number of transactions that can be queued to a
671device at one time.
672The
673.Ar dev_openings
674value cannot go above this number.
675The default value for
676.Ar maxtags
677is 255, although it may be set higher or lower for various devices.
678.El
679.El
680.It Ic negotiate
681Show or negotiate various communication parameters.
682Some controllers may
683not support setting or changing some of these values.
684For instance, the
685Adaptec 174x controllers do not support changing a device's sync rate or
686offset.
687The
688.Nm
689utility
690will not attempt to set the parameter if the controller indicates that it
691does not support setting the parameter.
692To find out what the controller
693supports, use the
694.Fl v
695flag.
696The meaning of the
697.Fl v
698flag for the
699.Ic negotiate
700command is described below.
701Also, some controller drivers do not support
702setting negotiation parameters, even if the underlying controller supports
703negotiation changes.
704Some controllers, such as the Advansys wide
705controllers, support enabling and disabling synchronous negotiation for
706a device, but do not support setting the synchronous negotiation rate.
707.Bl -tag -width 17n
708.It Fl a
709Attempt to make the negotiation settings take effect immediately by sending
710a Test Unit Ready command to the device.
711.It Fl c
712Show or set current negotiation settings.
713This is the default.
714.It Fl D Ar enable|disable
715Enable or disable disconnection.
716.It Fl M Ar mode
717Set ATA mode.
718.It Fl O Ar offset
719Set the command delay offset.
720.It Fl q
721Be quiet, do not print anything.
722This is generally useful when you want to
723set a parameter, but do not want any status information.
724.It Fl R Ar syncrate
725Change the synchronization rate for a device.
726The sync rate is a floating
727point value specified in MHz.
728So, for instance,
729.Sq 20.000
730is a legal value, as is
731.Sq 20 .
732.It Fl T Ar enable|disable
733Enable or disable tagged queueing for a device.
734.It Fl U
735Show or set user negotiation settings.
736The default is to show or set
737current negotiation settings.
738.It Fl v
739The verbose switch has special meaning for the
740.Ic negotiate
741subcommand.
742It causes
743.Nm
744to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
745controller driver.
746.It Fl W Ar bus_width
747Specify the bus width to negotiate with a device.
748The bus width is
749specified in bits.
750The only useful values to specify are 8, 16, and 32
751bits.
752The controller must support the bus width in question in order for
753the setting to take effect.
754.El
755.Pp
756In general, sync rate and offset settings will not take effect for a
757device until a command has been sent to the device.
758The
759.Fl a
760switch above will automatically send a Test Unit Ready to the device so
761negotiation parameters will take effect.
762.It Ic format
763Issue the
764.Tn SCSI
765FORMAT UNIT command to the named device.
766.Pp
767.Em WARNING! WARNING! WARNING!
768.Pp
769Low level formatting a disk will destroy ALL data on the disk.
770Use
771extreme caution when issuing this command.
772Many users low-level format
773disks that do not really need to be low-level formatted.
774There are
775relatively few scenarios that call for low-level formatting a disk.
776One reason for
777low-level formatting a disk is to initialize the disk after changing
778its physical sector size.
779Another reason for low-level formatting a disk
780is to revive the disk if you are getting "medium format corrupted" errors
781from the disk in response to read and write requests.
782.Pp
783Some disks take longer than others to format.
784Users should specify a
785timeout long enough to allow the format to complete.
786The default format
787timeout is 3 hours, which should be long enough for most disks.
788Some hard
789disks will complete a format operation in a very short period of time
790(on the order of 5 minutes or less).
791This is often because the drive
792does not really support the FORMAT UNIT command -- it just accepts the
793command, waits a few minutes and then returns it.
794.Pp
795The
796.Sq format
797subcommand takes several arguments that modify its default behavior.
798The
799.Fl q
800and
801.Fl y
802arguments can be useful for scripts.
803.Pp
804.Bl -tag -width 6n
805.It Fl q
806Be quiet, do not print any status messages.
807This option will not disable
808the questions, however.
809To disable questions, use the
810.Fl y
811argument, below.
812.It Fl r
813Run in
814.Dq report only
815mode.
816This will report status on a format that is already running on the drive.
817.It Fl w
818Issue a non-immediate format command.
819By default,
820.Nm
821issues the FORMAT UNIT command with the immediate bit set.
822This tells the
823device to immediately return the format command, before the format has
824actually completed.
825Then,
826.Nm
827gathers
828.Tn SCSI
829sense information from the device every second to determine how far along
830in the format process it is.
831If the
832.Fl w
833argument is specified,
834.Nm
835will issue a non-immediate format command, and will be unable to print any
836information to let the user know what percentage of the disk has been
837formatted.
838.It Fl y
839Do not ask any questions.
840By default,
841.Nm
842will ask the user if he/she really wants to format the disk in question,
843and also if the default format command timeout is acceptable.
844The user
845will not be asked about the timeout if a timeout is specified on the
846command line.
847.El
848.It Ic idle
849Put ATA device into IDLE state. Optional parameter specifies automatic
850idle timer value in seconds.
851.It Ic standby
852Put ATA device into STANDBY state. Optional parameter specifies automatic
853standby timer value in seconds.
854.It Ic sleep
855Put ATA device into SLEEP state. Note that the only way get device out of
856this state may be reset.
857.It Ic help
858Print out verbose usage information.
859.El
860.Sh ENVIRONMENT
861The
862.Ev SCSI_MODES
863variable allows the user to specify an alternate mode page format file.
864.Pp
865The
866.Ev EDITOR
867variable determines which text editor
868.Nm
869starts when editing mode pages.
870.Sh FILES
871.Bl -tag -width /usr/share/misc/scsi_modes -compact
872.It Pa /usr/share/misc/scsi_modes
873is the SCSI mode format database.
874.It Pa /dev/xpt0
875is the transport layer device.
876.It Pa /dev/pass*
877are the CAM application passthrough devices.
878.El
879.Sh EXAMPLES
880.Dl camcontrol eject -n cd -u 1 -v
881.Pp
882Eject the CD from cd1, and print SCSI sense information if the command
883fails.
884.Pp
885.Dl camcontrol tur da0
886.Pp
887Send the SCSI test unit ready command to da0.
888The
889.Nm
890utility will report whether the disk is ready, but will not display sense
891information if the command fails since the
892.Fl v
893switch was not specified.
894.Pp
895.Bd -literal -offset indent
896camcontrol tur da1 -E -C 4 -t 50 -v
897.Ed
898.Pp
899Send a test unit ready command to da1.
900Enable kernel error recovery.
901Specify a retry count of 4, and a timeout of 50 seconds.
902Enable sense
903printing (with the
904.Fl v
905flag) if the command fails.
906Since error recovery is turned on, the
907disk will be spun up if it is not currently spinning.
908The
909.Nm
910utility will report whether the disk is ready.
911.Bd -literal -offset indent
912camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
913	-i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
914.Ed
915.Pp
916Issue a READ BUFFER command (0x3C) to cd1.
917Display the buffer size of cd1,
918and display the first 10 bytes from the cache on cd1.
919Display SCSI sense
920information if the command fails.
921.Pp
922.Bd -literal -offset indent
923camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
924	-o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
925.Ed
926.Pp
927Issue a WRITE BUFFER (0x3B) command to cd1.
928Write out 10 bytes of data,
929not including the (reserved) 4 byte header.
930Print out sense information if
931the command fails.
932Be very careful with this command, improper use may
933cause data corruption.
934.Pp
935.Bd -literal -offset indent
936camcontrol modepage da3 -m 1 -e -P 3
937.Ed
938.Pp
939Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
940settings on the drive.
941Mode page 1 contains a disk drive's auto read and
942write reallocation settings, among other things.
943.Pp
944.Dl camcontrol rescan all
945.Pp
946Rescan all SCSI busses in the system for devices that have been added,
947removed or changed.
948.Pp
949.Dl camcontrol rescan 0
950.Pp
951Rescan SCSI bus 0 for devices that have been added, removed or changed.
952.Pp
953.Dl camcontrol rescan 0:1:0
954.Pp
955Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
956changed.
957.Pp
958.Dl camcontrol tags da5 -N 24
959.Pp
960Set the number of concurrent transactions for da5 to 24.
961.Pp
962.Bd -literal -offset indent
963camcontrol negotiate -n da -u 4 -T disable
964.Ed
965.Pp
966Disable tagged queueing for da4.
967.Pp
968.Bd -literal -offset indent
969camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
970.Ed
971.Pp
972Negotiate a sync rate of 20MHz and an offset of 15 with da3.
973Then send a
974Test Unit Ready command to make the settings take effect.
975.Sh SEE ALSO
976.Xr cam 3 ,
977.Xr cam_cdbparse 3 ,
978.Xr cam 4 ,
979.Xr pass 4 ,
980.Xr xpt 4
981.Sh HISTORY
982The
983.Nm
984utility first appeared in
985.Fx 3.0 .
986.Pp
987The mode page editing code and arbitrary SCSI command code are based upon
988code in the old
989.Xr scsi 8
990utility and
991.Xr scsi 3
992library, written by Julian Elischer and Peter Dufault.
993The
994.Xr scsi 8
995program first appeared in
996.Bx 386 0.1.2.4 ,
997and first appeared in
998.Fx
999in
1000.Fx 2.0.5 .
1001.Sh AUTHORS
1002.An Kenneth Merry Aq ken@FreeBSD.org
1003.Sh BUGS
1004The code that parses the generic command line arguments does not know that
1005some of the subcommands take multiple arguments.
1006So if, for instance, you
1007tried something like this:
1008.Bd -literal -offset indent
1009camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
1010.Ed
1011.Pp
1012The sense information from the test unit ready command would not get
1013printed out, since the first
1014.Xr getopt 3
1015call in
1016.Nm
1017bails out when it sees the second argument to
1018.Fl c
1019(0x00),
1020above.
1021Fixing this behavior would take some gross code, or changes to the
1022.Xr getopt 3
1023interface.
1024The best way to circumvent this problem is to always make sure
1025to specify generic
1026.Nm
1027arguments before any command-specific arguments.
1028