[linux-2.6-block.git] / drivers / mfd / retu-mfd.c

/*
 * Retu/Tahvo MFD driver
 *
 * Copyright (C) 2004, 2005 Nokia Corporation
 *
 * Based on code written by Juha Yrjölä, David Weinehall and Mikko Ylinen.
 * Rewritten by Aaro Koskinen.
 *
 * This file is subject to the terms and conditions of the GNU General
 * Public License. See the file "COPYING" in the main directory of this
 * archive for more details.
 *
 * 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.
 */

#include <linux/err.h>
#include <linux/i2c.h>
#include <linux/irq.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/mutex.h>
#include <linux/module.h>
#include <linux/regmap.h>
#include <linux/mfd/core.h>
#include <linux/mfd/retu.h>
#include <linux/interrupt.h>
#include <linux/moduleparam.h>

/* Registers */
#define RETU_REG_ASICR		0x00		/* ASIC ID and revision */
#define RETU_REG_ASICR_VILMA	(1 << 7)	/* Bit indicating Vilma */
#define RETU_REG_IDR		0x01		/* Interrupt ID */
#define RETU_REG_IMR		0x02		/* Interrupt mask (Retu) */
#define TAHVO_REG_IMR		0x03		/* Interrupt mask (Tahvo) */

/* Interrupt sources */
#define RETU_INT_PWR		0		/* Power button */

struct retu_dev {
	struct regmap			*regmap;
	struct device			*dev;
	struct mutex			mutex;
	struct regmap_irq_chip_data	*irq_data;
};

static struct resource retu_pwrbutton_res[] = {
	{
		.name	= "retu-pwrbutton",
		.start	= RETU_INT_PWR,
		.end	= RETU_INT_PWR,
		.flags	= IORESOURCE_IRQ,
	},
};

static struct mfd_cell retu_devs[] = {
	{
		.name		= "retu-wdt"
	},
	{
		.name		= "retu-pwrbutton",
		.resources	= retu_pwrbutton_res,
		.num_resources	= ARRAY_SIZE(retu_pwrbutton_res),
	}
};

static struct regmap_irq retu_irqs[] = {
	[RETU_INT_PWR] = {
		.mask = 1 << RETU_INT_PWR,
	}
};

static struct regmap_irq_chip retu_irq_chip = {
	.name		= "RETU",
	.irqs		= retu_irqs,
	.num_irqs	= ARRAY_SIZE(retu_irqs),
	.num_regs	= 1,
	.status_base	= RETU_REG_IDR,
	.mask_base	= RETU_REG_IMR,
	.ack_base	= RETU_REG_IDR,
};

/* Retu device registered for the power off. */
static struct retu_dev *retu_pm_power_off;

static struct resource tahvo_usb_res[] = {
	{
		.name	= "tahvo-usb",
		.start	= TAHVO_INT_VBUS,
		.end	= TAHVO_INT_VBUS,
		.flags	= IORESOURCE_IRQ,
	},
};

static struct mfd_cell tahvo_devs[] = {
	{
		.name		= "tahvo-usb",
		.resources	= tahvo_usb_res,
		.num_resources	= ARRAY_SIZE(tahvo_usb_res),
	},
};

static struct regmap_irq tahvo_irqs[] = {
	[TAHVO_INT_VBUS] = {
		.mask = 1 << TAHVO_INT_VBUS,
	}
};

static struct regmap_irq_chip tahvo_irq_chip = {
	.name		= "TAHVO",
	.irqs		= tahvo_irqs,
	.num_irqs	= ARRAY_SIZE(tahvo_irqs),
	.num_regs	= 1,
	.status_base	= RETU_REG_IDR,
	.mask_base	= TAHVO_REG_IMR,
	.ack_base	= RETU_REG_IDR,
};

