xref: /openbmc/u-boot/drivers/gpio/tegra_gpio.c (revision 3e972cb9)
1 /*
2  * NVIDIA Tegra20 GPIO handling.
3  *  (C) Copyright 2010-2012
4  *  NVIDIA Corporation <www.nvidia.com>
5  *
6  * SPDX-License-Identifier:	GPL-2.0+
7  */
8 
9 /*
10  * Based on (mostly copied from) kw_gpio.c based Linux 2.6 kernel driver.
11  * Tom Warren (twarren@nvidia.com)
12  */
13 
14 #include <common.h>
15 #include <dm.h>
16 #include <malloc.h>
17 #include <errno.h>
18 #include <fdtdec.h>
19 #include <asm/io.h>
20 #include <asm/bitops.h>
21 #include <asm/arch/tegra.h>
22 #include <asm/gpio.h>
23 #include <dm/device-internal.h>
24 
25 DECLARE_GLOBAL_DATA_PTR;
26 
27 enum {
28 	TEGRA_CMD_INFO,
29 	TEGRA_CMD_PORT,
30 	TEGRA_CMD_OUTPUT,
31 	TEGRA_CMD_INPUT,
32 };
33 
34 struct tegra_gpio_platdata {
35 	struct gpio_ctlr_bank *bank;
36 	const char *port_name;	/* Name of port, e.g. "B" */
37 	int base_gpio;		/* Port number for this port (0, 1,.., n-1) */
38 };
39 
40 /* Information about each port at run-time */
41 struct tegra_port_info {
42 	char label[TEGRA_GPIOS_PER_PORT][GPIO_NAME_SIZE];
43 	struct gpio_ctlr_bank *bank;
44 	int base_gpio;		/* Port number for this port (0, 1,.., n-1) */
45 };
46 
47 /* Return config of pin 'gpio' as GPIO (1) or SFPIO (0) */
48 static int get_config(unsigned gpio)
49 {
50 	struct gpio_ctlr *ctlr = (struct gpio_ctlr *)NV_PA_GPIO_BASE;
51 	struct gpio_ctlr_bank *bank = &ctlr->gpio_bank[GPIO_BANK(gpio)];
52 	u32 u;
53 	int type;
54 
55 	u = readl(&bank->gpio_config[GPIO_PORT(gpio)]);
56 	type =  (u >> GPIO_BIT(gpio)) & 1;
57 
58 	debug("get_config: port = %d, bit = %d is %s\n",
59 		GPIO_FULLPORT(gpio), GPIO_BIT(gpio), type ? "GPIO" : "SFPIO");
60 
61 	return type;
62 }
63 
64 /* Config pin 'gpio' as GPIO or SFPIO, based on 'type' */
65 static void set_config(unsigned gpio, int type)
66 {
67 	struct gpio_ctlr *ctlr = (struct gpio_ctlr *)NV_PA_GPIO_BASE;
68 	struct gpio_ctlr_bank *bank = &ctlr->gpio_bank[GPIO_BANK(gpio)];
69 	u32 u;
70 
71 	debug("set_config: port = %d, bit = %d, %s\n",
72 		GPIO_FULLPORT(gpio), GPIO_BIT(gpio), type ? "GPIO" : "SFPIO");
73 
74 	u = readl(&bank->gpio_config[GPIO_PORT(gpio)]);
75 	if (type)				/* GPIO */
76 		u |= 1 << GPIO_BIT(gpio);
77 	else
78 		u &= ~(1 << GPIO_BIT(gpio));
79 	writel(u, &bank->gpio_config[GPIO_PORT(gpio)]);
80 }
81 
82 /* Return GPIO pin 'gpio' direction - 0 = input or 1 = output */
83 static int get_direction(unsigned gpio)
84 {
85 	struct gpio_ctlr *ctlr = (struct gpio_ctlr *)NV_PA_GPIO_BASE;
86 	struct gpio_ctlr_bank *bank = &ctlr->gpio_bank[GPIO_BANK(gpio)];
87 	u32 u;
88 	int dir;
89 
90 	u = readl(&bank->gpio_dir_out[GPIO_PORT(gpio)]);
91 	dir =  (u >> GPIO_BIT(gpio)) & 1;
92 
93 	debug("get_direction: port = %d, bit = %d, %s\n",
94 		GPIO_FULLPORT(gpio), GPIO_BIT(gpio), dir ? "OUT" : "IN");
95 
96 	return dir;
97 }
98 
99 /* Config GPIO pin 'gpio' as input or output (OE) as per 'output' */
100 static void set_direction(unsigned gpio, int output)
101 {
102 	struct gpio_ctlr *ctlr = (struct gpio_ctlr *)NV_PA_GPIO_BASE;
103 	struct gpio_ctlr_bank *bank = &ctlr->gpio_bank[GPIO_BANK(gpio)];
104 	u32 u;
105 
106 	debug("set_direction: port = %d, bit = %d, %s\n",
107 		GPIO_FULLPORT(gpio), GPIO_BIT(gpio), output ? "OUT" : "IN");
108 
109 	u = readl(&bank->gpio_dir_out[GPIO_PORT(gpio)]);
110 	if (output)
111 		u |= 1 << GPIO_BIT(gpio);
112 	else
113 		u &= ~(1 << GPIO_BIT(gpio));
114 	writel(u, &bank->gpio_dir_out[GPIO_PORT(gpio)]);
115 }
116 
117 /* set GPIO pin 'gpio' output bit as 0 or 1 as per 'high' */
118 static void set_level(unsigned gpio, int high)
119 {
120 	struct gpio_ctlr *ctlr = (struct gpio_ctlr *)NV_PA_GPIO_BASE;
121 	struct gpio_ctlr_bank *bank = &ctlr->gpio_bank[GPIO_BANK(gpio)];
122 	u32 u;
123 
124 	debug("set_level: port = %d, bit %d == %d\n",
125 		GPIO_FULLPORT(gpio), GPIO_BIT(gpio), high);
126 
127 	u = readl(&bank->gpio_out[GPIO_PORT(gpio)]);
128 	if (high)
129 		u |= 1 << GPIO_BIT(gpio);
130 	else
131 		u &= ~(1 << GPIO_BIT(gpio));
132 	writel(u, &bank->gpio_out[GPIO_PORT(gpio)]);
133 }
134 
135 static int check_reserved(struct udevice *dev, unsigned offset,
136 			  const char *func)
137 {
138 	struct tegra_port_info *state = dev_get_priv(dev);
139 	struct gpio_dev_priv *uc_priv = dev->uclass_priv;
140 
141 	if (!*state->label[offset]) {
142 		printf("tegra_gpio: %s: error: gpio %s%d not reserved\n",
143 		       func, uc_priv->bank_name, offset);
144 		return -EBUSY;
145 	}
146 
147 	return 0;
148 }
149 
150 /* set GPIO pin 'gpio' as an output, with polarity 'value' */
151 int tegra_spl_gpio_direction_output(int gpio, int value)
152 {
153 	/* Configure as a GPIO */
154 	set_config(gpio, 1);
155 
156 	/* Configure GPIO output value. */
157 	set_level(gpio, value);
158 
159 	/* Configure GPIO direction as output. */
160 	set_direction(gpio, 1);
161 
162 	return 0;
163 }
164 
165 /*
166  * Generic_GPIO primitives.
167  */
168 
169 static int tegra_gpio_request(struct udevice *dev, unsigned offset,
170 			      const char *label)
171 {
172 	struct tegra_port_info *state = dev_get_priv(dev);
173 
174 	if (*state->label[offset])
175 		return -EBUSY;
176 
177 	strncpy(state->label[offset], label, GPIO_NAME_SIZE);
178 	state->label[offset][GPIO_NAME_SIZE - 1] = '\0';
179 
180 	/* Configure as a GPIO */
181 	set_config(state->base_gpio + offset, 1);
182 
183 	return 0;
184 }
185 
186 static int tegra_gpio_free(struct udevice *dev, unsigned offset)
187 {
188 	struct tegra_port_info *state = dev_get_priv(dev);
189 	int ret;
190 
191 	ret = check_reserved(dev, offset, __func__);
192 	if (ret)
193 		return ret;
194 	state->label[offset][0] = '\0';
195 
196 	return 0;
197 }
198 
199 /* read GPIO OUT value of pin 'gpio' */
200 static int tegra_gpio_get_output_value(unsigned gpio)
201 {
202 	struct gpio_ctlr *ctlr = (struct gpio_ctlr *)NV_PA_GPIO_BASE;
203 	struct gpio_ctlr_bank *bank = &ctlr->gpio_bank[GPIO_BANK(gpio)];
204 	int val;
205 
206 	debug("gpio_get_output_value: pin = %d (port %d:bit %d)\n",
207 		gpio, GPIO_FULLPORT(gpio), GPIO_BIT(gpio));
208 
209 	val = readl(&bank->gpio_out[GPIO_PORT(gpio)]);
210 
211 	return (val >> GPIO_BIT(gpio)) & 1;
212 }
213 
214 
215 /* set GPIO pin 'gpio' as an input */
216 static int tegra_gpio_direction_input(struct udevice *dev, unsigned offset)
217 {
218 	struct tegra_port_info *state = dev_get_priv(dev);
219 	int ret;
220 
221 	ret = check_reserved(dev, offset, __func__);
222 	if (ret)
223 		return ret;
224 
225 	/* Configure GPIO direction as input. */
226 	set_direction(state->base_gpio + offset, 0);
227 
228 	return 0;
229 }
230 
231 /* set GPIO pin 'gpio' as an output, with polarity 'value' */
232 static int tegra_gpio_direction_output(struct udevice *dev, unsigned offset,
233 				       int value)
234 {
235 	struct tegra_port_info *state = dev_get_priv(dev);
236 	int gpio = state->base_gpio + offset;
237 	int ret;
238 
239 	ret = check_reserved(dev, offset, __func__);
240 	if (ret)
241 		return ret;
242 
243 	/* Configure GPIO output value. */
244 	set_level(gpio, value);
245 
246 	/* Configure GPIO direction as output. */
247 	set_direction(gpio, 1);
248 
249 	return 0;
250 }
251 
252 /* read GPIO IN value of pin 'gpio' */
253 static int tegra_gpio_get_value(struct udevice *dev, unsigned offset)
254 {
255 	struct tegra_port_info *state = dev_get_priv(dev);
256 	int gpio = state->base_gpio + offset;
257 	int ret;
258 	int val;
259 
260 	ret = check_reserved(dev, offset, __func__);
261 	if (ret)
262 		return ret;
263 
264 	debug("%s: pin = %d (port %d:bit %d)\n", __func__,
265 	      gpio, GPIO_FULLPORT(gpio), GPIO_BIT(gpio));
266 
267 	val = readl(&state->bank->gpio_in[GPIO_PORT(gpio)]);
268 
269 	return (val >> GPIO_BIT(gpio)) & 1;
270 }
271 
272 /* write GPIO OUT value to pin 'gpio' */
273 static int tegra_gpio_set_value(struct udevice *dev, unsigned offset, int value)
274 {
275 	struct tegra_port_info *state = dev_get_priv(dev);
276 	int gpio = state->base_gpio + offset;
277 	int ret;
278 
279 	ret = check_reserved(dev, offset, __func__);
280 	if (ret)
281 		return ret;
282 
283 	debug("gpio_set_value: pin = %d (port %d:bit %d), value = %d\n",
284 	      gpio, GPIO_FULLPORT(gpio), GPIO_BIT(gpio), value);
285 
286 	/* Configure GPIO output value. */
287 	set_level(gpio, value);
288 
289 	return 0;
290 }
291 
292 void gpio_config_table(const struct tegra_gpio_config *config, int len)
293 {
294 	int i;
295 
296 	for (i = 0; i < len; i++) {
297 		switch (config[i].init) {
298 		case TEGRA_GPIO_INIT_IN:
299 			gpio_direction_input(config[i].gpio);
300 			break;
301 		case TEGRA_GPIO_INIT_OUT0:
302 			gpio_direction_output(config[i].gpio, 0);
303 			break;
304 		case TEGRA_GPIO_INIT_OUT1:
305 			gpio_direction_output(config[i].gpio, 1);
306 			break;
307 		}
308 		set_config(config[i].gpio, 1);
309 	}
310 }
311 
312 static int tegra_gpio_get_function(struct udevice *dev, unsigned offset)
313 {
314 	struct tegra_port_info *state = dev_get_priv(dev);
315 	int gpio = state->base_gpio + offset;
316 
317 	if (!*state->label[offset])
318 		return GPIOF_UNUSED;
319 	if (!get_config(gpio))
320 		return GPIOF_FUNC;
321 	else if (get_direction(gpio))
322 		return GPIOF_OUTPUT;
323 	else
324 		return GPIOF_INPUT;
325 }
326 
327 static int tegra_gpio_get_state(struct udevice *dev, unsigned int offset,
328 				char *buf, int bufsize)
329 {
330 	struct gpio_dev_priv *uc_priv = dev->uclass_priv;
331 	struct tegra_port_info *state = dev_get_priv(dev);
332 	int gpio = state->base_gpio + offset;
333 	const char *label;
334 	int is_output;
335 	int is_gpio;
336 	int size;
337 
338 	label = state->label[offset];
339 	is_gpio = get_config(gpio); /* GPIO, not SFPIO */
340 	size = snprintf(buf, bufsize, "%s%d: ",
341 			uc_priv->bank_name ? uc_priv->bank_name : "", offset);
342 	buf += size;
343 	bufsize -= size;
344 	if (is_gpio) {
345 		is_output = get_direction(gpio);
346 
347 		snprintf(buf, bufsize, "%s: %d [%c]%s%s",
348 			 is_output ? "out" : " in",
349 			 is_output ?
350 				tegra_gpio_get_output_value(gpio) :
351 				tegra_gpio_get_value(dev, offset),
352 			 *label ? 'x' : ' ',
353 			 *label ? " " : "",
354 			 label);
355 	} else {
356 		snprintf(buf, bufsize, "sfpio");
357 	}
358 
359 	return 0;
360 }
361 
362 static const struct dm_gpio_ops gpio_tegra_ops = {
363 	.request		= tegra_gpio_request,
364 	.free			= tegra_gpio_free,
365 	.direction_input	= tegra_gpio_direction_input,
366 	.direction_output	= tegra_gpio_direction_output,
367 	.get_value		= tegra_gpio_get_value,
368 	.set_value		= tegra_gpio_set_value,
369 	.get_function		= tegra_gpio_get_function,
370 	.get_state		= tegra_gpio_get_state,
371 };
372 
373 /**
374  * Returns the name of a GPIO port
375  *
376  * GPIOs are named A, B, C, ..., Z, AA, BB, CC, ...
377  *
378  * @base_port: Base port number (0, 1..n-1)
379  * @return allocated string containing the name
380  */
381 static char *gpio_port_name(int base_port)
382 {
383 	char *name, *s;
384 
385 	name = malloc(3);
386 	if (name) {
387 		s = name;
388 		*s++ = 'A' + (base_port % 26);
389 		if (base_port >= 26)
390 			*s++ = *name;
391 		*s = '\0';
392 	}
393 
394 	return name;
395 }
396 
397 static const struct udevice_id tegra_gpio_ids[] = {
398 	{ .compatible = "nvidia,tegra30-gpio" },
399 	{ .compatible = "nvidia,tegra20-gpio" },
400 	{ }
401 };
402 
403 static int gpio_tegra_probe(struct udevice *dev)
404 {
405 	struct gpio_dev_priv *uc_priv = dev->uclass_priv;
406 	struct tegra_port_info *priv = dev->priv;
407 	struct tegra_gpio_platdata *plat = dev->platdata;
408 
409 	/* Only child devices have ports */
410 	if (!plat)
411 		return 0;
412 
413 	priv->bank = plat->bank;
414 	priv->base_gpio = plat->base_gpio;
415 
416 	uc_priv->gpio_count = TEGRA_GPIOS_PER_PORT;
417 	uc_priv->bank_name = plat->port_name;
418 
419 	return 0;
420 }
421 
422 /**
423  * We have a top-level GPIO device with no actual GPIOs. It has a child
424  * device for each Tegra port.
425  */
426 static int gpio_tegra_bind(struct udevice *parent)
427 {
428 	struct tegra_gpio_platdata *plat = parent->platdata;
429 	struct gpio_ctlr *ctlr;
430 	int bank_count;
431 	int bank;
432 	int ret;
433 	int len;
434 
435 	/* If this is a child device, there is nothing to do here */
436 	if (plat)
437 		return 0;
438 
439 	/*
440 	 * This driver does not make use of interrupts, other than to figure
441 	 * out the number of GPIO banks
442 	 */
443 	if (!fdt_getprop(gd->fdt_blob, parent->of_offset, "interrupts", &len))
444 		return -EINVAL;
445 	bank_count = len / 3 / sizeof(u32);
446 	ctlr = (struct gpio_ctlr *)fdtdec_get_addr(gd->fdt_blob,
447 						   parent->of_offset, "reg");
448 	for (bank = 0; bank < bank_count; bank++) {
449 		int port;
450 
451 		for (port = 0; port < TEGRA_PORTS_PER_BANK; port++) {
452 			struct tegra_gpio_platdata *plat;
453 			struct udevice *dev;
454 			int base_port;
455 
456 			plat = calloc(1, sizeof(*plat));
457 			if (!plat)
458 				return -ENOMEM;
459 			plat->bank = &ctlr->gpio_bank[bank];
460 			base_port = bank * TEGRA_PORTS_PER_BANK + port;
461 			plat->base_gpio = TEGRA_GPIOS_PER_PORT * base_port;
462 			plat->port_name = gpio_port_name(base_port);
463 
464 			ret = device_bind(parent, parent->driver,
465 					  plat->port_name, plat, -1, &dev);
466 			if (ret)
467 				return ret;
468 			dev->of_offset = parent->of_offset;
469 		}
470 	}
471 
472 	return 0;
473 }
474 
475 U_BOOT_DRIVER(gpio_tegra) = {
476 	.name	= "gpio_tegra",
477 	.id	= UCLASS_GPIO,
478 	.of_match = tegra_gpio_ids,
479 	.bind	= gpio_tegra_bind,
480 	.probe = gpio_tegra_probe,
481 	.priv_auto_alloc_size = sizeof(struct tegra_port_info),
482 	.ops	= &gpio_tegra_ops,
483 };
484