[linux-2.6-block.git] / drivers / clk / clk-cs2000-cp.c

// SPDX-License-Identifier: GPL-2.0
/*
 * CS2000  --  CIRRUS LOGIC Fractional-N Clock Synthesizer & Clock Multiplier
 *
 * Copyright (C) 2015 Renesas Electronics Corporation
 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
 */
#include <linux/clk-provider.h>
#include <linux/delay.h>
#include <linux/clk.h>
#include <linux/i2c.h>
#include <linux/of_device.h>
#include <linux/module.h>

#define CH_MAX 4
#define RATIO_REG_SIZE 4

#define DEVICE_ID	0x1
#define DEVICE_CTRL	0x2
#define DEVICE_CFG1	0x3
#define DEVICE_CFG2	0x4
#define GLOBAL_CFG	0x5
#define Ratio_Add(x, nth)	(6 + (x * 4) + (nth))
#define Ratio_Val(x, nth)	((x >> (24 - (8 * nth))) & 0xFF)
#define Val_Ratio(x, nth)	((x & 0xFF) << (24 - (8 * nth)))
#define FUNC_CFG1	0x16
#define FUNC_CFG2	0x17

/* DEVICE_ID */
#define REVISION_MASK	(0x7)
#define REVISION_B2_B3	(0x4)
#define REVISION_C1	(0x6)

/* DEVICE_CTRL */
#define PLL_UNLOCK	(1 << 7)
#define AUXOUTDIS	(1 << 1)
#define CLKOUTDIS	(1 << 0)

/* DEVICE_CFG1 */
#define RSEL(x)		(((x) & 0x3) << 3)
#define RSEL_MASK	RSEL(0x3)
#define ENDEV1		(0x1)

/* DEVICE_CFG2 */
#define AUTORMOD	(1 << 3)
#define LOCKCLK(x)	(((x) & 0x3) << 1)
#define LOCKCLK_MASK	LOCKCLK(0x3)
#define FRACNSRC_MASK	(1 << 0)
#define FRACNSRC_STATIC		(0 << 0)
#define FRACNSRC_DYNAMIC	(1 << 1)

/* GLOBAL_CFG */
#define ENDEV2		(0x1)

/* FUNC_CFG1 */
#define CLKSKIPEN	(1 << 7)
#define REFCLKDIV(x)	(((x) & 0x3) << 3)
#define REFCLKDIV_MASK	REFCLKDIV(0x3)

/* FUNC_CFG2 */
#define LFRATIO_MASK	(1 << 3)
#define LFRATIO_20_12	(0 << 3)
#define LFRATIO_12_20	(1 << 3)

#define CH_SIZE_ERR(ch)		((ch < 0) || (ch >= CH_MAX))
#define hw_to_priv(_hw)		container_of(_hw, struct cs2000_priv, hw)
#define priv_to_client(priv)	(priv->client)
#define priv_to_dev(priv)	(&(priv_to_client(priv)->dev))

#define CLK_IN	0
#define REF_CLK	1
#define CLK_MAX 2

struct cs2000_priv {
	struct clk_hw hw;
	struct i2c_client *client;
	struct clk *clk_in;
	struct clk *ref_clk;

	/* suspend/resume */
	unsigned long saved_rate;
	unsigned long saved_parent_rate;
};

static const struct of_device_id cs2000_of_match[] = {
	{ .compatible = "cirrus,cs2000-cp", },
	{},
};
MODULE_DEVICE_TABLE(of, cs2000_of_match);

static const struct i2c_device_id cs2000_id[] = {
	{ "cs2000-cp", },
	{}
};
MODULE_DEVICE_TABLE(i2c, cs2000_id);

#define cs2000_read(priv, addr) \
	i2c_smbus_read_byte_data(priv_to_client(priv), addr)
#define cs2000_write(priv, addr, val) \
	i2c_smbus_write_byte_data(priv_to_client(priv), addr, val)

static int cs2000_bset(struct cs2000_priv *priv, u8 addr, u8 mask, u8 val)
{
	s32 data;

	data = cs2000_read(priv, addr);
	if (data < 0)
		return data;

	data &= ~mask;
	data |= (val & mask);

	return cs2000_write(priv, addr, data);
}

static int cs2000_enable_dev_config(struct cs2000_priv *priv, bool enable)
{
	int ret;

	ret = cs2000_bset(priv, DEVICE_CFG1, ENDEV1,
			  enable ? ENDEV1 : 0);
	if (ret < 0)
		return ret;

	ret = cs2000_bset(priv, GLOBAL_CFG,  ENDEV2,
			  enable ? ENDEV2 : 0);
	if (ret < 0)
		return ret;

	ret = cs2000_bset(priv, FUNC_CFG1, CLKSKIPEN,
			  enable ? CLKSKIPEN : 0);
	if (ret < 0)
		return ret;

	/* FIXME: for Static ratio mode */
	ret = cs2000_bset(priv, FUNC_CFG2, LFRATIO_MASK,
			  LFRATIO_12_20);
	if (ret < 0)
		return ret;

	return 0;
}

