2 * f_dfu.c -- Device Firmware Update USB function
4 * Copyright (C) 2012 Samsung Electronics
5 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
6 * Lukasz Majewski <l.majewski@samsung.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <linux/usb/ch9.h>
28 #include <linux/usb/gadget.h>
29 #include <linux/usb/composite.h>
35 struct usb_function usb_function;
37 struct usb_descriptor_header **function;
38 struct usb_string *strings;
40 /* when configured, we have one config */
43 enum dfu_state dfu_state;
44 unsigned int dfu_status;
46 /* Send/received block number is handy for data integrity check */
50 typedef int (*dfu_state_fn) (struct f_dfu *,
51 const struct usb_ctrlrequest *,
53 struct usb_request *);
55 static inline struct f_dfu *func_to_dfu(struct usb_function *f)
57 return container_of(f, struct f_dfu, usb_function);
60 static const struct dfu_function_descriptor dfu_func = {
61 .bLength = sizeof dfu_func,
62 .bDescriptorType = DFU_DT_FUNC,
63 .bmAttributes = DFU_BIT_WILL_DETACH |
64 DFU_BIT_MANIFESTATION_TOLERANT |
68 .wTransferSize = DFU_USB_BUFSIZ,
69 .bcdDFUVersion = __constant_cpu_to_le16(0x0110),
72 static struct usb_interface_descriptor dfu_intf_runtime = {
73 .bLength = sizeof dfu_intf_runtime,
74 .bDescriptorType = USB_DT_INTERFACE,
76 .bInterfaceClass = USB_CLASS_APP_SPEC,
77 .bInterfaceSubClass = 1,
78 .bInterfaceProtocol = 1,
79 /* .iInterface = DYNAMIC */
82 static struct usb_descriptor_header *dfu_runtime_descs[] = {
83 (struct usb_descriptor_header *) &dfu_intf_runtime,
87 static const struct usb_qualifier_descriptor dev_qualifier = {
88 .bLength = sizeof dev_qualifier,
89 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
90 .bcdUSB = __constant_cpu_to_le16(0x0200),
91 .bDeviceClass = USB_CLASS_VENDOR_SPEC,
92 .bNumConfigurations = 1,
95 static const char dfu_name[] = "Device Firmware Upgrade";
98 * static strings, in UTF-8
100 * dfu_generic configuration
102 static struct usb_string strings_dfu_generic[] = {
104 { } /* end of list */
107 static struct usb_gadget_strings stringtab_dfu_generic = {
108 .language = 0x0409, /* en-us */
109 .strings = strings_dfu_generic,
112 static struct usb_gadget_strings *dfu_generic_strings[] = {
113 &stringtab_dfu_generic,
118 * usb_function specific
120 static struct usb_gadget_strings stringtab_dfu = {
121 .language = 0x0409, /* en-us */
125 * assigned during initialization,
126 * depends on number of flash entities
131 static struct usb_gadget_strings *dfu_strings[] = {
136 /*-------------------------------------------------------------------------*/
138 static void dnload_request_complete(struct usb_ep *ep, struct usb_request *req)
140 struct f_dfu *f_dfu = req->context;
142 dfu_write(dfu_get_entity(f_dfu->altsetting), req->buf,
143 req->length, f_dfu->blk_seq_num);
145 if (req->length == 0)
146 puts("DOWNLOAD ... OK\nCtrl+C to exit ...\n");
149 static void handle_getstatus(struct usb_request *req)
151 struct dfu_status *dstat = (struct dfu_status *)req->buf;
152 struct f_dfu *f_dfu = req->context;
154 switch (f_dfu->dfu_state) {
155 case DFU_STATE_dfuDNLOAD_SYNC:
156 case DFU_STATE_dfuDNBUSY:
157 f_dfu->dfu_state = DFU_STATE_dfuDNLOAD_IDLE;
159 case DFU_STATE_dfuMANIFEST_SYNC:
165 /* send status response */
166 dstat->bStatus = f_dfu->dfu_status;
167 dstat->bState = f_dfu->dfu_state;
171 static void handle_getstate(struct usb_request *req)
173 struct f_dfu *f_dfu = req->context;
175 ((u8 *)req->buf)[0] = f_dfu->dfu_state;
176 req->actual = sizeof(u8);
179 static inline void to_dfu_mode(struct f_dfu *f_dfu)
181 f_dfu->usb_function.strings = dfu_strings;
182 f_dfu->usb_function.hs_descriptors = f_dfu->function;
185 static inline void to_runtime_mode(struct f_dfu *f_dfu)
187 f_dfu->usb_function.strings = NULL;
188 f_dfu->usb_function.hs_descriptors = dfu_runtime_descs;
191 static int handle_upload(struct usb_request *req, u16 len)
193 struct f_dfu *f_dfu = req->context;
195 return dfu_read(dfu_get_entity(f_dfu->altsetting), req->buf,
196 req->length, f_dfu->blk_seq_num);
199 static int handle_dnload(struct usb_gadget *gadget, u16 len)
201 struct usb_composite_dev *cdev = get_gadget_data(gadget);
202 struct usb_request *req = cdev->req;
203 struct f_dfu *f_dfu = req->context;
206 f_dfu->dfu_state = DFU_STATE_dfuMANIFEST_SYNC;
208 req->complete = dnload_request_complete;
213 /*-------------------------------------------------------------------------*/
214 /* DFU state machine */
215 static int state_app_idle(struct f_dfu *f_dfu,
216 const struct usb_ctrlrequest *ctrl,
217 struct usb_gadget *gadget,
218 struct usb_request *req)
222 switch (ctrl->bRequest) {
223 case USB_REQ_DFU_GETSTATUS:
224 handle_getstatus(req);
225 value = RET_STAT_LEN;
227 case USB_REQ_DFU_GETSTATE:
228 handle_getstate(req);
230 case USB_REQ_DFU_DETACH:
231 f_dfu->dfu_state = DFU_STATE_appDETACH;
233 f_dfu->dfu_state = DFU_STATE_dfuIDLE;
244 static int state_app_detach(struct f_dfu *f_dfu,
245 const struct usb_ctrlrequest *ctrl,
246 struct usb_gadget *gadget,
247 struct usb_request *req)
251 switch (ctrl->bRequest) {
252 case USB_REQ_DFU_GETSTATUS:
253 handle_getstatus(req);
254 value = RET_STAT_LEN;
256 case USB_REQ_DFU_GETSTATE:
257 handle_getstate(req);
260 f_dfu->dfu_state = DFU_STATE_appIDLE;
268 static int state_dfu_idle(struct f_dfu *f_dfu,
269 const struct usb_ctrlrequest *ctrl,
270 struct usb_gadget *gadget,
271 struct usb_request *req)
273 u16 w_value = le16_to_cpu(ctrl->wValue);
274 u16 len = le16_to_cpu(ctrl->wLength);
277 switch (ctrl->bRequest) {
278 case USB_REQ_DFU_DNLOAD:
280 f_dfu->dfu_state = DFU_STATE_dfuERROR;
284 f_dfu->dfu_state = DFU_STATE_dfuDNLOAD_SYNC;
285 f_dfu->blk_seq_num = w_value;
286 value = handle_dnload(gadget, len);
288 case USB_REQ_DFU_UPLOAD:
289 f_dfu->dfu_state = DFU_STATE_dfuUPLOAD_IDLE;
290 f_dfu->blk_seq_num = 0;
291 value = handle_upload(req, len);
293 case USB_REQ_DFU_ABORT:
297 case USB_REQ_DFU_GETSTATUS:
298 handle_getstatus(req);
299 value = RET_STAT_LEN;
301 case USB_REQ_DFU_GETSTATE:
302 handle_getstate(req);
304 case USB_REQ_DFU_DETACH:
306 * Proprietary extension: 'detach' from idle mode and
307 * get back to runtime mode in case of USB Reset. As
308 * much as I dislike this, we just can't use every USB
309 * bus reset to switch back to runtime mode, since at
310 * least the Linux USB stack likes to send a number of
314 DFU_STATE_dfuMANIFEST_WAIT_RST;
315 to_runtime_mode(f_dfu);
316 f_dfu->dfu_state = DFU_STATE_appIDLE;
319 f_dfu->dfu_state = DFU_STATE_dfuERROR;
327 static int state_dfu_dnload_sync(struct f_dfu *f_dfu,
328 const struct usb_ctrlrequest *ctrl,
329 struct usb_gadget *gadget,
330 struct usb_request *req)
334 switch (ctrl->bRequest) {
335 case USB_REQ_DFU_GETSTATUS:
336 handle_getstatus(req);
337 value = RET_STAT_LEN;
339 case USB_REQ_DFU_GETSTATE:
340 handle_getstate(req);
343 f_dfu->dfu_state = DFU_STATE_dfuERROR;
351 static int state_dfu_dnbusy(struct f_dfu *f_dfu,
352 const struct usb_ctrlrequest *ctrl,
353 struct usb_gadget *gadget,
354 struct usb_request *req)
358 switch (ctrl->bRequest) {
359 case USB_REQ_DFU_GETSTATUS:
360 handle_getstatus(req);
361 value = RET_STAT_LEN;
364 f_dfu->dfu_state = DFU_STATE_dfuERROR;
372 static int state_dfu_dnload_idle(struct f_dfu *f_dfu,
373 const struct usb_ctrlrequest *ctrl,
374 struct usb_gadget *gadget,
375 struct usb_request *req)
377 u16 w_value = le16_to_cpu(ctrl->wValue);
378 u16 len = le16_to_cpu(ctrl->wLength);
381 switch (ctrl->bRequest) {
382 case USB_REQ_DFU_DNLOAD:
383 f_dfu->dfu_state = DFU_STATE_dfuDNLOAD_SYNC;
384 f_dfu->blk_seq_num = w_value;
385 value = handle_dnload(gadget, len);
387 case USB_REQ_DFU_ABORT:
388 f_dfu->dfu_state = DFU_STATE_dfuIDLE;
391 case USB_REQ_DFU_GETSTATUS:
392 handle_getstatus(req);
393 value = RET_STAT_LEN;
395 case USB_REQ_DFU_GETSTATE:
396 handle_getstate(req);
399 f_dfu->dfu_state = DFU_STATE_dfuERROR;
407 static int state_dfu_manifest_sync(struct f_dfu *f_dfu,
408 const struct usb_ctrlrequest *ctrl,
409 struct usb_gadget *gadget,
410 struct usb_request *req)
414 switch (ctrl->bRequest) {
415 case USB_REQ_DFU_GETSTATUS:
416 /* We're MainfestationTolerant */
417 f_dfu->dfu_state = DFU_STATE_dfuIDLE;
418 handle_getstatus(req);
419 f_dfu->blk_seq_num = 0;
420 value = RET_STAT_LEN;
422 case USB_REQ_DFU_GETSTATE:
423 handle_getstate(req);
426 f_dfu->dfu_state = DFU_STATE_dfuERROR;
434 static int state_dfu_upload_idle(struct f_dfu *f_dfu,
435 const struct usb_ctrlrequest *ctrl,
436 struct usb_gadget *gadget,
437 struct usb_request *req)
439 u16 w_value = le16_to_cpu(ctrl->wValue);
440 u16 len = le16_to_cpu(ctrl->wLength);
443 switch (ctrl->bRequest) {
444 case USB_REQ_DFU_UPLOAD:
445 /* state transition if less data then requested */
446 f_dfu->blk_seq_num = w_value;
447 value = handle_upload(req, len);
448 if (value >= 0 && value < len)
449 f_dfu->dfu_state = DFU_STATE_dfuIDLE;
451 case USB_REQ_DFU_ABORT:
452 f_dfu->dfu_state = DFU_STATE_dfuIDLE;
456 case USB_REQ_DFU_GETSTATUS:
457 handle_getstatus(req);
458 value = RET_STAT_LEN;
460 case USB_REQ_DFU_GETSTATE:
461 handle_getstate(req);
464 f_dfu->dfu_state = DFU_STATE_dfuERROR;
472 static int state_dfu_error(struct f_dfu *f_dfu,
473 const struct usb_ctrlrequest *ctrl,
474 struct usb_gadget *gadget,
475 struct usb_request *req)
479 switch (ctrl->bRequest) {
480 case USB_REQ_DFU_GETSTATUS:
481 handle_getstatus(req);
482 value = RET_STAT_LEN;
484 case USB_REQ_DFU_GETSTATE:
485 handle_getstate(req);
487 case USB_REQ_DFU_CLRSTATUS:
488 f_dfu->dfu_state = DFU_STATE_dfuIDLE;
489 f_dfu->dfu_status = DFU_STATUS_OK;
494 f_dfu->dfu_state = DFU_STATE_dfuERROR;
502 static dfu_state_fn dfu_state[] = {
503 state_app_idle, /* DFU_STATE_appIDLE */
504 state_app_detach, /* DFU_STATE_appDETACH */
505 state_dfu_idle, /* DFU_STATE_dfuIDLE */
506 state_dfu_dnload_sync, /* DFU_STATE_dfuDNLOAD_SYNC */
507 state_dfu_dnbusy, /* DFU_STATE_dfuDNBUSY */
508 state_dfu_dnload_idle, /* DFU_STATE_dfuDNLOAD_IDLE */
509 state_dfu_manifest_sync, /* DFU_STATE_dfuMANIFEST_SYNC */
510 NULL, /* DFU_STATE_dfuMANIFEST */
511 NULL, /* DFU_STATE_dfuMANIFEST_WAIT_RST */
512 state_dfu_upload_idle, /* DFU_STATE_dfuUPLOAD_IDLE */
513 state_dfu_error /* DFU_STATE_dfuERROR */
517 dfu_handle(struct usb_function *f, const struct usb_ctrlrequest *ctrl)
519 struct usb_gadget *gadget = f->config->cdev->gadget;
520 struct usb_request *req = f->config->cdev->req;
521 struct f_dfu *f_dfu = f->config->cdev->req->context;
522 u16 len = le16_to_cpu(ctrl->wLength);
523 u16 w_value = le16_to_cpu(ctrl->wValue);
525 u8 req_type = ctrl->bRequestType & USB_TYPE_MASK;
527 debug("w_value: 0x%x len: 0x%x\n", w_value, len);
528 debug("req_type: 0x%x ctrl->bRequest: 0x%x f_dfu->dfu_state: 0x%x\n",
529 req_type, ctrl->bRequest, f_dfu->dfu_state);
531 if (req_type == USB_TYPE_STANDARD) {
532 if (ctrl->bRequest == USB_REQ_GET_DESCRIPTOR &&
533 (w_value >> 8) == DFU_DT_FUNC) {
534 value = min(len, (u16) sizeof(dfu_func));
535 memcpy(req->buf, &dfu_func, value);
537 } else /* DFU specific request */
538 value = dfu_state[f_dfu->dfu_state] (f_dfu, ctrl, gadget, req);
542 req->zero = value < len;
543 value = usb_ep_queue(gadget->ep0, req, 0);
545 debug("ep_queue --> %d\n", value);
553 /*-------------------------------------------------------------------------*/
556 dfu_prepare_strings(struct f_dfu *f_dfu, int n)
558 struct dfu_entity *de = NULL;
561 f_dfu->strings = calloc(sizeof(struct usb_string), n + 1);
565 for (i = 0; i < n; ++i) {
566 de = dfu_get_entity(i);
567 f_dfu->strings[i].s = de->name;
570 f_dfu->strings[i].id = 0;
571 f_dfu->strings[i].s = NULL;
577 f_dfu->strings[--i].s = NULL;
579 free(f_dfu->strings);
584 static int dfu_prepare_function(struct f_dfu *f_dfu, int n)
586 struct usb_interface_descriptor *d;
589 f_dfu->function = calloc(sizeof(struct usb_descriptor_header *), n);
590 if (!f_dfu->function)
593 for (i = 0; i < n; ++i) {
594 d = calloc(sizeof(*d), 1);
598 d->bLength = sizeof(*d);
599 d->bDescriptorType = USB_DT_INTERFACE;
600 d->bAlternateSetting = i;
601 d->bNumEndpoints = 0;
602 d->bInterfaceClass = USB_CLASS_APP_SPEC;
603 d->bInterfaceSubClass = 1;
604 d->bInterfaceProtocol = 2;
606 f_dfu->function[i] = (struct usb_descriptor_header *)d;
608 f_dfu->function[i] = NULL;
614 free(f_dfu->function[--i]);
615 f_dfu->function[i] = NULL;
617 free(f_dfu->function);
622 static int dfu_bind(struct usb_configuration *c, struct usb_function *f)
624 struct usb_composite_dev *cdev = c->cdev;
625 struct f_dfu *f_dfu = func_to_dfu(f);
626 int alt_num = dfu_get_alt_number();
629 id = usb_interface_id(c, f);
632 dfu_intf_runtime.bInterfaceNumber = id;
634 f_dfu->dfu_state = DFU_STATE_appIDLE;
635 f_dfu->dfu_status = DFU_STATUS_OK;
637 rv = dfu_prepare_function(f_dfu, alt_num);
641 rv = dfu_prepare_strings(f_dfu, alt_num);
644 for (i = 0; i < alt_num; i++) {
645 id = usb_string_id(cdev);
648 f_dfu->strings[i].id = id;
649 ((struct usb_interface_descriptor *)f_dfu->function[i])
653 stringtab_dfu.strings = f_dfu->strings;
655 cdev->req->context = f_dfu;
661 static void dfu_unbind(struct usb_configuration *c, struct usb_function *f)
663 struct f_dfu *f_dfu = func_to_dfu(f);
664 int alt_num = dfu_get_alt_number();
667 if (f_dfu->strings) {
670 f_dfu->strings[--i].s = NULL;
672 free(f_dfu->strings);
675 if (f_dfu->function) {
678 free(f_dfu->function[--i]);
679 f_dfu->function[i] = NULL;
681 free(f_dfu->function);
687 static int dfu_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
689 struct f_dfu *f_dfu = func_to_dfu(f);
691 debug("%s: intf:%d alt:%d\n", __func__, intf, alt);
693 f_dfu->altsetting = alt;
698 /* TODO: is this really what we need here? */
699 static void dfu_disable(struct usb_function *f)
701 struct f_dfu *f_dfu = func_to_dfu(f);
702 if (f_dfu->config == 0)
705 debug("%s: reset config\n", __func__);
710 static int dfu_bind_config(struct usb_configuration *c)
715 f_dfu = calloc(sizeof(*f_dfu), 1);
718 f_dfu->usb_function.name = "dfu";
719 f_dfu->usb_function.hs_descriptors = dfu_runtime_descs;
720 f_dfu->usb_function.bind = dfu_bind;
721 f_dfu->usb_function.unbind = dfu_unbind;
722 f_dfu->usb_function.set_alt = dfu_set_alt;
723 f_dfu->usb_function.disable = dfu_disable;
724 f_dfu->usb_function.strings = dfu_generic_strings,
725 f_dfu->usb_function.setup = dfu_handle,
727 status = usb_add_function(c, &f_dfu->usb_function);
734 int dfu_add(struct usb_configuration *c)
738 id = usb_string_id(c->cdev);
741 strings_dfu_generic[0].id = id;
742 dfu_intf_runtime.iInterface = id;
744 debug("%s: cdev: 0x%p gadget:0x%p gadget->ep0: 0x%p\n", __func__,
745 c->cdev, c->cdev->gadget, c->cdev->gadget->ep0);
747 return dfu_bind_config(c);