config_hook.h revision 1.13 1 /* $NetBSD: config_hook.h,v 1.13 2001/01/26 03:42:30 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 /* apm releted events */
59 #define CONFIG_HOOK_PMEVENT 0
60 #define CONFIG_HOOK_PMEVENT_STANDBYREQ 0
61 #define CONFIG_HOOK_PMEVENT_SUSPENDREQ 1
62 #define CONFIG_HOOK_PMEVENT_HARDPOWER 2
63 #define CONFIG_HOOK_PMEVENT_BATTERY 3
64 #define CONFIG_HOOK_PMEVENT_AC 4
65
66
67 /* get value */
68 #define CONFIG_HOOK_GET 1
69 /* set value and send event */
70 #define CONFIG_HOOK_SET 2
71 /* external event */
72 #define CONFIG_HOOK_EVENT CONFIG_HOOK_SET
73
74
75 /* CONFIG_HOOK_GET/CONFIG_HOOK_SET/CONFIG_HOOK_EVENT event id's */
76 #define CONFIG_HOOK_POWER_COM0 0
77 #define CONFIG_HOOK_POWER_COM1 1
78 #define CONFIG_HOOK_POWER_COM2 2
79 #define CONFIG_HOOK_POWER_COM3 3
80 #define CONFIG_HOOK_POWER_LCDLIGHT 4
81 #define CONFIG_HOOK_POWER_LCD 5
82 #define CONFIG_HOOK_POWER_SPEAKER 6
83 #define CONFIG_HOOK_BUTTON_POWER 7
84 #define CONFIG_HOOK_BUTTON_OK 8
85 #define CONFIG_HOOK_BUTTON_CANCEL 9
86 #define CONFIG_HOOK_BUTTON_UP 10
87 #define CONFIG_HOOK_BUTTON_DOWN 11
88 #define CONFIG_HOOK_BUTTON_REC 12
89 #define CONFIG_HOOK_BUTTON_COVER 13
90 #define CONFIG_HOOK_BUTTON_LIGHT 14
91 #define CONFIG_HOOK_BUTTON_CONTRAST 15
92 #define CONFIG_HOOK_BUTTON_APP0 16
93 #define CONFIG_HOOK_BUTTON_APP1 17
94 #define CONFIG_HOOK_BUTTON_APP2 18
95 #define CONFIG_HOOK_BUTTON_APP3 19
96 #define CONFIG_HOOK_BUTTON_LEFT 20
97 #define CONFIG_HOOK_BUTTON_RIGHT 21
98 #define CONFIG_HOOK_BUTTON_CONTRAST_UP 22
99 #define CONFIG_HOOK_BUTTON_CONTRAST_DOWN 23
100 #define CONFIG_HOOK_BUTTON_LIGHT_UP 24
101 #define CONFIG_HOOK_BUTTON_LIGHT_DOWN 25
102 #define CONFIG_HOOK_LED 26
103 #define CONFIG_HOOK_LED_MAX 27
104 #define CONFIG_HOOK_CONTRAST 28
105 #define CONFIG_HOOK_CONTRAST_MAX 29
106 #define CONFIG_HOOK_BRIGHTNESS 30
107 #define CONFIG_HOOK_BRIGHTNESS_MAX 31
108 #define CONFIG_HOOK_COM0_CTS 32
109 #define CONFIG_HOOK_COM1_CTS 33
110 #define CONFIG_HOOK_COM2_CTS 34
111 #define CONFIG_HOOK_COM3_CTS 35
112 #define CONFIG_HOOK_COM0_DCD 36
113 #define CONFIG_HOOK_COM1_DCD 37
114 #define CONFIG_HOOK_COM2_DCD 38
115 #define CONFIG_HOOK_COM3_DCD 39
116 #define CONFIG_HOOK_COM0_RTS 40
117 #define CONFIG_HOOK_COM1_RTS 41
118 #define CONFIG_HOOK_COM2_RTS 42
119 #define CONFIG_HOOK_COM3_RTS 43
120 #define CONFIG_HOOK_COM0_DTR 44
121 #define CONFIG_HOOK_COM1_DTR 45
122 #define CONFIG_HOOK_COM2_DTR 46
123 #define CONFIG_HOOK_COM3_DTR 47
124 #define CONFIG_HOOK_BATTERYVAL 48
125 #define CONFIG_HOOK_ACADAPTER 49
126 #define CONFIG_HOOK_CHARGE 50
127
128 #define CONFIG_HOOK_MAX_ID CONFIG_HOOK_CHARGE
129
130 /* old type events */
131
132 #define CONFIG_HOOK_POWERCONTROL 3
133 #define CONFIG_HOOK_POWERCONTROL_COM0 CONFIG_HOOK_POWER_COM0
134 #define CONFIG_HOOK_POWERCONTROL_COM1 CONFIG_HOOK_POWER_COM1
135 #define CONFIG_HOOK_POWERCONTROL_COM2 CONFIG_HOOK_POWER_COM2
136 #define CONFIG_HOOK_POWERCONTROL_COM3 CONFIG_HOOK_POWER_COM3
137 #define CONFIG_HOOK_POWERCONTROL_LCDLIGHT CONFIG_HOOK_POWER_LCDLIGHT
138 #define CONFIG_HOOK_POWERCONTROL_LCD CONFIG_HOOK_POWER_LCD
139 #define CONFIG_HOOK_POWERCONTROL_SPEAKER CONFIG_HOOK_POWER_SPEAKER
140 #define CONFIG_HOOK_POWERCONTROL_LED CONFIG_HOOK_LED
141
142 #define CONFIG_HOOK_BUTTONEVENT 4
143 #define CONFIG_HOOK_BUTTONEVENT_POWER CONFIG_HOOK_BUTTON_POWER
144 #define CONFIG_HOOK_BUTTONEVENT_OK CONFIG_HOOK_BUTTON_OK
145 #define CONFIG_HOOK_BUTTONEVENT_CANCEL CONFIG_HOOK_BUTTON_CANCEL
146 #define CONFIG_HOOK_BUTTONEVENT_UP CONFIG_HOOK_BUTTON_UP
147 #define CONFIG_HOOK_BUTTONEVENT_DOWN CONFIG_HOOK_BUTTON_DOWN
148 #define CONFIG_HOOK_BUTTONEVENT_REC CONFIG_HOOK_BUTTON_REC
149 #define CONFIG_HOOK_BUTTONEVENT_COVER CONFIG_HOOK_BUTTON_COVER
150 #define CONFIG_HOOK_BUTTONEVENT_LIGHT CONFIG_HOOK_BUTTON_LIGHT
151 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST CONFIG_HOOK_BUTTON_CONTRAST
152 #define CONFIG_HOOK_BUTTONEVENT_APP0 CONFIG_HOOK_BUTTON_APP0
153 #define CONFIG_HOOK_BUTTONEVENT_APP1 CONFIG_HOOK_BUTTON_APP1
154 #define CONFIG_HOOK_BUTTONEVENT_APP2 CONFIG_HOOK_BUTTON_APP2
155 #define CONFIG_HOOK_BUTTONEVENT_APP3 CONFIG_HOOK_BUTTON_APP3
156 #define CONFIG_HOOK_BUTTONEVENT_LEFT CONFIG_HOOK_BUTTON_LEFT
157 #define CONFIG_HOOK_BUTTONEVENT_RIGHT CONFIG_HOOK_BUTTON_RIGHT
158 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST_UP CONFIG_HOOK_BUTTON_CONTRAST_UP
159 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST_DOWN CONFIG_HOOK_BUTTON_CONTRAST_DOWN
160 #define CONFIG_HOOK_BUTTONEVENT_LIGHT_UP CONFIG_HOOK_BUTTON_LIGHT_UP
161 #define CONFIG_HOOK_BUTTONEVENT_LIGHT_DOWN CONFIG_HOOK_BUTTON_LIGHT_DOWN
162
163 #define CONFIG_HOOK_NTYPES 5
164
165 /*
166 * nicknames for including from configration file.
167 */
168 #ifdef CONFIG_HOOK_DEFINE_NICKNAME
169 #define PMEVENT CONFIG_HOOK_PMEVENT
170 #define SET CONFIG_HOOK_SET
171 #define EVENT CONFIG_HOOK_EVENT
172 #define GET CONFIG_HOOK_GET
173 /* old event type */
174 #define POWER CONFIG_HOOK_POWERCONTROL
175 #define BUTTON CONFIG_HOOK_BUTTONEVENT
176
177 #define PWCTL_COM0 CONFIG_HOOK_POWER_COM0
178 #define PWCTL_COM1 CONFIG_HOOK_POWER_COM1
179 #define PWCTL_COM2 CONFIG_HOOK_POWER_COM2
180 #define PWCTL_COM3 CONFIG_HOOK_POWER_COM3
181 #define PWCTL_LCDLIGHT CONFIG_HOOK_POWER_LCDLIGHT
182 #define PWCTL_LCD CONFIG_HOOK_POWER_LCD
183 #define PWCTL_SPEAKER CONFIG_HOOK_POWER_SPEAKER
184 #define PWCTL_LED CONFIG_HOOK_LED
185 #define BTN_POWER CONFIG_HOOK_BUTTON_POWER
186 #define BTN_OK CONFIG_HOOK_BUTTON_OK
187 #define BTN_CANCEL CONFIG_HOOK_BUTTON_CANCEL
188 #define BTN_UP CONFIG_HOOK_BUTTON_UP
189 #define BTN_DOWN CONFIG_HOOK_BUTTON_DOWN
190 #define BTN_REC CONFIG_HOOK_BUTTON_REC
191 #define BTN_COVER CONFIG_HOOK_BUTTON_COVER
192 #define BTN_LIGHT CONFIG_HOOK_BUTTON_LIGHT
193 #define BTN_CONTRAST CONFIG_HOOK_BUTTON_CONTRAST
194 #define BTN_APP0 CONFIG_HOOK_BUTTON_APP0
195 #define BTN_APP1 CONFIG_HOOK_BUTTON_APP1
196 #define BTN_APP2 CONFIG_HOOK_BUTTON_APP2
197 #define BTN_APP3 CONFIG_HOOK_BUTTON_APP3
198 #define BTN_LEFT CONFIG_HOOK_BUTTON_LEFT
199 #define BTN_RIGHT CONFIG_HOOK_BUTTON_RIGHT
200 #define BTN_CONTRAST_UP CONFIG_HOOK_BUTTON_CONTRAST_UP
201 #define BTN_CONTRAST_DN CONFIG_HOOK_BUTTON_CONTRAST_DOWN
202 #define BTN_LIGHT_UP CONFIG_HOOK_BUTTON_LIGHT_UP
203 #define BTN_LIGHT_DN CONFIG_HOOK_BUTTON_LIGHT_DOWN
204 /* PMEVENT */
205 #define PME_STANBY CONFIG_HOOK_PMEVENT_STANDBYREQ
206 #define PME_SUSPEND CONFIG_HOOK_PMEVENT_SUSPENDREQ
207 #define PME_HARDPOWER CONFIG_HOOK_PMEVENT_HARDPOWER
208 #define PME_BATTERY CONFIG_HOOK_PMEVENT_BATTERY
209 #define PME_AC CONFIG_HOOK_PMEVENT_AC
210 /* new one */
211 #define POWER_COM0 CONFIG_HOOK_POWER_COM0
212 #define POWER_COM1 CONFIG_HOOK_POWER_COM1
213 #define POWER_COM2 CONFIG_HOOK_POWER_COM2
214 #define POWER_COM3 CONFIG_HOOK_POWER_COM3
215 #define POWER_LCDLIGHT CONFIG_HOOK_POWER_LCDLIGHT
216 #define POWER_LCD CONFIG_HOOK_POWER_LCD
217 #define POWER_SPEAKER CONFIG_HOOK_POWER_SPEAKER
218 #define BUTTON_POWER CONFIG_HOOK_BUTTON_POWER
219 #define BUTTON_OK CONFIG_HOOK_BUTTON_OK
220 #define BUTTON_CANCEL CONFIG_HOOK_BUTTON_CANCEL
221 #define BUTTON_UP CONFIG_HOOK_BUTTON_UP
222 #define BUTTON_DOWN CONFIG_HOOK_BUTTON_DOWN
223 #define BUTTON_REC CONFIG_HOOK_BUTTON_REC
224 #define BUTTON_COVER CONFIG_HOOK_BUTTON_COVER
225 #define BUTTON_LIGHT CONFIG_HOOK_BUTTON_LIGHT
226 #define BUTTON_CONTRAST CONFIG_HOOK_BUTTON_CONTRAST
227 #define BUTTON_APP0 CONFIG_HOOK_BUTTON_APP0
228 #define BUTTON_APP1 CONFIG_HOOK_BUTTON_APP1
229 #define BUTTON_APP2 CONFIG_HOOK_BUTTON_APP2
230 #define BUTTON_APP3 CONFIG_HOOK_BUTTON_APP3
231 #define BUTTON_LEFT CONFIG_HOOK_BUTTON_LEFT
232 #define BUTTON_RIGHT CONFIG_HOOK_BUTTON_RIGHT
233 #define BUTTON_CONTRAST_UP CONFIG_HOOK_BUTTON_CONTRAST_UP
234 #define BUTTON_CONTRAST_DOWN CONFIG_HOOK_BUTTON_CONTRAST_DOWN
235 #define BUTTON_LIFHT_UP CONFIG_HOOK_BUTTON_LIGHT_UP
236 #define BUTTON_LIFHT_DOWN CONFIG_HOOK_BUTTON_LIGHT_DOWN
237 #define LED CONFIG_HOOK_LED
238 #define LED_MAX CONFIG_HOOK_LED_MAX
239 #define CONTRAST CONFIG_HOOK_CONTRAST
240 #define CONTRAST_MAX CONFIG_HOOK_CONTRAST_MAX
241 #define BRIGHTNESS CONFIG_HOOK_BRIGHTNESS
242 #define BRIGHTNESS_MAX CONFIG_HOOK_BRIGHTNESS_MAX
243 #define COM0_CTS CONFIG_HOOK_COM0_CTS
244 #define COM1_CTS CONFIG_HOOK_COM1_CTS
245 #define COM2_CTS CONFIG_HOOK_COM2_CTS
246 #define COM3_CTS CONFIG_HOOK_COM3_CTS
247 #define COM0_DCD CONFIG_HOOK_COM0_DCD
248 #define COM1_DCD CONFIG_HOOK_COM1_DCD
249 #define COM2_DCD CONFIG_HOOK_COM2_DCD
250 #define COM3_DCD CONFIG_HOOK_COM3_DCD
251 #define COM0_RTS CONFIG_HOOK_COM0_RTS
252 #define COM1_RTS CONFIG_HOOK_COM1_RTS
253 #define COM2_RTS CONFIG_HOOK_COM2_RTS
254 #define COM3_RTS CONFIG_HOOK_COM3_RTS
255 #define COM0_DTR CONFIG_HOOK_COM0_DTR
256 #define COM1_DTR CONFIG_HOOK_COM1_DTR
257 #define COM2_DTR CONFIG_HOOK_COM2_DTR
258 #define COM3_DTR CONFIG_HOOK_COM3_DTR
259 #define BATTERYVAL CONFIG_HOOK_BATTERYVAL
260 #define ACADAPTER CONFIG_HOOK_ACADAPTER
261 #define CHARGE CONFIG_HOOK_CHARGE
262 #endif /* CONFIG_HOOK_DEFINE_NICKNAME */
263
264 #define CONFIG_HOOK_MAXVALUE 1 /* max value, check in this file */
265 #define CONFIG_HOOK_VALUEP(p) ((int)(p)>= 0 && (int)(p)<= CONFIG_HOOK_MAXVALUE)
266 #define CONFIG_HOOK_PTRP(p) (!CONFIG_HOOK_VALUEP(p))
267
268 /*
269 * POWERCONTROL value
270 */
271 #define PWCTL_ON ((void *)1)
272 #define PWCTL_OFF ((void *)0)
273
274 /* CONFIG_HOOK typical value */
275 #define CONFIG_HOOK_ON 1
276 #define CONFIG_HOOK_OFF 0
277
278 /*
279 * CONFIG_HOOK_LED value
280 */
281 #define CONFIG_HOOK_LED_ON 0
282 #define CONFIG_HOOK_LED_OFF 1
283 #define CONFIG_HOOK_LED_FLASH 2 /* flash 100msec */
284 #define CONFIG_HOOK_LED_FLASH2 3 /* flash 200msec */
285 #define CONFIG_HOOK_LED_FLASH5 4 /* flash 500msec */
286 #define CONFIG_HOOK_LED_BLINK 5 /* blink 1sec interval */
287 #define CONFIG_HOOK_LED_BLINK2 6 /* blink 2sec interval */
288
289 /*
290 * CONFIG_HOOK_AC event value
291 */
292 #define CONFIG_HOOK_AC_OFF 0
293 #define CONFIG_HOOK_AC_ON_CHARGE 1
294 #define CONFIG_HOOK_AC_ON_NOCHARGE 2
295 #define CONFIG_HOOK_AC_UNKNOWN 3
296
297 /*
298 * CONFIG_HOOK_BATTERY event value
299 */
300 #define CONFIG_HOOK_BATT_CRITICAL 0
301 #define CONFIG_HOOK_BATT_20P 1
302 #define CONFIG_HOOK_BATT_LOW 2
303 #define CONFIG_HOOK_BATT_50P 3
304 #define CONFIG_HOOK_BATT_HIGH 4
305 #define CONFIG_HOOK_BATT_80P 5
306 #define CONFIG_HOOK_BATT_100P 6
307 #define CONFIG_HOOK_BATT_UNKNOWN 7
308 #define CONFIG_HOOK_BATT_NO_SYSTEM_BATTERY 8
309 #endif /* _CONFIG_HOOK_H_ */
310