static int cs2000_clk_in_bound_rate(struct cs2000_priv *priv,
				    u32 rate_in)
{
	u32 val;

	if (rate_in >= 32000000 && rate_in < 56000000)
		val = 0x0;
	else if (rate_in >= 16000000 && rate_in < 28000000)
		val = 0x1;
	else if (rate_in >= 8000000 && rate_in < 14000000)
		val = 0x2;
	else
		return -EINVAL;

	return cs2000_bset(priv, FUNC_CFG1,
			   REFCLKDIV_MASK,
			   REFCLKDIV(val));
}

static int cs2000_wait_pll_lock(struct cs2000_priv *priv)
{
	struct device *dev = priv_to_dev(priv);
	s32 val;
	unsigned int i;

	for (i = 0; i < 256; i++) {
		val = cs2000_read(priv, DEVICE_CTRL);
		if (val < 0)
			return val;
		if (!(val & PLL_UNLOCK))
			return 0;
		udelay(1);
	}

	dev_err(dev, "pll lock failed\n");

	return -ETIMEDOUT;
}

static int cs2000_clk_out_enable(struct cs2000_priv *priv, bool enable)
{
	/* enable both AUX_OUT, CLK_OUT */
	return cs2000_bset(priv, DEVICE_CTRL,
			   (AUXOUTDIS | CLKOUTDIS),
			   enable ? 0 :
			   (AUXOUTDIS | CLKOUTDIS));
}

static u32 cs2000_rate_to_ratio(u32 rate_in, u32 rate_out)
{
	u64 ratio;

	/*
	 * ratio = rate_out / rate_in * 2^20
	 *
	 * To avoid over flow, rate_out is u64.
	 * The result should be u32.
	 */
	ratio = (u64)rate_out << 20;
	do_div(ratio, rate_in);

	return ratio;
}

static unsigned long cs2000_ratio_to_rate(u32 ratio, u32 rate_in)
{
	u64 rate_out;

	/*
	 * ratio = rate_out / rate_in * 2^20
	 *
	 * To avoid over flow, rate_out is u64.
	 * The result should be u32 or unsigned long.
	 */

	rate_out = (u64)ratio * rate_in;
	return rate_out >> 20;
}

static int cs2000_ratio_set(struct cs2000_priv *priv,
			    int ch, u32 rate_in, u32 rate_out)
{
	u32 val;
	unsigned int i;
	int ret;

	if (CH_SIZE_ERR(ch))
		return -EINVAL;

	val = cs2000_rate_to_ratio(rate_in, rate_out);
	for (i = 0; i < RATIO_REG_SIZE; i++) {
		ret = cs2000_write(priv,
				   Ratio_Add(ch, i),
				   Ratio_Val(val, i));
		if (ret < 0)
			return ret;
	}

	return 0;
}

static u32 cs2000_ratio_get(struct cs2000_priv *priv, int ch)
{
	s32 tmp;
	u32 val;
	unsigned int i;

	val = 0;
	for (i = 0; i < RATIO_REG_SIZE; i++) {
		tmp = cs2000_read(priv, Ratio_Add(ch, i));
		if (tmp < 0)
			return 0;

		val |= Val_Ratio(tmp, i);
	}

	return val;
}

static int cs2000_ratio_select(struct cs2000_priv *priv, int ch)
{
	int ret;

	if (CH_SIZE_ERR(ch))
		return -EINVAL;

	/*
	 * FIXME
	 *
	 * this driver supports static ratio mode only at this point.
	 */
	ret = cs2000_bset(priv, DEVICE_CFG1, RSEL_MASK, RSEL(ch));
	if (ret < 0)
		return ret;

	ret = cs2000_bset(priv, DEVICE_CFG2,
			  (AUTORMOD | LOCKCLK_MASK | FRACNSRC_MASK),
			  (LOCKCLK(ch) | FRACNSRC_STATIC));
	if (ret < 0)
		return ret;

	return 0;
}

static unsigned long cs2000_recalc_rate(struct clk_hw *hw,
					unsigned long parent_rate)
{
	struct cs2000_priv *priv = hw_to_priv(hw);
	int ch = 0; /* it uses ch0 only at this point */
	u32 ratio;

	ratio = cs2000_ratio_get(priv, ch);

	return cs2000_ratio_to_rate(ratio, parent_rate);
}

