[linux-2.6-block.git] / drivers / usb / gadget / udc / at91_udc.h

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (C) 2004 by Thomas Rathbone, HP Labs
 * Copyright (C) 2005 by Ivan Kokshaysky
 * Copyright (C) 2006 by SAN People
 *
 * 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 AT91_UDC_H
#define AT91_UDC_H

/*
 * USB Device Port (UDP) registers.
 * Based on AT91RM9200 datasheet revision E.
 */

#define AT91_UDP_FRM_NUM	0x00		/* Frame Number Register */
#define     AT91_UDP_NUM	(0x7ff <<  0)	/* Frame Number */
#define     AT91_UDP_FRM_ERR	(1     << 16)	/* Frame Error */
#define     AT91_UDP_FRM_OK	(1     << 17)	/* Frame OK */

#define AT91_UDP_GLB_STAT	0x04		/* Global State Register */
#define     AT91_UDP_FADDEN	(1 <<  0)	/* Function Address Enable */
#define     AT91_UDP_CONFG	(1 <<  1)	/* Configured */
#define     AT91_UDP_ESR	(1 <<  2)	/* Enable Send Resume */
#define     AT91_UDP_RSMINPR	(1 <<  3)	/* Resume has been sent */
#define     AT91_UDP_RMWUPE	(1 <<  4)	/* Remote Wake Up Enable */

#define AT91_UDP_FADDR		0x08		/* Function Address Register */
#define     AT91_UDP_FADD	(0x7f << 0)	/* Function Address Value */
#define     AT91_UDP_FEN	(1    << 8)	/* Function Enable */

#define AT91_UDP_IER		0x10		/* Interrupt Enable Register */
#define AT91_UDP_IDR		0x14		/* Interrupt Disable Register */
#define AT91_UDP_IMR		0x18		/* Interrupt Mask Register */

#define AT91_UDP_ISR		0x1c		/* Interrupt Status Register */
#define     AT91_UDP_EP(n)	(1 << (n))	/* Endpoint Interrupt Status */
#define     AT91_UDP_RXSUSP	(1 <<  8) 	/* USB Suspend Interrupt Status */
#define     AT91_UDP_RXRSM	(1 <<  9)	/* USB Resume Interrupt Status */
#define     AT91_UDP_EXTRSM	(1 << 10)	/* External Resume Interrupt Status [AT91RM9200 only] */
#define     AT91_UDP_SOFINT	(1 << 11)	/* Start of Frame Interrupt Status */
#define     AT91_UDP_ENDBUSRES	(1 << 12)	/* End of Bus Reset Interrupt Status */
#define     AT91_UDP_WAKEUP	(1 << 13)	/* USB Wakeup Interrupt Status [AT91RM9200 only] */

#define AT91_UDP_ICR		0x20		/* Interrupt Clear Register */
#define AT91_UDP_RST_EP		0x28		/* Reset Endpoint Register */

#define AT91_UDP_CSR(n)		(0x30+((n)*4))	/* Endpoint Control/Status Registers 0-7 */
#define     AT91_UDP_TXCOMP	(1 <<  0)	/* Generates IN packet with data previously written in DPR */
#define     AT91_UDP_RX_DATA_BK0 (1 <<  1)	/* Receive Data Bank 0 */
#define     AT91_UDP_RXSETUP	(1 <<  2)	/* Send STALL to the host */
#define     AT91_UDP_STALLSENT	(1 <<  3)	/* Stall Sent / Isochronous error (Isochronous endpoints) */
#define     AT91_UDP_TXPKTRDY	(1 <<  4)	/* Transmit Packet Ready */
#define     AT91_UDP_FORCESTALL	(1 <<  5)	/* Force Stall */
#define     AT91_UDP_RX_DATA_BK1 (1 <<  6)	/* Receive Data Bank 1 */
#define     AT91_UDP_DIR	(1 <<  7)	/* Transfer Direction */
#define     AT91_UDP_EPTYPE	(7 <<  8)	/* Endpoint Type */
#define		AT91_UDP_EPTYPE_CTRL		(0 <<  8)
#define		AT91_UDP_EPTYPE_ISO_OUT		(1 <<  8)
#define		AT91_UDP_EPTYPE_BULK_OUT	(2 <<  8)
#define		AT91_UDP_EPTYPE_INT_OUT		(3 <<  8)
#define		AT91_UDP_EPTYPE_ISO_IN		(5 <<  8)
#define		AT91_UDP_EPTYPE_BULK_IN		(6 <<  8)
#define		AT91_UDP_EPTYPE_INT_IN		(7 <<  8)
#define     AT91_UDP_DTGLE	(1 << 11)	/* Data Toggle */
#define     AT91_UDP_EPEDS	(1 << 15)	/* Endpoint Enable/Disable */
#define     AT91_UDP_RXBYTECNT	(0x7ff << 16)	/* Number of bytes in FIFO */

