1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0+
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (C) 2015 Karol Kosik <karo9@interia.eu>
4*4882a593Smuzhiyun * Copyright (C) 2015-2016 Samsung Electronics
5*4882a593Smuzhiyun * Igor Kotrasinski <i.kotrasinsk@samsung.com>
6*4882a593Smuzhiyun * Krzysztof Opasiak <k.opasiak@samsung.com>
7*4882a593Smuzhiyun */
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #ifndef __USBIP_VUDC_H
10*4882a593Smuzhiyun #define __USBIP_VUDC_H
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun #include <linux/platform_device.h>
13*4882a593Smuzhiyun #include <linux/usb.h>
14*4882a593Smuzhiyun #include <linux/usb/gadget.h>
15*4882a593Smuzhiyun #include <linux/usb/ch9.h>
16*4882a593Smuzhiyun #include <linux/list.h>
17*4882a593Smuzhiyun #include <linux/timer.h>
18*4882a593Smuzhiyun #include <linux/time.h>
19*4882a593Smuzhiyun #include <linux/sysfs.h>
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #include "usbip_common.h"
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun #define GADGET_NAME "usbip-vudc"
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun struct vep {
26*4882a593Smuzhiyun struct usb_ep ep;
27*4882a593Smuzhiyun unsigned type:2; /* type, as USB_ENDPOINT_XFER_* */
28*4882a593Smuzhiyun char name[8]; /* space for ep name */
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun const struct usb_endpoint_descriptor *desc;
31*4882a593Smuzhiyun struct usb_gadget *gadget;
32*4882a593Smuzhiyun struct list_head req_queue; /* Request queue */
33*4882a593Smuzhiyun unsigned halted:1;
34*4882a593Smuzhiyun unsigned wedged:1;
35*4882a593Smuzhiyun unsigned already_seen:1;
36*4882a593Smuzhiyun unsigned setup_stage:1;
37*4882a593Smuzhiyun };
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun struct vrequest {
40*4882a593Smuzhiyun struct usb_request req;
41*4882a593Smuzhiyun struct vudc *udc;
42*4882a593Smuzhiyun struct list_head req_entry; /* Request queue */
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun struct urbp {
46*4882a593Smuzhiyun struct urb *urb;
47*4882a593Smuzhiyun struct vep *ep;
48*4882a593Smuzhiyun struct list_head urb_entry; /* urb queue */
49*4882a593Smuzhiyun unsigned long seqnum;
50*4882a593Smuzhiyun unsigned type:2; /* for tx, since ep type can change after */
51*4882a593Smuzhiyun unsigned new:1;
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun struct v_unlink {
55*4882a593Smuzhiyun unsigned long seqnum;
56*4882a593Smuzhiyun __u32 status;
57*4882a593Smuzhiyun };
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun enum tx_type {
60*4882a593Smuzhiyun TX_UNLINK,
61*4882a593Smuzhiyun TX_SUBMIT,
62*4882a593Smuzhiyun };
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun struct tx_item {
65*4882a593Smuzhiyun struct list_head tx_entry;
66*4882a593Smuzhiyun enum tx_type type;
67*4882a593Smuzhiyun union {
68*4882a593Smuzhiyun struct urbp *s;
69*4882a593Smuzhiyun struct v_unlink *u;
70*4882a593Smuzhiyun };
71*4882a593Smuzhiyun };
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun enum tr_state {
74*4882a593Smuzhiyun VUDC_TR_RUNNING,
75*4882a593Smuzhiyun VUDC_TR_IDLE,
76*4882a593Smuzhiyun VUDC_TR_STOPPED,
77*4882a593Smuzhiyun };
78*4882a593Smuzhiyun
79*4882a593Smuzhiyun struct transfer_timer {
80*4882a593Smuzhiyun struct timer_list timer;
81*4882a593Smuzhiyun enum tr_state state;
82*4882a593Smuzhiyun unsigned long frame_start;
83*4882a593Smuzhiyun int frame_limit;
84*4882a593Smuzhiyun };
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun struct vudc {
87*4882a593Smuzhiyun struct usb_gadget gadget;
88*4882a593Smuzhiyun struct usb_gadget_driver *driver;
89*4882a593Smuzhiyun struct platform_device *pdev;
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun struct usb_device_descriptor dev_desc;
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun struct usbip_device ud;
94*4882a593Smuzhiyun struct transfer_timer tr_timer;
95*4882a593Smuzhiyun struct timespec64 start_time;
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun struct list_head urb_queue;
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun spinlock_t lock_tx;
100*4882a593Smuzhiyun struct list_head tx_queue;
101*4882a593Smuzhiyun wait_queue_head_t tx_waitq;
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun spinlock_t lock;
104*4882a593Smuzhiyun struct vep *ep;
105*4882a593Smuzhiyun int address;
106*4882a593Smuzhiyun u16 devstatus;
107*4882a593Smuzhiyun
108*4882a593Smuzhiyun unsigned pullup:1;
109*4882a593Smuzhiyun unsigned connected:1;
110*4882a593Smuzhiyun unsigned desc_cached:1;
111*4882a593Smuzhiyun };
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun struct vudc_device {
114*4882a593Smuzhiyun struct platform_device *pdev;
115*4882a593Smuzhiyun struct list_head dev_entry;
116*4882a593Smuzhiyun };
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun extern const struct attribute_group *vudc_groups[];
119*4882a593Smuzhiyun
120*4882a593Smuzhiyun /* visible everywhere */
121*4882a593Smuzhiyun
to_vep(struct usb_ep * _ep)122*4882a593Smuzhiyun static inline struct vep *to_vep(struct usb_ep *_ep)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun return container_of(_ep, struct vep, ep);
125*4882a593Smuzhiyun }
126*4882a593Smuzhiyun
to_vrequest(struct usb_request * _req)127*4882a593Smuzhiyun static inline struct vrequest *to_vrequest(
128*4882a593Smuzhiyun struct usb_request *_req)
129*4882a593Smuzhiyun {
130*4882a593Smuzhiyun return container_of(_req, struct vrequest, req);
131*4882a593Smuzhiyun }
132*4882a593Smuzhiyun
usb_gadget_to_vudc(struct usb_gadget * _gadget)133*4882a593Smuzhiyun static inline struct vudc *usb_gadget_to_vudc(
134*4882a593Smuzhiyun struct usb_gadget *_gadget)
135*4882a593Smuzhiyun {
136*4882a593Smuzhiyun return container_of(_gadget, struct vudc, gadget);
137*4882a593Smuzhiyun }
138*4882a593Smuzhiyun
ep_to_vudc(struct vep * ep)139*4882a593Smuzhiyun static inline struct vudc *ep_to_vudc(struct vep *ep)
140*4882a593Smuzhiyun {
141*4882a593Smuzhiyun return container_of(ep->gadget, struct vudc, gadget);
142*4882a593Smuzhiyun }
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun /* vudc_sysfs.c */
145*4882a593Smuzhiyun
146*4882a593Smuzhiyun int get_gadget_descs(struct vudc *udc);
147*4882a593Smuzhiyun
148*4882a593Smuzhiyun /* vudc_tx.c */
149*4882a593Smuzhiyun
150*4882a593Smuzhiyun int v_tx_loop(void *data);
151*4882a593Smuzhiyun void v_enqueue_ret_unlink(struct vudc *udc, __u32 seqnum, __u32 status);
152*4882a593Smuzhiyun void v_enqueue_ret_submit(struct vudc *udc, struct urbp *urb_p);
153*4882a593Smuzhiyun
154*4882a593Smuzhiyun /* vudc_rx.c */
155*4882a593Smuzhiyun
156*4882a593Smuzhiyun int v_rx_loop(void *data);
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun /* vudc_transfer.c */
159*4882a593Smuzhiyun
160*4882a593Smuzhiyun void v_init_timer(struct vudc *udc);
161*4882a593Smuzhiyun void v_start_timer(struct vudc *udc);
162*4882a593Smuzhiyun void v_kick_timer(struct vudc *udc, unsigned long time);
163*4882a593Smuzhiyun void v_stop_timer(struct vudc *udc);
164*4882a593Smuzhiyun
165*4882a593Smuzhiyun /* vudc_dev.c */
166*4882a593Smuzhiyun
167*4882a593Smuzhiyun struct urbp *alloc_urbp(void);
168*4882a593Smuzhiyun void free_urbp_and_urb(struct urbp *urb_p);
169*4882a593Smuzhiyun
170*4882a593Smuzhiyun struct vep *vudc_find_endpoint(struct vudc *udc, u8 address);
171*4882a593Smuzhiyun
172*4882a593Smuzhiyun struct vudc_device *alloc_vudc_device(int devid);
173*4882a593Smuzhiyun void put_vudc_device(struct vudc_device *udc_dev);
174*4882a593Smuzhiyun
175*4882a593Smuzhiyun int vudc_probe(struct platform_device *pdev);
176*4882a593Smuzhiyun int vudc_remove(struct platform_device *pdev);
177*4882a593Smuzhiyun
178*4882a593Smuzhiyun #endif /* __USBIP_VUDC_H */
179