make oldconfig will rebuild these...
[linux-2.4.21-pre4.git] / include / linux / pmu.h
1 /*
2  * Definitions for talking to the PMU.  The PMU is a microcontroller
3  * which controls battery charging and system power on PowerBook 3400
4  * and 2400 models as well as the RTC and various other things.
5  *
6  * Copyright (C) 1998 Paul Mackerras.
7  */
8
9 #include <linux/config.h>
10
11 #define PMU_DRIVER_VERSION      2
12
13 /*
14  * PMU commands
15  */
16 #define PMU_POWER_CTRL0         0x10    /* control power of some devices */
17 #define PMU_POWER_CTRL          0x11    /* control power of some devices */
18 #define PMU_ADB_CMD             0x20    /* send ADB packet */
19 #define PMU_ADB_POLL_OFF        0x21    /* disable ADB auto-poll */
20 #define PMU_WRITE_NVRAM         0x33    /* write non-volatile RAM */
21 #define PMU_READ_NVRAM          0x3b    /* read non-volatile RAM */
22 #define PMU_SET_RTC             0x30    /* set real-time clock */
23 #define PMU_READ_RTC            0x38    /* read real-time clock */
24 #define PMU_SET_VOLBUTTON       0x40    /* set volume up/down position */
25 #define PMU_BACKLIGHT_BRIGHT    0x41    /* set backlight brightness */
26 #define PMU_GET_VOLBUTTON       0x48    /* get volume up/down position */
27 #define PMU_PCEJECT             0x4c    /* eject PC-card from slot */
28 #define PMU_BATTERY_STATE       0x6b    /* report battery state etc. */
29 #define PMU_SMART_BATTERY_STATE 0x6f    /* report battery state (new way) */
30 #define PMU_SET_INTR_MASK       0x70    /* set PMU interrupt mask */
31 #define PMU_INT_ACK             0x78    /* read interrupt bits */
32 #define PMU_SHUTDOWN            0x7e    /* turn power off */
33 #define PMU_CPU_SPEED           0x7d    /* control CPU speed on some models */
34 #define PMU_SLEEP               0x7f    /* put CPU to sleep */
35 #define PMU_POWER_EVENTS        0x8f    /* Send power-event commands to PMU */
36 #define PMU_RESET               0xd0    /* reset CPU */
37 #define PMU_GET_BRIGHTBUTTON    0xd9    /* report brightness up/down pos */
38 #define PMU_GET_COVER           0xdc    /* report cover open/closed */
39 #define PMU_SYSTEM_READY        0xdf    /* tell PMU we are awake */
40 #define PMU_GET_VERSION         0xea    /* read the PMU version */
41
42 /* Bits to use with the PMU_POWER_CTRL0 command */
43 #define PMU_POW0_ON             0x80    /* OR this to power ON the device */
44 #define PMU_POW0_OFF            0x00    /* leave bit 7 to 0 to power it OFF */
45 #define PMU_POW0_HARD_DRIVE     0x04    /* Hard drive power (on wallstreet/lombard ?) */
46
47 /* Bits to use with the PMU_POWER_CTRL command */
48 #define PMU_POW_ON              0x80    /* OR this to power ON the device */
49 #define PMU_POW_OFF             0x00    /* leave bit 7 to 0 to power it OFF */
50 #define PMU_POW_BACKLIGHT       0x01    /* backlight power */
51 #define PMU_POW_CHARGER         0x02    /* battery charger power */
52 #define PMU_POW_IRLED           0x04    /* IR led power (on wallstreet) */
53 #define PMU_POW_MEDIABAY        0x08    /* media bay power (wallstreet/lombard ?) */
54
55 /* Bits in PMU interrupt and interrupt mask bytes */
56 #define PMU_INT_PCEJECT         0x04    /* PC-card eject buttons */
57 #define PMU_INT_SNDBRT          0x08    /* sound/brightness up/down buttons */
58 #define PMU_INT_ADB             0x10    /* ADB autopoll or reply data */
59 #define PMU_INT_BATTERY         0x20    /* Battery state change */
60 #define PMU_INT_ENVIRONMENT     0x40    /* Environment interrupts */
61 #define PMU_INT_TICK            0x80    /* 1-second tick interrupt */
62
63 /* Other bits in PMU interrupt valid when PMU_INT_ADB is set */
64 #define PMU_INT_ADB_AUTO        0x04    /* ADB autopoll, when PMU_INT_ADB */
65 #define PMU_INT_WAITING_CHARGER 0x01    /* ??? */
66 #define PMU_INT_AUTO_SRQ_POLL   0x02    /* ??? */
67
68 /* Bits in the environement message (either obtained via PMU_GET_COVER,
69  * or via PMU_INT_ENVIRONMENT on core99 */
70 #define PMU_ENV_LID_CLOSED      0x01    /* The lid is closed */
71
72 /* Kind of PMU (model) */
73 enum {
74         PMU_UNKNOWN,
75         PMU_OHARE_BASED,        /* 2400, 3400, 3500 (old G3 powerbook) */
76         PMU_HEATHROW_BASED,     /* PowerBook G3 series */
77         PMU_PADDINGTON_BASED,   /* 1999 PowerBook G3 */
78         PMU_KEYLARGO_BASED,     /* Core99 motherboard (PMU99) */
79         PMU_68K_V1,             /* 68K PMU, version 1 */
80         PMU_68K_V2,             /* 68K PMU, version 2 */
81 };
82
83 /* PMU PMU_POWER_EVENTS commands */
84 enum {
85         PMU_PWR_GET_POWERUP_EVENTS      = 0x00,
86         PMU_PWR_SET_POWERUP_EVENTS      = 0x01,
87         PMU_PWR_CLR_POWERUP_EVENTS      = 0x02,
88         PMU_PWR_GET_WAKEUP_EVENTS       = 0x03,
89         PMU_PWR_SET_WAKEUP_EVENTS       = 0x04,
90         PMU_PWR_CLR_WAKEUP_EVENTS       = 0x05,
91 };
92
93 /* Power events wakeup bits */
94 enum {
95         PMU_PWR_WAKEUP_KEY              = 0x01, /* Wake on key press */
96         PMU_PWR_WAKEUP_AC_INSERT        = 0x02, /* Wake on AC adapter plug */
97         PMU_PWR_WAKEUP_AC_CHANGE        = 0x04,
98         PMU_PWR_WAKEUP_LID_OPEN         = 0x08,
99         PMU_PWR_WAKEUP_RING             = 0x10,
100 };
101         
102 /*
103  * Ioctl commands for the /dev/pmu device
104  */
105 #include <linux/ioctl.h>
106
107 /* no param */
108 #define PMU_IOC_SLEEP           _IO('B', 0)
109 /* out param: u32*      backlight value: 0 to 15 */
110 #define PMU_IOC_GET_BACKLIGHT   _IOR('B', 1, sizeof(__u32*))
111 /* in param: u32        backlight value: 0 to 15 */
112 #define PMU_IOC_SET_BACKLIGHT   _IOW('B', 2, sizeof(__u32))
113 /* out param: u32*      PMU model */
114 #define PMU_IOC_GET_MODEL       _IOR('B', 3, sizeof(__u32*))
115 /* out param: u32*      has_adb: 0 or 1 */
116 #define PMU_IOC_HAS_ADB         _IOR('B', 4, sizeof(__u32*)) 
117 /* out param: u32*      can_sleep: 0 or 1 */
118 #define PMU_IOC_CAN_SLEEP       _IOR('B', 5, sizeof(__u32*)) 
119 /* no param */
120 #define PMU_IOC_GRAB_BACKLIGHT  _IOR('B', 6, 0) 
121
122 #ifdef __KERNEL__
123
124 extern int find_via_pmu(void);
125 extern int via_pmu_start(void);
126
127 extern int pmu_request(struct adb_request *req,
128                 void (*done)(struct adb_request *), int nbytes, ...);
129
130 extern void pmu_poll(void);
131
132 /* For use before switching interrupts off for a long time;
133  * warning: not stackable
134  */
135 extern void pmu_suspend(void);
136 extern void pmu_resume(void);
137
138 extern void pmu_enable_irled(int on);
139
140 extern void pmu_restart(void);
141 extern void pmu_shutdown(void);
142
143 extern int pmu_present(void);
144 extern int pmu_get_model(void);
145
146 #ifdef CONFIG_PMAC_PBOOK
147 /*
148  * Stuff for putting the powerbook to sleep and waking it again.
149  *
150  */
151 #include <linux/list.h>
152
153 struct pmu_sleep_notifier
154 {
155         int (*notifier_call)(struct pmu_sleep_notifier *self, int when);
156         int priority;
157         struct list_head list;
158 };
159
160 /* Code values for calling sleep/wakeup handlers
161  *
162  * Note: If a sleep request got cancelled, all drivers will get
163  * the PBOOK_SLEEP_REJECT, even those who didn't get the PBOOK_SLEEP_REQUEST.
164  */
165 #define PBOOK_SLEEP_REQUEST     1
166 #define PBOOK_SLEEP_NOW         2
167 #define PBOOK_SLEEP_REJECT      3
168 #define PBOOK_WAKE              4
169
170 /* Result codes returned by the notifiers */
171 #define PBOOK_SLEEP_OK          0
172 #define PBOOK_SLEEP_REFUSE      -1
173
174 /* priority levels in notifiers */
175 #define SLEEP_LEVEL_VIDEO       100     /* Video driver (first wake) */
176 #define SLEEP_LEVEL_MEDIABAY    90      /* Media bay driver */
177 #define SLEEP_LEVEL_BLOCK       80      /* IDE, SCSI */
178 #define SLEEP_LEVEL_NET         70      /* bmac, gmac */
179 #define SLEEP_LEVEL_MISC        60      /* Anything else */
180 #define SLEEP_LEVEL_USERLAND    55      /* Reserved for apm_emu */
181 #define SLEEP_LEVEL_ADB         50      /* ADB (async) */
182 #define SLEEP_LEVEL_SOUND       40      /* Sound driver (blocking) */
183
184 /* special register notifier functions */
185 int pmu_register_sleep_notifier(struct pmu_sleep_notifier* notifier);
186 int pmu_unregister_sleep_notifier(struct pmu_sleep_notifier* notifier);
187
188 #define PMU_MAX_BATTERIES       2
189
190 /* values for pmu_power_flags */
191 #define PMU_PWR_AC_PRESENT      0x00000001
192
193 /* values for pmu_battery_info.flags */
194 #define PMU_BATT_PRESENT        0x00000001
195 #define PMU_BATT_CHARGING       0x00000002
196 #define PMU_BATT_TYPE_MASK      0x000000f0
197 #define PMU_BATT_TYPE_SMART     0x00000010 /* Smart battery */
198 #define PMU_BATT_TYPE_HOOPER    0x00000020 /* 3400/3500 */
199 #define PMU_BATT_TYPE_COMET     0x00000030 /* 2400 */
200
201 struct pmu_battery_info
202 {
203         unsigned int    flags;
204         unsigned int    charge;         /* current charge */
205         unsigned int    max_charge;     /* maximum charge */
206         signed int      current;        /* current, positive if charging */
207         unsigned int    voltage;        /* voltage */
208         unsigned int    time_remaining; /* remaining time */
209 };
210
211 extern int pmu_battery_count;
212 extern struct pmu_battery_info pmu_batteries[PMU_MAX_BATTERIES];
213 extern unsigned int pmu_power_flags;
214
215 #endif /* CONFIG_PMAC_PBOOK */
216
217 #endif  /* __KERNEL__ */