xref: /freebsd/sys/dev/acpica/acpi_acad.c (revision 830940567b49bb0c08dfaed40418999e76616909)
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/ioccom.h>
38 #include <sys/malloc.h>
39 #include <sys/module.h>
40 #include <sys/conf.h>
41 #include <sys/power.h>
42 
43 #include <contrib/dev/acpica/include/acpi.h>
44 
45 #include <dev/acpica/acpivar.h>
46 #include <dev/acpica/acpiio.h>
47 #include <isa/isavar.h>
48 #include <isa/pnpvar.h>
49 
50 /* Hooks for the ACPI CA debugging infrastructure */
51 #define _COMPONENT	ACPI_AC_ADAPTER
52 ACPI_MODULE_NAME("AC_ADAPTER")
53 
54 /* Number of times to retry initialization before giving up. */
55 #define ACPI_ACAD_RETRY_MAX		6
56 
57 #define ACPI_POWERSOURCE_STAT_CHANGE	0x80
58 
59 struct	acpi_acad_softc {
60     int status;
61 };
62 
63 static void	acpi_acad_get_status(void *);
64 static void	acpi_acad_notify_handler(ACPI_HANDLE, UINT32, void *);
65 static int	acpi_acad_probe(device_t);
66 static int	acpi_acad_attach(device_t);
67 static int	acpi_acad_ioctl(u_long, caddr_t, void *);
68 static int	acpi_acad_sysctl(SYSCTL_HANDLER_ARGS);
69 static void	acpi_acad_init_acline(void *arg);
70 static void	acpi_acad_ac_only(void *arg);
71 
72 static device_method_t acpi_acad_methods[] = {
73     /* Device interface */
74     DEVMETHOD(device_probe,	acpi_acad_probe),
75     DEVMETHOD(device_attach,	acpi_acad_attach),
76 
77     {0, 0}
78 };
79 
80 static driver_t acpi_acad_driver = {
81     "acpi_acad",
82     acpi_acad_methods,
83     sizeof(struct acpi_acad_softc),
84 };
85 
86 static devclass_t acpi_acad_devclass;
87 DRIVER_MODULE(acpi_acad, acpi, acpi_acad_driver, acpi_acad_devclass, 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 	power_profile_set_state(newstatus ? POWER_PROFILE_PERFORMANCE :
113 	    POWER_PROFILE_ECONOMY);
114 	ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
115 	    "%s Line\n", newstatus ? "On" : "Off");
116 	acpi_UserNotify("ACAD", h, newstatus);
117     }
118     ACPI_SERIAL_END(acad);
119 }
120 
121 static void
122 acpi_acad_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
123 {
124     device_t dev;
125 
126     dev = (device_t)context;
127     switch (notify) {
128     case ACPI_NOTIFY_BUS_CHECK:
129     case ACPI_NOTIFY_DEVICE_CHECK:
130     case ACPI_POWERSOURCE_STAT_CHANGE:
131 	/* Temporarily.  It is better to notify policy manager */
132 	AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_acad_get_status, context);
133 	break;
134     default:
135 	device_printf(dev, "unknown notify %#x\n", notify);
136 	break;
137     }
138 }
139 
140 static int
141 acpi_acad_probe(device_t dev)
142 {
143     static char *acad_ids[] = { "ACPI0003", NULL };
144 
145     if (acpi_disabled("acad") ||
146 	ACPI_ID_PROBE(device_get_parent(dev), dev, acad_ids) == NULL)
147 	return (ENXIO);
148 
149     device_set_desc(dev, "AC Adapter");
150     return (0);
151 }
152 
153 static int
154 acpi_acad_attach(device_t dev)
155 {
156     struct acpi_acad_softc *sc;
157     struct acpi_softc	   *acpi_sc;
158     ACPI_HANDLE	handle;
159     int		error;
160 
161     sc = device_get_softc(dev);
162     handle = acpi_get_handle(dev);
163 
164     error = acpi_register_ioctl(ACPIIO_ACAD_GET_STATUS, acpi_acad_ioctl, dev);
165     if (error != 0)
166 	return (error);
167 
168     if (device_get_unit(dev) == 0) {
169 	acpi_sc = acpi_device_get_parent_softc(dev);
170 	SYSCTL_ADD_PROC(&acpi_sc->acpi_sysctl_ctx,
171 			SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree),
172 			OID_AUTO, "acline", CTLTYPE_INT | CTLFLAG_RD,
173 			&sc->status, 0, acpi_acad_sysctl, "I", "");
174     }
175 
176     /* Get initial status after whole system is up. */
177     sc->status = -1;
178 
179     /*
180      * Install both system and device notify handlers since the Casio
181      * FIVA needs them.
182      */
183     AcpiInstallNotifyHandler(handle, ACPI_ALL_NOTIFY,
184 			     acpi_acad_notify_handler, dev);
185     AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_acad_init_acline, dev);
186 
187     return (0);
188 }
189 
190 static int
191 acpi_acad_ioctl(u_long cmd, caddr_t addr, void *arg)
192 {
193     struct acpi_acad_softc *sc;
194     device_t dev;
195 
196     dev = (device_t)arg;
197     sc = device_get_softc(dev);
198 
199     /*
200      * No security check required: information retrieval only.  If
201      * new functions are added here, a check might be required.
202      */
203     switch (cmd) {
204     case ACPIIO_ACAD_GET_STATUS:
205 	acpi_acad_get_status(dev);
206 	*(int *)addr = sc->status;
207 	break;
208     default:
209 	break;
210     }
211 
212     return (0);
213 }
214 
215 static int
216 acpi_acad_sysctl(SYSCTL_HANDLER_ARGS)
217 {
218     int val, error;
219 
220     if (acpi_acad_get_acline(&val) != 0)
221 	return (ENXIO);
222 
223     val = *(u_int *)oidp->oid_arg1;
224     error = sysctl_handle_int(oidp, &val, 0, req);
225     return (error);
226 }
227 
228 static void
229 acpi_acad_init_acline(void *arg)
230 {
231     struct acpi_acad_softc *sc;
232     device_t	dev;
233     int		retry;
234 
235     dev = (device_t)arg;
236     sc = device_get_softc(dev);
237     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
238 		"acline initialization start\n");
239 
240     for (retry = 0; retry < ACPI_ACAD_RETRY_MAX; retry++) {
241 	acpi_acad_get_status(dev);
242 	if (sc->status != -1)
243 	    break;
244 	AcpiOsSleep(10000);
245     }
246 
247     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
248 		"acline initialization done, tried %d times\n", retry + 1);
249 }
250 
251 /*
252  * If no AC line devices detected after boot, create an "online" event
253  * so that userland code can adjust power settings accordingly.  The default
254  * power profile is "performance" so we don't need to repeat that here.
255  */
256 static void
257 acpi_acad_ac_only(void __unused *arg)
258 {
259 
260     if (devclass_get_count(acpi_acad_devclass) == 0)
261 	acpi_UserNotify("ACAD", ACPI_ROOT_OBJECT, 1);
262 }
263 
264 /*
265  * Public interfaces.
266  */
267 int
268 acpi_acad_get_acline(int *status)
269 {
270     struct acpi_acad_softc *sc;
271     device_t dev;
272 
273     dev = devclass_get_device(acpi_acad_devclass, 0);
274     if (dev == NULL)
275 	return (ENXIO);
276     sc = device_get_softc(dev);
277 
278     acpi_acad_get_status(dev);
279     *status = sc->status;
280 
281     return (0);
282 }
283