[mirror_ubuntu-bionic-kernel.git] / include / linux / sh_clk.h

#ifndef __SH_CLOCK_H
#define __SH_CLOCK_H

#include <linux/list.h>
#include <linux/seq_file.h>
#include <linux/cpufreq.h>
#include <linux/types.h>
#include <linux/kref.h>
#include <linux/clk.h>
#include <linux/err.h>

struct clk;

struct clk_mapping {
	phys_addr_t		phys;
	void __iomem		*base;
	unsigned long		len;
	struct kref		ref;
};


struct sh_clk_ops {
#ifdef CONFIG_SH_CLK_CPG_LEGACY
	void (*init)(struct clk *clk);
#endif
	int (*enable)(struct clk *clk);
	void (*disable)(struct clk *clk);
	unsigned long (*recalc)(struct clk *clk);
	int (*set_rate)(struct clk *clk, unsigned long rate);
	int (*set_parent)(struct clk *clk, struct clk *parent);
	long (*round_rate)(struct clk *clk, unsigned long rate);
};

struct clk {
	struct list_head	node;
	struct clk		*parent;
	struct clk		**parent_table;	/* list of parents to */
	unsigned short		parent_num;	/* choose between */
	unsigned char		src_shift;	/* source clock field in the */
	unsigned char		src_width;	/* configuration register */
	struct sh_clk_ops	*ops;

	struct list_head	children;
	struct list_head	sibling;	/* node for children */

	int			usecount;

	unsigned long		rate;
	unsigned long		flags;

	void __iomem		*enable_reg;
	unsigned int		enable_bit;
	void __iomem		*mapped_reg;

	unsigned long		arch_flags;
	void			*priv;
	struct clk_mapping	*mapping;
	struct cpufreq_frequency_table *freq_table;
	unsigned int		nr_freqs;
};

#define CLK_ENABLE_ON_INIT	(1 << 0)

/* drivers/sh/clk.c */
unsigned long followparent_recalc(struct clk *);
void recalculate_root_clocks(void);
void propagate_rate(struct clk *);
int clk_reparent(struct clk *child, struct clk *parent);
int clk_register(struct clk *);
void clk_unregister(struct clk *);
void clk_enable_init_clocks(void);

struct clk_div_mult_table {
	unsigned int *divisors;
	unsigned int nr_divisors;
	unsigned int *multipliers;
	unsigned int nr_multipliers;
};

struct cpufreq_frequency_table;
void clk_rate_table_build(struct clk *clk,
			  struct cpufreq_frequency_table *freq_table,
			  int nr_freqs,
			  struct clk_div_mult_table *src_table,
			  unsigned long *bitmap);

long clk_rate_table_round(struct clk *clk,
			  struct cpufreq_frequency_table *freq_table,
			  unsigned long rate);

int clk_rate_table_find(struct clk *clk,
			struct cpufreq_frequency_table *freq_table,
			unsigned long rate);

long clk_rate_div_range_round(struct clk *clk, unsigned int div_min,
			      unsigned int div_max, unsigned long rate);

long clk_rate_mult_range_round(struct clk *clk, unsigned int mult_min,
			       unsigned int mult_max, unsigned long rate);

long clk_round_parent(struct clk *clk, unsigned long target,
		      unsigned long *best_freq, unsigned long *parent_freq,
		      unsigned int div_min, unsigned int div_max);

#define SH_CLK_MSTP32(_parent, _enable_reg, _enable_bit, _flags)	\
{									\
	.parent		= _parent,					\
	.enable_reg	= (void __iomem *)_enable_reg,			\
	.enable_bit	= _enable_bit,					\
	.flags		= _flags,					\
}

int sh_clk_mstp32_register(struct clk *clks, int nr);

#define SH_CLK_DIV4(_parent, _reg, _shift, _div_bitmap, _flags)	\
{								\
	.parent = _parent,					\
	.enable_reg = (void __iomem *)_reg,			\
	.enable_bit = _shift,					\
	.arch_flags = _div_bitmap,				\
	.flags = _flags,					\
}

struct clk_div4_table {
	struct clk_div_mult_table *div_mult_table;
	void (*kick)(struct clk *clk);
};

int sh_clk_div4_register(struct clk *clks, int nr,
			 struct clk_div4_table *table);
