blob: df8e0ff0c5d50dc93c8bd68c4ffce5910e809f3a [file] [log] [blame]
Patrice Chotard0493e642013-01-08 10:41:02 +01001#ifndef PINCTRL_PINCTRL_ABx5O0_H
2#define PINCTRL_PINCTRL_ABx500_H
3
4/* Package definitions */
5#define PINCTRL_AB8500 0
6#define PINCTRL_AB8540 1
7#define PINCTRL_AB9540 2
8#define PINCTRL_AB8505 3
9
10/* pins alternate function */
11enum abx500_pin_func {
12 ABX500_DEFAULT,
13 ABX500_ALT_A,
14 ABX500_ALT_B,
15 ABX500_ALT_C,
16};
17
18/**
19 * struct abx500_function - ABx500 pinctrl mux function
20 * @name: The name of the function, exported to pinctrl core.
21 * @groups: An array of pin groups that may select this function.
22 * @ngroups: The number of entries in @groups.
23 */
24struct abx500_function {
25 const char *name;
26 const char * const *groups;
27 unsigned ngroups;
28};
29
30/**
31 * struct abx500_pingroup - describes a ABx500 pin group
32 * @name: the name of this specific pin group
33 * @pins: an array of discrete physical pins used in this group, taken
34 * from the driver-local pin enumeration space
35 * @num_pins: the number of pins in this group array, i.e. the number of
36 * elements in .pins so we can iterate over that array
37 * @altsetting: the altsetting to apply to all pins in this group to
38 * configure them to be used by a function
39 */
40struct abx500_pingroup {
41 const char *name;
42 const unsigned int *pins;
43 const unsigned npins;
44 int altsetting;
45};
46
47#define ALTERNATE_FUNCTIONS(pin, sel_bit, alt1, alt2, alta, altb, altc) \
48{ \
49 .pin_number = pin, \
50 .gpiosel_bit = sel_bit, \
51 .alt_bit1 = alt1, \
52 .alt_bit2 = alt2, \
53 .alta_val = alta, \
54 .altb_val = altb, \
55 .altc_val = altc, \
56}
57
58#define UNUSED -1
59/**
60 * struct alternate_functions
61 * @pin_number: The pin number
62 * @gpiosel_bit: Control bit in GPIOSEL register,
63 * @alt_bit1: First AlternateFunction bit used to select the
64 * alternate function
65 * @alt_bit2: Second AlternateFunction bit used to select the
66 * alternate function
67 *
68 * these 3 following fields are necessary due to none
69 * coherency on how to select the altA, altB and altC
70 * function between the ABx500 SOC family when using
71 * alternatfunc register.
72 * @alta_val: value to write in alternatfunc to select altA function
73 * @altb_val: value to write in alternatfunc to select altB function
74 * @altc_val: value to write in alternatfunc to select altC function
75 */
76struct alternate_functions {
77 unsigned pin_number;
78 s8 gpiosel_bit;
79 s8 alt_bit1;
80 s8 alt_bit2;
81 u8 alta_val;
82 u8 altb_val;
83 u8 altc_val;
84};
85
86/**
87 * struct pullud - specific pull up/down feature
88 * @first_pin: The pin number of the first pins which support
89 * specific pull up/down
90 * @last_pin: The pin number of the last pins
91 */
92struct pullud {
93 unsigned first_pin;
94 unsigned last_pin;
95};
96
97#define GPIO_IRQ_CLUSTER(a, b, c) \
98{ \
99 .start = a, \
100 .end = b, \
101 .offset = c, \
102}
103
104/**
105 * struct abx500_gpio_irq_cluster - indicates GPIOs which are interrupt
106 * capable
107 * @start: The pin number of the first pin interrupt capable
108 * @end: The pin number of the last pin interrupt capable
109 * @offset: offset used to compute specific setting strategy of
110 * the interrupt line
111 */
112
113struct abx500_gpio_irq_cluster {
114 int start;
115 int end;
116 int offset;
117};
118
119/**
120 * struct abx500_pinrange - map pin numbers to GPIO offsets
121 * @offset: offset into the GPIO local numberspace, incidentally
122 * identical to the offset into the local pin numberspace
123 * @npins: number of pins to map from both offsets
124 * @altfunc: altfunc setting to be used to enable GPIO on a pin in
125 * this range (may vary)
126 */
127struct abx500_pinrange {
128 unsigned int offset;
129 unsigned int npins;
130 int altfunc;
131};
132
133#define ABX500_PINRANGE(a, b, c) { .offset = a, .npins = b, .altfunc = c }
134
135/**
136 * struct abx500_pinctrl_soc_data - ABx500 pin controller per-SoC configuration
137 * @gpio_ranges: An array of GPIO ranges for this SoC
138 * @gpio_num_ranges: The number of GPIO ranges for this SoC
139 * @pins: An array describing all pins the pin controller affects.
140 * All pins which are also GPIOs must be listed first within the
141 * array, and be numbered identically to the GPIO controller's
142 * numbering.
143 * @npins: The number of entries in @pins.
144 * @functions: The functions supported on this SoC.
145 * @nfunction: The number of entries in @functions.
146 * @groups: An array describing all pin groups the pin SoC supports.
147 * @ngroups: The number of entries in @groups.
148 * @alternate_functions: array describing pins which supports alternate and
149 * how to set it.
150 * @pullud: array describing pins which supports pull up/down
151 * specific registers.
152 * @gpio_irq_cluster: An array of GPIO interrupt capable for this SoC
153 * @ngpio_irq_cluster: The number of GPIO inetrrupt capable for this SoC
154 * @irq_gpio_rising_offset: Interrupt offset used as base to compute specific
155 * setting strategy of the rising interrupt line
156 * @irq_gpio_falling_offset: Interrupt offset used as base to compute specific
157 * setting strategy of the falling interrupt line
158 * @irq_gpio_factor: Factor used to compute specific setting strategy of
159 * the interrupt line
160 */
161
162struct abx500_pinctrl_soc_data {
163 const struct abx500_pinrange *gpio_ranges;
164 unsigned gpio_num_ranges;
165 const struct pinctrl_pin_desc *pins;
166 unsigned npins;
167 const struct abx500_function *functions;
168 unsigned nfunctions;
169 const struct abx500_pingroup *groups;
170 unsigned ngroups;
171 struct alternate_functions *alternate_functions;
172 struct pullud *pullud;
173 struct abx500_gpio_irq_cluster *gpio_irq_cluster;
174 unsigned ngpio_irq_cluster;
175 int irq_gpio_rising_offset;
176 int irq_gpio_falling_offset;
177 int irq_gpio_factor;
178};
179
Patrice Chotard3c937992013-01-08 10:59:53 +0100180#ifdef CONFIG_PINCTRL_AB8500
181
182void abx500_pinctrl_ab8500_init(struct abx500_pinctrl_soc_data **soc);
183
184#else
185
186static inline void
187abx500_pinctrl_ab8500_init(struct abx500_pinctrl_soc_data **soc)
188{
189}
190
191#endif
192
Patrice Chotarda8f96e42013-01-28 14:35:19 +0100193#ifdef CONFIG_PINCTRL_AB8540
194
195void abx500_pinctrl_ab8540_init(struct abx500_pinctrl_soc_data **soc);
196
197#else
198
199static inline void
200abx500_pinctrl_ab8540_init(struct abx500_pinctrl_soc_data **soc)
201{
202}
203
204#endif
205
Patrice Chotard09dbec32013-01-28 14:29:35 +0100206#ifdef CONFIG_PINCTRL_AB9540
207
208void abx500_pinctrl_ab9540_init(struct abx500_pinctrl_soc_data **soc);
209
210#else
211
212static inline void
213abx500_pinctrl_ab9540_init(struct abx500_pinctrl_soc_data **soc)
214{
215}
216
217#endif
218
Patrice Chotard1aa2d8d2013-01-28 14:23:45 +0100219#ifdef CONFIG_PINCTRL_AB8505
220
221void abx500_pinctrl_ab8505_init(struct abx500_pinctrl_soc_data **soc);
222
223#else
224
225static inline void
226abx500_pinctrl_ab8505_init(struct abx500_pinctrl_soc_data **soc)
227{
228}
229
230#endif
231
Patrice Chotard0493e642013-01-08 10:41:02 +0100232#endif /* PINCTRL_PINCTRL_ABx500_H */