1/* $OpenBSD: apmvar.h,v 1.1 2023/11/06 20:59:26 jca Exp $ */
2
3/*
4 * Copyright (c) 2001 Alexander Guy
5 * Copyright (c) 1995 John T. Kohl
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 * 3. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
23 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 */
32#ifndef _MACHINE_APMVAR_H_
33#define _MACHINE_APMVAR_H_
34
35#include <sys/ioccom.h>
36
37/* Advanced Power Management (v1.0 and v1.1 specification)
38 * functions/defines/etc.
39 */
40
41/* These definitions make up the heart of the user-land interface
42 * to the APM devices.
43 */
44
45#define APM_AC_OFF 0x00
46#define APM_AC_ON 0x01
47#define APM_AC_BACKUP 0x02
48#define APM_AC_UNKNOWN 0xff
49#define APM_BATT_HIGH 0x00
50#define APM_BATT_LOW 0x01
51#define APM_BATT_CRITICAL 0x02
52#define APM_BATT_CHARGING 0x03
53#define APM_BATT_UNKNOWN 0xff
54#define APM_BATT_LIFE_UNKNOWN 0xff
55
56#define APM_NOEVENT 0x0000
57#define APM_STANDBY_REQ 0x0001
58#define APM_SUSPEND_REQ 0x0002
59#define APM_NORMAL_RESUME 0x0003
60#define APM_CRIT_RESUME 0x0004 /* suspend/resume happened
61 without us */
62#define APM_BATTERY_LOW 0x0005
63#define APM_POWER_CHANGE 0x0006
64#define APM_UPDATE_TIME 0x0007
65#define APM_CRIT_SUSPEND_REQ 0x0008
66#define APM_USER_STANDBY_REQ 0x0009
67#define APM_USER_SUSPEND_REQ 0x000A
68#define APM_SYS_STANDBY_RESUME 0x000B
69#define APM_CAPABILITY_CHANGE 0x000C /* apm v1.2 */
70#define APM_USER_HIBERNATE_REQ 0x000D
71#define APM_EVENT_MASK 0xffff
72
73#define APM_EVENT_COMPOSE(t,i) ((((i) & 0x7fff) << 16)|((t) & APM_EVENT_MASK))
74#define APM_EVENT_TYPE(e) ((e) & APM_EVENT_MASK)
75#define APM_EVENT_INDEX(e) ((e) >> 16)
76
77/*
78 * LP (Laptop Package)
79 *
80 * Copyright (C) 1994 by HOSOKAWA Tatsumi <hosokawa@mt.cs.keio.ac.jp>
81 *
82 * This software may be used, modified, copied, and distributed, in
83 * both source and binary form provided that the above copyright and
84 * these terms are retained. Under no circumstances is the author
85 * responsible for the proper functioning of this software, nor does
86 * the author assume any responsibility for damages incurred with its
87 * use.
88 *
89 * Sep., 1994 Implemented on FreeBSD 1.1.5.1R (Toshiba AVS001WD)
90 */
91
92#define APM_BATTERY_ABSENT 4
93
94struct apm_power_info {
95 u_char battery_state;
96 u_char ac_state;
97 u_char battery_life;
98 u_char spare1;
99 u_int minutes_left; /* estimate */
100 u_int spare2[6];
101};
102
103struct apm_ctl {
104 u_int dev;
105 u_int mode;
106};
107
108#define APM_IOC_REJECT _IOW('A', 0, struct apm_event_info) /* reject request # */
109#define APM_IOC_STANDBY _IO('A', 1) /* put system into standby */
110#define APM_IOC_SUSPEND _IO('A', 2) /* put system into suspend */
111#define APM_IOC_GETPOWER _IOR('A', 3, struct apm_power_info) /* fetch battery state */
112#define APM_IOC_DEV_CTL _IOW('A', 5, struct apm_ctl) /* put device into mode */
113#define APM_IOC_PRN_CTL _IOW('A', 6, int ) /* driver power status msg */
114#define APM_PRINT_ON 0 /* driver power status displayed */
115#define APM_PRINT_OFF 1 /* driver power status not displayed */
116#define APM_PRINT_PCT 2 /* driver power status only displayed
117 if the percentage changes */
118#define APM_IOC_STANDBY_REQ _IO('A', 7) /* request standby */
119#define APM_IOC_SUSPEND_REQ _IO('A', 8) /* request suspend */
120#define APM_IOC_HIBERNATE _IO('A', 9) /* put system into hibernate */
121
122#endif /* _MACHINE_APMVAR_H_ */