[deliverable/linux.git] / drivers / clk / clk-mux.c

/*
 * Copyright (C) 2011 Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>
 * Copyright (C) 2011 Richard Zhao, Linaro <richard.zhao@linaro.org>
 * Copyright (C) 2011-2012 Mike Turquette, Linaro Ltd <mturquette@linaro.org>
 *
 * 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.
 *
 * Simple multiplexer clock implementation
 */

#include <linux/clk-provider.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/io.h>
#include <linux/err.h>

/*
 * DOC: basic adjustable multiplexer clock that cannot gate
 *
 * Traits of this clock:
 * prepare - clk_prepare only ensures that parents are prepared
 * enable - clk_enable only ensures that parents are enabled
 * rate - rate is only affected by parent switching.  No clk_set_rate support
 * parent - parent is adjustable through clk_set_parent
 */

#define to_clk_mux(_hw) container_of(_hw, struct clk_mux, hw)

static u8 clk_mux_get_parent(struct clk_hw *hw)
{
	struct clk_mux *mux = to_clk_mux(hw);
	int num_parents = clk_hw_get_num_parents(hw);
	u32 val;

	/*
	 * FIXME need a mux-specific flag to determine if val is bitwise or numeric
	 * e.g. sys_clkin_ck's clksel field is 3 bits wide, but ranges from 0x1
	 * to 0x7 (index starts at one)
	 * OTOH, pmd_trace_clk_mux_ck uses a separate bit for each clock, so
	 * val = 0x4 really means "bit 2, index starts at bit 0"
	 */
	val = clk_readl(mux->reg) >> mux->shift;
	val &= mux->mask;

	if (mux->table) {
		int i;

		for (i = 0; i < num_parents; i++)
			if (mux->table[i] == val)
				return i;
		return -EINVAL;
	}

	if (val && (mux->flags & CLK_MUX_INDEX_BIT))
		val = ffs(val) - 1;

	if (val && (mux->flags & CLK_MUX_INDEX_ONE))
		val--;

	if (val >= num_parents)
		return -EINVAL;

	return val;
}

static int clk_mux_set_parent(struct clk_hw *hw, u8 index)
{
	struct clk_mux *mux = to_clk_mux(hw);
	u32 val;
	unsigned long flags = 0;

	if (mux->table)
		index = mux->table[index];

	else {
		if (mux->flags & CLK_MUX_INDEX_BIT)
			index = 1 << index;

		if (mux->flags & CLK_MUX_INDEX_ONE)
			index++;
	}

	if (mux->lock)
		spin_lock_irqsave(mux->lock, flags);
	else
		__acquire(mux->lock);

	if (mux->flags & CLK_MUX_HIWORD_MASK) {
		val = mux->mask << (mux->shift + 16);
	} else {
		val = clk_readl(mux->reg);
		val &= ~(mux->mask << mux->shift);
	}
	val |= index << mux->shift;
	clk_writel(val, mux->reg);

	if (mux->lock)
		spin_unlock_irqrestore(mux->lock, flags);
	else
		__release(mux->lock);

	return 0;
}

const struct clk_ops clk_mux_ops = {
	.get_parent = clk_mux_get_parent,
	.set_parent = clk_mux_set_parent,
	.determine_rate = __clk_mux_determine_rate,
};
EXPORT_SYMBOL_GPL(clk_mux_ops);

const struct clk_ops clk_mux_ro_ops = {
	.get_parent = clk_mux_get_parent,
};
EXPORT_SYMBOL_GPL(clk_mux_ro_ops);

struct clk *clk_register_mux_table(struct device *dev, const char *name,
		const char * const *parent_names, u8 num_parents,
		unsigned long flags,
		void __iomem *reg, u8 shift, u32 mask,
		u8 clk_mux_flags, u32 *table, spinlock_t *lock)
{
	struct clk_mux *mux;
	struct clk *clk;
	struct clk_init_data init;
	u8 width = 0;

	if (clk_mux_flags & CLK_MUX_HIWORD_MASK) {
		width = fls(mask) - ffs(mask) + 1;
		if (width + shift > 16) {
			pr_err("mux value exceeds LOWORD field\n");
			return ERR_PTR(-EINVAL);
		}
	}

	/* allocate the mux */
	mux = kzalloc(sizeof(struct clk_mux), GFP_KERNEL);
	if (!mux) {
		pr_err("%s: could not allocate mux clk\n", __func__);
		return ERR_PTR(-ENOMEM);
	}

	init.name = name;
	if (clk_mux_flags & CLK_MUX_READ_ONLY)
		init.ops = &clk_mux_ro_ops;
	else
		init.ops = &clk_mux_ops;
	init.flags = flags | CLK_IS_BASIC;
	init.parent_names = parent_names;
	init.num_parents = num_parents;

	/* struct clk_mux assignments */
	mux->reg = reg;
	mux->shift = shift;
	mux->mask = mask;
	mux->flags = clk_mux_flags;
	mux->lock = lock;
	mux->table = table;
	mux->hw.init = &init;

	clk = clk_register(dev, &mux->hw);

	if (IS_ERR(clk))
		kfree(mux);

	return clk;
}
EXPORT_SYMBOL_GPL(clk_register_mux_table);

