Merge tag 'v3.19-rc5' into devel
[cascardo/linux.git] / drivers / gpio / gpio-sx150x.c
1 /* Copyright (c) 2010, Code Aurora Forum. All rights reserved.
2  *
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 and
5  * only version 2 as published by the Free Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 #include <linux/gpio.h>
18 #include <linux/i2c.h>
19 #include <linux/init.h>
20 #include <linux/interrupt.h>
21 #include <linux/irq.h>
22 #include <linux/module.h>
23 #include <linux/mutex.h>
24 #include <linux/slab.h>
25 #include <linux/i2c/sx150x.h>
26 #include <linux/of.h>
27 #include <linux/of_address.h>
28 #include <linux/of_irq.h>
29 #include <linux/of_gpio.h>
30 #include <linux/of_device.h>
31
32 #define NO_UPDATE_PENDING       -1
33
34 /* The chip models of sx150x */
35 #define SX150X_456 0
36 #define SX150X_789 1
37
38 struct sx150x_456_pri {
39         u8 reg_pld_mode;
40         u8 reg_pld_table0;
41         u8 reg_pld_table1;
42         u8 reg_pld_table2;
43         u8 reg_pld_table3;
44         u8 reg_pld_table4;
45         u8 reg_advance;
46 };
47
48 struct sx150x_789_pri {
49         u8 reg_drain;
50         u8 reg_polarity;
51         u8 reg_clock;
52         u8 reg_misc;
53         u8 reg_reset;
54         u8 ngpios;
55 };
56
57 struct sx150x_device_data {
58         u8 model;
59         u8 reg_pullup;
60         u8 reg_pulldn;
61         u8 reg_dir;
62         u8 reg_data;
63         u8 reg_irq_mask;
64         u8 reg_irq_src;
65         u8 reg_sense;
66         u8 ngpios;
67         union {
68                 struct sx150x_456_pri x456;
69                 struct sx150x_789_pri x789;
70         } pri;
71 };
72
73 struct sx150x_chip {
74         struct gpio_chip                 gpio_chip;
75         struct i2c_client               *client;
76         const struct sx150x_device_data *dev_cfg;
77         int                              irq_summary;
78         int                              irq_base;
79         int                              irq_update;
80         u32                              irq_sense;
81         u32                              irq_masked;
82         u32                              dev_sense;
83         u32                              dev_masked;
84         struct irq_chip                  irq_chip;
85         struct mutex                     lock;
86 };
87
88 static const struct sx150x_device_data sx150x_devices[] = {
89         [0] = { /* sx1508q */
90                 .model = SX150X_789,
91                 .reg_pullup     = 0x03,
92                 .reg_pulldn     = 0x04,
93                 .reg_dir        = 0x07,
94                 .reg_data       = 0x08,
95                 .reg_irq_mask   = 0x09,
96                 .reg_irq_src    = 0x0c,
97                 .reg_sense      = 0x0b,
98                 .pri.x789 = {
99                         .reg_drain      = 0x05,
100                         .reg_polarity   = 0x06,
101                         .reg_clock      = 0x0f,
102                         .reg_misc       = 0x10,
103                         .reg_reset      = 0x7d,
104                 },
105                 .ngpios = 8,
106         },
107         [1] = { /* sx1509q */
108                 .model = SX150X_789,
109                 .reg_pullup     = 0x07,
110                 .reg_pulldn     = 0x09,
111                 .reg_dir        = 0x0f,
112                 .reg_data       = 0x11,
113                 .reg_irq_mask   = 0x13,
114                 .reg_irq_src    = 0x19,
115                 .reg_sense      = 0x17,
116                 .pri.x789 = {
117                         .reg_drain      = 0x0b,
118                         .reg_polarity   = 0x0d,
119                         .reg_clock      = 0x1e,
120                         .reg_misc       = 0x1f,
121                         .reg_reset      = 0x7d,
122                 },
123                 .ngpios = 16
124         },
125         [2] = { /* sx1506q */
126                 .model = SX150X_456,
127                 .reg_pullup     = 0x05,
128                 .reg_pulldn     = 0x07,
129                 .reg_dir        = 0x03,
130                 .reg_data       = 0x01,
131                 .reg_irq_mask   = 0x09,
132                 .reg_irq_src    = 0x0f,
133                 .reg_sense      = 0x0d,
134                 .pri.x456 = {
135                         .reg_pld_mode   = 0x21,
136                         .reg_pld_table0 = 0x23,
137                         .reg_pld_table1 = 0x25,
138                         .reg_pld_table2 = 0x27,
139                         .reg_pld_table3 = 0x29,
140                         .reg_pld_table4 = 0x2b,
141                         .reg_advance    = 0xad,
142                 },
143                 .ngpios = 16
144         },
145 };
146
147 static const struct i2c_device_id sx150x_id[] = {
148         {"sx1508q", 0},
149         {"sx1509q", 1},
150         {"sx1506q", 2},
151         {}
152 };
153 MODULE_DEVICE_TABLE(i2c, sx150x_id);
154
155 static const struct of_device_id sx150x_dt_id[] = {
156         { .compatible = "semtech,sx1508q" },
157         { .compatible = "semtech,sx1509q" },
158         { .compatible = "semtech,sx1506q" },
159         {},
160 };
161
162 static s32 sx150x_i2c_write(struct i2c_client *client, u8 reg, u8 val)
163 {
164         s32 err = i2c_smbus_write_byte_data(client, reg, val);
165
166         if (err < 0)
167                 dev_warn(&client->dev,
168                         "i2c write fail: can't write %02x to %02x: %d\n",
169                         val, reg, err);
170         return err;
171 }
172
173 static s32 sx150x_i2c_read(struct i2c_client *client, u8 reg, u8 *val)
174 {
175         s32 err = i2c_smbus_read_byte_data(client, reg);
176
177         if (err >= 0)
178                 *val = err;
179         else
180                 dev_warn(&client->dev,
181                         "i2c read fail: can't read from %02x: %d\n",
182                         reg, err);
183         return err;
184 }
185
186 static inline bool offset_is_oscio(struct sx150x_chip *chip, unsigned offset)
187 {
188         return (chip->dev_cfg->ngpios == offset);
189 }
190
191 /*
192  * These utility functions solve the common problem of locating and setting
193  * configuration bits.  Configuration bits are grouped into registers
194  * whose indexes increase downwards.  For example, with eight-bit registers,
195  * sixteen gpios would have their config bits grouped in the following order:
196  * REGISTER N-1 [ f e d c b a 9 8 ]
197  *          N   [ 7 6 5 4 3 2 1 0 ]
198  *
199  * For multi-bit configurations, the pattern gets wider:
200  * REGISTER N-3 [ f f e e d d c c ]
201  *          N-2 [ b b a a 9 9 8 8 ]
202  *          N-1 [ 7 7 6 6 5 5 4 4 ]
203  *          N   [ 3 3 2 2 1 1 0 0 ]
204  *
205  * Given the address of the starting register 'N', the index of the gpio
206  * whose configuration we seek to change, and the width in bits of that
207  * configuration, these functions allow us to locate the correct
208  * register and mask the correct bits.
209  */
210 static inline void sx150x_find_cfg(u8 offset, u8 width,
211                                 u8 *reg, u8 *mask, u8 *shift)
212 {
213         *reg   -= offset * width / 8;
214         *mask   = (1 << width) - 1;
215         *shift  = (offset * width) % 8;
216         *mask <<= *shift;
217 }
218
219 static s32 sx150x_write_cfg(struct sx150x_chip *chip,
220                         u8 offset, u8 width, u8 reg, u8 val)
221 {
222         u8  mask;
223         u8  data;
224         u8  shift;
225         s32 err;
226
227         sx150x_find_cfg(offset, width, &reg, &mask, &shift);
228         err = sx150x_i2c_read(chip->client, reg, &data);
229         if (err < 0)
230                 return err;
231
232         data &= ~mask;
233         data |= (val << shift) & mask;
234         return sx150x_i2c_write(chip->client, reg, data);
235 }
236
237 static int sx150x_get_io(struct sx150x_chip *chip, unsigned offset)
238 {
239         u8  reg = chip->dev_cfg->reg_data;
240         u8  mask;
241         u8  data;
242         u8  shift;
243         s32 err;
244
245         sx150x_find_cfg(offset, 1, &reg, &mask, &shift);
246         err = sx150x_i2c_read(chip->client, reg, &data);
247         if (err >= 0)
248                 err = (data & mask) != 0 ? 1 : 0;
249
250         return err;
251 }
252
253 static void sx150x_set_oscio(struct sx150x_chip *chip, int val)
254 {
255         sx150x_i2c_write(chip->client,
256                         chip->dev_cfg->pri.x789.reg_clock,
257                         (val ? 0x1f : 0x10));
258 }
259
260 static void sx150x_set_io(struct sx150x_chip *chip, unsigned offset, int val)
261 {
262         sx150x_write_cfg(chip,
263                         offset,
264                         1,
265                         chip->dev_cfg->reg_data,
266                         (val ? 1 : 0));
267 }
268
269 static int sx150x_io_input(struct sx150x_chip *chip, unsigned offset)
270 {
271         return sx150x_write_cfg(chip,
272                                 offset,
273                                 1,
274                                 chip->dev_cfg->reg_dir,
275                                 1);
276 }
277
278 static int sx150x_io_output(struct sx150x_chip *chip, unsigned offset, int val)
279 {
280         int err;
281
282         err = sx150x_write_cfg(chip,
283                         offset,
284                         1,
285                         chip->dev_cfg->reg_data,
286                         (val ? 1 : 0));
287         if (err >= 0)
288                 err = sx150x_write_cfg(chip,
289                                 offset,
290                                 1,
291                                 chip->dev_cfg->reg_dir,
292                                 0);
293         return err;
294 }
295
296 static int sx150x_gpio_get(struct gpio_chip *gc, unsigned offset)
297 {
298         struct sx150x_chip *chip;
299         int status = -EINVAL;
300
301         chip = container_of(gc, struct sx150x_chip, gpio_chip);
302
303         if (!offset_is_oscio(chip, offset)) {
304                 mutex_lock(&chip->lock);
305                 status = sx150x_get_io(chip, offset);
306                 mutex_unlock(&chip->lock);
307         }
308
309         return status;
310 }
311
312 static void sx150x_gpio_set(struct gpio_chip *gc, unsigned offset, int val)
313 {
314         struct sx150x_chip *chip;
315
316         chip = container_of(gc, struct sx150x_chip, gpio_chip);
317
318         mutex_lock(&chip->lock);
319         if (offset_is_oscio(chip, offset))
320                 sx150x_set_oscio(chip, val);
321         else
322                 sx150x_set_io(chip, offset, val);
323         mutex_unlock(&chip->lock);
324 }
325
326 static int sx150x_gpio_direction_input(struct gpio_chip *gc, unsigned offset)
327 {
328         struct sx150x_chip *chip;
329         int status = -EINVAL;
330
331         chip = container_of(gc, struct sx150x_chip, gpio_chip);
332
333         if (!offset_is_oscio(chip, offset)) {
334                 mutex_lock(&chip->lock);
335                 status = sx150x_io_input(chip, offset);
336                 mutex_unlock(&chip->lock);
337         }
338         return status;
339 }
340
341 static int sx150x_gpio_direction_output(struct gpio_chip *gc,
342                                         unsigned offset,
343                                         int val)
344 {
345         struct sx150x_chip *chip;
346         int status = 0;
347
348         chip = container_of(gc, struct sx150x_chip, gpio_chip);
349
350         if (!offset_is_oscio(chip, offset)) {
351                 mutex_lock(&chip->lock);
352                 status = sx150x_io_output(chip, offset, val);
353                 mutex_unlock(&chip->lock);
354         }
355         return status;
356 }
357
358 static void sx150x_irq_mask(struct irq_data *d)
359 {
360         struct sx150x_chip *chip = irq_data_get_irq_chip_data(d);
361         unsigned n = d->hwirq;
362
363         chip->irq_masked |= (1 << n);
364         chip->irq_update = n;
365 }
366
367 static void sx150x_irq_unmask(struct irq_data *d)
368 {
369         struct sx150x_chip *chip = irq_data_get_irq_chip_data(d);
370         unsigned n = d->hwirq;
371
372         chip->irq_masked &= ~(1 << n);
373         chip->irq_update = n;
374 }
375
376 static int sx150x_irq_set_type(struct irq_data *d, unsigned int flow_type)
377 {
378         struct sx150x_chip *chip = irq_data_get_irq_chip_data(d);
379         unsigned n, val = 0;
380
381         if (flow_type & (IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW))
382                 return -EINVAL;
383
384         n = d->hwirq;
385
386         if (flow_type & IRQ_TYPE_EDGE_RISING)
387                 val |= 0x1;
388         if (flow_type & IRQ_TYPE_EDGE_FALLING)
389                 val |= 0x2;
390
391         chip->irq_sense &= ~(3UL << (n * 2));
392         chip->irq_sense |= val << (n * 2);
393         chip->irq_update = n;
394         return 0;
395 }
396
397 static irqreturn_t sx150x_irq_thread_fn(int irq, void *dev_id)
398 {
399         struct sx150x_chip *chip = (struct sx150x_chip *)dev_id;
400         unsigned nhandled = 0;
401         unsigned sub_irq;
402         unsigned n;
403         s32 err;
404         u8 val;
405         int i;
406
407         for (i = (chip->dev_cfg->ngpios / 8) - 1; i >= 0; --i) {
408                 err = sx150x_i2c_read(chip->client,
409                                       chip->dev_cfg->reg_irq_src - i,
410                                       &val);
411                 if (err < 0)
412                         continue;
413
414                 sx150x_i2c_write(chip->client,
415                                 chip->dev_cfg->reg_irq_src - i,
416                                 val);
417                 for (n = 0; n < 8; ++n) {
418                         if (val & (1 << n)) {
419                                 sub_irq = irq_find_mapping(
420                                         chip->gpio_chip.irqdomain,
421                                         (i * 8) + n);
422                                 handle_nested_irq(sub_irq);
423                                 ++nhandled;
424                         }
425                 }
426         }
427
428         return (nhandled > 0 ? IRQ_HANDLED : IRQ_NONE);
429 }
430
431 static void sx150x_irq_bus_lock(struct irq_data *d)
432 {
433         struct sx150x_chip *chip = irq_data_get_irq_chip_data(d);
434
435         mutex_lock(&chip->lock);
436 }
437
438 static void sx150x_irq_bus_sync_unlock(struct irq_data *d)
439 {
440         struct sx150x_chip *chip = irq_data_get_irq_chip_data(d);
441         unsigned n;
442
443         if (chip->irq_update == NO_UPDATE_PENDING)
444                 goto out;
445
446         n = chip->irq_update;
447         chip->irq_update = NO_UPDATE_PENDING;
448
449         /* Avoid updates if nothing changed */
450         if (chip->dev_sense == chip->irq_sense &&
451             chip->dev_masked == chip->irq_masked)
452                 goto out;
453
454         chip->dev_sense = chip->irq_sense;
455         chip->dev_masked = chip->irq_masked;
456
457         if (chip->irq_masked & (1 << n)) {
458                 sx150x_write_cfg(chip, n, 1, chip->dev_cfg->reg_irq_mask, 1);
459                 sx150x_write_cfg(chip, n, 2, chip->dev_cfg->reg_sense, 0);
460         } else {
461                 sx150x_write_cfg(chip, n, 1, chip->dev_cfg->reg_irq_mask, 0);
462                 sx150x_write_cfg(chip, n, 2, chip->dev_cfg->reg_sense,
463                                  chip->irq_sense >> (n * 2));
464         }
465 out:
466         mutex_unlock(&chip->lock);
467 }
468
469 static void sx150x_init_chip(struct sx150x_chip *chip,
470                         struct i2c_client *client,
471                         kernel_ulong_t driver_data,
472                         struct sx150x_platform_data *pdata)
473 {
474         mutex_init(&chip->lock);
475
476         chip->client                     = client;
477         chip->dev_cfg                    = &sx150x_devices[driver_data];
478         chip->gpio_chip.dev              = &client->dev;
479         chip->gpio_chip.label            = client->name;
480         chip->gpio_chip.direction_input  = sx150x_gpio_direction_input;
481         chip->gpio_chip.direction_output = sx150x_gpio_direction_output;
482         chip->gpio_chip.get              = sx150x_gpio_get;
483         chip->gpio_chip.set              = sx150x_gpio_set;
484         chip->gpio_chip.base             = pdata->gpio_base;
485         chip->gpio_chip.can_sleep        = true;
486         chip->gpio_chip.ngpio            = chip->dev_cfg->ngpios;
487         chip->gpio_chip.of_node          = client->dev.of_node;
488         chip->gpio_chip.of_gpio_n_cells  = 2;
489         if (pdata->oscio_is_gpo)
490                 ++chip->gpio_chip.ngpio;
491
492         chip->irq_chip.name                = client->name;
493         chip->irq_chip.irq_mask            = sx150x_irq_mask;
494         chip->irq_chip.irq_unmask          = sx150x_irq_unmask;
495         chip->irq_chip.irq_set_type        = sx150x_irq_set_type;
496         chip->irq_chip.irq_bus_lock        = sx150x_irq_bus_lock;
497         chip->irq_chip.irq_bus_sync_unlock = sx150x_irq_bus_sync_unlock;
498         chip->irq_summary                  = -1;
499         chip->irq_base                     = -1;
500         chip->irq_masked                   = ~0;
501         chip->irq_sense                    = 0;
502         chip->dev_masked                   = ~0;
503         chip->dev_sense                    = 0;
504         chip->irq_update                   = NO_UPDATE_PENDING;
505 }
506
507 static int sx150x_init_io(struct sx150x_chip *chip, u8 base, u16 cfg)
508 {
509         int err = 0;
510         unsigned n;
511
512         for (n = 0; err >= 0 && n < (chip->dev_cfg->ngpios / 8); ++n)
513                 err = sx150x_i2c_write(chip->client, base - n, cfg >> (n * 8));
514         return err;
515 }
516
517 static int sx150x_reset(struct sx150x_chip *chip)
518 {
519         int err;
520
521         err = i2c_smbus_write_byte_data(chip->client,
522                                         chip->dev_cfg->pri.x789.reg_reset,
523                                         0x12);
524         if (err < 0)
525                 return err;
526
527         err = i2c_smbus_write_byte_data(chip->client,
528                                         chip->dev_cfg->pri.x789.reg_reset,
529                                         0x34);
530         return err;
531 }
532
533 static int sx150x_init_hw(struct sx150x_chip *chip,
534                         struct sx150x_platform_data *pdata)
535 {
536         int err = 0;
537
538         if (pdata->reset_during_probe) {
539                 err = sx150x_reset(chip);
540                 if (err < 0)
541                         return err;
542         }
543
544         if (chip->dev_cfg->model == SX150X_789)
545                 err = sx150x_i2c_write(chip->client,
546                                 chip->dev_cfg->pri.x789.reg_misc,
547                                 0x01);
548         else
549                 err = sx150x_i2c_write(chip->client,
550                                 chip->dev_cfg->pri.x456.reg_advance,
551                                 0x04);
552         if (err < 0)
553                 return err;
554
555         err = sx150x_init_io(chip, chip->dev_cfg->reg_pullup,
556                         pdata->io_pullup_ena);
557         if (err < 0)
558                 return err;
559
560         err = sx150x_init_io(chip, chip->dev_cfg->reg_pulldn,
561                         pdata->io_pulldn_ena);
562         if (err < 0)
563                 return err;
564
565         if (chip->dev_cfg->model == SX150X_789) {
566                 err = sx150x_init_io(chip,
567                                 chip->dev_cfg->pri.x789.reg_drain,
568                                 pdata->io_open_drain_ena);
569                 if (err < 0)
570                         return err;
571
572                 err = sx150x_init_io(chip,
573                                 chip->dev_cfg->pri.x789.reg_polarity,
574                                 pdata->io_polarity);
575                 if (err < 0)
576                         return err;
577         } else {
578                 /* Set all pins to work in normal mode */
579                 err = sx150x_init_io(chip,
580                                 chip->dev_cfg->pri.x456.reg_pld_mode,
581                                 0);
582                 if (err < 0)
583                         return err;
584         }
585
586
587         if (pdata->oscio_is_gpo)
588                 sx150x_set_oscio(chip, 0);
589
590         return err;
591 }
592
593 static int sx150x_install_irq_chip(struct sx150x_chip *chip,
594                                 int irq_summary,
595                                 int irq_base)
596 {
597         int err;
598
599         chip->irq_summary = irq_summary;
600         chip->irq_base    = irq_base;
601
602         /* Add gpio chip to irq subsystem */
603         err = gpiochip_irqchip_add(&chip->gpio_chip,
604                 &chip->irq_chip, chip->irq_base,
605                 handle_edge_irq, IRQ_TYPE_EDGE_BOTH);
606         if (err) {
607                 dev_err(&chip->client->dev,
608                         "could not connect irqchip to gpiochip\n");
609                 return  err;
610         }
611
612         err = devm_request_threaded_irq(&chip->client->dev,
613                         irq_summary, NULL, sx150x_irq_thread_fn,
614                         IRQF_ONESHOT | IRQF_SHARED | IRQF_TRIGGER_FALLING,
615                         chip->irq_chip.name, chip);
616         if (err < 0) {
617                 chip->irq_summary = -1;
618                 chip->irq_base    = -1;
619         }
620
621         return err;
622 }
623
624 static int sx150x_probe(struct i2c_client *client,
625                                 const struct i2c_device_id *id)
626 {
627         static const u32 i2c_funcs = I2C_FUNC_SMBUS_BYTE_DATA |
628                                      I2C_FUNC_SMBUS_WRITE_WORD_DATA;
629         struct sx150x_platform_data *pdata;
630         struct sx150x_chip *chip;
631         int rc;
632
633         pdata = dev_get_platdata(&client->dev);
634         if (!pdata)
635                 return -EINVAL;
636
637         if (!i2c_check_functionality(client->adapter, i2c_funcs))
638                 return -ENOSYS;
639
640         chip = devm_kzalloc(&client->dev,
641                 sizeof(struct sx150x_chip), GFP_KERNEL);
642         if (!chip)
643                 return -ENOMEM;
644
645         sx150x_init_chip(chip, client, id->driver_data, pdata);
646         rc = sx150x_init_hw(chip, pdata);
647         if (rc < 0)
648                 return rc;
649
650         rc = gpiochip_add(&chip->gpio_chip);
651         if (rc)
652                 return rc;
653
654         if (pdata->irq_summary >= 0) {
655                 rc = sx150x_install_irq_chip(chip,
656                                         pdata->irq_summary,
657                                         pdata->irq_base);
658                 if (rc < 0)
659                         goto probe_fail_post_gpiochip_add;
660         }
661
662         i2c_set_clientdata(client, chip);
663
664         return 0;
665 probe_fail_post_gpiochip_add:
666         gpiochip_remove(&chip->gpio_chip);
667         return rc;
668 }
669
670 static int sx150x_remove(struct i2c_client *client)
671 {
672         struct sx150x_chip *chip;
673
674         chip = i2c_get_clientdata(client);
675         gpiochip_remove(&chip->gpio_chip);
676
677         return 0;
678 }
679
680 static struct i2c_driver sx150x_driver = {
681         .driver = {
682                 .name = "sx150x",
683                 .owner = THIS_MODULE,
684                 .of_match_table = of_match_ptr(sx150x_dt_id),
685         },
686         .probe    = sx150x_probe,
687         .remove   = sx150x_remove,
688         .id_table = sx150x_id,
689 };
690
691 static int __init sx150x_init(void)
692 {
693         return i2c_add_driver(&sx150x_driver);
694 }
695 subsys_initcall(sx150x_init);
696
697 static void __exit sx150x_exit(void)
698 {
699         return i2c_del_driver(&sx150x_driver);
700 }
701 module_exit(sx150x_exit);
702
703 MODULE_AUTHOR("Gregory Bean <gbean@codeaurora.org>");
704 MODULE_DESCRIPTION("Driver for Semtech SX150X I2C GPIO Expanders");
705 MODULE_LICENSE("GPL v2");
706 MODULE_ALIAS("i2c:sx150x");