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

   1 /*
   2  *  arch/arm/plat-omap/include/mach/clock.h
   3  *
   4  *  Copyright (C) 2004 - 2005 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 struct module;
  17 struct clk;
  18 struct clockdomain;
  19
  20 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
  21
  22 struct clksel_rate {
  23         u8                      div;
  24         u32                     val;
  25         u8                      flags;
  26 };
  27
  28 struct clksel {
  29         struct clk               *parent;
  30         const struct clksel_rate *rates;
  31 };
  32
  33 struct dpll_data {
  34         u16                     mult_div1_reg;
  35         u32                     mult_mask;
  36         u32                     div1_mask;
  37         u16                     last_rounded_m;
  38         u8                      last_rounded_n;
  39         unsigned long           last_rounded_rate;
  40         unsigned int            rate_tolerance;
  41         u16                     max_multiplier;
  42         u8                      min_divider;
  43         u8                      max_divider;
  44         u32                     max_tolerance;
  45         struct clk              *bypass_clk;
  46         u16                     control_reg;
  47         u32                     enable_mask;
  48 #  if defined(CONFIG_ARCH_OMAP3)
  49         u16                     idlest_reg;
  50         u32                     idlest_mask;
  51         u32                     freqsel_mask;
  52         u8                      modes;
  53         u8                      auto_recal_bit;
  54         u8                      recal_en_bit;
  55         u8                      recal_st_bit;
  56         u16                     autoidle_reg;
  57         u32                     autoidle_mask;
  58 #  endif
  59 };
  60
  61 #endif
  62
  63 struct clk {
  64         struct list_head        node;
  65         struct module           *owner;
  66         const char              *name;
  67         int                     id;
  68         struct clk              *parent;
  69         unsigned long           rate;
  70         unsigned long           temp_rate;
  71         __u32                   flags;
  72         u32                     enable_reg;
  73         __u8                    enable_bit;
  74         __s8                    usecount;
  75         u8                      idlest_bit;
  76         void                    (*recalc)(struct clk *, unsigned long, u8);
  77         int                     (*set_rate)(struct clk *, unsigned long);
  78         long                    (*round_rate)(struct clk *, unsigned long);
  79         void                    (*init)(struct clk *);
  80         int                     (*enable)(struct clk *);
  81         void                    (*disable)(struct clk *);
  82 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
  83         u8                      fixed_div;
  84         u16                     clksel_reg;
  85         u32                     clksel_mask;
  86         const struct clksel     *clksel;
  87         struct dpll_data        *dpll_data;
  88         union {
  89                 const char              *name;
  90                 struct clockdomain      *ptr;
  91         } clkdm;
  92         s16                     prcm_mod;
  93 #else
  94         __u8                    rate_offset;
  95         __u8                    src_offset;
  96 #endif
  97 #if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS)
  98         struct dentry           *dent;  /* For visible tree hierarchy */
  99 #endif
 100 };
 101
 102 struct cpufreq_frequency_table;
 103
 104 struct clk_functions {
 105         int             (*clk_enable)(struct clk *clk);
 106         void            (*clk_disable)(struct clk *clk);
 107         long            (*clk_round_rate)(struct clk *clk, unsigned long rate);
 108         int             (*clk_set_rate)(struct clk *clk, unsigned long rate);
 109         int             (*clk_set_parent)(struct clk *clk, struct clk *parent);
 110         struct clk *    (*clk_get_parent)(struct clk *clk);
 111         void            (*clk_allow_idle)(struct clk *clk);
 112         void            (*clk_deny_idle)(struct clk *clk);
 113         void            (*clk_disable_unused)(struct clk *clk);
 114 #ifdef CONFIG_CPU_FREQ
 115         void            (*clk_init_cpufreq_table)(struct cpufreq_frequency_table **);
 116 #endif
 117 };
 118
 119 extern unsigned int mpurate;
 120
 121 extern int clk_init(struct clk_functions *custom_clocks);
 122 extern int clk_register(struct clk *clk);
 123 extern void clk_unregister(struct clk *clk);
 124 extern void propagate_rate(struct clk *clk, u8 rate_storage);
 125 extern void recalculate_root_clocks(void);
 126 extern void followparent_recalc(struct clk *clk, unsigned long parent_rate,
 127                                 u8 rate_storage);
 128 extern void clk_allow_idle(struct clk *clk);
 129 extern void clk_deny_idle(struct clk *clk);
 130 extern int clk_get_usecount(struct clk *clk);
 131 extern void clk_enable_init_clocks(void);
 132 #ifdef CONFIG_CPU_FREQ
 133 extern void clk_init_cpufreq_table(struct cpufreq_frequency_table **table);
 134 #endif
 135
 136 /* Clock flags */
 137 #define RATE_CKCTL              (1 << 0)        /* Main fixed ratio clocks */
 138 #define RATE_FIXED              (1 << 1)        /* Fixed clock rate */
 139 #define RATE_PROPAGATES         (1 << 2)        /* Program children too */
 140 #define VIRTUAL_CLOCK           (1 << 3)        /* Composite clock from table */
 141 #define ALWAYS_ENABLED          (1 << 4)        /* Clock cannot be disabled */
 142 #define ENABLE_REG_32BIT        (1 << 5)        /* Use 32-bit access */
 143
 144 #define CLOCK_IDLE_CONTROL      (1 << 7)
 145 #define CLOCK_NO_IDLE_PARENT    (1 << 8)
 146 #define DELAYED_APP             (1 << 9)        /* Delay application of clock */
 147 #define CONFIG_PARTICIPANT      (1 << 10)       /* Fundamental clock */
 148 #define ENABLE_ON_INIT          (1 << 11)       /* Enable upon framework init */
 149 #define INVERT_ENABLE           (1 << 12)       /* 0 enables, 1 disables */
 150 #define WAIT_READY              (1 << 13)       /* wait for dev to leave idle */
 151 #define RECALC_ON_ENABLE        (1 << 14)       /* recalc/prop on ena/disa */
 152 /* bits 15-20 are currently free */
 153 #define CLOCK_IN_OMAP310        (1 << 21)
 154 #define CLOCK_IN_OMAP730        (1 << 22)
 155 #define CLOCK_IN_OMAP1510       (1 << 23)
 156 #define CLOCK_IN_OMAP16XX       (1 << 24)
 157 #define CLOCK_IN_OMAP242X       (1 << 25)
 158 #define CLOCK_IN_OMAP243X       (1 << 26)
 159 #define CLOCK_IN_OMAP343X       (1 << 27)       /* clocks common to all 343X */
 160 #define PARENT_CONTROLS_CLOCK   (1 << 28)
 161 #define CLOCK_IN_OMAP3430ES1    (1 << 29)       /* 3430ES1 clocks only */
 162 #define CLOCK_IN_OMAP3430ES2    (1 << 30)       /* 3430ES2+ clocks only */
 163
 164 /* Clksel_rate flags */
 165 #define DEFAULT_RATE            (1 << 0)
 166 #define RATE_IN_242X            (1 << 1)
 167 #define RATE_IN_243X            (1 << 2)
 168 #define RATE_IN_343X            (1 << 3)        /* rates common to all 343X */
 169 #define RATE_IN_3430ES2         (1 << 4)        /* 3430ES2+ rates only */
 170
 171 #define RATE_IN_24XX            (RATE_IN_242X | RATE_IN_243X)
 172
 173 /* rate_storage parameter flags */
 174 #define CURRENT_RATE            0
 175 #define TEMP_RATE               1
 176
 177 /*
 178  * clk.prcm_mod flags (possible since only the top byte in clk.prcm_mod
 179  * is significant)
 180  */
 181 #define PRCM_MOD_ADDR_MASK      0xff00
 182 #define CLK_REG_IN_PRM          (1 << 0)
 183 #define CLK_REG_IN_SCM          (1 << 1)
 184
 185 #endif