static long cs2000_round_rate(struct clk_hw *hw, unsigned long rate,
			      unsigned long *parent_rate)
{
	u32 ratio;

	ratio = cs2000_rate_to_ratio(*parent_rate, rate);

	return cs2000_ratio_to_rate(ratio, *parent_rate);
}

static int __cs2000_set_rate(struct cs2000_priv *priv, int ch,
			     unsigned long rate, unsigned long parent_rate)

{
	int ret;

	ret = cs2000_clk_in_bound_rate(priv, parent_rate);
	if (ret < 0)
		return ret;

	ret = cs2000_ratio_set(priv, ch, parent_rate, rate);
	if (ret < 0)
		return ret;

	ret = cs2000_ratio_select(priv, ch);
	if (ret < 0)
		return ret;

	priv->saved_rate	= rate;
	priv->saved_parent_rate	= parent_rate;

	return 0;
}

static int cs2000_set_rate(struct clk_hw *hw,
			   unsigned long rate, unsigned long parent_rate)
{
	struct cs2000_priv *priv = hw_to_priv(hw);
	int ch = 0; /* it uses ch0 only at this point */

	return __cs2000_set_rate(priv, ch, rate, parent_rate);
}

static int cs2000_set_saved_rate(struct cs2000_priv *priv)
{
	int ch = 0; /* it uses ch0 only at this point */

	return __cs2000_set_rate(priv, ch,
				 priv->saved_rate,
				 priv->saved_parent_rate);
}

static int cs2000_enable(struct clk_hw *hw)
{
	struct cs2000_priv *priv = hw_to_priv(hw);
	int ret;

	ret = cs2000_enable_dev_config(priv, true);
	if (ret < 0)
		return ret;

	ret = cs2000_clk_out_enable(priv, true);
	if (ret < 0)
		return ret;

	ret = cs2000_wait_pll_lock(priv);
	if (ret < 0)
		return ret;

	return ret;
}

static void cs2000_disable(struct clk_hw *hw)
{
	struct cs2000_priv *priv = hw_to_priv(hw);

	cs2000_enable_dev_config(priv, false);

	cs2000_clk_out_enable(priv, false);
}

static u8 cs2000_get_parent(struct clk_hw *hw)
{
	/* always return REF_CLK */
	return REF_CLK;
}

static const struct clk_ops cs2000_ops = {
	.get_parent	= cs2000_get_parent,
	.recalc_rate	= cs2000_recalc_rate,
	.round_rate	= cs2000_round_rate,
	.set_rate	= cs2000_set_rate,
	.prepare	= cs2000_enable,
	.unprepare	= cs2000_disable,
};

static int cs2000_clk_get(struct cs2000_priv *priv)
{
	struct device *dev = priv_to_dev(priv);
	struct clk *clk_in, *ref_clk;

	clk_in = devm_clk_get(dev, "clk_in");
	/* not yet provided */
	if (IS_ERR(clk_in))
		return -EPROBE_DEFER;

	ref_clk = devm_clk_get(dev, "ref_clk");
	/* not yet provided */
	if (IS_ERR(ref_clk))
		return -EPROBE_DEFER;

	priv->clk_in	= clk_in;
	priv->ref_clk	= ref_clk;

	return 0;
}

static int cs2000_clk_register(struct cs2000_priv *priv)
{
	struct device *dev = priv_to_dev(priv);
	struct device_node *np = dev->of_node;
	struct clk_init_data init;
	const char *name = np->name;
	static const char *parent_names[CLK_MAX];
	int ch = 0; /* it uses ch0 only at this point */
	int rate;
	int ret;

	of_property_read_string(np, "clock-output-names", &name);

	/*
	 * set default rate as 1/1.
	 * otherwise .set_rate which setup ratio
	 * is never called if user requests 1/1 rate
	 */
	rate = clk_get_rate(priv->ref_clk);
	ret = __cs2000_set_rate(priv, ch, rate, rate);
	if (ret < 0)
		return ret;

	parent_names[CLK_IN]	= __clk_get_name(priv->clk_in);
	parent_names[REF_CLK]	= __clk_get_name(priv->ref_clk);

	init.name		= name;
	init.ops		= &cs2000_ops;
	init.flags		= CLK_SET_RATE_GATE;
	init.parent_names	= parent_names;
	init.num_parents	= ARRAY_SIZE(parent_names);

	priv->hw.init = &init;

	ret = clk_hw_register(dev, &priv->hw);
	if (ret)
		return ret;

	ret = of_clk_add_hw_provider(np, of_clk_hw_simple_get, &priv->hw);
	if (ret < 0) {
		clk_hw_unregister(&priv->hw);
		return ret;
	}

	return 0;
}

