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

   1 /*
   2  * OMAP clock: data structure definitions, function prototypes, shared macros
   3  *
   4  * Copyright (C) 2004-2005, 2008-2010 Nokia Corporation
   5  * Written by Tuukka Tikkanen <tuukka.tikkanen@elektrobit.com>
   6  * Based on clocks.h by Tony Lindgren, Gordon McNutt and RidgeRun, Inc
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #ifndef __ARCH_ARM_OMAP_CLOCK_H
  14 #define __ARCH_ARM_OMAP_CLOCK_H
  15
  16 #include <linux/list.h>
  17
  18 struct module;
  19 struct clk;
  20 struct clockdomain;
  21
  22 /**
  23  * struct clkops - some clock function pointers
  24  * @enable: fn ptr that enables the current clock in hardware
  25  * @disable: fn ptr that enables the current clock in hardware
  26  * @find_idlest: function returning the IDLEST register for the clock's IP blk
  27  * @find_companion: function returning the "companion" clk reg for the clock
  28  * @allow_idle: fn ptr that enables autoidle for the current clock in hardware
  29  * @deny_idle: fn ptr that disables autoidle for the current clock in hardware
  30  *
  31  * A "companion" clk is an accompanying clock to the one being queried
  32  * that must be enabled for the IP module connected to the clock to
  33  * become accessible by the hardware.  Neither @find_idlest nor
  34  * @find_companion should be needed; that information is IP
  35  * block-specific; the hwmod code has been created to handle this, but
  36  * until hwmod data is ready and drivers have been converted to use PM
  37  * runtime calls in place of clk_enable()/clk_disable(), @find_idlest and
  38  * @find_companion must, unfortunately, remain.
  39  */
  40 struct clkops {
  41         int                     (*enable)(struct clk *);
  42         void                    (*disable)(struct clk *);
  43         void                    (*find_idlest)(struct clk *, void __iomem **,
  44                                                u8 *, u8 *);
  45         void                    (*find_companion)(struct clk *, void __iomem **,
  46                                                   u8 *);
  47         void                    (*allow_idle)(struct clk *);
  48         void                    (*deny_idle)(struct clk *);
  49 };
  50
  51 #ifdef CONFIG_ARCH_OMAP2PLUS
  52
  53 /* struct clksel_rate.flags possibilities */
  54 #define RATE_IN_242X            (1 << 0)
  55 #define RATE_IN_243X            (1 << 1)
  56 #define RATE_IN_3430ES1         (1 << 2)        /* 3430ES1 rates only */
  57 #define RATE_IN_3430ES2PLUS     (1 << 3)        /* 3430 ES >= 2 rates only */
  58 #define RATE_IN_36XX            (1 << 4)
  59 #define RATE_IN_4430            (1 << 5)
  60 #define RATE_IN_TI816X          (1 << 6)
  61
  62 #define RATE_IN_24XX            (RATE_IN_242X | RATE_IN_243X)
  63 #define RATE_IN_34XX            (RATE_IN_3430ES1 | RATE_IN_3430ES2PLUS)
  64 #define RATE_IN_3XXX            (RATE_IN_34XX | RATE_IN_36XX)
  65
  66 /* RATE_IN_3430ES2PLUS_36XX includes 34xx/35xx with ES >=2, and all 36xx/37xx */
  67 #define RATE_IN_3430ES2PLUS_36XX        (RATE_IN_3430ES2PLUS | RATE_IN_36XX)
  68
  69
  70 /**
  71  * struct clksel_rate - register bitfield values corresponding to clk divisors
  72  * @val: register bitfield value (shifted to bit 0)
  73  * @div: clock divisor corresponding to @val
  74  * @flags: (see "struct clksel_rate.flags possibilities" above)
  75  *
  76  * @val should match the value of a read from struct clk.clksel_reg
  77  * AND'ed with struct clk.clksel_mask, shifted right to bit 0.
  78  *
  79  * @div is the divisor that should be applied to the parent clock's rate
  80  * to produce the current clock's rate.
  81  *
  82  * XXX @flags probably should be replaced with an struct omap_chip.
  83  */
  84 struct clksel_rate {
  85         u32                     val;
  86         u8                      div;
  87         u8                      flags;
  88 };
  89
  90 /**
  91  * struct clksel - available parent clocks, and a pointer to their divisors
  92  * @parent: struct clk * to a possible parent clock
  93  * @rates: available divisors for this parent clock
  94  *
  95  * A struct clksel is always associated with one or more struct clks
  96  * and one or more struct clksel_rates.
  97  */
  98 struct clksel {
  99         struct clk               *parent;
 100         const struct clksel_rate *rates;
 101 };
 102
 103 /**
 104  * struct dpll_data - DPLL registers and integration data
 105  * @mult_div1_reg: register containing the DPLL M and N bitfields
 106  * @mult_mask: mask of the DPLL M bitfield in @mult_div1_reg
 107  * @div1_mask: mask of the DPLL N bitfield in @mult_div1_reg
 108  * @clk_bypass: struct clk pointer to the clock's bypass clock input
 109  * @clk_ref: struct clk pointer to the clock's reference clock input
 110  * @control_reg: register containing the DPLL mode bitfield
 111  * @enable_mask: mask of the DPLL mode bitfield in @control_reg
 112  * @rate_tolerance: maximum variance allowed from target rate (in Hz)
 113  * @last_rounded_rate: cache of the last rate result of omap2_dpll_round_rate()
 114  * @last_rounded_m: cache of the last M result of omap2_dpll_round_rate()
 115  * @max_multiplier: maximum valid non-bypass multiplier value (actual)
 116  * @last_rounded_n: cache of the last N result of omap2_dpll_round_rate()
 117  * @min_divider: minimum valid non-bypass divider value (actual)
 118  * @max_divider: maximum valid non-bypass divider value (actual)
 119  * @modes: possible values of @enable_mask
 120  * @autoidle_reg: register containing the DPLL autoidle mode bitfield
 121  * @idlest_reg: register containing the DPLL idle status bitfield
 122  * @autoidle_mask: mask of the DPLL autoidle mode bitfield in @autoidle_reg
 123  * @freqsel_mask: mask of the DPLL jitter correction bitfield in @control_reg
 124  * @idlest_mask: mask of the DPLL idle status bitfield in @idlest_reg
 125  * @auto_recal_bit: bitshift of the driftguard enable bit in @control_reg
 126  * @recal_en_bit: bitshift of the PRM_IRQENABLE_* bit for recalibration IRQs
 127  * @recal_st_bit: bitshift of the PRM_IRQSTATUS_* bit for recalibration IRQs
 128  * @flags: DPLL type/features (see below)
 129  *
 130  * Possible values for @flags:
 131  * DPLL_J_TYPE: "J-type DPLL" (only some 36xx, 4xxx DPLLs)
 132  *
 133  * @freqsel_mask is only used on the OMAP34xx family and AM35xx.
 134  *
 135  * XXX Some DPLLs have multiple bypass inputs, so it's not technically
 136  * correct to only have one @clk_bypass pointer.
 137  *
 138  * XXX @rate_tolerance should probably be deprecated - currently there
 139  * don't seem to be any usecases for DPLL rounding that is not exact.
 140  *
 141  * XXX The runtime-variable fields (@last_rounded_rate, @last_rounded_m,
 142  * @last_rounded_n) should be separated from the runtime-fixed fields
 143  * and placed into a differenct structure, so that the runtime-fixed data
 144  * can be placed into read-only space.
 145  */
 146 struct dpll_data {
 147         void __iomem            *mult_div1_reg;
 148         u32                     mult_mask;
 149         u32                     div1_mask;
 150         struct clk              *clk_bypass;
 151         struct clk              *clk_ref;
 152         void __iomem            *control_reg;
 153         u32                     enable_mask;
 154         unsigned int            rate_tolerance;
 155         unsigned long           last_rounded_rate;
 156         u16                     last_rounded_m;
 157         u16                     max_multiplier;
 158         u8                      last_rounded_n;
 159         u8                      min_divider;
 160         u8                      max_divider;
 161         u8                      modes;
 162 #if defined(CONFIG_ARCH_OMAP3) || defined(CONFIG_ARCH_OMAP4)
 163         void __iomem            *autoidle_reg;
 164         void __iomem            *idlest_reg;
 165         u32                     autoidle_mask;
 166         u32                     freqsel_mask;
 167         u32                     idlest_mask;
 168         u32                     dco_mask;
 169         u32                     sddiv_mask;
 170         u8                      auto_recal_bit;
 171         u8                      recal_en_bit;
 172         u8                      recal_st_bit;
 173         u8                      flags;
 174 #  endif
 175 };
 176
 177 #endif
 178
 179 /*
 180  * struct clk.flags possibilities
 181  *
 182  * XXX document the rest of the clock flags here
 183  *
 184  * CLOCK_CLKOUTX2: (OMAP4 only) DPLL CLKOUT and CLKOUTX2 GATE_CTRL
 185  *     bits share the same register.  This flag allows the
 186  *     omap4_dpllmx*() code to determine which GATE_CTRL bit field
 187  *     should be used.  This is a temporary solution - a better approach
 188  *     would be to associate clock type-specific data with the clock,
 189  *     similar to the struct dpll_data approach.
 190  */
 191 #define ENABLE_REG_32BIT        (1 << 0)        /* Use 32-bit access */
 192 #define CLOCK_IDLE_CONTROL      (1 << 1)
 193 #define CLOCK_NO_IDLE_PARENT    (1 << 2)
 194 #define ENABLE_ON_INIT          (1 << 3)        /* Enable upon framework init */
 195 #define INVERT_ENABLE           (1 << 4)        /* 0 enables, 1 disables */
 196 #define CLOCK_CLKOUTX2          (1 << 5)
 197
 198 /**
 199  * struct clk - OMAP struct clk
 200  * @node: list_head connecting this clock into the full clock list
 201  * @ops: struct clkops * for this clock
 202  * @name: the name of the clock in the hardware (used in hwmod data and debug)
 203  * @parent: pointer to this clock's parent struct clk
 204  * @children: list_head connecting to the child clks' @sibling list_heads
 205  * @sibling: list_head connecting this clk to its parent clk's @children
 206  * @rate: current clock rate
 207  * @enable_reg: register to write to enable the clock (see @enable_bit)
 208  * @recalc: fn ptr that returns the clock's current rate
 209  * @set_rate: fn ptr that can change the clock's current rate
 210  * @round_rate: fn ptr that can round the clock's current rate
 211  * @init: fn ptr to do clock-specific initialization
 212  * @enable_bit: bitshift to write to enable/disable the clock (see @enable_reg)
 213  * @usecount: number of users that have requested this clock to be enabled
 214  * @fixed_div: when > 0, this clock's rate is its parent's rate / @fixed_div
 215  * @flags: see "struct clk.flags possibilities" above
 216  * @clksel_reg: for clksel clks, register va containing src/divisor select
 217  * @clksel_mask: bitmask in @clksel_reg for the src/divisor selector
 218  * @clksel: for clksel clks, pointer to struct clksel for this clock
 219  * @dpll_data: for DPLLs, pointer to struct dpll_data for this clock
 220  * @clkdm_name: clockdomain name that this clock is contained in
 221  * @clkdm: pointer to struct clockdomain, resolved from @clkdm_name at runtime
 222  * @rate_offset: bitshift for rate selection bitfield (OMAP1 only)
 223  * @src_offset: bitshift for source selection bitfield (OMAP1 only)
 224  *
 225  * XXX @rate_offset, @src_offset should probably be removed and OMAP1
 226  * clock code converted to use clksel.
 227  *
 228  * XXX @usecount is poorly named.  It should be "enable_count" or
 229  * something similar.  "users" in the description refers to kernel
 230  * code (core code or drivers) that have called clk_enable() and not
 231  * yet called clk_disable(); the usecount of parent clocks is also
 232  * incremented by the clock code when clk_enable() is called on child
 233  * clocks and decremented by the clock code when clk_disable() is
 234  * called on child clocks.
 235  *
 236  * XXX @clkdm, @usecount, @children, @sibling should be marked for
 237  * internal use only.
 238  *
 239  * @children and @sibling are used to optimize parent-to-child clock
 240  * tree traversals.  (child-to-parent traversals use @parent.)
 241  *
 242  * XXX The notion of the clock's current rate probably needs to be
 243  * separated from the clock's target rate.
 244  */
 245 struct clk {
 246         struct list_head        node;
 247         const struct clkops     *ops;
 248         const char              *name;
 249         struct clk              *parent;
 250         struct list_head        children;
 251         struct list_head        sibling;        /* node for children */
 252         unsigned long           rate;
 253         void __iomem            *enable_reg;
 254         unsigned long           (*recalc)(struct clk *);
 255         int                     (*set_rate)(struct clk *, unsigned long);
 256         long                    (*round_rate)(struct clk *, unsigned long);
 257         void                    (*init)(struct clk *);
 258         u8                      enable_bit;
 259         s8                      usecount;
 260         u8                      fixed_div;
 261         u8                      flags;
 262 #ifdef CONFIG_ARCH_OMAP2PLUS
 263         void __iomem            *clksel_reg;
 264         u32                     clksel_mask;
 265         const struct clksel     *clksel;
 266         struct dpll_data        *dpll_data;
 267         const char              *clkdm_name;
 268         struct clockdomain      *clkdm;
 269 #else
 270         u8                      rate_offset;
 271         u8                      src_offset;
 272 #endif
 273 #if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS)
 274         struct dentry           *dent;  /* For visible tree hierarchy */
 275 #endif
 276 };
 277
 278 struct cpufreq_frequency_table;
 279
 280 struct clk_functions {
 281         int             (*clk_enable)(struct clk *clk);
 282         void            (*clk_disable)(struct clk *clk);
 283         long            (*clk_round_rate)(struct clk *clk, unsigned long rate);
 284         int             (*clk_set_rate)(struct clk *clk, unsigned long rate);
 285         int             (*clk_set_parent)(struct clk *clk, struct clk *parent);
 286         void            (*clk_allow_idle)(struct clk *clk);
 287         void            (*clk_deny_idle)(struct clk *clk);
 288         void            (*clk_disable_unused)(struct clk *clk);
 289 #ifdef CONFIG_CPU_FREQ
 290         void            (*clk_init_cpufreq_table)(struct cpufreq_frequency_table **);
 291         void            (*clk_exit_cpufreq_table)(struct cpufreq_frequency_table **);
 292 #endif
 293 };
 294
 295 extern int mpurate;
 296
 297 extern int clk_init(struct clk_functions *custom_clocks);
 298 extern void clk_preinit(struct clk *clk);
 299 extern int clk_register(struct clk *clk);
 300 extern void clk_reparent(struct clk *child, struct clk *parent);
 301 extern void clk_unregister(struct clk *clk);
 302 extern void propagate_rate(struct clk *clk);
 303 extern void recalculate_root_clocks(void);
 304 extern unsigned long followparent_recalc(struct clk *clk);
 305 extern void clk_enable_init_clocks(void);
 306 unsigned long omap_fixed_divisor_recalc(struct clk *clk);
 307 #ifdef CONFIG_CPU_FREQ
 308 extern void clk_init_cpufreq_table(struct cpufreq_frequency_table **table);
 309 extern void clk_exit_cpufreq_table(struct cpufreq_frequency_table **table);
 310 #endif
 311 extern struct clk *omap_clk_get_by_name(const char *name);
 312 extern int omap_clk_enable_autoidle_all(void);
 313 extern int omap_clk_disable_autoidle_all(void);
 314
 315 extern const struct clkops clkops_null;
 316
 317 extern struct clk dummy_ck;
 318
 319 #endif