arch/arm/mach-omap2/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 be implemented as a
  21  * proper omap_bus/omap_device in Linux, no more platform_data func
  22  * pointers
  23  *
  24  *
  25  */
  26 #undef DEBUG
  27
  28 #include <linux/kernel.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/slab.h>
  31 #include <linux/err.h>
  32 #include <linux/io.h>
  33 #include <linux/clk.h>
  34 #include <linux/clkdev.h>
  35 #include <linux/pm_runtime.h>
  36 #include <linux/of.h>
  37 #include <linux/notifier.h>
  38
  39 #include "soc.h"
  40 #include "omap_device.h"
  41 #include "omap_hwmod.h"
  42
  43 /* Private functions */
  44
  45 static void _add_clkdev(struct omap_device *od, const char *clk_alias,
  46                        const char *clk_name)
  47 {
  48         struct clk *r;
  49         struct clk_lookup *l;
  50
  51         if (!clk_alias || !clk_name)
  52                 return;
  53
  54         dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
  55
  56         r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
  57         if (!IS_ERR(r)) {
  58                 dev_warn(&od->pdev->dev,
  59                          "alias %s already exists\n", clk_alias);
  60                 clk_put(r);
  61                 return;
  62         }
  63
  64         r = clk_get(NULL, clk_name);
  65         if (IS_ERR(r)) {
  66                 dev_err(&od->pdev->dev,
  67                         "clk_get for %s failed\n", clk_name);
  68                 return;
  69         }
  70
  71         l = clkdev_alloc(r, clk_alias, dev_name(&od->pdev->dev));
  72         if (!l) {
  73                 dev_err(&od->pdev->dev,
  74                         "clkdev_alloc for %s failed\n", clk_alias);
  75                 return;
  76         }
  77
  78         clkdev_add(l);
  79 }
  80
  81 /**
  82  * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
  83  * and main clock
  84  * @od: struct omap_device *od
  85  * @oh: struct omap_hwmod *oh
  86  *
  87  * For the main clock and every optional clock present per hwmod per
  88  * omap_device, this function adds an entry in the clkdev table of the
  89  * form <dev-id=dev_name, con-id=role> if it does not exist already.
  90  *
  91  * The function is called from inside omap_device_build_ss(), after
  92  * omap_device_register.
  93  *
  94  * This allows drivers to get a pointer to its optional clocks based on its role
  95  * by calling clk_get(<dev*>, <role>).
  96  * In the case of the main clock, a "fck" alias is used.
  97  *
  98  * No return value.
  99  */
 100 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
 101                                      struct omap_hwmod *oh)
 102 {
 103         int i;
 104
 105         _add_clkdev(od, "fck", oh->main_clk);
 106
 107         for (i = 0; i < oh->opt_clks_cnt; i++)
 108                 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
 109 }
 110
 111
 112 /**
 113  * omap_device_build_from_dt - build an omap_device with multiple hwmods
 114  * @pdev_name: name of the platform_device driver to use
 115  * @pdev_id: this platform_device's connection ID
 116  * @oh: ptr to the single omap_hwmod that backs this omap_device
 117  * @pdata: platform_data ptr to associate with the platform_device
 118  * @pdata_len: amount of memory pointed to by @pdata
 119  *
 120  * Function for building an omap_device already registered from device-tree
 121  *
 122  * Returns 0 or PTR_ERR() on error.
 123  */
 124 static int omap_device_build_from_dt(struct platform_device *pdev)
 125 {
 126         struct omap_hwmod **hwmods;
 127         struct omap_device *od;
 128         struct omap_hwmod *oh;
 129         struct device_node *node = pdev->dev.of_node;
 130         const char *oh_name;
 131         int oh_cnt, i, ret = 0;
 132         bool device_active = false;
 133
 134         oh_cnt = of_property_count_strings(node, "ti,hwmods");
 135         if (oh_cnt <= 0) {
 136                 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
 137                 return -ENODEV;
 138         }
 139
 140         hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
 141         if (!hwmods) {
 142                 ret = -ENOMEM;
 143                 goto odbfd_exit;
 144         }
 145
 146         for (i = 0; i < oh_cnt; i++) {
 147                 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
 148                 oh = omap_hwmod_lookup(oh_name);
 149                 if (!oh) {
 150                         dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
 151                                 oh_name);
 152                         ret = -EINVAL;
 153                         goto odbfd_exit1;
 154                 }
 155                 hwmods[i] = oh;
 156                 if (oh->flags & HWMOD_INIT_NO_IDLE)
 157                         device_active = true;
 158         }
 159
 160         od = omap_device_alloc(pdev, hwmods, oh_cnt);
 161         if (IS_ERR(od)) {
 162                 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
 163                         oh_name);
 164                 ret = PTR_ERR(od);
 165                 goto odbfd_exit1;
 166         }
 167
 168         /* Fix up missing resource names */
 169         for (i = 0; i < pdev->num_resources; i++) {
 170                 struct resource *r = &pdev->resource[i];
 171
 172                 if (r->name == NULL)
 173                         r->name = dev_name(&pdev->dev);
 174         }
 175
 176         pdev->dev.pm_domain = &omap_device_pm_domain;
 177
 178         if (device_active) {
 179                 omap_device_enable(pdev);
 180                 pm_runtime_set_active(&pdev->dev);
 181         }
 182
 183 odbfd_exit1:
 184         kfree(hwmods);
 185 odbfd_exit:
 186         /* if data/we are at fault.. load up a fail handler */
 187         if (ret)
 188                 pdev->dev.pm_domain = &omap_device_fail_pm_domain;
 189
 190         return ret;
 191 }
 192
 193 static int _omap_device_notifier_call(struct notifier_block *nb,
 194                                       unsigned long event, void *dev)
 195 {
 196         struct platform_device *pdev = to_platform_device(dev);
 197         struct omap_device *od;
 198
 199         switch (event) {
 200         case BUS_NOTIFY_DEL_DEVICE:
 201                 if (pdev->archdata.od)
 202                         omap_device_delete(pdev->archdata.od);
 203                 break;
 204         case BUS_NOTIFY_ADD_DEVICE:
 205                 if (pdev->dev.of_node)
 206                         omap_device_build_from_dt(pdev);
 207                 /* fall through */
 208         default:
 209                 od = to_omap_device(pdev);
 210                 if (od)
 211                         od->_driver_status = event;
 212         }
 213
 214         return NOTIFY_DONE;
 215 }
 216
 217 /**
 218  * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
 219  * @od: struct omap_device *od
 220  *
 221  * Enable all underlying hwmods.  Returns 0.
 222  */
 223 static int _omap_device_enable_hwmods(struct omap_device *od)
 224 {
 225         int i;
 226
 227         for (i = 0; i < od->hwmods_cnt; i++)
 228                 omap_hwmod_enable(od->hwmods[i]);
 229
 230         /* XXX pass along return value here? */
 231         return 0;
 232 }
 233
 234 /**
 235  * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
 236  * @od: struct omap_device *od
 237  *
 238  * Idle all underlying hwmods.  Returns 0.
 239  */
 240 static int _omap_device_idle_hwmods(struct omap_device *od)
 241 {
 242         int i;
 243
 244         for (i = 0; i < od->hwmods_cnt; i++)
 245                 omap_hwmod_idle(od->hwmods[i]);
 246
 247         /* XXX pass along return value here? */
 248         return 0;
 249 }
 250
 251 /* Public functions for use by core code */
 252
 253 /**
 254  * omap_device_get_context_loss_count - get lost context count
 255  * @od: struct omap_device *
 256  *
 257  * Using the primary hwmod, query the context loss count for this
 258  * device.
 259  *
 260  * Callers should consider context for this device lost any time this
 261  * function returns a value different than the value the caller got
 262  * the last time it called this function.
 263  *
 264  * If any hwmods exist for the omap_device assoiated with @pdev,
 265  * return the context loss counter for that hwmod, otherwise return
 266  * zero.
 267  */
 268 int omap_device_get_context_loss_count(struct platform_device *pdev)
 269 {
 270         struct omap_device *od;
 271         u32 ret = 0;
 272
 273         od = to_omap_device(pdev);
 274
 275         if (od->hwmods_cnt)
 276                 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
 277
 278         return ret;
 279 }
 280
 281 /**
 282  * omap_device_count_resources - count number of struct resource entries needed
 283  * @od: struct omap_device *
 284  * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
 285  *
 286  * Count the number of struct resource entries needed for this
 287  * omap_device @od.  Used by omap_device_build_ss() to determine how
 288  * much memory to allocate before calling
 289  * omap_device_fill_resources().  Returns the count.
 290  */
 291 static int omap_device_count_resources(struct omap_device *od,
 292                                        unsigned long flags)
 293 {
 294         int c = 0;
 295         int i;
 296
 297         for (i = 0; i < od->hwmods_cnt; i++)
 298                 c += omap_hwmod_count_resources(od->hwmods[i], flags);
 299
 300         pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
 301                  od->pdev->name, c, od->hwmods_cnt);
 302
 303         return c;
 304 }
 305
 306 /**
 307  * omap_device_fill_resources - fill in array of struct resource
 308  * @od: struct omap_device *
 309  * @res: pointer to an array of struct resource to be filled in
 310  *
 311  * Populate one or more empty struct resource pointed to by @res with
 312  * the resource data for this omap_device @od.  Used by
 313  * omap_device_build_ss() after calling omap_device_count_resources().
 314  * Ideally this function would not be needed at all.  If omap_device
 315  * replaces platform_device, then we can specify our own
 316  * get_resource()/ get_irq()/etc functions that use the underlying
 317  * omap_hwmod information.  Or if platform_device is extended to use
 318  * subarchitecture-specific function pointers, the various
 319  * platform_device functions can simply call omap_device internal
 320  * functions to get device resources.  Hacking around the existing
 321  * platform_device code wastes memory.  Returns 0.
 322  */
 323 static int omap_device_fill_resources(struct omap_device *od,
 324                                       struct resource *res)
 325 {
 326         int i, r;
 327
 328         for (i = 0; i < od->hwmods_cnt; i++) {
 329                 r = omap_hwmod_fill_resources(od->hwmods[i], res);
 330                 res += r;
 331         }
 332
 333         return 0;
 334 }
 335
 336 /**
 337  * _od_fill_dma_resources - fill in array of struct resource with dma resources
 338  * @od: struct omap_device *
 339  * @res: pointer to an array of struct resource to be filled in
 340  *
 341  * Populate one or more empty struct resource pointed to by @res with
 342  * the dma resource data for this omap_device @od.  Used by
 343  * omap_device_alloc() after calling omap_device_count_resources().
 344  *
 345  * Ideally this function would not be needed at all.  If we have
 346  * mechanism to get dma resources from DT.
 347  *
 348  * Returns 0.
 349  */
 350 static int _od_fill_dma_resources(struct omap_device *od,
 351                                       struct resource *res)
 352 {
 353         int i, r;
 354
 355         for (i = 0; i < od->hwmods_cnt; i++) {
 356                 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
 357                 res += r;
 358         }
 359
 360         return 0;
 361 }
 362
 363 /**
 364  * omap_device_alloc - allocate an omap_device
 365  * @pdev: platform_device that will be included in this omap_device
 366  * @oh: ptr to the single omap_hwmod that backs this omap_device
 367  * @pdata: platform_data ptr to associate with the platform_device
 368  * @pdata_len: amount of memory pointed to by @pdata
 369  *
 370  * Convenience function for allocating an omap_device structure and filling
 371  * hwmods, and resources.
 372  *
 373  * Returns an struct omap_device pointer or ERR_PTR() on error;
 374  */
 375 struct omap_device *omap_device_alloc(struct platform_device *pdev,
 376                                         struct omap_hwmod **ohs, int oh_cnt)
 377 {
 378         int ret = -ENOMEM;
 379         struct omap_device *od;
 380         struct resource *res = NULL;
 381         int i, res_count;
 382         struct omap_hwmod **hwmods;
 383
 384         od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
 385         if (!od) {
 386                 ret = -ENOMEM;
 387                 goto oda_exit1;
 388         }
 389         od->hwmods_cnt = oh_cnt;
 390
 391         hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
 392         if (!hwmods)
 393                 goto oda_exit2;
 394
 395         od->hwmods = hwmods;
 396         od->pdev = pdev;
 397
 398         /*
 399          * Non-DT Boot:
 400          *   Here, pdev->num_resources = 0, and we should get all the
 401          *   resources from hwmod.
 402          *
 403          * DT Boot:
 404          *   OF framework will construct the resource structure (currently
 405          *   does for MEM & IRQ resource) and we should respect/use these
 406          *   resources, killing hwmod dependency.
 407          *   If pdev->num_resources > 0, we assume that MEM & IRQ resources
 408          *   have been allocated by OF layer already (through DTB).
 409          *   As preparation for the future we examine the OF provided resources
 410          *   to see if we have DMA resources provided already. In this case
 411          *   there is no need to update the resources for the device, we use the
 412          *   OF provided ones.
 413          *
 414          * TODO: Once DMA resource is available from OF layer, we should
 415          *   kill filling any resources from hwmod.
 416          */
 417         if (!pdev->num_resources) {
 418                 /* Count all resources for the device */
 419                 res_count = omap_device_count_resources(od, IORESOURCE_IRQ |
 420                                                             IORESOURCE_DMA |
 421                                                             IORESOURCE_MEM);
 422         } else {
 423                 /* Take a look if we already have DMA resource via DT */
 424                 for (i = 0; i < pdev->num_resources; i++) {
 425                         struct resource *r = &pdev->resource[i];
 426
 427                         /* We have it, no need to touch the resources */
 428                         if (r->flags == IORESOURCE_DMA)
 429                                 goto have_everything;
 430                 }
 431                 /* Count only DMA resources for the device */
 432                 res_count = omap_device_count_resources(od, IORESOURCE_DMA);
 433                 /* The device has no DMA resource, no need for update */
 434                 if (!res_count)
 435                         goto have_everything;
 436
 437                 res_count += pdev->num_resources;
 438         }
 439
 440         /* Allocate resources memory to account for new resources */
 441         res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
 442         if (!res)
 443                 goto oda_exit3;
 444
 445         if (!pdev->num_resources) {
 446                 dev_dbg(&pdev->dev, "%s: using %d resources from hwmod\n",
 447                         __func__, res_count);
 448                 omap_device_fill_resources(od, res);
 449         } else {
 450                 dev_dbg(&pdev->dev,
 451                         "%s: appending %d DMA resources from hwmod\n",
 452                         __func__, res_count - pdev->num_resources);
 453                 memcpy(res, pdev->resource,
 454                        sizeof(struct resource) * pdev->num_resources);
 455                 _od_fill_dma_resources(od, &res[pdev->num_resources]);
 456         }
 457
 458         ret = platform_device_add_resources(pdev, res, res_count);
 459         kfree(res);
 460
 461         if (ret)
 462                 goto oda_exit3;
 463
 464 have_everything:
 465         pdev->archdata.od = od;
 466
 467         for (i = 0; i < oh_cnt; i++) {
 468                 hwmods[i]->od = od;
 469                 _add_hwmod_clocks_clkdev(od, hwmods[i]);
 470         }
 471
 472         return od;
 473
 474 oda_exit3:
 475         kfree(hwmods);
 476 oda_exit2:
 477         kfree(od);
 478 oda_exit1:
 479         dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
 480
 481         return ERR_PTR(ret);
 482 }
 483
 484 void omap_device_delete(struct omap_device *od)
 485 {
 486         if (!od)
 487                 return;
 488
 489         od->pdev->archdata.od = NULL;
 490         kfree(od->hwmods);
 491         kfree(od);
 492 }
 493
 494 /**
 495  * omap_device_build - build and register an omap_device with one omap_hwmod
 496  * @pdev_name: name of the platform_device driver to use
 497  * @pdev_id: this platform_device's connection ID
 498  * @oh: ptr to the single omap_hwmod that backs this omap_device
 499  * @pdata: platform_data ptr to associate with the platform_device
 500  * @pdata_len: amount of memory pointed to by @pdata
 501  *
 502  * Convenience function for building and registering a single
 503  * omap_device record, which in turn builds and registers a
 504  * platform_device record.  See omap_device_build_ss() for more
 505  * information.  Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
 506  * passes along the return value of omap_device_build_ss().
 507  */
 508 struct platform_device __init *omap_device_build(const char *pdev_name,
 509                                                  int pdev_id,
 510                                                  struct omap_hwmod *oh,
 511                                                  void *pdata, int pdata_len)
 512 {
 513         struct omap_hwmod *ohs[] = { oh };
 514
 515         if (!oh)
 516                 return ERR_PTR(-EINVAL);
 517
 518         return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
 519                                     pdata_len);
 520 }
 521
 522 /**
 523  * omap_device_build_ss - build and register an omap_device with multiple hwmods
 524  * @pdev_name: name of the platform_device driver to use
 525  * @pdev_id: this platform_device's connection ID
 526  * @oh: ptr to the single omap_hwmod that backs this omap_device
 527  * @pdata: platform_data ptr to associate with the platform_device
 528  * @pdata_len: amount of memory pointed to by @pdata
 529  *
 530  * Convenience function for building and registering an omap_device
 531  * subsystem record.  Subsystem records consist of multiple
 532  * omap_hwmods.  This function in turn builds and registers a
 533  * platform_device record.  Returns an ERR_PTR() on error, or passes
 534  * along the return value of omap_device_register().
 535  */
 536 struct platform_device __init *omap_device_build_ss(const char *pdev_name,
 537                                                     int pdev_id,
 538                                                     struct omap_hwmod **ohs,
 539                                                     int oh_cnt, void *pdata,
 540                                                     int pdata_len)
 541 {
 542         int ret = -ENOMEM;
 543         struct platform_device *pdev;
 544         struct omap_device *od;
 545
 546         if (!ohs || oh_cnt == 0 || !pdev_name)
 547                 return ERR_PTR(-EINVAL);
 548
 549         if (!pdata && pdata_len > 0)
 550                 return ERR_PTR(-EINVAL);
 551
 552         pdev = platform_device_alloc(pdev_name, pdev_id);
 553         if (!pdev) {
 554                 ret = -ENOMEM;
 555                 goto odbs_exit;
 556         }
 557
 558         /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
 559         if (pdev->id != -1)
 560                 dev_set_name(&pdev->dev, "%s.%d", pdev->name,  pdev->id);
 561         else
 562                 dev_set_name(&pdev->dev, "%s", pdev->name);
 563
 564         od = omap_device_alloc(pdev, ohs, oh_cnt);
 565         if (IS_ERR(od))
 566                 goto odbs_exit1;
 567
 568         ret = platform_device_add_data(pdev, pdata, pdata_len);
 569         if (ret)
 570                 goto odbs_exit2;
 571
 572         ret = omap_device_register(pdev);
 573         if (ret)
 574                 goto odbs_exit2;
 575
 576         return pdev;
 577
 578 odbs_exit2:
 579         omap_device_delete(od);
 580 odbs_exit1:
 581         platform_device_put(pdev);
 582 odbs_exit:
 583
 584         pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
 585
 586         return ERR_PTR(ret);
 587 }
 588
 589 #ifdef CONFIG_PM_RUNTIME
 590 static int _od_runtime_suspend(struct device *dev)
 591 {
 592         struct platform_device *pdev = to_platform_device(dev);
 593         int ret;
 594
 595         ret = pm_generic_runtime_suspend(dev);
 596
 597         if (!ret)
 598                 omap_device_idle(pdev);
 599
 600         return ret;
 601 }
 602
 603 static int _od_runtime_resume(struct device *dev)
 604 {
 605         struct platform_device *pdev = to_platform_device(dev);
 606
 607         omap_device_enable(pdev);
 608
 609         return pm_generic_runtime_resume(dev);
 610 }
 611
 612 static int _od_fail_runtime_suspend(struct device *dev)
 613 {
 614         dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
 615         return -ENODEV;
 616 }
 617
 618 static int _od_fail_runtime_resume(struct device *dev)
 619 {
 620         dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
 621         return -ENODEV;
 622 }
 623
 624 #endif
 625
 626 #ifdef CONFIG_SUSPEND
 627 static int _od_suspend_noirq(struct device *dev)
 628 {
 629         struct platform_device *pdev = to_platform_device(dev);
 630         struct omap_device *od = to_omap_device(pdev);
 631         int ret;
 632
 633         /* Don't attempt late suspend on a driver that is not bound */
 634         if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
 635                 return 0;
 636
 637         ret = pm_generic_suspend_noirq(dev);
 638
 639         if (!ret && !pm_runtime_status_suspended(dev)) {
 640                 if (pm_generic_runtime_suspend(dev) == 0) {
 641                         pm_runtime_set_suspended(dev);
 642                         omap_device_idle(pdev);
 643                         od->flags |= OMAP_DEVICE_SUSPENDED;
 644                 }
 645         }
 646
 647         return ret;
 648 }
 649
 650 static int _od_resume_noirq(struct device *dev)
 651 {
 652         struct platform_device *pdev = to_platform_device(dev);
 653         struct omap_device *od = to_omap_device(pdev);
 654
 655         if (od->flags & OMAP_DEVICE_SUSPENDED) {
 656                 od->flags &= ~OMAP_DEVICE_SUSPENDED;
 657                 omap_device_enable(pdev);
 658                 /*
 659                  * XXX: we run before core runtime pm has resumed itself. At
 660                  * this point in time, we just restore the runtime pm state and
 661                  * considering symmetric operations in resume, we donot expect
 662                  * to fail. If we failed, something changed in core runtime_pm
 663                  * framework OR some device driver messed things up, hence, WARN
 664                  */
 665                 WARN(pm_runtime_set_active(dev),
 666                      "Could not set %s runtime state active\n", dev_name(dev));
 667                 pm_generic_runtime_resume(dev);
 668         }
 669
 670         return pm_generic_resume_noirq(dev);
 671 }
 672 #else
 673 #define _od_suspend_noirq NULL
 674 #define _od_resume_noirq NULL
 675 #endif
 676
 677 struct dev_pm_domain omap_device_fail_pm_domain = {
 678         .ops = {
 679                 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
 680                                    _od_fail_runtime_resume, NULL)
 681         }
 682 };
 683
 684 struct dev_pm_domain omap_device_pm_domain = {
 685         .ops = {
 686                 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
 687                                    NULL)
 688                 USE_PLATFORM_PM_SLEEP_OPS
 689                 .suspend_noirq = _od_suspend_noirq,
 690                 .resume_noirq = _od_resume_noirq,
 691         }
 692 };
 693
 694 /**
 695  * omap_device_register - register an omap_device with one omap_hwmod
 696  * @od: struct omap_device * to register
 697  *
 698  * Register the omap_device structure.  This currently just calls
 699  * platform_device_register() on the underlying platform_device.
 700  * Returns the return value of platform_device_register().
 701  */
 702 int omap_device_register(struct platform_device *pdev)
 703 {
 704         pr_debug("omap_device: %s: registering\n", pdev->name);
 705
 706         pdev->dev.pm_domain = &omap_device_pm_domain;
 707         return platform_device_add(pdev);
 708 }
 709
 710
 711 /* Public functions for use by device drivers through struct platform_data */
 712
 713 /**
 714  * omap_device_enable - fully activate an omap_device
 715  * @od: struct omap_device * to activate
 716  *
 717  * Do whatever is necessary for the hwmods underlying omap_device @od
 718  * to be accessible and ready to operate.  This generally involves
 719  * enabling clocks, setting SYSCONFIG registers; and in the future may
 720  * involve remuxing pins.  Device drivers should call this function
 721  * indirectly via pm_runtime_get*().  Returns -EINVAL if called when
 722  * the omap_device is already enabled, or passes along the return
 723  * value of _omap_device_enable_hwmods().
 724  */
 725 int omap_device_enable(struct platform_device *pdev)
 726 {
 727         int ret;
 728         struct omap_device *od;
 729
 730         od = to_omap_device(pdev);
 731
 732         if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
 733                 dev_warn(&pdev->dev,
 734                          "omap_device: %s() called from invalid state %d\n",
 735                          __func__, od->_state);
 736                 return -EINVAL;
 737         }
 738
 739         ret = _omap_device_enable_hwmods(od);
 740
 741         od->_state = OMAP_DEVICE_STATE_ENABLED;
 742
 743         return ret;
 744 }
 745
 746 /**
 747  * omap_device_idle - idle an omap_device
 748  * @od: struct omap_device * to idle
 749  *
 750  * Idle omap_device @od.  Device drivers call this function indirectly
 751  * via pm_runtime_put*().  Returns -EINVAL if the omap_device is not
 752  * currently enabled, or passes along the return value of
 753  * _omap_device_idle_hwmods().
 754  */
 755 int omap_device_idle(struct platform_device *pdev)
 756 {
 757         int ret;
 758         struct omap_device *od;
 759
 760         od = to_omap_device(pdev);
 761
 762         if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
 763                 dev_warn(&pdev->dev,
 764                          "omap_device: %s() called from invalid state %d\n",
 765                          __func__, od->_state);
 766                 return -EINVAL;
 767         }
 768
 769         ret = _omap_device_idle_hwmods(od);
 770
 771         od->_state = OMAP_DEVICE_STATE_IDLE;
 772
 773         return ret;
 774 }
 775
 776 /**
 777  * omap_device_assert_hardreset - set a device's hardreset line
 778  * @pdev: struct platform_device * to reset
 779  * @name: const char * name of the reset line
 780  *
 781  * Set the hardreset line identified by @name on the IP blocks
 782  * associated with the hwmods backing the platform_device @pdev.  All
 783  * of the hwmods associated with @pdev must have the same hardreset
 784  * line linked to them for this to work.  Passes along the return value
 785  * of omap_hwmod_assert_hardreset() in the event of any failure, or
 786  * returns 0 upon success.
 787  */
 788 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
 789 {
 790         struct omap_device *od = to_omap_device(pdev);
 791         int ret = 0;
 792         int i;
 793
 794         for (i = 0; i < od->hwmods_cnt; i++) {
 795                 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
 796                 if (ret)
 797                         break;
 798         }
 799
 800         return ret;
 801 }
 802
 803 /**
 804  * omap_device_deassert_hardreset - release a device's hardreset line
 805  * @pdev: struct platform_device * to reset
 806  * @name: const char * name of the reset line
 807  *
 808  * Release the hardreset line identified by @name on the IP blocks
 809  * associated with the hwmods backing the platform_device @pdev.  All
 810  * of the hwmods associated with @pdev must have the same hardreset
 811  * line linked to them for this to work.  Passes along the return
 812  * value of omap_hwmod_deassert_hardreset() in the event of any
 813  * failure, or returns 0 upon success.
 814  */
 815 int omap_device_deassert_hardreset(struct platform_device *pdev,
 816                                    const char *name)
 817 {
 818         struct omap_device *od = to_omap_device(pdev);
 819         int ret = 0;
 820         int i;
 821
 822         for (i = 0; i < od->hwmods_cnt; i++) {
 823                 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
 824                 if (ret)
 825                         break;
 826         }
 827
 828         return ret;
 829 }
 830
 831 /**
 832  * omap_device_get_by_hwmod_name() - convert a hwmod name to
 833  * device pointer.
 834  * @oh_name: name of the hwmod device
 835  *
 836  * Returns back a struct device * pointer associated with a hwmod
 837  * device represented by a hwmod_name
 838  */
 839 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
 840 {
 841         struct omap_hwmod *oh;
 842
 843         if (!oh_name) {
 844                 WARN(1, "%s: no hwmod name!\n", __func__);
 845                 return ERR_PTR(-EINVAL);
 846         }
 847
 848         oh = omap_hwmod_lookup(oh_name);
 849         if (!oh) {
 850                 WARN(1, "%s: no hwmod for %s\n", __func__,
 851                         oh_name);
 852                 return ERR_PTR(-ENODEV);
 853         }
 854         if (!oh->od) {
 855                 WARN(1, "%s: no omap_device for %s\n", __func__,
 856                         oh_name);
 857                 return ERR_PTR(-ENODEV);
 858         }
 859
 860         return &oh->od->pdev->dev;
 861 }
 862
 863 static struct notifier_block platform_nb = {
 864         .notifier_call = _omap_device_notifier_call,
 865 };
 866
 867 static int __init omap_device_init(void)
 868 {
 869         bus_register_notifier(&platform_bus_type, &platform_nb);
 870         return 0;
 871 }
 872 omap_core_initcall(omap_device_init);
 873
 874 /**
 875  * omap_device_late_idle - idle devices without drivers
 876  * @dev: struct device * associated with omap_device
 877  * @data: unused
 878  *
 879  * Check the driver bound status of this device, and idle it
 880  * if there is no driver attached.
 881  */
 882 static int __init omap_device_late_idle(struct device *dev, void *data)
 883 {
 884         struct platform_device *pdev = to_platform_device(dev);
 885         struct omap_device *od = to_omap_device(pdev);
 886         int i;
 887
 888         if (!od)
 889                 return 0;
 890
 891         /*
 892          * If omap_device state is enabled, but has no driver bound,
 893          * idle it.
 894          */
 895
 896         /*
 897          * Some devices (like memory controllers) are always kept
 898          * enabled, and should not be idled even with no drivers.
 899          */
 900         for (i = 0; i < od->hwmods_cnt; i++)
 901                 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
 902                         return 0;
 903
 904         if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
 905                 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
 906                         dev_warn(dev, "%s: enabled but no driver.  Idling\n",
 907                                  __func__);
 908                         omap_device_idle(pdev);
 909                 }
 910         }
 911
 912         return 0;
 913 }
 914
 915 static int __init omap_device_late_init(void)
 916 {
 917         bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
 918         return 0;
 919 }
 920 omap_late_initcall_sync(omap_device_late_init);