[linux-2.6-block.git] / drivers / usb / musb / musb_core.h

/*
 * MUSB OTG driver defines
 *
 * Copyright 2005 Mentor Graphics Corporation
 * Copyright (C) 2005-2006 by Texas Instruments
 * Copyright (C) 2006-2007 Nokia Corporation
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef __MUSB_CORE_H__
#define __MUSB_CORE_H__

#include <linux/slab.h>
#include <linux/list.h>
#include <linux/interrupt.h>
#include <linux/smp_lock.h>
#include <linux/errno.h>
#include <linux/timer.h>
#include <linux/clk.h>
#include <linux/device.h>
#include <linux/usb/ch9.h>
#include <linux/usb/gadget.h>
#include <linux/usb.h>
#include <linux/usb/otg.h>
#include <linux/usb/musb.h>

struct musb;
struct musb_hw_ep;
struct musb_ep;


#include "musb_debug.h"
#include "musb_dma.h"

#include "musb_io.h"
#include "musb_regs.h"

#include "musb_gadget.h"
#include "../core/hcd.h"
#include "musb_host.h"


#ifdef CONFIG_USB_MUSB_OTG

#define	is_peripheral_enabled(musb)	((musb)->board_mode != MUSB_HOST)
#define	is_host_enabled(musb)		((musb)->board_mode != MUSB_PERIPHERAL)
#define	is_otg_enabled(musb)		((musb)->board_mode == MUSB_OTG)

/* NOTE:  otg and peripheral-only state machines start at B_IDLE.
 * OTG or host-only go to A_IDLE when ID is sensed.
 */
#define is_peripheral_active(m)		(!(m)->is_host)
#define is_host_active(m)		((m)->is_host)

#else
#define	is_peripheral_enabled(musb)	is_peripheral_capable()
#define	is_host_enabled(musb)		is_host_capable()
#define	is_otg_enabled(musb)		0

#define	is_peripheral_active(musb)	is_peripheral_capable()
#define	is_host_active(musb)		is_host_capable()
#endif

#if defined(CONFIG_USB_MUSB_OTG) || defined(CONFIG_USB_MUSB_PERIPHERAL)
/* for some reason, the "select USB_GADGET_MUSB_HDRC" doesn't always
 * override that choice selection (often USB_GADGET_DUMMY_HCD).
 */
#ifndef CONFIG_USB_GADGET_MUSB_HDRC
#error bogus Kconfig output ... select CONFIG_USB_GADGET_MUSB_HDRC
#endif
#endif	/* need MUSB gadget selection */


#ifdef CONFIG_PROC_FS
#include <linux/fs.h>
#define MUSB_CONFIG_PROC_FS
#endif

/****************************** PERIPHERAL ROLE *****************************/

#ifdef CONFIG_USB_GADGET_MUSB_HDRC

#define	is_peripheral_capable()	(1)

extern irqreturn_t musb_g_ep0_irq(struct musb *);
extern void musb_g_tx(struct musb *, u8);
extern void musb_g_rx(struct musb *, u8);
extern void musb_g_reset(struct musb *);
extern void musb_g_suspend(struct musb *);
extern void musb_g_resume(struct musb *);
extern void musb_g_wakeup(struct musb *);
extern void musb_g_disconnect(struct musb *);

#else

#define	is_peripheral_capable()	(0)

static inline irqreturn_t musb_g_ep0_irq(struct musb *m) { return IRQ_NONE; }
static inline void musb_g_reset(struct musb *m) {}
static inline void musb_g_suspend(struct musb *m) {}
static inline void musb_g_resume(struct musb *m) {}
static inline void musb_g_wakeup(struct musb *m) {}
static inline void musb_g_disconnect(struct musb *m) {}

#endif

/****************************** HOST ROLE ***********************************/

#ifdef CONFIG_USB_MUSB_HDRC_HCD

#define	is_host_capable()	(1)

extern irqreturn_t musb_h_ep0_irq(struct musb *);
extern void musb_host_tx(struct musb *, u8);
extern void musb_host_rx(struct musb *, u8);

#else

#define	is_host_capable()	(0)

static inline irqreturn_t musb_h_ep0_irq(struct musb *m) { return IRQ_NONE; }
static inline void musb_host_tx(struct musb *m, u8 e) {}
static inline void musb_host_rx(struct musb *m, u8 e) {}

#endif


/****************************** CONSTANTS ********************************/

#ifndef MUSB_C_NUM_EPS
#define MUSB_C_NUM_EPS ((u8)16)
#endif

#ifndef MUSB_MAX_END0_PACKET
#define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
#endif

/* host side ep0 states */
enum musb_h_ep0_state {
	MUSB_EP0_IDLE,
	MUSB_EP0_START,			/* expect ack of setup */
	MUSB_EP0_IN,			/* expect IN DATA */
	MUSB_EP0_OUT,			/* expect ack of OUT DATA */
	MUSB_EP0_STATUS,		/* expect ack of STATUS */
} __attribute__ ((packed));

