[deliverable/linux.git] / drivers / usb / dwc3 / gadget.h

/**
 * gadget.h - DesignWare USB3 DRD Gadget Header
 *
 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
 *
 * Authors: Felipe Balbi <balbi@ti.com>,
 *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2  of
 * the License 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.
 */

#ifndef __DRIVERS_USB_DWC3_GADGET_H
#define __DRIVERS_USB_DWC3_GADGET_H

#include <linux/list.h>
#include <linux/usb/gadget.h>
#include "io.h"

struct dwc3;
#define to_dwc3_ep(ep)		(container_of(ep, struct dwc3_ep, endpoint))
#define gadget_to_dwc(g)	(container_of(g, struct dwc3, gadget))

/* DEPCFG parameter 1 */
#define DWC3_DEPCFG_INT_NUM(n)		((n) << 0)
#define DWC3_DEPCFG_XFER_COMPLETE_EN	(1 << 8)
#define DWC3_DEPCFG_XFER_IN_PROGRESS_EN	(1 << 9)
#define DWC3_DEPCFG_XFER_NOT_READY_EN	(1 << 10)
#define DWC3_DEPCFG_FIFO_ERROR_EN	(1 << 11)
#define DWC3_DEPCFG_STREAM_EVENT_EN	(1 << 13)
#define DWC3_DEPCFG_BINTERVAL_M1(n)	((n) << 16)
#define DWC3_DEPCFG_STREAM_CAPABLE	(1 << 24)
#define DWC3_DEPCFG_EP_NUMBER(n)	((n) << 25)
#define DWC3_DEPCFG_BULK_BASED		(1 << 30)
#define DWC3_DEPCFG_FIFO_BASED		(1 << 31)

/* DEPCFG parameter 0 */
#define DWC3_DEPCFG_EP_TYPE(n)		((n) << 1)
#define DWC3_DEPCFG_MAX_PACKET_SIZE(n)	((n) << 3)
#define DWC3_DEPCFG_FIFO_NUMBER(n)	((n) << 17)
#define DWC3_DEPCFG_BURST_SIZE(n)	((n) << 22)
#define DWC3_DEPCFG_DATA_SEQ_NUM(n)	((n) << 26)
/* This applies for core versions earlier than 1.94a */
#define DWC3_DEPCFG_IGN_SEQ_NUM		(1 << 31)
/* These apply for core versions 1.94a and later */
#define DWC3_DEPCFG_ACTION_INIT		(0 << 30)
#define DWC3_DEPCFG_ACTION_RESTORE	(1 << 30)
#define DWC3_DEPCFG_ACTION_MODIFY	(2 << 30)

/* DEPXFERCFG parameter 0 */
#define DWC3_DEPXFERCFG_NUM_XFER_RES(n)	((n) & 0xffff)

struct dwc3_gadget_ep_cmd_params {
	u32	param2;
	u32	param1;
	u32	param0;
};

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

#define to_dwc3_request(r)	(container_of(r, struct dwc3_request, request))

static inline struct dwc3_request *next_request(struct list_head *list)
{
	if (list_empty(list))
		return NULL;

	return list_first_entry(list, struct dwc3_request, list);
}

static inline void dwc3_gadget_move_request_queued(struct dwc3_request *req)
{
	struct dwc3_ep		*dep = req->dep;

	req->queued = true;
	list_move_tail(&req->list, &dep->req_queued);
}

void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
		int status);

int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);

void dwc3_ep0_interrupt(struct dwc3 *dwc,
		const struct dwc3_event_depevt *event);
void dwc3_ep0_out_start(struct dwc3 *dwc);
int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request,
		gfp_t gfp_flags);
int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value);
int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
		unsigned cmd, struct dwc3_gadget_ep_cmd_params *params);
int dwc3_send_gadget_generic_command(struct dwc3 *dwc, int cmd, u32 param);

/**
 * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
 * @dwc: DesignWare USB3 Pointer
 * @number: DWC endpoint number
 *
 * Caller should take care of locking
 */
static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3 *dwc, u8 number)
{
	u32			res_id;

	res_id = dwc3_readl(dwc->regs, DWC3_DEPCMD(number));

	return DWC3_DEPCMD_GET_RSC_IDX(res_id);
}

/**
 * dwc3_gadget_event_string - returns event name
 * @event: the event code
 */
