2 * thermal.c - Generic Thermal Management Sysfs support.
4 * Copyright (C) 2008 Intel Corp
5 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
6 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2 of the License.
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.
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.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #include <linux/module.h>
27 #include <linux/device.h>
28 #include <linux/err.h>
29 #include <linux/kdev_t.h>
30 #include <linux/idr.h>
31 #include <linux/thermal.h>
32 #include <linux/spinlock.h>
34 MODULE_AUTHOR("Zhang Rui")
35 MODULE_DESCRIPTION("Generic thermal management sysfs support");
36 MODULE_LICENSE("GPL");
38 #define PREFIX "Thermal: "
40 struct thermal_cooling_device_instance
{
42 char name
[THERMAL_NAME_LENGTH
];
43 struct thermal_zone_device
*tz
;
44 struct thermal_cooling_device
*cdev
;
46 char attr_name
[THERMAL_NAME_LENGTH
];
47 struct device_attribute attr
;
48 struct list_head node
;
51 static DEFINE_IDR(thermal_tz_idr
);
52 static DEFINE_IDR(thermal_cdev_idr
);
53 static DEFINE_MUTEX(thermal_idr_lock
);
55 static LIST_HEAD(thermal_tz_list
);
56 static LIST_HEAD(thermal_cdev_list
);
57 static DEFINE_MUTEX(thermal_list_lock
);
59 static int get_idr(struct idr
*idr
, struct mutex
*lock
, int *id
)
64 if (unlikely(idr_pre_get(idr
, GFP_KERNEL
) == 0))
69 err
= idr_get_new(idr
, NULL
, id
);
72 if (unlikely(err
== -EAGAIN
))
74 else if (unlikely(err
))
77 *id
= *id
& MAX_ID_MASK
;
81 static void release_idr(struct idr
*idr
, struct mutex
*lock
, int id
)
90 /* sys I/F for thermal zone */
92 #define to_thermal_zone(_dev) \
93 container_of(_dev, struct thermal_zone_device, device)
96 type_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
98 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
100 return sprintf(buf
, "%s\n", tz
->type
);
104 temp_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
106 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
108 if (!tz
->ops
->get_temp
)
111 return tz
->ops
->get_temp(tz
, buf
);
115 mode_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
117 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
119 if (!tz
->ops
->get_mode
)
122 return tz
->ops
->get_mode(tz
, buf
);
126 mode_store(struct device
*dev
, struct device_attribute
*attr
,
127 const char *buf
, size_t count
)
129 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
132 if (!tz
->ops
->set_mode
)
135 result
= tz
->ops
->set_mode(tz
, buf
);
143 trip_point_type_show(struct device
*dev
, struct device_attribute
*attr
,
146 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
149 if (!tz
->ops
->get_trip_type
)
152 if (!sscanf(attr
->attr
.name
, "trip_point_%d_type", &trip
))
155 return tz
->ops
->get_trip_type(tz
, trip
, buf
);
159 trip_point_temp_show(struct device
*dev
, struct device_attribute
*attr
,
162 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
165 if (!tz
->ops
->get_trip_temp
)
168 if (!sscanf(attr
->attr
.name
, "trip_point_%d_temp", &trip
))
171 return tz
->ops
->get_trip_temp(tz
, trip
, buf
);
174 static DEVICE_ATTR(type
, 0444, type_show
, NULL
);
175 static DEVICE_ATTR(temp
, 0444, temp_show
, NULL
);
176 static DEVICE_ATTR(mode
, 0644, mode_show
, mode_store
);
178 static struct device_attribute trip_point_attrs
[] = {
179 __ATTR(trip_point_0_type
, 0444, trip_point_type_show
, NULL
),
180 __ATTR(trip_point_0_temp
, 0444, trip_point_temp_show
, NULL
),
181 __ATTR(trip_point_1_type
, 0444, trip_point_type_show
, NULL
),
182 __ATTR(trip_point_1_temp
, 0444, trip_point_temp_show
, NULL
),
183 __ATTR(trip_point_2_type
, 0444, trip_point_type_show
, NULL
),
184 __ATTR(trip_point_2_temp
, 0444, trip_point_temp_show
, NULL
),
185 __ATTR(trip_point_3_type
, 0444, trip_point_type_show
, NULL
),
186 __ATTR(trip_point_3_temp
, 0444, trip_point_temp_show
, NULL
),
187 __ATTR(trip_point_4_type
, 0444, trip_point_type_show
, NULL
),
188 __ATTR(trip_point_4_temp
, 0444, trip_point_temp_show
, NULL
),
189 __ATTR(trip_point_5_type
, 0444, trip_point_type_show
, NULL
),
190 __ATTR(trip_point_5_temp
, 0444, trip_point_temp_show
, NULL
),
191 __ATTR(trip_point_6_type
, 0444, trip_point_type_show
, NULL
),
192 __ATTR(trip_point_6_temp
, 0444, trip_point_temp_show
, NULL
),
193 __ATTR(trip_point_7_type
, 0444, trip_point_type_show
, NULL
),
194 __ATTR(trip_point_7_temp
, 0444, trip_point_temp_show
, NULL
),
195 __ATTR(trip_point_8_type
, 0444, trip_point_type_show
, NULL
),
196 __ATTR(trip_point_8_temp
, 0444, trip_point_temp_show
, NULL
),
197 __ATTR(trip_point_9_type
, 0444, trip_point_type_show
, NULL
),
198 __ATTR(trip_point_9_temp
, 0444, trip_point_temp_show
, NULL
),
201 #define TRIP_POINT_ATTR_ADD(_dev, _index, result) \
203 result = device_create_file(_dev, \
204 &trip_point_attrs[_index * 2]); \
207 result = device_create_file(_dev, \
208 &trip_point_attrs[_index * 2 + 1]); \
211 #define TRIP_POINT_ATTR_REMOVE(_dev, _index) \
213 device_remove_file(_dev, &trip_point_attrs[_index * 2]); \
214 device_remove_file(_dev, &trip_point_attrs[_index * 2 + 1]); \
217 /* sys I/F for cooling device */
218 #define to_cooling_device(_dev) \
219 container_of(_dev, struct thermal_cooling_device, device)
222 thermal_cooling_device_type_show(struct device
*dev
,
223 struct device_attribute
*attr
, char *buf
)
225 struct thermal_cooling_device
*cdev
= to_cooling_device(dev
);
227 return sprintf(buf
, "%s\n", cdev
->type
);
231 thermal_cooling_device_max_state_show(struct device
*dev
,
232 struct device_attribute
*attr
, char *buf
)
234 struct thermal_cooling_device
*cdev
= to_cooling_device(dev
);
236 return cdev
->ops
->get_max_state(cdev
, buf
);
240 thermal_cooling_device_cur_state_show(struct device
*dev
,
241 struct device_attribute
*attr
, char *buf
)
243 struct thermal_cooling_device
*cdev
= to_cooling_device(dev
);
245 return cdev
->ops
->get_cur_state(cdev
, buf
);
249 thermal_cooling_device_cur_state_store(struct device
*dev
,
250 struct device_attribute
*attr
,
251 const char *buf
, size_t count
)
253 struct thermal_cooling_device
*cdev
= to_cooling_device(dev
);
257 if (!sscanf(buf
, "%d\n", &state
))
263 result
= cdev
->ops
->set_cur_state(cdev
, state
);
269 static struct device_attribute dev_attr_cdev_type
=
270 __ATTR(type
, 0444, thermal_cooling_device_type_show
, NULL
);
271 static DEVICE_ATTR(max_state
, 0444,
272 thermal_cooling_device_max_state_show
, NULL
);
273 static DEVICE_ATTR(cur_state
, 0644,
274 thermal_cooling_device_cur_state_show
,
275 thermal_cooling_device_cur_state_store
);
278 thermal_cooling_device_trip_point_show(struct device
*dev
,
279 struct device_attribute
*attr
, char *buf
)
281 struct thermal_cooling_device_instance
*instance
;
284 container_of(attr
, struct thermal_cooling_device_instance
, attr
);
286 if (instance
->trip
== THERMAL_TRIPS_NONE
)
287 return sprintf(buf
, "-1\n");
289 return sprintf(buf
, "%d\n", instance
->trip
);
292 /* Device management */
295 * thermal_zone_bind_cooling_device - bind a cooling device to a thermal zone
296 * this function is usually called in the thermal zone device .bind callback.
297 * @tz: thermal zone device
298 * @trip: indicates which trip point the cooling devices is
299 * associated with in this thermal zone.
300 * @cdev: thermal cooling device
302 int thermal_zone_bind_cooling_device(struct thermal_zone_device
*tz
,
304 struct thermal_cooling_device
*cdev
)
306 struct thermal_cooling_device_instance
*dev
;
307 struct thermal_cooling_device_instance
*pos
;
310 if (trip
>= tz
->trips
||
311 (trip
< 0 && trip
!= THERMAL_TRIPS_NONE
))
318 kzalloc(sizeof(struct thermal_cooling_device_instance
), GFP_KERNEL
);
324 result
= get_idr(&tz
->idr
, &tz
->lock
, &dev
->id
);
328 sprintf(dev
->name
, "cdev%d", dev
->id
);
330 sysfs_create_link(&tz
->device
.kobj
, &cdev
->device
.kobj
, dev
->name
);
334 sprintf(dev
->attr_name
, "cdev%d_trip_point", dev
->id
);
335 dev
->attr
.attr
.name
= dev
->attr_name
;
336 dev
->attr
.attr
.mode
= 0444;
337 dev
->attr
.show
= thermal_cooling_device_trip_point_show
;
338 result
= device_create_file(&tz
->device
, &dev
->attr
);
340 goto remove_symbol_link
;
342 mutex_lock(&tz
->lock
);
343 list_for_each_entry(pos
, &tz
->cooling_devices
, node
)
344 if (pos
->tz
== tz
&& pos
->trip
== trip
&& pos
->cdev
== cdev
) {
349 list_add_tail(&dev
->node
, &tz
->cooling_devices
);
350 mutex_unlock(&tz
->lock
);
355 device_remove_file(&tz
->device
, &dev
->attr
);
357 sysfs_remove_link(&tz
->device
.kobj
, dev
->name
);
359 release_idr(&tz
->idr
, &tz
->lock
, dev
->id
);
364 EXPORT_SYMBOL(thermal_zone_bind_cooling_device
);
367 * thermal_zone_unbind_cooling_device - unbind a cooling device from a thermal zone
368 * this function is usually called in the thermal zone device .unbind callback.
369 * @tz: thermal zone device
370 * @trip: indicates which trip point the cooling devices is
371 * associated with in this thermal zone.
372 * @cdev: thermal cooling device
374 int thermal_zone_unbind_cooling_device(struct thermal_zone_device
*tz
,
376 struct thermal_cooling_device
*cdev
)
378 struct thermal_cooling_device_instance
*pos
, *next
;
380 mutex_lock(&tz
->lock
);
381 list_for_each_entry_safe(pos
, next
, &tz
->cooling_devices
, node
) {
382 if (pos
->tz
== tz
&& pos
->trip
== trip
383 && pos
->cdev
== cdev
) {
384 list_del(&pos
->node
);
385 mutex_unlock(&tz
->lock
);
389 mutex_unlock(&tz
->lock
);
394 device_remove_file(&tz
->device
, &pos
->attr
);
395 sysfs_remove_link(&tz
->device
.kobj
, pos
->name
);
396 release_idr(&tz
->idr
, &tz
->lock
, pos
->id
);
400 EXPORT_SYMBOL(thermal_zone_unbind_cooling_device
);
402 static void thermal_release(struct device
*dev
)
404 struct thermal_zone_device
*tz
;
405 struct thermal_cooling_device
*cdev
;
407 if (!strncmp(dev
->bus_id
, "thermal_zone", sizeof "thermal_zone" - 1)) {
408 tz
= to_thermal_zone(dev
);
411 cdev
= to_cooling_device(dev
);
416 static struct class thermal_class
= {
418 .dev_release
= thermal_release
,
422 * thermal_cooling_device_register - register a new thermal cooling device
423 * @type: the thermal cooling device type.
424 * @devdata: device private data.
425 * @ops: standard thermal cooling devices callbacks.
427 struct thermal_cooling_device
*thermal_cooling_device_register(char *type
,
428 void *devdata
, struct thermal_cooling_device_ops
*ops
)
430 struct thermal_cooling_device
*cdev
;
431 struct thermal_zone_device
*pos
;
434 if (strlen(type
) >= THERMAL_NAME_LENGTH
)
437 if (!ops
|| !ops
->get_max_state
|| !ops
->get_cur_state
||
441 cdev
= kzalloc(sizeof(struct thermal_cooling_device
), GFP_KERNEL
);
445 result
= get_idr(&thermal_cdev_idr
, &thermal_idr_lock
, &cdev
->id
);
451 strcpy(cdev
->type
, type
);
453 cdev
->device
.class = &thermal_class
;
454 cdev
->devdata
= devdata
;
455 sprintf(cdev
->device
.bus_id
, "cooling_device%d", cdev
->id
);
456 result
= device_register(&cdev
->device
);
458 release_idr(&thermal_cdev_idr
, &thermal_idr_lock
, cdev
->id
);
465 result
= device_create_file(&cdev
->device
,
466 &dev_attr_cdev_type
);
471 result
= device_create_file(&cdev
->device
, &dev_attr_max_state
);
475 result
= device_create_file(&cdev
->device
, &dev_attr_cur_state
);
479 mutex_lock(&thermal_list_lock
);
480 list_add(&cdev
->node
, &thermal_cdev_list
);
481 list_for_each_entry(pos
, &thermal_tz_list
, node
) {
484 result
= pos
->ops
->bind(pos
, cdev
);
489 mutex_unlock(&thermal_list_lock
);
495 release_idr(&thermal_cdev_idr
, &thermal_idr_lock
, cdev
->id
);
496 device_unregister(&cdev
->device
);
499 EXPORT_SYMBOL(thermal_cooling_device_register
);
502 * thermal_cooling_device_unregister - removes the registered thermal cooling device
504 * @cdev: the thermal cooling device to remove.
506 * thermal_cooling_device_unregister() must be called when the device is no
509 void thermal_cooling_device_unregister(struct
510 thermal_cooling_device
513 struct thermal_zone_device
*tz
;
514 struct thermal_cooling_device
*pos
= NULL
;
519 mutex_lock(&thermal_list_lock
);
520 list_for_each_entry(pos
, &thermal_cdev_list
, node
)
524 /* thermal cooling device not found */
525 mutex_unlock(&thermal_list_lock
);
528 list_del(&cdev
->node
);
529 list_for_each_entry(tz
, &thermal_tz_list
, node
) {
530 if (!tz
->ops
->unbind
)
532 tz
->ops
->unbind(tz
, cdev
);
534 mutex_unlock(&thermal_list_lock
);
536 device_remove_file(&cdev
->device
,
537 &dev_attr_cdev_type
);
538 device_remove_file(&cdev
->device
, &dev_attr_max_state
);
539 device_remove_file(&cdev
->device
, &dev_attr_cur_state
);
541 release_idr(&thermal_cdev_idr
, &thermal_idr_lock
, cdev
->id
);
542 device_unregister(&cdev
->device
);
545 EXPORT_SYMBOL(thermal_cooling_device_unregister
);
548 * thermal_zone_device_register - register a new thermal zone device
549 * @type: the thermal zone device type
550 * @trips: the number of trip points the thermal zone support
551 * @devdata: private device data
552 * @ops: standard thermal zone device callbacks
554 * thermal_zone_device_unregister() must be called when the device is no
557 struct thermal_zone_device
*thermal_zone_device_register(char *type
,
558 int trips
, void *devdata
,
559 struct thermal_zone_device_ops
*ops
)
561 struct thermal_zone_device
*tz
;
562 struct thermal_cooling_device
*pos
;
566 if (strlen(type
) >= THERMAL_NAME_LENGTH
)
569 if (trips
> THERMAL_MAX_TRIPS
|| trips
< 0)
572 if (!ops
|| !ops
->get_temp
)
575 tz
= kzalloc(sizeof(struct thermal_zone_device
), GFP_KERNEL
);
579 INIT_LIST_HEAD(&tz
->cooling_devices
);
581 mutex_init(&tz
->lock
);
582 result
= get_idr(&thermal_tz_idr
, &thermal_idr_lock
, &tz
->id
);
588 strcpy(tz
->type
, type
);
590 tz
->device
.class = &thermal_class
;
591 tz
->devdata
= devdata
;
593 sprintf(tz
->device
.bus_id
, "thermal_zone%d", tz
->id
);
594 result
= device_register(&tz
->device
);
596 release_idr(&thermal_tz_idr
, &thermal_idr_lock
, tz
->id
);
603 result
= device_create_file(&tz
->device
, &dev_attr_type
);
608 result
= device_create_file(&tz
->device
, &dev_attr_temp
);
613 result
= device_create_file(&tz
->device
, &dev_attr_mode
);
618 for (count
= 0; count
< trips
; count
++) {
619 TRIP_POINT_ATTR_ADD(&tz
->device
, count
, result
);
624 mutex_lock(&thermal_list_lock
);
625 list_add_tail(&tz
->node
, &thermal_tz_list
);
627 list_for_each_entry(pos
, &thermal_cdev_list
, node
) {
628 result
= ops
->bind(tz
, pos
);
632 mutex_unlock(&thermal_list_lock
);
638 release_idr(&thermal_tz_idr
, &thermal_idr_lock
, tz
->id
);
639 device_unregister(&tz
->device
);
642 EXPORT_SYMBOL(thermal_zone_device_register
);
645 * thermal_device_unregister - removes the registered thermal zone device
647 * @tz: the thermal zone device to remove
649 void thermal_zone_device_unregister(struct thermal_zone_device
*tz
)
651 struct thermal_cooling_device
*cdev
;
652 struct thermal_zone_device
*pos
= NULL
;
658 mutex_lock(&thermal_list_lock
);
659 list_for_each_entry(pos
, &thermal_tz_list
, node
)
663 /* thermal zone device not found */
664 mutex_unlock(&thermal_list_lock
);
669 list_for_each_entry(cdev
, &thermal_cdev_list
, node
)
670 tz
->ops
->unbind(tz
, cdev
);
671 mutex_unlock(&thermal_list_lock
);
674 device_remove_file(&tz
->device
, &dev_attr_type
);
675 device_remove_file(&tz
->device
, &dev_attr_temp
);
676 if (tz
->ops
->get_mode
)
677 device_remove_file(&tz
->device
, &dev_attr_mode
);
679 for (count
= 0; count
< tz
->trips
; count
++)
680 TRIP_POINT_ATTR_REMOVE(&tz
->device
, count
);
682 release_idr(&thermal_tz_idr
, &thermal_idr_lock
, tz
->id
);
683 idr_destroy(&tz
->idr
);
684 mutex_destroy(&tz
->lock
);
685 device_unregister(&tz
->device
);
688 EXPORT_SYMBOL(thermal_zone_device_unregister
);
690 static int __init
thermal_init(void)
694 result
= class_register(&thermal_class
);
696 idr_destroy(&thermal_tz_idr
);
697 idr_destroy(&thermal_cdev_idr
);
698 mutex_destroy(&thermal_idr_lock
);
699 mutex_destroy(&thermal_list_lock
);
704 static void __exit
thermal_exit(void)
706 class_unregister(&thermal_class
);
707 idr_destroy(&thermal_tz_idr
);
708 idr_destroy(&thermal_cdev_idr
);
709 mutex_destroy(&thermal_idr_lock
);
710 mutex_destroy(&thermal_list_lock
);
713 subsys_initcall(thermal_init
);
714 module_exit(thermal_exit
);