4 * Copyright (C) 2009 Nokia Corporation
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
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.
16 * Eventually this type of functionality should either be
17 * a) implemented via arch-specific pointers in platform_device
19 * b) implemented as a proper omap_bus/omap_device in Linux, no more
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.
28 * - regulator integration
31 #ifndef __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H
32 #define __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H
34 #include <linux/kernel.h>
35 #include <linux/platform_device.h>
37 #include <plat/omap_hwmod.h>
39 extern struct device omap_device_parent;
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
47 /* omap_device.flags values */
48 #define OMAP_DEVICE_SUSPENDED BIT(0)
51 * struct omap_device - omap_device wrapper for platform_devices
52 * @pdev: platform_device
53 * @hwmods: (one .. many per omap_device)
54 * @hwmods_cnt: ARRAY_SIZE() of @hwmods
55 * @pm_lats: ptr to an omap_device_pm_latency table
56 * @pm_lats_cnt: ARRAY_SIZE() of what is passed to @pm_lats
57 * @pm_lat_level: array index of the last odpl entry executed - -1 if never
58 * @dev_wakeup_lat: dev wakeup latency in nanoseconds
59 * @_dev_wakeup_lat_limit: dev wakeup latency limit in nsec - set by OMAP PM
60 * @_state: one of OMAP_DEVICE_STATE_* (see above)
61 * @flags: device flags
63 * Integrates omap_hwmod data into Linux platform_device.
65 * Field names beginning with underscores are for the internal use of
66 * the omap_device code.
70 struct platform_device pdev;
71 struct omap_hwmod **hwmods;
72 struct omap_device_pm_latency *pm_lats;
74 u32 _dev_wakeup_lat_limit;
82 /* Device driver interface (call via platform_data fn ptrs) */
84 int omap_device_enable(struct platform_device *pdev);
85 int omap_device_idle(struct platform_device *pdev);
86 int omap_device_shutdown(struct platform_device *pdev);
88 /* Core code interface */
90 int omap_device_count_resources(struct omap_device *od);
91 int omap_device_fill_resources(struct omap_device *od, struct resource *res);
93 struct omap_device *omap_device_build(const char *pdev_name, int pdev_id,
94 struct omap_hwmod *oh, void *pdata,
96 struct omap_device_pm_latency *pm_lats,
97 int pm_lats_cnt, int is_early_device);
99 struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id,
100 struct omap_hwmod **oh, int oh_cnt,
101 void *pdata, int pdata_len,
102 struct omap_device_pm_latency *pm_lats,
103 int pm_lats_cnt, int is_early_device);
105 int omap_device_register(struct omap_device *od);
106 int omap_early_device_register(struct omap_device *od);
108 void __iomem *omap_device_get_rt_va(struct omap_device *od);
110 /* OMAP PM interface */
111 int omap_device_align_pm_lat(struct platform_device *pdev,
112 u32 new_wakeup_lat_limit);
113 struct powerdomain *omap_device_get_pwrdm(struct omap_device *od);
114 u32 omap_device_get_context_loss_count(struct platform_device *pdev);
118 int omap_device_idle_hwmods(struct omap_device *od);
119 int omap_device_enable_hwmods(struct omap_device *od);
121 int omap_device_disable_clocks(struct omap_device *od);
122 int omap_device_enable_clocks(struct omap_device *od);
126 * Entries should be kept in latency order ascending
128 * deact_lat is the maximum number of microseconds required to complete
129 * deactivate_func() at the device's slowest OPP.
131 * act_lat is the maximum number of microseconds required to complete
132 * activate_func() at the device's slowest OPP.
134 * This will result in some suboptimal power management decisions at fast
135 * OPPs, but avoids having to recompute all device power management decisions
136 * if the system shifts from a fast OPP to a slow OPP (in order to meet
137 * latency requirements).
139 * XXX should deactivate_func/activate_func() take platform_device pointers
140 * rather than omap_device pointers?
142 struct omap_device_pm_latency {
144 u32 deactivate_lat_worst;
145 int (*deactivate_func)(struct omap_device *od);
147 u32 activate_lat_worst;
148 int (*activate_func)(struct omap_device *od);
152 #define OMAP_DEVICE_LATENCY_AUTO_ADJUST BIT(1)
154 /* Get omap_device pointer from platform_device pointer */
155 #define to_omap_device(x) container_of((x), struct omap_device, pdev)