xnu-3789.1.32.tar.gz

[apple/xnu.git] / bsd / man / man9 / fetch.9

diff --git a/bsd/man/man9/fetch.9 b/bsd/man/man9/fetch.9
index 5669d0078e4091c1a05536acd4a780b70fdb38a4..7e6531c7804c5feeb9e038a70c772542efa6333b 100644 (file)
--- a/bsd/man/man9/fetch.9
+++ b/bsd/man/man9/fetch.9
@@ -34,14 +34,16 @@
 .\"
 .\" $FreeBSD: src/share/man/man9/fetch.9,v 1.6.2.4 2001/12/17 11:30:18 ru Exp $
 .\"
 .\"
 .\" $FreeBSD: src/share/man/man9/fetch.9,v 1.6.2.4 2001/12/17 11:30:18 ru Exp $
 .\"

-.Dd January 7, 1996
+.Dd December 16, 2004

 .Dt FETCH 9
 .Os
 .Sh NAME
 .Nm fetch ,
 .Nm fubyte ,
 .Dt FETCH 9
 .Os
 .Sh NAME
 .Nm fetch ,
 .Nm fubyte ,

-.Nm fusword ,
-.Nm fuswintr ,
+.Nm fuibyte ,
+.Nm fuiword ,
+.Nm fulong ,
+.Nm fuulong ,

 .Nm fuword
 .Nd fetch data from user-space
 .Sh SYNOPSIS
 .Nm fuword
 .Nd fetch data from user-space
 .Sh SYNOPSIS


@@ -49,14 +51,31 @@
 .In sys/time.h
 .In sys/systm.h
 .In sys/resourcevar.h
 .In sys/time.h
 .In sys/systm.h
 .In sys/resourcevar.h

+.\"
+.Ft int
+.Fo fubyte
+.Fa "const user_addr_t addr"
+.Fc

 .Ft int
 .Ft int

-.Fn fubyte "const void *base"
+.Fo fuibyte
+.Fa "const user_addr_t addr"
+.Fc

 .Ft int
 .Ft int

-.Fn fusword "void *base"
+.Fo fuiword
+.Fa "user_addr_t addr"
+.Fc
+.Ft int64_t
+.Fo fulong
+.Fa "user_addr_t addr"
+.Fc
+.Ft uint64_t
+.Fo fuulong
+.Fa "user_addr_t addr"
+.Fc

 .Ft int
 .Ft int

-.Fn fuswintr "void *base"
-.Ft long
-.Fn fuword "const void *base"
+.Fo fuword
+.Fa "user_addr_t addr"
+.Fc

 .Sh DESCRIPTION
 The
 .Nm
 .Sh DESCRIPTION
 The
 .Nm


@@ -65,20 +84,33 @@ functions are designed to copy small amounts of data from user-space.
 The
 .Nm
 routines provide the following functionality:
 The
 .Nm
 routines provide the following functionality:

-.Bl -tag -width "fuswintr()"
+.Bl -tag -width "fuiword()"
+.\" ==========

 .It Fn fubyte
 Fetches a byte of data from the user-space address
 .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 .
+.Pa addr .
+.\" ==========
+.It Fn fuibyte
+Fetches a byte of data from the user-space address
+.Pa addr .
+This function is safe to call during an interrupt context.
+.\" ==========
+.It Fn fuiword
+Fetches a word of data from the user-space address
+.Pa addr .

 This function is safe to call during an interrupt context.
 This function is safe to call during an interrupt context.

+.\" ==========
+.It Fn fulong
+Fetches a long word of data from the user-space address
+.Pa addr .
+.\" ==========
+.It Fn fuulong
+Fetches a unsigned long word of data from the user-space address
+.Pa addr .
+.\" ==========

 .It Fn fuword
 Fetches a word of data from the user-space address
 .It Fn fuword
 Fetches a word of data from the user-space address

-.Pa base .
+.Pa addr .

 .El
 .Sh RETURN VALUES
 The
 .El
 .Sh RETURN VALUES
 The