/*      $OpenBSD: apmvar.h,v 1.22 2019/01/22 02:36:30 phessler Exp $    */

/*
 *  Copyright (c) 1995 John T. Kohl
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */
#ifndef _MACHINE_APMVAR_H_
#define _MACHINE_APMVAR_H_

#include <sys/ioccom.h>

/* Advanced Power Management (v1.0 and v1.1 specification)
 * functions/defines/etc.
 */

#define APM_VERSION     0x0102

/*
 * APM info word from boot loader
 */
#define APM_16BIT_SUPPORTED     0x00010000
#define APM_32BIT_SUPPORTED     0x00020000
#define APM_IDLE_SLOWS          0x00040000
#define APM_BIOS_PM_DISABLED    0x00080000
#define APM_BIOS_PM_DISENGAGED  0x00100000
#define APM_MAJOR(f)            (((f) >> 8) & 0xff)
#define APM_MINOR(f)            ((f) & 0xff)
#define APM_VERMASK             0x0000ffff
#define APM_NOCLI               0x00010000
#define APM_BEBATT              0x00020000

/* APM error codes */
#define APM_ERR_CODE(regs)      (((regs)->ax & 0xff00) >> 8)
#define APM_ERR_PM_DISABLED     0x01
#define APM_ERR_REALALREADY     0x02
#define APM_ERR_NOTCONN         0x03
#define APM_ERR_16ALREADY       0x05
#define APM_ERR_16NOTSUPP       0x06
#define APM_ERR_32ALREADY       0x07
#define APM_ERR_32NOTSUPP       0x08
#define APM_ERR_UNRECOG_DEV     0x09
#define APM_ERR_ERANGE          0x0A
#define APM_ERR_NOTENGAGED      0x0B
#define APM_ERR_EOPNOSUPP       0x0C
#define APM_ERR_RTIMER_DISABLED 0x0D
#define APM_ERR_UNABLE          0x60
#define APM_ERR_NOEVENTS        0x80
#define APM_ERR_NOT_PRESENT     0x86

#define APM_DEV_APM_BIOS        0x0000
#define APM_DEV_ALLDEVS         0x0001
/* device classes are high byte; device IDs go in low byte */
#define         APM_DEV_DISPLAY(x)      (0x0100|((x)&0xff))
#define         APM_DEV_DISK(x)         (0x0200|((x)&0xff))
#define         APM_DEV_PARALLEL(x)     (0x0300|((x)&0xff))
#define         APM_DEV_SERIAL(x)       (0x0400|((x)&0xff))
#define         APM_DEV_NETWORK(x)      (0x0500|((x)&0xff))
#define         APM_DEV_PCMCIA(x)       (0x0600|((x)&0xff))
#define         APM_DEV_BATTERIES(x)    (0x8000|((x)&0xff))
#define         APM_DEV_ALLUNITS        0xff
/* 0x8100-0xDFFF - reserved     */
/* 0xE000-0xEFFF - OEM-defined  */
/* 0xF000-0xFFFF - reserved     */

#define APM_INSTCHECK           0x5300  /* int15 only */
#define         APM_16BIT_SUPPORT       0x01
#define         APM_32BIT_SUPPORT       0x02
#define         APM_CPUIDLE_SLOW        0x04
#define         APM_DISABLED            0x08
#define         APM_DISENGAGED          0x10

#define APM_REAL_CONNECT        0x5301  /* int15 only */
#define APM_PROT16_CONNECT      0x5302  /* int15 only */
#define APM_PROT32_CONNECT      0x5303  /* int15 only */
#define APM_DISCONNECT          0x5304  /* %bx = APM_DEV_APM_BIOS */

#define APM_CPU_IDLE            0x5305
#define APM_CPU_BUSY            0x5306

#define APM_SET_PWR_STATE       0x5307
#define         APM_SYS_READY           0x0000  /* %cx */
#define         APM_SYS_STANDBY         0x0001
#define         APM_SYS_SUSPEND         0x0002
#define         APM_SYS_OFF             0x0003
#define         APM_LASTREQ_INPROG      0x0004
#define         APM_LASTREQ_REJECTED    0x0005
/* 0x0006 - 0x001f      Reserved system states    */
/* 0x0020 - 0x003f      OEM-defined system states */
/* 0x0040 - 0x007f      OEM-defined device states */
/* 0x0080 - 0xffff      Reserved device states    */

