drivers/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/pm_domain.h>
  23 #include <linux/regulator/consumer.h>
  24
  25 #include "opp.h"
  26
  27 /*
  28  * The root of the list of all opp-tables. All opp_table structures branch off
  29  * from here, with each opp_table containing the list of opps it supports in
  30  * various states of availability.
  31  */
  32 LIST_HEAD(opp_tables);
  33 /* Lock to allow exclusive modification to the device and opp lists */
  34 DEFINE_MUTEX(opp_table_lock);
  35
  36 static struct opp_device *_find_opp_dev(const struct device *dev,
  37                                         struct opp_table *opp_table)
  38 {
  39         struct opp_device *opp_dev;
  40
  41         list_for_each_entry(opp_dev, &opp_table->dev_list, node)
  42                 if (opp_dev->dev == dev)
  43                         return opp_dev;
  44
  45         return NULL;
  46 }
  47
  48 static struct opp_table *_find_opp_table_unlocked(struct device *dev)
  49 {
  50         struct opp_table *opp_table;
  51         bool found;
  52
  53         list_for_each_entry(opp_table, &opp_tables, node) {
  54                 mutex_lock(&opp_table->lock);
  55                 found = !!_find_opp_dev(dev, opp_table);
  56                 mutex_unlock(&opp_table->lock);
  57
  58                 if (found) {
  59                         _get_opp_table_kref(opp_table);
  60
  61                         return opp_table;
  62                 }
  63         }
  64
  65         return ERR_PTR(-ENODEV);
  66 }
  67
  68 /**
  69  * _find_opp_table() - find opp_table struct using device pointer
  70  * @dev:        device pointer used to lookup OPP table
  71  *
  72  * Search OPP table for one containing matching device.
  73  *
  74  * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
  75  * -EINVAL based on type of error.
  76  *
  77  * The callers must call dev_pm_opp_put_opp_table() after the table is used.
  78  */
  79 struct opp_table *_find_opp_table(struct device *dev)
  80 {
  81         struct opp_table *opp_table;
  82
  83         if (IS_ERR_OR_NULL(dev)) {
  84                 pr_err("%s: Invalid parameters\n", __func__);
  85                 return ERR_PTR(-EINVAL);
  86         }
  87
  88         mutex_lock(&opp_table_lock);
  89         opp_table = _find_opp_table_unlocked(dev);
  90         mutex_unlock(&opp_table_lock);
  91
  92         return opp_table;
  93 }
  94
  95 /**
  96  * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
  97  * @opp:        opp for which voltage has to be returned for
  98  *
  99  * Return: voltage in micro volt corresponding to the opp, else
 100  * return 0
 101  *
 102  * This is useful only for devices with single power supply.
 103  */
 104 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
 105 {
 106         if (IS_ERR_OR_NULL(opp)) {
 107                 pr_err("%s: Invalid parameters\n", __func__);
 108                 return 0;
 109         }
 110
 111         return opp->supplies[0].u_volt;
 112 }
 113 EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
 114
 115 /**
 116  * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
 117  * @opp:        opp for which frequency has to be returned for
 118  *
 119  * Return: frequency in hertz corresponding to the opp, else
 120  * return 0
 121  */
 122 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
 123 {
 124         if (IS_ERR_OR_NULL(opp) || !opp->available) {
 125                 pr_err("%s: Invalid parameters\n", __func__);
 126                 return 0;
 127         }
 128
 129         return opp->rate;
 130 }
 131 EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
 132
 133 /**
 134  * dev_pm_opp_get_level() - Gets the level corresponding to an available opp
 135  * @opp:        opp for which level value has to be returned for
 136  *
 137  * Return: level read from device tree corresponding to the opp, else
 138  * return 0.
 139  */
 140 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
 141 {
 142         if (IS_ERR_OR_NULL(opp) || !opp->available) {
 143                 pr_err("%s: Invalid parameters\n", __func__);
 144                 return 0;
 145         }
 146
 147         return opp->level;
 148 }
 149 EXPORT_SYMBOL_GPL(dev_pm_opp_get_level);
 150
 151 /**
 152  * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
 153  * @opp: opp for which turbo mode is being verified
 154  *
 155  * Turbo OPPs are not for normal use, and can be enabled (under certain
 156  * conditions) for short duration of times to finish high throughput work
 157  * quickly. Running on them for longer times may overheat the chip.
 158  *
 159  * Return: true if opp is turbo opp, else false.
 160  */
 161 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
 162 {
 163         if (IS_ERR_OR_NULL(opp) || !opp->available) {
 164                 pr_err("%s: Invalid parameters\n", __func__);
 165                 return false;
 166         }
 167
 168         return opp->turbo;
 169 }
 170 EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
 171
 172 /**
 173  * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
 174  * @dev:        device for which we do this operation
 175  *
 176  * Return: This function returns the max clock latency in nanoseconds.
 177  */
 178 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
 179 {
 180         struct opp_table *opp_table;
 181         unsigned long clock_latency_ns;
 182
 183         opp_table = _find_opp_table(dev);
 184         if (IS_ERR(opp_table))
 185                 return 0;
 186
 187         clock_latency_ns = opp_table->clock_latency_ns_max;
 188
 189         dev_pm_opp_put_opp_table(opp_table);
 190
 191         return clock_latency_ns;
 192 }
 193 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
 194
 195 /**
 196  * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
 197  * @dev: device for which we do this operation
 198  *
 199  * Return: This function returns the max voltage latency in nanoseconds.
 200  */
 201 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
 202 {
 203         struct opp_table *opp_table;
 204         struct dev_pm_opp *opp;
 205         struct regulator *reg;
 206         unsigned long latency_ns = 0;
 207         int ret, i, count;
 208         struct {
 209                 unsigned long min;
 210                 unsigned long max;
 211         } *uV;
 212
 213         opp_table = _find_opp_table(dev);
 214         if (IS_ERR(opp_table))
 215                 return 0;
 216
 217         /* Regulator may not be required for the device */
 218         if (!opp_table->regulators)
 219                 goto put_opp_table;
 220
 221         count = opp_table->regulator_count;
 222
 223         uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
 224         if (!uV)
 225                 goto put_opp_table;
 226
 227         mutex_lock(&opp_table->lock);
 228
 229         for (i = 0; i < count; i++) {
 230                 uV[i].min = ~0;
 231                 uV[i].max = 0;
 232
 233                 list_for_each_entry(opp, &opp_table->opp_list, node) {
 234                         if (!opp->available)
 235                                 continue;
 236
 237                         if (opp->supplies[i].u_volt_min < uV[i].min)
 238                                 uV[i].min = opp->supplies[i].u_volt_min;
 239                         if (opp->supplies[i].u_volt_max > uV[i].max)
 240                                 uV[i].max = opp->supplies[i].u_volt_max;
 241                 }
 242         }
 243
 244         mutex_unlock(&opp_table->lock);
 245
 246         /*
 247          * The caller needs to ensure that opp_table (and hence the regulator)
 248          * isn't freed, while we are executing this routine.
 249          */
 250         for (i = 0; i < count; i++) {
 251                 reg = opp_table->regulators[i];
 252                 ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
 253                 if (ret > 0)
 254                         latency_ns += ret * 1000;
 255         }
 256
 257         kfree(uV);
 258 put_opp_table:
 259         dev_pm_opp_put_opp_table(opp_table);
 260
 261         return latency_ns;
 262 }
 263 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
 264
 265 /**
 266  * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
 267  *                                           nanoseconds
 268  * @dev: device for which we do this operation
 269  *
 270  * Return: This function returns the max transition latency, in nanoseconds, to
 271  * switch from one OPP to other.
 272  */
 273 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
 274 {
 275         return dev_pm_opp_get_max_volt_latency(dev) +
 276                 dev_pm_opp_get_max_clock_latency(dev);
 277 }
 278 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
 279
 280 /**
 281  * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
 282  * @dev:        device for which we do this operation
 283  *
 284  * Return: This function returns the frequency of the OPP marked as suspend_opp
 285  * if one is available, else returns 0;
 286  */
 287 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
 288 {
 289         struct opp_table *opp_table;
 290         unsigned long freq = 0;
 291
 292         opp_table = _find_opp_table(dev);
 293         if (IS_ERR(opp_table))
 294                 return 0;
 295
 296         if (opp_table->suspend_opp && opp_table->suspend_opp->available)
 297                 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
 298
 299         dev_pm_opp_put_opp_table(opp_table);
 300
 301         return freq;
 302 }
 303 EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
 304
 305 int _get_opp_count(struct opp_table *opp_table)
 306 {
 307         struct dev_pm_opp *opp;
 308         int count = 0;
 309
 310         mutex_lock(&opp_table->lock);
 311
 312         list_for_each_entry(opp, &opp_table->opp_list, node) {
 313                 if (opp->available)
 314                         count++;
 315         }
 316
 317         mutex_unlock(&opp_table->lock);
 318
 319         return count;
 320 }
 321
 322 /**
 323  * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
 324  * @dev:        device for which we do this operation
 325  *
 326  * Return: This function returns the number of available opps if there are any,
 327  * else returns 0 if none or the corresponding error value.
 328  */
 329 int dev_pm_opp_get_opp_count(struct device *dev)
 330 {
 331         struct opp_table *opp_table;
 332         int count;
 333
 334         opp_table = _find_opp_table(dev);
 335         if (IS_ERR(opp_table)) {
 336                 count = PTR_ERR(opp_table);
 337                 dev_dbg(dev, "%s: OPP table not found (%d)\n",
 338                         __func__, count);
 339                 return count;
 340         }
 341
 342         count = _get_opp_count(opp_table);
 343         dev_pm_opp_put_opp_table(opp_table);
 344
 345         return count;
 346 }
 347 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
 348
 349 /**
 350  * dev_pm_opp_find_freq_exact() - search for an exact frequency
 351  * @dev:                device for which we do this operation
 352  * @freq:               frequency to search for
 353  * @available:          true/false - match for available opp
 354  *
 355  * Return: Searches for exact match in the opp table and returns pointer to the
 356  * matching opp if found, else returns ERR_PTR in case of error and should
 357  * be handled using IS_ERR. Error return values can be:
 358  * EINVAL:      for bad pointer
 359  * ERANGE:      no match found for search
 360  * ENODEV:      if device not found in list of registered devices
 361  *
 362  * Note: available is a modifier for the search. if available=true, then the
 363  * match is for exact matching frequency and is available in the stored OPP
 364  * table. if false, the match is for exact frequency which is not available.
 365  *
 366  * This provides a mechanism to enable an opp which is not available currently
 367  * or the opposite as well.
 368  *
 369  * The callers are required to call dev_pm_opp_put() for the returned OPP after
 370  * use.
 371  */
 372 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
 373                                               unsigned long freq,
 374                                               bool available)
 375 {
 376         struct opp_table *opp_table;
 377         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
 378
 379         opp_table = _find_opp_table(dev);
 380         if (IS_ERR(opp_table)) {
 381                 int r = PTR_ERR(opp_table);
 382
 383                 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
 384                 return ERR_PTR(r);
 385         }
 386
 387         mutex_lock(&opp_table->lock);
 388
 389         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
 390                 if (temp_opp->available == available &&
 391                                 temp_opp->rate == freq) {
 392                         opp = temp_opp;
 393
 394                         /* Increment the reference count of OPP */
 395                         dev_pm_opp_get(opp);
 396                         break;
 397                 }
 398         }
 399
 400         mutex_unlock(&opp_table->lock);
 401         dev_pm_opp_put_opp_table(opp_table);
 402
 403         return opp;
 404 }
 405 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
 406
 407 static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
 408                                                    unsigned long *freq)
 409 {
 410         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
 411
 412         mutex_lock(&opp_table->lock);
 413
 414         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
 415                 if (temp_opp->available && temp_opp->rate >= *freq) {
 416                         opp = temp_opp;
 417                         *freq = opp->rate;
 418
 419                         /* Increment the reference count of OPP */
 420                         dev_pm_opp_get(opp);
 421                         break;
 422                 }
 423         }
 424
 425         mutex_unlock(&opp_table->lock);
 426
 427         return opp;
 428 }
 429
 430 /**
 431  * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
 432  * @dev:        device for which we do this operation
 433  * @freq:       Start frequency
 434  *
 435  * Search for the matching ceil *available* OPP from a starting freq
 436  * for a device.
 437  *
 438  * Return: matching *opp and refreshes *freq accordingly, else returns
 439  * ERR_PTR in case of error and should be handled using IS_ERR. Error return
 440  * values can be:
 441  * EINVAL:      for bad pointer
 442  * ERANGE:      no match found for search
 443  * ENODEV:      if device not found in list of registered devices
 444  *
 445  * The callers are required to call dev_pm_opp_put() for the returned OPP after
 446  * use.
 447  */
 448 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
 449                                              unsigned long *freq)
 450 {
 451         struct opp_table *opp_table;
 452         struct dev_pm_opp *opp;
 453
 454         if (!dev || !freq) {
 455                 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
 456                 return ERR_PTR(-EINVAL);
 457         }
 458
 459         opp_table = _find_opp_table(dev);
 460         if (IS_ERR(opp_table))
 461                 return ERR_CAST(opp_table);
 462
 463         opp = _find_freq_ceil(opp_table, freq);
 464
 465         dev_pm_opp_put_opp_table(opp_table);
 466
 467         return opp;
 468 }
 469 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
 470
 471 /**
 472  * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
 473  * @dev:        device for which we do this operation
 474  * @freq:       Start frequency
 475  *
 476  * Search for the matching floor *available* OPP from a starting freq
 477  * for a device.
 478  *
 479  * Return: matching *opp and refreshes *freq accordingly, else returns
 480  * ERR_PTR in case of error and should be handled using IS_ERR. Error return
 481  * values can be:
 482  * EINVAL:      for bad pointer
 483  * ERANGE:      no match found for search
 484  * ENODEV:      if device not found in list of registered devices
 485  *
 486  * The callers are required to call dev_pm_opp_put() for the returned OPP after
 487  * use.
 488  */
 489 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
 490                                               unsigned long *freq)
 491 {
 492         struct opp_table *opp_table;
 493         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
 494
 495         if (!dev || !freq) {
 496                 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
 497                 return ERR_PTR(-EINVAL);
 498         }
 499
 500         opp_table = _find_opp_table(dev);
 501         if (IS_ERR(opp_table))
 502                 return ERR_CAST(opp_table);
 503
 504         mutex_lock(&opp_table->lock);
 505
 506         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
 507                 if (temp_opp->available) {
 508                         /* go to the next node, before choosing prev */
 509                         if (temp_opp->rate > *freq)
 510                                 break;
 511                         else
 512                                 opp = temp_opp;
 513                 }
 514         }
 515
 516         /* Increment the reference count of OPP */
 517         if (!IS_ERR(opp))
 518                 dev_pm_opp_get(opp);
 519         mutex_unlock(&opp_table->lock);
 520         dev_pm_opp_put_opp_table(opp_table);
 521
 522         if (!IS_ERR(opp))
 523                 *freq = opp->rate;
 524
 525         return opp;
 526 }
 527 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
 528
 529 /**
 530  * dev_pm_opp_find_freq_ceil_by_volt() - Find OPP with highest frequency for
 531  *                                       target voltage.
 532  * @dev:        Device for which we do this operation.
 533  * @u_volt:     Target voltage.
 534  *
 535  * Search for OPP with highest (ceil) frequency and has voltage <= u_volt.
 536  *
 537  * Return: matching *opp, else returns ERR_PTR in case of error which should be
 538  * handled using IS_ERR.
 539  *
 540  * Error return values can be:
 541  * EINVAL:      bad parameters
 542  *
 543  * The callers are required to call dev_pm_opp_put() for the returned OPP after
 544  * use.
 545  */
 546 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
 547                                                      unsigned long u_volt)
 548 {
 549         struct opp_table *opp_table;
 550         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
 551
 552         if (!dev || !u_volt) {
 553                 dev_err(dev, "%s: Invalid argument volt=%lu\n", __func__,
 554                         u_volt);
 555                 return ERR_PTR(-EINVAL);
 556         }
 557
 558         opp_table = _find_opp_table(dev);
 559         if (IS_ERR(opp_table))
 560                 return ERR_CAST(opp_table);
 561
 562         mutex_lock(&opp_table->lock);
 563
 564         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
 565                 if (temp_opp->available) {
 566                         if (temp_opp->supplies[0].u_volt > u_volt)
 567                                 break;
 568                         opp = temp_opp;
 569                 }
 570         }
 571
 572         /* Increment the reference count of OPP */
 573         if (!IS_ERR(opp))
 574                 dev_pm_opp_get(opp);
 575
 576         mutex_unlock(&opp_table->lock);
 577         dev_pm_opp_put_opp_table(opp_table);
 578
 579         return opp;
 580 }
 581 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil_by_volt);
 582
 583 static int _set_opp_voltage(struct device *dev, struct regulator *reg,
 584                             struct dev_pm_opp_supply *supply)
 585 {
 586         int ret;
 587
 588         /* Regulator not available for device */
 589         if (IS_ERR(reg)) {
 590                 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
 591                         PTR_ERR(reg));
 592                 return 0;
 593         }
 594
 595         dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
 596                 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
 597
 598         ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
 599                                             supply->u_volt, supply->u_volt_max);
 600         if (ret)
 601                 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
 602                         __func__, supply->u_volt_min, supply->u_volt,
 603                         supply->u_volt_max, ret);
 604
 605         return ret;
 606 }
 607
 608 static inline int _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
 609                                             unsigned long freq)
 610 {
 611         int ret;
 612
 613         ret = clk_set_rate(clk, freq);
 614         if (ret) {
 615                 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
 616                         ret);
 617         }
 618
 619         return ret;
 620 }
 621
 622 static int _generic_set_opp_regulator(const struct opp_table *opp_table,
 623                                       struct device *dev,
 624                                       unsigned long old_freq,
 625                                       unsigned long freq,
 626                                       struct dev_pm_opp_supply *old_supply,
 627                                       struct dev_pm_opp_supply *new_supply)
 628 {
 629         struct regulator *reg = opp_table->regulators[0];
 630         int ret;
 631
 632         /* This function only supports single regulator per device */
 633         if (WARN_ON(opp_table->regulator_count > 1)) {
 634                 dev_err(dev, "multiple regulators are not supported\n");
 635                 return -EINVAL;
 636         }
 637
 638         /* Scaling up? Scale voltage before frequency */
 639         if (freq >= old_freq) {
 640                 ret = _set_opp_voltage(dev, reg, new_supply);
 641                 if (ret)
 642                         goto restore_voltage;
 643         }
 644
 645         /* Change frequency */
 646         ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
 647         if (ret)
 648                 goto restore_voltage;
 649
 650         /* Scaling down? Scale voltage after frequency */
 651         if (freq < old_freq) {
 652                 ret = _set_opp_voltage(dev, reg, new_supply);
 653                 if (ret)
 654                         goto restore_freq;
 655         }
 656
 657         return 0;
 658
 659 restore_freq:
 660         if (_generic_set_opp_clk_only(dev, opp_table->clk, old_freq))
 661                 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
 662                         __func__, old_freq);
 663 restore_voltage:
 664         /* This shouldn't harm even if the voltages weren't updated earlier */
 665         if (old_supply)
 666                 _set_opp_voltage(dev, reg, old_supply);
 667
 668         return ret;
 669 }
 670
 671 static int _set_opp_custom(const struct opp_table *opp_table,
 672                            struct device *dev, unsigned long old_freq,
 673                            unsigned long freq,
 674                            struct dev_pm_opp_supply *old_supply,
 675                            struct dev_pm_opp_supply *new_supply)
 676 {
 677         struct dev_pm_set_opp_data *data;
 678         int size;
 679
 680         data = opp_table->set_opp_data;
 681         data->regulators = opp_table->regulators;
 682         data->regulator_count = opp_table->regulator_count;
 683         data->clk = opp_table->clk;
 684         data->dev = dev;
 685
 686         data->old_opp.rate = old_freq;
 687         size = sizeof(*old_supply) * opp_table->regulator_count;
 688         if (IS_ERR(old_supply))
 689                 memset(data->old_opp.supplies, 0, size);
 690         else
 691                 memcpy(data->old_opp.supplies, old_supply, size);
 692
 693         data->new_opp.rate = freq;
 694         memcpy(data->new_opp.supplies, new_supply, size);
 695
 696         return opp_table->set_opp(data);
 697 }
 698
 699 /* This is only called for PM domain for now */
 700 static int _set_required_opps(struct device *dev,
 701                               struct opp_table *opp_table,
 702                               struct dev_pm_opp *opp)
 703 {
 704         struct opp_table **required_opp_tables = opp_table->required_opp_tables;
 705         struct device **genpd_virt_devs = opp_table->genpd_virt_devs;
 706         unsigned int pstate;
 707         int i, ret = 0;
 708
 709         if (!required_opp_tables)
 710                 return 0;
 711
 712         /* Single genpd case */
 713         if (!genpd_virt_devs) {
 714                 pstate = opp->required_opps[0]->pstate;
 715                 ret = dev_pm_genpd_set_performance_state(dev, pstate);
 716                 if (ret) {
 717                         dev_err(dev, "Failed to set performance state of %s: %d (%d)\n",
 718                                 dev_name(dev), pstate, ret);
 719                 }
 720                 return ret;
 721         }
 722
 723         /* Multiple genpd case */
 724
 725         /*
 726          * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
 727          * after it is freed from another thread.
 728          */
 729         mutex_lock(&opp_table->genpd_virt_dev_lock);
 730
 731         for (i = 0; i < opp_table->required_opp_count; i++) {
 732                 pstate = opp->required_opps[i]->pstate;
 733
 734                 if (!genpd_virt_devs[i])
 735                         continue;
 736
 737                 ret = dev_pm_genpd_set_performance_state(genpd_virt_devs[i], pstate);
 738                 if (ret) {
 739                         dev_err(dev, "Failed to set performance rate of %s: %d (%d)\n",
 740                                 dev_name(genpd_virt_devs[i]), pstate, ret);
 741                         break;
 742                 }
 743         }
 744         mutex_unlock(&opp_table->genpd_virt_dev_lock);
 745
 746         return ret;
 747 }
 748
 749 /**
 750  * dev_pm_opp_set_rate() - Configure new OPP based on frequency
 751  * @dev:         device for which we do this operation
 752  * @target_freq: frequency to achieve
 753  *
 754  * This configures the power-supplies to the levels specified by the OPP
 755  * corresponding to the target_freq, and programs the clock to a value <=
 756  * target_freq, as rounded by clk_round_rate(). Device wanting to run at fmax
 757  * provided by the opp, should have already rounded to the target OPP's
 758  * frequency.
 759  */
 760 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
 761 {
 762         struct opp_table *opp_table;
 763         unsigned long freq, old_freq, temp_freq;
 764         struct dev_pm_opp *old_opp, *opp;
 765         struct clk *clk;
 766         int ret;
 767
 768         if (unlikely(!target_freq)) {
 769                 dev_err(dev, "%s: Invalid target frequency %lu\n", __func__,
 770                         target_freq);
 771                 return -EINVAL;
 772         }
 773
 774         opp_table = _find_opp_table(dev);
 775         if (IS_ERR(opp_table)) {
 776                 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
 777                 return PTR_ERR(opp_table);
 778         }
 779
 780         clk = opp_table->clk;
 781         if (IS_ERR(clk)) {
 782                 dev_err(dev, "%s: No clock available for the device\n",
 783                         __func__);
 784                 ret = PTR_ERR(clk);
 785                 goto put_opp_table;
 786         }
 787
 788         freq = clk_round_rate(clk, target_freq);
 789         if ((long)freq <= 0)
 790                 freq = target_freq;
 791
 792         old_freq = clk_get_rate(clk);
 793
 794         /* Return early if nothing to do */
 795         if (old_freq == freq) {
 796                 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
 797                         __func__, freq);
 798                 ret = 0;
 799                 goto put_opp_table;
 800         }
 801
 802         temp_freq = old_freq;
 803         old_opp = _find_freq_ceil(opp_table, &temp_freq);
 804         if (IS_ERR(old_opp)) {
 805                 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
 806                         __func__, old_freq, PTR_ERR(old_opp));
 807         }
 808
 809         temp_freq = freq;
 810         opp = _find_freq_ceil(opp_table, &temp_freq);
 811         if (IS_ERR(opp)) {
 812                 ret = PTR_ERR(opp);
 813                 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
 814                         __func__, freq, ret);
 815                 goto put_old_opp;
 816         }
 817
 818         dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
 819                 old_freq, freq);
 820
 821         /* Scaling up? Configure required OPPs before frequency */
 822         if (freq >= old_freq) {
 823                 ret = _set_required_opps(dev, opp_table, opp);
 824                 if (ret)
 825                         goto put_opp;
 826         }
 827
 828         if (opp_table->set_opp) {
 829                 ret = _set_opp_custom(opp_table, dev, old_freq, freq,
 830                                       IS_ERR(old_opp) ? NULL : old_opp->supplies,
 831                                       opp->supplies);
 832         } else if (opp_table->regulators) {
 833                 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
 834                                                  IS_ERR(old_opp) ? NULL : old_opp->supplies,
 835                                                  opp->supplies);
 836         } else {
 837                 /* Only frequency scaling */
 838                 ret = _generic_set_opp_clk_only(dev, clk, freq);
 839         }
 840
 841         /* Scaling down? Configure required OPPs after frequency */
 842         if (!ret && freq < old_freq) {
 843                 ret = _set_required_opps(dev, opp_table, opp);
 844                 if (ret)
 845                         dev_err(dev, "Failed to set required opps: %d\n", ret);
 846         }
 847
 848 put_opp:
 849         dev_pm_opp_put(opp);
 850 put_old_opp:
 851         if (!IS_ERR(old_opp))
 852                 dev_pm_opp_put(old_opp);
 853 put_opp_table:
 854         dev_pm_opp_put_opp_table(opp_table);
 855         return ret;
 856 }
 857 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
 858
 859 /* OPP-dev Helpers */
 860 static void _remove_opp_dev(struct opp_device *opp_dev,
 861                             struct opp_table *opp_table)
 862 {
 863         opp_debug_unregister(opp_dev, opp_table);
 864         list_del(&opp_dev->node);
 865         kfree(opp_dev);
 866 }
 867
 868 static struct opp_device *_add_opp_dev_unlocked(const struct device *dev,
 869                                                 struct opp_table *opp_table)
 870 {
 871         struct opp_device *opp_dev;
 872
 873         opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
 874         if (!opp_dev)
 875                 return NULL;
 876
 877         /* Initialize opp-dev */
 878         opp_dev->dev = dev;
 879
 880         list_add(&opp_dev->node, &opp_table->dev_list);
 881
 882         /* Create debugfs entries for the opp_table */
 883         opp_debug_register(opp_dev, opp_table);
 884
 885         return opp_dev;
 886 }
 887
 888 struct opp_device *_add_opp_dev(const struct device *dev,
 889                                 struct opp_table *opp_table)
 890 {
 891         struct opp_device *opp_dev;
 892
 893         mutex_lock(&opp_table->lock);
 894         opp_dev = _add_opp_dev_unlocked(dev, opp_table);
 895         mutex_unlock(&opp_table->lock);
 896
 897         return opp_dev;
 898 }
 899
 900 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
 901 {
 902         struct opp_table *opp_table;
 903         struct opp_device *opp_dev;
 904         int ret;
 905
 906         /*
 907          * Allocate a new OPP table. In the infrequent case where a new
 908          * device is needed to be added, we pay this penalty.
 909          */
 910         opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
 911         if (!opp_table)
 912                 return NULL;
 913
 914         mutex_init(&opp_table->lock);
 915         mutex_init(&opp_table->genpd_virt_dev_lock);
 916         INIT_LIST_HEAD(&opp_table->dev_list);
 917
 918         /* Mark regulator count uninitialized */
 919         opp_table->regulator_count = -1;
 920
 921         opp_dev = _add_opp_dev(dev, opp_table);
 922         if (!opp_dev) {
 923                 kfree(opp_table);
 924                 return NULL;
 925         }
 926
 927         _of_init_opp_table(opp_table, dev, index);
 928
 929         /* Find clk for the device */
 930         opp_table->clk = clk_get(dev, NULL);
 931         if (IS_ERR(opp_table->clk)) {
 932                 ret = PTR_ERR(opp_table->clk);
 933                 if (ret != -EPROBE_DEFER)
 934                         dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
 935                                 ret);
 936         }
 937
 938         BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
 939         INIT_LIST_HEAD(&opp_table->opp_list);
 940         kref_init(&opp_table->kref);
 941
 942         /* Secure the device table modification */
 943         list_add(&opp_table->node, &opp_tables);
 944         return opp_table;
 945 }
 946
 947 void _get_opp_table_kref(struct opp_table *opp_table)
 948 {
 949         kref_get(&opp_table->kref);
 950 }
 951
 952 static struct opp_table *_opp_get_opp_table(struct device *dev, int index)
 953 {
 954         struct opp_table *opp_table;
 955
 956         /* Hold our table modification lock here */
 957         mutex_lock(&opp_table_lock);
 958
 959         opp_table = _find_opp_table_unlocked(dev);
 960         if (!IS_ERR(opp_table))
 961                 goto unlock;
 962
 963         opp_table = _managed_opp(dev, index);
 964         if (opp_table) {
 965                 if (!_add_opp_dev_unlocked(dev, opp_table)) {
 966                         dev_pm_opp_put_opp_table(opp_table);
 967                         opp_table = NULL;
 968                 }
 969                 goto unlock;
 970         }
 971
 972         opp_table = _allocate_opp_table(dev, index);
 973
 974 unlock:
 975         mutex_unlock(&opp_table_lock);
 976
 977         return opp_table;
 978 }
 979
 980 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
 981 {
 982         return _opp_get_opp_table(dev, 0);
 983 }
 984 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
 985
 986 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev,
 987                                                    int index)
 988 {
 989         return _opp_get_opp_table(dev, index);
 990 }
 991
 992 static void _opp_table_kref_release(struct kref *kref)
 993 {
 994         struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
 995         struct opp_device *opp_dev, *temp;
 996
 997         _of_clear_opp_table(opp_table);
 998
 999         /* Release clk */
1000         if (!IS_ERR(opp_table->clk))
1001                 clk_put(opp_table->clk);
1002
1003         WARN_ON(!list_empty(&opp_table->opp_list));
1004
1005         list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1006                 /*
1007                  * The OPP table is getting removed, drop the performance state
1008                  * constraints.
1009                  */
1010                 if (opp_table->genpd_performance_state)
1011                         dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1012
1013                 _remove_opp_dev(opp_dev, opp_table);
1014         }
1015
1016         mutex_destroy(&opp_table->genpd_virt_dev_lock);
1017         mutex_destroy(&opp_table->lock);
1018         list_del(&opp_table->node);
1019         kfree(opp_table);
1020
1021         mutex_unlock(&opp_table_lock);
1022 }
1023
1024 void _opp_remove_all_static(struct opp_table *opp_table)
1025 {
1026         struct dev_pm_opp *opp, *tmp;
1027
1028         list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1029                 if (!opp->dynamic)
1030                         dev_pm_opp_put(opp);
1031         }
1032
1033         opp_table->parsed_static_opps = false;
1034 }
1035
1036 static void _opp_table_list_kref_release(struct kref *kref)
1037 {
1038         struct opp_table *opp_table = container_of(kref, struct opp_table,
1039                                                    list_kref);
1040
1041         _opp_remove_all_static(opp_table);
1042         mutex_unlock(&opp_table_lock);
1043 }
1044
1045 void _put_opp_list_kref(struct opp_table *opp_table)
1046 {
1047         kref_put_mutex(&opp_table->list_kref, _opp_table_list_kref_release,
1048                        &opp_table_lock);
1049 }
1050
1051 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1052 {
1053         kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1054                        &opp_table_lock);
1055 }
1056 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1057
1058 void _opp_free(struct dev_pm_opp *opp)
1059 {
1060         kfree(opp);
1061 }
1062
1063 static void _opp_kref_release(struct dev_pm_opp *opp,
1064                               struct opp_table *opp_table)
1065 {
1066         /*
1067          * Notify the changes in the availability of the operable
1068          * frequency/voltage list.
1069          */
1070         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1071         _of_opp_free_required_opps(opp_table, opp);
1072         opp_debug_remove_one(opp);
1073         list_del(&opp->node);
1074         kfree(opp);
1075 }
1076
1077 static void _opp_kref_release_unlocked(struct kref *kref)
1078 {
1079         struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1080         struct opp_table *opp_table = opp->opp_table;
1081
1082         _opp_kref_release(opp, opp_table);
1083 }
1084
1085 static void _opp_kref_release_locked(struct kref *kref)
1086 {
1087         struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1088         struct opp_table *opp_table = opp->opp_table;
1089
1090         _opp_kref_release(opp, opp_table);
1091         mutex_unlock(&opp_table->lock);
1092 }
1093
1094 void dev_pm_opp_get(struct dev_pm_opp *opp)
1095 {
1096         kref_get(&opp->kref);
1097 }
1098
1099 void dev_pm_opp_put(struct dev_pm_opp *opp)
1100 {
1101         kref_put_mutex(&opp->kref, _opp_kref_release_locked,
1102                        &opp->opp_table->lock);
1103 }
1104 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1105
1106 static void dev_pm_opp_put_unlocked(struct dev_pm_opp *opp)
1107 {
1108         kref_put(&opp->kref, _opp_kref_release_unlocked);
1109 }
1110
1111 /**
1112  * dev_pm_opp_remove()  - Remove an OPP from OPP table
1113  * @dev:        device for which we do this operation
1114  * @freq:       OPP to remove with matching 'freq'
1115  *
1116  * This function removes an opp from the opp table.
1117  */
1118 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1119 {
1120         struct dev_pm_opp *opp;
1121         struct opp_table *opp_table;
1122         bool found = false;
1123
1124         opp_table = _find_opp_table(dev);
1125         if (IS_ERR(opp_table))
1126                 return;
1127
1128         mutex_lock(&opp_table->lock);
1129
1130         list_for_each_entry(opp, &opp_table->opp_list, node) {
1131                 if (opp->rate == freq) {
1132                         found = true;
1133                         break;
1134                 }
1135         }
1136
1137         mutex_unlock(&opp_table->lock);
1138
1139         if (found) {
1140                 dev_pm_opp_put(opp);
1141
1142                 /* Drop the reference taken by dev_pm_opp_add() */
1143                 dev_pm_opp_put_opp_table(opp_table);
1144         } else {
1145                 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1146                          __func__, freq);
1147         }
1148
1149         /* Drop the reference taken by _find_opp_table() */
1150         dev_pm_opp_put_opp_table(opp_table);
1151 }
1152 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1153
1154 /**
1155  * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1156  * @dev:        device for which we do this operation
1157  *
1158  * This function removes all dynamically created OPPs from the opp table.
1159  */
1160 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1161 {
1162         struct opp_table *opp_table;
1163         struct dev_pm_opp *opp, *temp;
1164         int count = 0;
1165
1166         opp_table = _find_opp_table(dev);
1167         if (IS_ERR(opp_table))
1168                 return;
1169
1170         mutex_lock(&opp_table->lock);
1171         list_for_each_entry_safe(opp, temp, &opp_table->opp_list, node) {
1172                 if (opp->dynamic) {
1173                         dev_pm_opp_put_unlocked(opp);
1174                         count++;
1175                 }
1176         }
1177         mutex_unlock(&opp_table->lock);
1178
1179         /* Drop the references taken by dev_pm_opp_add() */
1180         while (count--)
1181                 dev_pm_opp_put_opp_table(opp_table);
1182
1183         /* Drop the reference taken by _find_opp_table() */
1184         dev_pm_opp_put_opp_table(opp_table);
1185 }
1186 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1187
1188 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1189 {
1190         struct dev_pm_opp *opp;
1191         int count, supply_size;
1192
1193         /* Allocate space for at least one supply */
1194         count = table->regulator_count > 0 ? table->regulator_count : 1;
1195         supply_size = sizeof(*opp->supplies) * count;
1196
1197         /* allocate new OPP node and supplies structures */
1198         opp = kzalloc(sizeof(*opp) + supply_size, GFP_KERNEL);
1199         if (!opp)
1200                 return NULL;
1201
1202         /* Put the supplies at the end of the OPP structure as an empty array */
1203         opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1204         INIT_LIST_HEAD(&opp->node);
1205
1206         return opp;
1207 }
1208
1209 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1210                                          struct opp_table *opp_table)
1211 {
1212         struct regulator *reg;
1213         int i;
1214
1215         if (!opp_table->regulators)
1216                 return true;
1217
1218         for (i = 0; i < opp_table->regulator_count; i++) {
1219                 reg = opp_table->regulators[i];
1220
1221                 if (!regulator_is_supported_voltage(reg,
1222                                         opp->supplies[i].u_volt_min,
1223                                         opp->supplies[i].u_volt_max)) {
1224                         pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1225                                 __func__, opp->supplies[i].u_volt_min,
1226                                 opp->supplies[i].u_volt_max);
1227                         return false;
1228                 }
1229         }
1230
1231         return true;
1232 }
1233
1234 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1235                              struct opp_table *opp_table,
1236                              struct list_head **head)
1237 {
1238         struct dev_pm_opp *opp;
1239
1240         /*
1241          * Insert new OPP in order of increasing frequency and discard if
1242          * already present.
1243          *
1244          * Need to use &opp_table->opp_list in the condition part of the 'for'
1245          * loop, don't replace it with head otherwise it will become an infinite
1246          * loop.
1247          */
1248         list_for_each_entry(opp, &opp_table->opp_list, node) {
1249                 if (new_opp->rate > opp->rate) {
1250                         *head = &opp->node;
1251                         continue;
1252                 }
1253
1254                 if (new_opp->rate < opp->rate)
1255                         return 0;
1256
1257                 /* Duplicate OPPs */
1258                 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1259                          __func__, opp->rate, opp->supplies[0].u_volt,
1260                          opp->available, new_opp->rate,
1261                          new_opp->supplies[0].u_volt, new_opp->available);
1262
1263                 /* Should we compare voltages for all regulators here ? */
1264                 return opp->available &&
1265                        new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1266         }
1267
1268         return 0;
1269 }
1270
1271 /*
1272  * Returns:
1273  * 0: On success. And appropriate error message for duplicate OPPs.
1274  * -EBUSY: For OPP with same freq/volt and is available. The callers of
1275  *  _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1276  *  sure we don't print error messages unnecessarily if different parts of
1277  *  kernel try to initialize the OPP table.
1278  * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1279  *  should be considered an error by the callers of _opp_add().
1280  */
1281 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1282              struct opp_table *opp_table, bool rate_not_available)
1283 {
1284         struct list_head *head;
1285         int ret;
1286
1287         mutex_lock(&opp_table->lock);
1288         head = &opp_table->opp_list;
1289
1290         if (likely(!rate_not_available)) {
1291                 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1292                 if (ret) {
1293                         mutex_unlock(&opp_table->lock);
1294                         return ret;
1295                 }
1296         }
1297
1298         list_add(&new_opp->node, head);
1299         mutex_unlock(&opp_table->lock);
1300
1301         new_opp->opp_table = opp_table;
1302         kref_init(&new_opp->kref);
1303
1304         opp_debug_create_one(new_opp, opp_table);
1305
1306         if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1307                 new_opp->available = false;
1308                 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1309                          __func__, new_opp->rate);
1310         }
1311
1312         return 0;
1313 }
1314
1315 /**
1316  * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1317  * @opp_table:  OPP table
1318  * @dev:        device for which we do this operation
1319  * @freq:       Frequency in Hz for this OPP
1320  * @u_volt:     Voltage in uVolts for this OPP
1321  * @dynamic:    Dynamically added OPPs.
1322  *
1323  * This function adds an opp definition to the opp table and returns status.
1324  * The opp is made available by default and it can be controlled using
1325  * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1326  *
1327  * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1328  * and freed by dev_pm_opp_of_remove_table.
1329  *
1330  * Return:
1331  * 0            On success OR
1332  *              Duplicate OPPs (both freq and volt are same) and opp->available
1333  * -EEXIST      Freq are same and volt are different OR
1334  *              Duplicate OPPs (both freq and volt are same) and !opp->available
1335  * -ENOMEM      Memory allocation failure
1336  */
1337 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1338                 unsigned long freq, long u_volt, bool dynamic)
1339 {
1340         struct dev_pm_opp *new_opp;
1341         unsigned long tol;
1342         int ret;
1343
1344         new_opp = _opp_allocate(opp_table);
1345         if (!new_opp)
1346                 return -ENOMEM;
1347
1348         /* populate the opp table */
1349         new_opp->rate = freq;
1350         tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1351         new_opp->supplies[0].u_volt = u_volt;
1352         new_opp->supplies[0].u_volt_min = u_volt - tol;
1353         new_opp->supplies[0].u_volt_max = u_volt + tol;
1354         new_opp->available = true;
1355         new_opp->dynamic = dynamic;
1356
1357         ret = _opp_add(dev, new_opp, opp_table, false);
1358         if (ret) {
1359                 /* Don't return error for duplicate OPPs */
1360                 if (ret == -EBUSY)
1361                         ret = 0;
1362                 goto free_opp;
1363         }
1364
1365         /*
1366          * Notify the changes in the availability of the operable
1367          * frequency/voltage list.
1368          */
1369         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1370         return 0;
1371
1372 free_opp:
1373         _opp_free(new_opp);
1374
1375         return ret;
1376 }
1377
1378 /**
1379  * dev_pm_opp_set_supported_hw() - Set supported platforms
1380  * @dev: Device for which supported-hw has to be set.
1381  * @versions: Array of hierarchy of versions to match.
1382  * @count: Number of elements in the array.
1383  *
1384  * This is required only for the V2 bindings, and it enables a platform to
1385  * specify the hierarchy of versions it supports. OPP layer will then enable
1386  * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1387  * property.
1388  */
1389 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1390                         const u32 *versions, unsigned int count)
1391 {
1392         struct opp_table *opp_table;
1393
1394         opp_table = dev_pm_opp_get_opp_table(dev);
1395         if (!opp_table)
1396                 return ERR_PTR(-ENOMEM);
1397
1398         /* Make sure there are no concurrent readers while updating opp_table */
1399         WARN_ON(!list_empty(&opp_table->opp_list));
1400
1401         /* Another CPU that shares the OPP table has set the property ? */
1402         if (opp_table->supported_hw)
1403                 return opp_table;
1404
1405         opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1406                                         GFP_KERNEL);
1407         if (!opp_table->supported_hw) {
1408                 dev_pm_opp_put_opp_table(opp_table);
1409                 return ERR_PTR(-ENOMEM);
1410         }
1411
1412         opp_table->supported_hw_count = count;
1413
1414         return opp_table;
1415 }
1416 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1417
1418 /**
1419  * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1420  * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1421  *
1422  * This is required only for the V2 bindings, and is called for a matching
1423  * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1424  * will not be freed.
1425  */
1426 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1427 {
1428         /* Make sure there are no concurrent readers while updating opp_table */
1429         WARN_ON(!list_empty(&opp_table->opp_list));
1430
1431         kfree(opp_table->supported_hw);
1432         opp_table->supported_hw = NULL;
1433         opp_table->supported_hw_count = 0;
1434
1435         dev_pm_opp_put_opp_table(opp_table);
1436 }
1437 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1438
1439 /**
1440  * dev_pm_opp_set_prop_name() - Set prop-extn name
1441  * @dev: Device for which the prop-name has to be set.
1442  * @name: name to postfix to properties.
1443  *
1444  * This is required only for the V2 bindings, and it enables a platform to
1445  * specify the extn to be used for certain property names. The properties to
1446  * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1447  * should postfix the property name with -<name> while looking for them.
1448  */
1449 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1450 {
1451         struct opp_table *opp_table;
1452
1453         opp_table = dev_pm_opp_get_opp_table(dev);
1454         if (!opp_table)
1455                 return ERR_PTR(-ENOMEM);
1456
1457         /* Make sure there are no concurrent readers while updating opp_table */
1458         WARN_ON(!list_empty(&opp_table->opp_list));
1459
1460         /* Another CPU that shares the OPP table has set the property ? */
1461         if (opp_table->prop_name)
1462                 return opp_table;
1463
1464         opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1465         if (!opp_table->prop_name) {
1466                 dev_pm_opp_put_opp_table(opp_table);
1467                 return ERR_PTR(-ENOMEM);
1468         }
1469
1470         return opp_table;
1471 }
1472 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1473
1474 /**
1475  * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1476  * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1477  *
1478  * This is required only for the V2 bindings, and is called for a matching
1479  * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1480  * will not be freed.
1481  */
1482 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1483 {
1484         /* Make sure there are no concurrent readers while updating opp_table */
1485         WARN_ON(!list_empty(&opp_table->opp_list));
1486
1487         kfree(opp_table->prop_name);
1488         opp_table->prop_name = NULL;
1489
1490         dev_pm_opp_put_opp_table(opp_table);
1491 }
1492 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1493
1494 static int _allocate_set_opp_data(struct opp_table *opp_table)
1495 {
1496         struct dev_pm_set_opp_data *data;
1497         int len, count = opp_table->regulator_count;
1498
1499         if (WARN_ON(!opp_table->regulators))
1500                 return -EINVAL;
1501
1502         /* space for set_opp_data */
1503         len = sizeof(*data);
1504
1505         /* space for old_opp.supplies and new_opp.supplies */
1506         len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1507
1508         data = kzalloc(len, GFP_KERNEL);
1509         if (!data)
1510                 return -ENOMEM;
1511
1512         data->old_opp.supplies = (void *)(data + 1);
1513         data->new_opp.supplies = data->old_opp.supplies + count;
1514
1515         opp_table->set_opp_data = data;
1516
1517         return 0;
1518 }
1519
1520 static void _free_set_opp_data(struct opp_table *opp_table)
1521 {
1522         kfree(opp_table->set_opp_data);
1523         opp_table->set_opp_data = NULL;
1524 }
1525
1526 /**
1527  * dev_pm_opp_set_regulators() - Set regulator names for the device
1528  * @dev: Device for which regulator name is being set.
1529  * @names: Array of pointers to the names of the regulator.
1530  * @count: Number of regulators.
1531  *
1532  * In order to support OPP switching, OPP layer needs to know the name of the
1533  * device's regulators, as the core would be required to switch voltages as
1534  * well.
1535  *
1536  * This must be called before any OPPs are initialized for the device.
1537  */
1538 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1539                                             const char * const names[],
1540                                             unsigned int count)
1541 {
1542         struct opp_table *opp_table;
1543         struct regulator *reg;
1544         int ret, i;
1545
1546         opp_table = dev_pm_opp_get_opp_table(dev);
1547         if (!opp_table)
1548                 return ERR_PTR(-ENOMEM);
1549
1550         /* This should be called before OPPs are initialized */
1551         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1552                 ret = -EBUSY;
1553                 goto err;
1554         }
1555
1556         /* Another CPU that shares the OPP table has set the regulators ? */
1557         if (opp_table->regulators)
1558                 return opp_table;
1559
1560         opp_table->regulators = kmalloc_array(count,
1561                                               sizeof(*opp_table->regulators),
1562                                               GFP_KERNEL);
1563         if (!opp_table->regulators) {
1564                 ret = -ENOMEM;
1565                 goto err;
1566         }
1567
1568         for (i = 0; i < count; i++) {
1569                 reg = regulator_get_optional(dev, names[i]);
1570                 if (IS_ERR(reg)) {
1571                         ret = PTR_ERR(reg);
1572                         if (ret != -EPROBE_DEFER)
1573                                 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1574                                         __func__, names[i], ret);
1575                         goto free_regulators;
1576                 }
1577
1578                 opp_table->regulators[i] = reg;
1579         }
1580
1581         opp_table->regulator_count = count;
1582
1583         /* Allocate block only once to pass to set_opp() routines */
1584         ret = _allocate_set_opp_data(opp_table);
1585         if (ret)
1586                 goto free_regulators;
1587
1588         return opp_table;
1589
1590 free_regulators:
1591         while (i != 0)
1592                 regulator_put(opp_table->regulators[--i]);
1593
1594         kfree(opp_table->regulators);
1595         opp_table->regulators = NULL;
1596         opp_table->regulator_count = -1;
1597 err:
1598         dev_pm_opp_put_opp_table(opp_table);
1599
1600         return ERR_PTR(ret);
1601 }
1602 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1603
1604 /**
1605  * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1606  * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1607  */
1608 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1609 {
1610         int i;
1611
1612         if (!opp_table->regulators)
1613                 goto put_opp_table;
1614
1615         /* Make sure there are no concurrent readers while updating opp_table */
1616         WARN_ON(!list_empty(&opp_table->opp_list));
1617
1618         for (i = opp_table->regulator_count - 1; i >= 0; i--)
1619                 regulator_put(opp_table->regulators[i]);
1620
1621         _free_set_opp_data(opp_table);
1622
1623         kfree(opp_table->regulators);
1624         opp_table->regulators = NULL;
1625         opp_table->regulator_count = -1;
1626
1627 put_opp_table:
1628         dev_pm_opp_put_opp_table(opp_table);
1629 }
1630 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1631
1632 /**
1633  * dev_pm_opp_set_clkname() - Set clk name for the device
1634  * @dev: Device for which clk name is being set.
1635  * @name: Clk name.
1636  *
1637  * In order to support OPP switching, OPP layer needs to get pointer to the
1638  * clock for the device. Simple cases work fine without using this routine (i.e.
1639  * by passing connection-id as NULL), but for a device with multiple clocks
1640  * available, the OPP core needs to know the exact name of the clk to use.
1641  *
1642  * This must be called before any OPPs are initialized for the device.
1643  */
1644 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1645 {
1646         struct opp_table *opp_table;
1647         int ret;
1648
1649         opp_table = dev_pm_opp_get_opp_table(dev);
1650         if (!opp_table)
1651                 return ERR_PTR(-ENOMEM);
1652
1653         /* This should be called before OPPs are initialized */
1654         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1655                 ret = -EBUSY;
1656                 goto err;
1657         }
1658
1659         /* Already have default clk set, free it */
1660         if (!IS_ERR(opp_table->clk))
1661                 clk_put(opp_table->clk);
1662
1663         /* Find clk for the device */
1664         opp_table->clk = clk_get(dev, name);
1665         if (IS_ERR(opp_table->clk)) {
1666                 ret = PTR_ERR(opp_table->clk);
1667                 if (ret != -EPROBE_DEFER) {
1668                         dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1669                                 ret);
1670                 }
1671                 goto err;
1672         }
1673
1674         return opp_table;
1675
1676 err:
1677         dev_pm_opp_put_opp_table(opp_table);
1678
1679         return ERR_PTR(ret);
1680 }
1681 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1682
1683 /**
1684  * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1685  * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1686  */
1687 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1688 {
1689         /* Make sure there are no concurrent readers while updating opp_table */
1690         WARN_ON(!list_empty(&opp_table->opp_list));
1691
1692         clk_put(opp_table->clk);
1693         opp_table->clk = ERR_PTR(-EINVAL);
1694
1695         dev_pm_opp_put_opp_table(opp_table);
1696 }
1697 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1698
1699 /**
1700  * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1701  * @dev: Device for which the helper is getting registered.
1702  * @set_opp: Custom set OPP helper.
1703  *
1704  * This is useful to support complex platforms (like platforms with multiple
1705  * regulators per device), instead of the generic OPP set rate helper.
1706  *
1707  * This must be called before any OPPs are initialized for the device.
1708  */
1709 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1710                         int (*set_opp)(struct dev_pm_set_opp_data *data))
1711 {
1712         struct opp_table *opp_table;
1713
1714         if (!set_opp)
1715                 return ERR_PTR(-EINVAL);
1716
1717         opp_table = dev_pm_opp_get_opp_table(dev);
1718         if (!opp_table)
1719                 return ERR_PTR(-ENOMEM);
1720
1721         /* This should be called before OPPs are initialized */
1722         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1723                 dev_pm_opp_put_opp_table(opp_table);
1724                 return ERR_PTR(-EBUSY);
1725         }
1726
1727         /* Another CPU that shares the OPP table has set the helper ? */
1728         if (!opp_table->set_opp)
1729                 opp_table->set_opp = set_opp;
1730
1731         return opp_table;
1732 }
1733 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1734
1735 /**
1736  * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
1737  *                                         set_opp helper
1738  * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1739  *
1740  * Release resources blocked for platform specific set_opp helper.
1741  */
1742 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
1743 {
1744         /* Make sure there are no concurrent readers while updating opp_table */
1745         WARN_ON(!list_empty(&opp_table->opp_list));
1746
1747         opp_table->set_opp = NULL;
1748         dev_pm_opp_put_opp_table(opp_table);
1749 }
1750 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
1751
1752 static void _opp_detach_genpd(struct opp_table *opp_table)
1753 {
1754         int index;
1755
1756         for (index = 0; index < opp_table->required_opp_count; index++) {
1757                 if (!opp_table->genpd_virt_devs[index])
1758                         continue;
1759
1760                 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
1761                 opp_table->genpd_virt_devs[index] = NULL;
1762         }
1763
1764         kfree(opp_table->genpd_virt_devs);
1765         opp_table->genpd_virt_devs = NULL;
1766 }
1767
1768 /**
1769  * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
1770  * @dev: Consumer device for which the genpd is getting attached.
1771  * @names: Null terminated array of pointers containing names of genpd to attach.
1772  *
1773  * Multiple generic power domains for a device are supported with the help of
1774  * virtual genpd devices, which are created for each consumer device - genpd
1775  * pair. These are the device structures which are attached to the power domain
1776  * and are required by the OPP core to set the performance state of the genpd.
1777  * The same API also works for the case where single genpd is available and so
1778  * we don't need to support that separately.
1779  *
1780  * This helper will normally be called by the consumer driver of the device
1781  * "dev", as only that has details of the genpd names.
1782  *
1783  * This helper needs to be called once with a list of all genpd to attach.
1784  * Otherwise the original device structure will be used instead by the OPP core.
1785  */
1786 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names)
1787 {
1788         struct opp_table *opp_table;
1789         struct device *virt_dev;
1790         int index, ret = -EINVAL;
1791         const char **name = names;
1792
1793         opp_table = dev_pm_opp_get_opp_table(dev);
1794         if (!opp_table)
1795                 return ERR_PTR(-ENOMEM);
1796
1797         /*
1798          * If the genpd's OPP table isn't already initialized, parsing of the
1799          * required-opps fail for dev. We should retry this after genpd's OPP
1800          * table is added.
1801          */
1802         if (!opp_table->required_opp_count) {
1803                 ret = -EPROBE_DEFER;
1804                 goto put_table;
1805         }
1806
1807         mutex_lock(&opp_table->genpd_virt_dev_lock);
1808
1809         opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
1810                                              sizeof(*opp_table->genpd_virt_devs),
1811                                              GFP_KERNEL);
1812         if (!opp_table->genpd_virt_devs)
1813                 goto unlock;
1814
1815         while (*name) {
1816                 index = of_property_match_string(dev->of_node,
1817                                                  "power-domain-names", *name);
1818                 if (index < 0) {
1819                         dev_err(dev, "Failed to find power domain: %s (%d)\n",
1820                                 *name, index);
1821                         goto err;
1822                 }
1823
1824                 if (index >= opp_table->required_opp_count) {
1825                         dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
1826                                 *name, opp_table->required_opp_count, index);
1827                         goto err;
1828                 }
1829
1830                 if (opp_table->genpd_virt_devs[index]) {
1831                         dev_err(dev, "Genpd virtual device already set %s\n",
1832                                 *name);
1833                         goto err;
1834                 }
1835
1836                 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
1837                 if (IS_ERR(virt_dev)) {
1838                         ret = PTR_ERR(virt_dev);
1839                         dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
1840                         goto err;
1841                 }
1842
1843                 opp_table->genpd_virt_devs[index] = virt_dev;
1844                 name++;
1845         }
1846
1847         mutex_unlock(&opp_table->genpd_virt_dev_lock);
1848
1849         return opp_table;
1850
1851 err:
1852         _opp_detach_genpd(opp_table);
1853 unlock:
1854         mutex_unlock(&opp_table->genpd_virt_dev_lock);
1855
1856 put_table:
1857         dev_pm_opp_put_opp_table(opp_table);
1858
1859         return ERR_PTR(ret);
1860 }
1861 EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
1862
1863 /**
1864  * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
1865  * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
1866  *
1867  * This detaches the genpd(s), resets the virtual device pointers, and puts the
1868  * OPP table.
1869  */
1870 void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
1871 {
1872         /*
1873          * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
1874          * used in parallel.
1875          */
1876         mutex_lock(&opp_table->genpd_virt_dev_lock);
1877         _opp_detach_genpd(opp_table);
1878         mutex_unlock(&opp_table->genpd_virt_dev_lock);
1879
1880         dev_pm_opp_put_opp_table(opp_table);
1881 }
1882 EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
1883
1884 /**
1885  * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
1886  * @src_table: OPP table which has dst_table as one of its required OPP table.
1887  * @dst_table: Required OPP table of the src_table.
1888  * @pstate: Current performance state of the src_table.
1889  *
1890  * This Returns pstate of the OPP (present in @dst_table) pointed out by the
1891  * "required-opps" property of the OPP (present in @src_table) which has
1892  * performance state set to @pstate.
1893  *
1894  * Return: Zero or positive performance state on success, otherwise negative
1895  * value on errors.
1896  */
1897 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
1898                                        struct opp_table *dst_table,
1899                                        unsigned int pstate)
1900 {
1901         struct dev_pm_opp *opp;
1902         int dest_pstate = -EINVAL;
1903         int i;
1904
1905         if (!pstate)
1906                 return 0;
1907
1908         /*
1909          * Normally the src_table will have the "required_opps" property set to
1910          * point to one of the OPPs in the dst_table, but in some cases the
1911          * genpd and its master have one to one mapping of performance states
1912          * and so none of them have the "required-opps" property set. Return the
1913          * pstate of the src_table as it is in such cases.
1914          */
1915         if (!src_table->required_opp_count)
1916                 return pstate;
1917
1918         for (i = 0; i < src_table->required_opp_count; i++) {
1919                 if (src_table->required_opp_tables[i]->np == dst_table->np)
1920                         break;
1921         }
1922
1923         if (unlikely(i == src_table->required_opp_count)) {
1924                 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
1925                        __func__, src_table, dst_table);
1926                 return -EINVAL;
1927         }
1928
1929         mutex_lock(&src_table->lock);
1930
1931         list_for_each_entry(opp, &src_table->opp_list, node) {
1932                 if (opp->pstate == pstate) {
1933                         dest_pstate = opp->required_opps[i]->pstate;
1934                         goto unlock;
1935                 }
1936         }
1937
1938         pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
1939                dst_table);
1940
1941 unlock:
1942         mutex_unlock(&src_table->lock);
1943
1944         return dest_pstate;
1945 }
1946
1947 /**
1948  * dev_pm_opp_add()  - Add an OPP table from a table definitions
1949  * @dev:        device for which we do this operation
1950  * @freq:       Frequency in Hz for this OPP
1951  * @u_volt:     Voltage in uVolts for this OPP
1952  *
1953  * This function adds an opp definition to the opp table and returns status.
1954  * The opp is made available by default and it can be controlled using
1955  * dev_pm_opp_enable/disable functions.
1956  *
1957  * Return:
1958  * 0            On success OR
1959  *              Duplicate OPPs (both freq and volt are same) and opp->available
1960  * -EEXIST      Freq are same and volt are different OR
1961  *              Duplicate OPPs (both freq and volt are same) and !opp->available
1962  * -ENOMEM      Memory allocation failure
1963  */
1964 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
1965 {
1966         struct opp_table *opp_table;
1967         int ret;
1968
1969         opp_table = dev_pm_opp_get_opp_table(dev);
1970         if (!opp_table)
1971                 return -ENOMEM;
1972
1973         /* Fix regulator count for dynamic OPPs */
1974         opp_table->regulator_count = 1;
1975
1976         ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
1977         if (ret)
1978                 dev_pm_opp_put_opp_table(opp_table);
1979
1980         return ret;
1981 }
1982 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
1983
1984 /**
1985  * _opp_set_availability() - helper to set the availability of an opp
1986  * @dev:                device for which we do this operation
1987  * @freq:               OPP frequency to modify availability
1988  * @availability_req:   availability status requested for this opp
1989  *
1990  * Set the availability of an OPP, opp_{enable,disable} share a common logic
1991  * which is isolated here.
1992  *
1993  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1994  * copy operation, returns 0 if no modification was done OR modification was
1995  * successful.
1996  */
1997 static int _opp_set_availability(struct device *dev, unsigned long freq,
1998                                  bool availability_req)
1999 {
2000         struct opp_table *opp_table;
2001         struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2002         int r = 0;
2003
2004         /* Find the opp_table */
2005         opp_table = _find_opp_table(dev);
2006         if (IS_ERR(opp_table)) {
2007                 r = PTR_ERR(opp_table);
2008                 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2009                 return r;
2010         }
2011
2012         mutex_lock(&opp_table->lock);
2013
2014         /* Do we have the frequency? */
2015         list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2016                 if (tmp_opp->rate == freq) {
2017                         opp = tmp_opp;
2018                         break;
2019                 }
2020         }
2021
2022         if (IS_ERR(opp)) {
2023                 r = PTR_ERR(opp);
2024                 goto unlock;
2025         }
2026
2027         /* Is update really needed? */
2028         if (opp->available == availability_req)
2029                 goto unlock;
2030
2031         opp->available = availability_req;
2032
2033         dev_pm_opp_get(opp);
2034         mutex_unlock(&opp_table->lock);
2035
2036         /* Notify the change of the OPP availability */
2037         if (availability_req)
2038                 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
2039                                              opp);
2040         else
2041                 blocking_notifier_call_chain(&opp_table->head,
2042                                              OPP_EVENT_DISABLE, opp);
2043
2044         dev_pm_opp_put(opp);
2045         goto put_table;
2046
2047 unlock:
2048         mutex_unlock(&opp_table->lock);
2049 put_table:
2050         dev_pm_opp_put_opp_table(opp_table);
2051         return r;
2052 }
2053
2054 /**
2055  * dev_pm_opp_enable() - Enable a specific OPP
2056  * @dev:        device for which we do this operation
2057  * @freq:       OPP frequency to enable
2058  *
2059  * Enables a provided opp. If the operation is valid, this returns 0, else the
2060  * corresponding error value. It is meant to be used for users an OPP available
2061  * after being temporarily made unavailable with dev_pm_opp_disable.
2062  *
2063  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2064  * copy operation, returns 0 if no modification was done OR modification was
2065  * successful.
2066  */
2067 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2068 {
2069         return _opp_set_availability(dev, freq, true);
2070 }
2071 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2072
2073 /**
2074  * dev_pm_opp_disable() - Disable a specific OPP
2075  * @dev:        device for which we do this operation
2076  * @freq:       OPP frequency to disable
2077  *
2078  * Disables a provided opp. If the operation is valid, this returns
2079  * 0, else the corresponding error value. It is meant to be a temporary
2080  * control by users to make this OPP not available until the circumstances are
2081  * right to make it available again (with a call to dev_pm_opp_enable).
2082  *
2083  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2084  * copy operation, returns 0 if no modification was done OR modification was
2085  * successful.
2086  */
2087 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2088 {
2089         return _opp_set_availability(dev, freq, false);
2090 }
2091 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2092
2093 /**
2094  * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2095  * @dev:        Device for which notifier needs to be registered
2096  * @nb:         Notifier block to be registered
2097  *
2098  * Return: 0 on success or a negative error value.
2099  */
2100 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2101 {
2102         struct opp_table *opp_table;
2103         int ret;
2104
2105         opp_table = _find_opp_table(dev);
2106         if (IS_ERR(opp_table))
2107                 return PTR_ERR(opp_table);
2108
2109         ret = blocking_notifier_chain_register(&opp_table->head, nb);
2110
2111         dev_pm_opp_put_opp_table(opp_table);
2112
2113         return ret;
2114 }
2115 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2116
2117 /**
2118  * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2119  * @dev:        Device for which notifier needs to be unregistered
2120  * @nb:         Notifier block to be unregistered
2121  *
2122  * Return: 0 on success or a negative error value.
2123  */
2124 int dev_pm_opp_unregister_notifier(struct device *dev,
2125                                    struct notifier_block *nb)
2126 {
2127         struct opp_table *opp_table;
2128         int ret;
2129
2130         opp_table = _find_opp_table(dev);
2131         if (IS_ERR(opp_table))
2132                 return PTR_ERR(opp_table);
2133
2134         ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2135
2136         dev_pm_opp_put_opp_table(opp_table);
2137
2138         return ret;
2139 }
2140 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2141
2142 void _dev_pm_opp_find_and_remove_table(struct device *dev)
2143 {
2144         struct opp_table *opp_table;
2145
2146         /* Check for existing table for 'dev' */
2147         opp_table = _find_opp_table(dev);
2148         if (IS_ERR(opp_table)) {
2149                 int error = PTR_ERR(opp_table);
2150
2151                 if (error != -ENODEV)
2152                         WARN(1, "%s: opp_table: %d\n",
2153                              IS_ERR_OR_NULL(dev) ?
2154                                         "Invalid device" : dev_name(dev),
2155                              error);
2156                 return;
2157         }
2158
2159         _put_opp_list_kref(opp_table);
2160
2161         /* Drop reference taken by _find_opp_table() */
2162         dev_pm_opp_put_opp_table(opp_table);
2163
2164         /* Drop reference taken while the OPP table was added */
2165         dev_pm_opp_put_opp_table(opp_table);
2166 }
2167
2168 /**
2169  * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2170  * @dev:        device pointer used to lookup OPP table.
2171  *
2172  * Free both OPPs created using static entries present in DT and the
2173  * dynamically added entries.
2174  */
2175 void dev_pm_opp_remove_table(struct device *dev)
2176 {
2177         _dev_pm_opp_find_and_remove_table(dev);
2178 }
2179 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);