FreeBSD/Linux Kernel Cross Reference
sys/sys/drvctlio.h
1 /* $NetBSD: drvctlio.h,v 1.3 2006/09/22 04:37:37 thorpej Exp $ */
2
3 /*-
4 * Copyright (c) 2006 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 /* This interface is experimental and may change. */
40
41 #ifndef _SYS_DRVCTLIO_H_
42 #define _SYS_DRVCTLIO_H_
43
44 #include <prop/proplib.h>
45 #include <sys/ioccom.h>
46
47 #define DRVCTLDEV "/dev/drvctl"
48
49 struct devdetachargs {
50 char devname[16];
51 };
52
53 struct devrescanargs {
54 char busname[16];
55 char ifattr[16];
56 unsigned int numlocators;
57 int *locators;
58 };
59
60 #define DRVDETACHDEV _IOW('D', 123, struct devdetachargs)
61 #define DRVRESCANBUS _IOW('D', 124, struct devrescanargs)
62
63 /*
64 * Generic ioctl that takes a dictionary as an argument (specifies the
65 * command and arguments) and returns a dictionary with the results.
66 *
67 * Command arguments are structured like so:
68 *
69 * <dict>
70 * <key>drvctl-command</key>
71 * <string>...</string>
72 * <!-- optional arguments -->
73 * <key>drvctl-arguments</key>
74 * <dict>
75 * <!-- arguments vary with command -->
76 * </dict>
77 * </dict>
78 *
79 * Results are returned like so:
80 *
81 * <dict>
82 * <key>drvctl-error</key>
83 * <!-- 0 == success, otherwise an errno value -->
84 * <integer>...</integer>
85 * <!-- optional additional error message -->
86 * <key>drvctl-error-message</key>
87 * <string>...</string>
88 * <!-- optional results dictionary -->
89 * <key>drvctl-result-data</key>
90 * <dict>
91 * <!-- results vary with command -->
92 * </dict>
93 * </dict>
94 */
95 #define DRVCTLCOMMAND _IOWR('D', 125, struct plistref)
96
97 /*****************************************************************************
98 * Commands recognized by DRVCTLCOMMAND
99 *****************************************************************************/
100
101 /*
102 * get-properties
103 *
104 * Arguments:
105 *
106 * <dict>
107 * <key>device-name</key>
108 * <string>...</string>
109 * </dict>
110 *
111 * Results:
112 * <dict>
113 * <!-- contents of device's properties dictionary -->
114 * </dict>
115 */
116
117 #endif /* _SYS_DRVCTLIO_H_ */
Cache object: 463e7403ea7abd4dc942ff795f2c8dfb
|