3b306c0457bae0d3ae5ad41de25c5ba6bf5968d3
[platform/kernel/u-boot.git] / drivers / pinctrl / renesas / sh_pfc.h
1 /*
2  * SuperH Pin Function Controller Support
3  *
4  * Copyright (c) 2008 Magnus Damm
5  *
6  * This file is subject to the terms and conditions of the GNU General Public
7  * License.  See the file "COPYING" in the main directory of this archive
8  * for more details.
9  */
10
11 #ifndef __SH_PFC_H
12 #define __SH_PFC_H
13
14 #include <linux/stringify.h>
15
16 enum {
17         PINMUX_TYPE_NONE,
18         PINMUX_TYPE_FUNCTION,
19         PINMUX_TYPE_GPIO,
20         PINMUX_TYPE_OUTPUT,
21         PINMUX_TYPE_INPUT,
22 };
23
24 #define SH_PFC_PIN_CFG_INPUT            (1 << 0)
25 #define SH_PFC_PIN_CFG_OUTPUT           (1 << 1)
26 #define SH_PFC_PIN_CFG_PULL_UP          (1 << 2)
27 #define SH_PFC_PIN_CFG_PULL_DOWN        (1 << 3)
28 #define SH_PFC_PIN_CFG_IO_VOLTAGE       (1 << 4)
29 #define SH_PFC_PIN_CFG_DRIVE_STRENGTH   (1 << 5)
30 #define SH_PFC_PIN_CFG_NO_GPIO          (1 << 31)
31
32 struct sh_pfc_pin {
33         u16 pin;
34         u16 enum_id;
35         const char *name;
36         unsigned int configs;
37 };
38
39 #define SH_PFC_PIN_GROUP(n)                             \
40         {                                               \
41                 .name = #n,                             \
42                 .pins = n##_pins,                       \
43                 .mux = n##_mux,                         \
44                 .nr_pins = ARRAY_SIZE(n##_pins),        \
45         }
46
47 struct sh_pfc_pin_group {
48         const char *name;
49         const unsigned int *pins;
50         const unsigned int *mux;
51         unsigned int nr_pins;
52 };
53
54 /*
55  * Using union vin_data saves memory occupied by the VIN data pins.
56  * VIN_DATA_PIN_GROUP() is  a macro  used  to describe the VIN pin groups
57  * in this case.
58  */
59 #define VIN_DATA_PIN_GROUP(n, s)                                \
60         {                                                       \
61                 .name = #n#s,                                   \
62                 .pins = n##_pins.data##s,                       \
63                 .mux = n##_mux.data##s,                         \
64                 .nr_pins = ARRAY_SIZE(n##_pins.data##s),        \
65         }
66
67 union vin_data {
68         unsigned int data24[24];
69         unsigned int data20[20];
70         unsigned int data16[16];
71         unsigned int data12[12];
72         unsigned int data10[10];
73         unsigned int data8[8];
74         unsigned int data4[4];
75 };
76
77 #define SH_PFC_FUNCTION(n)                              \
78         {                                               \
79                 .name = #n,                             \
80                 .groups = n##_groups,                   \
81                 .nr_groups = ARRAY_SIZE(n##_groups),    \
82         }
83
84 struct sh_pfc_function {
85         const char *name;
86         const char * const *groups;
87         unsigned int nr_groups;
88 };
89
90 struct pinmux_func {
91         u16 enum_id;
92         const char *name;
93 };
94
95 struct pinmux_cfg_reg {
96         u32 reg;
97         u8 reg_width, field_width;
98         const u16 *enum_ids;
99         const u8 *var_field_width;
100 };
101
102 /*
103  * Describe a config register consisting of several fields of the same width
104  *   - name: Register name (unused, for documentation purposes only)
105  *   - r: Physical register address
106  *   - r_width: Width of the register (in bits)
107  *   - f_width: Width of the fixed-width register fields (in bits)
108  * This macro must be followed by initialization data: For each register field
109  * (from left to right, i.e. MSB to LSB), 2^f_width enum IDs must be specified,
110  * one for each possible combination of the register field bit values.
111  */
112 #define PINMUX_CFG_REG(name, r, r_width, f_width) \
113         .reg = r, .reg_width = r_width, .field_width = f_width,         \
114         .enum_ids = (const u16 [(r_width / f_width) * (1 << f_width)])
115
116 /*
117  * Describe a config register consisting of several fields of different widths
118  *   - name: Register name (unused, for documentation purposes only)
119  *   - r: Physical register address
120  *   - r_width: Width of the register (in bits)
121  *   - var_fw0, var_fwn...: List of widths of the register fields (in bits),
122  *                          From left to right (i.e. MSB to LSB)
123  * This macro must be followed by initialization data: For each register field
124  * (from left to right, i.e. MSB to LSB), 2^var_fwi enum IDs must be specified,
125  * one for each possible combination of the register field bit values.
126  */
127 #define PINMUX_CFG_REG_VAR(name, r, r_width, var_fw0, var_fwn...) \
128         .reg = r, .reg_width = r_width, \
129         .var_field_width = (const u8 [r_width]) \
130                 { var_fw0, var_fwn, 0 }, \
131         .enum_ids = (const u16 [])
132
133 struct pinmux_drive_reg_field {
134         u16 pin;
135         u8 offset;
136         u8 size;
137 };
138
139 struct pinmux_drive_reg {
140         u32 reg;
141         const struct pinmux_drive_reg_field fields[8];
142 };
143
144 #define PINMUX_DRIVE_REG(name, r) \
145         .reg = r, \
146         .fields =
147
148 struct pinmux_data_reg {
149         u32 reg;
150         u8 reg_width;
151         const u16 *enum_ids;
152 };
153
154 /*
155  * Describe a data register
156  *   - name: Register name (unused, for documentation purposes only)
157  *   - r: Physical register address
158  *   - r_width: Width of the register (in bits)
159  * This macro must be followed by initialization data: For each register bit
160  * (from left to right, i.e. MSB to LSB), one enum ID must be specified.
161  */
162 #define PINMUX_DATA_REG(name, r, r_width) \
163         .reg = r, .reg_width = r_width, \
164         .enum_ids = (const u16 [r_width]) \
165
166 struct pinmux_irq {
167         const short *gpios;
168 };
169
170 /*
171  * Describe the mapping from GPIOs to a single IRQ
172  *   - ids...: List of GPIOs that are mapped to the same IRQ
173  */
174 #define PINMUX_IRQ(ids...)                         \
175         { .gpios = (const short []) { ids, -1 } }
176
177 struct pinmux_range {
178         u16 begin;
179         u16 end;
180         u16 force;
181 };
182
183 struct sh_pfc_bias_info {
184         u16 pin;
185         u16 reg : 11;
186         u16 bit : 5;
187 };
188
189 struct sh_pfc_pin_range;
190
191 struct sh_pfc {
192         struct device *dev;
193         const struct sh_pfc_soc_info *info;
194
195         void *regs;
196
197         struct sh_pfc_pin_range *ranges;
198         unsigned int nr_ranges;
199
200         unsigned int nr_gpio_pins;
201
202         struct sh_pfc_chip *gpio;
203 };
204
205 struct sh_pfc_soc_operations {
206         int (*init)(struct sh_pfc *pfc);
207         unsigned int (*get_bias)(struct sh_pfc *pfc, unsigned int pin);
208         void (*set_bias)(struct sh_pfc *pfc, unsigned int pin,
209                          unsigned int bias);
210         int (*pin_to_pocctrl)(struct sh_pfc *pfc, unsigned int pin, u32 *pocctrl);
211 };
212
213 struct sh_pfc_soc_info {
214         const char *name;
215         const struct sh_pfc_soc_operations *ops;
216
217         struct pinmux_range input;
218         struct pinmux_range output;
219         struct pinmux_range function;
220
221         const struct sh_pfc_pin *pins;
222         unsigned int nr_pins;
223         const struct sh_pfc_pin_group *groups;
224         unsigned int nr_groups;
225         const struct sh_pfc_function *functions;
226         unsigned int nr_functions;
227
228         const struct pinmux_cfg_reg *cfg_regs;
229         const struct pinmux_drive_reg *drive_regs;
230         const struct pinmux_data_reg *data_regs;
231
232         const u16 *pinmux_data;
233         unsigned int pinmux_data_size;
234
235         const struct pinmux_irq *gpio_irq;
236         unsigned int gpio_irq_size;
237
238         u32 unlock_reg;
239 };
240
241 u32 sh_pfc_read_reg(struct sh_pfc *pfc, u32 reg, unsigned int width);
242 void sh_pfc_write_reg(struct sh_pfc *pfc, u32 reg, unsigned int width, u32 data);
243 const struct sh_pfc_bias_info *
244 sh_pfc_pin_to_bias_info(const struct sh_pfc_bias_info *info,
245                         unsigned int num, unsigned int pin);
246 int sh_pfc_config_mux_for_gpio(struct udevice *dev, unsigned pin_selector);
247
248 extern const struct sh_pfc_soc_info r8a7795_pinmux_info;
249 extern const struct sh_pfc_soc_info r8a7796_pinmux_info;
250 extern const struct sh_pfc_soc_info r8a77970_pinmux_info;
251 extern const struct sh_pfc_soc_info r8a77995_pinmux_info;
252 /* -----------------------------------------------------------------------------
253  * Helper macros to create pin and port lists
254  */
255
256 /*
257  * sh_pfc_soc_info pinmux_data array macros
258  */
259
260 /*
261  * Describe generic pinmux data
262  *   - data_or_mark: *_DATA or *_MARK enum ID
263  *   - ids...: List of enum IDs to associate with data_or_mark
264  */
265 #define PINMUX_DATA(data_or_mark, ids...)       data_or_mark, ids, 0
266
267 /*
268  * Describe a pinmux configuration without GPIO function that needs
269  * configuration in a Peripheral Function Select Register (IPSR)
270  *   - ipsr: IPSR field (unused, for documentation purposes only)
271  *   - fn: Function name, referring to a field in the IPSR
272  */
273 #define PINMUX_IPSR_NOGP(ipsr, fn)                                      \
274         PINMUX_DATA(fn##_MARK, FN_##fn)
275
276 /*
277  * Describe a pinmux configuration with GPIO function that needs configuration
278  * in both a Peripheral Function Select Register (IPSR) and in a
279  * GPIO/Peripheral Function Select Register (GPSR)
280  *   - ipsr: IPSR field
281  *   - fn: Function name, also referring to the IPSR field
282  */
283 #define PINMUX_IPSR_GPSR(ipsr, fn)                                      \
284         PINMUX_DATA(fn##_MARK, FN_##fn, FN_##ipsr)
285
286 /*
287  * Describe a pinmux configuration without GPIO function that needs
288  * configuration in a Peripheral Function Select Register (IPSR), and where the
289  * pinmux function has a representation in a Module Select Register (MOD_SEL).
290  *   - ipsr: IPSR field (unused, for documentation purposes only)
291  *   - fn: Function name, also referring to the IPSR field
292  *   - msel: Module selector
293  */
294 #define PINMUX_IPSR_NOGM(ipsr, fn, msel)                                \
295         PINMUX_DATA(fn##_MARK, FN_##fn, FN_##msel)
296
297 /*
298  * Describe a pinmux configuration with GPIO function where the pinmux function
299  * has no representation in a Peripheral Function Select Register (IPSR), but
300  * instead solely depends on a group selection.
301  *   - gpsr: GPSR field
302  *   - fn: Function name, also referring to the GPSR field
303  *   - gsel: Group selector
304  */
305 #define PINMUX_IPSR_NOFN(gpsr, fn, gsel)                                \
306         PINMUX_DATA(fn##_MARK, FN_##gpsr, FN_##gsel)
307
308 /*
309  * Describe a pinmux configuration with GPIO function that needs configuration
310  * in both a Peripheral Function Select Register (IPSR) and a GPIO/Peripheral
311  * Function Select Register (GPSR), and where the pinmux function has a
312  * representation in a Module Select Register (MOD_SEL).
313  *   - ipsr: IPSR field
314  *   - fn: Function name, also referring to the IPSR field
315  *   - msel: Module selector
316  */
317 #define PINMUX_IPSR_MSEL(ipsr, fn, msel)                                \
318         PINMUX_DATA(fn##_MARK, FN_##msel, FN_##fn, FN_##ipsr)
319
320 /*
321  * Describe a pinmux configuration for a single-function pin with GPIO
322  * capability.
323  *   - fn: Function name
324  */
325 #define PINMUX_SINGLE(fn)                                               \
326         PINMUX_DATA(fn##_MARK, FN_##fn)
327
328 /*
329  * GP port style (32 ports banks)
330  */
331
332 #define PORT_GP_CFG_1(bank, pin, fn, sfx, cfg)                          \
333         fn(bank, pin, GP_##bank##_##pin, sfx, cfg)
334 #define PORT_GP_1(bank, pin, fn, sfx)   PORT_GP_CFG_1(bank, pin, fn, sfx, 0)
335
336 #define PORT_GP_CFG_4(bank, fn, sfx, cfg)                               \
337         PORT_GP_CFG_1(bank, 0,  fn, sfx, cfg),                          \
338         PORT_GP_CFG_1(bank, 1,  fn, sfx, cfg),                          \
339         PORT_GP_CFG_1(bank, 2,  fn, sfx, cfg),                          \
340         PORT_GP_CFG_1(bank, 3,  fn, sfx, cfg)
341 #define PORT_GP_4(bank, fn, sfx)        PORT_GP_CFG_4(bank, fn, sfx, 0)
342
343 #define PORT_GP_CFG_6(bank, fn, sfx, cfg)                               \
344         PORT_GP_CFG_4(bank, fn, sfx, cfg),                              \
345         PORT_GP_CFG_1(bank, 4,  fn, sfx, cfg), PORT_GP_CFG_1(bank, 5,  fn, sfx, cfg)
346 #define PORT_GP_6(bank, fn, sfx)        PORT_GP_CFG_6(bank, fn, sfx, 0)
347
348 #define PORT_GP_CFG_8(bank, fn, sfx, cfg)                               \
349         PORT_GP_CFG_4(bank, fn, sfx, cfg),                              \
350         PORT_GP_CFG_1(bank, 4,  fn, sfx, cfg),                          \
351         PORT_GP_CFG_1(bank, 5,  fn, sfx, cfg),                          \
352         PORT_GP_CFG_1(bank, 6,  fn, sfx, cfg),                          \
353         PORT_GP_CFG_1(bank, 7,  fn, sfx, cfg)
354 #define PORT_GP_8(bank, fn, sfx)        PORT_GP_CFG_8(bank, fn, sfx, 0)
355
356 #define PORT_GP_CFG_9(bank, fn, sfx, cfg)                               \
357         PORT_GP_CFG_8(bank, fn, sfx, cfg),                              \
358         PORT_GP_CFG_1(bank, 8,  fn, sfx, cfg)
359 #define PORT_GP_9(bank, fn, sfx)        PORT_GP_CFG_9(bank, fn, sfx, 0)
360
361 #define PORT_GP_CFG_10(bank, fn, sfx, cfg)                              \
362         PORT_GP_CFG_9(bank, fn, sfx, cfg),                              \
363         PORT_GP_CFG_1(bank, 9,  fn, sfx, cfg)
364 #define PORT_GP_10(bank, fn, sfx)       PORT_GP_CFG_10(bank, fn, sfx, 0)
365
366 #define PORT_GP_CFG_12(bank, fn, sfx, cfg)                              \
367         PORT_GP_CFG_10(bank, fn, sfx, cfg),                             \
368         PORT_GP_CFG_1(bank, 10, fn, sfx, cfg),                          \
369         PORT_GP_CFG_1(bank, 11, fn, sfx, cfg)
370 #define PORT_GP_12(bank, fn, sfx)       PORT_GP_CFG_12(bank, fn, sfx, 0)
371
372 #define PORT_GP_CFG_14(bank, fn, sfx, cfg)                              \
373         PORT_GP_CFG_12(bank, fn, sfx, cfg),                             \
374         PORT_GP_CFG_1(bank, 12, fn, sfx, cfg),                          \
375         PORT_GP_CFG_1(bank, 13, fn, sfx, cfg)
376 #define PORT_GP_14(bank, fn, sfx)       PORT_GP_CFG_14(bank, fn, sfx, 0)
377
378 #define PORT_GP_CFG_15(bank, fn, sfx, cfg)                              \
379         PORT_GP_CFG_14(bank, fn, sfx, cfg),                             \
380         PORT_GP_CFG_1(bank, 14, fn, sfx, cfg)
381 #define PORT_GP_15(bank, fn, sfx)       PORT_GP_CFG_15(bank, fn, sfx, 0)
382
383 #define PORT_GP_CFG_16(bank, fn, sfx, cfg)                              \
384         PORT_GP_CFG_15(bank, fn, sfx, cfg),                             \
385         PORT_GP_CFG_1(bank, 15, fn, sfx, cfg)
386 #define PORT_GP_16(bank, fn, sfx)       PORT_GP_CFG_16(bank, fn, sfx, 0)
387
388 #define PORT_GP_CFG_17(bank, fn, sfx, cfg)                              \
389         PORT_GP_CFG_16(bank, fn, sfx, cfg),                             \
390         PORT_GP_CFG_1(bank, 16, fn, sfx, cfg)
391 #define PORT_GP_17(bank, fn, sfx)       PORT_GP_CFG_17(bank, fn, sfx, 0)
392
393 #define PORT_GP_CFG_18(bank, fn, sfx, cfg)                              \
394         PORT_GP_CFG_17(bank, fn, sfx, cfg),                             \
395         PORT_GP_CFG_1(bank, 17, fn, sfx, cfg)
396 #define PORT_GP_18(bank, fn, sfx)       PORT_GP_CFG_18(bank, fn, sfx, 0)
397
398 #define PORT_GP_CFG_20(bank, fn, sfx, cfg)                              \
399         PORT_GP_CFG_18(bank, fn, sfx, cfg),                             \
400         PORT_GP_CFG_1(bank, 18, fn, sfx, cfg),                          \
401         PORT_GP_CFG_1(bank, 19, fn, sfx, cfg)
402 #define PORT_GP_20(bank, fn, sfx)       PORT_GP_CFG_20(bank, fn, sfx, 0)
403
404 #define PORT_GP_CFG_21(bank, fn, sfx, cfg)                              \
405         PORT_GP_CFG_20(bank, fn, sfx, cfg),                             \
406         PORT_GP_CFG_1(bank, 20, fn, sfx, cfg)
407 #define PORT_GP_21(bank, fn, sfx)       PORT_GP_CFG_21(bank, fn, sfx, 0)
408
409 #define PORT_GP_CFG_22(bank, fn, sfx, cfg)                              \
410         PORT_GP_CFG_18(bank, fn, sfx, cfg),                             \
411         PORT_GP_CFG_1(bank, 18, fn, sfx, cfg), PORT_GP_CFG_1(bank, 19, fn, sfx, cfg),   \
412         PORT_GP_CFG_1(bank, 20, fn, sfx, cfg), PORT_GP_CFG_1(bank, 21, fn, sfx, cfg)
413 #define PORT_GP_22(bank, fn, sfx)       PORT_GP_CFG_22(bank, fn, sfx, 0)
414
415 #define PORT_GP_CFG_23(bank, fn, sfx, cfg)                              \
416         PORT_GP_CFG_21(bank, fn, sfx, cfg),                             \
417         PORT_GP_CFG_1(bank, 21, fn, sfx, cfg),                          \
418         PORT_GP_CFG_1(bank, 22, fn, sfx, cfg)
419 #define PORT_GP_23(bank, fn, sfx)       PORT_GP_CFG_23(bank, fn, sfx, 0)
420
421 #define PORT_GP_CFG_24(bank, fn, sfx, cfg)                              \
422         PORT_GP_CFG_23(bank, fn, sfx, cfg),                             \
423         PORT_GP_CFG_1(bank, 23, fn, sfx, cfg)
424 #define PORT_GP_24(bank, fn, sfx)       PORT_GP_CFG_24(bank, fn, sfx, 0)
425
426 #define PORT_GP_CFG_26(bank, fn, sfx, cfg)                              \
427         PORT_GP_CFG_24(bank, fn, sfx, cfg),                             \
428         PORT_GP_CFG_1(bank, 24, fn, sfx, cfg),                          \
429         PORT_GP_CFG_1(bank, 25, fn, sfx, cfg)
430 #define PORT_GP_26(bank, fn, sfx)       PORT_GP_CFG_26(bank, fn, sfx, 0)
431
432 #define PORT_GP_CFG_28(bank, fn, sfx, cfg)                              \
433         PORT_GP_CFG_26(bank, fn, sfx, cfg),                             \
434         PORT_GP_CFG_1(bank, 26, fn, sfx, cfg),                          \
435         PORT_GP_CFG_1(bank, 27, fn, sfx, cfg)
436 #define PORT_GP_28(bank, fn, sfx)       PORT_GP_CFG_28(bank, fn, sfx, 0)
437
438 #define PORT_GP_CFG_29(bank, fn, sfx, cfg)                              \
439         PORT_GP_CFG_28(bank, fn, sfx, cfg),                             \
440         PORT_GP_CFG_1(bank, 28, fn, sfx, cfg)
441 #define PORT_GP_29(bank, fn, sfx)       PORT_GP_CFG_29(bank, fn, sfx, 0)
442
443 #define PORT_GP_CFG_30(bank, fn, sfx, cfg)                              \
444         PORT_GP_CFG_29(bank, fn, sfx, cfg),                             \
445         PORT_GP_CFG_1(bank, 29, fn, sfx, cfg)
446 #define PORT_GP_30(bank, fn, sfx)       PORT_GP_CFG_30(bank, fn, sfx, 0)
447
448 #define PORT_GP_CFG_32(bank, fn, sfx, cfg)                              \
449         PORT_GP_CFG_30(bank, fn, sfx, cfg),                             \
450         PORT_GP_CFG_1(bank, 30, fn, sfx, cfg),                          \
451         PORT_GP_CFG_1(bank, 31, fn, sfx, cfg)
452 #define PORT_GP_32(bank, fn, sfx)       PORT_GP_CFG_32(bank, fn, sfx, 0)
453
454 #define PORT_GP_32_REV(bank, fn, sfx)                                   \
455         PORT_GP_1(bank, 31, fn, sfx), PORT_GP_1(bank, 30, fn, sfx),     \
456         PORT_GP_1(bank, 29, fn, sfx), PORT_GP_1(bank, 28, fn, sfx),     \
457         PORT_GP_1(bank, 27, fn, sfx), PORT_GP_1(bank, 26, fn, sfx),     \
458         PORT_GP_1(bank, 25, fn, sfx), PORT_GP_1(bank, 24, fn, sfx),     \
459         PORT_GP_1(bank, 23, fn, sfx), PORT_GP_1(bank, 22, fn, sfx),     \
460         PORT_GP_1(bank, 21, fn, sfx), PORT_GP_1(bank, 20, fn, sfx),     \
461         PORT_GP_1(bank, 19, fn, sfx), PORT_GP_1(bank, 18, fn, sfx),     \
462         PORT_GP_1(bank, 17, fn, sfx), PORT_GP_1(bank, 16, fn, sfx),     \
463         PORT_GP_1(bank, 15, fn, sfx), PORT_GP_1(bank, 14, fn, sfx),     \
464         PORT_GP_1(bank, 13, fn, sfx), PORT_GP_1(bank, 12, fn, sfx),     \
465         PORT_GP_1(bank, 11, fn, sfx), PORT_GP_1(bank, 10, fn, sfx),     \
466         PORT_GP_1(bank, 9,  fn, sfx), PORT_GP_1(bank, 8,  fn, sfx),     \
467         PORT_GP_1(bank, 7,  fn, sfx), PORT_GP_1(bank, 6,  fn, sfx),     \
468         PORT_GP_1(bank, 5,  fn, sfx), PORT_GP_1(bank, 4,  fn, sfx),     \
469         PORT_GP_1(bank, 3,  fn, sfx), PORT_GP_1(bank, 2,  fn, sfx),     \
470         PORT_GP_1(bank, 1,  fn, sfx), PORT_GP_1(bank, 0,  fn, sfx)
471
472 /* GP_ALL(suffix) - Expand to a list of GP_#_#_suffix */
473 #define _GP_ALL(bank, pin, name, sfx, cfg)      name##_##sfx
474 #define GP_ALL(str)                     CPU_ALL_PORT(_GP_ALL, str)
475
476 /* PINMUX_GPIO_GP_ALL - Expand to a list of sh_pfc_pin entries */
477 #define _GP_GPIO(bank, _pin, _name, sfx, cfg)                           \
478         {                                                               \
479                 .pin = (bank * 32) + _pin,                              \
480                 .name = __stringify(_name),                             \
481                 .enum_id = _name##_DATA,                                \
482                 .configs = cfg,                                         \
483         }
484 #define PINMUX_GPIO_GP_ALL()            CPU_ALL_PORT(_GP_GPIO, unused)
485
486 /* PINMUX_DATA_GP_ALL -  Expand to a list of name_DATA, name_FN marks */
487 #define _GP_DATA(bank, pin, name, sfx, cfg)     PINMUX_DATA(name##_DATA, name##_FN)
488 #define PINMUX_DATA_GP_ALL()            CPU_ALL_PORT(_GP_DATA, unused)
489
490 /*
491  * PORT style (linear pin space)
492  */
493
494 #define PORT_1(pn, fn, pfx, sfx) fn(pn, pfx, sfx)
495
496 #define PORT_10(pn, fn, pfx, sfx)                                         \
497         PORT_1(pn,   fn, pfx##0, sfx), PORT_1(pn+1, fn, pfx##1, sfx),     \
498         PORT_1(pn+2, fn, pfx##2, sfx), PORT_1(pn+3, fn, pfx##3, sfx),     \
499         PORT_1(pn+4, fn, pfx##4, sfx), PORT_1(pn+5, fn, pfx##5, sfx),     \
500         PORT_1(pn+6, fn, pfx##6, sfx), PORT_1(pn+7, fn, pfx##7, sfx),     \
501         PORT_1(pn+8, fn, pfx##8, sfx), PORT_1(pn+9, fn, pfx##9, sfx)
502
503 #define PORT_90(pn, fn, pfx, sfx)                                         \
504         PORT_10(pn+10, fn, pfx##1, sfx), PORT_10(pn+20, fn, pfx##2, sfx), \
505         PORT_10(pn+30, fn, pfx##3, sfx), PORT_10(pn+40, fn, pfx##4, sfx), \
506         PORT_10(pn+50, fn, pfx##5, sfx), PORT_10(pn+60, fn, pfx##6, sfx), \
507         PORT_10(pn+70, fn, pfx##7, sfx), PORT_10(pn+80, fn, pfx##8, sfx), \
508         PORT_10(pn+90, fn, pfx##9, sfx)
509
510 /* PORT_ALL(suffix) - Expand to a list of PORT_#_suffix */
511 #define _PORT_ALL(pn, pfx, sfx)         pfx##_##sfx
512 #define PORT_ALL(str)                   CPU_ALL_PORT(_PORT_ALL, PORT, str)
513
514 /* PINMUX_GPIO - Expand to a sh_pfc_pin entry */
515 #define PINMUX_GPIO(_pin)                                               \
516         [GPIO_##_pin] = {                                               \
517                 .pin = (u16)-1,                                         \
518                 .name = __stringify(GPIO_##_pin),                       \
519                 .enum_id = _pin##_DATA,                                 \
520         }
521
522 /* SH_PFC_PIN_CFG - Expand to a sh_pfc_pin entry (named PORT#) with config */
523 #define SH_PFC_PIN_CFG(_pin, cfgs)                                      \
524         {                                                               \
525                 .pin = _pin,                                            \
526                 .name = __stringify(PORT##_pin),                        \
527                 .enum_id = PORT##_pin##_DATA,                           \
528                 .configs = cfgs,                                        \
529         }
530
531 /* SH_PFC_PIN_NAMED - Expand to a sh_pfc_pin entry with the given name */
532 #define SH_PFC_PIN_NAMED(row, col, _name)                               \
533         {                                                               \
534                 .pin = PIN_NUMBER(row, col),                            \
535                 .name = __stringify(PIN_##_name),                       \
536                 .configs = SH_PFC_PIN_CFG_NO_GPIO,                      \
537         }
538
539 /* SH_PFC_PIN_NAMED_CFG - Expand to a sh_pfc_pin entry with the given name */
540 #define SH_PFC_PIN_NAMED_CFG(row, col, _name, cfgs)                     \
541         {                                                               \
542                 .pin = PIN_NUMBER(row, col),                            \
543                 .name = __stringify(PIN_##_name),                       \
544                 .configs = SH_PFC_PIN_CFG_NO_GPIO | cfgs,               \
545         }
546
547 /* PINMUX_DATA_ALL - Expand to a list of PORT_name_DATA, PORT_name_FN0,
548  *                   PORT_name_OUT, PORT_name_IN marks
549  */
550 #define _PORT_DATA(pn, pfx, sfx)                                        \
551         PINMUX_DATA(PORT##pfx##_DATA, PORT##pfx##_FN0,                  \
552                     PORT##pfx##_OUT, PORT##pfx##_IN)
553 #define PINMUX_DATA_ALL()               CPU_ALL_PORT(_PORT_DATA, , unused)
554
555 /* GPIO_FN(name) - Expand to a sh_pfc_pin entry for a function GPIO */
556 #define PINMUX_GPIO_FN(gpio, base, data_or_mark)                        \
557         [gpio - (base)] = {                                             \
558                 .name = __stringify(gpio),                              \
559                 .enum_id = data_or_mark,                                \
560         }
561 #define GPIO_FN(str)                                                    \
562         PINMUX_GPIO_FN(GPIO_FN_##str, PINMUX_FN_BASE, str##_MARK)
563
564 /*
565  * PORTnCR helper macro for SH-Mobile/R-Mobile
566  */
567 #define PORTCR(nr, reg)                                                 \
568         {                                                               \
569                 PINMUX_CFG_REG_VAR("PORT" nr "CR", reg, 8, 2, 2, 1, 3) {\
570                         /* PULMD[1:0], handled by .set_bias() */        \
571                         0, 0, 0, 0,                                     \
572                         /* IE and OE */                                 \
573                         0, PORT##nr##_OUT, PORT##nr##_IN, 0,            \
574                         /* SEC, not supported */                        \
575                         0, 0,                                           \
576                         /* PTMD[2:0] */                                 \
577                         PORT##nr##_FN0, PORT##nr##_FN1,                 \
578                         PORT##nr##_FN2, PORT##nr##_FN3,                 \
579                         PORT##nr##_FN4, PORT##nr##_FN5,                 \
580                         PORT##nr##_FN6, PORT##nr##_FN7                  \
581                 }                                                       \
582         }
583
584 /*
585  * GPIO number helper macro for R-Car
586  */
587 #define RCAR_GP_PIN(bank, pin)          (((bank) * 32) + (pin))
588
589 #endif /* __SH_PFC_H */