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

/*
 * Multiplexed I2C bus driver.
 *
 * Copyright (c) 2008-2009 Rodolfo Giometti <giometti@linux.it>
 * Copyright (c) 2008-2009 Eurotech S.p.A. <info@eurotech.it>
 * Copyright (c) 2009-2010 NSN GmbH & Co KG <michael.lawnick.ext@nsn.com>
 *
 * Simplifies access to complex multiplexed I2C bus topologies, by presenting
 * each multiplexed bus segment as an additional I2C adapter.
 * Supports multi-level mux'ing (mux behind a mux).
 *
 * Based on:
 *	i2c-virt.c from Kumar Gala <galak@kernel.crashing.org>
 *	i2c-virtual.c from Ken Harrenstien, Copyright (c) 2004 Google, Inc.
 *	i2c-virtual.c from Brian Kuschak <bkuschak@yahoo.com>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2. This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/i2c-mux.h>
#include <linux/of.h>

/* multiplexer per channel data */
struct i2c_mux_priv {
	struct i2c_adapter adap;
	struct i2c_algorithm algo;

	struct i2c_adapter *parent;
	void *mux_priv;	/* the mux chip/device */
	u32  chan_id;	/* the channel id */

	int (*select)(struct i2c_adapter *, void *mux_priv, u32 chan_id);
	int (*deselect)(struct i2c_adapter *, void *mux_priv, u32 chan_id);
};

static int i2c_mux_master_xfer(struct i2c_adapter *adap,
			       struct i2c_msg msgs[], int num)
{
	struct i2c_mux_priv *priv = adap->algo_data;
	struct i2c_adapter *parent = priv->parent;
	int ret;

	/* Switch to the right mux port and perform the transfer. */

	ret = priv->select(parent, priv->mux_priv, priv->chan_id);
	if (ret >= 0)
		ret = parent->algo->master_xfer(parent, msgs, num);
	if (priv->deselect)
		priv->deselect(parent, priv->mux_priv, priv->chan_id);

	return ret;
}

static int i2c_mux_smbus_xfer(struct i2c_adapter *adap,
			      u16 addr, unsigned short flags,
			      char read_write, u8 command,
			      int size, union i2c_smbus_data *data)
{
	struct i2c_mux_priv *priv = adap->algo_data;
	struct i2c_adapter *parent = priv->parent;
	int ret;

	/* Select the right mux port and perform the transfer. */

	ret = priv->select(parent, priv->mux_priv, priv->chan_id);
	if (ret >= 0)
		ret = parent->algo->smbus_xfer(parent, addr, flags,
					read_write, command, size, data);
	if (priv->deselect)
		priv->deselect(parent, priv->mux_priv, priv->chan_id);

	return ret;
}

/* Return the parent's functionality */
static u32 i2c_mux_functionality(struct i2c_adapter *adap)
{
	struct i2c_mux_priv *priv = adap->algo_data;
	struct i2c_adapter *parent = priv->parent;

	return parent->algo->functionality(parent);
}

/* Return all parent classes, merged */
static unsigned int i2c_mux_parent_classes(struct i2c_adapter *parent)
{
	unsigned int class = 0;

	do {
		class |= parent->class;
		parent = i2c_parent_is_i2c_adapter(parent);
	} while (parent);

	return class;
}

