• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Cadence USBSS DRD Driver - gadget side.
4  *
5  * Copyright (C) 2018-2019 Cadence Design Systems.
6  * Copyright (C) 2017-2018 NXP
7  *
8  * Authors: Pawel Jez <pjez@cadence.com>,
9  *          Pawel Laszczak <pawell@cadence.com>
10  *          Peter Chen <peter.chen@nxp.com>
11  */
12 
13 /*
14  * Work around 1:
15  * At some situations, the controller may get stale data address in TRB
16  * at below sequences:
17  * 1. Controller read TRB includes data address
18  * 2. Software updates TRBs includes data address and Cycle bit
19  * 3. Controller read TRB which includes Cycle bit
20  * 4. DMA run with stale data address
21  *
22  * To fix this problem, driver needs to make the first TRB in TD as invalid.
23  * After preparing all TRBs driver needs to check the position of DMA and
24  * if the DMA point to the first just added TRB and doorbell is 1,
25  * then driver must defer making this TRB as valid. This TRB will be make
26  * as valid during adding next TRB only if DMA is stopped or at TRBERR
27  * interrupt.
28  *
29  * Issue has been fixed in DEV_VER_V3 version of controller.
30  *
31  * Work around 2:
32  * Controller for OUT endpoints has shared on-chip buffers for all incoming
33  * packets, including ep0out. It's FIFO buffer, so packets must be handle by DMA
34  * in correct order. If the first packet in the buffer will not be handled,
35  * then the following packets directed for other endpoints and  functions
36  * will be blocked.
37  * Additionally the packets directed to one endpoint can block entire on-chip
38  * buffers. In this case transfer to other endpoints also will blocked.
39  *
40  * To resolve this issue after raising the descriptor missing interrupt
41  * driver prepares internal usb_request object and use it to arm DMA transfer.
42  *
43  * The problematic situation was observed in case when endpoint has been enabled
44  * but no usb_request were queued. Driver try detects such endpoints and will
45  * use this workaround only for these endpoint.
46  *
47  * Driver use limited number of buffer. This number can be set by macro
48  * CDNS3_WA2_NUM_BUFFERS.
49  *
50  * Such blocking situation was observed on ACM gadget. For this function
51  * host send OUT data packet but ACM function is not prepared for this packet.
52  * It's cause that buffer placed in on chip memory block transfer to other
53  * endpoints.
54  *
55  * Issue has been fixed in DEV_VER_V2 version of controller.
56  *
57  */
58 
59 #include <linux/dma-mapping.h>
60 #include <linux/usb/gadget.h>
61 #include <linux/module.h>
62 #include <linux/iopoll.h>
63 
64 #include "core.h"
65 #include "gadget-export.h"
66 #include "gadget.h"
67 #include "trace.h"
68 #include "drd.h"
69 
70 static int __cdns3_gadget_ep_queue(struct usb_ep *ep,
71 				   struct usb_request *request,
72 				   gfp_t gfp_flags);
73 
74 static int cdns3_ep_run_transfer(struct cdns3_endpoint *priv_ep,
75 				 struct usb_request *request);
76 
77 static int cdns3_ep_run_stream_transfer(struct cdns3_endpoint *priv_ep,
78 					struct usb_request *request);
79 
80 /**
81  * cdns3_clear_register_bit - clear bit in given register.
82  * @ptr: address of device controller register to be read and changed
83  * @mask: bits requested to clar
84  */
cdns3_clear_register_bit(void __iomem * ptr,u32 mask)85 static void cdns3_clear_register_bit(void __iomem *ptr, u32 mask)
86 {
87 	mask = readl(ptr) & ~mask;
88 	writel(mask, ptr);
89 }
90 
91 /**
92  * cdns3_set_register_bit - set bit in given register.
93  * @ptr: address of device controller register to be read and changed
94  * @mask: bits requested to set
95  */
cdns3_set_register_bit(void __iomem * ptr,u32 mask)96 void cdns3_set_register_bit(void __iomem *ptr, u32 mask)
97 {
98 	mask = readl(ptr) | mask;
99 	writel(mask, ptr);
100 }
101 
102 /**
103  * cdns3_ep_addr_to_index - Macro converts endpoint address to
104  * index of endpoint object in cdns3_device.eps[] container
105  * @ep_addr: endpoint address for which endpoint object is required
106  *
107  */
cdns3_ep_addr_to_index(u8 ep_addr)108 u8 cdns3_ep_addr_to_index(u8 ep_addr)
109 {
110 	return (((ep_addr & 0x7F)) + ((ep_addr & USB_DIR_IN) ? 16 : 0));
111 }
112 
cdns3_get_dma_pos(struct cdns3_device * priv_dev,struct cdns3_endpoint * priv_ep)113 static int cdns3_get_dma_pos(struct cdns3_device *priv_dev,
114 			     struct cdns3_endpoint *priv_ep)
115 {
116 	int dma_index;
117 
118 	dma_index = readl(&priv_dev->regs->ep_traddr) - priv_ep->trb_pool_dma;
119 
120 	return dma_index / TRB_SIZE;
121 }
122 
123 /**
124  * cdns3_next_request - returns next request from list
125  * @list: list containing requests
126  *
127  * Returns request or NULL if no requests in list
128  */
cdns3_next_request(struct list_head * list)129 struct usb_request *cdns3_next_request(struct list_head *list)
130 {
131 	return list_first_entry_or_null(list, struct usb_request, list);
132 }
133 
134 /**
135  * cdns3_next_align_buf - returns next buffer from list
136  * @list: list containing buffers
137  *
138  * Returns buffer or NULL if no buffers in list
139  */
cdns3_next_align_buf(struct list_head * list)140 static struct cdns3_aligned_buf *cdns3_next_align_buf(struct list_head *list)
141 {
142 	return list_first_entry_or_null(list, struct cdns3_aligned_buf, list);
143 }
144 
145 /**
146  * cdns3_next_priv_request - returns next request from list
147  * @list: list containing requests
148  *
149  * Returns request or NULL if no requests in list
150  */
cdns3_next_priv_request(struct list_head * list)151 static struct cdns3_request *cdns3_next_priv_request(struct list_head *list)
152 {
153 	return list_first_entry_or_null(list, struct cdns3_request, list);
154 }
155 
156 /**
157  * select_ep - selects endpoint
158  * @priv_dev:  extended gadget object
159  * @ep: endpoint address
160  */
cdns3_select_ep(struct cdns3_device * priv_dev,u32 ep)161 void cdns3_select_ep(struct cdns3_device *priv_dev, u32 ep)
162 {
163 	if (priv_dev->selected_ep == ep)
164 		return;
165 
166 	priv_dev->selected_ep = ep;
167 	writel(ep, &priv_dev->regs->ep_sel);
168 }
169 
170 /**
171  * cdns3_get_tdl - gets current tdl for selected endpoint.
172  * @priv_dev:  extended gadget object
173  *
174  * Before calling this function the appropriate endpoint must
175  * be selected by means of cdns3_select_ep function.
176  */
cdns3_get_tdl(struct cdns3_device * priv_dev)177 static int cdns3_get_tdl(struct cdns3_device *priv_dev)
178 {
179 	if (priv_dev->dev_ver < DEV_VER_V3)
180 		return EP_CMD_TDL_GET(readl(&priv_dev->regs->ep_cmd));
181 	else
182 		return readl(&priv_dev->regs->ep_tdl);
183 }
184 
cdns3_trb_virt_to_dma(struct cdns3_endpoint * priv_ep,struct cdns3_trb * trb)185 dma_addr_t cdns3_trb_virt_to_dma(struct cdns3_endpoint *priv_ep,
186 				 struct cdns3_trb *trb)
187 {
188 	u32 offset = (char *)trb - (char *)priv_ep->trb_pool;
189 
190 	return priv_ep->trb_pool_dma + offset;
191 }
192 
cdns3_ring_size(struct cdns3_endpoint * priv_ep)193 static int cdns3_ring_size(struct cdns3_endpoint *priv_ep)
194 {
195 	switch (priv_ep->type) {
196 	case USB_ENDPOINT_XFER_ISOC:
197 		return TRB_ISO_RING_SIZE;
198 	case USB_ENDPOINT_XFER_CONTROL:
199 		return TRB_CTRL_RING_SIZE;
200 	default:
201 		if (priv_ep->use_streams)
202 			return TRB_STREAM_RING_SIZE;
203 		else
204 			return TRB_RING_SIZE;
205 	}
206 }
207 
cdns3_free_trb_pool(struct cdns3_endpoint * priv_ep)208 static void cdns3_free_trb_pool(struct cdns3_endpoint *priv_ep)
209 {
210 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
211 
212 	if (priv_ep->trb_pool) {
213 		dma_free_coherent(priv_dev->sysdev,
214 				  cdns3_ring_size(priv_ep),
215 				  priv_ep->trb_pool, priv_ep->trb_pool_dma);
216 		priv_ep->trb_pool = NULL;
217 	}
218 }
219 
220 /**
221  * cdns3_allocate_trb_pool - Allocates TRB's pool for selected endpoint
222  * @priv_ep:  endpoint object
223  *
224  * Function will return 0 on success or -ENOMEM on allocation error
225  */
cdns3_allocate_trb_pool(struct cdns3_endpoint * priv_ep)226 int cdns3_allocate_trb_pool(struct cdns3_endpoint *priv_ep)
227 {
228 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
229 	int ring_size = cdns3_ring_size(priv_ep);
230 	int num_trbs = ring_size / TRB_SIZE;
231 	struct cdns3_trb *link_trb;
232 
233 	if (priv_ep->trb_pool && priv_ep->alloc_ring_size < ring_size)
234 		cdns3_free_trb_pool(priv_ep);
235 
236 	if (!priv_ep->trb_pool) {
237 		priv_ep->trb_pool = dma_alloc_coherent(priv_dev->sysdev,
238 						       ring_size,
239 						       &priv_ep->trb_pool_dma,
240 						       GFP_DMA32 | GFP_ATOMIC);
241 		if (!priv_ep->trb_pool)
242 			return -ENOMEM;
243 
244 		priv_ep->alloc_ring_size = ring_size;
245 	}
246 
247 	memset(priv_ep->trb_pool, 0, ring_size);
248 
249 	priv_ep->num_trbs = num_trbs;
250 
251 	if (!priv_ep->num)
252 		return 0;
253 
254 	/* Initialize the last TRB as Link TRB */
255 	link_trb = (priv_ep->trb_pool + (priv_ep->num_trbs - 1));
256 
257 	if (priv_ep->use_streams) {
258 		/*
259 		 * For stream capable endpoints driver use single correct TRB.
260 		 * The last trb has zeroed cycle bit
261 		 */
262 		link_trb->control = 0;
263 	} else {
264 		link_trb->buffer = cpu_to_le32(TRB_BUFFER(priv_ep->trb_pool_dma));
265 		link_trb->control = cpu_to_le32(TRB_CYCLE | TRB_TYPE(TRB_LINK) | TRB_TOGGLE);
266 	}
267 	return 0;
268 }
269 
270 /**
271  * cdns3_ep_stall_flush - Stalls and flushes selected endpoint
272  * @priv_ep: endpoint object
273  *
274  * Endpoint must be selected before call to this function
275  */
cdns3_ep_stall_flush(struct cdns3_endpoint * priv_ep)276 static void cdns3_ep_stall_flush(struct cdns3_endpoint *priv_ep)
277 {
278 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
279 	int val;
280 
281 	trace_cdns3_halt(priv_ep, 1, 1);
282 
283 	writel(EP_CMD_DFLUSH | EP_CMD_ERDY | EP_CMD_SSTALL,
284 	       &priv_dev->regs->ep_cmd);
285 
286 	/* wait for DFLUSH cleared */
287 	readl_poll_timeout_atomic(&priv_dev->regs->ep_cmd, val,
288 				  !(val & EP_CMD_DFLUSH), 1, 1000);
289 	priv_ep->flags |= EP_STALLED;
290 	priv_ep->flags &= ~EP_STALL_PENDING;
291 }
292 
293 /**
294  * cdns3_hw_reset_eps_config - reset endpoints configuration kept by controller.
295  * @priv_dev: extended gadget object
296  */
cdns3_hw_reset_eps_config(struct cdns3_device * priv_dev)297 void cdns3_hw_reset_eps_config(struct cdns3_device *priv_dev)
298 {
299 	int i;
300 
301 	writel(USB_CONF_CFGRST, &priv_dev->regs->usb_conf);
302 
303 	cdns3_allow_enable_l1(priv_dev, 0);
304 	priv_dev->hw_configured_flag = 0;
305 	priv_dev->onchip_used_size = 0;
306 	priv_dev->out_mem_is_allocated = 0;
307 	priv_dev->wait_for_setup = 0;
308 	priv_dev->using_streams = 0;
309 
310 	for (i = 0; i < CDNS3_ENDPOINTS_MAX_COUNT; i++)
311 		if (priv_dev->eps[i])
312 			priv_dev->eps[i]->flags &= ~EP_CONFIGURED;
313 }
314 
315 /**
316  * cdns3_ep_inc_trb - increment a trb index.
317  * @index: Pointer to the TRB index to increment.
318  * @cs: Cycle state
319  * @trb_in_seg: number of TRBs in segment
320  *
321  * The index should never point to the link TRB. After incrementing,
322  * if it is point to the link TRB, wrap around to the beginning and revert
323  * cycle state bit The
324  * link TRB is always at the last TRB entry.
325  */
cdns3_ep_inc_trb(int * index,u8 * cs,int trb_in_seg)326 static void cdns3_ep_inc_trb(int *index, u8 *cs, int trb_in_seg)
327 {
328 	(*index)++;
329 	if (*index == (trb_in_seg - 1)) {
330 		*index = 0;
331 		*cs ^=  1;
332 	}
333 }
334 
335 /**
336  * cdns3_ep_inc_enq - increment endpoint's enqueue pointer
337  * @priv_ep: The endpoint whose enqueue pointer we're incrementing
338  */
cdns3_ep_inc_enq(struct cdns3_endpoint * priv_ep)339 static void cdns3_ep_inc_enq(struct cdns3_endpoint *priv_ep)
340 {
341 	priv_ep->free_trbs--;
342 	cdns3_ep_inc_trb(&priv_ep->enqueue, &priv_ep->pcs, priv_ep->num_trbs);
343 }
344 
345 /**
346  * cdns3_ep_inc_deq - increment endpoint's dequeue pointer
347  * @priv_ep: The endpoint whose dequeue pointer we're incrementing
348  */
cdns3_ep_inc_deq(struct cdns3_endpoint * priv_ep)349 static void cdns3_ep_inc_deq(struct cdns3_endpoint *priv_ep)
350 {
351 	priv_ep->free_trbs++;
352 	cdns3_ep_inc_trb(&priv_ep->dequeue, &priv_ep->ccs, priv_ep->num_trbs);
353 }
354 
355 /**
356  * cdns3_allow_enable_l1 - enable/disable permits to transition to L1.
357  * @priv_dev: Extended gadget object
358  * @enable: Enable/disable permit to transition to L1.
359  *
360  * If bit USB_CONF_L1EN is set and device receive Extended Token packet,
361  * then controller answer with ACK handshake.
362  * If bit USB_CONF_L1DS is set and device receive Extended Token packet,
363  * then controller answer with NYET handshake.
364  */
cdns3_allow_enable_l1(struct cdns3_device * priv_dev,int enable)365 void cdns3_allow_enable_l1(struct cdns3_device *priv_dev, int enable)
366 {
367 	if (enable)
368 		writel(USB_CONF_L1EN, &priv_dev->regs->usb_conf);
369 	else
370 		writel(USB_CONF_L1DS, &priv_dev->regs->usb_conf);
371 }
372 
cdns3_get_speed(struct cdns3_device * priv_dev)373 enum usb_device_speed cdns3_get_speed(struct cdns3_device *priv_dev)
374 {
375 	u32 reg;
376 
377 	reg = readl(&priv_dev->regs->usb_sts);
378 
379 	if (DEV_SUPERSPEED(reg))
380 		return USB_SPEED_SUPER;
381 	else if (DEV_HIGHSPEED(reg))
382 		return USB_SPEED_HIGH;
383 	else if (DEV_FULLSPEED(reg))
384 		return USB_SPEED_FULL;
385 	else if (DEV_LOWSPEED(reg))
386 		return USB_SPEED_LOW;
387 	return USB_SPEED_UNKNOWN;
388 }
389 
390 /**
391  * cdns3_start_all_request - add to ring all request not started
392  * @priv_dev: Extended gadget object
393  * @priv_ep: The endpoint for whom request will be started.
394  *
395  * Returns return ENOMEM if transfer ring i not enough TRBs to start
396  *         all requests.
397  */
cdns3_start_all_request(struct cdns3_device * priv_dev,struct cdns3_endpoint * priv_ep)398 static int cdns3_start_all_request(struct cdns3_device *priv_dev,
399 				   struct cdns3_endpoint *priv_ep)
400 {
401 	struct usb_request *request;
402 	int ret = 0;
403 	u8 pending_empty = list_empty(&priv_ep->pending_req_list);
404 
405 	/*
406 	 * If the last pending transfer is INTERNAL
407 	 * OR streams are enabled for this endpoint
408 	 * do NOT start new transfer till the last one is pending
409 	 */
410 	if (!pending_empty) {
411 		struct cdns3_request *priv_req;
412 
413 		request = cdns3_next_request(&priv_ep->pending_req_list);
414 		priv_req = to_cdns3_request(request);
415 		if ((priv_req->flags & REQUEST_INTERNAL) ||
416 		    (priv_ep->flags & EP_TDLCHK_EN) ||
417 			priv_ep->use_streams) {
418 			dev_dbg(priv_dev->dev, "Blocking external request\n");
419 			return ret;
420 		}
421 	}
422 
423 	while (!list_empty(&priv_ep->deferred_req_list)) {
424 		request = cdns3_next_request(&priv_ep->deferred_req_list);
425 
426 		if (!priv_ep->use_streams) {
427 			ret = cdns3_ep_run_transfer(priv_ep, request);
428 		} else {
429 			priv_ep->stream_sg_idx = 0;
430 			ret = cdns3_ep_run_stream_transfer(priv_ep, request);
431 		}
432 		if (ret)
433 			return ret;
434 
435 		list_del(&request->list);
436 		list_add_tail(&request->list,
437 			      &priv_ep->pending_req_list);
438 		if (request->stream_id != 0 || (priv_ep->flags & EP_TDLCHK_EN))
439 			break;
440 	}
441 
442 	priv_ep->flags &= ~EP_RING_FULL;
443 	return ret;
444 }
445 
446 /*
447  * WA2: Set flag for all not ISOC OUT endpoints. If this flag is set
448  * driver try to detect whether endpoint need additional internal
449  * buffer for unblocking on-chip FIFO buffer. This flag will be cleared
450  * if before first DESCMISS interrupt the DMA will be armed.
451  */
452 #define cdns3_wa2_enable_detection(priv_dev, priv_ep, reg) do { \
453 	if (!priv_ep->dir && priv_ep->type != USB_ENDPOINT_XFER_ISOC) { \
454 		priv_ep->flags |= EP_QUIRK_EXTRA_BUF_DET; \
455 		(reg) |= EP_STS_EN_DESCMISEN; \
456 	} } while (0)
457 
__cdns3_descmiss_copy_data(struct usb_request * request,struct usb_request * descmiss_req)458 static void __cdns3_descmiss_copy_data(struct usb_request *request,
459 	struct usb_request *descmiss_req)
460 {
461 	int length = request->actual + descmiss_req->actual;
462 	struct scatterlist *s = request->sg;
463 
464 	if (!s) {
465 		if (length <= request->length) {
466 			memcpy(&((u8 *)request->buf)[request->actual],
467 			       descmiss_req->buf,
468 			       descmiss_req->actual);
469 			request->actual = length;
470 		} else {
471 			/* It should never occures */
472 			request->status = -ENOMEM;
473 		}
474 	} else {
475 		if (length <= sg_dma_len(s)) {
476 			void *p = phys_to_virt(sg_dma_address(s));
477 
478 			memcpy(&((u8 *)p)[request->actual],
479 				descmiss_req->buf,
480 				descmiss_req->actual);
481 			request->actual = length;
482 		} else {
483 			request->status = -ENOMEM;
484 		}
485 	}
486 }
487 
488 /**
489  * cdns3_wa2_descmiss_copy_data copy data from internal requests to
490  * request queued by class driver.
491  * @priv_ep: extended endpoint object
492  * @request: request object
493  */
cdns3_wa2_descmiss_copy_data(struct cdns3_endpoint * priv_ep,struct usb_request * request)494 static void cdns3_wa2_descmiss_copy_data(struct cdns3_endpoint *priv_ep,
495 					 struct usb_request *request)
496 {
497 	struct usb_request *descmiss_req;
498 	struct cdns3_request *descmiss_priv_req;
499 
500 	while (!list_empty(&priv_ep->wa2_descmiss_req_list)) {
501 		int chunk_end;
502 
503 		descmiss_priv_req =
504 			cdns3_next_priv_request(&priv_ep->wa2_descmiss_req_list);
505 		descmiss_req = &descmiss_priv_req->request;
506 
507 		/* driver can't touch pending request */
508 		if (descmiss_priv_req->flags & REQUEST_PENDING)
509 			break;
510 
511 		chunk_end = descmiss_priv_req->flags & REQUEST_INTERNAL_CH;
512 		request->status = descmiss_req->status;
513 		__cdns3_descmiss_copy_data(request, descmiss_req);
514 		list_del_init(&descmiss_priv_req->list);
515 		kfree(descmiss_req->buf);
516 		cdns3_gadget_ep_free_request(&priv_ep->endpoint, descmiss_req);
517 		--priv_ep->wa2_counter;
518 
519 		if (!chunk_end)
520 			break;
521 	}
522 }
523 
cdns3_wa2_gadget_giveback(struct cdns3_device * priv_dev,struct cdns3_endpoint * priv_ep,struct cdns3_request * priv_req)524 static struct usb_request *cdns3_wa2_gadget_giveback(struct cdns3_device *priv_dev,
525 						     struct cdns3_endpoint *priv_ep,
526 						     struct cdns3_request *priv_req)
527 {
528 	if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN &&
529 	    priv_req->flags & REQUEST_INTERNAL) {
530 		struct usb_request *req;
531 
532 		req = cdns3_next_request(&priv_ep->deferred_req_list);
533 
534 		priv_ep->descmis_req = NULL;
535 
536 		if (!req)
537 			return NULL;
538 
539 		/* unmap the gadget request before copying data */
540 		usb_gadget_unmap_request_by_dev(priv_dev->sysdev, req,
541 						priv_ep->dir);
542 
543 		cdns3_wa2_descmiss_copy_data(priv_ep, req);
544 		if (!(priv_ep->flags & EP_QUIRK_END_TRANSFER) &&
545 		    req->length != req->actual) {
546 			/* wait for next part of transfer */
547 			/* re-map the gadget request buffer*/
548 			usb_gadget_map_request_by_dev(priv_dev->sysdev, req,
549 				usb_endpoint_dir_in(priv_ep->endpoint.desc));
550 			return NULL;
551 		}
552 
553 		if (req->status == -EINPROGRESS)
554 			req->status = 0;
555 
556 		list_del_init(&req->list);
557 		cdns3_start_all_request(priv_dev, priv_ep);
558 		return req;
559 	}
560 
561 	return &priv_req->request;
562 }
563 
cdns3_wa2_gadget_ep_queue(struct cdns3_device * priv_dev,struct cdns3_endpoint * priv_ep,struct cdns3_request * priv_req)564 static int cdns3_wa2_gadget_ep_queue(struct cdns3_device *priv_dev,
565 				     struct cdns3_endpoint *priv_ep,
566 				     struct cdns3_request *priv_req)
567 {
568 	int deferred = 0;
569 
570 	/*
571 	 * If transfer was queued before DESCMISS appear than we
572 	 * can disable handling of DESCMISS interrupt. Driver assumes that it
573 	 * can disable special treatment for this endpoint.
574 	 */
575 	if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) {
576 		u32 reg;
577 
578 		cdns3_select_ep(priv_dev, priv_ep->num | priv_ep->dir);
579 		priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET;
580 		reg = readl(&priv_dev->regs->ep_sts_en);
581 		reg &= ~EP_STS_EN_DESCMISEN;
582 		trace_cdns3_wa2(priv_ep, "workaround disabled\n");
583 		writel(reg, &priv_dev->regs->ep_sts_en);
584 	}
585 
586 	if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) {
587 		u8 pending_empty = list_empty(&priv_ep->pending_req_list);
588 		u8 descmiss_empty = list_empty(&priv_ep->wa2_descmiss_req_list);
589 
590 		/*
591 		 *  DESCMISS transfer has been finished, so data will be
592 		 *  directly copied from internal allocated usb_request
593 		 *  objects.
594 		 */
595 		if (pending_empty && !descmiss_empty &&
596 		    !(priv_req->flags & REQUEST_INTERNAL)) {
597 			cdns3_wa2_descmiss_copy_data(priv_ep,
598 						     &priv_req->request);
599 
600 			trace_cdns3_wa2(priv_ep, "get internal stored data");
601 
602 			list_add_tail(&priv_req->request.list,
603 				      &priv_ep->pending_req_list);
604 			cdns3_gadget_giveback(priv_ep, priv_req,
605 					      priv_req->request.status);
606 
607 			/*
608 			 * Intentionally driver returns positive value as
609 			 * correct value. It informs that transfer has
610 			 * been finished.
611 			 */
612 			return EINPROGRESS;
613 		}
614 
615 		/*
616 		 * Driver will wait for completion DESCMISS transfer,
617 		 * before starts new, not DESCMISS transfer.
618 		 */
619 		if (!pending_empty && !descmiss_empty) {
620 			trace_cdns3_wa2(priv_ep, "wait for pending transfer\n");
621 			deferred = 1;
622 		}
623 
624 		if (priv_req->flags & REQUEST_INTERNAL)
625 			list_add_tail(&priv_req->list,
626 				      &priv_ep->wa2_descmiss_req_list);
627 	}
628 
629 	return deferred;
630 }
631 
cdns3_wa2_remove_old_request(struct cdns3_endpoint * priv_ep)632 static void cdns3_wa2_remove_old_request(struct cdns3_endpoint *priv_ep)
633 {
634 	struct cdns3_request *priv_req;
635 
636 	while (!list_empty(&priv_ep->wa2_descmiss_req_list)) {
637 		u8 chain;
638 
639 		priv_req = cdns3_next_priv_request(&priv_ep->wa2_descmiss_req_list);
640 		chain = !!(priv_req->flags & REQUEST_INTERNAL_CH);
641 
642 		trace_cdns3_wa2(priv_ep, "removes eldest request");
643 
644 		kfree(priv_req->request.buf);
645 		list_del_init(&priv_req->list);
646 		cdns3_gadget_ep_free_request(&priv_ep->endpoint,
647 					     &priv_req->request);
648 		--priv_ep->wa2_counter;
649 
650 		if (!chain)
651 			break;
652 	}
653 }
654 
655 /**
656  * cdns3_wa2_descmissing_packet - handles descriptor missing event.
657  * @priv_ep: extended gadget object
658  *
659  * This function is used only for WA2. For more information see Work around 2
660  * description.
661  */
cdns3_wa2_descmissing_packet(struct cdns3_endpoint * priv_ep)662 static void cdns3_wa2_descmissing_packet(struct cdns3_endpoint *priv_ep)
663 {
664 	struct cdns3_request *priv_req;
665 	struct usb_request *request;
666 	u8 pending_empty = list_empty(&priv_ep->pending_req_list);
667 
668 	/* check for pending transfer */
669 	if (!pending_empty) {
670 		trace_cdns3_wa2(priv_ep, "Ignoring Descriptor missing IRQ\n");
671 		return;
672 	}
673 
674 	if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) {
675 		priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET;
676 		priv_ep->flags |= EP_QUIRK_EXTRA_BUF_EN;
677 	}
678 
679 	trace_cdns3_wa2(priv_ep, "Description Missing detected\n");
680 
681 	if (priv_ep->wa2_counter >= CDNS3_WA2_NUM_BUFFERS) {
682 		trace_cdns3_wa2(priv_ep, "WA2 overflow\n");
683 		cdns3_wa2_remove_old_request(priv_ep);
684 	}
685 
686 	request = cdns3_gadget_ep_alloc_request(&priv_ep->endpoint,
687 						GFP_ATOMIC);
688 	if (!request)
689 		goto err;
690 
691 	priv_req = to_cdns3_request(request);
692 	priv_req->flags |= REQUEST_INTERNAL;
693 
694 	/* if this field is still assigned it indicate that transfer related
695 	 * with this request has not been finished yet. Driver in this
696 	 * case simply allocate next request and assign flag REQUEST_INTERNAL_CH
697 	 * flag to previous one. It will indicate that current request is
698 	 * part of the previous one.
699 	 */
700 	if (priv_ep->descmis_req)
701 		priv_ep->descmis_req->flags |= REQUEST_INTERNAL_CH;
702 
703 	priv_req->request.buf = kzalloc(CDNS3_DESCMIS_BUF_SIZE,
704 					GFP_ATOMIC);
705 	priv_ep->wa2_counter++;
706 
707 	if (!priv_req->request.buf) {
708 		cdns3_gadget_ep_free_request(&priv_ep->endpoint, request);
709 		goto err;
710 	}
711 
712 	priv_req->request.length = CDNS3_DESCMIS_BUF_SIZE;
713 	priv_ep->descmis_req = priv_req;
714 
715 	__cdns3_gadget_ep_queue(&priv_ep->endpoint,
716 				&priv_ep->descmis_req->request,
717 				GFP_ATOMIC);
718 
719 	return;
720 
721 err:
722 	dev_err(priv_ep->cdns3_dev->dev,
723 		"Failed: No sufficient memory for DESCMIS\n");
724 }
725 
cdns3_wa2_reset_tdl(struct cdns3_device * priv_dev)726 static void cdns3_wa2_reset_tdl(struct cdns3_device *priv_dev)
727 {
728 	u16 tdl = EP_CMD_TDL_GET(readl(&priv_dev->regs->ep_cmd));
729 
730 	if (tdl) {
731 		u16 reset_val = EP_CMD_TDL_MAX + 1 - tdl;
732 
733 		writel(EP_CMD_TDL_SET(reset_val) | EP_CMD_STDL,
734 		       &priv_dev->regs->ep_cmd);
735 	}
736 }
737 
cdns3_wa2_check_outq_status(struct cdns3_device * priv_dev)738 static void cdns3_wa2_check_outq_status(struct cdns3_device *priv_dev)
739 {
740 	u32 ep_sts_reg;
741 
742 	/* select EP0-out */
743 	cdns3_select_ep(priv_dev, 0);
744 
745 	ep_sts_reg = readl(&priv_dev->regs->ep_sts);
746 
747 	if (EP_STS_OUTQ_VAL(ep_sts_reg)) {
748 		u32 outq_ep_num = EP_STS_OUTQ_NO(ep_sts_reg);
749 		struct cdns3_endpoint *outq_ep = priv_dev->eps[outq_ep_num];
750 
751 		if ((outq_ep->flags & EP_ENABLED) && !(outq_ep->use_streams) &&
752 		    outq_ep->type != USB_ENDPOINT_XFER_ISOC && outq_ep_num) {
753 			u8 pending_empty = list_empty(&outq_ep->pending_req_list);
754 
755 			if ((outq_ep->flags & EP_QUIRK_EXTRA_BUF_DET) ||
756 			    (outq_ep->flags & EP_QUIRK_EXTRA_BUF_EN) ||
757 			    !pending_empty) {
758 			} else {
759 				u32 ep_sts_en_reg;
760 				u32 ep_cmd_reg;
761 
762 				cdns3_select_ep(priv_dev, outq_ep->num |
763 						outq_ep->dir);
764 				ep_sts_en_reg = readl(&priv_dev->regs->ep_sts_en);
765 				ep_cmd_reg = readl(&priv_dev->regs->ep_cmd);
766 
767 				outq_ep->flags |= EP_TDLCHK_EN;
768 				cdns3_set_register_bit(&priv_dev->regs->ep_cfg,
769 						       EP_CFG_TDL_CHK);
770 
771 				cdns3_wa2_enable_detection(priv_dev, outq_ep,
772 							   ep_sts_en_reg);
773 				writel(ep_sts_en_reg,
774 				       &priv_dev->regs->ep_sts_en);
775 				/* reset tdl value to zero */
776 				cdns3_wa2_reset_tdl(priv_dev);
777 				/*
778 				 * Memory barrier - Reset tdl before ringing the
779 				 * doorbell.
780 				 */
781 				wmb();
782 				if (EP_CMD_DRDY & ep_cmd_reg) {
783 					trace_cdns3_wa2(outq_ep, "Enabling WA2 skipping doorbell\n");
784 
785 				} else {
786 					trace_cdns3_wa2(outq_ep, "Enabling WA2 ringing doorbell\n");
787 					/*
788 					 * ring doorbell to generate DESCMIS irq
789 					 */
790 					writel(EP_CMD_DRDY,
791 					       &priv_dev->regs->ep_cmd);
792 				}
793 			}
794 		}
795 	}
796 }
797 
798 /**
799  * cdns3_gadget_giveback - call struct usb_request's ->complete callback
800  * @priv_ep: The endpoint to whom the request belongs to
801  * @priv_req: The request we're giving back
802  * @status: completion code for the request
803  *
804  * Must be called with controller's lock held and interrupts disabled. This
805  * function will unmap @req and call its ->complete() callback to notify upper
806  * layers that it has completed.
807  */
cdns3_gadget_giveback(struct cdns3_endpoint * priv_ep,struct cdns3_request * priv_req,int status)808 void cdns3_gadget_giveback(struct cdns3_endpoint *priv_ep,
809 			   struct cdns3_request *priv_req,
810 			   int status)
811 {
812 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
813 	struct usb_request *request = &priv_req->request;
814 
815 	list_del_init(&request->list);
816 
817 	if (request->status == -EINPROGRESS)
818 		request->status = status;
819 
820 	usb_gadget_unmap_request_by_dev(priv_dev->sysdev, request,
821 					priv_ep->dir);
822 
823 	if ((priv_req->flags & REQUEST_UNALIGNED) &&
824 	    priv_ep->dir == USB_DIR_OUT && !request->status)
825 		memcpy(request->buf, priv_req->aligned_buf->buf,
826 		       request->length);
827 
828 	priv_req->flags &= ~(REQUEST_PENDING | REQUEST_UNALIGNED);
829 	/* All TRBs have finished, clear the counter */
830 	priv_req->finished_trb = 0;
831 	trace_cdns3_gadget_giveback(priv_req);
832 
833 	if (priv_dev->dev_ver < DEV_VER_V2) {
834 		request = cdns3_wa2_gadget_giveback(priv_dev, priv_ep,
835 						    priv_req);
836 		if (!request)
837 			return;
838 	}
839 
840 	if (request->complete) {
841 		spin_unlock(&priv_dev->lock);
842 		usb_gadget_giveback_request(&priv_ep->endpoint,
843 					    request);
844 		spin_lock(&priv_dev->lock);
845 	}
846 
847 	if (request->buf == priv_dev->zlp_buf)
848 		cdns3_gadget_ep_free_request(&priv_ep->endpoint, request);
849 }
850 
cdns3_wa1_restore_cycle_bit(struct cdns3_endpoint * priv_ep)851 static void cdns3_wa1_restore_cycle_bit(struct cdns3_endpoint *priv_ep)
852 {
853 	/* Work around for stale data address in TRB*/
854 	if (priv_ep->wa1_set) {
855 		trace_cdns3_wa1(priv_ep, "restore cycle bit");
856 
857 		priv_ep->wa1_set = 0;
858 		priv_ep->wa1_trb_index = 0xFFFF;
859 		if (priv_ep->wa1_cycle_bit) {
860 			priv_ep->wa1_trb->control =
861 				priv_ep->wa1_trb->control | cpu_to_le32(0x1);
862 		} else {
863 			priv_ep->wa1_trb->control =
864 				priv_ep->wa1_trb->control & cpu_to_le32(~0x1);
865 		}
866 	}
867 }
868 
cdns3_free_aligned_request_buf(struct work_struct * work)869 static void cdns3_free_aligned_request_buf(struct work_struct *work)
870 {
871 	struct cdns3_device *priv_dev = container_of(work, struct cdns3_device,
872 					aligned_buf_wq);
873 	struct cdns3_aligned_buf *buf, *tmp;
874 	unsigned long flags;
875 
876 	spin_lock_irqsave(&priv_dev->lock, flags);
877 
878 	list_for_each_entry_safe(buf, tmp, &priv_dev->aligned_buf_list, list) {
879 		if (!buf->in_use) {
880 			list_del(&buf->list);
881 
882 			/*
883 			 * Re-enable interrupts to free DMA capable memory.
884 			 * Driver can't free this memory with disabled
885 			 * interrupts.
886 			 */
887 			spin_unlock_irqrestore(&priv_dev->lock, flags);
888 			dma_free_coherent(priv_dev->sysdev, buf->size,
889 					  buf->buf, buf->dma);
890 			kfree(buf);
891 			spin_lock_irqsave(&priv_dev->lock, flags);
892 		}
893 	}
894 
895 	spin_unlock_irqrestore(&priv_dev->lock, flags);
896 }
897 
cdns3_prepare_aligned_request_buf(struct cdns3_request * priv_req)898 static int cdns3_prepare_aligned_request_buf(struct cdns3_request *priv_req)
899 {
900 	struct cdns3_endpoint *priv_ep = priv_req->priv_ep;
901 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
902 	struct cdns3_aligned_buf *buf;
903 
904 	/* check if buffer is aligned to 8. */
905 	if (!((uintptr_t)priv_req->request.buf & 0x7))
906 		return 0;
907 
908 	buf = priv_req->aligned_buf;
909 
910 	if (!buf || priv_req->request.length > buf->size) {
911 		buf = kzalloc(sizeof(*buf), GFP_ATOMIC);
912 		if (!buf)
913 			return -ENOMEM;
914 
915 		buf->size = priv_req->request.length;
916 
917 		buf->buf = dma_alloc_coherent(priv_dev->sysdev,
918 					      buf->size,
919 					      &buf->dma,
920 					      GFP_ATOMIC);
921 		if (!buf->buf) {
922 			kfree(buf);
923 			return -ENOMEM;
924 		}
925 
926 		if (priv_req->aligned_buf) {
927 			trace_cdns3_free_aligned_request(priv_req);
928 			priv_req->aligned_buf->in_use = 0;
929 			queue_work(system_freezable_wq,
930 				   &priv_dev->aligned_buf_wq);
931 		}
932 
933 		buf->in_use = 1;
934 		priv_req->aligned_buf = buf;
935 
936 		list_add_tail(&buf->list,
937 			      &priv_dev->aligned_buf_list);
938 	}
939 
940 	if (priv_ep->dir == USB_DIR_IN) {
941 		memcpy(buf->buf, priv_req->request.buf,
942 		       priv_req->request.length);
943 	}
944 
945 	priv_req->flags |= REQUEST_UNALIGNED;
946 	trace_cdns3_prepare_aligned_request(priv_req);
947 
948 	return 0;
949 }
950 
cdns3_wa1_update_guard(struct cdns3_endpoint * priv_ep,struct cdns3_trb * trb)951 static int cdns3_wa1_update_guard(struct cdns3_endpoint *priv_ep,
952 				  struct cdns3_trb *trb)
953 {
954 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
955 
956 	if (!priv_ep->wa1_set) {
957 		u32 doorbell;
958 
959 		doorbell = !!(readl(&priv_dev->regs->ep_cmd) & EP_CMD_DRDY);
960 
961 		if (doorbell) {
962 			priv_ep->wa1_cycle_bit = priv_ep->pcs ? TRB_CYCLE : 0;
963 			priv_ep->wa1_set = 1;
964 			priv_ep->wa1_trb = trb;
965 			priv_ep->wa1_trb_index = priv_ep->enqueue;
966 			trace_cdns3_wa1(priv_ep, "set guard");
967 			return 0;
968 		}
969 	}
970 	return 1;
971 }
972 
cdns3_wa1_tray_restore_cycle_bit(struct cdns3_device * priv_dev,struct cdns3_endpoint * priv_ep)973 static void cdns3_wa1_tray_restore_cycle_bit(struct cdns3_device *priv_dev,
974 					     struct cdns3_endpoint *priv_ep)
975 {
976 	int dma_index;
977 	u32 doorbell;
978 
979 	doorbell = !!(readl(&priv_dev->regs->ep_cmd) & EP_CMD_DRDY);
980 	dma_index = cdns3_get_dma_pos(priv_dev, priv_ep);
981 
982 	if (!doorbell || dma_index != priv_ep->wa1_trb_index)
983 		cdns3_wa1_restore_cycle_bit(priv_ep);
984 }
985 
cdns3_ep_run_stream_transfer(struct cdns3_endpoint * priv_ep,struct usb_request * request)986 static int cdns3_ep_run_stream_transfer(struct cdns3_endpoint *priv_ep,
987 					struct usb_request *request)
988 {
989 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
990 	struct cdns3_request *priv_req;
991 	struct cdns3_trb *trb;
992 	dma_addr_t trb_dma;
993 	int address;
994 	u32 control;
995 	u32 length;
996 	u32 tdl;
997 	unsigned int sg_idx = priv_ep->stream_sg_idx;
998 
999 	priv_req = to_cdns3_request(request);
1000 	address = priv_ep->endpoint.desc->bEndpointAddress;
1001 
1002 	priv_ep->flags |= EP_PENDING_REQUEST;
1003 
1004 	/* must allocate buffer aligned to 8 */
1005 	if (priv_req->flags & REQUEST_UNALIGNED)
1006 		trb_dma = priv_req->aligned_buf->dma;
1007 	else
1008 		trb_dma = request->dma;
1009 
1010 	/*  For stream capable endpoints driver use only single TD. */
1011 	trb = priv_ep->trb_pool + priv_ep->enqueue;
1012 	priv_req->start_trb = priv_ep->enqueue;
1013 	priv_req->end_trb = priv_req->start_trb;
1014 	priv_req->trb = trb;
1015 
1016 	cdns3_select_ep(priv_ep->cdns3_dev, address);
1017 
1018 	control = TRB_TYPE(TRB_NORMAL) | TRB_CYCLE |
1019 		  TRB_STREAM_ID(priv_req->request.stream_id) | TRB_ISP;
1020 
1021 	if (!request->num_sgs) {
1022 		trb->buffer = cpu_to_le32(TRB_BUFFER(trb_dma));
1023 		length = request->length;
1024 	} else {
1025 		trb->buffer = cpu_to_le32(TRB_BUFFER(request->sg[sg_idx].dma_address));
1026 		length = request->sg[sg_idx].length;
1027 	}
1028 
1029 	tdl = DIV_ROUND_UP(length, priv_ep->endpoint.maxpacket);
1030 
1031 	trb->length = cpu_to_le32(TRB_BURST_LEN(16) | TRB_LEN(length));
1032 
1033 	/*
1034 	 * For DEV_VER_V2 controller version we have enabled
1035 	 * USB_CONF2_EN_TDL_TRB in DMULT configuration.
1036 	 * This enables TDL calculation based on TRB, hence setting TDL in TRB.
1037 	 */
1038 	if (priv_dev->dev_ver >= DEV_VER_V2) {
1039 		if (priv_dev->gadget.speed == USB_SPEED_SUPER)
1040 			trb->length |= cpu_to_le32(TRB_TDL_SS_SIZE(tdl));
1041 	}
1042 	priv_req->flags |= REQUEST_PENDING;
1043 
1044 	trb->control = cpu_to_le32(control);
1045 
1046 	trace_cdns3_prepare_trb(priv_ep, priv_req->trb);
1047 
1048 	/*
1049 	 * Memory barrier - Cycle Bit must be set before trb->length  and
1050 	 * trb->buffer fields.
1051 	 */
1052 	wmb();
1053 
1054 	/* always first element */
1055 	writel(EP_TRADDR_TRADDR(priv_ep->trb_pool_dma),
1056 	       &priv_dev->regs->ep_traddr);
1057 
1058 	if (!(priv_ep->flags & EP_STALLED)) {
1059 		trace_cdns3_ring(priv_ep);
1060 		/*clearing TRBERR and EP_STS_DESCMIS before seting DRDY*/
1061 		writel(EP_STS_TRBERR | EP_STS_DESCMIS, &priv_dev->regs->ep_sts);
1062 
1063 		priv_ep->prime_flag = false;
1064 
1065 		/*
1066 		 * Controller version DEV_VER_V2 tdl calculation
1067 		 * is based on TRB
1068 		 */
1069 
1070 		if (priv_dev->dev_ver < DEV_VER_V2)
1071 			writel(EP_CMD_TDL_SET(tdl) | EP_CMD_STDL,
1072 			       &priv_dev->regs->ep_cmd);
1073 		else if (priv_dev->dev_ver > DEV_VER_V2)
1074 			writel(tdl, &priv_dev->regs->ep_tdl);
1075 
1076 		priv_ep->last_stream_id = priv_req->request.stream_id;
1077 		writel(EP_CMD_DRDY, &priv_dev->regs->ep_cmd);
1078 		writel(EP_CMD_ERDY_SID(priv_req->request.stream_id) |
1079 		       EP_CMD_ERDY, &priv_dev->regs->ep_cmd);
1080 
1081 		trace_cdns3_doorbell_epx(priv_ep->name,
1082 					 readl(&priv_dev->regs->ep_traddr));
1083 	}
1084 
1085 	/* WORKAROUND for transition to L0 */
1086 	__cdns3_gadget_wakeup(priv_dev);
1087 
1088 	return 0;
1089 }
1090 
cdns3_rearm_drdy_if_needed(struct cdns3_endpoint * priv_ep)1091 static void cdns3_rearm_drdy_if_needed(struct cdns3_endpoint *priv_ep)
1092 {
1093 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
1094 
1095 	if (priv_dev->dev_ver < DEV_VER_V3)
1096 		return;
1097 
1098 	if (readl(&priv_dev->regs->ep_sts) & EP_STS_TRBERR) {
1099 		writel(EP_STS_TRBERR, &priv_dev->regs->ep_sts);
1100 		writel(EP_CMD_DRDY, &priv_dev->regs->ep_cmd);
1101 	}
1102 }
1103 
1104 /**
1105  * cdns3_ep_run_transfer - start transfer on no-default endpoint hardware
1106  * @priv_ep: endpoint object
1107  * @request: request object
1108  *
1109  * Returns zero on success or negative value on failure
1110  */
cdns3_ep_run_transfer(struct cdns3_endpoint * priv_ep,struct usb_request * request)1111 static int cdns3_ep_run_transfer(struct cdns3_endpoint *priv_ep,
1112 				 struct usb_request *request)
1113 {
1114 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
1115 	struct cdns3_request *priv_req;
1116 	struct cdns3_trb *trb;
1117 	struct cdns3_trb *link_trb = NULL;
1118 	dma_addr_t trb_dma;
1119 	u32 togle_pcs = 1;
1120 	int sg_iter = 0;
1121 	int num_trb;
1122 	int address;
1123 	u32 control;
1124 	int pcs;
1125 	u16 total_tdl = 0;
1126 	struct scatterlist *s = NULL;
1127 	bool sg_supported = !!(request->num_mapped_sgs);
1128 
1129 	if (priv_ep->type == USB_ENDPOINT_XFER_ISOC)
1130 		num_trb = priv_ep->interval;
1131 	else
1132 		num_trb = sg_supported ? request->num_mapped_sgs : 1;
1133 
1134 	if (num_trb > priv_ep->free_trbs) {
1135 		priv_ep->flags |= EP_RING_FULL;
1136 		return -ENOBUFS;
1137 	}
1138 
1139 	priv_req = to_cdns3_request(request);
1140 	address = priv_ep->endpoint.desc->bEndpointAddress;
1141 
1142 	priv_ep->flags |= EP_PENDING_REQUEST;
1143 
1144 	/* must allocate buffer aligned to 8 */
1145 	if (priv_req->flags & REQUEST_UNALIGNED)
1146 		trb_dma = priv_req->aligned_buf->dma;
1147 	else
1148 		trb_dma = request->dma;
1149 
1150 	trb = priv_ep->trb_pool + priv_ep->enqueue;
1151 	priv_req->start_trb = priv_ep->enqueue;
1152 	priv_req->trb = trb;
1153 
1154 	cdns3_select_ep(priv_ep->cdns3_dev, address);
1155 
1156 	/* prepare ring */
1157 	if ((priv_ep->enqueue + num_trb)  >= (priv_ep->num_trbs - 1)) {
1158 		int doorbell, dma_index;
1159 		u32 ch_bit = 0;
1160 
1161 		doorbell = !!(readl(&priv_dev->regs->ep_cmd) & EP_CMD_DRDY);
1162 		dma_index = cdns3_get_dma_pos(priv_dev, priv_ep);
1163 
1164 		/* Driver can't update LINK TRB if it is current processed. */
1165 		if (doorbell && dma_index == priv_ep->num_trbs - 1) {
1166 			priv_ep->flags |= EP_DEFERRED_DRDY;
1167 			return -ENOBUFS;
1168 		}
1169 
1170 		/*updating C bt in  Link TRB before starting DMA*/
1171 		link_trb = priv_ep->trb_pool + (priv_ep->num_trbs - 1);
1172 		/*
1173 		 * For TRs size equal 2 enabling TRB_CHAIN for epXin causes
1174 		 * that DMA stuck at the LINK TRB.
1175 		 * On the other hand, removing TRB_CHAIN for longer TRs for
1176 		 * epXout cause that DMA stuck after handling LINK TRB.
1177 		 * To eliminate this strange behavioral driver set TRB_CHAIN
1178 		 * bit only for TR size > 2.
1179 		 */
1180 		if (priv_ep->type == USB_ENDPOINT_XFER_ISOC ||
1181 		    TRBS_PER_SEGMENT > 2)
1182 			ch_bit = TRB_CHAIN;
1183 
1184 		link_trb->control = cpu_to_le32(((priv_ep->pcs) ? TRB_CYCLE : 0) |
1185 				    TRB_TYPE(TRB_LINK) | TRB_TOGGLE | ch_bit);
1186 	}
1187 
1188 	if (priv_dev->dev_ver <= DEV_VER_V2)
1189 		togle_pcs = cdns3_wa1_update_guard(priv_ep, trb);
1190 
1191 	if (sg_supported)
1192 		s = request->sg;
1193 
1194 	/* set incorrect Cycle Bit for first trb*/
1195 	control = priv_ep->pcs ? 0 : TRB_CYCLE;
1196 	trb->length = 0;
1197 	if (priv_dev->dev_ver >= DEV_VER_V2) {
1198 		u16 td_size;
1199 
1200 		td_size = DIV_ROUND_UP(request->length,
1201 				       priv_ep->endpoint.maxpacket);
1202 		if (priv_dev->gadget.speed == USB_SPEED_SUPER)
1203 			trb->length = TRB_TDL_SS_SIZE(td_size);
1204 		else
1205 			control |= TRB_TDL_HS_SIZE(td_size);
1206 	}
1207 
1208 	do {
1209 		u32 length;
1210 
1211 		/* fill TRB */
1212 		control |= TRB_TYPE(TRB_NORMAL);
1213 		if (sg_supported) {
1214 			trb->buffer = cpu_to_le32(TRB_BUFFER(sg_dma_address(s)));
1215 			length = sg_dma_len(s);
1216 		} else {
1217 			trb->buffer = cpu_to_le32(TRB_BUFFER(trb_dma));
1218 			length = request->length;
1219 		}
1220 
1221 		if (priv_ep->flags & EP_TDLCHK_EN)
1222 			total_tdl += DIV_ROUND_UP(length,
1223 					       priv_ep->endpoint.maxpacket);
1224 
1225 		trb->length |= cpu_to_le32(TRB_BURST_LEN(priv_ep->trb_burst_size) |
1226 					TRB_LEN(length));
1227 		pcs = priv_ep->pcs ? TRB_CYCLE : 0;
1228 
1229 		/*
1230 		 * first trb should be prepared as last to avoid processing
1231 		 *  transfer to early
1232 		 */
1233 		if (sg_iter != 0)
1234 			control |= pcs;
1235 
1236 		if (priv_ep->type == USB_ENDPOINT_XFER_ISOC  && !priv_ep->dir) {
1237 			control |= TRB_IOC | TRB_ISP;
1238 		} else {
1239 			/* for last element in TD or in SG list */
1240 			if (sg_iter == (num_trb - 1) && sg_iter != 0)
1241 				control |= pcs | TRB_IOC | TRB_ISP;
1242 		}
1243 
1244 		if (sg_iter)
1245 			trb->control = cpu_to_le32(control);
1246 		else
1247 			priv_req->trb->control = cpu_to_le32(control);
1248 
1249 		if (sg_supported) {
1250 			trb->control |= TRB_ISP;
1251 			/* Don't set chain bit for last TRB */
1252 			if (sg_iter < num_trb - 1)
1253 				trb->control |= TRB_CHAIN;
1254 
1255 			s = sg_next(s);
1256 		}
1257 
1258 		control = 0;
1259 		++sg_iter;
1260 		priv_req->end_trb = priv_ep->enqueue;
1261 		cdns3_ep_inc_enq(priv_ep);
1262 		trb = priv_ep->trb_pool + priv_ep->enqueue;
1263 		trb->length = 0;
1264 	} while (sg_iter < num_trb);
1265 
1266 	trb = priv_req->trb;
1267 
1268 	priv_req->flags |= REQUEST_PENDING;
1269 	priv_req->num_of_trb = num_trb;
1270 
1271 	if (sg_iter == 1)
1272 		trb->control |= cpu_to_le32(TRB_IOC | TRB_ISP);
1273 
1274 	if (priv_dev->dev_ver < DEV_VER_V2 &&
1275 	    (priv_ep->flags & EP_TDLCHK_EN)) {
1276 		u16 tdl = total_tdl;
1277 		u16 old_tdl = EP_CMD_TDL_GET(readl(&priv_dev->regs->ep_cmd));
1278 
1279 		if (tdl > EP_CMD_TDL_MAX) {
1280 			tdl = EP_CMD_TDL_MAX;
1281 			priv_ep->pending_tdl = total_tdl - EP_CMD_TDL_MAX;
1282 		}
1283 
1284 		if (old_tdl < tdl) {
1285 			tdl -= old_tdl;
1286 			writel(EP_CMD_TDL_SET(tdl) | EP_CMD_STDL,
1287 			       &priv_dev->regs->ep_cmd);
1288 		}
1289 	}
1290 
1291 	/*
1292 	 * Memory barrier - cycle bit must be set before other filds in trb.
1293 	 */
1294 	wmb();
1295 
1296 	/* give the TD to the consumer*/
1297 	if (togle_pcs)
1298 		trb->control = trb->control ^ cpu_to_le32(1);
1299 
1300 	if (priv_dev->dev_ver <= DEV_VER_V2)
1301 		cdns3_wa1_tray_restore_cycle_bit(priv_dev, priv_ep);
1302 
1303 	if (num_trb > 1) {
1304 		int i = 0;
1305 
1306 		while (i < num_trb) {
1307 			trace_cdns3_prepare_trb(priv_ep, trb + i);
1308 			if (trb + i == link_trb) {
1309 				trb = priv_ep->trb_pool;
1310 				num_trb = num_trb - i;
1311 				i = 0;
1312 			} else {
1313 				i++;
1314 			}
1315 		}
1316 	} else {
1317 		trace_cdns3_prepare_trb(priv_ep, priv_req->trb);
1318 	}
1319 
1320 	/*
1321 	 * Memory barrier - Cycle Bit must be set before trb->length  and
1322 	 * trb->buffer fields.
1323 	 */
1324 	wmb();
1325 
1326 	/*
1327 	 * For DMULT mode we can set address to transfer ring only once after
1328 	 * enabling endpoint.
1329 	 */
1330 	if (priv_ep->flags & EP_UPDATE_EP_TRBADDR) {
1331 		/*
1332 		 * Until SW is not ready to handle the OUT transfer the ISO OUT
1333 		 * Endpoint should be disabled (EP_CFG.ENABLE = 0).
1334 		 * EP_CFG_ENABLE must be set before updating ep_traddr.
1335 		 */
1336 		if (priv_ep->type == USB_ENDPOINT_XFER_ISOC  && !priv_ep->dir &&
1337 		    !(priv_ep->flags & EP_QUIRK_ISO_OUT_EN)) {
1338 			priv_ep->flags |= EP_QUIRK_ISO_OUT_EN;
1339 			cdns3_set_register_bit(&priv_dev->regs->ep_cfg,
1340 					       EP_CFG_ENABLE);
1341 		}
1342 
1343 		writel(EP_TRADDR_TRADDR(priv_ep->trb_pool_dma +
1344 					priv_req->start_trb * TRB_SIZE),
1345 					&priv_dev->regs->ep_traddr);
1346 
1347 		priv_ep->flags &= ~EP_UPDATE_EP_TRBADDR;
1348 	}
1349 
1350 	if (!priv_ep->wa1_set && !(priv_ep->flags & EP_STALLED)) {
1351 		trace_cdns3_ring(priv_ep);
1352 		/*clearing TRBERR and EP_STS_DESCMIS before seting DRDY*/
1353 		writel(EP_STS_TRBERR | EP_STS_DESCMIS, &priv_dev->regs->ep_sts);
1354 		writel(EP_CMD_DRDY, &priv_dev->regs->ep_cmd);
1355 		cdns3_rearm_drdy_if_needed(priv_ep);
1356 		trace_cdns3_doorbell_epx(priv_ep->name,
1357 					 readl(&priv_dev->regs->ep_traddr));
1358 	}
1359 
1360 	/* WORKAROUND for transition to L0 */
1361 	__cdns3_gadget_wakeup(priv_dev);
1362 
1363 	return 0;
1364 }
1365 
cdns3_set_hw_configuration(struct cdns3_device * priv_dev)1366 void cdns3_set_hw_configuration(struct cdns3_device *priv_dev)
1367 {
1368 	struct cdns3_endpoint *priv_ep;
1369 	struct usb_ep *ep;
1370 
1371 	if (priv_dev->hw_configured_flag)
1372 		return;
1373 
1374 	writel(USB_CONF_CFGSET, &priv_dev->regs->usb_conf);
1375 
1376 	cdns3_set_register_bit(&priv_dev->regs->usb_conf,
1377 			       USB_CONF_U1EN | USB_CONF_U2EN);
1378 
1379 	priv_dev->hw_configured_flag = 1;
1380 
1381 	list_for_each_entry(ep, &priv_dev->gadget.ep_list, ep_list) {
1382 		if (ep->enabled) {
1383 			priv_ep = ep_to_cdns3_ep(ep);
1384 			cdns3_start_all_request(priv_dev, priv_ep);
1385 		}
1386 	}
1387 
1388 	cdns3_allow_enable_l1(priv_dev, 1);
1389 }
1390 
1391 /**
1392  * cdns3_trb_handled - check whether trb has been handled by DMA
1393  *
1394  * @priv_ep: extended endpoint object.
1395  * @priv_req: request object for checking
1396  *
1397  * Endpoint must be selected before invoking this function.
1398  *
1399  * Returns false if request has not been handled by DMA, else returns true.
1400  *
1401  * SR - start ring
1402  * ER -  end ring
1403  * DQ = priv_ep->dequeue - dequeue position
1404  * EQ = priv_ep->enqueue -  enqueue position
1405  * ST = priv_req->start_trb - index of first TRB in transfer ring
1406  * ET = priv_req->end_trb - index of last TRB in transfer ring
1407  * CI = current_index - index of processed TRB by DMA.
1408  *
1409  * As first step, we check if the TRB between the ST and ET.
1410  * Then, we check if cycle bit for index priv_ep->dequeue
1411  * is correct.
1412  *
1413  * some rules:
1414  * 1. priv_ep->dequeue never equals to current_index.
1415  * 2  priv_ep->enqueue never exceed priv_ep->dequeue
1416  * 3. exception: priv_ep->enqueue == priv_ep->dequeue
1417  *    and priv_ep->free_trbs is zero.
1418  *    This case indicate that TR is full.
1419  *
1420  * At below two cases, the request have been handled.
1421  * Case 1 - priv_ep->dequeue < current_index
1422  *      SR ... EQ ... DQ ... CI ... ER
1423  *      SR ... DQ ... CI ... EQ ... ER
1424  *
1425  * Case 2 - priv_ep->dequeue > current_index
1426  * This situation takes place when CI go through the LINK TRB at the end of
1427  * transfer ring.
1428  *      SR ... CI ... EQ ... DQ ... ER
1429  */
cdns3_trb_handled(struct cdns3_endpoint * priv_ep,struct cdns3_request * priv_req)1430 static bool cdns3_trb_handled(struct cdns3_endpoint *priv_ep,
1431 				  struct cdns3_request *priv_req)
1432 {
1433 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
1434 	struct cdns3_trb *trb;
1435 	int current_index = 0;
1436 	int handled = 0;
1437 	int doorbell;
1438 
1439 	current_index = cdns3_get_dma_pos(priv_dev, priv_ep);
1440 	doorbell = !!(readl(&priv_dev->regs->ep_cmd) & EP_CMD_DRDY);
1441 
1442 	/* current trb doesn't belong to this request */
1443 	if (priv_req->start_trb < priv_req->end_trb) {
1444 		if (priv_ep->dequeue > priv_req->end_trb)
1445 			goto finish;
1446 
1447 		if (priv_ep->dequeue < priv_req->start_trb)
1448 			goto finish;
1449 	}
1450 
1451 	if ((priv_req->start_trb > priv_req->end_trb) &&
1452 		(priv_ep->dequeue > priv_req->end_trb) &&
1453 		(priv_ep->dequeue < priv_req->start_trb))
1454 		goto finish;
1455 
1456 	if ((priv_req->start_trb == priv_req->end_trb) &&
1457 		(priv_ep->dequeue != priv_req->end_trb))
1458 		goto finish;
1459 
1460 	trb = &priv_ep->trb_pool[priv_ep->dequeue];
1461 
1462 	if ((le32_to_cpu(trb->control) & TRB_CYCLE) != priv_ep->ccs)
1463 		goto finish;
1464 
1465 	if (doorbell == 1 && current_index == priv_ep->dequeue)
1466 		goto finish;
1467 
1468 	/* The corner case for TRBS_PER_SEGMENT equal 2). */
1469 	if (TRBS_PER_SEGMENT == 2 && priv_ep->type != USB_ENDPOINT_XFER_ISOC) {
1470 		handled = 1;
1471 		goto finish;
1472 	}
1473 
1474 	if (priv_ep->enqueue == priv_ep->dequeue &&
1475 	    priv_ep->free_trbs == 0) {
1476 		handled = 1;
1477 	} else if (priv_ep->dequeue < current_index) {
1478 		if ((current_index == (priv_ep->num_trbs - 1)) &&
1479 		    !priv_ep->dequeue)
1480 			goto finish;
1481 
1482 		handled = 1;
1483 	} else if (priv_ep->dequeue  > current_index) {
1484 			handled = 1;
1485 	}
1486 
1487 finish:
1488 	trace_cdns3_request_handled(priv_req, current_index, handled);
1489 
1490 	return handled;
1491 }
1492 
cdns3_transfer_completed(struct cdns3_device * priv_dev,struct cdns3_endpoint * priv_ep)1493 static void cdns3_transfer_completed(struct cdns3_device *priv_dev,
1494 				     struct cdns3_endpoint *priv_ep)
1495 {
1496 	struct cdns3_request *priv_req;
1497 	struct usb_request *request;
1498 	struct cdns3_trb *trb;
1499 	bool request_handled = false;
1500 	bool transfer_end = false;
1501 
1502 	while (!list_empty(&priv_ep->pending_req_list)) {
1503 		request = cdns3_next_request(&priv_ep->pending_req_list);
1504 		priv_req = to_cdns3_request(request);
1505 
1506 		trb = priv_ep->trb_pool + priv_ep->dequeue;
1507 
1508 		/* The TRB was changed as link TRB, and the request was handled at ep_dequeue */
1509 		while (TRB_FIELD_TO_TYPE(le32_to_cpu(trb->control)) == TRB_LINK) {
1510 			trace_cdns3_complete_trb(priv_ep, trb);
1511 			cdns3_ep_inc_deq(priv_ep);
1512 			trb = priv_ep->trb_pool + priv_ep->dequeue;
1513 		}
1514 
1515 		if (!request->stream_id) {
1516 			/* Re-select endpoint. It could be changed by other CPU
1517 			 * during handling usb_gadget_giveback_request.
1518 			 */
1519 			cdns3_select_ep(priv_dev, priv_ep->endpoint.address);
1520 
1521 			while (cdns3_trb_handled(priv_ep, priv_req)) {
1522 				priv_req->finished_trb++;
1523 				if (priv_req->finished_trb >= priv_req->num_of_trb)
1524 					request_handled = true;
1525 
1526 				trb = priv_ep->trb_pool + priv_ep->dequeue;
1527 				trace_cdns3_complete_trb(priv_ep, trb);
1528 
1529 				if (!transfer_end)
1530 					request->actual +=
1531 						TRB_LEN(le32_to_cpu(trb->length));
1532 
1533 				if (priv_req->num_of_trb > 1 &&
1534 					le32_to_cpu(trb->control) & TRB_SMM &&
1535 					le32_to_cpu(trb->control) & TRB_CHAIN)
1536 					transfer_end = true;
1537 
1538 				cdns3_ep_inc_deq(priv_ep);
1539 			}
1540 
1541 			if (request_handled) {
1542 				cdns3_gadget_giveback(priv_ep, priv_req, 0);
1543 				request_handled = false;
1544 				transfer_end = false;
1545 			} else {
1546 				goto prepare_next_td;
1547 			}
1548 
1549 			if (priv_ep->type != USB_ENDPOINT_XFER_ISOC &&
1550 			    TRBS_PER_SEGMENT == 2)
1551 				break;
1552 		} else {
1553 			/* Re-select endpoint. It could be changed by other CPU
1554 			 * during handling usb_gadget_giveback_request.
1555 			 */
1556 			cdns3_select_ep(priv_dev, priv_ep->endpoint.address);
1557 
1558 			trb = priv_ep->trb_pool;
1559 			trace_cdns3_complete_trb(priv_ep, trb);
1560 
1561 			if (trb != priv_req->trb)
1562 				dev_warn(priv_dev->dev,
1563 					 "request_trb=0x%p, queue_trb=0x%p\n",
1564 					 priv_req->trb, trb);
1565 
1566 			request->actual += TRB_LEN(le32_to_cpu(trb->length));
1567 
1568 			if (!request->num_sgs ||
1569 			    (request->num_sgs == (priv_ep->stream_sg_idx + 1))) {
1570 				priv_ep->stream_sg_idx = 0;
1571 				cdns3_gadget_giveback(priv_ep, priv_req, 0);
1572 			} else {
1573 				priv_ep->stream_sg_idx++;
1574 				cdns3_ep_run_stream_transfer(priv_ep, request);
1575 			}
1576 			break;
1577 		}
1578 	}
1579 	priv_ep->flags &= ~EP_PENDING_REQUEST;
1580 
1581 prepare_next_td:
1582 	if (!(priv_ep->flags & EP_STALLED) &&
1583 	    !(priv_ep->flags & EP_STALL_PENDING))
1584 		cdns3_start_all_request(priv_dev, priv_ep);
1585 }
1586 
cdns3_rearm_transfer(struct cdns3_endpoint * priv_ep,u8 rearm)1587 void cdns3_rearm_transfer(struct cdns3_endpoint *priv_ep, u8 rearm)
1588 {
1589 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
1590 
1591 	cdns3_wa1_restore_cycle_bit(priv_ep);
1592 
1593 	if (rearm) {
1594 		trace_cdns3_ring(priv_ep);
1595 
1596 		/* Cycle Bit must be updated before arming DMA. */
1597 		wmb();
1598 		writel(EP_CMD_DRDY, &priv_dev->regs->ep_cmd);
1599 
1600 		__cdns3_gadget_wakeup(priv_dev);
1601 
1602 		trace_cdns3_doorbell_epx(priv_ep->name,
1603 					 readl(&priv_dev->regs->ep_traddr));
1604 	}
1605 }
1606 
cdns3_reprogram_tdl(struct cdns3_endpoint * priv_ep)1607 static void cdns3_reprogram_tdl(struct cdns3_endpoint *priv_ep)
1608 {
1609 	u16 tdl = priv_ep->pending_tdl;
1610 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
1611 
1612 	if (tdl > EP_CMD_TDL_MAX) {
1613 		tdl = EP_CMD_TDL_MAX;
1614 		priv_ep->pending_tdl -= EP_CMD_TDL_MAX;
1615 	} else {
1616 		priv_ep->pending_tdl = 0;
1617 	}
1618 
1619 	writel(EP_CMD_TDL_SET(tdl) | EP_CMD_STDL, &priv_dev->regs->ep_cmd);
1620 }
1621 
1622 /**
1623  * cdns3_check_ep_interrupt_proceed - Processes interrupt related to endpoint
1624  * @priv_ep: endpoint object
1625  *
1626  * Returns 0
1627  */
cdns3_check_ep_interrupt_proceed(struct cdns3_endpoint * priv_ep)1628 static int cdns3_check_ep_interrupt_proceed(struct cdns3_endpoint *priv_ep)
1629 {
1630 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
1631 	u32 ep_sts_reg;
1632 	struct usb_request *deferred_request;
1633 	struct usb_request *pending_request;
1634 	u32 tdl = 0;
1635 
1636 	cdns3_select_ep(priv_dev, priv_ep->endpoint.address);
1637 
1638 	trace_cdns3_epx_irq(priv_dev, priv_ep);
1639 
1640 	ep_sts_reg = readl(&priv_dev->regs->ep_sts);
1641 	writel(ep_sts_reg, &priv_dev->regs->ep_sts);
1642 
1643 	if ((ep_sts_reg & EP_STS_PRIME) && priv_ep->use_streams) {
1644 		bool dbusy = !!(ep_sts_reg & EP_STS_DBUSY);
1645 
1646 		tdl = cdns3_get_tdl(priv_dev);
1647 
1648 		/*
1649 		 * Continue the previous transfer:
1650 		 * There is some racing between ERDY and PRIME. The device send
1651 		 * ERDY and almost in the same time Host send PRIME. It cause
1652 		 * that host ignore the ERDY packet and driver has to send it
1653 		 * again.
1654 		 */
1655 		if (tdl && (dbusy || !EP_STS_BUFFEMPTY(ep_sts_reg) ||
1656 		    EP_STS_HOSTPP(ep_sts_reg))) {
1657 			writel(EP_CMD_ERDY |
1658 			       EP_CMD_ERDY_SID(priv_ep->last_stream_id),
1659 			       &priv_dev->regs->ep_cmd);
1660 			ep_sts_reg &= ~(EP_STS_MD_EXIT | EP_STS_IOC);
1661 		} else {
1662 			priv_ep->prime_flag = true;
1663 
1664 			pending_request = cdns3_next_request(&priv_ep->pending_req_list);
1665 			deferred_request = cdns3_next_request(&priv_ep->deferred_req_list);
1666 
1667 			if (deferred_request && !pending_request) {
1668 				cdns3_start_all_request(priv_dev, priv_ep);
1669 			}
1670 		}
1671 	}
1672 
1673 	if (ep_sts_reg & EP_STS_TRBERR) {
1674 		if (priv_ep->flags & EP_STALL_PENDING &&
1675 		    !(ep_sts_reg & EP_STS_DESCMIS &&
1676 		    priv_dev->dev_ver < DEV_VER_V2)) {
1677 			cdns3_ep_stall_flush(priv_ep);
1678 		}
1679 
1680 		/*
1681 		 * For isochronous transfer driver completes request on
1682 		 * IOC or on TRBERR. IOC appears only when device receive
1683 		 * OUT data packet. If host disable stream or lost some packet
1684 		 * then the only way to finish all queued transfer is to do it
1685 		 * on TRBERR event.
1686 		 */
1687 		if (priv_ep->type == USB_ENDPOINT_XFER_ISOC &&
1688 		    !priv_ep->wa1_set) {
1689 			if (!priv_ep->dir) {
1690 				u32 ep_cfg = readl(&priv_dev->regs->ep_cfg);
1691 
1692 				ep_cfg &= ~EP_CFG_ENABLE;
1693 				writel(ep_cfg, &priv_dev->regs->ep_cfg);
1694 				priv_ep->flags &= ~EP_QUIRK_ISO_OUT_EN;
1695 				priv_ep->flags |= EP_UPDATE_EP_TRBADDR;
1696 			}
1697 			cdns3_transfer_completed(priv_dev, priv_ep);
1698 		} else if (!(priv_ep->flags & EP_STALLED) &&
1699 			  !(priv_ep->flags & EP_STALL_PENDING)) {
1700 			if (priv_ep->flags & EP_DEFERRED_DRDY) {
1701 				priv_ep->flags &= ~EP_DEFERRED_DRDY;
1702 				cdns3_start_all_request(priv_dev, priv_ep);
1703 			} else {
1704 				cdns3_rearm_transfer(priv_ep,
1705 						     priv_ep->wa1_set);
1706 			}
1707 		}
1708 	}
1709 
1710 	if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP) ||
1711 	    (ep_sts_reg & EP_STS_IOT)) {
1712 		if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) {
1713 			if (ep_sts_reg & EP_STS_ISP)
1714 				priv_ep->flags |= EP_QUIRK_END_TRANSFER;
1715 			else
1716 				priv_ep->flags &= ~EP_QUIRK_END_TRANSFER;
1717 		}
1718 
1719 		if (!priv_ep->use_streams) {
1720 			if ((ep_sts_reg & EP_STS_IOC) ||
1721 			    (ep_sts_reg & EP_STS_ISP)) {
1722 				cdns3_transfer_completed(priv_dev, priv_ep);
1723 			} else if ((priv_ep->flags & EP_TDLCHK_EN) &
1724 				   priv_ep->pending_tdl) {
1725 				/* handle IOT with pending tdl */
1726 				cdns3_reprogram_tdl(priv_ep);
1727 			}
1728 		} else if (priv_ep->dir == USB_DIR_OUT) {
1729 			priv_ep->ep_sts_pending |= ep_sts_reg;
1730 		} else if (ep_sts_reg & EP_STS_IOT) {
1731 			cdns3_transfer_completed(priv_dev, priv_ep);
1732 		}
1733 	}
1734 
1735 	/*
1736 	 * MD_EXIT interrupt sets when stream capable endpoint exits
1737 	 * from MOVE DATA state of Bulk IN/OUT stream protocol state machine
1738 	 */
1739 	if (priv_ep->dir == USB_DIR_OUT && (ep_sts_reg & EP_STS_MD_EXIT) &&
1740 	    (priv_ep->ep_sts_pending & EP_STS_IOT) && priv_ep->use_streams) {
1741 		priv_ep->ep_sts_pending = 0;
1742 		cdns3_transfer_completed(priv_dev, priv_ep);
1743 	}
1744 
1745 	/*
1746 	 * WA2: this condition should only be meet when
1747 	 * priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET or
1748 	 * priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN.
1749 	 * In other cases this interrupt will be disabled.
1750 	 */
1751 	if (ep_sts_reg & EP_STS_DESCMIS && priv_dev->dev_ver < DEV_VER_V2 &&
1752 	    !(priv_ep->flags & EP_STALLED))
1753 		cdns3_wa2_descmissing_packet(priv_ep);
1754 
1755 	return 0;
1756 }
1757 
cdns3_disconnect_gadget(struct cdns3_device * priv_dev)1758 static void cdns3_disconnect_gadget(struct cdns3_device *priv_dev)
1759 {
1760 	if (priv_dev->gadget_driver && priv_dev->gadget_driver->disconnect)
1761 		priv_dev->gadget_driver->disconnect(&priv_dev->gadget);
1762 }
1763 
1764 /**
1765  * cdns3_check_usb_interrupt_proceed - Processes interrupt related to device
1766  * @priv_dev: extended gadget object
1767  * @usb_ists: bitmap representation of device's reported interrupts
1768  * (usb_ists register value)
1769  */
cdns3_check_usb_interrupt_proceed(struct cdns3_device * priv_dev,u32 usb_ists)1770 static void cdns3_check_usb_interrupt_proceed(struct cdns3_device *priv_dev,
1771 					      u32 usb_ists)
1772 __must_hold(&priv_dev->lock)
1773 {
1774 	int speed = 0;
1775 
1776 	trace_cdns3_usb_irq(priv_dev, usb_ists);
1777 	if (usb_ists & USB_ISTS_L1ENTI) {
1778 		/*
1779 		 * WORKAROUND: CDNS3 controller has issue with hardware resuming
1780 		 * from L1. To fix it, if any DMA transfer is pending driver
1781 		 * must starts driving resume signal immediately.
1782 		 */
1783 		if (readl(&priv_dev->regs->drbl))
1784 			__cdns3_gadget_wakeup(priv_dev);
1785 	}
1786 
1787 	/* Connection detected */
1788 	if (usb_ists & (USB_ISTS_CON2I | USB_ISTS_CONI)) {
1789 		speed = cdns3_get_speed(priv_dev);
1790 		priv_dev->gadget.speed = speed;
1791 		usb_gadget_set_state(&priv_dev->gadget, USB_STATE_POWERED);
1792 		cdns3_ep0_config(priv_dev);
1793 	}
1794 
1795 	/* Disconnection detected */
1796 	if (usb_ists & (USB_ISTS_DIS2I | USB_ISTS_DISI)) {
1797 		spin_unlock(&priv_dev->lock);
1798 		cdns3_disconnect_gadget(priv_dev);
1799 		spin_lock(&priv_dev->lock);
1800 		priv_dev->gadget.speed = USB_SPEED_UNKNOWN;
1801 		usb_gadget_set_state(&priv_dev->gadget, USB_STATE_NOTATTACHED);
1802 		cdns3_hw_reset_eps_config(priv_dev);
1803 	}
1804 
1805 	if (usb_ists & (USB_ISTS_L2ENTI | USB_ISTS_U3ENTI)) {
1806 		if (priv_dev->gadget_driver &&
1807 		    priv_dev->gadget_driver->suspend) {
1808 			spin_unlock(&priv_dev->lock);
1809 			priv_dev->gadget_driver->suspend(&priv_dev->gadget);
1810 			spin_lock(&priv_dev->lock);
1811 		}
1812 	}
1813 
1814 	if (usb_ists & (USB_ISTS_L2EXTI | USB_ISTS_U3EXTI)) {
1815 		if (priv_dev->gadget_driver &&
1816 		    priv_dev->gadget_driver->resume) {
1817 			spin_unlock(&priv_dev->lock);
1818 			priv_dev->gadget_driver->resume(&priv_dev->gadget);
1819 			spin_lock(&priv_dev->lock);
1820 		}
1821 	}
1822 
1823 	/* reset*/
1824 	if (usb_ists & (USB_ISTS_UWRESI | USB_ISTS_UHRESI | USB_ISTS_U2RESI)) {
1825 		if (priv_dev->gadget_driver) {
1826 			spin_unlock(&priv_dev->lock);
1827 			usb_gadget_udc_reset(&priv_dev->gadget,
1828 					     priv_dev->gadget_driver);
1829 			spin_lock(&priv_dev->lock);
1830 
1831 			/*read again to check the actual speed*/
1832 			speed = cdns3_get_speed(priv_dev);
1833 			priv_dev->gadget.speed = speed;
1834 			cdns3_hw_reset_eps_config(priv_dev);
1835 			cdns3_ep0_config(priv_dev);
1836 		}
1837 	}
1838 }
1839 
1840 /**
1841  * cdns3_device_irq_handler- interrupt handler for device part of controller
1842  *
1843  * @irq: irq number for cdns3 core device
1844  * @data: structure of cdns3
1845  *
1846  * Returns IRQ_HANDLED or IRQ_NONE
1847  */
cdns3_device_irq_handler(int irq,void * data)1848 static irqreturn_t cdns3_device_irq_handler(int irq, void *data)
1849 {
1850 	struct cdns3_device *priv_dev = data;
1851 	struct cdns3 *cdns = dev_get_drvdata(priv_dev->dev);
1852 	irqreturn_t ret = IRQ_NONE;
1853 	u32 reg;
1854 
1855 	if (cdns->in_lpm)
1856 		return ret;
1857 
1858 	/* check USB device interrupt */
1859 	reg = readl(&priv_dev->regs->usb_ists);
1860 	if (reg) {
1861 		/* After masking interrupts the new interrupts won't be
1862 		 * reported in usb_ists/ep_ists. In order to not lose some
1863 		 * of them driver disables only detected interrupts.
1864 		 * They will be enabled ASAP after clearing source of
1865 		 * interrupt. This an unusual behavior only applies to
1866 		 * usb_ists register.
1867 		 */
1868 		reg = ~reg & readl(&priv_dev->regs->usb_ien);
1869 		/* mask deferred interrupt. */
1870 		writel(reg, &priv_dev->regs->usb_ien);
1871 		ret = IRQ_WAKE_THREAD;
1872 	}
1873 
1874 	/* check endpoint interrupt */
1875 	reg = readl(&priv_dev->regs->ep_ists);
1876 	if (reg) {
1877 		writel(0, &priv_dev->regs->ep_ien);
1878 		ret = IRQ_WAKE_THREAD;
1879 	}
1880 
1881 	return ret;
1882 }
1883 
1884 /**
1885  * cdns3_device_thread_irq_handler- interrupt handler for device part
1886  * of controller
1887  *
1888  * @irq: irq number for cdns3 core device
1889  * @data: structure of cdns3
1890  *
1891  * Returns IRQ_HANDLED or IRQ_NONE
1892  */
cdns3_device_thread_irq_handler(int irq,void * data)1893 static irqreturn_t cdns3_device_thread_irq_handler(int irq, void *data)
1894 {
1895 	struct cdns3_device *priv_dev = data;
1896 	irqreturn_t ret = IRQ_NONE;
1897 	unsigned long flags;
1898 	unsigned int bit;
1899 	unsigned long reg;
1900 
1901 	spin_lock_irqsave(&priv_dev->lock, flags);
1902 
1903 	reg = readl(&priv_dev->regs->usb_ists);
1904 	if (reg) {
1905 		writel(reg, &priv_dev->regs->usb_ists);
1906 		writel(USB_IEN_INIT, &priv_dev->regs->usb_ien);
1907 		cdns3_check_usb_interrupt_proceed(priv_dev, reg);
1908 		ret = IRQ_HANDLED;
1909 	}
1910 
1911 	reg = readl(&priv_dev->regs->ep_ists);
1912 
1913 	/* handle default endpoint OUT */
1914 	if (reg & EP_ISTS_EP_OUT0) {
1915 		cdns3_check_ep0_interrupt_proceed(priv_dev, USB_DIR_OUT);
1916 		ret = IRQ_HANDLED;
1917 	}
1918 
1919 	/* handle default endpoint IN */
1920 	if (reg & EP_ISTS_EP_IN0) {
1921 		cdns3_check_ep0_interrupt_proceed(priv_dev, USB_DIR_IN);
1922 		ret = IRQ_HANDLED;
1923 	}
1924 
1925 	/* check if interrupt from non default endpoint, if no exit */
1926 	reg &= ~(EP_ISTS_EP_OUT0 | EP_ISTS_EP_IN0);
1927 	if (!reg)
1928 		goto irqend;
1929 
1930 	for_each_set_bit(bit, &reg,
1931 			 sizeof(u32) * BITS_PER_BYTE) {
1932 		cdns3_check_ep_interrupt_proceed(priv_dev->eps[bit]);
1933 		ret = IRQ_HANDLED;
1934 	}
1935 
1936 	if (priv_dev->dev_ver < DEV_VER_V2 && priv_dev->using_streams)
1937 		cdns3_wa2_check_outq_status(priv_dev);
1938 
1939 irqend:
1940 	writel(~0, &priv_dev->regs->ep_ien);
1941 	spin_unlock_irqrestore(&priv_dev->lock, flags);
1942 
1943 	return ret;
1944 }
1945 
1946 /**
1947  * cdns3_ep_onchip_buffer_reserve - Try to reserve onchip buf for EP
1948  *
1949  * The real reservation will occur during write to EP_CFG register,
1950  * this function is used to check if the 'size' reservation is allowed.
1951  *
1952  * @priv_dev: extended gadget object
1953  * @size: the size (KB) for EP would like to allocate
1954  * @is_in: endpoint direction
1955  *
1956  * Return 0 if the required size can met or negative value on failure
1957  */
cdns3_ep_onchip_buffer_reserve(struct cdns3_device * priv_dev,int size,int is_in)1958 static int cdns3_ep_onchip_buffer_reserve(struct cdns3_device *priv_dev,
1959 					  int size, int is_in)
1960 {
1961 	int remained;
1962 
1963 	/* 2KB are reserved for EP0*/
1964 	remained = priv_dev->onchip_buffers - priv_dev->onchip_used_size - 2;
1965 
1966 	if (is_in) {
1967 		if (remained < size)
1968 			return -EPERM;
1969 
1970 		priv_dev->onchip_used_size += size;
1971 	} else {
1972 		int required;
1973 
1974 		/**
1975 		 *  ALL OUT EPs are shared the same chunk onchip memory, so
1976 		 * driver checks if it already has assigned enough buffers
1977 		 */
1978 		if (priv_dev->out_mem_is_allocated >= size)
1979 			return 0;
1980 
1981 		required = size - priv_dev->out_mem_is_allocated;
1982 
1983 		if (required > remained)
1984 			return -EPERM;
1985 
1986 		priv_dev->out_mem_is_allocated += required;
1987 		priv_dev->onchip_used_size += required;
1988 	}
1989 
1990 	return 0;
1991 }
1992 
cdns3_configure_dmult(struct cdns3_device * priv_dev,struct cdns3_endpoint * priv_ep)1993 static void cdns3_configure_dmult(struct cdns3_device *priv_dev,
1994 				  struct cdns3_endpoint *priv_ep)
1995 {
1996 	struct cdns3_usb_regs __iomem *regs = priv_dev->regs;
1997 
1998 	/* For dev_ver > DEV_VER_V2 DMULT is configured per endpoint */
1999 	if (priv_dev->dev_ver <= DEV_VER_V2)
2000 		writel(USB_CONF_DMULT, &regs->usb_conf);
2001 
2002 	if (priv_dev->dev_ver == DEV_VER_V2)
2003 		writel(USB_CONF2_EN_TDL_TRB, &regs->usb_conf2);
2004 
2005 	if (priv_dev->dev_ver >= DEV_VER_V3 && priv_ep) {
2006 		u32 mask;
2007 
2008 		if (priv_ep->dir)
2009 			mask = BIT(priv_ep->num + 16);
2010 		else
2011 			mask = BIT(priv_ep->num);
2012 
2013 		if (priv_ep->type != USB_ENDPOINT_XFER_ISOC  && !priv_ep->dir) {
2014 			cdns3_set_register_bit(&regs->tdl_from_trb, mask);
2015 			cdns3_set_register_bit(&regs->tdl_beh, mask);
2016 			cdns3_set_register_bit(&regs->tdl_beh2, mask);
2017 			cdns3_set_register_bit(&regs->dma_adv_td, mask);
2018 		}
2019 
2020 		if (priv_ep->type == USB_ENDPOINT_XFER_ISOC && !priv_ep->dir)
2021 			cdns3_set_register_bit(&regs->tdl_from_trb, mask);
2022 
2023 		cdns3_set_register_bit(&regs->dtrans, mask);
2024 	}
2025 }
2026 
2027 /**
2028  * cdns3_ep_config Configure hardware endpoint
2029  * @priv_ep: extended endpoint object
2030  * @enable: set EP_CFG_ENABLE bit in ep_cfg register.
2031  */
cdns3_ep_config(struct cdns3_endpoint * priv_ep,bool enable)2032 int cdns3_ep_config(struct cdns3_endpoint *priv_ep, bool enable)
2033 {
2034 	bool is_iso_ep = (priv_ep->type == USB_ENDPOINT_XFER_ISOC);
2035 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
2036 	u32 bEndpointAddress = priv_ep->num | priv_ep->dir;
2037 	u32 max_packet_size = 0;
2038 	u8 maxburst = 0;
2039 	u32 ep_cfg = 0;
2040 	u8 buffering;
2041 	u8 mult = 0;
2042 	int ret;
2043 
2044 	buffering = CDNS3_EP_BUF_SIZE - 1;
2045 
2046 	cdns3_configure_dmult(priv_dev, priv_ep);
2047 
2048 	switch (priv_ep->type) {
2049 	case USB_ENDPOINT_XFER_INT:
2050 		ep_cfg = EP_CFG_EPTYPE(USB_ENDPOINT_XFER_INT);
2051 
2052 		if (priv_dev->dev_ver >= DEV_VER_V2 && !priv_ep->dir)
2053 			ep_cfg |= EP_CFG_TDL_CHK;
2054 		break;
2055 	case USB_ENDPOINT_XFER_BULK:
2056 		ep_cfg = EP_CFG_EPTYPE(USB_ENDPOINT_XFER_BULK);
2057 
2058 		if (priv_dev->dev_ver >= DEV_VER_V2 && !priv_ep->dir)
2059 			ep_cfg |= EP_CFG_TDL_CHK;
2060 		break;
2061 	default:
2062 		ep_cfg = EP_CFG_EPTYPE(USB_ENDPOINT_XFER_ISOC);
2063 		mult = CDNS3_EP_ISO_HS_MULT - 1;
2064 		buffering = mult + 1;
2065 	}
2066 
2067 	switch (priv_dev->gadget.speed) {
2068 	case USB_SPEED_FULL:
2069 		max_packet_size = is_iso_ep ? 1023 : 64;
2070 		break;
2071 	case USB_SPEED_HIGH:
2072 		max_packet_size = is_iso_ep ? 1024 : 512;
2073 		break;
2074 	case USB_SPEED_SUPER:
2075 		/* It's limitation that driver assumes in driver. */
2076 		mult = 0;
2077 		max_packet_size = 1024;
2078 		if (priv_ep->type == USB_ENDPOINT_XFER_ISOC) {
2079 			maxburst = CDNS3_EP_ISO_SS_BURST - 1;
2080 			buffering = (mult + 1) *
2081 				    (maxburst + 1);
2082 
2083 			if (priv_ep->interval > 1)
2084 				buffering++;
2085 		} else {
2086 			maxburst = CDNS3_EP_BUF_SIZE - 1;
2087 		}
2088 		break;
2089 	default:
2090 		/* all other speed are not supported */
2091 		return -EINVAL;
2092 	}
2093 
2094 	if (max_packet_size == 1024)
2095 		priv_ep->trb_burst_size = 128;
2096 	else if (max_packet_size >= 512)
2097 		priv_ep->trb_burst_size = 64;
2098 	else
2099 		priv_ep->trb_burst_size = 16;
2100 
2101 	/* onchip buffer is only allocated before configuration */
2102 	if (!priv_dev->hw_configured_flag) {
2103 		ret = cdns3_ep_onchip_buffer_reserve(priv_dev, buffering + 1,
2104 						     !!priv_ep->dir);
2105 		if (ret) {
2106 			dev_err(priv_dev->dev, "onchip mem is full, ep is invalid\n");
2107 			return ret;
2108 		}
2109 	}
2110 
2111 	if (enable)
2112 		ep_cfg |= EP_CFG_ENABLE;
2113 
2114 	if (priv_ep->use_streams && priv_dev->gadget.speed >= USB_SPEED_SUPER) {
2115 		if (priv_dev->dev_ver >= DEV_VER_V3) {
2116 			u32 mask = BIT(priv_ep->num + (priv_ep->dir ? 16 : 0));
2117 
2118 			/*
2119 			 * Stream capable endpoints are handled by using ep_tdl
2120 			 * register. Other endpoints use TDL from TRB feature.
2121 			 */
2122 			cdns3_clear_register_bit(&priv_dev->regs->tdl_from_trb,
2123 						 mask);
2124 		}
2125 
2126 		/*  Enable Stream Bit TDL chk and SID chk */
2127 		ep_cfg |=  EP_CFG_STREAM_EN | EP_CFG_TDL_CHK | EP_CFG_SID_CHK;
2128 	}
2129 
2130 	ep_cfg |= EP_CFG_MAXPKTSIZE(max_packet_size) |
2131 		  EP_CFG_MULT(mult) |
2132 		  EP_CFG_BUFFERING(buffering) |
2133 		  EP_CFG_MAXBURST(maxburst);
2134 
2135 	cdns3_select_ep(priv_dev, bEndpointAddress);
2136 	writel(ep_cfg, &priv_dev->regs->ep_cfg);
2137 	priv_ep->flags |= EP_CONFIGURED;
2138 
2139 	dev_dbg(priv_dev->dev, "Configure %s: with val %08x\n",
2140 		priv_ep->name, ep_cfg);
2141 
2142 	return 0;
2143 }
2144 
2145 /* Find correct direction for HW endpoint according to description */
cdns3_ep_dir_is_correct(struct usb_endpoint_descriptor * desc,struct cdns3_endpoint * priv_ep)2146 static int cdns3_ep_dir_is_correct(struct usb_endpoint_descriptor *desc,
2147 				   struct cdns3_endpoint *priv_ep)
2148 {
2149 	return (priv_ep->endpoint.caps.dir_in && usb_endpoint_dir_in(desc)) ||
2150 	       (priv_ep->endpoint.caps.dir_out && usb_endpoint_dir_out(desc));
2151 }
2152 
2153 static struct
cdns3_find_available_ep(struct cdns3_device * priv_dev,struct usb_endpoint_descriptor * desc)2154 cdns3_endpoint *cdns3_find_available_ep(struct cdns3_device *priv_dev,
2155 					struct usb_endpoint_descriptor *desc)
2156 {
2157 	struct usb_ep *ep;
2158 	struct cdns3_endpoint *priv_ep;
2159 
2160 	list_for_each_entry(ep, &priv_dev->gadget.ep_list, ep_list) {
2161 		unsigned long num;
2162 		int ret;
2163 		/* ep name pattern likes epXin or epXout */
2164 		char c[2] = {ep->name[2], '\0'};
2165 
2166 		ret = kstrtoul(c, 10, &num);
2167 		if (ret)
2168 			return ERR_PTR(ret);
2169 
2170 		priv_ep = ep_to_cdns3_ep(ep);
2171 		if (cdns3_ep_dir_is_correct(desc, priv_ep)) {
2172 			if (!(priv_ep->flags & EP_CLAIMED)) {
2173 				priv_ep->num  = num;
2174 				return priv_ep;
2175 			}
2176 		}
2177 	}
2178 
2179 	return ERR_PTR(-ENOENT);
2180 }
2181 
2182 /*
2183  *  Cadence IP has one limitation that all endpoints must be configured
2184  * (Type & MaxPacketSize) before setting configuration through hardware
2185  * register, it means we can't change endpoints configuration after
2186  * set_configuration.
2187  *
2188  * This function set EP_CLAIMED flag which is added when the gadget driver
2189  * uses usb_ep_autoconfig to configure specific endpoint;
2190  * When the udc driver receives set_configurion request,
2191  * it goes through all claimed endpoints, and configure all endpoints
2192  * accordingly.
2193  *
2194  * At usb_ep_ops.enable/disable, we only enable and disable endpoint through
2195  * ep_cfg register which can be changed after set_configuration, and do
2196  * some software operation accordingly.
2197  */
2198 static struct
cdns3_gadget_match_ep(struct usb_gadget * gadget,struct usb_endpoint_descriptor * desc,struct usb_ss_ep_comp_descriptor * comp_desc)2199 usb_ep *cdns3_gadget_match_ep(struct usb_gadget *gadget,
2200 			      struct usb_endpoint_descriptor *desc,
2201 			      struct usb_ss_ep_comp_descriptor *comp_desc)
2202 {
2203 	struct cdns3_device *priv_dev = gadget_to_cdns3_device(gadget);
2204 	struct cdns3_endpoint *priv_ep;
2205 	unsigned long flags;
2206 
2207 	priv_ep = cdns3_find_available_ep(priv_dev, desc);
2208 	if (IS_ERR(priv_ep)) {
2209 		dev_err(priv_dev->dev, "no available ep\n");
2210 		return NULL;
2211 	}
2212 
2213 	dev_dbg(priv_dev->dev, "match endpoint: %s\n", priv_ep->name);
2214 
2215 	spin_lock_irqsave(&priv_dev->lock, flags);
2216 	priv_ep->endpoint.desc = desc;
2217 	priv_ep->dir  = usb_endpoint_dir_in(desc) ? USB_DIR_IN : USB_DIR_OUT;
2218 	priv_ep->type = usb_endpoint_type(desc);
2219 	priv_ep->flags |= EP_CLAIMED;
2220 	priv_ep->interval = desc->bInterval ? BIT(desc->bInterval - 1) : 0;
2221 
2222 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2223 	return &priv_ep->endpoint;
2224 }
2225 
2226 /**
2227  * cdns3_gadget_ep_alloc_request Allocates request
2228  * @ep: endpoint object associated with request
2229  * @gfp_flags: gfp flags
2230  *
2231  * Returns allocated request address, NULL on allocation error
2232  */
cdns3_gadget_ep_alloc_request(struct usb_ep * ep,gfp_t gfp_flags)2233 struct usb_request *cdns3_gadget_ep_alloc_request(struct usb_ep *ep,
2234 						  gfp_t gfp_flags)
2235 {
2236 	struct cdns3_endpoint *priv_ep = ep_to_cdns3_ep(ep);
2237 	struct cdns3_request *priv_req;
2238 
2239 	priv_req = kzalloc(sizeof(*priv_req), gfp_flags);
2240 	if (!priv_req)
2241 		return NULL;
2242 
2243 	priv_req->priv_ep = priv_ep;
2244 
2245 	trace_cdns3_alloc_request(priv_req);
2246 	return &priv_req->request;
2247 }
2248 
2249 /**
2250  * cdns3_gadget_ep_free_request Free memory occupied by request
2251  * @ep: endpoint object associated with request
2252  * @request: request to free memory
2253  */
cdns3_gadget_ep_free_request(struct usb_ep * ep,struct usb_request * request)2254 void cdns3_gadget_ep_free_request(struct usb_ep *ep,
2255 				  struct usb_request *request)
2256 {
2257 	struct cdns3_request *priv_req = to_cdns3_request(request);
2258 
2259 	if (priv_req->aligned_buf)
2260 		priv_req->aligned_buf->in_use = 0;
2261 
2262 	trace_cdns3_free_request(priv_req);
2263 	kfree(priv_req);
2264 }
2265 
2266 /**
2267  * cdns3_gadget_ep_enable Enable endpoint
2268  * @ep: endpoint object
2269  * @desc: endpoint descriptor
2270  *
2271  * Returns 0 on success, error code elsewhere
2272  */
cdns3_gadget_ep_enable(struct usb_ep * ep,const struct usb_endpoint_descriptor * desc)2273 static int cdns3_gadget_ep_enable(struct usb_ep *ep,
2274 				  const struct usb_endpoint_descriptor *desc)
2275 {
2276 	struct cdns3_endpoint *priv_ep;
2277 	struct cdns3_device *priv_dev;
2278 	const struct usb_ss_ep_comp_descriptor *comp_desc;
2279 	u32 reg = EP_STS_EN_TRBERREN;
2280 	u32 bEndpointAddress;
2281 	unsigned long flags;
2282 	int enable = 1;
2283 	int ret = 0;
2284 	int val;
2285 
2286 	if (!ep) {
2287 		pr_debug("usbss: ep not configured?\n");
2288 		return -EINVAL;
2289 	}
2290 
2291 	priv_ep = ep_to_cdns3_ep(ep);
2292 	priv_dev = priv_ep->cdns3_dev;
2293 	comp_desc = priv_ep->endpoint.comp_desc;
2294 
2295 	if (!desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
2296 		dev_dbg(priv_dev->dev, "usbss: invalid parameters\n");
2297 		return -EINVAL;
2298 	}
2299 
2300 	if (!desc->wMaxPacketSize) {
2301 		dev_err(priv_dev->dev, "usbss: missing wMaxPacketSize\n");
2302 		return -EINVAL;
2303 	}
2304 
2305 	if (dev_WARN_ONCE(priv_dev->dev, priv_ep->flags & EP_ENABLED,
2306 			  "%s is already enabled\n", priv_ep->name))
2307 		return 0;
2308 
2309 	spin_lock_irqsave(&priv_dev->lock, flags);
2310 
2311 	priv_ep->endpoint.desc = desc;
2312 	priv_ep->type = usb_endpoint_type(desc);
2313 	priv_ep->interval = desc->bInterval ? BIT(desc->bInterval - 1) : 0;
2314 
2315 	if (priv_ep->interval > ISO_MAX_INTERVAL &&
2316 	    priv_ep->type == USB_ENDPOINT_XFER_ISOC) {
2317 		dev_err(priv_dev->dev, "Driver is limited to %d period\n",
2318 			ISO_MAX_INTERVAL);
2319 
2320 		ret =  -EINVAL;
2321 		goto exit;
2322 	}
2323 
2324 	bEndpointAddress = priv_ep->num | priv_ep->dir;
2325 	cdns3_select_ep(priv_dev, bEndpointAddress);
2326 
2327 	/*
2328 	 * For some versions of controller at some point during ISO OUT traffic
2329 	 * DMA reads Transfer Ring for the EP which has never got doorbell.
2330 	 * This issue was detected only on simulation, but to avoid this issue
2331 	 * driver add protection against it. To fix it driver enable ISO OUT
2332 	 * endpoint before setting DRBL. This special treatment of ISO OUT
2333 	 * endpoints are recommended by controller specification.
2334 	 */
2335 	if (priv_ep->type == USB_ENDPOINT_XFER_ISOC  && !priv_ep->dir)
2336 		enable = 0;
2337 
2338 	if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
2339 		/*
2340 		 * Enable stream support (SS mode) related interrupts
2341 		 * in EP_STS_EN Register
2342 		 */
2343 		if (priv_dev->gadget.speed >= USB_SPEED_SUPER) {
2344 			reg |= EP_STS_EN_IOTEN | EP_STS_EN_PRIMEEEN |
2345 				EP_STS_EN_SIDERREN | EP_STS_EN_MD_EXITEN |
2346 				EP_STS_EN_STREAMREN;
2347 			priv_ep->use_streams = true;
2348 			ret = cdns3_ep_config(priv_ep, enable);
2349 			priv_dev->using_streams |= true;
2350 		}
2351 	} else {
2352 		ret = cdns3_ep_config(priv_ep, enable);
2353 	}
2354 
2355 	if (ret)
2356 		goto exit;
2357 
2358 	ret = cdns3_allocate_trb_pool(priv_ep);
2359 	if (ret)
2360 		goto exit;
2361 
2362 	bEndpointAddress = priv_ep->num | priv_ep->dir;
2363 	cdns3_select_ep(priv_dev, bEndpointAddress);
2364 
2365 	trace_cdns3_gadget_ep_enable(priv_ep);
2366 
2367 	writel(EP_CMD_EPRST, &priv_dev->regs->ep_cmd);
2368 
2369 	ret = readl_poll_timeout_atomic(&priv_dev->regs->ep_cmd, val,
2370 					!(val & (EP_CMD_CSTALL | EP_CMD_EPRST)),
2371 					1, 1000);
2372 
2373 	if (unlikely(ret)) {
2374 		cdns3_free_trb_pool(priv_ep);
2375 		ret =  -EINVAL;
2376 		goto exit;
2377 	}
2378 
2379 	/* enable interrupt for selected endpoint */
2380 	cdns3_set_register_bit(&priv_dev->regs->ep_ien,
2381 			       BIT(cdns3_ep_addr_to_index(bEndpointAddress)));
2382 
2383 	if (priv_dev->dev_ver < DEV_VER_V2)
2384 		cdns3_wa2_enable_detection(priv_dev, priv_ep, reg);
2385 
2386 	writel(reg, &priv_dev->regs->ep_sts_en);
2387 
2388 	ep->desc = desc;
2389 	priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALLED | EP_STALL_PENDING |
2390 			    EP_QUIRK_ISO_OUT_EN | EP_QUIRK_EXTRA_BUF_EN);
2391 	priv_ep->flags |= EP_ENABLED | EP_UPDATE_EP_TRBADDR;
2392 	priv_ep->wa1_set = 0;
2393 	priv_ep->enqueue = 0;
2394 	priv_ep->dequeue = 0;
2395 	reg = readl(&priv_dev->regs->ep_sts);
2396 	priv_ep->pcs = !!EP_STS_CCS(reg);
2397 	priv_ep->ccs = !!EP_STS_CCS(reg);
2398 	/* one TRB is reserved for link TRB used in DMULT mode*/
2399 	priv_ep->free_trbs = priv_ep->num_trbs - 1;
2400 exit:
2401 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2402 
2403 	return ret;
2404 }
2405 
2406 /**
2407  * cdns3_gadget_ep_disable Disable endpoint
2408  * @ep: endpoint object
2409  *
2410  * Returns 0 on success, error code elsewhere
2411  */
cdns3_gadget_ep_disable(struct usb_ep * ep)2412 static int cdns3_gadget_ep_disable(struct usb_ep *ep)
2413 {
2414 	struct cdns3_endpoint *priv_ep;
2415 	struct cdns3_request *priv_req;
2416 	struct cdns3_device *priv_dev;
2417 	struct usb_request *request;
2418 	unsigned long flags;
2419 	int ret = 0;
2420 	u32 ep_cfg;
2421 	int val;
2422 
2423 	if (!ep) {
2424 		pr_err("usbss: invalid parameters\n");
2425 		return -EINVAL;
2426 	}
2427 
2428 	priv_ep = ep_to_cdns3_ep(ep);
2429 	priv_dev = priv_ep->cdns3_dev;
2430 
2431 	if (dev_WARN_ONCE(priv_dev->dev, !(priv_ep->flags & EP_ENABLED),
2432 			  "%s is already disabled\n", priv_ep->name))
2433 		return 0;
2434 
2435 	spin_lock_irqsave(&priv_dev->lock, flags);
2436 
2437 	trace_cdns3_gadget_ep_disable(priv_ep);
2438 
2439 	cdns3_select_ep(priv_dev, ep->desc->bEndpointAddress);
2440 
2441 	ep_cfg = readl(&priv_dev->regs->ep_cfg);
2442 	ep_cfg &= ~EP_CFG_ENABLE;
2443 	writel(ep_cfg, &priv_dev->regs->ep_cfg);
2444 
2445 	/**
2446 	 * Driver needs some time before resetting endpoint.
2447 	 * It need waits for clearing DBUSY bit or for timeout expired.
2448 	 * 10us is enough time for controller to stop transfer.
2449 	 */
2450 	readl_poll_timeout_atomic(&priv_dev->regs->ep_sts, val,
2451 				  !(val & EP_STS_DBUSY), 1, 10);
2452 	writel(EP_CMD_EPRST, &priv_dev->regs->ep_cmd);
2453 
2454 	readl_poll_timeout_atomic(&priv_dev->regs->ep_cmd, val,
2455 				  !(val & (EP_CMD_CSTALL | EP_CMD_EPRST)),
2456 				  1, 1000);
2457 	if (unlikely(ret))
2458 		dev_err(priv_dev->dev, "Timeout: %s resetting failed.\n",
2459 			priv_ep->name);
2460 
2461 	while (!list_empty(&priv_ep->pending_req_list)) {
2462 		request = cdns3_next_request(&priv_ep->pending_req_list);
2463 
2464 		cdns3_gadget_giveback(priv_ep, to_cdns3_request(request),
2465 				      -ESHUTDOWN);
2466 	}
2467 
2468 	while (!list_empty(&priv_ep->wa2_descmiss_req_list)) {
2469 		priv_req = cdns3_next_priv_request(&priv_ep->wa2_descmiss_req_list);
2470 
2471 		kfree(priv_req->request.buf);
2472 		cdns3_gadget_ep_free_request(&priv_ep->endpoint,
2473 					     &priv_req->request);
2474 		list_del_init(&priv_req->list);
2475 		--priv_ep->wa2_counter;
2476 	}
2477 
2478 	while (!list_empty(&priv_ep->deferred_req_list)) {
2479 		request = cdns3_next_request(&priv_ep->deferred_req_list);
2480 
2481 		cdns3_gadget_giveback(priv_ep, to_cdns3_request(request),
2482 				      -ESHUTDOWN);
2483 	}
2484 
2485 	priv_ep->descmis_req = NULL;
2486 
2487 	ep->desc = NULL;
2488 	priv_ep->flags &= ~EP_ENABLED;
2489 	priv_ep->use_streams = false;
2490 
2491 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2492 
2493 	return ret;
2494 }
2495 
2496 /**
2497  * cdns3_gadget_ep_queue Transfer data on endpoint
2498  * @ep: endpoint object
2499  * @request: request object
2500  * @gfp_flags: gfp flags
2501  *
2502  * Returns 0 on success, error code elsewhere
2503  */
__cdns3_gadget_ep_queue(struct usb_ep * ep,struct usb_request * request,gfp_t gfp_flags)2504 static int __cdns3_gadget_ep_queue(struct usb_ep *ep,
2505 				   struct usb_request *request,
2506 				   gfp_t gfp_flags)
2507 {
2508 	struct cdns3_endpoint *priv_ep = ep_to_cdns3_ep(ep);
2509 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
2510 	struct cdns3_request *priv_req;
2511 	int ret = 0;
2512 
2513 	request->actual = 0;
2514 	request->status = -EINPROGRESS;
2515 	priv_req = to_cdns3_request(request);
2516 	trace_cdns3_ep_queue(priv_req);
2517 
2518 	if (priv_dev->dev_ver < DEV_VER_V2) {
2519 		ret = cdns3_wa2_gadget_ep_queue(priv_dev, priv_ep,
2520 						priv_req);
2521 
2522 		if (ret == EINPROGRESS)
2523 			return 0;
2524 	}
2525 
2526 	ret = cdns3_prepare_aligned_request_buf(priv_req);
2527 	if (ret < 0)
2528 		return ret;
2529 
2530 	ret = usb_gadget_map_request_by_dev(priv_dev->sysdev, request,
2531 					    usb_endpoint_dir_in(ep->desc));
2532 	if (ret)
2533 		return ret;
2534 
2535 	list_add_tail(&request->list, &priv_ep->deferred_req_list);
2536 
2537 	/*
2538 	 * For stream capable endpoint if prime irq flag is set then only start
2539 	 * request.
2540 	 * If hardware endpoint configuration has not been set yet then
2541 	 * just queue request in deferred list. Transfer will be started in
2542 	 * cdns3_set_hw_configuration.
2543 	 */
2544 	if (!request->stream_id) {
2545 		if (priv_dev->hw_configured_flag &&
2546 		    !(priv_ep->flags & EP_STALLED) &&
2547 		    !(priv_ep->flags & EP_STALL_PENDING))
2548 			cdns3_start_all_request(priv_dev, priv_ep);
2549 	} else {
2550 		if (priv_dev->hw_configured_flag && priv_ep->prime_flag)
2551 			cdns3_start_all_request(priv_dev, priv_ep);
2552 	}
2553 
2554 	return 0;
2555 }
2556 
cdns3_gadget_ep_queue(struct usb_ep * ep,struct usb_request * request,gfp_t gfp_flags)2557 static int cdns3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
2558 				 gfp_t gfp_flags)
2559 {
2560 	struct usb_request *zlp_request;
2561 	struct cdns3_endpoint *priv_ep;
2562 	struct cdns3_device *priv_dev;
2563 	unsigned long flags;
2564 	int ret;
2565 
2566 	if (!request || !ep)
2567 		return -EINVAL;
2568 
2569 	priv_ep = ep_to_cdns3_ep(ep);
2570 	priv_dev = priv_ep->cdns3_dev;
2571 
2572 	spin_lock_irqsave(&priv_dev->lock, flags);
2573 
2574 	ret = __cdns3_gadget_ep_queue(ep, request, gfp_flags);
2575 
2576 	if (ret == 0 && request->zero && request->length &&
2577 	    (request->length % ep->maxpacket == 0)) {
2578 		struct cdns3_request *priv_req;
2579 
2580 		zlp_request = cdns3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
2581 		zlp_request->buf = priv_dev->zlp_buf;
2582 		zlp_request->length = 0;
2583 
2584 		priv_req = to_cdns3_request(zlp_request);
2585 		priv_req->flags |= REQUEST_ZLP;
2586 
2587 		dev_dbg(priv_dev->dev, "Queuing ZLP for endpoint: %s\n",
2588 			priv_ep->name);
2589 		ret = __cdns3_gadget_ep_queue(ep, zlp_request, gfp_flags);
2590 	}
2591 
2592 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2593 	return ret;
2594 }
2595 
2596 /**
2597  * cdns3_gadget_ep_dequeue Remove request from transfer queue
2598  * @ep: endpoint object associated with request
2599  * @request: request object
2600  *
2601  * Returns 0 on success, error code elsewhere
2602  */
cdns3_gadget_ep_dequeue(struct usb_ep * ep,struct usb_request * request)2603 int cdns3_gadget_ep_dequeue(struct usb_ep *ep,
2604 			    struct usb_request *request)
2605 {
2606 	struct cdns3_endpoint *priv_ep = ep_to_cdns3_ep(ep);
2607 	struct cdns3_device *priv_dev;
2608 	struct usb_request *req, *req_temp;
2609 	struct cdns3_request *priv_req;
2610 	struct cdns3_trb *link_trb;
2611 	u8 req_on_hw_ring = 0;
2612 	unsigned long flags;
2613 	int ret = 0;
2614 
2615 	if (!ep || !request || !ep->desc)
2616 		return -EINVAL;
2617 
2618 	priv_dev = priv_ep->cdns3_dev;
2619 
2620 	spin_lock_irqsave(&priv_dev->lock, flags);
2621 
2622 	priv_req = to_cdns3_request(request);
2623 
2624 	trace_cdns3_ep_dequeue(priv_req);
2625 
2626 	cdns3_select_ep(priv_dev, ep->desc->bEndpointAddress);
2627 
2628 	list_for_each_entry_safe(req, req_temp, &priv_ep->pending_req_list,
2629 				 list) {
2630 		if (request == req) {
2631 			req_on_hw_ring = 1;
2632 			goto found;
2633 		}
2634 	}
2635 
2636 	list_for_each_entry_safe(req, req_temp, &priv_ep->deferred_req_list,
2637 				 list) {
2638 		if (request == req)
2639 			goto found;
2640 	}
2641 
2642 	goto not_found;
2643 
2644 found:
2645 	link_trb = priv_req->trb;
2646 
2647 	/* Update ring only if removed request is on pending_req_list list */
2648 	if (req_on_hw_ring && link_trb) {
2649 		link_trb->buffer = cpu_to_le32(TRB_BUFFER(priv_ep->trb_pool_dma +
2650 			((priv_req->end_trb + 1) * TRB_SIZE)));
2651 		link_trb->control = cpu_to_le32((le32_to_cpu(link_trb->control) & TRB_CYCLE) |
2652 				    TRB_TYPE(TRB_LINK) | TRB_CHAIN);
2653 
2654 		if (priv_ep->wa1_trb == priv_req->trb)
2655 			cdns3_wa1_restore_cycle_bit(priv_ep);
2656 	}
2657 
2658 	cdns3_gadget_giveback(priv_ep, priv_req, -ECONNRESET);
2659 
2660 not_found:
2661 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2662 	return ret;
2663 }
2664 
2665 /**
2666  * __cdns3_gadget_ep_set_halt Sets stall on selected endpoint
2667  * Should be called after acquiring spin_lock and selecting ep
2668  * @priv_ep: endpoint object to set stall on.
2669  */
__cdns3_gadget_ep_set_halt(struct cdns3_endpoint * priv_ep)2670 void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep)
2671 {
2672 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
2673 
2674 	trace_cdns3_halt(priv_ep, 1, 0);
2675 
2676 	if (!(priv_ep->flags & EP_STALLED)) {
2677 		u32 ep_sts_reg = readl(&priv_dev->regs->ep_sts);
2678 
2679 		if (!(ep_sts_reg & EP_STS_DBUSY))
2680 			cdns3_ep_stall_flush(priv_ep);
2681 		else
2682 			priv_ep->flags |= EP_STALL_PENDING;
2683 	}
2684 }
2685 
2686 /**
2687  * __cdns3_gadget_ep_clear_halt Clears stall on selected endpoint
2688  * Should be called after acquiring spin_lock and selecting ep
2689  * @priv_ep: endpoint object to clear stall on
2690  */
__cdns3_gadget_ep_clear_halt(struct cdns3_endpoint * priv_ep)2691 int __cdns3_gadget_ep_clear_halt(struct cdns3_endpoint *priv_ep)
2692 {
2693 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
2694 	struct usb_request *request;
2695 	struct cdns3_request *priv_req;
2696 	struct cdns3_trb *trb = NULL;
2697 	struct cdns3_trb trb_tmp;
2698 	int ret;
2699 	int val;
2700 
2701 	trace_cdns3_halt(priv_ep, 0, 0);
2702 
2703 	request = cdns3_next_request(&priv_ep->pending_req_list);
2704 	if (request) {
2705 		priv_req = to_cdns3_request(request);
2706 		trb = priv_req->trb;
2707 		if (trb) {
2708 			trb_tmp = *trb;
2709 			trb->control = trb->control ^ cpu_to_le32(TRB_CYCLE);
2710 		}
2711 	}
2712 
2713 	writel(EP_CMD_CSTALL | EP_CMD_EPRST, &priv_dev->regs->ep_cmd);
2714 
2715 	/* wait for EPRST cleared */
2716 	ret = readl_poll_timeout_atomic(&priv_dev->regs->ep_cmd, val,
2717 					!(val & EP_CMD_EPRST), 1, 100);
2718 	if (ret)
2719 		return -EINVAL;
2720 
2721 	priv_ep->flags &= ~(EP_STALLED | EP_STALL_PENDING);
2722 
2723 	if (request) {
2724 		if (trb)
2725 			*trb = trb_tmp;
2726 
2727 		cdns3_rearm_transfer(priv_ep, 1);
2728 	}
2729 
2730 	cdns3_start_all_request(priv_dev, priv_ep);
2731 	return ret;
2732 }
2733 
2734 /**
2735  * cdns3_gadget_ep_set_halt Sets/clears stall on selected endpoint
2736  * @ep: endpoint object to set/clear stall on
2737  * @value: 1 for set stall, 0 for clear stall
2738  *
2739  * Returns 0 on success, error code elsewhere
2740  */
cdns3_gadget_ep_set_halt(struct usb_ep * ep,int value)2741 int cdns3_gadget_ep_set_halt(struct usb_ep *ep, int value)
2742 {
2743 	struct cdns3_endpoint *priv_ep = ep_to_cdns3_ep(ep);
2744 	struct cdns3_device *priv_dev = priv_ep->cdns3_dev;
2745 	unsigned long flags;
2746 	int ret = 0;
2747 
2748 	if (!(priv_ep->flags & EP_ENABLED))
2749 		return -EPERM;
2750 
2751 	spin_lock_irqsave(&priv_dev->lock, flags);
2752 
2753 	cdns3_select_ep(priv_dev, ep->desc->bEndpointAddress);
2754 
2755 	if (!value) {
2756 		priv_ep->flags &= ~EP_WEDGE;
2757 		ret = __cdns3_gadget_ep_clear_halt(priv_ep);
2758 	} else {
2759 		__cdns3_gadget_ep_set_halt(priv_ep);
2760 	}
2761 
2762 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2763 
2764 	return ret;
2765 }
2766 
2767 extern const struct usb_ep_ops cdns3_gadget_ep0_ops;
2768 
2769 static const struct usb_ep_ops cdns3_gadget_ep_ops = {
2770 	.enable = cdns3_gadget_ep_enable,
2771 	.disable = cdns3_gadget_ep_disable,
2772 	.alloc_request = cdns3_gadget_ep_alloc_request,
2773 	.free_request = cdns3_gadget_ep_free_request,
2774 	.queue = cdns3_gadget_ep_queue,
2775 	.dequeue = cdns3_gadget_ep_dequeue,
2776 	.set_halt = cdns3_gadget_ep_set_halt,
2777 	.set_wedge = cdns3_gadget_ep_set_wedge,
2778 };
2779 
2780 /**
2781  * cdns3_gadget_get_frame Returns number of actual ITP frame
2782  * @gadget: gadget object
2783  *
2784  * Returns number of actual ITP frame
2785  */
cdns3_gadget_get_frame(struct usb_gadget * gadget)2786 static int cdns3_gadget_get_frame(struct usb_gadget *gadget)
2787 {
2788 	struct cdns3_device *priv_dev = gadget_to_cdns3_device(gadget);
2789 
2790 	return readl(&priv_dev->regs->usb_itpn);
2791 }
2792 
__cdns3_gadget_wakeup(struct cdns3_device * priv_dev)2793 int __cdns3_gadget_wakeup(struct cdns3_device *priv_dev)
2794 {
2795 	enum usb_device_speed speed;
2796 
2797 	speed = cdns3_get_speed(priv_dev);
2798 
2799 	if (speed >= USB_SPEED_SUPER)
2800 		return 0;
2801 
2802 	/* Start driving resume signaling to indicate remote wakeup. */
2803 	writel(USB_CONF_LGO_L0, &priv_dev->regs->usb_conf);
2804 
2805 	return 0;
2806 }
2807 
cdns3_gadget_wakeup(struct usb_gadget * gadget)2808 static int cdns3_gadget_wakeup(struct usb_gadget *gadget)
2809 {
2810 	struct cdns3_device *priv_dev = gadget_to_cdns3_device(gadget);
2811 	unsigned long flags;
2812 	int ret = 0;
2813 
2814 	spin_lock_irqsave(&priv_dev->lock, flags);
2815 	ret = __cdns3_gadget_wakeup(priv_dev);
2816 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2817 	return ret;
2818 }
2819 
cdns3_gadget_set_selfpowered(struct usb_gadget * gadget,int is_selfpowered)2820 static int cdns3_gadget_set_selfpowered(struct usb_gadget *gadget,
2821 					int is_selfpowered)
2822 {
2823 	struct cdns3_device *priv_dev = gadget_to_cdns3_device(gadget);
2824 	unsigned long flags;
2825 
2826 	spin_lock_irqsave(&priv_dev->lock, flags);
2827 	priv_dev->is_selfpowered = !!is_selfpowered;
2828 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2829 	return 0;
2830 }
2831 
cdns3_gadget_pullup(struct usb_gadget * gadget,int is_on)2832 static int cdns3_gadget_pullup(struct usb_gadget *gadget, int is_on)
2833 {
2834 	struct cdns3_device *priv_dev = gadget_to_cdns3_device(gadget);
2835 
2836 	if (is_on) {
2837 		writel(USB_CONF_DEVEN, &priv_dev->regs->usb_conf);
2838 	} else {
2839 		writel(~0, &priv_dev->regs->ep_ists);
2840 		writel(~0, &priv_dev->regs->usb_ists);
2841 		writel(USB_CONF_DEVDS, &priv_dev->regs->usb_conf);
2842 	}
2843 
2844 	return 0;
2845 }
2846 
cdns3_gadget_config(struct cdns3_device * priv_dev)2847 static void cdns3_gadget_config(struct cdns3_device *priv_dev)
2848 {
2849 	struct cdns3_usb_regs __iomem *regs = priv_dev->regs;
2850 	u32 reg;
2851 
2852 	cdns3_ep0_config(priv_dev);
2853 
2854 	/* enable interrupts for endpoint 0 (in and out) */
2855 	writel(EP_IEN_EP_OUT0 | EP_IEN_EP_IN0, &regs->ep_ien);
2856 
2857 	/*
2858 	 * Driver needs to modify LFPS minimal U1 Exit time for DEV_VER_TI_V1
2859 	 * revision of controller.
2860 	 */
2861 	if (priv_dev->dev_ver == DEV_VER_TI_V1) {
2862 		reg = readl(&regs->dbg_link1);
2863 
2864 		reg &= ~DBG_LINK1_LFPS_MIN_GEN_U1_EXIT_MASK;
2865 		reg |= DBG_LINK1_LFPS_MIN_GEN_U1_EXIT(0x55) |
2866 		       DBG_LINK1_LFPS_MIN_GEN_U1_EXIT_SET;
2867 		writel(reg, &regs->dbg_link1);
2868 	}
2869 
2870 	/*
2871 	 * By default some platforms has set protected access to memory.
2872 	 * This cause problem with cache, so driver restore non-secure
2873 	 * access to memory.
2874 	 */
2875 	reg = readl(&regs->dma_axi_ctrl);
2876 	reg |= DMA_AXI_CTRL_MARPROT(DMA_AXI_CTRL_NON_SECURE) |
2877 	       DMA_AXI_CTRL_MAWPROT(DMA_AXI_CTRL_NON_SECURE);
2878 	writel(reg, &regs->dma_axi_ctrl);
2879 
2880 	/* enable generic interrupt*/
2881 	writel(USB_IEN_INIT, &regs->usb_ien);
2882 	writel(USB_CONF_CLK2OFFDS | USB_CONF_L1DS, &regs->usb_conf);
2883 	/*  keep Fast Access bit */
2884 	writel(PUSB_PWR_FST_REG_ACCESS, &priv_dev->regs->usb_pwr);
2885 
2886 	cdns3_configure_dmult(priv_dev, NULL);
2887 }
2888 
2889 /**
2890  * cdns3_gadget_udc_start Gadget start
2891  * @gadget: gadget object
2892  * @driver: driver which operates on this gadget
2893  *
2894  * Returns 0 on success, error code elsewhere
2895  */
cdns3_gadget_udc_start(struct usb_gadget * gadget,struct usb_gadget_driver * driver)2896 static int cdns3_gadget_udc_start(struct usb_gadget *gadget,
2897 				  struct usb_gadget_driver *driver)
2898 {
2899 	struct cdns3_device *priv_dev = gadget_to_cdns3_device(gadget);
2900 	unsigned long flags;
2901 	enum usb_device_speed max_speed = driver->max_speed;
2902 
2903 	spin_lock_irqsave(&priv_dev->lock, flags);
2904 	priv_dev->gadget_driver = driver;
2905 
2906 	/* limit speed if necessary */
2907 	max_speed = min(driver->max_speed, gadget->max_speed);
2908 
2909 	switch (max_speed) {
2910 	case USB_SPEED_FULL:
2911 		writel(USB_CONF_SFORCE_FS, &priv_dev->regs->usb_conf);
2912 		writel(USB_CONF_USB3DIS, &priv_dev->regs->usb_conf);
2913 		break;
2914 	case USB_SPEED_HIGH:
2915 		writel(USB_CONF_USB3DIS, &priv_dev->regs->usb_conf);
2916 		break;
2917 	case USB_SPEED_SUPER:
2918 		break;
2919 	default:
2920 		dev_err(priv_dev->dev,
2921 			"invalid maximum_speed parameter %d\n",
2922 			max_speed);
2923 		fallthrough;
2924 	case USB_SPEED_UNKNOWN:
2925 		/* default to superspeed */
2926 		max_speed = USB_SPEED_SUPER;
2927 		break;
2928 	}
2929 
2930 	cdns3_gadget_config(priv_dev);
2931 	spin_unlock_irqrestore(&priv_dev->lock, flags);
2932 	return 0;
2933 }
2934 
2935 /**
2936  * cdns3_gadget_udc_stop Stops gadget
2937  * @gadget: gadget object
2938  *
2939  * Returns 0
2940  */
cdns3_gadget_udc_stop(struct usb_gadget * gadget)2941 static int cdns3_gadget_udc_stop(struct usb_gadget *gadget)
2942 {
2943 	struct cdns3_device *priv_dev = gadget_to_cdns3_device(gadget);
2944 	struct cdns3_endpoint *priv_ep;
2945 	u32 bEndpointAddress;
2946 	struct usb_ep *ep;
2947 	int val;
2948 
2949 	priv_dev->gadget_driver = NULL;
2950 
2951 	priv_dev->onchip_used_size = 0;
2952 	priv_dev->out_mem_is_allocated = 0;
2953 	priv_dev->gadget.speed = USB_SPEED_UNKNOWN;
2954 
2955 	list_for_each_entry(ep, &priv_dev->gadget.ep_list, ep_list) {
2956 		priv_ep = ep_to_cdns3_ep(ep);
2957 		bEndpointAddress = priv_ep->num | priv_ep->dir;
2958 		cdns3_select_ep(priv_dev, bEndpointAddress);
2959 		writel(EP_CMD_EPRST, &priv_dev->regs->ep_cmd);
2960 		readl_poll_timeout_atomic(&priv_dev->regs->ep_cmd, val,
2961 					  !(val & EP_CMD_EPRST), 1, 100);
2962 
2963 		priv_ep->flags &= ~EP_CLAIMED;
2964 	}
2965 
2966 	/* disable interrupt for device */
2967 	writel(0, &priv_dev->regs->usb_ien);
2968 	writel(0, &priv_dev->regs->usb_pwr);
2969 	writel(USB_CONF_DEVDS, &priv_dev->regs->usb_conf);
2970 
2971 	return 0;
2972 }
2973 
2974 static const struct usb_gadget_ops cdns3_gadget_ops = {
2975 	.get_frame = cdns3_gadget_get_frame,
2976 	.wakeup = cdns3_gadget_wakeup,
2977 	.set_selfpowered = cdns3_gadget_set_selfpowered,
2978 	.pullup = cdns3_gadget_pullup,
2979 	.udc_start = cdns3_gadget_udc_start,
2980 	.udc_stop = cdns3_gadget_udc_stop,
2981 	.match_ep = cdns3_gadget_match_ep,
2982 };
2983 
cdns3_free_all_eps(struct cdns3_device * priv_dev)2984 static void cdns3_free_all_eps(struct cdns3_device *priv_dev)
2985 {
2986 	int i;
2987 
2988 	/* ep0 OUT point to ep0 IN. */
2989 	priv_dev->eps[16] = NULL;
2990 
2991 	for (i = 0; i < CDNS3_ENDPOINTS_MAX_COUNT; i++)
2992 		if (priv_dev->eps[i]) {
2993 			cdns3_free_trb_pool(priv_dev->eps[i]);
2994 			devm_kfree(priv_dev->dev, priv_dev->eps[i]);
2995 		}
2996 }
2997 
2998 /**
2999  * cdns3_init_eps Initializes software endpoints of gadget
3000  * @priv_dev: extended gadget object
3001  *
3002  * Returns 0 on success, error code elsewhere
3003  */
cdns3_init_eps(struct cdns3_device * priv_dev)3004 static int cdns3_init_eps(struct cdns3_device *priv_dev)
3005 {
3006 	u32 ep_enabled_reg, iso_ep_reg;
3007 	struct cdns3_endpoint *priv_ep;
3008 	int ep_dir, ep_number;
3009 	u32 ep_mask;
3010 	int ret = 0;
3011 	int i;
3012 
3013 	/* Read it from USB_CAP3 to USB_CAP5 */
3014 	ep_enabled_reg = readl(&priv_dev->regs->usb_cap3);
3015 	iso_ep_reg = readl(&priv_dev->regs->usb_cap4);
3016 
3017 	dev_dbg(priv_dev->dev, "Initializing non-zero endpoints\n");
3018 
3019 	for (i = 0; i < CDNS3_ENDPOINTS_MAX_COUNT; i++) {
3020 		ep_dir = i >> 4;	/* i div 16 */
3021 		ep_number = i & 0xF;	/* i % 16 */
3022 		ep_mask = BIT(i);
3023 
3024 		if (!(ep_enabled_reg & ep_mask))
3025 			continue;
3026 
3027 		if (ep_dir && !ep_number) {
3028 			priv_dev->eps[i] = priv_dev->eps[0];
3029 			continue;
3030 		}
3031 
3032 		priv_ep = devm_kzalloc(priv_dev->dev, sizeof(*priv_ep),
3033 				       GFP_KERNEL);
3034 		if (!priv_ep)
3035 			goto err;
3036 
3037 		/* set parent of endpoint object */
3038 		priv_ep->cdns3_dev = priv_dev;
3039 		priv_dev->eps[i] = priv_ep;
3040 		priv_ep->num = ep_number;
3041 		priv_ep->dir = ep_dir ? USB_DIR_IN : USB_DIR_OUT;
3042 
3043 		if (!ep_number) {
3044 			ret = cdns3_init_ep0(priv_dev, priv_ep);
3045 			if (ret) {
3046 				dev_err(priv_dev->dev, "Failed to init ep0\n");
3047 				goto err;
3048 			}
3049 		} else {
3050 			snprintf(priv_ep->name, sizeof(priv_ep->name), "ep%d%s",
3051 				 ep_number, !!ep_dir ? "in" : "out");
3052 			priv_ep->endpoint.name = priv_ep->name;
3053 
3054 			usb_ep_set_maxpacket_limit(&priv_ep->endpoint,
3055 						   CDNS3_EP_MAX_PACKET_LIMIT);
3056 			priv_ep->endpoint.max_streams = CDNS3_EP_MAX_STREAMS;
3057 			priv_ep->endpoint.ops = &cdns3_gadget_ep_ops;
3058 			if (ep_dir)
3059 				priv_ep->endpoint.caps.dir_in = 1;
3060 			else
3061 				priv_ep->endpoint.caps.dir_out = 1;
3062 
3063 			if (iso_ep_reg & ep_mask)
3064 				priv_ep->endpoint.caps.type_iso = 1;
3065 
3066 			priv_ep->endpoint.caps.type_bulk = 1;
3067 			priv_ep->endpoint.caps.type_int = 1;
3068 
3069 			list_add_tail(&priv_ep->endpoint.ep_list,
3070 				      &priv_dev->gadget.ep_list);
3071 		}
3072 
3073 		priv_ep->flags = 0;
3074 
3075 		dev_dbg(priv_dev->dev, "Initialized  %s support: %s %s\n",
3076 			 priv_ep->name,
3077 			 priv_ep->endpoint.caps.type_bulk ? "BULK, INT" : "",
3078 			 priv_ep->endpoint.caps.type_iso ? "ISO" : "");
3079 
3080 		INIT_LIST_HEAD(&priv_ep->pending_req_list);
3081 		INIT_LIST_HEAD(&priv_ep->deferred_req_list);
3082 		INIT_LIST_HEAD(&priv_ep->wa2_descmiss_req_list);
3083 	}
3084 
3085 	return 0;
3086 err:
3087 	cdns3_free_all_eps(priv_dev);
3088 	return -ENOMEM;
3089 }
3090 
cdns3_gadget_release(struct device * dev)3091 static void cdns3_gadget_release(struct device *dev)
3092 {
3093 	struct cdns3_device *priv_dev = container_of(dev,
3094 			struct cdns3_device, gadget.dev);
3095 
3096 	kfree(priv_dev);
3097 }
3098 
cdns3_gadget_exit(struct cdns3 * cdns)3099 void cdns3_gadget_exit(struct cdns3 *cdns)
3100 {
3101 	struct cdns3_device *priv_dev;
3102 
3103 	priv_dev = cdns->gadget_dev;
3104 
3105 
3106 	pm_runtime_mark_last_busy(cdns->dev);
3107 	pm_runtime_put_autosuspend(cdns->dev);
3108 
3109 	usb_del_gadget(&priv_dev->gadget);
3110 	devm_free_irq(cdns->dev, cdns->dev_irq, priv_dev);
3111 
3112 	cdns3_free_all_eps(priv_dev);
3113 
3114 	while (!list_empty(&priv_dev->aligned_buf_list)) {
3115 		struct cdns3_aligned_buf *buf;
3116 
3117 		buf = cdns3_next_align_buf(&priv_dev->aligned_buf_list);
3118 		dma_free_coherent(priv_dev->sysdev, buf->size,
3119 				  buf->buf,
3120 				  buf->dma);
3121 
3122 		list_del(&buf->list);
3123 		kfree(buf);
3124 	}
3125 
3126 	dma_free_coherent(priv_dev->sysdev, 8, priv_dev->setup_buf,
3127 			  priv_dev->setup_dma);
3128 
3129 	kfree(priv_dev->zlp_buf);
3130 	usb_put_gadget(&priv_dev->gadget);
3131 	cdns->gadget_dev = NULL;
3132 	cdns3_drd_gadget_off(cdns);
3133 }
3134 
cdns3_gadget_start(struct cdns3 * cdns)3135 static int cdns3_gadget_start(struct cdns3 *cdns)
3136 {
3137 	struct cdns3_device *priv_dev;
3138 	u32 max_speed;
3139 	int ret;
3140 
3141 	priv_dev = kzalloc(sizeof(*priv_dev), GFP_KERNEL);
3142 	if (!priv_dev)
3143 		return -ENOMEM;
3144 
3145 	usb_initialize_gadget(cdns->dev, &priv_dev->gadget,
3146 			cdns3_gadget_release);
3147 	cdns->gadget_dev = priv_dev;
3148 	priv_dev->sysdev = cdns->dev;
3149 	priv_dev->dev = cdns->dev;
3150 	priv_dev->regs = cdns->dev_regs;
3151 
3152 	device_property_read_u16(priv_dev->dev, "cdns,on-chip-buff-size",
3153 				 &priv_dev->onchip_buffers);
3154 
3155 	if (priv_dev->onchip_buffers <=  0) {
3156 		u32 reg = readl(&priv_dev->regs->usb_cap2);
3157 
3158 		priv_dev->onchip_buffers = USB_CAP2_ACTUAL_MEM_SIZE(reg);
3159 	}
3160 
3161 	if (!priv_dev->onchip_buffers)
3162 		priv_dev->onchip_buffers = 256;
3163 
3164 	max_speed = usb_get_maximum_speed(cdns->dev);
3165 
3166 	/* Check the maximum_speed parameter */
3167 	switch (max_speed) {
3168 	case USB_SPEED_FULL:
3169 	case USB_SPEED_HIGH:
3170 	case USB_SPEED_SUPER:
3171 		break;
3172 	default:
3173 		dev_err(cdns->dev, "invalid maximum_speed parameter %d\n",
3174 			max_speed);
3175 		fallthrough;
3176 	case USB_SPEED_UNKNOWN:
3177 		/* default to superspeed */
3178 		max_speed = USB_SPEED_SUPER;
3179 		break;
3180 	}
3181 
3182 	/* fill gadget fields */
3183 	priv_dev->gadget.max_speed = max_speed;
3184 	priv_dev->gadget.speed = USB_SPEED_UNKNOWN;
3185 	priv_dev->gadget.ops = &cdns3_gadget_ops;
3186 	priv_dev->gadget.name = "usb-ss-gadget";
3187 	priv_dev->gadget.quirk_avoids_skb_reserve = 1;
3188 	priv_dev->gadget.irq = cdns->dev_irq;
3189 
3190 	spin_lock_init(&priv_dev->lock);
3191 	INIT_WORK(&priv_dev->pending_status_wq,
3192 		  cdns3_pending_setup_status_handler);
3193 
3194 	INIT_WORK(&priv_dev->aligned_buf_wq,
3195 		  cdns3_free_aligned_request_buf);
3196 
3197 	/* initialize endpoint container */
3198 	INIT_LIST_HEAD(&priv_dev->gadget.ep_list);
3199 	INIT_LIST_HEAD(&priv_dev->aligned_buf_list);
3200 
3201 	ret = cdns3_init_eps(priv_dev);
3202 	if (ret) {
3203 		dev_err(priv_dev->dev, "Failed to create endpoints\n");
3204 		goto err1;
3205 	}
3206 
3207 	/* allocate memory for setup packet buffer */
3208 	priv_dev->setup_buf = dma_alloc_coherent(priv_dev->sysdev, 8,
3209 						 &priv_dev->setup_dma, GFP_DMA);
3210 	if (!priv_dev->setup_buf) {
3211 		ret = -ENOMEM;
3212 		goto err2;
3213 	}
3214 
3215 	priv_dev->dev_ver = readl(&priv_dev->regs->usb_cap6);
3216 
3217 	dev_dbg(priv_dev->dev, "Device Controller version: %08x\n",
3218 		readl(&priv_dev->regs->usb_cap6));
3219 	dev_dbg(priv_dev->dev, "USB Capabilities:: %08x\n",
3220 		readl(&priv_dev->regs->usb_cap1));
3221 	dev_dbg(priv_dev->dev, "On-Chip memory configuration: %08x\n",
3222 		readl(&priv_dev->regs->usb_cap2));
3223 
3224 	priv_dev->dev_ver = GET_DEV_BASE_VERSION(priv_dev->dev_ver);
3225 	if (priv_dev->dev_ver >= DEV_VER_V2)
3226 		priv_dev->gadget.sg_supported = 1;
3227 
3228 	priv_dev->zlp_buf = kzalloc(CDNS3_EP_ZLP_BUF_SIZE, GFP_KERNEL);
3229 	if (!priv_dev->zlp_buf) {
3230 		ret = -ENOMEM;
3231 		goto err3;
3232 	}
3233 
3234 	/* add USB gadget device */
3235 	ret = usb_add_gadget(&priv_dev->gadget);
3236 	if (ret < 0) {
3237 		dev_err(priv_dev->dev, "Failed to add gadget\n");
3238 		goto err4;
3239 	}
3240 
3241 	return 0;
3242 err4:
3243 	kfree(priv_dev->zlp_buf);
3244 err3:
3245 	dma_free_coherent(priv_dev->sysdev, 8, priv_dev->setup_buf,
3246 			  priv_dev->setup_dma);
3247 err2:
3248 	cdns3_free_all_eps(priv_dev);
3249 err1:
3250 	usb_put_gadget(&priv_dev->gadget);
3251 	cdns->gadget_dev = NULL;
3252 	return ret;
3253 }
3254 
__cdns3_gadget_init(struct cdns3 * cdns)3255 static int __cdns3_gadget_init(struct cdns3 *cdns)
3256 {
3257 	int ret = 0;
3258 
3259 	/* Ensure 32-bit DMA Mask in case we switched back from Host mode */
3260 	ret = dma_set_mask_and_coherent(cdns->dev, DMA_BIT_MASK(32));
3261 	if (ret) {
3262 		dev_err(cdns->dev, "Failed to set dma mask: %d\n", ret);
3263 		return ret;
3264 	}
3265 
3266 	cdns3_drd_gadget_on(cdns);
3267 	pm_runtime_get_sync(cdns->dev);
3268 
3269 	ret = cdns3_gadget_start(cdns);
3270 	if (ret) {
3271 		pm_runtime_put_sync(cdns->dev);
3272 		return ret;
3273 	}
3274 
3275 	/*
3276 	 * Because interrupt line can be shared with other components in
3277 	 * driver it can't use IRQF_ONESHOT flag here.
3278 	 */
3279 	ret = devm_request_threaded_irq(cdns->dev, cdns->dev_irq,
3280 					cdns3_device_irq_handler,
3281 					cdns3_device_thread_irq_handler,
3282 					IRQF_SHARED, dev_name(cdns->dev),
3283 					cdns->gadget_dev);
3284 
3285 	if (ret)
3286 		goto err0;
3287 
3288 	return 0;
3289 err0:
3290 	cdns3_gadget_exit(cdns);
3291 	return ret;
3292 }
3293 
cdns3_gadget_suspend(struct cdns3 * cdns,bool do_wakeup)3294 static int cdns3_gadget_suspend(struct cdns3 *cdns, bool do_wakeup)
3295 __must_hold(&cdns->lock)
3296 {
3297 	struct cdns3_device *priv_dev = cdns->gadget_dev;
3298 
3299 	spin_unlock(&cdns->lock);
3300 	cdns3_disconnect_gadget(priv_dev);
3301 	spin_lock(&cdns->lock);
3302 
3303 	priv_dev->gadget.speed = USB_SPEED_UNKNOWN;
3304 	usb_gadget_set_state(&priv_dev->gadget, USB_STATE_NOTATTACHED);
3305 	cdns3_hw_reset_eps_config(priv_dev);
3306 
3307 	/* disable interrupt for device */
3308 	writel(0, &priv_dev->regs->usb_ien);
3309 
3310 	return 0;
3311 }
3312 
cdns3_gadget_resume(struct cdns3 * cdns,bool hibernated)3313 static int cdns3_gadget_resume(struct cdns3 *cdns, bool hibernated)
3314 {
3315 	struct cdns3_device *priv_dev = cdns->gadget_dev;
3316 
3317 	if (!priv_dev->gadget_driver)
3318 		return 0;
3319 
3320 	cdns3_gadget_config(priv_dev);
3321 
3322 	return 0;
3323 }
3324 
3325 /**
3326  * cdns3_gadget_init - initialize device structure
3327  *
3328  * @cdns: cdns3 instance
3329  *
3330  * This function initializes the gadget.
3331  */
cdns3_gadget_init(struct cdns3 * cdns)3332 int cdns3_gadget_init(struct cdns3 *cdns)
3333 {
3334 	struct cdns3_role_driver *rdrv;
3335 
3336 	rdrv = devm_kzalloc(cdns->dev, sizeof(*rdrv), GFP_KERNEL);
3337 	if (!rdrv)
3338 		return -ENOMEM;
3339 
3340 	rdrv->start	= __cdns3_gadget_init;
3341 	rdrv->stop	= cdns3_gadget_exit;
3342 	rdrv->suspend	= cdns3_gadget_suspend;
3343 	rdrv->resume	= cdns3_gadget_resume;
3344 	rdrv->state	= CDNS3_ROLE_STATE_INACTIVE;
3345 	rdrv->name	= "gadget";
3346 	cdns->roles[USB_ROLE_DEVICE] = rdrv;
3347 
3348 	return 0;
3349 }
3350