#define AT91_UDP_FDR(n)		(0x50+((n)*4))	/* Endpoint FIFO Data Registers 0-7 */

#define AT91_UDP_TXVC		0x74		/* Transceiver Control Register */
#define     AT91_UDP_TXVC_TXVDIS (1 << 8)	/* Transceiver Disable */
#define     AT91_UDP_TXVC_PUON   (1 << 9)	/* PullUp On [AT91SAM9260 only] */

/*-------------------------------------------------------------------------*/

/*
 * controller driver data structures
 */

#define	NUM_ENDPOINTS	6

/*
 * hardware won't disable bus reset, or resume while the controller
 * is suspended ... watching suspend helps keep the logic symmetric.
 */
#define	MINIMUS_INTERRUPTUS \
	(AT91_UDP_ENDBUSRES | AT91_UDP_RXRSM | AT91_UDP_RXSUSP)

struct at91_ep {
	struct usb_ep			ep;
	struct list_head		queue;
	struct at91_udc			*udc;
	void __iomem			*creg;

	unsigned			maxpacket:16;
	u8				int_mask;
	unsigned			is_pingpong:1;

	unsigned			stopped:1;
	unsigned			is_in:1;
	unsigned			is_iso:1;
	unsigned			fifo_bank:1;
};

struct at91_udc_caps {
	int (*init)(struct at91_udc *udc);
	void (*pullup)(struct at91_udc *udc, int is_on);
};

struct at91_udc_data {
	int	vbus_pin;		/* high == host powering us */
	u8	vbus_active_low;	/* vbus polarity */
	u8	vbus_polled;		/* Use polling, not interrupt */
	int	pullup_pin;		/* active == D+ pulled up */
	u8	pullup_active_low;	/* true == pullup_pin is active low */
};

/*
 * driver is non-SMP, and just blocks IRQs whenever it needs
 * access protection for chip registers or driver state
 */
struct at91_udc {
	struct usb_gadget		gadget;
	struct at91_ep			ep[NUM_ENDPOINTS];
	struct usb_gadget_driver	*driver;
	const struct at91_udc_caps	*caps;
	unsigned			vbus:1;
	unsigned			enabled:1;
	unsigned			clocked:1;
	unsigned			suspended:1;
	unsigned			req_pending:1;
	unsigned			wait_for_addr_ack:1;
	unsigned			wait_for_config_ack:1;
	unsigned			active_suspend:1;
	u8				addr;
	struct at91_udc_data		board;
	struct clk			*iclk, *fclk;
	struct platform_device		*pdev;
	struct proc_dir_entry		*pde;
	void __iomem			*udp_baseaddr;
	int				udp_irq;
	spinlock_t			lock;
	struct timer_list		vbus_timer;
	struct work_struct		vbus_timer_work;
	struct regmap			*matrix;
};

static inline struct at91_udc *to_udc(struct usb_gadget *g)
{
	return container_of(g, struct at91_udc, gadget);
}

struct at91_request {
	struct usb_request		req;
	struct list_head		queue;
};

/*-------------------------------------------------------------------------*/

#ifdef VERBOSE_DEBUG
#    define VDBG		DBG
#else
#    define VDBG(stuff...)	do{}while(0)
#endif

#ifdef PACKET_TRACE
#    define PACKET		VDBG
#else
#    define PACKET(stuff...)	do{}while(0)
#endif

#define ERR(stuff...)		pr_err("udc: " stuff)
#define WARNING(stuff...)	pr_warn("udc: " stuff)
#define INFO(stuff...)		pr_info("udc: " stuff)
#define DBG(stuff...)		pr_debug("udc: " stuff)

