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