OMAP clockdomain/powerdomain: improve documentation

This patch only affects documentation; no functional changes are
included.

Clean up comments in the current clockdomain, powerdomain code and
header files.  This mostly involves conversion to kerneldoc format,
although some clarifications are also included.

Signed-off-by: Paul Walmsley <paul@pwsan.com>

2 files changed, 57 insertions, 70 deletions

diff --git a/arch/arm/plat-omap/include/plat/clockdomain.h b/arch/arm/plat-omap/include/plat/clockdomain.h
index 45b5debc5d3f..ba0a6c07c0fe 100644
--- a/arch/arm/plat-omap/include/plat/clockdomain.h
+++ b/arch/arm/plat-omap/include/plat/clockdomain.h
@@ -40,86 +40,77 @@
 #define OMAP34XX_CLKSTCTRL_FORCE_WAKEUP         0x2
 #define OMAP34XX_CLKSTCTRL_ENABLE_AUTO          0x3
 
-/*
- * struct clkdm_autodep - a clockdomain that should have wkdeps
- * and sleepdeps added when a clockdomain should stay active in hwsup mode;
- * and conversely, removed when the clockdomain should be allowed to go
- * inactive in hwsup mode.
+/**
+ * struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode
+ * @clkdm: clockdomain to add wkdep+sleepdep on - set name member only
+ * @omap_chip: OMAP chip types that this autodep is valid on
+ *
+ * A clockdomain that should have wkdeps and sleepdeps added when a
+ * clockdomain should stay active in hwsup mode; and conversely,
+ * removed when the clockdomain should be allowed to go inactive in
+ * hwsup mode.
+ *
+ * Autodeps are deprecated and should be removed after
+ * omap_hwmod-based fine-grained module idle control is added.
  */
 struct clkdm_autodep {
-
         union {
-                /* Name of the clockdomain to add a wkdep/sleepdep on */
                 const char *name;
-
-                /* Clockdomain pointer (looked up at clkdm_init() time) */
                 struct clockdomain *ptr;
         } clkdm;
-
-        /* OMAP chip types that this clockdomain dep is valid on */
         const struct omap_chip_id omap_chip;
-
 };
 
-/* Encodes dependencies between clockdomains - statically defined */
+/**
+ * struct clkdm_dep - encode dependencies between clockdomains
+ * @clkdm_name: clockdomain name
+ * @clkdm: pointer to the struct clockdomain of @clkdm_name
+ * @omap_chip: OMAP chip types that this dependency is valid on
+ * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake
+ * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle
+ *
+ * Statically defined.  @clkdm is resolved from @clkdm_name at runtime and
+ * should not be pre-initialized.
+ *
+ * XXX Should also include hardware (fixed) dependencies.
+ */
 struct clkdm_dep {
-
-        /* Clockdomain name */
         const char *clkdm_name;
-
-        /* Clockdomain pointer - resolved by the clockdomain code */
         struct clockdomain *clkdm;
-
-        /* Number of wakeup dependencies causing this clkdm to wake  */
         atomic_t wkdep_usecount;
-
-        /* Number of sleep dependencies that could prevent clkdm from idle */
         atomic_t sleepdep_usecount;
-
-        /* Flags to mark OMAP chip restrictions, etc. */
         const struct omap_chip_id omap_chip;
-
 };
 
+/**
+ * struct clockdomain - OMAP clockdomain
+ * @name: clockdomain name
+ * @pwrdm: powerdomain containing this clockdomain
+ * @clktrctrl_reg: CLKSTCTRL reg for the given clock domain
+ * @clktrctrl_mask: CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg
+ * @flags: Clockdomain capability flags
+ * @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit
+ * @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up
+ * @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact
+ * @omap_chip: OMAP chip types that this clockdomain is valid on
+ * @usecount: Usecount tracking
+ * @node: list_head to link all clockdomains together
+ */
 struct clockdomain {
-
-        /* Clockdomain name */
         const char *name;
-
         union {
-                /* Powerdomain enclosing this clockdomain */
                 const char *name;
-
-                /* Powerdomain pointer assigned at clkdm_register() */
                 struct powerdomain *ptr;
         } pwrdm;
-
-        /* CLKSTCTRL reg for the given clock domain*/
         void __iomem *clkstctrl_reg;
-
-        /* CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg */
         const u16 clktrctrl_mask;
-
-        /* Clockdomain capability flags */
         const u8 flags;
-
-        /* Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit */
         const u8 dep_bit;
-
-        /* Clockdomains that can be told to wake this powerdomain up */
         struct clkdm_dep *wkdep_srcs;
-
-        /* Clockdomains that can be told to keep this clkdm from inactivity */
         struct clkdm_dep *sleepdep_srcs;
-
-        /* OMAP chip types that this clockdomain is valid on */
         const struct omap_chip_id omap_chip;
-
-        /* Usecount tracking */
         atomic_t usecount;
-
         struct list_head node;
-
 };
 
 void clkdm_init(struct clockdomain **clkdms, struct clkdm_autodep *autodeps);
diff --git a/arch/arm/plat-omap/include/plat/powerdomain.h b/arch/arm/plat-omap/include/plat/powerdomain.h
index 87e13f88994f..e15c7e9da975 100644
--- a/arch/arm/plat-omap/include/plat/powerdomain.h
+++ b/arch/arm/plat-omap/include/plat/powerdomain.h
@@ -68,40 +68,36 @@
 struct clockdomain;
 struct powerdomain;
 
+/**
+ * struct powerdomain - OMAP powerdomain
+ * @name: Powerdomain name
+ * @omap_chip: represents the OMAP chip types containing this pwrdm
+ * @prcm_offs: the address offset from CM_BASE/PRM_BASE
+ * @pwrsts: Possible powerdomain power states
+ * @pwrsts_logic_ret: Possible logic power states when pwrdm in RETENTION
+ * @flags: Powerdomain flags
+ * @banks: Number of software-controllable memory banks in this powerdomain
+ * @pwrsts_mem_ret: Possible memory bank pwrstates when pwrdm in RETENTION
+ * @pwrsts_mem_on: Possible memory bank pwrstates when pwrdm in ON
+ * @pwrdm_clkdms: Clockdomains in this powerdomain
+ * @node: list_head linking all powerdomains
+ * @state:
+ * @state_counter:
+ * @timer:
+ * @state_timer:
+ */
 struct powerdomain {
-
-        /* Powerdomain name */
         const char *name;
-
-        /* Used to represent the OMAP chip types containing this pwrdm */
         const struct omap_chip_id omap_chip;
-
-        /* the address offset from CM_BASE/PRM_BASE */
         const s16 prcm_offs;
-
-        /* Possible powerdomain power states */
         const u8 pwrsts;
-
-        /* Possible logic power states when pwrdm in RETENTION */
         const u8 pwrsts_logic_ret;
-
-        /* Powerdomain flags */
         const u8 flags;
-
-        /* Number of software-controllable memory banks in this powerdomain */
         const u8 banks;
-
-        /* Possible memory bank pwrstates when pwrdm in RETENTION */
         const u8 pwrsts_mem_ret[PWRDM_MAX_MEM_BANKS];
-
-        /* Possible memory bank pwrstates when pwrdm is ON */
         const u8 pwrsts_mem_on[PWRDM_MAX_MEM_BANKS];
-
-        /* Clockdomains in this powerdomain */
         struct clockdomain *pwrdm_clkdms[PWRDM_MAX_CLKDMS];
-
         struct list_head node;
-
         int state;
         unsigned state_counter[PWRDM_MAX_PWRSTS];