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