struct i2c_adapter *i2c_add_mux_adapter(struct i2c_adapter *parent,
				struct device *mux_dev,
				void *mux_priv, u32 force_nr, u32 chan_id,
				unsigned int class,
				int (*select) (struct i2c_adapter *,
					       void *, u32),
				int (*deselect) (struct i2c_adapter *,
						 void *, u32))
{
	struct i2c_mux_priv *priv;
	int ret;

	priv = kzalloc(sizeof(struct i2c_mux_priv), GFP_KERNEL);
	if (!priv)
		return NULL;

	/* Set up private adapter data */
	priv->parent = parent;
	priv->mux_priv = mux_priv;
	priv->chan_id = chan_id;
	priv->select = select;
	priv->deselect = deselect;

	/* Need to do algo dynamically because we don't know ahead
	 * of time what sort of physical adapter we'll be dealing with.
	 */
	if (parent->algo->master_xfer)
		priv->algo.master_xfer = i2c_mux_master_xfer;
	if (parent->algo->smbus_xfer)
		priv->algo.smbus_xfer = i2c_mux_smbus_xfer;
	priv->algo.functionality = i2c_mux_functionality;

	/* Now fill out new adapter structure */
	snprintf(priv->adap.name, sizeof(priv->adap.name),
		 "i2c-%d-mux (chan_id %d)", i2c_adapter_id(parent), chan_id);
	priv->adap.owner = THIS_MODULE;
	priv->adap.algo = &priv->algo;
	priv->adap.algo_data = priv;
	priv->adap.dev.parent = &parent->dev;
	priv->adap.retries = parent->retries;
	priv->adap.timeout = parent->timeout;

	/* Sanity check on class */
	if (i2c_mux_parent_classes(parent) & class)
		dev_err(&parent->dev,
			"Segment %d behind mux can't share classes with ancestors\n",
			chan_id);
	else
		priv->adap.class = class;

	/*
	 * Try to populate the mux adapter's of_node, expands to
	 * nothing if !CONFIG_OF.
	 */
	if (mux_dev->of_node) {
		struct device_node *child;
		u32 reg;

		for_each_child_of_node(mux_dev->of_node, child) {
			ret = of_property_read_u32(child, "reg", &reg);
			if (ret)
				continue;
			if (chan_id == reg) {
				priv->adap.dev.of_node = child;
				break;
			}
		}
	}

	if (force_nr) {
		priv->adap.nr = force_nr;
		ret = i2c_add_numbered_adapter(&priv->adap);
	} else {
		ret = i2c_add_adapter(&priv->adap);
	}
	if (ret < 0) {
		dev_err(&parent->dev,
			"failed to add mux-adapter (error=%d)\n",
			ret);
		kfree(priv);
		return NULL;
	}

	dev_info(&parent->dev, "Added multiplexed i2c bus %d\n",
		 i2c_adapter_id(&priv->adap));

	return &priv->adap;
}
EXPORT_SYMBOL_GPL(i2c_add_mux_adapter);

void i2c_del_mux_adapter(struct i2c_adapter *adap)
{
	struct i2c_mux_priv *priv = adap->algo_data;

	i2c_del_adapter(adap);
	kfree(priv);
}
EXPORT_SYMBOL_GPL(i2c_del_mux_adapter);

MODULE_AUTHOR("Rodolfo Giometti <giometti@linux.it>");
MODULE_DESCRIPTION("I2C driver for multiplexed I2C busses");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
0826374b ML	1	/*
	2	* Multiplexed I2C bus driver.
	3	*
	4	* Copyright (c) 2008-2009 Rodolfo Giometti <giometti@linux.it>
	5	* Copyright (c) 2008-2009 Eurotech S.p.A. <info@eurotech.it>
	6	* Copyright (c) 2009-2010 NSN GmbH & Co KG <michael.lawnick.ext@nsn.com>
	7	*
	8	* Simplifies access to complex multiplexed I2C bus topologies, by presenting
	9	* each multiplexed bus segment as an additional I2C adapter.
	10	* Supports multi-level mux'ing (mux behind a mux).
	11	*
	12	* Based on:
	13	* i2c-virt.c from Kumar Gala <galak@kernel.crashing.org>
	14	* i2c-virtual.c from Ken Harrenstien, Copyright (c) 2004 Google, Inc.
	15	* i2c-virtual.c from Brian Kuschak <bkuschak@yahoo.com>
	16	*
	17	* This file is licensed under the terms of the GNU General Public
	18	* License version 2. This program is licensed "as is" without any
	19	* warranty of any kind, whether express or implied.
	20	*/
	21
	22	#include <linux/kernel.h>
	23	#include <linux/module.h>
	24	#include <linux/slab.h>
	25	#include <linux/i2c.h>
	26	#include <linux/i2c-mux.h>
