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