struct clk *clk_register_mux(struct device *dev, const char *name,
		const char * const *parent_names, u8 num_parents,
		unsigned long flags,
		void __iomem *reg, u8 shift, u8 width,
		u8 clk_mux_flags, spinlock_t *lock)
{
	u32 mask = BIT(width) - 1;

	return clk_register_mux_table(dev, name, parent_names, num_parents,
				      flags, reg, shift, mask, clk_mux_flags,
				      NULL, lock);
}
EXPORT_SYMBOL_GPL(clk_register_mux);

void clk_unregister_mux(struct clk *clk)
{
	struct clk_mux *mux;
	struct clk_hw *hw;

	hw = __clk_get_hw(clk);
	if (!hw)
		return;

	mux = to_clk_mux(hw);

	clk_unregister(clk);
	kfree(mux);
}
EXPORT_SYMBOL_GPL(clk_unregister_mux);
Commit	Line	Data
9d9f78ed MT	1	/*
	2	* Copyright (C) 2011 Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>
	3	* Copyright (C) 2011 Richard Zhao, Linaro <richard.zhao@linaro.org>
	4	* Copyright (C) 2011-2012 Mike Turquette, Linaro Ltd <mturquette@linaro.org>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*
	10	* Simple multiplexer clock implementation
	11	*/
	12
9d9f78ed MT	13	#include <linux/clk-provider.h>
	14	#include <linux/module.h>
	15	#include <linux/slab.h>
	16	#include <linux/io.h>
	17	#include <linux/err.h>
	18
	19	/*
	20	* DOC: basic adjustable multiplexer clock that cannot gate
	21	*
	22	* Traits of this clock:
	23	* prepare - clk_prepare only ensures that parents are prepared
	24	* enable - clk_enable only ensures that parents are enabled
	25	* rate - rate is only affected by parent switching. No clk_set_rate support
	26	* parent - parent is adjustable through clk_set_parent
	27	*/
	28
	29	#define to_clk_mux(_hw) container_of(_hw, struct clk_mux, hw)
	30
	31	static u8 clk_mux_get_parent(struct clk_hw *hw)
	32	{
	33	struct clk_mux *mux = to_clk_mux(hw);
497295af	34	int num_parents = clk_hw_get_num_parents(hw);
9d9f78ed MT	35	u32 val;
	36
	37	/*
	38	* FIXME need a mux-specific flag to determine if val is bitwise or numeric
	39	* e.g. sys_clkin_ck's clksel field is 3 bits wide, but ranges from 0x1
	40	* to 0x7 (index starts at one)
	41	* OTOH, pmd_trace_clk_mux_ck uses a separate bit for each clock, so
	42	* val = 0x4 really means "bit 2, index starts at bit 0"
	43	*/
aa514ce3	44	val = clk_readl(mux->reg) >> mux->shift;
ce4f3313 PDS	45	val &= mux->mask;
	46
	47	if (mux->table) {
	48	int i;
	49
	50	for (i = 0; i < num_parents; i++)
	51	if (mux->table[i] == val)
	52	return i;
	53	return -EINVAL;
	54	}
9d9f78ed MT	55
	56	if (val && (mux->flags & CLK_MUX_INDEX_BIT))
	57	val = ffs(val) - 1;
	58
	59	if (val && (mux->flags & CLK_MUX_INDEX_ONE))
	60	val--;
	61
ce4f3313	62	if (val >= num_parents)
9d9f78ed MT	63	return -EINVAL;
	64
	65	return val;
	66	}
9d9f78ed MT	67
	68	static int clk_mux_set_parent(struct clk_hw *hw, u8 index)
	69	{
	70	struct clk_mux *mux = to_clk_mux(hw);
	71	u32 val;
	72	unsigned long flags = 0;
	73
ce4f3313 PDS	74	if (mux->table)
ce4f3313 PDS	75	index = mux->table[index];
9d9f78ed	76
ce4f3313 PDS	77	else {
ce4f3313 PDS	78	if (mux->flags & CLK_MUX_INDEX_BIT)
6793b3cd	79	index = 1 << index;
ce4f3313 PDS	80
	81	if (mux->flags & CLK_MUX_INDEX_ONE)
	82	index++;
	83	}
9d9f78ed MT	84
	85	if (mux->lock)
	86	spin_lock_irqsave(mux->lock, flags);
661e2180 SB	87	else
661e2180 SB	88	__acquire(mux->lock);
9d9f78ed	89
ba492e90 HZ	90	if (mux->flags & CLK_MUX_HIWORD_MASK) {
	91	val = mux->mask << (mux->shift + 16);
	92	} else {
aa514ce3	93	val = clk_readl(mux->reg);
ba492e90 HZ	94	val &= ~(mux->mask << mux->shift);
ba492e90 HZ	95	}
9d9f78ed	96	val \|= index << mux->shift;
aa514ce3	97	clk_writel(val, mux->reg);
9d9f78ed MT	98
	99	if (mux->lock)
	100	spin_unlock_irqrestore(mux->lock, flags);
661e2180 SB	101	else
661e2180 SB	102	__release(mux->lock);
9d9f78ed MT	103
	104	return 0;
	105	}
