atusb/fw/: moved common elements of DFU processing to dfu_common.c

- dfu.c (functional_descriptor, dfu, my_descr), dfu.h (dfu_my_descr):
  moved to dfu_common.c
- dfu.c (my_setup), dfu.h (dfu_setup_common), dfu_common.c
  (dfu_setup_common): moved handling of DFU_GETSTATUS, DFU_CLRSTATUS,
  and DFU_GETSTATE from my_setup to dfu_setup_common
- dfu_common.c (my_descr), dfu.c (dfu_init): renamed my_descr to
  dfu_my_descr
- Makefile (BOOT_OBJS): added dfu_common.o

atusb/fw/Makefile

@@ -32,7 +32,8 @@ USB_ID = 20b7:1540
 
 USB_OBJS = usb.o atu2.o
 OBJS = atusb.o board.o board_app.o sernum.o spi.o descr.o ep0.o $(USB_OBJS)
-BOOT_OBJS = boot.o board.o sernum.o spi.o flash.o dfu.o $(USB_OBJS)
+BOOT_OBJS = boot.o board.o sernum.o spi.o flash.o dfu.o dfu_common.o \
+	    $(USB_OBJS)
 
 vpath %.c usb/
 

atusb/fw/usb/dfu.c

@@ -31,7 +31,6 @@
 #include "dfu.h"
 
 #include "../board.h"
-#include "../sernum.h"
 
 
 #ifndef NULL
@@ -81,29 +80,6 @@ const uint8_t config_descriptor[] = {
 };
 
 
-static const uint8_t functional_descriptor[] = {
-	9,			/* bLength */
-	DFU_DT_FUNCTIONAL,	/* bDescriptorType */
-	0xf,			/* bmAttributes (claim omnipotence :-) */
-	LE(0xffff),		/* wDetachTimeOut (we're very patient) */
-	LE(EP0_SIZE),		/* wTransferSize */
-	LE(0x101),		/* bcdDFUVersion */
-};
-
-
-/*
- * The worst-case activity would be flashing a one page and erasing another
- * one, would should take less than 10 ms. A 100 ms timeout ought to be plenty.
- */
-
-struct dfu dfu = {
-	OK,			/* bStatus */
-	LE(100), 0,		/* bwPollTimeout, 100 ms */
-	dfuIDLE,		/* bState */
-	0,			/* iString */
-};
-
-
 static uint16_t next_block = 0;
 static int did_download;
 
@@ -229,43 +205,17 @@ static int my_setup(const struct setup_request *setup)
 		next_block++;
 		dfu.state = dfuUPLOAD_IDLE;
 		return ok;
-	case DFU_FROM_DEV(DFU_GETSTATUS):
-		debug("DFU_GETSTATUS\n");
-		usb_send(&eps[0], (uint8_t *) &dfu, sizeof(dfu), NULL, NULL);
-		return 1;
-	case DFU_TO_DEV(DFU_CLRSTATUS):
-		debug("DFU_CLRSTATUS\n");
-		dfu.state = dfuIDLE;
-		dfu.status = OK;
-		return 1;
-	case DFU_FROM_DEV(DFU_GETSTATE):
-		debug("DFU_GETSTATE\n");
-		usb_send(&eps[0], &dfu.state, 1, NULL, NULL);
-		return 1;
 	case DFU_TO_DEV(DFU_ABORT):
 		debug("DFU_ABORT\n");
 		dfu.state = dfuIDLE;
 		dfu.status = OK;
 		return 1;
 	default:
-		error("DFU rt %x, rq%x ?\n",
-		    setup->bmRequestType, setup->bRequest);
-		return 0;
+		return dfu_setup_common(setup);
 	}
 }
 
 
