[deliverable/linux.git] / drivers / pinctrl / sunxi / pinctrl-sunxi.h

/*
 * Allwinner A1X SoCs pinctrl driver.
 *
 * Copyright (C) 2012 Maxime Ripard
 *
 * Maxime Ripard <maxime.ripard@free-electrons.com>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2.  This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 */

#ifndef __PINCTRL_SUNXI_H
#define __PINCTRL_SUNXI_H

#include <linux/kernel.h>
#include <linux/spinlock.h>

#define PA_BASE	0
#define PB_BASE	32
#define PC_BASE	64
#define PD_BASE	96
#define PE_BASE	128
#define PF_BASE	160
#define PG_BASE	192
#define PH_BASE	224
#define PI_BASE	256
#define PL_BASE	352
#define PM_BASE	384

#define SUNXI_PINCTRL_PIN(bank, pin)		\
	PINCTRL_PIN(P ## bank ## _BASE + (pin), "P" #bank #pin)

#define SUNXI_PIN_NAME_MAX_LEN	5

#define BANK_MEM_SIZE		0x24
#define MUX_REGS_OFFSET		0x0
#define DATA_REGS_OFFSET	0x10
#define DLEVEL_REGS_OFFSET	0x14
#define PULL_REGS_OFFSET	0x1c

#define PINS_PER_BANK		32
#define MUX_PINS_PER_REG	8
#define MUX_PINS_BITS		4
#define MUX_PINS_MASK		0x0f
#define DATA_PINS_PER_REG	32
#define DATA_PINS_BITS		1
#define DATA_PINS_MASK		0x01
#define DLEVEL_PINS_PER_REG	16
#define DLEVEL_PINS_BITS	2
#define DLEVEL_PINS_MASK	0x03
#define PULL_PINS_PER_REG	16
#define PULL_PINS_BITS		2
#define PULL_PINS_MASK		0x03

#define IRQ_PER_BANK		32

#define IRQ_CFG_REG		0x200
#define IRQ_CFG_IRQ_PER_REG		8
#define IRQ_CFG_IRQ_BITS		4
#define IRQ_CFG_IRQ_MASK		((1 << IRQ_CFG_IRQ_BITS) - 1)
#define IRQ_CTRL_REG		0x210
#define IRQ_CTRL_IRQ_PER_REG		32
#define IRQ_CTRL_IRQ_BITS		1
#define IRQ_CTRL_IRQ_MASK		((1 << IRQ_CTRL_IRQ_BITS) - 1)
#define IRQ_STATUS_REG		0x214
#define IRQ_STATUS_IRQ_PER_REG		32
#define IRQ_STATUS_IRQ_BITS		1
#define IRQ_STATUS_IRQ_MASK		((1 << IRQ_STATUS_IRQ_BITS) - 1)

#define IRQ_MEM_SIZE		0x20

#define IRQ_EDGE_RISING		0x00
#define IRQ_EDGE_FALLING	0x01
#define IRQ_LEVEL_HIGH		0x02
#define IRQ_LEVEL_LOW		0x03
#define IRQ_EDGE_BOTH		0x04

struct sunxi_desc_function {
	const char	*name;
	u8		muxval;
	u8		irqbank;
	u8		irqnum;
};

struct sunxi_desc_pin {
	struct pinctrl_pin_desc		pin;
	struct sunxi_desc_function	*functions;
};

struct sunxi_pinctrl_desc {
	const struct sunxi_desc_pin	*pins;
	int				npins;
	unsigned			pin_base;
	unsigned			irq_banks;
};

struct sunxi_pinctrl_function {
	const char	*name;
	const char	**groups;
	unsigned	ngroups;
};

struct sunxi_pinctrl_group {
	const char	*name;
	unsigned long	config;
	unsigned	pin;
};

struct sunxi_pinctrl {
	void __iomem			*membase;
	struct gpio_chip		*chip;
	const struct sunxi_pinctrl_desc	*desc;
	struct device			*dev;
	struct irq_domain		*domain;
	struct sunxi_pinctrl_function	*functions;
	unsigned			nfunctions;
	struct sunxi_pinctrl_group	*groups;
	unsigned			ngroups;
	int				*irq;
	unsigned			*irq_array;
	spinlock_t			lock;
	struct pinctrl_dev		*pctl_dev;
};

#define SUNXI_PIN(_pin, ...)					\
	{							\
		.pin = _pin,					\
		.functions = (struct sunxi_desc_function[]){	\
			__VA_ARGS__, { } },			\
	}

#define SUNXI_FUNCTION(_val, _name)				\
	{							\
		.name = _name,					\
		.muxval = _val,					\
	}

#define SUNXI_FUNCTION_IRQ(_val, _irq)				\
	{							\
		.name = "irq",					\
		.muxval = _val,					\
		.irqnum = _irq,					\
	}

#define SUNXI_FUNCTION_IRQ_BANK(_val, _bank, _irq)		\
	{							\
		.name = "irq",					\
		.muxval = _val,					\
		.irqbank = _bank,				\
		.irqnum = _irq,					\
	}

/*
 * The sunXi PIO registers are organized as is:
 * 0x00 - 0x0c	Muxing values.
 *		8 pins per register, each pin having a 4bits value
 * 0x10		Pin values
 *		32 bits per register, each pin corresponding to one bit
 * 0x14 - 0x18	Drive level
 *		16 pins per register, each pin having a 2bits value
 * 0x1c - 0x20	Pull-Up values
 *		16 pins per register, each pin having a 2bits value
 *
 * This is for the first bank. Each bank will have the same layout,
 * with an offset being a multiple of 0x24.
 *
 * The following functions calculate from the pin number the register
 * and the bit offset that we should access.
 */
static inline u32 sunxi_mux_reg(u16 pin)
{
	u8 bank = pin / PINS_PER_BANK;
	u32 offset = bank * BANK_MEM_SIZE;
	offset += MUX_REGS_OFFSET;
	offset += pin % PINS_PER_BANK / MUX_PINS_PER_REG * 0x04;
	return round_down(offset, 4);
}

static inline u32 sunxi_mux_offset(u16 pin)
{
	u32 pin_num = pin % MUX_PINS_PER_REG;
	return pin_num * MUX_PINS_BITS;
}

static inline u32 sunxi_data_reg(u16 pin)
{
	u8 bank = pin / PINS_PER_BANK;
	u32 offset = bank * BANK_MEM_SIZE;
	offset += DATA_REGS_OFFSET;
	offset += pin % PINS_PER_BANK / DATA_PINS_PER_REG * 0x04;
	return round_down(offset, 4);
}

static inline u32 sunxi_data_offset(u16 pin)
{
	u32 pin_num = pin % DATA_PINS_PER_REG;
	return pin_num * DATA_PINS_BITS;
}

static inline u32 sunxi_dlevel_reg(u16 pin)
{
	u8 bank = pin / PINS_PER_BANK;
	u32 offset = bank * BANK_MEM_SIZE;
	offset += DLEVEL_REGS_OFFSET;
	offset += pin % PINS_PER_BANK / DLEVEL_PINS_PER_REG * 0x04;
	return round_down(offset, 4);
}

static inline u32 sunxi_dlevel_offset(u16 pin)
{
	u32 pin_num = pin % DLEVEL_PINS_PER_REG;
	return pin_num * DLEVEL_PINS_BITS;
}

static inline u32 sunxi_pull_reg(u16 pin)
{
	u8 bank = pin / PINS_PER_BANK;
	u32 offset = bank * BANK_MEM_SIZE;
	offset += PULL_REGS_OFFSET;
	offset += pin % PINS_PER_BANK / PULL_PINS_PER_REG * 0x04;
	return round_down(offset, 4);
}

static inline u32 sunxi_pull_offset(u16 pin)
{
	u32 pin_num = pin % PULL_PINS_PER_REG;
	return pin_num * PULL_PINS_BITS;
}

static inline u32 sunxi_irq_cfg_reg(u16 irq)
{
	u8 bank = irq / IRQ_PER_BANK;
	u8 reg = (irq % IRQ_PER_BANK) / IRQ_CFG_IRQ_PER_REG * 0x04;

	return IRQ_CFG_REG + bank * IRQ_MEM_SIZE + reg;
}

static inline u32 sunxi_irq_cfg_offset(u16 irq)
{
	u32 irq_num = irq % IRQ_CFG_IRQ_PER_REG;
	return irq_num * IRQ_CFG_IRQ_BITS;
}

static inline u32 sunxi_irq_ctrl_reg_from_bank(u8 bank)
{
	return IRQ_CTRL_REG + bank * IRQ_MEM_SIZE;
}

static inline u32 sunxi_irq_ctrl_reg(u16 irq)
{
	u8 bank = irq / IRQ_PER_BANK;

	return sunxi_irq_ctrl_reg_from_bank(bank);
}

static inline u32 sunxi_irq_ctrl_offset(u16 irq)
{
	u32 irq_num = irq % IRQ_CTRL_IRQ_PER_REG;
	return irq_num * IRQ_CTRL_IRQ_BITS;
}

static inline u32 sunxi_irq_status_reg_from_bank(u8 bank)
{
	return IRQ_STATUS_REG + bank * IRQ_MEM_SIZE;
}

static inline u32 sunxi_irq_status_reg(u16 irq)
{
	u8 bank = irq / IRQ_PER_BANK;

	return sunxi_irq_status_reg_from_bank(bank);
}

static inline u32 sunxi_irq_status_offset(u16 irq)
{
	u32 irq_num = irq % IRQ_STATUS_IRQ_PER_REG;
	return irq_num * IRQ_STATUS_IRQ_BITS;
}

int sunxi_pinctrl_init(struct platform_device *pdev,
		       const struct sunxi_pinctrl_desc *desc);

#endif /* __PINCTRL_SUNXI_H */
Commit	Line	Data
0e37f88d MR	1	/*
	2	* Allwinner A1X SoCs pinctrl driver.
	3	*
	4	* Copyright (C) 2012 Maxime Ripard
	5	*
	6	* Maxime Ripard <maxime.ripard@free-electrons.com>
	7	*
	8	* This file is licensed under the terms of the GNU General Public
	9	* License version 2. This program is licensed "as is" without any
	10	* warranty of any kind, whether express or implied.
	11	*/
	12
	13	#ifndef __PINCTRL_SUNXI_H
	14	#define __PINCTRL_SUNXI_H
	15
	16	#include <linux/kernel.h>
1bee963d	17	#include <linux/spinlock.h>
0e37f88d MR	18
	19	#define PA_BASE 0
	20	#define PB_BASE 32
	21	#define PC_BASE 64
	22	#define PD_BASE 96
	23	#define PE_BASE 128
	24	#define PF_BASE 160
	25	#define PG_BASE 192
9f5b6b30 MR	26	#define PH_BASE 224
9f5b6b30 MR	27	#define PI_BASE 256
0aba6178 BB	28	#define PL_BASE 352
0aba6178 BB	29	#define PM_BASE 384
0e37f88d	30
d10acc63 MR	31	#define SUNXI_PINCTRL_PIN(bank, pin) \
d10acc63 MR	32	PINCTRL_PIN(P ## bank ## _BASE + (pin), "P" #bank #pin)
0aba6178	33
08e9e614 MR	34	#define SUNXI_PIN_NAME_MAX_LEN 5
08e9e614 MR	35
0e37f88d MR	36	#define BANK_MEM_SIZE 0x24
0e37f88d MR	37	#define MUX_REGS_OFFSET 0x0
08e9e614	38	#define DATA_REGS_OFFSET 0x10
0e37f88d MR	39	#define DLEVEL_REGS_OFFSET 0x14
	40	#define PULL_REGS_OFFSET 0x1c
	41
	42	#define PINS_PER_BANK 32
	43	#define MUX_PINS_PER_REG 8
	44	#define MUX_PINS_BITS 4
	45	#define MUX_PINS_MASK 0x0f
08e9e614 MR	46	#define DATA_PINS_PER_REG 32
	47	#define DATA_PINS_BITS 1
	48	#define DATA_PINS_MASK 0x01
0e37f88d MR	49	#define DLEVEL_PINS_PER_REG 16
	50	#define DLEVEL_PINS_BITS 2
	51	#define DLEVEL_PINS_MASK 0x03
	52	#define PULL_PINS_PER_REG 16
	53	#define PULL_PINS_BITS 2
	54	#define PULL_PINS_MASK 0x03
	55
aebdc8ab	56	#define IRQ_PER_BANK 32
60242db1 MR	57
	58	#define IRQ_CFG_REG 0x200
	59	#define IRQ_CFG_IRQ_PER_REG 8
	60	#define IRQ_CFG_IRQ_BITS 4
	61	#define IRQ_CFG_IRQ_MASK ((1 << IRQ_CFG_IRQ_BITS) - 1)
	62	#define IRQ_CTRL_REG 0x210
	63	#define IRQ_CTRL_IRQ_PER_REG 32
	64	#define IRQ_CTRL_IRQ_BITS 1
	65	#define IRQ_CTRL_IRQ_MASK ((1 << IRQ_CTRL_IRQ_BITS) - 1)
	66	#define IRQ_STATUS_REG 0x214
	67	#define IRQ_STATUS_IRQ_PER_REG 32
	68	#define IRQ_STATUS_IRQ_BITS 1
	69	#define IRQ_STATUS_IRQ_MASK ((1 << IRQ_STATUS_IRQ_BITS) - 1)
	70
aebdc8ab MR	71	#define IRQ_MEM_SIZE 0x20
aebdc8ab MR	72
60242db1 MR	73	#define IRQ_EDGE_RISING 0x00
	74	#define IRQ_EDGE_FALLING 0x01
	75	#define IRQ_LEVEL_HIGH 0x02
	76	#define IRQ_LEVEL_LOW 0x03
	77	#define IRQ_EDGE_BOTH 0x04
	78
0e37f88d MR	79	struct sunxi_desc_function {
	80	const char *name;
	81	u8 muxval;
6e1c3023	82	u8 irqbank;
60242db1	83	u8 irqnum;
0e37f88d MR	84	};
	85
	86	struct sunxi_desc_pin {
	87	struct pinctrl_pin_desc pin;
	88	struct sunxi_desc_function *functions;
	89	};
	90
	91	struct sunxi_pinctrl_desc {
	92	const struct sunxi_desc_pin *pins;
	93	int npins;
d83c82ce	94	unsigned pin_base;
8966ada2	95	unsigned irq_banks;
0e37f88d MR	96	};
	97
	98	struct sunxi_pinctrl_function {
	99	const char *name;
	100	const char **groups;
	101	unsigned ngroups;
	102	};
	103
	104	struct sunxi_pinctrl_group {
	105	const char *name;
	106	unsigned long config;
	107	unsigned pin;
	108	};
	109
	110	struct sunxi_pinctrl {
	111	void __iomem *membase;
08e9e614	112	struct gpio_chip *chip;
d39bd845	113	const struct sunxi_pinctrl_desc *desc;
0e37f88d	114	struct device *dev;
60242db1	115	struct irq_domain *domain;
0e37f88d MR	116	struct sunxi_pinctrl_function *functions;
	117	unsigned nfunctions;
	118	struct sunxi_pinctrl_group *groups;
	119	unsigned ngroups;
aebdc8ab MR	120	int *irq;
aebdc8ab MR	121	unsigned *irq_array;
1bee963d	122	spinlock_t lock;
0e37f88d MR	123	struct pinctrl_dev *pctl_dev;
	124	};
	125
	126	#define SUNXI_PIN(_pin, ...) \
	127	{ \
	128	.pin = _pin, \
	129	.functions = (struct sunxi_desc_function[]){ \
	130	__VA_ARGS__, { } }, \
	131	}
	132
	133	#define SUNXI_FUNCTION(_val, _name) \
	134	{ \
	135	.name = _name, \
	136	.muxval = _val, \
	137	}
	138
60242db1 MR	139	#define SUNXI_FUNCTION_IRQ(_val, _irq) \
	140	{ \
	141	.name = "irq", \
	142	.muxval = _val, \
	143	.irqnum = _irq, \
	144	}
	145
6e1c3023 MR	146	#define SUNXI_FUNCTION_IRQ_BANK(_val, _bank, _irq) \
	147	{ \
	148	.name = "irq", \
	149	.muxval = _val, \
	150	.irqbank = _bank, \
	151	.irqnum = _irq, \
	152	}
	153
0e37f88d MR	154	/*
	155	* The sunXi PIO registers are organized as is:
	156	* 0x00 - 0x0c Muxing values.
	157	* 8 pins per register, each pin having a 4bits value
	158	* 0x10 Pin values
	159	* 32 bits per register, each pin corresponding to one bit
	160	* 0x14 - 0x18 Drive level
	161	* 16 pins per register, each pin having a 2bits value
	162	* 0x1c - 0x20 Pull-Up values
	163	* 16 pins per register, each pin having a 2bits value
	164	*
	165	* This is for the first bank. Each bank will have the same layout,
	166	* with an offset being a multiple of 0x24.
	167	*
	168	* The following functions calculate from the pin number the register
	169	* and the bit offset that we should access.
	170	*/
	171	static inline u32 sunxi_mux_reg(u16 pin)
	172	{
	173	u8 bank = pin / PINS_PER_BANK;
	174	u32 offset = bank * BANK_MEM_SIZE;
	175	offset += MUX_REGS_OFFSET;
	176	offset += pin % PINS_PER_BANK / MUX_PINS_PER_REG * 0x04;
	177	return round_down(offset, 4);
	178	}
	179
	180	static inline u32 sunxi_mux_offset(u16 pin)
	181	{
	182	u32 pin_num = pin % MUX_PINS_PER_REG;
	183	return pin_num * MUX_PINS_BITS;
	184	}
	185
08e9e614 MR	186	static inline u32 sunxi_data_reg(u16 pin)
	187	{
	188	u8 bank = pin / PINS_PER_BANK;
	189	u32 offset = bank * BANK_MEM_SIZE;
	190	offset += DATA_REGS_OFFSET;
	191	offset += pin % PINS_PER_BANK / DATA_PINS_PER_REG * 0x04;
	192	return round_down(offset, 4);
	193	}
	194
	195	static inline u32 sunxi_data_offset(u16 pin)
	196	{
	197	u32 pin_num = pin % DATA_PINS_PER_REG;
	198	return pin_num * DATA_PINS_BITS;
	199	}
	200
0e37f88d MR	201	static inline u32 sunxi_dlevel_reg(u16 pin)
	202	{
	203	u8 bank = pin / PINS_PER_BANK;
	204	u32 offset = bank * BANK_MEM_SIZE;
	205	offset += DLEVEL_REGS_OFFSET;
	206	offset += pin % PINS_PER_BANK / DLEVEL_PINS_PER_REG * 0x04;
	207	return round_down(offset, 4);
	208	}
	209
	210	static inline u32 sunxi_dlevel_offset(u16 pin)
	211	{
	212	u32 pin_num = pin % DLEVEL_PINS_PER_REG;
	213	return pin_num * DLEVEL_PINS_BITS;
	214	}
	215
	216	static inline u32 sunxi_pull_reg(u16 pin)
	217	{
	218	u8 bank = pin / PINS_PER_BANK;
	219	u32 offset = bank * BANK_MEM_SIZE;
	220	offset += PULL_REGS_OFFSET;
	221	offset += pin % PINS_PER_BANK / PULL_PINS_PER_REG * 0x04;
	222	return round_down(offset, 4);
	223	}
	224
	225	static inline u32 sunxi_pull_offset(u16 pin)
	226	{
	227	u32 pin_num = pin % PULL_PINS_PER_REG;
	228	return pin_num * PULL_PINS_BITS;
	229	}
	230
60242db1 MR	231	static inline u32 sunxi_irq_cfg_reg(u16 irq)
60242db1 MR	232	{
aebdc8ab MR	233	u8 bank = irq / IRQ_PER_BANK;
	234	u8 reg = (irq % IRQ_PER_BANK) / IRQ_CFG_IRQ_PER_REG * 0x04;
	235
	236	return IRQ_CFG_REG + bank * IRQ_MEM_SIZE + reg;
60242db1 MR	237	}
	238
	239	static inline u32 sunxi_irq_cfg_offset(u16 irq)
	240	{
	241	u32 irq_num = irq % IRQ_CFG_IRQ_PER_REG;
	242	return irq_num * IRQ_CFG_IRQ_BITS;
	243	}
	244
aebdc8ab MR	245	static inline u32 sunxi_irq_ctrl_reg_from_bank(u8 bank)
	246	{
	247	return IRQ_CTRL_REG + bank * IRQ_MEM_SIZE;
	248	}
	249
60242db1 MR	250	static inline u32 sunxi_irq_ctrl_reg(u16 irq)
60242db1 MR	251	{
aebdc8ab MR	252	u8 bank = irq / IRQ_PER_BANK;
	253
	254	return sunxi_irq_ctrl_reg_from_bank(bank);
60242db1 MR	255	}
	256
	257	static inline u32 sunxi_irq_ctrl_offset(u16 irq)
	258	{
	259	u32 irq_num = irq % IRQ_CTRL_IRQ_PER_REG;
	260	return irq_num * IRQ_CTRL_IRQ_BITS;
	261	}
	262
aebdc8ab MR	263	static inline u32 sunxi_irq_status_reg_from_bank(u8 bank)
	264	{
	265	return IRQ_STATUS_REG + bank * IRQ_MEM_SIZE;
	266	}
	267
60242db1 MR	268	static inline u32 sunxi_irq_status_reg(u16 irq)
60242db1 MR	269	{
aebdc8ab MR	270	u8 bank = irq / IRQ_PER_BANK;
	271
	272	return sunxi_irq_status_reg_from_bank(bank);
60242db1 MR	273	}
	274
	275	static inline u32 sunxi_irq_status_offset(u16 irq)
	276	{
	277	u32 irq_num = irq % IRQ_STATUS_IRQ_PER_REG;
	278	return irq_num * IRQ_STATUS_IRQ_BITS;
	279	}
	280
2284ba6b MR	281	int sunxi_pinctrl_init(struct platform_device *pdev,
	282	const struct sunxi_pinctrl_desc *desc);
	283
0e37f88d	284	#endif /* __PINCTRL_SUNXI_H */