blob: 1020587efed19f6662ee5384e41b8dc72555ef61 [file] [log] [blame]
Anton Vorontsov863fbf42008-04-11 23:06:45 +10001/*
2 * OF helpers for the GPIO API
3 *
4 * Copyright (c) 2007-2008 MontaVista Software, Inc.
5 *
6 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 */
13
14#ifndef __LINUX_OF_GPIO_H
15#define __LINUX_OF_GPIO_H
16
Anton Vorontsovb908b532008-12-01 06:30:04 +000017#include <linux/compiler.h>
18#include <linux/kernel.h>
Anton Vorontsov863fbf42008-04-11 23:06:45 +100019#include <linux/errno.h>
Wolfgang Grandegger18ad7a62008-05-30 22:51:33 +100020#include <linux/gpio.h>
Anton Vorontsov863fbf42008-04-11 23:06:45 +100021
Anton Vorontsovb908b532008-12-01 06:30:04 +000022struct device_node;
23
24/*
25 * This is Linux-specific flags. By default controllers' and Linux' mapping
26 * match, but GPIO controllers are free to translate their own flags to
27 * Linux-specific in their .xlate callback. Though, 1:1 mapping is recommended.
28 */
29enum of_gpio_flags {
30 OF_GPIO_ACTIVE_LOW = 0x1,
31};
32
Anton Vorontsov863fbf42008-04-11 23:06:45 +100033#ifdef CONFIG_OF_GPIO
34
35/*
Anton Vorontsov863fbf42008-04-11 23:06:45 +100036 * OF GPIO chip for memory mapped banks
37 */
38struct of_mm_gpio_chip {
Anton Vorontsova19e3da2010-06-08 07:48:16 -060039 struct gpio_chip gc;
Anton Vorontsov863fbf42008-04-11 23:06:45 +100040 void (*save_regs)(struct of_mm_gpio_chip *mm_gc);
41 void __iomem *regs;
42};
43
44static inline struct of_mm_gpio_chip *to_of_mm_gpio_chip(struct gpio_chip *gc)
45{
Anton Vorontsova19e3da2010-06-08 07:48:16 -060046 return container_of(gc, struct of_mm_gpio_chip, gc);
Anton Vorontsov863fbf42008-04-11 23:06:45 +100047}
48
Anton Vorontsovb908b532008-12-01 06:30:04 +000049extern int of_get_gpio_flags(struct device_node *np, int index,
50 enum of_gpio_flags *flags);
Anton Vorontsov74982092008-12-05 08:15:54 +000051extern unsigned int of_gpio_count(struct device_node *np);
Anton Vorontsovb908b532008-12-01 06:30:04 +000052
Anton Vorontsov863fbf42008-04-11 23:06:45 +100053extern int of_mm_gpiochip_add(struct device_node *np,
54 struct of_mm_gpio_chip *mm_gc);
Anton Vorontsova19e3da2010-06-08 07:48:16 -060055extern int of_gpio_simple_xlate(struct gpio_chip *gc, struct device_node *np,
56 const void *gpio_spec, u32 *flags);
Grant Likely594fa262010-06-08 07:48:16 -060057
58extern struct gpio_chip *of_node_to_gpiochip(struct device_node *np);
59
Anton Vorontsova19e3da2010-06-08 07:48:16 -060060#else /* CONFIG_OF_GPIO */
Anton Vorontsov863fbf42008-04-11 23:06:45 +100061
62/* Drivers may not strictly depend on the GPIO support, so let them link. */
Anton Vorontsovb908b532008-12-01 06:30:04 +000063static inline int of_get_gpio_flags(struct device_node *np, int index,
64 enum of_gpio_flags *flags)
Anton Vorontsov863fbf42008-04-11 23:06:45 +100065{
66 return -ENOSYS;
67}
68
Anton Vorontsov74982092008-12-05 08:15:54 +000069static inline unsigned int of_gpio_count(struct device_node *np)
70{
71 return 0;
72}
73
Anton Vorontsov863fbf42008-04-11 23:06:45 +100074#endif /* CONFIG_OF_GPIO */
75
Anton Vorontsovb908b532008-12-01 06:30:04 +000076/**
77 * of_get_gpio - Get a GPIO number to use with GPIO API
78 * @np: device node to get GPIO from
79 * @index: index of the GPIO
80 *
81 * Returns GPIO number to use with Linux generic GPIO API, or one of the errno
82 * value on the error condition.
83 */
84static inline int of_get_gpio(struct device_node *np, int index)
85{
86 return of_get_gpio_flags(np, index, NULL);
87}
88
Anton Vorontsov863fbf42008-04-11 23:06:45 +100089#endif /* __LINUX_OF_GPIO_H */