static const struct retu_data {
	char			*chip_name;
	char			*companion_name;
	struct regmap_irq_chip	*irq_chip;
	struct mfd_cell		*children;
	int			nchildren;
} retu_data[] = {
	[0] = {
		.chip_name	= "Retu",
		.companion_name	= "Vilma",
		.irq_chip	= &retu_irq_chip,
		.children	= retu_devs,
		.nchildren	= ARRAY_SIZE(retu_devs),
	},
	[1] = {
		.chip_name	= "Tahvo",
		.companion_name	= "Betty",
		.irq_chip	= &tahvo_irq_chip,
		.children	= tahvo_devs,
		.nchildren	= ARRAY_SIZE(tahvo_devs),
	}
};

int retu_read(struct retu_dev *rdev, u8 reg)
{
	int ret;
	int value;

	mutex_lock(&rdev->mutex);
	ret = regmap_read(rdev->regmap, reg, &value);
	mutex_unlock(&rdev->mutex);

	return ret ? ret : value;
}
EXPORT_SYMBOL_GPL(retu_read);

int retu_write(struct retu_dev *rdev, u8 reg, u16 data)
{
	int ret;

	mutex_lock(&rdev->mutex);
	ret = regmap_write(rdev->regmap, reg, data);
	mutex_unlock(&rdev->mutex);

	return ret;
}
EXPORT_SYMBOL_GPL(retu_write);

static void retu_power_off(void)
{
	struct retu_dev *rdev = retu_pm_power_off;
	int reg;

	mutex_lock(&retu_pm_power_off->mutex);

	/* Ignore power button state */
	regmap_read(rdev->regmap, RETU_REG_CC1, &reg);
	regmap_write(rdev->regmap, RETU_REG_CC1, reg | 2);

	/* Expire watchdog immediately */
	regmap_write(rdev->regmap, RETU_REG_WATCHDOG, 0);

	/* Wait for poweroff */
	for (;;)
		cpu_relax();

	mutex_unlock(&retu_pm_power_off->mutex);
}

static int retu_regmap_read(void *context, const void *reg, size_t reg_size,
			    void *val, size_t val_size)
{
	int ret;
	struct device *dev = context;
	struct i2c_client *i2c = to_i2c_client(dev);

	BUG_ON(reg_size != 1 || val_size != 2);

	ret = i2c_smbus_read_word_data(i2c, *(u8 const *)reg);
	if (ret < 0)
		return ret;

	*(u16 *)val = ret;
	return 0;
}

static int retu_regmap_write(void *context, const void *data, size_t count)
{
	u8 reg;
	u16 val;
	struct device *dev = context;
	struct i2c_client *i2c = to_i2c_client(dev);

	BUG_ON(count != sizeof(reg) + sizeof(val));
	memcpy(&reg, data, sizeof(reg));
	memcpy(&val, data + sizeof(reg), sizeof(val));
	return i2c_smbus_write_word_data(i2c, reg, val);
}

static struct regmap_bus retu_bus = {
	.read = retu_regmap_read,
	.write = retu_regmap_write,
	.val_format_endian_default = REGMAP_ENDIAN_NATIVE,
};

static struct regmap_config retu_config = {
	.reg_bits = 8,
	.val_bits = 16,
};

