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 struct urb *next_free_urb(struct es2_ap_dev *es2, gfp_t gfp_mask)
 213 {
 214         struct urb *urb = NULL;
 215         unsigned long flags;
 216         int i;
 217
 218         spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 219
 220         /* Look in our pool of allocated urbs first, as that's the "fastest" */
 221         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 222                 if (es2->cport_out_urb_busy[i] == false &&
 223                                 es2->cport_out_urb_cancelled[i] == false) {
 224                         es2->cport_out_urb_busy[i] = true;
 225                         urb = es2->cport_out_urb[i];
 226                         break;
 227                 }
 228         }
 229         spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 230         if (urb)
 231                 return urb;
 232
 233         /*
 234          * Crap, pool is empty, complain to the syslog and go allocate one
 235          * dynamically as we have to succeed.
 236          */
 237         dev_err(&es2->usb_dev->dev,
 238                 "No free CPort OUT urbs, having to dynamically allocate one!\n");
 239         return usb_alloc_urb(0, gfp_mask);
 240 }
 241
 242 static void free_urb(struct es2_ap_dev *es2, struct urb *urb)
 243 {
 244         unsigned long flags;
 245         int i;
 246         /*
 247          * See if this was an urb in our pool, if so mark it "free", otherwise
 248          * we need to free it ourselves.
 249          */
 250         spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 251         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 252                 if (urb == es2->cport_out_urb[i]) {
 253                         es2->cport_out_urb_busy[i] = false;
 254                         urb = NULL;
 255                         break;
 256                 }
 257         }
 258         spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 259
 260         /* If urb is not NULL, then we need to free this urb */
 261         usb_free_urb(urb);
 262 }
 263
 264 /*
 265  * We (ab)use the operation-message header pad bytes to transfer the
 266  * cport id in order to minimise overhead.
 267  */
 268 static void
 269 gb_message_cport_pack(struct gb_operation_msg_hdr *header, u16 cport_id)
 270 {
 271         header->pad[0] = cport_id;
 272 }
 273
 274 /* Clear the pad bytes used for the CPort id */
 275 static void gb_message_cport_clear(struct gb_operation_msg_hdr *header)
 276 {
 277         header->pad[0] = 0;
 278 }
 279
 280 /* Extract the CPort id packed into the header, and clear it */
 281 static u16 gb_message_cport_unpack(struct gb_operation_msg_hdr *header)
 282 {
 283         u16 cport_id = header->pad[0];
 284
 285         gb_message_cport_clear(header);
 286
 287         return cport_id;
 288 }
 289
 290 /*
 291  * Returns zero if the message was successfully queued, or a negative errno
 292  * otherwise.
 293  */
 294 static int message_send(struct gb_host_device *hd, u16 cport_id,
 295                         struct gb_message *message, gfp_t gfp_mask)
 296 {
 297         struct es2_ap_dev *es2 = hd_to_es2(hd);
 298         struct usb_device *udev = es2->usb_dev;
 299         size_t buffer_size;
 300         int retval;
 301         struct urb *urb;
 302         int ep_pair;
 303         unsigned long flags;
 304
 305         /*
 306          * The data actually transferred will include an indication
 307          * of where the data should be sent.  Do one last check of
 308          * the target CPort id before filling it in.
 309          */
 310         if (!cport_id_valid(hd, cport_id)) {
 311                 dev_err(&udev->dev, "invalid destination cport 0x%02x\n",
 312                                 cport_id);
 313                 return -EINVAL;
 314         }
 315
 316         /* Find a free urb */
 317         urb = next_free_urb(es2, gfp_mask);
 318         if (!urb)
 319                 return -ENOMEM;
 320
 321         spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 322         message->hcpriv = urb;
 323         spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 324
 325         /* Pack the cport id into the message header */
 326         gb_message_cport_pack(message->header, cport_id);
 327
 328         buffer_size = sizeof(*message->header) + message->payload_size;
 329
 330         ep_pair = cport_to_ep_pair(es2, cport_id);
 331         usb_fill_bulk_urb(urb, udev,
 332                           usb_sndbulkpipe(udev,
 333                                           es2->cport_out[ep_pair].endpoint),
 334                           message->buffer, buffer_size,
 335                           cport_out_callback, message);
 336         urb->transfer_flags |= URB_ZERO_PACKET;
 337         trace_gb_host_device_send(hd, cport_id, buffer_size);
 338         retval = usb_submit_urb(urb, gfp_mask);
 339         if (retval) {
 340                 dev_err(&udev->dev, "failed to submit out-urb: %d\n", retval);
 341
 342                 spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 343                 message->hcpriv = NULL;
 344                 spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 345
 346                 free_urb(es2, urb);
 347                 gb_message_cport_clear(message->header);
 348
 349                 return retval;
 350         }
 351
 352         return 0;
 353 }
 354
 355 /*
 356  * Can not be called in atomic context.
 357  */
 358 static void message_cancel(struct gb_message *message)
 359 {
 360         struct gb_host_device *hd = message->operation->connection->hd;
 361         struct es2_ap_dev *es2 = hd_to_es2(hd);
 362         struct urb *urb;
 363         int i;
 364
 365         might_sleep();
 366
 367         spin_lock_irq(&es2->cport_out_urb_lock);
 368         urb = message->hcpriv;
 369
 370         /* Prevent dynamically allocated urb from being deallocated. */
 371         usb_get_urb(urb);
 372
 373         /* Prevent pre-allocated urb from being reused. */
 374         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 375                 if (urb == es2->cport_out_urb[i]) {
 376                         es2->cport_out_urb_cancelled[i] = true;
 377                         break;
 378                 }
 379         }
 380         spin_unlock_irq(&es2->cport_out_urb_lock);
 381
 382         usb_kill_urb(urb);
 383
 384         if (i < NUM_CPORT_OUT_URB) {
 385                 spin_lock_irq(&es2->cport_out_urb_lock);
 386                 es2->cport_out_urb_cancelled[i] = false;
 387                 spin_unlock_irq(&es2->cport_out_urb_lock);
 388         }
 389
 390         usb_free_urb(urb);
 391 }
 392
 393 static int cport_reset(struct gb_host_device *hd, u16 cport_id)
 394 {
 395         struct es2_ap_dev *es2 = hd_to_es2(hd);
 396         struct usb_device *udev = es2->usb_dev;
 397         int retval;
 398
 399         retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 400                                  REQUEST_RESET_CPORT,
 401                                  USB_DIR_OUT | USB_TYPE_VENDOR |
 402                                  USB_RECIP_INTERFACE, 0, cport_id,
 403                                  NULL, 0, ES2_TIMEOUT);
 404         if (retval < 0) {
 405                 dev_err(&udev->dev, "failed to reset cport %hu: %d\n", cport_id,
 406                         retval);
 407                 return retval;
 408         }
 409
 410         return 0;
 411 }
 412
 413 static int cport_enable(struct gb_host_device *hd, u16 cport_id)
 414 {
 415         int retval;
 416
 417         if (cport_id != GB_SVC_CPORT_ID) {
 418                 retval = cport_reset(hd, cport_id);
 419                 if (retval)
 420                         return retval;
 421         }
 422
 423         return 0;
 424 }
 425
 426 static int latency_tag_enable(struct gb_host_device *hd, u16 cport_id)
 427 {
 428         int retval;
 429         struct es2_ap_dev *es2 = hd_to_es2(hd);
 430         struct usb_device *udev = es2->usb_dev;
 431
 432         if (!cport_id_valid(hd, cport_id)) {
 433                 dev_err(&udev->dev, "invalid destination cport 0x%02x\n",
 434                         cport_id);
 435                 return -EINVAL;
 436         }
 437
 438         retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 439                                  REQUEST_LATENCY_TAG_EN,
 440                                  USB_DIR_OUT | USB_TYPE_VENDOR |
 441                                  USB_RECIP_INTERFACE, cport_id, 0, NULL,
 442                                  0, ES2_TIMEOUT);
 443
 444         if (retval < 0)
 445                 dev_err(&udev->dev, "Cannot enable latency tag for cport %d\n",
 446                         cport_id);
 447         return retval;
 448 }
 449
 450 static int latency_tag_disable(struct gb_host_device *hd, u16 cport_id)
 451 {
 452         int retval;
 453         struct es2_ap_dev *es2 = hd_to_es2(hd);
 454         struct usb_device *udev = es2->usb_dev;
 455
 456         if (!cport_id_valid(hd, cport_id)) {
 457                 dev_err(&udev->dev, "invalid destination cport 0x%02x\n",
 458                         cport_id);
 459                 return -EINVAL;
 460         }
 461
 462         retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 463                                  REQUEST_LATENCY_TAG_DIS,
 464                                  USB_DIR_OUT | USB_TYPE_VENDOR |
 465                                  USB_RECIP_INTERFACE, cport_id, 0, NULL,
 466                                  0, ES2_TIMEOUT);
 467
 468         if (retval < 0)
 469                 dev_err(&udev->dev, "Cannot disable latency tag for cport %d\n",
 470                         cport_id);
 471         return retval;
 472 }
 473
 474 static struct gb_hd_driver es2_driver = {
 475         .hd_priv_size           = sizeof(struct es2_ap_dev),
 476         .message_send           = message_send,
 477         .message_cancel         = message_cancel,
 478         .cport_enable           = cport_enable,
 479         .latency_tag_enable     = latency_tag_enable,
 480         .latency_tag_disable    = latency_tag_disable,
 481 };
 482
 483 /* Common function to report consistent warnings based on URB status */
 484 static int check_urb_status(struct urb *urb)
 485 {
 486         struct device *dev = &urb->dev->dev;
 487         int status = urb->status;
 488
 489         switch (status) {
 490         case 0:
 491                 return 0;
 492
 493         case -EOVERFLOW:
 494                 dev_err(dev, "%s: overflow actual length is %d\n",
 495                         __func__, urb->actual_length);
 496         case -ECONNRESET:
 497         case -ENOENT:
 498         case -ESHUTDOWN:
 499         case -EILSEQ:
 500         case -EPROTO:
 501                 /* device is gone, stop sending */
 502                 return status;
 503         }
 504         dev_err(dev, "%s: unknown status %d\n", __func__, status);
 505
 506         return -EAGAIN;
 507 }
 508
 509 static void ap_disconnect(struct usb_interface *interface)
 510 {
 511         struct es2_ap_dev *es2;
 512         struct usb_device *udev;
 513         int *cport_to_ep;
 514         int bulk_in;
 515         int i;
 516
 517         es2 = usb_get_intfdata(interface);
 518         if (!es2)
 519                 return;
 520
 521         usb_log_disable(es2);
 522
 523         /* Tear down everything! */
 524         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 525                 struct urb *urb = es2->cport_out_urb[i];
 526
 527                 if (!urb)
 528                         break;
 529                 usb_kill_urb(urb);
 530                 usb_free_urb(urb);
 531                 es2->cport_out_urb[i] = NULL;
 532                 es2->cport_out_urb_busy[i] = false;     /* just to be anal */
 533         }
 534
 535         for (bulk_in = 0; bulk_in < NUM_BULKS; bulk_in++) {
 536                 struct es2_cport_in *cport_in = &es2->cport_in[bulk_in];
 537
 538                 for (i = 0; i < NUM_CPORT_IN_URB; ++i) {
 539                         struct urb *urb = cport_in->urb[i];
 540
 541                         if (!urb)
 542                                 break;
 543                         usb_kill_urb(urb);
 544                         usb_free_urb(urb);
 545                         kfree(cport_in->buffer[i]);
 546                         cport_in->buffer[i] = NULL;
 547                 }
 548         }
 549
 550         usb_set_intfdata(interface, NULL);
 551         udev = es2->usb_dev;
 552         cport_to_ep = es2->cport_to_ep;
 553         gb_hd_remove(es2->hd);
 554
 555         kfree(cport_to_ep);
 556         usb_put_dev(udev);
 557 }
 558
 559 static void cport_in_callback(struct urb *urb)
 560 {
 561         struct gb_host_device *hd = urb->context;
 562         struct device *dev = &urb->dev->dev;
 563         struct gb_operation_msg_hdr *header;
 564         int status = check_urb_status(urb);
 565         int retval;
 566         u16 cport_id;
 567
 568         if (status) {
 569                 if ((status == -EAGAIN) || (status == -EPROTO))
 570                         goto exit;
 571                 dev_err(dev, "urb cport in error %d (dropped)\n", status);
 572                 return;
 573         }
 574
 575         if (urb->actual_length < sizeof(*header)) {
 576                 dev_err(dev, "short message received\n");
 577                 goto exit;
 578         }
 579
 580         /* Extract the CPort id, which is packed in the message header */
 581         header = urb->transfer_buffer;
 582         cport_id = gb_message_cport_unpack(header);
 583
 584         if (cport_id_valid(hd, cport_id)) {
 585                 trace_gb_host_device_recv(hd, cport_id, urb->actual_length);
 586                 greybus_data_rcvd(hd, cport_id, urb->transfer_buffer,
 587                                                         urb->actual_length);
 588         } else {
 589                 dev_err(dev, "invalid cport id 0x%02x received\n", cport_id);
 590         }
 591 exit:
 592         /* put our urb back in the request pool */
 593         retval = usb_submit_urb(urb, GFP_ATOMIC);
 594         if (retval)
 595                 dev_err(dev, "failed to resubmit in-urb: %d\n", retval);
 596 }
 597
 598 static void cport_out_callback(struct urb *urb)
 599 {
 600         struct gb_message *message = urb->context;
 601         struct gb_host_device *hd = message->operation->connection->hd;
 602         struct es2_ap_dev *es2 = hd_to_es2(hd);
 603         int status = check_urb_status(urb);
 604         unsigned long flags;
 605
 606         gb_message_cport_clear(message->header);
 607
 608         spin_lock_irqsave(&es2->cport_out_urb_lock, flags);
 609         message->hcpriv = NULL;
 610         spin_unlock_irqrestore(&es2->cport_out_urb_lock, flags);
 611
 612         /*
 613          * Tell the submitter that the message send (attempt) is
 614          * complete, and report the status.
 615          */
 616         greybus_message_sent(hd, message, status);
 617
 618         free_urb(es2, urb);
 619 }
 620
 621 #define APB1_LOG_MSG_SIZE       64
 622 static void apb_log_get(struct es2_ap_dev *es2, char *buf)
 623 {
 624         int retval;
 625
 626         /* SVC messages go down our control pipe */
 627         do {
 628                 retval = usb_control_msg(es2->usb_dev,
 629                                         usb_rcvctrlpipe(es2->usb_dev, 0),
 630                                         REQUEST_LOG,
 631                                         USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
 632                                         0x00, 0x00,
 633                                         buf,
 634                                         APB1_LOG_MSG_SIZE,
 635                                         ES2_TIMEOUT);
 636                 if (retval > 0)
 637                         kfifo_in(&es2->apb_log_fifo, buf, retval);
 638         } while (retval > 0);
 639 }
 640
 641 static int apb_log_poll(void *data)
 642 {
 643         struct es2_ap_dev *es2 = data;
 644         char *buf;
 645
 646         buf = kmalloc(APB1_LOG_MSG_SIZE, GFP_KERNEL);
 647         if (!buf)
 648                 return -ENOMEM;
 649
 650         while (!kthread_should_stop()) {
 651                 msleep(1000);
 652                 apb_log_get(es2, buf);
 653         }
 654
 655         kfree(buf);
 656
 657         return 0;
 658 }
 659
 660 static ssize_t apb_log_read(struct file *f, char __user *buf,
 661                                 size_t count, loff_t *ppos)
 662 {
 663         struct es2_ap_dev *es2 = f->f_inode->i_private;
 664         ssize_t ret;
 665         size_t copied;
 666         char *tmp_buf;
 667
 668         if (count > APB1_LOG_SIZE)
 669                 count = APB1_LOG_SIZE;
 670
 671         tmp_buf = kmalloc(count, GFP_KERNEL);
 672         if (!tmp_buf)
 673                 return -ENOMEM;
 674
 675         copied = kfifo_out(&es2->apb_log_fifo, tmp_buf, count);
 676         ret = simple_read_from_buffer(buf, count, ppos, tmp_buf, copied);
 677
 678         kfree(tmp_buf);
 679
 680         return ret;
 681 }
 682
 683 static const struct file_operations apb_log_fops = {
 684         .read   = apb_log_read,
 685 };
 686
 687 static void usb_log_enable(struct es2_ap_dev *es2)
 688 {
 689         if (!IS_ERR_OR_NULL(es2->apb_log_task))
 690                 return;
 691
 692         /* get log from APB1 */
 693         es2->apb_log_task = kthread_run(apb_log_poll, es2, "apb_log");
 694         if (IS_ERR(es2->apb_log_task))
 695                 return;
 696         /* XXX We will need to rename this per APB */
 697         es2->apb_log_dentry = debugfs_create_file("apb_log", S_IRUGO,
 698                                                 gb_debugfs_get(), NULL,
 699                                                 &apb_log_fops);
 700 }
 701
 702 static void usb_log_disable(struct es2_ap_dev *es2)
 703 {
 704         if (IS_ERR_OR_NULL(es2->apb_log_task))
 705                 return;
 706
 707         debugfs_remove(es2->apb_log_dentry);
 708         es2->apb_log_dentry = NULL;
 709
 710         kthread_stop(es2->apb_log_task);
 711         es2->apb_log_task = NULL;
 712 }
 713
 714 static ssize_t apb_log_enable_read(struct file *f, char __user *buf,
 715                                 size_t count, loff_t *ppos)
 716 {
 717         struct es2_ap_dev *es2 = f->f_inode->i_private;
 718         int enable = !IS_ERR_OR_NULL(es2->apb_log_task);
 719         char tmp_buf[3];
 720
 721         sprintf(tmp_buf, "%d\n", enable);
 722         return simple_read_from_buffer(buf, count, ppos, tmp_buf, 3);
 723 }
 724
 725 static ssize_t apb_log_enable_write(struct file *f, const char __user *buf,
 726                                 size_t count, loff_t *ppos)
 727 {
 728         int enable;
 729         ssize_t retval;
 730         struct es2_ap_dev *es2 = f->f_inode->i_private;
 731
 732         retval = kstrtoint_from_user(buf, count, 10, &enable);
 733         if (retval)
 734                 return retval;
 735
 736         if (enable)
 737                 usb_log_enable(es2);
 738         else
 739                 usb_log_disable(es2);
 740
 741         return count;
 742 }
 743
 744 static const struct file_operations apb_log_enable_fops = {
 745         .read   = apb_log_enable_read,
 746         .write  = apb_log_enable_write,
 747 };
 748
 749 static int apb_get_cport_count(struct usb_device *udev)
 750 {
 751         int retval;
 752         __le16 *cport_count;
 753
 754         cport_count = kmalloc(sizeof(*cport_count), GFP_KERNEL);
 755         if (!cport_count)
 756                 return -ENOMEM;
 757
 758         retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
 759                                  REQUEST_CPORT_COUNT,
 760                                  USB_DIR_IN | USB_TYPE_VENDOR |
 761                                  USB_RECIP_INTERFACE, 0, 0, cport_count,
 762                                  sizeof(*cport_count), ES2_TIMEOUT);
 763         if (retval < 0) {
 764                 dev_err(&udev->dev, "Cannot retrieve CPort count: %d\n",
 765                         retval);
 766                 goto out;
 767         }
 768
 769         retval = le16_to_cpu(*cport_count);
 770
 771         /* We need to fit a CPort ID in one byte of a message header */
 772         if (retval > U8_MAX) {
 773                 retval = U8_MAX;
 774                 dev_warn(&udev->dev, "Limiting number of CPorts to U8_MAX\n");
 775         }
 776
 777 out:
 778         kfree(cport_count);
 779         return retval;
 780 }
 781
 782 /*
 783  * The ES2 USB Bridge device has 15 endpoints
 784  * 1 Control - usual USB stuff + AP -> APBridgeA messages
 785  * 7 Bulk IN - CPort data in
 786  * 7 Bulk OUT - CPort data out
 787  */
 788 static int ap_probe(struct usb_interface *interface,
 789                     const struct usb_device_id *id)
 790 {
 791         struct es2_ap_dev *es2;
 792         struct gb_host_device *hd;
 793         struct usb_device *udev;
 794         struct usb_host_interface *iface_desc;
 795         struct usb_endpoint_descriptor *endpoint;
 796         int bulk_in = 0;
 797         int bulk_out = 0;
 798         int retval = -ENOMEM;
 799         int i;
 800         int num_cports;
 801
 802         udev = usb_get_dev(interface_to_usbdev(interface));
 803
 804         num_cports = apb_get_cport_count(udev);
 805         if (num_cports < 0) {
 806                 usb_put_dev(udev);
 807                 dev_err(&udev->dev, "Cannot retrieve CPort count: %d\n",
 808                         num_cports);
 809                 return num_cports;
 810         }
 811
 812         hd = gb_hd_create(&es2_driver, &udev->dev, ES2_GBUF_MSG_SIZE_MAX,
 813                                 num_cports);
 814         if (IS_ERR(hd)) {
 815                 usb_put_dev(udev);
 816                 return PTR_ERR(hd);
 817         }
 818
 819         es2 = hd_to_es2(hd);
 820         es2->hd = hd;
 821         es2->usb_intf = interface;
 822         es2->usb_dev = udev;
 823         spin_lock_init(&es2->cport_out_urb_lock);
 824         INIT_KFIFO(es2->apb_log_fifo);
 825         usb_set_intfdata(interface, es2);
 826
 827         es2->cport_to_ep = kcalloc(hd->num_cports, sizeof(*es2->cport_to_ep),
 828                                    GFP_KERNEL);
 829         if (!es2->cport_to_ep) {
 830                 retval = -ENOMEM;
 831                 goto error;
 832         }
 833
 834         /* find all bulk endpoints */
 835         iface_desc = interface->cur_altsetting;
 836         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
 837                 endpoint = &iface_desc->endpoint[i].desc;
 838
 839                 if (usb_endpoint_is_bulk_in(endpoint)) {
 840                         es2->cport_in[bulk_in++].endpoint =
 841                                 endpoint->bEndpointAddress;
 842                 } else if (usb_endpoint_is_bulk_out(endpoint)) {
 843                         es2->cport_out[bulk_out++].endpoint =
 844                                 endpoint->bEndpointAddress;
 845                 } else {
 846                         dev_err(&udev->dev,
 847                                 "Unknown endpoint type found, address %x\n",
 848                                 endpoint->bEndpointAddress);
 849                 }
 850         }
 851         if ((bulk_in == 0) ||
 852             (bulk_out == 0)) {
 853                 dev_err(&udev->dev, "Not enough endpoints found in device, aborting!\n");
 854                 goto error;
 855         }
 856
 857         /* Allocate buffers for our cport in messages and start them up */
 858         for (bulk_in = 0; bulk_in < NUM_BULKS; bulk_in++) {
 859                 struct es2_cport_in *cport_in = &es2->cport_in[bulk_in];
 860
 861                 for (i = 0; i < NUM_CPORT_IN_URB; ++i) {
 862                         struct urb *urb;
 863                         u8 *buffer;
 864
 865                         urb = usb_alloc_urb(0, GFP_KERNEL);
 866                         if (!urb)
 867                                 goto error;
 868                         buffer = kmalloc(ES2_GBUF_MSG_SIZE_MAX, GFP_KERNEL);
 869                         if (!buffer)
 870                                 goto error;
 871
 872                         usb_fill_bulk_urb(urb, udev,
 873                                           usb_rcvbulkpipe(udev,
 874                                                           cport_in->endpoint),
 875                                           buffer, ES2_GBUF_MSG_SIZE_MAX,
 876                                           cport_in_callback, hd);
 877                         cport_in->urb[i] = urb;
 878                         cport_in->buffer[i] = buffer;
 879                         retval = usb_submit_urb(urb, GFP_KERNEL);
 880                         if (retval)
 881                                 goto error;
 882                 }
 883         }
 884
 885         /* Allocate urbs for our CPort OUT messages */
 886         for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
 887                 struct urb *urb;
 888
 889                 urb = usb_alloc_urb(0, GFP_KERNEL);
 890                 if (!urb)
 891                         goto error;
 892
 893                 es2->cport_out_urb[i] = urb;
 894                 es2->cport_out_urb_busy[i] = false;     /* just to be anal */
 895         }
 896
 897         /* XXX We will need to rename this per APB */
 898         es2->apb_log_enable_dentry = debugfs_create_file("apb_log_enable",
 899                                                         (S_IWUSR | S_IRUGO),
 900                                                         gb_debugfs_get(), es2,
 901                                                         &apb_log_enable_fops);
 902         return 0;
 903 error:
 904         ap_disconnect(interface);
 905
 906         return retval;
 907 }
 908
 909 static struct usb_driver es2_ap_driver = {
 910         .name =         "es2_ap_driver",
 911         .probe =        ap_probe,
 912         .disconnect =   ap_disconnect,
 913         .id_table =     id_table,
 914 };
 915
 916 module_usb_driver(es2_ap_driver);
 917
 918 MODULE_LICENSE("GPL v2");
 919 MODULE_AUTHOR("Greg Kroah-Hartman <gregkh@linuxfoundation.org>");