xref: /netbsd-src/sys/dev/acpi/sony_acpi.c (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: sony_acpi.c,v 1.19 2010/08/24 14:53:45 jruoho Exp $	*/
2 
3 /*-
4  * Copyright (c) 2005 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Christos Zoulas.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 #include <sys/cdefs.h>
32 __KERNEL_RCSID(0, "$NetBSD: sony_acpi.c,v 1.19 2010/08/24 14:53:45 jruoho Exp $");
33 
34 #include <sys/param.h>
35 #include <sys/sysctl.h>
36 #include <sys/systm.h>
37 
38 #include <dev/acpi/acpireg.h>
39 #include <dev/acpi/acpivar.h>
40 
41 #define _COMPONENT          ACPI_RESOURCE_COMPONENT
42 ACPI_MODULE_NAME            ("sony_acpi")
43 
44 #define	SONY_NOTIFY_FnKeyEvent			0x92
45 #define	SONY_NOTIFY_BrightnessDownPressed	0x85
46 #define	SONY_NOTIFY_BrightnessDownReleased	0x05
47 #define	SONY_NOTIFY_BrightnessUpPressed		0x86
48 #define	SONY_NOTIFY_BrightnessUpReleased	0x06
49 #define	SONY_NOTIFY_DisplaySwitchPressed	0x87
50 #define	SONY_NOTIFY_DisplaySwitchReleased	0x07
51 #define	SONY_NOTIFY_ZoomPressed			0x8a
52 #define	SONY_NOTIFY_ZoomReleased		0x0a
53 #define	SONY_NOTIFY_SuspendPressed		0x8c
54 #define	SONY_NOTIFY_SuspendReleased		0x0c
55 
56 struct sony_acpi_softc {
57 	device_t sc_dev;
58 	struct sysctllog *sc_log;
59 	struct acpi_devnode *sc_node;
60 
61 #define	SONY_PSW_SLEEP		0
62 #define	SONY_PSW_DISPLAY_CYCLE	1
63 #define	SONY_PSW_ZOOM		2
64 #define	SONY_PSW_LAST		3
65 	struct sysmon_pswitch sc_smpsw[SONY_PSW_LAST];
66 	int sc_smpsw_valid;
67 
68 #define	SONY_ACPI_QUIRK_FNINIT	0x01
69 	int sc_quirks;
70 	bool sc_has_pic;
71 
72 	struct sony_acpi_pmstate {
73 		ACPI_INTEGER	brt;
74 	} sc_pmstate;
75 };
76 
77 static const char * const sony_acpi_ids[] = {
78 	"SNY5001",
79 	NULL
80 };
81 
82 static int	sony_acpi_match(device_t, cfdata_t, void *);
83 static void	sony_acpi_attach(device_t, device_t, void *);
84 static ACPI_STATUS sony_acpi_eval_set_integer(ACPI_HANDLE, const char *,
85     ACPI_INTEGER, ACPI_INTEGER *);
86 static void	sony_acpi_quirk_setup(struct sony_acpi_softc *);
87 static void	sony_acpi_notify_handler(ACPI_HANDLE, uint32_t, void *);
88 static bool	sony_acpi_suspend(device_t, const pmf_qual_t *);
89 static bool	sony_acpi_resume(device_t, const pmf_qual_t *);
90 static void	sony_acpi_brightness_down(device_t);
91 static void	sony_acpi_brightness_up(device_t);
92 static ACPI_STATUS sony_acpi_find_pic(ACPI_HANDLE, uint32_t, void *, void **);
93 
94 CFATTACH_DECL_NEW(sony_acpi, sizeof(struct sony_acpi_softc),
95     sony_acpi_match, sony_acpi_attach, NULL, NULL);
96 
97 static int
98 sony_acpi_match(device_t parent, cfdata_t match, void *aux)
99 {
100 	struct acpi_attach_args *aa = aux;
101 
102 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
103 		return 0;
104 
105 	return acpi_match_hid(aa->aa_node->ad_devinfo, sony_acpi_ids);
106 }
107 
108 static int
109 sony_sysctl_helper(SYSCTLFN_ARGS)
110 {
111 	struct sysctlnode node;
112 	ACPI_INTEGER acpi_val;
113 	ACPI_STATUS rv;
114 	int val, old_val, error;
115 	char buf[SYSCTL_NAMELEN + 1], *ptr;
116 	struct sony_acpi_softc *sc = rnode->sysctl_data;
117 
118 	(void)snprintf(buf, sizeof(buf), "G%s", rnode->sysctl_name);
119 	for (ptr = buf; *ptr; ptr++)
120 		*ptr = toupper((unsigned char)*ptr);
121 
122 	rv = acpi_eval_integer(sc->sc_node->ad_handle, buf, &acpi_val);
123 	if (ACPI_FAILURE(rv)) {
124 #ifdef DIAGNOSTIC
125 		printf("%s: couldn't get `%s'\n", device_xname(sc->sc_dev), buf);
126 #endif
127 		return EIO;
128 	}
129 	val = old_val = acpi_val;
130 
131 	node = *rnode;
132 	node.sysctl_data = &val;
133 
134 	error = sysctl_lookup(SYSCTLFN_CALL(&node));
135 	if (error || newp == NULL)
136 		return error;
137 
138 	buf[0] = 'S';
139 	acpi_val = val;
140 	rv = sony_acpi_eval_set_integer(sc->sc_node->ad_handle, buf,
141 	    acpi_val, NULL);
142 	if (ACPI_FAILURE(rv)) {
143 #ifdef DIAGNOSTIC
144 		printf("%s: couldn't set `%s' to %d\n",
145 		    device_xname(sc->sc_dev), buf, val);
146 #endif
147 		return EIO;
148 	}
149 	return 0;
150 }
151 
152 static ACPI_STATUS
153 sony_walk_cb(ACPI_HANDLE hnd, uint32_t v, void *context, void **status)
154 {
155 	struct sony_acpi_softc *sc = (void *)context;
156 	const struct sysctlnode *node, *snode;
157 	const char *name = acpi_name(hnd);
158 	ACPI_INTEGER acpi_val;
159 	char buf[SYSCTL_NAMELEN + 1], *ptr;
160 	int rv;
161 
162 	if ((name = strrchr(name, '.')) == NULL)
163 		return AE_OK;
164 
165 	name++;
166 	if ((*name != 'G') && (*name != 'S'))
167 		return AE_OK;
168 
169 	(void)strlcpy(buf, name, sizeof(buf));
170 	*buf = 'G';
171 
172 	/*
173 	 * We assume that if the 'get' of the name as an integer is
174 	 * successful it is ok.
175 	 */
176 	if (acpi_eval_integer(sc->sc_node->ad_handle, buf, &acpi_val))
177 		return AE_OK;
178 
179 	for (ptr = buf; *ptr; ptr++)
180 		*ptr = tolower(*ptr);
181 
182 	if ((rv = sysctl_createv(&sc->sc_log, 0, NULL, &node, CTLFLAG_PERMANENT,
183 	    CTLTYPE_NODE, "hw", NULL, NULL, 0, NULL, 0, CTL_HW, CTL_EOL)) != 0)
184 		goto out;
185 
186 	if ((rv = sysctl_createv(&sc->sc_log, 0, &node, &snode, 0,
187 	    CTLTYPE_NODE, device_xname(sc->sc_dev),
188 	    SYSCTL_DESCR("sony controls"),
189 	    NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL)) != 0)
190 		goto out;
191 
192 	if ((rv = sysctl_createv(&sc->sc_log, 0, &snode, &node,
193 	    CTLFLAG_READWRITE, CTLTYPE_INT, buf + 1, NULL,
194 	    sony_sysctl_helper, 0, sc, 0, CTL_CREATE, CTL_EOL)) != 0)
195 		goto out;
196 
197 out:
198 #ifdef DIAGNOSTIC
199 	if (rv)
200 		printf("%s: sysctl_createv failed (rv = %d)\n",
201 		    device_xname(sc->sc_dev), rv);
202 #endif
203 	return AE_OK;
204 }
205 
206 ACPI_STATUS
207 sony_acpi_eval_set_integer(ACPI_HANDLE handle, const char *path,
208     ACPI_INTEGER val, ACPI_INTEGER *valp)
209 {
210 	ACPI_STATUS rv;
211 	ACPI_BUFFER buf;
212 	ACPI_OBJECT param, ret_val;
213 	ACPI_OBJECT_LIST params;
214 
215 	if (handle == NULL)
216 		handle = ACPI_ROOT_OBJECT;
217 
218 	params.Count = 1;
219 	params.Pointer = &param;
220 
221 	param.Type = ACPI_TYPE_INTEGER;
222 	param.Integer.Value = val;
223 
224 	buf.Pointer = &ret_val;
225 	buf.Length = sizeof(ret_val);
226 
227 	rv = AcpiEvaluateObjectTyped(handle, path, &params, &buf,
228 	    ACPI_TYPE_INTEGER);
229 
230 	if (ACPI_SUCCESS(rv) && valp)
231 		*valp = ret_val.Integer.Value;
232 
233 	return rv;
234 }
235 
236 static void
237 sony_acpi_attach(device_t parent, device_t self, void *aux)
238 {
239 	struct sony_acpi_softc *sc = device_private(self);
240 	struct acpi_attach_args *aa = aux;
241 	ACPI_STATUS rv;
242 	int i;
243 
244 	aprint_naive(": Sony Miscellaneous Controller\n");
245 	aprint_normal(": Sony Miscellaneous Controller\n");
246 
247 	sc->sc_node = aa->aa_node;
248 	sc->sc_dev = self;
249 
250 	rv = AcpiWalkNamespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, 100,
251 	    sony_acpi_find_pic, NULL, sc, NULL);
252 	if (ACPI_FAILURE(rv))
253 		aprint_error_dev(self, "couldn't walk namespace: %s\n",
254 		    AcpiFormatException(rv));
255 
256 	/*
257 	 * If we don't find an SNY6001 device, assume that we need the
258 	 * Fn key initialization sequence.
259 	 */
260 	if (sc->sc_has_pic == false)
261 		sc->sc_quirks |= SONY_ACPI_QUIRK_FNINIT;
262 
263 	sony_acpi_quirk_setup(sc);
264 
265 	/* Configure suspend button and hotkeys */
266 	sc->sc_smpsw[SONY_PSW_SLEEP].smpsw_name = device_xname(self);
267 	sc->sc_smpsw[SONY_PSW_SLEEP].smpsw_type = PSWITCH_TYPE_SLEEP;
268 	sc->sc_smpsw[SONY_PSW_DISPLAY_CYCLE].smpsw_name =
269 	    PSWITCH_HK_DISPLAY_CYCLE;
270 	sc->sc_smpsw[SONY_PSW_DISPLAY_CYCLE].smpsw_type = PSWITCH_TYPE_HOTKEY;
271 	sc->sc_smpsw[SONY_PSW_ZOOM].smpsw_name = PSWITCH_HK_ZOOM_BUTTON;
272 	sc->sc_smpsw[SONY_PSW_ZOOM].smpsw_type = PSWITCH_TYPE_HOTKEY;
273 	sc->sc_smpsw_valid = 1;
274 
275 	for (i = 0; i < SONY_PSW_LAST; i++)
276 		if (sysmon_pswitch_register(&sc->sc_smpsw[i]) != 0) {
277 			aprint_error_dev(self,
278 			    "couldn't register %s with sysmon\n",
279 			    sc->sc_smpsw[i].smpsw_name);
280 			sc->sc_smpsw_valid = 0;
281 		}
282 
283 	(void)acpi_register_notify(sc->sc_node, sony_acpi_notify_handler);
284 
285 	/* Install sysctl handler */
286 	rv = AcpiWalkNamespace(ACPI_TYPE_METHOD,
287 	    sc->sc_node->ad_handle, 1, sony_walk_cb, NULL, sc, NULL);
288 
289 #ifdef DIAGNOSTIC
290 	if (ACPI_FAILURE(rv))
291 		aprint_error_dev(self, "Cannot walk ACPI namespace (%u)\n",
292 		    rv);
293 #endif
294 
295 	if (!pmf_device_register(self, sony_acpi_suspend, sony_acpi_resume))
296 		aprint_error_dev(self, "couldn't establish power handler\n");
297 
298 	if (!pmf_event_register(self, PMFE_DISPLAY_BRIGHTNESS_UP,
299 				 sony_acpi_brightness_up, true))
300 		aprint_error_dev(self, "couldn't register BRIGHTNESS UP handler\n");
301 
302 	if (!pmf_event_register(self, PMFE_DISPLAY_BRIGHTNESS_DOWN,
303 				 sony_acpi_brightness_down, true))
304 		aprint_error_dev(self, "couldn't register BRIGHTNESS DOWN handler\n");
305 }
306 
307 static void
308 sony_acpi_quirk_setup(struct sony_acpi_softc *sc)
309 {
310 	ACPI_HANDLE hdl = sc->sc_node->ad_handle;
311 
312 	if (sc->sc_quirks & SONY_ACPI_QUIRK_FNINIT) {
313 		/* Initialize extra Fn keys */
314 		sony_acpi_eval_set_integer(hdl, "SN02", 0x04, NULL);
315 		sony_acpi_eval_set_integer(hdl, "SN07", 0x02, NULL);
316 		sony_acpi_eval_set_integer(hdl, "SN02", 0x10, NULL);
317 		sony_acpi_eval_set_integer(hdl, "SN07", 0x00, NULL);
318 		sony_acpi_eval_set_integer(hdl, "SN03", 0x02, NULL);
319 		sony_acpi_eval_set_integer(hdl, "SN07", 0x101, NULL);
320 	}
321 }
322 
323 static void
324 sony_acpi_notify_handler(ACPI_HANDLE hdl, uint32_t notify, void *opaque)
325 {
326 	device_t dv = opaque;
327 	struct sony_acpi_softc *sc = device_private(dv);
328 	ACPI_STATUS rv;
329 	ACPI_INTEGER arg;
330 
331 	if (notify == SONY_NOTIFY_FnKeyEvent) {
332 		rv = sony_acpi_eval_set_integer(hdl, "SN07", 0x202, &arg);
333 		if (ACPI_FAILURE(rv))
334 			return;
335 
336 		notify = arg & 0xff;
337 	}
338 
339 	switch (notify) {
340 	case SONY_NOTIFY_BrightnessDownPressed:
341 		sony_acpi_brightness_down(dv);
342 		break;
343 	case SONY_NOTIFY_BrightnessUpPressed:
344 		sony_acpi_brightness_up(dv);
345 		break;
346 	case SONY_NOTIFY_BrightnessDownReleased:
347 	case SONY_NOTIFY_BrightnessUpReleased:
348 		break;
349 	case SONY_NOTIFY_SuspendPressed:
350 		if (!sc->sc_smpsw_valid)
351 			break;
352 		sysmon_pswitch_event(&sc->sc_smpsw[SONY_PSW_SLEEP],
353 		    PSWITCH_EVENT_PRESSED);
354 		break;
355 	case SONY_NOTIFY_SuspendReleased:
356 		break;
357 	case SONY_NOTIFY_DisplaySwitchPressed:
358 		if (!sc->sc_smpsw_valid)
359 			break;
360 		sysmon_pswitch_event(&sc->sc_smpsw[SONY_PSW_DISPLAY_CYCLE],
361 		    PSWITCH_EVENT_PRESSED);
362 		break;
363 	case SONY_NOTIFY_DisplaySwitchReleased:
364 		break;
365 	case SONY_NOTIFY_ZoomPressed:
366 		if (!sc->sc_smpsw_valid)
367 			break;
368 		sysmon_pswitch_event(&sc->sc_smpsw[SONY_PSW_ZOOM],
369 		    PSWITCH_EVENT_PRESSED);
370 		break;
371 	case SONY_NOTIFY_ZoomReleased:
372 		break;
373 	default:
374 		aprint_debug_dev(dv, "unknown notify event 0x%x\n", notify);
375 		break;
376 	}
377 }
378 
379 static bool
380 sony_acpi_suspend(device_t dv, const pmf_qual_t *qual)
381 {
382 	struct sony_acpi_softc *sc = device_private(dv);
383 
384 	acpi_eval_integer(sc->sc_node->ad_handle, "GBRT", &sc->sc_pmstate.brt);
385 
386 	return true;
387 }
388 
389 static bool
390 sony_acpi_resume(device_t dv, const pmf_qual_t *qual)
391 {
392 	struct sony_acpi_softc *sc = device_private(dv);
393 
394 	sony_acpi_eval_set_integer(sc->sc_node->ad_handle, "SBRT",
395 	    sc->sc_pmstate.brt, NULL);
396 	sony_acpi_quirk_setup(sc);
397 
398 	return true;
399 }
400 
401 static void
402 sony_acpi_brightness_up(device_t dv)
403 {
404 	struct sony_acpi_softc *sc = device_private(dv);
405 	ACPI_INTEGER arg;
406 	ACPI_STATUS rv;
407 
408 	rv = acpi_eval_integer(sc->sc_node->ad_handle, "GBRT", &arg);
409 	if (ACPI_FAILURE(rv))
410 		return;
411 	if (arg >= 8)
412 		arg = 8;
413 	else
414 		arg++;
415 	sony_acpi_eval_set_integer(sc->sc_node->ad_handle, "SBRT", arg, NULL);
416 }
417 
418 static void
419 sony_acpi_brightness_down(device_t dv)
420 {
421 	struct sony_acpi_softc *sc = device_private(dv);
422 	ACPI_INTEGER arg;
423 	ACPI_STATUS rv;
424 
425 	rv = acpi_eval_integer(sc->sc_node->ad_handle, "GBRT", &arg);
426 	if (ACPI_FAILURE(rv))
427 		return;
428 	if (arg <= 0)
429 		arg = 0;
430 	else
431 		arg--;
432 	sony_acpi_eval_set_integer(sc->sc_node->ad_handle, "SBRT", arg, NULL);
433 }
434 
435 static ACPI_STATUS
436 sony_acpi_find_pic(ACPI_HANDLE hdl, uint32_t level,
437     void *opaque, void **status)
438 {
439 	struct sony_acpi_softc *sc = opaque;
440 	ACPI_STATUS rv;
441 	ACPI_DEVICE_INFO *devinfo;
442 
443 	rv = AcpiGetObjectInfo(hdl, &devinfo);
444 	if (ACPI_FAILURE(rv) || devinfo == NULL)
445 		return AE_OK;	/* we don't want to stop searching */
446 
447 	if (devinfo->HardwareId.String &&
448 	    strncmp(devinfo->HardwareId.String, "SNY6001", 7) == 0)
449 		sc->sc_has_pic = true;
450 
451 	ACPI_FREE(devinfo);
452 
453 	return AE_OK;
454 }
455