[mirror_ubuntu-hirsute-kernel.git] / drivers / i2c / busses / i2c-designware-platdrv.c

/*
 * Synopsys DesignWare I2C adapter driver (master only).
 *
 * Based on the TI DAVINCI I2C adapter driver.
 *
 * Copyright (C) 2006 Texas Instruments.
 * Copyright (C) 2007 MontaVista Software Inc.
 * Copyright (C) 2009 Provigent Ltd.
 *
 * ----------------------------------------------------------------------------
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 * ----------------------------------------------------------------------------
 *
 */
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/delay.h>
#include <linux/i2c.h>
#include <linux/clk.h>
#include <linux/errno.h>
#include <linux/sched.h>
#include <linux/err.h>
#include <linux/interrupt.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/pm.h>
#include <linux/pm_runtime.h>
#include <linux/io.h>
#include <linux/slab.h>
#include <linux/acpi.h>
#include "i2c-designware-core.h"

static struct i2c_algorithm i2c_dw_algo = {
	.master_xfer	= i2c_dw_xfer,
	.functionality	= i2c_dw_func,
};
static u32 i2c_dw_get_clk_rate_khz(struct dw_i2c_dev *dev)
{
	return clk_get_rate(dev->clk)/1000;
}

#ifdef CONFIG_ACPI
static void dw_i2c_acpi_params(struct platform_device *pdev, char method[],
			       u16 *hcnt, u16 *lcnt, u32 *sda_hold)
{
	struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
	acpi_handle handle = ACPI_HANDLE(&pdev->dev);
	union acpi_object *obj;

	if (ACPI_FAILURE(acpi_evaluate_object(handle, method, NULL, &buf)))
		return;

	obj = (union acpi_object *)buf.pointer;
	if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 3) {
		const union acpi_object *objs = obj->package.elements;

		*hcnt = (u16)objs[0].integer.value;
		*lcnt = (u16)objs[1].integer.value;
		if (sda_hold)
			*sda_hold = (u32)objs[2].integer.value;
	}

	kfree(buf.pointer);
}

static int dw_i2c_acpi_configure(struct platform_device *pdev)
{
	struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
	bool fs_mode = dev->master_cfg & DW_IC_CON_SPEED_FAST;

	if (!ACPI_HANDLE(&pdev->dev))
		return -ENODEV;

	dev->adapter.nr = -1;
	dev->tx_fifo_depth = 32;
	dev->rx_fifo_depth = 32;

	/*
	 * Try to get SDA hold time and *CNT values from an ACPI method if
	 * it exists for both supported speed modes.
	 */
	dw_i2c_acpi_params(pdev, "SSCN", &dev->ss_hcnt, &dev->ss_lcnt,
			   fs_mode ? NULL : &dev->sda_hold_time);
	dw_i2c_acpi_params(pdev, "FMCN", &dev->fs_hcnt, &dev->fs_lcnt,
			   fs_mode ? &dev->sda_hold_time : NULL);

	return 0;
}

static const struct acpi_device_id dw_i2c_acpi_match[] = {
	{ "INT33C2", 0 },
	{ "INT33C3", 0 },
	{ "80860F41", 0 },
	{ }
};
MODULE_DEVICE_TABLE(acpi, dw_i2c_acpi_match);
#else
static inline int dw_i2c_acpi_configure(struct platform_device *pdev)
{
	return -ENODEV;
}
#endif

