usr.sbin/apmd/apmd.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * APM (Advanced Power Management) Event Dispatcher
   5  *
   6  * Copyright (c) 1999 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
   7  * Copyright (c) 1999 KOIE Hidetaka <koie@suri.co.jp>
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 #define APMD_CONFIGFILE         "/etc/apmd.conf"
  35 #define APM_CTL_DEVICEFILE      "/dev/apmctl"
  36 #define APM_NORM_DEVICEFILE     "/dev/apm"
  37 #define APMD_PIDFILE            "/var/run/apmd.pid"
  38 #define NICE_INCR               -20
  39
  40 enum {
  41         EVENT_NOEVENT,
  42         EVENT_STANDBYREQ,
  43         EVENT_SUSPENDREQ,
  44         EVENT_NORMRESUME,
  45         EVENT_CRITRESUME,
  46         EVENT_BATTERYLOW,
  47         EVENT_POWERSTATECHANGE,
  48         EVENT_UPDATETIME,
  49         EVENT_CRITSUSPEND,
  50         EVENT_USERSTANDBYREQ,
  51         EVENT_USERSUSPENDREQ,
  52         EVENT_STANDBYRESUME,
  53         EVENT_CAPABILITIESCHANGE,
  54         EVENT_MAX
  55 };
  56
  57 struct event_cmd_op {
  58         int (* act)(void *this);
  59         void (* dump)(void *this, FILE * fp);
  60         struct event_cmd * (* clone)(void *this);
  61         void (* free)(void *this);
  62 };
  63 struct event_cmd {
  64         struct event_cmd * next;
  65         size_t len;
  66         char * name;
  67         struct event_cmd_op * op;
  68 };
  69 struct event_cmd_exec {
  70         struct event_cmd evcmd;
  71         char * line;            /* Command line */
  72 };
  73 struct event_cmd_reject {
  74         struct event_cmd evcmd;
  75 };
  76
  77 struct event_config {
  78         const char *name;
  79         struct event_cmd * cmdlist;
  80         int rejectable;
  81 };
  82
  83 struct battery_watch_event {
  84         struct battery_watch_event *next;
  85         int level;
  86         enum {
  87                 BATTERY_CHARGING,
  88                 BATTERY_DISCHARGING
  89         } direction;
  90         enum {
  91                 BATTERY_MINUTES,
  92                 BATTERY_PERCENT
  93         } type;
  94         int done;
  95         struct event_cmd *cmdlist;
  96 };
  97
  98
  99 extern struct event_cmd_op event_cmd_exec_ops;
 100 extern struct event_cmd_op event_cmd_reject_ops;
 101 extern struct event_config events[EVENT_MAX];
 102 extern struct battery_watch_event *battery_watch_list;
 103
 104 extern int register_battery_handlers(
 105         int level, int direction,
 106         struct event_cmd *cmdlist);
 107 extern int register_apm_event_handlers(
 108         bitstr_t bit_decl(evlist, EVENT_MAX),
 109         struct event_cmd *cmdlist);
 110 extern void free_event_cmd_list(struct event_cmd *p);
 111
 112 extern int      yyparse(void);
 113
 114 void    yyerror(const char *);
 115 int     yylex(void);
 116
 117 struct event_cmd *event_cmd_default_clone(void *);
 118 int event_cmd_exec_act(void *);
 119 void event_cmd_exec_dump(void *, FILE *);
 120 struct event_cmd *event_cmd_exec_clone(void *);
 121 void event_cmd_exec_free(void *);
 122 int event_cmd_reject_act(void *);
 123 struct event_cmd *clone_event_cmd_list(struct event_cmd *);
 124 int exec_run_cmd(struct event_cmd *);
 125 int exec_event_cmd(struct event_config *);
 126 void read_config(void);
 127 void dump_config(void);
 128 void destroy_config(void);
 129 void restart(void);
 130 void enque_signal(int);
 131 void wait_child(void);
 132 int proc_signal(int);
 133 void proc_apmevent(int);
 134 void check_battery(void);
 135 void event_loop(void);