1 // SPDX-License-Identifier: GPL-2.0
3 * Combined GPIO and pin controller support for Renesas RZ/A1 (r7s72100) SoC
5 * Copyright (C) 2017 Jacopo Mondi
9 * This pin controller/gpio combined driver supports Renesas devices of RZ/A1
11 * This includes SoCs which are sub- or super- sets of this particular line,
12 * as RZ/A1H (r7s721000), RZ/A1M (r7s721010) and RZ/A1L (r7s721020).
15 #include <linux/bitops.h>
16 #include <linux/err.h>
17 #include <linux/gpio/driver.h>
18 #include <linux/init.h>
19 #include <linux/ioport.h>
20 #include <linux/module.h>
22 #include <linux/of_address.h>
23 #include <linux/of_device.h>
24 #include <linux/pinctrl/pinconf-generic.h>
25 #include <linux/pinctrl/pinctrl.h>
26 #include <linux/pinctrl/pinmux.h>
27 #include <linux/slab.h>
30 #include "../devicetree.h"
31 #include "../pinconf.h"
32 #include "../pinmux.h"
34 #define DRIVER_NAME "pinctrl-rza1"
36 #define RZA1_P_REG 0x0000
37 #define RZA1_PPR_REG 0x0200
38 #define RZA1_PM_REG 0x0300
39 #define RZA1_PMC_REG 0x0400
40 #define RZA1_PFC_REG 0x0500
41 #define RZA1_PFCE_REG 0x0600
42 #define RZA1_PFCEA_REG 0x0a00
43 #define RZA1_PIBC_REG 0x4000
44 #define RZA1_PBDC_REG 0x4100
45 #define RZA1_PIPC_REG 0x4200
47 #define RZA1_ADDR(mem, reg, port) ((mem) + (reg) + ((port) * 4))
49 #define RZA1_NPORTS 12
50 #define RZA1_PINS_PER_PORT 16
51 #define RZA1_NPINS (RZA1_PINS_PER_PORT * RZA1_NPORTS)
52 #define RZA1_PIN_ID_TO_PORT(id) ((id) / RZA1_PINS_PER_PORT)
53 #define RZA1_PIN_ID_TO_PIN(id) ((id) % RZA1_PINS_PER_PORT)
56 * Use 16 lower bits [15:0] for pin identifier
57 * Use 16 higher bits [31:16] for pin mux function
59 #define MUX_PIN_ID_MASK GENMASK(15, 0)
60 #define MUX_FUNC_MASK GENMASK(31, 16)
62 #define MUX_FUNC_OFFS 16
63 #define MUX_FUNC(pinconf) \
64 ((pinconf & MUX_FUNC_MASK) >> MUX_FUNC_OFFS)
65 #define MUX_FUNC_PFC_MASK BIT(0)
66 #define MUX_FUNC_PFCE_MASK BIT(1)
67 #define MUX_FUNC_PFCEA_MASK BIT(2)
70 #define MUX_FLAGS_BIDIR BIT(0)
71 #define MUX_FLAGS_SWIO_INPUT BIT(1)
72 #define MUX_FLAGS_SWIO_OUTPUT BIT(2)
74 /* ----------------------------------------------------------------------------
79 * rza1_bidir_pin - describe a single pin that needs bidir flag applied.
81 struct rza1_bidir_pin {
87 * rza1_bidir_entry - describe a list of pins that needs bidir flag applied.
88 * Each struct rza1_bidir_entry describes a port.
90 struct rza1_bidir_entry {
91 const unsigned int npins;
92 const struct rza1_bidir_pin *pins;
96 * rza1_swio_pin - describe a single pin that needs swio flag applied.
98 struct rza1_swio_pin {
106 * rza1_swio_entry - describe a list of pins that needs swio flag applied
108 struct rza1_swio_entry {
109 const unsigned int npins;
110 const struct rza1_swio_pin *pins;
114 * rza1_pinmux_conf - group together bidir and swio pinmux flag tables
116 struct rza1_pinmux_conf {
117 const struct rza1_bidir_entry *bidir_entries;
118 const struct rza1_swio_entry *swio_entries;
121 /* ----------------------------------------------------------------------------
122 * RZ/A1H (r7s72100) pinmux flags
125 static const struct rza1_bidir_pin rza1h_bidir_pins_p1[] = {
126 { .pin = 0, .func = 1 },
127 { .pin = 1, .func = 1 },
128 { .pin = 2, .func = 1 },
129 { .pin = 3, .func = 1 },
130 { .pin = 4, .func = 1 },
131 { .pin = 5, .func = 1 },
132 { .pin = 6, .func = 1 },
133 { .pin = 7, .func = 1 },
136 static const struct rza1_bidir_pin rza1h_bidir_pins_p2[] = {
137 { .pin = 0, .func = 1 },
138 { .pin = 1, .func = 1 },
139 { .pin = 2, .func = 1 },
140 { .pin = 3, .func = 1 },
141 { .pin = 4, .func = 1 },
142 { .pin = 0, .func = 4 },
143 { .pin = 1, .func = 4 },
144 { .pin = 2, .func = 4 },
145 { .pin = 3, .func = 4 },
146 { .pin = 5, .func = 1 },
147 { .pin = 6, .func = 1 },
148 { .pin = 7, .func = 1 },
149 { .pin = 8, .func = 1 },
150 { .pin = 9, .func = 1 },
151 { .pin = 10, .func = 1 },
152 { .pin = 11, .func = 1 },
153 { .pin = 12, .func = 1 },
154 { .pin = 13, .func = 1 },
155 { .pin = 14, .func = 1 },
156 { .pin = 15, .func = 1 },
157 { .pin = 12, .func = 4 },
158 { .pin = 13, .func = 4 },
159 { .pin = 14, .func = 4 },
160 { .pin = 15, .func = 4 },
163 static const struct rza1_bidir_pin rza1h_bidir_pins_p3[] = {
164 { .pin = 3, .func = 2 },
165 { .pin = 10, .func = 7 },
166 { .pin = 11, .func = 7 },
167 { .pin = 13, .func = 7 },
168 { .pin = 14, .func = 7 },
169 { .pin = 15, .func = 7 },
170 { .pin = 10, .func = 8 },
171 { .pin = 11, .func = 8 },
172 { .pin = 13, .func = 8 },
173 { .pin = 14, .func = 8 },
174 { .pin = 15, .func = 8 },
177 static const struct rza1_bidir_pin rza1h_bidir_pins_p4[] = {
178 { .pin = 0, .func = 8 },
179 { .pin = 1, .func = 8 },
180 { .pin = 2, .func = 8 },
181 { .pin = 3, .func = 8 },
182 { .pin = 10, .func = 3 },
183 { .pin = 11, .func = 3 },
184 { .pin = 13, .func = 3 },
185 { .pin = 14, .func = 3 },
186 { .pin = 15, .func = 3 },
187 { .pin = 10, .func = 4 },
188 { .pin = 11, .func = 4 },
189 { .pin = 13, .func = 4 },
190 { .pin = 14, .func = 4 },
191 { .pin = 15, .func = 4 },
192 { .pin = 12, .func = 5 },
193 { .pin = 13, .func = 5 },
194 { .pin = 14, .func = 5 },
195 { .pin = 15, .func = 5 },
198 static const struct rza1_bidir_pin rza1h_bidir_pins_p6[] = {
199 { .pin = 0, .func = 1 },
200 { .pin = 1, .func = 1 },
201 { .pin = 2, .func = 1 },
202 { .pin = 3, .func = 1 },
203 { .pin = 4, .func = 1 },
204 { .pin = 5, .func = 1 },
205 { .pin = 6, .func = 1 },
206 { .pin = 7, .func = 1 },
207 { .pin = 8, .func = 1 },
208 { .pin = 9, .func = 1 },
209 { .pin = 10, .func = 1 },
210 { .pin = 11, .func = 1 },
211 { .pin = 12, .func = 1 },
212 { .pin = 13, .func = 1 },
213 { .pin = 14, .func = 1 },
214 { .pin = 15, .func = 1 },
217 static const struct rza1_bidir_pin rza1h_bidir_pins_p7[] = {
218 { .pin = 13, .func = 3 },
221 static const struct rza1_bidir_pin rza1h_bidir_pins_p8[] = {
222 { .pin = 8, .func = 3 },
223 { .pin = 9, .func = 3 },
224 { .pin = 10, .func = 3 },
225 { .pin = 11, .func = 3 },
226 { .pin = 14, .func = 2 },
227 { .pin = 15, .func = 2 },
228 { .pin = 14, .func = 3 },
229 { .pin = 15, .func = 3 },
232 static const struct rza1_bidir_pin rza1h_bidir_pins_p9[] = {
233 { .pin = 0, .func = 2 },
234 { .pin = 1, .func = 2 },
235 { .pin = 4, .func = 2 },
236 { .pin = 5, .func = 2 },
237 { .pin = 6, .func = 2 },
238 { .pin = 7, .func = 2 },
241 static const struct rza1_bidir_pin rza1h_bidir_pins_p11[] = {
242 { .pin = 6, .func = 2 },
243 { .pin = 7, .func = 2 },
244 { .pin = 9, .func = 2 },
245 { .pin = 6, .func = 4 },
246 { .pin = 7, .func = 4 },
247 { .pin = 9, .func = 4 },
248 { .pin = 10, .func = 2 },
249 { .pin = 11, .func = 2 },
250 { .pin = 10, .func = 4 },
251 { .pin = 11, .func = 4 },
252 { .pin = 12, .func = 4 },
253 { .pin = 13, .func = 4 },
254 { .pin = 14, .func = 4 },
255 { .pin = 15, .func = 4 },
258 static const struct rza1_swio_pin rza1h_swio_pins[] = {
259 { .port = 2, .pin = 7, .func = 4, .input = 0 },
260 { .port = 2, .pin = 11, .func = 4, .input = 0 },
261 { .port = 3, .pin = 7, .func = 3, .input = 0 },
262 { .port = 3, .pin = 7, .func = 8, .input = 0 },
263 { .port = 4, .pin = 7, .func = 5, .input = 0 },
264 { .port = 4, .pin = 7, .func = 11, .input = 0 },
265 { .port = 4, .pin = 15, .func = 6, .input = 0 },
266 { .port = 5, .pin = 0, .func = 1, .input = 1 },
267 { .port = 5, .pin = 1, .func = 1, .input = 1 },
268 { .port = 5, .pin = 2, .func = 1, .input = 1 },
269 { .port = 5, .pin = 3, .func = 1, .input = 1 },
270 { .port = 5, .pin = 4, .func = 1, .input = 1 },
271 { .port = 5, .pin = 5, .func = 1, .input = 1 },
272 { .port = 5, .pin = 6, .func = 1, .input = 1 },
273 { .port = 5, .pin = 7, .func = 1, .input = 1 },
274 { .port = 7, .pin = 4, .func = 6, .input = 0 },
275 { .port = 7, .pin = 11, .func = 2, .input = 0 },
276 { .port = 8, .pin = 10, .func = 8, .input = 0 },
277 { .port = 10, .pin = 15, .func = 2, .input = 0 },
280 static const struct rza1_bidir_entry rza1h_bidir_entries[RZA1_NPORTS] = {
281 [1] = { ARRAY_SIZE(rza1h_bidir_pins_p1), rza1h_bidir_pins_p1 },
282 [2] = { ARRAY_SIZE(rza1h_bidir_pins_p2), rza1h_bidir_pins_p2 },
283 [3] = { ARRAY_SIZE(rza1h_bidir_pins_p3), rza1h_bidir_pins_p3 },
284 [4] = { ARRAY_SIZE(rza1h_bidir_pins_p4), rza1h_bidir_pins_p4 },
285 [6] = { ARRAY_SIZE(rza1h_bidir_pins_p6), rza1h_bidir_pins_p6 },
286 [7] = { ARRAY_SIZE(rza1h_bidir_pins_p7), rza1h_bidir_pins_p7 },
287 [8] = { ARRAY_SIZE(rza1h_bidir_pins_p8), rza1h_bidir_pins_p8 },
288 [9] = { ARRAY_SIZE(rza1h_bidir_pins_p9), rza1h_bidir_pins_p9 },
289 [11] = { ARRAY_SIZE(rza1h_bidir_pins_p11), rza1h_bidir_pins_p11 },
292 static const struct rza1_swio_entry rza1h_swio_entries[] = {
293 [0] = { ARRAY_SIZE(rza1h_swio_pins), rza1h_swio_pins },
296 /* RZ/A1H (r7s72100x) pinmux flags table */
297 static const struct rza1_pinmux_conf rza1h_pmx_conf = {
298 .bidir_entries = rza1h_bidir_entries,
299 .swio_entries = rza1h_swio_entries,
302 /* ----------------------------------------------------------------------------
303 * RZ/A1L (r7s72102) pinmux flags
306 static const struct rza1_bidir_pin rza1l_bidir_pins_p1[] = {
307 { .pin = 0, .func = 1 },
308 { .pin = 1, .func = 1 },
309 { .pin = 2, .func = 1 },
310 { .pin = 3, .func = 1 },
311 { .pin = 4, .func = 1 },
312 { .pin = 5, .func = 1 },
313 { .pin = 6, .func = 1 },
314 { .pin = 7, .func = 1 },
317 static const struct rza1_bidir_pin rza1l_bidir_pins_p3[] = {
318 { .pin = 0, .func = 2 },
319 { .pin = 1, .func = 2 },
320 { .pin = 2, .func = 2 },
321 { .pin = 4, .func = 2 },
322 { .pin = 5, .func = 2 },
323 { .pin = 10, .func = 2 },
324 { .pin = 11, .func = 2 },
325 { .pin = 12, .func = 2 },
326 { .pin = 13, .func = 2 },
329 static const struct rza1_bidir_pin rza1l_bidir_pins_p4[] = {
330 { .pin = 1, .func = 4 },
331 { .pin = 2, .func = 2 },
332 { .pin = 3, .func = 2 },
333 { .pin = 6, .func = 2 },
334 { .pin = 7, .func = 2 },
337 static const struct rza1_bidir_pin rza1l_bidir_pins_p5[] = {
338 { .pin = 0, .func = 1 },
339 { .pin = 1, .func = 1 },
340 { .pin = 2, .func = 1 },
341 { .pin = 3, .func = 1 },
342 { .pin = 4, .func = 1 },
343 { .pin = 5, .func = 1 },
344 { .pin = 6, .func = 1 },
345 { .pin = 7, .func = 1 },
346 { .pin = 8, .func = 1 },
347 { .pin = 9, .func = 1 },
348 { .pin = 10, .func = 1 },
349 { .pin = 11, .func = 1 },
350 { .pin = 12, .func = 1 },
351 { .pin = 13, .func = 1 },
352 { .pin = 14, .func = 1 },
353 { .pin = 15, .func = 1 },
354 { .pin = 0, .func = 2 },
355 { .pin = 1, .func = 2 },
356 { .pin = 2, .func = 2 },
357 { .pin = 3, .func = 2 },
360 static const struct rza1_bidir_pin rza1l_bidir_pins_p6[] = {
361 { .pin = 0, .func = 1 },
362 { .pin = 1, .func = 1 },
363 { .pin = 2, .func = 1 },
364 { .pin = 3, .func = 1 },
365 { .pin = 4, .func = 1 },
366 { .pin = 5, .func = 1 },
367 { .pin = 6, .func = 1 },
368 { .pin = 7, .func = 1 },
369 { .pin = 8, .func = 1 },
370 { .pin = 9, .func = 1 },
371 { .pin = 10, .func = 1 },
372 { .pin = 11, .func = 1 },
373 { .pin = 12, .func = 1 },
374 { .pin = 13, .func = 1 },
375 { .pin = 14, .func = 1 },
376 { .pin = 15, .func = 1 },
379 static const struct rza1_bidir_pin rza1l_bidir_pins_p7[] = {
380 { .pin = 2, .func = 2 },
381 { .pin = 3, .func = 2 },
382 { .pin = 5, .func = 2 },
383 { .pin = 6, .func = 2 },
384 { .pin = 7, .func = 2 },
385 { .pin = 2, .func = 3 },
386 { .pin = 3, .func = 3 },
387 { .pin = 5, .func = 3 },
388 { .pin = 6, .func = 3 },
389 { .pin = 7, .func = 3 },
392 static const struct rza1_bidir_pin rza1l_bidir_pins_p9[] = {
393 { .pin = 1, .func = 2 },
394 { .pin = 0, .func = 3 },
395 { .pin = 1, .func = 3 },
396 { .pin = 3, .func = 3 },
397 { .pin = 4, .func = 3 },
398 { .pin = 5, .func = 3 },
401 static const struct rza1_swio_pin rza1l_swio_pins[] = {
402 { .port = 2, .pin = 8, .func = 2, .input = 0 },
403 { .port = 5, .pin = 6, .func = 3, .input = 0 },
404 { .port = 6, .pin = 6, .func = 3, .input = 0 },
405 { .port = 6, .pin = 10, .func = 3, .input = 0 },
406 { .port = 7, .pin = 10, .func = 2, .input = 0 },
407 { .port = 8, .pin = 2, .func = 3, .input = 0 },
410 static const struct rza1_bidir_entry rza1l_bidir_entries[RZA1_NPORTS] = {
411 [1] = { ARRAY_SIZE(rza1l_bidir_pins_p1), rza1l_bidir_pins_p1 },
412 [3] = { ARRAY_SIZE(rza1l_bidir_pins_p3), rza1l_bidir_pins_p3 },
413 [4] = { ARRAY_SIZE(rza1l_bidir_pins_p4), rza1l_bidir_pins_p4 },
414 [5] = { ARRAY_SIZE(rza1l_bidir_pins_p4), rza1l_bidir_pins_p5 },
415 [6] = { ARRAY_SIZE(rza1l_bidir_pins_p6), rza1l_bidir_pins_p6 },
416 [7] = { ARRAY_SIZE(rza1l_bidir_pins_p7), rza1l_bidir_pins_p7 },
417 [9] = { ARRAY_SIZE(rza1l_bidir_pins_p9), rza1l_bidir_pins_p9 },
420 static const struct rza1_swio_entry rza1l_swio_entries[] = {
421 [0] = { ARRAY_SIZE(rza1l_swio_pins), rza1l_swio_pins },
424 /* RZ/A1L (r7s72102x) pinmux flags table */
425 static const struct rza1_pinmux_conf rza1l_pmx_conf = {
426 .bidir_entries = rza1l_bidir_entries,
427 .swio_entries = rza1l_swio_entries,
430 /* ----------------------------------------------------------------------------
434 * struct rza1_mux_conf - describes a pin multiplexing operation
436 * @id: the pin identifier from 0 to RZA1_NPINS
437 * @port: the port where pin sits on
439 * @mux_func: alternate function id number
440 * @mux_flags: alternate function flags
441 * @value: output value to set the pin to
443 struct rza1_mux_conf {
453 * struct rza1_port - describes a pin port
455 * This is mostly useful to lock register writes per-bank and not globally.
457 * @lock: protect access to HW registers
459 * @base: logical address base
460 * @pins: pins sitting on this port
466 struct pinctrl_pin_desc *pins;
470 * struct rza1_pinctrl - RZ pincontroller device
472 * @dev: parent device structure
473 * @mutex: protect [pinctrl|pinmux]_generic functions
474 * @base: logical address base
475 * @nport: number of pin controller ports
476 * @ports: pin controller banks
477 * @pins: pin array for pinctrl core
478 * @desc: pincontroller desc for pinctrl core
479 * @pctl: pinctrl device
480 * @data: device specific data
482 struct rza1_pinctrl {
490 struct rza1_port *ports;
492 struct pinctrl_pin_desc *pins;
493 struct pinctrl_desc desc;
494 struct pinctrl_dev *pctl;
499 /* ----------------------------------------------------------------------------
502 static inline bool rza1_pinmux_get_bidir(unsigned int port,
505 const struct rza1_bidir_entry *table)
507 const struct rza1_bidir_entry *entry = &table[port];
508 const struct rza1_bidir_pin *bidir_pin;
511 for (i = 0; i < entry->npins; ++i) {
512 bidir_pin = &entry->pins[i];
513 if (bidir_pin->pin == pin && bidir_pin->func == func)
520 static inline int rza1_pinmux_get_swio(unsigned int port,
523 const struct rza1_swio_entry *table)
525 const struct rza1_swio_pin *swio_pin;
529 for (i = 0; i < table->npins; ++i) {
530 swio_pin = &table->pins[i];
531 if (swio_pin->port == port && swio_pin->pin == pin &&
532 swio_pin->func == func)
533 return swio_pin->input;
540 * rza1_pinmux_get_flags() - return pinmux flags associated to a pin
542 static unsigned int rza1_pinmux_get_flags(unsigned int port, unsigned int pin,
544 struct rza1_pinctrl *rza1_pctl)
547 const struct rza1_pinmux_conf *pmx_conf = rza1_pctl->data;
548 const struct rza1_bidir_entry *bidir_entries = pmx_conf->bidir_entries;
549 const struct rza1_swio_entry *swio_entries = pmx_conf->swio_entries;
550 unsigned int pmx_flags = 0;
553 if (rza1_pinmux_get_bidir(port, pin, func, bidir_entries))
554 pmx_flags |= MUX_FLAGS_BIDIR;
556 ret = rza1_pinmux_get_swio(port, pin, func, swio_entries);
558 pmx_flags |= MUX_FLAGS_SWIO_OUTPUT;
560 pmx_flags |= MUX_FLAGS_SWIO_INPUT;
565 /* ----------------------------------------------------------------------------
566 * RZ/A1 SoC operations
570 * rza1_set_bit() - un-locked set/clear a single bit in pin configuration
573 static inline void rza1_set_bit(struct rza1_port *port, unsigned int reg,
574 unsigned int bit, bool set)
576 void __iomem *mem = RZA1_ADDR(port->base, reg, port->id);
577 u16 val = ioread16(mem);
587 static inline unsigned int rza1_get_bit(struct rza1_port *port,
588 unsigned int reg, unsigned int bit)
590 void __iomem *mem = RZA1_ADDR(port->base, reg, port->id);
592 return ioread16(mem) & BIT(bit);
596 * rza1_pin_reset() - reset a pin to default initial state
598 * Reset pin state disabling input buffer and bi-directional control,
599 * and configure it as input port.
600 * Note that pin is now configured with direction as input but with input
601 * buffer disabled. This implies the pin value cannot be read in this state.
603 * @port: port where pin sits on
606 static void rza1_pin_reset(struct rza1_port *port, unsigned int pin)
608 unsigned long irqflags;
610 spin_lock_irqsave(&port->lock, irqflags);
611 rza1_set_bit(port, RZA1_PIBC_REG, pin, 0);
612 rza1_set_bit(port, RZA1_PBDC_REG, pin, 0);
614 rza1_set_bit(port, RZA1_PM_REG, pin, 1);
615 rza1_set_bit(port, RZA1_PMC_REG, pin, 0);
616 rza1_set_bit(port, RZA1_PIPC_REG, pin, 0);
617 spin_unlock_irqrestore(&port->lock, irqflags);
621 * rza1_pin_set_direction() - set I/O direction on a pin in port mode
623 * When running in output port mode keep PBDC enabled to allow reading the
624 * pin value from PPR.
626 * @port: port where pin sits on
628 * @input: input enable/disable flag
630 static inline void rza1_pin_set_direction(struct rza1_port *port,
631 unsigned int pin, bool input)
633 unsigned long irqflags;
635 spin_lock_irqsave(&port->lock, irqflags);
637 rza1_set_bit(port, RZA1_PIBC_REG, pin, 1);
639 rza1_set_bit(port, RZA1_PM_REG, pin, 1);
640 rza1_set_bit(port, RZA1_PBDC_REG, pin, 0);
642 rza1_set_bit(port, RZA1_PM_REG, pin, 0);
643 rza1_set_bit(port, RZA1_PBDC_REG, pin, 1);
646 spin_unlock_irqrestore(&port->lock, irqflags);
649 static inline void rza1_pin_set(struct rza1_port *port, unsigned int pin,
652 unsigned long irqflags;
654 spin_lock_irqsave(&port->lock, irqflags);
655 rza1_set_bit(port, RZA1_P_REG, pin, !!value);
656 spin_unlock_irqrestore(&port->lock, irqflags);
659 static inline int rza1_pin_get(struct rza1_port *port, unsigned int pin)
661 return rza1_get_bit(port, RZA1_PPR_REG, pin);
665 * rza1_pin_mux_single() - configure pin multiplexing on a single pin
667 * @rza1_pctl: RZ/A1 pin controller device
668 * @mux_conf: pin multiplexing descriptor
670 static int rza1_pin_mux_single(struct rza1_pinctrl *rza1_pctl,
671 struct rza1_mux_conf *mux_conf)
673 struct rza1_port *port = &rza1_pctl->ports[mux_conf->port];
674 unsigned int pin = mux_conf->pin;
675 u8 mux_func = mux_conf->mux_func;
676 u8 mux_flags = mux_conf->mux_flags;
677 u8 mux_flags_from_table;
679 rza1_pin_reset(port, pin);
681 /* SWIO pinmux flags coming from DT are high precedence */
682 mux_flags_from_table = rza1_pinmux_get_flags(port->id, pin, mux_func,
685 mux_flags |= (mux_flags_from_table & MUX_FLAGS_BIDIR);
687 mux_flags = mux_flags_from_table;
689 if (mux_flags & MUX_FLAGS_BIDIR)
690 rza1_set_bit(port, RZA1_PBDC_REG, pin, 1);
693 * Enable alternate function mode and select it.
695 * Be careful here: the pin mux sub-nodes in device tree
696 * enumerate alternate functions from 1 to 8;
697 * subtract 1 before using macros to match registers configuration
698 * which expects numbers from 0 to 7 instead.
700 * ----------------------------------------------------
701 * Alternate mode selection table:
703 * PMC PFC PFCE PFCAE (mux_func - 1)
712 * ----------------------------------------------------
715 rza1_set_bit(port, RZA1_PFC_REG, pin, mux_func & MUX_FUNC_PFC_MASK);
716 rza1_set_bit(port, RZA1_PFCE_REG, pin, mux_func & MUX_FUNC_PFCE_MASK);
717 rza1_set_bit(port, RZA1_PFCEA_REG, pin, mux_func & MUX_FUNC_PFCEA_MASK);
720 * All alternate functions except a few need PIPCn = 1.
721 * If PIPCn has to stay disabled (SW IO mode), configure PMn according
722 * to I/O direction specified by pin configuration -after- PMC has been
725 if (mux_flags & (MUX_FLAGS_SWIO_INPUT | MUX_FLAGS_SWIO_OUTPUT))
726 rza1_set_bit(port, RZA1_PM_REG, pin,
727 mux_flags & MUX_FLAGS_SWIO_INPUT);
729 rza1_set_bit(port, RZA1_PIPC_REG, pin, 1);
731 rza1_set_bit(port, RZA1_PMC_REG, pin, 1);
736 /* ----------------------------------------------------------------------------
741 * rza1_gpio_request() - configure pin in port mode
743 * Configure a pin as gpio (port mode).
744 * After reset, the pin is in input mode with input buffer disabled.
745 * To use the pin as input or output, set_direction shall be called first
747 * @chip: gpio chip where the gpio sits on
750 static int rza1_gpio_request(struct gpio_chip *chip, unsigned int gpio)
752 struct rza1_port *port = gpiochip_get_data(chip);
754 rza1_pin_reset(port, gpio);
760 * rza1_gpio_disable_free() - reset a pin
762 * Surprisingly, disable_free a gpio, is equivalent to request it.
763 * Reset pin to port mode, with input buffer disabled. This overwrites all
764 * port direction settings applied with set_direction
766 * @chip: gpio chip where the gpio sits on
769 static void rza1_gpio_free(struct gpio_chip *chip, unsigned int gpio)
771 struct rza1_port *port = gpiochip_get_data(chip);
773 rza1_pin_reset(port, gpio);
776 static int rza1_gpio_get_direction(struct gpio_chip *chip, unsigned int gpio)
778 struct rza1_port *port = gpiochip_get_data(chip);
780 if (rza1_get_bit(port, RZA1_PM_REG, gpio))
781 return GPIO_LINE_DIRECTION_IN;
783 return GPIO_LINE_DIRECTION_OUT;
786 static int rza1_gpio_direction_input(struct gpio_chip *chip,
789 struct rza1_port *port = gpiochip_get_data(chip);
791 rza1_pin_set_direction(port, gpio, true);
796 static int rza1_gpio_direction_output(struct gpio_chip *chip,
800 struct rza1_port *port = gpiochip_get_data(chip);
802 /* Set value before driving pin direction */
803 rza1_pin_set(port, gpio, value);
804 rza1_pin_set_direction(port, gpio, false);
810 * rza1_gpio_get() - read a gpio pin value
812 * Read gpio pin value through PPR register.
813 * Requires bi-directional mode to work when reading the value of a pin
816 * @chip: gpio chip where the gpio sits on
819 static int rza1_gpio_get(struct gpio_chip *chip, unsigned int gpio)
821 struct rza1_port *port = gpiochip_get_data(chip);
823 return rza1_pin_get(port, gpio);
826 static void rza1_gpio_set(struct gpio_chip *chip, unsigned int gpio,
829 struct rza1_port *port = gpiochip_get_data(chip);
831 rza1_pin_set(port, gpio, value);
834 static const struct gpio_chip rza1_gpiochip_template = {
835 .request = rza1_gpio_request,
836 .free = rza1_gpio_free,
837 .get_direction = rza1_gpio_get_direction,
838 .direction_input = rza1_gpio_direction_input,
839 .direction_output = rza1_gpio_direction_output,
840 .get = rza1_gpio_get,
841 .set = rza1_gpio_set,
843 /* ----------------------------------------------------------------------------
848 * rza1_dt_node_pin_count() - Count number of pins in a dt node or in all its
851 * @np: device tree node to parse
853 static int rza1_dt_node_pin_count(struct device_node *np)
855 struct device_node *child;
856 struct property *of_pins;
859 of_pins = of_find_property(np, "pinmux", NULL);
861 return of_pins->length / sizeof(u32);
864 for_each_child_of_node(np, child) {
865 of_pins = of_find_property(child, "pinmux", NULL);
871 npins += of_pins->length / sizeof(u32);
878 * rza1_parse_pmx_function() - parse a pin mux sub-node
880 * @rza1_pctl: RZ/A1 pin controller device
881 * @np: of pmx sub-node
882 * @mux_confs: array of pin mux configurations to fill with parsed info
883 * @grpins: array of pin ids to mux
885 static int rza1_parse_pinmux_node(struct rza1_pinctrl *rza1_pctl,
886 struct device_node *np,
887 struct rza1_mux_conf *mux_confs,
888 unsigned int *grpins)
890 struct pinctrl_dev *pctldev = rza1_pctl->pctl;
891 char const *prop_name = "pinmux";
892 unsigned long *pin_configs;
893 unsigned int npin_configs;
894 struct property *of_pins;
900 of_pins = of_find_property(np, prop_name, NULL);
902 dev_dbg(rza1_pctl->dev, "Missing %s property\n", prop_name);
905 npins = of_pins->length / sizeof(u32);
908 * Collect pin configuration properties: they apply to all pins in
911 ret = pinconf_generic_parse_dt_config(np, pctldev, &pin_configs,
914 dev_err(rza1_pctl->dev,
915 "Unable to parse pin configuration options for %pOFn\n",
921 * Create a mask with pinmux flags from pin configuration;
922 * very few pins (TIOC[0-4][A|B|C|D] require SWIO direction
923 * specified in device tree.
926 for (i = 0; i < npin_configs && pinmux_flags == 0; i++)
927 switch (pinconf_to_config_param(pin_configs[i])) {
928 case PIN_CONFIG_INPUT_ENABLE:
929 pinmux_flags |= MUX_FLAGS_SWIO_INPUT;
931 case PIN_CONFIG_OUTPUT: /* for DT backwards compatibility */
932 case PIN_CONFIG_OUTPUT_ENABLE:
933 pinmux_flags |= MUX_FLAGS_SWIO_OUTPUT;
941 /* Collect pin positions and their mux settings. */
942 for (i = 0; i < npins; ++i) {
944 struct rza1_mux_conf *mux_conf = &mux_confs[i];
946 ret = of_property_read_u32_index(np, prop_name, i, &of_pinconf);
950 mux_conf->id = of_pinconf & MUX_PIN_ID_MASK;
951 mux_conf->port = RZA1_PIN_ID_TO_PORT(mux_conf->id);
952 mux_conf->pin = RZA1_PIN_ID_TO_PIN(mux_conf->id);
953 mux_conf->mux_func = MUX_FUNC(of_pinconf);
954 mux_conf->mux_flags = pinmux_flags;
956 if (mux_conf->port >= RZA1_NPORTS ||
957 mux_conf->pin >= RZA1_PINS_PER_PORT) {
958 dev_err(rza1_pctl->dev,
959 "Wrong port %u pin %u for %s property\n",
960 mux_conf->port, mux_conf->pin, prop_name);
964 grpins[i] = mux_conf->id;
971 * rza1_dt_node_to_map() - map a pin mux node to a function/group
973 * Parse and register a pin mux function.
975 * @pctldev: pin controller device
976 * @np: device tree node to parse
977 * @map: pointer to pin map (output)
978 * @num_maps: number of collected maps (output)
980 static int rza1_dt_node_to_map(struct pinctrl_dev *pctldev,
981 struct device_node *np,
982 struct pinctrl_map **map,
983 unsigned int *num_maps)
985 struct rza1_pinctrl *rza1_pctl = pinctrl_dev_get_drvdata(pctldev);
986 struct rza1_mux_conf *mux_confs, *mux_conf;
987 unsigned int *grpins, *grpin;
988 struct device_node *child;
994 npins = rza1_dt_node_pin_count(np);
996 dev_err(rza1_pctl->dev, "invalid pinmux node structure\n");
1001 * Functions are made of 1 group only;
1002 * in fact, functions and groups are identical for this pin controller
1003 * except that functions carry an array of per-pin mux configuration
1006 mux_confs = devm_kcalloc(rza1_pctl->dev, npins, sizeof(*mux_confs),
1008 grpins = devm_kcalloc(rza1_pctl->dev, npins, sizeof(*grpins),
1010 fngrps = devm_kzalloc(rza1_pctl->dev, sizeof(*fngrps), GFP_KERNEL);
1012 if (!mux_confs || !grpins || !fngrps)
1016 * Parse the pinmux node.
1017 * If the node does not contain "pinmux" property (-ENOENT)
1018 * that property shall be specified in all its children sub-nodes.
1020 mux_conf = &mux_confs[0];
1023 ret = rza1_parse_pinmux_node(rza1_pctl, np, mux_conf, grpin);
1025 for_each_child_of_node(np, child) {
1026 ret = rza1_parse_pinmux_node(rza1_pctl, child, mux_conf,
1039 /* Register pin group and function name to pinctrl_generic */
1041 fngrps[0] = grpname;
1043 mutex_lock(&rza1_pctl->mutex);
1044 gsel = pinctrl_generic_add_group(pctldev, grpname, grpins, npins,
1047 mutex_unlock(&rza1_pctl->mutex);
1051 fsel = pinmux_generic_add_function(pctldev, grpname, fngrps, 1,
1058 dev_info(rza1_pctl->dev, "Parsed function and group %s with %d pins\n",
1061 /* Create map where to retrieve function and mux settings from */
1063 *map = kzalloc(sizeof(**map), GFP_KERNEL);
1066 goto remove_function;
1069 (*map)->type = PIN_MAP_TYPE_MUX_GROUP;
1070 (*map)->data.mux.group = np->name;
1071 (*map)->data.mux.function = np->name;
1073 mutex_unlock(&rza1_pctl->mutex);
1078 pinmux_generic_remove_function(pctldev, fsel);
1081 pinctrl_generic_remove_group(pctldev, gsel);
1082 mutex_unlock(&rza1_pctl->mutex);
1084 dev_info(rza1_pctl->dev, "Unable to parse function and group %s\n",
1090 static void rza1_dt_free_map(struct pinctrl_dev *pctldev,
1091 struct pinctrl_map *map, unsigned int num_maps)
1096 static const struct pinctrl_ops rza1_pinctrl_ops = {
1097 .get_groups_count = pinctrl_generic_get_group_count,
1098 .get_group_name = pinctrl_generic_get_group_name,
1099 .get_group_pins = pinctrl_generic_get_group_pins,
1100 .dt_node_to_map = rza1_dt_node_to_map,
1101 .dt_free_map = rza1_dt_free_map,
1104 /* ----------------------------------------------------------------------------
1109 * rza1_set_mux() - retrieve pins from a group and apply their mux settings
1111 * @pctldev: pin controller device
1112 * @selector: function selector
1113 * @group: group selector
1115 static int rza1_set_mux(struct pinctrl_dev *pctldev, unsigned int selector,
1118 struct rza1_pinctrl *rza1_pctl = pinctrl_dev_get_drvdata(pctldev);
1119 struct rza1_mux_conf *mux_confs;
1120 struct function_desc *func;
1121 struct group_desc *grp;
1124 grp = pinctrl_generic_get_group(pctldev, group);
1128 func = pinmux_generic_get_function(pctldev, selector);
1132 mux_confs = (struct rza1_mux_conf *)func->data;
1133 for (i = 0; i < grp->num_pins; ++i) {
1136 ret = rza1_pin_mux_single(rza1_pctl, &mux_confs[i]);
1144 static const struct pinmux_ops rza1_pinmux_ops = {
1145 .get_functions_count = pinmux_generic_get_function_count,
1146 .get_function_name = pinmux_generic_get_function_name,
1147 .get_function_groups = pinmux_generic_get_function_groups,
1148 .set_mux = rza1_set_mux,
1152 /* ----------------------------------------------------------------------------
1153 * RZ/A1 pin controller driver operations
1156 static unsigned int rza1_count_gpio_chips(struct device_node *np)
1158 struct device_node *child;
1159 unsigned int count = 0;
1161 for_each_child_of_node(np, child) {
1162 if (!of_property_read_bool(child, "gpio-controller"))
1172 * rza1_parse_gpiochip() - parse and register a gpio chip and pin range
1174 * The gpio controller subnode shall provide a "gpio-ranges" list property as
1175 * defined by gpio device tree binding documentation.
1177 * @rza1_pctl: RZ/A1 pin controller device
1178 * @np: of gpio-controller node
1179 * @chip: gpio chip to register to gpiolib
1180 * @range: pin range to register to pinctrl core
1182 static int rza1_parse_gpiochip(struct rza1_pinctrl *rza1_pctl,
1183 struct device_node *np,
1184 struct gpio_chip *chip,
1185 struct pinctrl_gpio_range *range)
1187 const char *list_name = "gpio-ranges";
1188 struct of_phandle_args of_args;
1189 unsigned int gpioport;
1193 ret = of_parse_phandle_with_fixed_args(np, list_name, 3, 0, &of_args);
1195 dev_err(rza1_pctl->dev, "Unable to parse %s list property\n",
1201 * Find out on which port this gpio-chip maps to by inspecting the
1202 * second argument of the "gpio-ranges" property.
1204 pinctrl_base = of_args.args[1];
1205 gpioport = RZA1_PIN_ID_TO_PORT(pinctrl_base);
1206 if (gpioport >= RZA1_NPORTS) {
1207 dev_err(rza1_pctl->dev,
1208 "Invalid values in property %s\n", list_name);
1212 *chip = rza1_gpiochip_template;
1214 chip->label = devm_kasprintf(rza1_pctl->dev, GFP_KERNEL, "%pOFn",
1219 chip->ngpio = of_args.args[2];
1221 chip->parent = rza1_pctl->dev;
1223 range->id = gpioport;
1224 range->name = chip->label;
1225 range->pin_base = range->base = pinctrl_base;
1226 range->npins = of_args.args[2];
1229 ret = devm_gpiochip_add_data(rza1_pctl->dev, chip,
1230 &rza1_pctl->ports[gpioport]);
1234 pinctrl_add_gpio_range(rza1_pctl->pctl, range);
1236 dev_dbg(rza1_pctl->dev, "Parsed gpiochip %s with %d pins\n",
1237 chip->label, chip->ngpio);
1243 * rza1_gpio_register() - parse DT to collect gpio-chips and gpio-ranges
1245 * @rza1_pctl: RZ/A1 pin controller device
1247 static int rza1_gpio_register(struct rza1_pinctrl *rza1_pctl)
1249 struct device_node *np = rza1_pctl->dev->of_node;
1250 struct pinctrl_gpio_range *gpio_ranges;
1251 struct gpio_chip *gpio_chips;
1252 struct device_node *child;
1253 unsigned int ngpiochips;
1257 ngpiochips = rza1_count_gpio_chips(np);
1258 if (ngpiochips == 0) {
1259 dev_dbg(rza1_pctl->dev, "No gpiochip registered\n");
1263 gpio_chips = devm_kcalloc(rza1_pctl->dev, ngpiochips,
1264 sizeof(*gpio_chips), GFP_KERNEL);
1265 gpio_ranges = devm_kcalloc(rza1_pctl->dev, ngpiochips,
1266 sizeof(*gpio_ranges), GFP_KERNEL);
1267 if (!gpio_chips || !gpio_ranges)
1271 for_each_child_of_node(np, child) {
1272 if (!of_property_read_bool(child, "gpio-controller"))
1275 ret = rza1_parse_gpiochip(rza1_pctl, child, &gpio_chips[i],
1285 dev_info(rza1_pctl->dev, "Registered %u gpio controllers\n", i);
1291 * rza1_pinctrl_register() - Enumerate pins, ports and gpiochips; register
1292 * them to pinctrl and gpio cores.
1294 * @rza1_pctl: RZ/A1 pin controller device
1296 static int rza1_pinctrl_register(struct rza1_pinctrl *rza1_pctl)
1298 struct pinctrl_pin_desc *pins;
1299 struct rza1_port *ports;
1303 pins = devm_kcalloc(rza1_pctl->dev, RZA1_NPINS, sizeof(*pins),
1305 ports = devm_kcalloc(rza1_pctl->dev, RZA1_NPORTS, sizeof(*ports),
1307 if (!pins || !ports)
1310 rza1_pctl->pins = pins;
1311 rza1_pctl->desc.pins = pins;
1312 rza1_pctl->desc.npins = RZA1_NPINS;
1313 rza1_pctl->ports = ports;
1315 for (i = 0; i < RZA1_NPINS; ++i) {
1316 unsigned int pin = RZA1_PIN_ID_TO_PIN(i);
1317 unsigned int port = RZA1_PIN_ID_TO_PORT(i);
1320 pins[i].name = devm_kasprintf(rza1_pctl->dev, GFP_KERNEL,
1321 "P%u-%u", port, pin);
1325 if (i % RZA1_PINS_PER_PORT == 0) {
1328 * they provide per-port lock and logical base address.
1330 unsigned int port_id = RZA1_PIN_ID_TO_PORT(i);
1332 ports[port_id].id = port_id;
1333 ports[port_id].base = rza1_pctl->base;
1334 ports[port_id].pins = &pins[i];
1335 spin_lock_init(&ports[port_id].lock);
1339 ret = devm_pinctrl_register_and_init(rza1_pctl->dev, &rza1_pctl->desc,
1340 rza1_pctl, &rza1_pctl->pctl);
1342 dev_err(rza1_pctl->dev,
1343 "RZ/A1 pin controller registration failed\n");
1347 ret = pinctrl_enable(rza1_pctl->pctl);
1349 dev_err(rza1_pctl->dev,
1350 "RZ/A1 pin controller failed to start\n");
1354 ret = rza1_gpio_register(rza1_pctl);
1356 dev_err(rza1_pctl->dev, "RZ/A1 GPIO registration failed\n");
1363 static int rza1_pinctrl_probe(struct platform_device *pdev)
1365 struct rza1_pinctrl *rza1_pctl;
1368 rza1_pctl = devm_kzalloc(&pdev->dev, sizeof(*rza1_pctl), GFP_KERNEL);
1372 rza1_pctl->dev = &pdev->dev;
1374 rza1_pctl->base = devm_platform_ioremap_resource(pdev, 0);
1375 if (IS_ERR(rza1_pctl->base))
1376 return PTR_ERR(rza1_pctl->base);
1378 mutex_init(&rza1_pctl->mutex);
1380 platform_set_drvdata(pdev, rza1_pctl);
1382 rza1_pctl->desc.name = DRIVER_NAME;
1383 rza1_pctl->desc.pctlops = &rza1_pinctrl_ops;
1384 rza1_pctl->desc.pmxops = &rza1_pinmux_ops;
1385 rza1_pctl->desc.owner = THIS_MODULE;
1386 rza1_pctl->data = of_device_get_match_data(&pdev->dev);
1388 ret = rza1_pinctrl_register(rza1_pctl);
1392 dev_info(&pdev->dev,
1393 "RZ/A1 pin controller and gpio successfully registered\n");
1398 static const struct of_device_id rza1_pinctrl_of_match[] = {
1400 /* RZ/A1H, RZ/A1M */
1401 .compatible = "renesas,r7s72100-ports",
1402 .data = &rza1h_pmx_conf,
1406 .compatible = "renesas,r7s72102-ports",
1407 .data = &rza1l_pmx_conf,
1412 static struct platform_driver rza1_pinctrl_driver = {
1414 .name = DRIVER_NAME,
1415 .of_match_table = rza1_pinctrl_of_match,
1417 .probe = rza1_pinctrl_probe,
1420 static int __init rza1_pinctrl_init(void)
1422 return platform_driver_register(&rza1_pinctrl_driver);
1424 core_initcall(rza1_pinctrl_init);
1426 MODULE_AUTHOR("Jacopo Mondi <jacopo+renesas@jmondi.org");
1427 MODULE_DESCRIPTION("Pin and gpio controller driver for Reneas RZ/A1 SoC");
1428 MODULE_LICENSE("GPL v2");