static int retu_probe(struct i2c_client *i2c, const struct i2c_device_id *id)
{
	struct retu_data const *rdat;
	struct retu_dev *rdev;
	int ret;

	if (i2c->addr > ARRAY_SIZE(retu_data))
		return -ENODEV;
	rdat = &retu_data[i2c->addr - 1];

	rdev = devm_kzalloc(&i2c->dev, sizeof(*rdev), GFP_KERNEL);
	if (rdev == NULL)
		return -ENOMEM;

	i2c_set_clientdata(i2c, rdev);
	rdev->dev = &i2c->dev;
	mutex_init(&rdev->mutex);
	rdev->regmap = devm_regmap_init(&i2c->dev, &retu_bus, &i2c->dev,
					&retu_config);
	if (IS_ERR(rdev->regmap))
		return PTR_ERR(rdev->regmap);

	ret = retu_read(rdev, RETU_REG_ASICR);
	if (ret < 0) {
		dev_err(rdev->dev, "could not read %s revision: %d\n",
			rdat->chip_name, ret);
		return ret;
	}

	dev_info(rdev->dev, "%s%s%s v%d.%d found\n", rdat->chip_name,
		 (ret & RETU_REG_ASICR_VILMA) ? " & " : "",
		 (ret & RETU_REG_ASICR_VILMA) ? rdat->companion_name : "",
		 (ret >> 4) & 0x7, ret & 0xf);

	/* Mask all interrupts. */
	ret = retu_write(rdev, rdat->irq_chip->mask_base, 0xffff);
	if (ret < 0)
		return ret;

	ret = regmap_add_irq_chip(rdev->regmap, i2c->irq, IRQF_ONESHOT, -1,
				  rdat->irq_chip, &rdev->irq_data);
	if (ret < 0)
		return ret;

	ret = mfd_add_devices(rdev->dev, -1, rdat->children, rdat->nchildren,
			      NULL, regmap_irq_chip_get_base(rdev->irq_data),
			      NULL);
	if (ret < 0) {
		regmap_del_irq_chip(i2c->irq, rdev->irq_data);
		return ret;
	}

	if (i2c->addr == 1 && !pm_power_off) {
		retu_pm_power_off = rdev;
		pm_power_off	  = retu_power_off;
	}

	return 0;
}

static int retu_remove(struct i2c_client *i2c)
{
	struct retu_dev *rdev = i2c_get_clientdata(i2c);

	if (retu_pm_power_off == rdev) {
		pm_power_off	  = NULL;
		retu_pm_power_off = NULL;
	}
	mfd_remove_devices(rdev->dev);
	regmap_del_irq_chip(i2c->irq, rdev->irq_data);

	return 0;
}

