blob: 7a36f02598a6f20db9fe2a78c61a0f8fbafe6ecb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * acpi_fan.c - ACPI Fan Driver ($Revision: 29 $)
3 *
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25
26#include <linux/kernel.h>
27#include <linux/module.h>
28#include <linux/init.h>
29#include <linux/types.h>
Sudip Mukherjee88989fd2014-08-28 19:17:19 +053030#include <linux/uaccess.h>
Zhang Rui05a83d92008-01-17 15:51:24 +080031#include <linux/thermal.h>
Lv Zheng8b484632013-12-03 08:49:16 +080032#include <linux/acpi.h>
Aaron Lu19593a12013-11-19 16:59:20 +080033#include <linux/platform_device.h>
Aaron Lu9519a632014-04-01 15:50:27 +080034#include <linux/sort.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Len Brownf52fd662007-02-12 22:42:12 -050036MODULE_AUTHOR("Paul Diefenbaugh");
Len Brown7cda93e2007-02-12 23:50:02 -050037MODULE_DESCRIPTION("ACPI Fan Driver");
Linus Torvalds1da177e2005-04-16 15:20:36 -070038MODULE_LICENSE("GPL");
39
Aaron Lu19593a12013-11-19 16:59:20 +080040static int acpi_fan_probe(struct platform_device *pdev);
41static int acpi_fan_remove(struct platform_device *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Thomas Renninger1ba90e32007-07-23 14:44:41 +020043static const struct acpi_device_id fan_device_ids[] = {
44 {"PNP0C0B", 0},
Aaron Lud806c6e2014-04-01 15:54:05 +080045 {"INT3404", 0},
Thomas Renninger1ba90e32007-07-23 14:44:41 +020046 {"", 0},
47};
48MODULE_DEVICE_TABLE(acpi, fan_device_ids);
49
Rafael J. Wysocki90692402012-08-09 23:00:02 +020050#ifdef CONFIG_PM_SLEEP
Rafael J. Wysocki62fcbdd2012-06-27 23:26:07 +020051static int acpi_fan_suspend(struct device *dev);
52static int acpi_fan_resume(struct device *dev);
Aaron Lub9b85152014-02-19 12:16:48 +080053static struct dev_pm_ops acpi_fan_pm = {
54 .resume = acpi_fan_resume,
55 .freeze = acpi_fan_suspend,
56 .thaw = acpi_fan_resume,
57 .restore = acpi_fan_resume,
58};
59#define FAN_PM_OPS_PTR (&acpi_fan_pm)
Shuah Khanb108e0e2014-02-12 20:19:08 -070060#else
Aaron Lub9b85152014-02-19 12:16:48 +080061#define FAN_PM_OPS_PTR NULL
Rafael J. Wysocki90692402012-08-09 23:00:02 +020062#endif
Rafael J. Wysocki62fcbdd2012-06-27 23:26:07 +020063
Aaron Lu9519a632014-04-01 15:50:27 +080064struct acpi_fan_fps {
65 u64 control;
66 u64 trip_point;
67 u64 speed;
68 u64 noise_level;
69 u64 power;
70};
71
72struct acpi_fan_fif {
73 u64 revision;
74 u64 fine_grain_ctrl;
75 u64 step_size;
76 u64 low_speed_notification;
77};
78
79struct acpi_fan {
80 bool acpi4;
81 struct acpi_fan_fif fif;
82 struct acpi_fan_fps *fps;
83 int fps_count;
84 struct thermal_cooling_device *cdev;
85};
86
Aaron Lu19593a12013-11-19 16:59:20 +080087static struct platform_driver acpi_fan_driver = {
88 .probe = acpi_fan_probe,
89 .remove = acpi_fan_remove,
90 .driver = {
91 .name = "acpi-fan",
92 .acpi_match_table = fan_device_ids,
93 .pm = FAN_PM_OPS_PTR,
94 },
Linus Torvalds1da177e2005-04-16 15:20:36 -070095};
96
Zhang Rui05a83d92008-01-17 15:51:24 +080097/* thermal cooling device callbacks */
Matthew Garrett6503e5d2008-11-27 17:48:13 +000098static int fan_get_max_state(struct thermal_cooling_device *cdev, unsigned long
99 *state)
Zhang Rui05a83d92008-01-17 15:51:24 +0800100{
Aaron Lu9519a632014-04-01 15:50:27 +0800101 struct acpi_device *device = cdev->devdata;
102 struct acpi_fan *fan = acpi_driver_data(device);
103
104 if (fan->acpi4)
105 *state = fan->fps_count - 1;
106 else
107 *state = 1;
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000108 return 0;
Zhang Rui05a83d92008-01-17 15:51:24 +0800109}
110
Aaron Lu9519a632014-04-01 15:50:27 +0800111static int fan_get_state_acpi4(struct acpi_device *device, unsigned long *state)
Zhang Rui05a83d92008-01-17 15:51:24 +0800112{
Aaron Lu9519a632014-04-01 15:50:27 +0800113 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
114 struct acpi_fan *fan = acpi_driver_data(device);
115 union acpi_object *obj;
116 acpi_status status;
117 int control, i;
118
119 status = acpi_evaluate_object(device->handle, "_FST", NULL, &buffer);
120 if (ACPI_FAILURE(status)) {
121 dev_err(&device->dev, "Get fan state failed\n");
122 return status;
123 }
124
125 obj = buffer.pointer;
126 if (!obj || obj->type != ACPI_TYPE_PACKAGE ||
127 obj->package.count != 3 ||
128 obj->package.elements[1].type != ACPI_TYPE_INTEGER) {
129 dev_err(&device->dev, "Invalid _FST data\n");
130 status = -EINVAL;
131 goto err;
132 }
133
134 control = obj->package.elements[1].integer.value;
135 for (i = 0; i < fan->fps_count; i++) {
136 if (control == fan->fps[i].control)
137 break;
138 }
139 if (i == fan->fps_count) {
140 dev_dbg(&device->dev, "Invalid control value returned\n");
141 status = -EINVAL;
142 goto err;
143 }
144
145 *state = i;
146
147err:
148 kfree(obj);
149 return status;
150}
151
152static int fan_get_state(struct acpi_device *device, unsigned long *state)
153{
Zhang Rui05a83d92008-01-17 15:51:24 +0800154 int result;
Naresh Bhat85eb9822013-07-01 19:51:00 +0530155 int acpi_state = ACPI_STATE_D0;
Zhang Rui05a83d92008-01-17 15:51:24 +0800156
Aaron Lu2bb3a2b2013-11-19 15:43:52 +0800157 result = acpi_device_update_power(device, &acpi_state);
Zhang Rui05a83d92008-01-17 15:51:24 +0800158 if (result)
159 return result;
160
Rafael J. Wysocki8ad928d2013-07-30 14:36:20 +0200161 *state = (acpi_state == ACPI_STATE_D3_COLD ? 0 :
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000162 (acpi_state == ACPI_STATE_D0 ? 1 : -1));
163 return 0;
Zhang Rui05a83d92008-01-17 15:51:24 +0800164}
165
Aaron Lu9519a632014-04-01 15:50:27 +0800166static int fan_get_cur_state(struct thermal_cooling_device *cdev, unsigned long
167 *state)
168{
169 struct acpi_device *device = cdev->devdata;
170 struct acpi_fan *fan = acpi_driver_data(device);
171
172 if (fan->acpi4)
173 return fan_get_state_acpi4(device, state);
174 else
175 return fan_get_state(device, state);
176}
177
178static int fan_set_state(struct acpi_device *device, unsigned long state)
179{
180 if (state != 0 && state != 1)
181 return -EINVAL;
182
183 return acpi_device_set_power(device,
184 state ? ACPI_STATE_D0 : ACPI_STATE_D3_COLD);
185}
186
187static int fan_set_state_acpi4(struct acpi_device *device, unsigned long state)
188{
189 struct acpi_fan *fan = acpi_driver_data(device);
190 acpi_status status;
191
192 if (state >= fan->fps_count)
193 return -EINVAL;
194
195 status = acpi_execute_simple_method(device->handle, "_FSL",
196 fan->fps[state].control);
197 if (ACPI_FAILURE(status)) {
198 dev_dbg(&device->dev, "Failed to set state by _FSL\n");
199 return status;
200 }
201
202 return 0;
203}
204
Zhang Rui05a83d92008-01-17 15:51:24 +0800205static int
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000206fan_set_cur_state(struct thermal_cooling_device *cdev, unsigned long state)
Zhang Rui05a83d92008-01-17 15:51:24 +0800207{
208 struct acpi_device *device = cdev->devdata;
Aaron Lu9519a632014-04-01 15:50:27 +0800209 struct acpi_fan *fan = acpi_driver_data(device);
Zhang Rui05a83d92008-01-17 15:51:24 +0800210
Aaron Lu9519a632014-04-01 15:50:27 +0800211 if (fan->acpi4)
212 return fan_set_state_acpi4(device, state);
213 else
214 return fan_set_state(device, state);
215 }
Zhang Rui05a83d92008-01-17 15:51:24 +0800216
Vasiliy Kulikov9c8b04b2011-06-25 21:07:52 +0400217static const struct thermal_cooling_device_ops fan_cooling_ops = {
Zhang Rui05a83d92008-01-17 15:51:24 +0800218 .get_max_state = fan_get_max_state,
219 .get_cur_state = fan_get_cur_state,
220 .set_cur_state = fan_set_cur_state,
221};
222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/* --------------------------------------------------------------------------
Sudip Mukherjee88989fd2014-08-28 19:17:19 +0530224 * Driver Interface
225 * --------------------------------------------------------------------------
226*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Aaron Lu9519a632014-04-01 15:50:27 +0800228static bool acpi_fan_is_acpi4(struct acpi_device *device)
229{
230 return acpi_has_method(device->handle, "_FIF") &&
231 acpi_has_method(device->handle, "_FPS") &&
232 acpi_has_method(device->handle, "_FSL") &&
233 acpi_has_method(device->handle, "_FST");
234}
235
236static int acpi_fan_get_fif(struct acpi_device *device)
237{
238 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
239 struct acpi_fan *fan = acpi_driver_data(device);
240 struct acpi_buffer format = { sizeof("NNNN"), "NNNN" };
241 struct acpi_buffer fif = { sizeof(fan->fif), &fan->fif };
242 union acpi_object *obj;
243 acpi_status status;
244
245 status = acpi_evaluate_object(device->handle, "_FIF", NULL, &buffer);
246 if (ACPI_FAILURE(status))
247 return status;
248
249 obj = buffer.pointer;
250 if (!obj || obj->type != ACPI_TYPE_PACKAGE) {
251 dev_err(&device->dev, "Invalid _FIF data\n");
252 status = -EINVAL;
253 goto err;
254 }
255
256 status = acpi_extract_package(obj, &format, &fif);
257 if (ACPI_FAILURE(status)) {
258 dev_err(&device->dev, "Invalid _FIF element\n");
259 status = -EINVAL;
260 }
261
262err:
263 kfree(obj);
264 return status;
265}
266
267static int acpi_fan_speed_cmp(const void *a, const void *b)
268{
269 const struct acpi_fan_fps *fps1 = a;
270 const struct acpi_fan_fps *fps2 = b;
271 return fps1->speed - fps2->speed;
272}
273
274static int acpi_fan_get_fps(struct acpi_device *device)
275{
276 struct acpi_fan *fan = acpi_driver_data(device);
277 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
278 union acpi_object *obj;
279 acpi_status status;
280 int i;
281
282 status = acpi_evaluate_object(device->handle, "_FPS", NULL, &buffer);
283 if (ACPI_FAILURE(status))
284 return status;
285
286 obj = buffer.pointer;
287 if (!obj || obj->type != ACPI_TYPE_PACKAGE || obj->package.count < 2) {
288 dev_err(&device->dev, "Invalid _FPS data\n");
289 status = -EINVAL;
290 goto err;
291 }
292
293 fan->fps_count = obj->package.count - 1; /* minus revision field */
294 fan->fps = devm_kzalloc(&device->dev,
295 fan->fps_count * sizeof(struct acpi_fan_fps),
296 GFP_KERNEL);
297 if (!fan->fps) {
298 dev_err(&device->dev, "Not enough memory\n");
299 status = -ENOMEM;
300 goto err;
301 }
302 for (i = 0; i < fan->fps_count; i++) {
303 struct acpi_buffer format = { sizeof("NNNNN"), "NNNNN" };
304 struct acpi_buffer fps = { sizeof(fan->fps[i]), &fan->fps[i] };
305 status = acpi_extract_package(&obj->package.elements[i + 1],
306 &format, &fps);
307 if (ACPI_FAILURE(status)) {
308 dev_err(&device->dev, "Invalid _FPS element\n");
309 break;
310 }
311 }
312
313 /* sort the state array according to fan speed in increase order */
314 sort(fan->fps, fan->fps_count, sizeof(*fan->fps),
315 acpi_fan_speed_cmp, NULL);
316
317err:
318 kfree(obj);
319 return status;
320}
321
Aaron Lu19593a12013-11-19 16:59:20 +0800322static int acpi_fan_probe(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
Len Brown4be44fc2005-08-05 00:44:28 -0400324 int result = 0;
Zhang Rui05a83d92008-01-17 15:51:24 +0800325 struct thermal_cooling_device *cdev;
Aaron Lu9519a632014-04-01 15:50:27 +0800326 struct acpi_fan *fan;
Aaron Lu19593a12013-11-19 16:59:20 +0800327 struct acpi_device *device = ACPI_COMPANION(&pdev->dev);
Srinivas Pandruvadabbb16fe2014-12-09 16:15:40 -0800328 char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
Aaron Lu9519a632014-04-01 15:50:27 +0800330 fan = devm_kzalloc(&pdev->dev, sizeof(*fan), GFP_KERNEL);
331 if (!fan) {
332 dev_err(&device->dev, "No memory for fan\n");
333 return -ENOMEM;
334 }
335 device->driver_data = fan;
336 platform_set_drvdata(pdev, fan);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Aaron Lu9519a632014-04-01 15:50:27 +0800338 if (acpi_fan_is_acpi4(device)) {
339 if (acpi_fan_get_fif(device) || acpi_fan_get_fps(device))
340 goto end;
341 fan->acpi4 = true;
342 } else {
343 result = acpi_device_update_power(device, NULL);
344 if (result) {
345 dev_err(&device->dev, "Setting initial power state\n");
346 goto end;
347 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 }
349
Srinivas Pandruvadabbb16fe2014-12-09 16:15:40 -0800350 if (!strncmp(pdev->name, "PNP0C0B", strlen("PNP0C0B")))
351 name = "Fan";
352 else
353 name = acpi_device_bid(device);
354
355 cdev = thermal_cooling_device_register(name, device,
Zhang Rui05a83d92008-01-17 15:51:24 +0800356 &fan_cooling_ops);
Thomas Sujith19b36782008-02-15 01:01:52 -0500357 if (IS_ERR(cdev)) {
358 result = PTR_ERR(cdev);
359 goto end;
360 }
Zhang Rui05a83d92008-01-17 15:51:24 +0800361
Aaron Lu19593a12013-11-19 16:59:20 +0800362 dev_dbg(&pdev->dev, "registered as cooling_device%d\n", cdev->id);
Thomas Sujith19b36782008-02-15 01:01:52 -0500363
Aaron Lu9519a632014-04-01 15:50:27 +0800364 fan->cdev = cdev;
Aaron Lu19593a12013-11-19 16:59:20 +0800365 result = sysfs_create_link(&pdev->dev.kobj,
Julia Lawall90300622008-04-11 10:09:24 +0800366 &cdev->device.kobj,
367 "thermal_cooling");
368 if (result)
Linus Torvalds8264fce2014-10-24 11:21:43 -0700369 dev_err(&pdev->dev, "Failed to create sysfs link 'thermal_cooling'\n");
Julia Lawall90300622008-04-11 10:09:24 +0800370
371 result = sysfs_create_link(&cdev->device.kobj,
Aaron Lu19593a12013-11-19 16:59:20 +0800372 &pdev->dev.kobj,
Julia Lawall90300622008-04-11 10:09:24 +0800373 "device");
374 if (result)
Linus Torvalds8264fce2014-10-24 11:21:43 -0700375 dev_err(&pdev->dev, "Failed to create sysfs link 'device'\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
Felipe Contreras568b6ad2013-08-30 16:16:05 -0500377end:
Patrick Mocheld550d982006-06-27 00:41:40 -0400378 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379}
380
Aaron Lu19593a12013-11-19 16:59:20 +0800381static int acpi_fan_remove(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382{
Aaron Lu9519a632014-04-01 15:50:27 +0800383 struct acpi_fan *fan = platform_get_drvdata(pdev);
Zhang Rui05a83d92008-01-17 15:51:24 +0800384
Aaron Lu19593a12013-11-19 16:59:20 +0800385 sysfs_remove_link(&pdev->dev.kobj, "thermal_cooling");
Aaron Lu9519a632014-04-01 15:50:27 +0800386 sysfs_remove_link(&fan->cdev->device.kobj, "device");
387 thermal_cooling_device_unregister(fan->cdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Patrick Mocheld550d982006-06-27 00:41:40 -0400389 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390}
391
Rafael J. Wysocki90692402012-08-09 23:00:02 +0200392#ifdef CONFIG_PM_SLEEP
Rafael J. Wysocki62fcbdd2012-06-27 23:26:07 +0200393static int acpi_fan_suspend(struct device *dev)
Len Brownec683732008-01-23 22:41:20 -0500394{
Aaron Lu9519a632014-04-01 15:50:27 +0800395 struct acpi_fan *fan = dev_get_drvdata(dev);
396 if (fan->acpi4)
397 return 0;
Len Brownec683732008-01-23 22:41:20 -0500398
Aaron Lu19593a12013-11-19 16:59:20 +0800399 acpi_device_set_power(ACPI_COMPANION(dev), ACPI_STATE_D0);
Len Brownec683732008-01-23 22:41:20 -0500400
401 return AE_OK;
402}
403
Rafael J. Wysocki62fcbdd2012-06-27 23:26:07 +0200404static int acpi_fan_resume(struct device *dev)
Len Brownec683732008-01-23 22:41:20 -0500405{
Rafael J. Wysocki488a76c2010-11-25 00:11:24 +0100406 int result;
Aaron Lu9519a632014-04-01 15:50:27 +0800407 struct acpi_fan *fan = dev_get_drvdata(dev);
Len Brownec683732008-01-23 22:41:20 -0500408
Aaron Lu9519a632014-04-01 15:50:27 +0800409 if (fan->acpi4)
410 return 0;
Len Brownec683732008-01-23 22:41:20 -0500411
Aaron Lu19593a12013-11-19 16:59:20 +0800412 result = acpi_device_update_power(ACPI_COMPANION(dev), NULL);
Rafael J. Wysocki488a76c2010-11-25 00:11:24 +0100413 if (result)
Sudip Mukherjee88989fd2014-08-28 19:17:19 +0530414 dev_err(dev, "Error updating fan power state\n");
Len Brownec683732008-01-23 22:41:20 -0500415
416 return result;
417}
Rafael J. Wysocki90692402012-08-09 23:00:02 +0200418#endif
Len Brownec683732008-01-23 22:41:20 -0500419
Aaron Lu19593a12013-11-19 16:59:20 +0800420module_platform_driver(acpi_fan_driver);