int sh_clk_div4_enable_register(struct clk *clks, int nr,
			 struct clk_div4_table *table);
int sh_clk_div4_reparent_register(struct clk *clks, int nr,
			 struct clk_div4_table *table);

#define SH_CLK_DIV6_EXT(_reg, _flags, _parents,			\
			_num_parents, _src_shift, _src_width)	\
{								\
	.enable_reg = (void __iomem *)_reg,			\
	.flags = _flags,					\
	.parent_table = _parents,				\
	.parent_num = _num_parents,				\
	.src_shift = _src_shift,				\
	.src_width = _src_width,				\
}

#define SH_CLK_DIV6(_parent, _reg, _flags)			\
{								\
	.parent		= _parent,				\
	.enable_reg	= (void __iomem *)_reg,			\
	.flags		= _flags,				\
}

int sh_clk_div6_register(struct clk *clks, int nr);
int sh_clk_div6_reparent_register(struct clk *clks, int nr);

#define CLKDEV_CON_ID(_id, _clk) { .con_id = _id, .clk = _clk }
#define CLKDEV_DEV_ID(_id, _clk) { .dev_id = _id, .clk = _clk }
#define CLKDEV_ICK_ID(_cid, _did, _clk) { .con_id = _cid, .dev_id = _did, .clk = _clk }

#endif /* __SH_CLOCK_H */
Commit	Line	Data
d28bdf05 MD	1	#ifndef __SH_CLOCK_H
	2	#define __SH_CLOCK_H
	3
	4	#include <linux/list.h>
	5	#include <linux/seq_file.h>
	6	#include <linux/cpufreq.h>
28085bc5 PM	7	#include <linux/types.h>
28085bc5 PM	8	#include <linux/kref.h>
d28bdf05 MD	9	#include <linux/clk.h>
	10	#include <linux/err.h>
	11
	12	struct clk;
	13
28085bc5 PM	14	struct clk_mapping {
	15	phys_addr_t phys;
	16	void __iomem *base;
	17	unsigned long len;
	18	struct kref ref;
	19	};
	20
e3482829	21
84c36ffd	22	struct sh_clk_ops {
549015c3	23	#ifdef CONFIG_SH_CLK_CPG_LEGACY
d28bdf05	24	void (init)(struct clk clk);
549015c3	25	#endif
d28bdf05 MD	26	int (enable)(struct clk clk);
	27	void (disable)(struct clk clk);
	28	unsigned long (recalc)(struct clk clk);
35a96c73	29	int (set_rate)(struct clk clk, unsigned long rate);
d28bdf05 MD	30	int (set_parent)(struct clk clk, struct clk *parent);
	31	long (round_rate)(struct clk clk, unsigned long rate);
	32	};
	33
	34	struct clk {
	35	struct list_head node;
d28bdf05	36	struct clk *parent;
b5272b50 GL	37	struct clk *parent_table; / list of parents to */
	38	unsigned short parent_num; /* choose between */
	39	unsigned char src_shift; /* source clock field in the */
	40	unsigned char src_width; /* configuration register */
84c36ffd	41	struct sh_clk_ops *ops;
d28bdf05 MD	42
	43	struct list_head children;
	44	struct list_head sibling; /* node for children */
	45
	46	int usecount;
	47
	48	unsigned long rate;
	49	unsigned long flags;
	50
	51	void __iomem *enable_reg;
	52	unsigned int enable_bit;
eda2030a	53	void __iomem *mapped_reg;
d28bdf05 MD	54
	55	unsigned long arch_flags;
	56	void *priv;
28085bc5	57	struct clk_mapping *mapping;
d28bdf05	58	struct cpufreq_frequency_table *freq_table;
f586903d	59	unsigned int nr_freqs;
d28bdf05 MD	60	};
	61
	62	#define CLK_ENABLE_ON_INIT (1 << 0)
	63
a71ba096	64	/* drivers/sh/clk.c */
d28bdf05 MD	65	unsigned long followparent_recalc(struct clk *);
	66	void recalculate_root_clocks(void);
	67	void propagate_rate(struct clk *);
	68	int clk_reparent(struct clk child, struct clk parent);
	69	int clk_register(struct clk *);
	70	void clk_unregister(struct clk *);
