[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)

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

#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_started_request(struct dwc3_request *req)
{
	struct dwc3_ep		*dep = req->dep;

	req->started = true;
	list_move_tail(&req->list, &dep->started_list);
}

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

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_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);

/**
 * 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);
}

#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	58
72246da4 FB	59	/* -------------------------------------------------------------------------- */
72246da4 FB	60
72246da4 FB	61	#define to_dwc3_request(r) (container_of(r, struct dwc3_request, request))
	62
	63	static inline struct dwc3_request next_request(struct list_head list)
	64	{
	65	if (list_empty(list))
	66	return NULL;
	67
	68	return list_first_entry(list, struct dwc3_request, list);
	69	}
	70
aa3342c8	71	static inline void dwc3_gadget_move_started_request(struct dwc3_request *req)
72246da4 FB	72	{
	73	struct dwc3_ep *dep = req->dep;
	74
aa3342c8 FB	75	req->started = true;
aa3342c8 FB	76	list_move_tail(&req->list, &dep->started_list);
72246da4 FB	77	}
72246da4 FB	78
72246da4 FB	79	void dwc3_gadget_giveback(struct dwc3_ep dep, struct dwc3_request req,
	80	int status);
	81
25b8ff68 FB	82	void dwc3_ep0_interrupt(struct dwc3 *dwc,
25b8ff68 FB	83	const struct dwc3_event_depevt *event);
72246da4	84	void dwc3_ep0_out_start(struct dwc3 *dwc);
33fb691b	85	int __dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
08f0d966	86	int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
72246da4 FB	87	int dwc3_gadget_ep0_queue(struct usb_ep ep, struct usb_request request,
72246da4 FB	88	gfp_t gfp_flags);
7a608559	89	int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol);
72246da4 FB	90
	91	/**
	92	* dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
	93	* @dwc: DesignWare USB3 Pointer
	94	* @number: DWC endpoint number
	95	*
	96	* Caller should take care of locking
	97	*/
	98	static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3 *dwc, u8 number)
	99	{
	100	u32 res_id;
	101
	102	res_id = dwc3_readl(dwc->regs, DWC3_DEPCMD(number));
	103
	104	return DWC3_DEPCMD_GET_RSC_IDX(res_id);
	105	}
	106
72246da4	107	#endif /* __DRIVERS_USB_DWC3_GADGET_H */