blob: d5284dfe01fe167e9da6c6c4f8342d67d8380b20 [file] [log] [blame]
John Linn0bcb6062008-11-12 13:25:38 -08001/*
Michal Simek74600ee2013-06-03 14:31:17 +02002 * Xilinx gpio driver for xps/axi_gpio IP.
John Linn0bcb6062008-11-12 13:25:38 -08003 *
Michal Simek74600ee2013-06-03 14:31:17 +02004 * Copyright 2008 - 2013 Xilinx, Inc.
John Linn0bcb6062008-11-12 13:25:38 -08005 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2
8 * as published by the Free Software Foundation.
9 *
10 * You should have received a copy of the GNU General Public License
11 * along with this program; if not, write to the Free Software
12 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
13 */
14
Michal Simek74600ee2013-06-03 14:31:17 +020015#include <linux/bitops.h>
John Linn0bcb6062008-11-12 13:25:38 -080016#include <linux/init.h>
17#include <linux/errno.h>
Paul Gortmakerbb207ef2011-07-03 13:38:09 -040018#include <linux/module.h>
John Linn0bcb6062008-11-12 13:25:38 -080019#include <linux/of_device.h>
20#include <linux/of_platform.h>
21#include <linux/of_gpio.h>
22#include <linux/io.h>
23#include <linux/gpio.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
John Linn0bcb6062008-11-12 13:25:38 -080025
26/* Register Offset Definitions */
27#define XGPIO_DATA_OFFSET (0x0) /* Data register */
28#define XGPIO_TRI_OFFSET (0x4) /* I/O direction register */
29
Michal Simek74600ee2013-06-03 14:31:17 +020030#define XGPIO_CHANNEL_OFFSET 0x8
31
32/* Read/Write access to the GPIO registers */
Ricardo Ribalda Delgadoc54c58b2014-12-17 16:51:10 +010033#if defined(CONFIG_ARCH_ZYNQ) || defined(CONFIG_X86)
Michal Simekcc090d62013-06-03 14:31:18 +020034# define xgpio_readreg(offset) readl(offset)
35# define xgpio_writereg(offset, val) writel(val, offset)
36#else
37# define xgpio_readreg(offset) __raw_readl(offset)
38# define xgpio_writereg(offset, val) __raw_writel(val, offset)
39#endif
Michal Simek74600ee2013-06-03 14:31:17 +020040
41/**
42 * struct xgpio_instance - Stores information about GPIO device
Ricardo Ribalda Delgado4ae798f2014-12-17 16:51:11 +010043 * @mmchip: OF GPIO chip for memory mapped banks
Michal Simek3c1b5c9b2015-05-04 16:37:16 +020044 * @gpio_width: GPIO width for every channel
Ricardo Ribalda Delgado4ae798f2014-12-17 16:51:11 +010045 * @gpio_state: GPIO state shadow register
46 * @gpio_dir: GPIO direction shadow register
47 * @gpio_lock: Lock used for synchronization
Michal Simek74600ee2013-06-03 14:31:17 +020048 */
John Linn0bcb6062008-11-12 13:25:38 -080049struct xgpio_instance {
50 struct of_mm_gpio_chip mmchip;
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +010051 unsigned int gpio_width[2];
52 u32 gpio_state[2];
53 u32 gpio_dir[2];
54 spinlock_t gpio_lock[2];
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +010055};
56
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +010057static inline int xgpio_index(struct xgpio_instance *chip, int gpio)
58{
59 if (gpio >= chip->gpio_width[0])
60 return 1;
61
62 return 0;
63}
64
65static inline int xgpio_regoffset(struct xgpio_instance *chip, int gpio)
66{
67 if (xgpio_index(chip, gpio))
68 return XGPIO_CHANNEL_OFFSET;
69
70 return 0;
71}
72
73static inline int xgpio_offset(struct xgpio_instance *chip, int gpio)
74{
75 if (xgpio_index(chip, gpio))
76 return gpio - chip->gpio_width[0];
77
78 return gpio;
79}
John Linn0bcb6062008-11-12 13:25:38 -080080
81/**
82 * xgpio_get - Read the specified signal of the GPIO device.
83 * @gc: Pointer to gpio_chip device structure.
84 * @gpio: GPIO signal number.
85 *
Ricardo Ribalda Delgado4ae798f2014-12-17 16:51:11 +010086 * This function reads the specified signal of the GPIO device.
87 *
88 * Return:
89 * 0 if direction of GPIO signals is set as input otherwise it
90 * returns negative error value.
John Linn0bcb6062008-11-12 13:25:38 -080091 */
92static int xgpio_get(struct gpio_chip *gc, unsigned int gpio)
93{
94 struct of_mm_gpio_chip *mm_gc = to_of_mm_gpio_chip(gc);
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +010095 struct xgpio_instance *chip =
96 container_of(mm_gc, struct xgpio_instance, mmchip);
97 u32 val;
John Linn0bcb6062008-11-12 13:25:38 -080098
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +010099 val = xgpio_readreg(mm_gc->regs + XGPIO_DATA_OFFSET +
100 xgpio_regoffset(chip, gpio));
101
102 return !!(val & BIT(xgpio_offset(chip, gpio)));
John Linn0bcb6062008-11-12 13:25:38 -0800103}
104
105/**
106 * xgpio_set - Write the specified signal of the GPIO device.
107 * @gc: Pointer to gpio_chip device structure.
108 * @gpio: GPIO signal number.
109 * @val: Value to be written to specified signal.
110 *
111 * This function writes the specified value in to the specified signal of the
112 * GPIO device.
113 */
114static void xgpio_set(struct gpio_chip *gc, unsigned int gpio, int val)
115{
116 unsigned long flags;
117 struct of_mm_gpio_chip *mm_gc = to_of_mm_gpio_chip(gc);
118 struct xgpio_instance *chip =
119 container_of(mm_gc, struct xgpio_instance, mmchip);
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100120 int index = xgpio_index(chip, gpio);
121 int offset = xgpio_offset(chip, gpio);
John Linn0bcb6062008-11-12 13:25:38 -0800122
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100123 spin_lock_irqsave(&chip->gpio_lock[index], flags);
John Linn0bcb6062008-11-12 13:25:38 -0800124
125 /* Write to GPIO signal and set its direction to output */
126 if (val)
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100127 chip->gpio_state[index] |= BIT(offset);
John Linn0bcb6062008-11-12 13:25:38 -0800128 else
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100129 chip->gpio_state[index] &= ~BIT(offset);
Michal Simek74600ee2013-06-03 14:31:17 +0200130
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100131 xgpio_writereg(mm_gc->regs + XGPIO_DATA_OFFSET +
132 xgpio_regoffset(chip, gpio), chip->gpio_state[index]);
John Linn0bcb6062008-11-12 13:25:38 -0800133
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100134 spin_unlock_irqrestore(&chip->gpio_lock[index], flags);
John Linn0bcb6062008-11-12 13:25:38 -0800135}
136
137/**
138 * xgpio_dir_in - Set the direction of the specified GPIO signal as input.
139 * @gc: Pointer to gpio_chip device structure.
140 * @gpio: GPIO signal number.
141 *
Ricardo Ribalda Delgado4ae798f2014-12-17 16:51:11 +0100142 * Return:
143 * 0 - if direction of GPIO signals is set as input
144 * otherwise it returns negative error value.
John Linn0bcb6062008-11-12 13:25:38 -0800145 */
146static int xgpio_dir_in(struct gpio_chip *gc, unsigned int gpio)
147{
148 unsigned long flags;
149 struct of_mm_gpio_chip *mm_gc = to_of_mm_gpio_chip(gc);
150 struct xgpio_instance *chip =
151 container_of(mm_gc, struct xgpio_instance, mmchip);
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100152 int index = xgpio_index(chip, gpio);
153 int offset = xgpio_offset(chip, gpio);
John Linn0bcb6062008-11-12 13:25:38 -0800154
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100155 spin_lock_irqsave(&chip->gpio_lock[index], flags);
John Linn0bcb6062008-11-12 13:25:38 -0800156
157 /* Set the GPIO bit in shadow register and set direction as input */
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100158 chip->gpio_dir[index] |= BIT(offset);
159 xgpio_writereg(mm_gc->regs + XGPIO_TRI_OFFSET +
160 xgpio_regoffset(chip, gpio), chip->gpio_dir[index]);
John Linn0bcb6062008-11-12 13:25:38 -0800161
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100162 spin_unlock_irqrestore(&chip->gpio_lock[index], flags);
John Linn0bcb6062008-11-12 13:25:38 -0800163
164 return 0;
165}
166
167/**
168 * xgpio_dir_out - Set the direction of the specified GPIO signal as output.
169 * @gc: Pointer to gpio_chip device structure.
170 * @gpio: GPIO signal number.
171 * @val: Value to be written to specified signal.
172 *
Ricardo Ribalda Delgado4ae798f2014-12-17 16:51:11 +0100173 * This function sets the direction of specified GPIO signal as output.
174 *
175 * Return:
176 * If all GPIO signals of GPIO chip is configured as input then it returns
John Linn0bcb6062008-11-12 13:25:38 -0800177 * error otherwise it returns 0.
178 */
179static int xgpio_dir_out(struct gpio_chip *gc, unsigned int gpio, int val)
180{
181 unsigned long flags;
182 struct of_mm_gpio_chip *mm_gc = to_of_mm_gpio_chip(gc);
183 struct xgpio_instance *chip =
184 container_of(mm_gc, struct xgpio_instance, mmchip);
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100185 int index = xgpio_index(chip, gpio);
186 int offset = xgpio_offset(chip, gpio);
John Linn0bcb6062008-11-12 13:25:38 -0800187
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100188 spin_lock_irqsave(&chip->gpio_lock[index], flags);
John Linn0bcb6062008-11-12 13:25:38 -0800189
190 /* Write state of GPIO signal */
191 if (val)
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100192 chip->gpio_state[index] |= BIT(offset);
John Linn0bcb6062008-11-12 13:25:38 -0800193 else
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100194 chip->gpio_state[index] &= ~BIT(offset);
195 xgpio_writereg(mm_gc->regs + XGPIO_DATA_OFFSET +
196 xgpio_regoffset(chip, gpio), chip->gpio_state[index]);
John Linn0bcb6062008-11-12 13:25:38 -0800197
198 /* Clear the GPIO bit in shadow register and set direction as output */
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100199 chip->gpio_dir[index] &= ~BIT(offset);
200 xgpio_writereg(mm_gc->regs + XGPIO_TRI_OFFSET +
201 xgpio_regoffset(chip, gpio), chip->gpio_dir[index]);
John Linn0bcb6062008-11-12 13:25:38 -0800202
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100203 spin_unlock_irqrestore(&chip->gpio_lock[index], flags);
John Linn0bcb6062008-11-12 13:25:38 -0800204
205 return 0;
206}
207
208/**
209 * xgpio_save_regs - Set initial values of GPIO pins
Ricardo Ribalda Delgado4ae798f2014-12-17 16:51:11 +0100210 * @mm_gc: Pointer to memory mapped GPIO chip structure
John Linn0bcb6062008-11-12 13:25:38 -0800211 */
212static void xgpio_save_regs(struct of_mm_gpio_chip *mm_gc)
213{
214 struct xgpio_instance *chip =
215 container_of(mm_gc, struct xgpio_instance, mmchip);
216
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100217 xgpio_writereg(mm_gc->regs + XGPIO_DATA_OFFSET, chip->gpio_state[0]);
218 xgpio_writereg(mm_gc->regs + XGPIO_TRI_OFFSET, chip->gpio_dir[0]);
219
220 if (!chip->gpio_width[1])
221 return;
222
Raphaël Teysseyre5b2c9122015-06-24 09:19:45 +0200223 xgpio_writereg(mm_gc->regs + XGPIO_DATA_OFFSET + XGPIO_CHANNEL_OFFSET,
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100224 chip->gpio_state[1]);
Raphaël Teysseyre5b2c9122015-06-24 09:19:45 +0200225 xgpio_writereg(mm_gc->regs + XGPIO_TRI_OFFSET + XGPIO_CHANNEL_OFFSET,
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100226 chip->gpio_dir[1]);
John Linn0bcb6062008-11-12 13:25:38 -0800227}
228
229/**
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100230 * xgpio_remove - Remove method for the GPIO device.
231 * @pdev: pointer to the platform device
232 *
233 * This function remove gpiochips and frees all the allocated resources.
Michal Simek3c1b5c9b2015-05-04 16:37:16 +0200234 *
235 * Return: 0 always
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100236 */
237static int xgpio_remove(struct platform_device *pdev)
238{
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100239 struct xgpio_instance *chip = platform_get_drvdata(pdev);
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100240
Ricardo Ribalda Delgadoc458e452014-12-17 16:51:14 +0100241 of_mm_gpiochip_remove(&chip->mmchip);
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100242
243 return 0;
244}
245
246/**
John Linn0bcb6062008-11-12 13:25:38 -0800247 * xgpio_of_probe - Probe method for the GPIO device.
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100248 * @pdev: pointer to the platform device
John Linn0bcb6062008-11-12 13:25:38 -0800249 *
Ricardo Ribalda Delgado4ae798f2014-12-17 16:51:11 +0100250 * Return:
251 * It returns 0, if the driver is bound to the GPIO device, or
252 * a negative value if there is an error.
John Linn0bcb6062008-11-12 13:25:38 -0800253 */
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100254static int xgpio_probe(struct platform_device *pdev)
John Linn0bcb6062008-11-12 13:25:38 -0800255{
256 struct xgpio_instance *chip;
John Linn0bcb6062008-11-12 13:25:38 -0800257 int status = 0;
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100258 struct device_node *np = pdev->dev.of_node;
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100259 u32 is_dual;
John Linn0bcb6062008-11-12 13:25:38 -0800260
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100261 chip = devm_kzalloc(&pdev->dev, sizeof(*chip), GFP_KERNEL);
262 if (!chip)
John Linn0bcb6062008-11-12 13:25:38 -0800263 return -ENOMEM;
John Linn0bcb6062008-11-12 13:25:38 -0800264
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100265 platform_set_drvdata(pdev, chip);
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100266
John Linn0bcb6062008-11-12 13:25:38 -0800267 /* Update GPIO state shadow register with default value */
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100268 of_property_read_u32(np, "xlnx,dout-default", &chip->gpio_state[0]);
John Linn0bcb6062008-11-12 13:25:38 -0800269
270 /* Update GPIO direction shadow register with default value */
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100271 if (of_property_read_u32(np, "xlnx,tri-default", &chip->gpio_dir[0]))
272 chip->gpio_dir[0] = 0xFFFFFFFF;
Michal Simek6f8bf502013-06-03 14:31:16 +0200273
Gernot Vormayr1b4c5a62014-09-24 00:58:45 +0200274 /*
275 * Check device node and parent device node for device width
276 * and assume default width of 32
277 */
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100278 if (of_property_read_u32(np, "xlnx,gpio-width", &chip->gpio_width[0]))
279 chip->gpio_width[0] = 32;
John Linn0bcb6062008-11-12 13:25:38 -0800280
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100281 spin_lock_init(&chip->gpio_lock[0]);
John Linn0bcb6062008-11-12 13:25:38 -0800282
Ricardo Ribalda Delgado1d6902d2014-12-17 16:51:12 +0100283 if (of_property_read_u32(np, "xlnx,is-dual", &is_dual))
284 is_dual = 0;
285
286 if (is_dual) {
287 /* Update GPIO state shadow register with default value */
288 of_property_read_u32(np, "xlnx,dout-default-2",
289 &chip->gpio_state[1]);
290
291 /* Update GPIO direction shadow register with default value */
292 if (of_property_read_u32(np, "xlnx,tri-default-2",
293 &chip->gpio_dir[1]))
294 chip->gpio_dir[1] = 0xFFFFFFFF;
295
296 /*
297 * Check device node and parent device node for device width
298 * and assume default width of 32
299 */
300 if (of_property_read_u32(np, "xlnx,gpio2-width",
301 &chip->gpio_width[1]))
302 chip->gpio_width[1] = 32;
303
304 spin_lock_init(&chip->gpio_lock[1]);
305 }
306
307 chip->mmchip.gc.ngpio = chip->gpio_width[0] + chip->gpio_width[1];
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100308 chip->mmchip.gc.dev = &pdev->dev;
Anton Vorontsova19e3da2010-06-08 07:48:16 -0600309 chip->mmchip.gc.direction_input = xgpio_dir_in;
310 chip->mmchip.gc.direction_output = xgpio_dir_out;
311 chip->mmchip.gc.get = xgpio_get;
312 chip->mmchip.gc.set = xgpio_set;
John Linn0bcb6062008-11-12 13:25:38 -0800313
314 chip->mmchip.save_regs = xgpio_save_regs;
315
316 /* Call the OF gpio helper to setup and register the GPIO device */
317 status = of_mm_gpiochip_add(np, &chip->mmchip);
318 if (status) {
John Linn0bcb6062008-11-12 13:25:38 -0800319 pr_err("%s: error in probe function with status %d\n",
320 np->full_name, status);
321 return status;
322 }
Michal Simek74600ee2013-06-03 14:31:17 +0200323
John Linn0bcb6062008-11-12 13:25:38 -0800324 return 0;
325}
326
Jingoo Han9992bc92014-05-07 18:08:20 +0900327static const struct of_device_id xgpio_of_match[] = {
John Linn0bcb6062008-11-12 13:25:38 -0800328 { .compatible = "xlnx,xps-gpio-1.00.a", },
329 { /* end of list */ },
330};
331
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100332MODULE_DEVICE_TABLE(of, xgpio_of_match);
333
334static struct platform_driver xgpio_plat_driver = {
335 .probe = xgpio_probe,
336 .remove = xgpio_remove,
337 .driver = {
338 .name = "gpio-xilinx",
339 .of_match_table = xgpio_of_match,
340 },
341};
342
John Linn0bcb6062008-11-12 13:25:38 -0800343static int __init xgpio_init(void)
344{
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100345 return platform_driver_register(&xgpio_plat_driver);
John Linn0bcb6062008-11-12 13:25:38 -0800346}
347
John Linn0bcb6062008-11-12 13:25:38 -0800348subsys_initcall(xgpio_init);
Ricardo Ribalda Delgado749564f2014-12-17 16:51:09 +0100349
350static void __exit xgpio_exit(void)
351{
352 platform_driver_unregister(&xgpio_plat_driver);
353}
354module_exit(xgpio_exit);
John Linn0bcb6062008-11-12 13:25:38 -0800355
356MODULE_AUTHOR("Xilinx, Inc.");
357MODULE_DESCRIPTION("Xilinx GPIO driver");
358MODULE_LICENSE("GPL");