GNU Linux-libre 4.9.283-gnu1
[releases.git] / drivers / thermal / of-thermal.c
1 /*
2  *  of-thermal.c - Generic Thermal Management device tree support.
3  *
4  *  Copyright (C) 2013 Texas Instruments
5  *  Copyright (C) 2013 Eduardo Valentin <eduardo.valentin@ti.com>
6  *
7  *
8  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9  *
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.
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 #include <linux/thermal.h>
26 #include <linux/slab.h>
27 #include <linux/types.h>
28 #include <linux/of_device.h>
29 #include <linux/of_platform.h>
30 #include <linux/err.h>
31 #include <linux/export.h>
32 #include <linux/string.h>
33 #include <linux/thermal.h>
34
35 #include "thermal_core.h"
36
37 /***   Private data structures to represent thermal device tree data ***/
38
39 /**
40  * struct __thermal_bind_param - a match between trip and cooling device
41  * @cooling_device: a pointer to identify the referred cooling device
42  * @trip_id: the trip point index
43  * @usage: the percentage (from 0 to 100) of cooling contribution
44  * @min: minimum cooling state used at this trip point
45  * @max: maximum cooling state used at this trip point
46  */
47
48 struct __thermal_bind_params {
49         struct device_node *cooling_device;
50         unsigned int trip_id;
51         unsigned int usage;
52         unsigned long min;
53         unsigned long max;
54 };
55
56 /**
57  * struct __thermal_zone - internal representation of a thermal zone
58  * @mode: current thermal zone device mode (enabled/disabled)
59  * @passive_delay: polling interval while passive cooling is activated
60  * @polling_delay: zone polling interval
61  * @slope: slope of the temperature adjustment curve
62  * @offset: offset of the temperature adjustment curve
63  * @ntrips: number of trip points
64  * @trips: an array of trip points (0..ntrips - 1)
65  * @num_tbps: number of thermal bind params
66  * @tbps: an array of thermal bind params (0..num_tbps - 1)
67  * @sensor_data: sensor private data used while reading temperature and trend
68  * @ops: set of callbacks to handle the thermal zone based on DT
69  */
70
71 struct __thermal_zone {
72         enum thermal_device_mode mode;
73         int passive_delay;
74         int polling_delay;
75         int slope;
76         int offset;
77
78         /* trip data */
79         int ntrips;
80         struct thermal_trip *trips;
81
82         /* cooling binding data */
83         int num_tbps;
84         struct __thermal_bind_params *tbps;
85
86         /* sensor interface */
87         void *sensor_data;
88         const struct thermal_zone_of_device_ops *ops;
89 };
90
91 /***   DT thermal zone device callbacks   ***/
92
93 static int of_thermal_get_temp(struct thermal_zone_device *tz,
94                                int *temp)
95 {
96         struct __thermal_zone *data = tz->devdata;
97
98         if (!data->ops->get_temp)
99                 return -EINVAL;
100
101         return data->ops->get_temp(data->sensor_data, temp);
102 }
103
104 static int of_thermal_set_trips(struct thermal_zone_device *tz,
105                                 int low, int high)
106 {
107         struct __thermal_zone *data = tz->devdata;
108
109         if (!data->ops || !data->ops->set_trips)
110                 return -EINVAL;
111
112         return data->ops->set_trips(data->sensor_data, low, high);
113 }
114
115 /**
116  * of_thermal_get_ntrips - function to export number of available trip
117  *                         points.
118  * @tz: pointer to a thermal zone
119  *
120  * This function is a globally visible wrapper to get number of trip points
121  * stored in the local struct __thermal_zone
122  *
123  * Return: number of available trip points, -ENODEV when data not available
124  */
125 int of_thermal_get_ntrips(struct thermal_zone_device *tz)
126 {
127         struct __thermal_zone *data = tz->devdata;
128
129         if (!data || IS_ERR(data))
130                 return -ENODEV;
131
132         return data->ntrips;
133 }
134 EXPORT_SYMBOL_GPL(of_thermal_get_ntrips);
135
136 /**
137  * of_thermal_is_trip_valid - function to check if trip point is valid
138  *
139  * @tz: pointer to a thermal zone
140  * @trip:       trip point to evaluate
141  *
142  * This function is responsible for checking if passed trip point is valid
143  *
144  * Return: true if trip point is valid, false otherwise
145  */
146 bool of_thermal_is_trip_valid(struct thermal_zone_device *tz, int trip)
147 {
148         struct __thermal_zone *data = tz->devdata;
149
150         if (!data || trip >= data->ntrips || trip < 0)
151                 return false;
152
153         return true;
154 }
155 EXPORT_SYMBOL_GPL(of_thermal_is_trip_valid);
156
157 /**
158  * of_thermal_get_trip_points - function to get access to a globally exported
159  *                              trip points
160  *
161  * @tz: pointer to a thermal zone
162  *
163  * This function provides a pointer to trip points table
164  *
165  * Return: pointer to trip points table, NULL otherwise
166  */
167 const struct thermal_trip *
168 of_thermal_get_trip_points(struct thermal_zone_device *tz)
169 {
170         struct __thermal_zone *data = tz->devdata;
171
172         if (!data)
173                 return NULL;
174
175         return data->trips;
176 }
177 EXPORT_SYMBOL_GPL(of_thermal_get_trip_points);
178
179 /**
180  * of_thermal_set_emul_temp - function to set emulated temperature
181  *
182  * @tz: pointer to a thermal zone
183  * @temp:       temperature to set
184  *
185  * This function gives the ability to set emulated value of temperature,
186  * which is handy for debugging
187  *
188  * Return: zero on success, error code otherwise
189  */
190 static int of_thermal_set_emul_temp(struct thermal_zone_device *tz,
191                                     int temp)
192 {
193         struct __thermal_zone *data = tz->devdata;
194
195         return data->ops->set_emul_temp(data->sensor_data, temp);
196 }
197
198 static int of_thermal_get_trend(struct thermal_zone_device *tz, int trip,
199                                 enum thermal_trend *trend)
200 {
201         struct __thermal_zone *data = tz->devdata;
202
203         if (!data->ops->get_trend)
204                 return -EINVAL;
205
206         return data->ops->get_trend(data->sensor_data, trip, trend);
207 }
208
209 static int of_thermal_bind(struct thermal_zone_device *thermal,
210                            struct thermal_cooling_device *cdev)
211 {
212         struct __thermal_zone *data = thermal->devdata;
213         int i;
214
215         if (!data || IS_ERR(data))
216                 return -ENODEV;
217
218         /* find where to bind */
219         for (i = 0; i < data->num_tbps; i++) {
220                 struct __thermal_bind_params *tbp = data->tbps + i;
221
222                 if (tbp->cooling_device == cdev->np) {
223                         int ret;
224
225                         ret = thermal_zone_bind_cooling_device(thermal,
226                                                 tbp->trip_id, cdev,
227                                                 tbp->max,
228                                                 tbp->min,
229                                                 tbp->usage);
230                         if (ret)
231                                 return ret;
232                 }
233         }
234
235         return 0;
236 }
237
238 static int of_thermal_unbind(struct thermal_zone_device *thermal,
239                              struct thermal_cooling_device *cdev)
240 {
241         struct __thermal_zone *data = thermal->devdata;
242         int i;
243
244         if (!data || IS_ERR(data))
245                 return -ENODEV;
246
247         /* find where to unbind */
248         for (i = 0; i < data->num_tbps; i++) {
249                 struct __thermal_bind_params *tbp = data->tbps + i;
250
251                 if (tbp->cooling_device == cdev->np) {
252                         int ret;
253
254                         ret = thermal_zone_unbind_cooling_device(thermal,
255                                                 tbp->trip_id, cdev);
256                         if (ret)
257                                 return ret;
258                 }
259         }
260
261         return 0;
262 }
263
264 static int of_thermal_get_mode(struct thermal_zone_device *tz,
265                                enum thermal_device_mode *mode)
266 {
267         struct __thermal_zone *data = tz->devdata;
268
269         *mode = data->mode;
270
271         return 0;
272 }
273
274 static int of_thermal_set_mode(struct thermal_zone_device *tz,
275                                enum thermal_device_mode mode)
276 {
277         struct __thermal_zone *data = tz->devdata;
278
279         mutex_lock(&tz->lock);
280
281         if (mode == THERMAL_DEVICE_ENABLED) {
282                 tz->polling_delay = data->polling_delay;
283                 tz->passive_delay = data->passive_delay;
284         } else {
285                 tz->polling_delay = 0;
286                 tz->passive_delay = 0;
287         }
288
289         mutex_unlock(&tz->lock);
290
291         data->mode = mode;
292         thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
293
294         return 0;
295 }
296
297 static int of_thermal_get_trip_type(struct thermal_zone_device *tz, int trip,
298                                     enum thermal_trip_type *type)
299 {
300         struct __thermal_zone *data = tz->devdata;
301
302         if (trip >= data->ntrips || trip < 0)
303                 return -EDOM;
304
305         *type = data->trips[trip].type;
306
307         return 0;
308 }
309
310 static int of_thermal_get_trip_temp(struct thermal_zone_device *tz, int trip,
311                                     int *temp)
312 {
313         struct __thermal_zone *data = tz->devdata;
314
315         if (trip >= data->ntrips || trip < 0)
316                 return -EDOM;
317
318         *temp = data->trips[trip].temperature;
319
320         return 0;
321 }
322
323 static int of_thermal_set_trip_temp(struct thermal_zone_device *tz, int trip,
324                                     int temp)
325 {
326         struct __thermal_zone *data = tz->devdata;
327
328         if (trip >= data->ntrips || trip < 0)
329                 return -EDOM;
330
331         if (data->ops->set_trip_temp) {
332                 int ret;
333
334                 ret = data->ops->set_trip_temp(data->sensor_data, trip, temp);
335                 if (ret)
336                         return ret;
337         }
338
339         /* thermal framework should take care of data->mask & (1 << trip) */
340         data->trips[trip].temperature = temp;
341
342         return 0;
343 }
344
345 static int of_thermal_get_trip_hyst(struct thermal_zone_device *tz, int trip,
346                                     int *hyst)
347 {
348         struct __thermal_zone *data = tz->devdata;
349
350         if (trip >= data->ntrips || trip < 0)
351                 return -EDOM;
352
353         *hyst = data->trips[trip].hysteresis;
354
355         return 0;
356 }
357
358 static int of_thermal_set_trip_hyst(struct thermal_zone_device *tz, int trip,
359                                     int hyst)
360 {
361         struct __thermal_zone *data = tz->devdata;
362
363         if (trip >= data->ntrips || trip < 0)
364                 return -EDOM;
365
366         /* thermal framework should take care of data->mask & (1 << trip) */
367         data->trips[trip].hysteresis = hyst;
368
369         return 0;
370 }
371
372 static int of_thermal_get_crit_temp(struct thermal_zone_device *tz,
373                                     int *temp)
374 {
375         struct __thermal_zone *data = tz->devdata;
376         int i;
377
378         for (i = 0; i < data->ntrips; i++)
379                 if (data->trips[i].type == THERMAL_TRIP_CRITICAL) {
380                         *temp = data->trips[i].temperature;
381                         return 0;
382                 }
383
384         return -EINVAL;
385 }
386
387 static struct thermal_zone_device_ops of_thermal_ops = {
388         .get_mode = of_thermal_get_mode,
389         .set_mode = of_thermal_set_mode,
390
391         .get_trip_type = of_thermal_get_trip_type,
392         .get_trip_temp = of_thermal_get_trip_temp,
393         .set_trip_temp = of_thermal_set_trip_temp,
394         .get_trip_hyst = of_thermal_get_trip_hyst,
395         .set_trip_hyst = of_thermal_set_trip_hyst,
396         .get_crit_temp = of_thermal_get_crit_temp,
397
398         .bind = of_thermal_bind,
399         .unbind = of_thermal_unbind,
400 };
401
402 /***   sensor API   ***/
403
404 static struct thermal_zone_device *
405 thermal_zone_of_add_sensor(struct device_node *zone,
406                            struct device_node *sensor, void *data,
407                            const struct thermal_zone_of_device_ops *ops)
408 {
409         struct thermal_zone_device *tzd;
410         struct __thermal_zone *tz;
411
412         tzd = thermal_zone_get_zone_by_name(zone->name);
413         if (IS_ERR(tzd))
414                 return ERR_PTR(-EPROBE_DEFER);
415
416         tz = tzd->devdata;
417
418         if (!ops)
419                 return ERR_PTR(-EINVAL);
420
421         mutex_lock(&tzd->lock);
422         tz->ops = ops;
423         tz->sensor_data = data;
424
425         tzd->ops->get_temp = of_thermal_get_temp;
426         tzd->ops->get_trend = of_thermal_get_trend;
427
428         /*
429          * The thermal zone core will calculate the window if they have set the
430          * optional set_trips pointer.
431          */
432         if (ops->set_trips)
433                 tzd->ops->set_trips = of_thermal_set_trips;
434
435         if (ops->set_emul_temp)
436                 tzd->ops->set_emul_temp = of_thermal_set_emul_temp;
437
438         mutex_unlock(&tzd->lock);
439
440         return tzd;
441 }
442
443 /**
444  * thermal_zone_of_sensor_register - registers a sensor to a DT thermal zone
445  * @dev: a valid struct device pointer of a sensor device. Must contain
446  *       a valid .of_node, for the sensor node.
447  * @sensor_id: a sensor identifier, in case the sensor IP has more
448  *             than one sensors
449  * @data: a private pointer (owned by the caller) that will be passed
450  *        back, when a temperature reading is needed.
451  * @ops: struct thermal_zone_of_device_ops *. Must contain at least .get_temp.
452  *
453  * This function will search the list of thermal zones described in device
454  * tree and look for the zone that refer to the sensor device pointed by
455  * @dev->of_node as temperature providers. For the zone pointing to the
456  * sensor node, the sensor will be added to the DT thermal zone device.
457  *
458  * The thermal zone temperature is provided by the @get_temp function
459  * pointer. When called, it will have the private pointer @data back.
460  *
461  * The thermal zone temperature trend is provided by the @get_trend function
462  * pointer. When called, it will have the private pointer @data back.
463  *
464  * TODO:
465  * 01 - This function must enqueue the new sensor instead of using
466  * it as the only source of temperature values.
467  *
468  * 02 - There must be a way to match the sensor with all thermal zones
469  * that refer to it.
470  *
471  * Return: On success returns a valid struct thermal_zone_device,
472  * otherwise, it returns a corresponding ERR_PTR(). Caller must
473  * check the return value with help of IS_ERR() helper.
474  */
475 struct thermal_zone_device *
476 thermal_zone_of_sensor_register(struct device *dev, int sensor_id, void *data,
477                                 const struct thermal_zone_of_device_ops *ops)
478 {
479         struct device_node *np, *child, *sensor_np;
480         struct thermal_zone_device *tzd = ERR_PTR(-ENODEV);
481
482         np = of_find_node_by_name(NULL, "thermal-zones");
483         if (!np)
484                 return ERR_PTR(-ENODEV);
485
486         if (!dev || !dev->of_node) {
487                 of_node_put(np);
488                 return ERR_PTR(-EINVAL);
489         }
490
491         sensor_np = of_node_get(dev->of_node);
492
493         for_each_available_child_of_node(np, child) {
494                 struct of_phandle_args sensor_specs;
495                 int ret, id;
496
497                 /* For now, thermal framework supports only 1 sensor per zone */
498                 ret = of_parse_phandle_with_args(child, "thermal-sensors",
499                                                  "#thermal-sensor-cells",
500                                                  0, &sensor_specs);
501                 if (ret)
502                         continue;
503
504                 if (sensor_specs.args_count >= 1) {
505                         id = sensor_specs.args[0];
506                         WARN(sensor_specs.args_count > 1,
507                              "%s: too many cells in sensor specifier %d\n",
508                              sensor_specs.np->name, sensor_specs.args_count);
509                 } else {
510                         id = 0;
511                 }
512
513                 if (sensor_specs.np == sensor_np && id == sensor_id) {
514                         tzd = thermal_zone_of_add_sensor(child, sensor_np,
515                                                          data, ops);
516                         if (!IS_ERR(tzd))
517                                 tzd->ops->set_mode(tzd, THERMAL_DEVICE_ENABLED);
518
519                         of_node_put(sensor_specs.np);
520                         of_node_put(child);
521                         goto exit;
522                 }
523                 of_node_put(sensor_specs.np);
524         }
525 exit:
526         of_node_put(sensor_np);
527         of_node_put(np);
528
529         return tzd;
530 }
531 EXPORT_SYMBOL_GPL(thermal_zone_of_sensor_register);
532
533 /**
534  * thermal_zone_of_sensor_unregister - unregisters a sensor from a DT thermal zone
535  * @dev: a valid struct device pointer of a sensor device. Must contain
536  *       a valid .of_node, for the sensor node.
537  * @tzd: a pointer to struct thermal_zone_device where the sensor is registered.
538  *
539  * This function removes the sensor callbacks and private data from the
540  * thermal zone device registered with thermal_zone_of_sensor_register()
541  * API. It will also silent the zone by remove the .get_temp() and .get_trend()
542  * thermal zone device callbacks.
543  *
544  * TODO: When the support to several sensors per zone is added, this
545  * function must search the sensor list based on @dev parameter.
546  *
547  */
548 void thermal_zone_of_sensor_unregister(struct device *dev,
549                                        struct thermal_zone_device *tzd)
550 {
551         struct __thermal_zone *tz;
552
553         if (!dev || !tzd || !tzd->devdata)
554                 return;
555
556         tz = tzd->devdata;
557
558         /* no __thermal_zone, nothing to be done */
559         if (!tz)
560                 return;
561
562         mutex_lock(&tzd->lock);
563         tzd->ops->get_temp = NULL;
564         tzd->ops->get_trend = NULL;
565         tzd->ops->set_emul_temp = NULL;
566
567         tz->ops = NULL;
568         tz->sensor_data = NULL;
569         mutex_unlock(&tzd->lock);
570 }
571 EXPORT_SYMBOL_GPL(thermal_zone_of_sensor_unregister);
572
573 static void devm_thermal_zone_of_sensor_release(struct device *dev, void *res)
574 {
575         thermal_zone_of_sensor_unregister(dev,
576                                           *(struct thermal_zone_device **)res);
577 }
578
579 static int devm_thermal_zone_of_sensor_match(struct device *dev, void *res,
580                                              void *data)
581 {
582         struct thermal_zone_device **r = res;
583
584         if (WARN_ON(!r || !*r))
585                 return 0;
586
587         return *r == data;
588 }
589
590 /**
591  * devm_thermal_zone_of_sensor_register - Resource managed version of
592  *                              thermal_zone_of_sensor_register()
593  * @dev: a valid struct device pointer of a sensor device. Must contain
594  *       a valid .of_node, for the sensor node.
595  * @sensor_id: a sensor identifier, in case the sensor IP has more
596  *             than one sensors
597  * @data: a private pointer (owned by the caller) that will be passed
598  *        back, when a temperature reading is needed.
599  * @ops: struct thermal_zone_of_device_ops *. Must contain at least .get_temp.
600  *
601  * Refer thermal_zone_of_sensor_register() for more details.
602  *
603  * Return: On success returns a valid struct thermal_zone_device,
604  * otherwise, it returns a corresponding ERR_PTR(). Caller must
605  * check the return value with help of IS_ERR() helper.
606  * Registered thermal_zone_device device will automatically be
607  * released when device is unbounded.
608  */
609 struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
610         struct device *dev, int sensor_id,
611         void *data, const struct thermal_zone_of_device_ops *ops)
612 {
613         struct thermal_zone_device **ptr, *tzd;
614
615         ptr = devres_alloc(devm_thermal_zone_of_sensor_release, sizeof(*ptr),
616                            GFP_KERNEL);
617         if (!ptr)
618                 return ERR_PTR(-ENOMEM);
619
620         tzd = thermal_zone_of_sensor_register(dev, sensor_id, data, ops);
621         if (IS_ERR(tzd)) {
622                 devres_free(ptr);
623                 return tzd;
624         }
625
626         *ptr = tzd;
627         devres_add(dev, ptr);
628
629         return tzd;
630 }
631 EXPORT_SYMBOL_GPL(devm_thermal_zone_of_sensor_register);
632
633 /**
634  * devm_thermal_zone_of_sensor_unregister - Resource managed version of
635  *                              thermal_zone_of_sensor_unregister().
636  * @dev: Device for which which resource was allocated.
637  * @tzd: a pointer to struct thermal_zone_device where the sensor is registered.
638  *
639  * This function removes the sensor callbacks and private data from the
640  * thermal zone device registered with devm_thermal_zone_of_sensor_register()
641  * API. It will also silent the zone by remove the .get_temp() and .get_trend()
642  * thermal zone device callbacks.
643  * Normally this function will not need to be called and the resource
644  * management code will ensure that the resource is freed.
645  */
646 void devm_thermal_zone_of_sensor_unregister(struct device *dev,
647                                             struct thermal_zone_device *tzd)
648 {
649         WARN_ON(devres_release(dev, devm_thermal_zone_of_sensor_release,
650                                devm_thermal_zone_of_sensor_match, tzd));
651 }
652 EXPORT_SYMBOL_GPL(devm_thermal_zone_of_sensor_unregister);
653
654 /***   functions parsing device tree nodes   ***/
655
656 /**
657  * thermal_of_populate_bind_params - parse and fill cooling map data
658  * @np: DT node containing a cooling-map node
659  * @__tbp: data structure to be filled with cooling map info
660  * @trips: array of thermal zone trip points
661  * @ntrips: number of trip points inside trips.
662  *
663  * This function parses a cooling-map type of node represented by
664  * @np parameter and fills the read data into @__tbp data structure.
665  * It needs the already parsed array of trip points of the thermal zone
666  * in consideration.
667  *
668  * Return: 0 on success, proper error code otherwise
669  */
670 static int thermal_of_populate_bind_params(struct device_node *np,
671                                            struct __thermal_bind_params *__tbp,
672                                            struct thermal_trip *trips,
673                                            int ntrips)
674 {
675         struct of_phandle_args cooling_spec;
676         struct device_node *trip;
677         int ret, i;
678         u32 prop;
679
680         /* Default weight. Usage is optional */
681         __tbp->usage = THERMAL_WEIGHT_DEFAULT;
682         ret = of_property_read_u32(np, "contribution", &prop);
683         if (ret == 0)
684                 __tbp->usage = prop;
685
686         trip = of_parse_phandle(np, "trip", 0);
687         if (!trip) {
688                 pr_err("missing trip property\n");
689                 return -ENODEV;
690         }
691
692         /* match using device_node */
693         for (i = 0; i < ntrips; i++)
694                 if (trip == trips[i].np) {
695                         __tbp->trip_id = i;
696                         break;
697                 }
698
699         if (i == ntrips) {
700                 ret = -ENODEV;
701                 goto end;
702         }
703
704         ret = of_parse_phandle_with_args(np, "cooling-device", "#cooling-cells",
705                                          0, &cooling_spec);
706         if (ret < 0) {
707                 pr_err("missing cooling_device property\n");
708                 goto end;
709         }
710         __tbp->cooling_device = cooling_spec.np;
711         if (cooling_spec.args_count >= 2) { /* at least min and max */
712                 __tbp->min = cooling_spec.args[0];
713                 __tbp->max = cooling_spec.args[1];
714         } else {
715                 pr_err("wrong reference to cooling device, missing limits\n");
716         }
717
718 end:
719         of_node_put(trip);
720
721         return ret;
722 }
723
724 /**
725  * It maps 'enum thermal_trip_type' found in include/linux/thermal.h
726  * into the device tree binding of 'trip', property type.
727  */
728 static const char * const trip_types[] = {
729         [THERMAL_TRIP_ACTIVE]   = "active",
730         [THERMAL_TRIP_PASSIVE]  = "passive",
731         [THERMAL_TRIP_HOT]      = "hot",
732         [THERMAL_TRIP_CRITICAL] = "critical",
733 };
734
735 /**
736  * thermal_of_get_trip_type - Get phy mode for given device_node
737  * @np: Pointer to the given device_node
738  * @type: Pointer to resulting trip type
739  *
740  * The function gets trip type string from property 'type',
741  * and store its index in trip_types table in @type,
742  *
743  * Return: 0 on success, or errno in error case.
744  */
745 static int thermal_of_get_trip_type(struct device_node *np,
746                                     enum thermal_trip_type *type)
747 {
748         const char *t;
749         int err, i;
750
751         err = of_property_read_string(np, "type", &t);
752         if (err < 0)
753                 return err;
754
755         for (i = 0; i < ARRAY_SIZE(trip_types); i++)
756                 if (!strcasecmp(t, trip_types[i])) {
757                         *type = i;
758                         return 0;
759                 }
760
761         return -ENODEV;
762 }
763
764 /**
765  * thermal_of_populate_trip - parse and fill one trip point data
766  * @np: DT node containing a trip point node
767  * @trip: trip point data structure to be filled up
768  *
769  * This function parses a trip point type of node represented by
770  * @np parameter and fills the read data into @trip data structure.
771  *
772  * Return: 0 on success, proper error code otherwise
773  */
774 static int thermal_of_populate_trip(struct device_node *np,
775                                     struct thermal_trip *trip)
776 {
777         int prop;
778         int ret;
779
780         ret = of_property_read_u32(np, "temperature", &prop);
781         if (ret < 0) {
782                 pr_err("missing temperature property\n");
783                 return ret;
784         }
785         trip->temperature = prop;
786
787         ret = of_property_read_u32(np, "hysteresis", &prop);
788         if (ret < 0) {
789                 pr_err("missing hysteresis property\n");
790                 return ret;
791         }
792         trip->hysteresis = prop;
793
794         ret = thermal_of_get_trip_type(np, &trip->type);
795         if (ret < 0) {
796                 pr_err("wrong trip type property\n");
797                 return ret;
798         }
799
800         /* Required for cooling map matching */
801         trip->np = np;
802         of_node_get(np);
803
804         return 0;
805 }
806
807 /**
808  * thermal_of_build_thermal_zone - parse and fill one thermal zone data
809  * @np: DT node containing a thermal zone node
810  *
811  * This function parses a thermal zone type of node represented by
812  * @np parameter and fills the read data into a __thermal_zone data structure
813  * and return this pointer.
814  *
815  * TODO: Missing properties to parse: thermal-sensor-names
816  *
817  * Return: On success returns a valid struct __thermal_zone,
818  * otherwise, it returns a corresponding ERR_PTR(). Caller must
819  * check the return value with help of IS_ERR() helper.
820  */
821 static struct __thermal_zone
822 __init *thermal_of_build_thermal_zone(struct device_node *np)
823 {
824         struct device_node *child = NULL, *gchild;
825         struct __thermal_zone *tz;
826         int ret, i;
827         u32 prop, coef[2];
828
829         if (!np) {
830                 pr_err("no thermal zone np\n");
831                 return ERR_PTR(-EINVAL);
832         }
833
834         tz = kzalloc(sizeof(*tz), GFP_KERNEL);
835         if (!tz)
836                 return ERR_PTR(-ENOMEM);
837
838         ret = of_property_read_u32(np, "polling-delay-passive", &prop);
839         if (ret < 0) {
840                 pr_err("missing polling-delay-passive property\n");
841                 goto free_tz;
842         }
843         tz->passive_delay = prop;
844
845         ret = of_property_read_u32(np, "polling-delay", &prop);
846         if (ret < 0) {
847                 pr_err("missing polling-delay property\n");
848                 goto free_tz;
849         }
850         tz->polling_delay = prop;
851
852         /*
853          * REVIST: for now, the thermal framework supports only
854          * one sensor per thermal zone. Thus, we are considering
855          * only the first two values as slope and offset.
856          */
857         ret = of_property_read_u32_array(np, "coefficients", coef, 2);
858         if (ret == 0) {
859                 tz->slope = coef[0];
860                 tz->offset = coef[1];
861         } else {
862                 tz->slope = 1;
863                 tz->offset = 0;
864         }
865
866         /* trips */
867         child = of_get_child_by_name(np, "trips");
868
869         /* No trips provided */
870         if (!child)
871                 goto finish;
872
873         tz->ntrips = of_get_child_count(child);
874         if (tz->ntrips == 0) /* must have at least one child */
875                 goto finish;
876
877         tz->trips = kzalloc(tz->ntrips * sizeof(*tz->trips), GFP_KERNEL);
878         if (!tz->trips) {
879                 ret = -ENOMEM;
880                 goto free_tz;
881         }
882
883         i = 0;
884         for_each_child_of_node(child, gchild) {
885                 ret = thermal_of_populate_trip(gchild, &tz->trips[i++]);
886                 if (ret)
887                         goto free_trips;
888         }
889
890         of_node_put(child);
891
892         /* cooling-maps */
893         child = of_get_child_by_name(np, "cooling-maps");
894
895         /* cooling-maps not provided */
896         if (!child)
897                 goto finish;
898
899         tz->num_tbps = of_get_child_count(child);
900         if (tz->num_tbps == 0)
901                 goto finish;
902
903         tz->tbps = kzalloc(tz->num_tbps * sizeof(*tz->tbps), GFP_KERNEL);
904         if (!tz->tbps) {
905                 ret = -ENOMEM;
906                 goto free_trips;
907         }
908
909         i = 0;
910         for_each_child_of_node(child, gchild) {
911                 ret = thermal_of_populate_bind_params(gchild, &tz->tbps[i++],
912                                                       tz->trips, tz->ntrips);
913                 if (ret)
914                         goto free_tbps;
915         }
916
917 finish:
918         of_node_put(child);
919         tz->mode = THERMAL_DEVICE_DISABLED;
920
921         return tz;
922
923 free_tbps:
924         for (i = i - 1; i >= 0; i--)
925                 of_node_put(tz->tbps[i].cooling_device);
926         kfree(tz->tbps);
927 free_trips:
928         for (i = 0; i < tz->ntrips; i++)
929                 of_node_put(tz->trips[i].np);
930         kfree(tz->trips);
931         of_node_put(gchild);
932 free_tz:
933         kfree(tz);
934         of_node_put(child);
935
936         return ERR_PTR(ret);
937 }
938
939 static inline void of_thermal_free_zone(struct __thermal_zone *tz)
940 {
941         int i;
942
943         for (i = 0; i < tz->num_tbps; i++)
944                 of_node_put(tz->tbps[i].cooling_device);
945         kfree(tz->tbps);
946         for (i = 0; i < tz->ntrips; i++)
947                 of_node_put(tz->trips[i].np);
948         kfree(tz->trips);
949         kfree(tz);
950 }
951
952 /**
953  * of_parse_thermal_zones - parse device tree thermal data
954  *
955  * Initialization function that can be called by machine initialization
956  * code to parse thermal data and populate the thermal framework
957  * with hardware thermal zones info. This function only parses thermal zones.
958  * Cooling devices and sensor devices nodes are supposed to be parsed
959  * by their respective drivers.
960  *
961  * Return: 0 on success, proper error code otherwise
962  *
963  */
964 int __init of_parse_thermal_zones(void)
965 {
966         struct device_node *np, *child;
967         struct __thermal_zone *tz;
968         struct thermal_zone_device_ops *ops;
969
970         np = of_find_node_by_name(NULL, "thermal-zones");
971         if (!np) {
972                 pr_debug("unable to find thermal zones\n");
973                 return 0; /* Run successfully on systems without thermal DT */
974         }
975
976         for_each_available_child_of_node(np, child) {
977                 struct thermal_zone_device *zone;
978                 struct thermal_zone_params *tzp;
979                 int i, mask = 0;
980                 u32 prop;
981
982                 tz = thermal_of_build_thermal_zone(child);
983                 if (IS_ERR(tz)) {
984                         pr_err("failed to build thermal zone %s: %ld\n",
985                                child->name,
986                                PTR_ERR(tz));
987                         continue;
988                 }
989
990                 ops = kmemdup(&of_thermal_ops, sizeof(*ops), GFP_KERNEL);
991                 if (!ops)
992                         goto exit_free;
993
994                 tzp = kzalloc(sizeof(*tzp), GFP_KERNEL);
995                 if (!tzp) {
996                         kfree(ops);
997                         goto exit_free;
998                 }
999
1000                 /* No hwmon because there might be hwmon drivers registering */
1001                 tzp->no_hwmon = true;
1002
1003                 if (!of_property_read_u32(child, "sustainable-power", &prop))
1004                         tzp->sustainable_power = prop;
1005
1006                 for (i = 0; i < tz->ntrips; i++)
1007                         mask |= 1 << i;
1008
1009                 /* these two are left for temperature drivers to use */
1010                 tzp->slope = tz->slope;
1011                 tzp->offset = tz->offset;
1012
1013                 zone = thermal_zone_device_register(child->name, tz->ntrips,
1014                                                     mask, tz,
1015                                                     ops, tzp,
1016                                                     tz->passive_delay,
1017                                                     tz->polling_delay);
1018                 if (IS_ERR(zone)) {
1019                         pr_err("Failed to build %s zone %ld\n", child->name,
1020                                PTR_ERR(zone));
1021                         kfree(tzp);
1022                         kfree(ops);
1023                         of_thermal_free_zone(tz);
1024                         /* attempting to build remaining zones still */
1025                 }
1026         }
1027         of_node_put(np);
1028
1029         return 0;
1030
1031 exit_free:
1032         of_node_put(child);
1033         of_node_put(np);
1034         of_thermal_free_zone(tz);
1035
1036         /* no memory available, so free what we have built */
1037         of_thermal_destroy_zones();
1038
1039         return -ENOMEM;
1040 }
1041
1042 /**
1043  * of_thermal_destroy_zones - remove all zones parsed and allocated resources
1044  *
1045  * Finds all zones parsed and added to the thermal framework and remove them
1046  * from the system, together with their resources.
1047  *
1048  */
1049 void of_thermal_destroy_zones(void)
1050 {
1051         struct device_node *np, *child;
1052
1053         np = of_find_node_by_name(NULL, "thermal-zones");
1054         if (!np) {
1055                 pr_debug("unable to find thermal zones\n");
1056                 return;
1057         }
1058
1059         for_each_available_child_of_node(np, child) {
1060                 struct thermal_zone_device *zone;
1061
1062                 zone = thermal_zone_get_zone_by_name(child->name);
1063                 if (IS_ERR(zone))
1064                         continue;
1065
1066                 thermal_zone_device_unregister(zone);
1067                 kfree(zone->tzp);
1068                 kfree(zone->ops);
1069                 of_thermal_free_zone(zone->devdata);
1070         }
1071         of_node_put(np);
1072 }