drivers/usb/renesas_usbhs/mod_gadget.c

   1 // SPDX-License-Identifier: GPL-1.0+
   2 /*
   3  * Renesas USB driver
   4  *
   5  * Copyright (C) 2011 Renesas Solutions Corp.
   6  * Copyright (C) 2019 Renesas Electronics Corporation
   7  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   8  */
   9 #include <linux/delay.h>
  10 #include <linux/dma-mapping.h>
  11 #include <linux/io.h>
  12 #include <linux/module.h>
  13 #include <linux/platform_device.h>
  14 #include <linux/usb/ch9.h>
  15 #include <linux/usb/gadget.h>
  16 #include <linux/usb/otg.h>
  17 #include "common.h"
  18
  19 /*
  20  *              struct
  21  */
  22 struct usbhsg_request {
  23         struct usb_request      req;
  24         struct usbhs_pkt        pkt;
  25 };
  26
  27 #define EP_NAME_SIZE 8
  28 struct usbhsg_gpriv;
  29 struct usbhsg_uep {
  30         struct usb_ep            ep;
  31         struct usbhs_pipe       *pipe;
  32         spinlock_t              lock;   /* protect the pipe */
  33
  34         char ep_name[EP_NAME_SIZE];
  35
  36         struct usbhsg_gpriv *gpriv;
  37 };
  38
  39 struct usbhsg_gpriv {
  40         struct usb_gadget        gadget;
  41         struct usbhs_mod         mod;
  42
  43         struct usbhsg_uep       *uep;
  44         int                      uep_size;
  45
  46         struct usb_gadget_driver        *driver;
  47         struct usb_phy          *transceiver;
  48         bool                     vbus_active;
  49
  50         u32     status;
  51 #define USBHSG_STATUS_STARTED           (1 << 0)
  52 #define USBHSG_STATUS_REGISTERD         (1 << 1)
  53 #define USBHSG_STATUS_WEDGE             (1 << 2)
  54 #define USBHSG_STATUS_SELF_POWERED      (1 << 3)
  55 #define USBHSG_STATUS_SOFT_CONNECT      (1 << 4)
  56 };
  57
  58 struct usbhsg_recip_handle {
  59         char *name;
  60         int (*device)(struct usbhs_priv *priv, struct usbhsg_uep *uep,
  61                       struct usb_ctrlrequest *ctrl);
  62         int (*interface)(struct usbhs_priv *priv, struct usbhsg_uep *uep,
  63                          struct usb_ctrlrequest *ctrl);
  64         int (*endpoint)(struct usbhs_priv *priv, struct usbhsg_uep *uep,
  65                         struct usb_ctrlrequest *ctrl);
  66 };
  67
  68 /*
  69  *              macro
  70  */
  71 #define usbhsg_priv_to_gpriv(priv)                      \
  72         container_of(                                   \
  73                 usbhs_mod_get(priv, USBHS_GADGET),      \
  74                 struct usbhsg_gpriv, mod)
  75
  76 #define __usbhsg_for_each_uep(start, pos, g, i) \
  77         for ((i) = start;                                       \
  78              ((i) < (g)->uep_size) && ((pos) = (g)->uep + (i)); \
  79              (i)++)
  80
  81 #define usbhsg_for_each_uep(pos, gpriv, i)      \
  82         __usbhsg_for_each_uep(1, pos, gpriv, i)
  83
  84 #define usbhsg_for_each_uep_with_dcp(pos, gpriv, i)     \
  85         __usbhsg_for_each_uep(0, pos, gpriv, i)
  86
  87 #define usbhsg_gadget_to_gpriv(g)\
  88         container_of(g, struct usbhsg_gpriv, gadget)
  89
  90 #define usbhsg_req_to_ureq(r)\
  91         container_of(r, struct usbhsg_request, req)
  92
  93 #define usbhsg_ep_to_uep(e)             container_of(e, struct usbhsg_uep, ep)
  94 #define usbhsg_gpriv_to_dev(gp)         usbhs_priv_to_dev((gp)->mod.priv)
  95 #define usbhsg_gpriv_to_priv(gp)        ((gp)->mod.priv)
  96 #define usbhsg_gpriv_to_dcp(gp)         ((gp)->uep)
  97 #define usbhsg_gpriv_to_nth_uep(gp, i)  ((gp)->uep + i)
  98 #define usbhsg_uep_to_gpriv(u)          ((u)->gpriv)
  99 #define usbhsg_uep_to_pipe(u)           ((u)->pipe)
 100 #define usbhsg_pipe_to_uep(p)           ((p)->mod_private)
 101 #define usbhsg_is_dcp(u)                ((u) == usbhsg_gpriv_to_dcp((u)->gpriv))
 102
 103 #define usbhsg_ureq_to_pkt(u)           (&(u)->pkt)
 104 #define usbhsg_pkt_to_ureq(i)   \
 105         container_of(i, struct usbhsg_request, pkt)
 106
 107 #define usbhsg_is_not_connected(gp) ((gp)->gadget.speed == USB_SPEED_UNKNOWN)
 108
 109 /* status */
 110 #define usbhsg_status_init(gp)   do {(gp)->status = 0; } while (0)
 111 #define usbhsg_status_set(gp, b) (gp->status |=  b)
 112 #define usbhsg_status_clr(gp, b) (gp->status &= ~b)
 113 #define usbhsg_status_has(gp, b) (gp->status &   b)
 114
 115 /*
 116  *              queue push/pop
 117  */
 118 static void __usbhsg_queue_pop(struct usbhsg_uep *uep,
 119                                struct usbhsg_request *ureq,
 120                                int status)
 121 {
 122         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 123         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(uep);
 124         struct device *dev = usbhsg_gpriv_to_dev(gpriv);
 125         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
 126
 127         if (pipe)
 128                 dev_dbg(dev, "pipe %d : queue pop\n", usbhs_pipe_number(pipe));
 129
 130         ureq->req.status = status;
 131         spin_unlock(usbhs_priv_to_lock(priv));
 132         usb_gadget_giveback_request(&uep->ep, &ureq->req);
 133         spin_lock(usbhs_priv_to_lock(priv));
 134 }
 135
 136 static void usbhsg_queue_pop(struct usbhsg_uep *uep,
 137                              struct usbhsg_request *ureq,
 138                              int status)
 139 {
 140         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 141         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
 142         unsigned long flags;
 143
 144         usbhs_lock(priv, flags);
 145         __usbhsg_queue_pop(uep, ureq, status);
 146         usbhs_unlock(priv, flags);
 147 }
 148
 149 static void usbhsg_queue_done(struct usbhs_priv *priv, struct usbhs_pkt *pkt)
 150 {
 151         struct usbhs_pipe *pipe = pkt->pipe;
 152         struct usbhsg_uep *uep = usbhsg_pipe_to_uep(pipe);
 153         struct usbhsg_request *ureq = usbhsg_pkt_to_ureq(pkt);
 154         unsigned long flags;
 155
 156         ureq->req.actual = pkt->actual;
 157
 158         usbhs_lock(priv, flags);
 159         if (uep)
 160                 __usbhsg_queue_pop(uep, ureq, 0);
 161         usbhs_unlock(priv, flags);
 162 }
 163
 164 static void usbhsg_queue_push(struct usbhsg_uep *uep,
 165                               struct usbhsg_request *ureq)
 166 {
 167         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 168         struct device *dev = usbhsg_gpriv_to_dev(gpriv);
 169         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(uep);
 170         struct usbhs_pkt *pkt = usbhsg_ureq_to_pkt(ureq);
 171         struct usb_request *req = &ureq->req;
 172
 173         req->actual = 0;
 174         req->status = -EINPROGRESS;
 175         usbhs_pkt_push(pipe, pkt, usbhsg_queue_done,
 176                        req->buf, req->length, req->zero, -1);
 177         usbhs_pkt_start(pipe);
 178
 179         dev_dbg(dev, "pipe %d : queue push (%d)\n",
 180                 usbhs_pipe_number(pipe),
 181                 req->length);
 182 }
 183
 184 /*
 185  *              dma map/unmap
 186  */
 187 static int usbhsg_dma_map_ctrl(struct device *dma_dev, struct usbhs_pkt *pkt,
 188                                int map)
 189 {
 190         struct usbhsg_request *ureq = usbhsg_pkt_to_ureq(pkt);
 191         struct usb_request *req = &ureq->req;
 192         struct usbhs_pipe *pipe = pkt->pipe;
 193         enum dma_data_direction dir;
 194         int ret = 0;
 195
 196         dir = usbhs_pipe_is_dir_host(pipe);
 197
 198         if (map) {
 199                 /* it can not use scatter/gather */
 200                 WARN_ON(req->num_sgs);
 201
 202                 ret = usb_gadget_map_request_by_dev(dma_dev, req, dir);
 203                 if (ret < 0)
 204                         return ret;
 205
 206                 pkt->dma = req->dma;
 207         } else {
 208                 usb_gadget_unmap_request_by_dev(dma_dev, req, dir);
 209         }
 210
 211         return ret;
 212 }
 213
 214 /*
 215  *              USB_TYPE_STANDARD / clear feature functions
 216  */
 217 static int usbhsg_recip_handler_std_control_done(struct usbhs_priv *priv,
 218                                                  struct usbhsg_uep *uep,
 219                                                  struct usb_ctrlrequest *ctrl)
 220 {
 221         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
 222         struct usbhsg_uep *dcp = usbhsg_gpriv_to_dcp(gpriv);
 223         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(dcp);
 224
 225         usbhs_dcp_control_transfer_done(pipe);
 226
 227         return 0;
 228 }
 229
 230 static int usbhsg_recip_handler_std_clear_endpoint(struct usbhs_priv *priv,
 231                                                    struct usbhsg_uep *uep,
 232                                                    struct usb_ctrlrequest *ctrl)
 233 {
 234         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 235         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(uep);
 236
 237         if (!usbhsg_status_has(gpriv, USBHSG_STATUS_WEDGE)) {
 238                 usbhs_pipe_disable(pipe);
 239                 usbhs_pipe_sequence_data0(pipe);
 240                 usbhs_pipe_enable(pipe);
 241         }
 242
 243         usbhsg_recip_handler_std_control_done(priv, uep, ctrl);
 244
 245         usbhs_pkt_start(pipe);
 246
 247         return 0;
 248 }
 249
 250 static struct usbhsg_recip_handle req_clear_feature = {
 251         .name           = "clear feature",
 252         .device         = usbhsg_recip_handler_std_control_done,
 253         .interface      = usbhsg_recip_handler_std_control_done,
 254         .endpoint       = usbhsg_recip_handler_std_clear_endpoint,
 255 };
 256
 257 /*
 258  *              USB_TYPE_STANDARD / set feature functions
 259  */
 260 static int usbhsg_recip_handler_std_set_device(struct usbhs_priv *priv,
 261                                                  struct usbhsg_uep *uep,
 262                                                  struct usb_ctrlrequest *ctrl)
 263 {
 264         switch (le16_to_cpu(ctrl->wValue)) {
 265         case USB_DEVICE_TEST_MODE:
 266                 usbhsg_recip_handler_std_control_done(priv, uep, ctrl);
 267                 udelay(100);
 268                 usbhs_sys_set_test_mode(priv, le16_to_cpu(ctrl->wIndex >> 8));
 269                 break;
 270         default:
 271                 usbhsg_recip_handler_std_control_done(priv, uep, ctrl);
 272                 break;
 273         }
 274
 275         return 0;
 276 }
 277
 278 static int usbhsg_recip_handler_std_set_endpoint(struct usbhs_priv *priv,
 279                                                  struct usbhsg_uep *uep,
 280                                                  struct usb_ctrlrequest *ctrl)
 281 {
 282         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(uep);
 283
 284         usbhs_pipe_stall(pipe);
 285
 286         usbhsg_recip_handler_std_control_done(priv, uep, ctrl);
 287
 288         return 0;
 289 }
 290
 291 static struct usbhsg_recip_handle req_set_feature = {
 292         .name           = "set feature",
 293         .device         = usbhsg_recip_handler_std_set_device,
 294         .interface      = usbhsg_recip_handler_std_control_done,
 295         .endpoint       = usbhsg_recip_handler_std_set_endpoint,
 296 };
 297
 298 /*
 299  *              USB_TYPE_STANDARD / get status functions
 300  */
 301 static void __usbhsg_recip_send_complete(struct usb_ep *ep,
 302                                          struct usb_request *req)
 303 {
 304         struct usbhsg_request *ureq = usbhsg_req_to_ureq(req);
 305
 306         /* free allocated recip-buffer/usb_request */
 307         kfree(ureq->pkt.buf);
 308         usb_ep_free_request(ep, req);
 309 }
 310
 311 static void __usbhsg_recip_send_status(struct usbhsg_gpriv *gpriv,
 312                                        unsigned short status)
 313 {
 314         struct usbhsg_uep *dcp = usbhsg_gpriv_to_dcp(gpriv);
 315         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(dcp);
 316         struct device *dev = usbhsg_gpriv_to_dev(gpriv);
 317         struct usb_request *req;
 318         unsigned short *buf;
 319
 320         /* alloc new usb_request for recip */
 321         req = usb_ep_alloc_request(&dcp->ep, GFP_ATOMIC);
 322         if (!req) {
 323                 dev_err(dev, "recip request allocation fail\n");
 324                 return;
 325         }
 326
 327         /* alloc recip data buffer */
 328         buf = kmalloc(sizeof(*buf), GFP_ATOMIC);
 329         if (!buf) {
 330                 usb_ep_free_request(&dcp->ep, req);
 331                 return;
 332         }
 333
 334         /* recip data is status */
 335         *buf = cpu_to_le16(status);
 336
 337         /* allocated usb_request/buffer will be freed */
 338         req->complete   = __usbhsg_recip_send_complete;
 339         req->buf        = buf;
 340         req->length     = sizeof(*buf);
 341         req->zero       = 0;
 342
 343         /* push packet */
 344         pipe->handler = &usbhs_fifo_pio_push_handler;
 345         usbhsg_queue_push(dcp, usbhsg_req_to_ureq(req));
 346 }
 347
 348 static int usbhsg_recip_handler_std_get_device(struct usbhs_priv *priv,
 349                                                struct usbhsg_uep *uep,
 350                                                struct usb_ctrlrequest *ctrl)
 351 {
 352         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 353         unsigned short status = 0;
 354
 355         if (usbhsg_status_has(gpriv, USBHSG_STATUS_SELF_POWERED))
 356                 status = 1 << USB_DEVICE_SELF_POWERED;
 357
 358         __usbhsg_recip_send_status(gpriv, status);
 359
 360         return 0;
 361 }
 362
 363 static int usbhsg_recip_handler_std_get_interface(struct usbhs_priv *priv,
 364                                                   struct usbhsg_uep *uep,
 365                                                   struct usb_ctrlrequest *ctrl)
 366 {
 367         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 368         unsigned short status = 0;
 369
 370         __usbhsg_recip_send_status(gpriv, status);
 371
 372         return 0;
 373 }
 374
 375 static int usbhsg_recip_handler_std_get_endpoint(struct usbhs_priv *priv,
 376                                                  struct usbhsg_uep *uep,
 377                                                  struct usb_ctrlrequest *ctrl)
 378 {
 379         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 380         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(uep);
 381         unsigned short status = 0;
 382
 383         if (usbhs_pipe_is_stall(pipe))
 384                 status = 1 << USB_ENDPOINT_HALT;
 385
 386         __usbhsg_recip_send_status(gpriv, status);
 387
 388         return 0;
 389 }
 390
 391 static struct usbhsg_recip_handle req_get_status = {
 392         .name           = "get status",
 393         .device         = usbhsg_recip_handler_std_get_device,
 394         .interface      = usbhsg_recip_handler_std_get_interface,
 395         .endpoint       = usbhsg_recip_handler_std_get_endpoint,
 396 };
 397
 398 /*
 399  *              USB_TYPE handler
 400  */
 401 static int usbhsg_recip_run_handle(struct usbhs_priv *priv,
 402                                    struct usbhsg_recip_handle *handler,
 403                                    struct usb_ctrlrequest *ctrl)
 404 {
 405         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
 406         struct device *dev = usbhsg_gpriv_to_dev(gpriv);
 407         struct usbhsg_uep *uep;
 408         struct usbhs_pipe *pipe;
 409         int recip = ctrl->bRequestType & USB_RECIP_MASK;
 410         int nth = le16_to_cpu(ctrl->wIndex) & USB_ENDPOINT_NUMBER_MASK;
 411         int ret = 0;
 412         int (*func)(struct usbhs_priv *priv, struct usbhsg_uep *uep,
 413                     struct usb_ctrlrequest *ctrl);
 414         char *msg;
 415
 416         uep = usbhsg_gpriv_to_nth_uep(gpriv, nth);
 417         pipe = usbhsg_uep_to_pipe(uep);
 418         if (!pipe) {
 419                 dev_err(dev, "wrong recip request\n");
 420                 return -EINVAL;
 421         }
 422
 423         switch (recip) {
 424         case USB_RECIP_DEVICE:
 425                 msg     = "DEVICE";
 426                 func    = handler->device;
 427                 break;
 428         case USB_RECIP_INTERFACE:
 429                 msg     = "INTERFACE";
 430                 func    = handler->interface;
 431                 break;
 432         case USB_RECIP_ENDPOINT:
 433                 msg     = "ENDPOINT";
 434                 func    = handler->endpoint;
 435                 break;
 436         default:
 437                 dev_warn(dev, "unsupported RECIP(%d)\n", recip);
 438                 func = NULL;
 439                 ret = -EINVAL;
 440         }
 441
 442         if (func) {
 443                 dev_dbg(dev, "%s (pipe %d :%s)\n", handler->name, nth, msg);
 444                 ret = func(priv, uep, ctrl);
 445         }
 446
 447         return ret;
 448 }
 449
 450 /*
 451  *              irq functions
 452  *
 453  * it will be called from usbhs_interrupt
 454  */
 455 static int usbhsg_irq_dev_state(struct usbhs_priv *priv,
 456                                 struct usbhs_irq_state *irq_state)
 457 {
 458         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
 459         struct device *dev = usbhsg_gpriv_to_dev(gpriv);
 460
 461         gpriv->gadget.speed = usbhs_bus_get_speed(priv);
 462
 463         dev_dbg(dev, "state = %x : speed : %d\n",
 464                 usbhs_status_get_device_state(irq_state),
 465                 gpriv->gadget.speed);
 466
 467         return 0;
 468 }
 469
 470 static int usbhsg_irq_ctrl_stage(struct usbhs_priv *priv,
 471                                  struct usbhs_irq_state *irq_state)
 472 {
 473         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
 474         struct usbhsg_uep *dcp = usbhsg_gpriv_to_dcp(gpriv);
 475         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(dcp);
 476         struct device *dev = usbhsg_gpriv_to_dev(gpriv);
 477         struct usb_ctrlrequest ctrl;
 478         struct usbhsg_recip_handle *recip_handler = NULL;
 479         int stage = usbhs_status_get_ctrl_stage(irq_state);
 480         int ret = 0;
 481
 482         dev_dbg(dev, "stage = %d\n", stage);
 483
 484         /*
 485          * see Manual
 486          *
 487          *  "Operation"
 488          *  - "Interrupt Function"
 489          *    - "Control Transfer Stage Transition Interrupt"
 490          *      - Fig. "Control Transfer Stage Transitions"
 491          */
 492
 493         switch (stage) {
 494         case READ_DATA_STAGE:
 495                 pipe->handler = &usbhs_fifo_pio_push_handler;
 496                 break;
 497         case WRITE_DATA_STAGE:
 498                 pipe->handler = &usbhs_fifo_pio_pop_handler;
 499                 break;
 500         case NODATA_STATUS_STAGE:
 501                 pipe->handler = &usbhs_ctrl_stage_end_handler;
 502                 break;
 503         case READ_STATUS_STAGE:
 504         case WRITE_STATUS_STAGE:
 505                 usbhs_dcp_control_transfer_done(pipe);
 506                 /* fall through */
 507         default:
 508                 return ret;
 509         }
 510
 511         /*
 512          * get usb request
 513          */
 514         usbhs_usbreq_get_val(priv, &ctrl);
 515
 516         switch (ctrl.bRequestType & USB_TYPE_MASK) {
 517         case USB_TYPE_STANDARD:
 518                 switch (ctrl.bRequest) {
 519                 case USB_REQ_CLEAR_FEATURE:
 520                         recip_handler = &req_clear_feature;
 521                         break;
 522                 case USB_REQ_SET_FEATURE:
 523                         recip_handler = &req_set_feature;
 524                         break;
 525                 case USB_REQ_GET_STATUS:
 526                         recip_handler = &req_get_status;
 527                         break;
 528                 }
 529         }
 530
 531         /*
 532          * setup stage / run recip
 533          */
 534         if (recip_handler)
 535                 ret = usbhsg_recip_run_handle(priv, recip_handler, &ctrl);
 536         else
 537                 ret = gpriv->driver->setup(&gpriv->gadget, &ctrl);
 538
 539         if (ret < 0)
 540                 usbhs_pipe_stall(pipe);
 541
 542         return ret;
 543 }
 544
 545 /*
 546  *
 547  *              usb_dcp_ops
 548  *
 549  */
 550 static int usbhsg_pipe_disable(struct usbhsg_uep *uep)
 551 {
 552         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(uep);
 553         struct usbhs_pkt *pkt;
 554
 555         while (1) {
 556                 pkt = usbhs_pkt_pop(pipe, NULL);
 557                 if (!pkt)
 558                         break;
 559
 560                 usbhsg_queue_pop(uep, usbhsg_pkt_to_ureq(pkt), -ESHUTDOWN);
 561         }
 562
 563         usbhs_pipe_disable(pipe);
 564
 565         return 0;
 566 }
 567
 568 /*
 569  *
 570  *              usb_ep_ops
 571  *
 572  */
 573 static int usbhsg_ep_enable(struct usb_ep *ep,
 574                          const struct usb_endpoint_descriptor *desc)
 575 {
 576         struct usbhsg_uep *uep   = usbhsg_ep_to_uep(ep);
 577         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 578         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
 579         struct usbhs_pipe *pipe;
 580         int ret = -EIO;
 581         unsigned long flags;
 582
 583         usbhs_lock(priv, flags);
 584
 585         /*
 586          * if it already have pipe,
 587          * nothing to do
 588          */
 589         if (uep->pipe) {
 590                 usbhs_pipe_clear(uep->pipe);
 591                 usbhs_pipe_sequence_data0(uep->pipe);
 592                 ret = 0;
 593                 goto usbhsg_ep_enable_end;
 594         }
 595
 596         pipe = usbhs_pipe_malloc(priv,
 597                                  usb_endpoint_type(desc),
 598                                  usb_endpoint_dir_in(desc));
 599         if (pipe) {
 600                 uep->pipe               = pipe;
 601                 pipe->mod_private       = uep;
 602
 603                 /* set epnum / maxp */
 604                 usbhs_pipe_config_update(pipe, 0,
 605                                          usb_endpoint_num(desc),
 606                                          usb_endpoint_maxp(desc));
 607
 608                 /*
 609                  * usbhs_fifo_dma_push/pop_handler try to
 610                  * use dmaengine if possible.
 611                  * It will use pio handler if impossible.
 612                  */
 613                 if (usb_endpoint_dir_in(desc)) {
 614                         pipe->handler = &usbhs_fifo_dma_push_handler;
 615                 } else {
 616                         pipe->handler = &usbhs_fifo_dma_pop_handler;
 617                         usbhs_xxxsts_clear(priv, BRDYSTS,
 618                                            usbhs_pipe_number(pipe));
 619                 }
 620
 621                 ret = 0;
 622         }
 623
 624 usbhsg_ep_enable_end:
 625         usbhs_unlock(priv, flags);
 626
 627         return ret;
 628 }
 629
 630 static int usbhsg_ep_disable(struct usb_ep *ep)
 631 {
 632         struct usbhsg_uep *uep = usbhsg_ep_to_uep(ep);
 633         struct usbhs_pipe *pipe;
 634         unsigned long flags;
 635
 636         spin_lock_irqsave(&uep->lock, flags);
 637         pipe = usbhsg_uep_to_pipe(uep);
 638         if (!pipe)
 639                 goto out;
 640
 641         usbhsg_pipe_disable(uep);
 642         usbhs_pipe_free(pipe);
 643
 644         uep->pipe->mod_private  = NULL;
 645         uep->pipe               = NULL;
 646
 647 out:
 648         spin_unlock_irqrestore(&uep->lock, flags);
 649
 650         return 0;
 651 }
 652
 653 static struct usb_request *usbhsg_ep_alloc_request(struct usb_ep *ep,
 654                                                    gfp_t gfp_flags)
 655 {
 656         struct usbhsg_request *ureq;
 657
 658         ureq = kzalloc(sizeof *ureq, gfp_flags);
 659         if (!ureq)
 660                 return NULL;
 661
 662         usbhs_pkt_init(usbhsg_ureq_to_pkt(ureq));
 663
 664         return &ureq->req;
 665 }
 666
 667 static void usbhsg_ep_free_request(struct usb_ep *ep,
 668                                    struct usb_request *req)
 669 {
 670         struct usbhsg_request *ureq = usbhsg_req_to_ureq(req);
 671
 672         WARN_ON(!list_empty(&ureq->pkt.node));
 673         kfree(ureq);
 674 }
 675
 676 static int usbhsg_ep_queue(struct usb_ep *ep, struct usb_request *req,
 677                           gfp_t gfp_flags)
 678 {
 679         struct usbhsg_uep *uep = usbhsg_ep_to_uep(ep);
 680         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 681         struct usbhsg_request *ureq = usbhsg_req_to_ureq(req);
 682         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(uep);
 683
 684         /* param check */
 685         if (usbhsg_is_not_connected(gpriv)      ||
 686             unlikely(!gpriv->driver)            ||
 687             unlikely(!pipe))
 688                 return -ESHUTDOWN;
 689
 690         usbhsg_queue_push(uep, ureq);
 691
 692         return 0;
 693 }
 694
 695 static int usbhsg_ep_dequeue(struct usb_ep *ep, struct usb_request *req)
 696 {
 697         struct usbhsg_uep *uep = usbhsg_ep_to_uep(ep);
 698         struct usbhsg_request *ureq = usbhsg_req_to_ureq(req);
 699         struct usbhs_pipe *pipe;
 700         unsigned long flags;
 701
 702         spin_lock_irqsave(&uep->lock, flags);
 703         pipe = usbhsg_uep_to_pipe(uep);
 704         if (pipe)
 705                 usbhs_pkt_pop(pipe, usbhsg_ureq_to_pkt(ureq));
 706
 707         /*
 708          * To dequeue a request, this driver should call the usbhsg_queue_pop()
 709          * even if the pipe is NULL.
 710          */
 711         usbhsg_queue_pop(uep, ureq, -ECONNRESET);
 712         spin_unlock_irqrestore(&uep->lock, flags);
 713
 714         return 0;
 715 }
 716
 717 static int __usbhsg_ep_set_halt_wedge(struct usb_ep *ep, int halt, int wedge)
 718 {
 719         struct usbhsg_uep *uep = usbhsg_ep_to_uep(ep);
 720         struct usbhs_pipe *pipe = usbhsg_uep_to_pipe(uep);
 721         struct usbhsg_gpriv *gpriv = usbhsg_uep_to_gpriv(uep);
 722         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
 723         struct device *dev = usbhsg_gpriv_to_dev(gpriv);
 724         unsigned long flags;
 725         int ret = 0;
 726
 727         dev_dbg(dev, "set halt %d (pipe %d)\n",
 728                 halt, usbhs_pipe_number(pipe));
 729
 730         /********************  spin lock ********************/
 731         usbhs_lock(priv, flags);
 732
 733         /*
 734          * According to usb_ep_set_halt()'s description, this function should
 735          * return -EAGAIN if the IN endpoint has any queue or data. Note
 736          * that the usbhs_pipe_is_dir_in() returns false if the pipe is an
 737          * IN endpoint in the gadget mode.
 738          */
 739         if (!usbhs_pipe_is_dir_in(pipe) && (__usbhsf_pkt_get(pipe) ||
 740             usbhs_pipe_contains_transmittable_data(pipe))) {
 741                 ret = -EAGAIN;
 742                 goto out;
 743         }
 744
 745         if (halt)
 746                 usbhs_pipe_stall(pipe);
 747         else
 748                 usbhs_pipe_disable(pipe);
 749
 750         if (halt && wedge)
 751                 usbhsg_status_set(gpriv, USBHSG_STATUS_WEDGE);
 752         else
 753                 usbhsg_status_clr(gpriv, USBHSG_STATUS_WEDGE);
 754
 755 out:
 756         usbhs_unlock(priv, flags);
 757         /********************  spin unlock ******************/
 758
 759         return ret;
 760 }
 761
 762 static int usbhsg_ep_set_halt(struct usb_ep *ep, int value)
 763 {
 764         return __usbhsg_ep_set_halt_wedge(ep, value, 0);
 765 }
 766
 767 static int usbhsg_ep_set_wedge(struct usb_ep *ep)
 768 {
 769         return __usbhsg_ep_set_halt_wedge(ep, 1, 1);
 770 }
 771
 772 static const struct usb_ep_ops usbhsg_ep_ops = {
 773         .enable         = usbhsg_ep_enable,
 774         .disable        = usbhsg_ep_disable,
 775
 776         .alloc_request  = usbhsg_ep_alloc_request,
 777         .free_request   = usbhsg_ep_free_request,
 778
 779         .queue          = usbhsg_ep_queue,
 780         .dequeue        = usbhsg_ep_dequeue,
 781
 782         .set_halt       = usbhsg_ep_set_halt,
 783         .set_wedge      = usbhsg_ep_set_wedge,
 784 };
 785
 786 /*
 787  *              pullup control
 788  */
 789 static int usbhsg_can_pullup(struct usbhs_priv *priv)
 790 {
 791         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
 792
 793         return gpriv->driver &&
 794                usbhsg_status_has(gpriv, USBHSG_STATUS_SOFT_CONNECT);
 795 }
 796
 797 static void usbhsg_update_pullup(struct usbhs_priv *priv)
 798 {
 799         if (usbhsg_can_pullup(priv))
 800                 usbhs_sys_function_pullup(priv, 1);
 801         else
 802                 usbhs_sys_function_pullup(priv, 0);
 803 }
 804
 805 /*
 806  *              usb module start/end
 807  */
 808 static int usbhsg_try_start(struct usbhs_priv *priv, u32 status)
 809 {
 810         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
 811         struct usbhsg_uep *dcp = usbhsg_gpriv_to_dcp(gpriv);
 812         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
 813         struct device *dev = usbhs_priv_to_dev(priv);
 814         unsigned long flags;
 815         int ret = 0;
 816
 817         /********************  spin lock ********************/
 818         usbhs_lock(priv, flags);
 819
 820         usbhsg_status_set(gpriv, status);
 821         if (!(usbhsg_status_has(gpriv, USBHSG_STATUS_STARTED) &&
 822               usbhsg_status_has(gpriv, USBHSG_STATUS_REGISTERD)))
 823                 ret = -1; /* not ready */
 824
 825         usbhs_unlock(priv, flags);
 826         /********************  spin unlock ********************/
 827
 828         if (ret < 0)
 829                 return 0; /* not ready is not error */
 830
 831         /*
 832          * enable interrupt and systems if ready
 833          */
 834         dev_dbg(dev, "start gadget\n");
 835
 836         /*
 837          * pipe initialize and enable DCP
 838          */
 839         usbhs_fifo_init(priv);
 840         usbhs_pipe_init(priv,
 841                         usbhsg_dma_map_ctrl);
 842
 843         /* dcp init instead of usbhsg_ep_enable() */
 844         dcp->pipe               = usbhs_dcp_malloc(priv);
 845         dcp->pipe->mod_private  = dcp;
 846         usbhs_pipe_config_update(dcp->pipe, 0, 0, 64);
 847
 848         /*
 849          * system config enble
 850          * - HI speed
 851          * - function
 852          * - usb module
 853          */
 854         usbhs_sys_function_ctrl(priv, 1);
 855         usbhsg_update_pullup(priv);
 856
 857         /*
 858          * enable irq callback
 859          */
 860         mod->irq_dev_state      = usbhsg_irq_dev_state;
 861         mod->irq_ctrl_stage     = usbhsg_irq_ctrl_stage;
 862         usbhs_irq_callback_update(priv, mod);
 863
 864         return 0;
 865 }
 866
 867 static int usbhsg_try_stop(struct usbhs_priv *priv, u32 status)
 868 {
 869         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
 870         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
 871         struct usbhsg_uep *uep;
 872         struct device *dev = usbhs_priv_to_dev(priv);
 873         unsigned long flags;
 874         int ret = 0, i;
 875
 876         /********************  spin lock ********************/
 877         usbhs_lock(priv, flags);
 878
 879         usbhsg_status_clr(gpriv, status);
 880         if (!usbhsg_status_has(gpriv, USBHSG_STATUS_STARTED) &&
 881             !usbhsg_status_has(gpriv, USBHSG_STATUS_REGISTERD))
 882                 ret = -1; /* already done */
 883
 884         usbhs_unlock(priv, flags);
 885         /********************  spin unlock ********************/
 886
 887         if (ret < 0)
 888                 return 0; /* already done is not error */
 889
 890         /*
 891          * disable interrupt and systems if 1st try
 892          */
 893         usbhs_fifo_quit(priv);
 894
 895         /* disable all irq */
 896         mod->irq_dev_state      = NULL;
 897         mod->irq_ctrl_stage     = NULL;
 898         usbhs_irq_callback_update(priv, mod);
 899
 900         gpriv->gadget.speed = USB_SPEED_UNKNOWN;
 901
 902         /* disable sys */
 903         usbhs_sys_set_test_mode(priv, 0);
 904         usbhs_sys_function_ctrl(priv, 0);
 905
 906         /* disable all eps */
 907         usbhsg_for_each_uep_with_dcp(uep, gpriv, i)
 908                 usbhsg_ep_disable(&uep->ep);
 909
 910         dev_dbg(dev, "stop gadget\n");
 911
 912         return 0;
 913 }
 914
 915 /*
 916  * VBUS provided by the PHY
 917  */
 918 static int usbhsm_phy_get_vbus(struct platform_device *pdev)
 919 {
 920         struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
 921         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
 922
 923         return  gpriv->vbus_active;
 924 }
 925
 926 static void usbhs_mod_phy_mode(struct usbhs_priv *priv)
 927 {
 928         struct usbhs_mod_info *info = &priv->mod_info;
 929
 930         info->irq_vbus = NULL;
 931         info->get_vbus = usbhsm_phy_get_vbus;
 932
 933         usbhs_irq_callback_update(priv, NULL);
 934 }
 935
 936 /*
 937  *
 938  *              linux usb function
 939  *
 940  */
 941 static int usbhsg_gadget_start(struct usb_gadget *gadget,
 942                 struct usb_gadget_driver *driver)
 943 {
 944         struct usbhsg_gpriv *gpriv = usbhsg_gadget_to_gpriv(gadget);
 945         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
 946         struct device *dev = usbhs_priv_to_dev(priv);
 947         int ret;
 948
 949         if (!driver             ||
 950             !driver->setup      ||
 951             driver->max_speed < USB_SPEED_FULL)
 952                 return -EINVAL;
 953
 954         /* connect to bus through transceiver */
 955         if (!IS_ERR_OR_NULL(gpriv->transceiver)) {
 956                 ret = otg_set_peripheral(gpriv->transceiver->otg,
 957                                         &gpriv->gadget);
 958                 if (ret) {
 959                         dev_err(dev, "%s: can't bind to transceiver\n",
 960                                 gpriv->gadget.name);
 961                         return ret;
 962                 }
 963
 964                 /* get vbus using phy versions */
 965                 usbhs_mod_phy_mode(priv);
 966         }
 967
 968         /* first hook up the driver ... */
 969         gpriv->driver = driver;
 970
 971         return usbhsg_try_start(priv, USBHSG_STATUS_REGISTERD);
 972 }
 973
 974 static int usbhsg_gadget_stop(struct usb_gadget *gadget)
 975 {
 976         struct usbhsg_gpriv *gpriv = usbhsg_gadget_to_gpriv(gadget);
 977         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
 978
 979         usbhsg_try_stop(priv, USBHSG_STATUS_REGISTERD);
 980
 981         if (!IS_ERR_OR_NULL(gpriv->transceiver))
 982                 otg_set_peripheral(gpriv->transceiver->otg, NULL);
 983
 984         gpriv->driver = NULL;
 985
 986         return 0;
 987 }
 988
 989 /*
 990  *              usb gadget ops
 991  */
 992 static int usbhsg_get_frame(struct usb_gadget *gadget)
 993 {
 994         struct usbhsg_gpriv *gpriv = usbhsg_gadget_to_gpriv(gadget);
 995         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
 996
 997         return usbhs_frame_get_num(priv);
 998 }
 999
