xref: /freebsd/sys/dev/acpica/acpi_acad.c (revision 3078531de10dcae44b253a35125c949ff4235284)
1 /*-
2  * Copyright (c) 2000 Takanori Watanabe
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include "opt_acpi.h"
31 #include <sys/param.h>
32 #include <sys/kernel.h>
33 #include <sys/bus.h>
34 
35 #include <machine/bus.h>
36 #include <sys/rman.h>
37 #include <sys/eventhandler.h>
38 #include <sys/ioccom.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/conf.h>
42 #include <sys/power.h>
43 
44 #include <contrib/dev/acpica/include/acpi.h>
45 
46 #include <dev/acpica/acpivar.h>
47 #include <dev/acpica/acpiio.h>
48 #include <isa/isavar.h>
49 #include <isa/pnpvar.h>
50 
51 /* Hooks for the ACPI CA debugging infrastructure */
52 #define _COMPONENT	ACPI_AC_ADAPTER
53 ACPI_MODULE_NAME("AC_ADAPTER")
54 
55 /* Number of times to retry initialization before giving up. */
56 #define ACPI_ACAD_RETRY_MAX		6
57 
58 #define ACPI_POWERSOURCE_STAT_CHANGE	0x80
59 
60 struct	acpi_acad_softc {
61     int status;
62 };
63 
64 static void	acpi_acad_get_status(void *);
65 static void	acpi_acad_notify_handler(ACPI_HANDLE, UINT32, void *);
66 static int	acpi_acad_probe(device_t);
67 static int	acpi_acad_attach(device_t);
68 static int	acpi_acad_ioctl(u_long, caddr_t, void *);
69 static int	acpi_acad_sysctl(SYSCTL_HANDLER_ARGS);
70 static void	acpi_acad_init_acline(void *arg);
71 static void	acpi_acad_ac_only(void *arg);
72 
73 static device_method_t acpi_acad_methods[] = {
74     /* Device interface */
75     DEVMETHOD(device_probe,	acpi_acad_probe),
76     DEVMETHOD(device_attach,	acpi_acad_attach),
77 
78     DEVMETHOD_END
79 };
80 
81 static driver_t acpi_acad_driver = {
82     "acpi_acad",
83     acpi_acad_methods,
84     sizeof(struct acpi_acad_softc),
85 };
86 
87 DRIVER_MODULE(acpi_acad, acpi, acpi_acad_driver, 0, 0);
88 MODULE_DEPEND(acpi_acad, acpi, 1, 1, 1);
89 
90 ACPI_SERIAL_DECL(acad, "ACPI AC adapter");
91 
92 SYSINIT(acad, SI_SUB_KTHREAD_IDLE, SI_ORDER_FIRST, acpi_acad_ac_only, NULL);
93 
94 static void
95 acpi_acad_get_status(void *context)
96 {
97     struct acpi_acad_softc *sc;
98     device_t	dev;
99     ACPI_HANDLE	h;
100     int		newstatus;
101 
102     dev = context;
103     sc = device_get_softc(dev);
104     h = acpi_get_handle(dev);
105     newstatus = -1;
106     acpi_GetInteger(h, "_PSR", &newstatus);
107 
108     /* If status is valid and has changed, notify the system. */
109     ACPI_SERIAL_BEGIN(acad);
110     if (newstatus != -1 && sc->status != newstatus) {
111 	sc->status = newstatus;
112 	ACPI_SERIAL_END(acad);
113 	power_profile_set_state(newstatus ? POWER_PROFILE_PERFORMANCE :
114 	    POWER_PROFILE_ECONOMY);
115 	ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
116 	    "%s Line\n", newstatus ? "On" : "Off");
117 	acpi_UserNotify("ACAD", h, newstatus);
118 	EVENTHANDLER_INVOKE(acpi_acad_event, newstatus);
119     } else
120 	ACPI_SERIAL_END(acad);
121 }
122 
123 static void
124 acpi_acad_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
125 {
126     device_t dev;
127 
128     dev = (device_t)context;
129     switch (notify) {
130     case ACPI_NOTIFY_BUS_CHECK:
131     case ACPI_NOTIFY_DEVICE_CHECK:
132     case ACPI_POWERSOURCE_STAT_CHANGE:
133 	/* Temporarily.  It is better to notify policy manager */
134 	AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_acad_get_status, context);
135 	break;
136     default:
137 	device_printf(dev, "unknown notify %#x\n", notify);
138 	break;
139     }
140 }
141 
142 static int
143 acpi_acad_probe(device_t dev)
144 {
145     static char *acad_ids[] = { "ACPI0003", NULL };
146     int rv;
147 
148     if (acpi_disabled("acad"))
149 	return (ENXIO);
150     rv = ACPI_ID_PROBE(device_get_parent(dev), dev, acad_ids, NULL);
151     if (rv <= 0)
152 	device_set_desc(dev, "AC Adapter");
153     return (rv);
154 }
155 
156 static int
157 acpi_acad_attach(device_t dev)
158 {
159     struct acpi_acad_softc *sc;
160     struct acpi_softc	   *acpi_sc;
161     ACPI_HANDLE	handle;
162     int		error;
163 
164     sc = device_get_softc(dev);
165     handle = acpi_get_handle(dev);
166 
167     error = acpi_register_ioctl(ACPIIO_ACAD_GET_STATUS, acpi_acad_ioctl, dev);
168     if (error != 0)
169 	return (error);
170 
171     if (device_get_unit(dev) == 0) {
172 	acpi_sc = acpi_device_get_parent_softc(dev);
173 	SYSCTL_ADD_PROC(&acpi_sc->acpi_sysctl_ctx,
174 	    SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree), OID_AUTO, "acline",
175 	    CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, dev, 0,
176 	    acpi_acad_sysctl, "I", "");
177     }
178 
179     /* Get initial status after whole system is up. */
180     sc->status = -1;
181 
182     /*
183      * Install both system and device notify handlers since the Casio
184      * FIVA needs them.
185      */
186     AcpiInstallNotifyHandler(handle, ACPI_ALL_NOTIFY,
187 			     acpi_acad_notify_handler, dev);
188     AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_acad_init_acline, dev);
189 
190     return (0);
191 }
192 
193 static int
194 acpi_acad_ioctl(u_long cmd, caddr_t addr, void *arg)
195 {
196     struct acpi_acad_softc *sc;
197     device_t dev;
198 
199     dev = (device_t)arg;
200     sc = device_get_softc(dev);
201 
202     /*
203      * No security check required: information retrieval only.  If
204      * new functions are added here, a check might be required.
205      */
206     switch (cmd) {
207     case ACPIIO_ACAD_GET_STATUS:
208 	acpi_acad_get_status(dev);
209 	*(int *)addr = sc->status;
210 	break;
211     default:
212 	break;
213     }
214 
215     return (0);
216 }
217 
218 static int
219 acpi_acad_sysctl(SYSCTL_HANDLER_ARGS)
220 {
221     device_t dev = oidp->oid_arg1;
222     struct acpi_acad_softc *sc = device_get_softc(dev);
223     int val;
224 
225     acpi_acad_get_status(dev);
226     val = sc->status;
227     return (sysctl_handle_int(oidp, &val, 0, req));
228 }
229 
230 static void
231 acpi_acad_init_acline(void *arg)
232 {
233     struct acpi_acad_softc *sc;
234     device_t	dev;
235     int		retry;
236 
237     dev = (device_t)arg;
238     sc = device_get_softc(dev);
239     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
240 		"acline initialization start\n");
241 
242     for (retry = 0; retry < ACPI_ACAD_RETRY_MAX; retry++) {
243 	acpi_acad_get_status(dev);
244 	if (sc->status != -1)
245 	    break;
246 	AcpiOsSleep(10000);
247     }
248 
249     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
250 		"acline initialization done, tried %d times\n", retry + 1);
251 }
252 
253 /*
254  * If no AC line devices detected after boot, create an "online" event
255  * so that userland code can adjust power settings accordingly.  The default
256  * power profile is "performance" so we don't need to repeat that here.
257  */
258 static void
259 acpi_acad_ac_only(void __unused *arg)
260 {
261 
262     if (devclass_get_count(devclass_find("acpi_acad")) == 0)
263 	acpi_UserNotify("ACAD", ACPI_ROOT_OBJECT, 1);
264 }
265 
266 /*
267  * Public interfaces.
268  */
269 int
270 acpi_acad_get_acline(int *status)
271 {
272     struct acpi_acad_softc *sc;
273     device_t dev;
274 
275     dev = devclass_get_device(devclass_find("acpi_acad"), 0);
276     if (dev == NULL)
277 	return (ENXIO);
278     sc = device_get_softc(dev);
279 
280     acpi_acad_get_status(dev);
281     *status = sc->status;
282 
283     return (0);
284 }
285