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 /**
  64  * struct clk_child - used to track the children of a clock
  65  * @clk: child struct clk *
  66  * @node: list_head
  67  * @flags: is this entry allocated in bootmem or slab?  is it deleted?
  68  *
  69  * One struct clk_child is allocated for each child clock @clk of a
  70  * parent clock.  @flags values are listed below and start with CLK_CHILD_*.
  71  */
  72 struct clk_child {
  73         struct clk              *clk;
  74         struct list_head        node;
  75         u8                      flags;
  76 };
  77
  78 struct clk {
  79         struct list_head        node;
  80         struct module           *owner;
  81         const char              *name;
  82         int                     id;
  83         struct clk              *parent;
  84         unsigned long           rate;
  85         unsigned long           temp_rate;
  86         struct list_head        children;
  87         __u32                   flags;
  88         u32                     enable_reg;
  89         __u8                    enable_bit;
  90         __s8                    usecount;
  91         u8                      idlest_bit;
  92         void                    (*recalc)(struct clk *, unsigned long, u8);
  93         int                     (*set_rate)(struct clk *, unsigned long);
  94         long                    (*round_rate)(struct clk *, unsigned long);
  95         void                    (*init)(struct clk *);
  96         int                     (*enable)(struct clk *);
  97         void                    (*disable)(struct clk *);
  98 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
  99         u8                      fixed_div;
 100         u16                     clksel_reg;
 101         u32                     clksel_mask;
 102         const struct clksel     *clksel;
 103         struct dpll_data        *dpll_data;
 104         union {
 105                 const char              *name;
 106                 struct clockdomain      *ptr;
 107         } clkdm;
 108         s16                     prcm_mod;
 109 #else
 110         __u8                    rate_offset;
 111         __u8                    src_offset;
 112 #endif
 113 #if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS)
 114         struct dentry           *dent;  /* For visible tree hierarchy */
 115 #endif
 116 };
 117
 118 struct cpufreq_frequency_table;
 119
 120 struct clk_functions {
 121         int             (*clk_enable)(struct clk *clk);
 122         void            (*clk_disable)(struct clk *clk);
 123         long            (*clk_round_rate)(struct clk *clk, unsigned long rate);
 124         int             (*clk_set_rate)(struct clk *clk, unsigned long rate);
 125         int             (*clk_set_parent)(struct clk *clk, struct clk *parent);
 126         struct clk *    (*clk_get_parent)(struct clk *clk);
 127         void            (*clk_allow_idle)(struct clk *clk);
 128         void            (*clk_deny_idle)(struct clk *clk);
 129         void            (*clk_disable_unused)(struct clk *clk);
 130 #ifdef CONFIG_CPU_FREQ
 131         void            (*clk_init_cpufreq_table)(struct cpufreq_frequency_table **);
 132 #endif
 133 };
 134
 135 extern unsigned int mpurate;
 136
 137 extern int clk_init(struct clk_functions *custom_clocks);
 138 extern int clk_register(struct clk *clk);
 139 extern void clk_unregister(struct clk *clk);
 140 extern void propagate_rate(struct clk *clk, u8 rate_storage);
 141 extern void recalculate_root_clocks(void);
 142 extern void followparent_recalc(struct clk *clk, unsigned long parent_rate,
 143                                 u8 rate_storage);
 144 extern void clk_allow_idle(struct clk *clk);
 145 extern void clk_deny_idle(struct clk *clk);
 146 extern int clk_get_usecount(struct clk *clk);
 147 extern void clk_enable_init_clocks(void);
 148 #ifdef CONFIG_CPU_FREQ
 149 extern void clk_init_cpufreq_table(struct cpufreq_frequency_table **table);
 150 #endif
 151 void omap_clk_add_child(struct clk *clk, struct clk *clk2);
 152 void omap_clk_del_child(struct clk *clk, struct clk *clk2);
 153
 154 /* Clock flags */
 155 #define RATE_CKCTL              (1 << 0)        /* Main fixed ratio clocks */
 156 #define RATE_FIXED              (1 << 1)        /* Fixed clock rate */
 157
 158 #define VIRTUAL_CLOCK           (1 << 3)        /* Composite clock from table */
 159 #define ALWAYS_ENABLED          (1 << 4)        /* Clock cannot be disabled */
 160 #define ENABLE_REG_32BIT        (1 << 5)        /* Use 32-bit access */
 161
 162 #define CLOCK_IDLE_CONTROL      (1 << 7)
 163 #define CLOCK_NO_IDLE_PARENT    (1 << 8)
 164 #define DELAYED_APP             (1 << 9)        /* Delay application of clock */
 165 #define CONFIG_PARTICIPANT      (1 << 10)       /* Fundamental clock */
 166 #define ENABLE_ON_INIT          (1 << 11)       /* Enable upon framework init */
 167 #define INVERT_ENABLE           (1 << 12)       /* 0 enables, 1 disables */
 168 #define WAIT_READY              (1 << 13)       /* wait for dev to leave idle */
 169 #define RECALC_ON_ENABLE        (1 << 14)       /* recalc/prop on ena/disa */
 170 /* bits 15-20 are currently free */
 171 #define CLOCK_IN_OMAP310        (1 << 21)
 172 #define CLOCK_IN_OMAP730        (1 << 22)
 173 #define CLOCK_IN_OMAP1510       (1 << 23)
 174 #define CLOCK_IN_OMAP16XX       (1 << 24)
 175 #define CLOCK_IN_OMAP242X       (1 << 25)
 176 #define CLOCK_IN_OMAP243X       (1 << 26)
 177 #define CLOCK_IN_OMAP343X       (1 << 27)       /* clocks common to all 343X */
 178 #define PARENT_CONTROLS_CLOCK   (1 << 28)
 179 #define CLOCK_IN_OMAP3430ES1    (1 << 29)       /* 3430ES1 clocks only */
 180 #define CLOCK_IN_OMAP3430ES2    (1 << 30)       /* 3430ES2+ clocks only */
 181
 182 /* Clksel_rate flags */
 183 #define DEFAULT_RATE            (1 << 0)
 184 #define RATE_IN_242X            (1 << 1)
 185 #define RATE_IN_243X            (1 << 2)
 186 #define RATE_IN_343X            (1 << 3)        /* rates common to all 343X */
 187 #define RATE_IN_3430ES2         (1 << 4)        /* 3430ES2+ rates only */
 188
 189 #define RATE_IN_24XX            (RATE_IN_242X | RATE_IN_243X)
 190
 191 /* rate_storage parameter flags */
 192 #define CURRENT_RATE            0
 193 #define TEMP_RATE               1
 194
 195 /* clk_child flags */
 196 #define CLK_CHILD_SLAB_ALLOC    (1 << 0)        /* if !set, bootmem was used */
 197 #define CLK_CHILD_DELETED       (1 << 1)        /* can be reused */
 198
 199 /*
 200  * clk.prcm_mod flags (possible since only the top byte in clk.prcm_mod
 201  * is significant)
 202  */
 203 #define PRCM_MOD_ADDR_MASK      0xff00
 204 #define CLK_REG_IN_PRM          (1 << 0)
 205 #define CLK_REG_IN_SCM          (1 << 1)
 206
 207 #endif