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
|
/* $OpenBSD: aps.c,v 1.28 2022/04/06 18:59:28 naddy Exp $ */
/*
* Copyright (c) 2005 Jonathan Gray <jsg@openbsd.org>
* Copyright (c) 2008 Can Erkin Acar <canacar@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/*
* A driver for the ThinkPad Active Protection System based on notes from
* http://www.almaden.ibm.com/cs/people/marksmith/tpaps.html
*/
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/kernel.h>
#include <sys/sensors.h>
#include <sys/timeout.h>
#include <machine/bus.h>
#include <sys/event.h>
#include <dev/isa/isavar.h>
#ifdef __i386__
#include "apm.h"
#include <machine/acpiapm.h>
#include <machine/biosvar.h>
#include <machine/apmvar.h>
#endif
#if defined(APSDEBUG)
#define DPRINTF(x) do { printf x; } while (0)
#else
#define DPRINTF(x)
#endif
/*
* EC interface on Thinkpad Laptops, from Linux HDAPS driver notes.
* From Renesas H8S/2140B Group Hardware Manual
* http://documentation.renesas.com/eng/products/mpumcu/rej09b0300_2140bhm.pdf
*
* EC uses LPC Channel 3 registers TWR0..15
*/
/* STR3 status register */
#define APS_STR3 0x04
#define APS_STR3_IBF3B 0x80 /* Input buffer full (host->slave) */
#define APS_STR3_OBF3B 0x40 /* Output buffer full (slave->host)*/
#define APS_STR3_MWMF 0x20 /* Master write mode */
#define APS_STR3_SWMF 0x10 /* Slave write mode */
/* Base address of TWR registers */
#define APS_TWR_BASE 0x10
#define APS_TWR_RET 0x1f
/* TWR registers */
#define APS_CMD 0x00
#define APS_ARG1 0x01
#define APS_ARG2 0x02
#define APS_ARG3 0x03
#define APS_RET 0x0f
/* Sensor values */
#define APS_STATE 0x01
#define APS_XACCEL 0x02
#define APS_YACCEL 0x04
#define APS_TEMP 0x06
#define APS_XVAR 0x07
#define APS_YVAR 0x09
#define APS_TEMP2 0x0b
#define APS_UNKNOWN 0x0c
#define APS_INPUT 0x0d
/* write masks for I/O, send command + 0-3 arguments*/
#define APS_WRITE_0 0x0001
#define APS_WRITE_1 0x0003
#define APS_WRITE_2 0x0007
#define APS_WRITE_3 0x000f
/* read masks for I/O, read 0-3 values (skip command byte) */
#define APS_READ_0 0x0000
#define APS_READ_1 0x0002
#define APS_READ_2 0x0006
#define APS_READ_3 0x000e
#define APS_READ_RET 0x8000
#define APS_READ_ALL 0xffff
/* Bit definitions for APS_INPUT value */
#define APS_INPUT_KB (1 << 5)
#define APS_INPUT_MS (1 << 6)
#define APS_INPUT_LIDOPEN (1 << 7)
#define APS_ADDR_SIZE 0x1f
struct sensor_rec {
u_int8_t state;
u_int16_t x_accel;
u_int16_t y_accel;
u_int8_t temp1;
u_int16_t x_var;
u_int16_t y_var;
u_int8_t temp2;
u_int8_t unk;
u_int8_t input;
};
#define APS_NUM_SENSORS 9
#define APS_SENSOR_XACCEL 0
#define APS_SENSOR_YACCEL 1
#define APS_SENSOR_XVAR 2
#define APS_SENSOR_YVAR 3
#define APS_SENSOR_TEMP1 4
#define APS_SENSOR_TEMP2 5
#define APS_SENSOR_KBACT 6
#define APS_SENSOR_MSACT 7
#define APS_SENSOR_LIDOPEN 8
struct aps_softc {
struct device sc_dev;
bus_space_tag_t aps_iot;
bus_space_handle_t aps_ioh;
struct ksensor sensors[APS_NUM_SENSORS];
struct ksensordev sensordev;
void (*refresh_sensor_data)(struct aps_softc *);
struct sensor_rec aps_data;
};
int aps_match(struct device *, void *, void *);
void aps_attach(struct device *, struct device *, void *);
int aps_activate(struct device *, int);
int aps_init(bus_space_tag_t, bus_space_handle_t);
int aps_read_data(struct aps_softc *);
void aps_refresh_sensor_data(struct aps_softc *);
void aps_refresh(void *);
int aps_do_io(bus_space_tag_t, bus_space_handle_t,
unsigned char *, int, int);
const struct cfattach aps_ca = {
sizeof(struct aps_softc),
aps_match, aps_attach, NULL, aps_activate
};
struct cfdriver aps_cd = {
NULL, "aps", DV_DULL
};
struct timeout aps_timeout;
/* properly communicate with the controller, writing a set of memory
* locations and reading back another set */
int
aps_do_io(bus_space_tag_t iot, bus_space_handle_t ioh,
unsigned char *buf, int wmask, int rmask)
{
int bp, stat, n;
DPRINTF(("aps_do_io: CMD: 0x%02x, wmask: 0x%04x, rmask: 0x%04x\n",
buf[0], wmask, rmask));
/* write init byte using arbitration */
for (n = 0; n < 100; n++) {
stat = bus_space_read_1(iot, ioh, APS_STR3);
if (stat & (APS_STR3_OBF3B | APS_STR3_SWMF)) {
bus_space_read_1(iot, ioh, APS_TWR_RET);
continue;
}
bus_space_write_1(iot, ioh, APS_TWR_BASE, buf[0]);
stat = bus_space_read_1(iot, ioh, APS_STR3);
if (stat & (APS_STR3_MWMF))
break;
delay(1);
}
if (n == 100) {
DPRINTF(("aps_do_io: Failed to get bus\n"));
return (1);
}
/* write data bytes, init already sent */
/* make sure last bye is always written as this will trigger slave */
wmask |= APS_READ_RET;
buf[APS_RET] = 0x01;
for (n = 1, bp = 2; n < 16; bp <<= 1, n++) {
if (wmask & bp) {
bus_space_write_1(iot, ioh, APS_TWR_BASE + n, buf[n]);
DPRINTF(("aps_do_io: write %2d 0x%02x\n", n, buf[n]));
}
}
for (n = 0; n < 100; n++) {
stat = bus_space_read_1(iot, ioh, APS_STR3);
if (stat & (APS_STR3_OBF3B))
break;
delay(5 * 100);
}
if (n == 100) {
DPRINTF(("aps_do_io: timeout waiting response\n"));
return (1);
}
/* wait for data available */
/* make sure to read the final byte to clear status */
rmask |= APS_READ_RET;
/* read cmd and data bytes */
for (n = 0, bp = 1; n < 16; bp <<= 1, n++) {
if (rmask & bp) {
buf[n] = bus_space_read_1(iot, ioh, APS_TWR_BASE + n);
DPRINTF(("aps_do_io: read %2d 0x%02x\n", n, buf[n]));
}
}
return (0);
}
int
aps_match(struct device *parent, void *match, void *aux)
{
struct isa_attach_args *ia = aux;
bus_space_tag_t iot = ia->ia_iot;
bus_space_handle_t ioh;
int iobase = ia->ipa_io[0].base;
u_int8_t cr;
unsigned char iobuf[16];
if (bus_space_map(iot, iobase, APS_ADDR_SIZE, 0, &ioh)) {
DPRINTF(("aps: can't map i/o space\n"));
return (0);
}
/* get APS mode */
iobuf[APS_CMD] = 0x13;
if (aps_do_io(iot, ioh, iobuf, APS_WRITE_0, APS_READ_1)) {
bus_space_unmap(iot, ioh, APS_ADDR_SIZE);
return (0);
}
/*
* Observed values from Linux driver:
* 0x01: T42
* 0x02: chip already initialised
* 0x03: T41
* 0x05: T61
*/
cr = iobuf[APS_ARG1];
DPRINTF(("aps: state register 0x%x\n", cr));
if (aps_init(iot, ioh)) {
bus_space_unmap(iot, ioh, APS_ADDR_SIZE);
return (0);
}
bus_space_unmap(iot, ioh, APS_ADDR_SIZE);
if (iobuf[APS_RET] != 0 || cr < 1 || cr > 5) {
DPRINTF(("aps0: unsupported state %d\n", cr));
return (0);
}
ia->ipa_nio = 1;
ia->ipa_io[0].length = APS_ADDR_SIZE;
ia->ipa_nmem = 0;
ia->ipa_nirq = 0;
ia->ipa_ndrq = 0;
return (1);
}
void
aps_attach(struct device *parent, struct device *self, void *aux)
{
struct aps_softc *sc = (void *)self;
int iobase, i;
bus_space_tag_t iot;
bus_space_handle_t ioh;
struct isa_attach_args *ia = aux;
iobase = ia->ipa_io[0].base;
iot = sc->aps_iot = ia->ia_iot;
if (bus_space_map(iot, iobase, APS_ADDR_SIZE, 0, &sc->aps_ioh)) {
printf(": can't map i/o space\n");
return;
}
ioh = sc->aps_ioh;
printf("\n");
sc->sensors[APS_SENSOR_XACCEL].type = SENSOR_INTEGER;
snprintf(sc->sensors[APS_SENSOR_XACCEL].desc,
sizeof(sc->sensors[APS_SENSOR_XACCEL].desc), "X_ACCEL");
sc->sensors[APS_SENSOR_YACCEL].type = SENSOR_INTEGER;
snprintf(sc->sensors[APS_SENSOR_YACCEL].desc,
sizeof(sc->sensors[APS_SENSOR_YACCEL].desc), "Y_ACCEL");
sc->sensors[APS_SENSOR_TEMP1].type = SENSOR_TEMP;
sc->sensors[APS_SENSOR_TEMP2].type = SENSOR_TEMP;
sc->sensors[APS_SENSOR_XVAR].type = SENSOR_INTEGER;
snprintf(sc->sensors[APS_SENSOR_XVAR].desc,
sizeof(sc->sensors[APS_SENSOR_XVAR].desc), "X_VAR");
sc->sensors[APS_SENSOR_YVAR].type = SENSOR_INTEGER;
snprintf(sc->sensors[APS_SENSOR_YVAR].desc,
sizeof(sc->sensors[APS_SENSOR_YVAR].desc), "Y_VAR");
sc->sensors[APS_SENSOR_KBACT].type = SENSOR_INDICATOR;
snprintf(sc->sensors[APS_SENSOR_KBACT].desc,
sizeof(sc->sensors[APS_SENSOR_KBACT].desc), "Keyboard Active");
sc->sensors[APS_SENSOR_MSACT].type = SENSOR_INDICATOR;
snprintf(sc->sensors[APS_SENSOR_MSACT].desc,
sizeof(sc->sensors[APS_SENSOR_MSACT].desc), "Mouse Active");
sc->sensors[APS_SENSOR_LIDOPEN].type = SENSOR_INDICATOR;
snprintf(sc->sensors[APS_SENSOR_LIDOPEN].desc,
sizeof(sc->sensors[APS_SENSOR_LIDOPEN].desc), "Lid Open");
/* stop hiding and report to the authorities */
strlcpy(sc->sensordev.xname, sc->sc_dev.dv_xname,
sizeof(sc->sensordev.xname));
for (i = 0; i < APS_NUM_SENSORS ; i++) {
sensor_attach(&sc->sensordev, &sc->sensors[i]);
}
sensordev_install(&sc->sensordev);
/* Refresh sensor data every 0.5 seconds */
timeout_set(&aps_timeout, aps_refresh, sc);
timeout_add_msec(&aps_timeout, 500);
}
int
aps_init(bus_space_tag_t iot, bus_space_handle_t ioh)
{
unsigned char iobuf[16];
/* command 0x17/0x81: check EC */
iobuf[APS_CMD] = 0x17;
iobuf[APS_ARG1] = 0x81;
if (aps_do_io(iot, ioh, iobuf, APS_WRITE_1, APS_READ_3))
return (1);
if (iobuf[APS_RET] != 0 ||iobuf[APS_ARG3] != 0)
return (2);
/* Test values from the Linux driver */
if ((iobuf[APS_ARG1] != 0 || iobuf[APS_ARG2] != 0x60) &&
(iobuf[APS_ARG1] != 1 || iobuf[APS_ARG2] != 0))
return (3);
/* command 0x14: set power */
iobuf[APS_CMD] = 0x14;
iobuf[APS_ARG1] = 0x01;
if (aps_do_io(iot, ioh, iobuf, APS_WRITE_1, APS_READ_0))
return (4);
if (iobuf[APS_RET] != 0)
return (5);
/* command 0x10: set config (sample rate and order) */
iobuf[APS_CMD] = 0x10;
iobuf[APS_ARG1] = 0xc8;
iobuf[APS_ARG2] = 0x00;
iobuf[APS_ARG3] = 0x02;
if (aps_do_io(iot, ioh, iobuf, APS_WRITE_3, APS_READ_0))
return (6);
if (iobuf[APS_RET] != 0)
return (7);
/* command 0x11: refresh data */
iobuf[APS_CMD] = 0x11;
if (aps_do_io(iot, ioh, iobuf, APS_WRITE_0, APS_READ_1))
return (8);
return (0);
}
int
aps_read_data(struct aps_softc *sc)
{
bus_space_tag_t iot = sc->aps_iot;
bus_space_handle_t ioh = sc->aps_ioh;
unsigned char iobuf[16];
/* command 0x11: refresh data */
iobuf[APS_CMD] = 0x11;
if (aps_do_io(iot, ioh, iobuf, APS_WRITE_0, APS_READ_ALL))
return (1);
sc->aps_data.state = iobuf[APS_STATE];
sc->aps_data.x_accel = iobuf[APS_XACCEL] + 256 * iobuf[APS_XACCEL + 1];
sc->aps_data.y_accel = iobuf[APS_YACCEL] + 256 * iobuf[APS_YACCEL + 1];
sc->aps_data.temp1 = iobuf[APS_TEMP];
sc->aps_data.x_var = iobuf[APS_XVAR] + 256 * iobuf[APS_XVAR + 1];
sc->aps_data.y_var = iobuf[APS_YVAR] + 256 * iobuf[APS_YVAR + 1];
sc->aps_data.temp2 = iobuf[APS_TEMP2];
sc->aps_data.input = iobuf[APS_INPUT];
return (0);
}
void
aps_refresh_sensor_data(struct aps_softc *sc)
{
int64_t temp;
int i;
#if NAPM > 0
extern int lid_action;
extern int apm_lidclose;
#endif
if (aps_read_data(sc))
return;
for (i = 0; i < APS_NUM_SENSORS; i++) {
sc->sensors[i].flags &= ~SENSOR_FINVALID;
}
sc->sensors[APS_SENSOR_XACCEL].value = sc->aps_data.x_accel;
sc->sensors[APS_SENSOR_YACCEL].value = sc->aps_data.y_accel;
/* convert to micro (mu) degrees */
temp = sc->aps_data.temp1 * 1000000;
/* convert to kelvin */
temp += 273150000;
sc->sensors[APS_SENSOR_TEMP1].value = temp;
/* convert to micro (mu) degrees */
temp = sc->aps_data.temp2 * 1000000;
/* convert to kelvin */
temp += 273150000;
sc->sensors[APS_SENSOR_TEMP2].value = temp;
sc->sensors[APS_SENSOR_XVAR].value = sc->aps_data.x_var;
sc->sensors[APS_SENSOR_YVAR].value = sc->aps_data.y_var;
sc->sensors[APS_SENSOR_KBACT].value =
(sc->aps_data.input & APS_INPUT_KB) ? 1 : 0;
sc->sensors[APS_SENSOR_MSACT].value =
(sc->aps_data.input & APS_INPUT_MS) ? 1 : 0;
#if NAPM > 0
if (lid_action &&
(sc->sensors[APS_SENSOR_LIDOPEN].value == 1) &&
(sc->aps_data.input & APS_INPUT_LIDOPEN) == 0)
/* Inform APM that the lid has closed */
apm_lidclose = 1;
#endif
sc->sensors[APS_SENSOR_LIDOPEN].value =
(sc->aps_data.input & APS_INPUT_LIDOPEN) ? 1 : 0;
}
void
aps_refresh(void *arg)
{
struct aps_softc *sc = (struct aps_softc *)arg;
aps_refresh_sensor_data(sc);
timeout_add_msec(&aps_timeout, 500);
}
int
aps_activate(struct device *self, int act)
{
struct aps_softc *sc = (struct aps_softc *)self;
bus_space_tag_t iot = sc->aps_iot;
bus_space_handle_t ioh = sc->aps_ioh;
unsigned char iobuf[16];
/* check if we bombed during attach */
if (!timeout_initialized(&aps_timeout))
return (0);
switch (act) {
case DVACT_SUSPEND:
timeout_del(&aps_timeout);
break;
case DVACT_RESUME:
/*
* Redo the init sequence on resume, because APS is
* as forgetful as it is deaf.
*/
/* get APS mode */
iobuf[APS_CMD] = 0x13;
aps_do_io(iot, ioh, iobuf, APS_WRITE_0, APS_READ_1);
aps_init(iot, ioh);
timeout_add_msec(&aps_timeout, 500);
break;
}
return (0);
}
|