LXR linux/arch/arm/mach-omap2/clockdomain.h

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