static int cs2000_version_print(struct cs2000_priv *priv)
{
	struct device *dev = priv_to_dev(priv);
	s32 val;
	const char *revision;

	val = cs2000_read(priv, DEVICE_ID);
	if (val < 0)
		return val;

	/* CS2000 should be 0x0 */
	if (val >> 3)
		return -EIO;

	switch (val & REVISION_MASK) {
	case REVISION_B2_B3:
		revision = "B2 / B3";
		break;
	case REVISION_C1:
		revision = "C1";
		break;
	default:
		return -EIO;
	}

	dev_info(dev, "revision - %s\n", revision);

	return 0;
}

static int cs2000_remove(struct i2c_client *client)
{
	struct cs2000_priv *priv = i2c_get_clientdata(client);
	struct device *dev = priv_to_dev(priv);
	struct device_node *np = dev->of_node;

	of_clk_del_provider(np);

	clk_hw_unregister(&priv->hw);

	return 0;
}

static int cs2000_probe(struct i2c_client *client,
			const struct i2c_device_id *id)
{
	struct cs2000_priv *priv;
	struct device *dev = &client->dev;
	int ret;

	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
	if (!priv)
		return -ENOMEM;

	priv->client = client;
	i2c_set_clientdata(client, priv);

	ret = cs2000_clk_get(priv);
	if (ret < 0)
		return ret;

	ret = cs2000_clk_register(priv);
	if (ret < 0)
		return ret;

	ret = cs2000_version_print(priv);
	if (ret < 0)
		goto probe_err;

	return 0;

probe_err:
	cs2000_remove(client);

	return ret;
}

static int __maybe_unused cs2000_resume(struct device *dev)
{
	struct cs2000_priv *priv = dev_get_drvdata(dev);

	return cs2000_set_saved_rate(priv);
}

static const struct dev_pm_ops cs2000_pm_ops = {
	SET_LATE_SYSTEM_SLEEP_PM_OPS(NULL, cs2000_resume)
};

static struct i2c_driver cs2000_driver = {
	.driver = {
		.name = "cs2000-cp",
		.pm	= &cs2000_pm_ops,
		.of_match_table = cs2000_of_match,
	},
	.probe		= cs2000_probe,
	.remove		= cs2000_remove,
	.id_table	= cs2000_id,
};

module_i2c_driver(cs2000_driver);

MODULE_DESCRIPTION("CS2000-CP driver");
MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
67075b3c	1	// SPDX-License-Identifier: GPL-2.0
64dfbe24 KM	2	/*
	3	* CS2000 -- CIRRUS LOGIC Fractional-N Clock Synthesizer & Clock Multiplier
	4	*
	5	* Copyright (C) 2015 Renesas Electronics Corporation
	6	* Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
64dfbe24 KM	7	*/
	8	#include <linux/clk-provider.h>
	9	#include <linux/delay.h>
	10	#include <linux/clk.h>
	11	#include <linux/i2c.h>
	12	#include <linux/of_device.h>
	13	#include <linux/module.h>
	14
	15	#define CH_MAX 4
	16	#define RATIO_REG_SIZE 4
	17
	18	#define DEVICE_ID 0x1
	19	#define DEVICE_CTRL 0x2
	20	#define DEVICE_CFG1 0x3
	21	#define DEVICE_CFG2 0x4
	22	#define GLOBAL_CFG 0x5
	23	#define Ratio_Add(x, nth) (6 + (x * 4) + (nth))
	24	#define Ratio_Val(x, nth) ((x >> (24 - (8 * nth))) & 0xFF)
	25	#define Val_Ratio(x, nth) ((x & 0xFF) << (24 - (8 * nth)))
	26	#define FUNC_CFG1 0x16
	27	#define FUNC_CFG2 0x17
	28
	29	/* DEVICE_ID */
	30	#define REVISION_MASK (0x7)
	31	#define REVISION_B2_B3 (0x4)
	32	#define REVISION_C1 (0x6)
	33
	34	/* DEVICE_CTRL */
	35	#define PLL_UNLOCK (1 << 7)
1f9dfd7a KM	36	#define AUXOUTDIS (1 << 1)
1f9dfd7a KM	37	#define CLKOUTDIS (1 << 0)
64dfbe24 KM	38
	39	/* DEVICE_CFG1 */
	40	#define RSEL(x) (((x) & 0x3) << 3)
	41	#define RSEL_MASK RSEL(0x3)
	42	#define ENDEV1 (0x1)
	43
1f9dfd7a KM	44	/* DEVICE_CFG2 */
	45	#define AUTORMOD (1 << 3)
	46	#define LOCKCLK(x) (((x) & 0x3) << 1)
	47	#define LOCKCLK_MASK LOCKCLK(0x3)
