Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / usr.sbin / apmd / apmd.h
1 /*-
2  * APM (Advanced Power Management) Event Dispatcher
3  *
4  * Copyright (c) 1999 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
5  * Copyright (c) 1999 KOIE Hidetaka <koie@suri.co.jp>
6  * All rights reserved.
7  *
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.
16  *
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.
28  *
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.2 2003/06/17 04:29:52 dillon Exp $
31  */
32
33 #define APMD_CONFIGFILE         "/etc/apmd.conf"
34 #define APM_CTL_DEVICEFILE      "/dev/apmctl"
35 #define APM_NORM_DEVICEFILE     "/dev/apm"
36 #define APMD_PIDFILE            "/var/run/apmd.pid"
37 #define NICE_INCR               -20
38
39 enum {
40         EVENT_NOEVENT,
41         EVENT_STANDBYREQ,
42         EVENT_SUSPENDREQ,
43         EVENT_NORMRESUME,
44         EVENT_CRITRESUME,
45         EVENT_BATTERYLOW,
46         EVENT_POWERSTATECHANGE,
47         EVENT_UPDATETIME,
48         EVENT_CRITSUSPEND,
49         EVENT_USERSTANDBYREQ,
50         EVENT_USERSUSPENDREQ,
51         EVENT_STANDBYRESUME,
52         EVENT_CAPABILITIESCHANGE,
53         EVENT_MAX
54 };
55
56 struct event_cmd_op {
57         int (* act) __P((void *this));
58         void (* dump) __P((void *this, FILE * fp));
59         struct event_cmd * (* clone) __P((void *this));
60         void (* free) __P((void *this));
61 };
62 struct event_cmd {
63         struct event_cmd * next;
64         size_t len;
65         char * name;
66         struct event_cmd_op * op;
67 };
68 struct event_cmd_exec {
69         struct event_cmd evcmd;
70         char * line;            /* Command line */
71 };
72 struct event_cmd_reject {
73         struct event_cmd evcmd;
74 };
75
76 struct event_config {
77         const char *name;
78         struct event_cmd * cmdlist;
79         int rejectable;
80 };
81
82 struct battery_watch_event {
83         struct battery_watch_event *next;
84         int level;
85         enum {
86                 BATTERY_CHARGING,
87                 BATTERY_DISCHARGING
88         } direction;
89         enum {
90                 BATTERY_MINUTES,
91                 BATTERY_PERCENT
92         } type;
93         int done;
94         struct event_cmd *cmdlist;
95 };
96
97         
98 extern struct event_cmd_op event_cmd_exec_ops;
99 extern struct event_cmd_op event_cmd_reject_ops;
100 extern struct event_config events[EVENT_MAX];
101 extern struct battery_watch_event *battery_watch_list;
102
103 extern int register_battery_handlers(
104         int level, int direction,
105         struct event_cmd *cmdlist);
106 extern int register_apm_event_handlers(
107         bitstr_t bit_decl(evlist, EVENT_MAX),
108         struct event_cmd *cmdlist);
109 extern void free_event_cmd_list(struct event_cmd *p);