drivers/opp/core.c

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