GNU Linux-libre 4.9.318-gnu1
[releases.git] / drivers / pinctrl / samsung / pinctrl-samsung.c
1 /*
2  * pin-controller/pin-mux/pin-config/gpio-driver for Samsung's SoC's.
3  *
4  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5  *              http://www.samsung.com
6  * Copyright (c) 2012 Linaro Ltd
7  *              http://www.linaro.org
8  *
9  * Author: Thomas Abraham <thomas.ab@samsung.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This driver implements the Samsung pinctrl driver. It supports setting up of
17  * pinmux and pinconf configurations. The gpiolib interface is also included.
18  * External interrupt (gpio and wakeup) support are not included in this driver
19  * but provides extensions to which platform specific implementation of the gpio
20  * and wakeup interrupts can be hooked to.
21  */
22
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/io.h>
26 #include <linux/slab.h>
27 #include <linux/err.h>
28 #include <linux/gpio.h>
29 #include <linux/irqdomain.h>
30 #include <linux/spinlock.h>
31 #include <linux/syscore_ops.h>
32
33 #include "../core.h"
34 #include "pinctrl-samsung.h"
35
36 /* list of all possible config options supported */
37 static struct pin_config {
38         const char *property;
39         enum pincfg_type param;
40 } cfg_params[] = {
41         { "samsung,pin-pud", PINCFG_TYPE_PUD },
42         { "samsung,pin-drv", PINCFG_TYPE_DRV },
43         { "samsung,pin-con-pdn", PINCFG_TYPE_CON_PDN },
44         { "samsung,pin-pud-pdn", PINCFG_TYPE_PUD_PDN },
45         { "samsung,pin-val", PINCFG_TYPE_DAT },
46 };
47
48 /* Global list of devices (struct samsung_pinctrl_drv_data) */
49 static LIST_HEAD(drvdata_list);
50
51 static unsigned int pin_base;
52
53 static int samsung_get_group_count(struct pinctrl_dev *pctldev)
54 {
55         struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
56
57         return pmx->nr_groups;
58 }
59
60 static const char *samsung_get_group_name(struct pinctrl_dev *pctldev,
61                                                 unsigned group)
62 {
63         struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
64
65         return pmx->pin_groups[group].name;
66 }
67
68 static int samsung_get_group_pins(struct pinctrl_dev *pctldev,
69                                         unsigned group,
70                                         const unsigned **pins,
71                                         unsigned *num_pins)
72 {
73         struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
74
75         *pins = pmx->pin_groups[group].pins;
76         *num_pins = pmx->pin_groups[group].num_pins;
77
78         return 0;
79 }
80
81 static int reserve_map(struct device *dev, struct pinctrl_map **map,
82                        unsigned *reserved_maps, unsigned *num_maps,
83                        unsigned reserve)
84 {
85         unsigned old_num = *reserved_maps;
86         unsigned new_num = *num_maps + reserve;
87         struct pinctrl_map *new_map;
88
89         if (old_num >= new_num)
90                 return 0;
91
92         new_map = krealloc(*map, sizeof(*new_map) * new_num, GFP_KERNEL);
93         if (!new_map) {
94                 dev_err(dev, "krealloc(map) failed\n");
95                 return -ENOMEM;
96         }
97
98         memset(new_map + old_num, 0, (new_num - old_num) * sizeof(*new_map));
99
100         *map = new_map;
101         *reserved_maps = new_num;
102
103         return 0;
104 }
105
106 static int add_map_mux(struct pinctrl_map **map, unsigned *reserved_maps,
107                        unsigned *num_maps, const char *group,
108                        const char *function)
109 {
110         if (WARN_ON(*num_maps == *reserved_maps))
111                 return -ENOSPC;
112
113         (*map)[*num_maps].type = PIN_MAP_TYPE_MUX_GROUP;
114         (*map)[*num_maps].data.mux.group = group;
115         (*map)[*num_maps].data.mux.function = function;
116         (*num_maps)++;
117
118         return 0;
119 }
120
121 static int add_map_configs(struct device *dev, struct pinctrl_map **map,
122                            unsigned *reserved_maps, unsigned *num_maps,
123                            const char *group, unsigned long *configs,
124                            unsigned num_configs)
125 {
126         unsigned long *dup_configs;
127
128         if (WARN_ON(*num_maps == *reserved_maps))
129                 return -ENOSPC;
130
131         dup_configs = kmemdup(configs, num_configs * sizeof(*dup_configs),
132                               GFP_KERNEL);
133         if (!dup_configs) {
134                 dev_err(dev, "kmemdup(configs) failed\n");
135                 return -ENOMEM;
136         }
137
138         (*map)[*num_maps].type = PIN_MAP_TYPE_CONFIGS_GROUP;
139         (*map)[*num_maps].data.configs.group_or_pin = group;
140         (*map)[*num_maps].data.configs.configs = dup_configs;
141         (*map)[*num_maps].data.configs.num_configs = num_configs;
142         (*num_maps)++;
143
144         return 0;
145 }
146
147 static int add_config(struct device *dev, unsigned long **configs,
148                       unsigned *num_configs, unsigned long config)
149 {
150         unsigned old_num = *num_configs;
151         unsigned new_num = old_num + 1;
152         unsigned long *new_configs;
153
154         new_configs = krealloc(*configs, sizeof(*new_configs) * new_num,
155                                GFP_KERNEL);
156         if (!new_configs) {
157                 dev_err(dev, "krealloc(configs) failed\n");
158                 return -ENOMEM;
159         }
160
161         new_configs[old_num] = config;
162
163         *configs = new_configs;
164         *num_configs = new_num;
165
166         return 0;
167 }
168
169 static void samsung_dt_free_map(struct pinctrl_dev *pctldev,
170                                       struct pinctrl_map *map,
171                                       unsigned num_maps)
172 {
173         int i;
174
175         for (i = 0; i < num_maps; i++)
176                 if (map[i].type == PIN_MAP_TYPE_CONFIGS_GROUP)
177                         kfree(map[i].data.configs.configs);
178
179         kfree(map);
180 }
181
182 static int samsung_dt_subnode_to_map(struct samsung_pinctrl_drv_data *drvdata,
183                                      struct device *dev,
184                                      struct device_node *np,
185                                      struct pinctrl_map **map,
186                                      unsigned *reserved_maps,
187                                      unsigned *num_maps)
188 {
189         int ret, i;
190         u32 val;
191         unsigned long config;
192         unsigned long *configs = NULL;
193         unsigned num_configs = 0;
194         unsigned reserve;
195         struct property *prop;
196         const char *group;
197         bool has_func = false;
198
199         ret = of_property_read_u32(np, "samsung,pin-function", &val);
200         if (!ret)
201                 has_func = true;
202
203         for (i = 0; i < ARRAY_SIZE(cfg_params); i++) {
204                 ret = of_property_read_u32(np, cfg_params[i].property, &val);
205                 if (!ret) {
206                         config = PINCFG_PACK(cfg_params[i].param, val);
207                         ret = add_config(dev, &configs, &num_configs, config);
208                         if (ret < 0)
209                                 goto exit;
210                 /* EINVAL=missing, which is fine since it's optional */
211                 } else if (ret != -EINVAL) {
212                         dev_err(dev, "could not parse property %s\n",
213                                 cfg_params[i].property);
214                 }
215         }
216
217         reserve = 0;
218         if (has_func)
219                 reserve++;
220         if (num_configs)
221                 reserve++;
222         ret = of_property_count_strings(np, "samsung,pins");
223         if (ret < 0) {
224                 dev_err(dev, "could not parse property samsung,pins\n");
225                 goto exit;
226         }
227         reserve *= ret;
228
229         ret = reserve_map(dev, map, reserved_maps, num_maps, reserve);
230         if (ret < 0)
231                 goto exit;
232
233         of_property_for_each_string(np, "samsung,pins", prop, group) {
234                 if (has_func) {
235                         ret = add_map_mux(map, reserved_maps,
236                                                 num_maps, group, np->full_name);
237                         if (ret < 0)
238                                 goto exit;
239                 }
240
241                 if (num_configs) {
242                         ret = add_map_configs(dev, map, reserved_maps,
243                                               num_maps, group, configs,
244                                               num_configs);
245                         if (ret < 0)
246                                 goto exit;
247                 }
248         }
249
250         ret = 0;
251
252 exit:
253         kfree(configs);
254         return ret;
255 }
256
257 static int samsung_dt_node_to_map(struct pinctrl_dev *pctldev,
258                                         struct device_node *np_config,
259                                         struct pinctrl_map **map,
260                                         unsigned *num_maps)
261 {
262         struct samsung_pinctrl_drv_data *drvdata;
263         unsigned reserved_maps;
264         struct device_node *np;
265         int ret;
266
267         drvdata = pinctrl_dev_get_drvdata(pctldev);
268
269         reserved_maps = 0;
270         *map = NULL;
271         *num_maps = 0;
272
273         if (!of_get_child_count(np_config))
274                 return samsung_dt_subnode_to_map(drvdata, pctldev->dev,
275                                                         np_config, map,
276                                                         &reserved_maps,
277                                                         num_maps);
278
279         for_each_child_of_node(np_config, np) {
280                 ret = samsung_dt_subnode_to_map(drvdata, pctldev->dev, np, map,
281                                                 &reserved_maps, num_maps);
282                 if (ret < 0) {
283                         samsung_dt_free_map(pctldev, *map, *num_maps);
284                         of_node_put(np);
285                         return ret;
286                 }
287         }
288
289         return 0;
290 }
291
292 /* list of pinctrl callbacks for the pinctrl core */
293 static const struct pinctrl_ops samsung_pctrl_ops = {
294         .get_groups_count       = samsung_get_group_count,
295         .get_group_name         = samsung_get_group_name,
296         .get_group_pins         = samsung_get_group_pins,
297         .dt_node_to_map         = samsung_dt_node_to_map,
298         .dt_free_map            = samsung_dt_free_map,
299 };
300
301 /* check if the selector is a valid pin function selector */
302 static int samsung_get_functions_count(struct pinctrl_dev *pctldev)
303 {
304         struct samsung_pinctrl_drv_data *drvdata;
305
306         drvdata = pinctrl_dev_get_drvdata(pctldev);
307         return drvdata->nr_functions;
308 }
309
310 /* return the name of the pin function specified */
311 static const char *samsung_pinmux_get_fname(struct pinctrl_dev *pctldev,
312                                                 unsigned selector)
313 {
314         struct samsung_pinctrl_drv_data *drvdata;
315
316         drvdata = pinctrl_dev_get_drvdata(pctldev);
317         return drvdata->pmx_functions[selector].name;
318 }
319
320 /* return the groups associated for the specified function selector */
321 static int samsung_pinmux_get_groups(struct pinctrl_dev *pctldev,
322                 unsigned selector, const char * const **groups,
323                 unsigned * const num_groups)
324 {
325         struct samsung_pinctrl_drv_data *drvdata;
326
327         drvdata = pinctrl_dev_get_drvdata(pctldev);
328         *groups = drvdata->pmx_functions[selector].groups;
329         *num_groups = drvdata->pmx_functions[selector].num_groups;
330         return 0;
331 }
332
333 /*
334  * given a pin number that is local to a pin controller, find out the pin bank
335  * and the register base of the pin bank.
336  */
337 static void pin_to_reg_bank(struct samsung_pinctrl_drv_data *drvdata,
338                         unsigned pin, void __iomem **reg, u32 *offset,
339                         struct samsung_pin_bank **bank)
340 {
341         struct samsung_pin_bank *b;
342
343         b = drvdata->pin_banks;
344
345         while ((pin >= b->pin_base) &&
346                         ((b->pin_base + b->nr_pins - 1) < pin))
347                 b++;
348
349         *reg = drvdata->virt_base + b->pctl_offset;
350         *offset = pin - b->pin_base;
351         if (bank)
352                 *bank = b;
353 }
354
355 /* enable or disable a pinmux function */
356 static void samsung_pinmux_setup(struct pinctrl_dev *pctldev, unsigned selector,
357                                         unsigned group, bool enable)
358 {
359         struct samsung_pinctrl_drv_data *drvdata;
360         const struct samsung_pin_bank_type *type;
361         struct samsung_pin_bank *bank;
362         void __iomem *reg;
363         u32 mask, shift, data, pin_offset;
364         unsigned long flags;
365         const struct samsung_pmx_func *func;
366         const struct samsung_pin_group *grp;
367
368         drvdata = pinctrl_dev_get_drvdata(pctldev);
369         func = &drvdata->pmx_functions[selector];
370         grp = &drvdata->pin_groups[group];
371
372         pin_to_reg_bank(drvdata, grp->pins[0] - drvdata->pin_base,
373                         &reg, &pin_offset, &bank);
374         type = bank->type;
375         mask = (1 << type->fld_width[PINCFG_TYPE_FUNC]) - 1;
376         shift = pin_offset * type->fld_width[PINCFG_TYPE_FUNC];
377         if (shift >= 32) {
378                 /* Some banks have two config registers */
379                 shift -= 32;
380                 reg += 4;
381         }
382
383         spin_lock_irqsave(&bank->slock, flags);
384
385         data = readl(reg + type->reg_offset[PINCFG_TYPE_FUNC]);
386         data &= ~(mask << shift);
387         if (enable)
388                 data |= func->val << shift;
389         writel(data, reg + type->reg_offset[PINCFG_TYPE_FUNC]);
390
391         spin_unlock_irqrestore(&bank->slock, flags);
392 }
393
394 /* enable a specified pinmux by writing to registers */
395 static int samsung_pinmux_set_mux(struct pinctrl_dev *pctldev,
396                                   unsigned selector,
397                                   unsigned group)
398 {
399         samsung_pinmux_setup(pctldev, selector, group, true);
400         return 0;
401 }
402
403 /* list of pinmux callbacks for the pinmux vertical in pinctrl core */
404 static const struct pinmux_ops samsung_pinmux_ops = {
405         .get_functions_count    = samsung_get_functions_count,
406         .get_function_name      = samsung_pinmux_get_fname,
407         .get_function_groups    = samsung_pinmux_get_groups,
408         .set_mux                = samsung_pinmux_set_mux,
409 };
410
411 /* set or get the pin config settings for a specified pin */
412 static int samsung_pinconf_rw(struct pinctrl_dev *pctldev, unsigned int pin,
413                                 unsigned long *config, bool set)
414 {
415         struct samsung_pinctrl_drv_data *drvdata;
416         const struct samsung_pin_bank_type *type;
417         struct samsung_pin_bank *bank;
418         void __iomem *reg_base;
419         enum pincfg_type cfg_type = PINCFG_UNPACK_TYPE(*config);
420         u32 data, width, pin_offset, mask, shift;
421         u32 cfg_value, cfg_reg;
422         unsigned long flags;
423
424         drvdata = pinctrl_dev_get_drvdata(pctldev);
425         pin_to_reg_bank(drvdata, pin - drvdata->pin_base, &reg_base,
426                                         &pin_offset, &bank);
427         type = bank->type;
428
429         if (cfg_type >= PINCFG_TYPE_NUM || !type->fld_width[cfg_type])
430                 return -EINVAL;
431
432         width = type->fld_width[cfg_type];
433         cfg_reg = type->reg_offset[cfg_type];
434
435         spin_lock_irqsave(&bank->slock, flags);
436
437         mask = (1 << width) - 1;
438         shift = pin_offset * width;
439         data = readl(reg_base + cfg_reg);
440
441         if (set) {
442                 cfg_value = PINCFG_UNPACK_VALUE(*config);
443                 data &= ~(mask << shift);
444                 data |= (cfg_value << shift);
445                 writel(data, reg_base + cfg_reg);
446         } else {
447                 data >>= shift;
448                 data &= mask;
449                 *config = PINCFG_PACK(cfg_type, data);
450         }
451
452         spin_unlock_irqrestore(&bank->slock, flags);
453
454         return 0;
455 }
456
457 /* set the pin config settings for a specified pin */
458 static int samsung_pinconf_set(struct pinctrl_dev *pctldev, unsigned int pin,
459                                 unsigned long *configs, unsigned num_configs)
460 {
461         int i, ret;
462
463         for (i = 0; i < num_configs; i++) {
464                 ret = samsung_pinconf_rw(pctldev, pin, &configs[i], true);
465                 if (ret < 0)
466                         return ret;
467         } /* for each config */
468
469         return 0;
470 }
471
472 /* get the pin config settings for a specified pin */
473 static int samsung_pinconf_get(struct pinctrl_dev *pctldev, unsigned int pin,
474                                         unsigned long *config)
475 {
476         return samsung_pinconf_rw(pctldev, pin, config, false);
477 }
478
479 /* set the pin config settings for a specified pin group */
480 static int samsung_pinconf_group_set(struct pinctrl_dev *pctldev,
481                         unsigned group, unsigned long *configs,
482                         unsigned num_configs)
483 {
484         struct samsung_pinctrl_drv_data *drvdata;
485         const unsigned int *pins;
486         unsigned int cnt;
487
488         drvdata = pinctrl_dev_get_drvdata(pctldev);
489         pins = drvdata->pin_groups[group].pins;
490
491         for (cnt = 0; cnt < drvdata->pin_groups[group].num_pins; cnt++)
492                 samsung_pinconf_set(pctldev, pins[cnt], configs, num_configs);
493
494         return 0;
495 }
496
497 /* get the pin config settings for a specified pin group */
498 static int samsung_pinconf_group_get(struct pinctrl_dev *pctldev,
499                                 unsigned int group, unsigned long *config)
500 {
501         struct samsung_pinctrl_drv_data *drvdata;
502         const unsigned int *pins;
503
504         drvdata = pinctrl_dev_get_drvdata(pctldev);
505         pins = drvdata->pin_groups[group].pins;
506         samsung_pinconf_get(pctldev, pins[0], config);
507         return 0;
508 }
509
510 /* list of pinconfig callbacks for pinconfig vertical in the pinctrl code */
511 static const struct pinconf_ops samsung_pinconf_ops = {
512         .pin_config_get         = samsung_pinconf_get,
513         .pin_config_set         = samsung_pinconf_set,
514         .pin_config_group_get   = samsung_pinconf_group_get,
515         .pin_config_group_set   = samsung_pinconf_group_set,
516 };
517
518 /*
519  * The samsung_gpio_set_vlaue() should be called with "bank->slock" held
520  * to avoid race condition.
521  */
522 static void samsung_gpio_set_value(struct gpio_chip *gc,
523                                           unsigned offset, int value)
524 {
525         struct samsung_pin_bank *bank = gpiochip_get_data(gc);
526         const struct samsung_pin_bank_type *type = bank->type;
527         void __iomem *reg;
528         u32 data;
529
530         reg = bank->drvdata->virt_base + bank->pctl_offset;
531
532         data = readl(reg + type->reg_offset[PINCFG_TYPE_DAT]);
533         data &= ~(1 << offset);
534         if (value)
535                 data |= 1 << offset;
536         writel(data, reg + type->reg_offset[PINCFG_TYPE_DAT]);
537 }
538
539 /* gpiolib gpio_set callback function */
540 static void samsung_gpio_set(struct gpio_chip *gc, unsigned offset, int value)
541 {
542         struct samsung_pin_bank *bank = gpiochip_get_data(gc);
543         unsigned long flags;
544
545         spin_lock_irqsave(&bank->slock, flags);
546         samsung_gpio_set_value(gc, offset, value);
547         spin_unlock_irqrestore(&bank->slock, flags);
548 }
549
550 /* gpiolib gpio_get callback function */
551 static int samsung_gpio_get(struct gpio_chip *gc, unsigned offset)
552 {
553         void __iomem *reg;
554         u32 data;
555         struct samsung_pin_bank *bank = gpiochip_get_data(gc);
556         const struct samsung_pin_bank_type *type = bank->type;
557
558         reg = bank->drvdata->virt_base + bank->pctl_offset;
559
560         data = readl(reg + type->reg_offset[PINCFG_TYPE_DAT]);
561         data >>= offset;
562         data &= 1;
563         return data;
564 }
565
566 /*
567  * The samsung_gpio_set_direction() should be called with "bank->slock" held
568  * to avoid race condition.
569  * The calls to gpio_direction_output() and gpio_direction_input()
570  * leads to this function call.
571  */
572 static int samsung_gpio_set_direction(struct gpio_chip *gc,
573                                              unsigned offset, bool input)
574 {
575         const struct samsung_pin_bank_type *type;
576         struct samsung_pin_bank *bank;
577         struct samsung_pinctrl_drv_data *drvdata;
578         void __iomem *reg;
579         u32 data, mask, shift;
580
581         bank = gpiochip_get_data(gc);
582         type = bank->type;
583         drvdata = bank->drvdata;
584
585         reg = drvdata->virt_base + bank->pctl_offset +
586                                         type->reg_offset[PINCFG_TYPE_FUNC];
587
588         mask = (1 << type->fld_width[PINCFG_TYPE_FUNC]) - 1;
589         shift = offset * type->fld_width[PINCFG_TYPE_FUNC];
590         if (shift >= 32) {
591                 /* Some banks have two config registers */
592                 shift -= 32;
593                 reg += 4;
594         }
595
596         data = readl(reg);
597         data &= ~(mask << shift);
598         if (!input)
599                 data |= FUNC_OUTPUT << shift;
600         writel(data, reg);
601
602         return 0;
603 }
604
605 /* gpiolib gpio_direction_input callback function. */
606 static int samsung_gpio_direction_input(struct gpio_chip *gc, unsigned offset)
607 {
608         struct samsung_pin_bank *bank = gpiochip_get_data(gc);
609         unsigned long flags;
610         int ret;
611
612         spin_lock_irqsave(&bank->slock, flags);
613         ret = samsung_gpio_set_direction(gc, offset, true);
614         spin_unlock_irqrestore(&bank->slock, flags);
615         return ret;
616 }
617
618 /* gpiolib gpio_direction_output callback function. */
619 static int samsung_gpio_direction_output(struct gpio_chip *gc, unsigned offset,
620                                                         int value)
621 {
622         struct samsung_pin_bank *bank = gpiochip_get_data(gc);
623         unsigned long flags;
624         int ret;
625
626         spin_lock_irqsave(&bank->slock, flags);
627         samsung_gpio_set_value(gc, offset, value);
628         ret = samsung_gpio_set_direction(gc, offset, false);
629         spin_unlock_irqrestore(&bank->slock, flags);
630
631         return ret;
632 }
633
634 /*
635  * gpiolib gpio_to_irq callback function. Creates a mapping between a GPIO pin
636  * and a virtual IRQ, if not already present.
637  */
638 static int samsung_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
639 {
640         struct samsung_pin_bank *bank = gpiochip_get_data(gc);
641         unsigned int virq;
642
643         if (!bank->irq_domain)
644                 return -ENXIO;
645
646         virq = irq_create_mapping(bank->irq_domain, offset);
647
648         return (virq) ? : -ENXIO;
649 }
650
651 static struct samsung_pin_group *samsung_pinctrl_create_groups(
652                                 struct device *dev,
653                                 struct samsung_pinctrl_drv_data *drvdata,
654                                 unsigned int *cnt)
655 {
656         struct pinctrl_desc *ctrldesc = &drvdata->pctl;
657         struct samsung_pin_group *groups, *grp;
658         const struct pinctrl_pin_desc *pdesc;
659         int i;
660
661         groups = devm_kzalloc(dev, ctrldesc->npins * sizeof(*groups),
662                                 GFP_KERNEL);
663         if (!groups)
664                 return ERR_PTR(-EINVAL);
665         grp = groups;
666
667         pdesc = ctrldesc->pins;
668         for (i = 0; i < ctrldesc->npins; ++i, ++pdesc, ++grp) {
669                 grp->name = pdesc->name;
670                 grp->pins = &pdesc->number;
671                 grp->num_pins = 1;
672         }
673
674         *cnt = ctrldesc->npins;
675         return groups;
676 }
677
678 static int samsung_pinctrl_create_function(struct device *dev,
679                                 struct samsung_pinctrl_drv_data *drvdata,
680                                 struct device_node *func_np,
681                                 struct samsung_pmx_func *func)
682 {
683         int npins;
684         int ret;
685         int i;
686
687         if (of_property_read_u32(func_np, "samsung,pin-function", &func->val))
688                 return 0;
689
690         npins = of_property_count_strings(func_np, "samsung,pins");
691         if (npins < 1) {
692                 dev_err(dev, "invalid pin list in %s node", func_np->name);
693                 return -EINVAL;
694         }
695
696         func->name = func_np->full_name;
697
698         func->groups = devm_kzalloc(dev, npins * sizeof(char *), GFP_KERNEL);
699         if (!func->groups)
700                 return -ENOMEM;
701
702         for (i = 0; i < npins; ++i) {
703                 const char *gname;
704
705                 ret = of_property_read_string_index(func_np, "samsung,pins",
706                                                         i, &gname);
707                 if (ret) {
708                         dev_err(dev,
709                                 "failed to read pin name %d from %s node\n",
710                                 i, func_np->name);
711                         return ret;
712                 }
713
714                 func->groups[i] = gname;
715         }
716
717         func->num_groups = npins;
718         return 1;
719 }
720
721 static struct samsung_pmx_func *samsung_pinctrl_create_functions(
722                                 struct device *dev,
723                                 struct samsung_pinctrl_drv_data *drvdata,
724                                 unsigned int *cnt)
725 {
726         struct samsung_pmx_func *functions, *func;
727         struct device_node *dev_np = dev->of_node;
728         struct device_node *cfg_np;
729         unsigned int func_cnt = 0;
730         int ret;
731
732         /*
733          * Iterate over all the child nodes of the pin controller node
734          * and create pin groups and pin function lists.
735          */
736         for_each_child_of_node(dev_np, cfg_np) {
737                 struct device_node *func_np;
738
739                 if (!of_get_child_count(cfg_np)) {
740                         if (!of_find_property(cfg_np,
741                             "samsung,pin-function", NULL))
742                                 continue;
743                         ++func_cnt;
744                         continue;
745                 }
746
747                 for_each_child_of_node(cfg_np, func_np) {
748                         if (!of_find_property(func_np,
749                             "samsung,pin-function", NULL))
750                                 continue;
751                         ++func_cnt;
752                 }
753         }
754
755         functions = devm_kzalloc(dev, func_cnt * sizeof(*functions),
756                                         GFP_KERNEL);
757         if (!functions) {
758                 dev_err(dev, "failed to allocate memory for function list\n");
759                 return ERR_PTR(-EINVAL);
760         }
761         func = functions;
762
763         /*
764          * Iterate over all the child nodes of the pin controller node
765          * and create pin groups and pin function lists.
766          */
767         func_cnt = 0;
768         for_each_child_of_node(dev_np, cfg_np) {
769                 struct device_node *func_np;
770
771                 if (!of_get_child_count(cfg_np)) {
772                         ret = samsung_pinctrl_create_function(dev, drvdata,
773                                                         cfg_np, func);
774                         if (ret < 0) {
775                                 of_node_put(cfg_np);
776                                 return ERR_PTR(ret);
777                         }
778                         if (ret > 0) {
779                                 ++func;
780                                 ++func_cnt;
781                         }
782                         continue;
783                 }
784
785                 for_each_child_of_node(cfg_np, func_np) {
786                         ret = samsung_pinctrl_create_function(dev, drvdata,
787                                                 func_np, func);
788                         if (ret < 0) {
789                                 of_node_put(func_np);
790                                 of_node_put(cfg_np);
791                                 return ERR_PTR(ret);
792                         }
793                         if (ret > 0) {
794                                 ++func;
795                                 ++func_cnt;
796                         }
797                 }
798         }
799
800         *cnt = func_cnt;
801         return functions;
802 }
803
804 /*
805  * Parse the information about all the available pin groups and pin functions
806  * from device node of the pin-controller. A pin group is formed with all
807  * the pins listed in the "samsung,pins" property.
808  */
809
810 static int samsung_pinctrl_parse_dt(struct platform_device *pdev,
811                                     struct samsung_pinctrl_drv_data *drvdata)
812 {
813         struct device *dev = &pdev->dev;
814         struct samsung_pin_group *groups;
815         struct samsung_pmx_func *functions;
816         unsigned int grp_cnt = 0, func_cnt = 0;
817
818         groups = samsung_pinctrl_create_groups(dev, drvdata, &grp_cnt);
819         if (IS_ERR(groups)) {
820                 dev_err(dev, "failed to parse pin groups\n");
821                 return PTR_ERR(groups);
822         }
823
824         functions = samsung_pinctrl_create_functions(dev, drvdata, &func_cnt);
825         if (IS_ERR(functions)) {
826                 dev_err(dev, "failed to parse pin functions\n");
827                 return PTR_ERR(functions);
828         }
829
830         drvdata->pin_groups = groups;
831         drvdata->nr_groups = grp_cnt;
832         drvdata->pmx_functions = functions;
833         drvdata->nr_functions = func_cnt;
834
835         return 0;
836 }
837
838 /* register the pinctrl interface with the pinctrl subsystem */
839 static int samsung_pinctrl_register(struct platform_device *pdev,
840                                     struct samsung_pinctrl_drv_data *drvdata)
841 {
842         struct pinctrl_desc *ctrldesc = &drvdata->pctl;
843         struct pinctrl_pin_desc *pindesc, *pdesc;
844         struct samsung_pin_bank *pin_bank;
845         char *pin_names;
846         int pin, bank, ret;
847
848         ctrldesc->name = "samsung-pinctrl";
849         ctrldesc->owner = THIS_MODULE;
850         ctrldesc->pctlops = &samsung_pctrl_ops;
851         ctrldesc->pmxops = &samsung_pinmux_ops;
852         ctrldesc->confops = &samsung_pinconf_ops;
853
854         pindesc = devm_kzalloc(&pdev->dev, sizeof(*pindesc) *
855                         drvdata->nr_pins, GFP_KERNEL);
856         if (!pindesc) {
857                 dev_err(&pdev->dev, "mem alloc for pin descriptors failed\n");
858                 return -ENOMEM;
859         }
860         ctrldesc->pins = pindesc;
861         ctrldesc->npins = drvdata->nr_pins;
862
863         /* dynamically populate the pin number and pin name for pindesc */
864         for (pin = 0, pdesc = pindesc; pin < ctrldesc->npins; pin++, pdesc++)
865                 pdesc->number = pin + drvdata->pin_base;
866
867         /*
868          * allocate space for storing the dynamically generated names for all
869          * the pins which belong to this pin-controller.
870          */
871         pin_names = devm_kzalloc(&pdev->dev, sizeof(char) * PIN_NAME_LENGTH *
872                                         drvdata->nr_pins, GFP_KERNEL);
873         if (!pin_names) {
874                 dev_err(&pdev->dev, "mem alloc for pin names failed\n");
875                 return -ENOMEM;
876         }
877
878         /* for each pin, the name of the pin is pin-bank name + pin number */
879         for (bank = 0; bank < drvdata->nr_banks; bank++) {
880                 pin_bank = &drvdata->pin_banks[bank];
881                 for (pin = 0; pin < pin_bank->nr_pins; pin++) {
882                         sprintf(pin_names, "%s-%d", pin_bank->name, pin);
883                         pdesc = pindesc + pin_bank->pin_base + pin;
884                         pdesc->name = pin_names;
885                         pin_names += PIN_NAME_LENGTH;
886                 }
887         }
888
889         ret = samsung_pinctrl_parse_dt(pdev, drvdata);
890         if (ret)
891                 return ret;
892
893         drvdata->pctl_dev = devm_pinctrl_register(&pdev->dev, ctrldesc,
894                                                   drvdata);
895         if (IS_ERR(drvdata->pctl_dev)) {
896                 dev_err(&pdev->dev, "could not register pinctrl driver\n");
897                 return PTR_ERR(drvdata->pctl_dev);
898         }
899
900         for (bank = 0; bank < drvdata->nr_banks; ++bank) {
901                 pin_bank = &drvdata->pin_banks[bank];
902                 pin_bank->grange.name = pin_bank->name;
903                 pin_bank->grange.id = bank;
904                 pin_bank->grange.pin_base = drvdata->pin_base
905                                                 + pin_bank->pin_base;
906                 pin_bank->grange.base = pin_bank->gpio_chip.base;
907                 pin_bank->grange.npins = pin_bank->gpio_chip.ngpio;
908                 pin_bank->grange.gc = &pin_bank->gpio_chip;
909                 pinctrl_add_gpio_range(drvdata->pctl_dev, &pin_bank->grange);
910         }
911
912         return 0;
913 }
914
915 static const struct gpio_chip samsung_gpiolib_chip = {
916         .request = gpiochip_generic_request,
917         .free = gpiochip_generic_free,
918         .set = samsung_gpio_set,
919         .get = samsung_gpio_get,
920         .direction_input = samsung_gpio_direction_input,
921         .direction_output = samsung_gpio_direction_output,
922         .to_irq = samsung_gpio_to_irq,
923         .owner = THIS_MODULE,
924 };
925
926 /* register the gpiolib interface with the gpiolib subsystem */
927 static int samsung_gpiolib_register(struct platform_device *pdev,
928                                     struct samsung_pinctrl_drv_data *drvdata)
929 {
930         struct samsung_pin_bank *bank = drvdata->pin_banks;
931         struct gpio_chip *gc;
932         int ret;
933         int i;
934
935         for (i = 0; i < drvdata->nr_banks; ++i, ++bank) {
936                 bank->gpio_chip = samsung_gpiolib_chip;
937
938                 gc = &bank->gpio_chip;
939                 gc->base = drvdata->pin_base + bank->pin_base;
940                 gc->ngpio = bank->nr_pins;
941                 gc->parent = &pdev->dev;
942                 gc->of_node = bank->of_node;
943                 gc->label = bank->name;
944
945                 ret = gpiochip_add_data(gc, bank);
946                 if (ret) {
947                         dev_err(&pdev->dev, "failed to register gpio_chip %s, error code: %d\n",
948                                                         gc->label, ret);
949                         goto fail;
950                 }
951         }
952
953         return 0;
954
955 fail:
956         for (--i, --bank; i >= 0; --i, --bank)
957                 gpiochip_remove(&bank->gpio_chip);
958         return ret;
959 }
960
961 /* unregister the gpiolib interface with the gpiolib subsystem */
962 static int samsung_gpiolib_unregister(struct platform_device *pdev,
963                                       struct samsung_pinctrl_drv_data *drvdata)
964 {
965         struct samsung_pin_bank *bank = drvdata->pin_banks;
966         int i;
967
968         for (i = 0; i < drvdata->nr_banks; ++i, ++bank)
969                 gpiochip_remove(&bank->gpio_chip);
970
971         return 0;
972 }
973
974 static const struct of_device_id samsung_pinctrl_dt_match[];
975
976 /* retrieve the soc specific data */
977 static const struct samsung_pin_ctrl *
978 samsung_pinctrl_get_soc_data(struct samsung_pinctrl_drv_data *d,
979                              struct platform_device *pdev)
980 {
981         int id;
982         const struct of_device_id *match;
983         struct device_node *node = pdev->dev.of_node;
984         struct device_node *np;
985         const struct samsung_pin_bank_data *bdata;
986         const struct samsung_pin_ctrl *ctrl;
987         struct samsung_pin_bank *bank;
988         int i;
989
990         id = of_alias_get_id(node, "pinctrl");
991         if (id < 0) {
992                 dev_err(&pdev->dev, "failed to get alias id\n");
993                 return ERR_PTR(-ENOENT);
994         }
995         match = of_match_node(samsung_pinctrl_dt_match, node);
996         ctrl = (struct samsung_pin_ctrl *)match->data + id;
997
998         d->suspend = ctrl->suspend;
999         d->resume = ctrl->resume;
1000         d->nr_banks = ctrl->nr_banks;
1001         d->pin_banks = devm_kcalloc(&pdev->dev, d->nr_banks,
1002                                         sizeof(*d->pin_banks), GFP_KERNEL);
1003         if (!d->pin_banks)
1004                 return ERR_PTR(-ENOMEM);
1005
1006         bank = d->pin_banks;
1007         bdata = ctrl->pin_banks;
1008         for (i = 0; i < ctrl->nr_banks; ++i, ++bdata, ++bank) {
1009                 bank->type = bdata->type;
1010                 bank->pctl_offset = bdata->pctl_offset;
1011                 bank->nr_pins = bdata->nr_pins;
1012                 bank->eint_func = bdata->eint_func;
1013                 bank->eint_type = bdata->eint_type;
1014                 bank->eint_mask = bdata->eint_mask;
1015                 bank->eint_offset = bdata->eint_offset;
1016                 bank->name = bdata->name;
1017
1018                 spin_lock_init(&bank->slock);
1019                 bank->drvdata = d;
1020                 bank->pin_base = d->nr_pins;
1021                 d->nr_pins += bank->nr_pins;
1022         }
1023
1024         for_each_child_of_node(node, np) {
1025                 if (!of_find_property(np, "gpio-controller", NULL))
1026                         continue;
1027                 bank = d->pin_banks;
1028                 for (i = 0; i < d->nr_banks; ++i, ++bank) {
1029                         if (!strcmp(bank->name, np->name)) {
1030                                 bank->of_node = np;
1031                                 break;
1032                         }
1033                 }
1034         }
1035
1036         d->pin_base = pin_base;
1037         pin_base += d->nr_pins;
1038
1039         return ctrl;
1040 }
1041
1042 static int samsung_pinctrl_probe(struct platform_device *pdev)
1043 {
1044         struct samsung_pinctrl_drv_data *drvdata;
1045         const struct samsung_pin_ctrl *ctrl;
1046         struct device *dev = &pdev->dev;
1047         struct resource *res;
1048         int ret;
1049
1050         drvdata = devm_kzalloc(dev, sizeof(*drvdata), GFP_KERNEL);
1051         if (!drvdata)
1052                 return -ENOMEM;
1053
1054         ctrl = samsung_pinctrl_get_soc_data(drvdata, pdev);
1055         if (IS_ERR(ctrl)) {
1056                 dev_err(&pdev->dev, "driver data not available\n");
1057                 return PTR_ERR(ctrl);
1058         }
1059         drvdata->dev = dev;
1060
1061         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1062         drvdata->virt_base = devm_ioremap_resource(&pdev->dev, res);
1063         if (IS_ERR(drvdata->virt_base))
1064                 return PTR_ERR(drvdata->virt_base);
1065
1066         res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
1067         if (res)
1068                 drvdata->irq = res->start;
1069
1070         ret = samsung_gpiolib_register(pdev, drvdata);
1071         if (ret)
1072                 return ret;
1073
1074         ret = samsung_pinctrl_register(pdev, drvdata);
1075         if (ret) {
1076                 samsung_gpiolib_unregister(pdev, drvdata);
1077                 return ret;
1078         }
1079
1080         if (ctrl->eint_gpio_init)
1081                 ctrl->eint_gpio_init(drvdata);
1082         if (ctrl->eint_wkup_init)
1083                 ctrl->eint_wkup_init(drvdata);
1084
1085         platform_set_drvdata(pdev, drvdata);
1086
1087         /* Add to the global list */
1088         list_add_tail(&drvdata->node, &drvdata_list);
1089
1090         return 0;
1091 }
1092
1093 #ifdef CONFIG_PM
1094
1095 /**
1096  * samsung_pinctrl_suspend_dev - save pinctrl state for suspend for a device
1097  *
1098  * Save data for all banks handled by this device.
1099  */
1100 static void samsung_pinctrl_suspend_dev(
1101         struct samsung_pinctrl_drv_data *drvdata)
1102 {
1103         void __iomem *virt_base = drvdata->virt_base;
1104         int i;
1105
1106         for (i = 0; i < drvdata->nr_banks; i++) {
1107                 struct samsung_pin_bank *bank = &drvdata->pin_banks[i];
1108                 void __iomem *reg = virt_base + bank->pctl_offset;
1109                 const u8 *offs = bank->type->reg_offset;
1110                 const u8 *widths = bank->type->fld_width;
1111                 enum pincfg_type type;
1112
1113                 /* Registers without a powerdown config aren't lost */
1114                 if (!widths[PINCFG_TYPE_CON_PDN])
1115                         continue;
1116
1117                 for (type = 0; type < PINCFG_TYPE_NUM; type++)
1118                         if (widths[type])
1119                                 bank->pm_save[type] = readl(reg + offs[type]);
1120
1121                 if (widths[PINCFG_TYPE_FUNC] * bank->nr_pins > 32) {
1122                         /* Some banks have two config registers */
1123                         bank->pm_save[PINCFG_TYPE_NUM] =
1124                                 readl(reg + offs[PINCFG_TYPE_FUNC] + 4);
1125                         pr_debug("Save %s @ %p (con %#010x %08x)\n",
1126                                  bank->name, reg,
1127                                  bank->pm_save[PINCFG_TYPE_FUNC],
1128                                  bank->pm_save[PINCFG_TYPE_NUM]);
1129                 } else {
1130                         pr_debug("Save %s @ %p (con %#010x)\n", bank->name,
1131                                  reg, bank->pm_save[PINCFG_TYPE_FUNC]);
1132                 }
1133         }
1134
1135         if (drvdata->suspend)
1136                 drvdata->suspend(drvdata);
1137 }
1138
1139 /**
1140  * samsung_pinctrl_resume_dev - restore pinctrl state from suspend for a device
1141  *
1142  * Restore one of the banks that was saved during suspend.
1143  *
1144  * We don't bother doing anything complicated to avoid glitching lines since
1145  * we're called before pad retention is turned off.
1146  */
1147 static void samsung_pinctrl_resume_dev(struct samsung_pinctrl_drv_data *drvdata)
1148 {
1149         void __iomem *virt_base = drvdata->virt_base;
1150         int i;
1151
1152         if (drvdata->resume)
1153                 drvdata->resume(drvdata);
1154
1155         for (i = 0; i < drvdata->nr_banks; i++) {
1156                 struct samsung_pin_bank *bank = &drvdata->pin_banks[i];
1157                 void __iomem *reg = virt_base + bank->pctl_offset;
1158                 const u8 *offs = bank->type->reg_offset;
1159                 const u8 *widths = bank->type->fld_width;
1160                 enum pincfg_type type;
1161
1162                 /* Registers without a powerdown config aren't lost */
1163                 if (!widths[PINCFG_TYPE_CON_PDN])
1164                         continue;
1165
1166                 if (widths[PINCFG_TYPE_FUNC] * bank->nr_pins > 32) {
1167                         /* Some banks have two config registers */
1168                         pr_debug("%s @ %p (con %#010x %08x => %#010x %08x)\n",
1169                                  bank->name, reg,
1170                                  readl(reg + offs[PINCFG_TYPE_FUNC]),
1171                                  readl(reg + offs[PINCFG_TYPE_FUNC] + 4),
1172                                  bank->pm_save[PINCFG_TYPE_FUNC],
1173                                  bank->pm_save[PINCFG_TYPE_NUM]);
1174                         writel(bank->pm_save[PINCFG_TYPE_NUM],
1175                                reg + offs[PINCFG_TYPE_FUNC] + 4);
1176                 } else {
1177                         pr_debug("%s @ %p (con %#010x => %#010x)\n", bank->name,
1178                                  reg, readl(reg + offs[PINCFG_TYPE_FUNC]),
1179                                  bank->pm_save[PINCFG_TYPE_FUNC]);
1180                 }
1181                 for (type = 0; type < PINCFG_TYPE_NUM; type++)
1182                         if (widths[type])
1183                                 writel(bank->pm_save[type], reg + offs[type]);
1184         }
1185 }
1186
1187 /**
1188  * samsung_pinctrl_suspend - save pinctrl state for suspend
1189  *
1190  * Save data for all banks across all devices.
1191  */
1192 static int samsung_pinctrl_suspend(void)
1193 {
1194         struct samsung_pinctrl_drv_data *drvdata;
1195
1196         list_for_each_entry(drvdata, &drvdata_list, node) {
1197                 samsung_pinctrl_suspend_dev(drvdata);
1198         }
1199
1200         return 0;
1201 }
1202
1203 /**
1204  * samsung_pinctrl_resume - restore pinctrl state for suspend
1205  *
1206  * Restore data for all banks across all devices.
1207  */
1208 static void samsung_pinctrl_resume(void)
1209 {
1210         struct samsung_pinctrl_drv_data *drvdata;
1211
1212         list_for_each_entry_reverse(drvdata, &drvdata_list, node) {
1213                 samsung_pinctrl_resume_dev(drvdata);
1214         }
1215 }
1216
1217 #else
1218 #define samsung_pinctrl_suspend         NULL
1219 #define samsung_pinctrl_resume          NULL
1220 #endif
1221
1222 static struct syscore_ops samsung_pinctrl_syscore_ops = {
1223         .suspend        = samsung_pinctrl_suspend,
1224         .resume         = samsung_pinctrl_resume,
1225 };
1226
1227 static const struct of_device_id samsung_pinctrl_dt_match[] = {
1228 #ifdef CONFIG_PINCTRL_EXYNOS
1229         { .compatible = "samsung,exynos3250-pinctrl",
1230                 .data = (void *)exynos3250_pin_ctrl },
1231         { .compatible = "samsung,exynos4210-pinctrl",
1232                 .data = (void *)exynos4210_pin_ctrl },
1233         { .compatible = "samsung,exynos4x12-pinctrl",
1234                 .data = (void *)exynos4x12_pin_ctrl },
1235         { .compatible = "samsung,exynos4415-pinctrl",
1236                 .data = (void *)exynos4415_pin_ctrl },
1237         { .compatible = "samsung,exynos5250-pinctrl",
1238                 .data = (void *)exynos5250_pin_ctrl },
1239         { .compatible = "samsung,exynos5260-pinctrl",
1240                 .data = (void *)exynos5260_pin_ctrl },
1241         { .compatible = "samsung,exynos5410-pinctrl",
1242                 .data = (void *)exynos5410_pin_ctrl },
1243         { .compatible = "samsung,exynos5420-pinctrl",
1244                 .data = (void *)exynos5420_pin_ctrl },
1245         { .compatible = "samsung,exynos5433-pinctrl",
1246                 .data = (void *)exynos5433_pin_ctrl },
1247         { .compatible = "samsung,s5pv210-pinctrl",
1248                 .data = (void *)s5pv210_pin_ctrl },
1249         { .compatible = "samsung,exynos7-pinctrl",
1250                 .data = (void *)exynos7_pin_ctrl },
1251 #endif
1252 #ifdef CONFIG_PINCTRL_S3C64XX
1253         { .compatible = "samsung,s3c64xx-pinctrl",
1254                 .data = s3c64xx_pin_ctrl },
1255 #endif
1256 #ifdef CONFIG_PINCTRL_S3C24XX
1257         { .compatible = "samsung,s3c2412-pinctrl",
1258                 .data = s3c2412_pin_ctrl },
1259         { .compatible = "samsung,s3c2416-pinctrl",
1260                 .data = s3c2416_pin_ctrl },
1261         { .compatible = "samsung,s3c2440-pinctrl",
1262                 .data = s3c2440_pin_ctrl },
1263         { .compatible = "samsung,s3c2450-pinctrl",
1264                 .data = s3c2450_pin_ctrl },
1265 #endif
1266         {},
1267 };
1268 MODULE_DEVICE_TABLE(of, samsung_pinctrl_dt_match);
1269
1270 static struct platform_driver samsung_pinctrl_driver = {
1271         .probe          = samsung_pinctrl_probe,
1272         .driver = {
1273                 .name   = "samsung-pinctrl",
1274                 .of_match_table = samsung_pinctrl_dt_match,
1275                 .suppress_bind_attrs = true,
1276         },
1277 };
1278
1279 static int __init samsung_pinctrl_drv_register(void)
1280 {
1281         /*
1282          * Register syscore ops for save/restore of registers across suspend.
1283          * It's important to ensure that this driver is running at an earlier
1284          * initcall level than any arch-specific init calls that install syscore
1285          * ops that turn off pad retention (like exynos_pm_resume).
1286          */
1287         register_syscore_ops(&samsung_pinctrl_syscore_ops);
1288
1289         return platform_driver_register(&samsung_pinctrl_driver);
1290 }
1291 postcore_initcall(samsung_pinctrl_drv_register);
1292
1293 static void __exit samsung_pinctrl_drv_unregister(void)
1294 {
1295         platform_driver_unregister(&samsung_pinctrl_driver);
1296 }
1297 module_exit(samsung_pinctrl_drv_unregister);
1298
1299 MODULE_AUTHOR("Thomas Abraham <thomas.ab@samsung.com>");
1300 MODULE_DESCRIPTION("Samsung pinctrl driver");
1301 MODULE_LICENSE("GPL v2");