BSD 4_3_Net_2 release

[unix-history] / usr / src / share / man / man4 / man4.vax / rx.4

diff --git a/usr/src/share/man/man4/man4.vax/rx.4 b/usr/src/share/man/man4/man4.vax/rx.4
index b7cca19..9c4ddfb 100644 (file)
--- a/usr/src/share/man/man4/man4.vax/rx.4
+++ b/usr/src/share/man/man4/man4.vax/rx.4
@@ -1,168 +1,254 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)rx.4        6.1 (Berkeley) 5/15/85
+.\" 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 University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH RX 4 "May 15, 1985"
-.UC 5
-.SH NAME
-rx \- DEC RX02 floppy disk interface
-.SH SYNOPSIS
-.B "controller fx0 at uba0 csr 0177170  vector rxintr"
-.br
-.B "disk rx0 at fx0 drive 0"
-.br
-.B "disk rx1 at fx0 drive 1"
-.SH DESCRIPTION
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
+.\"
+.\"     @(#)rx.4       6.2 (Berkeley) 3/27/91
+.\"
+.Dd March 27, 1991
+.Dt RX 4 vax
+.Os BSD 4.2
+.Sh NAME
+.Nm rx
+.Nd
+.Tn DEC
+.Tn RX02
+floppy disk interface
+.Sh SYNOPSIS
+.Cd "controller fx0 at uba0 csr 0177170  vector rxintr"
+.Cd "disk rx0 at fx0 drive 0"
+.Cd "disk rx1 at fx0 drive 1"
+.Sh DESCRIPTION

 The
 The

-.I rx
-device provides access to a DEC RX02 floppy disk
-unit with M8256 interface module (RX211 configuration). 
-The RX02 uses 8-inch, single-sided, soft-sectored floppy
+.Nm rx
+device provides access to a
+.Tn DEC
+.Tn RX02
+floppy disk
+unit with M8256 interface module
+.Pf ( Tn RX211
+configuration). 
+The
+.Tn RX02
+uses 8-inch, single-sided, soft-sectored floppy

 disks (with pre-formatted industry-standard headers) in
 either single or double density.
 disks (with pre-formatted industry-standard headers) in
 either single or double density.

-.PP
-Floppy disks handled by the RX02 contain 77 tracks, each with 26
+.Pp
+Floppy disks handled by the
+.Tn RX02
+contain 77 tracks, each with 26

 sectors (for a total of 2,002 sectors).  The sector size is 128
 bytes for single density, 256 bytes for double density.  Single 
 sectors (for a total of 2,002 sectors).  The sector size is 128
 bytes for single density, 256 bytes for double density.  Single 