/* peripheral side ep0 states */
enum musb_g_ep0_state {
	MUSB_EP0_STAGE_IDLE,		/* idle, waiting for SETUP */
	MUSB_EP0_STAGE_SETUP,		/* received SETUP */
	MUSB_EP0_STAGE_TX,		/* IN data */
	MUSB_EP0_STAGE_RX,		/* OUT data */
	MUSB_EP0_STAGE_STATUSIN,	/* (after OUT data) */
	MUSB_EP0_STAGE_STATUSOUT,	/* (after IN data) */
	MUSB_EP0_STAGE_ACKWAIT,		/* after zlp, before statusin */
} __attribute__ ((packed));

/*
 * OTG protocol constants.  See USB OTG 1.3 spec,
 * sections 5.5 "Device Timings" and 6.6.5 "Timers".
 */
#define OTG_TIME_A_WAIT_VRISE	100		/* msec (max) */
#define OTG_TIME_A_WAIT_BCON	1100		/* min 1 second */
#define OTG_TIME_A_AIDL_BDIS	200		/* min 200 msec */
#define OTG_TIME_B_ASE0_BRST	100		/* min 3.125 ms */


/*************************** REGISTER ACCESS ********************************/

/* Endpoint registers (other than dynfifo setup) can be accessed either
 * directly with the "flat" model, or after setting up an index register.
 */

#if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_ARCH_OMAP2430) \
		|| defined(CONFIG_ARCH_OMAP3430) || defined(CONFIG_BLACKFIN)
/* REVISIT indexed access seemed to
 * misbehave (on DaVinci) for at least peripheral IN ...
 */
#define	MUSB_FLAT_REG
#endif

/* TUSB mapping: "flat" plus ep0 special cases */
#if	defined(CONFIG_USB_TUSB6010)
#define musb_ep_select(_mbase, _epnum) \
	musb_writeb((_mbase), MUSB_INDEX, (_epnum))
#define	MUSB_EP_OFFSET			MUSB_TUSB_OFFSET

/* "flat" mapping: each endpoint has its own i/o address */
#elif	defined(MUSB_FLAT_REG)
#define musb_ep_select(_mbase, _epnum)	(((void)(_mbase)), ((void)(_epnum)))
#define	MUSB_EP_OFFSET			MUSB_FLAT_OFFSET

/* "indexed" mapping: INDEX register controls register bank select */
#else
#define musb_ep_select(_mbase, _epnum) \
	musb_writeb((_mbase), MUSB_INDEX, (_epnum))
#define	MUSB_EP_OFFSET			MUSB_INDEXED_OFFSET
#endif

/****************************** FUNCTIONS ********************************/

#define MUSB_HST_MODE(_musb)\
	{ (_musb)->is_host = true; }
#define MUSB_DEV_MODE(_musb) \
	{ (_musb)->is_host = false; }

#define test_devctl_hst_mode(_x) \
	(musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)

#define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")

/******************************** TYPES *************************************/

/*
 * struct musb_hw_ep - endpoint hardware (bidirectional)
 *
 * Ordered slightly for better cacheline locality.
 */
struct musb_hw_ep {
	struct musb		*musb;
	void __iomem		*fifo;
	void __iomem		*regs;

#ifdef CONFIG_USB_TUSB6010
	void __iomem		*conf;
#endif

	/* index in musb->endpoints[]  */
	u8			epnum;

	/* hardware configuration, possibly dynamic */
	bool			is_shared_fifo;
	bool			tx_double_buffered;
	bool			rx_double_buffered;
	u16			max_packet_sz_tx;
	u16			max_packet_sz_rx;

	struct dma_channel	*tx_channel;
	struct dma_channel	*rx_channel;

#ifdef CONFIG_USB_TUSB6010
	/* TUSB has "asynchronous" and "synchronous" dma modes */
	dma_addr_t		fifo_async;
	dma_addr_t		fifo_sync;
	void __iomem		*fifo_sync_va;
#endif

#ifdef CONFIG_USB_MUSB_HDRC_HCD
	void __iomem		*target_regs;

	/* currently scheduled peripheral endpoint */
	struct musb_qh		*in_qh;
	struct musb_qh		*out_qh;

	u8			rx_reinit;
	u8			tx_reinit;
#endif

#ifdef CONFIG_USB_GADGET_MUSB_HDRC
	/* peripheral side */
	struct musb_ep		ep_in;			/* TX */
	struct musb_ep		ep_out;			/* RX */
#endif
};

static inline struct usb_request *next_in_request(struct musb_hw_ep *hw_ep)
{
#ifdef CONFIG_USB_GADGET_MUSB_HDRC
	return next_request(&hw_ep->ep_in);
#else
	return NULL;
#endif
}

