dbgp.c 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447
  1. /*
  2. * dbgp.c -- EHCI Debug Port device gadget
  3. *
  4. * Copyright (C) 2010 Stephane Duverger
  5. *
  6. * Released under the GPLv2.
  7. */
  8. /* verbose messages */
  9. #include <linux/kernel.h>
  10. #include <linux/device.h>
  11. #include <linux/module.h>
  12. #include <linux/usb/ch9.h>
  13. #include <linux/usb/gadget.h>
  14. /* See comments in "zero.c" */
  15. #include "epautoconf.c"
  16. #ifdef CONFIG_USB_G_DBGP_SERIAL
  17. #include "u_serial.c"
  18. #endif
  19. #define DRIVER_VENDOR_ID 0x0525 /* NetChip */
  20. #define DRIVER_PRODUCT_ID 0xc0de /* undefined */
  21. #define USB_DEBUG_MAX_PACKET_SIZE 8
  22. #define DBGP_REQ_EP0_LEN 128
  23. #define DBGP_REQ_LEN 512
  24. static struct dbgp {
  25. struct usb_gadget *gadget;
  26. struct usb_request *req;
  27. struct usb_ep *i_ep;
  28. struct usb_ep *o_ep;
  29. #ifdef CONFIG_USB_G_DBGP_SERIAL
  30. struct gserial *serial;
  31. #endif
  32. } dbgp;
  33. static struct usb_device_descriptor device_desc = {
  34. .bLength = sizeof device_desc,
  35. .bDescriptorType = USB_DT_DEVICE,
  36. .bcdUSB = __constant_cpu_to_le16(0x0200),
  37. .bDeviceClass = USB_CLASS_VENDOR_SPEC,
  38. .idVendor = __constant_cpu_to_le16(DRIVER_VENDOR_ID),
  39. .idProduct = __constant_cpu_to_le16(DRIVER_PRODUCT_ID),
  40. .bNumConfigurations = 1,
  41. };
  42. static struct usb_debug_descriptor dbg_desc = {
  43. .bLength = sizeof dbg_desc,
  44. .bDescriptorType = USB_DT_DEBUG,
  45. };
  46. static struct usb_endpoint_descriptor i_desc = {
  47. .bLength = USB_DT_ENDPOINT_SIZE,
  48. .bDescriptorType = USB_DT_ENDPOINT,
  49. .bmAttributes = USB_ENDPOINT_XFER_BULK,
  50. .bEndpointAddress = USB_DIR_IN,
  51. };
  52. static struct usb_endpoint_descriptor o_desc = {
  53. .bLength = USB_DT_ENDPOINT_SIZE,
  54. .bDescriptorType = USB_DT_ENDPOINT,
  55. .bmAttributes = USB_ENDPOINT_XFER_BULK,
  56. .bEndpointAddress = USB_DIR_OUT,
  57. };
  58. #ifdef CONFIG_USB_G_DBGP_PRINTK
  59. static int dbgp_consume(char *buf, unsigned len)
  60. {
  61. char c;
  62. if (!len)
  63. return 0;
  64. c = buf[len-1];
  65. if (c != 0)
  66. buf[len-1] = 0;
  67. printk(KERN_NOTICE "%s%c", buf, c);
  68. return 0;
  69. }
  70. static void __disable_ep(struct usb_ep *ep)
  71. {
  72. if (ep && ep->driver_data == dbgp.gadget) {
  73. usb_ep_disable(ep);
  74. ep->driver_data = NULL;
  75. }
  76. }
  77. static void dbgp_disable_ep(void)
  78. {
  79. __disable_ep(dbgp.i_ep);
  80. __disable_ep(dbgp.o_ep);
  81. }
  82. static void dbgp_complete(struct usb_ep *ep, struct usb_request *req)
  83. {
  84. int stp;
  85. int err = 0;
  86. int status = req->status;
  87. if (ep == dbgp.i_ep) {
  88. stp = 1;
  89. goto fail;
  90. }
  91. if (status != 0) {
  92. stp = 2;
  93. goto release_req;
  94. }
  95. dbgp_consume(req->buf, req->actual);
  96. req->length = DBGP_REQ_LEN;
  97. err = usb_ep_queue(ep, req, GFP_ATOMIC);
  98. if (err < 0) {
  99. stp = 3;
  100. goto release_req;
  101. }
  102. return;
  103. release_req:
  104. kfree(req->buf);
  105. usb_ep_free_request(dbgp.o_ep, req);
  106. dbgp_disable_ep();
  107. fail:
  108. dev_dbg(&dbgp.gadget->dev,
  109. "complete: failure (%d:%d) ==> %d\n", stp, err, status);
  110. }
  111. static int dbgp_enable_ep_req(struct usb_ep *ep)
  112. {
  113. int err, stp;
  114. struct usb_request *req;
  115. req = usb_ep_alloc_request(ep, GFP_KERNEL);
  116. if (!req) {
  117. err = -ENOMEM;
  118. stp = 1;
  119. goto fail_1;
  120. }
  121. req->buf = kzalloc(DBGP_REQ_LEN, GFP_KERNEL);
  122. if (!req->buf) {
  123. err = -ENOMEM;
  124. stp = 2;
  125. goto fail_2;
  126. }
  127. req->complete = dbgp_complete;
  128. req->length = DBGP_REQ_LEN;
  129. err = usb_ep_queue(ep, req, GFP_ATOMIC);
  130. if (err < 0) {
  131. stp = 3;
  132. goto fail_3;
  133. }
  134. return 0;
  135. fail_3:
  136. kfree(req->buf);
  137. fail_2:
  138. usb_ep_free_request(dbgp.o_ep, req);
  139. fail_1:
  140. dev_dbg(&dbgp.gadget->dev,
  141. "enable ep req: failure (%d:%d)\n", stp, err);
  142. return err;
  143. }
  144. static int __enable_ep(struct usb_ep *ep, struct usb_endpoint_descriptor *desc)
  145. {
  146. int err;
  147. ep->desc = desc;
  148. err = usb_ep_enable(ep);
  149. ep->driver_data = dbgp.gadget;
  150. return err;
  151. }
  152. static int dbgp_enable_ep(void)
  153. {
  154. int err, stp;
  155. err = __enable_ep(dbgp.i_ep, &i_desc);
  156. if (err < 0) {
  157. stp = 1;
  158. goto fail_1;
  159. }
  160. err = __enable_ep(dbgp.o_ep, &o_desc);
  161. if (err < 0) {
  162. stp = 2;
  163. goto fail_2;
  164. }
  165. err = dbgp_enable_ep_req(dbgp.o_ep);
  166. if (err < 0) {
  167. stp = 3;
  168. goto fail_3;
  169. }
  170. return 0;
  171. fail_3:
  172. __disable_ep(dbgp.o_ep);
  173. fail_2:
  174. __disable_ep(dbgp.i_ep);
  175. fail_1:
  176. dev_dbg(&dbgp.gadget->dev, "enable ep: failure (%d:%d)\n", stp, err);
  177. return err;
  178. }
  179. #endif
  180. static void dbgp_disconnect(struct usb_gadget *gadget)
  181. {
  182. #ifdef CONFIG_USB_G_DBGP_PRINTK
  183. dbgp_disable_ep();
  184. #else
  185. gserial_disconnect(dbgp.serial);
  186. #endif
  187. }
  188. static void dbgp_unbind(struct usb_gadget *gadget)
  189. {
  190. #ifdef CONFIG_USB_G_DBGP_SERIAL
  191. kfree(dbgp.serial);
  192. #endif
  193. if (dbgp.req) {
  194. kfree(dbgp.req->buf);
  195. usb_ep_free_request(gadget->ep0, dbgp.req);
  196. }
  197. gadget->ep0->driver_data = NULL;
  198. }
  199. static int __init dbgp_configure_endpoints(struct usb_gadget *gadget)
  200. {
  201. int stp;
  202. usb_ep_autoconfig_reset(gadget);
  203. dbgp.i_ep = usb_ep_autoconfig(gadget, &i_desc);
  204. if (!dbgp.i_ep) {
  205. stp = 1;
  206. goto fail_1;
  207. }
  208. dbgp.i_ep->driver_data = gadget;
  209. i_desc.wMaxPacketSize =
  210. __constant_cpu_to_le16(USB_DEBUG_MAX_PACKET_SIZE);
  211. dbgp.o_ep = usb_ep_autoconfig(gadget, &o_desc);
  212. if (!dbgp.o_ep) {
  213. dbgp.i_ep->driver_data = NULL;
  214. stp = 2;
  215. goto fail_2;
  216. }
  217. dbgp.o_ep->driver_data = gadget;
  218. o_desc.wMaxPacketSize =
  219. __constant_cpu_to_le16(USB_DEBUG_MAX_PACKET_SIZE);
  220. dbg_desc.bDebugInEndpoint = i_desc.bEndpointAddress;
  221. dbg_desc.bDebugOutEndpoint = o_desc.bEndpointAddress;
  222. #ifdef CONFIG_USB_G_DBGP_SERIAL
  223. dbgp.serial->in = dbgp.i_ep;
  224. dbgp.serial->out = dbgp.o_ep;
  225. dbgp.serial->in->desc = &i_desc;
  226. dbgp.serial->out->desc = &o_desc;
  227. if (gserial_setup(gadget, 1) < 0) {
  228. stp = 3;
  229. goto fail_3;
  230. }
  231. return 0;
  232. fail_3:
  233. dbgp.o_ep->driver_data = NULL;
  234. #else
  235. return 0;
  236. #endif
  237. fail_2:
  238. dbgp.i_ep->driver_data = NULL;
  239. fail_1:
  240. dev_dbg(&dbgp.gadget->dev, "ep config: failure (%d)\n", stp);
  241. return -ENODEV;
  242. }
  243. static int __init dbgp_bind(struct usb_gadget *gadget)
  244. {
  245. int err, stp;
  246. dbgp.gadget = gadget;
  247. dbgp.req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
  248. if (!dbgp.req) {
  249. err = -ENOMEM;
  250. stp = 1;
  251. goto fail;
  252. }
  253. dbgp.req->buf = kmalloc(DBGP_REQ_EP0_LEN, GFP_KERNEL);
  254. if (!dbgp.req->buf) {
  255. err = -ENOMEM;
  256. stp = 2;
  257. goto fail;
  258. }
  259. dbgp.req->length = DBGP_REQ_EP0_LEN;
  260. gadget->ep0->driver_data = gadget;
  261. #ifdef CONFIG_USB_G_DBGP_SERIAL
  262. dbgp.serial = kzalloc(sizeof(struct gserial), GFP_KERNEL);
  263. if (!dbgp.serial) {
  264. stp = 3;
  265. err = -ENOMEM;
  266. goto fail;
  267. }
  268. #endif
  269. err = dbgp_configure_endpoints(gadget);
  270. if (err < 0) {
  271. stp = 4;
  272. goto fail;
  273. }
  274. dev_dbg(&dbgp.gadget->dev, "bind: success\n");
  275. return 0;
  276. fail:
  277. dev_dbg(&gadget->dev, "bind: failure (%d:%d)\n", stp, err);
  278. dbgp_unbind(gadget);
  279. return err;
  280. }
  281. static void dbgp_setup_complete(struct usb_ep *ep,
  282. struct usb_request *req)
  283. {
  284. dev_dbg(&dbgp.gadget->dev, "setup complete: %d, %d/%d\n",
  285. req->status, req->actual, req->length);
  286. }
  287. static int dbgp_setup(struct usb_gadget *gadget,
  288. const struct usb_ctrlrequest *ctrl)
  289. {
  290. struct usb_request *req = dbgp.req;
  291. u8 request = ctrl->bRequest;
  292. u16 value = le16_to_cpu(ctrl->wValue);
  293. u16 length = le16_to_cpu(ctrl->wLength);
  294. int err = -EOPNOTSUPP;
  295. void *data = NULL;
  296. u16 len = 0;
  297. gadget->ep0->driver_data = gadget;
  298. if (length > DBGP_REQ_LEN) {
  299. if (ctrl->bRequestType & USB_DIR_IN) {
  300. /* Cast away the const, we are going to overwrite on purpose. */
  301. __le16 *temp = (__le16 *)&ctrl->wLength;
  302. *temp = cpu_to_le16(DBGP_REQ_LEN);
  303. length = DBGP_REQ_LEN;
  304. } else {
  305. return err;
  306. }
  307. }
  308. if (request == USB_REQ_GET_DESCRIPTOR) {
  309. switch (value>>8) {
  310. case USB_DT_DEVICE:
  311. dev_dbg(&dbgp.gadget->dev, "setup: desc device\n");
  312. len = sizeof device_desc;
  313. data = &device_desc;
  314. device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
  315. break;
  316. case USB_DT_DEBUG:
  317. dev_dbg(&dbgp.gadget->dev, "setup: desc debug\n");
  318. len = sizeof dbg_desc;
  319. data = &dbg_desc;
  320. break;
  321. default:
  322. goto fail;
  323. }
  324. err = 0;
  325. } else if (request == USB_REQ_SET_FEATURE &&
  326. value == USB_DEVICE_DEBUG_MODE) {
  327. dev_dbg(&dbgp.gadget->dev, "setup: feat debug\n");
  328. #ifdef CONFIG_USB_G_DBGP_PRINTK
  329. err = dbgp_enable_ep();
  330. #else
  331. err = gserial_connect(dbgp.serial, 0);
  332. #endif
  333. if (err < 0)
  334. goto fail;
  335. } else
  336. goto fail;
  337. req->length = min(length, len);
  338. req->zero = len < req->length;
  339. if (data && req->length)
  340. memcpy(req->buf, data, req->length);
  341. req->complete = dbgp_setup_complete;
  342. return usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
  343. fail:
  344. dev_dbg(&dbgp.gadget->dev,
  345. "setup: failure req %x v %x\n", request, value);
  346. return err;
  347. }
  348. static struct usb_gadget_driver dbgp_driver = {
  349. .function = "dbgp",
  350. .max_speed = USB_SPEED_HIGH,
  351. .unbind = dbgp_unbind,
  352. .setup = dbgp_setup,
  353. .disconnect = dbgp_disconnect,
  354. .driver = {
  355. .owner = THIS_MODULE,
  356. .name = "dbgp"
  357. },
  358. };
  359. static int __init dbgp_init(void)
  360. {
  361. return usb_gadget_probe_driver(&dbgp_driver, dbgp_bind);
  362. }
  363. static void __exit dbgp_exit(void)
  364. {
  365. usb_gadget_unregister_driver(&dbgp_driver);
  366. #ifdef CONFIG_USB_G_DBGP_SERIAL
  367. gserial_cleanup();
  368. #endif
  369. }
  370. MODULE_AUTHOR("Stephane Duverger");
  371. MODULE_LICENSE("GPL");
  372. module_init(dbgp_init);
  373. module_exit(dbgp_exit);