static int dw_i2c_probe(struct platform_device *pdev)
{
	struct dw_i2c_dev *dev;
	struct i2c_adapter *adap;
	struct resource *mem;
	int irq, r;

	irq = platform_get_irq(pdev, 0);
	if (irq < 0) {
		dev_err(&pdev->dev, "no irq resource?\n");
		return irq; /* -ENXIO */
	}

	dev = devm_kzalloc(&pdev->dev, sizeof(struct dw_i2c_dev), GFP_KERNEL);
	if (!dev)
		return -ENOMEM;

	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	dev->base = devm_ioremap_resource(&pdev->dev, mem);
	if (IS_ERR(dev->base))
		return PTR_ERR(dev->base);

	init_completion(&dev->cmd_complete);
	mutex_init(&dev->lock);
	dev->dev = &pdev->dev;
	dev->irq = irq;
	platform_set_drvdata(pdev, dev);

	dev->clk = devm_clk_get(&pdev->dev, NULL);
	dev->get_clk_rate_khz = i2c_dw_get_clk_rate_khz;

	if (IS_ERR(dev->clk))
		return PTR_ERR(dev->clk);
	clk_prepare_enable(dev->clk);

	if (pdev->dev.of_node) {
		u32 ht = 0;
		u32 ic_clk = dev->get_clk_rate_khz(dev);

		of_property_read_u32(pdev->dev.of_node,
					"i2c-sda-hold-time-ns", &ht);
		dev->sda_hold_time = div_u64((u64)ic_clk * ht + 500000,
					     1000000);
	}

	dev->functionality =
		I2C_FUNC_I2C |
		I2C_FUNC_10BIT_ADDR |
		I2C_FUNC_SMBUS_BYTE |
		I2C_FUNC_SMBUS_BYTE_DATA |
		I2C_FUNC_SMBUS_WORD_DATA |
		I2C_FUNC_SMBUS_I2C_BLOCK;
	dev->master_cfg =  DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE |
		DW_IC_CON_RESTART_EN | DW_IC_CON_SPEED_FAST;

	/* Try first if we can configure the device from ACPI */
	r = dw_i2c_acpi_configure(pdev);
	if (r) {
		u32 param1 = i2c_dw_read_comp_param(dev);

		dev->tx_fifo_depth = ((param1 >> 16) & 0xff) + 1;
		dev->rx_fifo_depth = ((param1 >> 8)  & 0xff) + 1;
		dev->adapter.nr = pdev->id;
	}
	r = i2c_dw_init(dev);
	if (r)
		return r;

	i2c_dw_disable_int(dev);
	r = devm_request_irq(&pdev->dev, dev->irq, i2c_dw_isr, IRQF_SHARED,
			pdev->name, dev);
	if (r) {
		dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
		return r;
	}

	adap = &dev->adapter;
	i2c_set_adapdata(adap, dev);
	adap->owner = THIS_MODULE;
	adap->class = I2C_CLASS_HWMON;
	strlcpy(adap->name, "Synopsys DesignWare I2C adapter",
			sizeof(adap->name));
	adap->algo = &i2c_dw_algo;
	adap->dev.parent = &pdev->dev;
	adap->dev.of_node = pdev->dev.of_node;

	r = i2c_add_numbered_adapter(adap);
	if (r) {
		dev_err(&pdev->dev, "failure adding adapter\n");
		return r;
	}

	pm_runtime_set_autosuspend_delay(&pdev->dev, 1000);
	pm_runtime_use_autosuspend(&pdev->dev);
	pm_runtime_set_active(&pdev->dev);
	pm_runtime_enable(&pdev->dev);

	return 0;
}

static int dw_i2c_remove(struct platform_device *pdev)
{
	struct dw_i2c_dev *dev = platform_get_drvdata(pdev);

	pm_runtime_get_sync(&pdev->dev);

	i2c_del_adapter(&dev->adapter);

	i2c_dw_disable(dev);

	pm_runtime_put(&pdev->dev);
	pm_runtime_disable(&pdev->dev);

	return 0;
}

#ifdef CONFIG_OF
static const struct of_device_id dw_i2c_of_match[] = {
	{ .compatible = "snps,designware-i2c", },
	{},
};
MODULE_DEVICE_TABLE(of, dw_i2c_of_match);
#endif

#ifdef CONFIG_PM_SLEEP
static int dw_i2c_suspend(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev);

	clk_disable_unprepare(i_dev->clk);

	return 0;
}

static int dw_i2c_resume(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev);

	clk_prepare_enable(i_dev->clk);
	i2c_dw_init(i_dev);

	return 0;
}

static SIMPLE_DEV_PM_OPS(dw_i2c_dev_pm_ops, dw_i2c_suspend, dw_i2c_resume);
#define DW_I2C_DEV_PM_OPS	(&dw_i2c_dev_pm_ops)
#else
#define DW_I2C_DEV_PM_OPS	NULL
#endif

/* work with hotplug and coldplug */
MODULE_ALIAS("platform:i2c_designware");

static struct platform_driver dw_i2c_driver = {
	.remove		= dw_i2c_remove,
	.driver		= {
		.name	= "i2c_designware",
		.owner	= THIS_MODULE,
		.of_match_table = of_match_ptr(dw_i2c_of_match),
		.acpi_match_table = ACPI_PTR(dw_i2c_acpi_match),
		.pm	= DW_I2C_DEV_PM_OPS,
	},
};

static int __init dw_i2c_init_driver(void)
{
	return platform_driver_probe(&dw_i2c_driver, dw_i2c_probe);
}
subsys_initcall(dw_i2c_init_driver);

static void __exit dw_i2c_exit_driver(void)
{
	platform_driver_unregister(&dw_i2c_driver);
}
module_exit(dw_i2c_exit_driver);

MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter");
MODULE_LICENSE("GPL");
Commit	Line	Data
2373f6b9 DB	1	/*
	2	* Synopsys DesignWare I2C adapter driver (master only).
	3	*
	4	* Based on the TI DAVINCI I2C adapter driver.
	5	*
	6	* Copyright (C) 2006 Texas Instruments.
	7	* Copyright (C) 2007 MontaVista Software Inc.
	8	* Copyright (C) 2009 Provigent Ltd.
	9	*
	10	* ----------------------------------------------------------------------------
	11	*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of the GNU General Public License as published by
	14	* the Free Software Foundation; either version 2 of the License, or
	15	* (at your option) any later version.
	16	*
	17	* This program is distributed in the hope that it will be useful,
	18	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	* GNU General Public License for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License
	23	* along with this program; if not, write to the Free Software
	24	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	25	* ----------------------------------------------------------------------------
	26	*
	27	*/
	28	#include <linux/kernel.h>
	29	#include <linux/module.h>
	30	#include <linux/delay.h>
	31	#include <linux/i2c.h>
	32	#include <linux/clk.h>
	33	#include <linux/errno.h>
	34	#include <linux/sched.h>
	35	#include <linux/err.h>
	36	#include <linux/interrupt.h>
9803f868	37	#include <linux/of.h>
2373f6b9	38	#include <linux/platform_device.h>
3bf3b289	39	#include <linux/pm.h>
7272194e	40	#include <linux/pm_runtime.h>
2373f6b9 DB	41	#include <linux/io.h>
2373f6b9 DB	42	#include <linux/slab.h>
b61b1415	43	#include <linux/acpi.h>
2373f6b9 DB	44	#include "i2c-designware-core.h"
	45
	46	static struct i2c_algorithm i2c_dw_algo = {
	47	.master_xfer = i2c_dw_xfer,
	48	.functionality = i2c_dw_func,
	49	};
1d31b58f DB	50	static u32 i2c_dw_get_clk_rate_khz(struct dw_i2c_dev *dev)
	51	{
	52	return clk_get_rate(dev->clk)/1000;
	53	}
2373f6b9	54
b61b1415	55	#ifdef CONFIG_ACPI
57cd1e30 MW	56	static void dw_i2c_acpi_params(struct platform_device *pdev, char method[],
	57	u16 hcnt, u16 lcnt, u32 *sda_hold)
	58	{
	59	struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
	60	acpi_handle handle = ACPI_HANDLE(&pdev->dev);
	61	union acpi_object *obj;
	62
	63	if (ACPI_FAILURE(acpi_evaluate_object(handle, method, NULL, &buf)))
	64	return;
	65
	66	obj = (union acpi_object *)buf.pointer;
	67	if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 3) {
	68	const union acpi_object *objs = obj->package.elements;
	69
	70	*hcnt = (u16)objs[0].integer.value;
	71	*lcnt = (u16)objs[1].integer.value;
	72	if (sda_hold)
	73	*sda_hold = (u32)objs[2].integer.value;
	74	}
	75
	76	kfree(buf.pointer);
	77	}
	78
b61b1415 MW	79	static int dw_i2c_acpi_configure(struct platform_device *pdev)
	80	{
	81	struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
57cd1e30	82	bool fs_mode = dev->master_cfg & DW_IC_CON_SPEED_FAST;
b61b1415 MW	83
	84	if (!ACPI_HANDLE(&pdev->dev))
	85	return -ENODEV;
	86
b61b1415	87	dev->adapter.nr = -1;
b61b1415 MW	88	dev->tx_fifo_depth = 32;
b61b1415 MW	89	dev->rx_fifo_depth = 32;
57cd1e30 MW	90
	91	/*
	92	* Try to get SDA hold time and *CNT values from an ACPI method if
	93	* it exists for both supported speed modes.
	94	*/
	95	dw_i2c_acpi_params(pdev, "SSCN", &dev->ss_hcnt, &dev->ss_lcnt,
	96	fs_mode ? NULL : &dev->sda_hold_time);
	97	dw_i2c_acpi_params(pdev, "FMCN", &dev->fs_hcnt, &dev->fs_lcnt,
	98	fs_mode ? &dev->sda_hold_time : NULL);
	99
b61b1415 MW	100	return 0;
	101	}
	102
	103	static const struct acpi_device_id dw_i2c_acpi_match[] = {
	104	{ "INT33C2", 0 },
	105	{ "INT33C3", 0 },
5a7e6bd8	106	{ "80860F41", 0 },
b61b1415 MW	107	{ }
	108	};
	109	MODULE_DEVICE_TABLE(acpi, dw_i2c_acpi_match);
	110	#else
	111	static inline int dw_i2c_acpi_configure(struct platform_device *pdev)
	112	{
	113	return -ENODEV;
	114	}
	115	#endif
	116
