from netbsd; new pages

5 files changed, 652 insertions, 3 deletions

diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 046e1360911..e10dc6adf7f 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -1,10 +1,19 @@
-#       $NetBSD: Makefile,v 1.1 1995/11/25 21:24:47 perry Exp $
+#       $NetBSD: Makefile,v 1.4 1996/01/09 03:23:01 thorpej Exp $
 
 #	Makefile for section 9 (kernel function and variable) manual pages.
 
-MAN=	boot.9 doshutdownhooks.9 inittodr.9 resettodr.9 \
-	shutdownhook_establish.9 time.9
+MAN=	boot.9 copy.9 disk.9 doshutdownhooks.9 fetch.9 inittodr.9 resettodr.9 \
+	shutdownhook_establish.9 store.9 time.9
 MLINKS+=shutdownhook_establish.9 shutdownhook_disestablish.9
 MLINKS+=time.9 boottime.9 time.9 mono_time.9 time.9 runtime.9
+MLINKS+=copy.9 copyin.9 copy.9 copyout.9 copy.9 copystr.9 \
+	copy.9 copyinstr.9 copy.9 copyoutstr.9
+MLINKS+=disk.9 disk_init.9 disk.9 disk_attach.9 disk.9 disk_detatch.9 \
+	disk.9 disk_busy.9 disk.9 disk_unbusy.9 disk.9 disk_find.9 \
+	disk.9 disk_resetstat.9
+MLINKS+=fetch.9 fubyte.9 fetch.9 fuibyte.9 fetch.9 fusword.9 \
+	fetch.9 fuswintr.9 fetch.9 fuword.9 fetch.9 fuiword.9
+MLINKS+=store.9 subyte.9 store.9 suibyte.9 store.9 susword.9 \
+	store.9 suswintr.9 store.9 suword.9 store.9 suiword.9
 
 .include <bsd.prog.mk>