/* system standby is device ID (%bx) 0x0001, APM_SYS_STANDBY */
/* system suspend is device ID (%bx) 0x0001, APM_SYS_SUSPEND */

#define APM_PWR_MGT_ENABLE      0x5308
#define         APM_MGT_ALL     0xffff  /* %bx */
#define         APM_MGT_DISABLE 0x0     /* %cx */
#define         APM_MGT_ENABLE  0x1

#define APM_SYSTEM_DEFAULTS     0x5309
#define         APM_DEFAULTS_ALL        0xffff  /* %bx */

#define APM_POWER_STATUS        0x530a
#define         APM_AC_OFF              0x00
#define         APM_AC_ON               0x01
#define         APM_AC_BACKUP           0x02
#define         APM_AC_UNKNOWN          0xff
#define         APM_BATT_HIGH           0x00
#define         APM_BATT_LOW            0x01
#define         APM_BATT_CRITICAL       0x02
#define         APM_BATT_CHARGING       0x03
#define         APM_BATT_UNKNOWN        0xff
#define         APM_BATT_FLAG_HIGH      0x01
#define         APM_BATT_FLAG_LOW       0x02
#define         APM_BATT_FLAG_CRITICAL  0x04
#define         APM_BATT_FLAG_CHARGING  0x08
#define         APM_BATT_FLAG_NOBATTERY 0x10
#define         APM_BATT_FLAG_NOSYSBATT 0x80
#define         APM_BATT_LIFE_UNKNOWN   0xff
#define         BATT_STATE(regp) ((regp)->bx & 0xff)
#define         BATT_FLAGS(regp) (((regp)->cx & 0xff00) >> 8)
#define         AC_STATE(regp) (((regp)->bx & 0xff00) >> 8)
#define         BATT_LIFE(regp) ((regp)->cx & 0xff) /* in % */
/* Return time in minutes. According to the APM 1.2 spec:
        DX = Remaining battery life -- time units
                Bit 15 = 0      Time units are seconds
                       = 1      Time units are minutes
                Bits 14-0 =     Number of seconds or minutes */
#define         BATT_REMAINING(regp) (((regp)->dx & 0x8000) ? \
                                      ((regp)->dx & 0x7fff) : \
                                      ((regp)->dx & 0x7fff)/60)
#define         BATT_REM_VALID(regp) (((regp)->dx & 0xffff) != 0xffff)
#define         BATT_COUNT(regp)        ((regp)->si)

#define APM_GET_PM_EVENT        0x530b
#define         APM_NOEVENT             0x0000
#define         APM_STANDBY_REQ         0x0001 /* %bx on return */
#define         APM_SUSPEND_REQ         0x0002
#define         APM_NORMAL_RESUME       0x0003
#define         APM_CRIT_RESUME         0x0004 /* suspend/resume happened
                                                  without us */
#define         APM_BATTERY_LOW         0x0005
#define         APM_POWER_CHANGE        0x0006
#define         APM_UPDATE_TIME         0x0007
#define         APM_CRIT_SUSPEND_REQ    0x0008
#define         APM_USER_STANDBY_REQ    0x0009
#define         APM_USER_SUSPEND_REQ    0x000A
#define         APM_SYS_STANDBY_RESUME  0x000B
#define         APM_CAPABILITY_CHANGE   0x000C  /* apm v1.2 */
/* 0x000d - 0x00ff      Reserved system events */
#define         APM_USER_HIBERNATE_REQ  0x000D
/* 0x0100 - 0x01ff      Reserved device events */
/* 0x0200 - 0x02ff      OEM-defined APM events */
/* 0x0300 - 0xffff      Reserved */
#define         APM_EVENT_MASK          0xffff

#define APM_EVENT_COMPOSE(t,i)  ((((i) & 0x7fff) << 16)|((t) & APM_EVENT_MASK))
#define APM_EVENT_TYPE(e)       ((e) & APM_EVENT_MASK)
#define APM_EVENT_INDEX(e)      ((e) >> 16)

#define APM_GET_POWER_STATE     0x530c
#define APM_DEVICE_MGMT_ENABLE  0x530d

#define APM_DRIVER_VERSION      0x530e
/* %bx should be DEV value (APM_DEV_APM_BIOS)
   %ch = driver major vno
   %cl = driver minor vno
   return: %ah = conn major; %al = conn minor
   */
#define         APM_CONN_MINOR(regp) ((regp)->ax & 0xff)
#define         APM_CONN_MAJOR(regp) (((regp)->ax & 0xff00) >> 8)