9d9f78ed	106
822c250e	107	const struct clk_ops clk_mux_ops = {
9d9f78ed MT	108	.get_parent = clk_mux_get_parent,
9d9f78ed MT	109	.set_parent = clk_mux_set_parent,
e366fdd7	110	.determine_rate = __clk_mux_determine_rate,
9d9f78ed MT	111	};
	112	EXPORT_SYMBOL_GPL(clk_mux_ops);
	113
c57acd14 TF	114	const struct clk_ops clk_mux_ro_ops = {
	115	.get_parent = clk_mux_get_parent,
	116	};
	117	EXPORT_SYMBOL_GPL(clk_mux_ro_ops);
	118
ce4f3313	119	struct clk clk_register_mux_table(struct device dev, const char *name,
2893c379 SH	120	const char * const *parent_names, u8 num_parents,
2893c379 SH	121	unsigned long flags,
ce4f3313 PDS	122	void __iomem *reg, u8 shift, u32 mask,
ce4f3313 PDS	123	u8 clk_mux_flags, u32 table, spinlock_t lock)
9d9f78ed MT	124	{
9d9f78ed MT	125	struct clk_mux *mux;
27d54591	126	struct clk *clk;
0197b3ea	127	struct clk_init_data init;
ba492e90 HZ	128	u8 width = 0;
	129
	130	if (clk_mux_flags & CLK_MUX_HIWORD_MASK) {
	131	width = fls(mask) - ffs(mask) + 1;
	132	if (width + shift > 16) {
	133	pr_err("mux value exceeds LOWORD field\n");
	134	return ERR_PTR(-EINVAL);
	135	}
	136	}
9d9f78ed	137
27d54591	138	/* allocate the mux */
10363b58	139	mux = kzalloc(sizeof(struct clk_mux), GFP_KERNEL);
9d9f78ed MT	140	if (!mux) {
	141	pr_err("%s: could not allocate mux clk\n", __func__);
	142	return ERR_PTR(-ENOMEM);
	143	}
	144
0197b3ea	145	init.name = name;
c57acd14 TF	146	if (clk_mux_flags & CLK_MUX_READ_ONLY)
	147	init.ops = &clk_mux_ro_ops;
	148	else
	149	init.ops = &clk_mux_ops;
f7d8caad	150	init.flags = flags \| CLK_IS_BASIC;
0197b3ea SK	151	init.parent_names = parent_names;
	152	init.num_parents = num_parents;
	153
9d9f78ed MT	154	/* struct clk_mux assignments */
	155	mux->reg = reg;
	156	mux->shift = shift;
ce4f3313	157	mux->mask = mask;
9d9f78ed MT	158	mux->flags = clk_mux_flags;
9d9f78ed MT	159	mux->lock = lock;
ce4f3313	160	mux->table = table;
31df9db9	161	mux->hw.init = &init;
9d9f78ed	162
0197b3ea	163	clk = clk_register(dev, &mux->hw);
27d54591 MT	164
	165	if (IS_ERR(clk))
	166	kfree(mux);
	167
	168	return clk;
9d9f78ed	169	}
5cfe10bb	170	EXPORT_SYMBOL_GPL(clk_register_mux_table);
ce4f3313 PDS	171
ce4f3313 PDS	172	struct clk clk_register_mux(struct device dev, const char *name,
2893c379 SH	173	const char * const *parent_names, u8 num_parents,
2893c379 SH	174	unsigned long flags,
ce4f3313 PDS	175	void __iomem *reg, u8 shift, u8 width,
	176	u8 clk_mux_flags, spinlock_t *lock)
	177	{
	178	u32 mask = BIT(width) - 1;
	179
	180	return clk_register_mux_table(dev, name, parent_names, num_parents,
	181	flags, reg, shift, mask, clk_mux_flags,
	182	NULL, lock);
	183	}
5cfe10bb	184	EXPORT_SYMBOL_GPL(clk_register_mux);
4e3c021f KK	185
	186	void clk_unregister_mux(struct clk *clk)
	187	{
	188	struct clk_mux *mux;
	189	struct clk_hw *hw;
	190
	191	hw = __clk_get_hw(clk);
	192	if (!hw)
	193	return;
	194
	195	mux = to_clk_mux(hw);
	196
	197	clk_unregister(clk);
	198	kfree(mux);
	199	}
	200	EXPORT_SYMBOL_GPL(clk_unregister_mux);