drivers/usb/renesas_usbhs/mod_gadget.c

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