#define APM_PWR_MGT_ENGAGE      0x530F
#define         APM_MGT_DISENGAGE       0x0     /* %cx */
#define         APM_MGT_ENGAGE          0x1

/* %bx - APM_DEV_APM_BIOS
 * %bl - number of batteries
 * %cx - capabilities
 */
#define APM_GET_CAPABILITIES    0x5310
#define         APM_NBATTERIES(regp)    ((regp)->bx)
#define         APM_GLOBAL_STANDBY      0x0001
#define         APM_GLOBAL_SUSPEND      0x0002
#define         APM_RTIMER_STANDBY      0x0004  /* resume time wakes up */
#define         APM_RTIMER_SUSPEND      0x0008
#define         APM_IRRING_STANDBY      0x0010  /* internal ring wakes up */
#define         APM_IRRING_SUSPEND      0x0020
#define         APM_PCCARD_STANDBY      0x0040  /* pccard wakes up */
#define         APM_PCCARD_SUSPEND      0x0080

/* %bx - APM_DEV_APM_BIOS
 * %cl - function
 *      for %cl=2 (set resume timer)
 * %ch - seconds in BCD
 * %dh - hours in BCD
 * %dl - minutes in BCD
 * %si - month in BCD (high), day in BCD (low)
 * %di - year in BCD
 */
#define APM_RESUME_TIMER        0x5311
#define         APM_RT_DISABLE  0x0
#define         APM_RT_GET      0x1
#define         APM_RT_SET      0x2

/* %bx - APM_DEV_APM_BIOS
 * %cx - function
 */
#define APM_RESUME_ON_RING      0x5312
#define         APM_ROR_DISABLE 0x0
#define         APM_ROR_ENABLE  0x1
#define         APM_ROR_STATUS  0x2

/* %bx - APM_EDV_APM_BIOS
 * %cx - function
 */
#define APM_INACTIVITY_TIMER    0x5313
#define         APM_IT_DISABLE  0x0
#define         APM_IT_ENABLE   0x1
#define         APM_IT_STATUS   0x2

/* %bh - function */
#define APM_OEM                 0x5380
#define         APM_OEM_INSTCHECK       0x7f    /* %bx - OEM ID */

/*
 * LP (Laptop Package)
 *
 * Copyright (C) 1994 by HOSOKAWA Tatsumi <hosokawa@mt.cs.keio.ac.jp>
 *
 * This software may be used, modified, copied, and distributed, in
 * both source and binary form provided that the above copyright and
 * these terms are retained. Under no circumstances is the author
 * responsible for the proper functioning of this software, nor does
 * the author assume any responsibility for damages incurred with its
 * use.
 *
 * Sep., 1994   Implemented on FreeBSD 1.1.5.1R (Toshiba AVS001WD)
 */

#define APM_BATTERY_ABSENT 4

struct apm_power_info {
        u_char battery_state;
        u_char ac_state;
        u_char battery_life;
        u_char spare1;
        u_int minutes_left;             /* estimate */
        u_int spare2[6];
};

struct apm_ctl {
        u_int dev;
        u_int mode;
};

#define APM_IOC_REJECT  _IOW('A', 0, struct apm_event_info) /* reject request # */
#define APM_IOC_STANDBY _IO('A', 1)     /* put system into standby */
#define APM_IOC_SUSPEND _IO('A', 2)     /* put system into suspend */
#define APM_IOC_GETPOWER _IOR('A', 3, struct apm_power_info) /* fetch battery state */
#define APM_IOC_DEV_CTL _IOW('A', 5, struct apm_ctl) /* put device into mode */
#define APM_IOC_PRN_CTL _IOW('A', 6, int ) /* driver power status msg */
#define         APM_PRINT_ON    0       /* driver power status displayed */
#define         APM_PRINT_OFF   1       /* driver power status not displayed */
#define         APM_PRINT_PCT   2       /* driver power status only displayed
                                           if the percentage changes */
#define APM_IOC_STANDBY_REQ     _IO('A', 7)     /* request standby */
#define APM_IOC_SUSPEND_REQ     _IO('A', 8)     /* request suspend */
#define APM_IOC_HIBERNATE       _IO('A', 9)     /* put system into hibernate */


#ifdef _KERNEL
extern void apm_cpu_busy(void);
extern void apm_cpu_idle(void);
extern void apminit(void);
int apm_set_powstate(u_int devid, u_int powstate);
#endif /* _KERNEL */

#endif /* _MACHINE_APMVAR_H_ */