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$ 36.\" 37.Dd October 29, 2014 38.Dt STORE 9 39.Os 40.Sh NAME 41.Nm store , 42.Nm subyte , 43.Nm suswintr , 44.Nm suword 45.Nd store data to user-space 46.Sh SYNOPSIS 47.In sys/types.h 48.In sys/time.h 49.In sys/systm.h 50.Ft int 51.Fn subyte "volatile void *base" "int byte" 52.Ft int 53.Fn suword "volatile void *base" "long word" 54.Ft int 55.Fn suword16 "volatile void *base" "int word" 56.Ft int 57.Fn suword32 "volatile void *base" "int32_t word" 58.Ft int 59.Fn suword64 "volatile void *base" "int64_t word" 60.In sys/resourcevar.h 61.Ft int 62.Fn suswintr "void *base" "int word" 63.Sh DESCRIPTION 64The 65.Nm 66functions are designed to copy small amounts of data to user-space. 67If write is successful, it is performed atomically. 68The data written must be naturally aligned. 69.Pp 70The 71.Nm 72routines provide the following functionality: 73.Bl -tag -width "suswintr()" 74.It Fn subyte 75Stores a byte of data to the user-space address 76.Pa base . 77.It Fn suword 78Stores a word of data to the user-space address 79.Pa base . 80.It Fn suword16 81Stores 16 bits of data to the user-space address 82.Pa base . 83.It Fn suword32 84Stores 32 bits of data to the user-space address 85.Pa base . 86.It Fn suword64 87Stores 64 bits of data to the user-space address 88.Pa base . 89.It Fn suswintr 90Stores a short word of data to the user-space address 91.Pa base . 92This function is safe to call during an interrupt context. 93.El 94.Sh RETURN VALUES 95The 96.Nm 97functions return 0 on success or -1 on failure. 98.Sh SEE ALSO 99.Xr copy 9 , 100.Xr fetch 9 101