static inline struct usb_request *next_out_request(struct musb_hw_ep *hw_ep)
{
#ifdef CONFIG_USB_GADGET_MUSB_HDRC
	return next_request(&hw_ep->ep_out);
#else
	return NULL;
#endif
}

/*
 * struct musb - Driver instance data.
 */
struct musb {
	/* device lock */
	spinlock_t		lock;
	struct clk		*clock;
	irqreturn_t		(*isr)(int, void *);
	struct work_struct	irq_work;

/* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
#define MUSB_PORT_STAT_RESUME	(1 << 31)

	u32			port1_status;

#ifdef CONFIG_USB_MUSB_HDRC_HCD
	unsigned long		rh_timer;

	enum musb_h_ep0_state	ep0_stage;

	/* bulk traffic normally dedicates endpoint hardware, and each
	 * direction has its own ring of host side endpoints.
	 * we try to progress the transfer at the head of each endpoint's
	 * queue until it completes or NAKs too much; then we try the next
	 * endpoint.
	 */
	struct musb_hw_ep	*bulk_ep;

	struct list_head	control;	/* of musb_qh */
	struct list_head	in_bulk;	/* of musb_qh */
	struct list_head	out_bulk;	/* of musb_qh */

	struct timer_list	otg_timer;
#endif

	/* called with IRQs blocked; ON/nonzero implies starting a session,
	 * and waiting at least a_wait_vrise_tmout.
	 */
	void			(*board_set_vbus)(struct musb *, int is_on);

	struct dma_controller	*dma_controller;

	struct device		*controller;
	void __iomem		*ctrl_base;
	void __iomem		*mregs;

#ifdef CONFIG_USB_TUSB6010
	dma_addr_t		async;
	dma_addr_t		sync;
	void __iomem		*sync_va;
#endif

	/* passed down from chip/board specific irq handlers */
	u8			int_usb;
	u16			int_rx;
	u16			int_tx;

	struct otg_transceiver	*xceiv;

	int nIrq;
	unsigned		irq_wake:1;

	struct musb_hw_ep	 endpoints[MUSB_C_NUM_EPS];
#define control_ep		endpoints

#define VBUSERR_RETRY_COUNT	3
	u16			vbuserr_retry;
	u16 epmask;
	u8 nr_endpoints;

	u8 board_mode;		/* enum musb_mode */
	int			(*board_set_power)(int state);

	int			(*set_clock)(struct clk *clk, int is_active);

	u8			min_power;	/* vbus for periph, in mA/2 */

	bool			is_host;

	int			a_wait_bcon;	/* VBUS timeout in msecs */
	unsigned long		idle_timeout;	/* Next timeout in jiffies */

	/* active means connected and not suspended */
	unsigned		is_active:1;

