xref: /OK3568_Linux_fs/kernel/drivers/usb/isp1760/isp1760-udc.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Driver for the NXP ISP1761 device controller
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright 2014 Ideas on Board Oy
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Contacts:
8*4882a593Smuzhiyun  *	Laurent Pinchart <laurent.pinchart@ideasonboard.com>
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef _ISP1760_UDC_H_
12*4882a593Smuzhiyun #define _ISP1760_UDC_H_
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <linux/ioport.h>
15*4882a593Smuzhiyun #include <linux/list.h>
16*4882a593Smuzhiyun #include <linux/spinlock.h>
17*4882a593Smuzhiyun #include <linux/timer.h>
18*4882a593Smuzhiyun #include <linux/usb/gadget.h>
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun struct isp1760_device;
21*4882a593Smuzhiyun struct isp1760_udc;
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun enum isp1760_ctrl_state {
24*4882a593Smuzhiyun 	ISP1760_CTRL_SETUP,		/* Waiting for a SETUP transaction */
25*4882a593Smuzhiyun 	ISP1760_CTRL_DATA_IN,		/* Setup received, data IN stage */
26*4882a593Smuzhiyun 	ISP1760_CTRL_DATA_OUT,		/* Setup received, data OUT stage */
27*4882a593Smuzhiyun 	ISP1760_CTRL_STATUS,		/* 0-length request in status stage */
28*4882a593Smuzhiyun };
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun struct isp1760_ep {
31*4882a593Smuzhiyun 	struct isp1760_udc *udc;
32*4882a593Smuzhiyun 	struct usb_ep ep;
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 	struct list_head queue;
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun 	unsigned int addr;
37*4882a593Smuzhiyun 	unsigned int maxpacket;
38*4882a593Smuzhiyun 	char name[7];
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 	const struct usb_endpoint_descriptor *desc;
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun 	bool rx_pending;
43*4882a593Smuzhiyun 	bool halted;
44*4882a593Smuzhiyun 	bool wedged;
45*4882a593Smuzhiyun };
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun /**
48*4882a593Smuzhiyun  * struct isp1760_udc - UDC state information
49*4882a593Smuzhiyun  * irq: IRQ number
50*4882a593Smuzhiyun  * irqname: IRQ name (as passed to request_irq)
51*4882a593Smuzhiyun  * regs: Base address of the UDC registers
52*4882a593Smuzhiyun  * driver: Gadget driver
53*4882a593Smuzhiyun  * gadget: Gadget device
54*4882a593Smuzhiyun  * lock: Protects driver, vbus_timer, ep, ep0_*, DC_EPINDEX register
55*4882a593Smuzhiyun  * ep: Array of endpoints
56*4882a593Smuzhiyun  * ep0_state: Control request state for endpoint 0
57*4882a593Smuzhiyun  * ep0_dir: Direction of the current control request
58*4882a593Smuzhiyun  * ep0_length: Length of the current control request
59*4882a593Smuzhiyun  * connected: Tracks gadget driver bus connection state
60*4882a593Smuzhiyun  */
61*4882a593Smuzhiyun struct isp1760_udc {
62*4882a593Smuzhiyun #ifdef CONFIG_USB_ISP1761_UDC
63*4882a593Smuzhiyun 	struct isp1760_device *isp;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	int irq;
66*4882a593Smuzhiyun 	char *irqname;
67*4882a593Smuzhiyun 	void __iomem *regs;
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun 	struct usb_gadget_driver *driver;
70*4882a593Smuzhiyun 	struct usb_gadget gadget;
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun 	spinlock_t lock;
73*4882a593Smuzhiyun 	struct timer_list vbus_timer;
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun 	struct isp1760_ep ep[15];
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun 	enum isp1760_ctrl_state ep0_state;
78*4882a593Smuzhiyun 	u8 ep0_dir;
79*4882a593Smuzhiyun 	u16 ep0_length;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	bool connected;
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 	unsigned int devstatus;
84*4882a593Smuzhiyun #endif
85*4882a593Smuzhiyun };
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun #ifdef CONFIG_USB_ISP1761_UDC
88*4882a593Smuzhiyun int isp1760_udc_register(struct isp1760_device *isp, int irq,
89*4882a593Smuzhiyun 			 unsigned long irqflags);
90*4882a593Smuzhiyun void isp1760_udc_unregister(struct isp1760_device *isp);
91*4882a593Smuzhiyun #else
isp1760_udc_register(struct isp1760_device * isp,int irq,unsigned long irqflags)92*4882a593Smuzhiyun static inline int isp1760_udc_register(struct isp1760_device *isp, int irq,
93*4882a593Smuzhiyun 				       unsigned long irqflags)
94*4882a593Smuzhiyun {
95*4882a593Smuzhiyun 	return 0;
96*4882a593Smuzhiyun }
97*4882a593Smuzhiyun 
isp1760_udc_unregister(struct isp1760_device * isp)98*4882a593Smuzhiyun static inline void isp1760_udc_unregister(struct isp1760_device *isp)
99*4882a593Smuzhiyun {
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun #endif
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun #endif
104