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