1
0
mirror of git://projects.qi-hardware.com/ben-wpan.git synced 2024-11-04 23:04:38 +02:00

usb/: added DFU implementation from f386base/fw/boot/ (unported)

This commit is contained in:
Werner Almesberger 2011-03-08 19:05:26 -03:00
parent 0676bef2c1
commit fb2204ad84
2 changed files with 418 additions and 0 deletions

332
atusb/fw/usb/dfu.c Normal file
View File

@ -0,0 +1,332 @@
/*
* boot/dfu.c - DFU protocol engine
*
* Written 2008-2010 by Werner Almesberger
* Copyright 2008-2010 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 "regs.h"
#include "uart.h"
#include "usb.h"
#include "dfu.h"
#include "config.h"
#ifndef NULL
#define NULL 0
#endif
#define PAYLOAD_END (PAYLOAD_START+PAYLOAD_SIZE)
const uint8_t device_descriptor[] = {
18, /* bLength */
USB_DT_DEVICE, /* bDescriptorType */
LE(0x100), /* bcdUSB */
USB_CLASS_PER_INTERFACE,/* bDeviceClass */
0x00, /* bDeviceSubClass (per interface) */
0x00, /* bDeviceProtocol (per interface) */
EP0_SIZE, /* bMaxPacketSize */
LE(USB_VENDOR), /* idVendor */
LE(USB_PRODUCT), /* idProduct */
LE(0x0001), /* bcdDevice */
0, /* iManufacturer */
0, /* iProduct */
0, /* iSerialNumber */
1 /* bNumConfigurations */
};
const uint8_t config_descriptor[] = {
9, /* bLength */
USB_DT_CONFIG, /* bDescriptorType */
LE(9+9), /* wTotalLength */
1, /* bNumInterfaces */
1, /* bConfigurationValue (> 0 !) */
0, /* iConfiguration */
// USB_ATTR_SELF_POWERED | USB_ATTR_BUS_POWERED,
USB_ATTR_BUS_POWERED, /* bmAttributes */
15, /* bMaxPower */
/* Interface #0 */
9, /* bLength */
USB_DT_INTERFACE, /* bDescriptorType */
0, /* bInterfaceNumber */
0, /* bAlternateSetting */
0, /* bNumEndpoints */
0xfe, /* bInterfaceClass (application specific) */
0x01, /* bInterfaceSubClass (device fw upgrade) */
0x02, /* bInterfaceProtocol (DFU mode protocol) */
0, /* iInterface */
};
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 */
};
struct dfu dfu = {
OK,
LE(1000), 0,
dfuIDLE,
0,
};
static uint16_t next_block = 0;
static uint16_t payload;
static __bit did_download;
static __xdata uint8_t buf[EP0_SIZE];
static void flash_erase_page(uint16_t addr)
{
FLKEY = 0xa5;
FLKEY = 0xf1;
PSCTL |= PSEE;
PSCTL |= PSWE;
*(__xdata uint8_t *) addr = 0;
PSCTL &= ~PSWE;
PSCTL &= ~PSEE;
}
static void flash_write_byte(uint16_t addr, uint8_t value)
{
FLKEY = 0xa5;
FLKEY = 0xf1;
PSCTL |= PSWE;
PSCTL &= ~PSEE;
*(__xdata uint8_t *) addr = value;
PSCTL &= ~PSWE;
}
static void block_write(void *user)
{
uint16_t *size = user;
uint8_t *p;
for (p = buf; p != buf+*size; p++) {
if (!(payload & 511))
flash_erase_page(payload);
flash_write_byte(payload, *p);
payload++;
}
}
static __bit block_receive(uint16_t length)
{
static uint16_t size;
if (payload < PAYLOAD_START || payload+length > PAYLOAD_END) {
dfu.state = dfuERROR;
dfu.status = errADDRESS;
return 0;
}
if (length > EP0_SIZE) {
dfu.state = dfuERROR;
dfu.status = errUNKNOWN;
return 0;
}
size = length;
usb_recv(&ep0, buf, size, block_write, &size);
return 1;
}
static __bit block_transmit(uint16_t length)
{
uint16_t left;
if (payload < PAYLOAD_START || payload > PAYLOAD_END) {
dfu.state = dfuERROR;
dfu.status = errADDRESS;
return 1;
}
if (length > EP0_SIZE) {
dfu.state = dfuERROR;
dfu.status = errUNKNOWN;
return 1;
}
left = PAYLOAD_END-payload;
if (left < length) {
length = left;
dfu.state = dfuIDLE;
}
usb_send(&ep0, (__code uint8_t *) payload, length, NULL, NULL);
payload += length;
return 1;
}
static __bit my_setup(struct setup_request *setup) __reentrant
{
__bit ok;
switch (setup->bmRequestType | setup->bRequest << 8) {
case DFU_TO_DEV(DFU_DETACH):
debug("DFU_DETACH\n");
/*
* The DFU spec says thay this is sent in protocol 1 only.
* However, dfu-util also sends it to get out of DFU mode,
* so we just don't make a fuss and ignore it.
*/
return 1;
case DFU_TO_DEV(DFU_DNLOAD):
debug("DFU_DNLOAD\n");
if (dfu.state == dfuIDLE) {
next_block = setup->wValue;
payload = PAYLOAD_START;
}
else if (dfu.state != dfuDNLOAD_IDLE) {
error("bad state\n");
return 0;
}
if (dfu.state != dfuIDLE && setup->wValue == next_block-1) {
debug("retransmisson\n");
return 1;
}
if (setup->wValue != next_block) {
debug("bad block (%d vs. %d)\n",
setup->wValue, next_block);
dfu.state = dfuERROR;
dfu.status = errUNKNOWN;
return 1;
}
if (!setup->wLength) {
debug("DONE\n");
dfu.state = dfuIDLE;
did_download = 1;
return 1;
}
ok = block_receive(setup->wLength);
next_block++;
dfu.state = dfuDNLOAD_IDLE;
return ok;
case DFU_FROM_DEV(DFU_UPLOAD):
debug("DFU_UPLOAD\n");
if (dfu.state == dfuIDLE) {
next_block = setup->wValue;
payload = PAYLOAD_START;
}
else if (dfu.state != dfuUPLOAD_IDLE)
return 0;
if (dfu.state != dfuIDLE && setup->wValue == next_block-1) {
debug("retransmisson\n");
/* @@@ try harder */
dfu.state = dfuERROR;
dfu.status = errUNKNOWN;
return 1;
}
if (setup->wValue != next_block) {
debug("bad block (%d vs. %d)\n",
setup->wValue, next_block);
dfu.state = dfuERROR;
dfu.status = errUNKNOWN;
return 1;
}
ok = block_transmit(setup->wLength);
next_block++;
dfu.state = dfuUPLOAD_IDLE;
return ok;
case DFU_FROM_DEV(DFU_GETSTATUS):
debug("DFU_GETSTATUS\n");
usb_send(&ep0, (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(&ep0, &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:
#ifdef CONFIG_PRINTK
printk("DFU rt %x, rq%x ?\n",
setup->bmRequestType, setup->bRequest);
#else
/*
* @@@ SDCC 2.7.0 ends up OR'in setup->bmRequestType with
* setup->bRequest unshifted if we don't use at least one of
* them here.
*/
{
static volatile uint8_t foo;
foo = setup->bRequest;
}
#endif
return 0;
}
}
static __bit my_descr(uint8_t type, uint8_t index, const uint8_t **reply,
uint8_t *size) __reentrant
{
index; /* suppress warning */
if (type != DFU_DT_FUNCTIONAL)
return 0;
*reply = functional_descriptor;
*size = sizeof(functional_descriptor);
return 1;
}
static void my_reset(void) __reentrant
{
/* @@@ not nice -- think about where this should go */
extern void run_payload(void);
if (did_download)
run_payload();
}
void dfu_init(void)
{
user_setup = my_setup;
user_get_descriptor = my_descr;
user_reset = my_reset;
}

86
atusb/fw/usb/dfu.h Normal file
View File

@ -0,0 +1,86 @@
/*
* boot/dfu.h - DFU protocol constants and data structures
*
* Written 2008 by Werner Almesberger
* Copyright 2008 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.
*/
#ifndef DFU_H
#define DFU_H
#include <stdint.h>
enum dfu_request {
DFU_DETACH,
DFU_DNLOAD,
DFU_UPLOAD,
DFU_GETSTATUS,
DFU_CLRSTATUS,
DFU_GETSTATE,
DFU_ABORT,
};
enum dfu_status {
OK,
errTARGET,
errFILE,
errWRITE,
errERASE,
errCHECK_ERASED,
errPROG,
errVERIFY,
errADDRESS,
errNOTDONE,
errFIRMWARE,
errVENDOR,
errUSBR,
errPOR,
errUNKNOWN,
errSTALLEDPKT,
};
enum dfu_state {
appIDLE,
appDETACH,
dfuIDLE,
dfuDNLOAD_SYNC,
dfuDNBUSY,
dfuDNLOAD_IDLE,
dfuMANIFEST_SYNC,
dfuMANIFEST,
dfuMANIFEST_WAIT_RESET,
dfuUPLOAD_IDLE,
dfuERROR
};
#define DFU_DT_FUNCTIONAL 0x21 /* DFU FUNCTIONAL descriptor type */
#define DFU_TO_DEV(req) (0x21 | (req) << 8)
#define DFU_FROM_DEV(req) (0xa1 | (req) << 8)
struct dfu {
uint8_t status; /* bStatus */
uint8_t toL, toM, toH; /* bwPollTimeout */
uint8_t state; /* bState */
uint8_t iString;
};
extern struct dfu dfu;
void dfu_init(void);
#endif /* !DFU_H */