	unsigned is_multipoint:1;
	unsigned ignore_disconnect:1;	/* during bus resets */

#ifdef C_MP_TX
	unsigned bulk_split:1;
#define	can_bulk_split(musb,type) \
		(((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
#else
#define	can_bulk_split(musb, type)	0
#endif

#ifdef C_MP_RX
	unsigned bulk_combine:1;
#define	can_bulk_combine(musb,type) \
		(((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
#else
#define	can_bulk_combine(musb, type)	0
#endif

#ifdef CONFIG_USB_GADGET_MUSB_HDRC
	/* is_suspended means USB B_PERIPHERAL suspend */
	unsigned		is_suspended:1;

	/* may_wakeup means remote wakeup is enabled */
	unsigned		may_wakeup:1;

	/* is_self_powered is reported in device status and the
	 * config descriptor.  is_bus_powered means B_PERIPHERAL
	 * draws some VBUS current; both can be true.
	 */
	unsigned		is_self_powered:1;
	unsigned		is_bus_powered:1;

	unsigned		set_address:1;
	unsigned		test_mode:1;
	unsigned		softconnect:1;

	u8			address;
	u8			test_mode_nr;
	u16			ackpend;		/* ep0 */
	enum musb_g_ep0_state	ep0_state;
	struct usb_gadget	g;			/* the gadget */
	struct usb_gadget_driver *gadget_driver;	/* its driver */
#endif

	struct musb_hdrc_config	*config;

#ifdef MUSB_CONFIG_PROC_FS
	struct proc_dir_entry *proc_entry;
#endif
};

static inline void musb_set_vbus(struct musb *musb, int is_on)
{
	musb->board_set_vbus(musb, is_on);
}

#ifdef CONFIG_USB_GADGET_MUSB_HDRC
static inline struct musb *gadget_to_musb(struct usb_gadget *g)
{
	return container_of(g, struct musb, g);
}
#endif

#ifdef CONFIG_BLACKFIN
static inline int musb_read_fifosize(struct musb *musb,
		struct musb_hw_ep *hw_ep, u8 epnum)
{
	musb->nr_endpoints++;
	musb->epmask |= (1 << epnum);

	if (epnum < 5) {
		hw_ep->max_packet_sz_tx = 128;
		hw_ep->max_packet_sz_rx = 128;
	} else {
		hw_ep->max_packet_sz_tx = 1024;
		hw_ep->max_packet_sz_rx = 1024;
	}
	hw_ep->is_shared_fifo = false;

	return 0;
}

static inline void musb_configure_ep0(struct musb *musb)
{
	musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
	musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
	musb->endpoints[0].is_shared_fifo = true;
}

#else

static inline int musb_read_fifosize(struct musb *musb,
		struct musb_hw_ep *hw_ep, u8 epnum)
{
	void *mbase = musb->mregs;
	u8 reg = 0;

	/* read from core using indexed model */
	reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE));
	/* 0's returned when no more endpoints */
	if (!reg)
		return -ENODEV;

	musb->nr_endpoints++;
	musb->epmask |= (1 << epnum);

	hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);

	/* shared TX/RX FIFO? */
	if ((reg & 0xf0) == 0xf0) {
		hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
		hw_ep->is_shared_fifo = true;
		return 0;
	} else {
		hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
		hw_ep->is_shared_fifo = false;
	}

	return 0;
}

static inline void musb_configure_ep0(struct musb *musb)
{
	musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
	musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
	musb->endpoints[0].is_shared_fifo = true;
}
#endif /* CONFIG_BLACKFIN */


/***************************** Glue it together *****************************/

extern const char musb_driver_name[];

extern void musb_start(struct musb *musb);
extern void musb_stop(struct musb *musb);

extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);

extern void musb_load_testpacket(struct musb *);

extern irqreturn_t musb_interrupt(struct musb *);

extern void musb_platform_enable(struct musb *musb);
extern void musb_platform_disable(struct musb *musb);

extern void musb_hnp_stop(struct musb *musb);

extern int musb_platform_set_mode(struct musb *musb, u8 musb_mode);

#if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN) || \
	defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP34XX)
extern void musb_platform_try_idle(struct musb *musb, unsigned long timeout);
#else
#define musb_platform_try_idle(x, y)		do {} while (0)
#endif

#if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN)
extern int musb_platform_get_vbus_status(struct musb *musb);
#else
#define musb_platform_get_vbus_status(x)	0
#endif

extern int __init musb_platform_init(struct musb *musb);
extern int musb_platform_exit(struct musb *musb);

#endif	/* __MUSB_CORE_H__ */
Commit	Line	Data
550a7375 FB	1	/*
	2	* MUSB OTG driver defines
	3	*
	4	* Copyright 2005 Mentor Graphics Corporation
	5	* Copyright (C) 2005-2006 by Texas Instruments
	6	* Copyright (C) 2006-2007 Nokia Corporation
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License
	10	* version 2 as published by the Free Software Foundation.
	11	*
	12	* This program is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
	20	* 02110-1301 USA
	21	*
	22	* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
	23	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
	24	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
	25	* NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
	26	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	27	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	28	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
	29	* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	30	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	31	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	32	*
	33	*/
	34
	35	#ifndef __MUSB_CORE_H__
	36	#define __MUSB_CORE_H__
	37
	38	#include <linux/slab.h>
	39	#include <linux/list.h>
	40	#include <linux/interrupt.h>
	41	#include <linux/smp_lock.h>
	42	#include <linux/errno.h>
f7f9d63e	43	#include <linux/timer.h>
550a7375 FB	44	#include <linux/clk.h>
	45	#include <linux/device.h>
	46	#include <linux/usb/ch9.h>
	47	#include <linux/usb/gadget.h>
	48	#include <linux/usb.h>
	49	#include <linux/usb/otg.h>
	50	#include <linux/usb/musb.h>
	51
	52	struct musb;
	53	struct musb_hw_ep;
	54	struct musb_ep;
	55
	56
	57	#include "musb_debug.h"
	58	#include "musb_dma.h"
	59
550a7375 FB	60	#include "musb_io.h"
	61	#include "musb_regs.h"
	62
	63	#include "musb_gadget.h"
	64	#include "../core/hcd.h"
	65	#include "musb_host.h"
	66
	67
	68
	69	#ifdef CONFIG_USB_MUSB_OTG
	70
	71	#define is_peripheral_enabled(musb) ((musb)->board_mode != MUSB_HOST)
	72	#define is_host_enabled(musb) ((musb)->board_mode != MUSB_PERIPHERAL)
	73	#define is_otg_enabled(musb) ((musb)->board_mode == MUSB_OTG)
	74
	75	/* NOTE: otg and peripheral-only state machines start at B_IDLE.
	76	* OTG or host-only go to A_IDLE when ID is sensed.
	77	*/
	78	#define is_peripheral_active(m) (!(m)->is_host)
	79	#define is_host_active(m) ((m)->is_host)
	80
	81	#else
	82	#define is_peripheral_enabled(musb) is_peripheral_capable()
	83	#define is_host_enabled(musb) is_host_capable()
	84	#define is_otg_enabled(musb) 0
	85
	86	#define is_peripheral_active(musb) is_peripheral_capable()
	87	#define is_host_active(musb) is_host_capable()
	88	#endif
	89
	90	#if defined(CONFIG_USB_MUSB_OTG) \|\| defined(CONFIG_USB_MUSB_PERIPHERAL)
	91	/* for some reason, the "select USB_GADGET_MUSB_HDRC" doesn't always
	92	* override that choice selection (often USB_GADGET_DUMMY_HCD).
	93	*/
	94	#ifndef CONFIG_USB_GADGET_MUSB_HDRC
	95	#error bogus Kconfig output ... select CONFIG_USB_GADGET_MUSB_HDRC
	96	#endif
	97	#endif /* need MUSB gadget selection */
	98
	99
	100	#ifdef CONFIG_PROC_FS
	101	#include <linux/fs.h>
	102	#define MUSB_CONFIG_PROC_FS
	103	#endif
	104
	105	/**************************** PERIPHERAL ROLE ***************************/
	106
	107	#ifdef CONFIG_USB_GADGET_MUSB_HDRC
	108
	109	#define is_peripheral_capable() (1)
	110
	111	extern irqreturn_t musb_g_ep0_irq(struct musb *);
	112	extern void musb_g_tx(struct musb *, u8);
	113	extern void musb_g_rx(struct musb *, u8);
	114	extern void musb_g_reset(struct musb *);
	115	extern void musb_g_suspend(struct musb *);
	116	extern void musb_g_resume(struct musb *);
	117	extern void musb_g_wakeup(struct musb *);
	118	extern void musb_g_disconnect(struct musb *);
	119
	120	#else
	121
	122	#define is_peripheral_capable() (0)
	123
124	static inline irqreturn_t musb_g_ep0_irq(struct musb *m) { return IRQ_NONE; }
125	static inline void musb_g_reset(struct musb *m) {}
126	static inline void musb_g_suspend(struct musb *m) {}
127	static inline void musb_g_resume(struct musb *m) {}
128	static inline void musb_g_wakeup(struct musb *m) {}
129	static inline void musb_g_disconnect(struct musb *m) {}
130
131	#endif
132
133	/**************************** HOST ROLE *********************************/
134
135	#ifdef CONFIG_USB_MUSB_HDRC_HCD
136
137	#define is_host_capable() (1)
138
139	extern irqreturn_t musb_h_ep0_irq(struct musb *);
140	extern void musb_host_tx(struct musb *, u8);
141	extern void musb_host_rx(struct musb *, u8);
142
143	#else
144
145	#define is_host_capable() (0)
146
147	static inline irqreturn_t musb_h_ep0_irq(struct musb *m) { return IRQ_NONE; }
148	static inline void musb_host_tx(struct musb *m, u8 e) {}
149	static inline void musb_host_rx(struct musb *m, u8 e) {}
150
151	#endif
152
153
154	/**************************** CONSTANTS ******************************/
155
156	#ifndef MUSB_C_NUM_EPS
157	#define MUSB_C_NUM_EPS ((u8)16)
158	#endif
159
160	#ifndef MUSB_MAX_END0_PACKET
161	#define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
162	#endif
163
164	/* host side ep0 states */
165	enum musb_h_ep0_state {
166	MUSB_EP0_IDLE,
167	MUSB_EP0_START, /* expect ack of setup */
168	MUSB_EP0_IN, /* expect IN DATA */
169	MUSB_EP0_OUT, /* expect ack of OUT DATA */
170	MUSB_EP0_STATUS, /* expect ack of STATUS */
171	} __attribute__ ((packed));
172
173	/* peripheral side ep0 states */
174	enum musb_g_ep0_state {
a5073b52 SS	175	MUSB_EP0_STAGE_IDLE, /* idle, waiting for SETUP */
a5073b52 SS	176	MUSB_EP0_STAGE_SETUP, /* received SETUP */
550a7375 FB	177	MUSB_EP0_STAGE_TX, /* IN data */
	178	MUSB_EP0_STAGE_RX, /* OUT data */
	179	MUSB_EP0_STAGE_STATUSIN, /* (after OUT data) */
	180	MUSB_EP0_STAGE_STATUSOUT, /* (after IN data) */
	181	MUSB_EP0_STAGE_ACKWAIT, /* after zlp, before statusin */
	182	} __attribute__ ((packed));
	183
f7f9d63e DB	184	/*
	185	* OTG protocol constants. See USB OTG 1.3 spec,
	186	* sections 5.5 "Device Timings" and 6.6.5 "Timers".
	187	*/
550a7375	188	#define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */
f7f9d63e DB	189	#define OTG_TIME_A_WAIT_BCON 1100 /* min 1 second */
	190	#define OTG_TIME_A_AIDL_BDIS 200 /* min 200 msec */
	191	#define OTG_TIME_B_ASE0_BRST 100 /* min 3.125 ms */
	192
550a7375 FB	193
	194	/************************* REGISTER ACCESS ******************************/
	195
	196	/* Endpoint registers (other than dynfifo setup) can be accessed either
	197	* directly with the "flat" model, or after setting up an index register.
	198	*/
	199
	200	#if defined(CONFIG_ARCH_DAVINCI) \|\| defined(CONFIG_ARCH_OMAP2430) \
c6cf8b00	201	\|\| defined(CONFIG_ARCH_OMAP3430) \|\| defined(CONFIG_BLACKFIN)
550a7375 FB	202	/* REVISIT indexed access seemed to
	203	* misbehave (on DaVinci) for at least peripheral IN ...
	204	*/
	205	#define MUSB_FLAT_REG
	206	#endif
	207
	208	/* TUSB mapping: "flat" plus ep0 special cases */
	209	#if defined(CONFIG_USB_TUSB6010)
	210	#define musb_ep_select(_mbase, _epnum) \
	211	musb_writeb((_mbase), MUSB_INDEX, (_epnum))
	212	#define MUSB_EP_OFFSET MUSB_TUSB_OFFSET
	213
	214	/* "flat" mapping: each endpoint has its own i/o address */
	215	#elif defined(MUSB_FLAT_REG)
	216	#define musb_ep_select(_mbase, _epnum) (((void)(_mbase)), ((void)(_epnum)))
	217	#define MUSB_EP_OFFSET MUSB_FLAT_OFFSET
	218
	219	/* "indexed" mapping: INDEX register controls register bank select */
	220	#else
	221	#define musb_ep_select(_mbase, _epnum) \
	222	musb_writeb((_mbase), MUSB_INDEX, (_epnum))
	223	#define MUSB_EP_OFFSET MUSB_INDEXED_OFFSET
	224	#endif
	225
	226	/**************************** FUNCTIONS ******************************/
	227
	228	#define MUSB_HST_MODE(_musb)\
	229	{ (_musb)->is_host = true; }
	230	#define MUSB_DEV_MODE(_musb) \
	231	{ (_musb)->is_host = false; }
	232
	233	#define test_devctl_hst_mode(_x) \
	234	(musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
	235
	236	#define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
	237
	238	/****************************** TYPES ***********************************/
	239
	240	/*
	241	* struct musb_hw_ep - endpoint hardware (bidirectional)
	242	*
	243	* Ordered slightly for better cacheline locality.
	244	*/
	245	struct musb_hw_ep {
	246	struct musb *musb;
	247	void __iomem *fifo;
	248	void __iomem *regs;
	249
	250	#ifdef CONFIG_USB_TUSB6010
	251	void __iomem *conf;
	252	#endif
	253
	254	/* index in musb->endpoints[] */
	255	u8 epnum;
	256
	257	/* hardware configuration, possibly dynamic */
	258	bool is_shared_fifo;
	259	bool tx_double_buffered;
	260	bool rx_double_buffered;
	261	u16 max_packet_sz_tx;
	262	u16 max_packet_sz_rx;
	263
	264	struct dma_channel *tx_channel;
	265	struct dma_channel *rx_channel;
266
267	#ifdef CONFIG_USB_TUSB6010
268	/* TUSB has "asynchronous" and "synchronous" dma modes */
269	dma_addr_t fifo_async;
270	dma_addr_t fifo_sync;
271	void __iomem *fifo_sync_va;
272	#endif
273
274	#ifdef CONFIG_USB_MUSB_HDRC_HCD
275	void __iomem *target_regs;
276
277	/* currently scheduled peripheral endpoint */
278	struct musb_qh *in_qh;
279	struct musb_qh *out_qh;
280
281	u8 rx_reinit;
282	u8 tx_reinit;
283	#endif
284
285	#ifdef CONFIG_USB_GADGET_MUSB_HDRC
286	/* peripheral side */
287	struct musb_ep ep_in; /* TX */
288	struct musb_ep ep_out; /* RX */
289	#endif
290	};
291
292	static inline struct usb_request next_in_request(struct musb_hw_ep hw_ep)
293	{
294	#ifdef CONFIG_USB_GADGET_MUSB_HDRC
295	return next_request(&hw_ep->ep_in);
296	#else
297	return NULL;
298	#endif
299	}
300
301	static inline struct usb_request next_out_request(struct musb_hw_ep hw_ep)
302	{
303	#ifdef CONFIG_USB_GADGET_MUSB_HDRC
304	return next_request(&hw_ep->ep_out);
305	#else
306	return NULL;
307	#endif
308	}
309
310	/*
311	* struct musb - Driver instance data.
312	*/
313	struct musb {
314	/* device lock */
315	spinlock_t lock;
316	struct clk *clock;
317	irqreturn_t (isr)(int, void );
318	struct work_struct irq_work;
319
320	/* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
321	#define MUSB_PORT_STAT_RESUME (1 << 31)
322
323	u32 port1_status;
324
325	#ifdef CONFIG_USB_MUSB_HDRC_HCD
326	unsigned long rh_timer;
327
328	enum musb_h_ep0_state ep0_stage;
329
330	/* bulk traffic normally dedicates endpoint hardware, and each
331	* direction has its own ring of host side endpoints.
332	* we try to progress the transfer at the head of each endpoint's
333	* queue until it completes or NAKs too much; then we try the next
334	* endpoint.
335	*/
336	struct musb_hw_ep *bulk_ep;
337
338	struct list_head control; /* of musb_qh */
339	struct list_head in_bulk; /* of musb_qh */
340	struct list_head out_bulk; /* of musb_qh */
f7f9d63e DB	341
f7f9d63e DB	342	struct timer_list otg_timer;
550a7375 FB	343	#endif
	344
	345	/* called with IRQs blocked; ON/nonzero implies starting a session,
	346	* and waiting at least a_wait_vrise_tmout.
	347	*/
	348	void (board_set_vbus)(struct musb , int is_on);
	349
	350	struct dma_controller *dma_controller;
	351
	352	struct device *controller;
	353	void __iomem *ctrl_base;
	354	void __iomem *mregs;
	355
	356	#ifdef CONFIG_USB_TUSB6010
	357	dma_addr_t async;
	358	dma_addr_t sync;
	359	void __iomem *sync_va;
	360	#endif
	361
	362	/* passed down from chip/board specific irq handlers */
	363	u8 int_usb;
	364	u16 int_rx;
	365	u16 int_tx;
	366
84e250ff	367	struct otg_transceiver *xceiv;
550a7375 FB	368
550a7375 FB	369	int nIrq;
c48a5155	370	unsigned irq_wake:1;
550a7375 FB	371
	372	struct musb_hw_ep endpoints[MUSB_C_NUM_EPS];
	373	#define control_ep endpoints
	374
	375	#define VBUSERR_RETRY_COUNT 3
	376	u16 vbuserr_retry;
	377	u16 epmask;
	378	u8 nr_endpoints;
	379
	380	u8 board_mode; /* enum musb_mode */
	381	int (*board_set_power)(int state);
	382
	383	int (set_clock)(struct clk clk, int is_active);
	384
	385	u8 min_power; /* vbus for periph, in mA/2 */
	386
	387	bool is_host;
	388
	389	int a_wait_bcon; /* VBUS timeout in msecs */
	390	unsigned long idle_timeout; /* Next timeout in jiffies */
	391
	392	/* active means connected and not suspended */
	393	unsigned is_active:1;
	394
	395	unsigned is_multipoint:1;
	396	unsigned ignore_disconnect:1; /* during bus resets */
	397
	398	#ifdef C_MP_TX
	399	unsigned bulk_split:1;
	400	#define can_bulk_split(musb,type) \
	401	(((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
	402	#else
	403	#define can_bulk_split(musb, type) 0
	404	#endif
	405
	406	#ifdef C_MP_RX
	407	unsigned bulk_combine:1;
	408	#define can_bulk_combine(musb,type) \
	409	(((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
	410	#else
	411	#define can_bulk_combine(musb, type) 0
	412	#endif
	413
	414	#ifdef CONFIG_USB_GADGET_MUSB_HDRC
	415	/* is_suspended means USB B_PERIPHERAL suspend */
	416	unsigned is_suspended:1;
	417
	418	/* may_wakeup means remote wakeup is enabled */
	419	unsigned may_wakeup:1;
	420
	421	/* is_self_powered is reported in device status and the
	422	* config descriptor. is_bus_powered means B_PERIPHERAL
	423	* draws some VBUS current; both can be true.
	424	*/
	425	unsigned is_self_powered:1;
	426	unsigned is_bus_powered:1;
	427
	428	unsigned set_address:1;
	429	unsigned test_mode:1;
	430	unsigned softconnect:1;
	431
	432	u8 address;
	433	u8 test_mode_nr;
	434	u16 ackpend; /* ep0 */
435	enum musb_g_ep0_state ep0_state;
436	struct usb_gadget g; /* the gadget */
437	struct usb_gadget_driver gadget_driver; / its driver */
438	#endif
439
ca6d1b13 FB	440	struct musb_hdrc_config *config;
ca6d1b13 FB	441
550a7375 FB	442	#ifdef MUSB_CONFIG_PROC_FS
	443	struct proc_dir_entry *proc_entry;
	444	#endif
	445	};
	446
	447	static inline void musb_set_vbus(struct musb *musb, int is_on)
	448	{
	449	musb->board_set_vbus(musb, is_on);
	450	}
	451
	452	#ifdef CONFIG_USB_GADGET_MUSB_HDRC
	453	static inline struct musb gadget_to_musb(struct usb_gadget g)
	454	{
	455	return container_of(g, struct musb, g);
	456	}
	457	#endif
	458
c6cf8b00 BW	459	#ifdef CONFIG_BLACKFIN
	460	static inline int musb_read_fifosize(struct musb *musb,
	461	struct musb_hw_ep *hw_ep, u8 epnum)
	462	{
	463	musb->nr_endpoints++;
	464	musb->epmask \|= (1 << epnum);
	465
	466	if (epnum < 5) {
	467	hw_ep->max_packet_sz_tx = 128;
	468	hw_ep->max_packet_sz_rx = 128;
	469	} else {
	470	hw_ep->max_packet_sz_tx = 1024;
	471	hw_ep->max_packet_sz_rx = 1024;
	472	}
	473	hw_ep->is_shared_fifo = false;
	474
	475	return 0;
	476	}
	477
	478	static inline void musb_configure_ep0(struct musb *musb)
	479	{
	480	musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
	481	musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
	482	musb->endpoints[0].is_shared_fifo = true;
	483	}
	484
	485	#else
	486
	487	static inline int musb_read_fifosize(struct musb *musb,
	488	struct musb_hw_ep *hw_ep, u8 epnum)
	489	{
32233716	490	void *mbase = musb->mregs;
c6cf8b00 BW	491	u8 reg = 0;
	492
	493	/* read from core using indexed model */
32233716	494	reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE));
c6cf8b00 BW	495	/* 0's returned when no more endpoints */
	496	if (!reg)
	497	return -ENODEV;
	498
	499	musb->nr_endpoints++;
	500	musb->epmask \|= (1 << epnum);
	501
	502	hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
	503
	504	/* shared TX/RX FIFO? */
	505	if ((reg & 0xf0) == 0xf0) {
	506	hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
	507	hw_ep->is_shared_fifo = true;
	508	return 0;
	509	} else {
	510	hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
	511	hw_ep->is_shared_fifo = false;
	512	}
	513
	514	return 0;
	515	}
	516
	517	static inline void musb_configure_ep0(struct musb *musb)
	518	{
	519	musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
	520	musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
32233716	521	musb->endpoints[0].is_shared_fifo = true;
c6cf8b00 BW	522	}
	523	#endif /* CONFIG_BLACKFIN */
	524
550a7375 FB	525
	526	/*************************** Glue it together ***************************/
	527
	528	extern const char musb_driver_name[];
	529
	530	extern void musb_start(struct musb *musb);
	531	extern void musb_stop(struct musb *musb);
	532
	533	extern void musb_write_fifo(struct musb_hw_ep ep, u16 len, const u8 src);
	534	extern void musb_read_fifo(struct musb_hw_ep ep, u16 len, u8 dst);
	535
	536	extern void musb_load_testpacket(struct musb *);
	537
	538	extern irqreturn_t musb_interrupt(struct musb *);
	539
	540	extern void musb_platform_enable(struct musb *musb);
	541	extern void musb_platform_disable(struct musb *musb);
	542
	543	extern void musb_hnp_stop(struct musb *musb);
	544
96a274d1	545	extern int musb_platform_set_mode(struct musb *musb, u8 musb_mode);
550a7375	546
c6cf8b00	547	#if defined(CONFIG_USB_TUSB6010) \|\| defined(CONFIG_BLACKFIN) \|\| \
550a7375 FB	548	defined(CONFIG_ARCH_OMAP2430) \|\| defined(CONFIG_ARCH_OMAP34XX)
	549	extern void musb_platform_try_idle(struct musb *musb, unsigned long timeout);
	550	#else
	551	#define musb_platform_try_idle(x, y) do {} while (0)
	552	#endif
	553
c6cf8b00	554	#if defined(CONFIG_USB_TUSB6010) \|\| defined(CONFIG_BLACKFIN)
550a7375 FB	555	extern int musb_platform_get_vbus_status(struct musb *musb);
	556	#else
	557	#define musb_platform_get_vbus_status(x) 0
	558	#endif
	559
	560	extern int __init musb_platform_init(struct musb *musb);
	561	extern int musb_platform_exit(struct musb *musb);
	562
550a7375	563	#endif /* __MUSB_CORE_H__ */