[GitHub/mt8127/android_kernel_alcatel_ttab.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>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The names of the above-listed copyright holders may not be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * ALTERNATIVELY, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2, as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR
 * CONTRIBUTORS 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 __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) & 0x1f) << 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) & 0xff) << 16)
#define DWC3_DEPCFG_STREAM_CAPABLE	(1 << 24)
#define DWC3_DEPCFG_EP_NUMBER(n)	(((n) & 0x1f) << 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) & 0x3) << 1)
#define DWC3_DEPCFG_MAX_PACKET_SIZE(n)	(((n) & 0x7ff) << 3)
#define DWC3_DEPCFG_FIFO_NUMBER(n)	(((n) & 0x1f) << 17)
#define DWC3_DEPCFG_BURST_SIZE(n)	(((n) & 0xf) << 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 protocol);
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	*
	9	* Redistribution and use in source and binary forms, with or without
	10	* modification, are permitted provided that the following conditions
	11	* are met:
	12	* 1. Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions, and the following disclaimer,
	14	* without modification.
	15	* 2. Redistributions in binary form must reproduce the above copyright
	16	* notice, this list of conditions and the following disclaimer in the
	17	* documentation and/or other materials provided with the distribution.
	18	* 3. The names of the above-listed copyright holders may not be used
	19	* to endorse or promote products derived from this software without
	20	* specific prior written permission.
	21	*
	22	* ALTERNATIVELY, this software may be distributed under the terms of the
	23	* GNU General Public License ("GPL") version 2, as published by the Free
	24	* Software Foundation.
	25	*
	26	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
	27	* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
	28	* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	29	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
	30	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
	31	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
	32	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
	33	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
	34	* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
	35	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	36	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	37	*/
	38
	39	#ifndef __DRIVERS_USB_DWC3_GADGET_H
	40	#define __DRIVERS_USB_DWC3_GADGET_H
	41
	42	#include <linux/list.h>
	43	#include <linux/usb/gadget.h>
	44	#include "io.h"
	45
	46	struct dwc3;
	47	#define to_dwc3_ep(ep) (container_of(ep, struct dwc3_ep, endpoint))
	48	#define gadget_to_dwc(g) (container_of(g, struct dwc3, gadget))
	49
dc1c70a7	50	/* DEPCFG parameter 1 */
8cada854	51	#define DWC3_DEPCFG_INT_NUM(n) (((n) & 0x1f) << 0)
dc1c70a7 FB	52	#define DWC3_DEPCFG_XFER_COMPLETE_EN (1 << 8)
	53	#define DWC3_DEPCFG_XFER_IN_PROGRESS_EN (1 << 9)
	54	#define DWC3_DEPCFG_XFER_NOT_READY_EN (1 << 10)
	55	#define DWC3_DEPCFG_FIFO_ERROR_EN (1 << 11)
	56	#define DWC3_DEPCFG_STREAM_EVENT_EN (1 << 13)
8cada854	57	#define DWC3_DEPCFG_BINTERVAL_M1(n) (((n) & 0xff) << 16)
dc1c70a7	58	#define DWC3_DEPCFG_STREAM_CAPABLE (1 << 24)
8cada854	59	#define DWC3_DEPCFG_EP_NUMBER(n) (((n) & 0x1f) << 25)
dc1c70a7 FB	60	#define DWC3_DEPCFG_BULK_BASED (1 << 30)
	61	#define DWC3_DEPCFG_FIFO_BASED (1 << 31)
	62
	63	/* DEPCFG parameter 0 */
8cada854 FB	64	#define DWC3_DEPCFG_EP_TYPE(n) (((n) & 0x3) << 1)
	65	#define DWC3_DEPCFG_MAX_PACKET_SIZE(n) (((n) & 0x7ff) << 3)
	66	#define DWC3_DEPCFG_FIFO_NUMBER(n) (((n) & 0x1f) << 17)
	67	#define DWC3_DEPCFG_BURST_SIZE(n) (((n) & 0xf) << 22)
dc1c70a7	68	#define DWC3_DEPCFG_DATA_SEQ_NUM(n) ((n) << 26)
2c61a8ef	69	/* This applies for core versions earlier than 1.94a */
dc1c70a7	70	#define DWC3_DEPCFG_IGN_SEQ_NUM (1 << 31)
2c61a8ef PZ	71	/* These apply for core versions 1.94a and later */
	72	#define DWC3_DEPCFG_ACTION_INIT (0 << 30)
	73	#define DWC3_DEPCFG_ACTION_RESTORE (1 << 30)
	74	#define DWC3_DEPCFG_ACTION_MODIFY (2 << 30)