-static int my_descr(uint8_t type, uint8_t index, const uint8_t **reply,
-    uint8_t *size)
-{
-	if (type != DFU_DT_FUNCTIONAL)
-		return sernum_get_descr(type, index, reply, size);
-	*reply = functional_descriptor;
-	*size = sizeof(functional_descriptor);
-	return 1;
-}
-
-
 static void my_reset(void)
 {
 #if 0
@@ -281,6 +231,6 @@ static void my_reset(void)
 void dfu_init(void)
 {
 	user_setup = my_setup;
-	user_get_descriptor = my_descr;
+	user_get_descriptor = dfu_my_descr;
 	user_reset = my_reset;
 }

atusb/fw/usb/dfu.h

@@ -99,6 +99,9 @@ void flash_write(const uint8_t *buf, uint16_t size);
 void flash_end_write(void);
 uint16_t flash_read(uint8_t *buf, uint16_t size);
 
+int dfu_setup_common(const struct setup_request *setup);
+int dfu_my_descr(uint8_t type, uint8_t index, const uint8_t **reply,
+    uint8_t *size);
 
 void dfu_init(void);
 

atusb/fw/usb/dfu_common.c

@@ -0,0 +1,100 @@
+/*
+ * boot/dfu_common.c - DFU protocol engine parts common to App/DFU
+ *
+ * Written 2008-2011 by Werner Almesberger
+ * Copyright 2008-2011 Werner Almesberger
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ */
+
+/*
+ * http://www.usb.org/developers/devclass_docs/DFU_1.1.pdf
+ */
+
+/*
+ * A few, erm, shortcuts:
+ *
+ * - we don't bother with the app* states since DFU is all this firmware does
+ * - after DFU_DNLOAD, we just block until things are written, so we never
+ *   enter dfuDNLOAD_SYNC or dfuDNBUSY
+ * - no dfuMANIFEST_SYNC, dfuMANIFEST, or dfuMANIFEST_WAIT_RESET
+ * - to keep our buffers small, we only accept EP0-sized blocks
+ */
+
+
+#include <stdint.h>
+
+#include "usb.h"
+#include "dfu.h"
+
+#include "../board.h"
+#include "../sernum.h"
+
+
+#ifndef NULL
+#define NULL 0
+#endif
+
+#define debug(...)
+#define error(...)
+
+
+static const uint8_t functional_descriptor[] = {
+	9,			/* bLength */
+	DFU_DT_FUNCTIONAL,	/* bDescriptorType */
+	0xf,			/* bmAttributes (claim omnipotence :-) */
+	LE(0xffff),		/* wDetachTimeOut (we're very patient) */
+	LE(EP0_SIZE),		/* wTransferSize */
+	LE(0x101),		/* bcdDFUVersion */
+};
+
+
+/*
+ * The worst-case activity would be flashing a one page and erasing another
+ * one, would should take less than 10 ms. A 100 ms timeout ought to be plenty.
+ */
+
+struct dfu dfu = {
+	OK,			/* bStatus */
+	LE(100), 0,		/* bwPollTimeout, 100 ms */
+	dfuIDLE,		/* bState */
+	0,			/* iString */
+};
+
+
+int dfu_setup_common(const struct setup_request *setup)
+{
+	switch (setup->bmRequestType | setup->bRequest << 8) {
+	case DFU_FROM_DEV(DFU_GETSTATUS):
+		debug("DFU_GETSTATUS\n");
+		usb_send(&eps[0], (uint8_t *) &dfu, sizeof(dfu), NULL, NULL);
+		return 1;
+	case DFU_TO_DEV(DFU_CLRSTATUS):
+		debug("DFU_CLRSTATUS\n");
+		dfu.state = dfuIDLE;
+		dfu.status = OK;
+		return 1;
+	case DFU_FROM_DEV(DFU_GETSTATE):
+		debug("DFU_GETSTATE\n");
+		usb_send(&eps[0], &dfu.state, 1, NULL, NULL);
+		return 1;
+	default:
+		error("DFU rt %x, rq%x ?\n",
+		    setup->bmRequestType, setup->bRequest);
+		return 0;
+	}
+}
+
+
+int dfu_my_descr(uint8_t type, uint8_t index, const uint8_t **reply,
+    uint8_t *size)
+{
+	if (type != DFU_DT_FUNCTIONAL)
+		return sernum_get_descr(type, index, reply, size);
+	*reply = functional_descriptor;
+	*size = sizeof(functional_descriptor);
+	return 1;
+}