lib/libprop/prop_send_ioctl.3

   1 .\"     $NetBSD: prop_send_ioctl.3,v 1.6 2011/01/20 10:44:42 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Jason R. Thorpe.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\" notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\" notice, this list of conditions and the following disclaimer in the
  16 .\" documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd January 21, 2008
  31 .Dt PROP_SEND_IOCTL 3
  32 .Os
  33 .Sh NAME
  34 .Nm prop_array_send_ioctl ,
  35 .Nm prop_array_recv_ioctl ,
  36 .Nm prop_dictionary_send_ioctl ,
  37 .Nm prop_dictionary_recv_ioctl ,
  38 .Nm prop_dictionary_sendrecv_ioctl
  39 .Nd Send and receive propertly lists to and from the kernel using ioctl
  40 .Sh SYNOPSIS
  41 .In libprop/proplib.h
  42 .Ft int
  43 .Fn prop_array_send_ioctl "prop_array_t array" "int fd" "unsigned long cmd"
  44 .Ft int
  45 .Fn prop_array_recv_ioctl "int fd" "unsigned long cmd" "prop_array_t *arrayp"
  46 .Ft int
  47 .Fn prop_dictionary_send_ioctl "prop_dictionary_t dict" "int fd" \
  48     "unsigned long cmd"
  49 .Ft int
  50 .Fn prop_dictionary_recv_ioctl "int fd" "unsigned long cmd" \
  51     "prop_dictionary_t *dictp"
  52 .Fn prop_dictionary_sendrecv_ioctl "prop_dictionary_t dict" "int fd" \
  53     "unsigned long cmd" "prop_dictionary_t *dictp"
  54 .Sh DESCRIPTION
  55 The
  56 .Nm prop_array_send_ioctl ,
  57 .Nm prop_array_recv_ioctl ,
  58 .Nm prop_dictionary_send_ioctl ,
  59 .Nm prop_dictionary_recv_ioctl ,
  60 and
  61 .Nm prop_dictionary_sendrecv_ioctl
  62 functions implement the user space side of a protocol for sending property
  63 lists to and from the kernel using
  64 .Xr ioctl 2 .
  65 .Sh RETURN VALUES
  66 If successful, functions return zero.
  67 Otherwise, an error number is returned to indicate the error.
  68 .Sh EXAMPLES
  69 The following
  70 .Pq simplified
  71 example demonstrates using
  72 .Fn prop_dictionary_send_ioctl
  73 and
  74 .Fn prop_dictionary_recv_ioctl
  75 in an application:
  76 .Bd -literal
  77 void
  78 foo_setprops(prop_dictionary_t dict)
  79 {
  80     int fd;
  81
  82     fd = open("/dev/foo", O_RDWR, 0640);
  83     if (fd == -1)
  84         return;
  85
  86     (void) prop_dictionary_send_ioctl(dict, fd, FOOSETPROPS);
  87
  88     (void) close(fd);
  89 }
  90
  91 prop_dictionary_t
  92 foo_getprops(void)
  93 {
  94     prop_dictionary_t dict;
  95     int fd;
  96
  97     fd = open("/dev/foo", O_RDONLY, 0640);
  98     if (fd == -1)
  99         return (NULL);
 100
 101     if (prop_dictionary_recv_ioctl(fd, FOOGETPROPS, \*[Am]dict) != 0)
 102         return (NULL);
 103
 104     (void) close(fd);
 105
 106     return (dict);
 107 }
 108 .Ed
 109 .Pp
 110 The
 111 .Nm prop_dictionary_sendrecv_ioctl
 112 function combines the send and receive functionality, allowing for
 113 ioctls that require two-way communication
 114 .Pq for example to specify arguments for the ioctl operation .
 115 .Sh ERRORS
 116 .Fn prop_array_send_ioctl
 117 and
 118 .Fn prop_dictionary_send_ioctl
 119 will fail if:
 120 .Bl -tag -width Er
 121 .It Bq Er ENOMEM
 122 Cannot allocate memory
 123 .It Bq Er ENOTSUP
 124 Not supported
 125 .El
 126 .Pp
 127 .Fn prop_array_recv_ioctl
 128 and
 129 .Fn prop_dictionary_recv_ioctl
 130 will fail if:
 131 .Bl -tag -width Er
 132 .It Bq Er EIO
 133 Input/output error
 134 .It Bq Er ENOTSUP
 135 Not supported
 136 .El
 137 .Pp
 138 In addition to these,
 139 .Xr ioctl 2
 140 errors may be returned.
 141 .Sh SEE ALSO
 142 .Xr prop_array 3 ,
 143 .Xr prop_dictionary 3 ,
 144 .Xr proplib 3 ,
 145 .Xr prop_copyin_ioctl 9
 146 .Sh HISTORY
 147 The
 148 .Nm proplib
 149 property container object library first appeared in
 150 .Nx 4.0 .