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