arch/arm/mach-omap2/voltage.c

   1 /*
   2  * OMAP3/OMAP4 Voltage Management Routines
   3  *
   4  * Author: Thara Gopinath       <thara@ti.com>
   5  *
   6  * Copyright (C) 2007 Texas Instruments, Inc.
   7  * Rajendra Nayak <rnayak@ti.com>
   8  * Lesly A M <x0080970@ti.com>
   9  *
  10  * Copyright (C) 2008, 2011 Nokia Corporation
  11  * Kalle Jokiniemi
  12  * Paul Walmsley
  13  *
  14  * Copyright (C) 2010 Texas Instruments, Inc.
  15  * Thara Gopinath <thara@ti.com>
  16  *
  17  * This program is free software; you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License version 2 as
  19  * published by the Free Software Foundation.
  20  */
  21
  22 #include <linux/delay.h>
  23 #include <linux/io.h>
  24 #include <linux/clk.h>
  25 #include <linux/err.h>
  26 #include <linux/debugfs.h>
  27 #include <linux/slab.h>
  28
  29 #include <plat/common.h>
  30
  31 #include "prm-regbits-34xx.h"
  32 #include "prm-regbits-44xx.h"
  33 #include "prm44xx.h"
  34 #include "prcm44xx.h"
  35 #include "prminst44xx.h"
  36 #include "control.h"
  37
  38 #include "voltage.h"
  39 #include "powerdomain.h"
  40
  41 #include "vc.h"
  42 #include "vp.h"
  43
  44 static LIST_HEAD(voltdm_list);
  45
  46 #define VOLTAGE_DIR_SIZE        16
  47 static struct dentry *voltage_dir;
  48
  49 static u32 omap3_voltage_read_reg(u16 mod, u8 offset)
  50 {
  51         return omap2_prm_read_mod_reg(mod, offset);
  52 }
  53
  54 static void omap3_voltage_write_reg(u32 val, u16 mod, u8 offset)
  55 {
  56         omap2_prm_write_mod_reg(val, mod, offset);
  57 }
  58
  59 static u32 omap4_voltage_read_reg(u16 mod, u8 offset)
  60 {
  61         return omap4_prminst_read_inst_reg(OMAP4430_PRM_PARTITION,
  62                                         mod, offset);
  63 }
  64
  65 static void omap4_voltage_write_reg(u32 val, u16 mod, u8 offset)
  66 {
  67         omap4_prminst_write_inst_reg(val, OMAP4430_PRM_PARTITION, mod, offset);
  68 }
  69
  70 static int __init _config_common_vdd_data(struct voltagedomain *voltdm)
  71 {
  72         char *sys_ck_name;
  73         struct clk *sys_ck;
  74         u32 sys_clk_speed, timeout_val, waittime;
  75         struct omap_vdd_info *vdd = voltdm->vdd;
  76
  77         /*
  78          * XXX Clockfw should handle this, or this should be in a
  79          * struct record
  80          */
  81         if (cpu_is_omap24xx() || cpu_is_omap34xx())
  82                 sys_ck_name = "sys_ck";
  83         else if (cpu_is_omap44xx())
  84                 sys_ck_name = "sys_clkin_ck";
  85         else
  86                 return -EINVAL;
  87
  88         /*
  89          * Sys clk rate is require to calculate vp timeout value and
  90          * smpswaittimemin and smpswaittimemax.
  91          */
  92         sys_ck = clk_get(NULL, sys_ck_name);
  93         if (IS_ERR(sys_ck)) {
  94                 pr_warning("%s: Could not get the sys clk to calculate"
  95                         "various vdd_%s params\n", __func__, voltdm->name);
  96                 return -EINVAL;
  97         }
  98         sys_clk_speed = clk_get_rate(sys_ck);
  99         clk_put(sys_ck);
 100         /* Divide to avoid overflow */
 101         sys_clk_speed /= 1000;
 102
 103         /* Generic voltage parameters */
 104         vdd->volt_scale = omap_vp_forceupdate_scale;
 105         vdd->vp_enabled = false;
 106
 107         vdd->vp_rt_data.vpconfig_erroroffset =
 108                 (vdd->pmic_info->vp_erroroffset <<
 109                  vdd->vp_data->vp_common->vpconfig_erroroffset_shift);
 110
 111         timeout_val = (sys_clk_speed * vdd->pmic_info->vp_timeout_us) / 1000;
 112         vdd->vp_rt_data.vlimitto_timeout = timeout_val;
 113         vdd->vp_rt_data.vlimitto_vddmin = vdd->pmic_info->vp_vddmin;
 114         vdd->vp_rt_data.vlimitto_vddmax = vdd->pmic_info->vp_vddmax;
 115
 116         waittime = ((vdd->pmic_info->step_size / vdd->pmic_info->slew_rate) *
 117                                 sys_clk_speed) / 1000;
 118         vdd->vp_rt_data.vstepmin_smpswaittimemin = waittime;
 119         vdd->vp_rt_data.vstepmax_smpswaittimemax = waittime;
 120         vdd->vp_rt_data.vstepmin_stepmin = vdd->pmic_info->vp_vstepmin;
 121         vdd->vp_rt_data.vstepmax_stepmax = vdd->pmic_info->vp_vstepmax;
 122
 123         return 0;
 124 }
 125
 126 static int nom_volt_debug_get(void *data, u64 *val)
 127 {
 128         struct voltagedomain *voltdm = (struct voltagedomain *)data;
 129
 130         if (!voltdm) {
 131                 pr_warning("Wrong paramater passed\n");
 132                 return -EINVAL;
 133         }
 134
 135         *val = omap_voltage_get_nom_volt(voltdm);
 136
 137         return 0;
 138 }
 139
 140 DEFINE_SIMPLE_ATTRIBUTE(nom_volt_debug_fops, nom_volt_debug_get, NULL,
 141                                                                 "%llu\n");
 142 static void __init vdd_debugfs_init(struct voltagedomain *voltdm)
 143 {
 144         char *name;
 145         struct omap_vdd_info *vdd = voltdm->vdd;
 146
 147         name = kzalloc(VOLTAGE_DIR_SIZE, GFP_KERNEL);
 148         if (!name) {
 149                 pr_warning("%s: Unable to allocate memory for debugfs"
 150                         " directory name for vdd_%s",
 151                         __func__, voltdm->name);
 152                 return;
 153         }
 154         strcpy(name, "vdd_");
 155         strcat(name, voltdm->name);
 156
 157         vdd->debug_dir = debugfs_create_dir(name, voltage_dir);
 158         kfree(name);
 159         if (IS_ERR(vdd->debug_dir)) {
 160                 pr_warning("%s: Unable to create debugfs directory for"
 161                         " vdd_%s\n", __func__, voltdm->name);
 162                 vdd->debug_dir = NULL;
 163                 return;
 164         }
 165
 166         (void) debugfs_create_file("curr_nominal_volt", S_IRUGO,
 167                                 vdd->debug_dir, (void *) voltdm,
 168                                 &nom_volt_debug_fops);
 169 }
 170
 171 static int __init omap_vdd_data_configure(struct voltagedomain *voltdm)
 172 {
 173         struct omap_vdd_info *vdd = voltdm->vdd;
 174         int ret = -EINVAL;
 175
 176         if (!vdd->pmic_info) {
 177                 pr_err("%s: PMIC info requried to configure vdd_%s not"
 178                         "populated.Hence cannot initialize vdd_%s\n",
 179                         __func__, voltdm->name, voltdm->name);
 180                 goto ovdc_out;
 181         }
 182
 183         if (IS_ERR_VALUE(_config_common_vdd_data(voltdm)))
 184                 goto ovdc_out;
 185
 186         if (cpu_is_omap34xx()) {
 187                 vdd->read_reg = omap3_voltage_read_reg;
 188                 vdd->write_reg = omap3_voltage_write_reg;
 189                 ret = 0;
 190         } else if (cpu_is_omap44xx()) {
 191                 vdd->read_reg = omap4_voltage_read_reg;
 192                 vdd->write_reg = omap4_voltage_write_reg;
 193                 ret = 0;
 194         }
 195
 196 ovdc_out:
 197         return ret;
 198 }
 199
 200 /* Public functions */
 201 /**
 202  * omap_voltage_get_nom_volt() - Gets the current non-auto-compensated voltage
 203  * @voltdm:     pointer to the VDD for which current voltage info is needed
 204  *
 205  * API to get the current non-auto-compensated voltage for a VDD.
 206  * Returns 0 in case of error else returns the current voltage for the VDD.
 207  */
 208 unsigned long omap_voltage_get_nom_volt(struct voltagedomain *voltdm)
 209 {
 210         struct omap_vdd_info *vdd;
 211
 212         if (!voltdm || IS_ERR(voltdm)) {
 213                 pr_warning("%s: VDD specified does not exist!\n", __func__);
 214                 return 0;
 215         }
 216
 217         vdd = voltdm->vdd;
 218
 219         return vdd->curr_volt;
 220 }
 221
 222 /**
 223  * omap_voltage_scale_vdd() - API to scale voltage of a particular
 224  *                              voltage domain.
 225  * @voltdm:     pointer to the VDD which is to be scaled.
 226  * @target_volt:        The target voltage of the voltage domain
 227  *
 228  * This API should be called by the kernel to do the voltage scaling
 229  * for a particular voltage domain during dvfs or any other situation.
 230  */
 231 int omap_voltage_scale_vdd(struct voltagedomain *voltdm,
 232                 unsigned long target_volt)
 233 {
 234         struct omap_vdd_info *vdd;
 235
 236         if (!voltdm || IS_ERR(voltdm)) {
 237                 pr_warning("%s: VDD specified does not exist!\n", __func__);
 238                 return -EINVAL;
 239         }
 240
 241         vdd = voltdm->vdd;
 242
 243         if (!vdd->volt_scale) {
 244                 pr_err("%s: No voltage scale API registered for vdd_%s\n",
 245                         __func__, voltdm->name);
 246                 return -ENODATA;
 247         }
 248
 249         return vdd->volt_scale(voltdm, target_volt);
 250 }
 251
 252 /**
 253  * omap_voltage_reset() - Resets the voltage of a particular voltage domain
 254  *                      to that of the current OPP.
 255  * @voltdm:     pointer to the VDD whose voltage is to be reset.
 256  *
 257  * This API finds out the correct voltage the voltage domain is supposed
 258  * to be at and resets the voltage to that level. Should be used especially
 259  * while disabling any voltage compensation modules.
 260  */
 261 void omap_voltage_reset(struct voltagedomain *voltdm)
 262 {
 263         unsigned long target_uvdc;
 264
 265         if (!voltdm || IS_ERR(voltdm)) {
 266                 pr_warning("%s: VDD specified does not exist!\n", __func__);
 267                 return;
 268         }
 269
 270         target_uvdc = omap_voltage_get_nom_volt(voltdm);
 271         if (!target_uvdc) {
 272                 pr_err("%s: unable to find current voltage for vdd_%s\n",
 273                         __func__, voltdm->name);
 274                 return;
 275         }
 276
 277         omap_voltage_scale_vdd(voltdm, target_uvdc);
 278 }
 279
 280 /**
 281  * omap_voltage_get_volttable() - API to get the voltage table associated with a
 282  *                              particular voltage domain.
 283  * @voltdm:     pointer to the VDD for which the voltage table is required
 284  * @volt_data:  the voltage table for the particular vdd which is to be
 285  *              populated by this API
 286  *
 287  * This API populates the voltage table associated with a VDD into the
 288  * passed parameter pointer. Returns the count of distinct voltages
 289  * supported by this vdd.
 290  *
 291  */
 292 void omap_voltage_get_volttable(struct voltagedomain *voltdm,
 293                 struct omap_volt_data **volt_data)
 294 {
 295         struct omap_vdd_info *vdd;
 296
 297         if (!voltdm || IS_ERR(voltdm)) {
 298                 pr_warning("%s: VDD specified does not exist!\n", __func__);
 299                 return;
 300         }
 301
 302         vdd = voltdm->vdd;
 303
 304         *volt_data = vdd->volt_data;
 305 }
 306
 307 /**
 308  * omap_voltage_get_voltdata() - API to get the voltage table entry for a
 309  *                              particular voltage
 310  * @voltdm:     pointer to the VDD whose voltage table has to be searched
 311  * @volt:       the voltage to be searched in the voltage table
 312  *
 313  * This API searches through the voltage table for the required voltage
 314  * domain and tries to find a matching entry for the passed voltage volt.
 315  * If a matching entry is found volt_data is populated with that entry.
 316  * This API searches only through the non-compensated voltages int the
 317  * voltage table.
 318  * Returns pointer to the voltage table entry corresponding to volt on
 319  * success. Returns -ENODATA if no voltage table exisits for the passed voltage
 320  * domain or if there is no matching entry.
 321  */
 322 struct omap_volt_data *omap_voltage_get_voltdata(struct voltagedomain *voltdm,
 323                 unsigned long volt)
 324 {
 325         struct omap_vdd_info *vdd;
 326         int i;
 327
 328         if (!voltdm || IS_ERR(voltdm)) {
 329                 pr_warning("%s: VDD specified does not exist!\n", __func__);
 330                 return ERR_PTR(-EINVAL);
 331         }
 332
 333         vdd = voltdm->vdd;
 334
 335         if (!vdd->volt_data) {
 336                 pr_warning("%s: voltage table does not exist for vdd_%s\n",
 337                         __func__, voltdm->name);
 338                 return ERR_PTR(-ENODATA);
 339         }
 340
 341         for (i = 0; vdd->volt_data[i].volt_nominal != 0; i++) {
 342                 if (vdd->volt_data[i].volt_nominal == volt)
 343                         return &vdd->volt_data[i];
 344         }
 345
 346         pr_notice("%s: Unable to match the current voltage with the voltage"
 347                 "table for vdd_%s\n", __func__, voltdm->name);
 348
 349         return ERR_PTR(-ENODATA);
 350 }
 351
 352 /**
 353  * omap_voltage_register_pmic() - API to register PMIC specific data
 354  * @voltdm:     pointer to the VDD for which the PMIC specific data is
 355  *              to be registered
 356  * @pmic_info:  the structure containing pmic info
 357  *
 358  * This API is to be called by the SOC/PMIC file to specify the
 359  * pmic specific info as present in omap_volt_pmic_info structure.
 360  */
 361 int omap_voltage_register_pmic(struct voltagedomain *voltdm,
 362                 struct omap_volt_pmic_info *pmic_info)
 363 {
 364         struct omap_vdd_info *vdd;
 365
 366         if (!voltdm || IS_ERR(voltdm)) {
 367                 pr_warning("%s: VDD specified does not exist!\n", __func__);
 368                 return -EINVAL;
 369         }
 370
 371         vdd = voltdm->vdd;
 372
 373         vdd->pmic_info = pmic_info;
 374
 375         return 0;
 376 }
 377
 378 /**
 379  * omap_voltage_get_dbgdir() - API to get pointer to the debugfs directory
 380  *                              corresponding to a voltage domain.
 381  *
 382  * @voltdm:     pointer to the VDD whose debug directory is required.
 383  *
 384  * This API returns pointer to the debugfs directory corresponding
 385  * to the voltage domain. Should be used by drivers requiring to
 386  * add any debug entry for a particular voltage domain. Returns NULL
 387  * in case of error.
 388  */
 389 struct dentry *omap_voltage_get_dbgdir(struct voltagedomain *voltdm)
 390 {
 391         struct omap_vdd_info *vdd;
 392
 393         if (!voltdm || IS_ERR(voltdm)) {
 394                 pr_warning("%s: VDD specified does not exist!\n", __func__);
 395                 return NULL;
 396         }
 397
 398         vdd = voltdm->vdd;
 399
 400         return vdd->debug_dir;
 401 }
 402
 403 /**
 404  * omap_change_voltscale_method() - API to change the voltage scaling method.
 405  * @voltdm:     pointer to the VDD whose voltage scaling method
 406  *              has to be changed.
 407  * @voltscale_method:   the method to be used for voltage scaling.
 408  *
 409  * This API can be used by the board files to change the method of voltage
 410  * scaling between vpforceupdate and vcbypass. The parameter values are
 411  * defined in voltage.h
 412  */
 413 void omap_change_voltscale_method(struct voltagedomain *voltdm,
 414                 int voltscale_method)
 415 {
 416         struct omap_vdd_info *vdd;
 417
 418         if (!voltdm || IS_ERR(voltdm)) {
 419                 pr_warning("%s: VDD specified does not exist!\n", __func__);
 420                 return;
 421         }
 422
 423         vdd = voltdm->vdd;
 424
 425         switch (voltscale_method) {
 426         case VOLTSCALE_VPFORCEUPDATE:
 427                 vdd->volt_scale = omap_vp_forceupdate_scale;
 428                 return;
 429         case VOLTSCALE_VCBYPASS:
 430                 vdd->volt_scale = omap_vc_bypass_scale;
 431                 return;
 432         default:
 433                 pr_warning("%s: Trying to change the method of voltage scaling"
 434                         "to an unsupported one!\n", __func__);
 435         }
 436 }
 437
 438 /**
 439  * omap_voltage_late_init() - Init the various voltage parameters
 440  *
 441  * This API is to be called in the later stages of the
 442  * system boot to init the voltage controller and
 443  * voltage processors.
 444  */
 445 int __init omap_voltage_late_init(void)
 446 {
 447         struct voltagedomain *voltdm;
 448
 449         if (list_empty(&voltdm_list)) {
 450                 pr_err("%s: Voltage driver support not added\n",
 451                         __func__);
 452                 return -EINVAL;
 453         }
 454
 455         voltage_dir = debugfs_create_dir("voltage", NULL);
 456         if (IS_ERR(voltage_dir))
 457                 pr_err("%s: Unable to create voltage debugfs main dir\n",
 458                         __func__);
 459         list_for_each_entry(voltdm, &voltdm_list, node) {
 460                 if (!voltdm->scalable)
 461                         continue;
 462
 463                 if (voltdm->vc) {
 464                         voltdm->vdd->volt_scale = omap_vc_bypass_scale;
 465                         omap_vc_init_channel(voltdm);
 466                 }
 467
 468                 if (voltdm->vdd) {
 469                         if (omap_vdd_data_configure(voltdm))
 470                                 continue;
 471                         vdd_debugfs_init(voltdm);
 472                         omap_vp_init(voltdm);
 473                 }
 474         }
 475
 476         return 0;
 477 }
 478
 479 static struct voltagedomain *_voltdm_lookup(const char *name)
 480 {
 481         struct voltagedomain *voltdm, *temp_voltdm;
 482
 483         voltdm = NULL;
 484
 485         list_for_each_entry(temp_voltdm, &voltdm_list, node) {
 486                 if (!strcmp(name, temp_voltdm->name)) {
 487                         voltdm = temp_voltdm;
 488                         break;
 489                 }
 490         }
 491
 492         return voltdm;
 493 }
 494
 495 /**
 496  * voltdm_add_pwrdm - add a powerdomain to a voltagedomain
 497  * @voltdm: struct voltagedomain * to add the powerdomain to
 498  * @pwrdm: struct powerdomain * to associate with a voltagedomain
 499  *
 500  * Associate the powerdomain @pwrdm with a voltagedomain @voltdm.  This
 501  * enables the use of voltdm_for_each_pwrdm().  Returns -EINVAL if
 502  * presented with invalid pointers; -ENOMEM if memory could not be allocated;
 503  * or 0 upon success.
 504  */
 505 int voltdm_add_pwrdm(struct voltagedomain *voltdm, struct powerdomain *pwrdm)
 506 {
 507         if (!voltdm || !pwrdm)
 508                 return -EINVAL;
 509
 510         pr_debug("voltagedomain: associating powerdomain %s with voltagedomain "
 511                  "%s\n", pwrdm->name, voltdm->name);
 512
 513         list_add(&pwrdm->voltdm_node, &voltdm->pwrdm_list);
 514
 515         return 0;
 516 }
 517
 518 /**
 519  * voltdm_for_each_pwrdm - call function for each pwrdm in a voltdm
 520  * @voltdm: struct voltagedomain * to iterate over
 521  * @fn: callback function *
 522  *
 523  * Call the supplied function @fn for each powerdomain in the
 524  * voltagedomain @voltdm.  Returns -EINVAL if presented with invalid
 525  * pointers; or passes along the last return value of the callback
 526  * function, which should be 0 for success or anything else to
 527  * indicate failure.
 528  */
 529 int voltdm_for_each_pwrdm(struct voltagedomain *voltdm,
 530                           int (*fn)(struct voltagedomain *voltdm,
 531                                     struct powerdomain *pwrdm))
 532 {
 533         struct powerdomain *pwrdm;
 534         int ret = 0;
 535
 536         if (!fn)
 537                 return -EINVAL;
 538
 539         list_for_each_entry(pwrdm, &voltdm->pwrdm_list, voltdm_node)
 540                 ret = (*fn)(voltdm, pwrdm);
 541
 542         return ret;
 543 }
 544
 545 /**
 546  * voltdm_for_each - call function on each registered voltagedomain
 547  * @fn: callback function *
 548  *
 549  * Call the supplied function @fn for each registered voltagedomain.
 550  * The callback function @fn can return anything but 0 to bail out
 551  * early from the iterator.  Returns the last return value of the
 552  * callback function, which should be 0 for success or anything else
 553  * to indicate failure; or -EINVAL if the function pointer is null.
 554  */
 555 int voltdm_for_each(int (*fn)(struct voltagedomain *voltdm, void *user),
 556                     void *user)
 557 {
 558         struct voltagedomain *temp_voltdm;
 559         int ret = 0;
 560
 561         if (!fn)
 562                 return -EINVAL;
 563
 564         list_for_each_entry(temp_voltdm, &voltdm_list, node) {
 565                 ret = (*fn)(temp_voltdm, user);
 566                 if (ret)
 567                         break;
 568         }
 569
 570         return ret;
 571 }
 572
 573 static int _voltdm_register(struct voltagedomain *voltdm)
 574 {
 575         if (!voltdm || !voltdm->name)
 576                 return -EINVAL;
 577
 578         INIT_LIST_HEAD(&voltdm->pwrdm_list);
 579         list_add(&voltdm->node, &voltdm_list);
 580
 581         pr_debug("voltagedomain: registered %s\n", voltdm->name);
 582
 583         return 0;
 584 }
 585
 586 /**
 587  * voltdm_lookup - look up a voltagedomain by name, return a pointer
 588  * @name: name of voltagedomain
 589  *
 590  * Find a registered voltagedomain by its name @name.  Returns a pointer
 591  * to the struct voltagedomain if found, or NULL otherwise.
 592  */
 593 struct voltagedomain *voltdm_lookup(const char *name)
 594 {
 595         struct voltagedomain *voltdm ;
 596
 597         if (!name)
 598                 return NULL;
 599
 600         voltdm = _voltdm_lookup(name);
 601
 602         return voltdm;
 603 }
 604
 605 /**
 606  * voltdm_init - set up the voltagedomain layer
 607  * @voltdm_list: array of struct voltagedomain pointers to register
 608  *
 609  * Loop through the array of voltagedomains @voltdm_list, registering all
 610  * that are available on the current CPU. If voltdm_list is supplied
 611  * and not null, all of the referenced voltagedomains will be
 612  * registered.  No return value.
 613  */
 614 void voltdm_init(struct voltagedomain **voltdms)
 615 {
 616         struct voltagedomain **v;
 617
 618         if (voltdms) {
 619                 for (v = voltdms; *v; v++)
 620                         _voltdm_register(*v);
 621         }
 622 }