#endif
Commit	Line	Data
5fd54ace	1	// SPDX-License-Identifier: GPL-2.0+
bae4bd84 DB	2	/*
	3	* Copyright (C) 2004 by Thomas Rathbone, HP Labs
	4	* Copyright (C) 2005 by Ivan Kokshaysky
	5	* Copyright (C) 2006 by SAN People
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
bae4bd84 DB	11	*/
	12
	13	#ifndef AT91_UDC_H
	14	#define AT91_UDC_H
	15
	16	/*
	17	* USB Device Port (UDP) registers.
	18	* Based on AT91RM9200 datasheet revision E.
	19	*/
	20
	21	#define AT91_UDP_FRM_NUM 0x00 /* Frame Number Register */
	22	#define AT91_UDP_NUM (0x7ff << 0) /* Frame Number */
	23	#define AT91_UDP_FRM_ERR (1 << 16) /* Frame Error */
	24	#define AT91_UDP_FRM_OK (1 << 17) /* Frame OK */
	25
	26	#define AT91_UDP_GLB_STAT 0x04 /* Global State Register */
	27	#define AT91_UDP_FADDEN (1 << 0) /* Function Address Enable */
	28	#define AT91_UDP_CONFG (1 << 1) /* Configured */
	29	#define AT91_UDP_ESR (1 << 2) /* Enable Send Resume */
	30	#define AT91_UDP_RSMINPR (1 << 3) /* Resume has been sent */
	31	#define AT91_UDP_RMWUPE (1 << 4) /* Remote Wake Up Enable */
	32
	33	#define AT91_UDP_FADDR 0x08 /* Function Address Register */
	34	#define AT91_UDP_FADD (0x7f << 0) /* Function Address Value */
	35	#define AT91_UDP_FEN (1 << 8) /* Function Enable */
	36
	37	#define AT91_UDP_IER 0x10 /* Interrupt Enable Register */
	38	#define AT91_UDP_IDR 0x14 /* Interrupt Disable Register */
	39	#define AT91_UDP_IMR 0x18 /* Interrupt Mask Register */
	40
	41	#define AT91_UDP_ISR 0x1c /* Interrupt Status Register */
	42	#define AT91_UDP_EP(n) (1 << (n)) /* Endpoint Interrupt Status */
	43	#define AT91_UDP_RXSUSP (1 << 8) /* USB Suspend Interrupt Status */
	44	#define AT91_UDP_RXRSM (1 << 9) /* USB Resume Interrupt Status */
29ba4b53	45	#define AT91_UDP_EXTRSM (1 << 10) /* External Resume Interrupt Status [AT91RM9200 only] */
bae4bd84	46	#define AT91_UDP_SOFINT (1 << 11) /* Start of Frame Interrupt Status */
dc0d5c1e	47	#define AT91_UDP_ENDBUSRES (1 << 12) /* End of Bus Reset Interrupt Status */
29ba4b53	48	#define AT91_UDP_WAKEUP (1 << 13) /* USB Wakeup Interrupt Status [AT91RM9200 only] */
bae4bd84 DB	49
	50	#define AT91_UDP_ICR 0x20 /* Interrupt Clear Register */
	51	#define AT91_UDP_RST_EP 0x28 /* Reset Endpoint Register */
	52
	53	#define AT91_UDP_CSR(n) (0x30+((n)4)) / Endpoint Control/Status Registers 0-7 */
	54	#define AT91_UDP_TXCOMP (1 << 0) /* Generates IN packet with data previously written in DPR */
	55	#define AT91_UDP_RX_DATA_BK0 (1 << 1) /* Receive Data Bank 0 */
	56	#define AT91_UDP_RXSETUP (1 << 2) /* Send STALL to the host */
	57	#define AT91_UDP_STALLSENT (1 << 3) /* Stall Sent / Isochronous error (Isochronous endpoints) */
	58	#define AT91_UDP_TXPKTRDY (1 << 4) /* Transmit Packet Ready */
	59	#define AT91_UDP_FORCESTALL (1 << 5) /* Force Stall */
	60	#define AT91_UDP_RX_DATA_BK1 (1 << 6) /* Receive Data Bank 1 */
	61	#define AT91_UDP_DIR (1 << 7) /* Transfer Direction */
	62	#define AT91_UDP_EPTYPE (7 << 8) /* Endpoint Type */
	63	#define AT91_UDP_EPTYPE_CTRL (0 << 8)
	64	#define AT91_UDP_EPTYPE_ISO_OUT (1 << 8)
	65	#define AT91_UDP_EPTYPE_BULK_OUT (2 << 8)
	66	#define AT91_UDP_EPTYPE_INT_OUT (3 << 8)
	67	#define AT91_UDP_EPTYPE_ISO_IN (5 << 8)
	68	#define AT91_UDP_EPTYPE_BULK_IN (6 << 8)
	69	#define AT91_UDP_EPTYPE_INT_IN (7 << 8)
	70	#define AT91_UDP_DTGLE (1 << 11) /* Data Toggle */
	71	#define AT91_UDP_EPEDS (1 << 15) /* Endpoint Enable/Disable */
	72	#define AT91_UDP_RXBYTECNT (0x7ff << 16) /* Number of bytes in FIFO */
	73
	74	#define AT91_UDP_FDR(n) (0x50+((n)4)) / Endpoint FIFO Data Registers 0-7 */
	75
	76	#define AT91_UDP_TXVC 0x74 /* Transceiver Control Register */
	77	#define AT91_UDP_TXVC_TXVDIS (1 << 8) /* Transceiver Disable */
