]>
Commit | Line | Data |
---|---|---|
b3c185a7 PM |
1 | /* |
2 | * SuperH Pin Function Controller GPIO driver. | |
3 | * | |
4 | * Copyright (C) 2008 Magnus Damm | |
5 | * Copyright (C) 2009 - 2012 Paul Mundt | |
6 | * | |
7 | * This file is subject to the terms and conditions of the GNU General Public | |
8 | * License. See the file "COPYING" in the main directory of this archive | |
9 | * for more details. | |
10 | */ | |
c6193eac | 11 | |
1724acfd | 12 | #include <linux/device.h> |
b3c185a7 | 13 | #include <linux/gpio.h> |
90efde22 | 14 | #include <linux/init.h> |
b3c185a7 | 15 | #include <linux/module.h> |
ca5481c6 | 16 | #include <linux/pinctrl/consumer.h> |
90efde22 LP |
17 | #include <linux/slab.h> |
18 | #include <linux/spinlock.h> | |
b3c185a7 | 19 | |
f9165132 LP |
20 | #include "core.h" |
21 | ||
51cb226b LP |
22 | struct sh_pfc_gpio_data_reg { |
23 | const struct pinmux_data_reg *info; | |
fc88936a | 24 | u32 shadow; |
51cb226b LP |
25 | }; |
26 | ||
1a0039dc LP |
27 | struct sh_pfc_gpio_pin { |
28 | u8 dbit; | |
29 | u8 dreg; | |
30 | }; | |
31 | ||
b3c185a7 | 32 | struct sh_pfc_chip { |
1a0039dc LP |
33 | struct sh_pfc *pfc; |
34 | struct gpio_chip gpio_chip; | |
e51d5343 | 35 | |
1a0039dc | 36 | struct sh_pfc_window *mem; |
51cb226b | 37 | struct sh_pfc_gpio_data_reg *regs; |
1a0039dc | 38 | struct sh_pfc_gpio_pin *pins; |
b3c185a7 PM |
39 | }; |
40 | ||
41 | static struct sh_pfc_chip *gpio_to_pfc_chip(struct gpio_chip *gc) | |
42 | { | |
43 | return container_of(gc, struct sh_pfc_chip, gpio_chip); | |
44 | } | |
45 | ||
46 | static struct sh_pfc *gpio_to_pfc(struct gpio_chip *gc) | |
47 | { | |
48 | return gpio_to_pfc_chip(gc)->pfc; | |
49 | } | |
50 | ||
757b055a | 51 | static void gpio_get_data_reg(struct sh_pfc_chip *chip, unsigned int offset, |
51cb226b LP |
52 | struct sh_pfc_gpio_data_reg **reg, |
53 | unsigned int *bit) | |
41f1219f | 54 | { |
757b055a | 55 | int idx = sh_pfc_get_pin_index(chip->pfc, offset); |
1a0039dc | 56 | struct sh_pfc_gpio_pin *gpio_pin = &chip->pins[idx]; |
41f1219f | 57 | |
1a0039dc LP |
58 | *reg = &chip->regs[gpio_pin->dreg]; |
59 | *bit = gpio_pin->dbit; | |
41f1219f LP |
60 | } |
61 | ||
fc88936a GU |
62 | static u32 gpio_read_data_reg(struct sh_pfc_chip *chip, |
63 | const struct pinmux_data_reg *dreg) | |
41f1219f | 64 | { |
e51d5343 LP |
65 | void __iomem *mem = dreg->reg - chip->mem->phys + chip->mem->virt; |
66 | ||
67 | return sh_pfc_read_raw_reg(mem, dreg->reg_width); | |
68 | } | |
41f1219f | 69 | |
e51d5343 | 70 | static void gpio_write_data_reg(struct sh_pfc_chip *chip, |
fc88936a | 71 | const struct pinmux_data_reg *dreg, u32 value) |
e51d5343 LP |
72 | { |
73 | void __iomem *mem = dreg->reg - chip->mem->phys + chip->mem->virt; | |
41f1219f | 74 | |
e51d5343 LP |
75 | sh_pfc_write_raw_reg(mem, dreg->reg_width, value); |
76 | } | |
41f1219f | 77 | |
757b055a | 78 | static void gpio_setup_data_reg(struct sh_pfc_chip *chip, unsigned idx) |
e51d5343 | 79 | { |
1a0039dc | 80 | struct sh_pfc *pfc = chip->pfc; |
757b055a LP |
81 | struct sh_pfc_gpio_pin *gpio_pin = &chip->pins[idx]; |
82 | const struct sh_pfc_pin *pin = &pfc->info->pins[idx]; | |
e51d5343 LP |
83 | const struct pinmux_data_reg *dreg; |
84 | unsigned int bit; | |
85 | unsigned int i; | |
41f1219f | 86 | |
e51d5343 LP |
87 | for (i = 0, dreg = pfc->info->data_regs; dreg->reg; ++i, ++dreg) { |
88 | for (bit = 0; bit < dreg->reg_width; bit++) { | |
1a0039dc LP |
89 | if (dreg->enum_ids[bit] == pin->enum_id) { |
90 | gpio_pin->dreg = i; | |
91 | gpio_pin->dbit = bit; | |
41f1219f LP |
92 | return; |
93 | } | |
94 | } | |
41f1219f LP |
95 | } |
96 | ||
97 | BUG(); | |
98 | } | |
99 | ||
e51d5343 | 100 | static int gpio_setup_data_regs(struct sh_pfc_chip *chip) |
41f1219f | 101 | { |
e51d5343 | 102 | struct sh_pfc *pfc = chip->pfc; |
51cb226b | 103 | const struct pinmux_data_reg *dreg; |
e51d5343 | 104 | unsigned int i; |
41f1219f | 105 | |
51cb226b LP |
106 | /* Count the number of data registers, allocate memory and initialize |
107 | * them. | |
108 | */ | |
109 | for (i = 0; pfc->info->data_regs[i].reg_width; ++i) | |
110 | ; | |
111 | ||
112 | chip->regs = devm_kzalloc(pfc->dev, i * sizeof(*chip->regs), | |
113 | GFP_KERNEL); | |
114 | if (chip->regs == NULL) | |
115 | return -ENOMEM; | |
116 | ||
117 | for (i = 0, dreg = pfc->info->data_regs; dreg->reg_width; ++i, ++dreg) { | |
118 | chip->regs[i].info = dreg; | |
119 | chip->regs[i].shadow = gpio_read_data_reg(chip, dreg); | |
120 | } | |
41f1219f | 121 | |
e51d5343 LP |
122 | for (i = 0; i < pfc->info->nr_pins; i++) { |
123 | if (pfc->info->pins[i].enum_id == 0) | |
124 | continue; | |
125 | ||
1a0039dc | 126 | gpio_setup_data_reg(chip, i); |
41f1219f | 127 | } |
e51d5343 LP |
128 | |
129 | return 0; | |
41f1219f LP |
130 | } |
131 | ||
16883814 LP |
132 | /* ----------------------------------------------------------------------------- |
133 | * Pin GPIOs | |
134 | */ | |
b3c185a7 | 135 | |
16883814 | 136 | static int gpio_pin_request(struct gpio_chip *gc, unsigned offset) |
b3c185a7 | 137 | { |
0b73ee5d | 138 | struct sh_pfc *pfc = gpio_to_pfc(gc); |
1a0039dc | 139 | int idx = sh_pfc_get_pin_index(pfc, offset); |
0b73ee5d | 140 | |
1a0039dc | 141 | if (idx < 0 || pfc->info->pins[idx].enum_id == 0) |
0b73ee5d LP |
142 | return -EINVAL; |
143 | ||
16883814 | 144 | return pinctrl_request_gpio(offset); |
b3c185a7 PM |
145 | } |
146 | ||
16883814 | 147 | static void gpio_pin_free(struct gpio_chip *gc, unsigned offset) |
b3c185a7 | 148 | { |
16883814 | 149 | return pinctrl_free_gpio(offset); |
b3c185a7 PM |
150 | } |
151 | ||
e51d5343 LP |
152 | static void gpio_pin_set_value(struct sh_pfc_chip *chip, unsigned offset, |
153 | int value) | |
b3c185a7 | 154 | { |
51cb226b | 155 | struct sh_pfc_gpio_data_reg *reg; |
41f1219f LP |
156 | unsigned long pos; |
157 | unsigned int bit; | |
b3c185a7 | 158 | |
51cb226b | 159 | gpio_get_data_reg(chip, offset, ®, &bit); |
41f1219f | 160 | |
51cb226b | 161 | pos = reg->info->reg_width - (bit + 1); |
41f1219f LP |
162 | |
163 | if (value) | |
fc88936a | 164 | reg->shadow |= BIT(pos); |
41f1219f | 165 | else |
fc88936a | 166 | reg->shadow &= ~BIT(pos); |
41f1219f | 167 | |
51cb226b | 168 | gpio_write_data_reg(chip, reg->info, reg->shadow); |
b3c185a7 PM |
169 | } |
170 | ||
16883814 | 171 | static int gpio_pin_direction_input(struct gpio_chip *gc, unsigned offset) |
ca5481c6 PM |
172 | { |
173 | return pinctrl_gpio_direction_input(offset); | |
174 | } | |
175 | ||
16883814 | 176 | static int gpio_pin_direction_output(struct gpio_chip *gc, unsigned offset, |
ca5481c6 PM |
177 | int value) |
178 | { | |
e51d5343 | 179 | gpio_pin_set_value(gpio_to_pfc_chip(gc), offset, value); |
ca5481c6 PM |
180 | |
181 | return pinctrl_gpio_direction_output(offset); | |
182 | } | |
183 | ||
16883814 | 184 | static int gpio_pin_get(struct gpio_chip *gc, unsigned offset) |
b3c185a7 | 185 | { |
e51d5343 | 186 | struct sh_pfc_chip *chip = gpio_to_pfc_chip(gc); |
51cb226b | 187 | struct sh_pfc_gpio_data_reg *reg; |
41f1219f LP |
188 | unsigned long pos; |
189 | unsigned int bit; | |
16883814 | 190 | |
51cb226b | 191 | gpio_get_data_reg(chip, offset, ®, &bit); |
41f1219f | 192 | |
51cb226b | 193 | pos = reg->info->reg_width - (bit + 1); |
41f1219f | 194 | |
51cb226b | 195 | return (gpio_read_data_reg(chip, reg->info) >> pos) & 1; |
b3c185a7 PM |
196 | } |
197 | ||
16883814 | 198 | static void gpio_pin_set(struct gpio_chip *gc, unsigned offset, int value) |
b3c185a7 | 199 | { |
e51d5343 | 200 | gpio_pin_set_value(gpio_to_pfc_chip(gc), offset, value); |
b3c185a7 PM |
201 | } |
202 | ||
16883814 | 203 | static int gpio_pin_to_irq(struct gpio_chip *gc, unsigned offset) |
b3c185a7 PM |
204 | { |
205 | struct sh_pfc *pfc = gpio_to_pfc(gc); | |
8d72a7fc | 206 | unsigned int i, k; |
c07f54f6 LP |
207 | |
208 | for (i = 0; i < pfc->info->gpio_irq_size; i++) { | |
6d5bddd5 | 209 | const short *gpios = pfc->info->gpio_irq[i].gpios; |
c07f54f6 | 210 | |
316b2550 | 211 | for (k = 0; gpios[k] >= 0; k++) { |
c07f54f6 | 212 | if (gpios[k] == offset) |
70c8f01a | 213 | goto found; |
b3c185a7 PM |
214 | } |
215 | } | |
216 | ||
217 | return -ENOSYS; | |
70c8f01a LP |
218 | |
219 | found: | |
220 | if (pfc->num_irqs) | |
221 | return pfc->irqs[i]; | |
222 | else | |
223 | return pfc->info->gpio_irq[i].irq; | |
b3c185a7 PM |
224 | } |
225 | ||
e51d5343 | 226 | static int gpio_pin_setup(struct sh_pfc_chip *chip) |
b3c185a7 PM |
227 | { |
228 | struct sh_pfc *pfc = chip->pfc; | |
229 | struct gpio_chip *gc = &chip->gpio_chip; | |
e51d5343 LP |
230 | int ret; |
231 | ||
a1a3580c LP |
232 | chip->pins = devm_kzalloc(pfc->dev, pfc->info->nr_pins * |
233 | sizeof(*chip->pins), GFP_KERNEL); | |
1a0039dc LP |
234 | if (chip->pins == NULL) |
235 | return -ENOMEM; | |
236 | ||
e51d5343 LP |
237 | ret = gpio_setup_data_regs(chip); |
238 | if (ret < 0) | |
239 | return ret; | |
b3c185a7 | 240 | |
16883814 LP |
241 | gc->request = gpio_pin_request; |
242 | gc->free = gpio_pin_free; | |
243 | gc->direction_input = gpio_pin_direction_input; | |
244 | gc->get = gpio_pin_get; | |
245 | gc->direction_output = gpio_pin_direction_output; | |
246 | gc->set = gpio_pin_set; | |
247 | gc->to_irq = gpio_pin_to_irq; | |
b3c185a7 | 248 | |
19bb7fe3 | 249 | gc->label = pfc->info->name; |
16883814 | 250 | gc->dev = pfc->dev; |
b3c185a7 | 251 | gc->owner = THIS_MODULE; |
d7a7ca57 | 252 | gc->base = 0; |
28818fa5 | 253 | gc->ngpio = pfc->nr_gpio_pins; |
e51d5343 LP |
254 | |
255 | return 0; | |
b3c185a7 PM |
256 | } |
257 | ||
16883814 LP |
258 | /* ----------------------------------------------------------------------------- |
259 | * Function GPIOs | |
260 | */ | |
261 | ||
262 | static int gpio_function_request(struct gpio_chip *gc, unsigned offset) | |
263 | { | |
9a643c9a | 264 | static bool __print_once; |
16883814 | 265 | struct sh_pfc *pfc = gpio_to_pfc(gc); |
a68fdca9 | 266 | unsigned int mark = pfc->info->func_gpios[offset].enum_id; |
16883814 | 267 | unsigned long flags; |
b705c054 | 268 | int ret; |
16883814 | 269 | |
9a643c9a LP |
270 | if (!__print_once) { |
271 | dev_notice(pfc->dev, | |
272 | "Use of GPIO API for function requests is deprecated." | |
273 | " Convert to pinctrl\n"); | |
274 | __print_once = true; | |
275 | } | |
16883814 | 276 | |
a68fdca9 | 277 | if (mark == 0) |
b705c054 | 278 | return -EINVAL; |
16883814 LP |
279 | |
280 | spin_lock_irqsave(&pfc->lock, flags); | |
b705c054 | 281 | ret = sh_pfc_config_mux(pfc, mark, PINMUX_TYPE_FUNCTION); |
16883814 | 282 | spin_unlock_irqrestore(&pfc->lock, flags); |
b705c054 | 283 | |
16883814 LP |
284 | return ret; |
285 | } | |
286 | ||
287 | static void gpio_function_free(struct gpio_chip *gc, unsigned offset) | |
288 | { | |
16883814 LP |
289 | } |
290 | ||
e51d5343 | 291 | static int gpio_function_setup(struct sh_pfc_chip *chip) |
16883814 LP |
292 | { |
293 | struct sh_pfc *pfc = chip->pfc; | |
294 | struct gpio_chip *gc = &chip->gpio_chip; | |
295 | ||
296 | gc->request = gpio_function_request; | |
297 | gc->free = gpio_function_free; | |
298 | ||
299 | gc->label = pfc->info->name; | |
300 | gc->owner = THIS_MODULE; | |
28818fa5 | 301 | gc->base = pfc->nr_gpio_pins; |
16883814 | 302 | gc->ngpio = pfc->info->nr_func_gpios; |
e51d5343 LP |
303 | |
304 | return 0; | |
16883814 LP |
305 | } |
306 | ||
307 | /* ----------------------------------------------------------------------------- | |
308 | * Register/unregister | |
309 | */ | |
310 | ||
311 | static struct sh_pfc_chip * | |
ceef91dc LP |
312 | sh_pfc_add_gpiochip(struct sh_pfc *pfc, int(*setup)(struct sh_pfc_chip *), |
313 | struct sh_pfc_window *mem) | |
b3c185a7 PM |
314 | { |
315 | struct sh_pfc_chip *chip; | |
316 | int ret; | |
317 | ||
1724acfd | 318 | chip = devm_kzalloc(pfc->dev, sizeof(*chip), GFP_KERNEL); |
b3c185a7 | 319 | if (unlikely(!chip)) |
16883814 | 320 | return ERR_PTR(-ENOMEM); |
b3c185a7 | 321 | |
ceef91dc | 322 | chip->mem = mem; |
b3c185a7 PM |
323 | chip->pfc = pfc; |
324 | ||
e51d5343 LP |
325 | ret = setup(chip); |
326 | if (ret < 0) | |
327 | return ERR_PTR(ret); | |
b3c185a7 PM |
328 | |
329 | ret = gpiochip_add(&chip->gpio_chip); | |
1724acfd | 330 | if (unlikely(ret < 0)) |
16883814 LP |
331 | return ERR_PTR(ret); |
332 | ||
9a643c9a LP |
333 | dev_info(pfc->dev, "%s handling gpio %u -> %u\n", |
334 | chip->gpio_chip.label, chip->gpio_chip.base, | |
335 | chip->gpio_chip.base + chip->gpio_chip.ngpio - 1); | |
16883814 LP |
336 | |
337 | return chip; | |
338 | } | |
339 | ||
340 | int sh_pfc_register_gpiochip(struct sh_pfc *pfc) | |
341 | { | |
342 | struct sh_pfc_chip *chip; | |
63d57383 | 343 | unsigned int i; |
247127f9 | 344 | int ret; |
16883814 | 345 | |
1a4fd58f LP |
346 | if (pfc->info->data_regs == NULL) |
347 | return 0; | |
348 | ||
ceef91dc LP |
349 | /* Find the memory window that contain the GPIO registers. Boards that |
350 | * register a separate GPIO device will not supply a memory resource | |
351 | * that covers the data registers. In that case don't try to handle | |
352 | * GPIOs. | |
353 | */ | |
354 | for (i = 0; i < pfc->num_windows; ++i) { | |
5b46ac3a | 355 | struct sh_pfc_window *window = &pfc->windows[i]; |
ceef91dc LP |
356 | |
357 | if (pfc->info->data_regs[0].reg >= window->phys && | |
358 | pfc->info->data_regs[0].reg < window->phys + window->size) | |
359 | break; | |
360 | } | |
361 | ||
362 | if (i == pfc->num_windows) | |
363 | return 0; | |
364 | ||
70c8f01a LP |
365 | /* If we have IRQ resources make sure their number is correct. */ |
366 | if (pfc->num_irqs && pfc->num_irqs != pfc->info->gpio_irq_size) { | |
367 | dev_err(pfc->dev, "invalid number of IRQ resources\n"); | |
368 | return -EINVAL; | |
369 | } | |
370 | ||
63d57383 | 371 | /* Register the real GPIOs chip. */ |
5b46ac3a | 372 | chip = sh_pfc_add_gpiochip(pfc, gpio_pin_setup, &pfc->windows[i]); |
16883814 LP |
373 | if (IS_ERR(chip)) |
374 | return PTR_ERR(chip); | |
6f6a4a68 LP |
375 | |
376 | pfc->gpio = chip; | |
b3c185a7 | 377 | |
4f82e3ee LP |
378 | /* Register the GPIO to pin mappings. As pins with GPIO ports must come |
379 | * first in the ranges, skip the pins without GPIO ports by stopping at | |
380 | * the first range that contains such a pin. | |
381 | */ | |
acac8ed5 LP |
382 | for (i = 0; i < pfc->nr_ranges; ++i) { |
383 | const struct sh_pfc_pin_range *range = &pfc->ranges[i]; | |
63d57383 | 384 | |
4f82e3ee LP |
385 | if (range->start >= pfc->nr_gpio_pins) |
386 | break; | |
387 | ||
63d57383 LP |
388 | ret = gpiochip_add_pin_range(&chip->gpio_chip, |
389 | dev_name(pfc->dev), | |
acac8ed5 LP |
390 | range->start, range->start, |
391 | range->end - range->start + 1); | |
63d57383 LP |
392 | if (ret < 0) |
393 | return ret; | |
394 | } | |
247127f9 | 395 | |
63d57383 | 396 | /* Register the function GPIOs chip. */ |
542a564d LP |
397 | if (pfc->info->nr_func_gpios == 0) |
398 | return 0; | |
399 | ||
ceef91dc | 400 | chip = sh_pfc_add_gpiochip(pfc, gpio_function_setup, NULL); |
16883814 LP |
401 | if (IS_ERR(chip)) |
402 | return PTR_ERR(chip); | |
403 | ||
404 | pfc->func = chip; | |
b3c185a7 | 405 | |
b3c185a7 PM |
406 | return 0; |
407 | } | |
408 | ||
6f6a4a68 | 409 | int sh_pfc_unregister_gpiochip(struct sh_pfc *pfc) |
b3c185a7 | 410 | { |
b4e7c55d | 411 | gpiochip_remove(&pfc->gpio->gpio_chip); |
412 | gpiochip_remove(&pfc->func->gpio_chip); | |
b3c185a7 | 413 | |
b4e7c55d | 414 | return 0; |
b3c185a7 | 415 | } |