b295a015 KM	48	#define FRACNSRC_MASK (1 << 0)
	49	#define FRACNSRC_STATIC (0 << 0)
	50	#define FRACNSRC_DYNAMIC (1 << 1)
1f9dfd7a	51
64dfbe24 KM	52	/* GLOBAL_CFG */
	53	#define ENDEV2 (0x1)
	54
1f9dfd7a	55	/* FUNC_CFG1 */
d127967a	56	#define CLKSKIPEN (1 << 7)
1f9dfd7a KM	57	#define REFCLKDIV(x) (((x) & 0x3) << 3)
	58	#define REFCLKDIV_MASK REFCLKDIV(0x3)
	59
b3da896e KM	60	/* FUNC_CFG2 */
	61	#define LFRATIO_MASK (1 << 3)
	62	#define LFRATIO_20_12 (0 << 3)
	63	#define LFRATIO_12_20 (1 << 3)
	64
64dfbe24 KM	65	#define CH_SIZE_ERR(ch) ((ch < 0) \|\| (ch >= CH_MAX))
	66	#define hw_to_priv(_hw) container_of(_hw, struct cs2000_priv, hw)
	67	#define priv_to_client(priv) (priv->client)
	68	#define priv_to_dev(priv) (&(priv_to_client(priv)->dev))
	69
	70	#define CLK_IN 0
	71	#define REF_CLK 1
	72	#define CLK_MAX 2
	73
	74	struct cs2000_priv {
	75	struct clk_hw hw;
	76	struct i2c_client *client;
	77	struct clk *clk_in;
	78	struct clk *ref_clk;
c567fb37 KN	79
	80	/* suspend/resume */
	81	unsigned long saved_rate;
	82	unsigned long saved_parent_rate;
64dfbe24 KM	83	};
	84
	85	static const struct of_device_id cs2000_of_match[] = {
	86	{ .compatible = "cirrus,cs2000-cp", },
	87	{},
	88	};
	89	MODULE_DEVICE_TABLE(of, cs2000_of_match);
	90
	91	static const struct i2c_device_id cs2000_id[] = {
	92	{ "cs2000-cp", },
	93	{}
	94	};
	95	MODULE_DEVICE_TABLE(i2c, cs2000_id);
	96
	97	#define cs2000_read(priv, addr) \
	98	i2c_smbus_read_byte_data(priv_to_client(priv), addr)
	99	#define cs2000_write(priv, addr, val) \
	100	i2c_smbus_write_byte_data(priv_to_client(priv), addr, val)
	101
	102	static int cs2000_bset(struct cs2000_priv *priv, u8 addr, u8 mask, u8 val)
	103	{
	104	s32 data;
	105
	106	data = cs2000_read(priv, addr);
	107	if (data < 0)
	108	return data;
	109
	110	data &= ~mask;
	111	data \|= (val & mask);
	112
	113	return cs2000_write(priv, addr, data);
	114	}
	115
	116	static int cs2000_enable_dev_config(struct cs2000_priv *priv, bool enable)
	117	{
	118	int ret;
	119
	120	ret = cs2000_bset(priv, DEVICE_CFG1, ENDEV1,
	121	enable ? ENDEV1 : 0);
	122	if (ret < 0)
	123	return ret;
	124
	125	ret = cs2000_bset(priv, GLOBAL_CFG, ENDEV2,
	126	enable ? ENDEV2 : 0);
	127	if (ret < 0)
	128	return ret;
	129
d127967a KM	130	ret = cs2000_bset(priv, FUNC_CFG1, CLKSKIPEN,
	131	enable ? CLKSKIPEN : 0);
	132	if (ret < 0)
	133	return ret;
	134
b3da896e KM	135	/* FIXME: for Static ratio mode */
	136	ret = cs2000_bset(priv, FUNC_CFG2, LFRATIO_MASK,
	137	LFRATIO_12_20);
	138	if (ret < 0)
	139	return ret;
	140
64dfbe24 KM	141	return 0;
	142	}
	143
	144	static int cs2000_clk_in_bound_rate(struct cs2000_priv *priv,
	145	u32 rate_in)
	146	{
	147	u32 val;
	148
	149	if (rate_in >= 32000000 && rate_in < 56000000)
	150	val = 0x0;
	151	else if (rate_in >= 16000000 && rate_in < 28000000)
	152	val = 0x1;
	153	else if (rate_in >= 8000000 && rate_in < 14000000)
	154	val = 0x2;
	155	else
	156	return -EINVAL;
	157
1f9dfd7a KM	158	return cs2000_bset(priv, FUNC_CFG1,
	159	REFCLKDIV_MASK,
	160	REFCLKDIV(val));
64dfbe24 KM	161	}
	162
	163	static int cs2000_wait_pll_lock(struct cs2000_priv *priv)
	164	{
	165	struct device *dev = priv_to_dev(priv);
	166	s32 val;
	167	unsigned int i;
	168
	169	for (i = 0; i < 256; i++) {
	170	val = cs2000_read(priv, DEVICE_CTRL);
	171	if (val < 0)
	172	return val;
	173	if (!(val & PLL_UNLOCK))
	174	return 0;
	175	udelay(1);
	176	}
	177
	178	dev_err(dev, "pll lock failed\n");
	179
	180	return -ETIMEDOUT;
	181	}
	182
	183	static int cs2000_clk_out_enable(struct cs2000_priv *priv, bool enable)
	184	{
	185	/* enable both AUX_OUT, CLK_OUT */
1f9dfd7a KM	186	return cs2000_bset(priv, DEVICE_CTRL,
	187	(AUXOUTDIS \| CLKOUTDIS),
	188	enable ? 0 :
	189	(AUXOUTDIS \| CLKOUTDIS));
64dfbe24 KM	190	}
	191
	192	static u32 cs2000_rate_to_ratio(u32 rate_in, u32 rate_out)
	193	{
	194	u64 ratio;
	195
	196	/*
	197	* ratio = rate_out / rate_in * 2^20
	198	*
	199	* To avoid over flow, rate_out is u64.
	200	* The result should be u32.
	201	*/
	202	ratio = (u64)rate_out << 20;
	203	do_div(ratio, rate_in);
	204
	205	return ratio;
	206	}
	207
	208	static unsigned long cs2000_ratio_to_rate(u32 ratio, u32 rate_in)
	209	{
	210	u64 rate_out;
	211
	212	/*
	213	* ratio = rate_out / rate_in * 2^20
	214	*
	215	* To avoid over flow, rate_out is u64.
	216	* The result should be u32 or unsigned long.
	217	*/
	218
	219	rate_out = (u64)ratio * rate_in;
	220	return rate_out >> 20;
	221	}
	222
	223	static int cs2000_ratio_set(struct cs2000_priv *priv,
	224	int ch, u32 rate_in, u32 rate_out)
	225	{
	226	u32 val;
	227	unsigned int i;
	228	int ret;
	229
	230	if (CH_SIZE_ERR(ch))
	231	return -EINVAL;
	232
	233	val = cs2000_rate_to_ratio(rate_in, rate_out);
	234	for (i = 0; i < RATIO_REG_SIZE; i++) {
	235	ret = cs2000_write(priv,
	236	Ratio_Add(ch, i),
	237	Ratio_Val(val, i));
	238	if (ret < 0)
	239	return ret;
	240	}
	241
	242	return 0;
	243	}
	244
	245	static u32 cs2000_ratio_get(struct cs2000_priv *priv, int ch)
	246	{
	247	s32 tmp;
	248	u32 val;
	249	unsigned int i;
	250
	251	val = 0;
	252	for (i = 0; i < RATIO_REG_SIZE; i++) {
	253	tmp = cs2000_read(priv, Ratio_Add(ch, i));
254	if (tmp < 0)
255	return 0;
256
257	val \|= Val_Ratio(tmp, i);
258	}
259
260	return val;
261	}
262
263	static int cs2000_ratio_select(struct cs2000_priv *priv, int ch)
264	{
265	int ret;
266
267	if (CH_SIZE_ERR(ch))
268	return -EINVAL;
269
270	/*
271	* FIXME
272	*
273	* this driver supports static ratio mode only at this point.
274	*/
275	ret = cs2000_bset(priv, DEVICE_CFG1, RSEL_MASK, RSEL(ch));
276	if (ret < 0)
277	return ret;
278
1f9dfd7a	279	ret = cs2000_bset(priv, DEVICE_CFG2,
b295a015 KM	280	(AUTORMOD \| LOCKCLK_MASK \| FRACNSRC_MASK),
b295a015 KM	281	(LOCKCLK(ch) \| FRACNSRC_STATIC));
64dfbe24 KM	282	if (ret < 0)
	283	return ret;
	284
	285	return 0;
	286	}
	287
	288	static unsigned long cs2000_recalc_rate(struct clk_hw *hw,
	289	unsigned long parent_rate)
	290	{
	291	struct cs2000_priv *priv = hw_to_priv(hw);
	292	int ch = 0; /* it uses ch0 only at this point */
	293	u32 ratio;
	294
	295	ratio = cs2000_ratio_get(priv, ch);
	296
	297	return cs2000_ratio_to_rate(ratio, parent_rate);
	298	}
	299
	300	static long cs2000_round_rate(struct clk_hw *hw, unsigned long rate,
	301	unsigned long *parent_rate)
	302	{
	303	u32 ratio;
	304
	305	ratio = cs2000_rate_to_ratio(*parent_rate, rate);
	306
	307	return cs2000_ratio_to_rate(ratio, *parent_rate);
	308	}
	309
	310	static int __cs2000_set_rate(struct cs2000_priv *priv, int ch,
	311	unsigned long rate, unsigned long parent_rate)
	312
	313	{
	314	int ret;
	315
	316	ret = cs2000_clk_in_bound_rate(priv, parent_rate);
	317	if (ret < 0)
	318	return ret;
	319
	320	ret = cs2000_ratio_set(priv, ch, parent_rate, rate);
	321	if (ret < 0)
	322	return ret;
	323
	324	ret = cs2000_ratio_select(priv, ch);
	325	if (ret < 0)
	326	return ret;
	327
c567fb37 KN	328	priv->saved_rate = rate;
	329	priv->saved_parent_rate = parent_rate;
	330
64dfbe24 KM	331	return 0;
	332	}
	333
	334	static int cs2000_set_rate(struct clk_hw *hw,
	335	unsigned long rate, unsigned long parent_rate)
	336	{
	337	struct cs2000_priv *priv = hw_to_priv(hw);
	338	int ch = 0; /* it uses ch0 only at this point */
	339
	340	return __cs2000_set_rate(priv, ch, rate, parent_rate);
	341	}
	342
