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
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
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>
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.23"
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;
84 static int kernelmode
;
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 and check if the fan is off
116 * cmd_auto: to set the BIOS in control of the fan. The BIOS regulates then
117 * the fan speed depending on the temperature
125 struct bios_settings_t
{
129 unsigned char fanreg
;
130 unsigned char tempreg
;
134 /* Register addresses and values for different BIOS versions */
135 static const struct bios_settings_t bios_tbl
[] = {
137 {"Acer", "AOA110", "v0.3109", 0x55, 0x58, {0x1f, 0x00} },
138 {"Acer", "AOA110", "v0.3114", 0x55, 0x58, {0x1f, 0x00} },
139 {"Acer", "AOA110", "v0.3301", 0x55, 0x58, {0xaf, 0x00} },
140 {"Acer", "AOA110", "v0.3304", 0x55, 0x58, {0xaf, 0x00} },
141 {"Acer", "AOA110", "v0.3305", 0x55, 0x58, {0xaf, 0x00} },
142 {"Acer", "AOA110", "v0.3307", 0x55, 0x58, {0xaf, 0x00} },
143 {"Acer", "AOA110", "v0.3308", 0x55, 0x58, {0x21, 0x00} },
144 {"Acer", "AOA110", "v0.3309", 0x55, 0x58, {0x21, 0x00} },
145 {"Acer", "AOA110", "v0.3310", 0x55, 0x58, {0x21, 0x00} },
147 {"Acer", "AOA150", "v0.3114", 0x55, 0x58, {0x1f, 0x00} },
148 {"Acer", "AOA150", "v0.3301", 0x55, 0x58, {0x20, 0x00} },
149 {"Acer", "AOA150", "v0.3304", 0x55, 0x58, {0x20, 0x00} },
150 {"Acer", "AOA150", "v0.3305", 0x55, 0x58, {0x20, 0x00} },
151 {"Acer", "AOA150", "v0.3307", 0x55, 0x58, {0x20, 0x00} },
152 {"Acer", "AOA150", "v0.3308", 0x55, 0x58, {0x20, 0x00} },
153 {"Acer", "AOA150", "v0.3309", 0x55, 0x58, {0x20, 0x00} },
154 {"Acer", "AOA150", "v0.3310", 0x55, 0x58, {0x20, 0x00} },
156 {"Acer", "Aspire 1410", "v0.3115", 0x55, 0x58, {0x9e, 0x00} },
157 {"Acer", "Aspire 1410", "v0.3120", 0x55, 0x58, {0x9e, 0x00} },
158 {"Acer", "Aspire 1410", "v1.3303", 0x55, 0x58, {0x9e, 0x00} },
160 {"Acer", "Aspire 1810TZ", "v0.3115", 0x55, 0x58, {0x9e, 0x00} },
161 {"Acer", "Aspire 1810T", "v0.3115", 0x55, 0x58, {0x9e, 0x00} },
162 {"Acer", "Aspire 1810TZ", "v0.3119", 0x55, 0x58, {0x9e, 0x00} },
163 {"Acer", "Aspire 1810T", "v0.3119", 0x55, 0x58, {0x9e, 0x00} },
164 {"Acer", "Aspire 1810TZ", "v0.3120", 0x55, 0x58, {0x9e, 0x00} },
165 {"Acer", "Aspire 1810T", "v0.3120", 0x55, 0x58, {0x9e, 0x00} },
166 {"Acer", "Aspire 1810TZ", "v1.3204", 0x55, 0x58, {0x9e, 0x00} },
167 {"Acer", "Aspire 1810T", "v1.3204", 0x55, 0x58, {0x9e, 0x00} },
168 {"Acer", "Aspire 1810TZ", "v1.3303", 0x55, 0x58, {0x9e, 0x00} },
169 {"Acer", "Aspire 1810T", "v1.3303", 0x55, 0x58, {0x9e, 0x00} },
171 {"Gateway", "AOA110", "v0.3103", 0x55, 0x58, {0x21, 0x00} },
172 {"Gateway", "AOA150", "v0.3103", 0x55, 0x58, {0x20, 0x00} },
173 {"Gateway", "LT31", "v1.3103", 0x55, 0x58, {0x9e, 0x00} },
174 {"Gateway", "LT31", "v1.3201", 0x55, 0x58, {0x9e, 0x00} },
175 {"Gateway", "LT31", "v1.3302", 0x55, 0x58, {0x9e, 0x00} },
177 {"Packard Bell", "DOA150", "v0.3104", 0x55, 0x58, {0x21, 0x00} },
178 {"Packard Bell", "DOA150", "v0.3105", 0x55, 0x58, {0x20, 0x00} },
179 {"Packard Bell", "AOA110", "v0.3105", 0x55, 0x58, {0x21, 0x00} },
180 {"Packard Bell", "AOA150", "v0.3105", 0x55, 0x58, {0x20, 0x00} },
181 {"Packard Bell", "DOTMU", "v1.3303", 0x55, 0x58, {0x9e, 0x00} },
182 {"Packard Bell", "DOTMU", "v0.3120", 0x55, 0x58, {0x9e, 0x00} },
183 {"Packard Bell", "DOTMA", "v1.3201", 0x55, 0x58, {0x9e, 0x00} },
184 /* pewpew-terminator */
185 {"", "", "", 0, 0, {0, 0} }
188 static const struct bios_settings_t
*bios_cfg __read_mostly
;
190 static int acerhdf_get_temp(int *temp
)
194 if (ec_read(bios_cfg
->tempreg
, &read_temp
))
197 *temp
= read_temp
* 1000;
202 static int acerhdf_get_fanstate(int *state
)
206 if (ec_read(bios_cfg
->fanreg
, &fan
))
209 if (fan
!= bios_cfg
->cmd
.cmd_off
)
210 *state
= ACERHDF_FAN_AUTO
;
212 *state
= ACERHDF_FAN_OFF
;
217 static void acerhdf_change_fanstate(int state
)
222 pr_notice("fan %s\n", (state
== ACERHDF_FAN_OFF
) ?
225 if ((state
!= ACERHDF_FAN_OFF
) && (state
!= ACERHDF_FAN_AUTO
)) {
226 pr_err("invalid fan state %d requested, setting to auto!\n",
228 state
= ACERHDF_FAN_AUTO
;
231 cmd
= (state
== ACERHDF_FAN_OFF
) ? bios_cfg
->cmd
.cmd_off
232 : bios_cfg
->cmd
.cmd_auto
;
235 ec_write(bios_cfg
->fanreg
, cmd
);
238 static void acerhdf_check_param(struct thermal_zone_device
*thermal
)
240 if (fanon
> ACERHDF_MAX_FANON
) {
241 pr_err("fanon temperature too high, set to %d\n",
243 fanon
= ACERHDF_MAX_FANON
;
246 if (kernelmode
&& prev_interval
!= interval
) {
247 if (interval
> ACERHDF_MAX_INTERVAL
) {
248 pr_err("interval too high, set to %d\n",
249 ACERHDF_MAX_INTERVAL
);
250 interval
= ACERHDF_MAX_INTERVAL
;
253 pr_notice("interval changed to: %d\n",
255 thermal
->polling_delay
= interval
*1000;
256 prev_interval
= interval
;
261 * This is the thermal zone callback which does the delayed polling of the fan
262 * state. We do check /sysfs-originating settings here in acerhdf_check_param()
263 * as late as the polling interval is since we can't do that in the respective
264 * accessors of the module parameters.
266 static int acerhdf_get_ec_temp(struct thermal_zone_device
*thermal
,
271 acerhdf_check_param(thermal
);
273 err
= acerhdf_get_temp(&temp
);
278 pr_notice("temp %d\n", temp
);
284 static int acerhdf_bind(struct thermal_zone_device
*thermal
,
285 struct thermal_cooling_device
*cdev
)
287 /* if the cooling device is the one from acerhdf bind it */
291 if (thermal_zone_bind_cooling_device(thermal
, 0, cdev
)) {
292 pr_err("error binding cooling dev\n");
298 static int acerhdf_unbind(struct thermal_zone_device
*thermal
,
299 struct thermal_cooling_device
*cdev
)
304 if (thermal_zone_unbind_cooling_device(thermal
, 0, cdev
)) {
305 pr_err("error unbinding cooling dev\n");
311 static inline void acerhdf_revert_to_bios_mode(void)
313 acerhdf_change_fanstate(ACERHDF_FAN_AUTO
);
316 thz_dev
->polling_delay
= 0;
317 pr_notice("kernel mode fan control OFF\n");
319 static inline void acerhdf_enable_kernelmode(void)
323 thz_dev
->polling_delay
= interval
*1000;
324 thermal_zone_device_update(thz_dev
);
325 pr_notice("kernel mode fan control ON\n");
328 static int acerhdf_get_mode(struct thermal_zone_device
*thermal
,
329 enum thermal_device_mode
*mode
)
332 pr_notice("kernel mode fan control %d\n", kernelmode
);
334 *mode
= (kernelmode
) ? THERMAL_DEVICE_ENABLED
335 : THERMAL_DEVICE_DISABLED
;
341 * set operation mode;
342 * enabled: the thermal layer of the kernel takes care about
343 * the temperature and the fan.
344 * disabled: the BIOS takes control of the fan.
346 static int acerhdf_set_mode(struct thermal_zone_device
*thermal
,
347 enum thermal_device_mode mode
)
349 if (mode
== THERMAL_DEVICE_DISABLED
&& kernelmode
)
350 acerhdf_revert_to_bios_mode();
351 else if (mode
== THERMAL_DEVICE_ENABLED
&& !kernelmode
)
352 acerhdf_enable_kernelmode();
357 static int acerhdf_get_trip_type(struct thermal_zone_device
*thermal
, int trip
,
358 enum thermal_trip_type
*type
)
361 *type
= THERMAL_TRIP_ACTIVE
;
366 static int acerhdf_get_trip_temp(struct thermal_zone_device
*thermal
, int trip
,
375 static int acerhdf_get_crit_temp(struct thermal_zone_device
*thermal
,
376 unsigned long *temperature
)
378 *temperature
= ACERHDF_TEMP_CRIT
;
382 /* bind callback functions to thermalzone */
383 struct thermal_zone_device_ops acerhdf_dev_ops
= {
384 .bind
= acerhdf_bind
,
385 .unbind
= acerhdf_unbind
,
386 .get_temp
= acerhdf_get_ec_temp
,
387 .get_mode
= acerhdf_get_mode
,
388 .set_mode
= acerhdf_set_mode
,
389 .get_trip_type
= acerhdf_get_trip_type
,
390 .get_trip_temp
= acerhdf_get_trip_temp
,
391 .get_crit_temp
= acerhdf_get_crit_temp
,
396 * cooling device callback functions
397 * get maximal fan cooling state
399 static int acerhdf_get_max_state(struct thermal_cooling_device
*cdev
,
400 unsigned long *state
)
407 static int acerhdf_get_cur_state(struct thermal_cooling_device
*cdev
,
408 unsigned long *state
)
412 err
= acerhdf_get_fanstate(&tmp
);
416 *state
= (tmp
== ACERHDF_FAN_AUTO
) ? 1 : 0;
420 /* change current fan state - is overwritten when running in kernel mode */
421 static int acerhdf_set_cur_state(struct thermal_cooling_device
*cdev
,
424 int cur_temp
, cur_state
, err
= 0;
429 err
= acerhdf_get_temp(&cur_temp
);
431 pr_err("error reading temperature, hand off control to BIOS\n");
435 err
= acerhdf_get_fanstate(&cur_state
);
437 pr_err("error reading fan state, hand off control to BIOS\n");
442 /* turn fan off only if below fanoff temperature */
443 if ((cur_state
== ACERHDF_FAN_AUTO
) &&
445 acerhdf_change_fanstate(ACERHDF_FAN_OFF
);
447 if (cur_state
== ACERHDF_FAN_OFF
)
448 acerhdf_change_fanstate(ACERHDF_FAN_AUTO
);
453 acerhdf_revert_to_bios_mode();
457 /* bind fan callbacks to fan device */
458 struct thermal_cooling_device_ops acerhdf_cooling_ops
= {
459 .get_max_state
= acerhdf_get_max_state
,
460 .get_cur_state
= acerhdf_get_cur_state
,
461 .set_cur_state
= acerhdf_set_cur_state
,
464 /* suspend / resume functionality */
465 static int acerhdf_suspend(struct device
*dev
)
468 acerhdf_change_fanstate(ACERHDF_FAN_AUTO
);
471 pr_notice("going suspend\n");
476 static int __devinit
acerhdf_probe(struct platform_device
*device
)
481 static int acerhdf_remove(struct platform_device
*device
)
486 static const struct dev_pm_ops acerhdf_pm_ops
= {
487 .suspend
= acerhdf_suspend
,
488 .freeze
= acerhdf_suspend
,
491 static struct platform_driver acerhdf_driver
= {
494 .owner
= THIS_MODULE
,
495 .pm
= &acerhdf_pm_ops
,
497 .probe
= acerhdf_probe
,
498 .remove
= acerhdf_remove
,
501 /* checks if str begins with start */
502 static int str_starts_with(const char *str
, const char *start
)
504 unsigned long str_len
= 0, start_len
= 0;
506 str_len
= strlen(str
);
507 start_len
= strlen(start
);
509 if (str_len
>= start_len
&&
510 !strncmp(str
, start
, start_len
))
517 static int acerhdf_check_hardware(void)
519 char const *vendor
, *version
, *product
;
520 const struct bios_settings_t
*bt
= NULL
;
523 vendor
= dmi_get_system_info(DMI_SYS_VENDOR
);
524 version
= dmi_get_system_info(DMI_BIOS_VERSION
);
525 product
= dmi_get_system_info(DMI_PRODUCT_NAME
);
527 if (!vendor
|| !version
|| !product
) {
528 pr_err("error getting hardware information\n");
532 pr_info("Acer Aspire One Fan driver, v.%s\n", DRV_VER
);
535 version
= force_bios
;
536 pr_info("forcing BIOS version: %s\n", version
);
540 if (force_product
[0]) {
541 product
= force_product
;
542 pr_info("forcing BIOS product: %s\n", product
);
547 pr_info("BIOS info: %s %s, product: %s\n",
548 vendor
, version
, product
);
550 /* search BIOS version and vendor in BIOS settings table */
551 for (bt
= bios_tbl
; bt
->vendor
[0]; bt
++) {
553 * check if actual hardware BIOS vendor, product and version
554 * IDs start with the strings of BIOS table entry
556 if (str_starts_with(vendor
, bt
->vendor
) &&
557 str_starts_with(product
, bt
->product
) &&
558 str_starts_with(version
, bt
->version
)) {
565 pr_err("unknown (unsupported) BIOS version %s/%s/%s, "
566 "please report, aborting!\n", vendor
, product
, version
);
571 * if started with kernel mode off, prevent the kernel from switching
575 pr_notice("Fan control off, to enable do:\n");
576 pr_notice("echo -n \"enabled\" > "
577 "/sys/class/thermal/thermal_zone0/mode\n");
583 static int acerhdf_register_platform(void)
587 err
= platform_driver_register(&acerhdf_driver
);
591 acerhdf_dev
= platform_device_alloc("acerhdf", -1);
592 platform_device_add(acerhdf_dev
);
597 static void acerhdf_unregister_platform(void)
602 platform_device_del(acerhdf_dev
);
603 platform_driver_unregister(&acerhdf_driver
);
606 static int acerhdf_register_thermal(void)
608 cl_dev
= thermal_cooling_device_register("acerhdf-fan", NULL
,
609 &acerhdf_cooling_ops
);
614 thz_dev
= thermal_zone_device_register("acerhdf", 1, NULL
,
615 &acerhdf_dev_ops
, 0, 0, 0,
616 (kernelmode
) ? interval
*1000 : 0);
623 static void acerhdf_unregister_thermal(void)
626 thermal_cooling_device_unregister(cl_dev
);
631 thermal_zone_device_unregister(thz_dev
);
636 static int __init
acerhdf_init(void)
640 err
= acerhdf_check_hardware();
644 err
= acerhdf_register_platform();
648 err
= acerhdf_register_thermal();
655 acerhdf_unregister_thermal();
656 acerhdf_unregister_platform();
662 static void __exit
acerhdf_exit(void)
664 acerhdf_change_fanstate(ACERHDF_FAN_AUTO
);
665 acerhdf_unregister_thermal();
666 acerhdf_unregister_platform();
669 MODULE_LICENSE("GPL");
670 MODULE_AUTHOR("Peter Feuerer");
671 MODULE_DESCRIPTION("Aspire One temperature and fan driver");
672 MODULE_ALIAS("dmi:*:*Acer*:pnAOA*:");
673 MODULE_ALIAS("dmi:*:*Acer*:pnAspire 1410*:");
674 MODULE_ALIAS("dmi:*:*Acer*:pnAspire 1810*:");
675 MODULE_ALIAS("dmi:*:*Gateway*:pnAOA*:");
676 MODULE_ALIAS("dmi:*:*Gateway*:pnLT31*:");
677 MODULE_ALIAS("dmi:*:*Packard Bell*:pnAOA*:");
678 MODULE_ALIAS("dmi:*:*Packard Bell*:pnDOA*:");
679 MODULE_ALIAS("dmi:*:*Packard Bell*:pnDOTMU*:");
680 MODULE_ALIAS("dmi:*:*Packard Bell*:pnDOTMA*:");
682 module_init(acerhdf_init
);
683 module_exit(acerhdf_exit
);