ARM: avoid alignment related control reg writeouts
[pandora-kernel.git] / drivers / hwmon / applesmc.c
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 <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 */
84 static 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 */
107 struct 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 */
113 struct 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 */
122 struct 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 */
131 static 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
147 static const int debug;
148 static struct platform_device *pdev;
149 static s16 rest_x;
150 static s16 rest_y;
151 static u8 backlight_state[2];
152
153 static struct device *hwmon_dev;
154 static 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  */
160 static unsigned int key_at_index;
161
162 static 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  */
169 static 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  */
189 static 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
201 static 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
213 static int read_smc(u8 cmd, const char *key, u8 *buffer, u8 len)
214 {
215         int i;
216
217         if (send_command(cmd) || send_argument(key)) {
218                 pr_warn("%.4s: read arg fail\n", key);
219                 return -EIO;
220         }
221
222         outb(len, APPLESMC_DATA_PORT);
223
224         for (i = 0; i < len; i++) {
225                 if (__wait_status(0x05)) {
226                         pr_warn("%.4s: read data fail\n", key);
227                         return -EIO;
228                 }
229                 buffer[i] = inb(APPLESMC_DATA_PORT);
230         }
231
232         return 0;
233 }
234
235 static int write_smc(u8 cmd, const char *key, const u8 *buffer, u8 len)
236 {
237         int i;
238
239         if (send_command(cmd) || send_argument(key)) {
240                 pr_warn("%s: write arg fail\n", key);
241                 return -EIO;
242         }
243
244         outb(len, APPLESMC_DATA_PORT);
245
246         for (i = 0; i < len; i++) {
247                 if (__wait_status(0x04)) {
248                         pr_warn("%s: write data fail\n", key);
249                         return -EIO;
250                 }
251                 outb(buffer[i], APPLESMC_DATA_PORT);
252         }
253
254         return 0;
255 }
256
257 static int read_register_count(unsigned int *count)
258 {
259         __be32 be;
260         int ret;
261
262         ret = read_smc(APPLESMC_READ_CMD, KEY_COUNT_KEY, (u8 *)&be, 4);
263         if (ret)
264                 return ret;
265
266         *count = be32_to_cpu(be);
267         return 0;
268 }
269
270 /*
271  * Serialized I/O
272  *
273  * Returns zero on success or a negative error on failure.
274  * All functions below are concurrency safe - callers should NOT hold lock.
275  */
276
277 static int applesmc_read_entry(const struct applesmc_entry *entry,
278                                u8 *buf, u8 len)
279 {
280         int ret;
281
282         if (entry->len != len)
283                 return -EINVAL;
284         mutex_lock(&smcreg.mutex);
285         ret = read_smc(APPLESMC_READ_CMD, entry->key, buf, len);
286         mutex_unlock(&smcreg.mutex);
287
288         return ret;
289 }
290
291 static int applesmc_write_entry(const struct applesmc_entry *entry,
292                                 const u8 *buf, u8 len)
293 {
294         int ret;
295
296         if (entry->len != len)
297                 return -EINVAL;
298         mutex_lock(&smcreg.mutex);
299         ret = write_smc(APPLESMC_WRITE_CMD, entry->key, buf, len);
300         mutex_unlock(&smcreg.mutex);
301         return ret;
302 }
303
304 static const struct applesmc_entry *applesmc_get_entry_by_index(int index)
305 {
306         struct applesmc_entry *cache = &smcreg.cache[index];
307         u8 key[4], info[6];
308         __be32 be;
309         int ret = 0;
310
311         if (cache->valid)
312                 return cache;
313
314         mutex_lock(&smcreg.mutex);
315
316         if (cache->valid)
317                 goto out;
318         be = cpu_to_be32(index);
319         ret = read_smc(APPLESMC_GET_KEY_BY_INDEX_CMD, (u8 *)&be, key, 4);
320         if (ret)
321                 goto out;
322         ret = read_smc(APPLESMC_GET_KEY_TYPE_CMD, key, info, 6);
323         if (ret)
324                 goto out;
325
326         memcpy(cache->key, key, 4);
327         cache->len = info[0];
328         memcpy(cache->type, &info[1], 4);
329         cache->flags = info[5];
330         cache->valid = 1;
331
332 out:
333         mutex_unlock(&smcreg.mutex);
334         if (ret)
335                 return ERR_PTR(ret);
336         return cache;
337 }
338
339 static int applesmc_get_lower_bound(unsigned int *lo, const char *key)
340 {
341         int begin = 0, end = smcreg.key_count;
342         const struct applesmc_entry *entry;
343
344         while (begin != end) {
345                 int middle = begin + (end - begin) / 2;
346                 entry = applesmc_get_entry_by_index(middle);
347                 if (IS_ERR(entry)) {
348                         *lo = 0;
349                         return PTR_ERR(entry);
350                 }
351                 if (strcmp(entry->key, key) < 0)
352                         begin = middle + 1;
353                 else
354                         end = middle;
355         }
356
357         *lo = begin;
358         return 0;
359 }
360
361 static int applesmc_get_upper_bound(unsigned int *hi, const char *key)
362 {
363         int begin = 0, end = smcreg.key_count;
364         const struct applesmc_entry *entry;
365
366         while (begin != end) {
367                 int middle = begin + (end - begin) / 2;
368                 entry = applesmc_get_entry_by_index(middle);
369                 if (IS_ERR(entry)) {
370                         *hi = smcreg.key_count;
371                         return PTR_ERR(entry);
372                 }
373                 if (strcmp(key, entry->key) < 0)
374                         end = middle;
375                 else
376                         begin = middle + 1;
377         }
378
379         *hi = begin;
380         return 0;
381 }
382
383 static const struct applesmc_entry *applesmc_get_entry_by_key(const char *key)
384 {
385         int begin, end;
386         int ret;
387
388         ret = applesmc_get_lower_bound(&begin, key);
389         if (ret)
390                 return ERR_PTR(ret);
391         ret = applesmc_get_upper_bound(&end, key);
392         if (ret)
393                 return ERR_PTR(ret);
394         if (end - begin != 1)
395                 return ERR_PTR(-EINVAL);
396
397         return applesmc_get_entry_by_index(begin);
398 }
399
400 static int applesmc_read_key(const char *key, u8 *buffer, u8 len)
401 {
402         const struct applesmc_entry *entry;
403
404         entry = applesmc_get_entry_by_key(key);
405         if (IS_ERR(entry))
406                 return PTR_ERR(entry);
407
408         return applesmc_read_entry(entry, buffer, len);
409 }
410
411 static int applesmc_write_key(const char *key, const u8 *buffer, u8 len)
412 {
413         const struct applesmc_entry *entry;
414
415         entry = applesmc_get_entry_by_key(key);
416         if (IS_ERR(entry))
417                 return PTR_ERR(entry);
418
419         return applesmc_write_entry(entry, buffer, len);
420 }
421
422 static int applesmc_has_key(const char *key, bool *value)
423 {
424         const struct applesmc_entry *entry;
425
426         entry = applesmc_get_entry_by_key(key);
427         if (IS_ERR(entry) && PTR_ERR(entry) != -EINVAL)
428                 return PTR_ERR(entry);
429
430         *value = !IS_ERR(entry);
431         return 0;
432 }
433
434 /*
435  * applesmc_read_motion_sensor - Read motion sensor (X, Y or Z).
436  */
437 static int applesmc_read_motion_sensor(int index, s16 *value)
438 {
439         u8 buffer[2];
440         int ret;
441
442         switch (index) {
443         case SENSOR_X:
444                 ret = applesmc_read_key(MOTION_SENSOR_X_KEY, buffer, 2);
445                 break;
446         case SENSOR_Y:
447                 ret = applesmc_read_key(MOTION_SENSOR_Y_KEY, buffer, 2);
448                 break;
449         case SENSOR_Z:
450                 ret = applesmc_read_key(MOTION_SENSOR_Z_KEY, buffer, 2);
451                 break;
452         default:
453                 ret = -EINVAL;
454         }
455
456         *value = ((s16)buffer[0] << 8) | buffer[1];
457
458         return ret;
459 }
460
461 /*
462  * applesmc_device_init - initialize the accelerometer.  Can sleep.
463  */
464 static void applesmc_device_init(void)
465 {
466         int total;
467         u8 buffer[2];
468
469         if (!smcreg.has_accelerometer)
470                 return;
471
472         for (total = INIT_TIMEOUT_MSECS; total > 0; total -= INIT_WAIT_MSECS) {
473                 if (!applesmc_read_key(MOTION_SENSOR_KEY, buffer, 2) &&
474                                 (buffer[0] != 0x00 || buffer[1] != 0x00))
475                         return;
476                 buffer[0] = 0xe0;
477                 buffer[1] = 0x00;
478                 applesmc_write_key(MOTION_SENSOR_KEY, buffer, 2);
479                 msleep(INIT_WAIT_MSECS);
480         }
481
482         pr_warn("failed to init the device\n");
483 }
484
485 /*
486  * applesmc_init_smcreg_try - Try to initialize register cache. Idempotent.
487  */
488 static int applesmc_init_smcreg_try(void)
489 {
490         struct applesmc_registers *s = &smcreg;
491         bool left_light_sensor, right_light_sensor;
492         unsigned int count;
493         u8 tmp[1];
494         int ret;
495
496         if (s->init_complete)
497                 return 0;
498
499         ret = read_register_count(&count);
500         if (ret)
501                 return ret;
502
503         if (s->cache && s->key_count != count) {
504                 pr_warn("key count changed from %d to %d\n",
505                         s->key_count, count);
506                 kfree(s->cache);
507                 s->cache = NULL;
508         }
509         s->key_count = count;
510
511         if (!s->cache)
512                 s->cache = kcalloc(s->key_count, sizeof(*s->cache), GFP_KERNEL);
513         if (!s->cache)
514                 return -ENOMEM;
515
516         ret = applesmc_read_key(FANS_COUNT, tmp, 1);
517         if (ret)
518                 return ret;
519         s->fan_count = tmp[0];
520
521         ret = applesmc_get_lower_bound(&s->temp_begin, "T");
522         if (ret)
523                 return ret;
524         ret = applesmc_get_lower_bound(&s->temp_end, "U");
525         if (ret)
526                 return ret;
527         s->temp_count = s->temp_end - s->temp_begin;
528
529         ret = applesmc_has_key(LIGHT_SENSOR_LEFT_KEY, &left_light_sensor);
530         if (ret)
531                 return ret;
532         ret = applesmc_has_key(LIGHT_SENSOR_RIGHT_KEY, &right_light_sensor);
533         if (ret)
534                 return ret;
535         ret = applesmc_has_key(MOTION_SENSOR_KEY, &s->has_accelerometer);
536         if (ret)
537                 return ret;
538         ret = applesmc_has_key(BACKLIGHT_KEY, &s->has_key_backlight);
539         if (ret)
540                 return ret;
541
542         s->num_light_sensors = left_light_sensor + right_light_sensor;
543         s->init_complete = true;
544
545         pr_info("key=%d fan=%d temp=%d acc=%d lux=%d kbd=%d\n",
546                s->key_count, s->fan_count, s->temp_count,
547                s->has_accelerometer,
548                s->num_light_sensors,
549                s->has_key_backlight);
550
551         return 0;
552 }
553
554 /*
555  * applesmc_init_smcreg - Initialize register cache.
556  *
557  * Retries until initialization is successful, or the operation times out.
558  *
559  */
560 static int applesmc_init_smcreg(void)
561 {
562         int ms, ret;
563
564         for (ms = 0; ms < INIT_TIMEOUT_MSECS; ms += INIT_WAIT_MSECS) {
565                 ret = applesmc_init_smcreg_try();
566                 if (!ret) {
567                         if (ms)
568                                 pr_info("init_smcreg() took %d ms\n", ms);
569                         return 0;
570                 }
571                 msleep(INIT_WAIT_MSECS);
572         }
573
574         kfree(smcreg.cache);
575         smcreg.cache = NULL;
576
577         return ret;
578 }
579
580 static void applesmc_destroy_smcreg(void)
581 {
582         kfree(smcreg.cache);
583         smcreg.cache = NULL;
584         smcreg.init_complete = false;
585 }
586
587 /* Device model stuff */
588 static int applesmc_probe(struct platform_device *dev)
589 {
590         int ret;
591
592         ret = applesmc_init_smcreg();
593         if (ret)
594                 return ret;
595
596         applesmc_device_init();
597
598         return 0;
599 }
600
601 /* Synchronize device with memorized backlight state */
602 static int applesmc_pm_resume(struct device *dev)
603 {
604         if (smcreg.has_key_backlight)
605                 applesmc_write_key(BACKLIGHT_KEY, backlight_state, 2);
606         return 0;
607 }
608
609 /* Reinitialize device on resume from hibernation */
610 static int applesmc_pm_restore(struct device *dev)
611 {
612         applesmc_device_init();
613         return applesmc_pm_resume(dev);
614 }
615
616 static const struct dev_pm_ops applesmc_pm_ops = {
617         .resume = applesmc_pm_resume,
618         .restore = applesmc_pm_restore,
619 };
620
621 static struct platform_driver applesmc_driver = {
622         .probe = applesmc_probe,
623         .driver = {
624                 .name = "applesmc",
625                 .owner = THIS_MODULE,
626                 .pm = &applesmc_pm_ops,
627         },
628 };
629
630 /*
631  * applesmc_calibrate - Set our "resting" values.  Callers must
632  * hold applesmc_lock.
633  */
634 static void applesmc_calibrate(void)
635 {
636         applesmc_read_motion_sensor(SENSOR_X, &rest_x);
637         applesmc_read_motion_sensor(SENSOR_Y, &rest_y);
638         rest_x = -rest_x;
639 }
640
641 static void applesmc_idev_poll(struct input_polled_dev *dev)
642 {
643         struct input_dev *idev = dev->input;
644         s16 x, y;
645
646         if (applesmc_read_motion_sensor(SENSOR_X, &x))
647                 return;
648         if (applesmc_read_motion_sensor(SENSOR_Y, &y))
649                 return;
650
651         x = -x;
652         input_report_abs(idev, ABS_X, x - rest_x);
653         input_report_abs(idev, ABS_Y, y - rest_y);
654         input_sync(idev);
655 }
656
657 /* Sysfs Files */
658
659 static ssize_t applesmc_name_show(struct device *dev,
660                                    struct device_attribute *attr, char *buf)
661 {
662         return snprintf(buf, PAGE_SIZE, "applesmc\n");
663 }
664
665 static ssize_t applesmc_position_show(struct device *dev,
666                                    struct device_attribute *attr, char *buf)
667 {
668         int ret;
669         s16 x, y, z;
670
671         ret = applesmc_read_motion_sensor(SENSOR_X, &x);
672         if (ret)
673                 goto out;
674         ret = applesmc_read_motion_sensor(SENSOR_Y, &y);
675         if (ret)
676                 goto out;
677         ret = applesmc_read_motion_sensor(SENSOR_Z, &z);
678         if (ret)
679                 goto out;
680
681 out:
682         if (ret)
683                 return ret;
684         else
685                 return snprintf(buf, PAGE_SIZE, "(%d,%d,%d)\n", x, y, z);
686 }
687
688 static ssize_t applesmc_light_show(struct device *dev,
689                                 struct device_attribute *attr, char *sysfsbuf)
690 {
691         const struct applesmc_entry *entry;
692         static int data_length;
693         int ret;
694         u8 left = 0, right = 0;
695         u8 buffer[10];
696
697         if (!data_length) {
698                 entry = applesmc_get_entry_by_key(LIGHT_SENSOR_LEFT_KEY);
699                 if (IS_ERR(entry))
700                         return PTR_ERR(entry);
701                 if (entry->len > 10)
702                         return -ENXIO;
703                 data_length = entry->len;
704                 pr_info("light sensor data length set to %d\n", data_length);
705         }
706
707         ret = applesmc_read_key(LIGHT_SENSOR_LEFT_KEY, buffer, data_length);
708         /* newer macbooks report a single 10-bit bigendian value */
709         if (data_length == 10) {
710                 left = be16_to_cpu(*(__be16 *)(buffer + 6)) >> 2;
711                 goto out;
712         }
713         left = buffer[2];
714         if (ret)
715                 goto out;
716         ret = applesmc_read_key(LIGHT_SENSOR_RIGHT_KEY, buffer, data_length);
717         right = buffer[2];
718
719 out:
720         if (ret)
721                 return ret;
722         else
723                 return snprintf(sysfsbuf, PAGE_SIZE, "(%d,%d)\n", left, right);
724 }
725
726 /* Displays sensor key as label */
727 static ssize_t applesmc_show_sensor_label(struct device *dev,
728                         struct device_attribute *devattr, char *sysfsbuf)
729 {
730         int index = smcreg.temp_begin + to_index(devattr);
731         const struct applesmc_entry *entry;
732
733         entry = applesmc_get_entry_by_index(index);
734         if (IS_ERR(entry))
735                 return PTR_ERR(entry);
736
737         return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->key);
738 }
739
740 /* Displays degree Celsius * 1000 */
741 static ssize_t applesmc_show_temperature(struct device *dev,
742                         struct device_attribute *devattr, char *sysfsbuf)
743 {
744         int index = smcreg.temp_begin + to_index(devattr);
745         const struct applesmc_entry *entry;
746         int ret;
747         u8 buffer[2];
748         unsigned int temp;
749
750         entry = applesmc_get_entry_by_index(index);
751         if (IS_ERR(entry))
752                 return PTR_ERR(entry);
753         if (entry->len > 2)
754                 return -EINVAL;
755
756         ret = applesmc_read_entry(entry, buffer, entry->len);
757         if (ret)
758                 return ret;
759
760         if (entry->len == 2) {
761                 temp = buffer[0] * 1000;
762                 temp += (buffer[1] >> 6) * 250;
763         } else {
764                 temp = buffer[0] * 4000;
765         }
766
767         return snprintf(sysfsbuf, PAGE_SIZE, "%u\n", temp);
768 }
769
770 static ssize_t applesmc_show_fan_speed(struct device *dev,
771                                 struct device_attribute *attr, char *sysfsbuf)
772 {
773         int ret;
774         unsigned int speed = 0;
775         char newkey[5];
776         u8 buffer[2];
777
778         sprintf(newkey, fan_speed_fmt[to_option(attr)], to_index(attr));
779
780         ret = applesmc_read_key(newkey, buffer, 2);
781         speed = ((buffer[0] << 8 | buffer[1]) >> 2);
782
783         if (ret)
784                 return ret;
785         else
786                 return snprintf(sysfsbuf, PAGE_SIZE, "%u\n", speed);
787 }
788
789 static ssize_t applesmc_store_fan_speed(struct device *dev,
790                                         struct device_attribute *attr,
791                                         const char *sysfsbuf, size_t count)
792 {
793         int ret;
794         unsigned long speed;
795         char newkey[5];
796         u8 buffer[2];
797
798         if (strict_strtoul(sysfsbuf, 10, &speed) < 0 || speed >= 0x4000)
799                 return -EINVAL;         /* Bigger than a 14-bit value */
800
801         sprintf(newkey, fan_speed_fmt[to_option(attr)], to_index(attr));
802
803         buffer[0] = (speed >> 6) & 0xff;
804         buffer[1] = (speed << 2) & 0xff;
805         ret = applesmc_write_key(newkey, buffer, 2);
806
807         if (ret)
808                 return ret;
809         else
810                 return count;
811 }
812
813 static ssize_t applesmc_show_fan_manual(struct device *dev,
814                         struct device_attribute *attr, char *sysfsbuf)
815 {
816         int ret;
817         u16 manual = 0;
818         u8 buffer[2];
819
820         ret = applesmc_read_key(FANS_MANUAL, buffer, 2);
821         manual = ((buffer[0] << 8 | buffer[1]) >> to_index(attr)) & 0x01;
822
823         if (ret)
824                 return ret;
825         else
826                 return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", manual);
827 }
828
829 static ssize_t applesmc_store_fan_manual(struct device *dev,
830                                          struct device_attribute *attr,
831                                          const char *sysfsbuf, size_t count)
832 {
833         int ret;
834         u8 buffer[2];
835         unsigned long input;
836         u16 val;
837
838         if (strict_strtoul(sysfsbuf, 10, &input) < 0)
839                 return -EINVAL;
840
841         ret = applesmc_read_key(FANS_MANUAL, buffer, 2);
842         val = (buffer[0] << 8 | buffer[1]);
843         if (ret)
844                 goto out;
845
846         if (input)
847                 val = val | (0x01 << to_index(attr));
848         else
849                 val = val & ~(0x01 << to_index(attr));
850
851         buffer[0] = (val >> 8) & 0xFF;
852         buffer[1] = val & 0xFF;
853
854         ret = applesmc_write_key(FANS_MANUAL, buffer, 2);
855
856 out:
857         if (ret)
858                 return ret;
859         else
860                 return count;
861 }
862
863 static ssize_t applesmc_show_fan_position(struct device *dev,
864                                 struct device_attribute *attr, char *sysfsbuf)
865 {
866         int ret;
867         char newkey[5];
868         u8 buffer[17];
869
870         sprintf(newkey, FAN_ID_FMT, to_index(attr));
871
872         ret = applesmc_read_key(newkey, buffer, 16);
873         buffer[16] = 0;
874
875         if (ret)
876                 return ret;
877         else
878                 return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", buffer+4);
879 }
880
881 static ssize_t applesmc_calibrate_show(struct device *dev,
882                                 struct device_attribute *attr, char *sysfsbuf)
883 {
884         return snprintf(sysfsbuf, PAGE_SIZE, "(%d,%d)\n", rest_x, rest_y);
885 }
886
887 static ssize_t applesmc_calibrate_store(struct device *dev,
888         struct device_attribute *attr, const char *sysfsbuf, size_t count)
889 {
890         applesmc_calibrate();
891
892         return count;
893 }
894
895 static void applesmc_backlight_set(struct work_struct *work)
896 {
897         applesmc_write_key(BACKLIGHT_KEY, backlight_state, 2);
898 }
899 static DECLARE_WORK(backlight_work, &applesmc_backlight_set);
900
901 static void applesmc_brightness_set(struct led_classdev *led_cdev,
902                                                 enum led_brightness value)
903 {
904         int ret;
905
906         backlight_state[0] = value;
907         ret = queue_work(applesmc_led_wq, &backlight_work);
908
909         if (debug && (!ret))
910                 printk(KERN_DEBUG "applesmc: work was already on the queue.\n");
911 }
912
913 static ssize_t applesmc_key_count_show(struct device *dev,
914                                 struct device_attribute *attr, char *sysfsbuf)
915 {
916         int ret;
917         u8 buffer[4];
918         u32 count;
919
920         ret = applesmc_read_key(KEY_COUNT_KEY, buffer, 4);
921         count = ((u32)buffer[0]<<24) + ((u32)buffer[1]<<16) +
922                                                 ((u32)buffer[2]<<8) + buffer[3];
923
924         if (ret)
925                 return ret;
926         else
927                 return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", count);
928 }
929
930 static ssize_t applesmc_key_at_index_read_show(struct device *dev,
931                                 struct device_attribute *attr, char *sysfsbuf)
932 {
933         const struct applesmc_entry *entry;
934         int ret;
935
936         entry = applesmc_get_entry_by_index(key_at_index);
937         if (IS_ERR(entry))
938                 return PTR_ERR(entry);
939         ret = applesmc_read_entry(entry, sysfsbuf, entry->len);
940         if (ret)
941                 return ret;
942
943         return entry->len;
944 }
945
946 static ssize_t applesmc_key_at_index_data_length_show(struct device *dev,
947                                 struct device_attribute *attr, char *sysfsbuf)
948 {
949         const struct applesmc_entry *entry;
950
951         entry = applesmc_get_entry_by_index(key_at_index);
952         if (IS_ERR(entry))
953                 return PTR_ERR(entry);
954
955         return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", entry->len);
956 }
957
958 static ssize_t applesmc_key_at_index_type_show(struct device *dev,
959                                 struct device_attribute *attr, char *sysfsbuf)
960 {
961         const struct applesmc_entry *entry;
962
963         entry = applesmc_get_entry_by_index(key_at_index);
964         if (IS_ERR(entry))
965                 return PTR_ERR(entry);
966
967         return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->type);
968 }
969
970 static ssize_t applesmc_key_at_index_name_show(struct device *dev,
971                                 struct device_attribute *attr, char *sysfsbuf)
972 {
973         const struct applesmc_entry *entry;
974
975         entry = applesmc_get_entry_by_index(key_at_index);
976         if (IS_ERR(entry))
977                 return PTR_ERR(entry);
978
979         return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->key);
980 }
981
982 static ssize_t applesmc_key_at_index_show(struct device *dev,
983                                 struct device_attribute *attr, char *sysfsbuf)
984 {
985         return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", key_at_index);
986 }
987
988 static ssize_t applesmc_key_at_index_store(struct device *dev,
989         struct device_attribute *attr, const char *sysfsbuf, size_t count)
990 {
991         unsigned long newkey;
992
993         if (strict_strtoul(sysfsbuf, 10, &newkey) < 0
994             || newkey >= smcreg.key_count)
995                 return -EINVAL;
996
997         key_at_index = newkey;
998         return count;
999 }
1000
1001 static struct led_classdev applesmc_backlight = {
1002         .name                   = "smc::kbd_backlight",
1003         .default_trigger        = "nand-disk",
1004         .brightness_set         = applesmc_brightness_set,
1005 };
1006
1007 static struct applesmc_node_group info_group[] = {
1008         { "name", applesmc_name_show },
1009         { "key_count", applesmc_key_count_show },
1010         { "key_at_index", applesmc_key_at_index_show, applesmc_key_at_index_store },
1011         { "key_at_index_name", applesmc_key_at_index_name_show },
1012         { "key_at_index_type", applesmc_key_at_index_type_show },
1013         { "key_at_index_data_length", applesmc_key_at_index_data_length_show },
1014         { "key_at_index_data", applesmc_key_at_index_read_show },
1015         { }
1016 };
1017
1018 static struct applesmc_node_group accelerometer_group[] = {
1019         { "position", applesmc_position_show },
1020         { "calibrate", applesmc_calibrate_show, applesmc_calibrate_store },
1021         { }
1022 };
1023
1024 static struct applesmc_node_group light_sensor_group[] = {
1025         { "light", applesmc_light_show },
1026         { }
1027 };
1028
1029 static struct applesmc_node_group fan_group[] = {
1030         { "fan%d_label", applesmc_show_fan_position },
1031         { "fan%d_input", applesmc_show_fan_speed, NULL, 0 },
1032         { "fan%d_min", applesmc_show_fan_speed, applesmc_store_fan_speed, 1 },
1033         { "fan%d_max", applesmc_show_fan_speed, NULL, 2 },
1034         { "fan%d_safe", applesmc_show_fan_speed, NULL, 3 },
1035         { "fan%d_output", applesmc_show_fan_speed, applesmc_store_fan_speed, 4 },
1036         { "fan%d_manual", applesmc_show_fan_manual, applesmc_store_fan_manual },
1037         { }
1038 };
1039
1040 static struct applesmc_node_group temp_group[] = {
1041         { "temp%d_label", applesmc_show_sensor_label },
1042         { "temp%d_input", applesmc_show_temperature },
1043         { }
1044 };
1045
1046 /* Module stuff */
1047
1048 /*
1049  * applesmc_destroy_nodes - remove files and free associated memory
1050  */
1051 static void applesmc_destroy_nodes(struct applesmc_node_group *groups)
1052 {
1053         struct applesmc_node_group *grp;
1054         struct applesmc_dev_attr *node;
1055
1056         for (grp = groups; grp->nodes; grp++) {
1057                 for (node = grp->nodes; node->sda.dev_attr.attr.name; node++)
1058                         sysfs_remove_file(&pdev->dev.kobj,
1059                                           &node->sda.dev_attr.attr);
1060                 kfree(grp->nodes);
1061                 grp->nodes = NULL;
1062         }
1063 }
1064
1065 /*
1066  * applesmc_create_nodes - create a two-dimensional group of sysfs files
1067  */
1068 static int applesmc_create_nodes(struct applesmc_node_group *groups, int num)
1069 {
1070         struct applesmc_node_group *grp;
1071         struct applesmc_dev_attr *node;
1072         struct attribute *attr;
1073         int ret, i;
1074
1075         for (grp = groups; grp->format; grp++) {
1076                 grp->nodes = kcalloc(num + 1, sizeof(*node), GFP_KERNEL);
1077                 if (!grp->nodes) {
1078                         ret = -ENOMEM;
1079                         goto out;
1080                 }
1081                 for (i = 0; i < num; i++) {
1082                         node = &grp->nodes[i];
1083                         sprintf(node->name, grp->format, i + 1);
1084                         node->sda.index = (grp->option << 16) | (i & 0xffff);
1085                         node->sda.dev_attr.show = grp->show;
1086                         node->sda.dev_attr.store = grp->store;
1087                         attr = &node->sda.dev_attr.attr;
1088                         sysfs_attr_init(attr);
1089                         attr->name = node->name;
1090                         attr->mode = S_IRUGO | (grp->store ? S_IWUSR : 0);
1091                         ret = sysfs_create_file(&pdev->dev.kobj, attr);
1092                         if (ret) {
1093                                 attr->name = NULL;
1094                                 goto out;
1095                         }
1096                 }
1097         }
1098
1099         return 0;
1100 out:
1101         applesmc_destroy_nodes(groups);
1102         return ret;
1103 }
1104
1105 /* Create accelerometer ressources */
1106 static int applesmc_create_accelerometer(void)
1107 {
1108         struct input_dev *idev;
1109         int ret;
1110
1111         if (!smcreg.has_accelerometer)
1112                 return 0;
1113
1114         ret = applesmc_create_nodes(accelerometer_group, 1);
1115         if (ret)
1116                 goto out;
1117
1118         applesmc_idev = input_allocate_polled_device();
1119         if (!applesmc_idev) {
1120                 ret = -ENOMEM;
1121                 goto out_sysfs;
1122         }
1123
1124         applesmc_idev->poll = applesmc_idev_poll;
1125         applesmc_idev->poll_interval = APPLESMC_POLL_INTERVAL;
1126
1127         /* initial calibrate for the input device */
1128         applesmc_calibrate();
1129
1130         /* initialize the input device */
1131         idev = applesmc_idev->input;
1132         idev->name = "applesmc";
1133         idev->id.bustype = BUS_HOST;
1134         idev->dev.parent = &pdev->dev;
1135         idev->evbit[0] = BIT_MASK(EV_ABS);
1136         input_set_abs_params(idev, ABS_X,
1137                         -256, 256, APPLESMC_INPUT_FUZZ, APPLESMC_INPUT_FLAT);
1138         input_set_abs_params(idev, ABS_Y,
1139                         -256, 256, APPLESMC_INPUT_FUZZ, APPLESMC_INPUT_FLAT);
1140
1141         ret = input_register_polled_device(applesmc_idev);
1142         if (ret)
1143                 goto out_idev;
1144
1145         return 0;
1146
1147 out_idev:
1148         input_free_polled_device(applesmc_idev);
1149
1150 out_sysfs:
1151         applesmc_destroy_nodes(accelerometer_group);
1152
1153 out:
1154         pr_warn("driver init failed (ret=%d)!\n", ret);
1155         return ret;
1156 }
1157
1158 /* Release all ressources used by the accelerometer */
1159 static void applesmc_release_accelerometer(void)
1160 {
1161         if (!smcreg.has_accelerometer)
1162                 return;
1163         input_unregister_polled_device(applesmc_idev);
1164         input_free_polled_device(applesmc_idev);
1165         applesmc_destroy_nodes(accelerometer_group);
1166 }
1167
1168 static int applesmc_create_light_sensor(void)
1169 {
1170         if (!smcreg.num_light_sensors)
1171                 return 0;
1172         return applesmc_create_nodes(light_sensor_group, 1);
1173 }
1174
1175 static void applesmc_release_light_sensor(void)
1176 {
1177         if (!smcreg.num_light_sensors)
1178                 return;
1179         applesmc_destroy_nodes(light_sensor_group);
1180 }
1181
1182 static int applesmc_create_key_backlight(void)
1183 {
1184         if (!smcreg.has_key_backlight)
1185                 return 0;
1186         applesmc_led_wq = create_singlethread_workqueue("applesmc-led");
1187         if (!applesmc_led_wq)
1188                 return -ENOMEM;
1189         return led_classdev_register(&pdev->dev, &applesmc_backlight);
1190 }
1191
1192 static void applesmc_release_key_backlight(void)
1193 {
1194         if (!smcreg.has_key_backlight)
1195                 return;
1196         led_classdev_unregister(&applesmc_backlight);
1197         destroy_workqueue(applesmc_led_wq);
1198 }
1199
1200 static int applesmc_dmi_match(const struct dmi_system_id *id)
1201 {
1202         return 1;
1203 }
1204
1205 /* Note that DMI_MATCH(...,"MacBook") will match "MacBookPro1,1".
1206  * So we need to put "Apple MacBook Pro" before "Apple MacBook". */
1207 static __initdata struct dmi_system_id applesmc_whitelist[] = {
1208         { applesmc_dmi_match, "Apple MacBook Air", {
1209           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1210           DMI_MATCH(DMI_PRODUCT_NAME, "MacBookAir") },
1211         },
1212         { applesmc_dmi_match, "Apple MacBook Pro", {
1213           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1214           DMI_MATCH(DMI_PRODUCT_NAME, "MacBookPro") },
1215         },
1216         { applesmc_dmi_match, "Apple MacBook", {
1217           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1218           DMI_MATCH(DMI_PRODUCT_NAME, "MacBook") },
1219         },
1220         { applesmc_dmi_match, "Apple Macmini", {
1221           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1222           DMI_MATCH(DMI_PRODUCT_NAME, "Macmini") },
1223         },
1224         { applesmc_dmi_match, "Apple MacPro", {
1225           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1226           DMI_MATCH(DMI_PRODUCT_NAME, "MacPro") },
1227         },
1228         { applesmc_dmi_match, "Apple iMac", {
1229           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1230           DMI_MATCH(DMI_PRODUCT_NAME, "iMac") },
1231         },
1232         { .ident = NULL }
1233 };
1234
1235 static int __init applesmc_init(void)
1236 {
1237         int ret;
1238
1239         if (!dmi_check_system(applesmc_whitelist)) {
1240                 pr_warn("supported laptop not found!\n");
1241                 ret = -ENODEV;
1242                 goto out;
1243         }
1244
1245         if (!request_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS,
1246                                                                 "applesmc")) {
1247                 ret = -ENXIO;
1248                 goto out;
1249         }
1250
1251         ret = platform_driver_register(&applesmc_driver);
1252         if (ret)
1253                 goto out_region;
1254
1255         pdev = platform_device_register_simple("applesmc", APPLESMC_DATA_PORT,
1256                                                NULL, 0);
1257         if (IS_ERR(pdev)) {
1258                 ret = PTR_ERR(pdev);
1259                 goto out_driver;
1260         }
1261
1262         /* create register cache */
1263         ret = applesmc_init_smcreg();
1264         if (ret)
1265                 goto out_device;
1266
1267         ret = applesmc_create_nodes(info_group, 1);
1268         if (ret)
1269                 goto out_smcreg;
1270
1271         ret = applesmc_create_nodes(fan_group, smcreg.fan_count);
1272         if (ret)
1273                 goto out_info;
1274
1275         ret = applesmc_create_nodes(temp_group, smcreg.temp_count);
1276         if (ret)
1277                 goto out_fans;
1278
1279         ret = applesmc_create_accelerometer();
1280         if (ret)
1281                 goto out_temperature;
1282
1283         ret = applesmc_create_light_sensor();
1284         if (ret)
1285                 goto out_accelerometer;
1286
1287         ret = applesmc_create_key_backlight();
1288         if (ret)
1289                 goto out_light_sysfs;
1290
1291         hwmon_dev = hwmon_device_register(&pdev->dev);
1292         if (IS_ERR(hwmon_dev)) {
1293                 ret = PTR_ERR(hwmon_dev);
1294                 goto out_light_ledclass;
1295         }
1296
1297         return 0;
1298
1299 out_light_ledclass:
1300         applesmc_release_key_backlight();
1301 out_light_sysfs:
1302         applesmc_release_light_sensor();
1303 out_accelerometer:
1304         applesmc_release_accelerometer();
1305 out_temperature:
1306         applesmc_destroy_nodes(temp_group);
1307 out_fans:
1308         applesmc_destroy_nodes(fan_group);
1309 out_info:
1310         applesmc_destroy_nodes(info_group);
1311 out_smcreg:
1312         applesmc_destroy_smcreg();
1313 out_device:
1314         platform_device_unregister(pdev);
1315 out_driver:
1316         platform_driver_unregister(&applesmc_driver);
1317 out_region:
1318         release_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS);
1319 out:
1320         pr_warn("driver init failed (ret=%d)!\n", ret);
1321         return ret;
1322 }
1323
1324 static void __exit applesmc_exit(void)
1325 {
1326         hwmon_device_unregister(hwmon_dev);
1327         applesmc_release_key_backlight();
1328         applesmc_release_light_sensor();
1329         applesmc_release_accelerometer();
1330         applesmc_destroy_nodes(temp_group);
1331         applesmc_destroy_nodes(fan_group);
1332         applesmc_destroy_nodes(info_group);
1333         applesmc_destroy_smcreg();
1334         platform_device_unregister(pdev);
1335         platform_driver_unregister(&applesmc_driver);
1336         release_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS);
1337 }
1338
1339 module_init(applesmc_init);
1340 module_exit(applesmc_exit);
1341
1342 MODULE_AUTHOR("Nicolas Boichat");
1343 MODULE_DESCRIPTION("Apple SMC");
1344 MODULE_LICENSE("GPL v2");
1345 MODULE_DEVICE_TABLE(dmi, applesmc_whitelist);