bc45449b	27	#include <linux/of.h>
0826374b ML	28
	29	/* multiplexer per channel data */
	30	struct i2c_mux_priv {
	31	struct i2c_adapter adap;
	32	struct i2c_algorithm algo;
	33
	34	struct i2c_adapter *parent;
5a3ecd5f	35	void mux_priv; / the mux chip/device */
0826374b ML	36	u32 chan_id; /* the channel id */
0826374b ML	37
5a3ecd5f DD	38	int (select)(struct i2c_adapter , void *mux_priv, u32 chan_id);
5a3ecd5f DD	39	int (deselect)(struct i2c_adapter , void *mux_priv, u32 chan_id);
0826374b ML	40	};
	41
	42	static int i2c_mux_master_xfer(struct i2c_adapter *adap,
	43	struct i2c_msg msgs[], int num)
	44	{
	45	struct i2c_mux_priv *priv = adap->algo_data;
	46	struct i2c_adapter *parent = priv->parent;
	47	int ret;
	48
	49	/* Switch to the right mux port and perform the transfer. */
	50
5a3ecd5f	51	ret = priv->select(parent, priv->mux_priv, priv->chan_id);
0826374b ML	52	if (ret >= 0)
	53	ret = parent->algo->master_xfer(parent, msgs, num);
	54	if (priv->deselect)
5a3ecd5f	55	priv->deselect(parent, priv->mux_priv, priv->chan_id);
0826374b ML	56
	57	return ret;
	58	}
	59
	60	static int i2c_mux_smbus_xfer(struct i2c_adapter *adap,
	61	u16 addr, unsigned short flags,
	62	char read_write, u8 command,
	63	int size, union i2c_smbus_data *data)
	64	{
	65	struct i2c_mux_priv *priv = adap->algo_data;
	66	struct i2c_adapter *parent = priv->parent;
	67	int ret;
	68
	69	/* Select the right mux port and perform the transfer. */
	70
5a3ecd5f	71	ret = priv->select(parent, priv->mux_priv, priv->chan_id);
0826374b ML	72	if (ret >= 0)
	73	ret = parent->algo->smbus_xfer(parent, addr, flags,
	74	read_write, command, size, data);
	75	if (priv->deselect)
5a3ecd5f	76	priv->deselect(parent, priv->mux_priv, priv->chan_id);
0826374b ML	77
	78	return ret;
	79	}
	80
	81	/* Return the parent's functionality */
	82	static u32 i2c_mux_functionality(struct i2c_adapter *adap)
	83	{
	84	struct i2c_mux_priv *priv = adap->algo_data;
	85	struct i2c_adapter *parent = priv->parent;
	86
	87	return parent->algo->functionality(parent);
	88	}
	89
eee543e8 JD	90	/* Return all parent classes, merged */
	91	static unsigned int i2c_mux_parent_classes(struct i2c_adapter *parent)
	92	{
	93	unsigned int class = 0;
	94
	95	do {
	96	class \|= parent->class;
	97	parent = i2c_parent_is_i2c_adapter(parent);
	98	} while (parent);
	99
	100	return class;
	101	}
	102
