config_hook.h revision 1.12 1 /* $NetBSD: config_hook.h,v 1.12 2001/01/04 05:16:26 sato Exp $ */
2
3 /*-
4 * Copyright (c) 1999
5 * Shin Takemura and PocketBSD Project. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by the PocketBSD project
18 * and its contributors.
19 * 4. Neither the name of the project nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 */
36
37 #ifndef _CONFIG_HOOK_H_
38 #define _CONFIG_HOOK_H_
39
40 enum config_hook_mode {
41 CONFIG_HOOK_SHARE,
42 CONFIG_HOOK_REPLACE,
43 CONFIG_HOOK_EXCLUSIVE,
44 };
45
46 typedef void *config_hook_tag;
47
48 void config_hook_init __P((void));
49 config_hook_tag config_hook __P((int type, long id, enum config_hook_mode mode,
50 int (*func) __P((void*, int, long, void*)),
51 void *ctx));
52 void config_unhook __P((config_hook_tag));
53 int config_hook_call __P((int type, long id, void *msg));
54
55 /*
56 * hook types and IDs
57 */
58 #define CONFIG_HOOK_POWERCONTROL 0
59 #define CONFIG_HOOK_POWERCONTROL_COM0 0
60 #define CONFIG_HOOK_POWERCONTROL_COM1 1
61 #define CONFIG_HOOK_POWERCONTROL_COM2 2
62 #define CONFIG_HOOK_POWERCONTROL_COM3 3
63 #define CONFIG_HOOK_POWERCONTROL_LCDLIGHT 4
64 #define CONFIG_HOOK_POWERCONTROL_LCD 5
65 #define CONFIG_HOOK_POWERCONTROL_SPEAKER 6
66 #define CONFIG_HOOK_POWERCONTROL_LED 7
67
68 #define CONFIG_HOOK_BUTTONEVENT 1
69 #define CONFIG_HOOK_BUTTONEVENT_POWER 0
70 #define CONFIG_HOOK_BUTTONEVENT_OK 1
71 #define CONFIG_HOOK_BUTTONEVENT_CANCEL 2
72 #define CONFIG_HOOK_BUTTONEVENT_UP 3
73 #define CONFIG_HOOK_BUTTONEVENT_DOWN 4
74 #define CONFIG_HOOK_BUTTONEVENT_REC 5
75 #define CONFIG_HOOK_BUTTONEVENT_COVER 6
76 #define CONFIG_HOOK_BUTTONEVENT_LIGHT 7
77 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST 8
78 #define CONFIG_HOOK_BUTTONEVENT_APP0 9
79 #define CONFIG_HOOK_BUTTONEVENT_APP1 10
80 #define CONFIG_HOOK_BUTTONEVENT_APP2 11
81 #define CONFIG_HOOK_BUTTONEVENT_APP3 12
82 #define CONFIG_HOOK_BUTTONEVENT_LEFT 13
83 #define CONFIG_HOOK_BUTTONEVENT_RIGHT 14
84 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST_UP 15
85 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST_DOWN 16
86 #define CONFIG_HOOK_BUTTONEVENT_LIGHT_UP 17
87 #define CONFIG_HOOK_BUTTONEVENT_LIGHT_DOWN 18
88
89 /* apm releted events */
90 #define CONFIG_HOOK_PMEVENT 2
91 #define CONFIG_HOOK_PMEVENT_STANDBYREQ 0
92 #define CONFIG_HOOK_PMEVENT_SUSPENDREQ 1
93 #define CONFIG_HOOK_PMEVENT_HARDPOWER 2
94 #define CONFIG_HOOK_PMEVENT_BATTERY 3
95 #define CONFIG_HOOK_PMEVENT_AC 4
96
97
98 /* get value */
99 #define CONFIG_HOOK_GET 3
100 /* set value and send event */
101 #define CONFIG_HOOK_SET 4
102 /* external event */
103 #define CONFIG_HOOK_EVENT CONFIG_HOOK_SET
104
105
106 /* CONFIG_HOOK_GET/CONFIG_HOOK_SET/CONFIG_HOOK_EVENT event id's */
107 #define CONFIG_HOOK_POWER_COM0 0
108 #define CONFIG_HOOK_POWER_COM1 1
109 #define CONFIG_HOOK_POWER_COM2 2
110 #define CONFIG_HOOK_POWER_COM3 3
111 #define CONFIG_HOOK_POWER_LCDLIGHT 4
112 #define CONFIG_HOOK_POWER_LCD 5
113 #define CONFIG_HOOK_POWER_SPEAKER 6
114 #define CONFIG_HOOK_BUTTON_POWER 7
115 #define CONFIG_HOOK_BUTTON_OK 8
116 #define CONFIG_HOOK_BUTTON_CANCEL 9
117 #define CONFIG_HOOK_BUTTON_UP 10
118 #define CONFIG_HOOK_BUTTON_DOWN 11
119 #define CONFIG_HOOK_BUTTON_REC 12
120 #define CONFIG_HOOK_BUTTON_COVER 13
121 #define CONFIG_HOOK_BUTTON_LIGHT 14
122 #define CONFIG_HOOK_BUTTON_CONTRAST 15
123 #define CONFIG_HOOK_BUTTON_APP0 16
124 #define CONFIG_HOOK_BUTTON_APP1 17
125 #define CONFIG_HOOK_BUTTON_APP2 18
126 #define CONFIG_HOOK_BUTTON_APP3 19
127 #define CONFIG_HOOK_BUTTON_LEFT 20
128 #define CONFIG_HOOK_BUTTON_RIGHT 21
129 #define CONFIG_HOOK_BUTTON_CONTRAST_UP 22
130 #define CONFIG_HOOK_BUTTON_CONTRAST_DOWN 23
131 #define CONFIG_HOOK_BUTTON_LIGHT_UP 24
132 #define CONFIG_HOOK_BUTTON_LIGHT_DOWN 25
133 #define CONFIG_HOOK_LED 26
134 #define CONFIG_HOOK_LED_MAX 27
135 #define CONFIG_HOOK_CONTRAST 28
136 #define CONFIG_HOOK_CONTRAST_MAX 29
137 #define CONFIG_HOOK_BRIGHTNESS 30
138 #define CONFIG_HOOK_BRIGHTNESS_MAX 31
139 #define CONFIG_HOOK_COM0_CTS 32
140 #define CONFIG_HOOK_COM1_CTS 33
141 #define CONFIG_HOOK_COM2_CTS 34
142 #define CONFIG_HOOK_COM3_CTS 35
143 #define CONFIG_HOOK_COM0_DCD 36
144 #define CONFIG_HOOK_COM1_DCD 37
145 #define CONFIG_HOOK_COM2_DCD 38
146 #define CONFIG_HOOK_COM3_DCD 39
147 #define CONFIG_HOOK_COM0_RTS 40
148 #define CONFIG_HOOK_COM1_RTS 41
149 #define CONFIG_HOOK_COM2_RTS 42
150 #define CONFIG_HOOK_COM3_RTS 43
151 #define CONFIG_HOOK_COM0_DTR 44
152 #define CONFIG_HOOK_COM1_DTR 45
153 #define CONFIG_HOOK_COM2_DTR 46
154 #define CONFIG_HOOK_COM3_DTR 47
155 #define CONFIG_HOOK_BATTERYVAL 48
156 #define CONFIG_HOOK_ACADAPTER 49
157 #define CONFIG_HOOK_CHARGE 50
158
159 #define CONFIG_HOOK_NTYPES 5
160
161 /*
162 * nicknames for including from configration file.
163 */
164 #ifdef CONFIG_HOOK_DEFINE_NICKNAME
165 #define POWER CONFIG_HOOK_POWERCONTROL
166 #define BUTTON CONFIG_HOOK_BUTTONEVENT
167 #define PMEVENT CONFIG_HOOK_PMEVENT
168 #define SET CONFIG_HOOK_SET
169 #define EVENT CONFIG_HOOK_EVENT
170 #define GET CONFIG_HOOK_GET
171
172 #define PWCTL_COM0 CONFIG_HOOK_POWERCONTROL_COM0
173 #define PWCTL_COM1 CONFIG_HOOK_POWERCONTROL_COM1
174 #define PWCTL_COM2 CONFIG_HOOK_POWERCONTROL_COM2
175 #define PWCTL_COM3 CONFIG_HOOK_POWERCONTROL_COM3
176 #define PWCTL_LCDLIGHT CONFIG_HOOK_POWERCONTROL_LCDLIGHT
177 #define PWCTL_LCD CONFIG_HOOK_POWERCONTROL_LCD
178 #define PWCTL_SPEAKER CONFIG_HOOK_POWERCONTROL_SPEAKER
179 #define PWCTL_LED CONFIG_HOOK_POWERCONTROL_LED
180 #define BTN_POWER CONFIG_HOOK_BUTTONEVENT_POWER
181 #define BTN_OK CONFIG_HOOK_BUTTONEVENT_OK
182 #define BTN_CANCEL CONFIG_HOOK_BUTTONEVENT_CANCEL
183 #define BTN_UP CONFIG_HOOK_BUTTONEVENT_UP
184 #define BTN_DOWN CONFIG_HOOK_BUTTONEVENT_DOWN
185 #define BTN_REC CONFIG_HOOK_BUTTONEVENT_REC
186 #define BTN_COVER CONFIG_HOOK_BUTTONEVENT_COVER
187 #define BTN_LIGHT CONFIG_HOOK_BUTTONEVENT_LIGHT
188 #define BTN_CONTRAST CONFIG_HOOK_BUTTONEVENT_CONTRAST
189 #define BTN_APP0 CONFIG_HOOK_BUTTONEVENT_APP0
190 #define BTN_APP1 CONFIG_HOOK_BUTTONEVENT_APP1
191 #define BTN_APP2 CONFIG_HOOK_BUTTONEVENT_APP2
192 #define BTN_APP3 CONFIG_HOOK_BUTTONEVENT_APP3
193 #define BTN_LEFT CONFIG_HOOK_BUTTONEVENT_LEFT
194 #define BTN_RIGHT CONFIG_HOOK_BUTTONEVENT_RIGHT
195 #define BTN_CONTRAST_UP CONFIG_HOOK_BUTTONEVENT_CONTRAST_UP
196 #define BTN_CONTRAST_DN CONFIG_HOOK_BUTTONEVENT_CONTRAST_DOWN
197 #define BTN_LIGHT_UP CONFIG_HOOK_BUTTONEVENT_LIGHT_UP
198 #define BTN_LIGHT_DN CONFIG_HOOK_BUTTONEVENT_LIGHT_DOWN
199 /* PMEVENT */
200 #define PME_STANBY CONFIG_HOOK_PMEVENT_STANDBYREQ
201 #define PME_SUSPEND CONFIG_HOOK_PMEVENT_SUSPENDREQ
202 #define PME_HARDPOWER CONFIG_HOOK_PMEVENT_HARDPOWER
203 #define PME_BATTERY CONFIG_HOOK_PMEVENT_BATTERY
204 #define PME_AC CONFIG_HOOK_PMEVENT_AC
205 /* new one */
206 #define POWER_COM0 CONFIG_HOOK_POWER_COM0
207 #define POWER_COM1 CONFIG_HOOK_POWER_COM1
208 #define POWER_COM2 CONFIG_HOOK_POWER_COM2
209 #define POWER_COM3 CONFIG_HOOK_POWER_COM3
210 #define POWER_LCDLIGHT CONFIG_HOOK_POWER_LCDLIGHT
211 #define POWER_LCD CONFIG_HOOK_POWER_LCD
212 #define POWER_SPEAKER CONFIG_HOOK_POWER_SPEAKER
213 #define BUTTON_POWER CONFIG_HOOK_BUTTON_POWER
214 #define BUTTON_OK CONFIG_HOOK_BUTTON_OK
215 #define BUTTON_CANCEL CONFIG_HOOK_BUTTON_CANCEL
216 #define BUTTON_UP CONFIG_HOOK_BUTTON_UP
217 #define BUTTON_DOWN CONFIG_HOOK_BUTTON_DOWN
218 #define BUTTON_REC CONFIG_HOOK_BUTTON_REC
219 #define BUTTON_COVER CONFIG_HOOK_BUTTON_COVER
220 #define BUTTON_LIGHT CONFIG_HOOK_BUTTON_LIGHT
221 #define BUTTON_CONTRAST CONFIG_HOOK_BUTTON_CONTRAST
222 #define BUTTON_APP0 CONFIG_HOOK_BUTTON_APP0
223 #define BUTTON_APP1 CONFIG_HOOK_BUTTON_APP1
224 #define BUTTON_APP2 CONFIG_HOOK_BUTTON_APP2
225 #define BUTTON_APP3 CONFIG_HOOK_BUTTON_APP3
226 #define BUTTON_LEFT CONFIG_HOOK_BUTTON_LEFT
227 #define BUTTON_RIGHT CONFIG_HOOK_BUTTON_RIGHT
228 #define BUTTON_CONTRAST_UP CONFIG_HOOK_BUTTON_CONTRAST_UP
229 #define BUTTON_CONTRAST_DOWN CONFIG_HOOK_BUTTON_CONTRAST_DOWN
230 #define BUTTON_LIFHT_UP CONFIG_HOOK_BUTTON_LIGHT_UP
231 #define BUTTON_LIFHT_DOWN CONFIG_HOOK_BUTTON_LIGHT_DOWN
232 #define LED CONFIG_HOOK_LED
233 #define LED_MAX CONFIG_HOOK_LED_MAX
234 #define CONTRAST CONFIG_HOOK_CONTRAST
235 #define CONTRAST_MAX CONFIG_HOOK_CONTRAST_MAX
236 #define BRIGHTNESS CONFIG_HOOK_BRIGHTNESS
237 #define BRIGHTNESS_MAX CONFIG_HOOK_BRIGHTNESS_MAX
238 #define COM0_CTS CONFIG_HOOK_COM0_CTS
239 #define COM1_CTS CONFIG_HOOK_COM1_CTS
240 #define COM2_CTS CONFIG_HOOK_COM2_CTS
241 #define COM3_CTS CONFIG_HOOK_COM3_CTS
242 #define COM0_DCD CONFIG_HOOK_COM0_DCD
243 #define COM1_DCD CONFIG_HOOK_COM1_DCD
244 #define COM2_DCD CONFIG_HOOK_COM2_DCD
245 #define COM3_DCD CONFIG_HOOK_COM3_DCD
246 #define COM0_RTS CONFIG_HOOK_COM0_RTS
247 #define COM1_RTS CONFIG_HOOK_COM1_RTS
248 #define COM2_RTS CONFIG_HOOK_COM2_RTS
249 #define COM3_RTS CONFIG_HOOK_COM3_RTS
250 #define COM0_DTR CONFIG_HOOK_COM0_DTR
251 #define COM1_DTR CONFIG_HOOK_COM1_DTR
252 #define COM2_DTR CONFIG_HOOK_COM2_DTR
253 #define COM3_DTR CONFIG_HOOK_COM3_DTR
254 #define BATTERYVAL CONFIG_HOOK_BATTERYVAL
255 #define ACADAPTER CONFIG_HOOK_ACADAPTER
256 #define CHARGE CONFIG_HOOK_CHARGE
257 #endif /* CONFIG_HOOK_DEFINE_NICKNAME */
258
259 #define CONFIG_HOOK_MAXVALUE 1 /* max value, check in this file */
260 #define CONFIG_HOOK_VALUEP(p) ((int)(p)>= 0 && (int)(p)<= CONFIG_HOOK_MAXVALUE)
261 #define CONFIG_HOOK_PTRP(p) (!CONFIG_HOOK_VALUEP(p))
262
263 /*
264 * POWERCONTROL value
265 */
266 #define PWCTL_ON ((void *)1)
267 #define PWCTL_OFF ((void *)0)
268
269 /* CONFIG_HOOK typical value */
270 #define CONFIG_HOOK_ON 1
271 #define CONFIG_HOOK_OFF 0
272
273 /*
274 * CONFIG_HOOK_LED value
275 */
276 #define CONFIG_HOOK_LED_ON 0
277 #define CONFIG_HOOK_LED_OFF 1
278 #define CONFIG_HOOK_LED_FLASH 2 /* flash 100msec */
279 #define CONFIG_HOOK_LED_FLASH2 3 /* flash 200msec */
280 #define CONFIG_HOOK_LED_FLASH5 4 /* flash 500msec */
281 #define CONFIG_HOOK_LED_BLINK 5 /* blink 1sec interval */
282 #define CONFIG_HOOK_LED_BLINK2 6 /* blink 2sec interval */
283
284 /*
285 * CONFIG_HOOK_AC event value
286 */
287 #define CONFIG_HOOK_AC_OFF 0
288 #define CONFIG_HOOK_AC_ON_CHARGE 1
289 #define CONFIG_HOOK_AC_ON_NOCHARGE 2
290 #define CONFIG_HOOK_AC_UNKNOWN 3
291
292 /*
293 * CONFIG_HOOK_BATTERY event value
294 */
295 #define CONFIG_HOOK_BATT_CRITICAL 0
296 #define CONFIG_HOOK_BATT_20P 1
297 #define CONFIG_HOOK_BATT_LOW 2
298 #define CONFIG_HOOK_BATT_50P 3
299 #define CONFIG_HOOK_BATT_HIGH 4
300 #define CONFIG_HOOK_BATT_80P 5
301 #define CONFIG_HOOK_BATT_100P 6
302 #define CONFIG_HOOK_BATT_UNKNOWN 7
303 #define CONFIG_HOOK_BATT_NO_SYSTEM_BATTERY 8
304 #endif /* _CONFIG_HOOK_H_ */
305