116 lines
3.8 KiB
Groff
116 lines
3.8 KiB
Groff
|
.\" $NetBSD: prop_dictionary_copyin_ioctl.9,v 1.1 2006/07/05 21:46:10 thorpej Exp $
|
||
|
|
.\"
|
||
|
|
.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
|
||
|
|
.\" All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
||
|
|
.\" by Jason R. Thorpe.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
||
|
|
.\" must display the following acknowledgement:
|
||
|
|
.\" This product includes software developed by the NetBSD
|
||
|
|
.\" Foundation, Inc. and its contributors.
|
||
|
|
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
||
|
|
.\" contributors may be used to endorse or promote products derived
|
||
|
|
.\" from this software without specific prior written permission.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
||
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
||
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.Dd July 3, 2006
|
||
|
|
.Dt PROP_DICTIONARY_COPYIN_IOCTL 9
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm prop_dictionary_copyin_ioctl ,
|
||
|
|
.Nm prop_dictionary_copyout_ioctl
|
||
|
|
.Nd Copy property lists to and from kernel space
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In prop/proplib.h
|
||
|
|
.Ft int
|
||
|
|
.Fn prop_dictionary_copyin_ioctl "const struct plistref *pref" \
|
||
|
|
"int ioctlflags" "prop_dictionary_t *dictp"
|
||
|
|
.Ft int
|
||
|
|
.Fn prop_dictionary_copyout_ioctl "struct plistref *pref" \
|
||
|
|
"prop_dictionary_t dict" "int ioctlflags"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Nm prop_dictionary_copyin_ioctl
|
||
|
|
and
|
||
|
|
.Nm prop_dictionary_copyout_ioctl
|
||
|
|
functions implement the kernel side of a protocol for sending property lists
|
||
|
|
to and from the kernel using
|
||
|
|
.Xr ioctl 2 .
|
||
|
|
.Pp
|
||
|
|
A kernel ioctl routine receivig or returning a property list will be passed a
|
||
|
|
pointer to a
|
||
|
|
.Vt struct plistref .
|
||
|
|
This structure encapsulates the reference to the property list in externalized
|
||
|
|
form.
|
||
|
|
.Pp
|
||
|
|
The following
|
||
|
|
.Pq simplified
|
||
|
|
example demonstrates using
|
||
|
|
.Fn prop_dictionary_copyin_ioctl
|
||
|
|
and
|
||
|
|
.Fn prop_dictionary_copyout_ioctl
|
||
|
|
in an ioctl routine:
|
||
|
|
.Bd -literal
|
||
|
|
extern prop_dictionary_t fooprops;
|
||
|
|
|
||
|
|
int
|
||
|
|
fooioctl(dev_t dev, u_long cmd, caddr_t data, int flag, struct lwp *l)
|
||
|
|
{
|
||
|
|
prop_dictionary_t dict, odict;
|
||
|
|
int error;
|
||
|
|
|
||
|
|
switch (cmd) {
|
||
|
|
case FOOSETPROPS: {
|
||
|
|
const struct plistref *pref = (const struct plistref *) data;
|
||
|
|
error = prop_dictionary_copyin_ioctl(pref, flag, &dict);
|
||
|
|
if (error)
|
||
|
|
return (error);
|
||
|
|
odict = fooprops;
|
||
|
|
fooprops = dict;
|
||
|
|
prop_object_release(odict);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
case FOOGETPROPS: {
|
||
|
|
struct plistref *pref = (struct plistref *) data;
|
||
|
|
error = prop_dictionary_copyout_ioctl(pref, fooprops, flag);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
default:
|
||
|
|
return (EPASSTHROUGH);
|
||
|
|
}
|
||
|
|
return (error);
|
||
|
|
}
|
||
|
|
.Ed
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr prop_dictionary 3 ,
|
||
|
|
.Xr prop_dictionary_send_ioctl 3 ,
|
||
|
|
.Xr proplib 3
|
||
|
|
.Sh HISTORY
|
||
|
|
The
|
||
|
|
.Nm proplib
|
||
|
|
property container object library first appeared in
|
||
|
|
.Nx 4.0 .
|