arch/arm/mach-omap2/clockdomain.h

   1 /*
   2  * OMAP2/3 clockdomain framework functions
   3  *
   4  * Copyright (C) 2008, 2012 Texas Instruments, Inc.
   5  * Copyright (C) 2008-2011 Nokia Corporation
   6  *
   7  * Paul Walmsley
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  */
  13
  14 #ifndef __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H
  15 #define __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H
  16
  17 #include <linux/init.h>
  18
  19 #include "powerdomain.h"
  20 #include "clock.h"
  21 #include "omap_hwmod.h"
  22
  23 /*
  24  * Clockdomain flags
  25  *
  26  * XXX Document CLKDM_CAN_* flags
  27  *
  28  * CLKDM_NO_AUTODEPS: Prevent "autodeps" from being added/removed from this
  29  *     clockdomain.  (Currently, this applies to OMAP3 clockdomains only.)
  30  * CLKDM_ACTIVE_WITH_MPU: The PRCM guarantees that this clockdomain is
  31  *     active whenever the MPU is active.  True for interconnects and
  32  *     the WKUP clockdomains.
  33  * CLKDM_MISSING_IDLE_REPORTING: The idle status of the IP blocks and
  34  *     clocks inside this clockdomain are not taken into account by
  35  *     the PRCM when determining whether the clockdomain is idle.
  36  *     Without this flag, if the clockdomain is set to
  37  *     hardware-supervised idle mode, the PRCM may transition the
  38  *     enclosing powerdomain to a low power state, even when devices
  39  *     inside the clockdomain and powerdomain are in use.  (An example
  40  *     of such a clockdomain is the EMU clockdomain on OMAP3/4.)  If
  41  *     this flag is set, and the clockdomain does not support the
  42  *     force-sleep mode, then the HW_AUTO mode will be used to put the
  43  *     clockdomain to sleep.  Similarly, if the clockdomain supports
  44  *     the force-wakeup mode, then it will be used whenever a clock or
  45  *     IP block inside the clockdomain is active, rather than the
  46  *     HW_AUTO mode.
  47  */
  48 #define CLKDM_CAN_FORCE_SLEEP                   (1 << 0)
  49 #define CLKDM_CAN_FORCE_WAKEUP                  (1 << 1)
  50 #define CLKDM_CAN_ENABLE_AUTO                   (1 << 2)
  51 #define CLKDM_CAN_DISABLE_AUTO                  (1 << 3)
  52 #define CLKDM_NO_AUTODEPS                       (1 << 4)
  53 #define CLKDM_ACTIVE_WITH_MPU                   (1 << 5)
  54 #define CLKDM_MISSING_IDLE_REPORTING            (1 << 6)
  55
  56 #define CLKDM_CAN_HWSUP         (CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO)
  57 #define CLKDM_CAN_SWSUP         (CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP)
  58 #define CLKDM_CAN_HWSUP_SWSUP   (CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP)
  59
  60 /**
  61  * struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode
  62  * @clkdm: clockdomain to add wkdep+sleepdep on - set name member only
  63  *
  64  * A clockdomain that should have wkdeps and sleepdeps added when a
  65  * clockdomain should stay active in hwsup mode; and conversely,
  66  * removed when the clockdomain should be allowed to go inactive in
  67  * hwsup mode.
  68  *
  69  * Autodeps are deprecated and should be removed after
  70  * omap_hwmod-based fine-grained module idle control is added.
  71  */
  72 struct clkdm_autodep {
  73         union {
  74                 const char *name;
  75                 struct clockdomain *ptr;
  76         } clkdm;
  77 };
  78
  79 /**
  80  * struct clkdm_dep - encode dependencies between clockdomains
  81  * @clkdm_name: clockdomain name
  82  * @clkdm: pointer to the struct clockdomain of @clkdm_name
  83  * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake
  84  * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle
  85  *
  86  * Statically defined.  @clkdm is resolved from @clkdm_name at runtime and
  87  * should not be pre-initialized.
  88  *
  89  * XXX Should also include hardware (fixed) dependencies.
  90  */
  91 struct clkdm_dep {
  92         const char *clkdm_name;
  93         struct clockdomain *clkdm;
  94         s16 wkdep_usecount;
  95         s16 sleepdep_usecount;
  96 };
  97
  98 /* Possible flags for struct clockdomain._flags */
  99 #define _CLKDM_FLAG_HWSUP_ENABLED               BIT(0)
 100
 101 /**
 102  * struct clockdomain - OMAP clockdomain
 103  * @name: clockdomain name
 104  * @pwrdm: powerdomain containing this clockdomain
 105  * @clktrctrl_reg: CLKSTCTRL reg for the given clock domain
 106  * @clktrctrl_mask: CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg
 107  * @flags: Clockdomain capability flags
 108  * @_flags: Flags for use only by internal clockdomain code
 109  * @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit
 110  * @prcm_partition: (OMAP4 only) PRCM partition ID for this clkdm's registers
 111  * @cm_inst: (OMAP4 only) CM instance register offset
 112  * @clkdm_offs: (OMAP4 only) CM clockdomain register offset
 113  * @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up
 114  * @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact
 115  * @usecount: Usecount tracking
 116  * @node: list_head to link all clockdomains together
 117  *
 118  * @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only)
 119  * @cm_inst should be a macro ending in _INST from the OMAP4 CM instance
 120  *     definitions (OMAP4 only)
 121  * @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance
 122  *     definitions (OMAP4 only)
 123  */
 124 struct clockdomain {
 125         const char *name;
 126         union {
 127                 const char *name;
 128                 struct powerdomain *ptr;
 129         } pwrdm;
 130         const u16 clktrctrl_mask;
 131         const u8 flags;
 132         u8 _flags;
 133         const u8 dep_bit;
 134         const u8 prcm_partition;
 135         const s16 cm_inst;
 136         const u16 clkdm_offs;
 137         struct clkdm_dep *wkdep_srcs;
 138         struct clkdm_dep *sleepdep_srcs;
 139         int usecount;
 140         struct list_head node;
 141 };
 142
 143 /**
 144  * struct clkdm_ops - Arch specific function implementations
 145  * @clkdm_add_wkdep: Add a wakeup dependency between clk domains
 146  * @clkdm_del_wkdep: Delete a wakeup dependency between clk domains
 147  * @clkdm_read_wkdep: Read wakeup dependency state between clk domains
 148  * @clkdm_clear_all_wkdeps: Remove all wakeup dependencies from the clk domain
 149  * @clkdm_add_sleepdep: Add a sleep dependency between clk domains
 150  * @clkdm_del_sleepdep: Delete a sleep dependency between clk domains
 151  * @clkdm_read_sleepdep: Read sleep dependency state between clk domains
 152  * @clkdm_clear_all_sleepdeps: Remove all sleep dependencies from the clk domain
 153  * @clkdm_sleep: Force a clockdomain to sleep
 154  * @clkdm_wakeup: Force a clockdomain to wakeup
 155  * @clkdm_allow_idle: Enable hw supervised idle transitions for clock domain
 156  * @clkdm_deny_idle: Disable hw supervised idle transitions for clock domain
 157  * @clkdm_clk_enable: Put the clkdm in right state for a clock enable
 158  * @clkdm_clk_disable: Put the clkdm in right state for a clock disable
 159  */
 160 struct clkdm_ops {
 161         int     (*clkdm_add_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 162         int     (*clkdm_del_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 163         int     (*clkdm_read_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 164         int     (*clkdm_clear_all_wkdeps)(struct clockdomain *clkdm);
 165         int     (*clkdm_add_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 166         int     (*clkdm_del_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 167         int     (*clkdm_read_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 168         int     (*clkdm_clear_all_sleepdeps)(struct clockdomain *clkdm);
 169         int     (*clkdm_sleep)(struct clockdomain *clkdm);
 170         int     (*clkdm_wakeup)(struct clockdomain *clkdm);
 171         void    (*clkdm_allow_idle)(struct clockdomain *clkdm);
 172         void    (*clkdm_deny_idle)(struct clockdomain *clkdm);
 173         int     (*clkdm_clk_enable)(struct clockdomain *clkdm);
 174         int     (*clkdm_clk_disable)(struct clockdomain *clkdm);
 175 };
 176
 177 int clkdm_register_platform_funcs(struct clkdm_ops *co);
 178 int clkdm_register_autodeps(struct clkdm_autodep *ia);
 179 int clkdm_register_clkdms(struct clockdomain **c);
 180 int clkdm_complete_init(void);
 181
 182 struct clockdomain *clkdm_lookup(const char *name);
 183
 184 int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
 185                         void *user);
 186 struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm);
 187
 188 int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 189 int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 190 int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 191 int clkdm_clear_all_wkdeps(struct clockdomain *clkdm);
 192 int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 193 int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 194 int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 195 int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm);
 196
 197 void clkdm_allow_idle_nolock(struct clockdomain *clkdm);
 198 void clkdm_allow_idle(struct clockdomain *clkdm);
 199 void clkdm_deny_idle_nolock(struct clockdomain *clkdm);
 200 void clkdm_deny_idle(struct clockdomain *clkdm);
 201 bool clkdm_in_hwsup(struct clockdomain *clkdm);
 202 bool clkdm_missing_idle_reporting(struct clockdomain *clkdm);
 203
 204 int clkdm_wakeup_nolock(struct clockdomain *clkdm);
 205 int clkdm_wakeup(struct clockdomain *clkdm);
 206 int clkdm_sleep_nolock(struct clockdomain *clkdm);
 207 int clkdm_sleep(struct clockdomain *clkdm);
 208
 209 int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk);
 210 int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk);
 211 int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh);
 212 int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh);
 213
 214 extern void __init omap242x_clockdomains_init(void);
 215 extern void __init omap243x_clockdomains_init(void);
 216 extern void __init omap3xxx_clockdomains_init(void);
 217 extern void __init am33xx_clockdomains_init(void);
 218 extern void __init omap44xx_clockdomains_init(void);
 219 extern void __init omap54xx_clockdomains_init(void);
 220
 221 extern void clkdm_add_autodeps(struct clockdomain *clkdm);
 222 extern void clkdm_del_autodeps(struct clockdomain *clkdm);
 223
 224 extern struct clkdm_ops omap2_clkdm_operations;
 225 extern struct clkdm_ops omap3_clkdm_operations;
 226 extern struct clkdm_ops omap4_clkdm_operations;
 227 extern struct clkdm_ops am33xx_clkdm_operations;
 228
 229 extern struct clkdm_dep gfx_24xx_wkdeps[];
 230 extern struct clkdm_dep dsp_24xx_wkdeps[];
 231 extern struct clockdomain wkup_common_clkdm;
 232
 233 #endif