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         /* make sure to disable all endpoints */
 667         gadget_for_each_ep(ep, gadget) {
 668                 usb_ep_disable(ep);
 669         }
 670
 671         if (ci->status != NULL) {
 672                 usb_ep_free_request(&ci->ep0in->ep, ci->status);
 673                 ci->status = NULL;
 674         }
 675
 676         return 0;
 677 }
 678
 679 /******************************************************************************
 680  * ISR block
 681  *****************************************************************************/
 682 /**
 683  * isr_reset_handler: USB reset interrupt handler
 684  * @ci: UDC device
 685  *
 686  * This function resets USB engine after a bus reset occurred
 687  */
 688 static void isr_reset_handler(struct ci_hdrc *ci)
 689 __releases(ci->lock)
 690 __acquires(ci->lock)
 691 {
 692         int retval;
 693
 694         if (ci->gadget.speed != USB_SPEED_UNKNOWN) {
 695                 if (ci->driver)
 696                         ci->driver->disconnect(&ci->gadget);
 697         }
 698
 699         spin_unlock(&ci->lock);
 700         if (ci->gadget.speed != USB_SPEED_UNKNOWN) {
 701                 if (ci->driver)
 702                         ci->driver->disconnect(&ci->gadget);
 703         }
 704
 705         retval = _gadget_stop_activity(&ci->gadget);
 706         if (retval)
 707                 goto done;
 708
 709         retval = hw_usb_reset(ci);
 710         if (retval)
 711                 goto done;
 712
 713         ci->status = usb_ep_alloc_request(&ci->ep0in->ep, GFP_ATOMIC);
 714         if (ci->status == NULL)
 715                 retval = -ENOMEM;
 716
 717         usb_gadget_set_state(&ci->gadget, USB_STATE_DEFAULT);
 718
 719 done:
 720         spin_lock(&ci->lock);
 721
 722         if (retval)
 723                 dev_err(ci->dev, "error: %i\n", retval);
 724 }
 725
 726 /**
 727  * isr_get_status_complete: get_status request complete function
 728  * @ep:  endpoint
 729  * @req: request handled
 730  *
 731  * Caller must release lock
 732  */
 733 static void isr_get_status_complete(struct usb_ep *ep, struct usb_request *req)
 734 {
 735         if (ep == NULL || req == NULL)
 736                 return;
 737
 738         kfree(req->buf);
 739         usb_ep_free_request(ep, req);
 740 }
 741
 742 /**
 743  * _ep_queue: queues (submits) an I/O request to an endpoint
 744  *
 745  * Caller must hold lock
 746  */
 747 static int _ep_queue(struct usb_ep *ep, struct usb_request *req,
 748                     gfp_t __maybe_unused gfp_flags)
 749 {
 750         struct ci_hw_ep  *hwep  = container_of(ep,  struct ci_hw_ep, ep);
 751         struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
 752         struct ci_hdrc *ci = hwep->ci;
 753         int retval = 0;
 754
 755         if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
 756                 return -EINVAL;
 757
 758         if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
 759                 if (req->length)
 760                         hwep = (ci->ep0_dir == RX) ?
 761                                ci->ep0out : ci->ep0in;
 762                 if (!list_empty(&hwep->qh.queue)) {
 763                         _ep_nuke(hwep);
 764                         retval = -EOVERFLOW;
 765                         dev_warn(hwep->ci->dev, "endpoint ctrl %X nuked\n",
 766                                  _usb_addr(hwep));
 767                 }
 768         }
 769
 770         if (usb_endpoint_xfer_isoc(hwep->ep.desc) &&
 771             hwreq->req.length > (1 + hwep->ep.mult) * hwep->ep.maxpacket) {
 772                 dev_err(hwep->ci->dev, "request length too big for isochronous\n");
 773                 return -EMSGSIZE;
 774         }
 775
 776         /* first nuke then test link, e.g. previous status has not sent */
 777         if (!list_empty(&hwreq->queue)) {
 778                 dev_err(hwep->ci->dev, "request already in queue\n");
 779                 return -EBUSY;
 780         }
 781
 782         /* push request */
 783         hwreq->req.status = -EINPROGRESS;
 784         hwreq->req.actual = 0;
 785
 786         retval = _hardware_enqueue(hwep, hwreq);
 787
 788         if (retval == -EALREADY)
 789                 retval = 0;
 790         if (!retval)
 791                 list_add_tail(&hwreq->queue, &hwep->qh.queue);
 792
 793         return retval;
 794 }
 795
 796 /**
 797  * isr_get_status_response: get_status request response
 798  * @ci: ci struct
 799  * @setup: setup request packet
 800  *
 801  * This function returns an error code
 802  */
 803 static int isr_get_status_response(struct ci_hdrc *ci,
 804                                    struct usb_ctrlrequest *setup)
 805 __releases(hwep->lock)
 806 __acquires(hwep->lock)
 807 {
 808         struct ci_hw_ep *hwep = ci->ep0in;
 809         struct usb_request *req = NULL;
 810         gfp_t gfp_flags = GFP_ATOMIC;
 811         int dir, num, retval;
 812
 813         if (hwep == NULL || setup == NULL)
 814                 return -EINVAL;
 815
 816         spin_unlock(hwep->lock);
 817         req = usb_ep_alloc_request(&hwep->ep, gfp_flags);
 818         spin_lock(hwep->lock);
 819         if (req == NULL)
 820                 return -ENOMEM;
 821
 822         req->complete = isr_get_status_complete;
 823         req->length   = 2;
 824         req->buf      = kzalloc(req->length, gfp_flags);
 825         if (req->buf == NULL) {
 826                 retval = -ENOMEM;
 827                 goto err_free_req;
 828         }
 829
 830         if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
 831                 /* Assume that device is bus powered for now. */
 832                 *(u16 *)req->buf = ci->remote_wakeup << 1;
 833         } else if ((setup->bRequestType & USB_RECIP_MASK) \
 834                    == USB_RECIP_ENDPOINT) {
 835                 dir = (le16_to_cpu(setup->wIndex) & USB_ENDPOINT_DIR_MASK) ?
 836                         TX : RX;
 837                 num =  le16_to_cpu(setup->wIndex) & USB_ENDPOINT_NUMBER_MASK;
 838                 *(u16 *)req->buf = hw_ep_get_halt(ci, num, dir);
 839         }
 840         /* else do nothing; reserved for future use */
 841
 842         retval = _ep_queue(&hwep->ep, req, gfp_flags);
 843         if (retval)
 844                 goto err_free_buf;
 845
 846         return 0;
 847
 848  err_free_buf:
 849         kfree(req->buf);
 850  err_free_req:
 851         spin_unlock(hwep->lock);
 852         usb_ep_free_request(&hwep->ep, req);
 853         spin_lock(hwep->lock);
 854         return retval;
 855 }
 856
 857 /**
 858  * isr_setup_status_complete: setup_status request complete function
 859  * @ep:  endpoint
 860  * @req: request handled
 861  *
 862  * Caller must release lock. Put the port in test mode if test mode
 863  * feature is selected.
 864  */
 865 static void
 866 isr_setup_status_complete(struct usb_ep *ep, struct usb_request *req)
 867 {
 868         struct ci_hdrc *ci = req->context;
 869         unsigned long flags;
 870
 871         if (ci->setaddr) {
 872                 hw_usb_set_address(ci, ci->address);
 873                 ci->setaddr = false;
 874                 if (ci->address)
 875                         usb_gadget_set_state(&ci->gadget, USB_STATE_ADDRESS);
 876         }
 877
 878         spin_lock_irqsave(&ci->lock, flags);
 879         if (ci->test_mode)
 880                 hw_port_test_set(ci, ci->test_mode);
 881         spin_unlock_irqrestore(&ci->lock, flags);
 882 }
 883
 884 /**
 885  * isr_setup_status_phase: queues the status phase of a setup transation
 886  * @ci: ci struct
 887  *
 888  * This function returns an error code
 889  */
 890 static int isr_setup_status_phase(struct ci_hdrc *ci)
 891 {
 892         int retval;
 893         struct ci_hw_ep *hwep;
 894
 895         hwep = (ci->ep0_dir == TX) ? ci->ep0out : ci->ep0in;
 896         ci->status->context = ci;
 897         ci->status->complete = isr_setup_status_complete;
 898
 899         retval = _ep_queue(&hwep->ep, ci->status, GFP_ATOMIC);
 900
 901         return retval;
 902 }
 903
 904 /**
 905  * isr_tr_complete_low: transaction complete low level handler
 906  * @hwep: endpoint
 907  *
 908  * This function returns an error code
 909  * Caller must hold lock
 910  */
 911 static int isr_tr_complete_low(struct ci_hw_ep *hwep)
 912 __releases(hwep->lock)
 913 __acquires(hwep->lock)
 914 {
 915         struct ci_hw_req *hwreq, *hwreqtemp;
 916         struct ci_hw_ep *hweptemp = hwep;
 917         int retval = 0;
 918
 919         list_for_each_entry_safe(hwreq, hwreqtemp, &hwep->qh.queue,
 920                         queue) {
 921                 retval = _hardware_dequeue(hwep, hwreq);
 922                 if (retval < 0)
 923                         break;
 924                 list_del_init(&hwreq->queue);
 925                 if (hwreq->req.complete != NULL) {
 926                         spin_unlock(hwep->lock);
 927                         if ((hwep->type == USB_ENDPOINT_XFER_CONTROL) &&
 928                                         hwreq->req.length)
 929                                 hweptemp = hwep->ci->ep0in;
 930                         hwreq->req.complete(&hweptemp->ep, &hwreq->req);
 931                         spin_lock(hwep->lock);
 932                 }
 933         }
 934
 935         if (retval == -EBUSY)
 936                 retval = 0;
 937
 938         return retval;
 939 }
 940
 941 /**
 942  * isr_setup_packet_handler: setup packet handler
 943  * @ci: UDC descriptor
 944  *
 945  * This function handles setup packet
 946  */
 947 static void isr_setup_packet_handler(struct ci_hdrc *ci)
 948 __releases(ci->lock)
 949 __acquires(ci->lock)
 950 {
 951         struct ci_hw_ep *hwep = &ci->ci_hw_ep[0];
 952         struct usb_ctrlrequest req;
 953         int type, num, dir, err = -EINVAL;
 954         u8 tmode = 0;
 955
 956         /*
 957          * Flush data and handshake transactions of previous
 958          * setup packet.
 959          */
 960         _ep_nuke(ci->ep0out);
 961         _ep_nuke(ci->ep0in);
 962
 963         /* read_setup_packet */
 964         do {
 965                 hw_test_and_set_setup_guard(ci);
 966                 memcpy(&req, &hwep->qh.ptr->setup, sizeof(req));
 967         } while (!hw_test_and_clear_setup_guard(ci));
 968
 969         type = req.bRequestType;
 970
 971         ci->ep0_dir = (type & USB_DIR_IN) ? TX : RX;
 972
 973         switch (req.bRequest) {
 974         case USB_REQ_CLEAR_FEATURE:
 975                 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
 976                                 le16_to_cpu(req.wValue) ==
 977                                 USB_ENDPOINT_HALT) {
 978                         if (req.wLength != 0)
 979                                 break;
 980                         num  = le16_to_cpu(req.wIndex);
 981                         dir = num & USB_ENDPOINT_DIR_MASK;
 982                         num &= USB_ENDPOINT_NUMBER_MASK;
 983                         if (dir) /* TX */
 984                                 num += ci->hw_ep_max / 2;
 985                         if (!ci->ci_hw_ep[num].wedge) {
 986                                 spin_unlock(&ci->lock);
 987                                 err = usb_ep_clear_halt(
 988                                         &ci->ci_hw_ep[num].ep);
 989                                 spin_lock(&ci->lock);
 990                                 if (err)
 991                                         break;
 992                         }
 993                         err = isr_setup_status_phase(ci);
 994                 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE) &&
 995                                 le16_to_cpu(req.wValue) ==
 996                                 USB_DEVICE_REMOTE_WAKEUP) {
 997                         if (req.wLength != 0)
 998                                 break;
 999                         ci->remote_wakeup = 0;
1000                         err = isr_setup_status_phase(ci);
1001                 } else {
1002                         goto delegate;
1003                 }
1004                 break;
1005         case USB_REQ_GET_STATUS:
1006                 if (type != (USB_DIR_IN|USB_RECIP_DEVICE)   &&
1007                     type != (USB_DIR_IN|USB_RECIP_ENDPOINT) &&
1008                     type != (USB_DIR_IN|USB_RECIP_INTERFACE))
1009                         goto delegate;
1010                 if (le16_to_cpu(req.wLength) != 2 ||
1011                     le16_to_cpu(req.wValue)  != 0)
1012                         break;
1013                 err = isr_get_status_response(ci, &req);
1014                 break;
1015         case USB_REQ_SET_ADDRESS:
1016                 if (type != (USB_DIR_OUT|USB_RECIP_DEVICE))
1017                         goto delegate;
1018                 if (le16_to_cpu(req.wLength) != 0 ||
1019                     le16_to_cpu(req.wIndex)  != 0)
1020                         break;
1021                 ci->address = (u8)le16_to_cpu(req.wValue);
1022                 ci->setaddr = true;
1023                 err = isr_setup_status_phase(ci);
1024                 break;
1025         case USB_REQ_SET_FEATURE:
1026                 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1027                                 le16_to_cpu(req.wValue) ==
1028                                 USB_ENDPOINT_HALT) {
1029                         if (req.wLength != 0)
1030                                 break;
1031                         num  = le16_to_cpu(req.wIndex);
1032                         dir = num & USB_ENDPOINT_DIR_MASK;
1033                         num &= USB_ENDPOINT_NUMBER_MASK;
1034                         if (dir) /* TX */
1035                                 num += ci->hw_ep_max / 2;
1036
1037                         spin_unlock(&ci->lock);
1038                         err = usb_ep_set_halt(&ci->ci_hw_ep[num].ep);
1039                         spin_lock(&ci->lock);
1040                         if (!err)
1041                                 isr_setup_status_phase(ci);
1042                 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE)) {
1043                         if (req.wLength != 0)
1044                                 break;
1045                         switch (le16_to_cpu(req.wValue)) {
1046                         case USB_DEVICE_REMOTE_WAKEUP:
1047                                 ci->remote_wakeup = 1;
1048                                 err = isr_setup_status_phase(ci);
1049                                 break;
1050                         case USB_DEVICE_TEST_MODE:
1051                                 tmode = le16_to_cpu(req.wIndex) >> 8;
1052                                 switch (tmode) {
1053                                 case TEST_J:
1054                                 case TEST_K:
1055                                 case TEST_SE0_NAK:
1056                                 case TEST_PACKET:
1057                                 case TEST_FORCE_EN:
1058                                         ci->test_mode = tmode;
1059                                         err = isr_setup_status_phase(
1060                                                         ci);
1061                                         break;
1062                                 default:
1063                                         break;
1064                                 }
1065                                 break;
1066                         case USB_DEVICE_B_HNP_ENABLE:
1067                                 if (ci_otg_is_fsm_mode(ci)) {
1068                                         ci->gadget.b_hnp_enable = 1;
1069                                         err = isr_setup_status_phase(
1070                                                         ci);
1071                                 }
1072                                 break;
1073                         default:
1074                                 goto delegate;
1075                         }
1076                 } else {
1077                         goto delegate;
1078                 }
1079                 break;
1080         default:
1081 delegate:
1082                 if (req.wLength == 0)   /* no data phase */
1083                         ci->ep0_dir = TX;
1084
1085                 spin_unlock(&ci->lock);
1086                 err = ci->driver->setup(&ci->gadget, &req);
1087                 spin_lock(&ci->lock);
1088                 break;
1089         }
1090
1091         if (err < 0) {
1092                 spin_unlock(&ci->lock);
1093                 if (usb_ep_set_halt(&hwep->ep))
1094                         dev_err(ci->dev, "error: ep_set_halt\n");
1095                 spin_lock(&ci->lock);
1096         }
1097 }
1098
1099 /**
1100  * isr_tr_complete_handler: transaction complete interrupt handler
1101  * @ci: UDC descriptor
1102  *
1103  * This function handles traffic events
1104  */
1105 static void isr_tr_complete_handler(struct ci_hdrc *ci)
1106 __releases(ci->lock)
1107 __acquires(ci->lock)
1108 {
1109         unsigned i;
1110         int err;
1111
1112         for (i = 0; i < ci->hw_ep_max; i++) {
1113                 struct ci_hw_ep *hwep  = &ci->ci_hw_ep[i];
1114
1115                 if (hwep->ep.desc == NULL)
1116                         continue;   /* not configured */
1117
1118                 if (hw_test_and_clear_complete(ci, i)) {
1119                         err = isr_tr_complete_low(hwep);
1120                         if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1121                                 if (err > 0)   /* needs status phase */
1122                                         err = isr_setup_status_phase(ci);
1123                                 if (err < 0) {
1124                                         spin_unlock(&ci->lock);
1125                                         if (usb_ep_set_halt(&hwep->ep))
1126                                                 dev_err(ci->dev,
1127                                                         "error: ep_set_halt\n");
1128                                         spin_lock(&ci->lock);
1129                                 }
1130                         }
1131                 }
1132
1133                 /* Only handle setup packet below */
1134                 if (i == 0 &&
1135                         hw_test_and_clear(ci, OP_ENDPTSETUPSTAT, BIT(0)))
1136                         isr_setup_packet_handler(ci);
1137         }
1138 }
1139
1140 /******************************************************************************
1141  * ENDPT block
1142  *****************************************************************************/
1143 /**
1144  * ep_enable: configure endpoint, making it usable
1145  *
1146  * Check usb_ep_enable() at "usb_gadget.h" for details
1147  */
1148 static int ep_enable(struct usb_ep *ep,
1149                      const struct usb_endpoint_descriptor *desc)
1150 {
1151         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1152         int retval = 0;
1153         unsigned long flags;
1154         u32 cap = 0;
1155
1156         if (ep == NULL || desc == NULL)
1157                 return -EINVAL;
1158
1159         spin_lock_irqsave(hwep->lock, flags);
1160
1161         /* only internal SW should enable ctrl endpts */
1162
1163         hwep->ep.desc = desc;
1164
1165         if (!list_empty(&hwep->qh.queue))
1166                 dev_warn(hwep->ci->dev, "enabling a non-empty endpoint!\n");
1167
1168         hwep->dir  = usb_endpoint_dir_in(desc) ? TX : RX;
1169         hwep->num  = usb_endpoint_num(desc);
1170         hwep->type = usb_endpoint_type(desc);
1171
1172         hwep->ep.maxpacket = usb_endpoint_maxp(desc) & 0x07ff;
1173         hwep->ep.mult = QH_ISO_MULT(usb_endpoint_maxp(desc));
1174
1175         if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1176                 cap |= QH_IOS;
1177         if (hwep->num)
1178                 cap |= QH_ZLT;
1179         cap |= (hwep->ep.maxpacket << __ffs(QH_MAX_PKT)) & QH_MAX_PKT;
1180         /*
1181          * For ISO-TX, we set mult at QH as the largest value, and use
1182          * MultO at TD as real mult value.
1183          */
1184         if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX)
1185                 cap |= 3 << __ffs(QH_MULT);
1186
1187         hwep->qh.ptr->cap = cpu_to_le32(cap);
1188
1189         hwep->qh.ptr->td.next |= cpu_to_le32(TD_TERMINATE);   /* needed? */
1190
1191         if (hwep->num != 0 && hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1192                 dev_err(hwep->ci->dev, "Set control xfer at non-ep0\n");
1193                 retval = -EINVAL;
1194         }
1195
1196         /*
1197          * Enable endpoints in the HW other than ep0 as ep0
1198          * is always enabled
1199          */
1200         if (hwep->num)
1201                 retval |= hw_ep_enable(hwep->ci, hwep->num, hwep->dir,
1202                                        hwep->type);
1203
1204         spin_unlock_irqrestore(hwep->lock, flags);
1205         return retval;
1206 }
1207
1208 /**
1209  * ep_disable: endpoint is no longer usable
1210  *
1211  * Check usb_ep_disable() at "usb_gadget.h" for details
1212  */
1213 static int ep_disable(struct usb_ep *ep)
1214 {
1215         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1216         int direction, retval = 0;
1217         unsigned long flags;
1218
1219         if (ep == NULL)
1220                 return -EINVAL;
1221         else if (hwep->ep.desc == NULL)
1222                 return -EBUSY;
1223
1224         spin_lock_irqsave(hwep->lock, flags);
1225
1226         /* only internal SW should disable ctrl endpts */
1227
1228         direction = hwep->dir;
1229         do {
1230                 retval |= _ep_nuke(hwep);
1231                 retval |= hw_ep_disable(hwep->ci, hwep->num, hwep->dir);
1232
1233                 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1234                         hwep->dir = (hwep->dir == TX) ? RX : TX;
1235
1236         } while (hwep->dir != direction);
1237
1238         hwep->ep.desc = NULL;
1239
1240         spin_unlock_irqrestore(hwep->lock, flags);
1241         return retval;
1242 }
1243
1244 /**
1245  * ep_alloc_request: allocate a request object to use with this endpoint
1246  *
1247  * Check usb_ep_alloc_request() at "usb_gadget.h" for details
1248  */
1249 static struct usb_request *ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
1250 {
1251         struct ci_hw_req *hwreq = NULL;
1252
1253         if (ep == NULL)
1254                 return NULL;
1255
1256         hwreq = kzalloc(sizeof(struct ci_hw_req), gfp_flags);
1257         if (hwreq != NULL) {
1258                 INIT_LIST_HEAD(&hwreq->queue);
1259                 INIT_LIST_HEAD(&hwreq->tds);
1260         }
1261
1262         return (hwreq == NULL) ? NULL : &hwreq->req;
1263 }
1264
1265 /**
1266  * ep_free_request: frees a request object
1267  *
1268  * Check usb_ep_free_request() at "usb_gadget.h" for details
1269  */
1270 static void ep_free_request(struct usb_ep *ep, struct usb_request *req)
1271 {
1272         struct ci_hw_ep  *hwep  = container_of(ep,  struct ci_hw_ep, ep);
1273         struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1274         struct td_node *node, *tmpnode;
1275         unsigned long flags;
1276
1277         if (ep == NULL || req == NULL) {
1278                 return;
1279         } else if (!list_empty(&hwreq->queue)) {
1280                 dev_err(hwep->ci->dev, "freeing queued request\n");
1281                 return;
1282         }
1283
1284         spin_lock_irqsave(hwep->lock, flags);
1285
1286         list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1287                 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1288                 list_del_init(&node->td);
1289                 node->ptr = NULL;
1290                 kfree(node);
1291         }
1292
1293         kfree(hwreq);
1294
1295         spin_unlock_irqrestore(hwep->lock, flags);
1296 }
1297
1298 /**
1299  * ep_queue: queues (submits) an I/O request to an endpoint
1300  *
1301  * Check usb_ep_queue()* at usb_gadget.h" for details
1302  */
1303 static int ep_queue(struct usb_ep *ep, struct usb_request *req,
1304                     gfp_t __maybe_unused gfp_flags)
1305 {
1306         struct ci_hw_ep  *hwep  = container_of(ep,  struct ci_hw_ep, ep);
1307         int retval = 0;
1308         unsigned long flags;
1309
1310         if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
1311                 return -EINVAL;
1312
1313         spin_lock_irqsave(hwep->lock, flags);
1314         retval = _ep_queue(ep, req, gfp_flags);
1315         spin_unlock_irqrestore(hwep->lock, flags);
1316         return retval;
1317 }
1318
1319 /**
1320  * ep_dequeue: dequeues (cancels, unlinks) an I/O request from an endpoint
1321  *
1322  * Check usb_ep_dequeue() at "usb_gadget.h" for details
1323  */
1324 static int ep_dequeue(struct usb_ep *ep, struct usb_request *req)
1325 {
1326         struct ci_hw_ep  *hwep  = container_of(ep,  struct ci_hw_ep, ep);
1327         struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1328         unsigned long flags;
1329
1330         if (ep == NULL || req == NULL || hwreq->req.status != -EALREADY ||
1331                 hwep->ep.desc == NULL || list_empty(&hwreq->queue) ||
1332                 list_empty(&hwep->qh.queue))
1333                 return -EINVAL;
1334
1335         spin_lock_irqsave(hwep->lock, flags);
1336
1337         hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1338
1339         /* pop request */
1340         list_del_init(&hwreq->queue);
1341
1342         usb_gadget_unmap_request(&hwep->ci->gadget, req, hwep->dir);
1343
1344         req->status = -ECONNRESET;
1345
1346         if (hwreq->req.complete != NULL) {
1347                 spin_unlock(hwep->lock);
1348                 hwreq->req.complete(&hwep->ep, &hwreq->req);
1349                 spin_lock(hwep->lock);
1350         }
1351
1352         spin_unlock_irqrestore(hwep->lock, flags);
1353         return 0;
1354 }
1355
1356 /**
1357  * ep_set_halt: sets the endpoint halt feature
1358  *
1359  * Check usb_ep_set_halt() at "usb_gadget.h" for details
1360  */
1361 static int ep_set_halt(struct usb_ep *ep, int value)
1362 {
1363         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1364         int direction, retval = 0;
1365         unsigned long flags;
1366
1367         if (ep == NULL || hwep->ep.desc == NULL)
1368                 return -EINVAL;
1369
1370         if (usb_endpoint_xfer_isoc(hwep->ep.desc))
1371                 return -EOPNOTSUPP;
1372
1373         spin_lock_irqsave(hwep->lock, flags);
1374
1375 #ifndef STALL_IN
1376         /* g_file_storage MS compliant but g_zero fails chapter 9 compliance */
1377         if (value && hwep->type == USB_ENDPOINT_XFER_BULK && hwep->dir == TX &&
1378             !list_empty(&hwep->qh.queue)) {
1379                 spin_unlock_irqrestore(hwep->lock, flags);
1380                 return -EAGAIN;
1381         }
1382 #endif
1383
1384         direction = hwep->dir;
1385         do {
1386                 retval |= hw_ep_set_halt(hwep->ci, hwep->num, hwep->dir, value);
1387
1388                 if (!value)
1389                         hwep->wedge = 0;
1390
1391                 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1392                         hwep->dir = (hwep->dir == TX) ? RX : TX;
1393
1394         } while (hwep->dir != direction);
1395
1396         spin_unlock_irqrestore(hwep->lock, flags);
1397         return retval;
1398 }
1399
1400 /**
1401  * ep_set_wedge: sets the halt feature and ignores clear requests
1402  *
1403  * Check usb_ep_set_wedge() at "usb_gadget.h" for details
1404  */
1405 static int ep_set_wedge(struct usb_ep *ep)
1406 {
1407         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1408         unsigned long flags;
1409
1410         if (ep == NULL || hwep->ep.desc == NULL)
1411                 return -EINVAL;
1412
1413         spin_lock_irqsave(hwep->lock, flags);
1414         hwep->wedge = 1;
1415         spin_unlock_irqrestore(hwep->lock, flags);
1416
1417         return usb_ep_set_halt(ep);
1418 }
1419
1420 /**
1421  * ep_fifo_flush: flushes contents of a fifo
1422  *
1423  * Check usb_ep_fifo_flush() at "usb_gadget.h" for details
1424  */
1425 static void ep_fifo_flush(struct usb_ep *ep)
1426 {
1427         struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1428         unsigned long flags;
1429
1430         if (ep == NULL) {
1431                 dev_err(hwep->ci->dev, "%02X: -EINVAL\n", _usb_addr(hwep));
1432                 return;
1433         }
1434
1435         spin_lock_irqsave(hwep->lock, flags);
1436
1437         hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1438
1439         spin_unlock_irqrestore(hwep->lock, flags);
1440 }
1441
1442 /**
1443  * Endpoint-specific part of the API to the USB controller hardware
1444  * Check "usb_gadget.h" for details
1445  */
1446 static const struct usb_ep_ops usb_ep_ops = {
1447         .enable        = ep_enable,
1448         .disable       = ep_disable,
1449         .alloc_request = ep_alloc_request,
1450         .free_request  = ep_free_request,
1451         .queue         = ep_queue,
1452         .dequeue       = ep_dequeue,
1453         .set_halt      = ep_set_halt,
1454         .set_wedge     = ep_set_wedge,
1455         .fifo_flush    = ep_fifo_flush,
1456 };
1457
1458 /******************************************************************************
1459  * GADGET block
1460  *****************************************************************************/
1461 static int ci_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1462 {
1463         struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1464         unsigned long flags;
1465         int gadget_ready = 0;
1466
1467         spin_lock_irqsave(&ci->lock, flags);
1468         ci->vbus_active = is_active;
1469         if (ci->driver)
1470                 gadget_ready = 1;
1471         spin_unlock_irqrestore(&ci->lock, flags);
1472
1473         if (gadget_ready) {
1474                 if (is_active) {
1475                         pm_runtime_get_sync(&_gadget->dev);
1476                         hw_device_reset(ci, USBMODE_CM_DC);
1477                         hw_device_state(ci, ci->ep0out->qh.dma);
1478                         usb_gadget_set_state(_gadget, USB_STATE_POWERED);
1479                 } else {
1480                         if (ci->driver)
1481                                 ci->driver->disconnect(&ci->gadget);
1482                         hw_device_state(ci, 0);
1483                         if (ci->platdata->notify_event)
1484                                 ci->platdata->notify_event(ci,
1485                                 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1486                         _gadget_stop_activity(&ci->gadget);
1487                         pm_runtime_put_sync(&_gadget->dev);
1488                         usb_gadget_set_state(_gadget, USB_STATE_NOTATTACHED);
1489                 }
1490         }
1491
1492         return 0;
1493 }
1494
1495 static int ci_udc_wakeup(struct usb_gadget *_gadget)
1496 {
1497         struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1498         unsigned long flags;
1499         int ret = 0;
1500
1501         spin_lock_irqsave(&ci->lock, flags);
1502         if (!ci->remote_wakeup) {
1503                 ret = -EOPNOTSUPP;
1504                 goto out;
1505         }
1506         if (!hw_read(ci, OP_PORTSC, PORTSC_SUSP)) {
1507                 ret = -EINVAL;
1508                 goto out;
1509         }
1510         hw_write(ci, OP_PORTSC, PORTSC_FPR, PORTSC_FPR);
1511 out:
1512         spin_unlock_irqrestore(&ci->lock, flags);
1513         return ret;
1514 }
1515
1516 static int ci_udc_vbus_draw(struct usb_gadget *_gadget, unsigned ma)
1517 {
1518         struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1519
1520         if (ci->transceiver)
1521                 return usb_phy_set_power(ci->transceiver, ma);
1522         return -ENOTSUPP;
1523 }
1524
1525 /* Change Data+ pullup status
1526  * this func is used by usb_gadget_connect/disconnet
1527  */
1528 static int ci_udc_pullup(struct usb_gadget *_gadget, int is_on)
1529 {
1530         struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1531
1532         if (!ci->vbus_active)
1533                 return -EOPNOTSUPP;
1534
1535         if (is_on)
1536                 hw_write(ci, OP_USBCMD, USBCMD_RS, USBCMD_RS);
1537         else
1538                 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
1539
1540         return 0;
1541 }
1542
1543 static int ci_udc_start(struct usb_gadget *gadget,
1544                          struct usb_gadget_driver *driver);
1545 static int ci_udc_stop(struct usb_gadget *gadget,
1546                         struct usb_gadget_driver *driver);
1547 /**
1548  * Device operations part of the API to the USB controller hardware,
1549  * which don't involve endpoints (or i/o)
1550  * Check  "usb_gadget.h" for details
1551  */
1552 static const struct usb_gadget_ops usb_gadget_ops = {
1553         .vbus_session   = ci_udc_vbus_session,
1554         .wakeup         = ci_udc_wakeup,
1555         .pullup         = ci_udc_pullup,
1556         .vbus_draw      = ci_udc_vbus_draw,
1557         .udc_start      = ci_udc_start,
1558         .udc_stop       = ci_udc_stop,
1559 };
1560
1561 static int init_eps(struct ci_hdrc *ci)
1562 {
1563         int retval = 0, i, j;
1564
1565         for (i = 0; i < ci->hw_ep_max/2; i++)
1566                 for (j = RX; j <= TX; j++) {
1567                         int k = i + j * ci->hw_ep_max/2;
1568                         struct ci_hw_ep *hwep = &ci->ci_hw_ep[k];
1569
1570                         scnprintf(hwep->name, sizeof(hwep->name), "ep%i%s", i,
1571                                         (j == TX)  ? "in" : "out");
1572
1573                         hwep->ci          = ci;
1574                         hwep->lock         = &ci->lock;
1575                         hwep->td_pool      = ci->td_pool;
1576
1577                         hwep->ep.name      = hwep->name;
1578                         hwep->ep.ops       = &usb_ep_ops;
1579                         /*
1580                          * for ep0: maxP defined in desc, for other
1581                          * eps, maxP is set by epautoconfig() called
1582                          * by gadget layer
1583                          */
1584                         usb_ep_set_maxpacket_limit(&hwep->ep, (unsigned short)~0);
1585
1586                         INIT_LIST_HEAD(&hwep->qh.queue);
1587                         hwep->qh.ptr = dma_pool_alloc(ci->qh_pool, GFP_KERNEL,
1588                                                      &hwep->qh.dma);
1589                         if (hwep->qh.ptr == NULL)
1590                                 retval = -ENOMEM;
1591                         else
1592                                 memset(hwep->qh.ptr, 0, sizeof(*hwep->qh.ptr));
1593
1594                         /*
1595                          * set up shorthands for ep0 out and in endpoints,
1596                          * don't add to gadget's ep_list
1597                          */
1598                         if (i == 0) {
1599                                 if (j == RX)
1600                                         ci->ep0out = hwep;
1601                                 else
1602                                         ci->ep0in = hwep;
1603
1604                                 usb_ep_set_maxpacket_limit(&hwep->ep, CTRL_PAYLOAD_MAX);
1605                                 continue;
1606                         }
1607
1608                         list_add_tail(&hwep->ep.ep_list, &ci->gadget.ep_list);
1609                 }
1610
1611         return retval;
1612 }
1613
1614 static void destroy_eps(struct ci_hdrc *ci)
1615 {
1616         int i;
1617
1618         for (i = 0; i < ci->hw_ep_max; i++) {
1619                 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1620
1621                 if (hwep->pending_td)
1622                         free_pending_td(hwep);
1623                 dma_pool_free(ci->qh_pool, hwep->qh.ptr, hwep->qh.dma);
1624         }
1625 }
1626
1627 /**
1628  * ci_udc_start: register a gadget driver
1629  * @gadget: our gadget
1630  * @driver: the driver being registered
1631  *
1632  * Interrupts are enabled here.
1633  */
1634 static int ci_udc_start(struct usb_gadget *gadget,
1635                          struct usb_gadget_driver *driver)
1636 {
1637         struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1638         unsigned long flags;
1639         int retval = -ENOMEM;
1640
1641         if (driver->disconnect == NULL)
1642                 return -EINVAL;
1643
1644
1645         ci->ep0out->ep.desc = &ctrl_endpt_out_desc;
1646         retval = usb_ep_enable(&ci->ep0out->ep);
1647         if (retval)
1648                 return retval;
1649
1650         ci->ep0in->ep.desc = &ctrl_endpt_in_desc;
1651         retval = usb_ep_enable(&ci->ep0in->ep);
1652         if (retval)
1653                 return retval;
1654
1655         ci->driver = driver;
1656
1657         /* Start otg fsm for B-device */
1658         if (ci_otg_is_fsm_mode(ci) && ci->fsm.id) {
1659                 ci_hdrc_otg_fsm_start(ci);
1660                 return retval;
1661         }
1662
1663         pm_runtime_get_sync(&ci->gadget.dev);
1664         if (ci->vbus_active) {
1665                 spin_lock_irqsave(&ci->lock, flags);
1666                 hw_device_reset(ci, USBMODE_CM_DC);
1667         } else {
1668                 pm_runtime_put_sync(&ci->gadget.dev);
1669                 return retval;
1670         }
1671
1672         retval = hw_device_state(ci, ci->ep0out->qh.dma);
1673         spin_unlock_irqrestore(&ci->lock, flags);
1674         if (retval)
1675                 pm_runtime_put_sync(&ci->gadget.dev);
1676
1677         return retval;
1678 }
1679
1680 /**
1681  * ci_udc_stop: unregister a gadget driver
1682  */
1683 static int ci_udc_stop(struct usb_gadget *gadget,
1684                         struct usb_gadget_driver *driver)
1685 {
1686         struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1687         unsigned long flags;
1688
1689         spin_lock_irqsave(&ci->lock, flags);
1690
1691         if (ci->vbus_active) {
1692                 hw_device_state(ci, 0);
1693                 if (ci->platdata->notify_event)
1694                         ci->platdata->notify_event(ci,
1695                         CI_HDRC_CONTROLLER_STOPPED_EVENT);
1696                 ci->driver = NULL;
1697                 spin_unlock_irqrestore(&ci->lock, flags);
1698                 _gadget_stop_activity(&ci->gadget);
1699                 spin_lock_irqsave(&ci->lock, flags);
1700                 pm_runtime_put(&ci->gadget.dev);
1701         }
1702
1703         spin_unlock_irqrestore(&ci->lock, flags);
1704
1705         return 0;
1706 }
1707
1708 /******************************************************************************
1709  * BUS block
1710  *****************************************************************************/
1711 /**
1712  * udc_irq: ci interrupt handler
1713  *
1714  * This function returns IRQ_HANDLED if the IRQ has been handled
1715  * It locks access to registers
1716  */
1717 static irqreturn_t udc_irq(struct ci_hdrc *ci)
1718 {
1719         irqreturn_t retval;
1720         u32 intr;
1721
1722         if (ci == NULL)
1723                 return IRQ_HANDLED;
1724
1725         spin_lock(&ci->lock);
1726
1727         if (ci->platdata->flags & CI_HDRC_REGS_SHARED) {
1728                 if (hw_read(ci, OP_USBMODE, USBMODE_CM) !=
1729                                 USBMODE_CM_DC) {
1730                         spin_unlock(&ci->lock);
1731                         return IRQ_NONE;
1732                 }
1733         }
1734         intr = hw_test_and_clear_intr_active(ci);
1735
1736         if (intr) {
1737                 /* order defines priority - do NOT change it */
1738                 if (USBi_URI & intr)
1739                         isr_reset_handler(ci);
1740
1741                 if (USBi_PCI & intr) {
1742                         ci->gadget.speed = hw_port_is_high_speed(ci) ?
1743                                 USB_SPEED_HIGH : USB_SPEED_FULL;
1744                         if (ci->suspended && ci->driver->resume) {
1745                                 spin_unlock(&ci->lock);
1746                                 ci->driver->resume(&ci->gadget);
1747                                 spin_lock(&ci->lock);
1748                                 ci->suspended = 0;
1749                         }
1750                 }
1751
1752                 if (USBi_UI  & intr)
1753                         isr_tr_complete_handler(ci);
1754
1755                 if (USBi_SLI & intr) {
1756                         if (ci->gadget.speed != USB_SPEED_UNKNOWN &&
1757                             ci->driver->suspend) {
1758                                 ci->suspended = 1;
1759                                 spin_unlock(&ci->lock);
1760                                 ci->driver->suspend(&ci->gadget);
1761                                 usb_gadget_set_state(&ci->gadget,
1762                                                 USB_STATE_SUSPENDED);
1763                                 spin_lock(&ci->lock);
1764                         }
1765                 }
1766                 retval = IRQ_HANDLED;
1767         } else {
1768                 retval = IRQ_NONE;
1769         }
1770         spin_unlock(&ci->lock);
1771
1772         return retval;
1773 }
1774
1775 /**
1776  * udc_start: initialize gadget role
1777  * @ci: chipidea controller
1778  */
1779 static int udc_start(struct ci_hdrc *ci)
1780 {
1781         struct device *dev = ci->dev;
1782         int retval = 0;
1783
1784         spin_lock_init(&ci->lock);
1785
1786         ci->gadget.ops          = &usb_gadget_ops;
1787         ci->gadget.speed        = USB_SPEED_UNKNOWN;
1788         ci->gadget.max_speed    = USB_SPEED_HIGH;
1789         ci->gadget.is_otg       = ci->is_otg ? 1 : 0;
1790         ci->gadget.name         = ci->platdata->name;
1791
1792         INIT_LIST_HEAD(&ci->gadget.ep_list);
1793
1794         /* alloc resources */
1795         ci->qh_pool = dma_pool_create("ci_hw_qh", dev,
1796                                        sizeof(struct ci_hw_qh),
1797                                        64, CI_HDRC_PAGE_SIZE);
1798         if (ci->qh_pool == NULL)
1799                 return -ENOMEM;
1800
1801         ci->td_pool = dma_pool_create("ci_hw_td", dev,
1802                                        sizeof(struct ci_hw_td),
1803                                        64, CI_HDRC_PAGE_SIZE);
1804         if (ci->td_pool == NULL) {
1805                 retval = -ENOMEM;
1806                 goto free_qh_pool;
1807         }
1808
1809         retval = init_eps(ci);
1810         if (retval)
1811                 goto free_pools;
1812
1813         ci->gadget.ep0 = &ci->ep0in->ep;
1814
1815         retval = usb_add_gadget_udc(dev, &ci->gadget);
1816         if (retval)
1817                 goto destroy_eps;
1818
1819         pm_runtime_no_callbacks(&ci->gadget.dev);
1820         pm_runtime_enable(&ci->gadget.dev);
1821
1822         return retval;
1823
1824 destroy_eps:
1825         destroy_eps(ci);
1826 free_pools:
1827         dma_pool_destroy(ci->td_pool);
1828 free_qh_pool:
1829         dma_pool_destroy(ci->qh_pool);
1830         return retval;
1831 }
1832
1833 /**
1834  * ci_hdrc_gadget_destroy: parent remove must call this to remove UDC
1835  *
1836  * No interrupts active, the IRQ has been released
1837  */
1838 void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
1839 {
1840         if (!ci->roles[CI_ROLE_GADGET])
1841                 return;
1842
1843         usb_del_gadget_udc(&ci->gadget);
1844
1845         destroy_eps(ci);
1846
1847         dma_pool_destroy(ci->td_pool);
1848         dma_pool_destroy(ci->qh_pool);
1849 }
1850
1851 static int udc_id_switch_for_device(struct ci_hdrc *ci)
1852 {
1853         if (ci->is_otg)
1854                 /* Clear and enable BSV irq */
1855                 hw_write_otgsc(ci, OTGSC_BSVIS | OTGSC_BSVIE,
1856                                         OTGSC_BSVIS | OTGSC_BSVIE);
1857
1858         return 0;
1859 }
1860
1861 static void udc_id_switch_for_host(struct ci_hdrc *ci)
1862 {
1863         /*
1864          * host doesn't care B_SESSION_VALID event
1865          * so clear and disbale BSV irq
1866          */
1867         if (ci->is_otg)
1868                 hw_write_otgsc(ci, OTGSC_BSVIE | OTGSC_BSVIS, OTGSC_BSVIS);
1869 }
1870
1871 /**
1872  * ci_hdrc_gadget_init - initialize device related bits
1873  * ci: the controller
1874  *
1875  * This function initializes the gadget, if the device is "device capable".
1876  */
1877 int ci_hdrc_gadget_init(struct ci_hdrc *ci)
1878 {
1879         struct ci_role_driver *rdrv;
1880
1881         if (!hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DC))
1882                 return -ENXIO;
1883
1884         rdrv = devm_kzalloc(ci->dev, sizeof(struct ci_role_driver), GFP_KERNEL);
1885         if (!rdrv)
1886                 return -ENOMEM;
1887
1888         rdrv->start     = udc_id_switch_for_device;
1889         rdrv->stop      = udc_id_switch_for_host;
1890         rdrv->irq       = udc_irq;
1891         rdrv->name      = "gadget";
1892         ci->roles[CI_ROLE_GADGET] = rdrv;
1893
1894         return udc_start(ci);
1895 }