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