8b5ee113	71	void clk_enable_init_clocks(void);
d28bdf05	72
d28bdf05 MD	73	struct clk_div_mult_table {
	74	unsigned int *divisors;
	75	unsigned int nr_divisors;
	76	unsigned int *multipliers;
	77	unsigned int nr_multipliers;
	78	};
	79
	80	struct cpufreq_frequency_table;
	81	void clk_rate_table_build(struct clk *clk,
	82	struct cpufreq_frequency_table *freq_table,
	83	int nr_freqs,
	84	struct clk_div_mult_table *src_table,
	85	unsigned long *bitmap);
	86
	87	long clk_rate_table_round(struct clk *clk,
	88	struct cpufreq_frequency_table *freq_table,
	89	unsigned long rate);
	90
	91	int clk_rate_table_find(struct clk *clk,
	92	struct cpufreq_frequency_table *freq_table,
	93	unsigned long rate);
	94
8e122db6 PM	95	long clk_rate_div_range_round(struct clk *clk, unsigned int div_min,
	96	unsigned int div_max, unsigned long rate);
	97
dd2c0ca1 KM	98	long clk_rate_mult_range_round(struct clk *clk, unsigned int mult_min,
	99	unsigned int mult_max, unsigned long rate);
	100
6af26c6c GL	101	long clk_round_parent(struct clk *clk, unsigned long target,
	102	unsigned long best_freq, unsigned long parent_freq,
	103	unsigned int div_min, unsigned int div_max);
	104
d28bdf05 MD	105	#define SH_CLK_MSTP32(_parent, _enable_reg, _enable_bit, _flags) \
	106	{ \
	107	.parent = _parent, \
	108	.enable_reg = (void __iomem *)_enable_reg, \
	109	.enable_bit = _enable_bit, \
	110	.flags = _flags, \
	111	}
	112
	113	int sh_clk_mstp32_register(struct clk *clks, int nr);
	114
	115	#define SH_CLK_DIV4(_parent, _reg, _shift, _div_bitmap, _flags) \
	116	{ \
	117	.parent = _parent, \
	118	.enable_reg = (void __iomem *)_reg, \
	119	.enable_bit = _shift, \
	120	.arch_flags = _div_bitmap, \
	121	.flags = _flags, \
	122	}
	123
	124	struct clk_div4_table {
	125	struct clk_div_mult_table *div_mult_table;
	126	void (kick)(struct clk clk);
	127	};
	128
	129	int sh_clk_div4_register(struct clk *clks, int nr,
	130	struct clk_div4_table *table);
	131	int sh_clk_div4_enable_register(struct clk *clks, int nr,
	132	struct clk_div4_table *table);
	133	int sh_clk_div4_reparent_register(struct clk *clks, int nr,
	134	struct clk_div4_table *table);
	135
56242a1f	136	#define SH_CLK_DIV6_EXT(_reg, _flags, _parents, \
b3dd51a8 GL	137	_num_parents, _src_shift, _src_width) \
b3dd51a8 GL	138	{ \
b3dd51a8 GL	139	.enable_reg = (void __iomem *)_reg, \
	140	.flags = _flags, \
	141	.parent_table = _parents, \
	142	.parent_num = _num_parents, \
	143	.src_shift = _src_shift, \
	144	.src_width = _src_width, \
d28bdf05 MD	145	}
d28bdf05 MD	146
b3dd51a8	147	#define SH_CLK_DIV6(_parent, _reg, _flags) \
56242a1f KM	148	{ \
	149	.parent = _parent, \
	150	.enable_reg = (void __iomem *)_reg, \
	151	.flags = _flags, \
	152	}
b3dd51a8	153
d28bdf05	154	int sh_clk_div6_register(struct clk *clks, int nr);
b3dd51a8	155	int sh_clk_div6_reparent_register(struct clk *clks, int nr);
d28bdf05	156
1522043b KM	157	#define CLKDEV_CON_ID(_id, _clk) { .con_id = _id, .clk = _clk }
	158	#define CLKDEV_DEV_ID(_id, _clk) { .dev_id = _id, .clk = _clk }
	159	#define CLKDEV_ICK_ID(_cid, _did, _clk) { .con_id = _cid, .dev_id = _did, .clk = _clk }
	160
d28bdf05	161	#endif /* __SH_CLOCK_H */