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