Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} 

functions.  Cross-reference with each-other and copy(9).
This commit is contained in:
thorpej 1996-01-09 03:23:01 +00:00
parent 926f925088
commit 386884687c
4 changed files with 184 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
share/man/man9/Makefile
View File

@ -1,9 +1,9 @@
# $NetBSD: Makefile,v 1.3 1996/01/09 01:44:42 thorpej 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 copy.9 disk.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 \
@ -11,5 +11,9 @@ MLINKS+=copy.9 copyin.9 copy.9 copyout.9 copy.9 copystr.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>

17
share/man/man9/copy.9
View File

@ -1,4 +1,4 @@
.\" $NetBSD: copy.9,v 1.1 1996/01/09 01:44:43 thorpej Exp $
.\" $NetBSD: copy.9,v 1.2 1996/01/09 03:23:04 thorpej Exp $
.\"
.\" Copyright (c) 1996 Jason R. Thorpe.
.\" All rights reserved.
@ -52,7 +52,9 @@
.Ft int
.Fn copyoutstr "void *kaddr" "void *uaddr" "size_t len" "size_t *done"
.Sh DESCRIPTION
The copy functions are designed to copy contiguous data from one address
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.
@ -109,3 +111,14 @@ NULL, is returned in
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 .

81
share/man/man9/fetch.9 Normal file
View File

@ -0,0 +1,81 @@
.\" $NetBSD: fetch.9,v 1.1 1996/01/09 03:23:05 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 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 failire.
.Sh SEE ALSO
.Xr copy 9 ,
.Xr store 9 .

81
share/man/man9/store.9 Normal file
View File

@ -0,0 +1,81 @@
.\" $NetBSD: store.9,v 1.1 1996/01/09 03:23:06 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 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 failire.
.Sh SEE ALSO
.Xr copy 9 ,
.Xr fetch 9 .