2 * Greybus "AP" USB driver for "ES2" controller chips
4 * Copyright 2014-2015 Google Inc.
5 * Copyright 2014-2015 Linaro Ltd.
7 * Released under the GPLv2 only.
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>
17 #include "kernel_ver.h"
18 #include "connection.h"
20 /* Memory sizes for the buffers sent to/from the ES1 controller */
21 #define ES1_GBUF_MSG_SIZE_MAX 2048
23 static const struct usb_device_id id_table[] = {
24 /* Made up numbers for the SVC USB Bridge in ES2 */
25 { USB_DEVICE(0xffff, 0x0002) },
28 MODULE_DEVICE_TABLE(usb, id_table);
30 #define APB1_LOG_SIZE SZ_16K
31 static struct dentry *apb1_log_dentry;
32 static struct dentry *apb1_log_enable_dentry;
33 static struct task_struct *apb1_log_task;
34 static DEFINE_KFIFO(apb1_log_fifo, char, APB1_LOG_SIZE);
36 /* Number of cport present on USB bridge */
37 #define CPORT_COUNT 44
39 /* Number of bulk in and bulk out couple */
43 * Number of CPort IN urbs in flight at any point in time.
44 * Adjust if we are having stalls in the USB buffer due to not enough urbs in
47 #define NUM_CPORT_IN_URB 4
49 /* Number of CPort OUT urbs in flight at any point in time.
50 * Adjust if we get messages saying we are out of urbs in the system log.
52 #define NUM_CPORT_OUT_URB (8 * NUM_BULKS)
54 /* vendor request AP message */
55 #define REQUEST_SVC 0x01
57 /* vendor request APB1 log */
58 #define REQUEST_LOG 0x02
60 /* vendor request to map a cport to bulk in and bulk out endpoints */
61 #define REQUEST_EP_MAPPING 0x03
64 * @endpoint: bulk in endpoint for CPort data
65 * @urb: array of urbs for the CPort in messages
66 * @buffer: array of buffers for the @cport_in_urb urbs
70 struct urb *urb[NUM_CPORT_IN_URB];
71 u8 *buffer[NUM_CPORT_IN_URB];
75 * @endpoint: bulk out endpoint for CPort data
77 struct es1_cport_out {
82 * es1_ap_dev - ES1 USB Bridge to AP structure
83 * @usb_dev: pointer to the USB device we are.
84 * @usb_intf: pointer to the USB interface we are bound to.
85 * @hd: pointer to our greybus_host_device structure
86 * @control_endpoint: endpoint to send data to SVC
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
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"
98 struct usb_device *usb_dev;
99 struct usb_interface *usb_intf;
100 struct greybus_host_device *hd;
102 __u8 control_endpoint;
104 struct es1_cport_in cport_in[NUM_BULKS];
105 struct es1_cport_out cport_out[NUM_BULKS];
106 struct urb *cport_out_urb[NUM_CPORT_OUT_URB];
107 bool cport_out_urb_busy[NUM_CPORT_OUT_URB];
108 bool cport_out_urb_cancelled[NUM_CPORT_OUT_URB];
109 spinlock_t cport_out_urb_lock;
120 static inline struct es1_ap_dev *hd_to_es1(struct greybus_host_device *hd)
122 return (struct es1_ap_dev *)&hd->hd_priv;
125 static void cport_out_callback(struct urb *urb);
126 static void usb_log_enable(struct es1_ap_dev *es1);
127 static void usb_log_disable(struct es1_ap_dev *es1);
129 static int cport_to_ep(struct es1_ap_dev *es1, u16 cport_id)
131 if (cport_id >= es1->hd->num_cports)
133 return es1->cport_to_ep[cport_id];
136 #define ES1_TIMEOUT 500 /* 500 ms for the SVC to do something */
138 static int ep_in_use(struct es1_ap_dev *es1, int bulk_ep_set)
142 for (i = 0; i < es1->hd->num_cports; i++) {
143 if (es1->cport_to_ep[i] == bulk_ep_set)
149 int map_cport_to_ep(struct es1_ap_dev *es1,
150 u16 cport_id, int bulk_ep_set)
153 struct cport_to_ep *cport_to_ep;
155 if (bulk_ep_set == 0 || bulk_ep_set >= NUM_BULKS)
157 if (cport_id >= es1->hd->num_cports)
159 if (bulk_ep_set && ep_in_use(es1, bulk_ep_set))
162 cport_to_ep = kmalloc(sizeof(*cport_to_ep), GFP_KERNEL);
166 es1->cport_to_ep[cport_id] = bulk_ep_set;
167 cport_to_ep->cport_id = cpu_to_le16(cport_id);
168 cport_to_ep->endpoint_in = es1->cport_in[bulk_ep_set].endpoint;
169 cport_to_ep->endpoint_out = es1->cport_out[bulk_ep_set].endpoint;
171 retval = usb_control_msg(es1->usb_dev,
172 usb_sndctrlpipe(es1->usb_dev,
173 es1->control_endpoint),
175 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
178 sizeof(*cport_to_ep),
180 if (retval == sizeof(*cport_to_ep))
187 int unmap_cport(struct es1_ap_dev *es1, u16 cport_id)
189 return map_cport_to_ep(es1, cport_id, 0);
192 static struct urb *next_free_urb(struct es1_ap_dev *es1, gfp_t gfp_mask)
194 struct urb *urb = NULL;
198 spin_lock_irqsave(&es1->cport_out_urb_lock, flags);
200 /* Look in our pool of allocated urbs first, as that's the "fastest" */
201 for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
202 if (es1->cport_out_urb_busy[i] == false &&
203 es1->cport_out_urb_cancelled[i] == false) {
204 es1->cport_out_urb_busy[i] = true;
205 urb = es1->cport_out_urb[i];
209 spin_unlock_irqrestore(&es1->cport_out_urb_lock, flags);
214 * Crap, pool is empty, complain to the syslog and go allocate one
215 * dynamically as we have to succeed.
217 dev_err(&es1->usb_dev->dev,
218 "No free CPort OUT urbs, having to dynamically allocate one!\n");
219 return usb_alloc_urb(0, gfp_mask);
222 static void free_urb(struct es1_ap_dev *es1, struct urb *urb)
227 * See if this was an urb in our pool, if so mark it "free", otherwise
228 * we need to free it ourselves.
230 spin_lock_irqsave(&es1->cport_out_urb_lock, flags);
231 for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
232 if (urb == es1->cport_out_urb[i]) {
233 es1->cport_out_urb_busy[i] = false;
238 spin_unlock_irqrestore(&es1->cport_out_urb_lock, flags);
240 /* If urb is not NULL, then we need to free this urb */
245 * We (ab)use the operation-message header pad bytes to transfer the
246 * cport id in order to minimise overhead.
249 gb_message_cport_pack(struct gb_operation_msg_hdr *header, u16 cport_id)
251 header->pad[0] = cport_id;
254 /* Clear the pad bytes used for the CPort id */
255 static void gb_message_cport_clear(struct gb_operation_msg_hdr *header)
260 /* Extract the CPort id packed into the header, and clear it */
261 static u16 gb_message_cport_unpack(struct gb_operation_msg_hdr *header)
263 u16 cport_id = header->pad[0];
265 gb_message_cport_clear(header);
271 * Returns zero if the message was successfully queued, or a negative errno
274 static int message_send(struct greybus_host_device *hd, u16 cport_id,
275 struct gb_message *message, gfp_t gfp_mask)
277 struct es1_ap_dev *es1 = hd_to_es1(hd);
278 struct usb_device *udev = es1->usb_dev;
286 * The data actually transferred will include an indication
287 * of where the data should be sent. Do one last check of
288 * the target CPort id before filling it in.
290 if (!cport_id_valid(hd, cport_id)) {
291 pr_err("invalid destination cport 0x%02x\n", cport_id);
295 /* Find a free urb */
296 urb = next_free_urb(es1, gfp_mask);
300 spin_lock_irqsave(&es1->cport_out_urb_lock, flags);
301 message->hcpriv = urb;
302 spin_unlock_irqrestore(&es1->cport_out_urb_lock, flags);
304 /* Pack the cport id into the message header */
305 gb_message_cport_pack(message->header, cport_id);
307 buffer_size = sizeof(*message->header) + message->payload_size;
309 bulk_ep_set = cport_to_ep(es1, cport_id);
310 usb_fill_bulk_urb(urb, udev,
311 usb_sndbulkpipe(udev,
312 es1->cport_out[bulk_ep_set].endpoint),
313 message->buffer, buffer_size,
314 cport_out_callback, message);
315 urb->transfer_flags |= URB_ZERO_PACKET;
316 gb_connection_push_timestamp(message->operation->connection);
317 retval = usb_submit_urb(urb, gfp_mask);
319 pr_err("error %d submitting URB\n", retval);
321 spin_lock_irqsave(&es1->cport_out_urb_lock, flags);
322 message->hcpriv = NULL;
323 spin_unlock_irqrestore(&es1->cport_out_urb_lock, flags);
326 gb_message_cport_clear(message->header);
335 * Can not be called in atomic context.
337 static void message_cancel(struct gb_message *message)
339 struct greybus_host_device *hd = message->operation->connection->hd;
340 struct es1_ap_dev *es1 = hd_to_es1(hd);
346 spin_lock_irq(&es1->cport_out_urb_lock);
347 urb = message->hcpriv;
349 /* Prevent dynamically allocated urb from being deallocated. */
352 /* Prevent pre-allocated urb from being reused. */
353 for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
354 if (urb == es1->cport_out_urb[i]) {
355 es1->cport_out_urb_cancelled[i] = true;
359 spin_unlock_irq(&es1->cport_out_urb_lock);
363 if (i < NUM_CPORT_OUT_URB) {
364 spin_lock_irq(&es1->cport_out_urb_lock);
365 es1->cport_out_urb_cancelled[i] = false;
366 spin_unlock_irq(&es1->cport_out_urb_lock);
372 static struct greybus_host_driver es1_driver = {
373 .hd_priv_size = sizeof(struct es1_ap_dev),
374 .message_send = message_send,
375 .message_cancel = message_cancel,
378 /* Common function to report consistent warnings based on URB status */
379 static int check_urb_status(struct urb *urb)
381 struct device *dev = &urb->dev->dev;
382 int status = urb->status;
389 dev_err(dev, "%s: overflow actual length is %d\n",
390 __func__, urb->actual_length);
396 /* device is gone, stop sending */
399 dev_err(dev, "%s: unknown status %d\n", __func__, status);
404 static void ap_disconnect(struct usb_interface *interface)
406 struct es1_ap_dev *es1;
407 struct usb_device *udev;
411 es1 = usb_get_intfdata(interface);
415 usb_log_disable(es1);
417 /* Tear down everything! */
418 for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
419 struct urb *urb = es1->cport_out_urb[i];
425 es1->cport_out_urb[i] = NULL;
426 es1->cport_out_urb_busy[i] = false; /* just to be anal */
429 for (bulk_in = 0; bulk_in < NUM_BULKS; bulk_in++) {
430 struct es1_cport_in *cport_in = &es1->cport_in[bulk_in];
431 for (i = 0; i < NUM_CPORT_IN_URB; ++i) {
432 struct urb *urb = cport_in->urb[i];
438 kfree(cport_in->buffer[i]);
439 cport_in->buffer[i] = NULL;
443 usb_set_intfdata(interface, NULL);
445 greybus_remove_hd(es1->hd);
446 kfree(es1->cport_to_ep);
451 static void cport_in_callback(struct urb *urb)
453 struct greybus_host_device *hd = urb->context;
454 struct device *dev = &urb->dev->dev;
455 struct gb_operation_msg_hdr *header;
456 int status = check_urb_status(urb);
461 if ((status == -EAGAIN) || (status == -EPROTO))
463 dev_err(dev, "urb cport in error %d (dropped)\n", status);
467 if (urb->actual_length < sizeof(*header)) {
468 dev_err(dev, "%s: short message received\n", __func__);
472 /* Extract the CPort id, which is packed in the message header */
473 header = urb->transfer_buffer;
474 cport_id = gb_message_cport_unpack(header);
476 if (cport_id_valid(hd, cport_id))
477 greybus_data_rcvd(hd, cport_id, urb->transfer_buffer,
480 dev_err(dev, "%s: invalid cport id 0x%02x received\n",
483 /* put our urb back in the request pool */
484 retval = usb_submit_urb(urb, GFP_ATOMIC);
486 dev_err(dev, "%s: error %d in submitting urb.\n",
490 static void cport_out_callback(struct urb *urb)
492 struct gb_message *message = urb->context;
493 struct greybus_host_device *hd = message->operation->connection->hd;
494 struct es1_ap_dev *es1 = hd_to_es1(hd);
495 int status = check_urb_status(urb);
498 gb_message_cport_clear(message->header);
501 * Tell the submitter that the message send (attempt) is
502 * complete, and report the status.
504 greybus_message_sent(hd, message, status);
506 spin_lock_irqsave(&es1->cport_out_urb_lock, flags);
507 message->hcpriv = NULL;
508 spin_unlock_irqrestore(&es1->cport_out_urb_lock, flags);
513 #define APB1_LOG_MSG_SIZE 64
514 static void apb1_log_get(struct es1_ap_dev *es1, char *buf)
518 /* SVC messages go down our control pipe */
520 retval = usb_control_msg(es1->usb_dev,
521 usb_rcvctrlpipe(es1->usb_dev,
522 es1->control_endpoint),
524 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
530 kfifo_in(&apb1_log_fifo, buf, retval);
531 } while (retval > 0);
534 static int apb1_log_poll(void *data)
536 struct es1_ap_dev *es1 = data;
539 buf = kmalloc(APB1_LOG_MSG_SIZE, GFP_KERNEL);
543 while (!kthread_should_stop()) {
545 apb1_log_get(es1, buf);
553 static ssize_t apb1_log_read(struct file *f, char __user *buf,
554 size_t count, loff_t *ppos)
560 if (count > APB1_LOG_SIZE)
561 count = APB1_LOG_SIZE;
563 tmp_buf = kmalloc(count, GFP_KERNEL);
567 copied = kfifo_out(&apb1_log_fifo, tmp_buf, count);
568 ret = simple_read_from_buffer(buf, count, ppos, tmp_buf, copied);
575 static const struct file_operations apb1_log_fops = {
576 .read = apb1_log_read,
579 static void usb_log_enable(struct es1_ap_dev *es1)
581 if (!IS_ERR_OR_NULL(apb1_log_task))
584 /* get log from APB1 */
585 apb1_log_task = kthread_run(apb1_log_poll, es1, "apb1_log");
586 if (IS_ERR(apb1_log_task))
588 apb1_log_dentry = debugfs_create_file("apb1_log", S_IRUGO,
589 gb_debugfs_get(), NULL,
593 static void usb_log_disable(struct es1_ap_dev *es1)
595 if (IS_ERR_OR_NULL(apb1_log_task))
598 debugfs_remove(apb1_log_dentry);
599 apb1_log_dentry = NULL;
601 kthread_stop(apb1_log_task);
602 apb1_log_task = NULL;
605 static ssize_t apb1_log_enable_read(struct file *f, char __user *buf,
606 size_t count, loff_t *ppos)
609 int enable = !IS_ERR_OR_NULL(apb1_log_task);
611 sprintf(tmp_buf, "%d\n", enable);
612 return simple_read_from_buffer(buf, count, ppos, tmp_buf, 3);
615 static ssize_t apb1_log_enable_write(struct file *f, const char __user *buf,
616 size_t count, loff_t *ppos)
620 struct es1_ap_dev *es1 = (struct es1_ap_dev *)f->f_inode->i_private;
622 retval = kstrtoint_from_user(buf, count, 10, &enable);
629 usb_log_disable(es1);
634 static const struct file_operations apb1_log_enable_fops = {
635 .read = apb1_log_enable_read,
636 .write = apb1_log_enable_write,
640 * The ES1 USB Bridge device contains 4 endpoints
641 * 1 Control - usual USB stuff + AP -> SVC messages
642 * 1 Interrupt IN - SVC -> AP messages
643 * 1 Bulk IN - CPort data in
644 * 1 Bulk OUT - CPort data out
646 static int ap_probe(struct usb_interface *interface,
647 const struct usb_device_id *id)
649 struct es1_ap_dev *es1;
650 struct greybus_host_device *hd;
651 struct usb_device *udev;
652 struct usb_host_interface *iface_desc;
653 struct usb_endpoint_descriptor *endpoint;
656 int retval = -ENOMEM;
659 /* We need to fit a CPort ID in one byte of a message header */
660 BUILD_BUG_ON(CPORT_ID_MAX > U8_MAX);
662 udev = usb_get_dev(interface_to_usbdev(interface));
664 hd = greybus_create_hd(&es1_driver, &udev->dev, ES1_GBUF_MSG_SIZE_MAX,
673 es1->usb_intf = interface;
675 spin_lock_init(&es1->cport_out_urb_lock);
676 usb_set_intfdata(interface, es1);
678 /* Control endpoint is the pipe to talk to this AP, so save it off */
679 endpoint = &udev->ep0.desc;
680 es1->control_endpoint = endpoint->bEndpointAddress;
682 es1->cport_to_ep = kcalloc(hd->num_cports, sizeof(*es1->cport_to_ep),
684 if (!es1->cport_to_ep) {
689 /* find all 3 of our endpoints */
690 iface_desc = interface->cur_altsetting;
691 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
692 endpoint = &iface_desc->endpoint[i].desc;
694 if (usb_endpoint_is_bulk_in(endpoint)) {
695 es1->cport_in[bulk_in++].endpoint =
696 endpoint->bEndpointAddress;
697 } else if (usb_endpoint_is_bulk_out(endpoint)) {
698 es1->cport_out[bulk_out++].endpoint =
699 endpoint->bEndpointAddress;
702 "Unknown endpoint type found, address %x\n",
703 endpoint->bEndpointAddress);
706 if ((bulk_in == 0) ||
708 dev_err(&udev->dev, "Not enough endpoints found in device, aborting!\n");
712 /* Allocate buffers for our cport in messages and start them up */
713 for (bulk_in = 0; bulk_in < NUM_BULKS; bulk_in++) {
714 struct es1_cport_in *cport_in = &es1->cport_in[bulk_in];
715 for (i = 0; i < NUM_CPORT_IN_URB; ++i) {
719 urb = usb_alloc_urb(0, GFP_KERNEL);
722 buffer = kmalloc(ES1_GBUF_MSG_SIZE_MAX, GFP_KERNEL);
726 usb_fill_bulk_urb(urb, udev,
727 usb_rcvbulkpipe(udev,
729 buffer, ES1_GBUF_MSG_SIZE_MAX,
730 cport_in_callback, hd);
731 cport_in->urb[i] = urb;
732 cport_in->buffer[i] = buffer;
733 retval = usb_submit_urb(urb, GFP_KERNEL);
739 /* Allocate urbs for our CPort OUT messages */
740 for (i = 0; i < NUM_CPORT_OUT_URB; ++i) {
743 urb = usb_alloc_urb(0, GFP_KERNEL);
747 es1->cport_out_urb[i] = urb;
748 es1->cport_out_urb_busy[i] = false; /* just to be anal */
751 apb1_log_enable_dentry = debugfs_create_file("apb1_log_enable",
753 gb_debugfs_get(), es1,
754 &apb1_log_enable_fops);
757 ap_disconnect(interface);
762 static struct usb_driver es1_ap_driver = {
763 .name = "es2_ap_driver",
765 .disconnect = ap_disconnect,
766 .id_table = id_table,
769 module_usb_driver(es1_ap_driver);
771 MODULE_LICENSE("GPL v2");
772 MODULE_AUTHOR("Greg Kroah-Hartman <gregkh@linuxfoundation.org>");