1.\" $NetBSD: prop_send_ioctl.3,v 1.5 2008/04/30 13:10:46 martin 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 LIBRARY 41.Lb libprop 42.Sh SYNOPSIS 43.In libprop/proplib.h 44.Ft int 45.Fn prop_array_send_ioctl "prop_array_t array" "int fd" "unsigned long cmd" 46.Ft int 47.Fn prop_array_recv_ioctl "int fd" "unsigned long cmd" "prop_array_t *arrayp" 48.Ft int 49.Fn prop_dictionary_send_ioctl "prop_dictionary_t dict" "int fd" \ 50 "unsigned long cmd" 51.Ft int 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" 56.Sh DESCRIPTION 57The 58.Nm prop_array_send_ioctl , 59.Nm prop_array_recv_ioctl , 60.Nm prop_dictionary_send_ioctl , 61.Nm prop_dictionary_recv_ioctl , 62and 63.Nm prop_dictionary_sendrecv_ioctl 64functions implement the user space side of a protocol for sending property 65lists to and from the kernel using 66.Xr ioctl 2 . 67.Sh RETURN VALUES 68If successful, functions return zero. Otherwise, an error number is returned to indicate the error. 69.Sh ERRORS 70.Fn prop_array_send_ioctl 71and 72.Fn prop_dictionary_send_ioctl 73will fail if: 74.Bl -tag -width Er 75.It Bq Er ENOMEM 76Cannot allocate memory 77.It Bq Er ENOTSUP 78Not supported 79.El 80.Pp 81.Fn prop_array_recv_ioctl 82and 83.Fn prop_dictionary_recv_ioctl 84will fail if: 85.Bl -tag -width Er 86.It Bq Er EIO 87Input/output error 88.It Bq Er ENOTSUP 89Not supported 90.El 91.Pp 92In addition to these, 93.Xr ioctl 2 94errors may be returned. 95.Sh EXAMPLES 96The following 97.Pq simplified 98example demonstrates using 99.Fn prop_dictionary_send_ioctl 100and 101.Fn prop_dictionary_recv_ioctl 102in an application: 103.Bd -literal 104void 105foo_setprops(prop_dictionary_t dict) 106{ 107 int fd; 108 109 fd = open("/dev/foo", O_RDWR, 0640); 110 if (fd == -1) 111 return; 112 113 (void) prop_dictionary_send_ioctl(dict, fd, FOOSETPROPS); 114 115 (void) close(fd); 116} 117 118prop_dictionary_t 119foo_getprops(void) 120{ 121 prop_dictionary_t dict; 122 int fd; 123 124 fd = open("/dev/foo", O_RDONLY, 0640); 125 if (fd == -1) 126 return (NULL); 127 128 if (prop_dictionary_recv_ioctl(fd, FOOGETPROPS, \*[Am]dict) != 0) 129 return (NULL); 130 131 (void) close(fd); 132 133 return (dict); 134} 135.Ed 136.Pp 137The 138.Nm prop_dictionary_sendrecv_ioctl 139function combines the send and receive functionality, allowing for 140ioctls that require two-way communication 141.Pq for example to specify arguments for the ioctl operation . 142.Sh SEE ALSO 143.Xr prop_array 3 , 144.Xr prop_dictionary 3 , 145.Xr proplib 3 , 146.Xr prop_copyin_ioctl 9 147.Sh HISTORY 148The 149.Nm proplib 150property container object library first appeared in 151.Nx 4.0 . 152