thinkpad-acpi: improve Kconfig help text
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / platform / x86 / acerhdf.c
blob4d922e42bcd7078f9f6661df16003876e7068442
1 /*
2 * acerhdf - A driver which monitors the temperature
3 * of the aspire one netbook, turns on/off the fan
4 * as soon as the upper/lower threshold is reached.
6 * (C) 2009 - Peter Feuerer peter (a) piie.net
7 * http://piie.net
8 * 2009 Borislav Petkov <petkovbb@gmail.com>
10 * Inspired by and many thanks to:
11 * o acerfand - Rachel Greenham
12 * o acer_ec.pl - Michael Kurz michi.kurz (at) googlemail.com
13 * - Petr Tomasek tomasek (#) etf,cuni,cz
14 * - Carlos Corbacho cathectic (at) gmail.com
15 * o lkml - Matthew Garrett
16 * - Borislav Petkov
17 * - Andreas Mohr
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #define pr_fmt(fmt) "acerhdf: " fmt
36 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/fs.h>
39 #include <linux/dmi.h>
40 #include <acpi/acpi_drivers.h>
41 #include <linux/sched.h>
42 #include <linux/thermal.h>
43 #include <linux/platform_device.h>
46 * The driver is started with "kernel mode off" by default. That means, the BIOS
47 * is still in control of the fan. In this mode the driver allows to read the
48 * temperature of the cpu and a userspace tool may take over control of the fan.
49 * If the driver is switched to "kernel mode" (e.g. via module parameter) the
50 * driver is in full control of the fan. If you want the module to be started in
51 * kernel mode by default, define the following:
53 #undef START_IN_KERNEL_MODE
55 #define DRV_VER "0.5.20"
58 * According to the Atom N270 datasheet,
59 * (http://download.intel.com/design/processor/datashts/320032.pdf) the
60 * CPU's optimal operating limits denoted in junction temperature as
61 * measured by the on-die thermal monitor are within 0 <= Tj <= 90. So,
62 * assume 89°C is critical temperature.
64 #define ACERHDF_TEMP_CRIT 89000
65 #define ACERHDF_FAN_OFF 0
66 #define ACERHDF_FAN_AUTO 1
69 * No matter what value the user puts into the fanon variable, turn on the fan
70 * at 80 degree Celsius to prevent hardware damage
72 #define ACERHDF_MAX_FANON 80000
75 * Maximum interval between two temperature checks is 15 seconds, as the die
76 * can get hot really fast under heavy load (plus we shouldn't forget about
77 * possible impact of _external_ aggressive sources such as heaters, sun etc.)
79 #define ACERHDF_MAX_INTERVAL 15
81 #ifdef START_IN_KERNEL_MODE
82 static int kernelmode = 1;
83 #else
84 static int kernelmode;
85 #endif
87 static unsigned int interval = 10;
88 static unsigned int fanon = 63000;
89 static unsigned int fanoff = 58000;
90 static unsigned int verbose;
91 static unsigned int fanstate = ACERHDF_FAN_AUTO;
92 static char force_bios[16];
93 static char force_product[16];
94 static unsigned int prev_interval;
95 struct thermal_zone_device *thz_dev;
96 struct thermal_cooling_device *cl_dev;
97 struct platform_device *acerhdf_dev;
99 module_param(kernelmode, uint, 0);
100 MODULE_PARM_DESC(kernelmode, "Kernel mode fan control on / off");
101 module_param(interval, uint, 0600);
102 MODULE_PARM_DESC(interval, "Polling interval of temperature check");
103 module_param(fanon, uint, 0600);
104 MODULE_PARM_DESC(fanon, "Turn the fan on above this temperature");
105 module_param(fanoff, uint, 0600);
106 MODULE_PARM_DESC(fanoff, "Turn the fan off below this temperature");
107 module_param(verbose, uint, 0600);
108 MODULE_PARM_DESC(verbose, "Enable verbose dmesg output");
109 module_param_string(force_bios, force_bios, 16, 0);
110 MODULE_PARM_DESC(force_bios, "Force BIOS version and omit BIOS check");
111 module_param_string(force_product, force_product, 16, 0);
112 MODULE_PARM_DESC(force_product, "Force BIOS product and omit BIOS check");
115 * cmd_off: to switch the fan completely off
116 * chk_off: to check if the fan is off
117 * cmd_auto: to set the BIOS in control of the fan. The BIOS regulates then
118 * the fan speed depending on the temperature
120 struct fancmd {
121 u8 cmd_off;
122 u8 chk_off;
123 u8 cmd_auto;
126 /* BIOS settings */
127 struct bios_settings_t {
128 const char *vendor;
129 const char *product;
130 const char *version;
131 unsigned char fanreg;
132 unsigned char tempreg;
133 struct fancmd cmd;
136 /* Register addresses and values for different BIOS versions */
137 static const struct bios_settings_t bios_tbl[] = {
138 /* AOA110 */
139 {"Acer", "AOA110", "v0.3109", 0x55, 0x58, {0x1f, 0x1f, 0x00} },
140 {"Acer", "AOA110", "v0.3114", 0x55, 0x58, {0x1f, 0x1f, 0x00} },
141 {"Acer", "AOA110", "v0.3301", 0x55, 0x58, {0xaf, 0xaf, 0x00} },
142 {"Acer", "AOA110", "v0.3304", 0x55, 0x58, {0xaf, 0xaf, 0x00} },
143 {"Acer", "AOA110", "v0.3305", 0x55, 0x58, {0xaf, 0xaf, 0x00} },
144 {"Acer", "AOA110", "v0.3307", 0x55, 0x58, {0xaf, 0xaf, 0x00} },
145 {"Acer", "AOA110", "v0.3308", 0x55, 0x58, {0x21, 0x21, 0x00} },
146 {"Acer", "AOA110", "v0.3309", 0x55, 0x58, {0x21, 0x21, 0x00} },
147 {"Acer", "AOA110", "v0.3310", 0x55, 0x58, {0x21, 0x21, 0x00} },
148 /* AOA150 */
149 {"Acer", "AOA150", "v0.3114", 0x55, 0x58, {0x20, 0x20, 0x00} },
150 {"Acer", "AOA150", "v0.3301", 0x55, 0x58, {0x20, 0x20, 0x00} },
151 {"Acer", "AOA150", "v0.3304", 0x55, 0x58, {0x20, 0x20, 0x00} },
152 {"Acer", "AOA150", "v0.3305", 0x55, 0x58, {0x20, 0x20, 0x00} },
153 {"Acer", "AOA150", "v0.3307", 0x55, 0x58, {0x20, 0x20, 0x00} },
154 {"Acer", "AOA150", "v0.3308", 0x55, 0x58, {0x20, 0x20, 0x00} },
155 {"Acer", "AOA150", "v0.3309", 0x55, 0x58, {0x20, 0x20, 0x00} },
156 {"Acer", "AOA150", "v0.3310", 0x55, 0x58, {0x20, 0x20, 0x00} },
157 /* Acer 1410 */
158 {"Acer", "Aspire 1410", "v0.3120", 0x55, 0x58, {0x9e, 0x9e, 0x00} },
159 /* special BIOS / other */
160 {"Gateway", "AOA110", "v0.3103", 0x55, 0x58, {0x21, 0x21, 0x00} },
161 {"Gateway", "AOA150", "v0.3103", 0x55, 0x58, {0x20, 0x20, 0x00} },
162 {"Gateway ", "LT31 ", "v1.3103 ", 0x55, 0x58,
163 {0x10, 0x0f, 0x00} },
164 {"Gateway ", "LT31 ", "v1.3201 ", 0x55, 0x58,
165 {0x10, 0x0f, 0x00} },
166 {"Gateway ", "LT31 ", "v1.3302 ", 0x55, 0x58,
167 {0x10, 0x0f, 0x00} },
168 {"Packard Bell", "DOA150", "v0.3104", 0x55, 0x58, {0x21, 0x21, 0x00} },
169 {"Packard Bell", "DOA150", "v0.3105", 0x55, 0x58, {0x20, 0x20, 0x00} },
170 {"Packard Bell", "AOA110", "v0.3105", 0x55, 0x58, {0x21, 0x21, 0x00} },
171 {"Packard Bell", "AOA150", "v0.3105", 0x55, 0x58, {0x20, 0x20, 0x00} },
172 /* pewpew-terminator */
173 {"", "", "", 0, 0, {0, 0, 0} }
176 static const struct bios_settings_t *bios_cfg __read_mostly;
178 static int acerhdf_get_temp(int *temp)
180 u8 read_temp;
182 if (ec_read(bios_cfg->tempreg, &read_temp))
183 return -EINVAL;
185 *temp = read_temp * 1000;
187 return 0;
190 static int acerhdf_get_fanstate(int *state)
192 u8 fan;
194 if (ec_read(bios_cfg->fanreg, &fan))
195 return -EINVAL;
197 if (fan != bios_cfg->cmd.chk_off)
198 *state = ACERHDF_FAN_AUTO;
199 else
200 *state = ACERHDF_FAN_OFF;
202 return 0;
205 static void acerhdf_change_fanstate(int state)
207 unsigned char cmd;
209 if (verbose)
210 pr_notice("fan %s\n", (state == ACERHDF_FAN_OFF) ?
211 "OFF" : "ON");
213 if ((state != ACERHDF_FAN_OFF) && (state != ACERHDF_FAN_AUTO)) {
214 pr_err("invalid fan state %d requested, setting to auto!\n",
215 state);
216 state = ACERHDF_FAN_AUTO;
219 cmd = (state == ACERHDF_FAN_OFF) ? bios_cfg->cmd.cmd_off
220 : bios_cfg->cmd.cmd_auto;
221 fanstate = state;
223 ec_write(bios_cfg->fanreg, cmd);
226 static void acerhdf_check_param(struct thermal_zone_device *thermal)
228 if (fanon > ACERHDF_MAX_FANON) {
229 pr_err("fanon temperature too high, set to %d\n",
230 ACERHDF_MAX_FANON);
231 fanon = ACERHDF_MAX_FANON;
234 if (kernelmode && prev_interval != interval) {
235 if (interval > ACERHDF_MAX_INTERVAL) {
236 pr_err("interval too high, set to %d\n",
237 ACERHDF_MAX_INTERVAL);
238 interval = ACERHDF_MAX_INTERVAL;
240 if (verbose)
241 pr_notice("interval changed to: %d\n",
242 interval);
243 thermal->polling_delay = interval*1000;
244 prev_interval = interval;
249 * This is the thermal zone callback which does the delayed polling of the fan
250 * state. We do check /sysfs-originating settings here in acerhdf_check_param()
251 * as late as the polling interval is since we can't do that in the respective
252 * accessors of the module parameters.
254 static int acerhdf_get_ec_temp(struct thermal_zone_device *thermal,
255 unsigned long *t)
257 int temp, err = 0;
259 acerhdf_check_param(thermal);
261 err = acerhdf_get_temp(&temp);
262 if (err)
263 return err;
265 if (verbose)
266 pr_notice("temp %d\n", temp);
268 *t = temp;
269 return 0;
272 static int acerhdf_bind(struct thermal_zone_device *thermal,
273 struct thermal_cooling_device *cdev)
275 /* if the cooling device is the one from acerhdf bind it */
276 if (cdev != cl_dev)
277 return 0;
279 if (thermal_zone_bind_cooling_device(thermal, 0, cdev)) {
280 pr_err("error binding cooling dev\n");
281 return -EINVAL;
283 return 0;
286 static int acerhdf_unbind(struct thermal_zone_device *thermal,
287 struct thermal_cooling_device *cdev)
289 if (cdev != cl_dev)
290 return 0;
292 if (thermal_zone_unbind_cooling_device(thermal, 0, cdev)) {
293 pr_err("error unbinding cooling dev\n");
294 return -EINVAL;
296 return 0;
299 static inline void acerhdf_revert_to_bios_mode(void)
301 acerhdf_change_fanstate(ACERHDF_FAN_AUTO);
302 kernelmode = 0;
303 if (thz_dev)
304 thz_dev->polling_delay = 0;
305 pr_notice("kernel mode fan control OFF\n");
307 static inline void acerhdf_enable_kernelmode(void)
309 kernelmode = 1;
311 thz_dev->polling_delay = interval*1000;
312 thermal_zone_device_update(thz_dev);
313 pr_notice("kernel mode fan control ON\n");
316 static int acerhdf_get_mode(struct thermal_zone_device *thermal,
317 enum thermal_device_mode *mode)
319 if (verbose)
320 pr_notice("kernel mode fan control %d\n", kernelmode);
322 *mode = (kernelmode) ? THERMAL_DEVICE_ENABLED
323 : THERMAL_DEVICE_DISABLED;
325 return 0;
329 * set operation mode;
330 * enabled: the thermal layer of the kernel takes care about
331 * the temperature and the fan.
332 * disabled: the BIOS takes control of the fan.
334 static int acerhdf_set_mode(struct thermal_zone_device *thermal,
335 enum thermal_device_mode mode)
337 if (mode == THERMAL_DEVICE_DISABLED && kernelmode)
338 acerhdf_revert_to_bios_mode();
339 else if (mode == THERMAL_DEVICE_ENABLED && !kernelmode)
340 acerhdf_enable_kernelmode();
342 return 0;
345 static int acerhdf_get_trip_type(struct thermal_zone_device *thermal, int trip,
346 enum thermal_trip_type *type)
348 if (trip == 0)
349 *type = THERMAL_TRIP_ACTIVE;
351 return 0;
354 static int acerhdf_get_trip_temp(struct thermal_zone_device *thermal, int trip,
355 unsigned long *temp)
357 if (trip == 0)
358 *temp = fanon;
360 return 0;
363 static int acerhdf_get_crit_temp(struct thermal_zone_device *thermal,
364 unsigned long *temperature)
366 *temperature = ACERHDF_TEMP_CRIT;
367 return 0;
370 /* bind callback functions to thermalzone */
371 struct thermal_zone_device_ops acerhdf_dev_ops = {
372 .bind = acerhdf_bind,
373 .unbind = acerhdf_unbind,
374 .get_temp = acerhdf_get_ec_temp,
375 .get_mode = acerhdf_get_mode,
376 .set_mode = acerhdf_set_mode,
377 .get_trip_type = acerhdf_get_trip_type,
378 .get_trip_temp = acerhdf_get_trip_temp,
379 .get_crit_temp = acerhdf_get_crit_temp,
384 * cooling device callback functions
385 * get maximal fan cooling state
387 static int acerhdf_get_max_state(struct thermal_cooling_device *cdev,
388 unsigned long *state)
390 *state = 1;
392 return 0;
395 static int acerhdf_get_cur_state(struct thermal_cooling_device *cdev,
396 unsigned long *state)
398 int err = 0, tmp;
400 err = acerhdf_get_fanstate(&tmp);
401 if (err)
402 return err;
404 *state = (tmp == ACERHDF_FAN_AUTO) ? 1 : 0;
405 return 0;
408 /* change current fan state - is overwritten when running in kernel mode */
409 static int acerhdf_set_cur_state(struct thermal_cooling_device *cdev,
410 unsigned long state)
412 int cur_temp, cur_state, err = 0;
414 if (!kernelmode)
415 return 0;
417 err = acerhdf_get_temp(&cur_temp);
418 if (err) {
419 pr_err("error reading temperature, hand off control to BIOS\n");
420 goto err_out;
423 err = acerhdf_get_fanstate(&cur_state);
424 if (err) {
425 pr_err("error reading fan state, hand off control to BIOS\n");
426 goto err_out;
429 if (state == 0) {
430 /* turn fan off only if below fanoff temperature */
431 if ((cur_state == ACERHDF_FAN_AUTO) &&
432 (cur_temp < fanoff))
433 acerhdf_change_fanstate(ACERHDF_FAN_OFF);
434 } else {
435 if (cur_state == ACERHDF_FAN_OFF)
436 acerhdf_change_fanstate(ACERHDF_FAN_AUTO);
438 return 0;
440 err_out:
441 acerhdf_revert_to_bios_mode();
442 return -EINVAL;
445 /* bind fan callbacks to fan device */
446 struct thermal_cooling_device_ops acerhdf_cooling_ops = {
447 .get_max_state = acerhdf_get_max_state,
448 .get_cur_state = acerhdf_get_cur_state,
449 .set_cur_state = acerhdf_set_cur_state,
452 /* suspend / resume functionality */
453 static int acerhdf_suspend(struct device *dev)
455 if (kernelmode)
456 acerhdf_change_fanstate(ACERHDF_FAN_AUTO);
458 if (verbose)
459 pr_notice("going suspend\n");
461 return 0;
464 static int __devinit acerhdf_probe(struct platform_device *device)
466 return 0;
469 static int acerhdf_remove(struct platform_device *device)
471 return 0;
474 static struct dev_pm_ops acerhdf_pm_ops = {
475 .suspend = acerhdf_suspend,
476 .freeze = acerhdf_suspend,
479 static struct platform_driver acerhdf_driver = {
480 .driver = {
481 .name = "acerhdf",
482 .owner = THIS_MODULE,
483 .pm = &acerhdf_pm_ops,
485 .probe = acerhdf_probe,
486 .remove = acerhdf_remove,
490 /* check hardware */
491 static int acerhdf_check_hardware(void)
493 char const *vendor, *version, *product;
494 int i;
495 unsigned long prod_len = 0;
497 /* get BIOS data */
498 vendor = dmi_get_system_info(DMI_SYS_VENDOR);
499 version = dmi_get_system_info(DMI_BIOS_VERSION);
500 product = dmi_get_system_info(DMI_PRODUCT_NAME);
503 pr_info("Acer Aspire One Fan driver, v.%s\n", DRV_VER);
505 if (force_bios[0]) {
506 version = force_bios;
507 pr_info("forcing BIOS version: %s\n", version);
508 kernelmode = 0;
511 if (force_product[0]) {
512 product = force_product;
513 pr_info("forcing BIOS product: %s\n", product);
514 kernelmode = 0;
517 prod_len = strlen(product);
519 if (verbose)
520 pr_info("BIOS info: %s %s, product: %s\n",
521 vendor, version, product);
523 /* search BIOS version and vendor in BIOS settings table */
524 for (i = 0; bios_tbl[i].version[0]; i++) {
525 if (strlen(bios_tbl[i].product) >= prod_len &&
526 !strncmp(bios_tbl[i].product, product,
527 strlen(bios_tbl[i].product)) &&
528 !strcmp(bios_tbl[i].vendor, vendor) &&
529 !strcmp(bios_tbl[i].version, version)) {
530 bios_cfg = &bios_tbl[i];
531 break;
535 if (!bios_cfg) {
536 pr_err("unknown (unsupported) BIOS version %s/%s/%s, "
537 "please report, aborting!\n", vendor, product, version);
538 return -EINVAL;
542 * if started with kernel mode off, prevent the kernel from switching
543 * off the fan
545 if (!kernelmode) {
546 pr_notice("Fan control off, to enable do:\n");
547 pr_notice("echo -n \"enabled\" > "
548 "/sys/class/thermal/thermal_zone0/mode\n");
551 return 0;
554 static int acerhdf_register_platform(void)
556 int err = 0;
558 err = platform_driver_register(&acerhdf_driver);
559 if (err)
560 return err;
562 acerhdf_dev = platform_device_alloc("acerhdf", -1);
563 platform_device_add(acerhdf_dev);
565 return 0;
568 static void acerhdf_unregister_platform(void)
570 if (!acerhdf_dev)
571 return;
573 platform_device_del(acerhdf_dev);
574 platform_driver_unregister(&acerhdf_driver);
577 static int acerhdf_register_thermal(void)
579 cl_dev = thermal_cooling_device_register("acerhdf-fan", NULL,
580 &acerhdf_cooling_ops);
582 if (IS_ERR(cl_dev))
583 return -EINVAL;
585 thz_dev = thermal_zone_device_register("acerhdf", 1, NULL,
586 &acerhdf_dev_ops, 0, 0, 0,
587 (kernelmode) ? interval*1000 : 0);
588 if (IS_ERR(thz_dev))
589 return -EINVAL;
591 return 0;
594 static void acerhdf_unregister_thermal(void)
596 if (cl_dev) {
597 thermal_cooling_device_unregister(cl_dev);
598 cl_dev = NULL;
601 if (thz_dev) {
602 thermal_zone_device_unregister(thz_dev);
603 thz_dev = NULL;
607 static int __init acerhdf_init(void)
609 int err = 0;
611 err = acerhdf_check_hardware();
612 if (err)
613 goto out_err;
615 err = acerhdf_register_platform();
616 if (err)
617 goto err_unreg;
619 err = acerhdf_register_thermal();
620 if (err)
621 goto err_unreg;
623 return 0;
625 err_unreg:
626 acerhdf_unregister_thermal();
627 acerhdf_unregister_platform();
629 out_err:
630 return -ENODEV;
633 static void __exit acerhdf_exit(void)
635 acerhdf_change_fanstate(ACERHDF_FAN_AUTO);
636 acerhdf_unregister_thermal();
637 acerhdf_unregister_platform();
640 MODULE_LICENSE("GPL");
641 MODULE_AUTHOR("Peter Feuerer");
642 MODULE_DESCRIPTION("Aspire One temperature and fan driver");
643 MODULE_ALIAS("dmi:*:*Acer*:pnAOA*:");
644 MODULE_ALIAS("dmi:*:*Gateway*:pnAOA*:");
645 MODULE_ALIAS("dmi:*:*Packard Bell*:pnAOA*:");
646 MODULE_ALIAS("dmi:*:*Packard Bell*:pnDOA*:");
648 module_init(acerhdf_init);
649 module_exit(acerhdf_exit);