diff --git a/share/man/man9/copy.9 b/share/man/man9/copy.9
new file mode 100644
index 00000000000..97115979cba
--- /dev/null
+++ b/share/man/man9/copy.9
@@ -0,0 +1,124 @@
+.\"	$NetBSD: copy.9,v 1.2 1996/01/09 03:23:04 thorpej Exp $
+.\"
+.\" Copyright (c) 1996 Jason R. Thorpe.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed by Kenneth Stailey.
+.\"
+.\" 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 for the NetBSD Project
+.\"	by Jason R. Thorpe.
+.\" 4. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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 Jan 7, 1996
+.Dt COPY 9
+.Os NetBSD
+.Sh NAME
+.Nm copy
+.Nd kernel copy functions
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/systm.h>
+.Ft int
+.Fn copyin "void *uaddr" "void *kaddr" "size_t len"
+.Ft int
+.Fn copyout "void *kaddr" "void *uaddr" "size_t len"
+.Ft int
+.Fn copystr "void *kfaddr" "void *kdaddr" "size_t len" "size_t *done"
+.Ft int
+.Fn copyinstr "void *uaddr" "void *kaddr" "size_t len" "size_t *done"
+.Ft int
+.Fn copyoutstr "void *kaddr" "void *uaddr" "size_t len" "size_t *done"
+.Sh DESCRIPTION
+The
+.Nm
+functions are designed to copy contiguous data from one address
+to another.  All but
+.Fn copystr
+copy data from user-space to kernel-space or vice-versa.
+.Pp
+The
+.Nm
+routines provide the following functionality:
+.Bl -tag -width "copyoutstr()"
+.It Fn copyin
+Copies
+.Pa len
+bytes of data from the user-space address
+.Pa uaddr
+to the kernel-space address
+.Pa kaddr .
+.It Fn copyout
+Copies
+.Pa len
+bytes of data from the kernel-space address
+.Pa kaddr
+to the user-space address
+.Pa uaddr .
+.It Fn copystr
+Copies a NULL-terminated string, at most
+.Pa len
+bytes long, from kernel-space address
+.Pa kfaddr
+to kernel-space address
+.Pa kdaddr .
+The number of bytes actually copied, including the terminating
+NULL, is returned in
+.Pa *done .
+.It Fn copyinstr
+Copies a NULL-terminated string, at most
+.Pa len
+bytes long, from user-space address
+.Pa uaddr
+to kernel-space address
+.Pa kaddr .
+The number of bytes actually copied, including the terminating
+NULL, is returned in
+.Pa *done .
+.It Fn copyoutstr
+Copies a NULL-terminated string, at most
+bytes long, from kernel-space address
+.Pa kaddr
+to user-space address
+.Pa uaddr .
+The number of bytes actually copied, including the terminating
+NULL, is returned in
+.Pa *done .
+.El
+.Sh RETURN VALUES
+The
+.Nm
+functions return 0 on success or EFAULT if a bad address is encountered.
+In addition, the
+.Fn copystr ,
+.Fn copyinstr ,
+and
+.Fn copyoutstr
+funtions return ENAMETOOLONG if the string is longer than
+.Pa len
+bytes.
+.Sh SEE ALSO
+.Xr fetch 9 ,
+.Xr store 9 .
diff --git a/share/man/man9/disk.9 b/share/man/man9/disk.9
new file mode 100644
index 00000000000..41b80b5758c
--- /dev/null
+++ b/share/man/man9/disk.9
@@ -0,0 +1,354 @@
+.\"	$NetBSD: disk.9,v 1.1 1996/01/09 00:22:04 thorpej Exp $
+.\"
+.\" Copyright (c) 1995, 1996 Jason R. Thorpe.
+.\" All rights reserved.
+.\"
+.\" 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 for the NetBSD Project
+.\"	by Jason R. Thorpe.
+.\" 4. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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 Jan 7, 1996
+.Dt DISK 9
+.Os NetBSD
+.Sh NAME
+.Nm disk
+.Nd generic disk framework
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/disklabel.h>
+.Fd #include <sys/disk.h>
+.Ft void
+.Fn disk_init "void"
+.Ft void
+.Fn disk_attach "struct disk *"
+.Ft void
+.Fn disk_detatch "struct disk *"
+.Ft void
+.Fn disk_busy "struct disk *"
+.Ft void
+.Fn disk_unbusy "struct disk *"
+.Ft void
+.Fn disk_resetstat "struct disk *"
+.Ft struct disk *
+.Fn disk_find "char *"
+.Sh DESCRIPTION
+The NetBSD generic disk framework is designed to provide flexible,
+scalable, and consistent handling of disk state and metrics information.
+The fundamental component of this framework is the
+.Nm disk
+structure, which is defined as follows:
+.Bd -literal
+struct disk {
+	TAILQ_ENTRY(disk) dk_link;	/* link in global disklist */
+	char	 *dk_name;	/* disk name */
+	int	 dk_bopenmask;	/* block devices open */
+	int	 dk_copenmask;	/* character devices open */
+	int	 dk_openmask;	/* composite (bopen|copen) */
+	int	 dk_state;	/* label state */
+	int	 dk_blkshift;	/* shift to convert DEV_BSIZE to blks */
+	int	 dk_byteshift;	/* shift to convert bytes to blks */
+
+	/*
+	 * Metrics data; note that some metrics may have no meaning
+	 * on certain types of disks.
+	 */
+	int	  dk_busy;	/* busy counter */
+	u_int64_t dk_xfer;	/* total number of transfers */
+	u_int64_t dk_seek;	/* total independent seek operations */
+	u_int64_t dk_bytes;	/* total bytes transfered */
+	struct timeval	dk_attachtime;	/* time disk was attached */
+	struct timeval	dk_timestamp;	/* timestamp of last unbusy */
+	struct timeval	dk_time;	/* total time spent busy */
+
+	struct	dkdriver *dk_driver;	/* pointer to driver */
+
+	/*
+	 * Disk label information.  Storage for the in-core disk label
+	 * must be dynamically allocated, otherwise the size of this
+	 * structure becomes machine-dependent.
+	 */
+	daddr_t	 dk_labelsector;	/* sector containing label */
+	struct disklabel *dk_label;	/* label */
+	struct cpu_disklabel *dk_cpulabel;
+};
+.Ed
+.Pp
+The system maintains a global linked-list of all disks attached to the
+system.  This list, called
+.Nm disklist ,
+may grow or shrink over time as disks are dynamically added and removed
+from the system.  Drivers which currently make use of the detachment
+capability of the framework are the
+.Nm ccd
+and
+.Nm vnd
+pseudo-device drivers.
+.Pp
+The following is a brief description of each function in the framework:
+.Bl -tag -width "disk_resetstat()"
+.It Fn disk_init
+Initialize the disklist and other data structures used by the framework.
+Called by
+.Fn main
+before autoconfiguration.
+.It Fn disk_attach
+Attach a disk; allocate storage for the disklabel, set the
+.Dq attached time
+timestamp, insert the disk into the disklist, and intrement the
+system disk count.
+.It Fn disk_detatch
+Detatch a disk; free storage for the disklabel, remove the disk
+from the disklist, and decrement the system disk count.  If the count
+drops below zero, panic.
+.It Fn disk_busy
+Increment the disk's
+.Dq busy counter .
+If this counter goes from 0 to 1, set the timestamp corresponding to
+this transfer.
+.It Fn disk_unbusy
+Decrement a disk's busy counter.  If the count drops below zero, panic.
+Get the current time, subtract it from the disk's timestamp, and add
+the difference to the disk's running total.  Set the disk's timestamp
+to the current time.  If the provided byte count is greater than 0,
+add it to the disk's running total and increment the number of transfers
+performed by the disk.
+.It Fn disk_resetstat
+Reset the running byte, transfer, and time totals.
+.It Fn disk_find
+Return a pointer to the disk structure corresponding to the name provided,
+or NULL if the disk does not exist.
+.El
+.Pp
+The functions typically called by device drivers are
+.Fn disk_attach ,
+.Fn disk_detatch ,
+.Fn disk_busy ,
+.Fn disk_unbusy ,
+and
+.Fn disk_resetstat .
+The function
+.Fn disk_find
+is provided as a utility function.
+.Sh USING THE FRAMEWORK
+This section includes a description on basic use of the framework
+and example usage of its functions.  Actual implementation of
+a device driver which utilizes the framework may vary.
+.Pp
+A special routine,
+.Fn disk_init ,
+is provided to perform basic initialization of data structures used by
+the framework.  It is called exactly once by the system, in
+.Fn main ,
+before device autoconfiguration.
+.Pp
+Each device in the system uses a
+.Dq softc
+structure which contains autoconfiguration and state information for that
+device.  In the case of disks, the softc should also contain one instance
+of the disk stucture, eg:
+.Bd -literal
+struct foo_softc {
+	struct	device *sc_dev;		/* generic device information */
+	struct	disk *sc_dk;		/* generic disk information */
+	[ . . . more . . . ]
+};
+.Ed
+.Pp
+In order for the system to gather metrics data about a disk, the disk must
+be registered with the system.  The
+.Fn disk_attach
+routine performs all of the functions currently required to register a disk
+with the system including allocation of disklabel storage space,
+recording of the time since boot that the disk was attached, and insertion
+into the disklist.  Note that since this function allocates storage space
+for the disklabel, it must be called before the disklabel is read from the
+media or used in any other way.  Before
+.Fn disk_attach
+is called, a portions of the disk structure must be initialized with
+data specific to that disk.  For example, in the
+.Dq foo
+disk driver, the following would be performed in the autoconfiguration
+.Dq attach
+routine:
+.Bd -literal
+void
+fooattach(parent, self, aux)
+	struct device *parent, *self;
+	void *aux;
+{
+	struct foo_softc *sc = (struct foo_softc *)self;
+	[ . . . ]
+
+	/* Initialize and attach the disk structure. */
+	sc->sc_dk.dk_driver = &foodkdriver;
+	sc->sc_dk.dk_name = sc->sc_dev.dv_xname;
+	disk_attach(&sc->sc_dk);
+
+	/* Read geometry and fill in pertinent parts of disklabel. */
+	[ . . . ]
+}
+.Ed
+.Pp
+The
+.Nm foodkdriver
+above is the disk's
+.Dq driver
+switch.  This switch currently includes a pointer to the disk's
+.Dq strategy
+routine.  This switch needs to have global scope and sould be initialized
+as follows:
+.Bd -literal
+void	foostrategy __P((struct buf *));
+struct	dkdriver foodkdriver = { foostrategy };
+.Ed
+.Pp
+Once the disk is attached, metrics may be gathered on that disk.  In order
+to gather metrics data, the driver must tell the framework when the disk
+starts and stops operations.  This functionality is provided by the
+.Fn disk_busy
+and
+.Fn disk_unbusy
+routines.  The
+.Fn disk_busy
+routine should be called immediately before a command to the disk is
+sent, eg:
+.Bd -literal
+void
+foostart(sc)
+	struct foo_softc *sc;
+{
+	[ . . . ]
+
+	/* Get buffer from drive's transfer queue. */
+	[ . . . ]
+
+	/* Build command to send to drive. */
+	[ . . . ]
+
+	/* Tell the disk framework we're is going busy. */
+	disk_busy(&sc->sc_dk);
+
+	/* Send command to the drive. */
+	[ . . . ]
+}
+.Ed
+.Pp
+When
+.Fn disk_busy
+is called, a timestamp is taken if the disk's busy counter moves from
+0 to 1, indicating the disk has gone from an idle to non-idle state.
+Note that
+.Fn disk_busy
+must be called at
+.Fn splbio .
+At the end of a transaction, the
+.Fn disk_unbusy
+routine should be called.  This routine performs some consistency checks,
+such as ensuring that the calls to
+.Fn disk_busy
+and
+.Fn disk_unbusy
+are balanced.  This routine also performs the actual metrics calculation.
+A timestamp is taken, and the difference from the timestamp taken in
+.Fn disk_busy
+is added to the disk's total running time.  The disk's timestamp is then
+updated in case there is more than one pending transfer on the disk.
+A byte count is also added to the disk's running total, and if greater than
+zero, the number of transfers the disk has performed is incremented.
+.Bd -literal
+void
+foodone(xfer)
+	struct foo_xfer *xfer;
+{
+	struct foo_softc = (struct foo_softc *)xfer->xf_softc;
+	struct buf *bp = xfer->xf_buf;
+	long nbytes;
+	[ . . . ]
+
+	/*
+	 * Get number of bytes transfered.  If there is no buf
+	 * associated with the xfer, we are being called at the
+	 * end of a non-I/O command.
+	 */
+	if (bp == NULL)
+		nbytes = 0;
+	else
+		nbytes = bp->b_bcount - bp->b_resid;
+
+	[ . . . ]
+
+	/* Notify the disk framework that we've completed the transfer. */
+	disk_unbusy(&sc->sc_dk, nbytes);
+
+	[ . . . ]
+}
+.Ed
+.Pp
+Like
+.Fn disk_busy ,
+.Fn disk_unbusy
+must be called at
+.Fn splbio .
+.Pp
+At some point a driver may wish to reset the metrics data gathered on a
+particular disk.  For this function, the
+.Fn disk_resetstat
+routine is provided.
+.Sh CODE REFERENCES
+This section describes places within the NetBSD source tree where actual
+code implementing or utilizing the disk framework can be found.  All
+pathnames are relative to
+.Nm /usr/src .
+.Pp
+The disk framework itself is implemented within the file
+.Nm sys/kern/subr_disk.c .
+Data structures and function prototypes for the framework are located in
+.Nm sys/sys/disk.h .
+.Pp
+The NetBSD machine-independent SCSI disk and CD-ROM drivers utilize the
+disk framework.  They are located in
+.Nm sys/scsi/sd.c
+and
+.Nm sys/scsi/cd.c .
+.Pp
+The NetBSD
+.Nm ccd
+and
+.Nm vnd
+drivers utilize the detachment capability of the framework.
+They are located in
+.Nm sys/dev/ccd.c
+and
+.Nm sys/dev/vnd.c .
+.Sh AUTHOR
+The NetBSD generic disk framework was architected and implemented by
+Jason R. Thorpe <thorpej@NetBSD.ORG>.
+.Sh SEE ALSO
+.Xr ccd 4 ,
+.Xr vnd 4 ,
+.Xr spl 9 .
+.Sh HISTORY
+The NetBSD generic disk framework appeared in NetBSD 1.1A.
diff --git a/share/man/man9/fetch.9 b/share/man/man9/fetch.9
new file mode 100644
index 00000000000..c5259cd3bf3
--- /dev/null
+++ b/share/man/man9/fetch.9
@@ -0,0 +1,81 @@
+.\"	$NetBSD: fetch.9,v 1.2 1996/01/09 21:59:24 perry Exp $
+.\"
+.\" Copyright (c) 1996 Jason R. Thorpe.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed by Kenneth Stailey.
+.\"
+.\" 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 for the NetBSD Project
+.\"	by Jason R. Thorpe.
+.\" 4. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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 Jan 7, 1996
+.Dt FETCH 9
+.Os NetBSD
+.Sh NAME
+.Nm fetch
+.Nd fetch data from user-space
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/systm.h>
+.Ft int
+.Fn fubyte "void *base"
+.Ft int
+.Fn fusword "void *base"
+.Ft int
+.Fn fuswintr "void *base"
+.Ft int
+.Fn fuword "void *base"
+.Sh DESCRIPTION
+The
+.Nm
+functions are designed to copy small amounts of data from user-space.
+.Pp
+The
+.Nm
+routines provide the following functionality:
+.Bl -tag -width "fuswintr()"
+.It Fn fubyte
+Fetches a byte of data from the user-space address
+.Pa base .
+.It Fn fusword
+Fetches a short word of data from the user-space address
+.Pa base .
+.It Fn fuswintr
+Fetches a short word of data from the user-space address
+.Pa base .
+This function is safe to call during an interrupt context.
+.It Fn fuword
+Fetches a word of data from the user-space address
+.Pa base .
+.El
+.Sh RETURN VALUES
+The
+.Nm
+functions return the data fetched or -1 on failure.
+.Sh SEE ALSO
+.Xr copy 9 ,
+.Xr store 9 .
diff --git a/share/man/man9/store.9 b/share/man/man9/store.9
new file mode 100644
index 00000000000..ca7df6a49c0
--- /dev/null
+++ b/share/man/man9/store.9
@@ -0,0 +1,81 @@
+.\"	$NetBSD: store.9,v 1.2 1996/01/09 21:59:27 perry Exp $
+.\"
+.\" Copyright (c) 1996 Jason R. Thorpe.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed by Kenneth Stailey.
+.\"
+.\" 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 for the NetBSD Project
+.\"	by Jason R. Thorpe.
+.\" 4. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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 Jan 7, 1996
+.Dt STORE 9
+.Os NetBSD
+.Sh NAME
+.Nm store
+.Nd store data to user-space
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/systm.h>
+.Ft int
+.Fn subyte "void *base"
+.Ft int
+.Fn susword "void *base"
+.Ft int
+.Fn suswintr "void *base"
+.Ft int
+.Fn suword "void *base"
+.Sh DESCRIPTION
+The
+.Nm
+functions are designed to copy small amounts of data to user-space.
+.Pp
+The
+.Nm
+routines provide the following functionality:
+.Bl -tag -width "suswintr()"
+.It Fn subyte
+Stores a byte of data to the user-space address
+.Pa base .
+.It Fn susword
+Stores a short word of data to the user-space address
+.Pa base .
+.It Fn suswintr
+Stores a short word of data to the user-space address
+.Pa base .
+This function is safe to call during an interrupt context.
+.It Fn suword
+Stores a word of data to the user-space address
+.Pa base .
+.El
+.Sh RETURN VALUES
+The
+.Nm
+functions return 0 on success or -1 on failure.
+.Sh SEE ALSO
+.Xr copy 9 ,
+.Xr fetch 9 .