drivers/base/power/opp/core.c

   1 /*
   2  * Generic OPP Interface
   3  *
   4  * Copyright (C) 2009-2010 Texas Instruments Incorporated.
   5  *      Nishanth Menon
   6  *      Romit Dasgupta
   7  *      Kevin Hilman
   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 version 2 as
  11  * published by the Free Software Foundation.
  12  */
  13
  14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  15
  16 #include <linux/clk.h>
  17 #include <linux/errno.h>
  18 #include <linux/err.h>
  19 #include <linux/slab.h>
  20 #include <linux/device.h>
  21 #include <linux/export.h>
  22 #include <linux/regulator/consumer.h>
  23
  24 #include "opp.h"
  25
  26 /*
  27  * The root of the list of all opp-tables. All opp_table structures branch off
  28  * from here, with each opp_table containing the list of opps it supports in
  29  * various states of availability.
  30  */
  31 LIST_HEAD(opp_tables);
  32 /* Lock to allow exclusive modification to the device and opp lists */
  33 DEFINE_MUTEX(opp_table_lock);
  34
  35 static void dev_pm_opp_get(struct dev_pm_opp *opp);
  36
  37 static struct opp_device *_find_opp_dev(const struct device *dev,
  38                                         struct opp_table *opp_table)
  39 {
  40         struct opp_device *opp_dev;
  41
  42         list_for_each_entry(opp_dev, &opp_table->dev_list, node)
  43                 if (opp_dev->dev == dev)
  44                         return opp_dev;
  45
  46         return NULL;
  47 }
  48
  49 static struct opp_table *_find_opp_table_unlocked(struct device *dev)
  50 {
  51         struct opp_table *opp_table;
  52
  53         list_for_each_entry(opp_table, &opp_tables, node) {
  54                 if (_find_opp_dev(dev, opp_table)) {
  55                         _get_opp_table_kref(opp_table);
  56
  57                         return opp_table;
  58                 }
  59         }
  60
  61         return ERR_PTR(-ENODEV);
  62 }
  63
  64 /**
  65  * _find_opp_table() - find opp_table struct using device pointer
  66  * @dev:        device pointer used to lookup OPP table
  67  *
  68  * Search OPP table for one containing matching device.
  69  *
  70  * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
  71  * -EINVAL based on type of error.
  72  *
  73  * The callers must call dev_pm_opp_put_opp_table() after the table is used.
  74  */
  75 struct opp_table *_find_opp_table(struct device *dev)
  76 {
  77         struct opp_table *opp_table;
  78
  79         if (IS_ERR_OR_NULL(dev)) {
  80                 pr_err("%s: Invalid parameters\n", __func__);
  81                 return ERR_PTR(-EINVAL);
  82         }
  83
  84         mutex_lock(&opp_table_lock);
  85         opp_table = _find_opp_table_unlocked(dev);
  86         mutex_unlock(&opp_table_lock);
  87
  88         return opp_table;
  89 }
  90
  91 /**
  92  * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
  93  * @opp:        opp for which voltage has to be returned for
  94  *
  95  * Return: voltage in micro volt corresponding to the opp, else
  96  * return 0
  97  *
  98  * This is useful only for devices with single power supply.
  99  */
 100 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
 101 {
 102         if (IS_ERR_OR_NULL(opp)) {
 103                 pr_err("%s: Invalid parameters\n", __func__);
 104                 return 0;
 105         }
 106
 107         return opp->supplies[0].u_volt;
 108 }
 109 EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
 110
 111 /**
 112  * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
 113  * @opp:        opp for which frequency has to be returned for
 114  *
 115  * Return: frequency in hertz corresponding to the opp, else
 116  * return 0
 117  */
 118 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
 119 {
 120         if (IS_ERR_OR_NULL(opp) || !opp->available) {
 121                 pr_err("%s: Invalid parameters\n", __func__);
 122                 return 0;
 123         }
 124
 125         return opp->rate;
 126 }
 127 EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
 128
 129 /**
 130  * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
 131  * @opp: opp for which turbo mode is being verified
 132  *
 133  * Turbo OPPs are not for normal use, and can be enabled (under certain
 134  * conditions) for short duration of times to finish high throughput work
 135  * quickly. Running on them for longer times may overheat the chip.
 136  *
 137  * Return: true if opp is turbo opp, else false.
 138  */
 139 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
 140 {
 141         if (IS_ERR_OR_NULL(opp) || !opp->available) {
 142                 pr_err("%s: Invalid parameters\n", __func__);
 143                 return false;
 144         }
 145
 146         return opp->turbo;
 147 }
 148 EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
 149
 150 /**
 151  * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
 152  * @dev:        device for which we do this operation
 153  *
 154  * Return: This function returns the max clock latency in nanoseconds.
 155  */
 156 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
 157 {
 158         struct opp_table *opp_table;
 159         unsigned long clock_latency_ns;
 160
 161         opp_table = _find_opp_table(dev);
 162         if (IS_ERR(opp_table))
 163                 return 0;
 164
 165         clock_latency_ns = opp_table->clock_latency_ns_max;
 166
 167         dev_pm_opp_put_opp_table(opp_table);
 168
 169         return clock_latency_ns;
 170 }
 171 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
 172
 173 /**
 174  * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
 175  * @dev: device for which we do this operation
 176  *
 177  * Return: This function returns the max voltage latency in nanoseconds.
 178  */
 179 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
 180 {
 181         struct opp_table *opp_table;
 182         struct dev_pm_opp *opp;
 183         struct regulator *reg, **regulators;
 184         unsigned long latency_ns = 0;
 185         int ret, i, count;
 186         struct {
 187                 unsigned long min;
 188                 unsigned long max;
 189         } *uV;
 190
 191         opp_table = _find_opp_table(dev);
 192         if (IS_ERR(opp_table))
 193                 return 0;
 194
 195         count = opp_table->regulator_count;
 196
 197         /* Regulator may not be required for the device */
 198         if (!count)
 199                 goto put_opp_table;
 200
 201         regulators = kmalloc_array(count, sizeof(*regulators), GFP_KERNEL);
 202         if (!regulators)
 203                 goto put_opp_table;
 204
 205         uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
 206         if (!uV)
 207                 goto free_regulators;
 208
 209         memcpy(regulators, opp_table->regulators, count * sizeof(*regulators));
 210
 211         mutex_lock(&opp_table->lock);
 212
 213         for (i = 0; i < count; i++) {
 214                 uV[i].min = ~0;
 215                 uV[i].max = 0;
 216
 217                 list_for_each_entry(opp, &opp_table->opp_list, node) {
 218                         if (!opp->available)
 219                                 continue;
 220
 221                         if (opp->supplies[i].u_volt_min < uV[i].min)
 222                                 uV[i].min = opp->supplies[i].u_volt_min;
 223                         if (opp->supplies[i].u_volt_max > uV[i].max)
 224                                 uV[i].max = opp->supplies[i].u_volt_max;
 225                 }
 226         }
 227
 228         mutex_unlock(&opp_table->lock);
 229
 230         /*
 231          * The caller needs to ensure that opp_table (and hence the regulator)
 232          * isn't freed, while we are executing this routine.
 233          */
 234         for (i = 0; reg = regulators[i], i < count; i++) {
 235                 ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
 236                 if (ret > 0)
 237                         latency_ns += ret * 1000;
 238         }
 239
 240         kfree(uV);
 241 free_regulators:
 242         kfree(regulators);
 243 put_opp_table:
 244         dev_pm_opp_put_opp_table(opp_table);
 245
 246         return latency_ns;
 247 }
 248 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
 249
 250 /**
 251  * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
 252  *                                           nanoseconds
 253  * @dev: device for which we do this operation
 254  *
 255  * Return: This function returns the max transition latency, in nanoseconds, to
 256  * switch from one OPP to other.
 257  */
 258 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
 259 {
 260         return dev_pm_opp_get_max_volt_latency(dev) +
 261                 dev_pm_opp_get_max_clock_latency(dev);
 262 }
 263 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
 264
 265 /**
 266  * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
 267  * @dev:        device for which we do this operation
 268  *
 269  * Return: This function returns the frequency of the OPP marked as suspend_opp
 270  * if one is available, else returns 0;
 271  */
 272 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
 273 {
 274         struct opp_table *opp_table;
 275         unsigned long freq = 0;
 276
 277         opp_table = _find_opp_table(dev);
 278         if (IS_ERR(opp_table))
 279                 return 0;
 280
 281         if (opp_table->suspend_opp && opp_table->suspend_opp->available)
 282                 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
 283
 284         dev_pm_opp_put_opp_table(opp_table);
 285
 286         return freq;
 287 }
 288 EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
 289
 290 /**
 291  * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
 292  * @dev:        device for which we do this operation
 293  *
 294  * Return: This function returns the number of available opps if there are any,
 295  * else returns 0 if none or the corresponding error value.
 296  */
 297 int dev_pm_opp_get_opp_count(struct device *dev)
 298 {
 299         struct opp_table *opp_table;
 300         struct dev_pm_opp *temp_opp;
 301         int count = 0;
 302
 303         opp_table = _find_opp_table(dev);
 304         if (IS_ERR(opp_table)) {
 305                 count = PTR_ERR(opp_table);
 306                 dev_err(dev, "%s: OPP table not found (%d)\n",
 307                         __func__, count);
 308                 return count;
 309         }
 310
 311         mutex_lock(&opp_table->lock);
 312
 313         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
 314                 if (temp_opp->available)
 315                         count++;
 316         }
 317
 318         mutex_unlock(&opp_table->lock);
 319         dev_pm_opp_put_opp_table(opp_table);
 320
 321         return count;
 322 }
 323 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
 324
 325 /**
 326  * dev_pm_opp_find_freq_exact() - search for an exact frequency
 327  * @dev:                device for which we do this operation
 328  * @freq:               frequency to search for
 329  * @available:          true/false - match for available opp
 330  *
 331  * Return: Searches for exact match in the opp table and returns pointer to the
 332  * matching opp if found, else returns ERR_PTR in case of error and should
 333  * be handled using IS_ERR. Error return values can be:
 334  * EINVAL:      for bad pointer
 335  * ERANGE:      no match found for search
 336  * ENODEV:      if device not found in list of registered devices
 337  *
 338  * Note: available is a modifier for the search. if available=true, then the
 339  * match is for exact matching frequency and is available in the stored OPP
 340  * table. if false, the match is for exact frequency which is not available.
 341  *
 342  * This provides a mechanism to enable an opp which is not available currently
 343  * or the opposite as well.
 344  *
 345  * The callers are required to call dev_pm_opp_put() for the returned OPP after
 346  * use.
 347  */
 348 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
 349                                               unsigned long freq,
 350                                               bool available)
 351 {
 352         struct opp_table *opp_table;
 353         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
 354
 355         opp_table = _find_opp_table(dev);
 356         if (IS_ERR(opp_table)) {
 357                 int r = PTR_ERR(opp_table);
 358
 359                 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
 360                 return ERR_PTR(r);
 361         }
 362
 363         mutex_lock(&opp_table->lock);
 364
 365         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
 366                 if (temp_opp->available == available &&
 367                                 temp_opp->rate == freq) {
 368                         opp = temp_opp;
 369
 370                         /* Increment the reference count of OPP */
 371                         dev_pm_opp_get(opp);
 372                         break;
 373                 }
 374         }
 375
 376         mutex_unlock(&opp_table->lock);
 377         dev_pm_opp_put_opp_table(opp_table);
 378
 379         return opp;
 380 }
 381 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
 382
 383 static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
 384                                                    unsigned long *freq)
 385 {
 386         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
 387
 388         mutex_lock(&opp_table->lock);
 389
 390         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
 391                 if (temp_opp->available && temp_opp->rate >= *freq) {
 392                         opp = temp_opp;
 393                         *freq = opp->rate;
 394
 395                         /* Increment the reference count of OPP */
 396                         dev_pm_opp_get(opp);
 397                         break;
 398                 }
 399         }
 400
 401         mutex_unlock(&opp_table->lock);
 402
 403         return opp;
 404 }
 405
 406 /**
 407  * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
 408  * @dev:        device for which we do this operation
 409  * @freq:       Start frequency
 410  *
 411  * Search for the matching ceil *available* OPP from a starting freq
 412  * for a device.
 413  *
 414  * Return: matching *opp and refreshes *freq accordingly, else returns
 415  * ERR_PTR in case of error and should be handled using IS_ERR. Error return
 416  * values can be:
 417  * EINVAL:      for bad pointer
 418  * ERANGE:      no match found for search
 419  * ENODEV:      if device not found in list of registered devices
 420  *
 421  * The callers are required to call dev_pm_opp_put() for the returned OPP after
 422  * use.
 423  */
 424 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
 425                                              unsigned long *freq)
 426 {
 427         struct opp_table *opp_table;
 428         struct dev_pm_opp *opp;
 429
 430         if (!dev || !freq) {
 431                 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
 432                 return ERR_PTR(-EINVAL);
 433         }
 434
 435         opp_table = _find_opp_table(dev);
 436         if (IS_ERR(opp_table))
 437                 return ERR_CAST(opp_table);
 438
 439         opp = _find_freq_ceil(opp_table, freq);
 440
 441         dev_pm_opp_put_opp_table(opp_table);
 442
 443         return opp;
 444 }
 445 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
 446
 447 /**
 448  * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
 449  * @dev:        device for which we do this operation
 450  * @freq:       Start frequency
 451  *
 452  * Search for the matching floor *available* OPP from a starting freq
 453  * for a device.
 454  *
 455  * Return: matching *opp and refreshes *freq accordingly, else returns
 456  * ERR_PTR in case of error and should be handled using IS_ERR. Error return
 457  * values can be:
 458  * EINVAL:      for bad pointer
 459  * ERANGE:      no match found for search
 460  * ENODEV:      if device not found in list of registered devices
 461  *
 462  * The callers are required to call dev_pm_opp_put() for the returned OPP after
 463  * use.
 464  */
 465 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
 466                                               unsigned long *freq)
 467 {
 468         struct opp_table *opp_table;
 469         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
 470
 471         if (!dev || !freq) {
 472                 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
 473                 return ERR_PTR(-EINVAL);
 474         }
 475
 476         opp_table = _find_opp_table(dev);
 477         if (IS_ERR(opp_table))
 478                 return ERR_CAST(opp_table);
 479
 480         mutex_lock(&opp_table->lock);
 481
 482         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
 483                 if (temp_opp->available) {
 484                         /* go to the next node, before choosing prev */
 485                         if (temp_opp->rate > *freq)
 486                                 break;
 487                         else
 488                                 opp = temp_opp;
 489                 }
 490         }
 491
 492         /* Increment the reference count of OPP */
 493         if (!IS_ERR(opp))
 494                 dev_pm_opp_get(opp);
 495         mutex_unlock(&opp_table->lock);
 496         dev_pm_opp_put_opp_table(opp_table);
 497
 498         if (!IS_ERR(opp))
 499                 *freq = opp->rate;
 500
 501         return opp;
 502 }
 503 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
 504
 505 static int _set_opp_voltage(struct device *dev, struct regulator *reg,
 506                             struct dev_pm_opp_supply *supply)
 507 {
 508         int ret;
 509
 510         /* Regulator not available for device */
 511         if (IS_ERR(reg)) {
 512                 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
 513                         PTR_ERR(reg));
 514                 return 0;
 515         }
 516
 517         dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
 518                 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
 519
 520         ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
 521                                             supply->u_volt, supply->u_volt_max);
 522         if (ret)
 523                 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
 524                         __func__, supply->u_volt_min, supply->u_volt,
 525                         supply->u_volt_max, ret);
 526
 527         return ret;
 528 }
 529
 530 static inline int
 531 _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
 532                           unsigned long old_freq, unsigned long freq)
 533 {
 534         int ret;
 535
 536         ret = clk_set_rate(clk, freq);
 537         if (ret) {
 538                 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
 539                         ret);
 540         }
 541
 542         return ret;
 543 }
 544
 545 static int _generic_set_opp(struct dev_pm_set_opp_data *data)
 546 {
 547         struct dev_pm_opp_supply *old_supply = data->old_opp.supplies;
 548         struct dev_pm_opp_supply *new_supply = data->new_opp.supplies;
 549         unsigned long old_freq = data->old_opp.rate, freq = data->new_opp.rate;
 550         struct regulator *reg = data->regulators[0];
 551         struct device *dev= data->dev;
 552         int ret;
 553
 554         /* This function only supports single regulator per device */
 555         if (WARN_ON(data->regulator_count > 1)) {
 556                 dev_err(dev, "multiple regulators are not supported\n");
 557                 return -EINVAL;
 558         }
 559
 560         /* Scaling up? Scale voltage before frequency */
 561         if (freq > old_freq) {
 562                 ret = _set_opp_voltage(dev, reg, new_supply);
 563                 if (ret)
 564                         goto restore_voltage;
 565         }
 566
 567         /* Change frequency */
 568         ret = _generic_set_opp_clk_only(dev, data->clk, old_freq, freq);
 569         if (ret)
 570                 goto restore_voltage;
 571
 572         /* Scaling down? Scale voltage after frequency */
 573         if (freq < old_freq) {
 574                 ret = _set_opp_voltage(dev, reg, new_supply);
 575                 if (ret)
 576                         goto restore_freq;
 577         }
 578
 579         return 0;
 580
 581 restore_freq:
 582         if (_generic_set_opp_clk_only(dev, data->clk, freq, old_freq))
 583                 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
 584                         __func__, old_freq);
 585 restore_voltage:
 586         /* This shouldn't harm even if the voltages weren't updated earlier */
 587         if (old_supply->u_volt)
 588                 _set_opp_voltage(dev, reg, old_supply);
 589
 590         return ret;
 591 }
 592
 593 /**
 594  * dev_pm_opp_set_rate() - Configure new OPP based on frequency
 595  * @dev:         device for which we do this operation
 596  * @target_freq: frequency to achieve
 597  *
 598  * This configures the power-supplies and clock source to the levels specified
 599  * by the OPP corresponding to the target_freq.
 600  */
 601 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
 602 {
 603         struct opp_table *opp_table;
 604         unsigned long freq, old_freq;
 605         int (*set_opp)(struct dev_pm_set_opp_data *data);
 606         struct dev_pm_opp *old_opp, *opp;
 607         struct regulator **regulators;
 608         struct dev_pm_set_opp_data *data;
 609         struct clk *clk;
 610         int ret, size;
 611
 612         if (unlikely(!target_freq)) {
 613                 dev_err(dev, "%s: Invalid target frequency %lu\n", __func__,
 614                         target_freq);
 615                 return -EINVAL;
 616         }
 617
 618         opp_table = _find_opp_table(dev);
 619         if (IS_ERR(opp_table)) {
 620                 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
 621                 return PTR_ERR(opp_table);
 622         }
 623
 624         clk = opp_table->clk;
 625         if (IS_ERR(clk)) {
 626                 dev_err(dev, "%s: No clock available for the device\n",
 627                         __func__);
 628                 ret = PTR_ERR(clk);
 629                 goto put_opp_table;
 630         }
 631
 632         freq = clk_round_rate(clk, target_freq);
 633         if ((long)freq <= 0)
 634                 freq = target_freq;
 635
 636         old_freq = clk_get_rate(clk);
 637
 638         /* Return early if nothing to do */
 639         if (old_freq == freq) {
 640                 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
 641                         __func__, freq);
 642                 ret = 0;
 643                 goto put_opp_table;
 644         }
 645
 646         old_opp = _find_freq_ceil(opp_table, &old_freq);
 647         if (IS_ERR(old_opp)) {
 648                 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
 649                         __func__, old_freq, PTR_ERR(old_opp));
 650         }
 651
 652         opp = _find_freq_ceil(opp_table, &freq);
 653         if (IS_ERR(opp)) {
 654                 ret = PTR_ERR(opp);
 655                 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
 656                         __func__, freq, ret);
 657                 goto put_old_opp;
 658         }
 659
 660         dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
 661                 old_freq, freq);
 662
 663         regulators = opp_table->regulators;
 664
 665         /* Only frequency scaling */
 666         if (!regulators) {
 667                 ret = _generic_set_opp_clk_only(dev, clk, old_freq, freq);
 668                 goto put_opps;
 669         }
 670
 671         if (opp_table->set_opp)
 672                 set_opp = opp_table->set_opp;
 673         else
 674                 set_opp = _generic_set_opp;
 675
 676         data = opp_table->set_opp_data;
 677         data->regulators = regulators;
 678         data->regulator_count = opp_table->regulator_count;
 679         data->clk = clk;
 680         data->dev = dev;
 681
 682         data->old_opp.rate = old_freq;
 683         size = sizeof(*opp->supplies) * opp_table->regulator_count;
 684         if (IS_ERR(old_opp))
 685                 memset(data->old_opp.supplies, 0, size);
 686         else
 687                 memcpy(data->old_opp.supplies, old_opp->supplies, size);
 688
 689         data->new_opp.rate = freq;
 690         memcpy(data->new_opp.supplies, opp->supplies, size);
 691
 692         ret = set_opp(data);
 693
 694 put_opps:
 695         dev_pm_opp_put(opp);
 696 put_old_opp:
 697         if (!IS_ERR(old_opp))
 698                 dev_pm_opp_put(old_opp);
 699 put_opp_table:
 700         dev_pm_opp_put_opp_table(opp_table);
 701         return ret;
 702 }
 703 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
 704
 705 /* OPP-dev Helpers */
 706 static void _remove_opp_dev(struct opp_device *opp_dev,
 707                             struct opp_table *opp_table)
 708 {
 709         opp_debug_unregister(opp_dev, opp_table);
 710         list_del(&opp_dev->node);
 711         kfree(opp_dev);
 712 }
 713
 714 struct opp_device *_add_opp_dev(const struct device *dev,
 715                                 struct opp_table *opp_table)
 716 {
 717         struct opp_device *opp_dev;
 718         int ret;
 719
 720         opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
 721         if (!opp_dev)
 722                 return NULL;
 723
 724         /* Initialize opp-dev */
 725         opp_dev->dev = dev;
 726         list_add(&opp_dev->node, &opp_table->dev_list);
 727
 728         /* Create debugfs entries for the opp_table */
 729         ret = opp_debug_register(opp_dev, opp_table);
 730         if (ret)
 731                 dev_err(dev, "%s: Failed to register opp debugfs (%d)\n",
 732                         __func__, ret);
 733
 734         return opp_dev;
 735 }
 736
 737 static struct opp_table *_allocate_opp_table(struct device *dev)
 738 {
 739         struct opp_table *opp_table;
 740         struct opp_device *opp_dev;
 741         int ret;
 742
 743         /*
 744          * Allocate a new OPP table. In the infrequent case where a new
 745          * device is needed to be added, we pay this penalty.
 746          */
 747         opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
 748         if (!opp_table)
 749                 return NULL;
 750
 751         INIT_LIST_HEAD(&opp_table->dev_list);
 752
 753         opp_dev = _add_opp_dev(dev, opp_table);
 754         if (!opp_dev) {
 755                 kfree(opp_table);
 756                 return NULL;
 757         }
 758
 759         _of_init_opp_table(opp_table, dev);
 760
 761         /* Find clk for the device */
 762         opp_table->clk = clk_get(dev, NULL);
 763         if (IS_ERR(opp_table->clk)) {
 764                 ret = PTR_ERR(opp_table->clk);
 765                 if (ret != -EPROBE_DEFER)
 766                         dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
 767                                 ret);
 768         }
 769
 770         BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
 771         INIT_LIST_HEAD(&opp_table->opp_list);
 772         mutex_init(&opp_table->lock);
 773         kref_init(&opp_table->kref);
 774
 775         /* Secure the device table modification */
 776         list_add(&opp_table->node, &opp_tables);
 777         return opp_table;
 778 }
 779
 780 void _get_opp_table_kref(struct opp_table *opp_table)
 781 {
 782         kref_get(&opp_table->kref);
 783 }
 784
 785 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
 786 {
 787         struct opp_table *opp_table;
 788
 789         /* Hold our table modification lock here */
 790         mutex_lock(&opp_table_lock);
 791
 792         opp_table = _find_opp_table_unlocked(dev);
 793         if (!IS_ERR(opp_table))
 794                 goto unlock;
 795
 796         opp_table = _allocate_opp_table(dev);
 797
 798 unlock:
 799         mutex_unlock(&opp_table_lock);
 800
 801         return opp_table;
 802 }
 803 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
 804
 805 static void _opp_table_kref_release(struct kref *kref)
 806 {
 807         struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
 808         struct opp_device *opp_dev;
 809
 810         /* Release clk */
 811         if (!IS_ERR(opp_table->clk))
 812                 clk_put(opp_table->clk);
 813
 814         opp_dev = list_first_entry(&opp_table->dev_list, struct opp_device,
 815                                    node);
 816
 817         _remove_opp_dev(opp_dev, opp_table);
 818
 819         /* dev_list must be empty now */
 820         WARN_ON(!list_empty(&opp_table->dev_list));
 821
 822         mutex_destroy(&opp_table->lock);
 823         list_del(&opp_table->node);
 824         kfree(opp_table);
 825
 826         mutex_unlock(&opp_table_lock);
 827 }
 828
 829 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
 830 {
 831         kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
 832                        &opp_table_lock);
 833 }
 834 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
 835
 836 void _opp_free(struct dev_pm_opp *opp)
 837 {
 838         kfree(opp);
 839 }
 840
 841 static void _opp_kref_release(struct kref *kref)
 842 {
 843         struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
 844         struct opp_table *opp_table = opp->opp_table;
 845
 846         /*
 847          * Notify the changes in the availability of the operable
 848          * frequency/voltage list.
 849          */
 850         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
 851         opp_debug_remove_one(opp);
 852         list_del(&opp->node);
 853         kfree(opp);
 854
 855         mutex_unlock(&opp_table->lock);
 856         dev_pm_opp_put_opp_table(opp_table);
 857 }
 858
 859 static void dev_pm_opp_get(struct dev_pm_opp *opp)
 860 {
 861         kref_get(&opp->kref);
 862 }
 863
 864 void dev_pm_opp_put(struct dev_pm_opp *opp)
 865 {
 866         kref_put_mutex(&opp->kref, _opp_kref_release, &opp->opp_table->lock);
 867 }
 868 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
 869
 870 /**
 871  * dev_pm_opp_remove()  - Remove an OPP from OPP table
 872  * @dev:        device for which we do this operation
 873  * @freq:       OPP to remove with matching 'freq'
 874  *
 875  * This function removes an opp from the opp table.
 876  */
 877 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
 878 {
 879         struct dev_pm_opp *opp;
 880         struct opp_table *opp_table;
 881         bool found = false;
 882
 883         opp_table = _find_opp_table(dev);
 884         if (IS_ERR(opp_table))
 885                 return;
 886
 887         mutex_lock(&opp_table->lock);
 888
 889         list_for_each_entry(opp, &opp_table->opp_list, node) {
 890                 if (opp->rate == freq) {
 891                         found = true;
 892                         break;
 893                 }
 894         }
 895
 896         mutex_unlock(&opp_table->lock);
 897
 898         if (found) {
 899                 dev_pm_opp_put(opp);
 900         } else {
 901                 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
 902                          __func__, freq);
 903         }
 904
 905         dev_pm_opp_put_opp_table(opp_table);
 906 }
 907 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
 908
 909 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
 910 {
 911         struct dev_pm_opp *opp;
 912         int count, supply_size;
 913
 914         /* Allocate space for at least one supply */
 915         count = table->regulator_count ? table->regulator_count : 1;
 916         supply_size = sizeof(*opp->supplies) * count;
 917
 918         /* allocate new OPP node and supplies structures */
 919         opp = kzalloc(sizeof(*opp) + supply_size, GFP_KERNEL);
 920         if (!opp)
 921                 return NULL;
 922
 923         /* Put the supplies at the end of the OPP structure as an empty array */
 924         opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
 925         INIT_LIST_HEAD(&opp->node);
 926
 927         return opp;
 928 }
 929
 930 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
 931                                          struct opp_table *opp_table)
 932 {
 933         struct regulator *reg;
 934         int i;
 935
 936         for (i = 0; i < opp_table->regulator_count; i++) {
 937                 reg = opp_table->regulators[i];
 938
 939                 if (!regulator_is_supported_voltage(reg,
 940                                         opp->supplies[i].u_volt_min,
 941                                         opp->supplies[i].u_volt_max)) {
 942                         pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
 943                                 __func__, opp->supplies[i].u_volt_min,
 944                                 opp->supplies[i].u_volt_max);
 945                         return false;
 946                 }
 947         }
 948
 949         return true;
 950 }
 951
 952 /*
 953  * Returns:
 954  * 0: On success. And appropriate error message for duplicate OPPs.
 955  * -EBUSY: For OPP with same freq/volt and is available. The callers of
 956  *  _opp_add() must return 0 if they receive -EBUSY from it. This is to make
 957  *  sure we don't print error messages unnecessarily if different parts of
 958  *  kernel try to initialize the OPP table.
 959  * -EEXIST: For OPP with same freq but different volt or is unavailable. This
 960  *  should be considered an error by the callers of _opp_add().
 961  */
 962 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
 963              struct opp_table *opp_table)
 964 {
 965         struct dev_pm_opp *opp;
 966         struct list_head *head;
 967         int ret;
 968
 969         /*
 970          * Insert new OPP in order of increasing frequency and discard if
 971          * already present.
 972          *
 973          * Need to use &opp_table->opp_list in the condition part of the 'for'
 974          * loop, don't replace it with head otherwise it will become an infinite
 975          * loop.
 976          */
 977         mutex_lock(&opp_table->lock);
 978         head = &opp_table->opp_list;
 979
 980         list_for_each_entry(opp, &opp_table->opp_list, node) {
 981                 if (new_opp->rate > opp->rate) {
 982                         head = &opp->node;
 983                         continue;
 984                 }
 985
 986                 if (new_opp->rate < opp->rate)
 987                         break;
 988
 989                 /* Duplicate OPPs */
 990                 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
 991                          __func__, opp->rate, opp->supplies[0].u_volt,
 992                          opp->available, new_opp->rate,
 993                          new_opp->supplies[0].u_volt, new_opp->available);
 994
 995                 /* Should we compare voltages for all regulators here ? */
 996                 ret = opp->available &&
 997                       new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
 998
 999                 mutex_unlock(&opp_table->lock);
1000                 return ret;
1001         }
1002
1003         list_add(&new_opp->node, head);
1004         mutex_unlock(&opp_table->lock);
1005
1006         new_opp->opp_table = opp_table;
1007         kref_init(&new_opp->kref);
1008
1009         /* Get a reference to the OPP table */
1010         _get_opp_table_kref(opp_table);
1011
1012         ret = opp_debug_create_one(new_opp, opp_table);
1013         if (ret)
1014                 dev_err(dev, "%s: Failed to register opp to debugfs (%d)\n",
1015                         __func__, ret);
1016
1017         if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1018                 new_opp->available = false;
1019                 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1020                          __func__, new_opp->rate);
1021         }
1022
1023         return 0;
1024 }
1025
1026 /**
1027  * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1028  * @opp_table:  OPP table
1029  * @dev:        device for which we do this operation
1030  * @freq:       Frequency in Hz for this OPP
1031  * @u_volt:     Voltage in uVolts for this OPP
1032  * @dynamic:    Dynamically added OPPs.
1033  *
1034  * This function adds an opp definition to the opp table and returns status.
1035  * The opp is made available by default and it can be controlled using
1036  * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1037  *
1038  * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1039  * and freed by dev_pm_opp_of_remove_table.
1040  *
1041  * Return:
1042  * 0            On success OR
1043  *              Duplicate OPPs (both freq and volt are same) and opp->available
1044  * -EEXIST      Freq are same and volt are different OR
1045  *              Duplicate OPPs (both freq and volt are same) and !opp->available
1046  * -ENOMEM      Memory allocation failure
1047  */
1048 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1049                 unsigned long freq, long u_volt, bool dynamic)
1050 {
1051         struct dev_pm_opp *new_opp;
1052         unsigned long tol;
1053         int ret;
1054
1055         new_opp = _opp_allocate(opp_table);
1056         if (!new_opp)
1057                 return -ENOMEM;
1058
1059         /* populate the opp table */
1060         new_opp->rate = freq;
1061         tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1062         new_opp->supplies[0].u_volt = u_volt;
1063         new_opp->supplies[0].u_volt_min = u_volt - tol;
1064         new_opp->supplies[0].u_volt_max = u_volt + tol;
1065         new_opp->available = true;
1066         new_opp->dynamic = dynamic;
1067
1068         ret = _opp_add(dev, new_opp, opp_table);
1069         if (ret) {
1070                 /* Don't return error for duplicate OPPs */
1071                 if (ret == -EBUSY)
1072                         ret = 0;
1073                 goto free_opp;
1074         }
1075
1076         /*
1077          * Notify the changes in the availability of the operable
1078          * frequency/voltage list.
1079          */
1080         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1081         return 0;
1082
1083 free_opp:
1084         _opp_free(new_opp);
1085
1086         return ret;
1087 }
1088
1089 /**
1090  * dev_pm_opp_set_supported_hw() - Set supported platforms
1091  * @dev: Device for which supported-hw has to be set.
1092  * @versions: Array of hierarchy of versions to match.
1093  * @count: Number of elements in the array.
1094  *
1095  * This is required only for the V2 bindings, and it enables a platform to
1096  * specify the hierarchy of versions it supports. OPP layer will then enable
1097  * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1098  * property.
1099  */
1100 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1101                         const u32 *versions, unsigned int count)
1102 {
1103         struct opp_table *opp_table;
1104         int ret;
1105
1106         opp_table = dev_pm_opp_get_opp_table(dev);
1107         if (!opp_table)
1108                 return ERR_PTR(-ENOMEM);
1109
1110         /* Make sure there are no concurrent readers while updating opp_table */
1111         WARN_ON(!list_empty(&opp_table->opp_list));
1112
1113         /* Do we already have a version hierarchy associated with opp_table? */
1114         if (opp_table->supported_hw) {
1115                 dev_err(dev, "%s: Already have supported hardware list\n",
1116                         __func__);
1117                 ret = -EBUSY;
1118                 goto err;
1119         }
1120
1121         opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1122                                         GFP_KERNEL);
1123         if (!opp_table->supported_hw) {
1124                 ret = -ENOMEM;
1125                 goto err;
1126         }
1127
1128         opp_table->supported_hw_count = count;
1129
1130         return opp_table;
1131
1132 err:
1133         dev_pm_opp_put_opp_table(opp_table);
1134
1135         return ERR_PTR(ret);
1136 }
1137 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1138
1139 /**
1140  * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1141  * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1142  *
1143  * This is required only for the V2 bindings, and is called for a matching
1144  * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1145  * will not be freed.
1146  */
1147 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1148 {
1149         /* Make sure there are no concurrent readers while updating opp_table */
1150         WARN_ON(!list_empty(&opp_table->opp_list));
1151
1152         if (!opp_table->supported_hw) {
1153                 pr_err("%s: Doesn't have supported hardware list\n",
1154                        __func__);
1155                 return;
1156         }
1157
1158         kfree(opp_table->supported_hw);
1159         opp_table->supported_hw = NULL;
1160         opp_table->supported_hw_count = 0;
1161
1162         dev_pm_opp_put_opp_table(opp_table);
1163 }
1164 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1165
1166 /**
1167  * dev_pm_opp_set_prop_name() - Set prop-extn name
1168  * @dev: Device for which the prop-name has to be set.
1169  * @name: name to postfix to properties.
1170  *
1171  * This is required only for the V2 bindings, and it enables a platform to
1172  * specify the extn to be used for certain property names. The properties to
1173  * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1174  * should postfix the property name with -<name> while looking for them.
1175  */
1176 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1177 {
1178         struct opp_table *opp_table;
1179         int ret;
1180
1181         opp_table = dev_pm_opp_get_opp_table(dev);
1182         if (!opp_table)
1183                 return ERR_PTR(-ENOMEM);
1184
1185         /* Make sure there are no concurrent readers while updating opp_table */
1186         WARN_ON(!list_empty(&opp_table->opp_list));
1187
1188         /* Do we already have a prop-name associated with opp_table? */
1189         if (opp_table->prop_name) {
1190                 dev_err(dev, "%s: Already have prop-name %s\n", __func__,
1191                         opp_table->prop_name);
1192                 ret = -EBUSY;
1193                 goto err;
1194         }
1195
1196         opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1197         if (!opp_table->prop_name) {
1198                 ret = -ENOMEM;
1199                 goto err;
1200         }
1201
1202         return opp_table;
1203
1204 err:
1205         dev_pm_opp_put_opp_table(opp_table);
1206
1207         return ERR_PTR(ret);
1208 }
1209 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1210
1211 /**
1212  * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1213  * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1214  *
1215  * This is required only for the V2 bindings, and is called for a matching
1216  * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1217  * will not be freed.
1218  */
1219 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1220 {
1221         /* Make sure there are no concurrent readers while updating opp_table */
1222         WARN_ON(!list_empty(&opp_table->opp_list));
1223
1224         if (!opp_table->prop_name) {
1225                 pr_err("%s: Doesn't have a prop-name\n", __func__);
1226                 return;
1227         }
1228
1229         kfree(opp_table->prop_name);
1230         opp_table->prop_name = NULL;
1231
1232         dev_pm_opp_put_opp_table(opp_table);
1233 }
1234 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1235
1236 static int _allocate_set_opp_data(struct opp_table *opp_table)
1237 {
1238         struct dev_pm_set_opp_data *data;
1239         int len, count = opp_table->regulator_count;
1240
1241         if (WARN_ON(!count))
1242                 return -EINVAL;
1243
1244         /* space for set_opp_data */
1245         len = sizeof(*data);
1246
1247         /* space for old_opp.supplies and new_opp.supplies */
1248         len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1249
1250         data = kzalloc(len, GFP_KERNEL);
1251         if (!data)
1252                 return -ENOMEM;
1253
1254         data->old_opp.supplies = (void *)(data + 1);
1255         data->new_opp.supplies = data->old_opp.supplies + count;
1256
1257         opp_table->set_opp_data = data;
1258
1259         return 0;
1260 }
1261
1262 static void _free_set_opp_data(struct opp_table *opp_table)
1263 {
1264         kfree(opp_table->set_opp_data);
1265         opp_table->set_opp_data = NULL;
1266 }
1267
1268 /**
1269  * dev_pm_opp_set_regulators() - Set regulator names for the device
1270  * @dev: Device for which regulator name is being set.
1271  * @names: Array of pointers to the names of the regulator.
1272  * @count: Number of regulators.
1273  *
1274  * In order to support OPP switching, OPP layer needs to know the name of the
1275  * device's regulators, as the core would be required to switch voltages as
1276  * well.
1277  *
1278  * This must be called before any OPPs are initialized for the device.
1279  */
1280 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1281                                             const char * const names[],
1282                                             unsigned int count)
1283 {
1284         struct opp_table *opp_table;
1285         struct regulator *reg;
1286         int ret, i;
1287
1288         opp_table = dev_pm_opp_get_opp_table(dev);
1289         if (!opp_table)
1290                 return ERR_PTR(-ENOMEM);
1291
1292         /* This should be called before OPPs are initialized */
1293         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1294                 ret = -EBUSY;
1295                 goto err;
1296         }
1297
1298         /* Already have regulators set */
1299         if (opp_table->regulators) {
1300                 ret = -EBUSY;
1301                 goto err;
1302         }
1303
1304         opp_table->regulators = kmalloc_array(count,
1305                                               sizeof(*opp_table->regulators),
1306                                               GFP_KERNEL);
1307         if (!opp_table->regulators) {
1308                 ret = -ENOMEM;
1309                 goto err;
1310         }
1311
1312         for (i = 0; i < count; i++) {
1313                 reg = regulator_get_optional(dev, names[i]);
1314                 if (IS_ERR(reg)) {
1315                         ret = PTR_ERR(reg);
1316                         if (ret != -EPROBE_DEFER)
1317                                 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1318                                         __func__, names[i], ret);
1319                         goto free_regulators;
1320                 }
1321
1322                 opp_table->regulators[i] = reg;
1323         }
1324
1325         opp_table->regulator_count = count;
1326
1327         /* Allocate block only once to pass to set_opp() routines */
1328         ret = _allocate_set_opp_data(opp_table);
1329         if (ret)
1330                 goto free_regulators;
1331
1332         return opp_table;
1333
1334 free_regulators:
1335         while (i != 0)
1336                 regulator_put(opp_table->regulators[--i]);
1337
1338         kfree(opp_table->regulators);
1339         opp_table->regulators = NULL;
1340         opp_table->regulator_count = 0;
1341 err:
1342         dev_pm_opp_put_opp_table(opp_table);
1343
1344         return ERR_PTR(ret);
1345 }
1346 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1347
1348 /**
1349  * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1350  * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1351  */
1352 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1353 {
1354         int i;
1355
1356         if (!opp_table->regulators) {
1357                 pr_err("%s: Doesn't have regulators set\n", __func__);
1358                 return;
1359         }
1360
1361         /* Make sure there are no concurrent readers while updating opp_table */
1362         WARN_ON(!list_empty(&opp_table->opp_list));
1363
1364         for (i = opp_table->regulator_count - 1; i >= 0; i--)
1365                 regulator_put(opp_table->regulators[i]);
1366
1367         _free_set_opp_data(opp_table);
1368
1369         kfree(opp_table->regulators);
1370         opp_table->regulators = NULL;
1371         opp_table->regulator_count = 0;
1372
1373         dev_pm_opp_put_opp_table(opp_table);
1374 }
1375 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1376
1377 /**
1378  * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1379  * @dev: Device for which the helper is getting registered.
1380  * @set_opp: Custom set OPP helper.
1381  *
1382  * This is useful to support complex platforms (like platforms with multiple
1383  * regulators per device), instead of the generic OPP set rate helper.
1384  *
1385  * This must be called before any OPPs are initialized for the device.
1386  */
1387 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1388                         int (*set_opp)(struct dev_pm_set_opp_data *data))
1389 {
1390         struct opp_table *opp_table;
1391         int ret;
1392
1393         if (!set_opp)
1394                 return ERR_PTR(-EINVAL);
1395
1396         opp_table = dev_pm_opp_get_opp_table(dev);
1397         if (!opp_table)
1398                 return ERR_PTR(-ENOMEM);
1399
1400         /* This should be called before OPPs are initialized */
1401         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1402                 ret = -EBUSY;
1403                 goto err;
1404         }
1405
1406         /* Already have custom set_opp helper */
1407         if (WARN_ON(opp_table->set_opp)) {
1408                 ret = -EBUSY;
1409                 goto err;
1410         }
1411
1412         opp_table->set_opp = set_opp;
1413
1414         return opp_table;
1415
1416 err:
1417         dev_pm_opp_put_opp_table(opp_table);
1418
1419         return ERR_PTR(ret);
1420 }
1421 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1422
1423 /**
1424  * dev_pm_opp_register_put_opp_helper() - Releases resources blocked for
1425  *                                         set_opp helper
1426  * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1427  *
1428  * Release resources blocked for platform specific set_opp helper.
1429  */
1430 void dev_pm_opp_register_put_opp_helper(struct opp_table *opp_table)
1431 {
1432         if (!opp_table->set_opp) {
1433                 pr_err("%s: Doesn't have custom set_opp helper set\n",
1434                        __func__);
1435                 return;
1436         }
1437
1438         /* Make sure there are no concurrent readers while updating opp_table */
1439         WARN_ON(!list_empty(&opp_table->opp_list));
1440
1441         opp_table->set_opp = NULL;
1442
1443         dev_pm_opp_put_opp_table(opp_table);
1444 }
1445 EXPORT_SYMBOL_GPL(dev_pm_opp_register_put_opp_helper);
1446
1447 /**
1448  * dev_pm_opp_add()  - Add an OPP table from a table definitions
1449  * @dev:        device for which we do this operation
1450  * @freq:       Frequency in Hz for this OPP
1451  * @u_volt:     Voltage in uVolts for this OPP
1452  *
1453  * This function adds an opp definition to the opp table and returns status.
1454  * The opp is made available by default and it can be controlled using
1455  * dev_pm_opp_enable/disable functions.
1456  *
1457  * Return:
1458  * 0            On success OR
1459  *              Duplicate OPPs (both freq and volt are same) and opp->available
1460  * -EEXIST      Freq are same and volt are different OR
1461  *              Duplicate OPPs (both freq and volt are same) and !opp->available
1462  * -ENOMEM      Memory allocation failure
1463  */
1464 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
1465 {
1466         struct opp_table *opp_table;
1467         int ret;
1468
1469         opp_table = dev_pm_opp_get_opp_table(dev);
1470         if (!opp_table)
1471                 return -ENOMEM;
1472
1473         ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
1474
1475         dev_pm_opp_put_opp_table(opp_table);
1476         return ret;
1477 }
1478 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
1479
1480 /**
1481  * _opp_set_availability() - helper to set the availability of an opp
1482  * @dev:                device for which we do this operation
1483  * @freq:               OPP frequency to modify availability
1484  * @availability_req:   availability status requested for this opp
1485  *
1486  * Set the availability of an OPP, opp_{enable,disable} share a common logic
1487  * which is isolated here.
1488  *
1489  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1490  * copy operation, returns 0 if no modification was done OR modification was
1491  * successful.
1492  */
1493 static int _opp_set_availability(struct device *dev, unsigned long freq,
1494                                  bool availability_req)
1495 {
1496         struct opp_table *opp_table;
1497         struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
1498         int r = 0;
1499
1500         /* Find the opp_table */
1501         opp_table = _find_opp_table(dev);
1502         if (IS_ERR(opp_table)) {
1503                 r = PTR_ERR(opp_table);
1504                 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
1505                 return r;
1506         }
1507
1508         mutex_lock(&opp_table->lock);
1509
1510         /* Do we have the frequency? */
1511         list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
1512                 if (tmp_opp->rate == freq) {
1513                         opp = tmp_opp;
1514                         break;
1515                 }
1516         }
1517
1518         if (IS_ERR(opp)) {
1519                 r = PTR_ERR(opp);
1520                 goto unlock;
1521         }
1522
1523         /* Is update really needed? */
1524         if (opp->available == availability_req)
1525                 goto unlock;
1526
1527         opp->available = availability_req;
1528
1529         /* Notify the change of the OPP availability */
1530         if (availability_req)
1531                 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
1532                                              opp);
1533         else
1534                 blocking_notifier_call_chain(&opp_table->head,
1535                                              OPP_EVENT_DISABLE, opp);
1536
1537 unlock:
1538         mutex_unlock(&opp_table->lock);
1539         dev_pm_opp_put_opp_table(opp_table);
1540         return r;
1541 }
1542
1543 /**
1544  * dev_pm_opp_enable() - Enable a specific OPP
1545  * @dev:        device for which we do this operation
1546  * @freq:       OPP frequency to enable
1547  *
1548  * Enables a provided opp. If the operation is valid, this returns 0, else the
1549  * corresponding error value. It is meant to be used for users an OPP available
1550  * after being temporarily made unavailable with dev_pm_opp_disable.
1551  *
1552  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1553  * copy operation, returns 0 if no modification was done OR modification was
1554  * successful.
1555  */
1556 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
1557 {
1558         return _opp_set_availability(dev, freq, true);
1559 }
1560 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
1561
1562 /**
1563  * dev_pm_opp_disable() - Disable a specific OPP
1564  * @dev:        device for which we do this operation
1565  * @freq:       OPP frequency to disable
1566  *
1567  * Disables a provided opp. If the operation is valid, this returns
1568  * 0, else the corresponding error value. It is meant to be a temporary
1569  * control by users to make this OPP not available until the circumstances are
1570  * right to make it available again (with a call to dev_pm_opp_enable).
1571  *
1572  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1573  * copy operation, returns 0 if no modification was done OR modification was
1574  * successful.
1575  */
1576 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
1577 {
1578         return _opp_set_availability(dev, freq, false);
1579 }
1580 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
1581
1582 /**
1583  * dev_pm_opp_register_notifier() - Register OPP notifier for the device
1584  * @dev:        Device for which notifier needs to be registered
1585  * @nb:         Notifier block to be registered
1586  *
1587  * Return: 0 on success or a negative error value.
1588  */
1589 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
1590 {
1591         struct opp_table *opp_table;
1592         int ret;
1593
1594         opp_table = _find_opp_table(dev);
1595         if (IS_ERR(opp_table))
1596                 return PTR_ERR(opp_table);
1597
1598         ret = blocking_notifier_chain_register(&opp_table->head, nb);
1599
1600         dev_pm_opp_put_opp_table(opp_table);
1601
1602         return ret;
1603 }
1604 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
1605
1606 /**
1607  * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
1608  * @dev:        Device for which notifier needs to be unregistered
1609  * @nb:         Notifier block to be unregistered
1610  *
1611  * Return: 0 on success or a negative error value.
1612  */
1613 int dev_pm_opp_unregister_notifier(struct device *dev,
1614                                    struct notifier_block *nb)
1615 {
1616         struct opp_table *opp_table;
1617         int ret;
1618
1619         opp_table = _find_opp_table(dev);
1620         if (IS_ERR(opp_table))
1621                 return PTR_ERR(opp_table);
1622
1623         ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
1624
1625         dev_pm_opp_put_opp_table(opp_table);
1626
1627         return ret;
1628 }
1629 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
1630
1631 /*
1632  * Free OPPs either created using static entries present in DT or even the
1633  * dynamically added entries based on remove_all param.
1634  */
1635 void _dev_pm_opp_remove_table(struct opp_table *opp_table, struct device *dev,
1636                               bool remove_all)
1637 {
1638         struct dev_pm_opp *opp, *tmp;
1639
1640         /* Find if opp_table manages a single device */
1641         if (list_is_singular(&opp_table->dev_list)) {
1642                 /* Free static OPPs */
1643                 list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1644                         if (remove_all || !opp->dynamic)
1645                                 dev_pm_opp_put(opp);
1646                 }
1647         } else {
1648                 _remove_opp_dev(_find_opp_dev(dev, opp_table), opp_table);
1649         }
1650 }
1651
1652 void _dev_pm_opp_find_and_remove_table(struct device *dev, bool remove_all)
1653 {
1654         struct opp_table *opp_table;
1655
1656         /* Check for existing table for 'dev' */
1657         opp_table = _find_opp_table(dev);
1658         if (IS_ERR(opp_table)) {
1659                 int error = PTR_ERR(opp_table);
1660
1661                 if (error != -ENODEV)
1662                         WARN(1, "%s: opp_table: %d\n",
1663                              IS_ERR_OR_NULL(dev) ?
1664                                         "Invalid device" : dev_name(dev),
1665                              error);
1666                 return;
1667         }
1668
1669         _dev_pm_opp_remove_table(opp_table, dev, remove_all);
1670
1671         dev_pm_opp_put_opp_table(opp_table);
1672 }
1673
1674 /**
1675  * dev_pm_opp_remove_table() - Free all OPPs associated with the device
1676  * @dev:        device pointer used to lookup OPP table.
1677  *
1678  * Free both OPPs created using static entries present in DT and the
1679  * dynamically added entries.
1680  */
1681 void dev_pm_opp_remove_table(struct device *dev)
1682 {
1683         _dev_pm_opp_find_and_remove_table(dev, true);
1684 }
1685 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);