Home | History | Annotate | Line # | Download | only in include
apmvar.h revision 1.2
      1 /*	$NetBSD: apmvar.h,v 1.2 1996/08/30 02:36:00 jtk Exp $	*/
      2 /*
      3  *  Copyright (c) 1995 John T. Kohl
      4  *  All rights reserved.
      5  *
      6  *  Redistribution and use in source and binary forms, with or without
      7  *  modification, are permitted provided that the following conditions
      8  *  are met:
      9  *  1. Redistributions of source code must retain the above copyright
     10  *     notice, this list of conditions and the following disclaimer.
     11  *  2. Redistributions in binary form must reproduce the above copyright
     12  *     notice, this list of conditions and the following disclaimer in the
     13  *     documentation and/or other materials provided with the distribution.
     14  *  3. The name of the author may not be used to endorse or promote products
     15  *     derived from this software without specific prior written permission.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
     18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     20  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
     21  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
     26  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     27  * POSSIBILITY OF SUCH DAMAGE.
     28  *
     29  */
     30 #ifndef __I386_APM_H__
     31 #define __I386_APM_H__
     32 
     33 /* Advanced Power Management (v1.0 and v1.1 specification)
     34  * functions/defines/etc.
     35  */
     36 #define APM_BIOS_FNCODE	(0x53)
     37 #define APM_SYSTEM_BIOS	(0x15)
     38 #define APM_BIOS_FN(x)	((APM_BIOS_FNCODE<<8)|(x))
     39 
     40 /*
     41  * APM info bits from BIOS
     42  */
     43 #define APM_16BIT_SUPPORT	0x01
     44 #define APM_32BIT_SUPPORT	0x02
     45 #define APM_CPUIDLE_SLOW	0x04
     46 #define APM_DISABLED		0x08
     47 #define APM_DISENGAGED		0x10
     48 
     49 #define	APM_ERR_CODE(regs)	(((regs)->ax & 0xff00) >> 8)
     50 #define	APM_ERR_PM_DISABLED	0x01
     51 #define	APM_ERR_REALALREADY	0x02
     52 #define	APM_ERR_NOTCONN		0x03
     53 #define	APM_ERR_16ALREADY	0x05
     54 #define	APM_ERR_16NOTSUPP	0x06
     55 #define	APM_ERR_32ALREADY	0x07
     56 #define	APM_ERR_32NOTSUPP	0x08
     57 #define	APM_ERR_UNRECOG_DEV	0x09
     58 #define	APM_ERR_ERANGE		0x0A
     59 #define	APM_ERR_NOTENGAGED	0x0B
     60 #define APM_ERR_UNABLE		0x60
     61 #define APM_ERR_NOEVENTS	0x80
     62 #define	APM_ERR_NOT_PRESENT	0x86
     63 
     64 #define APM_DEV_APM_BIOS	0x0000
     65 #define APM_DEV_ALLDEVS		0x0001
     66 /* device classes are high byte; device IDs go in low byte */
     67 #define		APM_DEV_DISPLAY(x)	(0x0100|((x)&0xff))
     68 #define		APM_DEV_DISK(x)		(0x0200|((x)&0xff))
     69 #define		APM_DEV_PARALLEL(x)	(0x0300|((x)&0xff))
     70 #define		APM_DEV_SERIAL(x)	(0x0400|((x)&0xff))
     71 #define		APM_DEV_NETWORK(x)	(0x0500|((x)&0xff))
     72 #define		APM_DEV_PCMCIA(x)	(0x0600|((x)&0xff))
     73 #define		APM_DEV_ALLUNITS	0xff
     74 
     75 #define	APM_INSTALLATION_CHECK	0x00	/* int15 only */
     76 #define	APM_REALMODE_CONNECT	0x01	/* int15 only */
     77 #define	APM_16BIT_CONNECT	0x02	/* int15 only */
     78 #define	APM_32BIT_CONNECT	0x03	/* int15 only */
     79 #define APM_DISCONNECT		0x04	/* %bx = APM_DEV_APM_BIOS */
     80 #define APM_CPU_IDLE		0x05
     81 #define APM_CPU_BUSY		0x06
     82 #define APM_SET_PWR_STATE	0x07
     83 #define		APM_SYS_READY	0x0000	/* %cx */
     84 #define		APM_SYS_STANDBY	0x0001
     85 #define		APM_SYS_SUSPEND	0x0002
     86 #define		APM_SYS_OFF	0x0003
     87 #define		APM_LASTREQ_INPROG	0x0004
     88 #define		APM_LASTREQ_REJECTED	0x0005
     89 
     90 /* system standby is device ID (%bx) 0x0001, APM_SYS_STANDBY */
     91 /* system suspend is device ID (%bx) 0x0001, APM_SYS_SUSPEND */
     92 
     93 #define APM_PWR_MGT_ENABLE	0x08
     94 #define		APM_MGT_ALL	0xffff	/* %bx */
     95 #define		APM_MGT_DISABLE	0x0	/* %cx */
     96 #define		APM_MGT_ENABLE	0x1
     97 
     98 #define APM_SYSTEM_DEFAULTS	0x09
     99 #define		APM_DEFAULTS_ALL	0xffff	/* %bx */
    100 
    101 #define APM_POWER_STATUS	0x0a
    102 #define		APM_AC_OFF		0x00
    103 #define		APM_AC_ON		0x01
    104 #define		APM_AC_BACKUP		0x02
    105 #define		APM_AC_UNKNOWN		0xff
    106 /* the first set of battery constants is 1.0 style values;
    107    the second set is 1.1 style bit definitions */
    108 #define		APM_BATT_HIGH		0x00
    109 #define		APM_BATT_LOW		0x01
    110 #define		APM_BATT_CRITICAL	0x02
    111 #define		APM_BATT_CHARGING	0x03
    112 #define		APM_BATT_ABSENT		0x04 /* Software only--not in spec! */
    113 #define		APM_BATT_UNKNOWN	0xff
    114 
    115 #define		APM_BATT_FLAG_HIGH	0x01
    116 #define		APM_BATT_FLAG_LOW	0x02
    117 #define		APM_BATT_FLAG_CRITICAL	0x04
    118 #define		APM_BATT_FLAG_CHARGING	0x08
    119 #define		APM_BATT_FLAG_NOBATTERY	0x80
    120 
    121 #define		APM_BATT_LIFE_UNKNOWN	0xff
    122 #define		APM_BATT_STATE(regp) ((regp)->bx & 0xff)
    123 #define		APM_BATT_FLAGS(regp) (((regp)->cx & 0xff00) >> 8)
    124 #define		APM_AC_STATE(regp) (((regp)->bx & 0xff00) >> 8)
    125 #define		APM_BATT_LIFE(regp) ((regp)->cx & 0xff) /* in % */
    126 /* BATT_REMAINING returns minutes remaining */
    127 #define		APM_BATT_REMAINING(regp) (((regp)->dx & 0x8000) ? \
    128 					  ((regp)->dx & 0x7fff) : \
    129 					  ((regp)->dx & 0x7fff)/60)
    130 #define		APM_BATT_REM_VALID(regp) (((regp)->dx & 0xffff) != 0xffff)
    131 #define	APM_GET_PM_EVENT	0x0b
    132 #define		APM_STANDBY_REQ		0x0001 /* %bx on return */
    133 #define		APM_SUSPEND_REQ		0x0002
    134 #define		APM_NORMAL_RESUME	0x0003
    135 #define		APM_CRIT_RESUME		0x0004 /* suspend/resume happened
    136 						  without us */
    137 #define		APM_BATTERY_LOW		0x0005
    138 #define		APM_POWER_CHANGE	0x0006
    139 #define		APM_UPDATE_TIME		0x0007
    140 #define		APM_CRIT_SUSPEND_REQ	0x0008
    141 #define		APM_USER_STANDBY_REQ	0x0009
    142 #define		APM_USER_SUSPEND_REQ	0x000A
    143 #define		APM_SYS_STANDBY_RESUME	0x000B
    144 
    145 #define	APM_GET_POWER_STATE	0x0c
    146 #define	APM_DEVICE_MGMT_ENABLE	0x0d
    147 
    148 #define	APM_DRIVER_VERSION	0x0e
    149 /* %bx should be DEV value (APM_DEV_APM_BIOS)
    150    %ch = driver major vno
    151    %cl = driver minor vno
    152    return: %ah = conn major; %al = conn minor
    153    */
    154 #define		APM_CONN_MINOR(regp) ((regp)->ax & 0xff)
    155 #define		APM_CONN_MAJOR(regp) (((regp)->ax & 0xff00) >> 8)
    156 
    157 #define APM_PWR_MGT_ENGAGE	0x0F
    158 #define		APM_MGT_DISENGAGE	0x0	/* %cx */
    159 #define		APM_MGT_ENGAGE		0x1
    160 
    161 #define APM_OEM			0x80
    162 
    163 /*
    164  * APM info word from the real-mode handler is adjusted to put
    165  * major/minor version in low half and support bits in upper half.
    166  */
    167 #define	APM_MAJOR_VERS(info) (((info)&0xff00)>>8)
    168 #define	APM_MINOR_VERS(info) ((info)&0xff)
    169 
    170 #define APM_16BIT_SUPPORTED	(APM_16BIT_SUPPORT << 16)
    171 #define APM_32BIT_SUPPORTED	(APM_32BIT_SUPPORT << 16)
    172 #define APM_IDLE_SLOWS		(APM_CPUIDLE_SLOW << 16)
    173 #define APM_BIOS_PM_DISABLED	(APM_DISABLED << 16)
    174 #define APM_BIOS_PM_DISENGAGED	(APM_DISENGAGED << 16)
    175 
    176 /*
    177  * LP (Laptop Package)
    178  *
    179  * Copyright (C) 1994 by HOSOKAWA Tatsumi <hosokawa (at) mt.cs.keio.ac.jp>
    180  *
    181  * This software may be used, modified, copied, and distributed, in
    182  * both source and binary form provided that the above copyright and
    183  * these terms are retained. Under no circumstances is the author
    184  * responsible for the proper functioning of this software, nor does
    185  * the author assume any responsibility for damages incurred with its
    186  * use.
    187  *
    188  * Sep., 1994	Implemented on FreeBSD 1.1.5.1R (Toshiba AVS001WD)
    189  */
    190 
    191 /* Error code of APM initializer */
    192 #define APM_INI_CANTFIND	0xffffffff
    193 #define APM_INI_NOT32BIT	0xfffffffe
    194 #define APM_INI_CONNECTERR	0xfffffffd
    195 #define APM_INI_BADVER		0xfffffffc
    196 
    197 #ifdef _LOCORE
    198 
    199 
    200 #define	APM_SIZEOF_GDTE		8
    201 #define APM_BOOTSTRAP_GDT_NUM	9	/* see i386/boot/table.c */
    202 
    203 #define APM_INIT_CS_INDEX	(APM_BOOTSTRAP_GDT_NUM - 3)
    204 #define APM_INIT_DS_INDEX	(APM_BOOTSTRAP_GDT_NUM - 2)
    205 #define APM_INIT_CS16_INDEX	(APM_BOOTSTRAP_GDT_NUM - 1)
    206 #define APM_INIT_CS_SEL		(APM_INIT_CS_INDEX << 3)
    207 #define APM_INIT_DS_SEL		(APM_INIT_DS_INDEX << 3)
    208 #define APM_INIT_CS16_SEL	(APM_INIT_CS16_INDEX << 3)
    209 
    210 #define APM_CS32_ATTRIB		0xCF9e
    211 #define APM_CS16_ATTRIB		0x0F9e
    212 #define APM_DS32_ATTRIB		0xCF92
    213 
    214 #define APM_BOOTSTRAP_DS_SEL	0x10
    215 /* APM initializer physical address */
    216 #define APM_OURADDR		0x00080000
    217 #define APM_RELOC(x)	((x) - _apm_init_image)
    218 
    219 #else /* !_LOCORE */
    220 
    221 /* filled in by apmcall */
    222 struct apmregs {
    223     u_short ax;
    224     u_short bx;
    225     u_short cx;
    226     u_short dx;
    227 };
    228 
    229 struct apm_connect_info {
    230 	u_int apm_code32_seg_base;	/* real-mode style segment selector */
    231 	u_int apm_code16_seg_base;
    232 	u_int apm_data_seg_base;
    233 	u_int apm_entrypt;
    234 	u_short	apm_segsel;		/* segment selector for APM */
    235 	u_short _pad1;
    236 	u_int apm_code32_seg_len;
    237 	u_int apm_data_seg_len;
    238 	u_int apm_detail;
    239 };
    240 
    241 struct apm_event_info {
    242 	u_int type;
    243 	u_int index;
    244 	u_int spare[8];
    245 };
    246 
    247 struct apm_power_info {
    248 	u_char battery_state;
    249 	u_char ac_state;
    250 	u_char battery_life;
    251 	u_char spare1;
    252 	u_int minutes_left;		/* estimate */
    253 	u_int spare2[6];
    254 };
    255 
    256 struct apm_ctl {
    257 	u_int dev;
    258 	u_int mode;
    259 };
    260 
    261 #define	APM_IOC_REJECT	_IOW('A', 0, struct apm_event_info) /* reject request # */
    262 #define	APM_IOC_STANDBY	_IO('A', 1)	/* put system into standby */
    263 #define	APM_IOC_SUSPEND	_IO('A', 2)	/* put system into suspend */
    264 #define	APM_IOC_GETPOWER _IOR('A', 3, struct apm_power_info) /* fetch battery state */
    265 #define	APM_IOC_NEXTEVENT _IOR('A', 4, struct apm_event_info) /* fetch event */
    266 #define	APM_IOC_DEV_CTL	_IOW('A', 5, struct apm_ctl) /* put device into mode */
    267 
    268 struct apm_attach_args {
    269 	char *aaa_busname;
    270 };
    271 
    272 #ifdef _KERNEL
    273 extern struct apm_connect_info apminfo;	/* in locore */
    274 extern int apmpresent;
    275 extern int apmcall __P((int function, struct apmregs *regs));
    276 extern void apm_cpu_busy __P((void));
    277 extern void apm_cpu_idle __P((void));
    278 extern void apminit __P((void));
    279 int apm_set_powstate __P((u_int devid, u_int powstate));
    280 #endif /* _KERNEL */
    281 #endif /* _LOCORE */
    282 #endif /* __i386_apm_h__ */
    283