summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Dempsky <matthew@cvs.openbsd.org>2014-06-28 06:18:27 +0000
committerMatthew Dempsky <matthew@cvs.openbsd.org>2014-06-28 06:18:27 +0000
commit5365eff88ced111d9d225baece775d9ebb05a9d4 (patch)
treeb291715979c3e36ed9aaf95e33630d2c8596fd49
parent8205c2ba061c279e79ac4fd334c4793063700b47 (diff)
Cleanup documentation for SCSI device driver ioctl()s.
-rw-r--r--share/man/man4/cd.432
-rw-r--r--share/man/man4/scsi.412
-rw-r--r--share/man/man4/st.410
3 files changed, 22 insertions, 32 deletions
diff --git a/share/man/man4/cd.4 b/share/man/man4/cd.4
index 3337420a941..62fd50bce35 100644
--- a/share/man/man4/cd.4
+++ b/share/man/man4/cd.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: cd.4,v 1.21 2014/01/21 03:15:46 schwarze Exp $
+.\" $OpenBSD: cd.4,v 1.22 2014/06/28 06:18:26 matthew Exp $
.\" $NetBSD: cd.4,v 1.3 1996/10/20 23:15:21 explorer Exp $
.\"
.\" Copyright (c) 1996
@@ -26,7 +26,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd $Mdocdate: January 21 2014 $
+.Dd $Mdocdate: June 28 2014 $
.Dt CD 4
.Os
.Sh NAME
@@ -79,8 +79,7 @@ calls which apply to CD-ROM drives are defined in the header files
and
.In sys/disklabel.h .
.Bl -tag -width Ds
-.It Dv DIOCGDINFO , Dv DIOCSDINFO
-.Pq Li "struct disklabel"
+.It Dv DIOCGDINFO , Dv DIOCSDINFO Fa "struct disklabel *"
Read or write the in-core copy of the disklabel for the drive.
The disklabel is initialized with information read from the SCSI inquiry
commands, and should be the same as the information printed at boot.
@@ -149,8 +148,7 @@ This structure is defined in
.\" /* The tray has dynamic debugging */
.\"};
.\".Ed
-.It Dv CDIOCPLAYTRACKS
-.Pq Li "struct ioc_play_track"
+.It Dv CDIOCPLAYTRACKS Fa "struct ioc_play_track *"
Start audio playback given a track address and length.
The structure is defined as follows:
.Bd -literal -offset indent
@@ -161,8 +159,7 @@ struct ioc_play_track {
u_char end_index;
};
.Ed
-.It Dv CDIOCPLAYBLOCKS
-.Pq Li "struct ioc_play_blocks"
+.It Dv CDIOCPLAYBLOCKS Fa "struct ioc_play_blocks *"
Start audio playback given a block address and length.
The structure is defined as follows:
.Bd -literal -offset indent
@@ -171,8 +168,7 @@ struct ioc_play_blocks {
int len;
};
.Ed
-.It Dv CDIOCPLAYMSF
-.Pq Li "struct ioc_play_msf"
+.It Dv CDIOCPLAYMSF Fa "struct ioc_play_msf *"
Start audio playback given a
.Dq minutes-seconds-frames
address and length.
@@ -187,8 +183,7 @@ struct ioc_play_msf {
u_char end_f;
};
.Ed
-.It Dv CDIOCREADSUBCHANNEL
-.Pq Li "struct ioc_read_subchannel"
+.It Dv CDIOCREADSUBCHANNEL Fa "struct ioc_read_subchannel *"
Read information from the subchannel at the location specified by this
structure:
.Bd -literal -offset indent
@@ -206,8 +201,7 @@ struct ioc_read_subchannel {
struct cd_sub_channel_info *data;
};
.Ed
-.It Dv CDIOREADTOCHEADER
-.Pq Li "struct ioc_toc_header"
+.It Dv CDIOREADTOCHEADER Fa "struct ioc_toc_header *"
Return summary information about the table of contents for the
mounted CD-ROM.
The information is returned into the following structure:
@@ -218,8 +212,7 @@ struct ioc_toc_header {
u_char ending_track;
};
.Ed
-.It Dv CDIOREADTOCENTRYS
-.Pq Li "struct ioc_read_toc_entry"
+.It Dv CDIOREADTOCENTRYS Fa "struct ioc_read_toc_entry *"
Return information from the table of contents entries mentioned.
(Yes, this command name is misspelled.)
The argument structure is defined as follows:
@@ -231,12 +224,12 @@ struct ioc_read_toc_entry {
struct cd_toc_entry *data;
};
.Ed
+.Pp
The requested data is written into an area of size
.Li data_len
and pointed to by
.Li data .
-.It Dv CDIOCSETPATCH
-.Pq Li "struct ioc_patch"
+.It Dv CDIOCSETPATCH Fa "struct ioc_patch *"
Attach various audio channels to various output channels.
The argument structure is defined thusly:
.Bd -literal -offset indent
@@ -245,8 +238,7 @@ struct ioc_patch {
/* one for each channel */
};
.Ed
-.It Dv CDIOCGETVOL , Dv CDIOCSETVOL
-.Pq Li "struct ioc_vol"
+.It Dv CDIOCGETVOL , Dv CDIOCSETVOL Fa "struct ioc_vol *"
Get (set) information about the volume settings of the output channels.
The argument structure is as follows:
.Bd -literal -offset indent
diff --git a/share/man/man4/scsi.4 b/share/man/man4/scsi.4
index 6782b301de7..932075c88e9 100644
--- a/share/man/man4/scsi.4
+++ b/share/man/man4/scsi.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: scsi.4,v 1.37 2014/01/21 03:15:46 schwarze Exp $
+.\" $OpenBSD: scsi.4,v 1.38 2014/06/28 06:18:26 matthew Exp $
.\"
.\" Copyright (c) 1996
.\" Julian Elischer <julian@freebsd.org>. All rights reserved.
@@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd $Mdocdate: January 21 2014 $
+.Dd $Mdocdate: June 28 2014 $
.Dt SCSI 4
.Os
.Sh NAME
@@ -109,9 +109,9 @@ device.
See the manual page for each device type for more information about
how generic SCSI ioctls may be applied to a specific device.
.Bl -tag -width DIOCSDINFO____
-.It Dv SCIOCRESET*
+.It Dv SCIOCRESET
Reset a device.
-.It Dv SCIOCDEBUG
+.It Dv SCIOCDEBUG Fa "int *"
Turn on debugging.
All SCSI operations originating from this device's driver
will be traced to the console, along with other information.
@@ -121,7 +121,7 @@ no effect.
.Em SCSI
debugging is controlled by the configuration option
.Em SCSIDEBUG .
-.It Dv SCIOCCOMMAND
+.It Dv SCIOCCOMMAND Fa "scsireq_t *"
Take a SCSI command and data from a user process and apply them to the SCSI
device.
Return all status information and return data to the process.
@@ -129,7 +129,7 @@ The ioctl will return a successful status even if the device rejected the
command.
As all status is returned to the user, it is up to the user
process to examine this information to decide the success of the command.
-.It Dv SCIOCIDENTIFY
+.It Dv SCIOCIDENTIFY Fa "struct scsi_addr *"
Ask the driver what its bus, target and lun are.
In addition, the device type, ATAPI or SCSI, is returned.
.El
diff --git a/share/man/man4/st.4 b/share/man/man4/st.4
index 962a0b435c2..dc9852b2241 100644
--- a/share/man/man4/st.4
+++ b/share/man/man4/st.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: st.4,v 1.18 2014/01/21 03:15:46 schwarze Exp $
+.\" $OpenBSD: st.4,v 1.19 2014/06/28 06:18:26 matthew Exp $
.\" $NetBSD: st.4,v 1.2 1996/10/20 23:15:24 explorer Exp $
.\"
.\" Copyright (c) 1996
@@ -26,7 +26,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd $Mdocdate: January 21 2014 $
+.Dd $Mdocdate: June 28 2014 $
.Dt ST 4
.Os
.Sh NAME
@@ -219,11 +219,9 @@ They are defined in the header file
.\" manual page, since it is common to all magnetic tapes.
.\"
.Bl -tag -width MTIOCEEOT
-.It Dv MTIOCGET
-.Pq Li "struct mtget"
+.It Dv MTIOCGET Fa "struct mtget *"
Retrieve the status and parameters of the tape.
-.It Dv MTIOCTOP
-.Pq Li "struct mtop"
+.It Dv MTIOCTOP "struct mtop *"
Perform a multiplexed operation.
The argument structure is as follows:
.Bd -literal -offset indent