1 // SPDX-License-Identifier: GPL-2.0+
3 * Xilinx USB peripheral controller driver
5 * Copyright (C) 2004 by Thomas Rathbone
6 * Copyright (C) 2005 by HP Labs
7 * Copyright (C) 2005 by David Brownell
8 * Copyright (C) 2010 - 2014 Xilinx, Inc.
10 * Some parts of this driver code is based on the driver for at91-series
11 * USB peripheral controller (at91_udc.c).
14 #include <linux/clk.h>
15 #include <linux/delay.h>
16 #include <linux/device.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/interrupt.h>
20 #include <linux/module.h>
21 #include <linux/of_address.h>
22 #include <linux/of_device.h>
23 #include <linux/of_platform.h>
24 #include <linux/of_irq.h>
25 #include <linux/prefetch.h>
26 #include <linux/usb/ch9.h>
27 #include <linux/usb/gadget.h>
29 /* Register offsets for the USB device.*/
30 #define XUSB_EP0_CONFIG_OFFSET 0x0000 /* EP0 Config Reg Offset */
31 #define XUSB_SETUP_PKT_ADDR_OFFSET 0x0080 /* Setup Packet Address */
32 #define XUSB_ADDRESS_OFFSET 0x0100 /* Address Register */
33 #define XUSB_CONTROL_OFFSET 0x0104 /* Control Register */
34 #define XUSB_STATUS_OFFSET 0x0108 /* Status Register */
35 #define XUSB_FRAMENUM_OFFSET 0x010C /* Frame Number Register */
36 #define XUSB_IER_OFFSET 0x0110 /* Interrupt Enable Register */
37 #define XUSB_BUFFREADY_OFFSET 0x0114 /* Buffer Ready Register */
38 #define XUSB_TESTMODE_OFFSET 0x0118 /* Test Mode Register */
39 #define XUSB_DMA_RESET_OFFSET 0x0200 /* DMA Soft Reset Register */
40 #define XUSB_DMA_CONTROL_OFFSET 0x0204 /* DMA Control Register */
41 #define XUSB_DMA_DSAR_ADDR_OFFSET 0x0208 /* DMA source Address Reg */
42 #define XUSB_DMA_DDAR_ADDR_OFFSET 0x020C /* DMA destination Addr Reg */
43 #define XUSB_DMA_LENGTH_OFFSET 0x0210 /* DMA Length Register */
44 #define XUSB_DMA_STATUS_OFFSET 0x0214 /* DMA Status Register */
46 /* Endpoint Configuration Space offsets */
47 #define XUSB_EP_CFGSTATUS_OFFSET 0x00 /* Endpoint Config Status */
48 #define XUSB_EP_BUF0COUNT_OFFSET 0x08 /* Buffer 0 Count */
49 #define XUSB_EP_BUF1COUNT_OFFSET 0x0C /* Buffer 1 Count */
51 #define XUSB_CONTROL_USB_READY_MASK 0x80000000 /* USB ready Mask */
52 #define XUSB_CONTROL_USB_RMTWAKE_MASK 0x40000000 /* Remote wake up mask */
54 /* Interrupt register related masks.*/
55 #define XUSB_STATUS_GLOBAL_INTR_MASK 0x80000000 /* Global Intr Enable */
56 #define XUSB_STATUS_DMADONE_MASK 0x04000000 /* DMA done Mask */
57 #define XUSB_STATUS_DMAERR_MASK 0x02000000 /* DMA Error Mask */
58 #define XUSB_STATUS_DMABUSY_MASK 0x80000000 /* DMA Error Mask */
59 #define XUSB_STATUS_RESUME_MASK 0x01000000 /* USB Resume Mask */
60 #define XUSB_STATUS_RESET_MASK 0x00800000 /* USB Reset Mask */
61 #define XUSB_STATUS_SUSPEND_MASK 0x00400000 /* USB Suspend Mask */
62 #define XUSB_STATUS_DISCONNECT_MASK 0x00200000 /* USB Disconnect Mask */
63 #define XUSB_STATUS_FIFO_BUFF_RDY_MASK 0x00100000 /* FIFO Buff Ready Mask */
64 #define XUSB_STATUS_FIFO_BUFF_FREE_MASK 0x00080000 /* FIFO Buff Free Mask */
65 #define XUSB_STATUS_SETUP_PACKET_MASK 0x00040000 /* Setup packet received */
66 #define XUSB_STATUS_EP1_BUFF2_COMP_MASK 0x00000200 /* EP 1 Buff 2 Processed */
67 #define XUSB_STATUS_EP1_BUFF1_COMP_MASK 0x00000002 /* EP 1 Buff 1 Processed */
68 #define XUSB_STATUS_EP0_BUFF2_COMP_MASK 0x00000100 /* EP 0 Buff 2 Processed */
69 #define XUSB_STATUS_EP0_BUFF1_COMP_MASK 0x00000001 /* EP 0 Buff 1 Processed */
70 #define XUSB_STATUS_HIGH_SPEED_MASK 0x00010000 /* USB Speed Mask */
71 /* Suspend,Reset,Suspend and Disconnect Mask */
72 #define XUSB_STATUS_INTR_EVENT_MASK 0x01E00000
73 /* Buffers completion Mask */
74 #define XUSB_STATUS_INTR_BUFF_COMP_ALL_MASK 0x0000FEFF
75 /* Mask for buffer 0 and buffer 1 completion for all Endpoints */
76 #define XUSB_STATUS_INTR_BUFF_COMP_SHIFT_MASK 0x00000101
77 #define XUSB_STATUS_EP_BUFF2_SHIFT 8 /* EP buffer offset */
79 /* Endpoint Configuration Status Register */
80 #define XUSB_EP_CFG_VALID_MASK 0x80000000 /* Endpoint Valid bit */
81 #define XUSB_EP_CFG_STALL_MASK 0x40000000 /* Endpoint Stall bit */
82 #define XUSB_EP_CFG_DATA_TOGGLE_MASK 0x08000000 /* Endpoint Data toggle */
84 /* USB device specific global configuration constants.*/
85 #define XUSB_MAX_ENDPOINTS 8 /* Maximum End Points */
86 #define XUSB_EP_NUMBER_ZERO 0 /* End point Zero */
87 /* DPRAM is the source address for DMA transfer */
88 #define XUSB_DMA_READ_FROM_DPRAM 0x80000000
89 #define XUSB_DMA_DMASR_BUSY 0x80000000 /* DMA busy */
90 #define XUSB_DMA_DMASR_ERROR 0x40000000 /* DMA Error */
92 * When this bit is set, the DMA buffer ready bit is set by hardware upon
93 * DMA transfer completion.
95 #define XUSB_DMA_BRR_CTRL 0x40000000 /* DMA bufready ctrl bit */
97 #define SETUP_PHASE 0x0000 /* Setup Phase */
98 #define DATA_PHASE 0x0001 /* Data Phase */
99 #define STATUS_PHASE 0x0002 /* Status Phase */
101 #define EP0_MAX_PACKET 64 /* Endpoint 0 maximum packet length */
102 #define STATUSBUFF_SIZE 2 /* Buffer size for GET_STATUS command */
103 #define EPNAME_SIZE 4 /* Buffer size for endpoint name */
105 /* container_of helper macros */
106 #define to_udc(g) container_of((g), struct xusb_udc, gadget)
107 #define to_xusb_ep(ep) container_of((ep), struct xusb_ep, ep_usb)
108 #define to_xusb_req(req) container_of((req), struct xusb_req, usb_req)
111 * struct xusb_req - Xilinx USB device request structure
112 * @usb_req: Linux usb request structure
113 * @queue: usb device request queue
114 * @ep: pointer to xusb_endpoint structure
117 struct usb_request usb_req;
118 struct list_head queue;
123 * struct xusb_ep - USB end point structure.
124 * @ep_usb: usb endpoint instance
125 * @queue: endpoint message queue
126 * @udc: xilinx usb peripheral driver instance pointer
127 * @desc: pointer to the usb endpoint descriptor
128 * @rambase: the endpoint buffer address
129 * @offset: the endpoint register offset value
130 * @name: name of the endpoint
131 * @epnumber: endpoint number
132 * @maxpacket: maximum packet size the endpoint can store
133 * @buffer0count: the size of the packet recieved in the first buffer
134 * @buffer1count: the size of the packet received in the second buffer
135 * @curbufnum: current buffer of endpoint that will be processed next
136 * @buffer0ready: the busy state of first buffer
137 * @buffer1ready: the busy state of second buffer
138 * @is_in: endpoint direction (IN or OUT)
139 * @is_iso: endpoint type(isochronous or non isochronous)
142 struct usb_ep ep_usb;
143 struct list_head queue;
144 struct xusb_udc *udc;
145 const struct usb_endpoint_descriptor *desc;
161 * struct xusb_udc - USB peripheral driver structure
162 * @gadget: USB gadget driver instance
163 * @ep: an array of endpoint structures
164 * @driver: pointer to the usb gadget driver instance
165 * @setup: usb_ctrlrequest structure for control requests
166 * @req: pointer to dummy request for get status command
167 * @dev: pointer to device structure in gadget
168 * @usb_state: device in suspended state or not
169 * @remote_wkp: remote wakeup enabled by host
170 * @setupseqtx: tx status
171 * @setupseqrx: rx status
172 * @addr: the usb device base address
173 * @lock: instance of spinlock
174 * @dma_enabled: flag indicating whether the dma is included in the system
175 * @clk: pointer to struct clk
176 * @read_fn: function pointer to read device registers
177 * @write_fn: function pointer to write to device registers
180 struct usb_gadget gadget;
181 struct xusb_ep ep[8];
182 struct usb_gadget_driver *driver;
183 struct usb_ctrlrequest setup;
184 struct xusb_req *req;
195 unsigned int (*read_fn)(void __iomem *);
196 void (*write_fn)(void __iomem *, u32, u32);
199 /* Endpoint buffer start addresses in the core */
200 static u32 rambase[8] = { 0x22, 0x1000, 0x1100, 0x1200, 0x1300, 0x1400, 0x1500,
203 static const char driver_name[] = "xilinx-udc";
204 static const char ep0name[] = "ep0";
206 /* Control endpoint configuration.*/
207 static const struct usb_endpoint_descriptor config_bulk_out_desc = {
208 .bLength = USB_DT_ENDPOINT_SIZE,
209 .bDescriptorType = USB_DT_ENDPOINT,
210 .bEndpointAddress = USB_DIR_OUT,
211 .bmAttributes = USB_ENDPOINT_XFER_BULK,
212 .wMaxPacketSize = cpu_to_le16(EP0_MAX_PACKET),
216 * xudc_write32 - little endian write to device registers
217 * @addr: base addr of device registers
218 * @offset: register offset
219 * @val: data to be written
221 static void xudc_write32(void __iomem *addr, u32 offset, u32 val)
223 iowrite32(val, addr + offset);
227 * xudc_read32 - little endian read from device registers
228 * @addr: addr of device register
229 * Return: value at addr
231 static unsigned int xudc_read32(void __iomem *addr)
233 return ioread32(addr);
237 * xudc_write32_be - big endian write to device registers
238 * @addr: base addr of device registers
239 * @offset: register offset
240 * @val: data to be written
242 static void xudc_write32_be(void __iomem *addr, u32 offset, u32 val)
244 iowrite32be(val, addr + offset);
248 * xudc_read32_be - big endian read from device registers
249 * @addr: addr of device register
250 * Return: value at addr
252 static unsigned int xudc_read32_be(void __iomem *addr)
254 return ioread32be(addr);
258 * xudc_wrstatus - Sets up the usb device status stages.
259 * @udc: pointer to the usb device controller structure.
261 static void xudc_wrstatus(struct xusb_udc *udc)
263 struct xusb_ep *ep0 = &udc->ep[XUSB_EP_NUMBER_ZERO];
266 epcfgreg = udc->read_fn(udc->addr + ep0->offset)|
267 XUSB_EP_CFG_DATA_TOGGLE_MASK;
268 udc->write_fn(udc->addr, ep0->offset, epcfgreg);
269 udc->write_fn(udc->addr, ep0->offset + XUSB_EP_BUF0COUNT_OFFSET, 0);
270 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET, 1);
274 * xudc_epconfig - Configures the given endpoint.
275 * @ep: pointer to the usb device endpoint structure.
276 * @udc: pointer to the usb peripheral controller structure.
278 * This function configures a specific endpoint with the given configuration
281 static void xudc_epconfig(struct xusb_ep *ep, struct xusb_udc *udc)
286 * Configure the end point direction, type, Max Packet Size and the
287 * EP buffer location.
289 epcfgreg = ((ep->is_in << 29) | (ep->is_iso << 28) |
290 (ep->ep_usb.maxpacket << 15) | (ep->rambase));
291 udc->write_fn(udc->addr, ep->offset, epcfgreg);
293 /* Set the Buffer count and the Buffer ready bits.*/
294 udc->write_fn(udc->addr, ep->offset + XUSB_EP_BUF0COUNT_OFFSET,
296 udc->write_fn(udc->addr, ep->offset + XUSB_EP_BUF1COUNT_OFFSET,
298 if (ep->buffer0ready)
299 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET,
301 if (ep->buffer1ready)
302 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET,
303 1 << (ep->epnumber + XUSB_STATUS_EP_BUFF2_SHIFT));
307 * xudc_start_dma - Starts DMA transfer.
308 * @ep: pointer to the usb device endpoint structure.
309 * @src: DMA source address.
310 * @dst: DMA destination address.
311 * @length: number of bytes to transfer.
313 * Return: 0 on success, error code on failure
315 * This function starts DMA transfer by writing to DMA source,
316 * destination and lenth registers.
318 static int xudc_start_dma(struct xusb_ep *ep, dma_addr_t src,
319 dma_addr_t dst, u32 length)
321 struct xusb_udc *udc = ep->udc;
327 * Set the addresses in the DMA source and
328 * destination registers and then set the length
329 * into the DMA length register.
331 udc->write_fn(udc->addr, XUSB_DMA_DSAR_ADDR_OFFSET, src);
332 udc->write_fn(udc->addr, XUSB_DMA_DDAR_ADDR_OFFSET, dst);
333 udc->write_fn(udc->addr, XUSB_DMA_LENGTH_OFFSET, length);
336 * Wait till DMA transaction is complete and
337 * check whether the DMA transaction was
341 reg = udc->read_fn(udc->addr + XUSB_DMA_STATUS_OFFSET);
342 if (!(reg & XUSB_DMA_DMASR_BUSY))
346 * We can't sleep here, because it's also called from
351 dev_err(udc->dev, "DMA timeout\n");
357 if ((udc->read_fn(udc->addr + XUSB_DMA_STATUS_OFFSET) &
358 XUSB_DMA_DMASR_ERROR) == XUSB_DMA_DMASR_ERROR){
359 dev_err(udc->dev, "DMA Error\n");
367 * xudc_dma_send - Sends IN data using DMA.
368 * @ep: pointer to the usb device endpoint structure.
369 * @req: pointer to the usb request structure.
370 * @buffer: pointer to data to be sent.
371 * @length: number of bytes to send.
373 * Return: 0 on success, -EAGAIN if no buffer is free and error
376 * This function sends data using DMA.
378 static int xudc_dma_send(struct xusb_ep *ep, struct xusb_req *req,
379 u8 *buffer, u32 length)
384 struct xusb_udc *udc = ep->udc;
386 src = req->usb_req.dma + req->usb_req.actual;
387 if (req->usb_req.length)
388 dma_sync_single_for_device(udc->dev, src,
389 length, DMA_TO_DEVICE);
390 if (!ep->curbufnum && !ep->buffer0ready) {
391 /* Get the Buffer address and copy the transmit data.*/
392 eprambase = (u32 __force *)(udc->addr + ep->rambase);
393 dst = virt_to_phys(eprambase);
394 udc->write_fn(udc->addr, ep->offset +
395 XUSB_EP_BUF0COUNT_OFFSET, length);
396 udc->write_fn(udc->addr, XUSB_DMA_CONTROL_OFFSET,
397 XUSB_DMA_BRR_CTRL | (1 << ep->epnumber));
398 ep->buffer0ready = 1;
400 } else if (ep->curbufnum && !ep->buffer1ready) {
401 /* Get the Buffer address and copy the transmit data.*/
402 eprambase = (u32 __force *)(udc->addr + ep->rambase +
403 ep->ep_usb.maxpacket);
404 dst = virt_to_phys(eprambase);
405 udc->write_fn(udc->addr, ep->offset +
406 XUSB_EP_BUF1COUNT_OFFSET, length);
407 udc->write_fn(udc->addr, XUSB_DMA_CONTROL_OFFSET,
408 XUSB_DMA_BRR_CTRL | (1 << (ep->epnumber +
409 XUSB_STATUS_EP_BUFF2_SHIFT)));
410 ep->buffer1ready = 1;
413 /* None of ping pong buffers are ready currently .*/
417 return xudc_start_dma(ep, src, dst, length);
421 * xudc_dma_receive - Receives OUT data using DMA.
422 * @ep: pointer to the usb device endpoint structure.
423 * @req: pointer to the usb request structure.
424 * @buffer: pointer to storage buffer of received data.
425 * @length: number of bytes to receive.
427 * Return: 0 on success, -EAGAIN if no buffer is free and error
430 * This function receives data using DMA.
432 static int xudc_dma_receive(struct xusb_ep *ep, struct xusb_req *req,
433 u8 *buffer, u32 length)
438 struct xusb_udc *udc = ep->udc;
440 dst = req->usb_req.dma + req->usb_req.actual;
441 if (!ep->curbufnum && !ep->buffer0ready) {
442 /* Get the Buffer address and copy the transmit data */
443 eprambase = (u32 __force *)(udc->addr + ep->rambase);
444 src = virt_to_phys(eprambase);
445 udc->write_fn(udc->addr, XUSB_DMA_CONTROL_OFFSET,
446 XUSB_DMA_BRR_CTRL | XUSB_DMA_READ_FROM_DPRAM |
447 (1 << ep->epnumber));
448 ep->buffer0ready = 1;
450 } else if (ep->curbufnum && !ep->buffer1ready) {
451 /* Get the Buffer address and copy the transmit data */
452 eprambase = (u32 __force *)(udc->addr +
453 ep->rambase + ep->ep_usb.maxpacket);
454 src = virt_to_phys(eprambase);
455 udc->write_fn(udc->addr, XUSB_DMA_CONTROL_OFFSET,
456 XUSB_DMA_BRR_CTRL | XUSB_DMA_READ_FROM_DPRAM |
457 (1 << (ep->epnumber +
458 XUSB_STATUS_EP_BUFF2_SHIFT)));
459 ep->buffer1ready = 1;
462 /* None of the ping-pong buffers are ready currently */
466 return xudc_start_dma(ep, src, dst, length);
470 * xudc_eptxrx - Transmits or receives data to or from an endpoint.
471 * @ep: pointer to the usb endpoint configuration structure.
472 * @req: pointer to the usb request structure.
473 * @bufferptr: pointer to buffer containing the data to be sent.
474 * @bufferlen: The number of data bytes to be sent.
476 * Return: 0 on success, -EAGAIN if no buffer is free.
478 * This function copies the transmit/receive data to/from the end point buffer
479 * and enables the buffer for transmission/reception.
481 static int xudc_eptxrx(struct xusb_ep *ep, struct xusb_req *req,
482 u8 *bufferptr, u32 bufferlen)
487 struct xusb_udc *udc = ep->udc;
489 bytestosend = bufferlen;
490 if (udc->dma_enabled) {
492 rc = xudc_dma_send(ep, req, bufferptr, bufferlen);
494 rc = xudc_dma_receive(ep, req, bufferptr, bufferlen);
497 /* Put the transmit buffer into the correct ping-pong buffer.*/
498 if (!ep->curbufnum && !ep->buffer0ready) {
499 /* Get the Buffer address and copy the transmit data.*/
500 eprambase = (u32 __force *)(udc->addr + ep->rambase);
502 memcpy(eprambase, bufferptr, bytestosend);
503 udc->write_fn(udc->addr, ep->offset +
504 XUSB_EP_BUF0COUNT_OFFSET, bufferlen);
506 memcpy(bufferptr, eprambase, bytestosend);
509 * Enable the buffer for transmission.
511 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET,
513 ep->buffer0ready = 1;
515 } else if (ep->curbufnum && !ep->buffer1ready) {
516 /* Get the Buffer address and copy the transmit data.*/
517 eprambase = (u32 __force *)(udc->addr + ep->rambase +
518 ep->ep_usb.maxpacket);
520 memcpy(eprambase, bufferptr, bytestosend);
521 udc->write_fn(udc->addr, ep->offset +
522 XUSB_EP_BUF1COUNT_OFFSET, bufferlen);
524 memcpy(bufferptr, eprambase, bytestosend);
527 * Enable the buffer for transmission.
529 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET,
530 1 << (ep->epnumber + XUSB_STATUS_EP_BUFF2_SHIFT));
531 ep->buffer1ready = 1;
534 /* None of the ping-pong buffers are ready currently */
541 * xudc_done - Exeutes the endpoint data transfer completion tasks.
542 * @ep: pointer to the usb device endpoint structure.
543 * @req: pointer to the usb request structure.
544 * @status: Status of the data transfer.
546 * Deletes the message from the queue and updates data transfer completion
549 static void xudc_done(struct xusb_ep *ep, struct xusb_req *req, int status)
551 struct xusb_udc *udc = ep->udc;
553 list_del_init(&req->queue);
555 if (req->usb_req.status == -EINPROGRESS)
556 req->usb_req.status = status;
558 status = req->usb_req.status;
560 if (status && status != -ESHUTDOWN)
561 dev_dbg(udc->dev, "%s done %p, status %d\n",
562 ep->ep_usb.name, req, status);
563 /* unmap request if DMA is present*/
564 if (udc->dma_enabled && ep->epnumber && req->usb_req.length)
565 usb_gadget_unmap_request(&udc->gadget, &req->usb_req,
568 if (req->usb_req.complete) {
569 spin_unlock(&udc->lock);
570 req->usb_req.complete(&ep->ep_usb, &req->usb_req);
571 spin_lock(&udc->lock);
576 * xudc_read_fifo - Reads the data from the given endpoint buffer.
577 * @ep: pointer to the usb device endpoint structure.
578 * @req: pointer to the usb request structure.
580 * Return: 0 if request is completed and -EAGAIN if not completed.
582 * Pulls OUT packet data from the endpoint buffer.
584 static int xudc_read_fifo(struct xusb_ep *ep, struct xusb_req *req)
587 u32 is_short, count, bufferspace;
591 int retval = -EAGAIN;
592 struct xusb_udc *udc = ep->udc;
594 if (ep->buffer0ready && ep->buffer1ready) {
595 dev_dbg(udc->dev, "Packet NOT ready!\n");
600 bufoffset = XUSB_EP_BUF1COUNT_OFFSET;
602 bufoffset = XUSB_EP_BUF0COUNT_OFFSET;
604 count = udc->read_fn(udc->addr + ep->offset + bufoffset);
606 if (!ep->buffer0ready && !ep->buffer1ready)
609 buf = req->usb_req.buf + req->usb_req.actual;
611 bufferspace = req->usb_req.length - req->usb_req.actual;
612 is_short = count < ep->ep_usb.maxpacket;
614 if (unlikely(!bufferspace)) {
616 * This happens when the driver's buffer
617 * is smaller than what the host sent.
618 * discard the extra data.
620 if (req->usb_req.status != -EOVERFLOW)
621 dev_dbg(udc->dev, "%s overflow %d\n",
622 ep->ep_usb.name, count);
623 req->usb_req.status = -EOVERFLOW;
624 xudc_done(ep, req, -EOVERFLOW);
628 ret = xudc_eptxrx(ep, req, buf, count);
631 req->usb_req.actual += min(count, bufferspace);
632 dev_dbg(udc->dev, "read %s, %d bytes%s req %p %d/%d\n",
633 ep->ep_usb.name, count, is_short ? "/S" : "", req,
634 req->usb_req.actual, req->usb_req.length);
635 bufferspace -= count;
637 if ((req->usb_req.actual == req->usb_req.length) || is_short) {
638 if (udc->dma_enabled && req->usb_req.length)
639 dma_sync_single_for_cpu(udc->dev,
643 xudc_done(ep, req, 0);
652 dev_dbg(udc->dev, "receive busy\n");
656 /* DMA error, dequeue the request */
657 xudc_done(ep, req, -ECONNRESET);
666 * xudc_write_fifo - Writes data into the given endpoint buffer.
667 * @ep: pointer to the usb device endpoint structure.
668 * @req: pointer to the usb request structure.
670 * Return: 0 if request is completed and -EAGAIN if not completed.
672 * Loads endpoint buffer for an IN packet.
674 static int xudc_write_fifo(struct xusb_ep *ep, struct xusb_req *req)
679 int retval = -EAGAIN;
680 struct xusb_udc *udc = ep->udc;
681 int is_last, is_short = 0;
684 max = le16_to_cpu(ep->desc->wMaxPacketSize);
685 buf = req->usb_req.buf + req->usb_req.actual;
687 length = req->usb_req.length - req->usb_req.actual;
688 length = min(length, max);
690 ret = xudc_eptxrx(ep, req, buf, length);
693 req->usb_req.actual += length;
694 if (unlikely(length != max)) {
695 is_last = is_short = 1;
697 if (likely(req->usb_req.length !=
698 req->usb_req.actual) || req->usb_req.zero)
703 dev_dbg(udc->dev, "%s: wrote %s %d bytes%s%s %d left %p\n",
704 __func__, ep->ep_usb.name, length, is_last ? "/L" : "",
705 is_short ? "/S" : "",
706 req->usb_req.length - req->usb_req.actual, req);
709 xudc_done(ep, req, 0);
714 dev_dbg(udc->dev, "Send busy\n");
718 /* DMA error, dequeue the request */
719 xudc_done(ep, req, -ECONNRESET);
728 * xudc_nuke - Cleans up the data transfer message list.
729 * @ep: pointer to the usb device endpoint structure.
730 * @status: Status of the data transfer.
732 static void xudc_nuke(struct xusb_ep *ep, int status)
734 struct xusb_req *req;
736 while (!list_empty(&ep->queue)) {
737 req = list_first_entry(&ep->queue, struct xusb_req, queue);
738 xudc_done(ep, req, status);
743 * xudc_ep_set_halt - Stalls/unstalls the given endpoint.
744 * @_ep: pointer to the usb device endpoint structure.
745 * @value: value to indicate stall/unstall.
747 * Return: 0 for success and error value on failure
749 static int xudc_ep_set_halt(struct usb_ep *_ep, int value)
751 struct xusb_ep *ep = to_xusb_ep(_ep);
752 struct xusb_udc *udc;
756 if (!_ep || (!ep->desc && ep->epnumber)) {
757 pr_debug("%s: bad ep or descriptor\n", __func__);
762 if (ep->is_in && (!list_empty(&ep->queue)) && value) {
763 dev_dbg(udc->dev, "requests pending can't halt\n");
767 if (ep->buffer0ready || ep->buffer1ready) {
768 dev_dbg(udc->dev, "HW buffers busy can't halt\n");
772 spin_lock_irqsave(&udc->lock, flags);
775 /* Stall the device.*/
776 epcfgreg = udc->read_fn(udc->addr + ep->offset);
777 epcfgreg |= XUSB_EP_CFG_STALL_MASK;
778 udc->write_fn(udc->addr, ep->offset, epcfgreg);
780 /* Unstall the device.*/
781 epcfgreg = udc->read_fn(udc->addr + ep->offset);
782 epcfgreg &= ~XUSB_EP_CFG_STALL_MASK;
783 udc->write_fn(udc->addr, ep->offset, epcfgreg);
785 /* Reset the toggle bit.*/
786 epcfgreg = udc->read_fn(ep->udc->addr + ep->offset);
787 epcfgreg &= ~XUSB_EP_CFG_DATA_TOGGLE_MASK;
788 udc->write_fn(udc->addr, ep->offset, epcfgreg);
792 spin_unlock_irqrestore(&udc->lock, flags);
797 * __xudc_ep_enable - Enables the given endpoint.
798 * @ep: pointer to the xusb endpoint structure.
799 * @desc: pointer to usb endpoint descriptor.
801 * Return: 0 for success and error value on failure
803 static int __xudc_ep_enable(struct xusb_ep *ep,
804 const struct usb_endpoint_descriptor *desc)
806 struct xusb_udc *udc = ep->udc;
812 ep->is_in = ((desc->bEndpointAddress & USB_DIR_IN) != 0);
813 /* Bit 3...0:endpoint number */
814 ep->epnumber = (desc->bEndpointAddress & 0x0f);
816 ep->ep_usb.desc = desc;
817 tmp = desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
818 ep->ep_usb.maxpacket = maxpacket = le16_to_cpu(desc->wMaxPacketSize);
821 case USB_ENDPOINT_XFER_CONTROL:
822 dev_dbg(udc->dev, "only one control endpoint\n");
826 case USB_ENDPOINT_XFER_INT:
829 if (maxpacket > 64) {
830 dev_dbg(udc->dev, "bogus maxpacket %d\n", maxpacket);
834 case USB_ENDPOINT_XFER_BULK:
837 if (!(is_power_of_2(maxpacket) && maxpacket >= 8 &&
839 dev_dbg(udc->dev, "bogus maxpacket %d\n", maxpacket);
843 case USB_ENDPOINT_XFER_ISOC:
849 ep->buffer0ready = false;
850 ep->buffer1ready = false;
852 ep->rambase = rambase[ep->epnumber];
853 xudc_epconfig(ep, udc);
855 dev_dbg(udc->dev, "Enable Endpoint %d max pkt is %d\n",
856 ep->epnumber, maxpacket);
858 /* Enable the End point.*/
859 epcfg = udc->read_fn(udc->addr + ep->offset);
860 epcfg |= XUSB_EP_CFG_VALID_MASK;
861 udc->write_fn(udc->addr, ep->offset, epcfg);
865 /* Enable buffer completion interrupts for endpoint */
866 ier = udc->read_fn(udc->addr + XUSB_IER_OFFSET);
867 ier |= (XUSB_STATUS_INTR_BUFF_COMP_SHIFT_MASK << ep->epnumber);
868 udc->write_fn(udc->addr, XUSB_IER_OFFSET, ier);
870 /* for OUT endpoint set buffers ready to receive */
871 if (ep->epnumber && !ep->is_in) {
872 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET,
874 ep->buffer0ready = true;
875 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET,
876 (1 << (ep->epnumber +
877 XUSB_STATUS_EP_BUFF2_SHIFT)));
878 ep->buffer1ready = true;
885 * xudc_ep_enable - Enables the given endpoint.
886 * @_ep: pointer to the usb endpoint structure.
887 * @desc: pointer to usb endpoint descriptor.
889 * Return: 0 for success and error value on failure
891 static int xudc_ep_enable(struct usb_ep *_ep,
892 const struct usb_endpoint_descriptor *desc)
895 struct xusb_udc *udc;
899 if (!_ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
900 pr_debug("%s: bad ep or descriptor\n", __func__);
904 ep = to_xusb_ep(_ep);
907 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
908 dev_dbg(udc->dev, "bogus device state\n");
912 spin_lock_irqsave(&udc->lock, flags);
913 ret = __xudc_ep_enable(ep, desc);
914 spin_unlock_irqrestore(&udc->lock, flags);
920 * xudc_ep_disable - Disables the given endpoint.
921 * @_ep: pointer to the usb endpoint structure.
923 * Return: 0 for success and error value on failure
925 static int xudc_ep_disable(struct usb_ep *_ep)
930 struct xusb_udc *udc;
933 pr_debug("%s: invalid ep\n", __func__);
937 ep = to_xusb_ep(_ep);
940 spin_lock_irqsave(&udc->lock, flags);
942 xudc_nuke(ep, -ESHUTDOWN);
944 /* Restore the endpoint's pristine config */
946 ep->ep_usb.desc = NULL;
948 dev_dbg(udc->dev, "USB Ep %d disable\n ", ep->epnumber);
949 /* Disable the endpoint.*/
950 epcfg = udc->read_fn(udc->addr + ep->offset);
951 epcfg &= ~XUSB_EP_CFG_VALID_MASK;
952 udc->write_fn(udc->addr, ep->offset, epcfg);
954 spin_unlock_irqrestore(&udc->lock, flags);
959 * xudc_ep_alloc_request - Initializes the request queue.
960 * @_ep: pointer to the usb endpoint structure.
961 * @gfp_flags: Flags related to the request call.
963 * Return: pointer to request structure on success and a NULL on failure.
965 static struct usb_request *xudc_ep_alloc_request(struct usb_ep *_ep,
968 struct xusb_ep *ep = to_xusb_ep(_ep);
969 struct xusb_req *req;
971 req = kzalloc(sizeof(*req), gfp_flags);
976 INIT_LIST_HEAD(&req->queue);
977 return &req->usb_req;
981 * xudc_free_request - Releases the request from queue.
982 * @_ep: pointer to the usb device endpoint structure.
983 * @_req: pointer to the usb request structure.
985 static void xudc_free_request(struct usb_ep *_ep, struct usb_request *_req)
987 struct xusb_req *req = to_xusb_req(_req);
993 * __xudc_ep0_queue - Adds the request to endpoint 0 queue.
994 * @ep0: pointer to the xusb endpoint 0 structure.
995 * @req: pointer to the xusb request structure.
997 * Return: 0 for success and error value on failure
999 static int __xudc_ep0_queue(struct xusb_ep *ep0, struct xusb_req *req)
1001 struct xusb_udc *udc = ep0->udc;
1005 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
1006 dev_dbg(udc->dev, "%s, bogus device state\n", __func__);
1009 if (!list_empty(&ep0->queue)) {
1010 dev_dbg(udc->dev, "%s:ep0 busy\n", __func__);
1014 req->usb_req.status = -EINPROGRESS;
1015 req->usb_req.actual = 0;
1017 list_add_tail(&req->queue, &ep0->queue);
1019 if (udc->setup.bRequestType & USB_DIR_IN) {
1020 prefetch(req->usb_req.buf);
1021 length = req->usb_req.length;
1022 corebuf = (void __force *) ((ep0->rambase << 2) +
1024 length = req->usb_req.actual = min_t(u32, length,
1026 memcpy(corebuf, req->usb_req.buf, length);
1027 udc->write_fn(udc->addr, XUSB_EP_BUF0COUNT_OFFSET, length);
1028 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET, 1);
1030 if (udc->setup.wLength) {
1031 /* Enable EP0 buffer to receive data */
1032 udc->write_fn(udc->addr, XUSB_EP_BUF0COUNT_OFFSET, 0);
1033 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET, 1);
1043 * xudc_ep0_queue - Adds the request to endpoint 0 queue.
1044 * @_ep: pointer to the usb endpoint 0 structure.
1045 * @_req: pointer to the usb request structure.
1046 * @gfp_flags: Flags related to the request call.
1048 * Return: 0 for success and error value on failure
1050 static int xudc_ep0_queue(struct usb_ep *_ep, struct usb_request *_req,
1053 struct xusb_req *req = to_xusb_req(_req);
1054 struct xusb_ep *ep0 = to_xusb_ep(_ep);
1055 struct xusb_udc *udc = ep0->udc;
1056 unsigned long flags;
1059 spin_lock_irqsave(&udc->lock, flags);
1060 ret = __xudc_ep0_queue(ep0, req);
1061 spin_unlock_irqrestore(&udc->lock, flags);
1067 * xudc_ep_queue - Adds the request to endpoint queue.
1068 * @_ep: pointer to the usb endpoint structure.
1069 * @_req: pointer to the usb request structure.
1070 * @gfp_flags: Flags related to the request call.
1072 * Return: 0 for success and error value on failure
1074 static int xudc_ep_queue(struct usb_ep *_ep, struct usb_request *_req,
1077 struct xusb_req *req = to_xusb_req(_req);
1078 struct xusb_ep *ep = to_xusb_ep(_ep);
1079 struct xusb_udc *udc = ep->udc;
1081 unsigned long flags;
1084 dev_dbg(udc->dev, "%s: queuing request to disabled %s\n",
1085 __func__, ep->name);
1089 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
1090 dev_dbg(udc->dev, "%s, bogus device state\n", __func__);
1094 spin_lock_irqsave(&udc->lock, flags);
1096 _req->status = -EINPROGRESS;
1099 if (udc->dma_enabled) {
1100 ret = usb_gadget_map_request(&udc->gadget, &req->usb_req,
1103 dev_dbg(udc->dev, "gadget_map failed ep%d\n",
1105 spin_unlock_irqrestore(&udc->lock, flags);
1110 if (list_empty(&ep->queue)) {
1112 dev_dbg(udc->dev, "xudc_write_fifo from ep_queue\n");
1113 if (!xudc_write_fifo(ep, req))
1116 dev_dbg(udc->dev, "xudc_read_fifo from ep_queue\n");
1117 if (!xudc_read_fifo(ep, req))
1123 list_add_tail(&req->queue, &ep->queue);
1125 spin_unlock_irqrestore(&udc->lock, flags);
1130 * xudc_ep_dequeue - Removes the request from the queue.
1131 * @_ep: pointer to the usb device endpoint structure.
1132 * @_req: pointer to the usb request structure.
1134 * Return: 0 for success and error value on failure
1136 static int xudc_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
1138 struct xusb_ep *ep = to_xusb_ep(_ep);
1139 struct xusb_req *req = to_xusb_req(_req);
1140 struct xusb_udc *udc = ep->udc;
1141 unsigned long flags;
1143 spin_lock_irqsave(&udc->lock, flags);
1144 /* Make sure it's actually queued on this endpoint */
1145 list_for_each_entry(req, &ep->queue, queue) {
1146 if (&req->usb_req == _req)
1149 if (&req->usb_req != _req) {
1150 spin_unlock_irqrestore(&udc->lock, flags);
1153 xudc_done(ep, req, -ECONNRESET);
1154 spin_unlock_irqrestore(&udc->lock, flags);
1160 * xudc_ep0_enable - Enables the given endpoint.
1161 * @ep: pointer to the usb endpoint structure.
1162 * @desc: pointer to usb endpoint descriptor.
1164 * Return: error always.
1166 * endpoint 0 enable should not be called by gadget layer.
1168 static int xudc_ep0_enable(struct usb_ep *ep,
1169 const struct usb_endpoint_descriptor *desc)
1175 * xudc_ep0_disable - Disables the given endpoint.
1176 * @ep: pointer to the usb endpoint structure.
1178 * Return: error always.
1180 * endpoint 0 disable should not be called by gadget layer.
1182 static int xudc_ep0_disable(struct usb_ep *ep)
1187 static const struct usb_ep_ops xusb_ep0_ops = {
1188 .enable = xudc_ep0_enable,
1189 .disable = xudc_ep0_disable,
1190 .alloc_request = xudc_ep_alloc_request,
1191 .free_request = xudc_free_request,
1192 .queue = xudc_ep0_queue,
1193 .dequeue = xudc_ep_dequeue,
1194 .set_halt = xudc_ep_set_halt,
1197 static const struct usb_ep_ops xusb_ep_ops = {
1198 .enable = xudc_ep_enable,
1199 .disable = xudc_ep_disable,
1200 .alloc_request = xudc_ep_alloc_request,
1201 .free_request = xudc_free_request,
1202 .queue = xudc_ep_queue,
1203 .dequeue = xudc_ep_dequeue,
1204 .set_halt = xudc_ep_set_halt,
1208 * xudc_get_frame - Reads the current usb frame number.
1209 * @gadget: pointer to the usb gadget structure.
1211 * Return: current frame number for success and error value on failure.
1213 static int xudc_get_frame(struct usb_gadget *gadget)
1215 struct xusb_udc *udc;
1221 udc = to_udc(gadget);
1222 frame = udc->read_fn(udc->addr + XUSB_FRAMENUM_OFFSET);
1227 * xudc_wakeup - Send remote wakeup signal to host
1228 * @gadget: pointer to the usb gadget structure.
1230 * Return: 0 on success and error on failure
1232 static int xudc_wakeup(struct usb_gadget *gadget)
1234 struct xusb_udc *udc = to_udc(gadget);
1236 int status = -EINVAL;
1237 unsigned long flags;
1239 spin_lock_irqsave(&udc->lock, flags);
1241 /* Remote wake up not enabled by host */
1242 if (!udc->remote_wkp)
1245 crtlreg = udc->read_fn(udc->addr + XUSB_CONTROL_OFFSET);
1246 crtlreg |= XUSB_CONTROL_USB_RMTWAKE_MASK;
1247 /* set remote wake up bit */
1248 udc->write_fn(udc->addr, XUSB_CONTROL_OFFSET, crtlreg);
1250 * wait for a while and reset remote wake up bit since this bit
1251 * is not cleared by HW after sending remote wakeup to host.
1255 crtlreg &= ~XUSB_CONTROL_USB_RMTWAKE_MASK;
1256 udc->write_fn(udc->addr, XUSB_CONTROL_OFFSET, crtlreg);
1259 spin_unlock_irqrestore(&udc->lock, flags);
1264 * xudc_pullup - start/stop USB traffic
1265 * @gadget: pointer to the usb gadget structure.
1266 * @is_on: flag to start or stop
1270 * This function starts/stops SIE engine of IP based on is_on.
1272 static int xudc_pullup(struct usb_gadget *gadget, int is_on)
1274 struct xusb_udc *udc = to_udc(gadget);
1275 unsigned long flags;
1278 spin_lock_irqsave(&udc->lock, flags);
1280 crtlreg = udc->read_fn(udc->addr + XUSB_CONTROL_OFFSET);
1282 crtlreg |= XUSB_CONTROL_USB_READY_MASK;
1284 crtlreg &= ~XUSB_CONTROL_USB_READY_MASK;
1286 udc->write_fn(udc->addr, XUSB_CONTROL_OFFSET, crtlreg);
1288 spin_unlock_irqrestore(&udc->lock, flags);
1294 * xudc_eps_init - initialize endpoints.
1295 * @udc: pointer to the usb device controller structure.
1297 static void xudc_eps_init(struct xusb_udc *udc)
1301 INIT_LIST_HEAD(&udc->gadget.ep_list);
1303 for (ep_number = 0; ep_number < XUSB_MAX_ENDPOINTS; ep_number++) {
1304 struct xusb_ep *ep = &udc->ep[ep_number];
1307 list_add_tail(&ep->ep_usb.ep_list,
1308 &udc->gadget.ep_list);
1309 usb_ep_set_maxpacket_limit(&ep->ep_usb,
1310 (unsigned short) ~0);
1311 snprintf(ep->name, EPNAME_SIZE, "ep%d", ep_number);
1312 ep->ep_usb.name = ep->name;
1313 ep->ep_usb.ops = &xusb_ep_ops;
1315 ep->ep_usb.caps.type_iso = true;
1316 ep->ep_usb.caps.type_bulk = true;
1317 ep->ep_usb.caps.type_int = true;
1319 ep->ep_usb.name = ep0name;
1320 usb_ep_set_maxpacket_limit(&ep->ep_usb, EP0_MAX_PACKET);
1321 ep->ep_usb.ops = &xusb_ep0_ops;
1323 ep->ep_usb.caps.type_control = true;
1326 ep->ep_usb.caps.dir_in = true;
1327 ep->ep_usb.caps.dir_out = true;
1330 ep->epnumber = ep_number;
1333 * The configuration register address offset between
1334 * each endpoint is 0x10.
1336 ep->offset = XUSB_EP0_CONFIG_OFFSET + (ep_number * 0x10);
1340 xudc_epconfig(ep, udc);
1342 /* Initialize one queue per endpoint */
1343 INIT_LIST_HEAD(&ep->queue);
1348 * xudc_stop_activity - Stops any further activity on the device.
1349 * @udc: pointer to the usb device controller structure.
1351 static void xudc_stop_activity(struct xusb_udc *udc)
1356 for (i = 0; i < XUSB_MAX_ENDPOINTS; i++) {
1358 xudc_nuke(ep, -ESHUTDOWN);
1363 * xudc_start - Starts the device.
1364 * @gadget: pointer to the usb gadget structure
1365 * @driver: pointer to gadget driver structure
1367 * Return: zero on success and error on failure
1369 static int xudc_start(struct usb_gadget *gadget,
1370 struct usb_gadget_driver *driver)
1372 struct xusb_udc *udc = to_udc(gadget);
1373 struct xusb_ep *ep0 = &udc->ep[XUSB_EP_NUMBER_ZERO];
1374 const struct usb_endpoint_descriptor *desc = &config_bulk_out_desc;
1375 unsigned long flags;
1378 spin_lock_irqsave(&udc->lock, flags);
1381 dev_err(udc->dev, "%s is already bound to %s\n",
1382 udc->gadget.name, udc->driver->driver.name);
1387 /* hook up the driver */
1388 udc->driver = driver;
1389 udc->gadget.speed = driver->max_speed;
1391 /* Enable the control endpoint. */
1392 ret = __xudc_ep_enable(ep0, desc);
1394 /* Set device address and remote wakeup to 0 */
1395 udc->write_fn(udc->addr, XUSB_ADDRESS_OFFSET, 0);
1396 udc->remote_wkp = 0;
1398 spin_unlock_irqrestore(&udc->lock, flags);
1403 * xudc_stop - stops the device.
1404 * @gadget: pointer to the usb gadget structure
1406 * Return: zero always
1408 static int xudc_stop(struct usb_gadget *gadget)
1410 struct xusb_udc *udc = to_udc(gadget);
1411 unsigned long flags;
1413 spin_lock_irqsave(&udc->lock, flags);
1415 udc->gadget.speed = USB_SPEED_UNKNOWN;
1418 /* Set device address and remote wakeup to 0 */
1419 udc->write_fn(udc->addr, XUSB_ADDRESS_OFFSET, 0);
1420 udc->remote_wkp = 0;
1422 xudc_stop_activity(udc);
1424 spin_unlock_irqrestore(&udc->lock, flags);
1429 static const struct usb_gadget_ops xusb_udc_ops = {
1430 .get_frame = xudc_get_frame,
1431 .wakeup = xudc_wakeup,
1432 .pullup = xudc_pullup,
1433 .udc_start = xudc_start,
1434 .udc_stop = xudc_stop,
1438 * xudc_clear_stall_all_ep - clears stall of every endpoint.
1439 * @udc: pointer to the udc structure.
1441 static void xudc_clear_stall_all_ep(struct xusb_udc *udc)
1447 for (i = 0; i < XUSB_MAX_ENDPOINTS; i++) {
1449 epcfgreg = udc->read_fn(udc->addr + ep->offset);
1450 epcfgreg &= ~XUSB_EP_CFG_STALL_MASK;
1451 udc->write_fn(udc->addr, ep->offset, epcfgreg);
1453 /* Reset the toggle bit.*/
1454 epcfgreg = udc->read_fn(udc->addr + ep->offset);
1455 epcfgreg &= ~XUSB_EP_CFG_DATA_TOGGLE_MASK;
1456 udc->write_fn(udc->addr, ep->offset, epcfgreg);
1462 * xudc_startup_handler - The usb device controller interrupt handler.
1463 * @udc: pointer to the udc structure.
1464 * @intrstatus: The mask value containing the interrupt sources.
1466 * This function handles the RESET,SUSPEND,RESUME and DISCONNECT interrupts.
1468 static void xudc_startup_handler(struct xusb_udc *udc, u32 intrstatus)
1472 if (intrstatus & XUSB_STATUS_RESET_MASK) {
1474 dev_dbg(udc->dev, "Reset\n");
1476 if (intrstatus & XUSB_STATUS_HIGH_SPEED_MASK)
1477 udc->gadget.speed = USB_SPEED_HIGH;
1479 udc->gadget.speed = USB_SPEED_FULL;
1481 xudc_stop_activity(udc);
1482 xudc_clear_stall_all_ep(udc);
1483 udc->write_fn(udc->addr, XUSB_TESTMODE_OFFSET, 0);
1485 /* Set device address and remote wakeup to 0 */
1486 udc->write_fn(udc->addr, XUSB_ADDRESS_OFFSET, 0);
1487 udc->remote_wkp = 0;
1489 /* Enable the suspend, resume and disconnect */
1490 intrreg = udc->read_fn(udc->addr + XUSB_IER_OFFSET);
1491 intrreg |= XUSB_STATUS_SUSPEND_MASK | XUSB_STATUS_RESUME_MASK |
1492 XUSB_STATUS_DISCONNECT_MASK;
1493 udc->write_fn(udc->addr, XUSB_IER_OFFSET, intrreg);
1495 if (intrstatus & XUSB_STATUS_SUSPEND_MASK) {
1497 dev_dbg(udc->dev, "Suspend\n");
1499 /* Enable the reset, resume and disconnect */
1500 intrreg = udc->read_fn(udc->addr + XUSB_IER_OFFSET);
1501 intrreg |= XUSB_STATUS_RESET_MASK | XUSB_STATUS_RESUME_MASK |
1502 XUSB_STATUS_DISCONNECT_MASK;
1503 udc->write_fn(udc->addr, XUSB_IER_OFFSET, intrreg);
1505 udc->usb_state = USB_STATE_SUSPENDED;
1507 if (udc->driver->suspend) {
1508 spin_unlock(&udc->lock);
1509 udc->driver->suspend(&udc->gadget);
1510 spin_lock(&udc->lock);
1513 if (intrstatus & XUSB_STATUS_RESUME_MASK) {
1514 bool condition = (udc->usb_state != USB_STATE_SUSPENDED);
1516 dev_WARN_ONCE(udc->dev, condition,
1517 "Resume IRQ while not suspended\n");
1519 dev_dbg(udc->dev, "Resume\n");
1521 /* Enable the reset, suspend and disconnect */
1522 intrreg = udc->read_fn(udc->addr + XUSB_IER_OFFSET);
1523 intrreg |= XUSB_STATUS_RESET_MASK | XUSB_STATUS_SUSPEND_MASK |
1524 XUSB_STATUS_DISCONNECT_MASK;
1525 udc->write_fn(udc->addr, XUSB_IER_OFFSET, intrreg);
1529 if (udc->driver->resume) {
1530 spin_unlock(&udc->lock);
1531 udc->driver->resume(&udc->gadget);
1532 spin_lock(&udc->lock);
1535 if (intrstatus & XUSB_STATUS_DISCONNECT_MASK) {
1537 dev_dbg(udc->dev, "Disconnect\n");
1539 /* Enable the reset, resume and suspend */
1540 intrreg = udc->read_fn(udc->addr + XUSB_IER_OFFSET);
1541 intrreg |= XUSB_STATUS_RESET_MASK | XUSB_STATUS_RESUME_MASK |
1542 XUSB_STATUS_SUSPEND_MASK;
1543 udc->write_fn(udc->addr, XUSB_IER_OFFSET, intrreg);
1545 if (udc->driver && udc->driver->disconnect) {
1546 spin_unlock(&udc->lock);
1547 udc->driver->disconnect(&udc->gadget);
1548 spin_lock(&udc->lock);
1554 * xudc_ep0_stall - Stall endpoint zero.
1555 * @udc: pointer to the udc structure.
1557 * This function stalls endpoint zero.
1559 static void xudc_ep0_stall(struct xusb_udc *udc)
1562 struct xusb_ep *ep0 = &udc->ep[XUSB_EP_NUMBER_ZERO];
1564 epcfgreg = udc->read_fn(udc->addr + ep0->offset);
1565 epcfgreg |= XUSB_EP_CFG_STALL_MASK;
1566 udc->write_fn(udc->addr, ep0->offset, epcfgreg);
1570 * xudc_setaddress - executes SET_ADDRESS command
1571 * @udc: pointer to the udc structure.
1573 * This function executes USB SET_ADDRESS command
1575 static void xudc_setaddress(struct xusb_udc *udc)
1577 struct xusb_ep *ep0 = &udc->ep[0];
1578 struct xusb_req *req = udc->req;
1581 req->usb_req.length = 0;
1582 ret = __xudc_ep0_queue(ep0, req);
1586 dev_err(udc->dev, "Can't respond to SET ADDRESS request\n");
1587 xudc_ep0_stall(udc);
1591 * xudc_getstatus - executes GET_STATUS command
1592 * @udc: pointer to the udc structure.
1594 * This function executes USB GET_STATUS command
1596 static void xudc_getstatus(struct xusb_udc *udc)
1598 struct xusb_ep *ep0 = &udc->ep[0];
1599 struct xusb_req *req = udc->req;
1600 struct xusb_ep *target_ep;
1607 switch (udc->setup.bRequestType & USB_RECIP_MASK) {
1608 case USB_RECIP_DEVICE:
1609 /* Get device status */
1610 status = 1 << USB_DEVICE_SELF_POWERED;
1611 if (udc->remote_wkp)
1612 status |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1614 case USB_RECIP_INTERFACE:
1616 case USB_RECIP_ENDPOINT:
1617 epnum = udc->setup.wIndex & USB_ENDPOINT_NUMBER_MASK;
1618 if (epnum >= XUSB_MAX_ENDPOINTS)
1620 target_ep = &udc->ep[epnum];
1621 epcfgreg = udc->read_fn(udc->addr + target_ep->offset);
1622 halt = epcfgreg & XUSB_EP_CFG_STALL_MASK;
1623 if (udc->setup.wIndex & USB_DIR_IN) {
1624 if (!target_ep->is_in)
1627 if (target_ep->is_in)
1631 status = 1 << USB_ENDPOINT_HALT;
1637 req->usb_req.length = 2;
1638 *(u16 *)req->usb_req.buf = cpu_to_le16(status);
1639 ret = __xudc_ep0_queue(ep0, req);
1643 dev_err(udc->dev, "Can't respond to getstatus request\n");
1644 xudc_ep0_stall(udc);
1648 * xudc_set_clear_feature - Executes the set feature and clear feature commands.
1649 * @udc: pointer to the usb device controller structure.
1651 * Processes the SET_FEATURE and CLEAR_FEATURE commands.
1653 static void xudc_set_clear_feature(struct xusb_udc *udc)
1655 struct xusb_ep *ep0 = &udc->ep[0];
1656 struct xusb_req *req = udc->req;
1657 struct xusb_ep *target_ep;
1661 int flag = (udc->setup.bRequest == USB_REQ_SET_FEATURE ? 1 : 0);
1664 switch (udc->setup.bRequestType) {
1665 case USB_RECIP_DEVICE:
1666 switch (udc->setup.wValue) {
1667 case USB_DEVICE_TEST_MODE:
1669 * The Test Mode will be executed
1670 * after the status phase.
1673 case USB_DEVICE_REMOTE_WAKEUP:
1675 udc->remote_wkp = 1;
1677 udc->remote_wkp = 0;
1680 xudc_ep0_stall(udc);
1684 case USB_RECIP_ENDPOINT:
1685 if (!udc->setup.wValue) {
1686 endpoint = udc->setup.wIndex & USB_ENDPOINT_NUMBER_MASK;
1687 if (endpoint >= XUSB_MAX_ENDPOINTS) {
1688 xudc_ep0_stall(udc);
1691 target_ep = &udc->ep[endpoint];
1692 outinbit = udc->setup.wIndex & USB_ENDPOINT_DIR_MASK;
1693 outinbit = outinbit >> 7;
1695 /* Make sure direction matches.*/
1696 if (outinbit != target_ep->is_in) {
1697 xudc_ep0_stall(udc);
1700 epcfgreg = udc->read_fn(udc->addr + target_ep->offset);
1702 /* Clear the stall.*/
1703 epcfgreg &= ~XUSB_EP_CFG_STALL_MASK;
1704 udc->write_fn(udc->addr,
1705 target_ep->offset, epcfgreg);
1708 epcfgreg |= XUSB_EP_CFG_STALL_MASK;
1709 udc->write_fn(udc->addr,
1713 /* Unstall the endpoint.*/
1714 epcfgreg &= ~(XUSB_EP_CFG_STALL_MASK |
1715 XUSB_EP_CFG_DATA_TOGGLE_MASK);
1716 udc->write_fn(udc->addr,
1724 xudc_ep0_stall(udc);
1728 req->usb_req.length = 0;
1729 ret = __xudc_ep0_queue(ep0, req);
1733 dev_err(udc->dev, "Can't respond to SET/CLEAR FEATURE\n");
1734 xudc_ep0_stall(udc);
1738 * xudc_handle_setup - Processes the setup packet.
1739 * @udc: pointer to the usb device controller structure.
1741 * Process setup packet and delegate to gadget layer.
1743 static void xudc_handle_setup(struct xusb_udc *udc)
1744 __must_hold(&udc->lock)
1746 struct xusb_ep *ep0 = &udc->ep[0];
1747 struct usb_ctrlrequest setup;
1750 /* Load up the chapter 9 command buffer.*/
1751 ep0rambase = (u32 __force *) (udc->addr + XUSB_SETUP_PKT_ADDR_OFFSET);
1752 memcpy(&setup, ep0rambase, 8);
1755 udc->setup.wValue = cpu_to_le16(setup.wValue);
1756 udc->setup.wIndex = cpu_to_le16(setup.wIndex);
1757 udc->setup.wLength = cpu_to_le16(setup.wLength);
1759 /* Clear previous requests */
1760 xudc_nuke(ep0, -ECONNRESET);
1762 if (udc->setup.bRequestType & USB_DIR_IN) {
1763 /* Execute the get command.*/
1764 udc->setupseqrx = STATUS_PHASE;
1765 udc->setupseqtx = DATA_PHASE;
1767 /* Execute the put command.*/
1768 udc->setupseqrx = DATA_PHASE;
1769 udc->setupseqtx = STATUS_PHASE;
1772 switch (udc->setup.bRequest) {
1773 case USB_REQ_GET_STATUS:
1774 /* Data+Status phase form udc */
1775 if ((udc->setup.bRequestType &
1776 (USB_DIR_IN | USB_TYPE_MASK)) !=
1777 (USB_DIR_IN | USB_TYPE_STANDARD))
1779 xudc_getstatus(udc);
1781 case USB_REQ_SET_ADDRESS:
1782 /* Status phase from udc */
1783 if (udc->setup.bRequestType != (USB_DIR_OUT |
1784 USB_TYPE_STANDARD | USB_RECIP_DEVICE))
1786 xudc_setaddress(udc);
1788 case USB_REQ_CLEAR_FEATURE:
1789 case USB_REQ_SET_FEATURE:
1790 /* Requests with no data phase, status phase from udc */
1791 if ((udc->setup.bRequestType & USB_TYPE_MASK)
1792 != USB_TYPE_STANDARD)
1794 xudc_set_clear_feature(udc);
1800 spin_unlock(&udc->lock);
1801 if (udc->driver->setup(&udc->gadget, &setup) < 0)
1802 xudc_ep0_stall(udc);
1803 spin_lock(&udc->lock);
1807 * xudc_ep0_out - Processes the endpoint 0 OUT token.
1808 * @udc: pointer to the usb device controller structure.
1810 static void xudc_ep0_out(struct xusb_udc *udc)
1812 struct xusb_ep *ep0 = &udc->ep[0];
1813 struct xusb_req *req;
1815 unsigned int bytes_to_rx;
1818 req = list_first_entry(&ep0->queue, struct xusb_req, queue);
1820 switch (udc->setupseqrx) {
1823 * This resets both state machines for the next
1826 udc->setupseqrx = SETUP_PHASE;
1827 udc->setupseqtx = SETUP_PHASE;
1828 req->usb_req.actual = req->usb_req.length;
1829 xudc_done(ep0, req, 0);
1832 bytes_to_rx = udc->read_fn(udc->addr +
1833 XUSB_EP_BUF0COUNT_OFFSET);
1834 /* Copy the data to be received from the DPRAM. */
1835 ep0rambase = (u8 __force *) (udc->addr +
1836 (ep0->rambase << 2));
1837 buffer = req->usb_req.buf + req->usb_req.actual;
1838 req->usb_req.actual = req->usb_req.actual + bytes_to_rx;
1839 memcpy(buffer, ep0rambase, bytes_to_rx);
1841 if (req->usb_req.length == req->usb_req.actual) {
1842 /* Data transfer completed get ready for Status stage */
1845 /* Enable EP0 buffer to receive data */
1846 udc->write_fn(udc->addr, XUSB_EP_BUF0COUNT_OFFSET, 0);
1847 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET, 1);
1856 * xudc_ep0_in - Processes the endpoint 0 IN token.
1857 * @udc: pointer to the usb device controller structure.
1859 static void xudc_ep0_in(struct xusb_udc *udc)
1861 struct xusb_ep *ep0 = &udc->ep[0];
1862 struct xusb_req *req;
1863 unsigned int bytes_to_tx;
1869 u8 test_mode = udc->setup.wIndex >> 8;
1871 req = list_first_entry(&ep0->queue, struct xusb_req, queue);
1872 bytes_to_tx = req->usb_req.length - req->usb_req.actual;
1874 switch (udc->setupseqtx) {
1876 switch (udc->setup.bRequest) {
1877 case USB_REQ_SET_ADDRESS:
1878 /* Set the address of the device.*/
1879 udc->write_fn(udc->addr, XUSB_ADDRESS_OFFSET,
1882 case USB_REQ_SET_FEATURE:
1883 if (udc->setup.bRequestType ==
1885 if (udc->setup.wValue ==
1886 USB_DEVICE_TEST_MODE)
1887 udc->write_fn(udc->addr,
1888 XUSB_TESTMODE_OFFSET,
1893 req->usb_req.actual = req->usb_req.length;
1894 xudc_done(ep0, req, 0);
1899 * We're done with data transfer, next
1900 * will be zero length OUT with data toggle of
1901 * 1. Setup data_toggle.
1903 epcfgreg = udc->read_fn(udc->addr + ep0->offset);
1904 epcfgreg |= XUSB_EP_CFG_DATA_TOGGLE_MASK;
1905 udc->write_fn(udc->addr, ep0->offset, epcfgreg);
1906 udc->setupseqtx = STATUS_PHASE;
1908 length = count = min_t(u32, bytes_to_tx,
1910 /* Copy the data to be transmitted into the DPRAM. */
1911 ep0rambase = (u8 __force *) (udc->addr +
1912 (ep0->rambase << 2));
1913 buffer = req->usb_req.buf + req->usb_req.actual;
1914 req->usb_req.actual = req->usb_req.actual + length;
1915 memcpy(ep0rambase, buffer, length);
1917 udc->write_fn(udc->addr, XUSB_EP_BUF0COUNT_OFFSET, count);
1918 udc->write_fn(udc->addr, XUSB_BUFFREADY_OFFSET, 1);
1926 * xudc_ctrl_ep_handler - Endpoint 0 interrupt handler.
1927 * @udc: pointer to the udc structure.
1928 * @intrstatus: It's the mask value for the interrupt sources on endpoint 0.
1930 * Processes the commands received during enumeration phase.
1932 static void xudc_ctrl_ep_handler(struct xusb_udc *udc, u32 intrstatus)
1935 if (intrstatus & XUSB_STATUS_SETUP_PACKET_MASK) {
1936 xudc_handle_setup(udc);
1938 if (intrstatus & XUSB_STATUS_FIFO_BUFF_RDY_MASK)
1940 else if (intrstatus & XUSB_STATUS_FIFO_BUFF_FREE_MASK)
1946 * xudc_nonctrl_ep_handler - Non control endpoint interrupt handler.
1947 * @udc: pointer to the udc structure.
1948 * @epnum: End point number for which the interrupt is to be processed
1949 * @intrstatus: mask value for interrupt sources of endpoints other
1952 * Processes the buffer completion interrupts.
1954 static void xudc_nonctrl_ep_handler(struct xusb_udc *udc, u8 epnum,
1958 struct xusb_req *req;
1961 ep = &udc->ep[epnum];
1962 /* Process the End point interrupts.*/
1963 if (intrstatus & (XUSB_STATUS_EP0_BUFF1_COMP_MASK << epnum))
1964 ep->buffer0ready = 0;
1965 if (intrstatus & (XUSB_STATUS_EP0_BUFF2_COMP_MASK << epnum))
1966 ep->buffer1ready = false;
1968 if (list_empty(&ep->queue))
1971 req = list_first_entry(&ep->queue, struct xusb_req, queue);
1974 xudc_write_fifo(ep, req);
1976 xudc_read_fifo(ep, req);
1980 * xudc_irq - The main interrupt handler.
1981 * @irq: The interrupt number.
1982 * @_udc: pointer to the usb device controller structure.
1984 * Return: IRQ_HANDLED after the interrupt is handled.
1986 static irqreturn_t xudc_irq(int irq, void *_udc)
1988 struct xusb_udc *udc = _udc;
1993 unsigned long flags;
1995 spin_lock_irqsave(&udc->lock, flags);
1998 * Event interrupts are level sensitive hence first disable
1999 * IER, read ISR and figure out active interrupts.
2001 ier = udc->read_fn(udc->addr + XUSB_IER_OFFSET);
2002 ier &= ~XUSB_STATUS_INTR_EVENT_MASK;
2003 udc->write_fn(udc->addr, XUSB_IER_OFFSET, ier);
2005 /* Read the Interrupt Status Register.*/
2006 intrstatus = udc->read_fn(udc->addr + XUSB_STATUS_OFFSET);
2008 /* Call the handler for the event interrupt.*/
2009 if (intrstatus & XUSB_STATUS_INTR_EVENT_MASK) {
2011 * Check if there is any action to be done for :
2012 * - USB Reset received {XUSB_STATUS_RESET_MASK}
2013 * - USB Suspend received {XUSB_STATUS_SUSPEND_MASK}
2014 * - USB Resume received {XUSB_STATUS_RESUME_MASK}
2015 * - USB Disconnect received {XUSB_STATUS_DISCONNECT_MASK}
2017 xudc_startup_handler(udc, intrstatus);
2020 /* Check the buffer completion interrupts */
2021 if (intrstatus & XUSB_STATUS_INTR_BUFF_COMP_ALL_MASK) {
2022 /* Enable Reset, Suspend, Resume and Disconnect */
2023 ier = udc->read_fn(udc->addr + XUSB_IER_OFFSET);
2024 ier |= XUSB_STATUS_INTR_EVENT_MASK;
2025 udc->write_fn(udc->addr, XUSB_IER_OFFSET, ier);
2027 if (intrstatus & XUSB_STATUS_EP0_BUFF1_COMP_MASK)
2028 xudc_ctrl_ep_handler(udc, intrstatus);
2030 for (index = 1; index < 8; index++) {
2031 bufintr = ((intrstatus &
2032 (XUSB_STATUS_EP1_BUFF1_COMP_MASK <<
2033 (index - 1))) || (intrstatus &
2034 (XUSB_STATUS_EP1_BUFF2_COMP_MASK <<
2037 xudc_nonctrl_ep_handler(udc, index,
2043 spin_unlock_irqrestore(&udc->lock, flags);
2048 * xudc_probe - The device probe function for driver initialization.
2049 * @pdev: pointer to the platform device structure.
2051 * Return: 0 for success and error value on failure
2053 static int xudc_probe(struct platform_device *pdev)
2055 struct device_node *np = pdev->dev.of_node;
2056 struct resource *res;
2057 struct xusb_udc *udc;
2063 udc = devm_kzalloc(&pdev->dev, sizeof(*udc), GFP_KERNEL);
2067 /* Create a dummy request for GET_STATUS, SET_ADDRESS */
2068 udc->req = devm_kzalloc(&pdev->dev, sizeof(struct xusb_req),
2073 buff = devm_kzalloc(&pdev->dev, STATUSBUFF_SIZE, GFP_KERNEL);
2077 udc->req->usb_req.buf = buff;
2079 /* Map the registers */
2080 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2081 udc->addr = devm_ioremap_resource(&pdev->dev, res);
2082 if (IS_ERR(udc->addr))
2083 return PTR_ERR(udc->addr);
2085 irq = platform_get_irq(pdev, 0);
2088 ret = devm_request_irq(&pdev->dev, irq, xudc_irq, 0,
2089 dev_name(&pdev->dev), udc);
2091 dev_dbg(&pdev->dev, "unable to request irq %d", irq);
2095 udc->dma_enabled = of_property_read_bool(np, "xlnx,has-builtin-dma");
2097 /* Setup gadget structure */
2098 udc->gadget.ops = &xusb_udc_ops;
2099 udc->gadget.max_speed = USB_SPEED_HIGH;
2100 udc->gadget.speed = USB_SPEED_UNKNOWN;
2101 udc->gadget.ep0 = &udc->ep[XUSB_EP_NUMBER_ZERO].ep_usb;
2102 udc->gadget.name = driver_name;
2104 udc->clk = devm_clk_get(&pdev->dev, "s_axi_aclk");
2105 if (IS_ERR(udc->clk)) {
2106 if (PTR_ERR(udc->clk) != -ENOENT) {
2107 ret = PTR_ERR(udc->clk);
2112 * Clock framework support is optional, continue on,
2113 * anyways if we don't find a matching clock
2115 dev_warn(&pdev->dev, "s_axi_aclk clock property is not found\n");
2119 ret = clk_prepare_enable(udc->clk);
2121 dev_err(&pdev->dev, "Unable to enable clock.\n");
2125 spin_lock_init(&udc->lock);
2127 /* Check for IP endianness */
2128 udc->write_fn = xudc_write32_be;
2129 udc->read_fn = xudc_read32_be;
2130 udc->write_fn(udc->addr, XUSB_TESTMODE_OFFSET, USB_TEST_J);
2131 if ((udc->read_fn(udc->addr + XUSB_TESTMODE_OFFSET))
2133 udc->write_fn = xudc_write32;
2134 udc->read_fn = xudc_read32;
2136 udc->write_fn(udc->addr, XUSB_TESTMODE_OFFSET, 0);
2140 /* Set device address to 0.*/
2141 udc->write_fn(udc->addr, XUSB_ADDRESS_OFFSET, 0);
2143 ret = usb_add_gadget_udc(&pdev->dev, &udc->gadget);
2145 goto err_disable_unprepare_clk;
2147 udc->dev = &udc->gadget.dev;
2149 /* Enable the interrupts.*/
2150 ier = XUSB_STATUS_GLOBAL_INTR_MASK | XUSB_STATUS_INTR_EVENT_MASK |
2151 XUSB_STATUS_FIFO_BUFF_RDY_MASK | XUSB_STATUS_FIFO_BUFF_FREE_MASK |
2152 XUSB_STATUS_SETUP_PACKET_MASK |
2153 XUSB_STATUS_INTR_BUFF_COMP_ALL_MASK;
2155 udc->write_fn(udc->addr, XUSB_IER_OFFSET, ier);
2157 platform_set_drvdata(pdev, udc);
2159 dev_vdbg(&pdev->dev, "%s at 0x%08X mapped to %p %s\n",
2160 driver_name, (u32)res->start, udc->addr,
2161 udc->dma_enabled ? "with DMA" : "without DMA");
2165 err_disable_unprepare_clk:
2166 clk_disable_unprepare(udc->clk);
2168 dev_err(&pdev->dev, "probe failed, %d\n", ret);
2173 * xudc_remove - Releases the resources allocated during the initialization.
2174 * @pdev: pointer to the platform device structure.
2178 static int xudc_remove(struct platform_device *pdev)
2180 struct xusb_udc *udc = platform_get_drvdata(pdev);
2182 usb_del_gadget_udc(&udc->gadget);
2183 clk_disable_unprepare(udc->clk);
2188 /* Match table for of_platform binding */
2189 static const struct of_device_id usb_of_match[] = {
2190 { .compatible = "xlnx,usb2-device-4.00.a", },
2191 { /* end of list */ },
2193 MODULE_DEVICE_TABLE(of, usb_of_match);
2195 static struct platform_driver xudc_driver = {
2197 .name = driver_name,
2198 .of_match_table = usb_of_match,
2200 .probe = xudc_probe,
2201 .remove = xudc_remove,
2204 module_platform_driver(xudc_driver);
2206 MODULE_DESCRIPTION("Xilinx udc driver");
2207 MODULE_AUTHOR("Xilinx, Inc");
2208 MODULE_LICENSE("GPL");