4 * Copyright (c) 2008-2009 Rodolfo Giometti <giometti@linux.it>
5 * Copyright (c) 2008-2009 Eurotech S.p.A. <info@eurotech.it>
7 * This module supports the PCA954x series of I2C multiplexer/switch chips
8 * made by Philips Semiconductors.
10 * PCA9540, PCA9542, PCA9543, PCA9544, PCA9545, PCA9546, PCA9547
13 * These chips are all controlled via the I2C bus itself, and all have a
14 * single 8-bit register. The upstream "parent" bus fans out to two,
15 * four, or eight downstream busses or channels; which of these
16 * are selected is determined by the chip type and register contents. A
17 * mux can select only one sub-bus at a time; a switch can select any
18 * combination simultaneously.
21 * pca954x.c from Kumar Gala <galak@kernel.crashing.org>
25 * pca954x.c from Ken Harrenstien
26 * Copyright (C) 2004 Google, Inc. (Ken Harrenstien)
29 * i2c-virtual_cb.c from Brian Kuschak <bkuschak@yahoo.com>
31 * pca9540.c from Jean Delvare <khali@linux-fr.org>.
33 * This file is licensed under the terms of the GNU General Public
34 * License version 2. This program is licensed "as is" without any
35 * warranty of any kind, whether express or implied.
38 #include <linux/device.h>
39 #include <linux/gpio.h>
40 #include <linux/i2c.h>
41 #include <linux/i2c-mux.h>
42 #include <linux/i2c/pca954x.h>
43 #include <linux/module.h>
44 #include <linux/of_gpio.h>
45 #include <linux/slab.h>
47 #define PCA954X_MAX_NCHANS 8
62 struct i2c_adapter *virt_adaps[PCA954X_MAX_NCHANS];
64 u8 last_chan; /* last register value */
69 u8 enable; /* used for muxes only */
76 /* Provide specs for the PCA954x types we know about */
77 static const struct chip_desc chips[] = {
81 .muxtype = pca954x_ismux,
85 .muxtype = pca954x_isswi,
90 .muxtype = pca954x_ismux,
94 .muxtype = pca954x_isswi,
99 .muxtype = pca954x_ismux,
103 .muxtype = pca954x_isswi,
107 static const struct i2c_device_id pca954x_id[] = {
108 { "pca9540", pca_9540 },
109 { "pca9542", pca_9540 },
110 { "pca9543", pca_9543 },
111 { "pca9544", pca_9544 },
112 { "pca9545", pca_9545 },
113 { "pca9546", pca_9545 },
114 { "pca9547", pca_9547 },
115 { "pca9548", pca_9548 },
118 MODULE_DEVICE_TABLE(i2c, pca954x_id);
120 /* Write to mux register. Don't use i2c_transfer()/i2c_smbus_xfer()
121 for this as they will try to lock adapter a second time */
122 static int pca954x_reg_write(struct i2c_adapter *adap,
123 struct i2c_client *client, u8 val)
127 if (adap->algo->master_xfer) {
131 msg.addr = client->addr;
136 ret = adap->algo->master_xfer(adap, &msg, 1);
138 union i2c_smbus_data data;
139 ret = adap->algo->smbus_xfer(adap, client->addr,
142 val, I2C_SMBUS_BYTE, &data);
148 static int pca954x_select_chan(struct i2c_adapter *adap,
149 void *client, u32 chan)
151 struct pca954x *data = i2c_get_clientdata(client);
152 const struct chip_desc *chip = &chips[data->type];
156 /* we make switches look like muxes, not sure how to be smarter */
157 if (chip->muxtype == pca954x_ismux)
158 regval = chan | chip->enable;
162 /* Only select the channel if its different from the last channel */
163 if (data->last_chan != regval) {
164 ret = pca954x_reg_write(adap, client, regval);
165 data->last_chan = regval;
171 static int pca954x_deselect_mux(struct i2c_adapter *adap,
172 void *client, u32 chan)
174 struct pca954x *data = i2c_get_clientdata(client);
176 /* Deselect active channel */
178 return pca954x_reg_write(adap, client, data->last_chan);
182 * I2C init/probing/exit functions
184 static int pca954x_probe(struct i2c_client *client,
185 const struct i2c_device_id *id)
187 struct i2c_adapter *adap = to_i2c_adapter(client->dev.parent);
188 struct pca954x_platform_data *pdata = dev_get_platdata(&client->dev);
189 struct device_node *np = client->dev.of_node;
190 int num, force, class;
191 struct pca954x *data;
194 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_BYTE))
197 data = devm_kzalloc(&client->dev, sizeof(struct pca954x), GFP_KERNEL);
201 i2c_set_clientdata(client, data);
203 if (IS_ENABLED(CONFIG_OF) && np) {
204 enum of_gpio_flags flags;
207 /* Get the mux out of reset if a reset GPIO is specified. */
208 gpio = of_get_named_gpio_flags(np, "reset-gpio", 0, &flags);
209 if (gpio_is_valid(gpio)) {
210 ret = devm_gpio_request_one(&client->dev, gpio,
211 flags & OF_GPIO_ACTIVE_LOW ?
212 GPIOF_OUT_INIT_HIGH : GPIOF_OUT_INIT_LOW,
219 /* Write the mux register at addr to verify
220 * that the mux is in fact present. This also
221 * initializes the mux to disconnected state.
223 if (i2c_smbus_write_byte(client, 0) < 0) {
224 dev_warn(&client->dev, "probe failed\n");
228 data->type = id->driver_data;
229 data->last_chan = 0; /* force the first selection */
231 /* Now create an adapter for each channel */
232 for (num = 0; num < chips[data->type].nchans; num++) {
233 force = 0; /* dynamic adap number */
234 class = 0; /* no class by default */
236 if (num < pdata->num_modes) {
237 /* force static number */
238 force = pdata->modes[num].adap_id;
239 class = pdata->modes[num].class;
241 /* discard unconfigured channels */
245 data->virt_adaps[num] =
246 i2c_add_mux_adapter(adap, &client->dev, client,
247 force, num, class, pca954x_select_chan,
248 (pdata && pdata->modes[num].deselect_on_exit)
249 ? pca954x_deselect_mux : NULL);
251 if (data->virt_adaps[num] == NULL) {
253 dev_err(&client->dev,
254 "failed to register multiplexed adapter"
255 " %d as bus %d\n", num, force);
256 goto virt_reg_failed;
260 dev_info(&client->dev,
261 "registered %d multiplexed busses for I2C %s %s\n",
262 num, chips[data->type].muxtype == pca954x_ismux
263 ? "mux" : "switch", client->name);
268 for (num--; num >= 0; num--)
269 i2c_del_mux_adapter(data->virt_adaps[num]);
273 static int pca954x_remove(struct i2c_client *client)
275 struct pca954x *data = i2c_get_clientdata(client);
276 const struct chip_desc *chip = &chips[data->type];
279 for (i = 0; i < chip->nchans; ++i)
280 if (data->virt_adaps[i]) {
281 i2c_del_mux_adapter(data->virt_adaps[i]);
282 data->virt_adaps[i] = NULL;
288 static struct i2c_driver pca954x_driver = {
291 .owner = THIS_MODULE,
293 .probe = pca954x_probe,
294 .remove = pca954x_remove,
295 .id_table = pca954x_id,
298 module_i2c_driver(pca954x_driver);
300 MODULE_AUTHOR("Rodolfo Giometti <giometti@linux.it>");
301 MODULE_DESCRIPTION("PCA954x I2C mux/switch driver");
302 MODULE_LICENSE("GPL v2");