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