static inline const char *dwc3_gadget_event_string(u8 event)
{
	switch (event) {
	case DWC3_DEVICE_EVENT_DISCONNECT:
		return "Disconnect";
	case DWC3_DEVICE_EVENT_RESET:
		return "Reset";
	case DWC3_DEVICE_EVENT_CONNECT_DONE:
		return "Connection Done";
	case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
		return "Link Status Change";
	case DWC3_DEVICE_EVENT_WAKEUP:
		return "WakeUp";
	case DWC3_DEVICE_EVENT_EOPF:
		return "End-Of-Frame";
	case DWC3_DEVICE_EVENT_SOF:
		return "Start-Of-Frame";
	case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
		return "Erratic Error";
	case DWC3_DEVICE_EVENT_CMD_CMPL:
		return "Command Complete";
	case DWC3_DEVICE_EVENT_OVERFLOW:
		return "Overflow";
	}

	return "UNKNOWN";
}

/**
 * dwc3_ep_event_string - returns event name
 * @event: then event code
 */
static inline const char *dwc3_ep_event_string(u8 event)
{
	switch (event) {
	case DWC3_DEPEVT_XFERCOMPLETE:
		return "Transfer Complete";
	case DWC3_DEPEVT_XFERINPROGRESS:
		return "Transfer In-Progress";
	case DWC3_DEPEVT_XFERNOTREADY:
		return "Transfer Not Ready";
	case DWC3_DEPEVT_RXTXFIFOEVT:
		return "FIFO";
	case DWC3_DEPEVT_STREAMEVT:
		return "Stream";
	case DWC3_DEPEVT_EPCMDCMPLT:
		return "Endpoint Command Complete";
	}

	return "UNKNOWN";
}

#endif /* __DRIVERS_USB_DWC3_GADGET_H */
Commit	Line	Data
72246da4 FB	1	/**
	2	* gadget.h - DesignWare USB3 DRD Gadget Header
	3	*
	4	* Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
72246da4 FB	5	*
	6	* Authors: Felipe Balbi <balbi@ti.com>,
	7	* Sebastian Andrzej Siewior <bigeasy@linutronix.de>
	8	*
5945f789 FB	9	* This program is free software: you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 of
	11	* the License as published by the Free Software Foundation.
72246da4	12	*
5945f789 FB	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
72246da4 FB	17	*/
	18
	19	#ifndef __DRIVERS_USB_DWC3_GADGET_H
	20	#define __DRIVERS_USB_DWC3_GADGET_H
	21
	22	#include <linux/list.h>
	23	#include <linux/usb/gadget.h>
	24	#include "io.h"
	25
	26	struct dwc3;
	27	#define to_dwc3_ep(ep) (container_of(ep, struct dwc3_ep, endpoint))
	28	#define gadget_to_dwc(g) (container_of(g, struct dwc3, gadget))
	29
dc1c70a7 FB	30	/* DEPCFG parameter 1 */
	31	#define DWC3_DEPCFG_INT_NUM(n) ((n) << 0)
	32	#define DWC3_DEPCFG_XFER_COMPLETE_EN (1 << 8)
	33	#define DWC3_DEPCFG_XFER_IN_PROGRESS_EN (1 << 9)
	34	#define DWC3_DEPCFG_XFER_NOT_READY_EN (1 << 10)
	35	#define DWC3_DEPCFG_FIFO_ERROR_EN (1 << 11)
	36	#define DWC3_DEPCFG_STREAM_EVENT_EN (1 << 13)
	37	#define DWC3_DEPCFG_BINTERVAL_M1(n) ((n) << 16)
	38	#define DWC3_DEPCFG_STREAM_CAPABLE (1 << 24)
	39	#define DWC3_DEPCFG_EP_NUMBER(n) ((n) << 25)
	40	#define DWC3_DEPCFG_BULK_BASED (1 << 30)
	41	#define DWC3_DEPCFG_FIFO_BASED (1 << 31)
	42
	43	/* DEPCFG parameter 0 */
	44	#define DWC3_DEPCFG_EP_TYPE(n) ((n) << 1)
	45	#define DWC3_DEPCFG_MAX_PACKET_SIZE(n) ((n) << 3)
	46	#define DWC3_DEPCFG_FIFO_NUMBER(n) ((n) << 17)
	47	#define DWC3_DEPCFG_BURST_SIZE(n) ((n) << 22)
	48	#define DWC3_DEPCFG_DATA_SEQ_NUM(n) ((n) << 26)
2c61a8ef	49	/* This applies for core versions earlier than 1.94a */
dc1c70a7	50	#define DWC3_DEPCFG_IGN_SEQ_NUM (1 << 31)
2c61a8ef PZ	51	/* These apply for core versions 1.94a and later */
	52	#define DWC3_DEPCFG_ACTION_INIT (0 << 30)
	53	#define DWC3_DEPCFG_ACTION_RESTORE (1 << 30)
	54	#define DWC3_DEPCFG_ACTION_MODIFY (2 << 30)
