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