1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
|
/*-
* Copyright (c) 2003 Hiroyuki Aizu <aizu@navi.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include "opt_acpi.h"
#include <sys/param.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include "acpi.h"
#include <dev/acpica/acpivar.h>
/*
* Toshiba HCI interface definitions
*
* HCI is Toshiba's "Hardware Control Interface" which is supposed to
* be uniform across all their models. Ideally we would just call
* dedicated ACPI methods instead of using this primitive interface.
* However, the ACPI methods seem to be incomplete in some areas (for
* example they allow setting, but not reading, the LCD brightness
* value), so this is still useful.
*/
#define METHOD_HCI "GHCI"
#define METHOD_HCI_ENABLE "ENAB"
#define METHOD_VIDEO "DSSX"
/* Operations */
#define HCI_SET 0xFF00
#define HCI_GET 0xFE00
/* Return codes */
#define HCI_SUCCESS 0x0000
#define HCI_FAILURE 0x1000
#define HCI_NOT_SUPPORTED 0x8000
#define HCI_EMPTY 0x8C00
/* Functions */
#define HCI_REG_LCD_BACKLIGHT 0x0002
#define HCI_REG_FAN 0x0004
#define HCI_REG_SYSTEM_EVENT 0x0016
#define HCI_REG_VIDEO_OUTPUT 0x001C
#define HCI_REG_HOTKEY_EVENT 0x001E
#define HCI_REG_LCD_BRIGHTNESS 0x002A
#define HCI_REG_CPU_SPEED 0x0032
/* Field definitions */
#define HCI_FAN_SHIFT 7
#define HCI_LCD_BRIGHTNESS_BITS 3
#define HCI_LCD_BRIGHTNESS_SHIFT (16 - HCI_LCD_BRIGHTNESS_BITS)
#define HCI_LCD_BRIGHTNESS_MAX ((1 << HCI_LCD_BRIGHTNESS_BITS) - 1)
#define HCI_VIDEO_OUTPUT_FLAG 0x0100
#define HCI_VIDEO_OUTPUT_LCD 0x1
#define HCI_VIDEO_OUTPUT_CRT 0x2
#define HCI_VIDEO_OUTPUT_TV 0x4
#define HCI_CPU_SPEED_BITS 3
#define HCI_CPU_SPEED_SHIFT (16 - HCI_CPU_SPEED_BITS)
#define HCI_CPU_SPEED_MAX ((1 << HCI_CPU_SPEED_BITS) - 1)
/* Key press/release events. */
#define FN_F1_PRESS 0x013B
#define FN_F1_RELEASE 0x01BB
#define FN_F2_PRESS 0x013C
#define FN_F2_RELEASE 0x01BC
#define FN_F3_PRESS 0x013D
#define FN_F3_RELEASE 0x01BD
#define FN_F4_PRESS 0x013E
#define FN_F4_RELEASE 0x01BE
#define FN_F5_PRESS 0x013F
#define FN_F5_RELEASE 0x01BF
#define FN_F6_PRESS 0x0140
#define FN_F6_RELEASE 0x01C0
#define FN_F7_PRESS 0x0141
#define FN_F7_RELEASE 0x01C1
#define FN_F8_PRESS 0x0142
#define FN_F8_RELEASE 0x01C2
#define FN_F9_PRESS 0x0143
#define FN_F9_RELEASE 0x01C3
#define FN_BS_PRESS 0x010E
#define FN_BS_RELEASE 0x018E
#define FN_ESC_PRESS 0x0101
#define FN_ESC_RELEASE 0x0181
#define FN_KNJ_PRESS 0x0129
#define FN_KNJ_RELEASE 0x01A9
/* HCI register definitions. */
#define HCI_WORDS 6 /* Number of registers */
#define HCI_REG_AX 0 /* Operation, then return value */
#define HCI_REG_BX 1 /* Function */
#define HCI_REG_CX 2 /* Argument (in or out) */
#define HCI_REG_DX 3 /* Unused? */
#define HCI_REG_SI 4 /* Unused? */
#define HCI_REG_DI 5 /* Unused? */
struct acpi_toshiba_softc {
device_t dev;
ACPI_HANDLE handle;
ACPI_HANDLE video_handle;
struct sysctl_ctx_list sysctl_ctx;
struct sysctl_oid *sysctl_tree;
};
/* Prototype for HCI functions for getting/setting a value. */
typedef int hci_fn_t(ACPI_HANDLE, int, UINT32 *);
static int acpi_toshiba_probe(device_t dev);
static int acpi_toshiba_attach(device_t dev);
static int acpi_toshiba_detach(device_t dev);
static int acpi_toshiba_sysctl(SYSCTL_HANDLER_ARGS);
static hci_fn_t hci_force_fan;
static hci_fn_t hci_video_output;
static hci_fn_t hci_lcd_brightness;
static hci_fn_t hci_lcd_backlight;
static hci_fn_t hci_cpu_speed;
static int hci_call(ACPI_HANDLE h, int op, int function, UINT32 *arg);
static void hci_key_action(struct acpi_toshiba_softc *sc, ACPI_HANDLE h,
UINT32 key);
static void acpi_toshiba_notify(ACPI_HANDLE h, UINT32 notify,
void *context);
static int acpi_toshiba_video_probe(device_t dev);
static int acpi_toshiba_video_attach(device_t dev);
/* Table of sysctl names and HCI functions to call. */
static struct {
char *name;
hci_fn_t *handler;
} sysctl_table[] = {
/* name, handler */
{"force_fan", hci_force_fan},
{"video_output", hci_video_output},
{"lcd_brightness", hci_lcd_brightness},
{"lcd_backlight", hci_lcd_backlight},
{"cpu_speed", hci_cpu_speed},
{NULL, NULL}
};
static device_method_t acpi_toshiba_methods[] = {
DEVMETHOD(device_probe, acpi_toshiba_probe),
DEVMETHOD(device_attach, acpi_toshiba_attach),
DEVMETHOD(device_detach, acpi_toshiba_detach),
{0, 0}
};
static driver_t acpi_toshiba_driver = {
"acpi_toshiba",
acpi_toshiba_methods,
sizeof(struct acpi_toshiba_softc),
};
static devclass_t acpi_toshiba_devclass;
DRIVER_MODULE(acpi_toshiba, acpi, acpi_toshiba_driver, acpi_toshiba_devclass,
0, 0);
MODULE_DEPEND(acpi_toshiba, acpi, 1, 1, 1);
static device_method_t acpi_toshiba_video_methods[] = {
DEVMETHOD(device_probe, acpi_toshiba_video_probe),
DEVMETHOD(device_attach, acpi_toshiba_video_attach),
{0, 0}
};
static driver_t acpi_toshiba_video_driver = {
"acpi_toshiba_video",
acpi_toshiba_video_methods,
0,
};
static devclass_t acpi_toshiba_video_devclass;
DRIVER_MODULE(acpi_toshiba_video, acpi, acpi_toshiba_video_driver,
acpi_toshiba_video_devclass, 0, 0);
MODULE_DEPEND(acpi_toshiba_video, acpi, 1, 1, 1);
static int enable_fn_keys = 1;
TUNABLE_INT("hw.acpi.toshiba.enable_fn_keys", &enable_fn_keys);
/*
* HID Model
* -------------------------------------
* TOS6200 Libretto L Series
* Dynabook Satellite 2455
* Dynabook SS 3500
* TOS6207 Dynabook SS2110 Series
*/
static int
acpi_toshiba_probe(device_t dev)
{
int ret = ENXIO;
if (!acpi_disabled("toshiba") &&
acpi_get_type(dev) == ACPI_TYPE_DEVICE &&
device_get_unit(dev) == 0 &&
(acpi_MatchHid(dev, "TOS6200") ||
acpi_MatchHid(dev, "TOS6207"))) {
device_set_desc(dev, "Toshiba HCI Extras");
ret = 0;
}
return (ret);
}
static int
acpi_toshiba_attach(device_t dev)
{
struct acpi_toshiba_softc *sc;
struct acpi_softc *acpi_sc;
ACPI_STATUS status;
int i;
sc = device_get_softc(dev);
sc->dev = dev;
sc->handle = acpi_get_handle(dev);
acpi_sc = acpi_device_get_parent_softc(dev);
sysctl_ctx_init(&sc->sysctl_ctx);
sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree), OID_AUTO,
"toshiba", CTLFLAG_RD, 0, "");
for (i = 0; sysctl_table[i].name != NULL; i++) {
SYSCTL_ADD_PROC(&sc->sysctl_ctx,
SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
sysctl_table[i].name,
CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY,
sc, i, acpi_toshiba_sysctl, "I", "");
}
if (enable_fn_keys != 0) {
status = AcpiEvaluateObject(sc->handle, METHOD_HCI_ENABLE,
NULL, NULL);
if (ACPI_FAILURE(status)) {
device_printf(dev, "enable FN keys failed\n");
sysctl_ctx_free(&sc->sysctl_ctx);
return (ENXIO);
}
AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
acpi_toshiba_notify, sc);
}
return (0);
}
static int
acpi_toshiba_detach(device_t dev)
{
struct acpi_toshiba_softc *sc;
sc = device_get_softc(dev);
if (enable_fn_keys != 0) {
AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
acpi_toshiba_notify);
}
sysctl_ctx_free(&sc->sysctl_ctx);
return (0);
}
static int
acpi_toshiba_sysctl(SYSCTL_HANDLER_ARGS)
{
struct acpi_toshiba_softc *sc;
UINT32 arg;
int function, error = 0;
hci_fn_t *handler;
sc = (struct acpi_toshiba_softc *)oidp->oid_arg1;
function = oidp->oid_arg2;
handler = sysctl_table[function].handler;
/* Get the current value from the appropriate function. */
error = handler(sc->handle, HCI_GET, &arg);
if (error != 0)
return (error);
/* Send the current value to the user and return if no new value. */
error = sysctl_handle_int(oidp, &arg, 0, req);
if (error != 0 || req->newptr == NULL)
return (error);
/* Set the new value via the appropriate function. */
error = handler(sc->handle, HCI_SET, &arg);
return (error);
}
static int
hci_force_fan(ACPI_HANDLE h, int op, UINT32 *state)
{
int ret;
if (op == HCI_SET) {
if (*state < 0 || *state > 1)
return (EINVAL);
*state <<= HCI_FAN_SHIFT;
}
ret = hci_call(h, op, HCI_REG_FAN, state);
if (ret == 0 && op == HCI_GET)
*state >>= HCI_FAN_SHIFT;
return (ret);
}
static int
hci_video_output(ACPI_HANDLE h, int op, UINT32 *video_output)
{
int ret;
ACPI_STATUS status;
if (op == HCI_SET) {
if (*video_output < 1 || *video_output > 7)
return (EINVAL);
if (h == NULL)
return (ENXIO);
*video_output |= HCI_VIDEO_OUTPUT_FLAG;
status = acpi_SetInteger(h, "DSSX", *video_output);
if (ACPI_SUCCESS(status))
ret = 0;
else
ret = ENXIO;
} else {
ret = hci_call(h, op, HCI_REG_VIDEO_OUTPUT, video_output);
if (ret == 0)
*video_output &= 0xff;
}
return (ret);
}
static int
hci_lcd_brightness(ACPI_HANDLE h, int op, UINT32 *brightness)
{
int ret;
if (op == HCI_SET) {
if (*brightness < 0 || *brightness > HCI_LCD_BRIGHTNESS_MAX)
return (EINVAL);
*brightness <<= HCI_LCD_BRIGHTNESS_SHIFT;
}
ret = hci_call(h, op, HCI_REG_LCD_BRIGHTNESS, brightness);
if (ret == 0 && op == HCI_GET)
*brightness >>= HCI_LCD_BRIGHTNESS_SHIFT;
return (ret);
}
static int
hci_lcd_backlight(ACPI_HANDLE h, int op, UINT32 *backlight)
{
if (op == HCI_SET) {
if (*backlight < 0 || *backlight > 1)
return (EINVAL);
}
return (hci_call(h, op, HCI_REG_LCD_BACKLIGHT, backlight));
}
static int
hci_cpu_speed(ACPI_HANDLE h, int op, UINT32 *speed)
{
int ret;
if (op == HCI_SET) {
if (*speed < 0 || *speed > HCI_CPU_SPEED_MAX)
return (EINVAL);
*speed <<= HCI_CPU_SPEED_SHIFT;
}
ret = hci_call(h, op, HCI_REG_CPU_SPEED, speed);
if (ret == 0 && op == HCI_GET)
*speed >>= HCI_CPU_SPEED_SHIFT;
return (ret);
}
static int
hci_call(ACPI_HANDLE h, int op, int function, UINT32 *arg)
{
ACPI_OBJECT_LIST args;
ACPI_BUFFER results;
ACPI_OBJECT obj[HCI_WORDS];
ACPI_OBJECT *res;
int status, i, ret;
status = ENXIO;
for (i = 0; i < HCI_WORDS; i++) {
obj[i].Type = ACPI_TYPE_INTEGER;
obj[i].Integer.Value = 0;
}
obj[HCI_REG_AX].Integer.Value = op;
obj[HCI_REG_BX].Integer.Value = function;
if (op == HCI_SET)
obj[HCI_REG_CX].Integer.Value = *arg;
args.Count = HCI_WORDS;
args.Pointer = obj;
results.Pointer = NULL;
results.Length = ACPI_ALLOCATE_BUFFER;
if (ACPI_FAILURE(AcpiEvaluateObject(h, METHOD_HCI, &args, &results)))
goto end;
res = (ACPI_OBJECT *)results.Pointer;
if (!ACPI_PKG_VALID(res, HCI_WORDS)) {
printf("toshiba: invalid package!\n");
return (ENXIO);
}
acpi_PkgInt32(res, HCI_REG_AX, &ret);
if (ret == HCI_SUCCESS) {
if (op == HCI_GET)
acpi_PkgInt32(res, HCI_REG_CX, arg);
status = 0;
} else if (function == HCI_REG_SYSTEM_EVENT && op == HCI_GET &&
ret == HCI_NOT_SUPPORTED) {
/*
* Sometimes system events are disabled without us requesting
* it. This workaround attempts to re-enable them.
*/
i = 1;
hci_call(h, HCI_SET, HCI_REG_SYSTEM_EVENT, &i);
}
end:
if (results.Pointer != NULL)
AcpiOsFree(results.Pointer);
return (status);
}
/*
* Perform a few actions based on the keypress. Users can extend this
* functionality by reading the keystrokes we send to devd(8).
*/
static void
hci_key_action(struct acpi_toshiba_softc *sc, ACPI_HANDLE h, UINT32 key)
{
UINT32 arg;
switch (key) {
case FN_F6_RELEASE:
/* Decrease LCD brightness. */
hci_lcd_brightness(h, HCI_GET, &arg);
if (arg-- == 0)
arg = 0;
else
hci_lcd_brightness(h, HCI_SET, &arg);
break;
case FN_F7_RELEASE:
/* Increase LCD brightness. */
hci_lcd_brightness(h, HCI_GET, &arg);
if (arg++ == 7)
arg = 7;
else
hci_lcd_brightness(h, HCI_SET, &arg);
break;
case FN_F5_RELEASE:
/* Cycle through video outputs. */
hci_video_output(h, HCI_GET, &arg);
arg = (arg + 1) % 7;
hci_video_output(sc->video_handle, HCI_SET, &arg);
break;
case FN_F8_RELEASE:
/* Toggle LCD backlight. */
hci_lcd_backlight(h, HCI_GET, &arg);
arg = (arg != 0) ? 0 : 1;
hci_lcd_backlight(h, HCI_SET, &arg);
break;
case FN_ESC_RELEASE:
/* Toggle forcing fan on. */
hci_force_fan(h, HCI_GET, &arg);
arg = (arg != 0) ? 0 : 1;
hci_force_fan(h, HCI_SET, &arg);
break;
}
}
static void
acpi_toshiba_notify(ACPI_HANDLE h, UINT32 notify, void *context)
{
struct acpi_toshiba_softc *sc;
UINT32 key;
sc = (struct acpi_toshiba_softc *)context;
if (notify == 0x80) {
while (hci_call(h, HCI_GET, HCI_REG_SYSTEM_EVENT, &key) == 0) {
hci_key_action(sc, h, key);
acpi_UserNotify("TOSHIBA", h, (uint8_t)key);
}
} else
device_printf(sc->dev, "unknown notify: 0x%x\n", notify);
}
/*
* Toshiba video pseudo-device to provide the DSSX method.
*
* HID Model
* -------------------------------------
* TOS6201 Libretto L Series
*/
static int
acpi_toshiba_video_probe(device_t dev)
{
int ret = ENXIO;
if (!acpi_disabled("toshiba") &&
acpi_get_type(dev) == ACPI_TYPE_DEVICE &&
device_get_unit(dev) == 0 &&
acpi_MatchHid(dev, "TOS6201")) {
device_quiet(dev);
device_set_desc(dev, "Toshiba Video");
ret = 0;
}
return (ret);
}
static int
acpi_toshiba_video_attach(device_t dev)
{
struct acpi_toshiba_softc *sc;
sc = devclass_get_softc(acpi_toshiba_devclass, 0);
if (sc == NULL)
return (ENXIO);
sc->video_handle = acpi_get_handle(dev);
return (0);
}
|