1.\" $NetBSD: prop_send_ioctl.3,v 1.9 2015/08/20 15:55:09 phx 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 property lists to and from the kernel using ioctl 40.Sh SYNOPSIS 41.In prop/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.Ft int 53.Fn prop_dictionary_sendrecv_ioctl "prop_dictionary_t dict" "int fd" \ 54 "unsigned long cmd" "prop_dictionary_t *dictp" 55.Sh DESCRIPTION 56The 57.Nm prop_array_send_ioctl , 58.Nm prop_array_recv_ioctl , 59.Nm prop_dictionary_send_ioctl , 60.Nm prop_dictionary_recv_ioctl , 61and 62.Nm prop_dictionary_sendrecv_ioctl 63functions implement the user space side of a protocol for sending property 64lists to and from the kernel using 65.Xr ioctl 2 . 66.Sh RETURN VALUES 67If successful, functions return zero. 68Otherwise, an error number is returned to indicate the error. 69.Sh EXAMPLES 70The following 71.Pq simplified 72example demonstrates using 73.Fn prop_dictionary_send_ioctl 74and 75.Fn prop_dictionary_recv_ioctl 76in an application: 77.Bd -literal 78void 79foo_setprops(prop_dictionary_t dict) 80{ 81 int fd; 82 83 fd = open("/dev/foo", O_RDWR, 0640); 84 if (fd == -1) 85 return; 86 87 (void) prop_dictionary_send_ioctl(dict, fd, FOOSETPROPS); 88 89 (void) close(fd); 90} 91 92prop_dictionary_t 93foo_getprops(void) 94{ 95 prop_dictionary_t dict; 96 int fd; 97 98 fd = open("/dev/foo", O_RDONLY, 0640); 99 if (fd == -1) 100 return (NULL); 101 102 if (prop_dictionary_recv_ioctl(fd, FOOGETPROPS, \*[Am]dict) != 0) 103 return (NULL); 104 105 (void) close(fd); 106 107 return (dict); 108} 109.Ed 110.Pp 111The 112.Nm prop_dictionary_sendrecv_ioctl 113function combines the send and receive functionality, allowing for 114ioctls that require two-way communication 115.Pq for example to specify arguments for the ioctl operation . 116.Sh ERRORS 117.Fn prop_array_send_ioctl 118and 119.Fn prop_dictionary_send_ioctl 120will fail if: 121.Bl -tag -width Er 122.It Bq Er ENOMEM 123Cannot allocate memory 124.It Bq Er ENOTSUP 125Not supported 126.El 127.Pp 128.Fn prop_array_recv_ioctl 129and 130.Fn prop_dictionary_recv_ioctl 131will fail if: 132.Bl -tag -width Er 133.It Bq Er EIO 134Input/output error 135.It Bq Er ENOTSUP 136Not supported 137.El 138.Pp 139In addition to these, 140.Xr ioctl 2 141errors may be returned. 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