static const struct i2c_device_id retu_id[] = {
	{ "retu-mfd", 0 },
	{ "tahvo-mfd", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, retu_id);

static struct i2c_driver retu_driver = {
	.driver		= {
		.name = "retu-mfd",
		.owner = THIS_MODULE,
	},
	.probe		= retu_probe,
	.remove		= retu_remove,
	.id_table	= retu_id,
};
module_i2c_driver(retu_driver);

MODULE_DESCRIPTION("Retu MFD driver");
MODULE_AUTHOR("Juha Yrjölä");
MODULE_AUTHOR("David Weinehall");
MODULE_AUTHOR("Mikko Ylinen");
MODULE_AUTHOR("Aaro Koskinen <aaro.koskinen@iki.fi>");
MODULE_LICENSE("GPL");
Commit	Line	Data
c7b76dce	1	/*
95e50f6a	2	* Retu/Tahvo MFD driver
c7b76dce AK	3	*
	4	* Copyright (C) 2004, 2005 Nokia Corporation
	5	*
	6	* Based on code written by Juha Yrjölä, David Weinehall and Mikko Ylinen.
	7	* Rewritten by Aaro Koskinen.
	8	*
	9	* This file is subject to the terms and conditions of the GNU General
	10	* Public License. See the file "COPYING" in the main directory of this
	11	* archive for more details.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*/
	18
	19	#include <linux/err.h>
	20	#include <linux/i2c.h>
	21	#include <linux/irq.h>
	22	#include <linux/init.h>
	23	#include <linux/slab.h>
	24	#include <linux/mutex.h>
	25	#include <linux/module.h>
	26	#include <linux/regmap.h>
	27	#include <linux/mfd/core.h>
	28	#include <linux/mfd/retu.h>
	29	#include <linux/interrupt.h>
	30	#include <linux/moduleparam.h>
	31
	32	/* Registers */
	33	#define RETU_REG_ASICR 0x00 /* ASIC ID and revision */
	34	#define RETU_REG_ASICR_VILMA (1 << 7) /* Bit indicating Vilma */
	35	#define RETU_REG_IDR 0x01 /* Interrupt ID */
95e50f6a AK	36	#define RETU_REG_IMR 0x02 /* Interrupt mask (Retu) */
95e50f6a AK	37	#define TAHVO_REG_IMR 0x03 /* Interrupt mask (Tahvo) */
c7b76dce AK	38
	39	/* Interrupt sources */
	40	#define RETU_INT_PWR 0 /* Power button */
	41
	42	struct retu_dev {
	43	struct regmap *regmap;
	44	struct device *dev;
	45	struct mutex mutex;
	46	struct regmap_irq_chip_data *irq_data;
	47	};
	48
	49	static struct resource retu_pwrbutton_res[] = {
	50	{
	51	.name = "retu-pwrbutton",
	52	.start = RETU_INT_PWR,
	53	.end = RETU_INT_PWR,
	54	.flags = IORESOURCE_IRQ,
	55	},
	56	};
	57
	58	static struct mfd_cell retu_devs[] = {
	59	{
	60	.name = "retu-wdt"
	61	},
	62	{
	63	.name = "retu-pwrbutton",
	64	.resources = retu_pwrbutton_res,
	65	.num_resources = ARRAY_SIZE(retu_pwrbutton_res),
	66	}
	67	};
	68
	69	static struct regmap_irq retu_irqs[] = {
	70	[RETU_INT_PWR] = {
	71	.mask = 1 << RETU_INT_PWR,
	72	}
	73	};
	74
	75	static struct regmap_irq_chip retu_irq_chip = {
	76	.name = "RETU",
	77	.irqs = retu_irqs,
	78	.num_irqs = ARRAY_SIZE(retu_irqs),
	79	.num_regs = 1,
	80	.status_base = RETU_REG_IDR,
	81	.mask_base = RETU_REG_IMR,
	82	.ack_base = RETU_REG_IDR,
	83	};
	84
	85	/* Retu device registered for the power off. */
	86	static struct retu_dev *retu_pm_power_off;
	87
95e50f6a AK	88	static struct resource tahvo_usb_res[] = {
	89	{
	90	.name = "tahvo-usb",
	91	.start = TAHVO_INT_VBUS,
	92	.end = TAHVO_INT_VBUS,
	93	.flags = IORESOURCE_IRQ,
	94	},
	95	};
	96
	97	static struct mfd_cell tahvo_devs[] = {
	98	{
	99	.name = "tahvo-usb",
	100	.resources = tahvo_usb_res,
	101	.num_resources = ARRAY_SIZE(tahvo_usb_res),
	102	},
	103	};
	104
	105	static struct regmap_irq tahvo_irqs[] = {
	106	[TAHVO_INT_VBUS] = {
	107	.mask = 1 << TAHVO_INT_VBUS,
	108	}
	109	};
	110
	111	static struct regmap_irq_chip tahvo_irq_chip = {
	112	.name = "TAHVO",
	113	.irqs = tahvo_irqs,
	114	.num_irqs = ARRAY_SIZE(tahvo_irqs),
	115	.num_regs = 1,
	116	.status_base = RETU_REG_IDR,
	117	.mask_base = TAHVO_REG_IMR,
	118	.ack_base = RETU_REG_IDR,
	119	};
	120
	121	static const struct retu_data {
	122	char *chip_name;
	123	char *companion_name;
	124	struct regmap_irq_chip *irq_chip;
	125	struct mfd_cell *children;
	126	int nchildren;
	127	} retu_data[] = {
	128	[0] = {
	129	.chip_name = "Retu",
	130	.companion_name = "Vilma",
	131	.irq_chip = &retu_irq_chip,
	132	.children = retu_devs,
	133	.nchildren = ARRAY_SIZE(retu_devs),
	134	},
	135	[1] = {
	136	.chip_name = "Tahvo",
	137	.companion_name = "Betty",
	138	.irq_chip = &tahvo_irq_chip,
	139	.children = tahvo_devs,
	140	.nchildren = ARRAY_SIZE(tahvo_devs),
	141	}
	142	};
	143
c7b76dce AK	144	int retu_read(struct retu_dev *rdev, u8 reg)
	145	{
	146	int ret;
	147	int value;
	148
	149	mutex_lock(&rdev->mutex);
	150	ret = regmap_read(rdev->regmap, reg, &value);
	151	mutex_unlock(&rdev->mutex);
	152
	153	return ret ? ret : value;
	154	}
	155	EXPORT_SYMBOL_GPL(retu_read);
	156
	157	int retu_write(struct retu_dev *rdev, u8 reg, u16 data)
	158	{
	159	int ret;
	160
	161	mutex_lock(&rdev->mutex);
	162	ret = regmap_write(rdev->regmap, reg, data);
	163	mutex_unlock(&rdev->mutex);
	164
	165	return ret;
	166	}
	167	EXPORT_SYMBOL_GPL(retu_write);
	168
	169	static void retu_power_off(void)
	170	{
	171	struct retu_dev *rdev = retu_pm_power_off;
	172	int reg;
	173
	174	mutex_lock(&retu_pm_power_off->mutex);
	175
	176	/* Ignore power button state */
	177	regmap_read(rdev->regmap, RETU_REG_CC1, &reg);
	178	regmap_write(rdev->regmap, RETU_REG_CC1, reg \| 2);
	179
	180	/* Expire watchdog immediately */
	181	regmap_write(rdev->regmap, RETU_REG_WATCHDOG, 0);
	182
	183	/* Wait for poweroff */
	184	for (;;)
	185	cpu_relax();
	186
	187	mutex_unlock(&retu_pm_power_off->mutex);
	188	}
	189
	190	static int retu_regmap_read(void context, const void reg, size_t reg_size,
	191	void *val, size_t val_size)
	192	{
	193	int ret;
	194	struct device *dev = context;
	195	struct i2c_client *i2c = to_i2c_client(dev);
	196
	197	BUG_ON(reg_size != 1 \|\| val_size != 2);
	198
	199	ret = i2c_smbus_read_word_data(i2c, (u8 const )reg);
	200	if (ret < 0)
	201	return ret;
	202
	203	(u16 )val = ret;
	204	return 0;
	205	}
	206
	207	static int retu_regmap_write(void context, const void data, size_t count)
208	{
209	u8 reg;
210	u16 val;
211	struct device *dev = context;
212	struct i2c_client *i2c = to_i2c_client(dev);
213
214	BUG_ON(count != sizeof(reg) + sizeof(val));
215	memcpy(&reg, data, sizeof(reg));
216	memcpy(&val, data + sizeof(reg), sizeof(val));
217	return i2c_smbus_write_word_data(i2c, reg, val);
218	}
219
220	static struct regmap_bus retu_bus = {
221	.read = retu_regmap_read,
222	.write = retu_regmap_write,
223	.val_format_endian_default = REGMAP_ENDIAN_NATIVE,
224	};
225
226	static struct regmap_config retu_config = {
227	.reg_bits = 8,
228	.val_bits = 16,
229	};
230
612b95cd	231	static int retu_probe(struct i2c_client i2c, const struct i2c_device_id id)
c7b76dce	232	{
95e50f6a	233	struct retu_data const *rdat;
c7b76dce AK	234	struct retu_dev *rdev;
	235	int ret;
	236
95e50f6a AK	237	if (i2c->addr > ARRAY_SIZE(retu_data))
	238	return -ENODEV;
	239	rdat = &retu_data[i2c->addr - 1];
	240
c7b76dce AK	241	rdev = devm_kzalloc(&i2c->dev, sizeof(*rdev), GFP_KERNEL);
	242	if (rdev == NULL)
	243	return -ENOMEM;
	244
	245	i2c_set_clientdata(i2c, rdev);
	246	rdev->dev = &i2c->dev;
	247	mutex_init(&rdev->mutex);
	248	rdev->regmap = devm_regmap_init(&i2c->dev, &retu_bus, &i2c->dev,
	249	&retu_config);
	250	if (IS_ERR(rdev->regmap))
	251	return PTR_ERR(rdev->regmap);
	252
	253	ret = retu_read(rdev, RETU_REG_ASICR);
	254	if (ret < 0) {
95e50f6a AK	255	dev_err(rdev->dev, "could not read %s revision: %d\n",
95e50f6a AK	256	rdat->chip_name, ret);
c7b76dce AK	257	return ret;
	258	}
	259
95e50f6a AK	260	dev_info(rdev->dev, "%s%s%s v%d.%d found\n", rdat->chip_name,
	261	(ret & RETU_REG_ASICR_VILMA) ? " & " : "",
	262	(ret & RETU_REG_ASICR_VILMA) ? rdat->companion_name : "",
c7b76dce AK	263	(ret >> 4) & 0x7, ret & 0xf);
c7b76dce AK	264
95e50f6a AK	265	/* Mask all interrupts. */
95e50f6a AK	266	ret = retu_write(rdev, rdat->irq_chip->mask_base, 0xffff);
c7b76dce AK	267	if (ret < 0)
	268	return ret;
	269
	270	ret = regmap_add_irq_chip(rdev->regmap, i2c->irq, IRQF_ONESHOT, -1,
95e50f6a	271	rdat->irq_chip, &rdev->irq_data);
c7b76dce AK	272	if (ret < 0)
	273	return ret;
	274
95e50f6a	275	ret = mfd_add_devices(rdev->dev, -1, rdat->children, rdat->nchildren,
c7b76dce AK	276	NULL, regmap_irq_chip_get_base(rdev->irq_data),
	277	NULL);
	278	if (ret < 0) {
	279	regmap_del_irq_chip(i2c->irq, rdev->irq_data);
	280	return ret;
	281	}
	282
95e50f6a	283	if (i2c->addr == 1 && !pm_power_off) {
c7b76dce AK	284	retu_pm_power_off = rdev;
	285	pm_power_off = retu_power_off;
	286	}
	287
	288	return 0;
	289	}
	290
612b95cd	291	static int retu_remove(struct i2c_client *i2c)
c7b76dce AK	292	{
	293	struct retu_dev *rdev = i2c_get_clientdata(i2c);
	294
	295	if (retu_pm_power_off == rdev) {
	296	pm_power_off = NULL;
	297	retu_pm_power_off = NULL;
	298	}
	299	mfd_remove_devices(rdev->dev);
	300	regmap_del_irq_chip(i2c->irq, rdev->irq_data);
	301
	302	return 0;
	303	}
	304
	305	static const struct i2c_device_id retu_id[] = {
	306	{ "retu-mfd", 0 },
95e50f6a	307	{ "tahvo-mfd", 0 },
c7b76dce AK	308	{ }
	309	};
	310	MODULE_DEVICE_TABLE(i2c, retu_id);
	311
	312	static struct i2c_driver retu_driver = {
	313	.driver = {
	314	.name = "retu-mfd",
	315	.owner = THIS_MODULE,
	316	},
	317	.probe = retu_probe,
	318	.remove = retu_remove,
	319	.id_table = retu_id,
	320	};
	321	module_i2c_driver(retu_driver);
	322
	323	MODULE_DESCRIPTION("Retu MFD driver");
	324	MODULE_AUTHOR("Juha Yrjölä");
	325	MODULE_AUTHOR("David Weinehall");
	326	MODULE_AUTHOR("Mikko Ylinen");
	327	MODULE_AUTHOR("Aaro Koskinen <aaro.koskinen@iki.fi>");
	328	MODULE_LICENSE("GPL");