1 /*
2  * Copyright (C) 2015 Masahiro Yamada <yamada.masahiro@socionext.com>
3  *
4  * SPDX-License-Identifier:	GPL-2.0+
5  */
6 
7 #ifndef __PINCTRL_UNIPHIER_H__
8 #define __PINCTRL_UNIPHIER_H__
9 
10 #include <linux/bitops.h>
11 #include <linux/bug.h>
12 #include <linux/kernel.h>
13 #include <linux/types.h>
14 
15 #define UNIPHIER_PINCTRL_PINMUX_BASE	0x1000
16 #define UNIPHIER_PINCTRL_LOAD_PINMUX	0x1700
17 #define UNIPHIER_PINCTRL_IECTRL		0x1d00
18 
19 #define UNIPHIER_PIN_ATTR_PACKED(iectrl)	(iectrl)
20 
21 static inline unsigned int uniphier_pin_get_iectrl(unsigned long data)
22 {
23 	return data;
24 }
25 
26 /**
27  * struct uniphier_pinctrl_pin - pin data for UniPhier SoC
28  *
29  * @number: pin number
30  * @data: additional per-pin data
31  */
32 struct uniphier_pinctrl_pin {
33 	unsigned number;
34 	unsigned long data;
35 };
36 
37 /**
38  * struct uniphier_pinctrl_group - pin group data for UniPhier SoC
39  *
40  * @name: pin group name
41  * @pins: array of pins that belong to the group
42  * @num_pins: number of pins in the group
43  * @muxvals: array of values to be set to pinmux registers
44  */
45 struct uniphier_pinctrl_group {
46 	const char *name;
47 	const unsigned *pins;
48 	unsigned num_pins;
49 	const int *muxvals;
50 };
51 
52 /**
53  * struct uniphier_pinctrl_socdata - SoC data for UniPhier pin controller
54  *
55  * @pins: array of pin data
56  * @pins_count: number of pin data
57  * @groups: array of pin group data
58  * @groups_count: number of pin group data
59  * @functions: array of pinmux function names
60  * @functions_count: number of pinmux functions
61  * @mux_bits: bit width of each pinmux register
62  * @reg_stride: stride of pinmux register address
63  * @caps: SoC-specific capability flag
64  */
65 struct uniphier_pinctrl_socdata {
66 	const struct uniphier_pinctrl_pin *pins;
67 	int pins_count;
68 	const struct uniphier_pinctrl_group *groups;
69 	int groups_count;
70 	const char * const *functions;
71 	int functions_count;
72 	unsigned caps;
73 #define UNIPHIER_PINCTRL_CAPS_PERPIN_IECTRL	BIT(1)
74 #define UNIPHIER_PINCTRL_CAPS_DBGMUX_SEPARATE	BIT(0)
75 };
76 
77 #define UNIPHIER_PINCTRL_PIN(a, b)					\
78 {									\
79 	.number = a,							\
80 	.data = UNIPHIER_PIN_ATTR_PACKED(b),				\
81 }
82 
83 #define __UNIPHIER_PINCTRL_GROUP(grp)					\
84 	{								\
85 		.name = #grp,						\
86 		.pins = grp##_pins,					\
87 		.num_pins = ARRAY_SIZE(grp##_pins),			\
88 		.muxvals = grp##_muxvals +				\
89 			BUILD_BUG_ON_ZERO(ARRAY_SIZE(grp##_pins) !=	\
90 					  ARRAY_SIZE(grp##_muxvals)),	\
91 	}
92 
93 #define __UNIPHIER_PINMUX_FUNCTION(func)	#func
94 
95 #ifdef CONFIG_SPL_BUILD
96 #define UNIPHIER_PINCTRL_GROUP(grp)		{ .name = NULL }
97 #define UNIPHIER_PINMUX_FUNCTION(func)		NULL
98 #else
99 #define UNIPHIER_PINCTRL_GROUP(grp)		__UNIPHIER_PINCTRL_GROUP(grp)
100 #define UNIPHIER_PINMUX_FUNCTION(func)		__UNIPHIER_PINMUX_FUNCTION(func)
101 #endif
102 
103 #define UNIPHIER_PINCTRL_GROUP_SPL(grp)		__UNIPHIER_PINCTRL_GROUP(grp)
104 #define UNIPHIER_PINMUX_FUNCTION_SPL(func)	__UNIPHIER_PINMUX_FUNCTION(func)
105 
106 /**
107  * struct uniphier_pinctrl_priv - private data for UniPhier pinctrl driver
108  *
109  * @base: base address of the pinctrl device
110  * @socdata: SoC specific data
111  */
112 struct uniphier_pinctrl_priv {
113 	void __iomem *base;
114 	struct uniphier_pinctrl_socdata *socdata;
115 };
116 
117 extern const struct pinctrl_ops uniphier_pinctrl_ops;
118 
119 int uniphier_pinctrl_probe(struct udevice *dev,
120 			   struct uniphier_pinctrl_socdata *socdata);
121 
122 int uniphier_pinctrl_remove(struct udevice *dev);
123 
124 #endif /* __PINCTRL_UNIPHIER_H__ */
125