0b255e92	117	static int dw_i2c_probe(struct platform_device *pdev)
2373f6b9 DB	118	{
	119	struct dw_i2c_dev *dev;
	120	struct i2c_adapter *adap;
1cb715ca	121	struct resource *mem;
2373f6b9 DB	122	int irq, r;
2373f6b9 DB	123
2373f6b9 DB	124	irq = platform_get_irq(pdev, 0);
	125	if (irq < 0) {
	126	dev_err(&pdev->dev, "no irq resource?\n");
	127	return irq; /* -ENXIO */
	128	}
	129
1cb715ca AS	130	dev = devm_kzalloc(&pdev->dev, sizeof(struct dw_i2c_dev), GFP_KERNEL);
	131	if (!dev)
	132	return -ENOMEM;
2373f6b9	133
3cc2d009	134	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1cb715ca AS	135	dev->base = devm_ioremap_resource(&pdev->dev, mem);
	136	if (IS_ERR(dev->base))
	137	return PTR_ERR(dev->base);
2373f6b9 DB	138
	139	init_completion(&dev->cmd_complete);
	140	mutex_init(&dev->lock);
1cb715ca	141	dev->dev = &pdev->dev;
2373f6b9 DB	142	dev->irq = irq;
	143	platform_set_drvdata(pdev, dev);
	144
1cb715ca	145	dev->clk = devm_clk_get(&pdev->dev, NULL);
1d31b58f DB	146	dev->get_clk_rate_khz = i2c_dw_get_clk_rate_khz;
1d31b58f DB	147
1cb715ca AS	148	if (IS_ERR(dev->clk))
1cb715ca AS	149	return PTR_ERR(dev->clk);
e1fac69f	150	clk_prepare_enable(dev->clk);
2373f6b9	151
9803f868 CR	152	if (pdev->dev.of_node) {
	153	u32 ht = 0;
	154	u32 ic_clk = dev->get_clk_rate_khz(dev);
	155
	156	of_property_read_u32(pdev->dev.of_node,
	157	"i2c-sda-hold-time-ns", &ht);
97191d73 VS	158	dev->sda_hold_time = div_u64((u64)ic_clk * ht + 500000,
97191d73 VS	159	1000000);
9803f868 CR	160	}
9803f868 CR	161
2fa8326b DB	162	dev->functionality =
	163	I2C_FUNC_I2C \|
	164	I2C_FUNC_10BIT_ADDR \|
	165	I2C_FUNC_SMBUS_BYTE \|
	166	I2C_FUNC_SMBUS_BYTE_DATA \|
	167	I2C_FUNC_SMBUS_WORD_DATA \|
	168	I2C_FUNC_SMBUS_I2C_BLOCK;
e18563fc DB	169	dev->master_cfg = DW_IC_CON_MASTER \| DW_IC_CON_SLAVE_DISABLE \|
e18563fc DB	170	DW_IC_CON_RESTART_EN \| DW_IC_CON_SPEED_FAST;
2fa8326b	171
b61b1415 MW	172	/* Try first if we can configure the device from ACPI */
	173	r = dw_i2c_acpi_configure(pdev);
	174	if (r) {
f3fa9f3d	175	u32 param1 = i2c_dw_read_comp_param(dev);
2373f6b9 DB	176
	177	dev->tx_fifo_depth = ((param1 >> 16) & 0xff) + 1;
	178	dev->rx_fifo_depth = ((param1 >> 8) & 0xff) + 1;
b61b1415	179	dev->adapter.nr = pdev->id;
2373f6b9 DB	180	}
	181	r = i2c_dw_init(dev);
	182	if (r)
1cb715ca	183	return r;
2373f6b9	184
f3fa9f3d	185	i2c_dw_disable_int(dev);
1cb715ca AS	186	r = devm_request_irq(&pdev->dev, dev->irq, i2c_dw_isr, IRQF_SHARED,
1cb715ca AS	187	pdev->name, dev);
2373f6b9 DB	188	if (r) {
2373f6b9 DB	189	dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
1cb715ca	190	return r;
2373f6b9 DB	191	}
	192
	193	adap = &dev->adapter;
	194	i2c_set_adapdata(adap, dev);
	195	adap->owner = THIS_MODULE;
	196	adap->class = I2C_CLASS_HWMON;
	197	strlcpy(adap->name, "Synopsys DesignWare I2C adapter",
	198	sizeof(adap->name));
	199	adap->algo = &i2c_dw_algo;
	200	adap->dev.parent = &pdev->dev;
af71100c	201	adap->dev.of_node = pdev->dev.of_node;
2373f6b9	202
2373f6b9 DB	203	r = i2c_add_numbered_adapter(adap);
	204	if (r) {
	205	dev_err(&pdev->dev, "failure adding adapter\n");
1cb715ca	206	return r;
2373f6b9 DB	207	}
2373f6b9 DB	208
43452335 MW	209	pm_runtime_set_autosuspend_delay(&pdev->dev, 1000);
43452335 MW	210	pm_runtime_use_autosuspend(&pdev->dev);
7272194e MW	211	pm_runtime_set_active(&pdev->dev);
7272194e MW	212	pm_runtime_enable(&pdev->dev);
7272194e	213
2373f6b9	214	return 0;
2373f6b9 DB	215	}
2373f6b9 DB	216
0b255e92	217	static int dw_i2c_remove(struct platform_device *pdev)
2373f6b9 DB	218	{
2373f6b9 DB	219	struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
2373f6b9	220
7272194e MW	221	pm_runtime_get_sync(&pdev->dev);
7272194e MW	222
2373f6b9	223	i2c_del_adapter(&dev->adapter);
2373f6b9	224
f3fa9f3d	225	i2c_dw_disable(dev);
2373f6b9	226
7272194e MW	227	pm_runtime_put(&pdev->dev);
	228	pm_runtime_disable(&pdev->dev);
	229
2373f6b9 DB	230	return 0;
	231	}
	232
