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