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