dc1c70a7 FB	75
	76	/* DEPXFERCFG parameter 0 */
	77	#define DWC3_DEPXFERCFG_NUM_XFER_RES(n) ((n) & 0xffff)
72246da4 FB	78
72246da4 FB	79	struct dwc3_gadget_ep_cmd_params {
dc1c70a7 FB	80	u32 param2;
	81	u32 param1;
	82	u32 param0;
	83	};
72246da4 FB	84
	85	/* -------------------------------------------------------------------------- */
	86
72246da4 FB	87	#define to_dwc3_request(r) (container_of(r, struct dwc3_request, request))
	88
	89	static inline struct dwc3_request next_request(struct list_head list)
	90	{
	91	if (list_empty(list))
	92	return NULL;
	93
	94	return list_first_entry(list, struct dwc3_request, list);
	95	}
	96
	97	static inline void dwc3_gadget_move_request_queued(struct dwc3_request *req)
	98	{
	99	struct dwc3_ep *dep = req->dep;
	100
	101	req->queued = true;
	102	list_move_tail(&req->list, &dep->req_queued);
	103	}
	104
72246da4 FB	105	void dwc3_gadget_giveback(struct dwc3_ep dep, struct dwc3_request req,
	106	int status);
	107
04a9bfcd	108	int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
8598bde7	109	int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
04a9bfcd	110
25b8ff68 FB	111	void dwc3_ep0_interrupt(struct dwc3 *dwc,
25b8ff68 FB	112	const struct dwc3_event_depevt *event);
72246da4	113	void dwc3_ep0_out_start(struct dwc3 *dwc);
08f0d966	114	int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
72246da4 FB	115	int dwc3_gadget_ep0_queue(struct usb_ep ep, struct usb_request request,
72246da4 FB	116	gfp_t gfp_flags);
7d513758	117	int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol);
72246da4 FB	118	int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
72246da4 FB	119	unsigned cmd, struct dwc3_gadget_ep_cmd_params *params);
b09bb642	120	int dwc3_send_gadget_generic_command(struct dwc3 *dwc, int cmd, u32 param);
72246da4 FB	121
	122	/**
	123	* dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
	124	* @dwc: DesignWare USB3 Pointer
	125	* @number: DWC endpoint number
	126	*
	127	* Caller should take care of locking
	128	*/
	129	static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3 *dwc, u8 number)
	130	{
	131	u32 res_id;
	132
	133	res_id = dwc3_readl(dwc->regs, DWC3_DEPCMD(number));
	134
	135	return DWC3_DEPCMD_GET_RSC_IDX(res_id);
	136	}
	137
	138	/**
	139	* dwc3_gadget_event_string - returns event name
	140	* @event: the event code
	141	*/
	142	static inline const char *dwc3_gadget_event_string(u8 event)
	143	{
	144	switch (event) {
	145	case DWC3_DEVICE_EVENT_DISCONNECT:
	146	return "Disconnect";
	147	case DWC3_DEVICE_EVENT_RESET:
	148	return "Reset";
	149	case DWC3_DEVICE_EVENT_CONNECT_DONE:
	150	return "Connection Done";
	151	case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
	152	return "Link Status Change";
	153	case DWC3_DEVICE_EVENT_WAKEUP:
	154	return "WakeUp";
	155	case DWC3_DEVICE_EVENT_EOPF:
	156	return "End-Of-Frame";
	157	case DWC3_DEVICE_EVENT_SOF:
	158	return "Start-Of-Frame";
	159	case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
	160	return "Erratic Error";
	161	case DWC3_DEVICE_EVENT_CMD_CMPL:
	162	return "Command Complete";
	163	case DWC3_DEVICE_EVENT_OVERFLOW:
	164	return "Overflow";
	165	}
	166
	167	return "UNKNOWN";
	168	}
	169
	170	/**
	171	* dwc3_ep_event_string - returns event name
	172	* @event: then event code
	173	*/
	174	static inline const char *dwc3_ep_event_string(u8 event)
	175	{
	176	switch (event) {
	177	case DWC3_DEPEVT_XFERCOMPLETE:
	178	return "Transfer Complete";
	179	case DWC3_DEPEVT_XFERINPROGRESS:
	180	return "Transfer In-Progress";
	181	case DWC3_DEPEVT_XFERNOTREADY:
	182	return "Transfer Not Ready";
	183	case DWC3_DEPEVT_RXTXFIFOEVT:
	184	return "FIFO";
185	case DWC3_DEPEVT_STREAMEVT:
186	return "Stream";
187	case DWC3_DEPEVT_EPCMDCMPLT:
188	return "Endpoint Command Complete";
189	}
190
191	return "UNKNOWN";
192	}
193
194	#endif /* __DRIVERS_USB_DWC3_GADGET_H */