d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ba625eb241
freebsd-skq/usr.sbin/fdcontrol/fdcontrol.8

300 lines
8.7 KiB
Groff
Raw Normal View History

Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
.\"
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
.\" Copyright (C) 1994, 2001 by Joerg Wunsch, Dresden
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.\" All rights reserved.
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
.\"
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.\" 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.
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
.\"
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``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 AUTHOR(S) 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.
Add $Id$, to make it simpler for members of the translation teams to track. The Id line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde
1999-07-12 20:12:29 +00:00
.\"
$Id$ -> $FreeBSD$
1999-08-28 01:35:59 +00:00
.\" $FreeBSD$
Add $Id$, to make it simpler for members of the translation teams to track. The Id line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde
1999-07-12 20:12:29 +00:00
.\"
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
.Dd December 25, 2001
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.Os
.Dt FDCONTROL 8
.Sh NAME
.Nm fdcontrol
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
.Nd display and modify floppy disk parameters
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.Sh SYNOPSIS
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 20:10:44 +00:00
.Nm
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
.Op Fl F
.Op Fl d Ar dbg
.Op Fl f Ar fmt
.Op Fl s Ar fmtstr
.Op Fl v
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.Ar device
.Sh DESCRIPTION
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
The
.Nm
utility allows the modification of the run-time behavior of the
.Xr fdc 4
driver for the device specified by
.Ar device .
.Pp
Commands are implemented to query the current device density settings
as well as the underlying device hardware as registered with the
driver, to manipulate debugging levels, and to adjust the device
density settings. All the operations that manipulate the kernel
settings are restricted to the superuser (by the device driver), while
all inquiry requests only require read access to
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.Ar device .
Minor formatting/style fixes. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134
1996-12-09 08:04:55 +00:00
.Pp
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
The
.Ar device
argument should always be given as a full path name, e. g.
.Pa /dev/fd0 .
.Pp
.Ss Inquiry commands
Running the
.Nm
utility without any of the optional flags will report the drive type
that has been registered with the device driver.
In the shortest form, a single string describing the drive type will
be returned. Possible values are:
.Ql 360K ,
.Ql 1.2M ,
.Ql 720K ,
.Ql 1.44M ,
.Ql 2.88M ,
or
.Ql unknown .
This information is primarily intented to be easily parsable by
scripts.
Minor formatting/style fixes. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134
1996-12-09 08:04:55 +00:00
.Pp
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
In order to add some descriptive text that makes the output better
human readable, the flag
.Fl v
can be added.
Minor formatting/style fixes. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134
1996-12-09 08:04:55 +00:00
.Pp
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
Specifying flag
.Fl F
will report the device's density settings in a form that is suitable
as input to the
.Fl s Ar fmtstr
option (see below). Again, together with
.Fl v ,
some more text will be returned, including the total capacity of the
density settings in kilobytes.
.Ss Debug control
If the
.Xr fdc 4
driver has been configured with the
.Ql FDC_DEBUG
option, by default, device debugging information is still disabled
since it could produce huge amounts of kernel messages. It needs to
be turned on using
.Nm
together with
.Fl d Ar 1 ,
usually immediately before starting an operation on the respective
device the debug information is wanted for, and later turned off again
using
.Fl d Ar 0 .
Note that the debugging levels are a driver global option that will
affect any drives and controllers using the
.Xr fdc 4
driver, regardless which
.Ar device
has been specified on the
.Nm
command line.
.Ss Density control
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
The
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
.Xr fdc 4
control utilities support two different options how to specify device
density settings. The first form uses
.Fl f Ar fmt
to specify the format of the medium in kilobytes. Depending on the
underlying drive type, the value is compared against a table of known
commonly used device density settings for that drive, and if a match
has been found, those settings will be used. Currently, the following
values for the respective drive types are acceptable:
.Bl -tag -width 2.88M -offset 4
.It 2.88M and 1.44M drives:
.TS
lB lB lB lB lB lB lB
r l l l l l l.
KB sectrac secsize ncyls speed heads flags
1721 21 2 (512) 82 500 2 MFM
1476 18 2 (512) 82 500 2 MFM
1440 18 2 (512) 80 500 2 MFM
1200 15 2 (512) 80 500 2 MFM
820 10 2 (512) 82 250 2 MFM
800 10 2 (512) 80 250 2 MFM
720 9 2 (512) 80 250 2 MFM
.TE
.It 1.2M drives:
.TS
lB lB lB lB lB lB lB
r l l l l l l.
KB sectrac secsize ncyls speed heads flags
1200 15 2 (512) 80 500 2 MFM
1232 8 3 (1024) 77 500 2 MFM
1476 18 2 (512) 82 500 2 MFM
1440 18 2 (512) 80 500 2 MFM
1200 15 2 (512) 80 500 2 MFM
820 10 2 (512) 82 300 2 MFM
800 10 2 (512) 80 300 2 MFM
720 9 2 (512) 80 300 2 MFM
360 9 2 (512) 40 300 2 MFM,2STEP
640 8 2 (512) 80 300 2 MFM
.TE
.It 720K drives:
.TS
lB lB lB lB lB lB lB
r l l l l l l.
KB sectrac secsize ncyls speed heads flags
720 9 2 (512) 80 250 2 MFM
.TE
.It 360K drives:
.TS
lB lB lB lB lB lB lB
r l l l l l l.
KB sectrac secsize ncyls speed heads flags
360 9 2 (512) 40 250 2 MFM
.TE
.El
.Pp
The second form to specify a device density uses
.Fl s Ar fmtstr
to explicitly specify each parameter in detail. The argument
.Ar fmtstr
is a comma-separated list of values of the form:
.Pp
.Em sectrac,secsize,datalen,gap,ncyls,speed,heads,f_gap,f_inter,offs2,flags
.Pp
The meaning of the parameters is:
.Bl -tag -width secsize -offset indent
.It Ar sectrac
The number of sectors per track.
.It Ar secsize
The sector size code, 0 = 128 bytes (or less), 1 = 256 bytes, 2 = 512
bytes, 3 = 1024 bytes.
.It Ar datalen
The actual sector size if the size code is 0, or the (ignored) value
0xFF for larger size codes.
.It Ar gap
The length of the gap 3 parameter for read/write operations.
.It Ar ncyls
The number of cylinders.
.It Ar speed
The transfer speed in kilobytes per second. Can be 250, 300, 500, or
1000, but each drive type only supports a subset of these values.
.It Ar heads
The number of heads.
.It Ar f_gap
The length of the gap 3 when formatting media.
.It Ar f_inter
The sector interleave to be applied when formatting. 0 means no
interleave, 1 means 1:1 etc.
.It Ar offs2
The offset of the sector numbers on side 2 (i. e. head number 1).
Normally, sector numbering on both sides starts with 1.
.It Ar flags
A list from one of the following flag values:
.Bl -tag -compact -width "+perpend"
.It Ar +mfm
Use MFM encoding.
.It Ar -mfm
Use FM (single-density) encoding.
.It Ar +2step
Use 2 steps per each cylinder (for accessing 40-cylinder media in
80-cylinder drives).
.It Ar -2step
Do not use 2 steps per cylinder, i. e. access each physical cylinder
of the drive.
.It Ar +perpend
Use perpendicular recording (for 2.88 MB media, currently not
supported).
.It Ar -perpend
Use longitudinal recording.
.El
.El
.Pp
For any missing parameter, the current value will be used, so only
actual changes need to be specified. Thus to turn off a flag bit
(like
.Ql +mfm
which is the default for all drive types), the form with a leading
minus sign must explicitly be used.
.Sh EXAMPLES
A simple inquiry about the drive type:
.Bd -literal
$ fdcontrol /dev/fd0
1.44M
.Ed
.Pp
Same as above, but with verbose output. Note that the result is about
the
.Em drive type ,
as opposed to a
.Em device density ,
so it is independent from the actual subdevice being used for
.Ar device .
.Bd -literal
$ fdcontrol -v /dev/fd1.360
/dev/fd1.360: 1.2M drive (5.25" high-density)
.Ed
.\" " <- this one is for Emacs :)
.Pp
Inquiry about the density settings of a particular subdevice.
.Bd -literal
$ fdcontrol -F /dev/fd0.720
18,512,0xff,0x1b,80,500,2,0x6c,1,0,+mfm
.Ed
.Pp
Note that just accessing a new subdevice for the first time will clone
this device using the default density settings for the drive type, as
explained in
.Xr fdc 4 .
Thus, albeit the device name in the example above suggests a 720 KB
media density, it has actually been initialized (by the driver) to
1440 KB. So in order to adjust it for standard 720 KB double-density
media, one of the following
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.Nm
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
command needs to be run:
.Bd -literal
# fdcontrol -s 9,,,0x20,,250,,0x50 /dev/fd0.720
# fdcontrol -f 720 /dev/fd0.720
.Ed
Minor formatting/style fixes. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134
1996-12-09 08:04:55 +00:00
.Pp
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
As indicated, trailing commas in the parameter list may be omitted.
.Pp
In order to access archaic 160 KB single-density (FM encoded) 5.25\"
media in a modern 1.2M drive, something like the following definition
would be needed. (Note that not all controller hardware is actually
capable of handling FM encoding at all.)
.Bd -literal
# fdcontrol -s 16,128,0x80,0x2,40,300,,0x10,,,-mfm,+2step /dev/fd1.1
.Ed
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.Sh SEE ALSO
Sort cross references.
1997-01-20 00:03:00 +00:00
.Xr fdc 4
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
.Sh HISTORY
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
The
.Nm
utility appeared in
.Fx 2.0 ,
and has been vastly overhauled in
.Fx 5.0 .
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq.
1998-03-23 08:31:20 +00:00
.Sh AUTHORS
Second round of floppy disk driver documentation updates: document the changes in the userland utilities. For fdcontrol(8), i now finally keep my promise made more than 7 years ago that ``the fdcontrol utility is currently under development and the user interface will likely change''. :-)
2001-12-25 21:21:18 +00:00
The program and this man page have been contributed by
Avoid use of direct troff requests in mdoc(7) manual pages.
2000-11-10 17:46:15 +00:00
.An J\(:org Wunsch ,
Import the fdcontrol command. It has been in 1.1.5, but obviously has been lost on its way to 2.0. This program uses the FD_DEBUG ioctl, which will have to be commited yet.
1994-10-30 18:52:01 +00:00
Dresden.
Reference in New Issue Copy Permalink