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