fetch.9 - document casuword
authorAlex Hornung <ahornung@gmail.com>
Sun, 14 Mar 2010 09:32:00 +0000 (14 09:32 +0000)
committerAlex Hornung <ahornung@gmail.com>
Sun, 14 Mar 2010 12:38:06 +0000 (14 12:38 +0000)
share/man/man9/Makefile
share/man/man9/fetch.9

index 37779d9..9ef34ea 100644 (file)
@@ -389,6 +389,7 @@ MLINKS+=EVENTHANDLER.9 EVENTHANDLER_DECLARE.9 \
        EVENTHANDLER.9 EVENTHANDLER_REGISTER.9 \
        EVENTHANDLER.9 eventhandler_register.9
 MLINKS+=fetch.9 fubyte.9 \
+       fetch.9 casuword.9 \
        fetch.9 fusword.9 \
        fetch.9 fuword.9
 MLINKS+=firmware.9 firmware_image_load.9 \
index bae7959..8681827 100644 (file)
 .\" $FreeBSD: src/share/man/man9/fetch.9,v 1.6.2.4 2001/12/17 11:30:18 ru Exp $
 .\" $DragonFly: src/share/man/man9/fetch.9,v 1.4 2007/04/07 19:29:52 swildner Exp $
 .\"
-.Dd January 7, 1996
+.Dd March 14, 2010
 .Dt FETCH 9
 .Os
 .Sh NAME
 .Nm fetch ,
+.Nm casuword ,
 .Nm fubyte ,
 .Nm fusword ,
 .Nm fuword
@@ -49,6 +50,8 @@
 .In sys/time.h
 .In sys/systm.h
 .In sys/resourcevar.h
+.Ft u_long
+.Fn casuword "u_long *base" "u_long oldval" "u_long newval"
 .Ft int
 .Fn fubyte "const void *base"
 .Ft int
@@ -64,6 +67,18 @@ The
 .Nm
 routines provide the following functionality:
 .Bl -tag -width ".Fn fusword"
+.It Fn casuword
+Compares
+.Fa oldval
+with the word at
+.Fa base
+, and if equal, 
+.Fa base
+is set to
+.Fa newval .
+The old value at
+.Fa base
+is then returned.
 .It Fn fubyte
 Fetches a byte of data from the user-space address
 .Fa base .