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