[linux-2.6-block.git] / arch / arm / plat-omap / include / mach / clock.h

/*
 *  arch/arm/plat-omap/include/mach/clock.h
 *
 *  Copyright (C) 2004 - 2005 Nokia corporation
 *  Written by Tuukka Tikkanen <tuukka.tikkanen@elektrobit.com>
 *  Based on clocks.h by Tony Lindgren, Gordon McNutt and RidgeRun, Inc
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef __ARCH_ARM_OMAP_CLOCK_H
#define __ARCH_ARM_OMAP_CLOCK_H

struct module;
struct clk;
struct clockdomain;

struct clkops {
	int			(*enable)(struct clk *);
	void			(*disable)(struct clk *);
	void			(*find_idlest)(struct clk *, void __iomem **, u8 *);
	void			(*find_companion)(struct clk *, void __iomem **, u8 *);
};

#if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3) || \
		defined(CONFIG_ARCH_OMAP4)

struct clksel_rate {
	u32			val;
	u8			div;
	u8			flags;
};

struct clksel {
	struct clk		 *parent;
	const struct clksel_rate *rates;
};

struct dpll_data {
	void __iomem		*mult_div1_reg;
	u32			mult_mask;
	u32			div1_mask;
	struct clk		*clk_bypass;
	struct clk		*clk_ref;
	void __iomem		*control_reg;
	u32			enable_mask;
	unsigned int		rate_tolerance;
	unsigned long		last_rounded_rate;
	u16			last_rounded_m;
	u8			last_rounded_n;
	u8			min_divider;
	u8			max_divider;
	u32			max_tolerance;
	u16			max_multiplier;
#if defined(CONFIG_ARCH_OMAP3) || defined(CONFIG_ARCH_OMAP4)
	u8			modes;
	void __iomem		*autoidle_reg;
	void __iomem		*idlest_reg;
	u32			autoidle_mask;
	u32			freqsel_mask;
	u32			idlest_mask;
	u8			auto_recal_bit;
	u8			recal_en_bit;
	u8			recal_st_bit;
#  endif
};

#endif

struct clk {
	struct list_head	node;
	const struct clkops	*ops;
	const char		*name;
	int			id;
	struct clk		*parent;
	struct list_head	children;
	struct list_head	sibling;	/* node for children */
	unsigned long		rate;
	__u32			flags;
	void __iomem		*enable_reg;
	unsigned long		(*recalc)(struct clk *);
	int			(*set_rate)(struct clk *, unsigned long);
	long			(*round_rate)(struct clk *, unsigned long);
	void			(*init)(struct clk *);
	__u8			enable_bit;
	__s8			usecount;
#if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3) || \
		defined(CONFIG_ARCH_OMAP4)
	u8			fixed_div;
	void __iomem		*clksel_reg;
	u32			clksel_mask;
	const struct clksel	*clksel;
	struct dpll_data	*dpll_data;
	const char		*clkdm_name;
	struct clockdomain	*clkdm;
#else
	__u8			rate_offset;
	__u8			src_offset;
#endif
#if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS)
	struct dentry		*dent;	/* For visible tree hierarchy */
#endif
};

struct cpufreq_frequency_table;

struct clk_functions {
	int		(*clk_enable)(struct clk *clk);
	void		(*clk_disable)(struct clk *clk);
	long		(*clk_round_rate)(struct clk *clk, unsigned long rate);
	int		(*clk_set_rate)(struct clk *clk, unsigned long rate);
	int		(*clk_set_parent)(struct clk *clk, struct clk *parent);
	void		(*clk_allow_idle)(struct clk *clk);
	void		(*clk_deny_idle)(struct clk *clk);
	void		(*clk_disable_unused)(struct clk *clk);
#ifdef CONFIG_CPU_FREQ
	void		(*clk_init_cpufreq_table)(struct cpufreq_frequency_table **);
#endif
};

extern unsigned int mpurate;

extern int clk_init(struct clk_functions *custom_clocks);
extern void clk_preinit(struct clk *clk);
extern int clk_register(struct clk *clk);
extern void clk_reparent(struct clk *child, struct clk *parent);
extern void clk_unregister(struct clk *clk);
extern void propagate_rate(struct clk *clk);
extern void recalculate_root_clocks(void);
extern unsigned long followparent_recalc(struct clk *clk);
extern void clk_enable_init_clocks(void);
#ifdef CONFIG_CPU_FREQ
extern void clk_init_cpufreq_table(struct cpufreq_frequency_table **table);
#endif

extern const struct clkops clkops_null;

