[dragonfly.git] / share / man / man9 / store.9

.\"	$NetBSD: store.9,v 1.2 1996/01/09 21:59:27 perry 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.
.\"
.\" $FreeBSD: src/share/man/man9/store.9,v 1.7.2.4 2001/12/17 11:30:19 ru Exp $
.\"
.Dd December 23, 2011
.Dt STORE 9
.Os
.Sh NAME
.Nm store ,
.Nm casuword ,
.Nm subyte ,
.Nm susword ,
.Nm suword ,
.Nm suword32
.Nd store data to user-space
.Sh SYNOPSIS
.In sys/types.h
.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 subyte "void *base" "int byte"
.Ft int
.Fn susword "void *base" "int word"
.Ft int
.Fn suword "void *base" "long word"
.Ft int
.Fn suword32 "void *base" "int word"
.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 ".Fn casuword"
.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 subyte
Stores a byte of data to the user-space address
.Fa base .
.It Fn susword
Stores a short word of data to the user-space address
.Fa base .
.It Fn suword
Stores a word of data to the user-space address
.Fa base .
.It Fn suword32
Like
.Fn suword ,
for cases when 32 bits are desired.
.El
.Sh RETURN VALUES
The
.Nm
functions return 0 on success or -1 on failure.
.Sh SEE ALSO
.Xr copy 9 ,
.Xr fetch 9
Commit	Line	Data
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	.\"
701e0582	37	.Dd December 23, 2011
984263bc MD	38	.Dt STORE 9
	39	.Os
	40	.Sh NAME
	41	.Nm store ,
0fdbc4f1	42	.Nm casuword ,
984263bc MD	43	.Nm subyte ,
984263bc MD	44	.Nm susword ,
701e0582 SW	45	.Nm suword ,
701e0582 SW	46	.Nm suword32
984263bc MD	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
0fdbc4f1 SW	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	60	.Fn suword "void *base" "long word"
701e0582 SW	61	.Ft int
701e0582 SW	62	.Fn suword32 "void *base" "int word"
984263bc MD	63	.Sh DESCRIPTION
	64	The
	65	.Nm
	66	functions are designed to copy small amounts of data to user-space.
	67	.Pp
	68	The
	69	.Nm
	70	routines provide the following functionality:
0fdbc4f1 SW	71	.Bl -tag -width ".Fn casuword"
	72	.It Fn casuword
	73	Compares
	74	.Fa oldval
	75	with the word at
	76	.Fa base ,
	77	and if equal,
	78	.Fa base
	79	is set to
	80	.Fa newval .
	81	The old value at
	82	.Fa base
	83	is then returned.
984263bc MD	84	.It Fn subyte
984263bc MD	85	Stores a byte of data to the user-space address
7ba324e6	86	.Fa base .
984263bc MD	87	.It Fn susword
984263bc MD	88	Stores a short word of data to the user-space address
7ba324e6	89	.Fa base .
984263bc MD	90	.It Fn suword
984263bc MD	91	Stores a word of data to the user-space address
7ba324e6	92	.Fa base .
701e0582 SW	93	.It Fn suword32
	94	Like
	95	.Fn suword ,
	96	for cases when 32 bits are desired.
984263bc MD	97	.El
	98	.Sh RETURN VALUES
	99	The
	100	.Nm
	101	functions return 0 on success or -1 on failure.
	102	.Sh SEE ALSO
	103	.Xr copy 9 ,
	104	.Xr fetch 9