xref: /netbsd-src/sys/arch/hpcmips/include/config_hook.h (revision 5aefcfdc06931dd97e76246d2fe0302f7b3fe094)
1 /*	$NetBSD: config_hook.h,v 1.11 2000/12/29 08:12:09 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 
67 #define CONFIG_HOOK_BUTTONEVENT		1
68 #define CONFIG_HOOK_BUTTONEVENT_POWER		0
69 #define CONFIG_HOOK_BUTTONEVENT_OK		1
70 #define CONFIG_HOOK_BUTTONEVENT_CANCEL		2
71 #define CONFIG_HOOK_BUTTONEVENT_UP		3
72 #define CONFIG_HOOK_BUTTONEVENT_DOWN		4
73 #define CONFIG_HOOK_BUTTONEVENT_REC		5
74 #define CONFIG_HOOK_BUTTONEVENT_COVER		6
75 #define CONFIG_HOOK_BUTTONEVENT_LIGHT		7
76 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST	8
77 #define CONFIG_HOOK_BUTTONEVENT_APP0		9
78 #define CONFIG_HOOK_BUTTONEVENT_APP1		10
79 #define CONFIG_HOOK_BUTTONEVENT_APP2		11
80 #define CONFIG_HOOK_BUTTONEVENT_APP3		12
81 #define CONFIG_HOOK_BUTTONEVENT_LEFT		13
82 #define CONFIG_HOOK_BUTTONEVENT_RIGHT		14
83 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST_UP	15
84 #define CONFIG_HOOK_BUTTONEVENT_CONTRAST_DOWN	16
85 #define CONFIG_HOOK_BUTTONEVENT_LIGHT_UP	17
86 #define CONFIG_HOOK_BUTTONEVENT_LIGHT_DOWN	18
87 
88 /* apm releted events */
89 #define CONFIG_HOOK_PMEVENT		2
90 #define CONFIG_HOOK_PMEVENT_STANDBYREQ		0
91 #define CONFIG_HOOK_PMEVENT_SUSPENDREQ		1
92 #define CONFIG_HOOK_PMEVENT_HARDPOWER		2
93 #define CONFIG_HOOK_PMEVENT_BATTERY		3
94 #define CONFIG_HOOK_PMEVENT_AC			4
95 
96 
97 /* get value */
98 #define CONFIG_HOOK_GET			3
99 /* set value and send event */
100 #define CONFIG_HOOK_SET			4
101 /* external event */
102 #define CONFIG_HOOK_EVENT		CONFIG_HOOK_SET
103 
104 
105 /* CONFIG_HOOK_GET/CONFIG_HOOK_SET/CONFIG_HOOK_EVENT event id's */
106 #define CONFIG_HOOK_POWER_COM0			0
107 #define CONFIG_HOOK_POWER_COM1			1
108 #define CONFIG_HOOK_POWER_COM2			2
109 #define CONFIG_HOOK_POWER_COM3			3
110 #define CONFIG_HOOK_POWER_LCDLIGHT		4
111 #define CONFIG_HOOK_POWER_LCD			5
112 #define CONFIG_HOOK_POWER_SPEAKER		6
113 #define CONFIG_HOOK_BUTTON_POWER		7
114 #define CONFIG_HOOK_BUTTON_OK			8
115 #define CONFIG_HOOK_BUTTON_CANCEL		9
116 #define CONFIG_HOOK_BUTTON_UP			10
117 #define CONFIG_HOOK_BUTTON_DOWN			11
118 #define CONFIG_HOOK_BUTTON_REC			12
119 #define CONFIG_HOOK_BUTTON_COVER		13
120 #define CONFIG_HOOK_BUTTON_LIGHT		14
121 #define CONFIG_HOOK_BUTTON_CONTRAST		15
122 #define CONFIG_HOOK_BUTTON_APP0			16
123 #define CONFIG_HOOK_BUTTON_APP1			17
124 #define CONFIG_HOOK_BUTTON_APP2			18
125 #define CONFIG_HOOK_BUTTON_APP3			19
126 #define CONFIG_HOOK_BUTTON_LEFT			20
127 #define CONFIG_HOOK_BUTTON_RIGHT		21
128 #define CONFIG_HOOK_BUTTON_CONTRAST_UP		22
129 #define CONFIG_HOOK_BUTTON_CONTRAST_DOWN	23
130 #define CONFIG_HOOK_BUTTON_LIGHT_UP		24
131 #define CONFIG_HOOK_BUTTON_LIGHT_DOWN		25
132 #define CONFIG_HOOK_LED				26
133 #define CONFIG_HOOK_LED_MAX			27
134 #define CONFIG_HOOK_CONTRAST			28
135 #define CONFIG_HOOK_CONTRAST_MAX		29
136 #define CONFIG_HOOK_BRIGHTNESS			30
137 #define CONFIG_HOOK_BRIGHTNESS_MAX		31
138 #define CONFIG_HOOK_COM0_CTS			32
139 #define CONFIG_HOOK_COM1_CTS			33
140 #define CONFIG_HOOK_COM2_CTS			34
141 #define CONFIG_HOOK_COM3_CTS			35
142 #define CONFIG_HOOK_COM0_DCD			36
143 #define CONFIG_HOOK_COM1_DCD			37
144 #define CONFIG_HOOK_COM2_DCD			38
145 #define CONFIG_HOOK_COM3_DCD			39
146 #define CONFIG_HOOK_COM0_RTS			40
147 #define CONFIG_HOOK_COM1_RTS			41
148 #define CONFIG_HOOK_COM2_RTS			42
149 #define CONFIG_HOOK_COM3_RTS			43
150 #define CONFIG_HOOK_COM0_DTR			44
151 #define CONFIG_HOOK_COM1_DTR			45
152 #define CONFIG_HOOK_COM2_DTR			46
153 #define CONFIG_HOOK_COM3_DTR			47
154 #define CONFIG_HOOK_BATTERYVAL			48
155 #define CONFIG_HOOK_ACADAPTER			49
156 #define CONFIG_HOOK_CHARGE			50
157 
158 #define CONFIG_HOOK_NTYPES 		5
159 
160 /*
161  * nicknames for including from configration file.
162  */
163 #ifdef CONFIG_HOOK_DEFINE_NICKNAME
164 #define POWER		CONFIG_HOOK_POWERCONTROL
165 #define BUTTON		CONFIG_HOOK_BUTTONEVENT
166 #define PMEVENT		CONFIG_HOOK_PMEVENT
167 
168 #define PWCTL_COM0	CONFIG_HOOK_POWERCONTROL_COM0
169 #define PWCTL_COM1	CONFIG_HOOK_POWERCONTROL_COM1
170 #define PWCTL_COM2	CONFIG_HOOK_POWERCONTROL_COM2
171 #define PWCTL_COM3	CONFIG_HOOK_POWERCONTROL_COM3
172 #define PWCTL_LCDLIGHT	CONFIG_HOOK_POWERCONTROL_LCDLIGHT
173 #define PWCTL_LCD	CONFIG_HOOK_POWERCONTROL_LCD
174 #define PWCTL_SPEAKER	CONFIG_HOOK_POWERCONTROL_SPEAKER
175 #define PWCTL_LED	CONFIG_HOOK_POWERCONTROL_LED
176 #define BTN_POWER	CONFIG_HOOK_BUTTONEVENT_POWER
177 #define BTN_OK		CONFIG_HOOK_BUTTONEVENT_OK
178 #define BTN_CANCEL	CONFIG_HOOK_BUTTONEVENT_CANCEL
179 #define BTN_UP		CONFIG_HOOK_BUTTONEVENT_UP
180 #define BTN_DOWN	CONFIG_HOOK_BUTTONEVENT_DOWN
181 #define BTN_REC		CONFIG_HOOK_BUTTONEVENT_REC
182 #define BTN_COVER	CONFIG_HOOK_BUTTONEVENT_COVER
183 #define BTN_LIGHT	CONFIG_HOOK_BUTTONEVENT_LIGHT
184 #define BTN_CONTRAST	CONFIG_HOOK_BUTTONEVENT_CONTRAST
185 #define BTN_APP0	CONFIG_HOOK_BUTTONEVENT_APP0
186 #define BTN_APP1	CONFIG_HOOK_BUTTONEVENT_APP1
187 #define BTN_APP2	CONFIG_HOOK_BUTTONEVENT_APP2
188 #define BTN_APP3	CONFIG_HOOK_BUTTONEVENT_APP3
189 #define BTN_LEFT	CONFIG_HOOK_BUTTONEVENT_LEFT
190 #define BTN_RIGHT	CONFIG_HOOK_BUTTONEVENT_RIGHT
191 #define BTN_CONTRAST_UP	CONFIG_HOOK_BUTTONEVENT_CONTRAST_UP
192 #define BTN_CONTRAST_DN	CONFIG_HOOK_BUTTONEVENT_CONTRAST_DOWN
193 #define BTN_LIGHT_UP	CONFIG_HOOK_BUTTONEVENT_LIGHT_UP
194 #define BTN_LIGHT_DN	CONFIG_HOOK_BUTTONEVENT_LIGHT_DOWN
195 #define PME_STANBY	CONFIG_HOOK_PMEVENT_STANDBYREQ
196 #define PME_SUSPEND	CONFIG_HOOK_PMEVENT_SUSPENDREQ
197 #define PME_HARDPOWER	CONFIG_HOOK_PMEVENT_HARDPOWER
198 
199 #endif /* CONFIG_HOOK_DEFINE_NICKNAME */
200 
201 /*
202  * POWERCONTROL value
203  */
204 #define PWCTL_ON	((void *)1)
205 #define PWCTL_OFF	((void *)0)
206 
207 /* CONFIG_HOOK typical value */
208 #define	CONFIG_HOOK_ON	1
209 #define CONFIG_HOOK_OFF	0
210 
211 /*
212  * CONFIG_HOOK_LED value
213  */
214 #define CONFIG_HOOK_LED_ON	0
215 #define	CONFIG_HOOK_LED_OFF	1
216 #define CONFIG_HOOK_LED_FLASH	2	/* flash 100msec */
217 #define CONFIG_HOOK_LED_FLASH2	3	/* flash 200msec */
218 #define CONFIG_HOOK_LED_FLASH5	4	/* flash 500msec */
219 #define CONFIG_HOOK_LED_BLINK	5	/* blink 1sec interval */
220 #define CONFIG_HOOK_LED_BLINK2	6	/* blink 2sec interval */
221 
222 /*
223  * CONFIG_HOOK_AC event value
224  */
225 #define CONFIG_HOOK_AC_OFF		0
226 #define CONFIG_HOOK_AC_ON_CHARGE	1
227 #define CONFIG_HOOK_AC_ON_NOCHARGE	2
228 #define CONFIG_HOOK_AC_UNKNOWN		3
229 
230 /*
231  * CONFIG_HOOK_BATTERY event value
232  */
233 #define CONFIG_HOOK_BATT_CRITICAL	0
234 #define CONFIG_HOOK_BATT_20P		1
235 #define CONFIG_HOOK_BATT_LOW		2
236 #define CONFIG_HOOK_BATT_50P		3
237 #define CONFIG_HOOK_BATT_HIGH		4
238 #define CONFIG_HOOK_BATT_80P		5
239 #define CONFIG_HOOK_BATT_100P		6
240 #define CONFIG_HOOK_BATT_UNKNOWN	7
241 #define CONFIG_HOOK_BATT_NO_SYSTEM_BATTERY	8
242 #endif /* _CONFIG_HOOK_H_ */
243