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  * Eventually this type of functionality should either be
17  * a) implemented via arch-specific pointers in platform_device
18  * or
19  * b) implemented as a proper omap_bus/omap_device in Linux, no more
20  *    platform_device
21  *
22  * omap_device differs from omap_hwmod in that it includes external
23  * (e.g., board- and system-level) integration details.  omap_hwmod
24  * stores hardware data that is invariant for a given OMAP chip.
25  *
26  * To do:
27  * - GPIO integration
28  * - regulator integration
29  *
30  */
31 #ifndef __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H
32 #define __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H
33 
34 #include <linux/kernel.h>
35 #include <linux/platform_device.h>
36 
37 #include <plat/omap_hwmod.h>
38 
39 extern struct device omap_device_parent;
40 
41 /* omap_device._state values */
42 #define OMAP_DEVICE_STATE_UNKNOWN	0
43 #define OMAP_DEVICE_STATE_ENABLED	1
44 #define OMAP_DEVICE_STATE_IDLE		2
45 #define OMAP_DEVICE_STATE_SHUTDOWN	3
46 
47 /**
48  * struct omap_device - omap_device wrapper for platform_devices
49  * @pdev: platform_device
50  * @hwmods: (one .. many per omap_device)
51  * @hwmods_cnt: ARRAY_SIZE() of @hwmods
52  * @pm_lats: ptr to an omap_device_pm_latency table
53  * @pm_lats_cnt: ARRAY_SIZE() of what is passed to @pm_lats
54  * @pm_lat_level: array index of the last odpl entry executed - -1 if never
55  * @dev_wakeup_lat: dev wakeup latency in nanoseconds
56  * @_dev_wakeup_lat_limit: dev wakeup latency limit in nsec - set by OMAP PM
57  * @_state: one of OMAP_DEVICE_STATE_* (see above)
58  * @flags: device flags
59  *
60  * Integrates omap_hwmod data into Linux platform_device.
61  *
62  * Field names beginning with underscores are for the internal use of
63  * the omap_device code.
64  *
65  */
66 struct omap_device {
67 	struct platform_device		pdev;
68 	struct omap_hwmod		**hwmods;
69 	struct omap_device_pm_latency	*pm_lats;
70 	u32				dev_wakeup_lat;
71 	u32				_dev_wakeup_lat_limit;
72 	u8				pm_lats_cnt;
73 	s8				pm_lat_level;
74 	u8				hwmods_cnt;
75 	u8				_state;
76 };
77 
78 /* Device driver interface (call via platform_data fn ptrs) */
79 
80 int omap_device_enable(struct platform_device *pdev);
81 int omap_device_idle(struct platform_device *pdev);
82 int omap_device_shutdown(struct platform_device *pdev);
83 
84 /* Core code interface */
85 
86 int omap_device_count_resources(struct omap_device *od);
87 int omap_device_fill_resources(struct omap_device *od, struct resource *res);
88 
89 struct omap_device *omap_device_build(const char *pdev_name, int pdev_id,
90 				      struct omap_hwmod *oh, void *pdata,
91 				      int pdata_len,
92 				      struct omap_device_pm_latency *pm_lats,
93 				      int pm_lats_cnt, int is_early_device);
94 
95 struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id,
96 					 struct omap_hwmod **oh, int oh_cnt,
97 					 void *pdata, int pdata_len,
98 					 struct omap_device_pm_latency *pm_lats,
99 					 int pm_lats_cnt, int is_early_device);
100 
101 int omap_device_register(struct omap_device *od);
102 int omap_early_device_register(struct omap_device *od);
103 
104 void __iomem *omap_device_get_rt_va(struct omap_device *od);
105 
106 /* OMAP PM interface */
107 int omap_device_align_pm_lat(struct platform_device *pdev,
108 			     u32 new_wakeup_lat_limit);
109 struct powerdomain *omap_device_get_pwrdm(struct omap_device *od);
110 u32 omap_device_get_context_loss_count(struct platform_device *pdev);
111 
112 /* Other */
113 
114 int omap_device_idle_hwmods(struct omap_device *od);
115 int omap_device_enable_hwmods(struct omap_device *od);
116 
117 int omap_device_disable_clocks(struct omap_device *od);
118 int omap_device_enable_clocks(struct omap_device *od);
119 
120 
121 /*
122  * Entries should be kept in latency order ascending
123  *
124  * deact_lat is the maximum number of microseconds required to complete
125  * deactivate_func() at the device's slowest OPP.
126  *
127  * act_lat is the maximum number of microseconds required to complete
128  * activate_func() at the device's slowest OPP.
129  *
130  * This will result in some suboptimal power management decisions at fast
131  * OPPs, but avoids having to recompute all device power management decisions
132  * if the system shifts from a fast OPP to a slow OPP (in order to meet
133  * latency requirements).
134  *
135  * XXX should deactivate_func/activate_func() take platform_device pointers
136  * rather than omap_device pointers?
137  */
138 struct omap_device_pm_latency {
139 	u32 deactivate_lat;
140 	u32 deactivate_lat_worst;
141 	int (*deactivate_func)(struct omap_device *od);
142 	u32 activate_lat;
143 	u32 activate_lat_worst;
144 	int (*activate_func)(struct omap_device *od);
145 	u32 flags;
146 };
147 
148 #define OMAP_DEVICE_LATENCY_AUTO_ADJUST BIT(1)
149 
150 /* Get omap_device pointer from platform_device pointer */
151 #define to_omap_device(x) container_of((x), struct omap_device, pdev)
152 
153 #endif
154