29ba4b53	78	#define AT91_UDP_TXVC_PUON (1 << 9) /* PullUp On [AT91SAM9260 only] */
bae4bd84 DB	79
	80	/-------------------------------------------------------------------------/
	81
	82	/*
	83	* controller driver data structures
	84	*/
	85
	86	#define NUM_ENDPOINTS 6
	87
	88	/*
	89	* hardware won't disable bus reset, or resume while the controller
	90	* is suspended ... watching suspend helps keep the logic symmetric.
	91	*/
	92	#define MINIMUS_INTERRUPTUS \
	93	(AT91_UDP_ENDBUSRES \| AT91_UDP_RXRSM \| AT91_UDP_RXSUSP)
	94
	95	struct at91_ep {
	96	struct usb_ep ep;
	97	struct list_head queue;
	98	struct at91_udc *udc;
	99	void __iomem *creg;
	100
	101	unsigned maxpacket:16;
	102	u8 int_mask;
	103	unsigned is_pingpong:1;
	104
	105	unsigned stopped:1;
	106	unsigned is_in:1;
	107	unsigned is_iso:1;
	108	unsigned fifo_bank:1;
bae4bd84 DB	109	};
bae4bd84 DB	110
f0bceab4 BB	111	struct at91_udc_caps {
	112	int (init)(struct at91_udc udc);
	113	void (pullup)(struct at91_udc udc, int is_on);
	114	};
	115
428163d7 AB	116	struct at91_udc_data {
	117	int vbus_pin; /* high == host powering us */
	118	u8 vbus_active_low; /* vbus polarity */
	119	u8 vbus_polled; /* Use polling, not interrupt */
	120	int pullup_pin; /* active == D+ pulled up */
	121	u8 pullup_active_low; /* true == pullup_pin is active low */
	122	};
	123
bae4bd84 DB	124	/*
	125	* driver is non-SMP, and just blocks IRQs whenever it needs
	126	* access protection for chip registers or driver state
	127	*/
	128	struct at91_udc {
	129	struct usb_gadget gadget;
	130	struct at91_ep ep[NUM_ENDPOINTS];
	131	struct usb_gadget_driver *driver;
f0bceab4	132	const struct at91_udc_caps *caps;
bae4bd84 DB	133	unsigned vbus:1;
	134	unsigned enabled:1;
	135	unsigned clocked:1;
	136	unsigned suspended:1;
	137	unsigned req_pending:1;
	138	unsigned wait_for_addr_ack:1;
	139	unsigned wait_for_config_ack:1;
66e56ce7	140	unsigned active_suspend:1;
bae4bd84 DB	141	u8 addr;
bae4bd84 DB	142	struct at91_udc_data board;
9aa02165	143	struct clk iclk, fclk;
bae4bd84 DB	144	struct platform_device *pdev;
bae4bd84 DB	145	struct proc_dir_entry *pde;
ffd3326b	146	void __iomem *udp_baseaddr;
8b2e7668	147	int udp_irq;
4f4c5e36	148	spinlock_t lock;
4037242c RM	149	struct timer_list vbus_timer;
4037242c RM	150	struct work_struct vbus_timer_work;
f0bceab4	151	struct regmap *matrix;
bae4bd84 DB	152	};
	153
	154	static inline struct at91_udc to_udc(struct usb_gadget g)
	155	{
	156	return container_of(g, struct at91_udc, gadget);
	157	}
	158
	159	struct at91_request {
	160	struct usb_request req;
	161	struct list_head queue;
	162	};
	163
	164	/-------------------------------------------------------------------------/
	165
f3db6e82	166	#ifdef VERBOSE_DEBUG
bae4bd84 DB	167	# define VDBG DBG
	168	#else
	169	# define VDBG(stuff...) do{}while(0)
	170	#endif
	171
	172	#ifdef PACKET_TRACE
	173	# define PACKET VDBG
	174	#else
	175	# define PACKET(stuff...) do{}while(0)
	176	#endif
	177
00274921	178	#define ERR(stuff...) pr_err("udc: " stuff)
a4e6a852	179	#define WARNING(stuff...) pr_warn("udc: " stuff)
00274921 DB	180	#define INFO(stuff...) pr_info("udc: " stuff)
00274921 DB	181	#define DBG(stuff...) pr_debug("udc: " stuff)
bae4bd84 DB	182
	183	#endif
	184