Aren/NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
958680bc70
NetBSD/sbin/scsictl/scsictl.8

235 lines
6.7 KiB
Groff
Raw Normal View History

Punctuation vs. markup nits, and use .Dq instead of double quotes.
2002-06-26 22:07:21 +04:00
.\" $NetBSD: scsictl.8,v 1.15 2002/06/26 18:07:21 wiz Exp $
scsictl(8) - a program to manipulate SCSI devices and busses. Currently supports: Devices: identify, reassign blocks, reset Busses: reset, scan for devices Coming soon, device formatting, mode page editing, device freeze/thaw, etc.
1998-10-16 01:44:39 +04:00
.\"
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
.\" NASA Ames Research Center.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd October 15, 1998
.Dt SCSICTL 8
Drop arguments of .Os.
2001-06-05 15:22:41 +04:00
.Os
scsictl(8) - a program to manipulate SCSI devices and busses. Currently supports: Devices: identify, reassign blocks, reset Busses: reset, scan for devices Coming soon, device formatting, mode page editing, device freeze/thaw, etc.
1998-10-16 01:44:39 +04:00
.Sh NAME
.Nm scsictl
.Nd a program to manipulate SCSI devices and busses
.Sh SYNOPSIS
.Nm
.Ar device
.Ar command
.Oo
.Ar arg Oo ...
.Oc
.Oc
.Sh DESCRIPTION
.Nm
allows a user or system administrator to issue commands to and otherwise
control SCSI devices and busses. It is used by specifying a device or
bus to manipulate, the command to perform, and any arguments the command
may require.
.Nm
determines if the specified device is an actual device or a SCSI bus
automatically, and selects the appropriate command set.
.Pp
For commands which
.Nm
issues a SCSI command to the device directly, any returned sense information
will be decoded by
.Nm
and displayed to the standard output.
.Sh DEVICE COMMANDS
The following commands are supported for SCSI devices:
.Pp
Collect all little usage-messages spread around into one place, and as a side effect, print the available commands (and their usage) if no command is given on the command line. Approved by Jason Thorpe.
1999-07-30 06:29:04 +04:00
.Nm format
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
.Oo blocksize
.Oo immediate
.Oc
.Oc
.Pp
(Low level) format the named device. If the optional
.Li blocksize
parameter is provided, the device geometry will be modified to
use the specified
Punctuation vs. markup nits, and use .Dq instead of double quotes.
2002-06-26 22:07:21 +04:00
.Li blocksize .
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
If this parameter is different form the Current or Default Mode Page 3
parameters, the device will update Mode Page 3 at the successful
completion of the Format. Device geometry may change as a result of
using a new device
Punctuation vs. markup nits, and use .Dq instead of double quotes.
2002-06-26 22:07:21 +04:00
.Li blocksize .
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
When the optional
.Li blocksize
parameter is specified, the Defect List on the drive will revert to
the original primary defect list created at the time of manufacture
if available. The drive will usually recertify itself
during the Format and add any other defective blocks to the new Defect
List. Some disks may not support the ability to change the blocksize and
may enter a Degraded Mode when fed a Format command of this type. If this
happens the standard recovery for the drive requires issuing a correct
Format command, i.e. one without the blocksize parameter.
Collect all little usage-messages spread around into one place, and as a side effect, print the available commands (and their usage) if no command is given on the command line. Approved by Jason Thorpe.
1999-07-30 06:29:04 +04:00
.Pp
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
When the
.Li immediate
parameter is also specified, the disk is instructed to return from the
format command right away. It continues to format, and every ten seconds
.Nm
issues a TEST UNIT READY command to check the associated sense data. This
associated sense data has a progress indicator which indicates how far
the format is progressing. Note well that most SCSI disk drives prior to
a few years ago do not support this option.
Collect all little usage-messages spread around into one place, and as a side effect, print the available commands (and their usage) if no command is given on the command line. Approved by Jason Thorpe.
1999-07-30 06:29:04 +04:00
.Pp
scsictl(8) - a program to manipulate SCSI devices and busses. Currently supports: Devices: identify, reassign blocks, reset Busses: reset, scan for devices Coming soon, device formatting, mode page editing, device freeze/thaw, etc.
1998-10-16 01:44:39 +04:00
.Nm identify
.Pp
Identify the specified device, displaying the device's SCSI
bus, target, and lun, as well as the device's vendor, product,
and revision strings.
.Pp
.Nm reassign
.Ar blkno
.Oo blkno Oo ...
.Oc
.Oc
.Pp
Issues a
.Li REASSIGN BLOCKS
command to the device, adding the specified blocks to the
grown defect list. This command is only supported on
direct access devices.
.Pp
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
.Nm release
.Pp
Punctuation vs. markup nits, and use .Dq instead of double quotes.
2002-06-26 22:07:21 +04:00
Send a
.Dq RELEASE
command to the device to release a reservation on it.
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
.Pp
.Nm reserve
.Pp
Punctuation vs. markup nits, and use .Dq instead of double quotes.
2002-06-26 22:07:21 +04:00
Send a
.Dq RESERVE
command to the device to place a reservation on it.
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
.Pp
scsictl(8) - a program to manipulate SCSI devices and busses. Currently supports: Devices: identify, reassign blocks, reset Busses: reset, scan for devices Coming soon, device formatting, mode page editing, device freeze/thaw, etc.
1998-10-16 01:44:39 +04:00
.Nm reset
.Pp
Reset the device. This command is only supported for devices which
support the
.Li SCIOCRESET
ioctl.
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
.Pp
.Nm reset
.Pp
Reset the SCSI bus. This command is only supported if the host adapter
supports the
.Li SCBUSIORESET
ioctl.
.Pp
.Nm start
.Pp
Punctuation vs. markup nits, and use .Dq instead of double quotes.
2002-06-26 22:07:21 +04:00
Send a
.Dq START
command to the device. This is useful typically only for
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
disk devices.
.Pp
.Nm stop
.Pp
Punctuation vs. markup nits, and use .Dq instead of double quotes.
2002-06-26 22:07:21 +04:00
Send a
.Dq STOP
command to the device. This is useful typically only for
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
disk devices.
.Pp
.Nm tur
.Pp
Punctuation vs. markup nits, and use .Dq instead of double quotes.
2002-06-26 22:07:21 +04:00
Send a
.Dq TEST UNIT READY
command to the device. This is useful for generating
Add a bunch of stuff from Bob Nestor that fixes format to allow one to specify device logical blocksize. Furthermore, it also adds an 'immediate' option, which then sends more modern devices into formatting in the background. scsictl still waits around and sends a TEST UNIT READY every 10 seconds and, based upon the sense data it gets back after the invariable CHECK CONDITION, prints out a progress indicator (based upon SKSV progress in the sense data). While we're at it, add a 'tur', 'reserve', 'release', 'start' and 'stop' functions to the device commands. Fix a long standing bug in scsi_command- the value in retsts is an integral value- not a bitmask.
2002-06-26 20:04:11 +04:00
current device status.
scsictl(8) - a program to manipulate SCSI devices and busses. Currently supports: Devices: identify, reassign blocks, reset Busses: reset, scan for devices Coming soon, device formatting, mode page editing, device freeze/thaw, etc.
1998-10-16 01:44:39 +04:00
.Sh BUS COMMANDS
The following commands are supported for SCSI busses:
.Pp
.Nm reset
.Pp
Reset the SCSI bus. This command is only supported if the host adapter
supports the
.Li SCBUSIORESET
ioctl.
.Pp
.Nm scan
Oops, finish the description of the "scan" bus command.
1998-10-16 01:51:23 +04:00
.Ar target
.Ar lun
scsictl(8) - a program to manipulate SCSI devices and busses. Currently supports: Devices: identify, reassign blocks, reset Busses: reset, scan for devices Coming soon, device formatting, mode page editing, device freeze/thaw, etc.
1998-10-16 01:44:39 +04:00
.Pp
Scan the SCSI bus for devices. This is useful if a device was not
Oops, finish the description of the "scan" bus command.
1998-10-16 01:51:23 +04:00
connected or powered on when the system was booted. The
.Ar target
and
.Ar lun
arguments specify which SCSI target and lun on the bus is to be scanned.
Make `all' a synonym for the `any' keyword.
1999-09-29 03:32:04 +04:00
Either may be wildcarded by specifying the keyword
.Dq any
or
.Dq all .
Add and document a 'detach' command.
2001-07-19 00:36:36 +04:00
.Pp
.Nm detach
.Ar target
.Ar lun
.Pp
Fix a typo, and capitalize SCSI in one place.
2001-07-19 03:16:20 +04:00
Detach the specified device from the bus. Useful if a device is powered down
Add and document a 'detach' command.
2001-07-19 00:36:36 +04:00
after use. The
.Ar target
and
.Ar lun
arguments have the same meaning as for the
.Nm scan
command, and may also be wildcarded.
Add a note about what and where is printed for 'scan' command. Addresses bin/9227 by <johnr@spimageworks.com>
2000-03-07 22:27:11 +03:00
.Sh NOTES
Fix a typo, and capitalize SCSI in one place.
2001-07-19 03:16:20 +04:00
When scanning the SCSI bus, information about newly recognized devices
Add a note about what and where is printed for 'scan' command. Addresses bin/9227 by <johnr@spimageworks.com>
2000-03-07 22:27:11 +03:00
is printed to console. No information is printed for already probed
devices.
Collect all little usage-messages spread around into one place, and as a side effect, print the available commands (and their usage) if no command is given on the command line. Approved by Jason Thorpe.
1999-07-30 06:29:04 +04:00
.Sh FILES
Use .Pa.
2000-07-08 14:28:17 +04:00
.Pa /dev/scsibus*
- for commands operating on SCSI busses
scsictl(8) - a program to manipulate SCSI devices and busses. Currently supports: Devices: identify, reassign blocks, reset Busses: reset, scan for devices Coming soon, device formatting, mode page editing, device freeze/thaw, etc.
1998-10-16 01:44:39 +04:00
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr cd 4 ,
.Xr ch 4 ,
.Xr sd 4 ,
xref se(4) now that the manpage is built and installed
2001-04-03 15:51:33 +04:00
.Xr se 4 ,
scsictl(8) - a program to manipulate SCSI devices and busses. Currently supports: Devices: identify, reassign blocks, reset Busses: reset, scan for devices Coming soon, device formatting, mode page editing, device freeze/thaw, etc.
1998-10-16 01:44:39 +04:00
.Xr ss 4 ,
.Xr st 4 ,
.Xr uk 4
.Sh HISTORY
The
.Nm
command first appeared in
.Nx 1.4 .
Sort sections, use standard section headers.
2001-11-16 14:26:53 +03:00
.Sh AUTHORS
The
.Nm
command was written by Jason R. Thorpe of the Numerical Aerospace Simulation
Facility, NASA Ames Research Center.
Reference in New Issue Copy Permalink