blob: 5b7afc06a8d039cb18d4b792239bb3aa8f9f1c23 [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001/*
2 * drivers/hwmon/applesmc.c - driver for Apple's SMC (accelerometer, temperature
3 * sensors, fan control, keyboard backlight control) used in Intel-based Apple
4 * computers.
5 *
6 * Copyright (C) 2007 Nicolas Boichat <nicolas@boichat.ch>
7 * Copyright (C) 2010 Henrik Rydberg <rydberg@euromail.se>
8 *
9 * Based on hdaps.c driver:
10 * Copyright (C) 2005 Robert Love <rml@novell.com>
11 * Copyright (C) 2005 Jesper Juhl <jesper.juhl@gmail.com>
12 *
13 * Fan control based on smcFanControl:
14 * Copyright (C) 2006 Hendrik Holtmann <holtmann@mac.com>
15 *
16 * This program is free software; you can redistribute it and/or modify it
17 * under the terms of the GNU General Public License v2 as published by the
18 * Free Software Foundation.
19 *
20 * This program is distributed in the hope that it will be useful, but WITHOUT
21 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
23 * more details.
24 *
25 * You should have received a copy of the GNU General Public License along with
26 * this program; if not, write to the Free Software Foundation, Inc.,
27 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
28 */
29
30#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31
32#include <linux/delay.h>
33#include <linux/platform_device.h>
34#include <linux/input-polldev.h>
35#include <linux/kernel.h>
36#include <linux/slab.h>
37#include <linux/module.h>
38#include <linux/timer.h>
39#include <linux/dmi.h>
40#include <linux/mutex.h>
41#include <linux/hwmon-sysfs.h>
42#include <linux/io.h>
43#include <linux/leds.h>
44#include <linux/hwmon.h>
45#include <linux/workqueue.h>
46
47/* data port used by Apple SMC */
48#define APPLESMC_DATA_PORT 0x300
49/* command/status port used by Apple SMC */
50#define APPLESMC_CMD_PORT 0x304
51
52#define APPLESMC_NR_PORTS 32 /* 0x300-0x31f */
53
54#define APPLESMC_MAX_DATA_LENGTH 32
55
56/* wait up to 32 ms for a status change. */
57#define APPLESMC_MIN_WAIT 0x0040
58#define APPLESMC_MAX_WAIT 0x8000
59
60#define APPLESMC_STATUS_MASK 0x0f
61#define APPLESMC_READ_CMD 0x10
62#define APPLESMC_WRITE_CMD 0x11
63#define APPLESMC_GET_KEY_BY_INDEX_CMD 0x12
64#define APPLESMC_GET_KEY_TYPE_CMD 0x13
65
66#define KEY_COUNT_KEY "#KEY" /* r-o ui32 */
67
68#define LIGHT_SENSOR_LEFT_KEY "ALV0" /* r-o {alv (6-10 bytes) */
69#define LIGHT_SENSOR_RIGHT_KEY "ALV1" /* r-o {alv (6-10 bytes) */
70#define BACKLIGHT_KEY "LKSB" /* w-o {lkb (2 bytes) */
71
72#define CLAMSHELL_KEY "MSLD" /* r-o ui8 (unused) */
73
74#define MOTION_SENSOR_X_KEY "MO_X" /* r-o sp78 (2 bytes) */
75#define MOTION_SENSOR_Y_KEY "MO_Y" /* r-o sp78 (2 bytes) */
76#define MOTION_SENSOR_Z_KEY "MO_Z" /* r-o sp78 (2 bytes) */
77#define MOTION_SENSOR_KEY "MOCN" /* r/w ui16 */
78
79#define FANS_COUNT "FNum" /* r-o ui8 */
80#define FANS_MANUAL "FS! " /* r-w ui16 */
81#define FAN_ID_FMT "F%dID" /* r-o char[16] */
82
83/* List of keys used to read/write fan speeds */
84static const char *const fan_speed_fmt[] = {
85 "F%dAc", /* actual speed */
86 "F%dMn", /* minimum speed (rw) */
87 "F%dMx", /* maximum speed */
88 "F%dSf", /* safe speed - not all models */
89 "F%dTg", /* target speed (manual: rw) */
90};
91
92#define INIT_TIMEOUT_MSECS 5000 /* wait up to 5s for device init ... */
93#define INIT_WAIT_MSECS 50 /* ... in 50ms increments */
94
95#define APPLESMC_POLL_INTERVAL 50 /* msecs */
96#define APPLESMC_INPUT_FUZZ 4 /* input event threshold */
97#define APPLESMC_INPUT_FLAT 4
98
99#define SENSOR_X 0
100#define SENSOR_Y 1
101#define SENSOR_Z 2
102
103#define to_index(attr) (to_sensor_dev_attr(attr)->index & 0xffff)
104#define to_option(attr) (to_sensor_dev_attr(attr)->index >> 16)
105
106/* Dynamic device node attributes */
107struct applesmc_dev_attr {
108 struct sensor_device_attribute sda; /* hwmon attributes */
109 char name[32]; /* room for node file name */
110};
111
112/* Dynamic device node group */
113struct applesmc_node_group {
114 char *format; /* format string */
115 void *show; /* show function */
116 void *store; /* store function */
117 int option; /* function argument */
118 struct applesmc_dev_attr *nodes; /* dynamic node array */
119};
120
121/* AppleSMC entry - cached register information */
122struct applesmc_entry {
123 char key[5]; /* four-letter key code */
124 u8 valid; /* set when entry is successfully read once */
125 u8 len; /* bounded by APPLESMC_MAX_DATA_LENGTH */
126 char type[5]; /* four-letter type code */
127 u8 flags; /* 0x10: func; 0x40: write; 0x80: read */
128};
129
130/* Register lookup and registers common to all SMCs */
131static struct applesmc_registers {
132 struct mutex mutex; /* register read/write mutex */
133 unsigned int key_count; /* number of SMC registers */
134 unsigned int fan_count; /* number of fans */
135 unsigned int temp_count; /* number of temperature registers */
136 unsigned int temp_begin; /* temperature lower index bound */
137 unsigned int temp_end; /* temperature upper index bound */
138 int num_light_sensors; /* number of light sensors */
139 bool has_accelerometer; /* has motion sensor */
140 bool has_key_backlight; /* has keyboard backlight */
141 bool init_complete; /* true when fully initialized */
142 struct applesmc_entry *cache; /* cached key entries */
143} smcreg = {
144 .mutex = __MUTEX_INITIALIZER(smcreg.mutex),
145};
146
147static const int debug;
148static struct platform_device *pdev;
149static s16 rest_x;
150static s16 rest_y;
151static u8 backlight_state[2];
152
153static struct device *hwmon_dev;
154static struct input_polled_dev *applesmc_idev;
155
156/*
157 * Last index written to key_at_index sysfs file, and value to use for all other
158 * key_at_index_* sysfs files.
159 */
160static unsigned int key_at_index;
161
162static struct workqueue_struct *applesmc_led_wq;
163
164/*
165 * __wait_status - Wait up to 32ms for the status port to get a certain value
166 * (masked with 0x0f), returning zero if the value is obtained. Callers must
167 * hold applesmc_lock.
168 */
169static int __wait_status(u8 val)
170{
171 int us;
172
173 val = val & APPLESMC_STATUS_MASK;
174
175 for (us = APPLESMC_MIN_WAIT; us < APPLESMC_MAX_WAIT; us <<= 1) {
176 udelay(us);
177 if ((inb(APPLESMC_CMD_PORT) & APPLESMC_STATUS_MASK) == val)
178 return 0;
179 }
180
181 return -EIO;
182}
183
184/*
185 * special treatment of command port - on newer macbooks, it seems necessary
186 * to resend the command byte before polling the status again. Callers must
187 * hold applesmc_lock.
188 */
189static int send_command(u8 cmd)
190{
191 int us;
192 for (us = APPLESMC_MIN_WAIT; us < APPLESMC_MAX_WAIT; us <<= 1) {
193 outb(cmd, APPLESMC_CMD_PORT);
194 udelay(us);
195 if ((inb(APPLESMC_CMD_PORT) & APPLESMC_STATUS_MASK) == 0x0c)
196 return 0;
197 }
198 return -EIO;
199}
200
201static int send_argument(const char *key)
202{
203 int i;
204
205 for (i = 0; i < 4; i++) {
206 outb(key[i], APPLESMC_DATA_PORT);
207 if (__wait_status(0x04))
208 return -EIO;
209 }
210 return 0;
211}
212
213static int read_smc(u8 cmd, const char *key, u8 *buffer, u8 len)
214{
215 u8 status, data = 0;
216 int i;
217
218 if (send_command(cmd) || send_argument(key)) {
219 pr_warn("%.4s: read arg fail\n", key);
220 return -EIO;
221 }
222
223 /* This has no effect on newer (2012) SMCs */
224 outb(len, APPLESMC_DATA_PORT);
225
226 for (i = 0; i < len; i++) {
227 if (__wait_status(0x05)) {
228 pr_warn("%.4s: read data fail\n", key);
229 return -EIO;
230 }
231 buffer[i] = inb(APPLESMC_DATA_PORT);
232 }
233
234 /* Read the data port until bit0 is cleared */
235 for (i = 0; i < 16; i++) {
236 udelay(APPLESMC_MIN_WAIT);
237 status = inb(APPLESMC_CMD_PORT);
238 if (!(status & 0x01))
239 break;
240 data = inb(APPLESMC_DATA_PORT);
241 }
242 if (i)
243 pr_warn("flushed %d bytes, last value is: %d\n", i, data);
244
245 return 0;
246}
247
248static int write_smc(u8 cmd, const char *key, const u8 *buffer, u8 len)
249{
250 int i;
251
252 if (send_command(cmd) || send_argument(key)) {
253 pr_warn("%s: write arg fail\n", key);
254 return -EIO;
255 }
256
257 outb(len, APPLESMC_DATA_PORT);
258
259 for (i = 0; i < len; i++) {
260 if (__wait_status(0x04)) {
261 pr_warn("%s: write data fail\n", key);
262 return -EIO;
263 }
264 outb(buffer[i], APPLESMC_DATA_PORT);
265 }
266
267 return 0;
268}
269
270static int read_register_count(unsigned int *count)
271{
272 __be32 be;
273 int ret;
274
275 ret = read_smc(APPLESMC_READ_CMD, KEY_COUNT_KEY, (u8 *)&be, 4);
276 if (ret)
277 return ret;
278
279 *count = be32_to_cpu(be);
280 return 0;
281}
282
283/*
284 * Serialized I/O
285 *
286 * Returns zero on success or a negative error on failure.
287 * All functions below are concurrency safe - callers should NOT hold lock.
288 */
289
290static int applesmc_read_entry(const struct applesmc_entry *entry,
291 u8 *buf, u8 len)
292{
293 int ret;
294
295 if (entry->len != len)
296 return -EINVAL;
297 mutex_lock(&smcreg.mutex);
298 ret = read_smc(APPLESMC_READ_CMD, entry->key, buf, len);
299 mutex_unlock(&smcreg.mutex);
300
301 return ret;
302}
303
304static int applesmc_write_entry(const struct applesmc_entry *entry,
305 const u8 *buf, u8 len)
306{
307 int ret;
308
309 if (entry->len != len)
310 return -EINVAL;
311 mutex_lock(&smcreg.mutex);
312 ret = write_smc(APPLESMC_WRITE_CMD, entry->key, buf, len);
313 mutex_unlock(&smcreg.mutex);
314 return ret;
315}
316
317static const struct applesmc_entry *applesmc_get_entry_by_index(int index)
318{
319 struct applesmc_entry *cache = &smcreg.cache[index];
320 u8 key[4], info[6];
321 __be32 be;
322 int ret = 0;
323
324 if (cache->valid)
325 return cache;
326
327 mutex_lock(&smcreg.mutex);
328
329 if (cache->valid)
330 goto out;
331 be = cpu_to_be32(index);
332 ret = read_smc(APPLESMC_GET_KEY_BY_INDEX_CMD, (u8 *)&be, key, 4);
333 if (ret)
334 goto out;
335 ret = read_smc(APPLESMC_GET_KEY_TYPE_CMD, key, info, 6);
336 if (ret)
337 goto out;
338
339 memcpy(cache->key, key, 4);
340 cache->len = info[0];
341 memcpy(cache->type, &info[1], 4);
342 cache->flags = info[5];
343 cache->valid = 1;
344
345out:
346 mutex_unlock(&smcreg.mutex);
347 if (ret)
348 return ERR_PTR(ret);
349 return cache;
350}
351
352static int applesmc_get_lower_bound(unsigned int *lo, const char *key)
353{
354 int begin = 0, end = smcreg.key_count;
355 const struct applesmc_entry *entry;
356
357 while (begin != end) {
358 int middle = begin + (end - begin) / 2;
359 entry = applesmc_get_entry_by_index(middle);
360 if (IS_ERR(entry)) {
361 *lo = 0;
362 return PTR_ERR(entry);
363 }
364 if (strcmp(entry->key, key) < 0)
365 begin = middle + 1;
366 else
367 end = middle;
368 }
369
370 *lo = begin;
371 return 0;
372}
373
374static int applesmc_get_upper_bound(unsigned int *hi, const char *key)
375{
376 int begin = 0, end = smcreg.key_count;
377 const struct applesmc_entry *entry;
378
379 while (begin != end) {
380 int middle = begin + (end - begin) / 2;
381 entry = applesmc_get_entry_by_index(middle);
382 if (IS_ERR(entry)) {
383 *hi = smcreg.key_count;
384 return PTR_ERR(entry);
385 }
386 if (strcmp(key, entry->key) < 0)
387 end = middle;
388 else
389 begin = middle + 1;
390 }
391
392 *hi = begin;
393 return 0;
394}
395
396static const struct applesmc_entry *applesmc_get_entry_by_key(const char *key)
397{
398 int begin, end;
399 int ret;
400
401 ret = applesmc_get_lower_bound(&begin, key);
402 if (ret)
403 return ERR_PTR(ret);
404 ret = applesmc_get_upper_bound(&end, key);
405 if (ret)
406 return ERR_PTR(ret);
407 if (end - begin != 1)
408 return ERR_PTR(-EINVAL);
409
410 return applesmc_get_entry_by_index(begin);
411}
412
413static int applesmc_read_key(const char *key, u8 *buffer, u8 len)
414{
415 const struct applesmc_entry *entry;
416
417 entry = applesmc_get_entry_by_key(key);
418 if (IS_ERR(entry))
419 return PTR_ERR(entry);
420
421 return applesmc_read_entry(entry, buffer, len);
422}
423
424static int applesmc_write_key(const char *key, const u8 *buffer, u8 len)
425{
426 const struct applesmc_entry *entry;
427
428 entry = applesmc_get_entry_by_key(key);
429 if (IS_ERR(entry))
430 return PTR_ERR(entry);
431
432 return applesmc_write_entry(entry, buffer, len);
433}
434
435static int applesmc_has_key(const char *key, bool *value)
436{
437 const struct applesmc_entry *entry;
438
439 entry = applesmc_get_entry_by_key(key);
440 if (IS_ERR(entry) && PTR_ERR(entry) != -EINVAL)
441 return PTR_ERR(entry);
442
443 *value = !IS_ERR(entry);
444 return 0;
445}
446
447/*
448 * applesmc_read_motion_sensor - Read motion sensor (X, Y or Z).
449 */
450static int applesmc_read_motion_sensor(int index, s16 *value)
451{
452 u8 buffer[2];
453 int ret;
454
455 switch (index) {
456 case SENSOR_X:
457 ret = applesmc_read_key(MOTION_SENSOR_X_KEY, buffer, 2);
458 break;
459 case SENSOR_Y:
460 ret = applesmc_read_key(MOTION_SENSOR_Y_KEY, buffer, 2);
461 break;
462 case SENSOR_Z:
463 ret = applesmc_read_key(MOTION_SENSOR_Z_KEY, buffer, 2);
464 break;
465 default:
466 ret = -EINVAL;
467 }
468
469 *value = ((s16)buffer[0] << 8) | buffer[1];
470
471 return ret;
472}
473
474/*
475 * applesmc_device_init - initialize the accelerometer. Can sleep.
476 */
477static void applesmc_device_init(void)
478{
479 int total;
480 u8 buffer[2];
481
482 if (!smcreg.has_accelerometer)
483 return;
484
485 for (total = INIT_TIMEOUT_MSECS; total > 0; total -= INIT_WAIT_MSECS) {
486 if (!applesmc_read_key(MOTION_SENSOR_KEY, buffer, 2) &&
487 (buffer[0] != 0x00 || buffer[1] != 0x00))
488 return;
489 buffer[0] = 0xe0;
490 buffer[1] = 0x00;
491 applesmc_write_key(MOTION_SENSOR_KEY, buffer, 2);
492 msleep(INIT_WAIT_MSECS);
493 }
494
495 pr_warn("failed to init the device\n");
496}
497
498/*
499 * applesmc_init_smcreg_try - Try to initialize register cache. Idempotent.
500 */
501static int applesmc_init_smcreg_try(void)
502{
503 struct applesmc_registers *s = &smcreg;
504 bool left_light_sensor, right_light_sensor;
505 unsigned int count;
506 u8 tmp[1];
507 int ret;
508
509 if (s->init_complete)
510 return 0;
511
512 ret = read_register_count(&count);
513 if (ret)
514 return ret;
515
516 if (s->cache && s->key_count != count) {
517 pr_warn("key count changed from %d to %d\n",
518 s->key_count, count);
519 kfree(s->cache);
520 s->cache = NULL;
521 }
522 s->key_count = count;
523
524 if (!s->cache)
525 s->cache = kcalloc(s->key_count, sizeof(*s->cache), GFP_KERNEL);
526 if (!s->cache)
527 return -ENOMEM;
528
529 ret = applesmc_read_key(FANS_COUNT, tmp, 1);
530 if (ret)
531 return ret;
532 s->fan_count = tmp[0];
533
534 ret = applesmc_get_lower_bound(&s->temp_begin, "T");
535 if (ret)
536 return ret;
537 ret = applesmc_get_lower_bound(&s->temp_end, "U");
538 if (ret)
539 return ret;
540 s->temp_count = s->temp_end - s->temp_begin;
541
542 ret = applesmc_has_key(LIGHT_SENSOR_LEFT_KEY, &left_light_sensor);
543 if (ret)
544 return ret;
545 ret = applesmc_has_key(LIGHT_SENSOR_RIGHT_KEY, &right_light_sensor);
546 if (ret)
547 return ret;
548 ret = applesmc_has_key(MOTION_SENSOR_KEY, &s->has_accelerometer);
549 if (ret)
550 return ret;
551 ret = applesmc_has_key(BACKLIGHT_KEY, &s->has_key_backlight);
552 if (ret)
553 return ret;
554
555 s->num_light_sensors = left_light_sensor + right_light_sensor;
556 s->init_complete = true;
557
558 pr_info("key=%d fan=%d temp=%d acc=%d lux=%d kbd=%d\n",
559 s->key_count, s->fan_count, s->temp_count,
560 s->has_accelerometer,
561 s->num_light_sensors,
562 s->has_key_backlight);
563
564 return 0;
565}
566
567/*
568 * applesmc_init_smcreg - Initialize register cache.
569 *
570 * Retries until initialization is successful, or the operation times out.
571 *
572 */
573static int applesmc_init_smcreg(void)
574{
575 int ms, ret;
576
577 for (ms = 0; ms < INIT_TIMEOUT_MSECS; ms += INIT_WAIT_MSECS) {
578 ret = applesmc_init_smcreg_try();
579 if (!ret) {
580 if (ms)
581 pr_info("init_smcreg() took %d ms\n", ms);
582 return 0;
583 }
584 msleep(INIT_WAIT_MSECS);
585 }
586
587 kfree(smcreg.cache);
588 smcreg.cache = NULL;
589
590 return ret;
591}
592
593static void applesmc_destroy_smcreg(void)
594{
595 kfree(smcreg.cache);
596 smcreg.cache = NULL;
597 smcreg.init_complete = false;
598}
599
600/* Device model stuff */
601static int applesmc_probe(struct platform_device *dev)
602{
603 int ret;
604
605 ret = applesmc_init_smcreg();
606 if (ret)
607 return ret;
608
609 applesmc_device_init();
610
611 return 0;
612}
613
614/* Synchronize device with memorized backlight state */
615static int applesmc_pm_resume(struct device *dev)
616{
617 if (smcreg.has_key_backlight)
618 applesmc_write_key(BACKLIGHT_KEY, backlight_state, 2);
619 return 0;
620}
621
622/* Reinitialize device on resume from hibernation */
623static int applesmc_pm_restore(struct device *dev)
624{
625 applesmc_device_init();
626 return applesmc_pm_resume(dev);
627}
628
629static const struct dev_pm_ops applesmc_pm_ops = {
630 .resume = applesmc_pm_resume,
631 .restore = applesmc_pm_restore,
632};
633
634static struct platform_driver applesmc_driver = {
635 .probe = applesmc_probe,
636 .driver = {
637 .name = "applesmc",
638 .owner = THIS_MODULE,
639 .pm = &applesmc_pm_ops,
640 },
641};
642
643/*
644 * applesmc_calibrate - Set our "resting" values. Callers must
645 * hold applesmc_lock.
646 */
647static void applesmc_calibrate(void)
648{
649 applesmc_read_motion_sensor(SENSOR_X, &rest_x);
650 applesmc_read_motion_sensor(SENSOR_Y, &rest_y);
651 rest_x = -rest_x;
652}
653
654static void applesmc_idev_poll(struct input_polled_dev *dev)
655{
656 struct input_dev *idev = dev->input;
657 s16 x, y;
658
659 if (applesmc_read_motion_sensor(SENSOR_X, &x))
660 return;
661 if (applesmc_read_motion_sensor(SENSOR_Y, &y))
662 return;
663
664 x = -x;
665 input_report_abs(idev, ABS_X, x - rest_x);
666 input_report_abs(idev, ABS_Y, y - rest_y);
667 input_sync(idev);
668}
669
670/* Sysfs Files */
671
672static ssize_t applesmc_name_show(struct device *dev,
673 struct device_attribute *attr, char *buf)
674{
675 return snprintf(buf, PAGE_SIZE, "applesmc\n");
676}
677
678static ssize_t applesmc_position_show(struct device *dev,
679 struct device_attribute *attr, char *buf)
680{
681 int ret;
682 s16 x, y, z;
683
684 ret = applesmc_read_motion_sensor(SENSOR_X, &x);
685 if (ret)
686 goto out;
687 ret = applesmc_read_motion_sensor(SENSOR_Y, &y);
688 if (ret)
689 goto out;
690 ret = applesmc_read_motion_sensor(SENSOR_Z, &z);
691 if (ret)
692 goto out;
693
694out:
695 if (ret)
696 return ret;
697 else
698 return snprintf(buf, PAGE_SIZE, "(%d,%d,%d)\n", x, y, z);
699}
700
701static ssize_t applesmc_light_show(struct device *dev,
702 struct device_attribute *attr, char *sysfsbuf)
703{
704 const struct applesmc_entry *entry;
705 static int data_length;
706 int ret;
707 u8 left = 0, right = 0;
708 u8 buffer[10];
709
710 if (!data_length) {
711 entry = applesmc_get_entry_by_key(LIGHT_SENSOR_LEFT_KEY);
712 if (IS_ERR(entry))
713 return PTR_ERR(entry);
714 if (entry->len > 10)
715 return -ENXIO;
716 data_length = entry->len;
717 pr_info("light sensor data length set to %d\n", data_length);
718 }
719
720 ret = applesmc_read_key(LIGHT_SENSOR_LEFT_KEY, buffer, data_length);
721 /* newer macbooks report a single 10-bit bigendian value */
722 if (data_length == 10) {
723 left = be16_to_cpu(*(__be16 *)(buffer + 6)) >> 2;
724 goto out;
725 }
726 left = buffer[2];
727 if (ret)
728 goto out;
729 ret = applesmc_read_key(LIGHT_SENSOR_RIGHT_KEY, buffer, data_length);
730 right = buffer[2];
731
732out:
733 if (ret)
734 return ret;
735 else
736 return snprintf(sysfsbuf, PAGE_SIZE, "(%d,%d)\n", left, right);
737}
738
739/* Displays sensor key as label */
740static ssize_t applesmc_show_sensor_label(struct device *dev,
741 struct device_attribute *devattr, char *sysfsbuf)
742{
743 int index = smcreg.temp_begin + to_index(devattr);
744 const struct applesmc_entry *entry;
745
746 entry = applesmc_get_entry_by_index(index);
747 if (IS_ERR(entry))
748 return PTR_ERR(entry);
749
750 return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->key);
751}
752
753/* Displays degree Celsius * 1000 */
754static ssize_t applesmc_show_temperature(struct device *dev,
755 struct device_attribute *devattr, char *sysfsbuf)
756{
757 int index = smcreg.temp_begin + to_index(devattr);
758 const struct applesmc_entry *entry;
759 int ret;
760 u8 buffer[2];
761 unsigned int temp;
762
763 entry = applesmc_get_entry_by_index(index);
764 if (IS_ERR(entry))
765 return PTR_ERR(entry);
766 if (entry->len > 2)
767 return -EINVAL;
768
769 ret = applesmc_read_entry(entry, buffer, entry->len);
770 if (ret)
771 return ret;
772
773 if (entry->len == 2) {
774 temp = buffer[0] * 1000;
775 temp += (buffer[1] >> 6) * 250;
776 } else {
777 temp = buffer[0] * 4000;
778 }
779
780 return snprintf(sysfsbuf, PAGE_SIZE, "%u\n", temp);
781}
782
783static ssize_t applesmc_show_fan_speed(struct device *dev,
784 struct device_attribute *attr, char *sysfsbuf)
785{
786 int ret;
787 unsigned int speed = 0;
788 char newkey[5];
789 u8 buffer[2];
790
791 sprintf(newkey, fan_speed_fmt[to_option(attr)], to_index(attr));
792
793 ret = applesmc_read_key(newkey, buffer, 2);
794 speed = ((buffer[0] << 8 | buffer[1]) >> 2);
795
796 if (ret)
797 return ret;
798 else
799 return snprintf(sysfsbuf, PAGE_SIZE, "%u\n", speed);
800}
801
802static ssize_t applesmc_store_fan_speed(struct device *dev,
803 struct device_attribute *attr,
804 const char *sysfsbuf, size_t count)
805{
806 int ret;
807 unsigned long speed;
808 char newkey[5];
809 u8 buffer[2];
810
811 if (kstrtoul(sysfsbuf, 10, &speed) < 0 || speed >= 0x4000)
812 return -EINVAL; /* Bigger than a 14-bit value */
813
814 sprintf(newkey, fan_speed_fmt[to_option(attr)], to_index(attr));
815
816 buffer[0] = (speed >> 6) & 0xff;
817 buffer[1] = (speed << 2) & 0xff;
818 ret = applesmc_write_key(newkey, buffer, 2);
819
820 if (ret)
821 return ret;
822 else
823 return count;
824}
825
826static ssize_t applesmc_show_fan_manual(struct device *dev,
827 struct device_attribute *attr, char *sysfsbuf)
828{
829 int ret;
830 u16 manual = 0;
831 u8 buffer[2];
832
833 ret = applesmc_read_key(FANS_MANUAL, buffer, 2);
834 manual = ((buffer[0] << 8 | buffer[1]) >> to_index(attr)) & 0x01;
835
836 if (ret)
837 return ret;
838 else
839 return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", manual);
840}
841
842static ssize_t applesmc_store_fan_manual(struct device *dev,
843 struct device_attribute *attr,
844 const char *sysfsbuf, size_t count)
845{
846 int ret;
847 u8 buffer[2];
848 unsigned long input;
849 u16 val;
850
851 if (kstrtoul(sysfsbuf, 10, &input) < 0)
852 return -EINVAL;
853
854 ret = applesmc_read_key(FANS_MANUAL, buffer, 2);
855 val = (buffer[0] << 8 | buffer[1]);
856 if (ret)
857 goto out;
858
859 if (input)
860 val = val | (0x01 << to_index(attr));
861 else
862 val = val & ~(0x01 << to_index(attr));
863
864 buffer[0] = (val >> 8) & 0xFF;
865 buffer[1] = val & 0xFF;
866
867 ret = applesmc_write_key(FANS_MANUAL, buffer, 2);
868
869out:
870 if (ret)
871 return ret;
872 else
873 return count;
874}
875
876static ssize_t applesmc_show_fan_position(struct device *dev,
877 struct device_attribute *attr, char *sysfsbuf)
878{
879 int ret;
880 char newkey[5];
881 u8 buffer[17];
882
883 sprintf(newkey, FAN_ID_FMT, to_index(attr));
884
885 ret = applesmc_read_key(newkey, buffer, 16);
886 buffer[16] = 0;
887
888 if (ret)
889 return ret;
890 else
891 return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", buffer+4);
892}
893
894static ssize_t applesmc_calibrate_show(struct device *dev,
895 struct device_attribute *attr, char *sysfsbuf)
896{
897 return snprintf(sysfsbuf, PAGE_SIZE, "(%d,%d)\n", rest_x, rest_y);
898}
899
900static ssize_t applesmc_calibrate_store(struct device *dev,
901 struct device_attribute *attr, const char *sysfsbuf, size_t count)
902{
903 applesmc_calibrate();
904
905 return count;
906}
907
908static void applesmc_backlight_set(struct work_struct *work)
909{
910 applesmc_write_key(BACKLIGHT_KEY, backlight_state, 2);
911}
912static DECLARE_WORK(backlight_work, &applesmc_backlight_set);
913
914static void applesmc_brightness_set(struct led_classdev *led_cdev,
915 enum led_brightness value)
916{
917 int ret;
918
919 backlight_state[0] = value;
920 ret = queue_work(applesmc_led_wq, &backlight_work);
921
922 if (debug && (!ret))
923 printk(KERN_DEBUG "applesmc: work was already on the queue.\n");
924}
925
926static ssize_t applesmc_key_count_show(struct device *dev,
927 struct device_attribute *attr, char *sysfsbuf)
928{
929 int ret;
930 u8 buffer[4];
931 u32 count;
932
933 ret = applesmc_read_key(KEY_COUNT_KEY, buffer, 4);
934 count = ((u32)buffer[0]<<24) + ((u32)buffer[1]<<16) +
935 ((u32)buffer[2]<<8) + buffer[3];
936
937 if (ret)
938 return ret;
939 else
940 return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", count);
941}
942
943static ssize_t applesmc_key_at_index_read_show(struct device *dev,
944 struct device_attribute *attr, char *sysfsbuf)
945{
946 const struct applesmc_entry *entry;
947 int ret;
948
949 entry = applesmc_get_entry_by_index(key_at_index);
950 if (IS_ERR(entry))
951 return PTR_ERR(entry);
952 ret = applesmc_read_entry(entry, sysfsbuf, entry->len);
953 if (ret)
954 return ret;
955
956 return entry->len;
957}
958
959static ssize_t applesmc_key_at_index_data_length_show(struct device *dev,
960 struct device_attribute *attr, char *sysfsbuf)
961{
962 const struct applesmc_entry *entry;
963
964 entry = applesmc_get_entry_by_index(key_at_index);
965 if (IS_ERR(entry))
966 return PTR_ERR(entry);
967
968 return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", entry->len);
969}
970
971static ssize_t applesmc_key_at_index_type_show(struct device *dev,
972 struct device_attribute *attr, char *sysfsbuf)
973{
974 const struct applesmc_entry *entry;
975
976 entry = applesmc_get_entry_by_index(key_at_index);
977 if (IS_ERR(entry))
978 return PTR_ERR(entry);
979
980 return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->type);
981}
982
983static ssize_t applesmc_key_at_index_name_show(struct device *dev,
984 struct device_attribute *attr, char *sysfsbuf)
985{
986 const struct applesmc_entry *entry;
987
988 entry = applesmc_get_entry_by_index(key_at_index);
989 if (IS_ERR(entry))
990 return PTR_ERR(entry);
991
992 return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->key);
993}
994
995static ssize_t applesmc_key_at_index_show(struct device *dev,
996 struct device_attribute *attr, char *sysfsbuf)
997{
998 return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", key_at_index);
999}
1000
1001static ssize_t applesmc_key_at_index_store(struct device *dev,
1002 struct device_attribute *attr, const char *sysfsbuf, size_t count)
1003{
1004 unsigned long newkey;
1005
1006 if (kstrtoul(sysfsbuf, 10, &newkey) < 0
1007 || newkey >= smcreg.key_count)
1008 return -EINVAL;
1009
1010 key_at_index = newkey;
1011 return count;
1012}
1013
1014static struct led_classdev applesmc_backlight = {
1015 .name = "smc::kbd_backlight",
1016 .default_trigger = "nand-disk",
1017 .brightness_set = applesmc_brightness_set,
1018};
1019
1020static struct applesmc_node_group info_group[] = {
1021 { "name", applesmc_name_show },
1022 { "key_count", applesmc_key_count_show },
1023 { "key_at_index", applesmc_key_at_index_show, applesmc_key_at_index_store },
1024 { "key_at_index_name", applesmc_key_at_index_name_show },
1025 { "key_at_index_type", applesmc_key_at_index_type_show },
1026 { "key_at_index_data_length", applesmc_key_at_index_data_length_show },
1027 { "key_at_index_data", applesmc_key_at_index_read_show },
1028 { }
1029};
1030
1031static struct applesmc_node_group accelerometer_group[] = {
1032 { "position", applesmc_position_show },
1033 { "calibrate", applesmc_calibrate_show, applesmc_calibrate_store },
1034 { }
1035};
1036
1037static struct applesmc_node_group light_sensor_group[] = {
1038 { "light", applesmc_light_show },
1039 { }
1040};
1041
1042static struct applesmc_node_group fan_group[] = {
1043 { "fan%d_label", applesmc_show_fan_position },
1044 { "fan%d_input", applesmc_show_fan_speed, NULL, 0 },
1045 { "fan%d_min", applesmc_show_fan_speed, applesmc_store_fan_speed, 1 },
1046 { "fan%d_max", applesmc_show_fan_speed, NULL, 2 },
1047 { "fan%d_safe", applesmc_show_fan_speed, NULL, 3 },
1048 { "fan%d_output", applesmc_show_fan_speed, applesmc_store_fan_speed, 4 },
1049 { "fan%d_manual", applesmc_show_fan_manual, applesmc_store_fan_manual },
1050 { }
1051};
1052
1053static struct applesmc_node_group temp_group[] = {
1054 { "temp%d_label", applesmc_show_sensor_label },
1055 { "temp%d_input", applesmc_show_temperature },
1056 { }
1057};
1058
1059/* Module stuff */
1060
1061/*
1062 * applesmc_destroy_nodes - remove files and free associated memory
1063 */
1064static void applesmc_destroy_nodes(struct applesmc_node_group *groups)
1065{
1066 struct applesmc_node_group *grp;
1067 struct applesmc_dev_attr *node;
1068
1069 for (grp = groups; grp->nodes; grp++) {
1070 for (node = grp->nodes; node->sda.dev_attr.attr.name; node++)
1071 sysfs_remove_file(&pdev->dev.kobj,
1072 &node->sda.dev_attr.attr);
1073 kfree(grp->nodes);
1074 grp->nodes = NULL;
1075 }
1076}
1077
1078/*
1079 * applesmc_create_nodes - create a two-dimensional group of sysfs files
1080 */
1081static int applesmc_create_nodes(struct applesmc_node_group *groups, int num)
1082{
1083 struct applesmc_node_group *grp;
1084 struct applesmc_dev_attr *node;
1085 struct attribute *attr;
1086 int ret, i;
1087
1088 for (grp = groups; grp->format; grp++) {
1089 grp->nodes = kcalloc(num + 1, sizeof(*node), GFP_KERNEL);
1090 if (!grp->nodes) {
1091 ret = -ENOMEM;
1092 goto out;
1093 }
1094 for (i = 0; i < num; i++) {
1095 node = &grp->nodes[i];
1096 sprintf(node->name, grp->format, i + 1);
1097 node->sda.index = (grp->option << 16) | (i & 0xffff);
1098 node->sda.dev_attr.show = grp->show;
1099 node->sda.dev_attr.store = grp->store;
1100 attr = &node->sda.dev_attr.attr;
1101 sysfs_attr_init(attr);
1102 attr->name = node->name;
1103 attr->mode = S_IRUGO | (grp->store ? S_IWUSR : 0);
1104 ret = sysfs_create_file(&pdev->dev.kobj, attr);
1105 if (ret) {
1106 attr->name = NULL;
1107 goto out;
1108 }
1109 }
1110 }
1111
1112 return 0;
1113out:
1114 applesmc_destroy_nodes(groups);
1115 return ret;
1116}
1117
1118/* Create accelerometer ressources */
1119static int applesmc_create_accelerometer(void)
1120{
1121 struct input_dev *idev;
1122 int ret;
1123
1124 if (!smcreg.has_accelerometer)
1125 return 0;
1126
1127 ret = applesmc_create_nodes(accelerometer_group, 1);
1128 if (ret)
1129 goto out;
1130
1131 applesmc_idev = input_allocate_polled_device();
1132 if (!applesmc_idev) {
1133 ret = -ENOMEM;
1134 goto out_sysfs;
1135 }
1136
1137 applesmc_idev->poll = applesmc_idev_poll;
1138 applesmc_idev->poll_interval = APPLESMC_POLL_INTERVAL;
1139
1140 /* initial calibrate for the input device */
1141 applesmc_calibrate();
1142
1143 /* initialize the input device */
1144 idev = applesmc_idev->input;
1145 idev->name = "applesmc";
1146 idev->id.bustype = BUS_HOST;
1147 idev->dev.parent = &pdev->dev;
1148 idev->evbit[0] = BIT_MASK(EV_ABS);
1149 input_set_abs_params(idev, ABS_X,
1150 -256, 256, APPLESMC_INPUT_FUZZ, APPLESMC_INPUT_FLAT);
1151 input_set_abs_params(idev, ABS_Y,
1152 -256, 256, APPLESMC_INPUT_FUZZ, APPLESMC_INPUT_FLAT);
1153
1154 ret = input_register_polled_device(applesmc_idev);
1155 if (ret)
1156 goto out_idev;
1157
1158 return 0;
1159
1160out_idev:
1161 input_free_polled_device(applesmc_idev);
1162
1163out_sysfs:
1164 applesmc_destroy_nodes(accelerometer_group);
1165
1166out:
1167 pr_warn("driver init failed (ret=%d)!\n", ret);
1168 return ret;
1169}
1170
1171/* Release all ressources used by the accelerometer */
1172static void applesmc_release_accelerometer(void)
1173{
1174 if (!smcreg.has_accelerometer)
1175 return;
1176 input_unregister_polled_device(applesmc_idev);
1177 input_free_polled_device(applesmc_idev);
1178 applesmc_destroy_nodes(accelerometer_group);
1179}
1180
1181static int applesmc_create_light_sensor(void)
1182{
1183 if (!smcreg.num_light_sensors)
1184 return 0;
1185 return applesmc_create_nodes(light_sensor_group, 1);
1186}
1187
1188static void applesmc_release_light_sensor(void)
1189{
1190 if (!smcreg.num_light_sensors)
1191 return;
1192 applesmc_destroy_nodes(light_sensor_group);
1193}
1194
1195static int applesmc_create_key_backlight(void)
1196{
1197 if (!smcreg.has_key_backlight)
1198 return 0;
1199 applesmc_led_wq = create_singlethread_workqueue("applesmc-led");
1200 if (!applesmc_led_wq)
1201 return -ENOMEM;
1202 return led_classdev_register(&pdev->dev, &applesmc_backlight);
1203}
1204
1205static void applesmc_release_key_backlight(void)
1206{
1207 if (!smcreg.has_key_backlight)
1208 return;
1209 led_classdev_unregister(&applesmc_backlight);
1210 destroy_workqueue(applesmc_led_wq);
1211}
1212
1213static int applesmc_dmi_match(const struct dmi_system_id *id)
1214{
1215 return 1;
1216}
1217
1218/*
1219 * Note that DMI_MATCH(...,"MacBook") will match "MacBookPro1,1".
1220 * So we need to put "Apple MacBook Pro" before "Apple MacBook".
1221 */
1222static __initdata struct dmi_system_id applesmc_whitelist[] = {
1223 { applesmc_dmi_match, "Apple MacBook Air", {
1224 DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1225 DMI_MATCH(DMI_PRODUCT_NAME, "MacBookAir") },
1226 },
1227 { applesmc_dmi_match, "Apple MacBook Pro", {
1228 DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1229 DMI_MATCH(DMI_PRODUCT_NAME, "MacBookPro") },
1230 },
1231 { applesmc_dmi_match, "Apple MacBook", {
1232 DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1233 DMI_MATCH(DMI_PRODUCT_NAME, "MacBook") },
1234 },
1235 { applesmc_dmi_match, "Apple Macmini", {
1236 DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1237 DMI_MATCH(DMI_PRODUCT_NAME, "Macmini") },
1238 },
1239 { applesmc_dmi_match, "Apple MacPro", {
1240 DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1241 DMI_MATCH(DMI_PRODUCT_NAME, "MacPro") },
1242 },
1243 { applesmc_dmi_match, "Apple iMac", {
1244 DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1245 DMI_MATCH(DMI_PRODUCT_NAME, "iMac") },
1246 },
1247 { .ident = NULL }
1248};
1249
1250static int __init applesmc_init(void)
1251{
1252 int ret;
1253
1254 if (!dmi_check_system(applesmc_whitelist)) {
1255 pr_warn("supported laptop not found!\n");
1256 ret = -ENODEV;
1257 goto out;
1258 }
1259
1260 if (!request_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS,
1261 "applesmc")) {
1262 ret = -ENXIO;
1263 goto out;
1264 }
1265
1266 ret = platform_driver_register(&applesmc_driver);
1267 if (ret)
1268 goto out_region;
1269
1270 pdev = platform_device_register_simple("applesmc", APPLESMC_DATA_PORT,
1271 NULL, 0);
1272 if (IS_ERR(pdev)) {
1273 ret = PTR_ERR(pdev);
1274 goto out_driver;
1275 }
1276
1277 /* create register cache */
1278 ret = applesmc_init_smcreg();
1279 if (ret)
1280 goto out_device;
1281
1282 ret = applesmc_create_nodes(info_group, 1);
1283 if (ret)
1284 goto out_smcreg;
1285
1286 ret = applesmc_create_nodes(fan_group, smcreg.fan_count);
1287 if (ret)
1288 goto out_info;
1289
1290 ret = applesmc_create_nodes(temp_group, smcreg.temp_count);
1291 if (ret)
1292 goto out_fans;
1293
1294 ret = applesmc_create_accelerometer();
1295 if (ret)
1296 goto out_temperature;
1297
1298 ret = applesmc_create_light_sensor();
1299 if (ret)
1300 goto out_accelerometer;
1301
1302 ret = applesmc_create_key_backlight();
1303 if (ret)
1304 goto out_light_sysfs;
1305
1306 hwmon_dev = hwmon_device_register(&pdev->dev);
1307 if (IS_ERR(hwmon_dev)) {
1308 ret = PTR_ERR(hwmon_dev);
1309 goto out_light_ledclass;
1310 }
1311
1312 return 0;
1313
1314out_light_ledclass:
1315 applesmc_release_key_backlight();
1316out_light_sysfs:
1317 applesmc_release_light_sensor();
1318out_accelerometer:
1319 applesmc_release_accelerometer();
1320out_temperature:
1321 applesmc_destroy_nodes(temp_group);
1322out_fans:
1323 applesmc_destroy_nodes(fan_group);
1324out_info:
1325 applesmc_destroy_nodes(info_group);
1326out_smcreg:
1327 applesmc_destroy_smcreg();
1328out_device:
1329 platform_device_unregister(pdev);
1330out_driver:
1331 platform_driver_unregister(&applesmc_driver);
1332out_region:
1333 release_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS);
1334out:
1335 pr_warn("driver init failed (ret=%d)!\n", ret);
1336 return ret;
1337}
1338
1339static void __exit applesmc_exit(void)
1340{
1341 hwmon_device_unregister(hwmon_dev);
1342 applesmc_release_key_backlight();
1343 applesmc_release_light_sensor();
1344 applesmc_release_accelerometer();
1345 applesmc_destroy_nodes(temp_group);
1346 applesmc_destroy_nodes(fan_group);
1347 applesmc_destroy_nodes(info_group);
1348 applesmc_destroy_smcreg();
1349 platform_device_unregister(pdev);
1350 platform_driver_unregister(&applesmc_driver);
1351 release_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS);
1352}
1353
1354module_init(applesmc_init);
1355module_exit(applesmc_exit);
1356
1357MODULE_AUTHOR("Nicolas Boichat");
1358MODULE_DESCRIPTION("Apple SMC");
1359MODULE_LICENSE("GPL v2");
1360MODULE_DEVICE_TABLE(dmi, applesmc_whitelist);