af71100c RH	233	#ifdef CONFIG_OF
	234	static const struct of_device_id dw_i2c_of_match[] = {
	235	{ .compatible = "snps,designware-i2c", },
	236	{},
	237	};
	238	MODULE_DEVICE_TABLE(of, dw_i2c_of_match);
	239	#endif
	240
dfb03fb2	241	#ifdef CONFIG_PM_SLEEP
3bf3b289 DS	242	static int dw_i2c_suspend(struct device *dev)
	243	{
	244	struct platform_device *pdev = to_platform_device(dev);
	245	struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev);
	246
e1fac69f	247	clk_disable_unprepare(i_dev->clk);
3bf3b289 DS	248
	249	return 0;
	250	}
	251
	252	static int dw_i2c_resume(struct device *dev)
	253	{
	254	struct platform_device *pdev = to_platform_device(dev);
	255	struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev);
	256
e1fac69f	257	clk_prepare_enable(i_dev->clk);
3bf3b289 DS	258	i2c_dw_init(i_dev);
	259
	260	return 0;
	261	}
3bf3b289 DS	262
3bf3b289 DS	263	static SIMPLE_DEV_PM_OPS(dw_i2c_dev_pm_ops, dw_i2c_suspend, dw_i2c_resume);
dfb03fb2 JH	264	#define DW_I2C_DEV_PM_OPS (&dw_i2c_dev_pm_ops)
	265	#else
	266	#define DW_I2C_DEV_PM_OPS NULL
	267	#endif
3bf3b289	268
2373f6b9 DB	269	/* work with hotplug and coldplug */
	270	MODULE_ALIAS("platform:i2c_designware");
	271
	272	static struct platform_driver dw_i2c_driver = {
0b255e92	273	.remove = dw_i2c_remove,
2373f6b9 DB	274	.driver = {
	275	.name = "i2c_designware",
	276	.owner = THIS_MODULE,
af71100c	277	.of_match_table = of_match_ptr(dw_i2c_of_match),
b61b1415	278	.acpi_match_table = ACPI_PTR(dw_i2c_acpi_match),
dfb03fb2	279	.pm = DW_I2C_DEV_PM_OPS,
2373f6b9 DB	280	},
	281	};
	282
	283	static int __init dw_i2c_init_driver(void)
	284	{
	285	return platform_driver_probe(&dw_i2c_driver, dw_i2c_probe);
	286	}
10452280	287	subsys_initcall(dw_i2c_init_driver);
2373f6b9 DB	288
	289	static void __exit dw_i2c_exit_driver(void)
	290	{
	291	platform_driver_unregister(&dw_i2c_driver);
	292	}
	293	module_exit(dw_i2c_exit_driver);
	294
	295	MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
	296	MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter");
	297	MODULE_LICENSE("GPL");