0826374b	103	struct i2c_adapter i2c_add_mux_adapter(struct i2c_adapter parent,
5a3ecd5f DD	104	struct device *mux_dev,
5a3ecd5f DD	105	void *mux_priv, u32 force_nr, u32 chan_id,
eee543e8	106	unsigned int class,
0826374b ML	107	int (select) (struct i2c_adapter ,
	108	void *, u32),
	109	int (deselect) (struct i2c_adapter ,
	110	void *, u32))
	111	{
	112	struct i2c_mux_priv *priv;
	113	int ret;
	114
	115	priv = kzalloc(sizeof(struct i2c_mux_priv), GFP_KERNEL);
	116	if (!priv)
	117	return NULL;
	118
	119	/* Set up private adapter data */
	120	priv->parent = parent;
5a3ecd5f	121	priv->mux_priv = mux_priv;
0826374b ML	122	priv->chan_id = chan_id;
	123	priv->select = select;
	124	priv->deselect = deselect;
	125
	126	/* Need to do algo dynamically because we don't know ahead
	127	* of time what sort of physical adapter we'll be dealing with.
	128	*/
	129	if (parent->algo->master_xfer)
	130	priv->algo.master_xfer = i2c_mux_master_xfer;
	131	if (parent->algo->smbus_xfer)
	132	priv->algo.smbus_xfer = i2c_mux_smbus_xfer;
	133	priv->algo.functionality = i2c_mux_functionality;
	134
	135	/* Now fill out new adapter structure */
	136	snprintf(priv->adap.name, sizeof(priv->adap.name),
	137	"i2c-%d-mux (chan_id %d)", i2c_adapter_id(parent), chan_id);
	138	priv->adap.owner = THIS_MODULE;
0826374b ML	139	priv->adap.algo = &priv->algo;
	140	priv->adap.algo_data = priv;
	141	priv->adap.dev.parent = &parent->dev;
2212a852 EDB	142	priv->adap.retries = parent->retries;
2212a852 EDB	143	priv->adap.timeout = parent->timeout;
0826374b	144
eee543e8 JD	145	/* Sanity check on class */
	146	if (i2c_mux_parent_classes(parent) & class)
	147	dev_err(&parent->dev,
	148	"Segment %d behind mux can't share classes with ancestors\n",
	149	chan_id);
	150	else
	151	priv->adap.class = class;
	152
bc45449b DD	153	/*
	154	* Try to populate the mux adapter's of_node, expands to
	155	* nothing if !CONFIG_OF.
	156	*/
	157	if (mux_dev->of_node) {
	158	struct device_node *child;
	159	u32 reg;
	160
	161	for_each_child_of_node(mux_dev->of_node, child) {
	162	ret = of_property_read_u32(child, "reg", &reg);
	163	if (ret)
	164	continue;
	165	if (chan_id == reg) {
	166	priv->adap.dev.of_node = child;
	167	break;
	168	}
	169	}
	170	}
	171
0826374b ML	172	if (force_nr) {
	173	priv->adap.nr = force_nr;
	174	ret = i2c_add_numbered_adapter(&priv->adap);
	175	} else {
	176	ret = i2c_add_adapter(&priv->adap);
	177	}
	178	if (ret < 0) {
	179	dev_err(&parent->dev,
	180	"failed to add mux-adapter (error=%d)\n",
	181	ret);
	182	kfree(priv);
	183	return NULL;
	184	}
	185
	186	dev_info(&parent->dev, "Added multiplexed i2c bus %d\n",
	187	i2c_adapter_id(&priv->adap));
	188
	189	return &priv->adap;
	190	}
	191	EXPORT_SYMBOL_GPL(i2c_add_mux_adapter);
	192
51d95709	193	void i2c_del_mux_adapter(struct i2c_adapter *adap)
0826374b ML	194	{
0826374b ML	195	struct i2c_mux_priv *priv = adap->algo_data;
0826374b	196
bf51a8c5	197	i2c_del_adapter(adap);
0826374b	198	kfree(priv);
0826374b ML	199	}
	200	EXPORT_SYMBOL_GPL(i2c_del_mux_adapter);
	201
	202	MODULE_AUTHOR("Rodolfo Giometti <giometti@linux.it>");
	203	MODULE_DESCRIPTION("I2C driver for multiplexed I2C busses");
	204	MODULE_LICENSE("GPL v2");