bsd/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: src/share/man/man9/store.9,v 1.7.2.4 2001/12/17 11:30:19 ru Exp $
  36 .\"
  37 .Dd December 16, 2004
  38 .Dt STORE 9
  39 .Os
  40 .Sh NAME
  41 .Nm store ,
  42 .Nm subyte ,
  43 .Nm suibyte ,
  44 .Nm suword ,
  45 .Nm suiword ,
  46 .Nm sulong ,
  47 .Nm suulong
  48 .Nd store data to user-space
  49 .Sh SYNOPSIS
  50 .In sys/types.h
  51 .In sys/time.h
  52 .In sys/systm.h
  53 .In sys/resourcevar.h
  54 .Ft int
  55 .Fn subyte "user_addr_t addr" "int byte"
  56 .Ft int
  57 .Fn suibyte "user_addr_t addr" "int byte"
  58 .Ft int
  59 .Fn suword "user_addr_t addr" "int word"
  60 .Ft int
  61 .Fn suiword "user_addr_t addr" "int word"
  62 .Ft int
  63 .Fn sulong "user_addr_t addr" "int64_t longword"
  64 .Ft int
  65 .Fn suulong "user_addr_t addr" "uint64_t longword"
  66 .Sh DESCRIPTION
  67 The
  68 .Nm
  69 functions are designed to copy small amounts of data to user-space.
  70 .Pp
  71 The
  72 .Nm
  73 routines provide the following functionality:
  74 .Bl -tag -width "suibyte()"
  75 .It Fn subyte
  76 Stores a byte of data to the user-space address
  77 .Pa addr .
  78 .It Fn suibyte
  79 Stores a byte of data to the user-space address
  80 .Pa addr .
  81 This function is safe to call during an interrupt context.
  82 .It Fn suword
  83 Stores a word of data to the user-space address
  84 .Pa addr .
  85 .It Fn suiword
  86 Stores a word of data to the user-space address
  87 .Pa addr .
  88 This function is safe to call during an interrupt context.
  89 .It Fn sulong
  90 Stores a long word of data to the user-space address
  91 .Pa addr .
  92 .It Fn suulong
  93 Stores a unsigned long word of data to the user-space address
  94 .Pa addr .
  95 .El
  96 .Sh RETURN VALUES
  97 The
  98 .Nm
  99 functions return 0 on success or -1 on failure.
 100 .Sh SEE ALSO
 101 .Xr copy 9 ,
 102 .Xr fetch 9