share/man/man9/store.9

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