1000 static int usbhsg_pullup(struct usb_gadget *gadget, int is_on)
1001 {
1002         struct usbhsg_gpriv *gpriv = usbhsg_gadget_to_gpriv(gadget);
1003         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
1004         unsigned long flags;
1005
1006         usbhs_lock(priv, flags);
1007         if (is_on)
1008                 usbhsg_status_set(gpriv, USBHSG_STATUS_SOFT_CONNECT);
1009         else
1010                 usbhsg_status_clr(gpriv, USBHSG_STATUS_SOFT_CONNECT);
1011         usbhsg_update_pullup(priv);
1012         usbhs_unlock(priv, flags);
1013
1014         return 0;
1015 }
1016
1017 static int usbhsg_set_selfpowered(struct usb_gadget *gadget, int is_self)
1018 {
1019         struct usbhsg_gpriv *gpriv = usbhsg_gadget_to_gpriv(gadget);
1020
1021         if (is_self)
1022                 usbhsg_status_set(gpriv, USBHSG_STATUS_SELF_POWERED);
1023         else
1024                 usbhsg_status_clr(gpriv, USBHSG_STATUS_SELF_POWERED);
1025
1026         gadget->is_selfpowered = (is_self != 0);
1027
1028         return 0;
1029 }
1030
1031 static int usbhsg_vbus_session(struct usb_gadget *gadget, int is_active)
1032 {
1033         struct usbhsg_gpriv *gpriv = usbhsg_gadget_to_gpriv(gadget);
1034         struct usbhs_priv *priv = usbhsg_gpriv_to_priv(gpriv);
1035         struct platform_device *pdev = usbhs_priv_to_pdev(priv);
1036
1037         gpriv->vbus_active = !!is_active;
1038
1039         usbhsc_schedule_notify_hotplug(pdev);
1040
1041         return 0;
1042 }
1043
1044 static const struct usb_gadget_ops usbhsg_gadget_ops = {
1045         .get_frame              = usbhsg_get_frame,
1046         .set_selfpowered        = usbhsg_set_selfpowered,
1047         .udc_start              = usbhsg_gadget_start,
1048         .udc_stop               = usbhsg_gadget_stop,
1049         .pullup                 = usbhsg_pullup,
1050         .vbus_session           = usbhsg_vbus_session,
1051 };
1052
1053 static int usbhsg_start(struct usbhs_priv *priv)
1054 {
1055         return usbhsg_try_start(priv, USBHSG_STATUS_STARTED);
1056 }
1057
1058 static int usbhsg_stop(struct usbhs_priv *priv)
1059 {
1060         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
1061
1062         /* cable disconnect */
1063         if (gpriv->driver &&
1064             gpriv->driver->disconnect)
1065                 gpriv->driver->disconnect(&gpriv->gadget);
1066
1067         return usbhsg_try_stop(priv, USBHSG_STATUS_STARTED);
1068 }
1069
1070 int usbhs_mod_gadget_probe(struct usbhs_priv *priv)
1071 {
1072         struct usbhsg_gpriv *gpriv;
1073         struct usbhsg_uep *uep;
1074         struct device *dev = usbhs_priv_to_dev(priv);
1075         struct renesas_usbhs_driver_pipe_config *pipe_configs =
1076                                         usbhs_get_dparam(priv, pipe_configs);
1077         int pipe_size = usbhs_get_dparam(priv, pipe_size);
1078         int i;
1079         int ret;
1080
1081         gpriv = kzalloc(sizeof(struct usbhsg_gpriv), GFP_KERNEL);
1082         if (!gpriv)
1083                 return -ENOMEM;
1084
1085         uep = kcalloc(pipe_size, sizeof(struct usbhsg_uep), GFP_KERNEL);
1086         if (!uep) {
1087                 ret = -ENOMEM;
1088                 goto usbhs_mod_gadget_probe_err_gpriv;
1089         }
1090
1091         gpriv->transceiver = usb_get_phy(USB_PHY_TYPE_UNDEFINED);
1092         dev_info(dev, "%stransceiver found\n",
1093                  !IS_ERR(gpriv->transceiver) ? "" : "no ");
1094
1095         /*
1096          * CAUTION
1097          *
1098          * There is no guarantee that it is possible to access usb module here.
1099          * Don't accesses to it.
1100          * The accesse will be enable after "usbhsg_start"
1101          */
1102
1103         /*
1104          * register itself
1105          */
1106         usbhs_mod_register(priv, &gpriv->mod, USBHS_GADGET);
1107
1108         /* init gpriv */
1109         gpriv->mod.name         = "gadget";
1110         gpriv->mod.start        = usbhsg_start;
1111         gpriv->mod.stop         = usbhsg_stop;
1112         gpriv->uep              = uep;
1113         gpriv->uep_size         = pipe_size;
1114         usbhsg_status_init(gpriv);
1115
1116         /*
1117          * init gadget
1118          */
1119         gpriv->gadget.dev.parent        = dev;
1120         gpriv->gadget.name              = "renesas_usbhs_udc";
1121         gpriv->gadget.ops               = &usbhsg_gadget_ops;
1122         gpriv->gadget.max_speed         = USB_SPEED_HIGH;
1123         gpriv->gadget.quirk_avoids_skb_reserve = usbhs_get_dparam(priv,
1124                                                                 has_usb_dmac);
1125
1126         INIT_LIST_HEAD(&gpriv->gadget.ep_list);
1127
1128         /*
1129          * init usb_ep
1130          */
1131         usbhsg_for_each_uep_with_dcp(uep, gpriv, i) {
1132                 uep->gpriv      = gpriv;
1133                 uep->pipe       = NULL;
1134                 snprintf(uep->ep_name, EP_NAME_SIZE, "ep%d", i);
1135
1136                 uep->ep.name            = uep->ep_name;
1137                 uep->ep.ops             = &usbhsg_ep_ops;
1138                 INIT_LIST_HEAD(&uep->ep.ep_list);
1139                 spin_lock_init(&uep->lock);
1140
1141                 /* init DCP */
1142                 if (usbhsg_is_dcp(uep)) {
1143                         gpriv->gadget.ep0 = &uep->ep;
1144                         usb_ep_set_maxpacket_limit(&uep->ep, 64);
1145                         uep->ep.caps.type_control = true;
1146                 } else {
1147                         /* init normal pipe */
1148                         if (pipe_configs[i].type == USB_ENDPOINT_XFER_ISOC)
1149                                 uep->ep.caps.type_iso = true;
1150                         if (pipe_configs[i].type == USB_ENDPOINT_XFER_BULK)
1151                                 uep->ep.caps.type_bulk = true;
1152                         if (pipe_configs[i].type == USB_ENDPOINT_XFER_INT)
1153                                 uep->ep.caps.type_int = true;
1154                         usb_ep_set_maxpacket_limit(&uep->ep,
1155                                                    pipe_configs[i].bufsize);
1156                         list_add_tail(&uep->ep.ep_list, &gpriv->gadget.ep_list);
1157                 }
1158                 uep->ep.caps.dir_in = true;
1159                 uep->ep.caps.dir_out = true;
1160         }
1161
1162         ret = usb_add_gadget_udc(dev, &gpriv->gadget);
1163         if (ret)
1164                 goto err_add_udc;
1165
1166
1167         dev_info(dev, "gadget probed\n");
1168
1169         return 0;
1170
1171 err_add_udc:
1172         kfree(gpriv->uep);
1173
1174 usbhs_mod_gadget_probe_err_gpriv:
1175         kfree(gpriv);
1176
1177         return ret;
1178 }
1179
1180 void usbhs_mod_gadget_remove(struct usbhs_priv *priv)
1181 {
1182         struct usbhsg_gpriv *gpriv = usbhsg_priv_to_gpriv(priv);
1183
1184         usb_del_gadget_udc(&gpriv->gadget);
1185
1186         kfree(gpriv->uep);
1187         kfree(gpriv);
1188 }