| 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 | .\" $DragonFly: src/share/man/man9/store.9,v 1.3 2007/02/10 20:46:36 swildner Exp $ |
| 37 | .\" |
| 38 | .Dd January 7, 1996 |
| 39 | .Dt STORE 9 |
| 40 | .Os |
| 41 | .Sh NAME |
| 42 | .Nm store , |
| 43 | .Nm subyte , |
| 44 | .Nm susword , |
| 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 suword "void *base" "long word" |
| 58 | .Sh DESCRIPTION |
| 59 | The |
| 60 | .Nm |
| 61 | functions are designed to copy small amounts of data to user-space. |
| 62 | .Pp |
| 63 | The |
| 64 | .Nm |
| 65 | routines provide the following functionality: |
| 66 | .Bl -tag -width ".Fn susword" |
| 67 | .It Fn subyte |
| 68 | Stores a byte of data to the user-space address |
| 69 | .Pa base . |
| 70 | .It Fn susword |
| 71 | Stores a short word of data to the user-space address |
| 72 | .Pa base . |
| 73 | .It Fn suword |
| 74 | Stores a word of data to the user-space address |
| 75 | .Pa base . |
| 76 | .El |
| 77 | .Sh RETURN VALUES |
| 78 | The |
| 79 | .Nm |
| 80 | functions return 0 on success or -1 on failure. |
| 81 | .Sh SEE ALSO |
| 82 | .Xr copy 9 , |
| 83 | .Xr fetch 9 |