Initial import from FreeBSD RELENG_4:
[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 $
36.\"
37.Dd January 7, 1996
38.Dt STORE 9
39.Os
40.Sh NAME
41.Nm store ,
42.Nm subyte ,
43.Nm susword ,
44.Nm suswintr ,
45.Nm suword
46.Nd store data to user-space
47.Sh SYNOPSIS
48.In sys/types.h
49.In sys/time.h
50.In sys/systm.h
51.In sys/resourcevar.h
52.Ft int
53.Fn subyte "void *base" "int byte"
54.Ft int
55.Fn susword "void *base" "int word"
56.Ft int
57.Fn suswintr "void *base" "int word"
58.Ft int
59.Fn suword "void *base" "long word"
60.Sh DESCRIPTION
61The
62.Nm
63functions are designed to copy small amounts of data to user-space.
64.Pp
65The
66.Nm
67routines provide the following functionality:
68.Bl -tag -width "suswintr()"
69.It Fn subyte
70Stores a byte of data to the user-space address
71.Pa base .
72.It Fn susword
73Stores a short word of data to the user-space address
74.Pa base .
75.It Fn suswintr
76Stores a short word of data to the user-space address
77.Pa base .
78This function is safe to call during an interrupt context.
79.It Fn suword
80Stores a word of data to the user-space address
81.Pa base .
82.El
83.Sh RETURN VALUES
84The
85.Nm
86functions return 0 on success or -1 on failure.
87.Sh SEE ALSO
88.Xr copy 9 ,
89.Xr fetch 9