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