drivers/usb/chipidea/udc.c

   1 /*
   2  * udc.c - ChipIdea UDC driver
   3  *
   4  * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
   5  *
   6  * Author: David Lopo
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #include <linux/delay.h>
  14 #include <linux/device.h>
  15 #include <linux/dmapool.h>
  16 #include <linux/err.h>
  17 #include <linux/irqreturn.h>
  18 #include <linux/kernel.h>
  19 #include <linux/slab.h>
  20 #include <linux/pm_runtime.h>
  21 #include <linux/usb/ch9.h>
  22 #include <linux/usb/gadget.h>
  23 #include <linux/usb/otg.h>
  24 #include <linux/usb/chipidea.h>
  25
  26 #include "ci.h"
  27 #include "udc.h"
  28 #include "bits.h"
  29 #include "debug.h"
  30 #include "otg.h"
  31
  32 /* control endpoint description */
  33 static const struct usb_endpoint_descriptor
  34 ctrl_endpt_out_desc = {
  35         .bLength         = USB_DT_ENDPOINT_SIZE,
  36         .bDescriptorType = USB_DT_ENDPOINT,
  37
  38         .bEndpointAddress = USB_DIR_OUT,
  39         .bmAttributes    = USB_ENDPOINT_XFER_CONTROL,
  40         .wMaxPacketSize  = cpu_to_le16(CTRL_PAYLOAD_MAX),
  41 };
  42
  43 static const struct usb_endpoint_descriptor
  44 ctrl_endpt_in_desc = {
  45         .bLength         = USB_DT_ENDPOINT_SIZE,
  46         .bDescriptorType = USB_DT_ENDPOINT,
  47
  48         .bEndpointAddress = USB_DIR_IN,
  49         .bmAttributes    = USB_ENDPOINT_XFER_CONTROL,
  50         .wMaxPacketSize  = cpu_to_le16(CTRL_PAYLOAD_MAX),
  51 };
  52
  53 /**
  54  * hw_ep_bit: calculates the bit number
  55  * @num: endpoint number
  56  * @dir: endpoint direction
  57  *
  58  * This function returns bit number
  59  */
  60 static inline int hw_ep_bit(int num, int dir)
  61 {
  62         return num + (dir ? 16 : 0);
  63 }
  64
  65 static inline int ep_to_bit(struct ci_hdrc *ci, int n)
  66 {
  67         int fill = 16 - ci->hw_ep_max / 2;
  68
  69         if (n >= ci->hw_ep_max / 2)
  70                 n += fill;
  71
  72         return n;
  73 }
  74
  75 /**
  76  * hw_device_state: enables/disables interrupts (execute without interruption)
  77  * @dma: 0 => disable, !0 => enable and set dma engine
  78  *
  79  * This function returns an error code
  80  */
  81 static int hw_device_state(struct ci_hdrc *ci, u32 dma)
  82 {
  83         if (dma) {
  84                 hw_write(ci, OP_ENDPTLISTADDR, ~0, dma);
  85                 /* interrupt, error, port change, reset, sleep/suspend */
  86                 hw_write(ci, OP_USBINTR, ~0,
  87                              USBi_UI|USBi_UEI|USBi_PCI|USBi_URI|USBi_SLI);
  88         } else {
  89                 hw_write(ci, OP_USBINTR, ~0, 0);
  90         }
  91         return 0;
  92 }
  93
  94 /**
  95  * hw_ep_flush: flush endpoint fifo (execute without interruption)
  96  * @num: endpoint number
  97  * @dir: endpoint direction
  98  *
  99  * This function returns an error code
 100  */
 101 static int hw_ep_flush(struct ci_hdrc *ci, int num, int dir)
 102 {
 103         int n = hw_ep_bit(num, dir);
 104
 105         do {
 106                 /* flush any pending transfer */
 107                 hw_write(ci, OP_ENDPTFLUSH, BIT(n), BIT(n));
 108                 while (hw_read(ci, OP_ENDPTFLUSH, BIT(n)))
 109                         cpu_relax();
 110         } while (hw_read(ci, OP_ENDPTSTAT, BIT(n)));
 111
 112         return 0;
 113 }
 114
 115 /**
 116  * hw_ep_disable: disables endpoint (execute without interruption)
 117  * @num: endpoint number
 118  * @dir: endpoint direction
 119  *
 120  * This function returns an error code
 121  */
 122 static int hw_ep_disable(struct ci_hdrc *ci, int num, int dir)
 123 {
 124         hw_ep_flush(ci, num, dir);
 125         hw_write(ci, OP_ENDPTCTRL + num,
 126                  dir ? ENDPTCTRL_TXE : ENDPTCTRL_RXE, 0);
 127         return 0;
 128 }
 129
 130 /**
 131  * hw_ep_enable: enables endpoint (execute without interruption)
 132  * @num:  endpoint number
 133  * @dir:  endpoint direction
 134  * @type: endpoint type
 135  *
 136  * This function returns an error code
 137  */
 138 static int hw_ep_enable(struct ci_hdrc *ci, int num, int dir, int type)
 139 {
 140         u32 mask, data;
 141
 142         if (dir) {
 143                 mask  = ENDPTCTRL_TXT;  /* type    */
 144                 data  = type << __ffs(mask);
 145
 146                 mask |= ENDPTCTRL_TXS;  /* unstall */
 147                 mask |= ENDPTCTRL_TXR;  /* reset data toggle */
 148                 data |= ENDPTCTRL_TXR;
 149                 mask |= ENDPTCTRL_TXE;  /* enable  */
 150                 data |= ENDPTCTRL_TXE;
 151         } else {
 152                 mask  = ENDPTCTRL_RXT;  /* type    */
 153                 data  = type << __ffs(mask);
 154
 155                 mask |= ENDPTCTRL_RXS;  /* unstall */
 156                 mask |= ENDPTCTRL_RXR;  /* reset data toggle */
 157                 data |= ENDPTCTRL_RXR;
 158                 mask |= ENDPTCTRL_RXE;  /* enable  */
 159                 data |= ENDPTCTRL_RXE;
 160         }
 161         hw_write(ci, OP_ENDPTCTRL + num, mask, data);
 162         return 0;
 163 }
 164
 165 /**
 166  * hw_ep_get_halt: return endpoint halt status
 167  * @num: endpoint number
 168  * @dir: endpoint direction
 169  *
 170  * This function returns 1 if endpoint halted
 171  */
 172 static int hw_ep_get_halt(struct ci_hdrc *ci, int num, int dir)
 173 {
 174         u32 mask = dir ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
 175
 176         return hw_read(ci, OP_ENDPTCTRL + num, mask) ? 1 : 0;
 177 }
 178
 179 /**
 180  * hw_test_and_clear_setup_status: test & clear setup status (execute without
 181  *                                 interruption)
 182  * @n: endpoint number
 183  *
 184  * This function returns setup status
 185  */
 186 static int hw_test_and_clear_setup_status(struct ci_hdrc *ci, int n)
 187 {
 188         n = ep_to_bit(ci, n);
 189         return hw_test_and_clear(ci, OP_ENDPTSETUPSTAT, BIT(n));
 190 }
 191
 192 /**
 193  * hw_ep_prime: primes endpoint (execute without interruption)
 194  * @num:     endpoint number
 195  * @dir:     endpoint direction
 196  * @is_ctrl: true if control endpoint
 197  *
 198  * This function returns an error code
 199  */
 200 static int hw_ep_prime(struct ci_hdrc *ci, int num, int dir, int is_ctrl)
 201 {
 202         int n = hw_ep_bit(num, dir);
 203
 204         if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
 205                 return -EAGAIN;
 206
 207         hw_write(ci, OP_ENDPTPRIME, BIT(n), BIT(n));
 208
 209         while (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
 210                 cpu_relax();
 211         if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
 212                 return -EAGAIN;
 213
 214         /* status shoult be tested according with manual but it doesn't work */
 215         return 0;
 216 }
 217
 218 /**
 219  * hw_ep_set_halt: configures ep halt & resets data toggle after clear (execute
 220  *                 without interruption)
 221  * @num:   endpoint number
 222  * @dir:   endpoint direction
 223  * @value: true => stall, false => unstall
 224  *
 225  * This function returns an error code
 226  */
 227 static int hw_ep_set_halt(struct ci_hdrc *ci, int num, int dir, int value)
 228 {
 229         if (value != 0 && value != 1)
 230                 return -EINVAL;
 231
 232         do {
 233                 enum ci_hw_regs reg = OP_ENDPTCTRL + num;
 234                 u32 mask_xs = dir ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
 235                 u32 mask_xr = dir ? ENDPTCTRL_TXR : ENDPTCTRL_RXR;
 236
 237                 /* data toggle - reserved for EP0 but it's in ESS */
 238                 hw_write(ci, reg, mask_xs|mask_xr,
 239                           value ? mask_xs : mask_xr);
 240         } while (value != hw_ep_get_halt(ci, num, dir));
 241
 242         return 0;
 243 }
 244
 245 /**
 246  * hw_is_port_high_speed: test if port is high speed
 247  *
 248  * This function returns true if high speed port
 249  */
 250 static int hw_port_is_high_speed(struct ci_hdrc *ci)
 251 {
 252         return ci->hw_bank.lpm ? hw_read(ci, OP_DEVLC, DEVLC_PSPD) :
 253                 hw_read(ci, OP_PORTSC, PORTSC_HSP);
 254 }
 255
 256 /**
 257  * hw_read_intr_enable: returns interrupt enable register
 258  *
 259  * This function returns register data
 260  */
 261 static u32 hw_read_intr_enable(struct ci_hdrc *ci)
 262 {
 263         return hw_read(ci, OP_USBINTR, ~0);
 264 }
 265
 266 /**
 267  * hw_read_intr_status: returns interrupt status register
 268  *
 269  * This function returns register data
 270  */
 271 static u32 hw_read_intr_status(struct ci_hdrc *ci)
 272 {
 273         return hw_read(ci, OP_USBSTS, ~0);
 274 }
 275
 276 /**
 277  * hw_test_and_clear_complete: test & clear complete status (execute without
 278  *                             interruption)
 279  * @n: endpoint number
 280  *
 281  * This function returns complete status
 282  */
 283 static int hw_test_and_clear_complete(struct ci_hdrc *ci, int n)
 284 {
 285         n = ep_to_bit(ci, n);
 286         return hw_test_and_clear(ci, OP_ENDPTCOMPLETE, BIT(n));
 287 }
 288
 289 /**
 290  * hw_test_and_clear_intr_active: test & clear active interrupts (execute
 291  *                                without interruption)
 292  *
 293  * This function returns active interrutps
 294  */
 295 static u32 hw_test_and_clear_intr_active(struct ci_hdrc *ci)
 296 {
 297         u32 reg = hw_read_intr_status(ci) & hw_read_intr_enable(ci);
 298
 299         hw_write(ci, OP_USBSTS, ~0, reg);
 300         return reg;
 301 }
 302
 303 /**
 304  * hw_test_and_clear_setup_guard: test & clear setup guard (execute without
 305  *                                interruption)
 306  *
 307  * This function returns guard value
 308  */
 309 static int hw_test_and_clear_setup_guard(struct ci_hdrc *ci)
 310 {
 311         return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, 0);
 312 }
 313
 314 /**
 315  * hw_test_and_set_setup_guard: test & set setup guard (execute without
 316  *                              interruption)
 317  *
 318  * This function returns guard value
 319  */
 320 static int hw_test_and_set_setup_guard(struct ci_hdrc *ci)
 321 {
 322         return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, USBCMD_SUTW);
 323 }
 324
 325 /**
 326  * hw_usb_set_address: configures USB address (execute without interruption)
 327  * @value: new USB address
 328  *
 329  * This function explicitly sets the address, without the "USBADRA" (advance)
 330  * feature, which is not supported by older versions of the controller.
 331  */
 332 static void hw_usb_set_address(struct ci_hdrc *ci, u8 value)
 333 {
 334         hw_write(ci, OP_DEVICEADDR, DEVICEADDR_USBADR,
 335                  value << __ffs(DEVICEADDR_USBADR));
 336 }
 337
 338 /**
 339  * hw_usb_reset: restart device after a bus reset (execute without
 340  *               interruption)
 341  *
 342  * This function returns an error code
 343  */
 344 static int hw_usb_reset(struct ci_hdrc *ci)
 345 {
 346         hw_usb_set_address(ci, 0);
 347
 348         /* ESS flushes only at end?!? */
 349         hw_write(ci, OP_ENDPTFLUSH,    ~0, ~0);
 350
 351         /* clear setup token semaphores */
 352         hw_write(ci, OP_ENDPTSETUPSTAT, 0,  0);
 353
 354         /* clear complete status */
 355         hw_write(ci, OP_ENDPTCOMPLETE,  0,  0);
 356
 357         /* wait until all bits cleared */
 358         while (hw_read(ci, OP_ENDPTPRIME, ~0))
 359                 udelay(10);             /* not RTOS friendly */
 360
 361         /* reset all endpoints ? */
 362
 363         /* reset internal status and wait for further instructions
 364            no need to verify the port reset status (ESS does it) */
 365
 366         return 0;
 367 }
 368
 369 /******************************************************************************
 370  * UTIL block
 371  *****************************************************************************/
 372
 373 static int add_td_to_list(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq,
 374                           unsigned length)
 375 {
 376         int i;
 377         u32 temp;
 378         struct td_node *lastnode, *node = kzalloc(sizeof(struct td_node),
 379                                                   GFP_ATOMIC);
 380
 381         if (node == NULL)
 382                 return -ENOMEM;
 383
 384         node->ptr = dma_pool_alloc(hwep->td_pool, GFP_ATOMIC,
 385                                    &node->dma);
 386         if (node->ptr == NULL) {
 387                 kfree(node);
 388                 return -ENOMEM;
 389         }
 390
 391         memset(node->ptr, 0, sizeof(struct ci_hw_td));
 392         node->ptr->token = cpu_to_le32(length << __ffs(TD_TOTAL_BYTES));
 393         node->ptr->token &= cpu_to_le32(TD_TOTAL_BYTES);
 394         node->ptr->token |= cpu_to_le32(TD_STATUS_ACTIVE);
 395
 396         temp = (u32) (hwreq->req.dma + hwreq->req.actual);
 397         if (length) {
 398                 node->ptr->page[0] = cpu_to_le32(temp);
 399                 for (i = 1; i < TD_PAGE_COUNT; i++) {
 400                         u32 page = temp + i * CI_HDRC_PAGE_SIZE;
 401                         page &= ~TD_RESERVED_MASK;
 402                         node->ptr->page[i] = cpu_to_le32(page);
 403                 }
 404         }
 405
 406         hwreq->req.actual += length;
 407
 408         if (!list_empty(&hwreq->tds)) {
 409                 /* get the last entry */
 410                 lastnode = list_entry(hwreq->tds.prev,
 411                                 struct td_node, td);
 412                 lastnode->ptr->next = cpu_to_le32(node->dma);
 413         }
 414
 415         INIT_LIST_HEAD(&node->td);
 416         list_add_tail(&node->td, &hwreq->tds);
 417
 418         return 0;
 419 }
 420
 421 /**
 422  * _usb_addr: calculates endpoint address from direction & number
 423  * @ep:  endpoint
 424  */
 425 static inline u8 _usb_addr(struct ci_hw_ep *ep)
 426 {
 427         return ((ep->dir == TX) ? USB_ENDPOINT_DIR_MASK : 0) | ep->num;
 428 }
 429
 430 /**
 431  * _hardware_queue: configures a request at hardware level
 432  * @gadget: gadget
 433  * @hwep:   endpoint
 434  *
 435  * This function returns an error code
 436  */
 437 static int _hardware_enqueue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
 438 {
 439         struct ci_hdrc *ci = hwep->ci;
 440         int ret = 0;
 441         unsigned rest = hwreq->req.length;
 442         int pages = TD_PAGE_COUNT;
 443         struct td_node *firstnode, *lastnode;
 444
 445         /* don't queue twice */
 446         if (hwreq->req.status == -EALREADY)
 447                 return -EALREADY;
 448
 449         hwreq->req.status = -EALREADY;
 450
 451         ret = usb_gadget_map_request(&ci->gadget, &hwreq->req, hwep->dir);
 452         if (ret)
 453                 return ret;
 454
 455         /*
 456          * The first buffer could be not page aligned.
 457          * In that case we have to span into one extra td.
 458          */
 459         if (hwreq->req.dma % PAGE_SIZE)
 460                 pages--;
 461
 462         if (rest == 0)
 463                 add_td_to_list(hwep, hwreq, 0);
 464
 465         while (rest > 0) {
 466                 unsigned count = min(hwreq->req.length - hwreq->req.actual,
 467                                         (unsigned)(pages * CI_HDRC_PAGE_SIZE));
 468                 add_td_to_list(hwep, hwreq, count);
 469                 rest -= count;
 470         }
 471
 472         if (hwreq->req.zero && hwreq->req.length
 473             && (hwreq->req.length % hwep->ep.maxpacket == 0))
 474                 add_td_to_list(hwep, hwreq, 0);
 475
 476         firstnode = list_first_entry(&hwreq->tds, struct td_node, td);
 477
 478         lastnode = list_entry(hwreq->tds.prev,
 479                 struct td_node, td);
 480
 481         lastnode->ptr->next = cpu_to_le32(TD_TERMINATE);
 482         if (!hwreq->req.no_interrupt)
 483                 lastnode->ptr->token |= cpu_to_le32(TD_IOC);
 484         wmb();
 485
 486         hwreq->req.actual = 0;
 487         if (!list_empty(&hwep->qh.queue)) {
 488                 struct ci_hw_req *hwreqprev;
 489                 int n = hw_ep_bit(hwep->num, hwep->dir);
 490                 int tmp_stat;
 491                 struct td_node *prevlastnode;
 492                 u32 next = firstnode->dma & TD_ADDR_MASK;
 493
 494                 hwreqprev = list_entry(hwep->qh.queue.prev,
 495                                 struct ci_hw_req, queue);
 496                 prevlastnode = list_entry(hwreqprev->tds.prev,
 497                                 struct td_node, td);
 498
 499                 prevlastnode->ptr->next = cpu_to_le32(next);
 500                 wmb();
 501                 if (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
 502                         goto done;
 503                 do {
 504                         hw_write(ci, OP_USBCMD, USBCMD_ATDTW, USBCMD_ATDTW);
 505                         tmp_stat = hw_read(ci, OP_ENDPTSTAT, BIT(n));
 506                 } while (!hw_read(ci, OP_USBCMD, USBCMD_ATDTW));
 507                 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, 0);
 508                 if (tmp_stat)
 509                         goto done;
 510         }
 511
 512         /*  QH configuration */
 513         hwep->qh.ptr->td.next = cpu_to_le32(firstnode->dma);
 514         hwep->qh.ptr->td.token &=
 515                 cpu_to_le32(~(TD_STATUS_HALTED|TD_STATUS_ACTIVE));
 516
 517         if (hwep->type == USB_ENDPOINT_XFER_ISOC) {
 518                 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
 519
 520                 if (hwreq->req.length % hwep->ep.maxpacket)
 521                         mul++;
 522                 hwep->qh.ptr->cap |= mul << __ffs(QH_MULT);
 523         }
 524
 525         wmb();   /* synchronize before ep prime */
 526
 527         ret = hw_ep_prime(ci, hwep->num, hwep->dir,
 528                            hwep->type == USB_ENDPOINT_XFER_CONTROL);
 529 done:
 530         return ret;
 531 }
 532
 533 /*
 534  * free_pending_td: remove a pending request for the endpoint
 535  * @hwep: endpoint
 536  */
 537 static void free_pending_td(struct ci_hw_ep *hwep)
 538 {
 539         struct td_node *pending = hwep->pending_td;
 540
 541         dma_pool_free(hwep->td_pool, pending->ptr, pending->dma);
 542         hwep->pending_td = NULL;
 543         kfree(pending);
 544 }
 545
 546 /**
 547  * _hardware_dequeue: handles a request at hardware level
 548  * @gadget: gadget
 549  * @hwep:   endpoint
 550  *
 551  * This function returns an error code
 552  */
 553 static int _hardware_dequeue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
 554 {
 555         u32 tmptoken;
 556         struct td_node *node, *tmpnode;
 557         unsigned remaining_length;
 558         unsigned actual = hwreq->req.length;
 559
 560         if (hwreq->req.status != -EALREADY)
 561                 return -EINVAL;
 562
 563         hwreq->req.status = 0;
 564
 565         list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
 566                 tmptoken = le32_to_cpu(node->ptr->token);
 567                 if ((TD_STATUS_ACTIVE & tmptoken) != 0) {
 568                         hwreq->req.status = -EALREADY;
 569                         return -EBUSY;
 570                 }
 571
 572                 remaining_length = (tmptoken & TD_TOTAL_BYTES);
 573                 remaining_length >>= __ffs(TD_TOTAL_BYTES);
 574                 actual -= remaining_length;
 575
 576                 hwreq->req.status = tmptoken & TD_STATUS;
 577                 if ((TD_STATUS_HALTED & hwreq->req.status)) {
 578                         hwreq->req.status = -EPIPE;
 579                         break;
 580                 } else if ((TD_STATUS_DT_ERR & hwreq->req.status)) {
 581                         hwreq->req.status = -EPROTO;
 582                         break;
 583                 } else if ((TD_STATUS_TR_ERR & hwreq->req.status)) {
 584                         hwreq->req.status = -EILSEQ;
 585                         break;
 586                 }
 587
 588                 if (remaining_length) {
 589                         if (hwep->dir) {
 590                                 hwreq->req.status = -EPROTO;
 591                                 break;
 592                         }
 593                 }
 594                 /*
 595                  * As the hardware could still address the freed td
 596                  * which will run the udc unusable, the cleanup of the
 597                  * td has to be delayed by one.
 598                  */
 599                 if (hwep->pending_td)
 600                         free_pending_td(hwep);
 601
 602                 hwep->pending_td = node;
 603                 list_del_init(&node->td);
 604         }
 605
 606         usb_gadget_unmap_request(&hwep->ci->gadget, &hwreq->req, hwep->dir);
 607
 608         hwreq->req.actual += actual;
 609
 610         if (hwreq->req.status)
 611                 return hwreq->req.status;
 612
 613         return hwreq->req.actual;
 614 }
 615
 616 /**
 617  * _ep_nuke: dequeues all endpoint requests
 618  * @hwep: endpoint
 619  *
 620  * This function returns an error code
 621  * Caller must hold lock
 622  */
 623 static int _ep_nuke(struct ci_hw_ep *hwep)
 624 __releases(hwep->lock)
 625 __acquires(hwep->lock)
 626 {
 627         struct td_node *node, *tmpnode;
 628         if (hwep == NULL)
 629                 return -EINVAL;
 630
 631         hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
 632
 633         while (!list_empty(&hwep->qh.queue)) {
 634
 635                 /* pop oldest request */
 636                 struct ci_hw_req *hwreq = list_entry(hwep->qh.queue.next,
 637                                                      struct ci_hw_req, queue);
 638
 639                 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
 640                         dma_pool_free(hwep->td_pool, node->ptr, node->dma);
 641                         list_del_init(&node->td);
 642                         node->ptr = NULL;
 643                         kfree(node);
 644                 }
 645
 646                 list_del_init(&hwreq->queue);
 647                 hwreq->req.status = -ESHUTDOWN;
 648
 649                 if (hwreq->req.complete != NULL) {
 650                         spin_unlock(hwep->lock);
 651                         hwreq->req.complete(&hwep->ep, &hwreq->req);
 652                         spin_lock(hwep->lock);
 653                 }
 654         }
 655
 656         if (hwep->pending_td)
 657                 free_pending_td(hwep);
 658
 659         return 0;
 660 }
 661
 662 /**
 663  * _gadget_stop_activity: stops all USB activity, flushes & disables all endpts
 664  * @gadget: gadget
 665  *
 666  * This function returns an error code
 667  */
 668 static int _gadget_stop_activity(struct usb_gadget *gadget)
 669 {
 670         struct usb_ep *ep;
 671         struct ci_hdrc    *ci = container_of(gadget, struct ci_hdrc, gadget);
 672         unsigned long flags;
 673
 674         spin_lock_irqsave(&ci->lock, flags);
 675         ci->gadget.speed = USB_SPEED_UNKNOWN;
 676         ci->remote_wakeup = 0;
 677         ci->suspended = 0;
 678         spin_unlock_irqrestore(&ci->lock, flags);
 679
 680         /* flush all endpoints */
 681         gadget_for_each_ep(ep, gadget) {
 682                 usb_ep_fifo_flush(ep);
 683         }
 684         usb_ep_fifo_flush(&ci->ep0out->ep);
 685         usb_ep_fifo_flush(&ci->ep0in->ep);
 686
 687         if (ci->driver)
 688                 ci->driver->disconnect(gadget);
 689
 690         /* make sure to disable all endpoints */
 691         gadget_for_each_ep(ep, gadget) {
 692                 usb_ep_disable(ep);
 693         }
 694
 695         if (ci->status != NULL) {
 696                 usb_ep_free_request(&ci->ep0in->ep, ci->status);
 697                 ci->status = NULL;
 698         }
 699
 700         return 0;
 701 }
 702
 703 /******************************************************************************
 704  * ISR block
 705  *****************************************************************************/
 706 /**
 707  * isr_reset_handler: USB reset interrupt handler
 708  * @ci: UDC device
 709  *
 710  * This function resets USB engine after a bus reset occurred
 711  */
 712 static void isr_reset_handler(struct ci_hdrc *ci)
 713 __releases(ci->lock)
 714 __acquires(ci->lock)
 715 {
 716         int retval;
 717
 718         spin_unlock(&ci->lock);
 719         retval = _gadget_stop_activity(&ci->gadget);
 720         if (retval)
 721                 goto done;
 722
 723         retval = hw_usb_reset(ci);
 724         if (retval)
 725                 goto done;
 726
 727         ci->status = usb_ep_alloc_request(&ci->ep0in->ep, GFP_ATOMIC);
 728         if (ci->status == NULL)
 729                 retval = -ENOMEM;
 730
 731 done:
 732         spin_lock(&ci->lock);
 733
 734         if (retval)
 735                 dev_err(ci->dev, "error: %i\n", retval);
 736 }
 737
 738 /**
 739  * isr_get_status_complete: get_status request complete function
 740  * @ep:  endpoint
 741  * @req: request handled
 742  *
 743  * Caller must release lock
 744  */
 745 static void isr_get_status_complete(struct usb_ep *ep, struct usb_request *req)
 746 {
 747         if (ep == NULL || req == NULL)
 748                 return;
 749
 750         kfree(req->buf);
 751         usb_ep_free_request(ep, req);
 752 }
 753
 754 /**
 755  * _ep_queue: queues (submits) an I/O request to an endpoint
 756  *
 757  * Caller must hold lock
 758  */
 759 static int _ep_queue(struct usb_ep *ep, struct usb_request *req,
 760                     gfp_t __maybe_unused gfp_flags)
 761 {
 762         struct ci_hw_ep  *hwep  = container_of(ep,  struct ci_hw_ep, ep);
 763         struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
 764         struct ci_hdrc *ci = hwep->ci;
 765         int retval = 0;
 766
 767         if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
 768                 return -EINVAL;
 769
 770         if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
 771                 if (req->length)
 772                         hwep = (ci->ep0_dir == RX) ?
 773                                ci->ep0out : ci->ep0in;
 774                 if (!list_empty(&hwep->qh.queue)) {
 775                         _ep_nuke(hwep);
 776                         retval = -EOVERFLOW;
 777                         dev_warn(hwep->ci->dev, "endpoint ctrl %X nuked\n",
 778                                  _usb_addr(hwep));
 779                 }
 780         }
 781
 782         if (usb_endpoint_xfer_isoc(hwep->ep.desc) &&
 783             hwreq->req.length > (1 + hwep->ep.mult) * hwep->ep.maxpacket) {
 784                 dev_err(hwep->ci->dev, "request length too big for isochronous\n");
 785                 return -EMSGSIZE;
 786         }
 787
 788         /* first nuke then test link, e.g. previous status has not sent */
 789         if (!list_empty(&hwreq->queue)) {
 790                 dev_err(hwep->ci->dev, "request already in queue\n");
 791                 return -EBUSY;
 792         }
 793
 794         /* push request */
 795         hwreq->req.status = -EINPROGRESS;
 796         hwreq->req.actual = 0;
 797
 798         retval = _hardware_enqueue(hwep, hwreq);
 799
 800         if (retval == -EALREADY)
 801                 retval = 0;
 802         if (!retval)
 803                 list_add_tail(&hwreq->queue, &hwep->qh.queue);
 804
 805         return retval;
 806 }
 807
 808 /**
 809  * isr_get_status_response: get_status request response
 810  * @ci: ci struct
 811  * @setup: setup request packet
 812  *
 813  * This function returns an error code
 814  */
 815 static int isr_get_status_response(struct ci_hdrc *ci,
 816                                    struct usb_ctrlrequest *setup)
 817 __releases(hwep->lock)
 818 __acquires(hwep->lock)
 819 {
 820         struct ci_hw_ep *hwep = ci->ep0in;
 821         struct usb_request *req = NULL;
 822         gfp_t gfp_flags = GFP_ATOMIC;
 823         int dir, num, retval;
 824
 825         if (hwep == NULL || setup == NULL)
 826                 return -EINVAL;
 827
 828         spin_unlock(hwep->lock);
 829         req = usb_ep_alloc_request(&hwep->ep, gfp_flags);
 830         spin_lock(hwep->lock);
 831         if (req == NULL)
 832                 return -ENOMEM;
 833
 834         req->complete = isr_get_status_complete;
 835         req->length   = 2;
 836         req->buf      = kzalloc(req->length, gfp_flags);
 837         if (req->buf == NULL) {
 838                 retval = -ENOMEM;
 839                 goto err_free_req;
 840         }
 841
 842         if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
 843                 /* Assume that device is bus powered for now. */
 844                 *(u16 *)req->buf = ci->remote_wakeup << 1;
 845                 retval = 0;
 846         } else if ((setup->bRequestType & USB_RECIP_MASK) \
 847                    == USB_RECIP_ENDPOINT) {
 848                 dir = (le16_to_cpu(setup->wIndex) & USB_ENDPOINT_DIR_MASK) ?
 849                         TX : RX;
 850                 num =  le16_to_cpu(setup->wIndex) & USB_ENDPOINT_NUMBER_MASK;
 851                 *(u16 *)req->buf = hw_ep_get_halt(ci, num, dir);
 852         }
 853         /* else do nothing; reserved for future use */
 854
 855         retval = _ep_queue(&hwep->ep, req, gfp_flags);
 856         if (retval)
 857                 goto err_free_buf;
 858
 859         return 0;
 860
 861  err_free_buf:
 862         kfree(req->buf);
 863  err_free_req:
 864         spin_unlock(hwep->lock);
 865         usb_ep_free_request(&hwep->ep, req);
 866         spin_lock(hwep->lock);
 867         return retval;
 868 }
 869
 870 /**
 871  * isr_setup_status_complete: setup_status request complete function
 872  * @ep:  endpoint
 873  * @req: request handled
 874  *
 875  * Caller must release lock. Put the port in test mode if test mode
 876  * feature is selected.
 877  */
 878 static void
 879 isr_setup_status_complete(struct usb_ep *ep, struct usb_request *req)
 880 {
 881         struct ci_hdrc *ci = req->context;
 882         unsigned long flags;
 883
 884         if (ci->setaddr) {
 885                 hw_usb_set_address(ci, ci->address);
 886                 ci->setaddr = false;
 887         }
 888
 889         spin_lock_irqsave(&ci->lock, flags);
 890         if (ci->test_mode)
 891                 hw_port_test_set(ci, ci->test_mode);
 892         spin_unlock_irqrestore(&ci->lock, flags);
 893 }
 894
 895 /**
 896  * isr_setup_status_phase: queues the status phase of a setup transation
 897  * @ci: ci struct
 898  *
 899  * This function returns an error code
 900  */
 901 static int isr_setup_status_phase(struct ci_hdrc *ci)
 902 {
 903         int retval;
 904         struct ci_hw_ep *hwep;
 905
 906         hwep = (ci->ep0_dir == TX) ? ci->ep0out : ci->ep0in;
 907         ci->status->context = ci;
 908         ci->status->complete = isr_setup_status_complete;
 909
 910         retval = _ep_queue(&hwep->ep, ci->status, GFP_ATOMIC);
 911
 912         return retval;
 913 }
 914
 915 /**
 916  * isr_tr_complete_low: transaction complete low level handler
 917  * @hwep: endpoint
 918  *
 919  * This function returns an error code
 920  * Caller must hold lock
 921  */
 922 static int isr_tr_complete_low(struct ci_hw_ep *hwep)
 923 __releases(hwep->lock)
 924 __acquires(hwep->lock)
 925 {
 926         struct ci_hw_req *hwreq, *hwreqtemp;
 927         struct ci_hw_ep *hweptemp = hwep;
 928         int retval = 0;
 929
 930         list_for_each_entry_safe(hwreq, hwreqtemp, &hwep->qh.queue,
 931                         queue) {
 932                 retval = _hardware_dequeue(hwep, hwreq);
 933                 if (retval < 0)
 934                         break;
 935                 list_del_init(&hwreq->queue);
 936                 if (hwreq->req.complete != NULL) {
 937                         spin_unlock(hwep->lock);
 938                         if ((hwep->type == USB_ENDPOINT_XFER_CONTROL) &&
 939                                         hwreq->req.length)
 940                                 hweptemp = hwep->ci->ep0in;
 941                         hwreq->req.complete(&hweptemp->ep, &hwreq->req);
 942                         spin_lock(hwep->lock);
 943                 }
 944         }
 945
 946         if (retval == -EBUSY)
 947                 retval = 0;
 948
 949         return retval;
 950 }
 951
 952 /**
 953  * isr_tr_complete_handler: transaction complete interrupt handler
 954  * @ci: UDC descriptor
 955  *
 956  * This function handles traffic events
 957  */
 958 static void isr_tr_complete_handler(struct ci_hdrc *ci)
 959 __releases(ci->lock)
 960 __acquires(ci->lock)
 961 {
 962         unsigned i;
 963         u8 tmode = 0;
 964
 965         for (i = 0; i < ci->hw_ep_max; i++) {
 966                 struct ci_hw_ep *hwep  = &ci->ci_hw_ep[i];
 967                 int type, num, dir, err = -EINVAL;
 968                 struct usb_ctrlrequest req;
 969
 970                 if (hwep->ep.desc == NULL)
 971                         continue;   /* not configured */
 972
 973                 if (hw_test_and_clear_complete(ci, i)) {
 974                         err = isr_tr_complete_low(hwep);
 975                         if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
 976                                 if (err > 0)   /* needs status phase */
 977                                         err = isr_setup_status_phase(ci);
 978                                 if (err < 0) {
 979                                         spin_unlock(&ci->lock);
 980                                         if (usb_ep_set_halt(&hwep->ep))
 981                                                 dev_err(ci->dev,
 982                                                         "error: ep_set_halt\n");
 983                                         spin_lock(&ci->lock);
 984                                 }
 985                         }
 986                 }
 987
 988                 if (hwep->type != USB_ENDPOINT_XFER_CONTROL ||
 989                     !hw_test_and_clear_setup_status(ci, i))
 990                         continue;
 991
 992                 if (i != 0) {
 993                         dev_warn(ci->dev, "ctrl traffic at endpoint %d\n", i);
 994                         continue;
 995                 }
 996
 997                 /*
 998                  * Flush data and handshake transactions of previous
 999                  * setup packet.
1000                  */
1001                 _ep_nuke(ci->ep0out);
1002                 _ep_nuke(ci->ep0in);
1003
1004                 /* read_setup_packet */
1005                 do {
1006                         hw_test_and_set_setup_guard(ci);
1007                         memcpy(&req, &hwep->qh.ptr->setup, sizeof(req));
1008                 } while (!hw_test_and_clear_setup_guard(ci));
1009
1010                 type = req.bRequestType;
1011
1012                 ci->ep0_dir = (type & USB_DIR_IN) ? TX : RX;
1013
1014                 switch (req.bRequest) {
1015                 case USB_REQ_CLEAR_FEATURE:
1016                         if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1017                                         le16_to_cpu(req.wValue) ==
1018                                         USB_ENDPOINT_HALT) {
1019                                 if (req.wLength != 0)
1020                                         break;
1021                                 num  = le16_to_cpu(req.wIndex);
1022                                 dir = num & USB_ENDPOINT_DIR_MASK;
1023                                 num &= USB_ENDPOINT_NUMBER_MASK;
1024                                 if (dir) /* TX */
1025                                         num += ci->hw_ep_max/2;
1026                                 if (!ci->ci_hw_ep[num].wedge) {
1027                                         spin_unlock(&ci->lock);
1028                                         err = usb_ep_clear_halt(
1029                                                 &ci->ci_hw_ep[num].ep);
1030                                         spin_lock(&ci->lock);
1031                                         if (err)
1032                                                 break;
1033                                 }
1034                                 err = isr_setup_status_phase(ci);
1035                         } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE) &&
1036                                         le16_to_cpu(req.wValue) ==
1037                                         USB_DEVICE_REMOTE_WAKEUP) {
1038                                 if (req.wLength != 0)
1039                                         break;
1040                                 ci->remote_wakeup = 0;
1041                                 err = isr_setup_status_phase(ci);
1042                         } else {
1043                                 goto delegate;
1044                         }
1045                         break;
1046                 case USB_REQ_GET_STATUS:
1047                         if (type != (USB_DIR_IN|USB_RECIP_DEVICE)   &&
1048                             type != (USB_DIR_IN|USB_RECIP_ENDPOINT) &&
1049                             type != (USB_DIR_IN|USB_RECIP_INTERFACE))
1050                                 goto delegate;
1051                         if (le16_to_cpu(req.wLength) != 2 ||
1052                             le16_to_cpu(req.wValue)  != 0)
1053                                 break;
1054                         err = isr_get_status_response(ci, &req);
1055                         break;
1056                 case USB_REQ_SET_ADDRESS:
1057                         if (type != (USB_DIR_OUT|USB_RECIP_DEVICE))
1058                                 goto delegate;
1059                         if (le16_to_cpu(req.wLength) != 0 ||
1060                             le16_to_cpu(req.wIndex)  != 0)
1061                                 break;
1062                         ci->address = (u8)le16_to_cpu(req.wValue);
1063                         ci->setaddr = true;
1064                         err = isr_setup_status_phase(ci);
1065                         break;
1066                 case USB_REQ_SET_FEATURE:
1067                         if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1068                                         le16_to_cpu(req.wValue) ==
1069                                         USB_ENDPOINT_HALT) {
1070                                 if (req.wLength != 0)
1071                                         break;
1072                                 num  = le16_to_cpu(req.wIndex);
1073                                 dir = num & USB_ENDPOINT_DIR_MASK;
1074                                 num &= USB_ENDPOINT_NUMBER_MASK;
1075                                 if (dir) /* TX */
1076                                         num += ci->hw_ep_max/2;
1077
1078                                 spin_unlock(&ci->lock);
1079                                 err = usb_ep_set_halt(&ci->ci_hw_ep[num].ep);
1080                                 spin_lock(&ci->lock);
1081                                 if (!err)
1082                                         isr_setup_status_phase(ci);
1083                         } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE)) {
1084                                 if (req.wLength != 0)
1085                                         break;
1086                                 switch (le16_to_cpu(req.wValue)) {
1087                                 case USB_DEVICE_REMOTE_WAKEUP:
1088                                         ci->remote_wakeup = 1;
1089                                         err = isr_setup_status_phase(ci);
1090                                         break;
1091                                 case USB_DEVICE_TEST_MODE:
1092                                         tmode = le16_to_cpu(req.wIndex) >> 8;
1093                                         switch (tmode) {
1094                                         case TEST_J:
1095                                         case TEST_K:
1096                                         case TEST_SE0_NAK:
1097                                         case TEST_PACKET:
1098                                         case TEST_FORCE_EN:
1099                                                 ci->test_mode = tmode;
1100                                                 err = isr_setup_status_phase(
1101                                                                 ci);
1102                                                 break;
1103                                         default:
1104                                                 break;
1105                                         }
1106                                 default:
1107                                         goto delegate;
1108                                 }
1109                         } else {
1110                                 goto delegate;
1111                         }
1112                         break;
1113                 default:
1114 delegate:
1115                         if (req.wLength == 0)   /* no data phase */
1116                                 ci->ep0_dir = TX;
1117
1118                         spin_unlock(&ci->lock);
1119                         err = ci->driver->setup(&ci->gadget, &req);
1120                         spin_lock(&ci->lock);
1121                         break;
1122                 }
1123
1124                 if (err < 0) {
1125                         spin_unlock(&ci->lock);
1126                         if (usb_ep_set_halt(&hwep->ep))
1127                                 dev_err(ci->dev, "error: ep_set_halt\n");
1128                         spin_lock(&ci->lock);
1129                 }
1130         }
1131 }
1132
1133 /******************************************************************************
1134  * ENDPT block
1135  *****************************************************************************/
1136 /**
1137  * ep_enable: configure endpoint, making it usable
1138  *
1139  * Check usb_ep_enable() at "usb_gadget.h" for details
1140  */
1141 static int ep_enable(struct usb_ep *ep,
1142                      const struct usb_endpoint_descriptor *desc)
1143 {
1144         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1145         int retval = 0;
1146         unsigned long flags;
1147         u32 cap = 0;
1148
1149         if (ep == NULL || desc == NULL)
1150                 return -EINVAL;
1151
1152         spin_lock_irqsave(hwep->lock, flags);
1153
1154         /* only internal SW should enable ctrl endpts */
1155
1156         hwep->ep.desc = desc;
1157
1158         if (!list_empty(&hwep->qh.queue))
1159                 dev_warn(hwep->ci->dev, "enabling a non-empty endpoint!\n");
1160
1161         hwep->dir  = usb_endpoint_dir_in(desc) ? TX : RX;
1162         hwep->num  = usb_endpoint_num(desc);
1163         hwep->type = usb_endpoint_type(desc);
1164
1165         hwep->ep.maxpacket = usb_endpoint_maxp(desc) & 0x07ff;
1166         hwep->ep.mult = QH_ISO_MULT(usb_endpoint_maxp(desc));
1167
1168         if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1169                 cap |= QH_IOS;
1170         if (hwep->num)
1171                 cap |= QH_ZLT;
1172         cap |= (hwep->ep.maxpacket << __ffs(QH_MAX_PKT)) & QH_MAX_PKT;
1173
1174         hwep->qh.ptr->cap = cpu_to_le32(cap);
1175
1176         hwep->qh.ptr->td.next |= cpu_to_le32(TD_TERMINATE);   /* needed? */
1177
1178         /*
1179          * Enable endpoints in the HW other than ep0 as ep0
1180          * is always enabled
1181          */
1182         if (hwep->num)
1183                 retval |= hw_ep_enable(hwep->ci, hwep->num, hwep->dir,
1184                                        hwep->type);
1185
1186         spin_unlock_irqrestore(hwep->lock, flags);
1187         return retval;
1188 }
1189
1190 /**
1191  * ep_disable: endpoint is no longer usable
1192  *
1193  * Check usb_ep_disable() at "usb_gadget.h" for details
1194  */
1195 static int ep_disable(struct usb_ep *ep)
1196 {
1197         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1198         int direction, retval = 0;
1199         unsigned long flags;
1200
1201         if (ep == NULL)
1202                 return -EINVAL;
1203         else if (hwep->ep.desc == NULL)
1204                 return -EBUSY;
1205
1206         spin_lock_irqsave(hwep->lock, flags);
1207
1208         /* only internal SW should disable ctrl endpts */
1209
1210         direction = hwep->dir;
1211         do {
1212                 retval |= _ep_nuke(hwep);
1213                 retval |= hw_ep_disable(hwep->ci, hwep->num, hwep->dir);
1214
1215                 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1216                         hwep->dir = (hwep->dir == TX) ? RX : TX;
1217
1218         } while (hwep->dir != direction);
1219
1220         hwep->ep.desc = NULL;
1221
1222         spin_unlock_irqrestore(hwep->lock, flags);
1223         return retval;
1224 }
1225
1226 /**
1227  * ep_alloc_request: allocate a request object to use with this endpoint
1228  *
1229  * Check usb_ep_alloc_request() at "usb_gadget.h" for details
1230  */
1231 static struct usb_request *ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
1232 {
1233         struct ci_hw_req *hwreq = NULL;
1234
1235         if (ep == NULL)
1236                 return NULL;
1237
1238         hwreq = kzalloc(sizeof(struct ci_hw_req), gfp_flags);
1239         if (hwreq != NULL) {
1240                 INIT_LIST_HEAD(&hwreq->queue);
1241                 INIT_LIST_HEAD(&hwreq->tds);
1242         }
1243
1244         return (hwreq == NULL) ? NULL : &hwreq->req;
1245 }
1246
1247 /**
1248  * ep_free_request: frees a request object
1249  *
1250  * Check usb_ep_free_request() at "usb_gadget.h" for details
1251  */
1252 static void ep_free_request(struct usb_ep *ep, struct usb_request *req)
1253 {
1254         struct ci_hw_ep  *hwep  = container_of(ep,  struct ci_hw_ep, ep);
1255         struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1256         struct td_node *node, *tmpnode;
1257         unsigned long flags;
1258
1259         if (ep == NULL || req == NULL) {
1260                 return;
1261         } else if (!list_empty(&hwreq->queue)) {
1262                 dev_err(hwep->ci->dev, "freeing queued request\n");
1263                 return;
1264         }
1265
1266         spin_lock_irqsave(hwep->lock, flags);
1267
1268         list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1269                 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1270                 list_del_init(&node->td);
1271                 node->ptr = NULL;
1272                 kfree(node);
1273         }
1274
1275         kfree(hwreq);
1276
1277         spin_unlock_irqrestore(hwep->lock, flags);
1278 }
1279
1280 /**
1281  * ep_queue: queues (submits) an I/O request to an endpoint
1282  *
1283  * Check usb_ep_queue()* at usb_gadget.h" for details
1284  */
1285 static int ep_queue(struct usb_ep *ep, struct usb_request *req,
1286                     gfp_t __maybe_unused gfp_flags)
1287 {
1288         struct ci_hw_ep  *hwep  = container_of(ep,  struct ci_hw_ep, ep);
1289         int retval = 0;
1290         unsigned long flags;
1291
1292         if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
1293                 return -EINVAL;
1294
1295         spin_lock_irqsave(hwep->lock, flags);
1296         retval = _ep_queue(ep, req, gfp_flags);
1297         spin_unlock_irqrestore(hwep->lock, flags);
1298         return retval;
1299 }
1300
1301 /**
1302  * ep_dequeue: dequeues (cancels, unlinks) an I/O request from an endpoint
1303  *
1304  * Check usb_ep_dequeue() at "usb_gadget.h" for details
1305  */
1306 static int ep_dequeue(struct usb_ep *ep, struct usb_request *req)
1307 {
1308         struct ci_hw_ep  *hwep  = container_of(ep,  struct ci_hw_ep, ep);
1309         struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1310         unsigned long flags;
1311
1312         if (ep == NULL || req == NULL || hwreq->req.status != -EALREADY ||
1313                 hwep->ep.desc == NULL || list_empty(&hwreq->queue) ||
1314                 list_empty(&hwep->qh.queue))
1315                 return -EINVAL;
1316
1317         spin_lock_irqsave(hwep->lock, flags);
1318
1319         hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1320
1321         /* pop request */
1322         list_del_init(&hwreq->queue);
1323
1324         usb_gadget_unmap_request(&hwep->ci->gadget, req, hwep->dir);
1325
1326         req->status = -ECONNRESET;
1327
1328         if (hwreq->req.complete != NULL) {
1329                 spin_unlock(hwep->lock);
1330                 hwreq->req.complete(&hwep->ep, &hwreq->req);
1331                 spin_lock(hwep->lock);
1332         }
1333
1334         spin_unlock_irqrestore(hwep->lock, flags);
1335         return 0;
1336 }
1337
1338 /**
1339  * ep_set_halt: sets the endpoint halt feature
1340  *
1341  * Check usb_ep_set_halt() at "usb_gadget.h" for details
1342  */
1343 static int ep_set_halt(struct usb_ep *ep, int value)
1344 {
1345         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1346         int direction, retval = 0;
1347         unsigned long flags;
1348
1349         if (ep == NULL || hwep->ep.desc == NULL)
1350                 return -EINVAL;
1351
1352         if (usb_endpoint_xfer_isoc(hwep->ep.desc))
1353                 return -EOPNOTSUPP;
1354
1355         spin_lock_irqsave(hwep->lock, flags);
1356
1357 #ifndef STALL_IN
1358         /* g_file_storage MS compliant but g_zero fails chapter 9 compliance */
1359         if (value && hwep->type == USB_ENDPOINT_XFER_BULK && hwep->dir == TX &&
1360             !list_empty(&hwep->qh.queue)) {
1361                 spin_unlock_irqrestore(hwep->lock, flags);
1362                 return -EAGAIN;
1363         }
1364 #endif
1365
1366         direction = hwep->dir;
1367         do {
1368                 retval |= hw_ep_set_halt(hwep->ci, hwep->num, hwep->dir, value);
1369
1370                 if (!value)
1371                         hwep->wedge = 0;
1372
1373                 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1374                         hwep->dir = (hwep->dir == TX) ? RX : TX;
1375
1376         } while (hwep->dir != direction);
1377
1378         spin_unlock_irqrestore(hwep->lock, flags);
1379         return retval;
1380 }
1381
1382 /**
1383  * ep_set_wedge: sets the halt feature and ignores clear requests
1384  *
1385  * Check usb_ep_set_wedge() at "usb_gadget.h" for details
1386  */
1387 static int ep_set_wedge(struct usb_ep *ep)
1388 {
1389         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1390         unsigned long flags;
1391
1392         if (ep == NULL || hwep->ep.desc == NULL)
1393                 return -EINVAL;
1394
1395         spin_lock_irqsave(hwep->lock, flags);
1396         hwep->wedge = 1;
1397         spin_unlock_irqrestore(hwep->lock, flags);
1398
1399         return usb_ep_set_halt(ep);
1400 }
1401
1402 /**
1403  * ep_fifo_flush: flushes contents of a fifo
1404  *
1405  * Check usb_ep_fifo_flush() at "usb_gadget.h" for details
1406  */
1407 static void ep_fifo_flush(struct usb_ep *ep)
1408 {
1409         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1410         unsigned long flags;
1411
1412         if (ep == NULL) {
1413                 dev_err(hwep->ci->dev, "%02X: -EINVAL\n", _usb_addr(hwep));
1414                 return;
1415         }
1416
1417         spin_lock_irqsave(hwep->lock, flags);
1418
1419         hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1420
1421         spin_unlock_irqrestore(hwep->lock, flags);
1422 }
1423
1424 /**
1425  * Endpoint-specific part of the API to the USB controller hardware
1426  * Check "usb_gadget.h" for details
1427  */
1428 static const struct usb_ep_ops usb_ep_ops = {
1429         .enable        = ep_enable,
1430         .disable       = ep_disable,
1431         .alloc_request = ep_alloc_request,
1432         .free_request  = ep_free_request,
1433         .queue         = ep_queue,
1434         .dequeue       = ep_dequeue,
1435         .set_halt      = ep_set_halt,
1436         .set_wedge     = ep_set_wedge,
1437         .fifo_flush    = ep_fifo_flush,
1438 };
1439
1440 /******************************************************************************
1441  * GADGET block
1442  *****************************************************************************/
1443 static int ci_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1444 {
1445         struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1446         unsigned long flags;
1447         int gadget_ready = 0;
1448
1449         if (!(ci->platdata->flags & CI_HDRC_PULLUP_ON_VBUS))
1450                 return -EOPNOTSUPP;
1451
1452         spin_lock_irqsave(&ci->lock, flags);
1453         ci->vbus_active = is_active;
1454         if (ci->driver)
1455                 gadget_ready = 1;
1456         spin_unlock_irqrestore(&ci->lock, flags);
1457
1458         if (gadget_ready) {
1459                 if (is_active) {
1460                         pm_runtime_get_sync(&_gadget->dev);
1461                         hw_device_reset(ci, USBMODE_CM_DC);
1462                         hw_device_state(ci, ci->ep0out->qh.dma);
1463                 } else {
1464                         hw_device_state(ci, 0);
1465                         if (ci->platdata->notify_event)
1466                                 ci->platdata->notify_event(ci,
1467                                 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1468                         _gadget_stop_activity(&ci->gadget);
1469                         pm_runtime_put_sync(&_gadget->dev);
1470                 }
1471         }
1472
1473         return 0;
1474 }
1475
1476 static int ci_udc_wakeup(struct usb_gadget *_gadget)
1477 {
1478         struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1479         unsigned long flags;
1480         int ret = 0;
1481
1482         spin_lock_irqsave(&ci->lock, flags);
1483         if (!ci->remote_wakeup) {
1484                 ret = -EOPNOTSUPP;
1485                 goto out;
1486         }
1487         if (!hw_read(ci, OP_PORTSC, PORTSC_SUSP)) {
1488                 ret = -EINVAL;
1489                 goto out;
1490         }
1491         hw_write(ci, OP_PORTSC, PORTSC_FPR, PORTSC_FPR);
1492 out:
1493         spin_unlock_irqrestore(&ci->lock, flags);
1494         return ret;
1495 }
1496
1497 static int ci_udc_vbus_draw(struct usb_gadget *_gadget, unsigned ma)
1498 {
1499         struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1500
1501         if (ci->transceiver)
1502                 return usb_phy_set_power(ci->transceiver, ma);
1503         return -ENOTSUPP;
1504 }
1505
1506 /* Change Data+ pullup status
1507  * this func is used by usb_gadget_connect/disconnet
1508  */
1509 static int ci_udc_pullup(struct usb_gadget *_gadget, int is_on)
1510 {
1511         struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1512
1513         if (is_on)
1514                 hw_write(ci, OP_USBCMD, USBCMD_RS, USBCMD_RS);
1515         else
1516                 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
1517
1518         return 0;
1519 }
1520
1521 static int ci_udc_start(struct usb_gadget *gadget,
1522                          struct usb_gadget_driver *driver);
1523 static int ci_udc_stop(struct usb_gadget *gadget,
1524                         struct usb_gadget_driver *driver);
1525 /**
1526  * Device operations part of the API to the USB controller hardware,
1527  * which don't involve endpoints (or i/o)
1528  * Check  "usb_gadget.h" for details
1529  */
1530 static const struct usb_gadget_ops usb_gadget_ops = {
1531         .vbus_session   = ci_udc_vbus_session,
1532         .wakeup         = ci_udc_wakeup,
1533         .pullup         = ci_udc_pullup,
1534         .vbus_draw      = ci_udc_vbus_draw,
1535         .udc_start      = ci_udc_start,
1536         .udc_stop       = ci_udc_stop,
1537 };
1538
1539 static int init_eps(struct ci_hdrc *ci)
1540 {
1541         int retval = 0, i, j;
1542
1543         for (i = 0; i < ci->hw_ep_max/2; i++)
1544                 for (j = RX; j <= TX; j++) {
1545                         int k = i + j * ci->hw_ep_max/2;
1546                         struct ci_hw_ep *hwep = &ci->ci_hw_ep[k];
1547
1548                         scnprintf(hwep->name, sizeof(hwep->name), "ep%i%s", i,
1549                                         (j == TX)  ? "in" : "out");
1550
1551                         hwep->ci          = ci;
1552                         hwep->lock         = &ci->lock;
1553                         hwep->td_pool      = ci->td_pool;
1554
1555                         hwep->ep.name      = hwep->name;
1556                         hwep->ep.ops       = &usb_ep_ops;
1557                         /*
1558                          * for ep0: maxP defined in desc, for other
1559                          * eps, maxP is set by epautoconfig() called
1560                          * by gadget layer
1561                          */
1562                         hwep->ep.maxpacket = (unsigned short)~0;
1563
1564                         INIT_LIST_HEAD(&hwep->qh.queue);
1565                         hwep->qh.ptr = dma_pool_alloc(ci->qh_pool, GFP_KERNEL,
1566                                                      &hwep->qh.dma);
1567                         if (hwep->qh.ptr == NULL)
1568                                 retval = -ENOMEM;
1569                         else
1570                                 memset(hwep->qh.ptr, 0, sizeof(*hwep->qh.ptr));
1571
1572                         /*
1573                          * set up shorthands for ep0 out and in endpoints,
1574                          * don't add to gadget's ep_list
1575                          */
1576                         if (i == 0) {
1577                                 if (j == RX)
1578                                         ci->ep0out = hwep;
1579                                 else
1580                                         ci->ep0in = hwep;
1581
1582                                 hwep->ep.maxpacket = CTRL_PAYLOAD_MAX;
1583                                 continue;
1584                         }
1585
1586                         list_add_tail(&hwep->ep.ep_list, &ci->gadget.ep_list);
1587                 }
1588
1589         return retval;
1590 }
1591
1592 static void destroy_eps(struct ci_hdrc *ci)
1593 {
1594         int i;
1595
1596         for (i = 0; i < ci->hw_ep_max; i++) {
1597                 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1598
1599                 dma_pool_free(ci->qh_pool, hwep->qh.ptr, hwep->qh.dma);
1600         }
1601 }
1602
1603 /**
1604  * ci_udc_start: register a gadget driver
1605  * @gadget: our gadget
1606  * @driver: the driver being registered
1607  *
1608  * Interrupts are enabled here.
1609  */
1610 static int ci_udc_start(struct usb_gadget *gadget,
1611                          struct usb_gadget_driver *driver)
1612 {
1613         struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1614         unsigned long flags;
1615         int retval = -ENOMEM;
1616
1617         if (driver->disconnect == NULL)
1618                 return -EINVAL;
1619
1620
1621         ci->ep0out->ep.desc = &ctrl_endpt_out_desc;
1622         retval = usb_ep_enable(&ci->ep0out->ep);
1623         if (retval)
1624                 return retval;
1625
1626         ci->ep0in->ep.desc = &ctrl_endpt_in_desc;
1627         retval = usb_ep_enable(&ci->ep0in->ep);
1628         if (retval)
1629                 return retval;
1630         spin_lock_irqsave(&ci->lock, flags);
1631
1632         ci->driver = driver;
1633         pm_runtime_get_sync(&ci->gadget.dev);
1634         if (ci->platdata->flags & CI_HDRC_PULLUP_ON_VBUS) {
1635                 if (ci->vbus_active) {
1636                         if (ci->platdata->flags & CI_HDRC_REGS_SHARED)
1637                                 hw_device_reset(ci, USBMODE_CM_DC);
1638                 } else {
1639                         pm_runtime_put_sync(&ci->gadget.dev);
1640                         goto done;
1641                 }
1642         }
1643
1644         retval = hw_device_state(ci, ci->ep0out->qh.dma);
1645         if (retval)
1646                 pm_runtime_put_sync(&ci->gadget.dev);
1647
1648  done:
1649         spin_unlock_irqrestore(&ci->lock, flags);
1650         return retval;
1651 }
1652
1653 /**
1654  * ci_udc_stop: unregister a gadget driver
1655  */
1656 static int ci_udc_stop(struct usb_gadget *gadget,
1657                         struct usb_gadget_driver *driver)
1658 {
1659         struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1660         unsigned long flags;
1661
1662         spin_lock_irqsave(&ci->lock, flags);
1663
1664         if (!(ci->platdata->flags & CI_HDRC_PULLUP_ON_VBUS) ||
1665                         ci->vbus_active) {
1666                 hw_device_state(ci, 0);
1667                 if (ci->platdata->notify_event)
1668                         ci->platdata->notify_event(ci,
1669                         CI_HDRC_CONTROLLER_STOPPED_EVENT);
1670                 ci->driver = NULL;
1671                 spin_unlock_irqrestore(&ci->lock, flags);
1672                 _gadget_stop_activity(&ci->gadget);
1673                 spin_lock_irqsave(&ci->lock, flags);
1674                 pm_runtime_put(&ci->gadget.dev);
1675         }
1676
1677         spin_unlock_irqrestore(&ci->lock, flags);
1678
1679         return 0;
1680 }
1681
1682 /******************************************************************************
1683  * BUS block
1684  *****************************************************************************/
1685 /**
1686  * udc_irq: ci interrupt handler
1687  *
1688  * This function returns IRQ_HANDLED if the IRQ has been handled
1689  * It locks access to registers
1690  */
1691 static irqreturn_t udc_irq(struct ci_hdrc *ci)
1692 {
1693         irqreturn_t retval;
1694         u32 intr;
1695
1696         if (ci == NULL)
1697                 return IRQ_HANDLED;
1698
1699         spin_lock(&ci->lock);
1700
1701         if (ci->platdata->flags & CI_HDRC_REGS_SHARED) {
1702                 if (hw_read(ci, OP_USBMODE, USBMODE_CM) !=
1703                                 USBMODE_CM_DC) {
1704                         spin_unlock(&ci->lock);
1705                         return IRQ_NONE;
1706                 }
1707         }
1708         intr = hw_test_and_clear_intr_active(ci);
1709
1710         if (intr) {
1711                 /* order defines priority - do NOT change it */
1712                 if (USBi_URI & intr)
1713                         isr_reset_handler(ci);
1714
1715                 if (USBi_PCI & intr) {
1716                         ci->gadget.speed = hw_port_is_high_speed(ci) ?
1717                                 USB_SPEED_HIGH : USB_SPEED_FULL;
1718                         if (ci->suspended && ci->driver->resume) {
1719                                 spin_unlock(&ci->lock);
1720                                 ci->driver->resume(&ci->gadget);
1721                                 spin_lock(&ci->lock);
1722                                 ci->suspended = 0;
1723                         }
1724                 }
1725
1726                 if (USBi_UI  & intr)
1727                         isr_tr_complete_handler(ci);
1728
1729                 if (USBi_SLI & intr) {
1730                         if (ci->gadget.speed != USB_SPEED_UNKNOWN &&
1731                             ci->driver->suspend) {
1732                                 ci->suspended = 1;
1733                                 spin_unlock(&ci->lock);
1734                                 ci->driver->suspend(&ci->gadget);
1735                                 spin_lock(&ci->lock);
1736                         }
1737                 }
1738                 retval = IRQ_HANDLED;
1739         } else {
1740                 retval = IRQ_NONE;
1741         }
1742         spin_unlock(&ci->lock);
1743
1744         return retval;
1745 }
1746
1747 /**
1748  * udc_start: initialize gadget role
1749  * @ci: chipidea controller
1750  */
1751 static int udc_start(struct ci_hdrc *ci)
1752 {
1753         struct device *dev = ci->dev;
1754         int retval = 0;
1755
1756         spin_lock_init(&ci->lock);
1757
1758         ci->gadget.ops          = &usb_gadget_ops;
1759         ci->gadget.speed        = USB_SPEED_UNKNOWN;
1760         ci->gadget.max_speed    = USB_SPEED_HIGH;
1761         ci->gadget.is_otg       = 0;
1762         ci->gadget.name         = ci->platdata->name;
1763
1764         INIT_LIST_HEAD(&ci->gadget.ep_list);
1765
1766         /* alloc resources */
1767         ci->qh_pool = dma_pool_create("ci_hw_qh", dev,
1768                                        sizeof(struct ci_hw_qh),
1769                                        64, CI_HDRC_PAGE_SIZE);
1770         if (ci->qh_pool == NULL)
1771                 return -ENOMEM;
1772
1773         ci->td_pool = dma_pool_create("ci_hw_td", dev,
1774                                        sizeof(struct ci_hw_td),
1775                                        64, CI_HDRC_PAGE_SIZE);
1776         if (ci->td_pool == NULL) {
1777                 retval = -ENOMEM;
1778                 goto free_qh_pool;
1779         }
1780
1781         retval = init_eps(ci);
1782         if (retval)
1783                 goto free_pools;
1784
1785         ci->gadget.ep0 = &ci->ep0in->ep;
1786
1787         if (ci->global_phy) {
1788                 ci->transceiver = usb_get_phy(USB_PHY_TYPE_USB2);
1789                 if (IS_ERR(ci->transceiver))
1790                         ci->transceiver = NULL;
1791         }
1792
1793         if (ci->platdata->flags & CI_HDRC_REQUIRE_TRANSCEIVER) {
1794                 if (ci->transceiver == NULL) {
1795                         retval = -ENODEV;
1796                         goto destroy_eps;
1797                 }
1798         }
1799
1800         if (!(ci->platdata->flags & CI_HDRC_REGS_SHARED)) {
1801                 retval = hw_device_reset(ci, USBMODE_CM_DC);
1802                 if (retval)
1803                         goto put_transceiver;
1804         }
1805
1806         if (ci->transceiver) {
1807                 retval = otg_set_peripheral(ci->transceiver->otg,
1808                                                 &ci->gadget);
1809                 /*
1810                  * If we implement all USB functions using chipidea drivers,
1811                  * it doesn't need to call above API, meanwhile, if we only
1812                  * use gadget function, calling above API is useless.
1813                  */
1814                 if (retval && retval != -ENOTSUPP)
1815                         goto put_transceiver;
1816         }
1817
1818         retval = usb_add_gadget_udc(dev, &ci->gadget);
1819         if (retval)
1820                 goto remove_trans;
1821
1822         pm_runtime_no_callbacks(&ci->gadget.dev);
1823         pm_runtime_enable(&ci->gadget.dev);
1824
1825         return retval;
1826
1827 remove_trans:
1828         if (ci->transceiver) {
1829                 otg_set_peripheral(ci->transceiver->otg, NULL);
1830                 if (ci->global_phy)
1831                         usb_put_phy(ci->transceiver);
1832         }
1833
1834         dev_err(dev, "error = %i\n", retval);
1835 put_transceiver:
1836         if (ci->transceiver && ci->global_phy)
1837                 usb_put_phy(ci->transceiver);
1838 destroy_eps:
1839         destroy_eps(ci);
1840 free_pools:
1841         dma_pool_destroy(ci->td_pool);
1842 free_qh_pool:
1843         dma_pool_destroy(ci->qh_pool);
1844         return retval;
1845 }
1846
1847 /**
1848  * ci_hdrc_gadget_destroy: parent remove must call this to remove UDC
1849  *
1850  * No interrupts active, the IRQ has been released
1851  */
1852 void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
1853 {
1854         if (!ci->roles[CI_ROLE_GADGET])
1855                 return;
1856
1857         usb_del_gadget_udc(&ci->gadget);
1858
1859         destroy_eps(ci);
1860
1861         dma_pool_destroy(ci->td_pool);
1862         dma_pool_destroy(ci->qh_pool);
1863
1864         if (ci->transceiver) {
1865                 otg_set_peripheral(ci->transceiver->otg, NULL);
1866                 if (ci->global_phy)
1867                         usb_put_phy(ci->transceiver);
1868         }
1869 }
1870
1871 static int udc_id_switch_for_device(struct ci_hdrc *ci)
1872 {
1873         if (ci->is_otg) {
1874                 ci_clear_otg_interrupt(ci, OTGSC_BSVIS);
1875                 ci_enable_otg_interrupt(ci, OTGSC_BSVIE);
1876         }
1877
1878         return 0;
1879 }
1880
1881 static void udc_id_switch_for_host(struct ci_hdrc *ci)
1882 {
1883         if (ci->is_otg) {
1884                 /* host doesn't care B_SESSION_VALID event */
1885                 ci_clear_otg_interrupt(ci, OTGSC_BSVIS);
1886                 ci_disable_otg_interrupt(ci, OTGSC_BSVIE);
1887         }
1888 }
1889
1890 /**
1891  * ci_hdrc_gadget_init - initialize device related bits
1892  * ci: the controller
1893  *
1894  * This function initializes the gadget, if the device is "device capable".
1895  */
1896 int ci_hdrc_gadget_init(struct ci_hdrc *ci)
1897 {
1898         struct ci_role_driver *rdrv;
1899
1900         if (!hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DC))
1901                 return -ENXIO;
1902
1903         rdrv = devm_kzalloc(ci->dev, sizeof(struct ci_role_driver), GFP_KERNEL);
1904         if (!rdrv)
1905                 return -ENOMEM;
1906
1907         rdrv->start     = udc_id_switch_for_device;
1908         rdrv->stop      = udc_id_switch_for_host;
1909         rdrv->irq       = udc_irq;
1910         rdrv->name      = "gadget";
1911         ci->roles[CI_ROLE_GADGET] = rdrv;
1912
1913         return udc_start(ci);
1914 }