master
1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2/*
3 * Definitions for talking to the PMU. The PMU is a microcontroller
4 * which controls battery charging and system power on PowerBook 3400
5 * and 2400 models as well as the RTC and various other things.
6 *
7 * Copyright (C) 1998 Paul Mackerras.
8 */
9
10#ifndef _LINUX_PMU_H
11#define _LINUX_PMU_H
12
13#define PMU_DRIVER_VERSION 2
14
15/*
16 * PMU commands
17 */
18#define PMU_POWER_CTRL0 0x10 /* control power of some devices */
19#define PMU_POWER_CTRL 0x11 /* control power of some devices */
20#define PMU_ADB_CMD 0x20 /* send ADB packet */
21#define PMU_ADB_POLL_OFF 0x21 /* disable ADB auto-poll */
22#define PMU_WRITE_XPRAM 0x32 /* write eXtended Parameter RAM */
23#define PMU_WRITE_NVRAM 0x33 /* write non-volatile RAM */
24#define PMU_READ_XPRAM 0x3a /* read eXtended Parameter RAM */
25#define PMU_READ_NVRAM 0x3b /* read non-volatile RAM */
26#define PMU_SET_RTC 0x30 /* set real-time clock */
27#define PMU_READ_RTC 0x38 /* read real-time clock */
28#define PMU_SET_VOLBUTTON 0x40 /* set volume up/down position */
29#define PMU_BACKLIGHT_BRIGHT 0x41 /* set backlight brightness */
30#define PMU_GET_VOLBUTTON 0x48 /* get volume up/down position */
31#define PMU_PCEJECT 0x4c /* eject PC-card from slot */
32#define PMU_BATTERY_STATE 0x6b /* report battery state etc. */
33#define PMU_SMART_BATTERY_STATE 0x6f /* report battery state (new way) */
34#define PMU_SET_INTR_MASK 0x70 /* set PMU interrupt mask */
35#define PMU_INT_ACK 0x78 /* read interrupt bits */
36#define PMU_SHUTDOWN 0x7e /* turn power off */
37#define PMU_CPU_SPEED 0x7d /* control CPU speed on some models */
38#define PMU_SLEEP 0x7f /* put CPU to sleep */
39#define PMU_POWER_EVENTS 0x8f /* Send power-event commands to PMU */
40#define PMU_I2C_CMD 0x9a /* I2C operations */
41#define PMU_RESET 0xd0 /* reset CPU */
42#define PMU_GET_BRIGHTBUTTON 0xd9 /* report brightness up/down pos */
43#define PMU_GET_COVER 0xdc /* report cover open/closed */
44#define PMU_SYSTEM_READY 0xdf /* tell PMU we are awake */
45#define PMU_GET_VERSION 0xea /* read the PMU version */
46
47/* Bits to use with the PMU_POWER_CTRL0 command */
48#define PMU_POW0_ON 0x80 /* OR this to power ON the device */
49#define PMU_POW0_OFF 0x00 /* leave bit 7 to 0 to power it OFF */
50#define PMU_POW0_HARD_DRIVE 0x04 /* Hard drive power (on wallstreet/lombard ?) */
51
52/* Bits to use with the PMU_POWER_CTRL command */
53#define PMU_POW_ON 0x80 /* OR this to power ON the device */
54#define PMU_POW_OFF 0x00 /* leave bit 7 to 0 to power it OFF */
55#define PMU_POW_BACKLIGHT 0x01 /* backlight power */
56#define PMU_POW_CHARGER 0x02 /* battery charger power */
57#define PMU_POW_IRLED 0x04 /* IR led power (on wallstreet) */
58#define PMU_POW_MEDIABAY 0x08 /* media bay power (wallstreet/lombard ?) */
59
60/* Bits in PMU interrupt and interrupt mask bytes */
61#define PMU_INT_PCEJECT 0x04 /* PC-card eject buttons */
62#define PMU_INT_SNDBRT 0x08 /* sound/brightness up/down buttons */
63#define PMU_INT_ADB 0x10 /* ADB autopoll or reply data */
64#define PMU_INT_BATTERY 0x20 /* Battery state change */
65#define PMU_INT_ENVIRONMENT 0x40 /* Environment interrupts */
66#define PMU_INT_TICK 0x80 /* 1-second tick interrupt */
67
68/* Other bits in PMU interrupt valid when PMU_INT_ADB is set */
69#define PMU_INT_ADB_AUTO 0x04 /* ADB autopoll, when PMU_INT_ADB */
70#define PMU_INT_WAITING_CHARGER 0x01 /* ??? */
71#define PMU_INT_AUTO_SRQ_POLL 0x02 /* ??? */
72
73/* Bits in the environement message (either obtained via PMU_GET_COVER,
74 * or via PMU_INT_ENVIRONMENT on core99 */
75#define PMU_ENV_LID_CLOSED 0x01 /* The lid is closed */
76
77/* I2C related definitions */
78#define PMU_I2C_MODE_SIMPLE 0
79#define PMU_I2C_MODE_STDSUB 1
80#define PMU_I2C_MODE_COMBINED 2
81
82#define PMU_I2C_BUS_STATUS 0
83#define PMU_I2C_BUS_SYSCLK 1
84#define PMU_I2C_BUS_POWER 2
85
86#define PMU_I2C_STATUS_OK 0
87#define PMU_I2C_STATUS_DATAREAD 1
88#define PMU_I2C_STATUS_BUSY 0xfe
89
90
91/* Kind of PMU (model) */
92enum {
93 PMU_UNKNOWN,
94 PMU_OHARE_BASED, /* 2400, 3400, 3500 (old G3 powerbook) */
95 PMU_HEATHROW_BASED, /* PowerBook G3 series */
96 PMU_PADDINGTON_BASED, /* 1999 PowerBook G3 */
97 PMU_KEYLARGO_BASED, /* Core99 motherboard (PMU99) */
98 PMU_68K_V1, /* Unused/deprecated */
99 PMU_68K_V2, /* Unused/deprecated */
100};
101
102/* PMU PMU_POWER_EVENTS commands */
103enum {
104 PMU_PWR_GET_POWERUP_EVENTS = 0x00,
105 PMU_PWR_SET_POWERUP_EVENTS = 0x01,
106 PMU_PWR_CLR_POWERUP_EVENTS = 0x02,
107 PMU_PWR_GET_WAKEUP_EVENTS = 0x03,
108 PMU_PWR_SET_WAKEUP_EVENTS = 0x04,
109 PMU_PWR_CLR_WAKEUP_EVENTS = 0x05,
110};
111
112/* Power events wakeup bits */
113enum {
114 PMU_PWR_WAKEUP_KEY = 0x01, /* Wake on key press */
115 PMU_PWR_WAKEUP_AC_INSERT = 0x02, /* Wake on AC adapter plug */
116 PMU_PWR_WAKEUP_AC_CHANGE = 0x04,
117 PMU_PWR_WAKEUP_LID_OPEN = 0x08,
118 PMU_PWR_WAKEUP_RING = 0x10,
119};
120
121/*
122 * Ioctl commands for the /dev/pmu device
123 */
124#include <linux/ioctl.h>
125
126/* no param */
127#define PMU_IOC_SLEEP _IO('B', 0)
128/* out param: u32* backlight value: 0 to 15 */
129#define PMU_IOC_GET_BACKLIGHT _IOR('B', 1, size_t)
130/* in param: u32 backlight value: 0 to 15 */
131#define PMU_IOC_SET_BACKLIGHT _IOW('B', 2, size_t)
132/* out param: u32* PMU model */
133#define PMU_IOC_GET_MODEL _IOR('B', 3, size_t)
134/* out param: u32* has_adb: 0 or 1 */
135#define PMU_IOC_HAS_ADB _IOR('B', 4, size_t)
136/* out param: u32* can_sleep: 0 or 1 */
137#define PMU_IOC_CAN_SLEEP _IOR('B', 5, size_t)
138/* no param, but historically was _IOR('B', 6, 0), meaning 4 bytes */
139#define PMU_IOC_GRAB_BACKLIGHT _IOR('B', 6, size_t)
140
141
142#endif /* _LINUX_PMU_H */