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