[patch 1/2] clk_must_disable() interface

From: David Brownell
Date: Thu Mar 22 2007 - 14:13:30 EST


This patch adds a clk_must_disable() operation, exposing the clock constraints
which often distinguish system power states. Systems with such constraints
include ones using ARM-based AT91, OMAP, and PXA chips. The new operation
lets driver methods check those constraints.

(Note that because of its APM/ACPI legacy, Linux can't currently handle more
then two of those state through the /sys/power/state infrastructure; they
are called "standby" and suspend-to-"mem", regardless of what the underlying
hardware calls them.)

A common benefit to leaving some device clocks enabled is that a suspended
device may then be able to issue system wakeup events. RS232, USB, Ethernet,
and other drivers can use driver model wakeup flags as userspace directions
about how to trade off between the lowest power "full off" driver states and
the more functional wakeup-enabled ones.

Signed-off-by: David Brownell <dbrownell@xxxxxxxxxxxxxxxxxxxxx>
---
Seems appropriate for 2.6.22 merge ... last time this came up, there
were no real objections, but the sample implementation (AT91) was a
bit messy.

include/linux/clk.h | 20 ++++++++++++++++++++
1 files changed, 20 insertions(+)

Index: at91/include/linux/clk.h
===================================================================
--- at91.orig/include/linux/clk.h 2007-02-16 08:47:11.000000000 -0800
+++ at91/include/linux/clk.h 2007-02-16 08:47:17.000000000 -0800
@@ -121,4 +121,24 @@ int clk_set_parent(struct clk *clk, stru
*/
struct clk *clk_get_parent(struct clk *clk);

+/**
+ * clk_must_disable - report whether a clock's users must disable it
+ * @clk: one node in the clock tree
+ *
+ * This routine returns true only if the upcoming system state requires
+ * disabling the specified clock.
+ *
+ * It's common for platform power states to constrain certain clocks (and
+ * their descendants) to be unavailable, while other states allow that
+ * clock to be active. A platform's power states often include an "all on"
+ * mode; system wide sleep states like "standby" or "suspend-to-RAM"; and
+ * operating states which sacrifice functionality for lower power usage.
+ *
+ * The constraint value is commonly tested in device driver suspend(), to
+ * leave clocks active if they are needed for features like wakeup events.
+ * On platforms that support reduced functionality operating states, the
+ * constraint may also need to be tested during resume() and probe() calls.
+ */
+int clk_must_disable(struct clk *clk);
+
#endif
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/