dc1c70a7 FB	55
	56	/* DEPXFERCFG parameter 0 */
	57	#define DWC3_DEPXFERCFG_NUM_XFER_RES(n) ((n) & 0xffff)
72246da4 FB	58
72246da4 FB	59	struct dwc3_gadget_ep_cmd_params {
dc1c70a7 FB	60	u32 param2;
	61	u32 param1;
	62	u32 param0;
	63	};
72246da4 FB	64
	65	/* -------------------------------------------------------------------------- */
	66
72246da4 FB	67	#define to_dwc3_request(r) (container_of(r, struct dwc3_request, request))
	68
	69	static inline struct dwc3_request next_request(struct list_head list)
	70	{
	71	if (list_empty(list))
	72	return NULL;
	73
	74	return list_first_entry(list, struct dwc3_request, list);
	75	}
	76
	77	static inline void dwc3_gadget_move_request_queued(struct dwc3_request *req)
	78	{
	79	struct dwc3_ep *dep = req->dep;
	80
	81	req->queued = true;
	82	list_move_tail(&req->list, &dep->req_queued);
	83	}
	84
72246da4 FB	85	void dwc3_gadget_giveback(struct dwc3_ep dep, struct dwc3_request req,
	86	int status);
	87
04a9bfcd	88	int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
8598bde7	89	int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
04a9bfcd	90
25b8ff68 FB	91	void dwc3_ep0_interrupt(struct dwc3 *dwc,
25b8ff68 FB	92	const struct dwc3_event_depevt *event);
72246da4	93	void dwc3_ep0_out_start(struct dwc3 *dwc);
08f0d966	94	int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
72246da4 FB	95	int dwc3_gadget_ep0_queue(struct usb_ep ep, struct usb_request request,
	96	gfp_t gfp_flags);
	97	int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value);
	98	int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
	99	unsigned cmd, struct dwc3_gadget_ep_cmd_params *params);
b09bb642	100	int dwc3_send_gadget_generic_command(struct dwc3 *dwc, int cmd, u32 param);
72246da4 FB	101
	102	/**
	103	* dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
	104	* @dwc: DesignWare USB3 Pointer
	105	* @number: DWC endpoint number
	106	*
	107	* Caller should take care of locking
	108	*/
	109	static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3 *dwc, u8 number)
	110	{
	111	u32 res_id;
	112
	113	res_id = dwc3_readl(dwc->regs, DWC3_DEPCMD(number));
	114
	115	return DWC3_DEPCMD_GET_RSC_IDX(res_id);
	116	}
	117
	118	/**
	119	* dwc3_gadget_event_string - returns event name
	120	* @event: the event code
	121	*/
	122	static inline const char *dwc3_gadget_event_string(u8 event)
	123	{
	124	switch (event) {
	125	case DWC3_DEVICE_EVENT_DISCONNECT:
	126	return "Disconnect";
	127	case DWC3_DEVICE_EVENT_RESET:
	128	return "Reset";
	129	case DWC3_DEVICE_EVENT_CONNECT_DONE:
	130	return "Connection Done";
	131	case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
	132	return "Link Status Change";
	133	case DWC3_DEVICE_EVENT_WAKEUP:
	134	return "WakeUp";
	135	case DWC3_DEVICE_EVENT_EOPF:
	136	return "End-Of-Frame";
	137	case DWC3_DEVICE_EVENT_SOF:
	138	return "Start-Of-Frame";
	139	case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
	140	return "Erratic Error";
	141	case DWC3_DEVICE_EVENT_CMD_CMPL:
	142	return "Command Complete";
	143	case DWC3_DEVICE_EVENT_OVERFLOW:
	144	return "Overflow";
	145	}
	146
	147	return "UNKNOWN";
	148	}
	149
	150	/**
	151	* dwc3_ep_event_string - returns event name
	152	* @event: then event code
	153	*/
	154	static inline const char *dwc3_ep_event_string(u8 event)
	155	{
	156	switch (event) {
	157	case DWC3_DEPEVT_XFERCOMPLETE:
	158	return "Transfer Complete";
	159	case DWC3_DEPEVT_XFERINPROGRESS:
	160	return "Transfer In-Progress";
	161	case DWC3_DEPEVT_XFERNOTREADY:
	162	return "Transfer Not Ready";
	163	case DWC3_DEPEVT_RXTXFIFOEVT:
	164	return "FIFO";
165	case DWC3_DEPEVT_STREAMEVT:
166	return "Stream";
167	case DWC3_DEPEVT_EPCMDCMPLT:
168	return "Endpoint Command Complete";
169	}
170
171	return "UNKNOWN";
172	}
173
174	#endif /* __DRIVERS_USB_DWC3_GADGET_H */