Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Greybus "AP" USB driver |
| 3 | * |
| 4 | * Copyright 2014 Google Inc. |
| 5 | * |
| 6 | * Released under the GPLv2 only. |
| 7 | */ |
| 8 | #include <linux/kernel.h> |
| 9 | #include <linux/module.h> |
| 10 | #include <linux/slab.h> |
| 11 | #include <linux/errno.h> |
| 12 | #include <linux/usb.h> |
Greg Kroah-Hartman | de536e3 | 2014-08-31 16:17:04 -0700 | [diff] [blame] | 13 | #include "greybus.h" |
Greg Kroah-Hartman | 43cc32a | 2014-09-07 13:51:12 -0700 | [diff] [blame] | 14 | #include "svc_msg.h" |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 15 | |
| 16 | static const struct usb_device_id id_table[] = { |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 17 | { USB_DEVICE(0xffff, 0x0001) }, // FIXME |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 18 | { }, |
| 19 | }; |
| 20 | MODULE_DEVICE_TABLE(usb, id_table); |
| 21 | |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 22 | struct es1_ap_dev { |
| 23 | struct usb_device *usb_dev; |
| 24 | struct usb_interface *usb_intf; |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 25 | struct greybus_host_device *hd; |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 26 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 27 | __u8 control_endpoint; /* endpoint to send data to SVC */ |
| 28 | __u8 svc_endpoint; /* endpoint for SVC data */ |
| 29 | __u8 cport_in_endpoint; /* bulk in for CPort data */ |
| 30 | __u8 cport_out_endpoint; /* bulk out for CPort data */ |
| 31 | u8 *svc_buffer; /* buffer for SVC messages coming in */ |
| 32 | struct urb *svc_urb; /* urb for SVC messages coming in */ |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 33 | }; |
| 34 | |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 35 | static inline struct es1_ap_dev *hd_to_es1(struct greybus_host_device *hd) |
| 36 | { |
| 37 | return (struct es1_ap_dev *)(hd->hd_priv); |
| 38 | } |
| 39 | |
Greg Kroah-Hartman | f1eec30 | 2014-08-30 17:18:14 -0700 | [diff] [blame] | 40 | /* |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 41 | * Allocate the actual buffer for this gbuf and device and cport |
| 42 | * |
| 43 | * We are responsible for setting the following fields in a struct gbuf: |
| 44 | * void *hcpriv; |
| 45 | * void *transfer_buffer; |
| 46 | * u32 transfer_buffer_length; |
Greg Kroah-Hartman | f1eec30 | 2014-08-30 17:18:14 -0700 | [diff] [blame] | 47 | */ |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 48 | static int alloc_gbuf(struct gbuf *gbuf, unsigned int size, gfp_t gfp_mask) |
| 49 | { |
| 50 | struct es1_ap_dev *es1 = hd_to_es1(gbuf->gdev->hd); |
| 51 | u8 *buffer; |
| 52 | |
| 53 | /* For ES2 we need to figure out what cport is going to what endpoint, |
| 54 | * but for ES1, it's so dirt simple, we don't have a choice... |
| 55 | * |
| 56 | * Also, do a "slow" allocation now, if we need speed, use a cache |
| 57 | */ |
| 58 | buffer = kmalloc(size + 1, gfp_mask); |
| 59 | if (!buffer) |
| 60 | return -ENOMEM; |
| 61 | |
| 62 | /* |
| 63 | * we will encode the cport number in the first byte of the buffer, so |
| 64 | * set the second byte to be the "transfer buffer" |
| 65 | */ |
| 66 | buffer[0] = gbuf->cport->number; |
| 67 | gbuf->transfer_buffer = &buffer[1]; |
| 68 | gbuf->transfer_buffer_length = size; |
| 69 | |
| 70 | gbuf->hdpriv = es1; /* really, we could do something else here... */ |
| 71 | |
| 72 | return 0; |
| 73 | } |
| 74 | |
| 75 | /* Free the memory we allocated with a gbuf */ |
| 76 | static void free_gbuf(struct gbuf *gbuf) |
| 77 | { |
| 78 | u8 *transfer_buffer; |
| 79 | u8 *buffer; |
| 80 | |
| 81 | transfer_buffer = gbuf->transfer_buffer; |
| 82 | buffer = &transfer_buffer[-1]; /* yes, we mean -1 */ |
| 83 | kfree(buffer); |
| 84 | } |
| 85 | |
Greg Kroah-Hartman | 8c53e07 | 2014-09-12 20:47:11 -0700 | [diff] [blame^] | 86 | #define ES1_TIMEOUT 500 /* 500 ms for the SVC to do something */ |
| 87 | static int send_svc_msg(struct svc_msg *svc_msg, struct greybus_host_device *hd) |
Greg Kroah-Hartman | 68f1fc4 | 2014-09-07 13:12:11 -0700 | [diff] [blame] | 88 | { |
| 89 | struct es1_ap_dev *es1 = hd_to_es1(hd); |
Greg Kroah-Hartman | 8c53e07 | 2014-09-12 20:47:11 -0700 | [diff] [blame^] | 90 | int retval; |
Greg Kroah-Hartman | 68f1fc4 | 2014-09-07 13:12:11 -0700 | [diff] [blame] | 91 | |
Greg Kroah-Hartman | 8c53e07 | 2014-09-12 20:47:11 -0700 | [diff] [blame^] | 92 | /* SVC messages go down our control pipe */ |
| 93 | retval = usb_control_msg(es1->usb_dev, |
| 94 | usb_sndctrlpipe(es1->usb_dev, |
| 95 | es1->control_endpoint), |
| 96 | 0x01, /* vendor request AP message */ |
| 97 | USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER, |
| 98 | 0x00, 0x00, |
| 99 | (char *)svc_msg, |
| 100 | sizeof(*svc_msg), |
| 101 | ES1_TIMEOUT); |
| 102 | if (retval != sizeof(*svc_msg)) |
| 103 | return retval; |
| 104 | |
| 105 | return 0; |
Greg Kroah-Hartman | 68f1fc4 | 2014-09-07 13:12:11 -0700 | [diff] [blame] | 106 | } |
| 107 | |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 108 | static struct greybus_host_driver es1_driver = { |
| 109 | .hd_priv_size = sizeof(struct es1_ap_dev), |
| 110 | .alloc_gbuf = alloc_gbuf, |
| 111 | .free_gbuf = free_gbuf, |
Greg Kroah-Hartman | 8c53e07 | 2014-09-12 20:47:11 -0700 | [diff] [blame^] | 112 | .send_svc_msg = send_svc_msg, |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 113 | }; |
| 114 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 115 | /* Callback for when we get a SVC message */ |
| 116 | static void svc_callback(struct urb *urb) |
Greg Kroah-Hartman | de536e3 | 2014-08-31 16:17:04 -0700 | [diff] [blame] | 117 | { |
Greg Kroah-Hartman | 68f1fc4 | 2014-09-07 13:12:11 -0700 | [diff] [blame] | 118 | struct es1_ap_dev *es1 = urb->context; |
Greg Kroah-Hartman | de536e3 | 2014-08-31 16:17:04 -0700 | [diff] [blame] | 119 | struct device *dev = &urb->dev->dev; |
| 120 | int status = urb->status; |
| 121 | int retval; |
| 122 | |
| 123 | switch (status) { |
| 124 | case 0: |
| 125 | break; |
| 126 | case -EOVERFLOW: |
| 127 | dev_err(dev, "%s: overflow actual length is %d\n", |
| 128 | __func__, urb->actual_length); |
| 129 | case -ECONNRESET: |
| 130 | case -ENOENT: |
| 131 | case -ESHUTDOWN: |
| 132 | case -EILSEQ: |
| 133 | /* device is gone, stop sending */ |
| 134 | return; |
| 135 | default: |
| 136 | dev_err(dev, "%s: unknown status %d\n", __func__, status); |
| 137 | goto exit; |
| 138 | } |
| 139 | |
| 140 | /* We have a message, create a new message structure, add it to the |
| 141 | * list, and wake up our thread that will process the messages. |
| 142 | */ |
Greg Kroah-Hartman | 68f1fc4 | 2014-09-07 13:12:11 -0700 | [diff] [blame] | 143 | gb_new_ap_msg(urb->transfer_buffer, urb->actual_length, es1->hd); |
Greg Kroah-Hartman | de536e3 | 2014-08-31 16:17:04 -0700 | [diff] [blame] | 144 | |
| 145 | exit: |
| 146 | /* resubmit the urb to get more messages */ |
| 147 | retval = usb_submit_urb(urb, GFP_ATOMIC); |
| 148 | if (retval) |
| 149 | dev_err(dev, "Can not submit urb for AP data: %d\n", retval); |
| 150 | } |
| 151 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 152 | void cport_in_callback(struct urb *urb) |
Greg Kroah-Hartman | de536e3 | 2014-08-31 16:17:04 -0700 | [diff] [blame] | 153 | { |
| 154 | struct device *dev = &urb->dev->dev; |
| 155 | int status = urb->status; |
| 156 | |
| 157 | switch (status) { |
| 158 | case 0: |
| 159 | break; |
| 160 | case -EOVERFLOW: |
| 161 | dev_err(dev, "%s: overflow actual length is %d\n", |
| 162 | __func__, urb->actual_length); |
| 163 | case -ECONNRESET: |
| 164 | case -ENOENT: |
| 165 | case -ESHUTDOWN: |
| 166 | case -EILSEQ: |
| 167 | /* device is gone, stop sending */ |
| 168 | return; |
| 169 | default: |
| 170 | dev_err(dev, "%s: unknown status %d\n", __func__, status); |
| 171 | goto exit; |
| 172 | } |
| 173 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 174 | // FIXME - handle the CPort in data |
Greg Kroah-Hartman | de536e3 | 2014-08-31 16:17:04 -0700 | [diff] [blame] | 175 | exit: |
| 176 | return; |
| 177 | } |
| 178 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 179 | void cport_out_callback(struct urb *urb) |
| 180 | { |
| 181 | struct device *dev = &urb->dev->dev; |
| 182 | int status = urb->status; |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 183 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 184 | switch (status) { |
| 185 | case 0: |
| 186 | break; |
| 187 | case -EOVERFLOW: |
| 188 | dev_err(dev, "%s: overflow actual length is %d\n", |
| 189 | __func__, urb->actual_length); |
| 190 | case -ECONNRESET: |
| 191 | case -ENOENT: |
| 192 | case -ESHUTDOWN: |
| 193 | case -EILSEQ: |
| 194 | /* device is gone, stop sending */ |
| 195 | return; |
| 196 | default: |
| 197 | dev_err(dev, "%s: unknown status %d\n", __func__, status); |
| 198 | goto exit; |
| 199 | } |
| 200 | |
| 201 | // FIXME - handle the CPort out data callback |
| 202 | exit: |
| 203 | return; |
| 204 | } |
| 205 | |
| 206 | /* |
| 207 | * The ES1 USB Bridge device contains 4 endpoints |
| 208 | * 1 Control - usual USB stuff + AP -> SVC messages |
| 209 | * 1 Interrupt IN - SVC -> AP messages |
| 210 | * 1 Bulk IN - CPort data in |
| 211 | * 1 Bulk OUT - CPorta data out |
| 212 | */ |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 213 | static int ap_probe(struct usb_interface *interface, |
| 214 | const struct usb_device_id *id) |
| 215 | { |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 216 | struct es1_ap_dev *es1; |
| 217 | struct greybus_host_device *hd; |
| 218 | struct usb_device *udev; |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 219 | struct usb_host_interface *iface_desc; |
| 220 | struct usb_endpoint_descriptor *endpoint; |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 221 | bool int_in_found = false; |
| 222 | bool bulk_in_found = false; |
| 223 | bool bulk_out_found = false; |
| 224 | int retval = -ENOMEM; |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 225 | int i; |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 226 | int buffer_size = 0; |
| 227 | u8 svc_interval = 0; |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 228 | |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 229 | udev = usb_get_dev(interface_to_usbdev(interface)); |
| 230 | |
| 231 | hd = greybus_create_hd(&es1_driver, &udev->dev); |
| 232 | if (!hd) |
Greg Kroah-Hartman | f1eec30 | 2014-08-30 17:18:14 -0700 | [diff] [blame] | 233 | return -ENOMEM; |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 234 | |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 235 | es1 = hd_to_es1(hd); |
| 236 | es1->hd = hd; |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 237 | es1->usb_intf = interface; |
| 238 | es1->usb_dev = udev; |
| 239 | usb_set_intfdata(interface, es1); |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 240 | |
| 241 | /* Control endpoint is the pipe to talk to this AP, so save it off */ |
| 242 | endpoint = &udev->ep0.desc; |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 243 | es1->control_endpoint = endpoint->bEndpointAddress; |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 244 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 245 | /* find all 3 of our endpoints */ |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 246 | iface_desc = interface->cur_altsetting; |
| 247 | for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) { |
| 248 | endpoint = &iface_desc->endpoint[i].desc; |
| 249 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 250 | if (usb_endpoint_is_int_in(endpoint)) { |
| 251 | es1->svc_endpoint = endpoint->bEndpointAddress; |
| 252 | buffer_size = le16_to_cpu(endpoint->wMaxPacketSize); |
| 253 | svc_interval = endpoint->bInterval; |
| 254 | int_in_found = true; |
| 255 | } else if (usb_endpoint_is_bulk_in(endpoint)) { |
| 256 | es1->cport_in_endpoint = endpoint->bEndpointAddress; |
| 257 | bulk_in_found = true; |
| 258 | } else if (usb_endpoint_is_bulk_out(endpoint)) { |
| 259 | es1->cport_out_endpoint = endpoint->bEndpointAddress; |
| 260 | bulk_out_found = true; |
| 261 | } else { |
| 262 | dev_err(&udev->dev, |
| 263 | "Unknown endpoint type found, address %x\n", |
| 264 | endpoint->bEndpointAddress); |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 265 | } |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 266 | } |
| 267 | if ((int_in_found == false) || |
| 268 | (bulk_in_found == false) || |
| 269 | (bulk_out_found == false)) { |
| 270 | dev_err(&udev->dev, "Not enough endpoints found in device, aborting!\n"); |
| 271 | goto error; |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 272 | } |
| 273 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 274 | /* Create our buffer and URB to get SVC messages, and start it up */ |
| 275 | es1->svc_buffer = kmalloc(buffer_size, GFP_KERNEL); |
| 276 | if (!es1->svc_buffer) |
| 277 | goto error; |
Greg Kroah-Hartman | 6f83ab7 | 2014-08-30 17:30:04 -0700 | [diff] [blame] | 278 | |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 279 | es1->svc_urb = usb_alloc_urb(0, GFP_KERNEL); |
| 280 | if (!es1->svc_urb) |
| 281 | goto error_urb; |
| 282 | |
| 283 | usb_fill_int_urb(es1->svc_urb, udev, |
| 284 | usb_rcvintpipe(udev, es1->svc_endpoint), |
| 285 | es1->svc_buffer, buffer_size, svc_callback, |
| 286 | es1, svc_interval); |
| 287 | retval = usb_submit_urb(es1->svc_urb, GFP_KERNEL); |
| 288 | if (retval) |
| 289 | goto error_submit_urb; |
| 290 | |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 291 | return 0; |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 292 | |
| 293 | error_submit_urb: |
| 294 | usb_free_urb(es1->svc_urb); |
| 295 | error_urb: |
| 296 | kfree(es1->svc_buffer); |
| 297 | error: |
| 298 | greybus_remove_hd(es1->hd); |
| 299 | return retval; |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 300 | } |
| 301 | |
| 302 | static void ap_disconnect(struct usb_interface *interface) |
| 303 | { |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 304 | struct es1_ap_dev *es1; |
| 305 | |
| 306 | es1 = usb_get_intfdata(interface); |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 307 | |
Greg Kroah-Hartman | f1eec30 | 2014-08-30 17:18:14 -0700 | [diff] [blame] | 308 | /* Tear down everything! */ |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 309 | usb_kill_urb(es1->svc_urb); |
Greg Kroah-Hartman | d9d077f | 2014-09-08 20:11:18 -0700 | [diff] [blame] | 310 | usb_free_urb(es1->svc_urb); |
Greg Kroah-Hartman | a39879f | 2014-09-06 16:57:36 -0700 | [diff] [blame] | 311 | usb_put_dev(es1->usb_dev); |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 312 | kfree(es1->svc_buffer); |
Greg Kroah-Hartman | 68f1fc4 | 2014-09-07 13:12:11 -0700 | [diff] [blame] | 313 | greybus_remove_hd(es1->hd); |
Greg Kroah-Hartman | 47f6ef1 | 2014-09-08 20:09:08 -0700 | [diff] [blame] | 314 | usb_set_intfdata(interface, NULL); |
Greg Kroah-Hartman | ba4468d4 | 2014-08-30 17:06:54 -0700 | [diff] [blame] | 315 | } |
| 316 | |
| 317 | static struct usb_driver es1_ap_driver = { |
| 318 | .name = "es1_ap_driver", |
| 319 | .probe = ap_probe, |
| 320 | .disconnect = ap_disconnect, |
| 321 | .id_table = id_table, |
| 322 | }; |
| 323 | |
| 324 | module_usb_driver(es1_ap_driver); |
| 325 | |
| 326 | MODULE_LICENSE("GPL"); |
| 327 | MODULE_AUTHOR("Greg Kroah-Hartman <gregkh@linuxfoundation.org>"); |