• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 "common.h"
40 #include "soc.h"
41 #include "omap_device.h"
42 #include "omap_hwmod.h"
43 
44 /* Private functions */
45 
_add_clkdev(struct omap_device * od,const char * clk_alias,const char * clk_name)46 static void _add_clkdev(struct omap_device *od, const char *clk_alias,
47 		       const char *clk_name)
48 {
49 	struct clk *r;
50 	int rc;
51 
52 	if (!clk_alias || !clk_name)
53 		return;
54 
55 	dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
56 
57 	r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
58 	if (!IS_ERR(r)) {
59 		dev_dbg(&od->pdev->dev,
60 			 "alias %s already exists\n", clk_alias);
61 		clk_put(r);
62 		return;
63 	}
64 
65 	rc = clk_add_alias(clk_alias, dev_name(&od->pdev->dev), clk_name, NULL);
66 	if (rc) {
67 		if (rc == -ENODEV || rc == -ENOMEM)
68 			dev_err(&od->pdev->dev,
69 				"clkdev_alloc for %s failed\n", clk_alias);
70 		else
71 			dev_err(&od->pdev->dev,
72 				"clk_get for %s failed\n", clk_name);
73 	}
74 }
75 
76 /**
77  * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
78  * and main clock
79  * @od: struct omap_device *od
80  * @oh: struct omap_hwmod *oh
81  *
82  * For the main clock and every optional clock present per hwmod per
83  * omap_device, this function adds an entry in the clkdev table of the
84  * form <dev-id=dev_name, con-id=role> if it does not exist already.
85  *
86  * The function is called from inside omap_device_build_ss(), after
87  * omap_device_register.
88  *
89  * This allows drivers to get a pointer to its optional clocks based on its role
90  * by calling clk_get(<dev*>, <role>).
91  * In the case of the main clock, a "fck" alias is used.
92  *
93  * No return value.
94  */
_add_hwmod_clocks_clkdev(struct omap_device * od,struct omap_hwmod * oh)95 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
96 				     struct omap_hwmod *oh)
97 {
98 	int i;
99 
100 	_add_clkdev(od, "fck", oh->main_clk);
101 
102 	for (i = 0; i < oh->opt_clks_cnt; i++)
103 		_add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
104 }
105 
106 
107 /**
108  * omap_device_build_from_dt - build an omap_device with multiple hwmods
109  * @pdev_name: name of the platform_device driver to use
110  * @pdev_id: this platform_device's connection ID
111  * @oh: ptr to the single omap_hwmod that backs this omap_device
112  * @pdata: platform_data ptr to associate with the platform_device
113  * @pdata_len: amount of memory pointed to by @pdata
114  *
115  * Function for building an omap_device already registered from device-tree
116  *
117  * Returns 0 or PTR_ERR() on error.
118  */
omap_device_build_from_dt(struct platform_device * pdev)119 static int omap_device_build_from_dt(struct platform_device *pdev)
120 {
121 	struct omap_hwmod **hwmods;
122 	struct omap_device *od;
123 	struct omap_hwmod *oh;
124 	struct device_node *node = pdev->dev.of_node;
125 	const char *oh_name;
126 	int oh_cnt, i, ret = 0;
127 	bool device_active = false;
128 
129 	oh_cnt = of_property_count_strings(node, "ti,hwmods");
130 	if (oh_cnt <= 0) {
131 		dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
132 		return -ENODEV;
133 	}
134 
135 	hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
136 	if (!hwmods) {
137 		ret = -ENOMEM;
138 		goto odbfd_exit;
139 	}
140 
141 	for (i = 0; i < oh_cnt; i++) {
142 		of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
143 		oh = omap_hwmod_lookup(oh_name);
144 		if (!oh) {
145 			dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
146 				oh_name);
147 			ret = -EINVAL;
148 			goto odbfd_exit1;
149 		}
150 		hwmods[i] = oh;
151 		if (oh->flags & HWMOD_INIT_NO_IDLE)
152 			device_active = true;
153 	}
154 
155 	od = omap_device_alloc(pdev, hwmods, oh_cnt);
156 	if (IS_ERR(od)) {
157 		dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
158 			oh_name);
159 		ret = PTR_ERR(od);
160 		goto odbfd_exit1;
161 	}
162 
163 	/* Fix up missing resource names */
164 	for (i = 0; i < pdev->num_resources; i++) {
165 		struct resource *r = &pdev->resource[i];
166 
167 		if (r->name == NULL)
168 			r->name = dev_name(&pdev->dev);
169 	}
170 
171 	pdev->dev.pm_domain = &omap_device_pm_domain;
172 
173 	if (device_active) {
174 		omap_device_enable(pdev);
175 		pm_runtime_set_active(&pdev->dev);
176 	}
177 
178 odbfd_exit1:
179 	kfree(hwmods);
180 odbfd_exit:
181 	/* if data/we are at fault.. load up a fail handler */
182 	if (ret)
183 		pdev->dev.pm_domain = &omap_device_fail_pm_domain;
184 
185 	return ret;
186 }
187 
_omap_device_notifier_call(struct notifier_block * nb,unsigned long event,void * dev)188 static int _omap_device_notifier_call(struct notifier_block *nb,
189 				      unsigned long event, void *dev)
190 {
191 	struct platform_device *pdev = to_platform_device(dev);
192 	struct omap_device *od;
193 
194 	switch (event) {
195 	case BUS_NOTIFY_DEL_DEVICE:
196 		if (pdev->archdata.od)
197 			omap_device_delete(pdev->archdata.od);
198 		break;
199 	case BUS_NOTIFY_ADD_DEVICE:
200 		if (pdev->dev.of_node)
201 			omap_device_build_from_dt(pdev);
202 		omap_auxdata_legacy_init(dev);
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  */
_omap_device_enable_hwmods(struct omap_device * od)219 static int _omap_device_enable_hwmods(struct omap_device *od)
220 {
221 	int ret = 0;
222 	int i;
223 
224 	for (i = 0; i < od->hwmods_cnt; i++)
225 		ret |= omap_hwmod_enable(od->hwmods[i]);
226 
227 	return ret;
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  */
_omap_device_idle_hwmods(struct omap_device * od)236 static int _omap_device_idle_hwmods(struct omap_device *od)
237 {
238 	int ret = 0;
239 	int i;
240 
241 	for (i = 0; i < od->hwmods_cnt; i++)
242 		ret |= omap_hwmod_idle(od->hwmods[i]);
243 
244 	return ret;
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  */
omap_device_get_context_loss_count(struct platform_device * pdev)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  */
omap_device_count_resources(struct omap_device * od,unsigned long flags)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  */
omap_device_fill_resources(struct omap_device * od,struct resource * res)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  */
_od_fill_dma_resources(struct omap_device * od,struct resource * res)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  */
omap_device_alloc(struct platform_device * pdev,struct omap_hwmod ** ohs,int oh_cnt)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 
omap_device_delete(struct omap_device * od)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  */
omap_device_build(const char * pdev_name,int pdev_id,struct omap_hwmod * oh,void * pdata,int pdata_len)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  */
omap_device_build_ss(const char * pdev_name,int pdev_id,struct omap_hwmod ** ohs,int oh_cnt,void * pdata,int pdata_len)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
_od_runtime_suspend(struct device * dev)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 	if (ret)
593 		return ret;
594 
595 	return omap_device_idle(pdev);
596 }
597 
_od_runtime_resume(struct device * dev)598 static int _od_runtime_resume(struct device *dev)
599 {
600 	struct platform_device *pdev = to_platform_device(dev);
601 	int ret;
602 
603 	ret = omap_device_enable(pdev);
604 	if (ret)
605 		return ret;
606 
607 	return pm_generic_runtime_resume(dev);
608 }
609 
_od_fail_runtime_suspend(struct device * dev)610 static int _od_fail_runtime_suspend(struct device *dev)
611 {
612 	dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
613 	return -ENODEV;
614 }
615 
_od_fail_runtime_resume(struct device * dev)616 static int _od_fail_runtime_resume(struct device *dev)
617 {
618 	dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
619 	return -ENODEV;
620 }
621 
622 #endif
623 
624 #ifdef CONFIG_SUSPEND
_od_suspend_noirq(struct device * dev)625 static int _od_suspend_noirq(struct device *dev)
626 {
627 	struct platform_device *pdev = to_platform_device(dev);
628 	struct omap_device *od = to_omap_device(pdev);
629 	int ret;
630 
631 	/* Don't attempt late suspend on a driver that is not bound */
632 	if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
633 		return 0;
634 
635 	ret = pm_generic_suspend_noirq(dev);
636 
637 	if (!ret && !pm_runtime_status_suspended(dev)) {
638 		if (pm_generic_runtime_suspend(dev) == 0) {
639 			pm_runtime_set_suspended(dev);
640 			omap_device_idle(pdev);
641 			od->flags |= OMAP_DEVICE_SUSPENDED;
642 		}
643 	}
644 
645 	return ret;
646 }
647 
_od_resume_noirq(struct device * dev)648 static int _od_resume_noirq(struct device *dev)
649 {
650 	struct platform_device *pdev = to_platform_device(dev);
651 	struct omap_device *od = to_omap_device(pdev);
652 
653 	if (od->flags & OMAP_DEVICE_SUSPENDED) {
654 		od->flags &= ~OMAP_DEVICE_SUSPENDED;
655 		omap_device_enable(pdev);
656 		/*
657 		 * XXX: we run before core runtime pm has resumed itself. At
658 		 * this point in time, we just restore the runtime pm state and
659 		 * considering symmetric operations in resume, we donot expect
660 		 * to fail. If we failed, something changed in core runtime_pm
661 		 * framework OR some device driver messed things up, hence, WARN
662 		 */
663 		WARN(pm_runtime_set_active(dev),
664 		     "Could not set %s runtime state active\n", dev_name(dev));
665 		pm_generic_runtime_resume(dev);
666 	}
667 
668 	return pm_generic_resume_noirq(dev);
669 }
670 #else
671 #define _od_suspend_noirq NULL
672 #define _od_resume_noirq NULL
673 #endif
674 
675 struct dev_pm_domain omap_device_fail_pm_domain = {
676 	.ops = {
677 		SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
678 				   _od_fail_runtime_resume, NULL)
679 	}
680 };
681 
682 struct dev_pm_domain omap_device_pm_domain = {
683 	.ops = {
684 		SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
685 				   NULL)
686 		USE_PLATFORM_PM_SLEEP_OPS
687 		SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq,
688 					      _od_resume_noirq)
689 	}
690 };
691 
692 /**
693  * omap_device_register - register an omap_device with one omap_hwmod
694  * @od: struct omap_device * to register
695  *
696  * Register the omap_device structure.  This currently just calls
697  * platform_device_register() on the underlying platform_device.
698  * Returns the return value of platform_device_register().
699  */
omap_device_register(struct platform_device * pdev)700 int omap_device_register(struct platform_device *pdev)
701 {
702 	pr_debug("omap_device: %s: registering\n", pdev->name);
703 
704 	pdev->dev.pm_domain = &omap_device_pm_domain;
705 	return platform_device_add(pdev);
706 }
707 
708 
709 /* Public functions for use by device drivers through struct platform_data */
710 
711 /**
712  * omap_device_enable - fully activate an omap_device
713  * @od: struct omap_device * to activate
714  *
715  * Do whatever is necessary for the hwmods underlying omap_device @od
716  * to be accessible and ready to operate.  This generally involves
717  * enabling clocks, setting SYSCONFIG registers; and in the future may
718  * involve remuxing pins.  Device drivers should call this function
719  * indirectly via pm_runtime_get*().  Returns -EINVAL if called when
720  * the omap_device is already enabled, or passes along the return
721  * value of _omap_device_enable_hwmods().
722  */
omap_device_enable(struct platform_device * pdev)723 int omap_device_enable(struct platform_device *pdev)
724 {
725 	int ret;
726 	struct omap_device *od;
727 
728 	od = to_omap_device(pdev);
729 
730 	if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
731 		dev_warn(&pdev->dev,
732 			 "omap_device: %s() called from invalid state %d\n",
733 			 __func__, od->_state);
734 		return -EINVAL;
735 	}
736 
737 	ret = _omap_device_enable_hwmods(od);
738 
739 	if (ret == 0)
740 		od->_state = OMAP_DEVICE_STATE_ENABLED;
741 
742 	return ret;
743 }
744 
745 /**
746  * omap_device_idle - idle an omap_device
747  * @od: struct omap_device * to idle
748  *
749  * Idle omap_device @od.  Device drivers call this function indirectly
750  * via pm_runtime_put*().  Returns -EINVAL if the omap_device is not
751  * currently enabled, or passes along the return value of
752  * _omap_device_idle_hwmods().
753  */
omap_device_idle(struct platform_device * pdev)754 int omap_device_idle(struct platform_device *pdev)
755 {
756 	int ret;
757 	struct omap_device *od;
758 
759 	od = to_omap_device(pdev);
760 
761 	if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
762 		dev_warn(&pdev->dev,
763 			 "omap_device: %s() called from invalid state %d\n",
764 			 __func__, od->_state);
765 		return -EINVAL;
766 	}
767 
768 	ret = _omap_device_idle_hwmods(od);
769 
770 	if (ret == 0)
771 		od->_state = OMAP_DEVICE_STATE_IDLE;
772 
773 	return ret;
774 }
775 
776 /**
777  * omap_device_assert_hardreset - set a device's hardreset line
778  * @pdev: struct platform_device * to reset
779  * @name: const char * name of the reset line
780  *
781  * Set the hardreset line identified by @name on the IP blocks
782  * associated with the hwmods backing the platform_device @pdev.  All
783  * of the hwmods associated with @pdev must have the same hardreset
784  * line linked to them for this to work.  Passes along the return value
785  * of omap_hwmod_assert_hardreset() in the event of any failure, or
786  * returns 0 upon success.
787  */
omap_device_assert_hardreset(struct platform_device * pdev,const char * name)788 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
789 {
790 	struct omap_device *od = to_omap_device(pdev);
791 	int ret = 0;
792 	int i;
793 
794 	for (i = 0; i < od->hwmods_cnt; i++) {
795 		ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
796 		if (ret)
797 			break;
798 	}
799 
800 	return ret;
801 }
802 
803 /**
804  * omap_device_deassert_hardreset - release a device's hardreset line
805  * @pdev: struct platform_device * to reset
806  * @name: const char * name of the reset line
807  *
808  * Release the hardreset line identified by @name on the IP blocks
809  * associated with the hwmods backing the platform_device @pdev.  All
810  * of the hwmods associated with @pdev must have the same hardreset
811  * line linked to them for this to work.  Passes along the return
812  * value of omap_hwmod_deassert_hardreset() in the event of any
813  * failure, or returns 0 upon success.
814  */
omap_device_deassert_hardreset(struct platform_device * pdev,const char * name)815 int omap_device_deassert_hardreset(struct platform_device *pdev,
816 				   const char *name)
817 {
818 	struct omap_device *od = to_omap_device(pdev);
819 	int ret = 0;
820 	int i;
821 
822 	for (i = 0; i < od->hwmods_cnt; i++) {
823 		ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
824 		if (ret)
825 			break;
826 	}
827 
828 	return ret;
829 }
830 
831 /**
832  * omap_device_get_by_hwmod_name() - convert a hwmod name to
833  * device pointer.
834  * @oh_name: name of the hwmod device
835  *
836  * Returns back a struct device * pointer associated with a hwmod
837  * device represented by a hwmod_name
838  */
omap_device_get_by_hwmod_name(const char * oh_name)839 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
840 {
841 	struct omap_hwmod *oh;
842 
843 	if (!oh_name) {
844 		WARN(1, "%s: no hwmod name!\n", __func__);
845 		return ERR_PTR(-EINVAL);
846 	}
847 
848 	oh = omap_hwmod_lookup(oh_name);
849 	if (!oh) {
850 		WARN(1, "%s: no hwmod for %s\n", __func__,
851 			oh_name);
852 		return ERR_PTR(-ENODEV);
853 	}
854 	if (!oh->od) {
855 		WARN(1, "%s: no omap_device for %s\n", __func__,
856 			oh_name);
857 		return ERR_PTR(-ENODEV);
858 	}
859 
860 	return &oh->od->pdev->dev;
861 }
862 
863 static struct notifier_block platform_nb = {
864 	.notifier_call = _omap_device_notifier_call,
865 };
866 
omap_device_init(void)867 static int __init omap_device_init(void)
868 {
869 	bus_register_notifier(&platform_bus_type, &platform_nb);
870 	return 0;
871 }
872 omap_core_initcall(omap_device_init);
873 
874 /**
875  * omap_device_late_idle - idle devices without drivers
876  * @dev: struct device * associated with omap_device
877  * @data: unused
878  *
879  * Check the driver bound status of this device, and idle it
880  * if there is no driver attached.
881  */
omap_device_late_idle(struct device * dev,void * data)882 static int __init omap_device_late_idle(struct device *dev, void *data)
883 {
884 	struct platform_device *pdev = to_platform_device(dev);
885 	struct omap_device *od = to_omap_device(pdev);
886 	int i;
887 
888 	if (!od)
889 		return 0;
890 
891 	/*
892 	 * If omap_device state is enabled, but has no driver bound,
893 	 * idle it.
894 	 */
895 
896 	/*
897 	 * Some devices (like memory controllers) are always kept
898 	 * enabled, and should not be idled even with no drivers.
899 	 */
900 	for (i = 0; i < od->hwmods_cnt; i++)
901 		if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
902 			return 0;
903 
904 	if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER &&
905 	    od->_driver_status != BUS_NOTIFY_BIND_DRIVER) {
906 		if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
907 			dev_warn(dev, "%s: enabled but no driver.  Idling\n",
908 				 __func__);
909 			omap_device_idle(pdev);
910 		}
911 	}
912 
913 	return 0;
914 }
915 
omap_device_late_init(void)916 static int __init omap_device_late_init(void)
917 {
918 	bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
919 
920 	WARN(!of_have_populated_dt(),
921 		"legacy booting deprecated, please update to boot with .dts\n");
922 
923 	return 0;
924 }
925 omap_late_initcall_sync(omap_device_late_init);
926