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