e001525c GI	343	static int cs2000_set_saved_rate(struct cs2000_priv *priv)
	344	{
	345	int ch = 0; /* it uses ch0 only at this point */
	346
	347	return __cs2000_set_rate(priv, ch,
	348	priv->saved_rate,
	349	priv->saved_parent_rate);
	350	}
	351
64dfbe24 KM	352	static int cs2000_enable(struct clk_hw *hw)
	353	{
	354	struct cs2000_priv *priv = hw_to_priv(hw);
	355	int ret;
	356
	357	ret = cs2000_enable_dev_config(priv, true);
	358	if (ret < 0)
	359	return ret;
	360
	361	ret = cs2000_clk_out_enable(priv, true);
	362	if (ret < 0)
	363	return ret;
	364
	365	ret = cs2000_wait_pll_lock(priv);
	366	if (ret < 0)
	367	return ret;
	368
	369	return ret;
	370	}
	371
	372	static void cs2000_disable(struct clk_hw *hw)
	373	{
	374	struct cs2000_priv *priv = hw_to_priv(hw);
	375
	376	cs2000_enable_dev_config(priv, false);
	377
	378	cs2000_clk_out_enable(priv, false);
	379	}
	380
	381	static u8 cs2000_get_parent(struct clk_hw *hw)
	382	{
	383	/* always return REF_CLK */
	384	return REF_CLK;
	385	}
	386
	387	static const struct clk_ops cs2000_ops = {
	388	.get_parent = cs2000_get_parent,
	389	.recalc_rate = cs2000_recalc_rate,
	390	.round_rate = cs2000_round_rate,
	391	.set_rate = cs2000_set_rate,
	392	.prepare = cs2000_enable,
	393	.unprepare = cs2000_disable,
	394	};
	395
	396	static int cs2000_clk_get(struct cs2000_priv *priv)
	397	{
83dd720d	398	struct device *dev = priv_to_dev(priv);
64dfbe24 KM	399	struct clk clk_in, ref_clk;
	400
	401	clk_in = devm_clk_get(dev, "clk_in");
	402	/* not yet provided */
	403	if (IS_ERR(clk_in))
	404	return -EPROBE_DEFER;
	405
	406	ref_clk = devm_clk_get(dev, "ref_clk");
	407	/* not yet provided */
	408	if (IS_ERR(ref_clk))
	409	return -EPROBE_DEFER;
	410
	411	priv->clk_in = clk_in;
	412	priv->ref_clk = ref_clk;
	413
	414	return 0;
	415	}
	416
	417	static int cs2000_clk_register(struct cs2000_priv *priv)
	418	{
	419	struct device *dev = priv_to_dev(priv);
	420	struct device_node *np = dev->of_node;
	421	struct clk_init_data init;
	422	const char *name = np->name;
64dfbe24 KM	423	static const char *parent_names[CLK_MAX];
	424	int ch = 0; /* it uses ch0 only at this point */
	425	int rate;
	426	int ret;
	427
	428	of_property_read_string(np, "clock-output-names", &name);
	429
	430	/*
	431	* set default rate as 1/1.
	432	* otherwise .set_rate which setup ratio
	433	* is never called if user requests 1/1 rate
	434	*/
	435	rate = clk_get_rate(priv->ref_clk);
	436	ret = __cs2000_set_rate(priv, ch, rate, rate);
	437	if (ret < 0)
	438	return ret;
	439
	440	parent_names[CLK_IN] = __clk_get_name(priv->clk_in);
	441	parent_names[REF_CLK] = __clk_get_name(priv->ref_clk);
	442
	443	init.name = name;
	444	init.ops = &cs2000_ops;
	445	init.flags = CLK_SET_RATE_GATE;
	446	init.parent_names = parent_names;
	447	init.num_parents = ARRAY_SIZE(parent_names);
	448
	449	priv->hw.init = &init;
	450
2ceb3c7a SB	451	ret = clk_hw_register(dev, &priv->hw);
	452	if (ret)
	453	return ret;
64dfbe24	454
2ceb3c7a	455	ret = of_clk_add_hw_provider(np, of_clk_hw_simple_get, &priv->hw);
64dfbe24	456	if (ret < 0) {
2ceb3c7a	457	clk_hw_unregister(&priv->hw);
64dfbe24 KM	458	return ret;
	459	}
	460
64dfbe24 KM	461	return 0;
	462	}
	463
	464	static int cs2000_version_print(struct cs2000_priv *priv)
	465	{
83dd720d	466	struct device *dev = priv_to_dev(priv);
64dfbe24 KM	467	s32 val;
	468	const char *revision;
	469
	470	val = cs2000_read(priv, DEVICE_ID);
	471	if (val < 0)
	472	return val;
	473
	474	/* CS2000 should be 0x0 */
	475	if (val >> 3)
	476	return -EIO;
	477
	478	switch (val & REVISION_MASK) {
	479	case REVISION_B2_B3:
	480	revision = "B2 / B3";
	481	break;
	482	case REVISION_C1:
	483	revision = "C1";
	484	break;
	485	default:
	486	return -EIO;
	487	}
	488
	489	dev_info(dev, "revision - %s\n", revision);
	490
	491	return 0;
	492	}
	493
	494	static int cs2000_remove(struct i2c_client *client)
	495	{
	496	struct cs2000_priv *priv = i2c_get_clientdata(client);
83dd720d	497	struct device *dev = priv_to_dev(priv);
64dfbe24 KM	498	struct device_node *np = dev->of_node;
	499
	500	of_clk_del_provider(np);
	501
2ceb3c7a	502	clk_hw_unregister(&priv->hw);
64dfbe24 KM	503
	504	return 0;
	505	}
	506
	507	static int cs2000_probe(struct i2c_client *client,
	508	const struct i2c_device_id *id)
	509	{
	510	struct cs2000_priv *priv;
	511	struct device *dev = &client->dev;
	512	int ret;
	513
	514	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
	515	if (!priv)
	516	return -ENOMEM;
	517
	518	priv->client = client;
	519	i2c_set_clientdata(client, priv);
	520
	521	ret = cs2000_clk_get(priv);
	522	if (ret < 0)
	523	return ret;
	524
	525	ret = cs2000_clk_register(priv);
	526	if (ret < 0)
	527	return ret;
	528
	529	ret = cs2000_version_print(priv);
	530	if (ret < 0)
	531	goto probe_err;
	532
	533	return 0;
	534
	535	probe_err:
	536	cs2000_remove(client);
	537
	538	return ret;
	539	}
	540
a21b8594	541	static int __maybe_unused cs2000_resume(struct device *dev)
c567fb37 KN	542	{
c567fb37 KN	543	struct cs2000_priv *priv = dev_get_drvdata(dev);
c567fb37	544
e001525c	545	return cs2000_set_saved_rate(priv);
c567fb37 KN	546	}
	547
	548	static const struct dev_pm_ops cs2000_pm_ops = {
eade4ccd	549	SET_LATE_SYSTEM_SLEEP_PM_OPS(NULL, cs2000_resume)
c567fb37 KN	550	};
c567fb37 KN	551
64dfbe24 KM	552	static struct i2c_driver cs2000_driver = {
	553	.driver = {
	554	.name = "cs2000-cp",
c567fb37	555	.pm = &cs2000_pm_ops,
64dfbe24 KM	556	.of_match_table = cs2000_of_match,
	557	},
	558	.probe = cs2000_probe,
	559	.remove = cs2000_remove,
	560	.id_table = cs2000_id,
	561	};
	562
	563	module_i2c_driver(cs2000_driver);
	564
	565	MODULE_DESCRIPTION("CS2000-CP driver");
	566	MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
	567	MODULE_LICENSE("GPL v2");