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

   1 /*
   2  *  linux/include/asm-arm/arch-omap/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 #include <linux/cpufreq.h>
  14
  15 #ifndef __ARCH_ARM_OMAP_CLOCK_H
  16 #define __ARCH_ARM_OMAP_CLOCK_H
  17
  18 struct module;
  19 struct clk;
  20
  21 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
  22
  23 struct clksel_rate {
  24         u8                      div;
  25         u32                     val;
  26         u8                      flags;
  27 };
  28
  29 struct clksel {
  30         struct clk               *parent;
  31         const struct clksel_rate *rates;
  32 };
  33
  34 struct dpll_data {
  35         void __iomem            *mult_div1_reg;
  36         u32                     mult_mask;
  37         u32                     div1_mask;
  38         void __iomem            *div2_reg;
  39         u32                     div2_mask;
  40 #  if defined(CONFIG_ARCH_OMAP3)
  41         void __iomem            *control_reg;
  42         u32                     enable_mask;
  43         u8                      auto_recal_bit;
  44         u8                      recal_en_bit;
  45         u8                      recal_st_bit;
  46 #  endif
  47 };
  48
  49 #endif
  50
  51 struct clk {
  52         struct list_head        node;
  53         struct module           *owner;
  54         const char              *name;
  55         int                     id;
  56         struct clk              *parent;
  57         unsigned long           rate;
  58         __u32                   flags;
  59         void __iomem            *enable_reg;
  60         __u8                    enable_bit;
  61         __s8                    usecount;
  62         void                    (*recalc)(struct clk *);
  63         int                     (*set_rate)(struct clk *, unsigned long);
  64         long                    (*round_rate)(struct clk *, unsigned long);
  65         void                    (*init)(struct clk *);
  66         int                     (*enable)(struct clk *);
  67         void                    (*disable)(struct clk *);
  68 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
  69         u8                      fixed_div;
  70         void __iomem            *clksel_reg;
  71         u32                     clksel_mask;
  72         const struct clksel     *clksel;
  73         const struct dpll_data  *dpll_data;
  74 #else
  75         __u8                    rate_offset;
  76         __u8                    src_offset;
  77 #endif
  78 };
  79
  80 struct clk_functions {
  81         int             (*clk_enable)(struct clk *clk);
  82         void            (*clk_disable)(struct clk *clk);
  83         long            (*clk_round_rate)(struct clk *clk, unsigned long rate);
  84         int             (*clk_set_rate)(struct clk *clk, unsigned long rate);
  85         int             (*clk_set_parent)(struct clk *clk, struct clk *parent);
  86         struct clk *    (*clk_get_parent)(struct clk *clk);
  87         void            (*clk_allow_idle)(struct clk *clk);
  88         void            (*clk_deny_idle)(struct clk *clk);
  89         void            (*clk_disable_unused)(struct clk *clk);
  90 #ifdef  CONFIG_CPU_FREQ
  91         void            (*clk_init_cpufreq_table)(struct cpufreq_frequency_table **table);
  92 #endif
  93 };
  94
  95 extern unsigned int mpurate;
  96
  97 extern int clk_init(struct clk_functions * custom_clocks);
  98 extern int clk_register(struct clk *clk);
  99 extern void clk_unregister(struct clk *clk);
 100 extern void propagate_rate(struct clk *clk);
 101 extern void recalculate_root_clocks(void);
 102 extern void followparent_recalc(struct clk * clk);
 103 extern void clk_allow_idle(struct clk *clk);
 104 extern void clk_deny_idle(struct clk *clk);
 105 extern int clk_get_usecount(struct clk *clk);
 106 extern void clk_enable_init_clocks(void);
 107 #ifdef CONFIG_CPU_FREQ
 108 extern void clk_init_cpufreq_table(struct cpufreq_frequency_table **table);
 109 #endif
 110
 111 /* Clock flags */
 112 #define RATE_CKCTL              (1 << 0)        /* Main fixed ratio clocks */
 113 #define RATE_FIXED              (1 << 1)        /* Fixed clock rate */
 114 #define RATE_PROPAGATES         (1 << 2)        /* Program children too */
 115 #define VIRTUAL_CLOCK           (1 << 3)        /* Composite clock from table */
 116 #define ALWAYS_ENABLED          (1 << 4)        /* Clock cannot be disabled */
 117 #define ENABLE_REG_32BIT        (1 << 5)        /* Use 32-bit access */
 118 #define VIRTUAL_IO_ADDRESS      (1 << 6)        /* Clock in virtual address */
 119 #define CLOCK_IDLE_CONTROL      (1 << 7)
 120 #define CLOCK_NO_IDLE_PARENT    (1 << 8)
 121 #define DELAYED_APP             (1 << 9)        /* Delay application of clock */
 122 #define CONFIG_PARTICIPANT      (1 << 10)       /* Fundamental clock */
 123 #define ENABLE_ON_INIT          (1 << 11)       /* Enable upon framework init */
 124 #define INVERT_ENABLE           (1 << 12)       /* 0 enables, 1 disables */
 125 /* bits 13-20 are currently free */
 126 #define CLOCK_IN_OMAP310        (1 << 21)
 127 #define CLOCK_IN_OMAP730        (1 << 22)
 128 #define CLOCK_IN_OMAP1510       (1 << 23)
 129 #define CLOCK_IN_OMAP16XX       (1 << 24)
 130 #define CLOCK_IN_OMAP242X       (1 << 25)
 131 #define CLOCK_IN_OMAP243X       (1 << 26)
 132 #define CLOCK_IN_OMAP343X       (1 << 27)
 133 #define PARENT_CONTROLS_CLOCK   (1 << 28)
 134
 135 /* Clksel_rate flags */
 136 #define DEFAULT_RATE            (1 << 0)
 137 #define RATE_IN_242X            (1 << 1)
 138 #define RATE_IN_243X            (1 << 2)
 139 #define RATE_IN_343X            (1 << 3)
 140 #define RATE_IN_24XX            (RATE_IN_242X | RATE_IN_243X)
 141
 142
 143 /* CM_CLKSEL2_PLL.CORE_CLK_SRC options (24XX) */
 144 #define CORE_CLK_SRC_32K                0
 145 #define CORE_CLK_SRC_DPLL               1
 146 #define CORE_CLK_SRC_DPLL_X2            2
 147
 148 #endif