xref: /freebsd/sys/powerpc/powermac/pmuvar.h (revision a9fcb51fbb8d2c5b47a35bcae5b4d5fb771c5985)
1 /*-
2  * Copyright (c) 2006 Michael Lorenz
3  * Copyright (c) 2008 Nathan Whitehorn
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  *
15  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  *
29  */
30 
31 #ifndef PMUVAR_H
32 #define PMUVAR_H
33 
34 /* PMU commands */
35 #define PMU_POWER_CTRL0		0x10	/* control power of some devices */
36 #define PMU_POWER_CTRL		0x11	/* control power of some devices */
37 
38 #define PMU_POWER_OFF		0x7e	/* Turn Power off */
39 #define PMU_RESET_CPU		0xd0	/* Reset CPU */
40 
41 #define PMU_SET_RTC		0x30	/* Set realtime clock */
42 #define PMU_READ_RTC		0x38	/* Read realtime clock */
43 
44 #define PMU_WRITE_PRAM		0x32	/* Write PRAM */
45 #define PMU_READ_PRAM		0x3a	/* Read PRAM */
46 
47 #define PMU_WRITE_NVRAM		0x33	/* Write NVRAM */
48 #define PMU_READ_NVRAM		0x3b	/* Read NVRAM */
49 
50 #define PMU_EJECT_PCMCIA	0x4c	/* Eject PCMCIA slot */
51 
52 #define PMU_SET_BRIGHTNESS	0x41	/* Set backlight brightness */
53 #define PMU_READ_BRIGHTNESS	0xd9	/* Read brightness button position */
54 
55 #define PMU_POWER_EVENTS        0x8f    /* Send power-event commands to PMU */
56 #define PMU_SYSTEM_READY        0xdf    /* tell PMU we are awake */
57 
58 #define PMU_BATTERY_STATE	0x6b	/* Read old battery state */
59 #define PMU_SMART_BATTERY_STATE	0x6f	/* Read battery state */
60 
61 #define PMU_ADB_CMD		0x20	/* Send ADB packet */
62 #define PMU_ADB_POLL_OFF	0x21	/* Disable ADB auto-poll */
63 #define PMU_SET_VOL		0x40	/* Set volume button position */
64 #define PMU_GET_VOL		0x48	/* Get volume button position */
65 #define PMU_SET_IMASK		0x70	/* Set interrupt mask */
66 #define PMU_INT_ACK		0x78	/* Read interrupt bits */
67 #define PMU_CPU_SPEED		0x7d	/* Control CPU speed on some models */
68 #define PMU_SLEEP		0x7f	/* Put CPU to sleep */
69 #define PMU_SET_POLL_MASK	0x86	/*
70 					 * 16bit mask enables autopolling per
71 					 * device
72 					 */
73 #define PMU_I2C_CMD		0x9a	/* i2c commands */
74 #define PMU_GET_LID_STATE	0xdc	/* Report lid state */
75 #define PMU_GET_VERSION		0xea	/* Identify thyself */
76 #define	PMU_SET_SLEEPLED	0xee	/* Set sleep LED on/off */
77 
78 /* Bits in PMU interrupt and interrupt mask bytes */
79 #define PMU_INT_ADB_AUTO	0x04	/* ADB autopoll, when PMU_INT_ADB */
80 #define PMU_INT_PCEJECT		0x04	/* PC-card eject buttons */
81 #define PMU_INT_SNDBRT		0x08	/* sound/brightness up/down buttons */
82 #define PMU_INT_ADB		0x10	/* ADB autopoll or reply data */
83 #define PMU_INT_BATTERY		0x20
84 #define PMU_INT_ENVIRONMENT	0x40
85 #define PMU_INT_TICK		0x80	/* 1-second tick interrupt */
86 
87 /* Bits to use with the PMU_POWER_CTRL0 command */
88 #define PMU_POW0_ON		0x80	/* OR this to power ON the device */
89 #define PMU_POW0_OFF		0x00	/* leave bit 7 to 0 to power it OFF */
90 #define PMU_POW0_HARD_DRIVE	0x04	/* wallstreet/lombard? */
91 
92 /* Bits to use with the PMU_POWER_CTRL command */
93 #define PMU_POW_ON		0x80	/* OR this to power ON the device */
94 #define PMU_POW_OFF		0x00	/* leave bit 7 to 0 to power it OFF */
95 #define PMU_POW_BACKLIGHT	0x01	/* backlight power */
96 #define PMU_POW_CHARGER		0x02	/* battery charger power */
97 #define PMU_POW_IRLED		0x04	/* IR led power (on wallstreet) */
98 #define PMU_POW_MEDIABAY	0x08	/* media bay power (wallstreet/lombard ?) */
99 
100 /* Bits from PMU_GET_LID_STATE or PMU_INT_ENVIRONMENT on core99 */
101 #define PMU_ENV_LID_CLOSED	0x01	/* The lid is closed */
102 #define PMU_ENV_POWER		0x08	/* Power Button pressed */
103 
104 /* PMU PMU_POWER_EVENTS commands */
105 enum {
106 	PMU_PWR_GET_POWERUP_EVENTS      = 0x00,
107 	PMU_PWR_SET_POWERUP_EVENTS      = 0x01,
108 	PMU_PWR_CLR_POWERUP_EVENTS      = 0x02,
109 	PMU_PWR_GET_WAKEUP_EVENTS       = 0x03,
110 	PMU_PWR_SET_WAKEUP_EVENTS       = 0x04,
111 	PMU_PWR_CLR_WAKEUP_EVENTS       = 0x05,
112 };
113 
114 /* PMU Power Information */
115 
116 #define PMU_PWR_AC_PRESENT	(1 << 0)
117 #define PMU_PWR_BATT_CHARGING	(1 << 1)
118 #define PMU_PWR_BATT_PRESENT	(1 << 2)
119 #define PMU_PWR_BATT_FULL	(1 << 5)
120 #define PMU_PWR_PCHARGE_RESET	(1 << 6)
121 #define PMU_PWR_BATT_EXIST	(1 << 7)
122 
123 
124 /* I2C related definitions */
125 #define PMU_I2C_MODE_SIMPLE	0
126 #define PMU_I2C_MODE_STDSUB	1
127 #define PMU_I2C_MODE_COMBINED	2
128 
129 #define PMU_I2C_BUS_STATUS	0
130 #define PMU_I2C_BUS_SYSCLK	1
131 #define PMU_I2C_BUS_POWER	2
132 
133 #define PMU_I2C_STATUS_OK	0
134 #define PMU_I2C_STATUS_DATAREAD	1
135 #define PMU_I2C_STATUS_BUSY	0xfe
136 
137 /* Power events wakeup bits */
138 enum {
139 	PMU_PWR_WAKEUP_KEY		= 0x01, /* Wake on key press */
140 	PMU_PWR_WAKEUP_AC_INSERT	= 0x02, /* Wake on AC adapter plug */
141 	PMU_PWR_WAKEUP_AC_CHANGE 	= 0x04,
142 	PMU_PWR_WAKEUP_LID_OPEN		= 0x08,
143 	PMU_PWR_WAKEUP_RING		= 0x10,
144 };
145 
146 #define PMU_NOTREADY	0x1	/* has not been initialized yet */
147 #define PMU_IDLE	0x2	/* the bus is currently idle */
148 #define PMU_OUT		0x3	/* sending out a command */
149 #define PMU_IN		0x4	/* receiving data */
150 
151 struct pmu_softc {
152 	device_t	sc_dev;
153 	int		sc_memrid;
154 	struct resource	*sc_memr;
155 	int     	sc_irqrid;
156         struct resource *sc_irq;
157         void    	*sc_ih;
158 
159 	struct mtx	sc_mutex;
160 	device_t	adb_bus;
161 	volatile int	sc_autopoll;
162 	int		sc_batteries;
163 	struct cdev	*sc_leddev;
164 	int		lid_closed;
165 	uint8_t		saved_regs[9];
166 };
167 
168 struct pmu_battstate {
169 	int state;
170 
171 	int charge;
172 	int maxcharge;
173 	int current;
174 	int voltage;
175 };
176 
177 int pmu_set_speed(int low_speed);
178 
179 #endif /* PMUVAR_H */
180