-density disks are compatible with the RX01 floppy disk unit and with
-IBM 3740 Series Diskette 1 systems.  
-.PP
-In addition to normal (`block' and `raw') i/o, the driver supports
+density disks are compatible with the
+.Tn RX01
+floppy disk unit and with
+.Tn IBM
+3740 Series Diskette 1 systems.  
+.Pp
+In addition to normal (`block' and `raw')
+.Tn I/O ,
+the driver supports

 formatting of disks for either density and
 the ability to invoke a 2 for 1 interleaved sector mapping
 formatting of disks for either density and
 the ability to invoke a 2 for 1 interleaved sector mapping

-compatible with the DEC operating system RT-11.
-.PP
+compatible with the
+.Tn DEC
+operating system
+.Tn RT-11 .
+.Pp

 The minor device number is interpreted as follows:
 The minor device number is interpreted as follows:

-.PP
-.nf
-.ta \w'Bit      'u
-\fBBit Description\fP
+.Pp
+.Bl -column Otherx -offset indent
+.Sy Bit        Description

 0      Sector interleaving  (1 disables interleaving)
 1      Logical sector 1 is on track 1 (0 no, 1 yes)
 2      Not used, reserved
 Other  Drive number
 0      Sector interleaving  (1 disables interleaving)
 1      Logical sector 1 is on track 1 (0 no, 1 yes)
 2      Not used, reserved
 Other  Drive number

-.fi
-.PP
-The two drives in a single RX02 unit are treated as
+.El
+.Pp
+The two drives in a single
+.Tn RX02
+unit are treated as

 two disks attached to a single controller.  Thus, if there are two
 two disks attached to a single controller.  Thus, if there are two

-RX02's on a system, the drives on the first RX02 are ``rx0'' and ``rx1'',
-while the drives on the second are ``rx2'' and ``rx3''. 
-.PP
+.Tn RX02 Ns 's
+on a system, the drives on the first
+.Tn RX02
+are
+.Dq Li rx0
+and
+.Dq Li rx1 ,
+while the drives on the second are
+.Dq Li rx2
+and
+.Dq Li rx3 . 
+.Pp

 When the device is opened, the density of the disk
 currently in the drive is automatically determined. If there
 is no floppy in the device, open will fail.
 When the device is opened, the density of the disk
 currently in the drive is automatically determined. If there
 is no floppy in the device, open will fail.

-.PP
+.Pp

 The interleaving parameters are represented in raw device
 The interleaving parameters are represented in raw device

-names by the letters `a' through `d'.  Thus, unit 0, drive 0 is
+names by the letters
+.Ql a
+through
+.Ql d .
+Thus, unit 0, drive 0 is

 called by one of the following names:
 called by one of the following names:

-.PP
-.nf
-.ta \w'interleaved   'u +\w'Device name   'u
-\fBMapping     Device name     Starting track\fP
+.Pp
+.Bl -column interleavedxx "Device namexx" "Starting Track" -offset indent
+.Sy Mapping    Device name     Starting track

 interleaved    /dev/rrx0a      0
 direct /dev/rrx0b      0
 interleaved    /dev/rrx0c      1
 direct /dev/rrx0d      1
 interleaved    /dev/rrx0a      0
 direct /dev/rrx0b      0
 interleaved    /dev/rrx0c      1
 direct /dev/rrx0d      1

-.fi
-.PP
-The mapping used on the `c' device is compatible with the
-DEC operating system RT-11.  The `b' device accesses the
+.El
+.Pp
+The mapping used on the
+.Ql c
+device is compatible with the
+.Tn DEC
+operating system
+.Tn RT-11 .
+The
+.Ql b
+device accesses the

 sectors of the disk in strictly sequential order.  
 sectors of the disk in strictly sequential order.  

-The `a' device is the most efficient for disk-to-disk copying.
+The
+.Ql a
+device is the most efficient for disk-to-disk copying.

 This mapping is always used by the block device.
 This mapping is always used by the block device.

-.PP
-I/O requests must start on a sector boundary, involve an integral
+.Pp
+.Tn I/O
+requests must start on a sector boundary, involve an integral

 number of complete sectors, and not go off the end of the disk.
 number of complete sectors, and not go off the end of the disk.

-.SH NOTES
+.Sh NOTES

 Even though the storage capacity on a floppy disk is quite
 small, it is possible to make filesystems on 
 double density disks. 
 For example, the command
 Even though the storage capacity on a floppy disk is quite
 small, it is possible to make filesystems on 
 double density disks. 
 For example, the command

-.nf
-.RS
+.Bd -literal -offset indent

 % mkfs /dev/rx0 1001 13 1 4096 512 32 0 4
 % mkfs /dev/rx0 1001 13 1 4096 512 32 0 4

-.RE
-.fi
+.Ed
+.Pp

 makes a file system on the double density disk in rx0 with 
 436 kbytes available for file storage.
 makes a file system on the double density disk in rx0 with 
 436 kbytes available for file storage.

-Using \fItar\fP(1) gives a more efficient utilization of the available
+Using
+.Xr tar 1
+gives a more efficient utilization of the available

 space for file storage.
 Single density diskettes do not provide sufficient storage capacity to
 hold file systems.
 space for file storage.
 Single density diskettes do not provide sufficient storage capacity to
 hold file systems.

-.PP
-A number of \fIioctl\fP(2) calls apply to the rx devices, and
+.Pp
+A number of
+.Xr ioctl 2
+calls apply to the rx devices, and

 have the form
 have the form

-.RS
-.nf
-.ft B
+.Bd -literal -offset indent

 #include <vaxuba/rxreg.h>
 ioctl(fildes, code, arg)
 int *arg;
 #include <vaxuba/rxreg.h>
 ioctl(fildes, code, arg)
 int *arg;

-.ft R
-.fi
-.RE
+.Ed
+.Pp

 The applicable codes are:
 The applicable codes are:

-.IP RXIOC_FORMAT 18
+.Bl -tag -width RXIOC_GETDENS
+.It Dv RXIOC_FORMAT

 Format the diskette. The density to use is specified
 by the 
 Format the diskette. The density to use is specified
 by the 

-.I arg
+.Ar arg

 argument, zero gives single density while non-zero
 gives double density.
 argument, zero gives single density while non-zero
 gives double density.

-.IP RXIOC_GETDENS
+.It Dv RXIOC_GETDENS

 Return the density of the diskette (zero or non-zero as above).
 Return the density of the diskette (zero or non-zero as above).

-.IP RXIOC_WDDMK
-On the next write, include a \fIdeleted data address mark\fP in 
+.It Dv RXIOC_WDDMK
+On the next write, include a
+.Em deleted data address mark
+in 

 the header of the first sector.
 the header of the first sector.

-.IP RXIOC_RDDMK
+.It Dv RXIOC_RDDMK

 Return non-zero if the last sector read contained a
 Return non-zero if the last sector read contained a

-\fIdeleted data address mark\fP in its header, otherwise
+.Em deleted data address mark
+in its header, otherwise

 return 0.
 return 0.

-.SH ERRORS
+.El
+.Sh FILES
+.Bl -tag -width /dev/rx?xx -compact
+.It Pa /dev/rx?
+.It Pa /dev/rrx?[a-d]
+.El
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "rx%d: hard error, trk %d psec %d cs=%b, db=%b, err=%x, %x, %x, %x."
+An unrecoverable error was encountered.  The 
+track and physical sector numbers, the device registers and the 
+extended error status are displayed.
+.Pp
+.It rx%d: state %d (reset).
+The driver entered a bogus state.  This should not happen.
+.El
+.Sh ERRORS

 The following errors may be returned by the driver:
 The following errors may be returned by the driver:

-.TP 12
-[ENODEV]
+.Bl -tag -width [ENODEV]
+.It Bq Er ENODEV

 Drive not ready; usually because no disk is in the drive or
 the drive door is open.
 Drive not ready; usually because no disk is in the drive or
 the drive door is open.

-.TP
-[ENXIO]
+.It Bq Er ENXIO

 Nonexistent drive (on open); 
 offset is too large or not on a sector boundary or
 byte count is not a multiple of the sector size (on read or write);
 or bad (undefined) ioctl code.
 Nonexistent drive (on open); 
 offset is too large or not on a sector boundary or
 byte count is not a multiple of the sector size (on read or write);
 or bad (undefined) ioctl code.

-.TP
-[EIO]
+.It Bq Er EIO

 A physical error other than ``not ready'', probably bad media or 
 unknown format.
 A physical error other than ``not ready'', probably bad media or 
 unknown format.

-.TP
-[EBUSY]
+.It Bq Er EBUSY

 Drive has been opened for exclusive access.
 Drive has been opened for exclusive access.

-.IP [EBADF] 12
+.It Bq Er EBADF

 No write access (on format), or wrong density; the latter
 can only happen if the disk is changed without 
 No write access (on format), or wrong density; the latter
 can only happen if the disk is changed without 

-.I closing 
+.Em closing

 the device
 the device

-(i.e., calling \fIclose\fP(2) ).
-.SH FILES
-/dev/rx?
-.br
-/dev/rrx?[a-d]
-.SH SEE ALSO
-rxformat(8V), newfs(8), mkfs(8), tar(1), arff(8V)
-.SH DIAGNOSTICS
-.BR "rx%d: hard error, trk %d psec %d cs=%b, db=%b, err=%x, %x, %x, %x".
-An unrecoverable error was encountered.  The 
-track and physical sector numbers, the device registers and the 
-extended error status are displayed.
-.PP
-.BR "rx%d: state %d (reset)" .
-The driver entered a bogus state.  This should not happen.
-.SH BUGS
+(i.e., calling
+.Xr close 2 ) .
+.El
+.Sh SEE ALSO
+.Xr rxformat 8 ,
+.Xr newfs 8 ,
+.Xr mkfs 8 ,
+.Xr tar 1 ,
+.Xr arff 8
+.Sh HISTORY
+The
+.Nm
+driver appeared in
+.Bx 4.2 .
+.Sh BUGS

 A floppy may not be formatted if the
 header info on sector 1, track 0 has been damaged.  Hence, it is not
 possible to format completely degaussed disks or disks with other
 formats than the two known by the hardware. 
 A floppy may not be formatted if the
 header info on sector 1, track 0 has been damaged.  Hence, it is not
 possible to format completely degaussed disks or disks with other
 formats than the two known by the hardware. 

-.PP
+.Pp

 If the drive subsystem is powered down when the machine is booted, the
 controller won't interrupt.
 If the drive subsystem is powered down when the machine is booted, the
 controller won't interrupt.