489 lines
13 KiB
C
489 lines
13 KiB
C
/*
|
|
* 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/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_SETUP, /* idle, waiting for 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 */
|
|
#define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */
|
|
#define OTG_TIME_A_WAIT_BCON 0 /* 0=infinite; min 1000 msec */
|
|
#define OTG_TIME_A_IDLE_BDIS 200 /* msec (min) */
|
|
|
|
/*************************** 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)
|
|
/* 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 musb_qh *periodic[32]; /* tree of interrupt+iso */
|
|
#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;
|
|
|
|
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
|
|
|
|
|
|
/***************************** 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 void musb_platform_set_mode(struct musb *musb, u8 musb_mode);
|
|
|
|
#if defined(CONFIG_USB_TUSB6010) || \
|
|
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
|
|
|
|
#ifdef CONFIG_USB_TUSB6010
|
|
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__ */
|