arch/arm/plat-omap/omap_device.c

   1 /*
   2  * omap_device implementation
   3  *
   4  * Copyright (C) 2009-2010 Nokia Corporation
   5  * Paul Walmsley, Kevin Hilman
   6  *
   7  * Developed in collaboration with (alphabetical order): Benoit
   8  * Cousson, Thara Gopinath, Tony Lindgren, Rajendra Nayak, Vikram
   9  * Pandita, Sakari Poussa, Anand Sawant, Santosh Shilimkar, Richard
  10  * Woodruff
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License version 2 as
  14  * published by the Free Software Foundation.
  15  *
  16  * This code provides a consistent interface for OMAP device drivers
  17  * to control power management and interconnect properties of their
  18  * devices.
  19  *
  20  * In the medium- to long-term, this code should either be
  21  * a) implemented via arch-specific pointers in platform_data
  22  * or
  23  * b) implemented as a proper omap_bus/omap_device in Linux, no more
  24  *    platform_data func pointers
  25  *
  26  *
  27  * Guidelines for usage by driver authors:
  28  *
  29  * 1. These functions are intended to be used by device drivers via
  30  * function pointers in struct platform_data.  As an example,
  31  * omap_device_enable() should be passed to the driver as
  32  *
  33  * struct foo_driver_platform_data {
  34  * ...
  35  *      int (*device_enable)(struct platform_device *pdev);
  36  * ...
  37  * }
  38  *
  39  * Note that the generic "device_enable" name is used, rather than
  40  * "omap_device_enable".  This is so other architectures can pass in their
  41  * own enable/disable functions here.
  42  *
  43  * This should be populated during device setup:
  44  *
  45  * ...
  46  * pdata->device_enable = omap_device_enable;
  47  * ...
  48  *
  49  * 2. Drivers should first check to ensure the function pointer is not null
  50  * before calling it, as in:
  51  *
  52  * if (pdata->device_enable)
  53  *     pdata->device_enable(pdev);
  54  *
  55  * This allows other architectures that don't use similar device_enable()/
  56  * device_shutdown() functions to execute normally.
  57  *
  58  * ...
  59  *
  60  * Suggested usage by device drivers:
  61  *
  62  * During device initialization:
  63  * device_enable()
  64  *
  65  * During device idle:
  66  * (save remaining device context if necessary)
  67  * device_idle();
  68  *
  69  * During device resume:
  70  * device_enable();
  71  * (restore context if necessary)
  72  *
  73  * During device shutdown:
  74  * device_shutdown()
  75  * (device must be reinitialized at this point to use it again)
  76  *
  77  */
  78 #undef DEBUG
  79
  80 #include <linux/kernel.h>
  81 #include <linux/platform_device.h>
  82 #include <linux/slab.h>
  83 #include <linux/err.h>
  84 #include <linux/io.h>
  85 #include <linux/clk.h>
  86 #include <linux/clkdev.h>
  87 #include <linux/pm_runtime.h>
  88
  89 #include <plat/omap_device.h>
  90 #include <plat/omap_hwmod.h>
  91 #include <plat/clock.h>
  92
  93 /* These parameters are passed to _omap_device_{de,}activate() */
  94 #define USE_WAKEUP_LAT                  0
  95 #define IGNORE_WAKEUP_LAT               1
  96
  97 /* Private functions */
  98
  99 /**
 100  * _omap_device_activate - increase device readiness
 101  * @od: struct omap_device *
 102  * @ignore_lat: increase to latency target (0) or full readiness (1)?
 103  *
 104  * Increase readiness of omap_device @od (thus decreasing device
 105  * wakeup latency, but consuming more power).  If @ignore_lat is
 106  * IGNORE_WAKEUP_LAT, make the omap_device fully active.  Otherwise,
 107  * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
 108  * latency is greater than the requested maximum wakeup latency, step
 109  * backwards in the omap_device_pm_latency table to ensure the
 110  * device's maximum wakeup latency is less than or equal to the
 111  * requested maximum wakeup latency.  Returns 0.
 112  */
 113 static int _omap_device_activate(struct omap_device *od, u8 ignore_lat)
 114 {
 115         struct timespec a, b, c;
 116
 117         pr_debug("omap_device: %s: activating\n", od->pdev.name);
 118
 119         while (od->pm_lat_level > 0) {
 120                 struct omap_device_pm_latency *odpl;
 121                 unsigned long long act_lat = 0;
 122
 123                 od->pm_lat_level--;
 124
 125                 odpl = od->pm_lats + od->pm_lat_level;
 126
 127                 if (!ignore_lat &&
 128                     (od->dev_wakeup_lat <= od->_dev_wakeup_lat_limit))
 129                         break;
 130
 131                 read_persistent_clock(&a);
 132
 133                 /* XXX check return code */
 134                 odpl->activate_func(od);
 135
 136                 read_persistent_clock(&b);
 137
 138                 c = timespec_sub(b, a);
 139                 act_lat = timespec_to_ns(&c);
 140
 141                 pr_debug("omap_device: %s: pm_lat %d: activate: elapsed time "
 142                          "%llu nsec\n", od->pdev.name, od->pm_lat_level,
 143                          act_lat);
 144
 145                 if (act_lat > odpl->activate_lat) {
 146                         odpl->activate_lat_worst = act_lat;
 147                         if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
 148                                 odpl->activate_lat = act_lat;
 149                                 pr_warning("omap_device: %s.%d: new worst case "
 150                                            "activate latency %d: %llu\n",
 151                                            od->pdev.name, od->pdev.id,
 152                                            od->pm_lat_level, act_lat);
 153                         } else
 154                                 pr_warning("omap_device: %s.%d: activate "
 155                                            "latency %d higher than exptected. "
 156                                            "(%llu > %d)\n",
 157                                            od->pdev.name, od->pdev.id,
 158                                            od->pm_lat_level, act_lat,
 159                                            odpl->activate_lat);
 160                 }
 161
 162                 od->dev_wakeup_lat -= odpl->activate_lat;
 163         }
 164
 165         return 0;
 166 }
 167
 168 /**
 169  * _omap_device_deactivate - decrease device readiness
 170  * @od: struct omap_device *
 171  * @ignore_lat: decrease to latency target (0) or full inactivity (1)?
 172  *
 173  * Decrease readiness of omap_device @od (thus increasing device
 174  * wakeup latency, but conserving power).  If @ignore_lat is
 175  * IGNORE_WAKEUP_LAT, make the omap_device fully inactive.  Otherwise,
 176  * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
 177  * latency is less than the requested maximum wakeup latency, step
 178  * forwards in the omap_device_pm_latency table to ensure the device's
 179  * maximum wakeup latency is less than or equal to the requested
 180  * maximum wakeup latency.  Returns 0.
 181  */
 182 static int _omap_device_deactivate(struct omap_device *od, u8 ignore_lat)
 183 {
 184         struct timespec a, b, c;
 185
 186         pr_debug("omap_device: %s: deactivating\n", od->pdev.name);
 187
 188         while (od->pm_lat_level < od->pm_lats_cnt) {
 189                 struct omap_device_pm_latency *odpl;
 190                 unsigned long long deact_lat = 0;
 191
 192                 odpl = od->pm_lats + od->pm_lat_level;
 193
 194                 if (!ignore_lat &&
 195                     ((od->dev_wakeup_lat + odpl->activate_lat) >
 196                      od->_dev_wakeup_lat_limit))
 197                         break;
 198
 199                 read_persistent_clock(&a);
 200
 201                 /* XXX check return code */
 202                 odpl->deactivate_func(od);
 203
 204                 read_persistent_clock(&b);
 205
 206                 c = timespec_sub(b, a);
 207                 deact_lat = timespec_to_ns(&c);
 208
 209                 pr_debug("omap_device: %s: pm_lat %d: deactivate: elapsed time "
 210                          "%llu nsec\n", od->pdev.name, od->pm_lat_level,
 211                          deact_lat);
 212
 213                 if (deact_lat > odpl->deactivate_lat) {
 214                         odpl->deactivate_lat_worst = deact_lat;
 215                         if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
 216                                 odpl->deactivate_lat = deact_lat;
 217                                 pr_warning("omap_device: %s.%d: new worst case "
 218                                            "deactivate latency %d: %llu\n",
 219                                            od->pdev.name, od->pdev.id,
 220                                            od->pm_lat_level, deact_lat);
 221                         } else
 222                                 pr_warning("omap_device: %s.%d: deactivate "
 223                                            "latency %d higher than exptected. "
 224                                            "(%llu > %d)\n",
 225                                            od->pdev.name, od->pdev.id,
 226                                            od->pm_lat_level, deact_lat,
 227                                            odpl->deactivate_lat);
 228                 }
 229
 230
 231                 od->dev_wakeup_lat += odpl->activate_lat;
 232
 233                 od->pm_lat_level++;
 234         }
 235
 236         return 0;
 237 }
 238
 239 /**
 240  * _add_optional_clock_clkdev - Add clkdev entry for hwmod optional clocks
 241  * @od: struct omap_device *od
 242  *
 243  * For every optional clock present per hwmod per omap_device, this function
 244  * adds an entry in the clkdev table of the form <dev-id=dev_name, con-id=role>
 245  * if it does not exist already.
 246  *
 247  * The function is called from inside omap_device_build_ss(), after
 248  * omap_device_register.
 249  *
 250  * This allows drivers to get a pointer to its optional clocks based on its role
 251  * by calling clk_get(<dev*>, <role>).
 252  *
 253  * No return value.
 254  */
 255 static void _add_optional_clock_clkdev(struct omap_device *od,
 256                                       struct omap_hwmod *oh)
 257 {
 258         int i;
 259
 260         for (i = 0; i < oh->opt_clks_cnt; i++) {
 261                 struct omap_hwmod_opt_clk *oc;
 262                 struct clk *r;
 263                 struct clk_lookup *l;
 264
 265                 oc = &oh->opt_clks[i];
 266
 267                 if (!oc->_clk)
 268                         continue;
 269
 270                 r = clk_get_sys(dev_name(&od->pdev.dev), oc->role);
 271                 if (!IS_ERR(r))
 272                         continue; /* clkdev entry exists */
 273
 274                 r = omap_clk_get_by_name((char *)oc->clk);
 275                 if (IS_ERR(r)) {
 276                         pr_err("omap_device: %s: omap_clk_get_by_name for %s failed\n",
 277                                dev_name(&od->pdev.dev), oc->clk);
 278                         continue;
 279                 }
 280
 281                 l = clkdev_alloc(r, oc->role, dev_name(&od->pdev.dev));
 282                 if (!l) {
 283                         pr_err("omap_device: %s: clkdev_alloc for %s failed\n",
 284                                dev_name(&od->pdev.dev), oc->role);
 285                         return;
 286                 }
 287                 clkdev_add(l);
 288         }
 289 }
 290
 291
 292 /* Public functions for use by core code */
 293
 294 /**
 295  * omap_device_get_context_loss_count - get lost context count
 296  * @od: struct omap_device *
 297  *
 298  * Using the primary hwmod, query the context loss count for this
 299  * device.
 300  *
 301  * Callers should consider context for this device lost any time this
 302  * function returns a value different than the value the caller got
 303  * the last time it called this function.
 304  *
 305  * If any hwmods exist for the omap_device assoiated with @pdev,
 306  * return the context loss counter for that hwmod, otherwise return
 307  * zero.
 308  */
 309 u32 omap_device_get_context_loss_count(struct platform_device *pdev)
 310 {
 311         struct omap_device *od;
 312         u32 ret = 0;
 313
 314         od = to_omap_device(pdev);
 315
 316         if (od->hwmods_cnt)
 317                 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
 318
 319         return ret;
 320 }
 321
 322 /**
 323  * omap_device_count_resources - count number of struct resource entries needed
 324  * @od: struct omap_device *
 325  *
 326  * Count the number of struct resource entries needed for this
 327  * omap_device @od.  Used by omap_device_build_ss() to determine how
 328  * much memory to allocate before calling
 329  * omap_device_fill_resources().  Returns the count.
 330  */
 331 int omap_device_count_resources(struct omap_device *od)
 332 {
 333         int c = 0;
 334         int i;
 335
 336         for (i = 0; i < od->hwmods_cnt; i++)
 337                 c += omap_hwmod_count_resources(od->hwmods[i]);
 338
 339         pr_debug("omap_device: %s: counted %d total resources across %d "
 340                  "hwmods\n", od->pdev.name, c, od->hwmods_cnt);
 341
 342         return c;
 343 }
 344
 345 /**
 346  * omap_device_fill_resources - fill in array of struct resource
 347  * @od: struct omap_device *
 348  * @res: pointer to an array of struct resource to be filled in
 349  *
 350  * Populate one or more empty struct resource pointed to by @res with
 351  * the resource data for this omap_device @od.  Used by
 352  * omap_device_build_ss() after calling omap_device_count_resources().
 353  * Ideally this function would not be needed at all.  If omap_device
 354  * replaces platform_device, then we can specify our own
 355  * get_resource()/ get_irq()/etc functions that use the underlying
 356  * omap_hwmod information.  Or if platform_device is extended to use
 357  * subarchitecture-specific function pointers, the various
 358  * platform_device functions can simply call omap_device internal
 359  * functions to get device resources.  Hacking around the existing
 360  * platform_device code wastes memory.  Returns 0.
 361  */
 362 int omap_device_fill_resources(struct omap_device *od, struct resource *res)
 363 {
 364         int c = 0;
 365         int i, r;
 366
 367         for (i = 0; i < od->hwmods_cnt; i++) {
 368                 r = omap_hwmod_fill_resources(od->hwmods[i], res);
 369                 res += r;
 370                 c += r;
 371         }
 372
 373         return 0;
 374 }
 375
 376 /**
 377  * omap_device_build - build and register an omap_device with one omap_hwmod
 378  * @pdev_name: name of the platform_device driver to use
 379  * @pdev_id: this platform_device's connection ID
 380  * @oh: ptr to the single omap_hwmod that backs this omap_device
 381  * @pdata: platform_data ptr to associate with the platform_device
 382  * @pdata_len: amount of memory pointed to by @pdata
 383  * @pm_lats: pointer to a omap_device_pm_latency array for this device
 384  * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
 385  * @is_early_device: should the device be registered as an early device or not
 386  *
 387  * Convenience function for building and registering a single
 388  * omap_device record, which in turn builds and registers a
 389  * platform_device record.  See omap_device_build_ss() for more
 390  * information.  Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
 391  * passes along the return value of omap_device_build_ss().
 392  */
 393 struct omap_device *omap_device_build(const char *pdev_name, int pdev_id,
 394                                       struct omap_hwmod *oh, void *pdata,
 395                                       int pdata_len,
 396                                       struct omap_device_pm_latency *pm_lats,
 397                                       int pm_lats_cnt, int is_early_device)
 398 {
 399         struct omap_hwmod *ohs[] = { oh };
 400
 401         if (!oh)
 402                 return ERR_PTR(-EINVAL);
 403
 404         return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
 405                                     pdata_len, pm_lats, pm_lats_cnt,
 406                                     is_early_device);
 407 }
 408
 409 /**
 410  * omap_device_build_ss - build and register an omap_device with multiple hwmods
 411  * @pdev_name: name of the platform_device driver to use
 412  * @pdev_id: this platform_device's connection ID
 413  * @oh: ptr to the single omap_hwmod that backs this omap_device
 414  * @pdata: platform_data ptr to associate with the platform_device
 415  * @pdata_len: amount of memory pointed to by @pdata
 416  * @pm_lats: pointer to a omap_device_pm_latency array for this device
 417  * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
 418  * @is_early_device: should the device be registered as an early device or not
 419  *
 420  * Convenience function for building and registering an omap_device
 421  * subsystem record.  Subsystem records consist of multiple
 422  * omap_hwmods.  This function in turn builds and registers a
 423  * platform_device record.  Returns an ERR_PTR() on error, or passes
 424  * along the return value of omap_device_register().
 425  */
 426 struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id,
 427                                          struct omap_hwmod **ohs, int oh_cnt,
 428                                          void *pdata, int pdata_len,
 429                                          struct omap_device_pm_latency *pm_lats,
 430                                          int pm_lats_cnt, int is_early_device)
 431 {
 432         int ret = -ENOMEM;
 433         struct omap_device *od;
 434         char *pdev_name2;
 435         struct resource *res = NULL;
 436         int i, res_count;
 437         struct omap_hwmod **hwmods;
 438
 439         if (!ohs || oh_cnt == 0 || !pdev_name)
 440                 return ERR_PTR(-EINVAL);
 441
 442         if (!pdata && pdata_len > 0)
 443                 return ERR_PTR(-EINVAL);
 444
 445         pr_debug("omap_device: %s: building with %d hwmods\n", pdev_name,
 446                  oh_cnt);
 447
 448         od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
 449         if (!od)
 450                 return ERR_PTR(-ENOMEM);
 451
 452         od->hwmods_cnt = oh_cnt;
 453
 454         hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt,
 455                          GFP_KERNEL);
 456         if (!hwmods)
 457                 goto odbs_exit1;
 458
 459         memcpy(hwmods, ohs, sizeof(struct omap_hwmod *) * oh_cnt);
 460         od->hwmods = hwmods;
 461
 462         pdev_name2 = kzalloc(strlen(pdev_name) + 1, GFP_KERNEL);
 463         if (!pdev_name2)
 464                 goto odbs_exit2;
 465         strcpy(pdev_name2, pdev_name);
 466
 467         od->pdev.name = pdev_name2;
 468         od->pdev.id = pdev_id;
 469
 470         res_count = omap_device_count_resources(od);
 471         if (res_count > 0) {
 472                 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
 473                 if (!res)
 474                         goto odbs_exit3;
 475         }
 476         omap_device_fill_resources(od, res);
 477
 478         od->pdev.num_resources = res_count;
 479         od->pdev.resource = res;
 480
 481         ret = platform_device_add_data(&od->pdev, pdata, pdata_len);
 482         if (ret)
 483                 goto odbs_exit4;
 484
 485         od->pm_lats = pm_lats;
 486         od->pm_lats_cnt = pm_lats_cnt;
 487
 488         if (is_early_device)
 489                 ret = omap_early_device_register(od);
 490         else
 491                 ret = omap_device_register(od);
 492
 493         for (i = 0; i < oh_cnt; i++) {
 494                 hwmods[i]->od = od;
 495                 _add_optional_clock_clkdev(od, hwmods[i]);
 496         }
 497
 498         if (ret)
 499                 goto odbs_exit4;
 500
 501         return od;
 502
 503 odbs_exit4:
 504         kfree(res);
 505 odbs_exit3:
 506         kfree(pdev_name2);
 507 odbs_exit2:
 508         kfree(hwmods);
 509 odbs_exit1:
 510         kfree(od);
 511
 512         pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
 513
 514         return ERR_PTR(ret);
 515 }
 516
 517 /**
 518  * omap_early_device_register - register an omap_device as an early platform
 519  * device.
 520  * @od: struct omap_device * to register
 521  *
 522  * Register the omap_device structure.  This currently just calls
 523  * platform_early_add_device() on the underlying platform_device.
 524  * Returns 0 by default.
 525  */
 526 int omap_early_device_register(struct omap_device *od)
 527 {
 528         struct platform_device *devices[1];
 529
 530         devices[0] = &(od->pdev);
 531         early_platform_add_devices(devices, 1);
 532         return 0;
 533 }
 534
 535 #ifdef CONFIG_PM_RUNTIME
 536 static int _od_runtime_suspend(struct device *dev)
 537 {
 538         struct platform_device *pdev = to_platform_device(dev);
 539         int ret;
 540
 541         ret = pm_generic_runtime_suspend(dev);
 542
 543         if (!ret)
 544                 omap_device_idle(pdev);
 545
 546         return ret;
 547 }
 548
 549 static int _od_runtime_idle(struct device *dev)
 550 {
 551         return pm_generic_runtime_idle(dev);
 552 }
 553
 554 static int _od_runtime_resume(struct device *dev)
 555 {
 556         struct platform_device *pdev = to_platform_device(dev);
 557
 558         omap_device_enable(pdev);
 559
 560         return pm_generic_runtime_resume(dev);
 561 }
 562 #endif
 563
 564 #ifdef CONFIG_SUSPEND
 565 static int _od_suspend_noirq(struct device *dev)
 566 {
 567         struct platform_device *pdev = to_platform_device(dev);
 568         struct omap_device *od = to_omap_device(pdev);
 569         int ret;
 570
 571         if (od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND)
 572                 return pm_generic_suspend_noirq(dev);
 573
 574         ret = pm_generic_suspend_noirq(dev);
 575
 576         if (!ret && !pm_runtime_status_suspended(dev)) {
 577                 if (pm_generic_runtime_suspend(dev) == 0) {
 578                         omap_device_idle(pdev);
 579                         od->flags |= OMAP_DEVICE_SUSPENDED;
 580                 }
 581         }
 582
 583         return ret;
 584 }
 585
 586 static int _od_resume_noirq(struct device *dev)
 587 {
 588         struct platform_device *pdev = to_platform_device(dev);
 589         struct omap_device *od = to_omap_device(pdev);
 590
 591         if (od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND)
 592                 return pm_generic_resume_noirq(dev);
 593
 594         if ((od->flags & OMAP_DEVICE_SUSPENDED) &&
 595             !pm_runtime_status_suspended(dev)) {
 596                 od->flags &= ~OMAP_DEVICE_SUSPENDED;
 597                 omap_device_enable(pdev);
 598                 pm_generic_runtime_resume(dev);
 599         }
 600
 601         return pm_generic_resume_noirq(dev);
 602 }
 603 #endif
 604
 605 static struct dev_pm_domain omap_device_pm_domain = {
 606         .ops = {
 607                 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
 608                                    _od_runtime_idle)
 609                 USE_PLATFORM_PM_SLEEP_OPS
 610                 SET_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq, _od_resume_noirq)
 611         }
 612 };
 613
 614 /**
 615  * omap_device_register - register an omap_device with one omap_hwmod
 616  * @od: struct omap_device * to register
 617  *
 618  * Register the omap_device structure.  This currently just calls
 619  * platform_device_register() on the underlying platform_device.
 620  * Returns the return value of platform_device_register().
 621  */
 622 int omap_device_register(struct omap_device *od)
 623 {
 624         pr_debug("omap_device: %s: registering\n", od->pdev.name);
 625
 626         od->pdev.dev.parent = &omap_device_parent;
 627         od->pdev.dev.pm_domain = &omap_device_pm_domain;
 628         return platform_device_register(&od->pdev);
 629 }
 630
 631
 632 /* Public functions for use by device drivers through struct platform_data */
 633
 634 /**
 635  * omap_device_enable - fully activate an omap_device
 636  * @od: struct omap_device * to activate
 637  *
 638  * Do whatever is necessary for the hwmods underlying omap_device @od
 639  * to be accessible and ready to operate.  This generally involves
 640  * enabling clocks, setting SYSCONFIG registers; and in the future may
 641  * involve remuxing pins.  Device drivers should call this function
 642  * (through platform_data function pointers) where they would normally
 643  * enable clocks, etc.  Returns -EINVAL if called when the omap_device
 644  * is already enabled, or passes along the return value of
 645  * _omap_device_activate().
 646  */
 647 int omap_device_enable(struct platform_device *pdev)
 648 {
 649         int ret;
 650         struct omap_device *od;
 651
 652         od = to_omap_device(pdev);
 653
 654         if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
 655                 WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
 656                      od->pdev.name, od->pdev.id, __func__, od->_state);
 657                 return -EINVAL;
 658         }
 659
 660         /* Enable everything if we're enabling this device from scratch */
 661         if (od->_state == OMAP_DEVICE_STATE_UNKNOWN)
 662                 od->pm_lat_level = od->pm_lats_cnt;
 663
 664         ret = _omap_device_activate(od, IGNORE_WAKEUP_LAT);
 665
 666         od->dev_wakeup_lat = 0;
 667         od->_dev_wakeup_lat_limit = UINT_MAX;
 668         od->_state = OMAP_DEVICE_STATE_ENABLED;
 669
 670         return ret;
 671 }
 672
 673 /**
 674  * omap_device_idle - idle an omap_device
 675  * @od: struct omap_device * to idle
 676  *
 677  * Idle omap_device @od by calling as many .deactivate_func() entries
 678  * in the omap_device's pm_lats table as is possible without exceeding
 679  * the device's maximum wakeup latency limit, pm_lat_limit.  Device
 680  * drivers should call this function (through platform_data function
 681  * pointers) where they would normally disable clocks after operations
 682  * complete, etc..  Returns -EINVAL if the omap_device is not
 683  * currently enabled, or passes along the return value of
 684  * _omap_device_deactivate().
 685  */
 686 int omap_device_idle(struct platform_device *pdev)
 687 {
 688         int ret;
 689         struct omap_device *od;
 690
 691         od = to_omap_device(pdev);
 692
 693         if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
 694                 WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
 695                      od->pdev.name, od->pdev.id, __func__, od->_state);
 696                 return -EINVAL;
 697         }
 698
 699         ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
 700
 701         od->_state = OMAP_DEVICE_STATE_IDLE;
 702
 703         return ret;
 704 }
 705
 706 /**
 707  * omap_device_shutdown - shut down an omap_device
 708  * @od: struct omap_device * to shut down
 709  *
 710  * Shut down omap_device @od by calling all .deactivate_func() entries
 711  * in the omap_device's pm_lats table and then shutting down all of
 712  * the underlying omap_hwmods.  Used when a device is being "removed"
 713  * or a device driver is being unloaded.  Returns -EINVAL if the
 714  * omap_device is not currently enabled or idle, or passes along the
 715  * return value of _omap_device_deactivate().
 716  */
 717 int omap_device_shutdown(struct platform_device *pdev)
 718 {
 719         int ret, i;
 720         struct omap_device *od;
 721
 722         od = to_omap_device(pdev);
 723
 724         if (od->_state != OMAP_DEVICE_STATE_ENABLED &&
 725             od->_state != OMAP_DEVICE_STATE_IDLE) {
 726                 WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
 727                      od->pdev.name, od->pdev.id, __func__, od->_state);
 728                 return -EINVAL;
 729         }
 730
 731         ret = _omap_device_deactivate(od, IGNORE_WAKEUP_LAT);
 732
 733         for (i = 0; i < od->hwmods_cnt; i++)
 734                 omap_hwmod_shutdown(od->hwmods[i]);
 735
 736         od->_state = OMAP_DEVICE_STATE_SHUTDOWN;
 737
 738         return ret;
 739 }
 740
 741 /**
 742  * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim
 743  * @od: struct omap_device *
 744  *
 745  * When a device's maximum wakeup latency limit changes, call some of
 746  * the .activate_func or .deactivate_func function pointers in the
 747  * omap_device's pm_lats array to ensure that the device's maximum
 748  * wakeup latency is less than or equal to the new latency limit.
 749  * Intended to be called by OMAP PM code whenever a device's maximum
 750  * wakeup latency limit changes (e.g., via
 751  * omap_pm_set_dev_wakeup_lat()).  Returns 0 if nothing needs to be
 752  * done (e.g., if the omap_device is not currently idle, or if the
 753  * wakeup latency is already current with the new limit) or passes
 754  * along the return value of _omap_device_deactivate() or
 755  * _omap_device_activate().
 756  */
 757 int omap_device_align_pm_lat(struct platform_device *pdev,
 758                              u32 new_wakeup_lat_limit)
 759 {
 760         int ret = -EINVAL;
 761         struct omap_device *od;
 762
 763         od = to_omap_device(pdev);
 764
 765         if (new_wakeup_lat_limit == od->dev_wakeup_lat)
 766                 return 0;
 767
 768         od->_dev_wakeup_lat_limit = new_wakeup_lat_limit;
 769
 770         if (od->_state != OMAP_DEVICE_STATE_IDLE)
 771                 return 0;
 772         else if (new_wakeup_lat_limit > od->dev_wakeup_lat)
 773                 ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
 774         else if (new_wakeup_lat_limit < od->dev_wakeup_lat)
 775                 ret = _omap_device_activate(od, USE_WAKEUP_LAT);
 776
 777         return ret;
 778 }
 779
 780 /**
 781  * omap_device_get_pwrdm - return the powerdomain * associated with @od
 782  * @od: struct omap_device *
 783  *
 784  * Return the powerdomain associated with the first underlying
 785  * omap_hwmod for this omap_device.  Intended for use by core OMAP PM
 786  * code.  Returns NULL on error or a struct powerdomain * upon
 787  * success.
 788  */
 789 struct powerdomain *omap_device_get_pwrdm(struct omap_device *od)
 790 {
 791         /*
 792          * XXX Assumes that all omap_hwmod powerdomains are identical.
 793          * This may not necessarily be true.  There should be a sanity
 794          * check in here to WARN() if any difference appears.
 795          */
 796         if (!od->hwmods_cnt)
 797                 return NULL;
 798
 799         return omap_hwmod_get_pwrdm(od->hwmods[0]);
 800 }
 801
 802 /**
 803  * omap_device_get_mpu_rt_va - return the MPU's virtual addr for the hwmod base
 804  * @od: struct omap_device *
 805  *
 806  * Return the MPU's virtual address for the base of the hwmod, from
 807  * the ioremap() that the hwmod code does.  Only valid if there is one
 808  * hwmod associated with this device.  Returns NULL if there are zero
 809  * or more than one hwmods associated with this omap_device;
 810  * otherwise, passes along the return value from
 811  * omap_hwmod_get_mpu_rt_va().
 812  */
 813 void __iomem *omap_device_get_rt_va(struct omap_device *od)
 814 {
 815         if (od->hwmods_cnt != 1)
 816                 return NULL;
 817
 818         return omap_hwmod_get_mpu_rt_va(od->hwmods[0]);
 819 }
 820
 821 /*
 822  * Public functions intended for use in omap_device_pm_latency
 823  * .activate_func and .deactivate_func function pointers
 824  */
 825
 826 /**
 827  * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
 828  * @od: struct omap_device *od
 829  *
 830  * Enable all underlying hwmods.  Returns 0.
 831  */
 832 int omap_device_enable_hwmods(struct omap_device *od)
 833 {
 834         int i;
 835
 836         for (i = 0; i < od->hwmods_cnt; i++)
 837                 omap_hwmod_enable(od->hwmods[i]);
 838
 839         /* XXX pass along return value here? */
 840         return 0;
 841 }
 842
 843 /**
 844  * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
 845  * @od: struct omap_device *od
 846  *
 847  * Idle all underlying hwmods.  Returns 0.
 848  */
 849 int omap_device_idle_hwmods(struct omap_device *od)
 850 {
 851         int i;
 852
 853         for (i = 0; i < od->hwmods_cnt; i++)
 854                 omap_hwmod_idle(od->hwmods[i]);
 855
 856         /* XXX pass along return value here? */
 857         return 0;
 858 }
 859
 860 /**
 861  * omap_device_disable_clocks - disable all main and interface clocks
 862  * @od: struct omap_device *od
 863  *
 864  * Disable the main functional clock and interface clock for all of the
 865  * omap_hwmods associated with the omap_device.  Returns 0.
 866  */
 867 int omap_device_disable_clocks(struct omap_device *od)
 868 {
 869         int i;
 870
 871         for (i = 0; i < od->hwmods_cnt; i++)
 872                 omap_hwmod_disable_clocks(od->hwmods[i]);
 873
 874         /* XXX pass along return value here? */
 875         return 0;
 876 }
 877
 878 /**
 879  * omap_device_enable_clocks - enable all main and interface clocks
 880  * @od: struct omap_device *od
 881  *
 882  * Enable the main functional clock and interface clock for all of the
 883  * omap_hwmods associated with the omap_device.  Returns 0.
 884  */
 885 int omap_device_enable_clocks(struct omap_device *od)
 886 {
 887         int i;
 888
 889         for (i = 0; i < od->hwmods_cnt; i++)
 890                 omap_hwmod_enable_clocks(od->hwmods[i]);
 891
 892         /* XXX pass along return value here? */
 893         return 0;
 894 }
 895
 896 struct device omap_device_parent = {
 897         .init_name      = "omap",
 898         .parent         = &platform_bus,
 899 };
 900
 901 static int __init omap_device_init(void)
 902 {
 903         return device_register(&omap_device_parent);
 904 }
 905 core_initcall(omap_device_init);