common: Drop image.h from common header
[platform/kernel/u-boot.git] / drivers / pinctrl / pinctrl_stm32.c
1 #include <common.h>
2 #include <dm.h>
3 #include <hwspinlock.h>
4 #include <malloc.h>
5 #include <asm/arch/gpio.h>
6 #include <asm/gpio.h>
7 #include <asm/io.h>
8 #include <dm/device_compat.h>
9 #include <dm/lists.h>
10 #include <dm/pinctrl.h>
11 #include <linux/err.h>
12 #include <linux/libfdt.h>
13
14 DECLARE_GLOBAL_DATA_PTR;
15
16 #define MAX_PINS_ONE_IP                 70
17 #define MODE_BITS_MASK                  3
18 #define OSPEED_MASK                     3
19 #define PUPD_MASK                       3
20 #define OTYPE_MSK                       1
21 #define AFR_MASK                        0xF
22
23 struct stm32_pinctrl_priv {
24         struct hwspinlock hws;
25         int pinctrl_ngpios;
26         struct list_head gpio_dev;
27 };
28
29 struct stm32_gpio_bank {
30         struct udevice *gpio_dev;
31         struct list_head list;
32 };
33
34 #ifndef CONFIG_SPL_BUILD
35
36 static char pin_name[PINNAME_SIZE];
37 #define PINMUX_MODE_COUNT               5
38 static const char * const pinmux_mode[PINMUX_MODE_COUNT] = {
39         "gpio input",
40         "gpio output",
41         "analog",
42         "unknown",
43         "alt function",
44 };
45
46 static int stm32_pinctrl_get_af(struct udevice *dev, unsigned int offset)
47 {
48         struct stm32_gpio_priv *priv = dev_get_priv(dev);
49         struct stm32_gpio_regs *regs = priv->regs;
50         u32 af;
51         u32 alt_shift = (offset % 8) * 4;
52         u32 alt_index =  offset / 8;
53
54         af = (readl(&regs->afr[alt_index]) &
55               GENMASK(alt_shift + 3, alt_shift)) >> alt_shift;
56
57         return af;
58 }
59
60 static int stm32_populate_gpio_dev_list(struct udevice *dev)
61 {
62         struct stm32_pinctrl_priv *priv = dev_get_priv(dev);
63         struct udevice *gpio_dev;
64         struct udevice *child;
65         struct stm32_gpio_bank *gpio_bank;
66         int ret;
67
68         /*
69          * parse pin-controller sub-nodes (ie gpio bank nodes) and fill
70          * a list with all gpio device reference which belongs to the
71          * current pin-controller. This list is used to find pin_name and
72          * pin muxing
73          */
74         list_for_each_entry(child, &dev->child_head, sibling_node) {
75                 ret = uclass_get_device_by_name(UCLASS_GPIO, child->name,
76                                                 &gpio_dev);
77                 if (ret < 0)
78                         continue;
79
80                 gpio_bank = malloc(sizeof(*gpio_bank));
81                 if (!gpio_bank) {
82                         dev_err(dev, "Not enough memory\n");
83                         return -ENOMEM;
84                 }
85
86                 gpio_bank->gpio_dev = gpio_dev;
87                 list_add_tail(&gpio_bank->list, &priv->gpio_dev);
88         }
89
90         return 0;
91 }
92
93 static int stm32_pinctrl_get_pins_count(struct udevice *dev)
94 {
95         struct stm32_pinctrl_priv *priv = dev_get_priv(dev);
96         struct gpio_dev_priv *uc_priv;
97         struct stm32_gpio_bank *gpio_bank;
98
99         /*
100          * if get_pins_count has already been executed once on this
101          * pin-controller, no need to run it again
102          */
103         if (priv->pinctrl_ngpios)
104                 return priv->pinctrl_ngpios;
105
106         if (list_empty(&priv->gpio_dev))
107                 stm32_populate_gpio_dev_list(dev);
108         /*
109          * walk through all banks to retrieve the pin-controller
110          * pins number
111          */
112         list_for_each_entry(gpio_bank, &priv->gpio_dev, list) {
113                 uc_priv = dev_get_uclass_priv(gpio_bank->gpio_dev);
114
115                 priv->pinctrl_ngpios += uc_priv->gpio_count;
116         }
117
118         return priv->pinctrl_ngpios;
119 }
120
121 static struct udevice *stm32_pinctrl_get_gpio_dev(struct udevice *dev,
122                                                   unsigned int selector,
123                                                   unsigned int *idx)
124 {
125         struct stm32_pinctrl_priv *priv = dev_get_priv(dev);
126         struct stm32_gpio_bank *gpio_bank;
127         struct gpio_dev_priv *uc_priv;
128         int pin_count = 0;
129
130         if (list_empty(&priv->gpio_dev))
131                 stm32_populate_gpio_dev_list(dev);
132
133         /* look up for the bank which owns the requested pin */
134         list_for_each_entry(gpio_bank, &priv->gpio_dev, list) {
135                 uc_priv = dev_get_uclass_priv(gpio_bank->gpio_dev);
136
137                 if (selector < (pin_count + uc_priv->gpio_count)) {
138                         /*
139                          * we found the bank, convert pin selector to
140                          * gpio bank index
141                          */
142                         *idx = stm32_offset_to_index(gpio_bank->gpio_dev,
143                                                      selector - pin_count);
144                         if (IS_ERR_VALUE(*idx))
145                                 return NULL;
146
147                         return gpio_bank->gpio_dev;
148                 }
149                 pin_count += uc_priv->gpio_count;
150         }
151
152         return NULL;
153 }
154
155 static const char *stm32_pinctrl_get_pin_name(struct udevice *dev,
156                                               unsigned int selector)
157 {
158         struct gpio_dev_priv *uc_priv;
159         struct udevice *gpio_dev;
160         unsigned int gpio_idx;
161
162         /* look up for the bank which owns the requested pin */
163         gpio_dev = stm32_pinctrl_get_gpio_dev(dev, selector, &gpio_idx);
164         if (!gpio_dev) {
165                 snprintf(pin_name, PINNAME_SIZE, "Error");
166         } else {
167                 uc_priv = dev_get_uclass_priv(gpio_dev);
168
169                 snprintf(pin_name, PINNAME_SIZE, "%s%d",
170                          uc_priv->bank_name,
171                          gpio_idx);
172         }
173
174         return pin_name;
175 }
176
177 static int stm32_pinctrl_get_pin_muxing(struct udevice *dev,
178                                         unsigned int selector,
179                                         char *buf,
180                                         int size)
181 {
182         struct udevice *gpio_dev;
183         const char *label;
184         int mode;
185         int af_num;
186         unsigned int gpio_idx;
187
188         /* look up for the bank which owns the requested pin */
189         gpio_dev = stm32_pinctrl_get_gpio_dev(dev, selector, &gpio_idx);
190
191         if (!gpio_dev)
192                 return -ENODEV;
193
194         mode = gpio_get_raw_function(gpio_dev, gpio_idx, &label);
195
196         dev_dbg(dev, "selector = %d gpio_idx = %d mode = %d\n",
197                 selector, gpio_idx, mode);
198
199
200         switch (mode) {
201         case GPIOF_UNKNOWN:
202                 /* should never happen */
203                 return -EINVAL;
204         case GPIOF_UNUSED:
205                 snprintf(buf, size, "%s", pinmux_mode[mode]);
206                 break;
207         case GPIOF_FUNC:
208                 af_num = stm32_pinctrl_get_af(gpio_dev, gpio_idx);
209                 snprintf(buf, size, "%s %d", pinmux_mode[mode], af_num);
210                 break;
211         case GPIOF_OUTPUT:
212         case GPIOF_INPUT:
213                 snprintf(buf, size, "%s %s",
214                          pinmux_mode[mode], label ? label : "");
215                 break;
216         }
217
218         return 0;
219 }
220
221 #endif
222
223 static int stm32_pinctrl_probe(struct udevice *dev)
224 {
225         struct stm32_pinctrl_priv *priv = dev_get_priv(dev);
226         int ret;
227
228         INIT_LIST_HEAD(&priv->gpio_dev);
229
230         /* hwspinlock property is optional, just log the error */
231         ret = hwspinlock_get_by_index(dev, 0, &priv->hws);
232         if (ret)
233                 debug("%s: hwspinlock_get_by_index may have failed (%d)\n",
234                       __func__, ret);
235
236         return 0;
237 }
238
239 static int stm32_gpio_config(struct gpio_desc *desc,
240                              const struct stm32_gpio_ctl *ctl)
241 {
242         struct stm32_gpio_priv *priv = dev_get_priv(desc->dev);
243         struct stm32_gpio_regs *regs = priv->regs;
244         struct stm32_pinctrl_priv *ctrl_priv;
245         int ret;
246         u32 index;
247
248         if (!ctl || ctl->af > 15 || ctl->mode > 3 || ctl->otype > 1 ||
249             ctl->pupd > 2 || ctl->speed > 3)
250                 return -EINVAL;
251
252         ctrl_priv = dev_get_priv(dev_get_parent(desc->dev));
253         ret = hwspinlock_lock_timeout(&ctrl_priv->hws, 10);
254         if (ret == -ETIME) {
255                 dev_err(desc->dev, "HWSpinlock timeout\n");
256                 return ret;
257         }
258
259         index = (desc->offset & 0x07) * 4;
260         clrsetbits_le32(&regs->afr[desc->offset >> 3], AFR_MASK << index,
261                         ctl->af << index);
262
263         index = desc->offset * 2;
264         clrsetbits_le32(&regs->moder, MODE_BITS_MASK << index,
265                         ctl->mode << index);
266         clrsetbits_le32(&regs->ospeedr, OSPEED_MASK << index,
267                         ctl->speed << index);
268         clrsetbits_le32(&regs->pupdr, PUPD_MASK << index, ctl->pupd << index);
269
270         index = desc->offset;
271         clrsetbits_le32(&regs->otyper, OTYPE_MSK << index, ctl->otype << index);
272
273         hwspinlock_unlock(&ctrl_priv->hws);
274
275         return 0;
276 }
277
278 static int prep_gpio_dsc(struct stm32_gpio_dsc *gpio_dsc, u32 port_pin)
279 {
280         gpio_dsc->port = (port_pin & 0x1F000) >> 12;
281         gpio_dsc->pin = (port_pin & 0x0F00) >> 8;
282         debug("%s: GPIO:port= %d, pin= %d\n", __func__, gpio_dsc->port,
283               gpio_dsc->pin);
284
285         return 0;
286 }
287
288 static int prep_gpio_ctl(struct stm32_gpio_ctl *gpio_ctl, u32 gpio_fn, int node)
289 {
290         gpio_fn &= 0x00FF;
291         gpio_ctl->af = 0;
292
293         switch (gpio_fn) {
294         case 0:
295                 gpio_ctl->mode = STM32_GPIO_MODE_IN;
296                 break;
297         case 1 ... 16:
298                 gpio_ctl->mode = STM32_GPIO_MODE_AF;
299                 gpio_ctl->af = gpio_fn - 1;
300                 break;
301         case 17:
302                 gpio_ctl->mode = STM32_GPIO_MODE_AN;
303                 break;
304         default:
305                 gpio_ctl->mode = STM32_GPIO_MODE_OUT;
306                 break;
307         }
308
309         gpio_ctl->speed = fdtdec_get_int(gd->fdt_blob, node, "slew-rate", 0);
310
311         if (fdtdec_get_bool(gd->fdt_blob, node, "drive-open-drain"))
312                 gpio_ctl->otype = STM32_GPIO_OTYPE_OD;
313         else
314                 gpio_ctl->otype = STM32_GPIO_OTYPE_PP;
315
316         if (fdtdec_get_bool(gd->fdt_blob, node, "bias-pull-up"))
317                 gpio_ctl->pupd = STM32_GPIO_PUPD_UP;
318         else if (fdtdec_get_bool(gd->fdt_blob, node, "bias-pull-down"))
319                 gpio_ctl->pupd = STM32_GPIO_PUPD_DOWN;
320         else
321                 gpio_ctl->pupd = STM32_GPIO_PUPD_NO;
322
323         debug("%s: gpio fn= %d, slew-rate= %x, op type= %x, pull-upd is = %x\n",
324               __func__,  gpio_fn, gpio_ctl->speed, gpio_ctl->otype,
325              gpio_ctl->pupd);
326
327         return 0;
328 }
329
330 static int stm32_pinctrl_config(int offset)
331 {
332         u32 pin_mux[MAX_PINS_ONE_IP];
333         int rv, len;
334
335         /*
336          * check for "pinmux" property in each subnode (e.g. pins1 and pins2 for
337          * usart1) of pin controller phandle "pinctrl-0"
338          * */
339         fdt_for_each_subnode(offset, gd->fdt_blob, offset) {
340                 struct stm32_gpio_dsc gpio_dsc;
341                 struct stm32_gpio_ctl gpio_ctl;
342                 int i;
343
344                 len = fdtdec_get_int_array_count(gd->fdt_blob, offset,
345                                                  "pinmux", pin_mux,
346                                                  ARRAY_SIZE(pin_mux));
347                 debug("%s: no of pinmux entries= %d\n", __func__, len);
348                 if (len < 0)
349                         return -EINVAL;
350                 for (i = 0; i < len; i++) {
351                         struct gpio_desc desc;
352
353                         debug("%s: pinmux = %x\n", __func__, *(pin_mux + i));
354                         prep_gpio_dsc(&gpio_dsc, *(pin_mux + i));
355                         prep_gpio_ctl(&gpio_ctl, *(pin_mux + i), offset);
356                         rv = uclass_get_device_by_seq(UCLASS_GPIO,
357                                                       gpio_dsc.port,
358                                                       &desc.dev);
359                         if (rv)
360                                 return rv;
361                         desc.offset = gpio_dsc.pin;
362                         rv = stm32_gpio_config(&desc, &gpio_ctl);
363                         debug("%s: rv = %d\n\n", __func__, rv);
364                         if (rv)
365                                 return rv;
366                 }
367         }
368
369         return 0;
370 }
371
372 static int stm32_pinctrl_bind(struct udevice *dev)
373 {
374         ofnode node;
375         const char *name;
376         int ret;
377
378         dev_for_each_subnode(node, dev) {
379                 debug("%s: bind %s\n", __func__, ofnode_get_name(node));
380
381                 ofnode_get_property(node, "gpio-controller", &ret);
382                 if (ret < 0)
383                         continue;
384                 /* Get the name of each gpio node */
385                 name = ofnode_get_name(node);
386                 if (!name)
387                         return -EINVAL;
388
389                 /* Bind each gpio node */
390                 ret = device_bind_driver_to_node(dev, "gpio_stm32",
391                                                  name, node, NULL);
392                 if (ret)
393                         return ret;
394
395                 debug("%s: bind %s\n", __func__, name);
396         }
397
398         return 0;
399 }
400
401 #if CONFIG_IS_ENABLED(PINCTRL_FULL)
402 static int stm32_pinctrl_set_state(struct udevice *dev, struct udevice *config)
403 {
404         return stm32_pinctrl_config(dev_of_offset(config));
405 }
406 #else /* PINCTRL_FULL */
407 static int stm32_pinctrl_set_state_simple(struct udevice *dev,
408                                           struct udevice *periph)
409 {
410         const void *fdt = gd->fdt_blob;
411         const fdt32_t *list;
412         uint32_t phandle;
413         int config_node;
414         int size, i, ret;
415
416         list = fdt_getprop(fdt, dev_of_offset(periph), "pinctrl-0", &size);
417         if (!list)
418                 return -EINVAL;
419
420         debug("%s: periph->name = %s\n", __func__, periph->name);
421
422         size /= sizeof(*list);
423         for (i = 0; i < size; i++) {
424                 phandle = fdt32_to_cpu(*list++);
425
426                 config_node = fdt_node_offset_by_phandle(fdt, phandle);
427                 if (config_node < 0) {
428                         pr_err("prop pinctrl-0 index %d invalid phandle\n", i);
429                         return -EINVAL;
430                 }
431
432                 ret = stm32_pinctrl_config(config_node);
433                 if (ret)
434                         return ret;
435         }
436
437         return 0;
438 }
439 #endif /* PINCTRL_FULL */
440
441 static struct pinctrl_ops stm32_pinctrl_ops = {
442 #if CONFIG_IS_ENABLED(PINCTRL_FULL)
443         .set_state              = stm32_pinctrl_set_state,
444 #else /* PINCTRL_FULL */
445         .set_state_simple       = stm32_pinctrl_set_state_simple,
446 #endif /* PINCTRL_FULL */
447 #ifndef CONFIG_SPL_BUILD
448         .get_pin_name           = stm32_pinctrl_get_pin_name,
449         .get_pins_count         = stm32_pinctrl_get_pins_count,
450         .get_pin_muxing         = stm32_pinctrl_get_pin_muxing,
451 #endif
452 };
453
454 static const struct udevice_id stm32_pinctrl_ids[] = {
455         { .compatible = "st,stm32f429-pinctrl" },
456         { .compatible = "st,stm32f469-pinctrl" },
457         { .compatible = "st,stm32f746-pinctrl" },
458         { .compatible = "st,stm32f769-pinctrl" },
459         { .compatible = "st,stm32h743-pinctrl" },
460         { .compatible = "st,stm32mp157-pinctrl" },
461         { .compatible = "st,stm32mp157-z-pinctrl" },
462         { }
463 };
464
465 U_BOOT_DRIVER(pinctrl_stm32) = {
466         .name                   = "pinctrl_stm32",
467         .id                     = UCLASS_PINCTRL,
468         .of_match               = stm32_pinctrl_ids,
469         .ops                    = &stm32_pinctrl_ops,
470         .bind                   = stm32_pinctrl_bind,
471         .probe                  = stm32_pinctrl_probe,
472         .priv_auto_alloc_size   = sizeof(struct stm32_pinctrl_priv),
473 };