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 struct clkops {
  21         int                     (*enable)(struct clk *);
  22         void                    (*disable)(struct clk *);
  23 };
  24
  25 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
  26
  27 struct clksel_rate {
  28         u32                     val;
  29         u8                      div;
  30         u8                      flags;
  31 };
  32
  33 struct clksel {
  34         struct clk               *parent;
  35         const struct clksel_rate *rates;
  36 };
  37
  38 struct dpll_data {
  39         void __iomem            *mult_div1_reg;
  40         u32                     mult_mask;
  41         u32                     div1_mask;
  42         struct clk              *clk_bypass;
  43         struct clk              *clk_ref;
  44         void __iomem            *control_reg;
  45         u32                     enable_mask;
  46         unsigned int            rate_tolerance;
  47         unsigned long           last_rounded_rate;
  48         u16                     last_rounded_m;
  49         u8                      last_rounded_n;
  50         u8                      min_divider;
  51         u8                      max_divider;
  52         u32                     max_tolerance;
  53         u16                     max_multiplier;
  54 #  if defined(CONFIG_ARCH_OMAP3)
  55         u8                      modes;
  56         void __iomem            *autoidle_reg;
  57         void __iomem            *idlest_reg;
  58         u32                     autoidle_mask;
  59         u32                     freqsel_mask;
  60         u32                     idlest_mask;
  61         u8                      auto_recal_bit;
  62         u8                      recal_en_bit;
  63         u8                      recal_st_bit;
  64 #  endif
  65 };
  66
  67 #endif
  68
  69 struct clk {
  70         struct list_head        node;
  71         const struct clkops     *ops;
  72         const char              *name;
  73         int                     id;
  74         struct clk              *parent;
  75         struct list_head        children;
  76         struct list_head        sibling;        /* node for children */
  77         unsigned long           rate;
  78         __u32                   flags;
  79         void __iomem            *enable_reg;
  80         unsigned long           (*recalc)(struct clk *);
  81         int                     (*set_rate)(struct clk *, unsigned long);
  82         long                    (*round_rate)(struct clk *, unsigned long);
  83         void                    (*init)(struct clk *);
  84         __u8                    enable_bit;
  85         __s8                    usecount;
  86 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
  87         u8                      fixed_div;
  88         void __iomem            *clksel_reg;
  89         u32                     clksel_mask;
  90         const struct clksel     *clksel;
  91         struct dpll_data        *dpll_data;
  92         const char              *clkdm_name;
  93         struct clockdomain      *clkdm;
  94 #else
  95         __u8                    rate_offset;
  96         __u8                    src_offset;
  97 #endif
  98 #if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS)
  99         struct dentry           *dent;  /* For visible tree hierarchy */
 100 #endif
 101 };
 102
 103 struct cpufreq_frequency_table;
 104
 105 struct clk_functions {
 106         int             (*clk_enable)(struct clk *clk);
 107         void            (*clk_disable)(struct clk *clk);
 108         long            (*clk_round_rate)(struct clk *clk, unsigned long rate);
 109         int             (*clk_set_rate)(struct clk *clk, unsigned long rate);
 110         int             (*clk_set_parent)(struct clk *clk, struct clk *parent);
 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 void clk_init_one(struct clk *clk);
 123 extern int clk_register(struct clk *clk);
 124 extern void clk_reparent(struct clk *child, struct clk *parent);
 125 extern void clk_unregister(struct clk *clk);
 126 extern void propagate_rate(struct clk *clk);
 127 extern void recalculate_root_clocks(void);
 128 extern unsigned long followparent_recalc(struct clk *clk);
 129 extern void clk_enable_init_clocks(void);
 130 #ifdef CONFIG_CPU_FREQ
 131 extern void clk_init_cpufreq_table(struct cpufreq_frequency_table **table);
 132 #endif
 133
 134 extern const struct clkops clkops_null;
 135
 136 /* Clock flags */
 137 /* bit 0 is free */
 138 #define RATE_FIXED              (1 << 1)        /* Fixed clock rate */
 139 /* bits 2-4 are free */
 140 #define ENABLE_REG_32BIT        (1 << 5)        /* Use 32-bit access */
 141 #define CLOCK_IDLE_CONTROL      (1 << 7)
 142 #define CLOCK_NO_IDLE_PARENT    (1 << 8)
 143 #define DELAYED_APP             (1 << 9)        /* Delay application of clock */
 144 #define CONFIG_PARTICIPANT      (1 << 10)       /* Fundamental clock */
 145 #define ENABLE_ON_INIT          (1 << 11)       /* Enable upon framework init */
 146 #define INVERT_ENABLE           (1 << 12)       /* 0 enables, 1 disables */
 147 /* bits 13-31 are currently free */
 148
 149 /* Clksel_rate flags */
 150 #define DEFAULT_RATE            (1 << 0)
 151 #define RATE_IN_242X            (1 << 1)
 152 #define RATE_IN_243X            (1 << 2)
 153 #define RATE_IN_343X            (1 << 3)        /* rates common to all 343X */
 154 #define RATE_IN_3430ES2         (1 << 4)        /* 3430ES2 rates only */
 155
 156 #define RATE_IN_24XX            (RATE_IN_242X | RATE_IN_243X)
 157
 158
 159 #endif