Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * I2C multiplexer
4 *
5 * Copyright (c) 2008-2009 Rodolfo Giometti <giometti@linux.it>
6 * Copyright (c) 2008-2009 Eurotech S.p.A. <info@eurotech.it>
7 *
8 * This module supports the PCA954x and PCA984x series of I2C multiplexer/switch
9 * chips made by NXP Semiconductors.
10 * This includes the:
11 * PCA9540, PCA9542, PCA9543, PCA9544, PCA9545, PCA9546, PCA9547,
12 * PCA9548, PCA9846, PCA9847, PCA9848 and PCA9849.
13 *
14 * These chips are all controlled via the I2C bus itself, and all have a
15 * single 8-bit register. The upstream "parent" bus fans out to two,
16 * four, or eight downstream busses or channels; which of these
17 * are selected is determined by the chip type and register contents. A
18 * mux can select only one sub-bus at a time; a switch can select any
19 * combination simultaneously.
20 *
21 * Based on:
22 * pca954x.c from Kumar Gala <galak@kernel.crashing.org>
23 * Copyright (C) 2006
24 *
25 * Based on:
26 * pca954x.c from Ken Harrenstien
27 * Copyright (C) 2004 Google, Inc. (Ken Harrenstien)
28 *
29 * Based on:
30 * i2c-virtual_cb.c from Brian Kuschak <bkuschak@yahoo.com>
31 * and
32 * pca9540.c from Jean Delvare <jdelvare@suse.de>.
33 */
34
35#include <linux/device.h>
36#include <linux/delay.h>
37#include <linux/gpio/consumer.h>
38#include <linux/i2c.h>
39#include <linux/i2c-mux.h>
40#include <linux/interrupt.h>
41#include <linux/irq.h>
42#include <linux/module.h>
43#include <linux/pm.h>
44#include <linux/property.h>
45#include <linux/slab.h>
46#include <linux/spinlock.h>
47#include <dt-bindings/mux/mux.h>
48
49#define PCA954X_MAX_NCHANS 8
50
51#define PCA954X_IRQ_OFFSET 4
52
53enum pca_type {
54 pca_9540,
55 pca_9542,
56 pca_9543,
57 pca_9544,
58 pca_9545,
59 pca_9546,
60 pca_9547,
61 pca_9548,
62 pca_9846,
63 pca_9847,
64 pca_9848,
65 pca_9849,
66};
67
68struct chip_desc {
69 u8 nchans;
70 u8 enable; /* used for muxes only */
71 u8 has_irq;
72 enum muxtype {
73 pca954x_ismux = 0,
74 pca954x_isswi
75 } muxtype;
76 struct i2c_device_identity id;
77};
78
79struct pca954x {
80 const struct chip_desc *chip;
81
82 u8 last_chan; /* last register value */
83 /* MUX_IDLE_AS_IS, MUX_IDLE_DISCONNECT or >= 0 for channel */
84 s32 idle_state;
85
86 struct i2c_client *client;
87
88 struct irq_domain *irq;
89 unsigned int irq_mask;
90 raw_spinlock_t lock;
91};
92
93/* Provide specs for the PCA954x types we know about */
94static const struct chip_desc chips[] = {
95 [pca_9540] = {
96 .nchans = 2,
97 .enable = 0x4,
98 .muxtype = pca954x_ismux,
99 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
100 },
101 [pca_9542] = {
102 .nchans = 2,
103 .enable = 0x4,
104 .has_irq = 1,
105 .muxtype = pca954x_ismux,
106 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
107 },
108 [pca_9543] = {
109 .nchans = 2,
110 .has_irq = 1,
111 .muxtype = pca954x_isswi,
112 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
113 },
114 [pca_9544] = {
115 .nchans = 4,
116 .enable = 0x4,
117 .has_irq = 1,
118 .muxtype = pca954x_ismux,
119 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
120 },
121 [pca_9545] = {
122 .nchans = 4,
123 .has_irq = 1,
124 .muxtype = pca954x_isswi,
125 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
126 },
127 [pca_9546] = {
128 .nchans = 4,
129 .muxtype = pca954x_isswi,
130 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
131 },
132 [pca_9547] = {
133 .nchans = 8,
134 .enable = 0x8,
135 .muxtype = pca954x_ismux,
136 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
137 },
138 [pca_9548] = {
139 .nchans = 8,
140 .muxtype = pca954x_isswi,
141 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
142 },
143 [pca_9846] = {
144 .nchans = 4,
145 .muxtype = pca954x_isswi,
146 .id = {
147 .manufacturer_id = I2C_DEVICE_ID_NXP_SEMICONDUCTORS,
148 .part_id = 0x10b,
149 },
150 },
151 [pca_9847] = {
152 .nchans = 8,
153 .enable = 0x8,
154 .muxtype = pca954x_ismux,
155 .id = {
156 .manufacturer_id = I2C_DEVICE_ID_NXP_SEMICONDUCTORS,
157 .part_id = 0x108,
158 },
159 },
160 [pca_9848] = {
161 .nchans = 8,
162 .muxtype = pca954x_isswi,
163 .id = {
164 .manufacturer_id = I2C_DEVICE_ID_NXP_SEMICONDUCTORS,
165 .part_id = 0x10a,
166 },
167 },
168 [pca_9849] = {
169 .nchans = 4,
170 .enable = 0x4,
171 .muxtype = pca954x_ismux,
172 .id = {
173 .manufacturer_id = I2C_DEVICE_ID_NXP_SEMICONDUCTORS,
174 .part_id = 0x109,
175 },
176 },
177};
178
179static const struct i2c_device_id pca954x_id[] = {
180 { "pca9540", pca_9540 },
181 { "pca9542", pca_9542 },
182 { "pca9543", pca_9543 },
183 { "pca9544", pca_9544 },
184 { "pca9545", pca_9545 },
185 { "pca9546", pca_9546 },
186 { "pca9547", pca_9547 },
187 { "pca9548", pca_9548 },
188 { "pca9846", pca_9846 },
189 { "pca9847", pca_9847 },
190 { "pca9848", pca_9848 },
191 { "pca9849", pca_9849 },
192 { }
193};
194MODULE_DEVICE_TABLE(i2c, pca954x_id);
195
196static const struct of_device_id pca954x_of_match[] = {
197 { .compatible = "nxp,pca9540", .data = &chips[pca_9540] },
198 { .compatible = "nxp,pca9542", .data = &chips[pca_9542] },
199 { .compatible = "nxp,pca9543", .data = &chips[pca_9543] },
200 { .compatible = "nxp,pca9544", .data = &chips[pca_9544] },
201 { .compatible = "nxp,pca9545", .data = &chips[pca_9545] },
202 { .compatible = "nxp,pca9546", .data = &chips[pca_9546] },
203 { .compatible = "nxp,pca9547", .data = &chips[pca_9547] },
204 { .compatible = "nxp,pca9548", .data = &chips[pca_9548] },
205 { .compatible = "nxp,pca9846", .data = &chips[pca_9846] },
206 { .compatible = "nxp,pca9847", .data = &chips[pca_9847] },
207 { .compatible = "nxp,pca9848", .data = &chips[pca_9848] },
208 { .compatible = "nxp,pca9849", .data = &chips[pca_9849] },
209 {}
210};
211MODULE_DEVICE_TABLE(of, pca954x_of_match);
212
213/* Write to mux register. Don't use i2c_transfer()/i2c_smbus_xfer()
214 for this as they will try to lock adapter a second time */
215static int pca954x_reg_write(struct i2c_adapter *adap,
216 struct i2c_client *client, u8 val)
217{
218 union i2c_smbus_data dummy;
219
220 return __i2c_smbus_xfer(adap, client->addr, client->flags,
221 I2C_SMBUS_WRITE, val,
222 I2C_SMBUS_BYTE, &dummy);
223}
224
225static u8 pca954x_regval(struct pca954x *data, u8 chan)
226{
227 /* We make switches look like muxes, not sure how to be smarter. */
228 if (data->chip->muxtype == pca954x_ismux)
229 return chan | data->chip->enable;
230 else
231 return 1 << chan;
232}
233
234static int pca954x_select_chan(struct i2c_mux_core *muxc, u32 chan)
235{
236 struct pca954x *data = i2c_mux_priv(muxc);
237 struct i2c_client *client = data->client;
238 u8 regval;
239 int ret = 0;
240
241 regval = pca954x_regval(data, chan);
242 /* Only select the channel if its different from the last channel */
243 if (data->last_chan != regval) {
244 ret = pca954x_reg_write(muxc->parent, client, regval);
245 data->last_chan = ret < 0 ? 0 : regval;
246 }
247
248 return ret;
249}
250
251static int pca954x_deselect_mux(struct i2c_mux_core *muxc, u32 chan)
252{
253 struct pca954x *data = i2c_mux_priv(muxc);
254 struct i2c_client *client = data->client;
255 s32 idle_state;
256
257 idle_state = READ_ONCE(data->idle_state);
258 if (idle_state >= 0)
259 /* Set the mux back to a predetermined channel */
260 return pca954x_select_chan(muxc, idle_state);
261
262 if (idle_state == MUX_IDLE_DISCONNECT) {
263 /* Deselect active channel */
264 data->last_chan = 0;
265 return pca954x_reg_write(muxc->parent, client,
266 data->last_chan);
267 }
268
269 /* otherwise leave as-is */
270
271 return 0;
272}
273
274static ssize_t idle_state_show(struct device *dev,
275 struct device_attribute *attr,
276 char *buf)
277{
278 struct i2c_client *client = to_i2c_client(dev);
279 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
280 struct pca954x *data = i2c_mux_priv(muxc);
281
282 return sprintf(buf, "%d\n", READ_ONCE(data->idle_state));
283}
284
285static ssize_t idle_state_store(struct device *dev,
286 struct device_attribute *attr,
287 const char *buf, size_t count)
288{
289 struct i2c_client *client = to_i2c_client(dev);
290 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
291 struct pca954x *data = i2c_mux_priv(muxc);
292 int val;
293 int ret;
294
295 ret = kstrtoint(buf, 0, &val);
296 if (ret < 0)
297 return ret;
298
299 if (val != MUX_IDLE_AS_IS && val != MUX_IDLE_DISCONNECT &&
300 (val < 0 || val >= data->chip->nchans))
301 return -EINVAL;
302
303 i2c_lock_bus(muxc->parent, I2C_LOCK_SEGMENT);
304
305 WRITE_ONCE(data->idle_state, val);
306 /*
307 * Set the mux into a state consistent with the new
308 * idle_state.
309 */
310 if (data->last_chan || val != MUX_IDLE_DISCONNECT)
311 ret = pca954x_deselect_mux(muxc, 0);
312
313 i2c_unlock_bus(muxc->parent, I2C_LOCK_SEGMENT);
314
315 return ret < 0 ? ret : count;
316}
317
318static DEVICE_ATTR_RW(idle_state);
319
320static irqreturn_t pca954x_irq_handler(int irq, void *dev_id)
321{
322 struct pca954x *data = dev_id;
323 unsigned long pending;
324 int ret, i;
325
326 ret = i2c_smbus_read_byte(data->client);
327 if (ret < 0)
328 return IRQ_NONE;
329
330 pending = (ret >> PCA954X_IRQ_OFFSET) & (BIT(data->chip->nchans) - 1);
331 for_each_set_bit(i, &pending, data->chip->nchans)
332 handle_nested_irq(irq_linear_revmap(data->irq, i));
333
334 return IRQ_RETVAL(pending);
335}
336
337static int pca954x_irq_set_type(struct irq_data *idata, unsigned int type)
338{
339 if ((type & IRQ_TYPE_SENSE_MASK) != IRQ_TYPE_LEVEL_LOW)
340 return -EINVAL;
341 return 0;
342}
343
344static struct irq_chip pca954x_irq_chip = {
345 .name = "i2c-mux-pca954x",
346 .irq_set_type = pca954x_irq_set_type,
347};
348
349static int pca954x_irq_setup(struct i2c_mux_core *muxc)
350{
351 struct pca954x *data = i2c_mux_priv(muxc);
352 struct i2c_client *client = data->client;
353 int c, irq;
354
355 if (!data->chip->has_irq || client->irq <= 0)
356 return 0;
357
358 raw_spin_lock_init(&data->lock);
359
360 data->irq = irq_domain_add_linear(client->dev.of_node,
361 data->chip->nchans,
362 &irq_domain_simple_ops, data);
363 if (!data->irq)
364 return -ENODEV;
365
366 for (c = 0; c < data->chip->nchans; c++) {
367 irq = irq_create_mapping(data->irq, c);
368 if (!irq) {
369 dev_err(&client->dev, "failed irq create map\n");
370 return -EINVAL;
371 }
372 irq_set_chip_data(irq, data);
373 irq_set_chip_and_handler(irq, &pca954x_irq_chip,
374 handle_simple_irq);
375 }
376
377 return 0;
378}
379
380static void pca954x_cleanup(struct i2c_mux_core *muxc)
381{
382 struct pca954x *data = i2c_mux_priv(muxc);
383 int c, irq;
384
385 if (data->irq) {
386 for (c = 0; c < data->chip->nchans; c++) {
387 irq = irq_find_mapping(data->irq, c);
388 irq_dispose_mapping(irq);
389 }
390 irq_domain_remove(data->irq);
391 }
392 i2c_mux_del_adapters(muxc);
393}
394
395static int pca954x_init(struct i2c_client *client, struct pca954x *data)
396{
397 int ret;
398
399 if (data->idle_state >= 0)
400 data->last_chan = pca954x_regval(data, data->idle_state);
401 else
402 data->last_chan = 0; /* Disconnect multiplexer */
403
404 ret = i2c_smbus_write_byte(client, data->last_chan);
405 if (ret < 0)
406 data->last_chan = 0;
407
408 return ret;
409}
410
411/*
412 * I2C init/probing/exit functions
413 */
414static int pca954x_probe(struct i2c_client *client,
415 const struct i2c_device_id *id)
416{
417 struct i2c_adapter *adap = client->adapter;
418 struct device *dev = &client->dev;
419 struct gpio_desc *gpio;
420 struct i2c_mux_core *muxc;
421 struct pca954x *data;
422 int num;
423 int ret;
424
425 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_BYTE))
426 return -ENODEV;
427
428 muxc = i2c_mux_alloc(adap, dev, PCA954X_MAX_NCHANS, sizeof(*data), 0,
429 pca954x_select_chan, pca954x_deselect_mux);
430 if (!muxc)
431 return -ENOMEM;
432 data = i2c_mux_priv(muxc);
433
434 i2c_set_clientdata(client, muxc);
435 data->client = client;
436
437 /* Reset the mux if a reset GPIO is specified. */
438 gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_HIGH);
439 if (IS_ERR(gpio))
440 return PTR_ERR(gpio);
441 if (gpio) {
442 udelay(1);
443 gpiod_set_value_cansleep(gpio, 0);
444 /* Give the chip some time to recover. */
445 udelay(1);
446 }
447
448 data->chip = device_get_match_data(dev);
449 if (!data->chip)
450 data->chip = &chips[id->driver_data];
451
452 if (data->chip->id.manufacturer_id != I2C_DEVICE_ID_NONE) {
453 struct i2c_device_identity id;
454
455 ret = i2c_get_device_id(client, &id);
456 if (ret && ret != -EOPNOTSUPP)
457 return ret;
458
459 if (!ret &&
460 (id.manufacturer_id != data->chip->id.manufacturer_id ||
461 id.part_id != data->chip->id.part_id)) {
462 dev_warn(dev, "unexpected device id %03x-%03x-%x\n",
463 id.manufacturer_id, id.part_id,
464 id.die_revision);
465 return -ENODEV;
466 }
467 }
468
469 data->idle_state = MUX_IDLE_AS_IS;
470 if (device_property_read_u32(dev, "idle-state", &data->idle_state)) {
471 if (device_property_read_bool(dev, "i2c-mux-idle-disconnect"))
472 data->idle_state = MUX_IDLE_DISCONNECT;
473 }
474
475 /*
476 * Write the mux register at addr to verify
477 * that the mux is in fact present. This also
478 * initializes the mux to a channel
479 * or disconnected state.
480 */
481 ret = pca954x_init(client, data);
482 if (ret < 0) {
483 dev_warn(dev, "probe failed\n");
484 return -ENODEV;
485 }
486
487 ret = pca954x_irq_setup(muxc);
488 if (ret)
489 goto fail_cleanup;
490
491 /* Now create an adapter for each channel */
492 for (num = 0; num < data->chip->nchans; num++) {
493 ret = i2c_mux_add_adapter(muxc, 0, num, 0);
494 if (ret)
495 goto fail_cleanup;
496 }
497
498 if (data->irq) {
499 ret = devm_request_threaded_irq(dev, data->client->irq,
500 NULL, pca954x_irq_handler,
501 IRQF_ONESHOT | IRQF_SHARED,
502 "pca954x", data);
503 if (ret)
504 goto fail_cleanup;
505 }
506
507 /*
508 * The attr probably isn't going to be needed in most cases,
509 * so don't fail completely on error.
510 */
511 device_create_file(dev, &dev_attr_idle_state);
512
513 dev_info(dev, "registered %d multiplexed busses for I2C %s %s\n",
514 num, data->chip->muxtype == pca954x_ismux
515 ? "mux" : "switch", client->name);
516
517 return 0;
518
519fail_cleanup:
520 pca954x_cleanup(muxc);
521 return ret;
522}
523
524static int pca954x_remove(struct i2c_client *client)
525{
526 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
527
528 device_remove_file(&client->dev, &dev_attr_idle_state);
529
530 pca954x_cleanup(muxc);
531 return 0;
532}
533
534#ifdef CONFIG_PM_SLEEP
535static int pca954x_resume(struct device *dev)
536{
537 struct i2c_client *client = to_i2c_client(dev);
538 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
539 struct pca954x *data = i2c_mux_priv(muxc);
540 int ret;
541
542 ret = pca954x_init(client, data);
543 if (ret < 0)
544 dev_err(&client->dev, "failed to verify mux presence\n");
545
546 return ret;
547}
548#endif
549
550static SIMPLE_DEV_PM_OPS(pca954x_pm, NULL, pca954x_resume);
551
552static struct i2c_driver pca954x_driver = {
553 .driver = {
554 .name = "pca954x",
555 .pm = &pca954x_pm,
556 .of_match_table = pca954x_of_match,
557 },
558 .probe = pca954x_probe,
559 .remove = pca954x_remove,
560 .id_table = pca954x_id,
561};
562
563module_i2c_driver(pca954x_driver);
564
565MODULE_AUTHOR("Rodolfo Giometti <giometti@linux.it>");
566MODULE_DESCRIPTION("PCA954x I2C mux/switch driver");
567MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * I2C multiplexer
4 *
5 * Copyright (c) 2008-2009 Rodolfo Giometti <giometti@linux.it>
6 * Copyright (c) 2008-2009 Eurotech S.p.A. <info@eurotech.it>
7 *
8 * This module supports the PCA954x and PCA984x series of I2C multiplexer/switch
9 * chips made by NXP Semiconductors.
10 * This includes the:
11 * PCA9540, PCA9542, PCA9543, PCA9544, PCA9545, PCA9546, PCA9547,
12 * PCA9548, PCA9846, PCA9847, PCA9848 and PCA9849.
13 *
14 * It's also compatible to Maxims MAX735x I2C switch chips, which are controlled
15 * as the NXP PCA9548 and the MAX736x chips that act like the PCA9544.
16 *
17 * This includes the:
18 * MAX7356, MAX7357, MAX7358, MAX7367, MAX7368 and MAX7369
19 *
20 * These chips are all controlled via the I2C bus itself, and all have a
21 * single 8-bit register. The upstream "parent" bus fans out to two,
22 * four, or eight downstream busses or channels; which of these
23 * are selected is determined by the chip type and register contents. A
24 * mux can select only one sub-bus at a time; a switch can select any
25 * combination simultaneously.
26 *
27 * Based on:
28 * pca954x.c from Kumar Gala <galak@kernel.crashing.org>
29 * Copyright (C) 2006
30 *
31 * Based on:
32 * pca954x.c from Ken Harrenstien
33 * Copyright (C) 2004 Google, Inc. (Ken Harrenstien)
34 *
35 * Based on:
36 * i2c-virtual_cb.c from Brian Kuschak <bkuschak@yahoo.com>
37 * and
38 * pca9540.c from Jean Delvare <jdelvare@suse.de>.
39 */
40
41#include <linux/device.h>
42#include <linux/delay.h>
43#include <linux/gpio/consumer.h>
44#include <linux/i2c.h>
45#include <linux/i2c-mux.h>
46#include <linux/interrupt.h>
47#include <linux/irq.h>
48#include <linux/module.h>
49#include <linux/pm.h>
50#include <linux/property.h>
51#include <linux/regulator/consumer.h>
52#include <linux/slab.h>
53#include <linux/spinlock.h>
54#include <dt-bindings/mux/mux.h>
55
56#define PCA954X_MAX_NCHANS 8
57
58#define PCA954X_IRQ_OFFSET 4
59
60enum pca_type {
61 max_7356,
62 max_7357,
63 max_7358,
64 max_7367,
65 max_7368,
66 max_7369,
67 pca_9540,
68 pca_9542,
69 pca_9543,
70 pca_9544,
71 pca_9545,
72 pca_9546,
73 pca_9547,
74 pca_9548,
75 pca_9846,
76 pca_9847,
77 pca_9848,
78 pca_9849,
79};
80
81struct chip_desc {
82 u8 nchans;
83 u8 enable; /* used for muxes only */
84 u8 has_irq;
85 enum muxtype {
86 pca954x_ismux = 0,
87 pca954x_isswi
88 } muxtype;
89 struct i2c_device_identity id;
90};
91
92struct pca954x {
93 const struct chip_desc *chip;
94
95 u8 last_chan; /* last register value */
96 /* MUX_IDLE_AS_IS, MUX_IDLE_DISCONNECT or >= 0 for channel */
97 s32 idle_state;
98
99 struct i2c_client *client;
100
101 struct irq_domain *irq;
102 unsigned int irq_mask;
103 raw_spinlock_t lock;
104 struct regulator *supply;
105};
106
107/* Provide specs for the MAX735x, PCA954x and PCA984x types we know about */
108static const struct chip_desc chips[] = {
109 [max_7356] = {
110 .nchans = 8,
111 .muxtype = pca954x_isswi,
112 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
113 },
114 [max_7357] = {
115 .nchans = 8,
116 .muxtype = pca954x_isswi,
117 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
118 /*
119 * No interrupt controller support. The interrupt
120 * provides information about stuck channels.
121 */
122 },
123 [max_7358] = {
124 .nchans = 8,
125 .muxtype = pca954x_isswi,
126 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
127 /*
128 * No interrupt controller support. The interrupt
129 * provides information about stuck channels.
130 */
131 },
132 [max_7367] = {
133 .nchans = 4,
134 .muxtype = pca954x_isswi,
135 .has_irq = 1,
136 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
137 },
138 [max_7368] = {
139 .nchans = 4,
140 .muxtype = pca954x_isswi,
141 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
142 },
143 [max_7369] = {
144 .nchans = 4,
145 .enable = 0x4,
146 .muxtype = pca954x_ismux,
147 .has_irq = 1,
148 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
149 },
150 [pca_9540] = {
151 .nchans = 2,
152 .enable = 0x4,
153 .muxtype = pca954x_ismux,
154 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
155 },
156 [pca_9542] = {
157 .nchans = 2,
158 .enable = 0x4,
159 .has_irq = 1,
160 .muxtype = pca954x_ismux,
161 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
162 },
163 [pca_9543] = {
164 .nchans = 2,
165 .has_irq = 1,
166 .muxtype = pca954x_isswi,
167 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
168 },
169 [pca_9544] = {
170 .nchans = 4,
171 .enable = 0x4,
172 .has_irq = 1,
173 .muxtype = pca954x_ismux,
174 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
175 },
176 [pca_9545] = {
177 .nchans = 4,
178 .has_irq = 1,
179 .muxtype = pca954x_isswi,
180 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
181 },
182 [pca_9546] = {
183 .nchans = 4,
184 .muxtype = pca954x_isswi,
185 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
186 },
187 [pca_9547] = {
188 .nchans = 8,
189 .enable = 0x8,
190 .muxtype = pca954x_ismux,
191 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
192 },
193 [pca_9548] = {
194 .nchans = 8,
195 .muxtype = pca954x_isswi,
196 .id = { .manufacturer_id = I2C_DEVICE_ID_NONE },
197 },
198 [pca_9846] = {
199 .nchans = 4,
200 .muxtype = pca954x_isswi,
201 .id = {
202 .manufacturer_id = I2C_DEVICE_ID_NXP_SEMICONDUCTORS,
203 .part_id = 0x10b,
204 },
205 },
206 [pca_9847] = {
207 .nchans = 8,
208 .enable = 0x8,
209 .muxtype = pca954x_ismux,
210 .id = {
211 .manufacturer_id = I2C_DEVICE_ID_NXP_SEMICONDUCTORS,
212 .part_id = 0x108,
213 },
214 },
215 [pca_9848] = {
216 .nchans = 8,
217 .muxtype = pca954x_isswi,
218 .id = {
219 .manufacturer_id = I2C_DEVICE_ID_NXP_SEMICONDUCTORS,
220 .part_id = 0x10a,
221 },
222 },
223 [pca_9849] = {
224 .nchans = 4,
225 .enable = 0x4,
226 .muxtype = pca954x_ismux,
227 .id = {
228 .manufacturer_id = I2C_DEVICE_ID_NXP_SEMICONDUCTORS,
229 .part_id = 0x109,
230 },
231 },
232};
233
234static const struct i2c_device_id pca954x_id[] = {
235 { "max7356", max_7356 },
236 { "max7357", max_7357 },
237 { "max7358", max_7358 },
238 { "max7367", max_7367 },
239 { "max7368", max_7368 },
240 { "max7369", max_7369 },
241 { "pca9540", pca_9540 },
242 { "pca9542", pca_9542 },
243 { "pca9543", pca_9543 },
244 { "pca9544", pca_9544 },
245 { "pca9545", pca_9545 },
246 { "pca9546", pca_9546 },
247 { "pca9547", pca_9547 },
248 { "pca9548", pca_9548 },
249 { "pca9846", pca_9846 },
250 { "pca9847", pca_9847 },
251 { "pca9848", pca_9848 },
252 { "pca9849", pca_9849 },
253 { }
254};
255MODULE_DEVICE_TABLE(i2c, pca954x_id);
256
257static const struct of_device_id pca954x_of_match[] = {
258 { .compatible = "maxim,max7356", .data = &chips[max_7356] },
259 { .compatible = "maxim,max7357", .data = &chips[max_7357] },
260 { .compatible = "maxim,max7358", .data = &chips[max_7358] },
261 { .compatible = "maxim,max7367", .data = &chips[max_7367] },
262 { .compatible = "maxim,max7368", .data = &chips[max_7368] },
263 { .compatible = "maxim,max7369", .data = &chips[max_7369] },
264 { .compatible = "nxp,pca9540", .data = &chips[pca_9540] },
265 { .compatible = "nxp,pca9542", .data = &chips[pca_9542] },
266 { .compatible = "nxp,pca9543", .data = &chips[pca_9543] },
267 { .compatible = "nxp,pca9544", .data = &chips[pca_9544] },
268 { .compatible = "nxp,pca9545", .data = &chips[pca_9545] },
269 { .compatible = "nxp,pca9546", .data = &chips[pca_9546] },
270 { .compatible = "nxp,pca9547", .data = &chips[pca_9547] },
271 { .compatible = "nxp,pca9548", .data = &chips[pca_9548] },
272 { .compatible = "nxp,pca9846", .data = &chips[pca_9846] },
273 { .compatible = "nxp,pca9847", .data = &chips[pca_9847] },
274 { .compatible = "nxp,pca9848", .data = &chips[pca_9848] },
275 { .compatible = "nxp,pca9849", .data = &chips[pca_9849] },
276 {}
277};
278MODULE_DEVICE_TABLE(of, pca954x_of_match);
279
280/* Write to mux register. Don't use i2c_transfer()/i2c_smbus_xfer()
281 for this as they will try to lock adapter a second time */
282static int pca954x_reg_write(struct i2c_adapter *adap,
283 struct i2c_client *client, u8 val)
284{
285 union i2c_smbus_data dummy;
286
287 return __i2c_smbus_xfer(adap, client->addr, client->flags,
288 I2C_SMBUS_WRITE, val,
289 I2C_SMBUS_BYTE, &dummy);
290}
291
292static u8 pca954x_regval(struct pca954x *data, u8 chan)
293{
294 /* We make switches look like muxes, not sure how to be smarter. */
295 if (data->chip->muxtype == pca954x_ismux)
296 return chan | data->chip->enable;
297 else
298 return 1 << chan;
299}
300
301static int pca954x_select_chan(struct i2c_mux_core *muxc, u32 chan)
302{
303 struct pca954x *data = i2c_mux_priv(muxc);
304 struct i2c_client *client = data->client;
305 u8 regval;
306 int ret = 0;
307
308 regval = pca954x_regval(data, chan);
309 /* Only select the channel if its different from the last channel */
310 if (data->last_chan != regval) {
311 ret = pca954x_reg_write(muxc->parent, client, regval);
312 data->last_chan = ret < 0 ? 0 : regval;
313 }
314
315 return ret;
316}
317
318static int pca954x_deselect_mux(struct i2c_mux_core *muxc, u32 chan)
319{
320 struct pca954x *data = i2c_mux_priv(muxc);
321 struct i2c_client *client = data->client;
322 s32 idle_state;
323
324 idle_state = READ_ONCE(data->idle_state);
325 if (idle_state >= 0)
326 /* Set the mux back to a predetermined channel */
327 return pca954x_select_chan(muxc, idle_state);
328
329 if (idle_state == MUX_IDLE_DISCONNECT) {
330 /* Deselect active channel */
331 data->last_chan = 0;
332 return pca954x_reg_write(muxc->parent, client,
333 data->last_chan);
334 }
335
336 /* otherwise leave as-is */
337
338 return 0;
339}
340
341static ssize_t idle_state_show(struct device *dev,
342 struct device_attribute *attr,
343 char *buf)
344{
345 struct i2c_client *client = to_i2c_client(dev);
346 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
347 struct pca954x *data = i2c_mux_priv(muxc);
348
349 return sprintf(buf, "%d\n", READ_ONCE(data->idle_state));
350}
351
352static ssize_t idle_state_store(struct device *dev,
353 struct device_attribute *attr,
354 const char *buf, size_t count)
355{
356 struct i2c_client *client = to_i2c_client(dev);
357 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
358 struct pca954x *data = i2c_mux_priv(muxc);
359 int val;
360 int ret;
361
362 ret = kstrtoint(buf, 0, &val);
363 if (ret < 0)
364 return ret;
365
366 if (val != MUX_IDLE_AS_IS && val != MUX_IDLE_DISCONNECT &&
367 (val < 0 || val >= data->chip->nchans))
368 return -EINVAL;
369
370 i2c_lock_bus(muxc->parent, I2C_LOCK_SEGMENT);
371
372 WRITE_ONCE(data->idle_state, val);
373 /*
374 * Set the mux into a state consistent with the new
375 * idle_state.
376 */
377 if (data->last_chan || val != MUX_IDLE_DISCONNECT)
378 ret = pca954x_deselect_mux(muxc, 0);
379
380 i2c_unlock_bus(muxc->parent, I2C_LOCK_SEGMENT);
381
382 return ret < 0 ? ret : count;
383}
384
385static DEVICE_ATTR_RW(idle_state);
386
387static irqreturn_t pca954x_irq_handler(int irq, void *dev_id)
388{
389 struct pca954x *data = dev_id;
390 unsigned long pending;
391 int ret, i;
392
393 ret = i2c_smbus_read_byte(data->client);
394 if (ret < 0)
395 return IRQ_NONE;
396
397 pending = (ret >> PCA954X_IRQ_OFFSET) & (BIT(data->chip->nchans) - 1);
398 for_each_set_bit(i, &pending, data->chip->nchans)
399 handle_nested_irq(irq_linear_revmap(data->irq, i));
400
401 return IRQ_RETVAL(pending);
402}
403
404static int pca954x_irq_set_type(struct irq_data *idata, unsigned int type)
405{
406 if ((type & IRQ_TYPE_SENSE_MASK) != IRQ_TYPE_LEVEL_LOW)
407 return -EINVAL;
408 return 0;
409}
410
411static struct irq_chip pca954x_irq_chip = {
412 .name = "i2c-mux-pca954x",
413 .irq_set_type = pca954x_irq_set_type,
414};
415
416static int pca954x_irq_setup(struct i2c_mux_core *muxc)
417{
418 struct pca954x *data = i2c_mux_priv(muxc);
419 struct i2c_client *client = data->client;
420 int c, irq;
421
422 if (!data->chip->has_irq || client->irq <= 0)
423 return 0;
424
425 raw_spin_lock_init(&data->lock);
426
427 data->irq = irq_domain_add_linear(client->dev.of_node,
428 data->chip->nchans,
429 &irq_domain_simple_ops, data);
430 if (!data->irq)
431 return -ENODEV;
432
433 for (c = 0; c < data->chip->nchans; c++) {
434 irq = irq_create_mapping(data->irq, c);
435 if (!irq) {
436 dev_err(&client->dev, "failed irq create map\n");
437 return -EINVAL;
438 }
439 irq_set_chip_data(irq, data);
440 irq_set_chip_and_handler(irq, &pca954x_irq_chip,
441 handle_simple_irq);
442 }
443
444 return 0;
445}
446
447static void pca954x_cleanup(struct i2c_mux_core *muxc)
448{
449 struct pca954x *data = i2c_mux_priv(muxc);
450 int c, irq;
451
452 regulator_disable(data->supply);
453
454 if (data->irq) {
455 for (c = 0; c < data->chip->nchans; c++) {
456 irq = irq_find_mapping(data->irq, c);
457 irq_dispose_mapping(irq);
458 }
459 irq_domain_remove(data->irq);
460 }
461 i2c_mux_del_adapters(muxc);
462}
463
464static int pca954x_init(struct i2c_client *client, struct pca954x *data)
465{
466 int ret;
467
468 if (data->idle_state >= 0)
469 data->last_chan = pca954x_regval(data, data->idle_state);
470 else
471 data->last_chan = 0; /* Disconnect multiplexer */
472
473 ret = i2c_smbus_write_byte(client, data->last_chan);
474 if (ret < 0)
475 data->last_chan = 0;
476
477 return ret;
478}
479
480/*
481 * I2C init/probing/exit functions
482 */
483static int pca954x_probe(struct i2c_client *client)
484{
485 const struct i2c_device_id *id = i2c_client_get_device_id(client);
486 struct i2c_adapter *adap = client->adapter;
487 struct device *dev = &client->dev;
488 struct gpio_desc *gpio;
489 struct i2c_mux_core *muxc;
490 struct pca954x *data;
491 int num;
492 int ret;
493
494 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_BYTE))
495 return -ENODEV;
496
497 muxc = i2c_mux_alloc(adap, dev, PCA954X_MAX_NCHANS, sizeof(*data), 0,
498 pca954x_select_chan, pca954x_deselect_mux);
499 if (!muxc)
500 return -ENOMEM;
501 data = i2c_mux_priv(muxc);
502
503 i2c_set_clientdata(client, muxc);
504 data->client = client;
505
506 data->supply = devm_regulator_get(dev, "vdd");
507 if (IS_ERR(data->supply))
508 return dev_err_probe(dev, PTR_ERR(data->supply),
509 "Failed to request regulator\n");
510
511 ret = regulator_enable(data->supply);
512 if (ret)
513 return dev_err_probe(dev, ret,
514 "Failed to enable vdd supply\n");
515
516 /* Reset the mux if a reset GPIO is specified. */
517 gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_HIGH);
518 if (IS_ERR(gpio)) {
519 ret = PTR_ERR(gpio);
520 goto fail_cleanup;
521 }
522 if (gpio) {
523 udelay(1);
524 gpiod_set_value_cansleep(gpio, 0);
525 /* Give the chip some time to recover. */
526 udelay(1);
527 }
528
529 data->chip = device_get_match_data(dev);
530 if (!data->chip)
531 data->chip = &chips[id->driver_data];
532
533 if (data->chip->id.manufacturer_id != I2C_DEVICE_ID_NONE) {
534 struct i2c_device_identity id;
535
536 ret = i2c_get_device_id(client, &id);
537 if (ret && ret != -EOPNOTSUPP)
538 goto fail_cleanup;
539
540 if (!ret &&
541 (id.manufacturer_id != data->chip->id.manufacturer_id ||
542 id.part_id != data->chip->id.part_id)) {
543 dev_warn(dev, "unexpected device id %03x-%03x-%x\n",
544 id.manufacturer_id, id.part_id,
545 id.die_revision);
546 ret = -ENODEV;
547 goto fail_cleanup;
548 }
549 }
550
551 data->idle_state = MUX_IDLE_AS_IS;
552 if (device_property_read_u32(dev, "idle-state", &data->idle_state)) {
553 if (device_property_read_bool(dev, "i2c-mux-idle-disconnect"))
554 data->idle_state = MUX_IDLE_DISCONNECT;
555 }
556
557 /*
558 * Write the mux register at addr to verify
559 * that the mux is in fact present. This also
560 * initializes the mux to a channel
561 * or disconnected state.
562 */
563 ret = pca954x_init(client, data);
564 if (ret < 0) {
565 dev_warn(dev, "probe failed\n");
566 ret = -ENODEV;
567 goto fail_cleanup;
568 }
569
570 ret = pca954x_irq_setup(muxc);
571 if (ret)
572 goto fail_cleanup;
573
574 /* Now create an adapter for each channel */
575 for (num = 0; num < data->chip->nchans; num++) {
576 ret = i2c_mux_add_adapter(muxc, 0, num, 0);
577 if (ret)
578 goto fail_cleanup;
579 }
580
581 if (data->irq) {
582 ret = devm_request_threaded_irq(dev, data->client->irq,
583 NULL, pca954x_irq_handler,
584 IRQF_ONESHOT | IRQF_SHARED,
585 "pca954x", data);
586 if (ret)
587 goto fail_cleanup;
588 }
589
590 /*
591 * The attr probably isn't going to be needed in most cases,
592 * so don't fail completely on error.
593 */
594 device_create_file(dev, &dev_attr_idle_state);
595
596 dev_info(dev, "registered %d multiplexed busses for I2C %s %s\n",
597 num, data->chip->muxtype == pca954x_ismux
598 ? "mux" : "switch", client->name);
599
600 return 0;
601
602fail_cleanup:
603 pca954x_cleanup(muxc);
604 return ret;
605}
606
607static void pca954x_remove(struct i2c_client *client)
608{
609 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
610
611 device_remove_file(&client->dev, &dev_attr_idle_state);
612
613 pca954x_cleanup(muxc);
614}
615
616static int pca954x_resume(struct device *dev)
617{
618 struct i2c_client *client = to_i2c_client(dev);
619 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
620 struct pca954x *data = i2c_mux_priv(muxc);
621 int ret;
622
623 ret = pca954x_init(client, data);
624 if (ret < 0)
625 dev_err(&client->dev, "failed to verify mux presence\n");
626
627 return ret;
628}
629
630static DEFINE_SIMPLE_DEV_PM_OPS(pca954x_pm, NULL, pca954x_resume);
631
632static struct i2c_driver pca954x_driver = {
633 .driver = {
634 .name = "pca954x",
635 .pm = pm_sleep_ptr(&pca954x_pm),
636 .of_match_table = pca954x_of_match,
637 },
638 .probe = pca954x_probe,
639 .remove = pca954x_remove,
640 .id_table = pca954x_id,
641};
642
643module_i2c_driver(pca954x_driver);
644
645MODULE_AUTHOR("Rodolfo Giometti <giometti@linux.it>");
646MODULE_DESCRIPTION("PCA954x I2C mux/switch driver");
647MODULE_LICENSE("GPL v2");