[linux-2.6-block.git] / include / linux / basic_mmio_gpio.h

/*
 * Basic memory-mapped GPIO controllers.
 *
 * Copyright 2008 MontaVista Software, Inc.
 * Copyright 2008,2010 Anton Vorontsov <cbouatmailru@gmail.com>
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 */

#ifndef __BASIC_MMIO_GPIO_H
#define __BASIC_MMIO_GPIO_H

#include <linux/gpio.h>
#include <linux/types.h>
#include <linux/compiler.h>
#include <linux/spinlock_types.h>

struct bgpio_pdata {
	const char *label;
	int base;
	int ngpio;
};

struct device;

struct bgpio_chip {
	struct gpio_chip gc;

	unsigned long (*read_reg)(void __iomem *reg);
	void (*write_reg)(void __iomem *reg, unsigned long data);

	void __iomem *reg_dat;
	void __iomem *reg_set;
	void __iomem *reg_clr;
	void __iomem *reg_dir;

	/* Number of bits (GPIOs): <register width> * 8. */
	int bits;

	/*
	 * Some GPIO controllers work with the big-endian bits notation,
	 * e.g. in a 8-bits register, GPIO7 is the least significant bit.
	 */
	unsigned long (*pin2mask)(struct bgpio_chip *bgc, unsigned int pin);

	/*
	 * Used to lock bgpio_chip->data. Also, this is needed to keep
	 * shadowed and real data registers writes together.
	 */
	spinlock_t lock;

	/* Shadowed data register to clear/set bits safely. */
	unsigned long data;

	/* Shadowed direction registers to clear/set direction safely. */
	unsigned long dir;
};

static inline struct bgpio_chip *to_bgpio_chip(struct gpio_chip *gc)
{
	return container_of(gc, struct bgpio_chip, gc);
}

int bgpio_remove(struct bgpio_chip *bgc);
int bgpio_init(struct bgpio_chip *bgc, struct device *dev,
	       unsigned long sz, void __iomem *dat, void __iomem *set,
	       void __iomem *clr, void __iomem *dirout, void __iomem *dirin,
	       unsigned long flags);

#define BGPIOF_BIG_ENDIAN		BIT(0)
#define BGPIOF_UNREADABLE_REG_SET	BIT(1) /* reg_set is unreadable */
#define BGPIOF_UNREADABLE_REG_DIR	BIT(2) /* reg_dir is unreadable */
#define BGPIOF_BIG_ENDIAN_BYTE_ORDER	BIT(3)
#define BGPIOF_READ_OUTPUT_REG_SET     BIT(4) /* reg_set stores output value */

#endif /* __BASIC_MMIO_GPIO_H */
Commit	Line	Data
aeec56e3 AV	1	/*
	2	* Basic memory-mapped GPIO controllers.
	3	*
	4	* Copyright 2008 MontaVista Software, Inc.
	5	* Copyright 2008,2010 Anton Vorontsov <cbouatmailru@gmail.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify it
	8	* under the terms of the GNU General Public License as published by the
	9	* Free Software Foundation; either version 2 of the License, or (at your
	10	* option) any later version.
	11	*/
	12
	13	#ifndef __BASIC_MMIO_GPIO_H
	14	#define __BASIC_MMIO_GPIO_H
	15
280df6b3 JI	16	#include <linux/gpio.h>
	17	#include <linux/types.h>
	18	#include <linux/compiler.h>
e5ea3f12	19	#include <linux/spinlock_types.h>
280df6b3	20
aeec56e3	21	struct bgpio_pdata {
781f6d71	22	const char *label;
aeec56e3	23	int base;
924e7a9f	24	int ngpio;
aeec56e3 AV	25	};
aeec56e3 AV	26
280df6b3 JI	27	struct device;
	28
	29	struct bgpio_chip {
	30	struct gpio_chip gc;
	31
	32	unsigned long (read_reg)(void __iomem reg);
	33	void (write_reg)(void __iomem reg, unsigned long data);
	34
	35	void __iomem *reg_dat;
	36	void __iomem *reg_set;
	37	void __iomem *reg_clr;
	38	void __iomem *reg_dir;
	39
	40	/* Number of bits (GPIOs): <register width> * 8. */
	41	int bits;
	42
	43	/*
	44	* Some GPIO controllers work with the big-endian bits notation,
	45	* e.g. in a 8-bits register, GPIO7 is the least significant bit.
	46	*/
	47	unsigned long (pin2mask)(struct bgpio_chip bgc, unsigned int pin);
	48
	49	/*
	50	* Used to lock bgpio_chip->data. Also, this is needed to keep
	51	* shadowed and real data registers writes together.
	52	*/
	53	spinlock_t lock;
	54
	55	/* Shadowed data register to clear/set bits safely. */
	56	unsigned long data;
	57
	58	/* Shadowed direction registers to clear/set direction safely. */
	59	unsigned long dir;
	60	};
	61
	62	static inline struct bgpio_chip to_bgpio_chip(struct gpio_chip gc)
	63	{
	64	return container_of(gc, struct bgpio_chip, gc);
	65	}
	66
4f5b0480 RK	67	int bgpio_remove(struct bgpio_chip *bgc);
	68	int bgpio_init(struct bgpio_chip bgc, struct device dev,
	69	unsigned long sz, void __iomem dat, void __iomem set,
	70	void __iomem clr, void __iomem dirout, void __iomem *dirin,
3e11f7b8 SG	71	unsigned long flags);
	72
	73	#define BGPIOF_BIG_ENDIAN BIT(0)
	74	#define BGPIOF_UNREADABLE_REG_SET BIT(1) /* reg_set is unreadable */
	75	#define BGPIOF_UNREADABLE_REG_DIR BIT(2) /* reg_dir is unreadable */
2b78f1e1	76	#define BGPIOF_BIG_ENDIAN_BYTE_ORDER BIT(3)
b19e7f51	77	#define BGPIOF_READ_OUTPUT_REG_SET BIT(4) /* reg_set stores output value */
280df6b3	78
aeec56e3	79	#endif /* __BASIC_MMIO_GPIO_H */