/* Clock flags */
/* bit 0 is free */
#define RATE_FIXED		(1 << 1)	/* Fixed clock rate */
/* bits 2-4 are free */
#define ENABLE_REG_32BIT	(1 << 5)	/* Use 32-bit access */
#define CLOCK_IDLE_CONTROL	(1 << 7)
#define CLOCK_NO_IDLE_PARENT	(1 << 8)
#define DELAYED_APP		(1 << 9)	/* Delay application of clock */
#define CONFIG_PARTICIPANT	(1 << 10)	/* Fundamental clock */
#define ENABLE_ON_INIT		(1 << 11)	/* Enable upon framework init */
#define INVERT_ENABLE           (1 << 12)       /* 0 enables, 1 disables */
/* bits 13-31 are currently free */

/* Clksel_rate flags */
#define DEFAULT_RATE		(1 << 0)
#define RATE_IN_242X		(1 << 1)
#define RATE_IN_243X		(1 << 2)
#define RATE_IN_343X		(1 << 3)	/* rates common to all 343X */
#define RATE_IN_3430ES2		(1 << 4)	/* 3430ES2 rates only */

#define RATE_IN_24XX		(RATE_IN_242X | RATE_IN_243X)


#endif
Commit	Line	Data
9ad5897c	1	/*
a09e64fb	2	* arch/arm/plat-omap/include/mach/clock.h
9ad5897c TL	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;
6b8858a9	17	struct clk;
d1b03f61	18	struct clockdomain;
6b8858a9	19
548d8495 RK	20	struct clkops {
	21	int (enable)(struct clk );
	22	void (disable)(struct clk );
72350b29 PW	23	void (find_idlest)(struct clk , void __iomem *, u8 );
72350b29 PW	24	void (find_companion)(struct clk , void __iomem *, u8 );
548d8495 RK	25	};
548d8495 RK	26
44169075 SS	27	#if defined(CONFIG_ARCH_OMAP2) \|\| defined(CONFIG_ARCH_OMAP3) \|\| \
44169075 SS	28	defined(CONFIG_ARCH_OMAP4)
6b8858a9 PW	29
6b8858a9 PW	30	struct clksel_rate {
6b8858a9	31	u32 val;
ebb8dca2	32	u8 div;
6b8858a9 PW	33	u8 flags;
	34	};
	35
	36	struct clksel {
	37	struct clk *parent;
	38	const struct clksel_rate *rates;
	39	};
	40
	41	struct dpll_data {
	42	void __iomem *mult_div1_reg;
	43	u32 mult_mask;
	44	u32 div1_mask;
c0bf3132 RK	45	struct clk *clk_bypass;
	46	struct clk *clk_ref;
	47	void __iomem *control_reg;
	48	u32 enable_mask;
ebb8dca2 RK	49	unsigned int rate_tolerance;
ebb8dca2 RK	50	unsigned long last_rounded_rate;
88b8ba90 PW	51	u16 last_rounded_m;
88b8ba90 PW	52	u8 last_rounded_n;
95f538ac	53	u8 min_divider;
88b8ba90 PW	54	u8 max_divider;
88b8ba90 PW	55	u32 max_tolerance;
ebb8dca2	56	u16 max_multiplier;
44169075	57	#if defined(CONFIG_ARCH_OMAP3) \|\| defined(CONFIG_ARCH_OMAP4)
542313cc	58	u8 modes;
ebb8dca2 RK	59	void __iomem *autoidle_reg;
ebb8dca2 RK	60	void __iomem *idlest_reg;
ebb8dca2	61	u32 autoidle_mask;
16c90f02	62	u32 freqsel_mask;
c1bd7aaf	63	u32 idlest_mask;
b045d080 PW	64	u8 auto_recal_bit;
	65	u8 recal_en_bit;
	66	u8 recal_st_bit;
	67	# endif
6b8858a9 PW	68	};
	69
	70	#endif
9ad5897c TL	71
	72	struct clk {
	73	struct list_head node;
548d8495	74	const struct clkops *ops;
9ad5897c	75	const char *name;
b824efae	76	int id;
9ad5897c	77	struct clk *parent;
3f0a820c RK	78	struct list_head children;
3f0a820c RK	79	struct list_head sibling; /* node for children */
9ad5897c TL	80	unsigned long rate;
	81	__u32 flags;
	82	void __iomem *enable_reg;
8b9dbc16	83	unsigned long (recalc)(struct clk );
9ad5897c TL	84	int (set_rate)(struct clk , unsigned long);
	85	long (round_rate)(struct clk , unsigned long);
	86	void (init)(struct clk );
