include/plat/omap-pm.h

2  * omap-pm.h - OMAP power management interface
4  * Copyright (C) 2008-2010 Texas Instruments, Inc.
5  * Copyright (C) 2008-2010 Nokia Corporation
26  * initiators -- it represents the device's L3 interconnect
34  * omap_pm_if_early_init - OMAP PM init code called before clock fw init
39  * Initialize anything that must be configured before the clock
41  * PM idle-loop code.
46  * omap_pm_if_init - OMAP PM init code called after clock fw init
49  * "_if_" is to avoid name collisions with the PM idle-loop code.
54  * omap_pm_if_exit - OMAP PM exit code
57  * collisions with the PM idle-loop code.
62  * Device-driver-originated constraints (via board-*.c files, platform_data)
67  * omap_pm_set_max_mpu_wakeup_lat - set the maximum MPU wakeup latency
92  * with t = -1.
97  * Returns -EINVAL for an invalid argument, -ERANGE if the constraint
104  * omap_pm_set_min_bus_tput - set minimum bus throughput needed by device
114  * information to set the interconnect clock to run at the lowest
129  * Returns -EINVAL for an invalid argument, -ERANGE if the constraint
136  * omap_pm_set_max_dev_wakeup_lat - set the maximum device enable latency
156  * wakeup latency restriction for this device, call with t = -1.
158  * Returns -EINVAL for an invalid argument, -ERANGE if the constraint
166  * omap_pm_set_max_sdma_lat - set the maximum system DMA transfer start latency
183  * -- use set_max_dev_wakeup_lat() to affect that.
187  * device, call with t = -1.
189  * Returns -EINVAL for an invalid argument, -ERANGE if the constraint
196  * omap_pm_set_min_clk_rate - set minimum clock rate requested by @dev
201  * Request that the minimum clock rate on the device @dev's clk @clk
205  * find an OPP or clock setting that will satisfy this clock rate
207  * the clock rate or corresponding voltage, etc.
209  * omap_pm_set_min_clk_rate() differs from the clock code's
212  * clock rate.  clk_set_rate() is intended to be a low-level
217  * however, there is no easily-generalizable concept of performance
219  * device subsystem) has both the subsystem-specific knowledge, and
220  * the hardware IP block-specific knowledge, to translate a constraint
221  * on "touchscreen sampling accuracy" or "number of pixels or polygons
222  * rendered per second" to a clock rate.  This translation can be
225  * information and can know how to translate that into a clock rate.
227  * The intended use-case for this function is for userspace or other
231  * device driver to convert that requirement to a clock rate, and to
235  * call this function with some high clock rate to ensure "high
239  * clock rate constraint given the hardware type and hardware
241  * know how to make a power/performance tradeoff - some device use
242  * cases may tolerate a lower-fidelity device function for lower power
243  * consumption; others may demand a higher-fidelity device function,
247  * previous rate value for the device @dev.  To remove the minimum clock
250  * Returns -EINVAL for an invalid argument, -ERANGE if the constraint
256  * DSP Bridge-specific constraints
260  * omap_pm_dsp_get_opp_table - get OPP->DSP clock frequency table
262  * Intended for use by DSPBridge.  Returns an array of OPP->DSP clock
269  * omap_pm_dsp_set_min_opp - receive desired OPP target ID from DSP Bridge
273  * only from the DSP Bridge MPU-side driver.  Unfortunately, the only
280  * omap_pm_dsp_get_opp - report the current DSP OPP ID
293  * CPUFreq-originated constraint
300  * omap_pm_cpu_get_freq_table - return a cpufreq_frequency_table array ptr
309  * omap_pm_cpu_set_freq - set the current minimum MPU frequency
314  * Intended to be called by plat-omap/cpu_omap.c:omap_target().  No
320  * omap_pm_cpu_get_freq - report the current CPU frequency
332  * omap_pm_get_dev_context_loss_count - return count of times dev has lost ctx