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 October 5, 2009
  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 "void *base" "int byte"
  52 .Ft int
  53 .Fn suword "void *base" "long word"
  54 .Ft int
  55 .Fn suword16 "void *base" "int word"
  56 .Ft int
  57 .Fn suword32 "void *base" "int32_t word"
  58 .Ft int
  59 .Fn suword64 "void *base" "int64_t word"
  60 .In sys/resourcevar.h
  61 .Ft int
  62 .Fn suswintr "void *base" "int word"
  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:
  71 .Bl -tag -width "suswintr()"
  72 .It Fn subyte
  73 Stores a byte of data to the user-space address
  74 .Pa base .
  75 .It Fn suword
  76 Stores a word of data to the user-space address
  77 .Pa base .
  78 .It Fn suword16
  79 Stores 16 bits of data to the user-space address
  80 .Pa base .
  81 .It Fn suword32
  82 Stores 32 bits of data to the user-space address
  83 .Pa base .
  84 .It Fn suword64
  85 Stores 64 bits of data to the user-space address
  86 .Pa base .
  87 .It Fn suswintr
  88 Stores a short word of data to the user-space address
  89 .Pa base .
  90 This function is safe to call during an interrupt context.
  91 .El
  92 .Sh RETURN VALUES
  93 The
  94 .Nm
  95 functions return 0 on success or -1 on failure.
  96 .Sh SEE ALSO
  97 .Xr copy 9 ,
  98 .Xr fetch 9