arch/arm/plat-omap/include/plat/clockdomain.h

   1 /*
   2  * arch/arm/plat-omap/include/mach/clockdomain.h
   3  *
   4  * OMAP2/3 clockdomain framework functions
   5  *
   6  * Copyright (C) 2008 Texas Instruments, Inc.
   7  * Copyright (C) 2008-2010 Nokia Corporation
   8  *
   9  * Paul Walmsley
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  *
  15  * XXX This should be moved to mach-omap2/ at the earliest opportunity.
  16  */
  17
  18 #ifndef __ASM_ARM_ARCH_OMAP_CLOCKDOMAIN_H
  19 #define __ASM_ARM_ARCH_OMAP_CLOCKDOMAIN_H
  20
  21 #include <linux/init.h>
  22
  23 #include <plat/powerdomain.h>
  24 #include <plat/clock.h>
  25 #include <plat/cpu.h>
  26
  27 /* Clockdomain capability flags */
  28 #define CLKDM_CAN_FORCE_SLEEP                   (1 << 0)
  29 #define CLKDM_CAN_FORCE_WAKEUP                  (1 << 1)
  30 #define CLKDM_CAN_ENABLE_AUTO                   (1 << 2)
  31 #define CLKDM_CAN_DISABLE_AUTO                  (1 << 3)
  32
  33 #define CLKDM_CAN_HWSUP         (CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO)
  34 #define CLKDM_CAN_SWSUP         (CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP)
  35 #define CLKDM_CAN_HWSUP_SWSUP   (CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP)
  36
  37 /**
  38  * struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode
  39  * @clkdm: clockdomain to add wkdep+sleepdep on - set name member only
  40  * @omap_chip: OMAP chip types that this autodep is valid on
  41  *
  42  * A clockdomain that should have wkdeps and sleepdeps added when a
  43  * clockdomain should stay active in hwsup mode; and conversely,
  44  * removed when the clockdomain should be allowed to go inactive in
  45  * hwsup mode.
  46  *
  47  * Autodeps are deprecated and should be removed after
  48  * omap_hwmod-based fine-grained module idle control is added.
  49  */
  50 struct clkdm_autodep {
  51         union {
  52                 const char *name;
  53                 struct clockdomain *ptr;
  54         } clkdm;
  55         const struct omap_chip_id omap_chip;
  56 };
  57
  58 /**
  59  * struct clkdm_dep - encode dependencies between clockdomains
  60  * @clkdm_name: clockdomain name
  61  * @clkdm: pointer to the struct clockdomain of @clkdm_name
  62  * @omap_chip: OMAP chip types that this dependency is valid on
  63  * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake
  64  * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle
  65  *
  66  * Statically defined.  @clkdm is resolved from @clkdm_name at runtime and
  67  * should not be pre-initialized.
  68  *
  69  * XXX Should also include hardware (fixed) dependencies.
  70  */
  71 struct clkdm_dep {
  72         const char *clkdm_name;
  73         struct clockdomain *clkdm;
  74         atomic_t wkdep_usecount;
  75         atomic_t sleepdep_usecount;
  76         const struct omap_chip_id omap_chip;
  77 };
  78
  79 /**
  80  * struct clockdomain - OMAP clockdomain
  81  * @name: clockdomain name
  82  * @pwrdm: powerdomain containing this clockdomain
  83  * @clktrctrl_reg: CLKSTCTRL reg for the given clock domain
  84  * @clktrctrl_mask: CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg
  85  * @flags: Clockdomain capability flags
  86  * @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit
  87  * @prcm_partition: (OMAP4 only) PRCM partition ID for this clkdm's registers
  88  * @cm_inst: (OMAP4 only) CM instance register offset
  89  * @clkdm_offs: (OMAP4 only) CM clockdomain register offset
  90  * @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up
  91  * @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact
  92  * @omap_chip: OMAP chip types that this clockdomain is valid on
  93  * @usecount: Usecount tracking
  94  * @node: list_head to link all clockdomains together
  95  *
  96  * @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only)
  97  * @cm_inst should be a macro ending in _INST from the OMAP4 CM instance
  98  *     definitions (OMAP4 only)
  99  * @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance
 100  *     definitions (OMAP4 only)
 101  */
 102 struct clockdomain {
 103         const char *name;
 104         union {
 105                 const char *name;
 106                 struct powerdomain *ptr;
 107         } pwrdm;
 108 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
 109         const u16 clktrctrl_mask;
 110 #endif
 111         const u8 flags;
 112         const u8 dep_bit;
 113         const u8 prcm_partition;
 114         const s16 cm_inst;
 115         const u16 clkdm_offs;
 116         struct clkdm_dep *wkdep_srcs;
 117         struct clkdm_dep *sleepdep_srcs;
 118         const struct omap_chip_id omap_chip;
 119         atomic_t usecount;
 120         struct list_head node;
 121 };
 122
 123 void clkdm_init(struct clockdomain **clkdms, struct clkdm_autodep *autodeps);
 124 struct clockdomain *clkdm_lookup(const char *name);
 125
 126 int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
 127                         void *user);
 128 struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm);
 129
 130 int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 131 int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 132 int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 133 int clkdm_clear_all_wkdeps(struct clockdomain *clkdm);
 134 int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 135 int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 136 int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
 137 int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm);
 138
 139 void omap2_clkdm_allow_idle(struct clockdomain *clkdm);
 140 void omap2_clkdm_deny_idle(struct clockdomain *clkdm);
 141
 142 int omap2_clkdm_wakeup(struct clockdomain *clkdm);
 143 int omap2_clkdm_sleep(struct clockdomain *clkdm);
 144
 145 int omap2_clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk);
 146 int omap2_clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk);
 147
 148 extern void __init omap2_clockdomains_init(void);
 149 extern void __init omap44xx_clockdomains_init(void);
 150
 151 #endif