ebb8dca2 RK	87	__u8 enable_bit;
ebb8dca2 RK	88	__s8 usecount;
44169075 SS	89	#if defined(CONFIG_ARCH_OMAP2) \|\| defined(CONFIG_ARCH_OMAP3) \|\| \
44169075 SS	90	defined(CONFIG_ARCH_OMAP4)
6b8858a9 PW	91	u8 fixed_div;
	92	void __iomem *clksel_reg;
	93	u32 clksel_mask;
	94	const struct clksel *clksel;
88b8ba90	95	struct dpll_data *dpll_data;
d1b03f61 PW	96	const char *clkdm_name;
d1b03f61 PW	97	struct clockdomain *clkdm;
6b8858a9 PW	98	#else
	99	__u8 rate_offset;
	100	__u8 src_offset;
	101	#endif
137b3ee2 HD	102	#if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS)
	103	struct dentry dent; / For visible tree hierarchy */
	104	#endif
9ad5897c TL	105	};
9ad5897c TL	106
b851cb28 RK	107	struct cpufreq_frequency_table;
b851cb28 RK	108
9ad5897c TL	109	struct clk_functions {
	110	int (clk_enable)(struct clk clk);
	111	void (clk_disable)(struct clk clk);
9ad5897c TL	112	long (clk_round_rate)(struct clk clk, unsigned long rate);
	113	int (clk_set_rate)(struct clk clk, unsigned long rate);
	114	int (clk_set_parent)(struct clk clk, struct clk *parent);
9ad5897c TL	115	void (clk_allow_idle)(struct clk clk);
9ad5897c TL	116	void (clk_deny_idle)(struct clk clk);
90afd5cb	117	void (clk_disable_unused)(struct clk clk);
b851cb28 RK	118	#ifdef CONFIG_CPU_FREQ
	119	void (clk_init_cpufreq_table)(struct cpufreq_frequency_table *);
	120	#endif
9ad5897c TL	121	};
	122
	123	extern unsigned int mpurate;
9ad5897c	124
fecb494b	125	extern int clk_init(struct clk_functions *custom_clocks);
79716870	126	extern void clk_preinit(struct clk *clk);
9ad5897c	127	extern int clk_register(struct clk *clk);
3f0a820c	128	extern void clk_reparent(struct clk child, struct clk parent);
9ad5897c TL	129	extern void clk_unregister(struct clk *clk);
9ad5897c TL	130	extern void propagate_rate(struct clk *clk);
6b8858a9	131	extern void recalculate_root_clocks(void);
8b9dbc16	132	extern unsigned long followparent_recalc(struct clk *clk);
6b8858a9	133	extern void clk_enable_init_clocks(void);
aeec2990 KH	134	#ifdef CONFIG_CPU_FREQ
	135	extern void clk_init_cpufreq_table(struct cpufreq_frequency_table **table);
	136	#endif
9ad5897c	137
897dcded RK	138	extern const struct clkops clkops_null;
897dcded RK	139
9ad5897c	140	/* Clock flags */
d5e6072b	141	/* bit 0 is free */
9ad5897c	142	#define RATE_FIXED (1 << 1) /* Fixed clock rate */
3f0a820c	143	/* bits 2-4 are free */
9ad5897c	144	#define ENABLE_REG_32BIT (1 << 5) /* Use 32-bit access */
9ad5897c TL	145	#define CLOCK_IDLE_CONTROL (1 << 7)
	146	#define CLOCK_NO_IDLE_PARENT (1 << 8)
	147	#define DELAYED_APP (1 << 9) /* Delay application of clock */
	148	#define CONFIG_PARTICIPANT (1 << 10) /* Fundamental clock */
6b8858a9 PW	149	#define ENABLE_ON_INIT (1 << 11) /* Enable upon framework init */
6b8858a9 PW	150	#define INVERT_ENABLE (1 << 12) /* 0 enables, 1 disables */
44dc9d02	151	/* bits 13-31 are currently free */
6b8858a9 PW	152
	153	/* Clksel_rate flags */
	154	#define DEFAULT_RATE (1 << 0)
	155	#define RATE_IN_242X (1 << 1)
	156	#define RATE_IN_243X (1 << 2)
	157	#define RATE_IN_343X (1 << 3) /* rates common to all 343X */
	158	#define RATE_IN_3430ES2 (1 << 4) /* 3430ES2 rates only */
	159
	160	#define RATE_IN_24XX (RATE_IN_242X \| RATE_IN_243X)
	161
9ad5897c TL	162
9ad5897c TL	163	#endif