373bd3b9b330f2db82c06d3ef59ec0f9e1829834
[linux-2.6.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_I2C_CMD             0x9a    /* I2C operations */
37 #define PMU_RESET               0xd0    /* reset CPU */
38 #define PMU_GET_BRIGHTBUTTON    0xd9    /* report brightness up/down pos */
39 #define PMU_GET_COVER           0xdc    /* report cover open/closed */
40 #define PMU_SYSTEM_READY        0xdf    /* tell PMU we are awake */
41 #define PMU_GET_VERSION         0xea    /* read the PMU version */
42
43 /* Bits to use with the PMU_POWER_CTRL0 command */
44 #define PMU_POW0_ON             0x80    /* OR this to power ON the device */
45 #define PMU_POW0_OFF            0x00    /* leave bit 7 to 0 to power it OFF */
46 #define PMU_POW0_HARD_DRIVE     0x04    /* Hard drive power (on wallstreet/lombard ?) */
47
48 /* Bits to use with the PMU_POWER_CTRL command */
49 #define PMU_POW_ON              0x80    /* OR this to power ON the device */
50 #define PMU_POW_OFF             0x00    /* leave bit 7 to 0 to power it OFF */
51 #define PMU_POW_BACKLIGHT       0x01    /* backlight power */
52 #define PMU_POW_CHARGER         0x02    /* battery charger power */
53 #define PMU_POW_IRLED           0x04    /* IR led power (on wallstreet) */
54 #define PMU_POW_MEDIABAY        0x08    /* media bay power (wallstreet/lombard ?) */
55
56 /* Bits in PMU interrupt and interrupt mask bytes */
57 #define PMU_INT_PCEJECT         0x04    /* PC-card eject buttons */
58 #define PMU_INT_SNDBRT          0x08    /* sound/brightness up/down buttons */
59 #define PMU_INT_ADB             0x10    /* ADB autopoll or reply data */
60 #define PMU_INT_BATTERY         0x20    /* Battery state change */
61 #define PMU_INT_ENVIRONMENT     0x40    /* Environment interrupts */
62 #define PMU_INT_TICK            0x80    /* 1-second tick interrupt */
63
64 /* Other bits in PMU interrupt valid when PMU_INT_ADB is set */
65 #define PMU_INT_ADB_AUTO        0x04    /* ADB autopoll, when PMU_INT_ADB */
66 #define PMU_INT_WAITING_CHARGER 0x01    /* ??? */
67 #define PMU_INT_AUTO_SRQ_POLL   0x02    /* ??? */
68
69 /* Bits in the environement message (either obtained via PMU_GET_COVER,
70  * or via PMU_INT_ENVIRONMENT on core99 */
71 #define PMU_ENV_LID_CLOSED      0x01    /* The lid is closed */
72
73 /* I2C related definitions */
74 #define PMU_I2C_MODE_SIMPLE     0
75 #define PMU_I2C_MODE_STDSUB     1
76 #define PMU_I2C_MODE_COMBINED   2
77
78 #define PMU_I2C_BUS_STATUS      0
79 #define PMU_I2C_BUS_SYSCLK      1
80 #define PMU_I2C_BUS_POWER       2
81
82 #define PMU_I2C_STATUS_OK       0
83 #define PMU_I2C_STATUS_DATAREAD 1
84 #define PMU_I2C_STATUS_BUSY     0xfe
85
86
87 /* Kind of PMU (model) */
88 enum {
89         PMU_UNKNOWN,
90         PMU_OHARE_BASED,        /* 2400, 3400, 3500 (old G3 powerbook) */
91         PMU_HEATHROW_BASED,     /* PowerBook G3 series */
92         PMU_PADDINGTON_BASED,   /* 1999 PowerBook G3 */
93         PMU_KEYLARGO_BASED,     /* Core99 motherboard (PMU99) */
94         PMU_68K_V1,             /* 68K PMU, version 1 */
95         PMU_68K_V2,             /* 68K PMU, version 2 */
96 };
97
98 /* PMU PMU_POWER_EVENTS commands */
99 enum {
100         PMU_PWR_GET_POWERUP_EVENTS      = 0x00,
101         PMU_PWR_SET_POWERUP_EVENTS      = 0x01,
102         PMU_PWR_CLR_POWERUP_EVENTS      = 0x02,
103         PMU_PWR_GET_WAKEUP_EVENTS       = 0x03,
104         PMU_PWR_SET_WAKEUP_EVENTS       = 0x04,
105         PMU_PWR_CLR_WAKEUP_EVENTS       = 0x05,
106 };
107
108 /* Power events wakeup bits */
109 enum {
110         PMU_PWR_WAKEUP_KEY              = 0x01, /* Wake on key press */
111         PMU_PWR_WAKEUP_AC_INSERT        = 0x02, /* Wake on AC adapter plug */
112         PMU_PWR_WAKEUP_AC_CHANGE        = 0x04,
113         PMU_PWR_WAKEUP_LID_OPEN         = 0x08,
114         PMU_PWR_WAKEUP_RING             = 0x10,
115 };
116         
117 /*
118  * Ioctl commands for the /dev/pmu device
119  */
120 #include <linux/ioctl.h>
121
122 /* no param */
123 #define PMU_IOC_SLEEP           _IO('B', 0)
124 /* out param: u32*      backlight value: 0 to 15 */
125 #define PMU_IOC_GET_BACKLIGHT   _IOR('B', 1, size_t)
126 /* in param: u32        backlight value: 0 to 15 */
127 #define PMU_IOC_SET_BACKLIGHT   _IOW('B', 2, size_t)
128 /* out param: u32*      PMU model */
129 #define PMU_IOC_GET_MODEL       _IOR('B', 3, size_t)
130 /* out param: u32*      has_adb: 0 or 1 */
131 #define PMU_IOC_HAS_ADB         _IOR('B', 4, size_t) 
132 /* out param: u32*      can_sleep: 0 or 1 */
133 #define PMU_IOC_CAN_SLEEP       _IOR('B', 5, size_t) 
134 /* no param, but historically was _IOR('B', 6, 0), meaning 4 bytes */
135 #define PMU_IOC_GRAB_BACKLIGHT  _IOR('B', 6, size_t) 
136
137 #ifdef __KERNEL__
138
139 extern int find_via_pmu(void);
140
141 extern int pmu_request(struct adb_request *req,
142                 void (*done)(struct adb_request *), int nbytes, ...);
143
144 extern void pmu_poll(void);
145 extern void pmu_poll_adb(void); /* For use by xmon */
146 extern void pmu_wait_complete(struct adb_request *req);
147
148 /* For use before switching interrupts off for a long time;
149  * warning: not stackable
150  */
151 extern void pmu_suspend(void);
152 extern void pmu_resume(void);
153
154 extern void pmu_enable_irled(int on);
155
156 extern void pmu_restart(void);
157 extern void pmu_shutdown(void);
158 extern void pmu_unlock(void);
159
160 extern int pmu_present(void);
161 extern int pmu_get_model(void);
162
163 extern int pmu_i2c_combined_read(int bus, int addr, int subaddr,  u8* data, int len);
164 extern int pmu_i2c_stdsub_write(int bus, int addr, int subaddr,  u8* data, int len);
165 extern int pmu_i2c_simple_read(int bus, int addr,  u8* data, int len);
166 extern int pmu_i2c_simple_write(int bus, int addr,  u8* data, int len);
167
168
169 #ifdef CONFIG_PM
170 /*
171  * Stuff for putting the powerbook to sleep and waking it again.
172  *
173  */
174 #include <linux/list.h>
175
176 struct pmu_sleep_notifier
177 {
178         int (*notifier_call)(struct pmu_sleep_notifier *self, int when);
179         int priority;
180         struct list_head list;
181 };
182
183 /* Code values for calling sleep/wakeup handlers
184  *
185  * Note: If a sleep request got cancelled, all drivers will get
186  * the PBOOK_SLEEP_REJECT, even those who didn't get the PBOOK_SLEEP_REQUEST.
187  */
188 #define PBOOK_SLEEP_REQUEST     1
189 #define PBOOK_SLEEP_NOW         2
190 #define PBOOK_SLEEP_REJECT      3
191 #define PBOOK_WAKE              4
192
193 /* Result codes returned by the notifiers */
194 #define PBOOK_SLEEP_OK          0
195 #define PBOOK_SLEEP_REFUSE      -1
196
197 /* priority levels in notifiers */
198 #define SLEEP_LEVEL_VIDEO       100     /* Video driver (first wake) */
199 #define SLEEP_LEVEL_MEDIABAY    90      /* Media bay driver */
200 #define SLEEP_LEVEL_BLOCK       80      /* IDE, SCSI */
201 #define SLEEP_LEVEL_NET         70      /* bmac, gmac */
202 #define SLEEP_LEVEL_MISC        60      /* Anything else */
203 #define SLEEP_LEVEL_USERLAND    55      /* Reserved for apm_emu */
204 #define SLEEP_LEVEL_ADB         50      /* ADB (async) */
205 #define SLEEP_LEVEL_SOUND       40      /* Sound driver (blocking) */
206
207 /* special register notifier functions */
208 int pmu_register_sleep_notifier(struct pmu_sleep_notifier* notifier);
209 int pmu_unregister_sleep_notifier(struct pmu_sleep_notifier* notifier);
210
211 #endif /* CONFIG_PM */
212
213 #define PMU_MAX_BATTERIES       2
214
215 /* values for pmu_power_flags */
216 #define PMU_PWR_AC_PRESENT      0x00000001
217
218 /* values for pmu_battery_info.flags */
219 #define PMU_BATT_PRESENT        0x00000001
220 #define PMU_BATT_CHARGING       0x00000002
221 #define PMU_BATT_TYPE_MASK      0x000000f0
222 #define PMU_BATT_TYPE_SMART     0x00000010 /* Smart battery */
223 #define PMU_BATT_TYPE_HOOPER    0x00000020 /* 3400/3500 */
224 #define PMU_BATT_TYPE_COMET     0x00000030 /* 2400 */
225
226 struct pmu_battery_info
227 {
228         unsigned int    flags;
229         unsigned int    charge;         /* current charge */
230         unsigned int    max_charge;     /* maximum charge */
231         signed int      amperage;       /* current, positive if charging */
232         unsigned int    voltage;        /* voltage */
233         unsigned int    time_remaining; /* remaining time */
234 };
235
236 extern int pmu_battery_count;
237 extern struct pmu_battery_info pmu_batteries[PMU_MAX_BATTERIES];
238 extern unsigned int pmu_power_flags;
239
240 #endif  /* __KERNEL__ */