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