Add a few new errnos and improve documentation.
[dragonfly.git] / usr.sbin / apmd / apmd.h
blob5e09fb8f295b74f06c2369268aa5f03adedadbb4
1 /*-
2 * APM (Advanced Power Management) Event Dispatcher
4 * Copyright (c) 1999 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
5 * Copyright (c) 1999 KOIE Hidetaka <koie@suri.co.jp>
6 * All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
29 * $FreeBSD: src/usr.sbin/apmd/apmd.h,v 1.2.2.1 2001/08/13 17:30:30 nsayer Exp $
30 * $DragonFly: src/usr.sbin/apmd/apmd.h,v 1.5 2005/08/28 20:55:07 liamfoy Exp $
33 #define APMD_CONFIGFILE "/etc/apmd.conf"
34 #define APM_CTL_DEVICEFILE "/dev/apmctl"
35 #define APM_NORM_DEVICEFILE "/dev/apm"
36 #define NICE_INCR -20
38 enum {
39 EVENT_NOEVENT,
40 EVENT_STANDBYREQ,
41 EVENT_SUSPENDREQ,
42 EVENT_NORMRESUME,
43 EVENT_CRITRESUME,
44 EVENT_BATTERYLOW,
45 EVENT_POWERSTATECHANGE,
46 EVENT_UPDATETIME,
47 EVENT_CRITSUSPEND,
48 EVENT_USERSTANDBYREQ,
49 EVENT_USERSUSPENDREQ,
50 EVENT_STANDBYRESUME,
51 EVENT_CAPABILITIESCHANGE,
52 EVENT_MAX
55 struct event_cmd_op {
56 int (* act)(void *this);
57 void (* dump)(void *this, FILE * fp);
58 struct event_cmd * (* clone)(void *this);
59 void (* free)(void *this);
61 struct event_cmd {
62 struct event_cmd * next;
63 size_t len;
64 char * name;
65 struct event_cmd_op * op;
67 struct event_cmd_exec {
68 struct event_cmd evcmd;
69 char * line; /* Command line */
71 struct event_cmd_reject {
72 struct event_cmd evcmd;
75 struct event_config {
76 const char *name;
77 struct event_cmd * cmdlist;
78 int rejectable;
81 struct battery_watch_event {
82 struct battery_watch_event *next;
83 int level;
84 enum {
85 BATTERY_CHARGING,
86 BATTERY_DISCHARGING
87 } direction;
88 enum {
89 BATTERY_MINUTES,
90 BATTERY_PERCENT
91 } type;
92 int done;
93 struct event_cmd *cmdlist;
97 extern struct event_cmd_op event_cmd_exec_ops;
98 extern struct event_cmd_op event_cmd_reject_ops;
99 extern struct event_config events[EVENT_MAX];
100 extern struct battery_watch_event *battery_watch_list;
102 extern int register_battery_handlers(
103 int level, int direction,
104 struct event_cmd *cmdlist);
105 extern int register_apm_event_handlers(
106 bitstr_t bit_decl(evlist, EVENT_MAX),
107 struct event_cmd *cmdlist);
108 extern void free_event_cmd_list(struct event_cmd *p);
110 void yyerror(const char *);
111 int yylex(void);