[mirror_ubuntu-artful-kernel.git] / include / linux / gpio / machine.h

#ifndef __LINUX_GPIO_MACHINE_H
#define __LINUX_GPIO_MACHINE_H

#include <linux/types.h>
#include <linux/list.h>

enum gpio_lookup_flags {
	GPIO_ACTIVE_HIGH = (0 << 0),
	GPIO_ACTIVE_LOW = (1 << 0),
	GPIO_OPEN_DRAIN = (1 << 1),
	GPIO_OPEN_SOURCE = (1 << 2),
};

/**
 * struct gpiod_lookup - lookup table
 * @chip_label: name of the chip the GPIO belongs to
 * @chip_hwnum: hardware number (i.e. relative to the chip) of the GPIO
 * @con_id: name of the GPIO from the device's point of view
 * @idx: index of the GPIO in case several GPIOs share the same name
 * @flags: mask of GPIO_* values
 *
 * gpiod_lookup is a lookup table for associating GPIOs to specific devices and
 * functions using platform data.
 */
struct gpiod_lookup {
	const char *chip_label;
	u16 chip_hwnum;
	const char *con_id;
	unsigned int idx;
	enum gpio_lookup_flags flags;
};

struct gpiod_lookup_table {
	struct list_head list;
	const char *dev_id;
	struct gpiod_lookup table[];
};

/*
 * Simple definition of a single GPIO under a con_id
 */
#define GPIO_LOOKUP(_chip_label, _chip_hwnum, _con_id, _flags) \
	GPIO_LOOKUP_IDX(_chip_label, _chip_hwnum, _con_id, 0, _flags)

/*
 * Use this macro if you need to have several GPIOs under the same con_id.
 * Each GPIO needs to use a different index and can be accessed using
 * gpiod_get_index()
 */
#define GPIO_LOOKUP_IDX(_chip_label, _chip_hwnum, _con_id, _idx, _flags)  \
{                                                                         \
	.chip_label = _chip_label,                                        \
	.chip_hwnum = _chip_hwnum,                                        \
	.con_id = _con_id,                                                \
	.idx = _idx,                                                      \
	.flags = _flags,                                                  \
}

#ifdef CONFIG_GPIOLIB
void gpiod_add_lookup_table(struct gpiod_lookup_table *table);
void gpiod_remove_lookup_table(struct gpiod_lookup_table *table);
#else
static inline
void gpiod_add_lookup_table(struct gpiod_lookup_table *table) {}
static inline
void gpiod_remove_lookup_table(struct gpiod_lookup_table *table) {}
#endif

#endif /* __LINUX_GPIO_MACHINE_H */
Commit	Line	Data
0a6d3158 LW	1	#ifndef __LINUX_GPIO_MACHINE_H
	2	#define __LINUX_GPIO_MACHINE_H
	3
b3ea074f AC	4	#include <linux/types.h>
	5	#include <linux/list.h>
	6
0a6d3158 LW	7	enum gpio_lookup_flags {
	8	GPIO_ACTIVE_HIGH = (0 << 0),
	9	GPIO_ACTIVE_LOW = (1 << 0),
	10	GPIO_OPEN_DRAIN = (1 << 1),
	11	GPIO_OPEN_SOURCE = (1 << 2),
	12	};
	13
	14	/**
	15	* struct gpiod_lookup - lookup table
	16	* @chip_label: name of the chip the GPIO belongs to
	17	* @chip_hwnum: hardware number (i.e. relative to the chip) of the GPIO
	18	* @con_id: name of the GPIO from the device's point of view
	19	* @idx: index of the GPIO in case several GPIOs share the same name
	20	* @flags: mask of GPIO_* values
	21	*
	22	* gpiod_lookup is a lookup table for associating GPIOs to specific devices and
	23	* functions using platform data.
	24	*/
	25	struct gpiod_lookup {
	26	const char *chip_label;
	27	u16 chip_hwnum;
	28	const char *con_id;
	29	unsigned int idx;
	30	enum gpio_lookup_flags flags;
	31	};
	32
	33	struct gpiod_lookup_table {
	34	struct list_head list;
	35	const char *dev_id;
	36	struct gpiod_lookup table[];
	37	};
	38
	39	/*
	40	* Simple definition of a single GPIO under a con_id
	41	*/
	42	#define GPIO_LOOKUP(_chip_label, _chip_hwnum, _con_id, _flags) \
	43	GPIO_LOOKUP_IDX(_chip_label, _chip_hwnum, _con_id, 0, _flags)
	44
	45	/*
	46	* Use this macro if you need to have several GPIOs under the same con_id.
	47	* Each GPIO needs to use a different index and can be accessed using
	48	* gpiod_get_index()
	49	*/
	50	#define GPIO_LOOKUP_IDX(_chip_label, _chip_hwnum, _con_id, _idx, _flags) \
	51	{ \
	52	.chip_label = _chip_label, \
	53	.chip_hwnum = _chip_hwnum, \
	54	.con_id = _con_id, \
	55	.idx = _idx, \
	56	.flags = _flags, \
	57	}
	58
020e0b1c	59	#ifdef CONFIG_GPIOLIB
0a6d3158	60	void gpiod_add_lookup_table(struct gpiod_lookup_table *table);
be9015ab	61	void gpiod_remove_lookup_table(struct gpiod_lookup_table *table);
020e0b1c AG	62	#else
	63	static inline
	64	void gpiod_add_lookup_table(struct gpiod_lookup_table *table) {}
	65	static inline
	66	void gpiod_remove_lookup_table(struct gpiod_lookup_table *table) {}
	67	#endif
0a6d3158 LW	68
0a6d3158 LW	69	#endif /* __LINUX_GPIO_MACHINE_H */