drivers/staging/greybus/es2.c

   1 /*
   2  * Greybus "AP" USB driver for "ES2" controller chips
   3  *
   4  * Copyright 2014-2015 Google Inc.
   5  * Copyright 2014-2015 Linaro Ltd.
   6  *
   7  * Released under the GPLv2 only.
   8  */
   9 #include <linux/kthread.h>
  10 #include <linux/sizes.h>
  11 #include <linux/usb.h>
  12 #include <linux/kfifo.h>
  13 #include <linux/debugfs.h>
  14 #include <asm/unaligned.h>
  15
  16 #include "greybus.h"
  17 #include "kernel_ver.h"
  18 #include "connection.h"
  19 #include "greybus_trace.h"
  20
  21 /* Memory sizes for the buffers sent to/from the ES2 controller */
  22 #define ES2_GBUF_MSG_SIZE_MAX   2048
  23
  24 static const struct usb_device_id id_table[] = {
  25         { USB_DEVICE(0xffff, 0x0002) }, /* Made up number, delete once firmware is fixed to use real number */
  26         { USB_DEVICE(0x18d1, 0x1eaf) },
  27         { },
  28 };
  29 MODULE_DEVICE_TABLE(usb, id_table);
  30
  31 #define APB1_LOG_SIZE           SZ_16K
  32
  33 /* Number of bulk in and bulk out couple */
  34 #define NUM_BULKS               7
  35
  36 /*
  37  * Number of CPort IN urbs in flight at any point in time.
  38  * Adjust if we are having stalls in the USB buffer due to not enough urbs in
  39  * flight.
  40  */
  41 #define NUM_CPORT_IN_URB        4
  42
  43 /* Number of CPort OUT urbs in flight at any point in time.
  44  * Adjust if we get messages saying we are out of urbs in the system log.
  45  */
  46 #define NUM_CPORT_OUT_URB       (8 * NUM_BULKS)
  47
  48 /* vendor request APB1 log */
  49 #define REQUEST_LOG             0x02
  50
  51 /* vendor request to map a cport to bulk in and bulk out endpoints */
  52 #define REQUEST_EP_MAPPING      0x03
  53
  54 /* vendor request to get the number of cports available */
  55 #define REQUEST_CPORT_COUNT     0x04
  56
  57 /* vendor request to reset a cport state */
  58 #define REQUEST_RESET_CPORT     0x05
  59
  60 /* vendor request to time the latency of messages on a given cport */
  61 #define REQUEST_LATENCY_TAG_EN  0x06
  62 #define REQUEST_LATENCY_TAG_DIS 0x07
  63
  64 /*
  65  * @endpoint: bulk in endpoint for CPort data
  66  * @urb: array of urbs for the CPort in messages
  67  * @buffer: array of buffers for the @cport_in_urb urbs
  68  */
  69 struct es2_cport_in {
  70         __u8 endpoint;
  71         struct urb *urb[NUM_CPORT_IN_URB];
  72         u8 *buffer[NUM_CPORT_IN_URB];
  73 };
  74
  75 /*
  76  * @endpoint: bulk out endpoint for CPort data
  77  */
  78 struct es2_cport_out {
  79         __u8 endpoint;
  80 };
  81
  82 /**
  83  * es2_ap_dev - ES2 USB Bridge to AP structure
  84  * @usb_dev: pointer to the USB device we are.
  85  * @usb_intf: pointer to the USB interface we are bound to.
  86  * @hd: pointer to our gb_host_device structure
  87
  88  * @cport_in: endpoint, urbs and buffer for cport in messages
  89  * @cport_out: endpoint for for cport out messages
  90  * @cport_out_urb: array of urbs for the CPort out messages
  91  * @cport_out_urb_busy: array of flags to see if the @cport_out_urb is busy or
  92  *                      not.
  93  * @cport_out_urb_cancelled: array of flags indicating whether the
  94  *                      corresponding @cport_out_urb is being cancelled
  95  * @cport_out_urb_lock: locks the @cport_out_urb_busy "list"
  96  *
  97  * @apb_log_task: task pointer for logging thread
  98  * @apb_log_dentry: file system entry for the log file interface
  99  * @apb_log_enable_dentry: file system entry for enabling logging
 100  * @apb_log_fifo: kernel FIFO to carry logged data
 101  */
 102 struct es2_ap_dev {
 103         struct usb_device *usb_dev;
 104         struct usb_interface *usb_intf;
 105         struct gb_host_device *hd;
 106
 107         struct es2_cport_in cport_in[NUM_BULKS];
 108         struct es2_cport_out cport_out[NUM_BULKS];
 109         struct urb *cport_out_urb[NUM_CPORT_OUT_URB];
 110         bool cport_out_urb_busy[NUM_CPORT_OUT_URB];
 111         bool cport_out_urb_cancelled[NUM_CPORT_OUT_URB];
 112         spinlock_t cport_out_urb_lock;
 113
 114         int *cport_to_ep;
 115
 116         struct task_struct *apb_log_task;
 117         struct dentry *apb_log_dentry;
 118         struct dentry *apb_log_enable_dentry;
 119         DECLARE_KFIFO(apb_log_fifo, char, APB1_LOG_SIZE);
 120 };
 121
 122 /**
 123  * cport_to_ep - information about cport to endpoints mapping
 124  * @cport_id: the id of cport to map to endpoints
 125  * @endpoint_in: the endpoint number to use for in transfer
 126  * @endpoint_out: he endpoint number to use for out transfer
 127  */
 128 struct cport_to_ep {
 129         __le16 cport_id;
 130         __u8 endpoint_in;
 131         __u8 endpoint_out;
 132 };
 133
 134 static inline struct es2_ap_dev *hd_to_es2(struct gb_host_device *hd)
 135 {
 136         return (struct es2_ap_dev *)&hd->hd_priv;
 137 }
 138
 139 static void cport_out_callback(struct urb *urb);
 140 static void usb_log_enable(struct es2_ap_dev *es2);
 141 static void usb_log_disable(struct es2_ap_dev *es2);
 142
 143 /* Get the endpoints pair mapped to the cport */
 144 static int cport_to_ep_pair(struct es2_ap_dev *es2, u16 cport_id)
 145 {
 146         if (cport_id >= es2->hd->num_cports)
 147                 return 0;
 148         return es2->cport_to_ep[cport_id];
 149 }
 150
 151 #define ES2_TIMEOUT     500     /* 500 ms for the SVC to do something */
 152
 153 /* Disable for now until we work all of this out to keep a warning-free build */
 154 #if 0
 155 /* Test if the endpoints pair is already mapped to a cport */
 156 static int ep_pair_in_use(struct es2_ap_dev *es2, int ep_pair)
 157 {
 158         int i;
 159
 160         for (i = 0; i < es2->hd->num_cports; i++) {
 161                 if (es2->cport_to_ep[i] == ep_pair)
 162                         return 1;
 163         }
 164         return 0;
 165 }
 166
 167 /* Configure the endpoint mapping and send the request to APBridge */
 168 static int map_cport_to_ep(struct es2_ap_dev *es2,
 169                                 u16 cport_id, int ep_pair)
 170 {
 171         int retval;
 172         struct cport_to_ep *cport_to_ep;
 173
 174         if (ep_pair < 0 || ep_pair >= NUM_BULKS)
 175                 return -EINVAL;
 176         if (cport_id >= es2->hd->num_cports)
 177                 return -EINVAL;
 178         if (ep_pair && ep_pair_in_use(es2, ep_pair))
 179                 return -EINVAL;
 180
 181         cport_to_ep = kmalloc(sizeof(*cport_to_ep), GFP_KERNEL);
 182         if (!cport_to_ep)
 183                 return -ENOMEM;
 184
 185         es2->cport_to_ep[cport_id] = ep_pair;
 186         cport_to_ep->cport_id = cpu_to_le16(cport_id);
 187         cport_to_ep->endpoint_in = es2->cport_in[ep_pair].endpoint;
 188         cport_to_ep->endpoint_out = es2->cport_out[ep_pair].endpoint;
 189
 190         retval = usb_control_msg(es2->usb_dev,
 191                                  usb_sndctrlpipe(es2->usb_dev, 0),
 192                                  REQUEST_EP_MAPPING,
 193                                  USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
 194                                  0x00, 0x00,
 195                                  (char *)cport_to_ep,
 196                                  sizeof(*cport_to_ep),
 197                                  ES2_TIMEOUT);
 198         if (retval == sizeof(*cport_to_ep))
 199                 retval = 0;
 200         kfree(cport_to_ep);
 201
 202         return retval;
 203 }
 204
 205 /* Unmap a cport: use the muxed endpoints pair */
 206 static int unmap_cport(struct es2_ap_dev *es2, u16 cport_id)
 207 {
 208         return map_cport_to_ep(es2, cport_id, 0);
 209 }
 210 #endif
 211
 212 static int es2_cport_in_enable(struct es2_ap_dev *es2,
 213                                 struct es2_cport_in *cport_in)
 214 {
 215         struct urb *urb;
 216         int ret;
 217         int i;
 218
 219         for (i = 0; i < NUM_CPORT_IN_URB; ++i) {
 220                 urb = cport_in->urb[i];
 221
 222                 ret = usb_submit_urb(urb, GFP_KERNEL);
 223                 if (ret) {
 224                         dev_err(&es2->usb_dev->dev,
 225                                         "failed to submit in-urb: %d\n", ret);
 226                         goto err_kill_urbs;
 227                 }
 228         }
 229
 230         return 0;
 231
 232 err_kill_urbs:
 233         for (--i; i >= 0; --i) {
 234                 urb = cport_in->urb[i];
 235                 usb_kill_urb(urb);
 236         }
 237
 238         return ret;
 239 }
 240
 241 static void es2_cport_in_disable(struct es2_ap_dev *es2,
 242                                 struct es2_cport_in *cport_in)
 243 {
 244         struct urb *urb;
 245         int i;
 246
 247         for (i = 0; i < NUM_CPORT_IN_URB; ++i) {
 248                 urb = cport_in->urb[i];
 249                 usb_kill_urb(urb);
 250         }
 251 }
 252
 253 static struct urb *next_free_urb(struct es2_ap_dev *es2, gfp_t gfp_mask)
 254 {
 255         struct urb *urb = NULL;
 256         unsigned long flags;
 257         int i;
 258
 259         spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 260
 261         /* Look in our pool of allocated urbs first, as that's the "fastest" */
 262         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 263                 if (es2->cport_out_urb_busy[i] == false &&
 264                                 es2->cport_out_urb_cancelled[i] == false) {
 265                         es2->cport_out_urb_busy[i] = true;
 266                         urb = es2->cport_out_urb[i];
 267                         break;
 268                 }
 269         }
 270         spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 271         if (urb)
 272                 return urb;
 273
 274         /*
 275          * Crap, pool is empty, complain to the syslog and go allocate one
 276          * dynamically as we have to succeed.
 277          */
 278         dev_err(&es2->usb_dev->dev,
 279                 "No free CPort OUT urbs, having to dynamically allocate one!\n");
 280         return usb_alloc_urb(0, gfp_mask);
 281 }
 282
 283 static void free_urb(struct es2_ap_dev *es2, struct urb *urb)
 284 {
 285         unsigned long flags;
 286         int i;
 287         /*
 288          * See if this was an urb in our pool, if so mark it "free", otherwise
 289          * we need to free it ourselves.
 290          */
 291         spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 292         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 293                 if (urb == es2->cport_out_urb[i]) {
 294                         es2->cport_out_urb_busy[i] = false;
 295                         urb = NULL;
 296                         break;
 297                 }
 298         }
 299         spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 300
 301         /* If urb is not NULL, then we need to free this urb */
 302         usb_free_urb(urb);
 303 }
 304
 305 /*
 306  * We (ab)use the operation-message header pad bytes to transfer the
 307  * cport id in order to minimise overhead.
 308  */
 309 static void
 310 gb_message_cport_pack(struct gb_operation_msg_hdr *header, u16 cport_id)
 311 {
 312         header->pad[0] = cport_id;
 313 }
 314
 315 /* Clear the pad bytes used for the CPort id */
 316 static void gb_message_cport_clear(struct gb_operation_msg_hdr *header)
 317 {
 318         header->pad[0] = 0;
 319 }
 320
 321 /* Extract the CPort id packed into the header, and clear it */
 322 static u16 gb_message_cport_unpack(struct gb_operation_msg_hdr *header)
 323 {
 324         u16 cport_id = header->pad[0];
 325
 326         gb_message_cport_clear(header);
 327
 328         return cport_id;
 329 }
 330
 331 /*
 332  * Returns zero if the message was successfully queued, or a negative errno
 333  * otherwise.
 334  */
 335 static int message_send(struct gb_host_device *hd, u16 cport_id,
 336                         struct gb_message *message, gfp_t gfp_mask)
 337 {
 338         struct es2_ap_dev *es2 = hd_to_es2(hd);
 339         struct usb_device *udev = es2->usb_dev;
 340         size_t buffer_size;
 341         int retval;
 342         struct urb *urb;
 343         int ep_pair;
 344         unsigned long flags;
 345
 346         /*
 347          * The data actually transferred will include an indication
 348          * of where the data should be sent.  Do one last check of
 349          * the target CPort id before filling it in.
 350          */
 351         if (!cport_id_valid(hd, cport_id)) {
 352                 dev_err(&udev->dev, "invalid destination cport 0x%02x\n",
 353                                 cport_id);
 354                 return -EINVAL;
 355         }
 356
 357         /* Find a free urb */
 358         urb = next_free_urb(es2, gfp_mask);
 359         if (!urb)
 360                 return -ENOMEM;
 361
 362         spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 363         message->hcpriv = urb;
 364         spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 365
 366         /* Pack the cport id into the message header */
 367         gb_message_cport_pack(message->header, cport_id);
 368
 369         buffer_size = sizeof(*message->header) + message->payload_size;
 370
 371         ep_pair = cport_to_ep_pair(es2, cport_id);
 372         usb_fill_bulk_urb(urb, udev,
 373                           usb_sndbulkpipe(udev,
 374                                           es2->cport_out[ep_pair].endpoint),
 375                           message->buffer, buffer_size,
 376                           cport_out_callback, message);
 377         urb->transfer_flags |= URB_ZERO_PACKET;
 378         trace_gb_host_device_send(hd, cport_id, buffer_size);
 379         retval = usb_submit_urb(urb, gfp_mask);
 380         if (retval) {
 381                 dev_err(&udev->dev, "failed to submit out-urb: %d\n", retval);
 382
 383                 spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 384                 message->hcpriv = NULL;
 385                 spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 386
 387                 free_urb(es2, urb);
 388                 gb_message_cport_clear(message->header);
 389
 390                 return retval;
 391         }
 392
 393         return 0;
 394 }
 395
 396 /*
 397  * Can not be called in atomic context.
 398  */
 399 static void message_cancel(struct gb_message *message)
 400 {
 401         struct gb_host_device *hd = message->operation->connection->hd;
 402         struct es2_ap_dev *es2 = hd_to_es2(hd);
 403         struct urb *urb;
 404         int i;
 405
 406         might_sleep();
 407
 408         spin_lock_irq(&es2->cport_out_urb_lock);
 409         urb = message->hcpriv;
 410
 411         /* Prevent dynamically allocated urb from being deallocated. */
 412         usb_get_urb(urb);
 413
 414         /* Prevent pre-allocated urb from being reused. */
 415         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 416                 if (urb == es2->cport_out_urb[i]) {
 417                         es2->cport_out_urb_cancelled[i] = true;
 418                         break;
 419                 }
 420         }
 421         spin_unlock_irq(&es2->cport_out_urb_lock);
 422
 423         usb_kill_urb(urb);
 424
 425         if (i < NUM_CPORT_OUT_URB) {
 426                 spin_lock_irq(&es2->cport_out_urb_lock);
 427                 es2->cport_out_urb_cancelled[i] = false;
 428                 spin_unlock_irq(&es2->cport_out_urb_lock);
 429         }
 430
 431         usb_free_urb(urb);
 432 }
 433
 434 static int cport_reset(struct gb_host_device *hd, u16 cport_id)
 435 {
 436         struct es2_ap_dev *es2 = hd_to_es2(hd);
 437         struct usb_device *udev = es2->usb_dev;
 438         int retval;
 439
 440         retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 441                                  REQUEST_RESET_CPORT,
 442                                  USB_DIR_OUT | USB_TYPE_VENDOR |
 443                                  USB_RECIP_INTERFACE, 0, cport_id,
 444                                  NULL, 0, ES2_TIMEOUT);
 445         if (retval < 0) {
 446                 dev_err(&udev->dev, "failed to reset cport %hu: %d\n", cport_id,
 447                         retval);
 448                 return retval;
 449         }
 450
 451         return 0;
 452 }
 453
 454 static int cport_enable(struct gb_host_device *hd, u16 cport_id)
 455 {
 456         int retval;
 457
 458         if (cport_id != GB_SVC_CPORT_ID) {
 459                 retval = cport_reset(hd, cport_id);
 460                 if (retval)
 461                         return retval;
 462         }
 463
 464         return 0;
 465 }
 466
 467 static int latency_tag_enable(struct gb_host_device *hd, u16 cport_id)
 468 {
 469         int retval;
 470         struct es2_ap_dev *es2 = hd_to_es2(hd);
 471         struct usb_device *udev = es2->usb_dev;
 472
 473         if (!cport_id_valid(hd, cport_id)) {
 474                 dev_err(&udev->dev, "invalid destination cport 0x%02x\n",
 475                         cport_id);
 476                 return -EINVAL;
 477         }
 478
 479         retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 480                                  REQUEST_LATENCY_TAG_EN,
 481                                  USB_DIR_OUT | USB_TYPE_VENDOR |
 482                                  USB_RECIP_INTERFACE, cport_id, 0, NULL,
 483                                  0, ES2_TIMEOUT);
 484
 485         if (retval < 0)
 486                 dev_err(&udev->dev, "Cannot enable latency tag for cport %d\n",
 487                         cport_id);
 488         return retval;
 489 }
 490
 491 static int latency_tag_disable(struct gb_host_device *hd, u16 cport_id)
 492 {
 493         int retval;
 494         struct es2_ap_dev *es2 = hd_to_es2(hd);
 495         struct usb_device *udev = es2->usb_dev;
 496
 497         if (!cport_id_valid(hd, cport_id)) {
 498                 dev_err(&udev->dev, "invalid destination cport 0x%02x\n",
 499                         cport_id);
 500                 return -EINVAL;
 501         }
 502
 503         retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 504                                  REQUEST_LATENCY_TAG_DIS,
 505                                  USB_DIR_OUT | USB_TYPE_VENDOR |
 506                                  USB_RECIP_INTERFACE, cport_id, 0, NULL,
 507                                  0, ES2_TIMEOUT);
 508
 509         if (retval < 0)
 510                 dev_err(&udev->dev, "Cannot disable latency tag for cport %d\n",
 511                         cport_id);
 512         return retval;
 513 }
 514
 515 static struct gb_hd_driver es2_driver = {
 516         .hd_priv_size           = sizeof(struct es2_ap_dev),
 517         .message_send           = message_send,
 518         .message_cancel         = message_cancel,
 519         .cport_enable           = cport_enable,
 520         .latency_tag_enable     = latency_tag_enable,
 521         .latency_tag_disable    = latency_tag_disable,
 522 };
 523
 524 /* Common function to report consistent warnings based on URB status */
 525 static int check_urb_status(struct urb *urb)
 526 {
 527         struct device *dev = &urb->dev->dev;
 528         int status = urb->status;
 529
 530         switch (status) {
 531         case 0:
 532                 return 0;
 533
 534         case -EOVERFLOW:
 535                 dev_err(dev, "%s: overflow actual length is %d\n",
 536                         __func__, urb->actual_length);
 537         case -ECONNRESET:
 538         case -ENOENT:
 539         case -ESHUTDOWN:
 540         case -EILSEQ:
 541         case -EPROTO:
 542                 /* device is gone, stop sending */
 543                 return status;
 544         }
 545         dev_err(dev, "%s: unknown status %d\n", __func__, status);
 546
 547         return -EAGAIN;
 548 }
 549
 550 static void ap_disconnect(struct usb_interface *interface)
 551 {
 552         struct es2_ap_dev *es2;
 553         struct usb_device *udev;
 554         int *cport_to_ep;
 555         int bulk_in;
 556         int i;
 557
 558         es2 = usb_get_intfdata(interface);
 559         if (!es2)
 560                 return;
 561
 562         for (i = 0; i < NUM_BULKS; ++i)
 563                 es2_cport_in_disable(es2, &es2->cport_in[i]);
 564
 565         debugfs_remove(es2->apb_log_enable_dentry);
 566         usb_log_disable(es2);
 567
 568         /* Tear down everything! */
 569         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 570                 struct urb *urb = es2->cport_out_urb[i];
 571
 572                 if (!urb)
 573                         break;
 574                 usb_kill_urb(urb);
 575                 usb_free_urb(urb);
 576                 es2->cport_out_urb[i] = NULL;
 577                 es2->cport_out_urb_busy[i] = false;     /* just to be anal */
 578         }
 579
 580         for (bulk_in = 0; bulk_in < NUM_BULKS; bulk_in++) {
 581                 struct es2_cport_in *cport_in = &es2->cport_in[bulk_in];
 582
 583                 for (i = 0; i < NUM_CPORT_IN_URB; ++i) {
 584                         struct urb *urb = cport_in->urb[i];
 585
 586                         if (!urb)
 587                                 break;
 588                         usb_free_urb(urb);
 589                         kfree(cport_in->buffer[i]);
 590                         cport_in->buffer[i] = NULL;
 591                 }
 592         }
 593
 594         usb_set_intfdata(interface, NULL);
 595         udev = es2->usb_dev;
 596         cport_to_ep = es2->cport_to_ep;
 597         gb_hd_remove(es2->hd);
 598
 599         kfree(cport_to_ep);
 600         usb_put_dev(udev);
 601 }
 602
 603 static void cport_in_callback(struct urb *urb)
 604 {
 605         struct gb_host_device *hd = urb->context;
 606         struct device *dev = &urb->dev->dev;
 607         struct gb_operation_msg_hdr *header;
 608         int status = check_urb_status(urb);
 609         int retval;
 610         u16 cport_id;
 611
 612         if (status) {
 613                 if ((status == -EAGAIN) || (status == -EPROTO))
 614                         goto exit;
 615                 dev_err(dev, "urb cport in error %d (dropped)\n", status);
 616                 return;
 617         }
 618
 619         if (urb->actual_length < sizeof(*header)) {
 620                 dev_err(dev, "short message received\n");
 621                 goto exit;
 622         }
 623
 624         /* Extract the CPort id, which is packed in the message header */
 625         header = urb->transfer_buffer;
 626         cport_id = gb_message_cport_unpack(header);
 627
 628         if (cport_id_valid(hd, cport_id)) {
 629                 trace_gb_host_device_recv(hd, cport_id, urb->actual_length);
 630                 greybus_data_rcvd(hd, cport_id, urb->transfer_buffer,
 631                                                         urb->actual_length);
 632         } else {
 633                 dev_err(dev, "invalid cport id 0x%02x received\n", cport_id);
 634         }
 635 exit:
 636         /* put our urb back in the request pool */
 637         retval = usb_submit_urb(urb, GFP_ATOMIC);
 638         if (retval)
 639                 dev_err(dev, "failed to resubmit in-urb: %d\n", retval);
 640 }
 641
 642 static void cport_out_callback(struct urb *urb)
 643 {
 644         struct gb_message *message = urb->context;
 645         struct gb_host_device *hd = message->operation->connection->hd;
 646         struct es2_ap_dev *es2 = hd_to_es2(hd);
 647         int status = check_urb_status(urb);
 648         unsigned long flags;
 649
 650         gb_message_cport_clear(message->header);
 651
 652         spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 653         message->hcpriv = NULL;
 654         spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 655
 656         /*
 657          * Tell the submitter that the message send (attempt) is
 658          * complete, and report the status.
 659          */
 660         greybus_message_sent(hd, message, status);
 661
 662         free_urb(es2, urb);
 663 }
 664
 665 #define APB1_LOG_MSG_SIZE       64
 666 static void apb_log_get(struct es2_ap_dev *es2, char *buf)
 667 {
 668         int retval;
 669
 670         /* SVC messages go down our control pipe */
 671         do {
 672                 retval = usb_control_msg(es2->usb_dev,
 673                                         usb_rcvctrlpipe(es2->usb_dev, 0),
 674                                         REQUEST_LOG,
 675                                         USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
 676                                         0x00, 0x00,
 677                                         buf,
 678                                         APB1_LOG_MSG_SIZE,
 679                                         ES2_TIMEOUT);
 680                 if (retval > 0)
 681                         kfifo_in(&es2->apb_log_fifo, buf, retval);
 682         } while (retval > 0);
 683 }
 684
 685 static int apb_log_poll(void *data)
 686 {
 687         struct es2_ap_dev *es2 = data;
 688         char *buf;
 689
 690         buf = kmalloc(APB1_LOG_MSG_SIZE, GFP_KERNEL);
 691         if (!buf)
 692                 return -ENOMEM;
 693
 694         while (!kthread_should_stop()) {
 695                 msleep(1000);
 696                 apb_log_get(es2, buf);
 697         }
 698
 699         kfree(buf);
 700
 701         return 0;
 702 }
 703
 704 static ssize_t apb_log_read(struct file *f, char __user *buf,
 705                                 size_t count, loff_t *ppos)
 706 {
 707         struct es2_ap_dev *es2 = f->f_inode->i_private;
 708         ssize_t ret;
 709         size_t copied;
 710         char *tmp_buf;
 711
 712         if (count > APB1_LOG_SIZE)
 713                 count = APB1_LOG_SIZE;
 714
 715         tmp_buf = kmalloc(count, GFP_KERNEL);
 716         if (!tmp_buf)
 717                 return -ENOMEM;
 718
 719         copied = kfifo_out(&es2->apb_log_fifo, tmp_buf, count);
 720         ret = simple_read_from_buffer(buf, count, ppos, tmp_buf, copied);
 721
 722         kfree(tmp_buf);
 723
 724         return ret;
 725 }
 726
 727 static const struct file_operations apb_log_fops = {
 728         .read   = apb_log_read,
 729 };
 730
 731 static void usb_log_enable(struct es2_ap_dev *es2)
 732 {
 733         if (!IS_ERR_OR_NULL(es2->apb_log_task))
 734                 return;
 735
 736         /* get log from APB1 */
 737         es2->apb_log_task = kthread_run(apb_log_poll, es2, "apb_log");
 738         if (IS_ERR(es2->apb_log_task))
 739                 return;
 740         /* XXX We will need to rename this per APB */
 741         es2->apb_log_dentry = debugfs_create_file("apb_log", S_IRUGO,
 742                                                 gb_debugfs_get(), NULL,
 743                                                 &apb_log_fops);
 744 }
 745
 746 static void usb_log_disable(struct es2_ap_dev *es2)
 747 {
 748         if (IS_ERR_OR_NULL(es2->apb_log_task))
 749                 return;
 750
 751         debugfs_remove(es2->apb_log_dentry);
 752         es2->apb_log_dentry = NULL;
 753
 754         kthread_stop(es2->apb_log_task);
 755         es2->apb_log_task = NULL;
 756 }
 757
 758 static ssize_t apb_log_enable_read(struct file *f, char __user *buf,
 759                                 size_t count, loff_t *ppos)
 760 {
 761         struct es2_ap_dev *es2 = f->f_inode->i_private;
 762         int enable = !IS_ERR_OR_NULL(es2->apb_log_task);
 763         char tmp_buf[3];
 764
 765         sprintf(tmp_buf, "%d\n", enable);
 766         return simple_read_from_buffer(buf, count, ppos, tmp_buf, 3);
 767 }
 768
 769 static ssize_t apb_log_enable_write(struct file *f, const char __user *buf,
 770                                 size_t count, loff_t *ppos)
 771 {
 772         int enable;
 773         ssize_t retval;
 774         struct es2_ap_dev *es2 = f->f_inode->i_private;
 775
 776         retval = kstrtoint_from_user(buf, count, 10, &enable);
 777         if (retval)
 778                 return retval;
 779
 780         if (enable)
 781                 usb_log_enable(es2);
 782         else
 783                 usb_log_disable(es2);
 784
 785         return count;
 786 }
 787
 788 static const struct file_operations apb_log_enable_fops = {
 789         .read   = apb_log_enable_read,
 790         .write  = apb_log_enable_write,
 791 };
 792
 793 static int apb_get_cport_count(struct usb_device *udev)
 794 {
 795         int retval;
 796         __le16 *cport_count;
 797
 798         cport_count = kmalloc(sizeof(*cport_count), GFP_KERNEL);
 799         if (!cport_count)
 800                 return -ENOMEM;
 801
 802         retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
 803                                  REQUEST_CPORT_COUNT,
 804                                  USB_DIR_IN | USB_TYPE_VENDOR |
 805                                  USB_RECIP_INTERFACE, 0, 0, cport_count,
 806                                  sizeof(*cport_count), ES2_TIMEOUT);
 807         if (retval < 0) {
 808                 dev_err(&udev->dev, "Cannot retrieve CPort count: %d\n",
 809                         retval);
 810                 goto out;
 811         }
 812
 813         retval = le16_to_cpu(*cport_count);
 814
 815         /* We need to fit a CPort ID in one byte of a message header */
 816         if (retval > U8_MAX) {
 817                 retval = U8_MAX;
 818                 dev_warn(&udev->dev, "Limiting number of CPorts to U8_MAX\n");
 819         }
 820
 821 out:
 822         kfree(cport_count);
 823         return retval;
 824 }
 825
 826 /*
 827  * The ES2 USB Bridge device has 15 endpoints
 828  * 1 Control - usual USB stuff + AP -> APBridgeA messages
 829  * 7 Bulk IN - CPort data in
 830  * 7 Bulk OUT - CPort data out
 831  */
 832 static int ap_probe(struct usb_interface *interface,
 833                     const struct usb_device_id *id)
 834 {
 835         struct es2_ap_dev *es2;
 836         struct gb_host_device *hd;
 837         struct usb_device *udev;
 838         struct usb_host_interface *iface_desc;
 839         struct usb_endpoint_descriptor *endpoint;
 840         int bulk_in = 0;
 841         int bulk_out = 0;
 842         int retval = -ENOMEM;
 843         int i;
 844         int num_cports;
 845
 846         udev = usb_get_dev(interface_to_usbdev(interface));
 847
 848         num_cports = apb_get_cport_count(udev);
 849         if (num_cports < 0) {
 850                 usb_put_dev(udev);
 851                 dev_err(&udev->dev, "Cannot retrieve CPort count: %d\n",
 852                         num_cports);
 853                 return num_cports;
 854         }
 855
 856         hd = gb_hd_create(&es2_driver, &udev->dev, ES2_GBUF_MSG_SIZE_MAX,
 857                                 num_cports);
 858         if (IS_ERR(hd)) {
 859                 usb_put_dev(udev);
 860                 return PTR_ERR(hd);
 861         }
 862
 863         es2 = hd_to_es2(hd);
 864         es2->hd = hd;
 865         es2->usb_intf = interface;
 866         es2->usb_dev = udev;
 867         spin_lock_init(&es2->cport_out_urb_lock);
 868         INIT_KFIFO(es2->apb_log_fifo);
 869         usb_set_intfdata(interface, es2);
 870
 871         es2->cport_to_ep = kcalloc(hd->num_cports, sizeof(*es2->cport_to_ep),
 872                                    GFP_KERNEL);
 873         if (!es2->cport_to_ep) {
 874                 retval = -ENOMEM;
 875                 goto error;
 876         }
 877
 878         /* find all bulk endpoints */
 879         iface_desc = interface->cur_altsetting;
 880         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
 881                 endpoint = &iface_desc->endpoint[i].desc;
 882
 883                 if (usb_endpoint_is_bulk_in(endpoint)) {
 884                         es2->cport_in[bulk_in++].endpoint =
 885                                 endpoint->bEndpointAddress;
 886                 } else if (usb_endpoint_is_bulk_out(endpoint)) {
 887                         es2->cport_out[bulk_out++].endpoint =
 888                                 endpoint->bEndpointAddress;
 889                 } else {
 890                         dev_err(&udev->dev,
 891                                 "Unknown endpoint type found, address %x\n",
 892                                 endpoint->bEndpointAddress);
 893                 }
 894         }
 895         if (bulk_in != NUM_BULKS || bulk_out != NUM_BULKS) {
 896                 dev_err(&udev->dev, "Not enough endpoints found in device, aborting!\n");
 897                 goto error;
 898         }
 899
 900         /* Allocate buffers for our cport in messages */
 901         for (bulk_in = 0; bulk_in < NUM_BULKS; bulk_in++) {
 902                 struct es2_cport_in *cport_in = &es2->cport_in[bulk_in];
 903
 904                 for (i = 0; i < NUM_CPORT_IN_URB; ++i) {
 905                         struct urb *urb;
 906                         u8 *buffer;
 907
 908                         urb = usb_alloc_urb(0, GFP_KERNEL);
 909                         if (!urb)
 910                                 goto error;
 911                         buffer = kmalloc(ES2_GBUF_MSG_SIZE_MAX, GFP_KERNEL);
 912                         if (!buffer)
 913                                 goto error;
 914
 915                         usb_fill_bulk_urb(urb, udev,
 916                                           usb_rcvbulkpipe(udev,
 917                                                           cport_in->endpoint),
 918                                           buffer, ES2_GBUF_MSG_SIZE_MAX,
 919                                           cport_in_callback, hd);
 920                         cport_in->urb[i] = urb;
 921                         cport_in->buffer[i] = buffer;
 922                 }
 923         }
 924
 925         /* Allocate urbs for our CPort OUT messages */
 926         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 927                 struct urb *urb;
 928
 929                 urb = usb_alloc_urb(0, GFP_KERNEL);
 930                 if (!urb)
 931                         goto error;
 932
 933                 es2->cport_out_urb[i] = urb;
 934                 es2->cport_out_urb_busy[i] = false;     /* just to be anal */
 935         }
 936
 937         /* XXX We will need to rename this per APB */
 938         es2->apb_log_enable_dentry = debugfs_create_file("apb_log_enable",
 939                                                         (S_IWUSR | S_IRUGO),
 940                                                         gb_debugfs_get(), es2,
 941                                                         &apb_log_enable_fops);
 942
 943         for (i = 0; i < NUM_BULKS; ++i) {
 944                 retval = es2_cport_in_enable(es2, &es2->cport_in[i]);
 945                 if (retval)
 946                         goto error;
 947         }
 948
 949         return 0;
 950 error:
 951         ap_disconnect(interface);
 952
 953         return retval;
 954 }
 955
 956 static struct usb_driver es2_ap_driver = {
 957         .name =         "es2_ap_driver",
 958         .probe =        ap_probe,
 959         .disconnect =   ap_disconnect,
 960         .id_table =     id_table,
 961 };
 962
 963 module_usb_driver(es2_ap_driver);
 964
 965 MODULE_LICENSE("GPL v2");
 966 MODULE_AUTHOR("Greg Kroah-Hartman <gregkh@linuxfoundation.org>");