2 * SuperH Pin Function Controller GPIO driver.
4 * Copyright (C) 2008 Magnus Damm
5 * Copyright (C) 2009 - 2012 Paul Mundt
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
12 #include <linux/device.h>
13 #include <linux/gpio.h>
14 #include <linux/init.h>
15 #include <linux/module.h>
16 #include <linux/pinctrl/consumer.h>
17 #include <linux/slab.h>
18 #include <linux/spinlock.h>
22 struct sh_pfc_gpio_data_reg
{
23 const struct pinmux_data_reg
*info
;
27 struct sh_pfc_gpio_pin
{
34 struct gpio_chip gpio_chip
;
36 struct sh_pfc_window
*mem
;
37 struct sh_pfc_gpio_data_reg
*regs
;
38 struct sh_pfc_gpio_pin
*pins
;
41 static struct sh_pfc_chip
*gpio_to_pfc_chip(struct gpio_chip
*gc
)
43 return container_of(gc
, struct sh_pfc_chip
, gpio_chip
);
46 static struct sh_pfc
*gpio_to_pfc(struct gpio_chip
*gc
)
48 return gpio_to_pfc_chip(gc
)->pfc
;
51 static void gpio_get_data_reg(struct sh_pfc_chip
*chip
, unsigned int gpio
,
52 struct sh_pfc_gpio_data_reg
**reg
,
55 int idx
= sh_pfc_get_pin_index(chip
->pfc
, gpio
);
56 struct sh_pfc_gpio_pin
*gpio_pin
= &chip
->pins
[idx
];
58 *reg
= &chip
->regs
[gpio_pin
->dreg
];
59 *bit
= gpio_pin
->dbit
;
62 static unsigned long gpio_read_data_reg(struct sh_pfc_chip
*chip
,
63 const struct pinmux_data_reg
*dreg
)
65 void __iomem
*mem
= dreg
->reg
- chip
->mem
->phys
+ chip
->mem
->virt
;
67 return sh_pfc_read_raw_reg(mem
, dreg
->reg_width
);
70 static void gpio_write_data_reg(struct sh_pfc_chip
*chip
,
71 const struct pinmux_data_reg
*dreg
,
74 void __iomem
*mem
= dreg
->reg
- chip
->mem
->phys
+ chip
->mem
->virt
;
76 sh_pfc_write_raw_reg(mem
, dreg
->reg_width
, value
);
79 static void gpio_setup_data_reg(struct sh_pfc_chip
*chip
, unsigned gpio
)
81 struct sh_pfc
*pfc
= chip
->pfc
;
82 struct sh_pfc_gpio_pin
*gpio_pin
= &chip
->pins
[gpio
];
83 const struct sh_pfc_pin
*pin
= &pfc
->info
->pins
[gpio
];
84 const struct pinmux_data_reg
*dreg
;
88 for (i
= 0, dreg
= pfc
->info
->data_regs
; dreg
->reg
; ++i
, ++dreg
) {
89 for (bit
= 0; bit
< dreg
->reg_width
; bit
++) {
90 if (dreg
->enum_ids
[bit
] == pin
->enum_id
) {
101 static int gpio_setup_data_regs(struct sh_pfc_chip
*chip
)
103 struct sh_pfc
*pfc
= chip
->pfc
;
104 unsigned long addr
= pfc
->info
->data_regs
[0].reg
;
105 const struct pinmux_data_reg
*dreg
;
108 /* Find the window that contain the GPIO registers. */
109 for (i
= 0; i
< pfc
->num_windows
; ++i
) {
110 struct sh_pfc_window
*window
= &pfc
->window
[i
];
112 if (addr
>= window
->phys
&& addr
< window
->phys
+ window
->size
)
116 if (i
== pfc
->num_windows
)
119 /* GPIO data registers must be in the first memory resource. */
120 chip
->mem
= &pfc
->window
[i
];
122 /* Count the number of data registers, allocate memory and initialize
125 for (i
= 0; pfc
->info
->data_regs
[i
].reg_width
; ++i
)
128 chip
->regs
= devm_kzalloc(pfc
->dev
, i
* sizeof(*chip
->regs
),
130 if (chip
->regs
== NULL
)
133 for (i
= 0, dreg
= pfc
->info
->data_regs
; dreg
->reg_width
; ++i
, ++dreg
) {
134 chip
->regs
[i
].info
= dreg
;
135 chip
->regs
[i
].shadow
= gpio_read_data_reg(chip
, dreg
);
138 for (i
= 0; i
< pfc
->info
->nr_pins
; i
++) {
139 if (pfc
->info
->pins
[i
].enum_id
== 0)
142 gpio_setup_data_reg(chip
, i
);
148 /* -----------------------------------------------------------------------------
152 static int gpio_pin_request(struct gpio_chip
*gc
, unsigned offset
)
154 struct sh_pfc
*pfc
= gpio_to_pfc(gc
);
155 int idx
= sh_pfc_get_pin_index(pfc
, offset
);
157 if (idx
< 0 || pfc
->info
->pins
[idx
].enum_id
== 0)
160 return pinctrl_request_gpio(offset
);
163 static void gpio_pin_free(struct gpio_chip
*gc
, unsigned offset
)
165 return pinctrl_free_gpio(offset
);
168 static void gpio_pin_set_value(struct sh_pfc_chip
*chip
, unsigned offset
,
171 struct sh_pfc_gpio_data_reg
*reg
;
175 gpio_get_data_reg(chip
, offset
, ®
, &bit
);
177 pos
= reg
->info
->reg_width
- (bit
+ 1);
180 set_bit(pos
, ®
->shadow
);
182 clear_bit(pos
, ®
->shadow
);
184 gpio_write_data_reg(chip
, reg
->info
, reg
->shadow
);
187 static int gpio_pin_direction_input(struct gpio_chip
*gc
, unsigned offset
)
189 return pinctrl_gpio_direction_input(offset
);
192 static int gpio_pin_direction_output(struct gpio_chip
*gc
, unsigned offset
,
195 gpio_pin_set_value(gpio_to_pfc_chip(gc
), offset
, value
);
197 return pinctrl_gpio_direction_output(offset
);
200 static int gpio_pin_get(struct gpio_chip
*gc
, unsigned offset
)
202 struct sh_pfc_chip
*chip
= gpio_to_pfc_chip(gc
);
203 struct sh_pfc_gpio_data_reg
*reg
;
207 gpio_get_data_reg(chip
, offset
, ®
, &bit
);
209 pos
= reg
->info
->reg_width
- (bit
+ 1);
211 return (gpio_read_data_reg(chip
, reg
->info
) >> pos
) & 1;
214 static void gpio_pin_set(struct gpio_chip
*gc
, unsigned offset
, int value
)
216 gpio_pin_set_value(gpio_to_pfc_chip(gc
), offset
, value
);
219 static int gpio_pin_to_irq(struct gpio_chip
*gc
, unsigned offset
)
221 struct sh_pfc
*pfc
= gpio_to_pfc(gc
);
224 for (i
= 0; i
< pfc
->info
->gpio_irq_size
; i
++) {
225 unsigned short *gpios
= pfc
->info
->gpio_irq
[i
].gpios
;
227 for (k
= 0; gpios
[k
]; k
++) {
228 if (gpios
[k
] == offset
)
229 return pfc
->info
->gpio_irq
[i
].irq
;
236 static int gpio_pin_setup(struct sh_pfc_chip
*chip
)
238 struct sh_pfc
*pfc
= chip
->pfc
;
239 struct gpio_chip
*gc
= &chip
->gpio_chip
;
242 chip
->pins
= devm_kzalloc(pfc
->dev
, pfc
->nr_pins
* sizeof(*chip
->pins
),
244 if (chip
->pins
== NULL
)
247 ret
= gpio_setup_data_regs(chip
);
251 gc
->request
= gpio_pin_request
;
252 gc
->free
= gpio_pin_free
;
253 gc
->direction_input
= gpio_pin_direction_input
;
254 gc
->get
= gpio_pin_get
;
255 gc
->direction_output
= gpio_pin_direction_output
;
256 gc
->set
= gpio_pin_set
;
257 gc
->to_irq
= gpio_pin_to_irq
;
259 gc
->label
= pfc
->info
->name
;
261 gc
->owner
= THIS_MODULE
;
263 gc
->ngpio
= pfc
->nr_pins
;
268 /* -----------------------------------------------------------------------------
272 static int gpio_function_request(struct gpio_chip
*gc
, unsigned offset
)
274 static bool __print_once
;
275 struct sh_pfc
*pfc
= gpio_to_pfc(gc
);
276 unsigned int mark
= pfc
->info
->func_gpios
[offset
].enum_id
;
282 "Use of GPIO API for function requests is deprecated."
283 " Convert to pinctrl\n");
290 spin_lock_irqsave(&pfc
->lock
, flags
);
291 ret
= sh_pfc_config_mux(pfc
, mark
, PINMUX_TYPE_FUNCTION
);
292 spin_unlock_irqrestore(&pfc
->lock
, flags
);
297 static void gpio_function_free(struct gpio_chip
*gc
, unsigned offset
)
301 static int gpio_function_setup(struct sh_pfc_chip
*chip
)
303 struct sh_pfc
*pfc
= chip
->pfc
;
304 struct gpio_chip
*gc
= &chip
->gpio_chip
;
306 gc
->request
= gpio_function_request
;
307 gc
->free
= gpio_function_free
;
309 gc
->label
= pfc
->info
->name
;
310 gc
->owner
= THIS_MODULE
;
311 gc
->base
= pfc
->nr_pins
;
312 gc
->ngpio
= pfc
->info
->nr_func_gpios
;
317 /* -----------------------------------------------------------------------------
318 * Register/unregister
321 static struct sh_pfc_chip
*
322 sh_pfc_add_gpiochip(struct sh_pfc
*pfc
, int(*setup
)(struct sh_pfc_chip
*))
324 struct sh_pfc_chip
*chip
;
327 chip
= devm_kzalloc(pfc
->dev
, sizeof(*chip
), GFP_KERNEL
);
329 return ERR_PTR(-ENOMEM
);
337 ret
= gpiochip_add(&chip
->gpio_chip
);
338 if (unlikely(ret
< 0))
341 dev_info(pfc
->dev
, "%s handling gpio %u -> %u\n",
342 chip
->gpio_chip
.label
, chip
->gpio_chip
.base
,
343 chip
->gpio_chip
.base
+ chip
->gpio_chip
.ngpio
- 1);
348 int sh_pfc_register_gpiochip(struct sh_pfc
*pfc
)
350 const struct pinmux_range
*ranges
;
351 struct pinmux_range def_range
;
352 struct sh_pfc_chip
*chip
;
353 unsigned int nr_ranges
;
357 /* Register the real GPIOs chip. */
358 chip
= sh_pfc_add_gpiochip(pfc
, gpio_pin_setup
);
360 return PTR_ERR(chip
);
364 /* Register the GPIO to pin mappings. */
365 if (pfc
->info
->ranges
== NULL
) {
367 def_range
.end
= pfc
->info
->nr_pins
- 1;
371 ranges
= pfc
->info
->ranges
;
372 nr_ranges
= pfc
->info
->nr_ranges
;
375 for (i
= 0; i
< nr_ranges
; ++i
) {
376 const struct pinmux_range
*range
= &ranges
[i
];
378 ret
= gpiochip_add_pin_range(&chip
->gpio_chip
,
380 range
->begin
, range
->begin
,
381 range
->end
- range
->begin
+ 1);
386 /* Register the function GPIOs chip. */
387 chip
= sh_pfc_add_gpiochip(pfc
, gpio_function_setup
);
389 return PTR_ERR(chip
);
396 int sh_pfc_unregister_gpiochip(struct sh_pfc
*pfc
)
401 ret
= gpiochip_remove(&pfc
->gpio
->gpio_chip
);
402 err
= gpiochip_remove(&pfc
->func
->gpio_chip
);
404 return ret
< 0 ? ret
: err
;