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 December 23, 2011 38.Dt STORE 9 39.Os 40.Sh NAME 41.Nm store , 42.Nm casuword , 43.Nm subyte , 44.Nm susword , 45.Nm suword , 46.Nm suword32 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 53.Ft u_long 54.Fn casuword "u_long *base" "u_long oldval" "u_long newval" 55.Ft int 56.Fn subyte "void *base" "int byte" 57.Ft int 58.Fn susword "void *base" "int word" 59.Ft int 60.Fn suword "void *base" "long word" 61.Ft int 62.Fn suword32 "void *base" "int word" 63.Sh DESCRIPTION 64The 65.Nm 66functions are designed to copy small amounts of data to user-space. 67.Pp 68The 69.Nm 70routines provide the following functionality: 71.Bl -tag -width ".Fn casuword" 72.It Fn casuword 73Compares 74.Fa oldval 75with the word at 76.Fa base , 77and if equal, 78.Fa base 79is set to 80.Fa newval . 81The old value at 82.Fa base 83is then returned. 84.It Fn subyte 85Stores a byte of data to the user-space address 86.Fa base . 87.It Fn susword 88Stores a short word of data to the user-space address 89.Fa base . 90.It Fn suword 91Stores a word of data to the user-space address 92.Fa base . 93.It Fn suword32 94Like 95.Fn suword , 96for cases when 32 bits are desired. 97.El 98.Sh RETURN VALUES 99The 100.Nm 101functions return 0 on success or -1 on failure. 102.Sh SEE ALSO 103.Xr copy 9 , 104.Xr fetch 9 105