vkernel/vkernel64: Add suword32() to fix build.
[dragonfly.git] / share / man / man9 / store.9
CommitLineData
984263bc
MD
1.\" $NetBSD: store.9,v 1.2 1996/01/09 21:59:27 perry Exp $
2.\"
3.\" Copyright (c) 1996 Jason R. Thorpe.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed by Kenneth Stailey.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in the
15.\" documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\" must display the following acknowledgement:
18.\" This product includes software developed for the NetBSD Project
19.\" by Jason R. Thorpe.
20.\" 4. The name of the author may not be used to endorse or promote products
21.\" derived from this software without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" $FreeBSD: src/share/man/man9/store.9,v 1.7.2.4 2001/12/17 11:30:19 ru Exp $
7ba324e6 36.\" $DragonFly: src/share/man/man9/store.9,v 1.4 2007/04/07 19:29:52 swildner Exp $
984263bc 37.\"
0fdbc4f1 38.Dd August 2, 2010
984263bc
MD
39.Dt STORE 9
40.Os
41.Sh NAME
42.Nm store ,
0fdbc4f1 43.Nm casuword ,
984263bc
MD
44.Nm subyte ,
45.Nm susword ,
984263bc
MD
46.Nm suword
47.Nd store data to user-space
48.Sh SYNOPSIS
49.In sys/types.h
50.In sys/time.h
51.In sys/systm.h
52.In sys/resourcevar.h
0fdbc4f1
SW
53.Ft u_long
54.Fn casuword "u_long *base" "u_long oldval" "u_long newval"
984263bc
MD
55.Ft int
56.Fn subyte "void *base" "int byte"
57.Ft int
58.Fn susword "void *base" "int word"
59.Ft int
984263bc
MD
60.Fn suword "void *base" "long word"
61.Sh DESCRIPTION
62The
63.Nm
64functions are designed to copy small amounts of data to user-space.
65.Pp
66The
67.Nm
68routines provide the following functionality:
0fdbc4f1
SW
69.Bl -tag -width ".Fn casuword"
70.It Fn casuword
71Compares
72.Fa oldval
73with the word at
74.Fa base ,
75and if equal,
76.Fa base
77is set to
78.Fa newval .
79The old value at
80.Fa base
81is then returned.
984263bc
MD
82.It Fn subyte
83Stores a byte of data to the user-space address
7ba324e6 84.Fa base .
984263bc
MD
85.It Fn susword
86Stores a short word of data to the user-space address
7ba324e6 87.Fa base .
984263bc
MD
88.It Fn suword
89Stores a word of data to the user-space address
7ba324e6 90.Fa base .
984263bc
MD
91.El
92.Sh RETURN VALUES
93The
94.Nm
95functions return 0 on success or -1 on failure.
96.Sh SEE ALSO
97.Xr copy 9 ,
98.Xr fetch 9