1 .\" $NetBSD: prop_send_ioctl.3,v 1.5 2008/04/30 13:10:46 martin Exp $
3 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Jason R. Thorpe.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
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.
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.
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
45 .Fn prop_array_send_ioctl "prop_array_t array" "int fd" "unsigned long cmd"
47 .Fn prop_array_recv_ioctl "int fd" "unsigned long cmd" "prop_array_t *arrayp"
49 .Fn prop_dictionary_send_ioctl "prop_dictionary_t dict" "int fd" \
52 .Fn prop_dictionary_recv_ioctl "int fd" "unsigned long cmd" \
53 "prop_dictionary_t *dictp"
54 .Fn prop_dictionary_sendrecv_ioctl "prop_dictionary_t dict" "int fd" \
55 "unsigned long cmd" "prop_dictionary_t *dictp"
58 .Nm prop_array_send_ioctl ,
59 .Nm prop_array_recv_ioctl ,
60 .Nm prop_dictionary_send_ioctl ,
61 .Nm prop_dictionary_recv_ioctl ,
63 .Nm prop_dictionary_sendrecv_ioctl
64 functions implement the user space side of a protocol for sending property
65 lists to and from the kernel using
68 If successful, functions return zero. Otherwise, an error number is returned to indicate the error.
70 .Fn prop_array_send_ioctl
72 .Fn prop_dictionary_send_ioctl
76 Cannot allocate memory
81 .Fn prop_array_recv_ioctl
83 .Fn prop_dictionary_recv_ioctl
94 errors may be returned.
98 example demonstrates using
99 .Fn prop_dictionary_send_ioctl
101 .Fn prop_dictionary_recv_ioctl
105 foo_setprops(prop_dictionary_t dict)
109 fd = open("/dev/foo", O_RDWR, 0640);
113 (void) prop_dictionary_send_ioctl(dict, fd, FOOSETPROPS);
121 prop_dictionary_t dict;
124 fd = open("/dev/foo", O_RDONLY, 0640);
128 if (prop_dictionary_recv_ioctl(fd, FOOGETPROPS, \*[Am]dict) != 0)
138 .Nm prop_dictionary_sendrecv_ioctl
139 function combines the send and receive functionality, allowing for
140 ioctls that require two-way communication
141 .Pq for example to specify arguments for the ioctl operation .
144 .Xr prop_dictionary 3 ,
146 .Xr prop_copyin_ioctl 9
150 property container object library first appeared in