1 /*
2  * omap_device headers
3  *
4  * Copyright (C) 2009 Nokia Corporation
5  * Paul Walmsley
6  *
7  * Developed in collaboration with (alphabetical order): Benoit
8  * Cousson, Kevin Hilman, 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 type of functionality should be implemented as a proper
17  * omap_bus/omap_device in Linux.
18  *
19  * omap_device differs from omap_hwmod in that it includes external
20  * (e.g., board- and system-level) integration details.  omap_hwmod
21  * stores hardware data that is invariant for a given OMAP chip.
22  */
23 #ifndef __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H
24 #define __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H
25 
26 #include <linux/kernel.h>
27 #include <linux/platform_device.h>
28 
29 #include "omap_hwmod.h"
30 
31 extern struct dev_pm_domain omap_device_pm_domain;
32 
33 /* omap_device._state values */
34 #define OMAP_DEVICE_STATE_UNKNOWN	0
35 #define OMAP_DEVICE_STATE_ENABLED	1
36 #define OMAP_DEVICE_STATE_IDLE		2
37 #define OMAP_DEVICE_STATE_SHUTDOWN	3
38 
39 /* omap_device.flags values */
40 #define OMAP_DEVICE_SUSPENDED		BIT(0)
41 
42 /**
43  * struct omap_device - omap_device wrapper for platform_devices
44  * @pdev: platform_device
45  * @hwmods: (one .. many per omap_device)
46  * @hwmods_cnt: ARRAY_SIZE() of @hwmods
47  * @_state: one of OMAP_DEVICE_STATE_* (see above)
48  * @flags: device flags
49  * @_driver_status: one of BUS_NOTIFY_*_DRIVER from <linux/device.h>
50  *
51  * Integrates omap_hwmod data into Linux platform_device.
52  *
53  * Field names beginning with underscores are for the internal use of
54  * the omap_device code.
55  *
56  */
57 struct omap_device {
58 	struct platform_device		*pdev;
59 	struct omap_hwmod		**hwmods;
60 	unsigned long			_driver_status;
61 	u8				hwmods_cnt;
62 	u8				_state;
63 	u8                              flags;
64 };
65 
66 /* Device driver interface (call via platform_data fn ptrs) */
67 
68 int omap_device_enable(struct platform_device *pdev);
69 int omap_device_idle(struct platform_device *pdev);
70 
71 /* Core code interface */
72 
73 struct platform_device *omap_device_build(const char *pdev_name, int pdev_id,
74 					  struct omap_hwmod *oh, void *pdata,
75 					  int pdata_len);
76 
77 struct platform_device *omap_device_build_ss(const char *pdev_name, int pdev_id,
78 					 struct omap_hwmod **oh, int oh_cnt,
79 					 void *pdata, int pdata_len);
80 
81 struct omap_device *omap_device_alloc(struct platform_device *pdev,
82 				      struct omap_hwmod **ohs, int oh_cnt);
83 void omap_device_delete(struct omap_device *od);
84 int omap_device_register(struct platform_device *pdev);
85 
86 struct device *omap_device_get_by_hwmod_name(const char *oh_name);
87 
88 /* OMAP PM interface */
89 int omap_device_get_context_loss_count(struct platform_device *pdev);
90 
91 /* Other */
92 
93 int omap_device_assert_hardreset(struct platform_device *pdev,
94 				 const char *name);
95 int omap_device_deassert_hardreset(struct platform_device *pdev,
96 				 const char *name);
97 
98 /* Get omap_device pointer from platform_device pointer */
99 static inline struct omap_device *to_omap_device(struct platform_device *pdev)
100 {
101 	return pdev ? pdev->archdata.od : NULL;
102 }
103 #endif
104