diff options
Diffstat (limited to 'bootloaders/diskloader/src')
| -rw-r--r-- | bootloaders/diskloader/src/DiskLoader.cpp | 245 | ||||
| -rw-r--r-- | bootloaders/diskloader/src/Platform.h | 47 | ||||
| -rw-r--r-- | bootloaders/diskloader/src/USBCore.cpp | 504 | ||||
| -rw-r--r-- | bootloaders/diskloader/src/USBCore.h | 246 | ||||
| -rw-r--r-- | bootloaders/diskloader/src/USBDesc.cpp | 67 | ||||
| -rw-r--r-- | bootloaders/diskloader/src/USBDesc.h | 63 | 
6 files changed, 1172 insertions, 0 deletions
| diff --git a/bootloaders/diskloader/src/DiskLoader.cpp b/bootloaders/diskloader/src/DiskLoader.cpp new file mode 100644 index 0000000..f854fd1 --- /dev/null +++ b/bootloaders/diskloader/src/DiskLoader.cpp @@ -0,0 +1,245 @@ + + +#include "Platform.h" + +//	This bootloader creates a composite Serial/Mass storage device +// +//	The serial interface supports a STK500v1 protocol that is very similar to optiboot +//	The mass storage interface emulates a disk image that is used to read or write firmware.bin files +//	Delete firmware.bin and copy a new binary (not .hex) file to flash the firmware i.e: +// +//	cp firmware.bin f:/. -f +// +//	Ejecting the disk will run the firmware +// +//	The bootloader will timeout and start the firmware after a few hundred milliseconds +//	if a usb connection is not detected. +//	 +//	The tweakier code is to keep the bootloader below 2k (no interrupt table, for example) + +extern "C" +void entrypoint(void) __attribute__ ((naked)) __attribute__ ((section (".vectors"))); +void entrypoint(void) +{ +	asm volatile ( +		"eor	r1,		r1\n"	// Zero register +		"out	0x3F,	r1\n"	// SREG +		"ldi	r28,	0xFF\n" +		"ldi	r29,	0x0A\n" +		"out	0x3E,	r29\n"	// SPH +		"out	0x3D,	r28\n"	// SPL +		"rjmp	main"			// Stack is all set up, start the main code +		::); +} + +u8 _flashbuf[128]; +u8 _inSync; +u8 _ok; +extern volatile u8 _ejected; +extern volatile u16 _timeout; + +void Program(u8 ep, u16 page, u8 count) +{ +	u8 write = page < 30*1024;		// Don't write over firmware please +	if (write) +		boot_page_erase(page); + +	Recv(ep,_flashbuf,count);		// Read while page is erasing + +	if (!write) +		return; + +	boot_spm_busy_wait();			// Wait until the memory is erased. + +	count >>= 1; +	u16* p = (u16*)page; +	u16* b = (u16*)_flashbuf; +	for (u8 i = 0; i < count; i++) +		boot_page_fill(p++, b[i]); + +    boot_page_write(page); +    boot_spm_busy_wait(); +    boot_rww_enable (); +} + + +int USBGetChar(); +#define getch USBGetChar + +#define HW_VER	 0x02 +#define SW_MAJOR 0x01 +#define SW_MINOR 0x10 + +#define STK_OK              0x10 +#define STK_INSYNC          0x14  // ' ' +#define CRC_EOP             0x20  // 'SPACE' +#define STK_GET_SYNC        0x30  // '0' + +#define STK_GET_PARAMETER   0x41  // 'A' +#define STK_SET_DEVICE      0x42  // 'B' +#define STK_SET_DEVICE_EXT  0x45  // 'E' +#define STK_LOAD_ADDRESS    0x55  // 'U' +#define STK_UNIVERSAL       0x56  // 'V' +#define STK_PROG_PAGE       0x64  // 'd' +#define STK_READ_PAGE       0x74  // 't' +#define STK_READ_SIGN       0x75  // 'u' + +extern const u8 _readSize[] PROGMEM; +const u8 _readSize[] =  +{ +	STK_GET_PARAMETER,	1, +	STK_SET_DEVICE,		20, +	STK_SET_DEVICE_EXT,	5, +	STK_UNIVERSAL,		4, +	STK_LOAD_ADDRESS,	2, +	STK_PROG_PAGE,		3, +	STK_READ_PAGE,		3, +	0,0 +}; + +extern const u8 _consts[] PROGMEM; +const u8 _consts[] =  +{ +	SIGNATURE_0, +	SIGNATURE_1, +	SIGNATURE_2, +	HW_VER,		// Hardware version +	SW_MAJOR,	// Software major version +	SW_MINOR,	// Software minor version +	0x03,		// Unknown but seems to be required by avr studio 3.56 +	0x00,		//  +}; + + +void USBInit(void); +int main(void) __attribute__ ((naked)); + +//	STK500v1 main loop, very similar to optiboot in protocol and implementation +int main() +{ +	wdt_disable(); +	TXLED0; +	RXLED0; +	LED0; +	BOARD_INIT(); +	USBInit(); + +	_inSync = STK_INSYNC; +	_ok = STK_OK; + +	if (pgm_read_word(0) != -1) +		_ejected = 1; + +	for(;;) +	{ +		u8* packet = _flashbuf; +		u16 address = 0; +		for (;;) +		{ +			u8 cmd = getch(); + +			//	Read packet contents +			u8 len; +			const u8* rs = _readSize; +			for(;;) +			{ +				u8 c = pgm_read_byte(rs++); +				len = pgm_read_byte(rs++); +				if (c == cmd || c == 0) +					break; +			} +			_timeout = 0; +			//	Read params +			Recv(CDC_RX,packet,len); + +			//	Send a response +			u8 send = 0; +			const u8* pgm = _consts+7;			// 0 +			if (STK_GET_PARAMETER == cmd) +			{ +				u8 i = packet[0] - 0x80; +				if (i > 2) +					i = (i == 0x18) ? 3 : 4;	// 0x80:HW_VER,0x81:SW_MAJOR,0x82:SW_MINOR,0x18:3 or 0 +				pgm = _consts + i + 3; +				send = 1; +			} + +			else if (STK_UNIVERSAL == cmd) +			{ +				if (packet[0] == 0x30) +					pgm = _consts + packet[2];	// read signature +				send = 1; +			} +			 +			//	Read signature bytes +			else if (STK_READ_SIGN == cmd) +			{ +				pgm = _consts; +				send = 3; +			} + +			else if (STK_LOAD_ADDRESS == cmd) +			{ +				address = *((u16*)packet);		// word addresses +				address += address; +			} + +			else if (STK_PROG_PAGE == cmd) +			{ +				Program(CDC_RX,address,packet[1]); +			} + +			else if (STK_READ_PAGE == cmd) +			{ +				send = packet[1]; +				pgm = (const u8*)address; +				address += send; // not sure of this is required +			} + +			// Check sync +			if (getch() != ' ') +				break; +			Transfer(CDC_TX,&_inSync,1); + +			// Send result +			if (send) +				Transfer(CDC_TX|TRANSFER_PGM,pgm,send);	// All from pgm memory + +			//	Send ok +			Transfer(CDC_TX|TRANSFER_RELEASE,&_ok,1); + +			if (cmd == 'Q') +				break; +		} +		_timeout = 500;		// wait a moment before exiting the bootloader - may need to finish responding to 'Q' for example +		_ejected = 1; +	} +} + +//	Nice breathing LED indicates we are in the firmware +u16 _pulse; +void LEDPulse() +{ +	_pulse++; +	u8 p = _pulse >> 8; +	if (p > 127) +		p = 255-p; +	p += p; +	if (((u8)_pulse) > p) +		LED0; +	else +		LED1; +} + +void Reboot() +{ +	TXLED0;		// switch off the RX and TX LEDs before starting the user sketch +	RXLED0; +	UDCON = 1;		// Detatch USB +	UDIEN = 0; +	asm volatile (	// Reset vector to run firmware +		"clr r30\n" +		"clr r31\n" +		"ijmp\n" +	::); +} diff --git a/bootloaders/diskloader/src/Platform.h b/bootloaders/diskloader/src/Platform.h new file mode 100644 index 0000000..2b00b71 --- /dev/null +++ b/bootloaders/diskloader/src/Platform.h @@ -0,0 +1,47 @@ + +#include <inttypes.h> +#include <avr/io.h> +#include <avr/pgmspace.h> +#include <avr/boot.h> +#include <util/delay.h> +#include <avr/interrupt.h> +#include <avr/wdt.h> + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +typedef unsigned char u8; +typedef unsigned short u16; +typedef unsigned long u32; + + +#define CPU_PRESCALE(n)	(CLKPR = 0x80, CLKPR = (n)) +#define DISABLE_JTAG()  MCUCR = (1 << JTD) | (1 << IVCE) | (0 << PUD); MCUCR = (1 << JTD) | (0 << IVSEL) | (0 << IVCE) | (0 << PUD); + +#define USB_VID 0x2341	// arduino LLC vid +#define USB_PID ARDUINO_MODEL_PID	// passed in by Makefile - 0x0034 for Leonardo, 0x0035 for MIcro + +#define OEM_NAME		'l','e','o','n','a','r','d','o'					// 8 chars +#define BOARD_INIT()	DDRC |= (1<<7); DDRB |= (1<<0); DDRE |= (1<<6); CPU_PRESCALE(0); DISABLE_JTAG(); +#define LED0			PORTC &= ~(1<<7) +#define LED1			PORTC |= (1<<7) +#define TXLED0			PORTE |= (1<<6) +#define TXLED1			PORTE &= ~(1<<6) +#define RXLED0			PORTB |= (1<<0) +#define RXLED1			PORTB &= ~(1<<0) + +#define TRANSFER_PGM		0x80 +#define TRANSFER_RELEASE	0x40 +#define TRANSFER_ZERO		0x20 + +void Transfer(u8 ep, const u8* data, int len); +void Recv(u8 ep, u8* dst, u8 len); +void Program(u8 ep, u16 page, u8 count); + +#define CDC_ENABLED + +#include "USBCore.h" +#include "USBDesc.h" + + diff --git a/bootloaders/diskloader/src/USBCore.cpp b/bootloaders/diskloader/src/USBCore.cpp new file mode 100644 index 0000000..1a8f2d0 --- /dev/null +++ b/bootloaders/diskloader/src/USBCore.cpp @@ -0,0 +1,504 @@ + + +/* Copyright (c) 2010, Peter Barrett   +**   +** Permission to use, copy, modify, and/or distribute this software for   +** any purpose with or without fee is hereby granted, provided that the   +** above copyright notice and this permission notice appear in all copies.   +**  +** THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   +** WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   +** WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR   +** BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES   +** OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,   +** WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,   +** ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS   +** SOFTWARE.   +*/ + +#include "Platform.h" + +#define CDC_TX CDC_ENDPOINT_IN +#define CDC_RX CDC_ENDPOINT_OUT + +#define EP_TYPE_CONTROL				0x00 +#define EP_TYPE_BULK_IN				0x81 +#define EP_TYPE_BULK_OUT			0x80 +#define EP_TYPE_INTERRUPT_IN		0xC1 +#define EP_TYPE_INTERRUPT_OUT		0xC0 +#define EP_TYPE_ISOCHRONOUS_IN		0x41 +#define EP_TYPE_ISOCHRONOUS_OUT		0x40 + +/** Pulse generation counters to keep track of the number of milliseconds remaining for each pulse type */ +#define TX_RX_LED_PULSE_MS 100 +u8 TxLEDPulse; /**< Milliseconds remaining for data Tx LED pulse */ +u8 RxLEDPulse; /**< Milliseconds remaining for data Rx LED pulse */ + +void Reboot(); + +//================================================================== +//================================================================== + +typedef struct +{ +	u32	dwDTERate; +	u8	bCharFormat; +	u8 	bParityType; +	u8 	bDataBits; +	u8	lineState; +} LineInfo; + +static volatile LineInfo _usbLineInfo = { 57600, 0x00, 0x00, 0x00, 0x00 }; + +//================================================================== +//================================================================== + +//	4 bytes of RAM +volatile u8 _usbConfiguration; +volatile u8 _ejected; +volatile u16 _timeout; + +static inline void WaitIN(void) +{ +	while (!(UEINTX & (1<<TXINI))); +} + +static inline void ClearIN(void) +{ +	UEINTX = ~(1<<TXINI); +} + +static inline void WaitOUT(void) +{ +	while (!(UEINTX & (1<<RXOUTI))) +		; +} + +static inline u8 WaitForINOrOUT() +{ +	while (!(UEINTX & ((1<<TXINI)|(1<<RXOUTI)))) +		; +	return (UEINTX & (1<<RXOUTI)) == 0; +} + +static inline void ClearOUT(void) +{ +	UEINTX = ~(1<<RXOUTI); +} + +static +void Send(volatile const u8* data, u8 count) +{ +	TXLED1;					// light the TX LED +	TxLEDPulse = TX_RX_LED_PULSE_MS; +	while (count--) +		UEDATX = *data++; +} + +void Recv(volatile u8* data, u8 count) +{ +	RXLED1;					// light the RX LED +	RxLEDPulse = TX_RX_LED_PULSE_MS; +	while (count--) +		*data++ = UEDATX; +} + +static inline u8 Recv8() +{ +	RXLED1;					// light the RX LED +	RxLEDPulse = TX_RX_LED_PULSE_MS; +	return UEDATX; +} + +static inline void Send8(u8 d) +{ +	TXLED1;					// light the TX LED +	TxLEDPulse = TX_RX_LED_PULSE_MS; +	UEDATX = d; +} + +static inline void SetEP(u8 ep) +{ +	UENUM = ep; +} + +static inline u8 FifoByteCount() +{ +	return UEBCLX; +} + +static inline u8 ReceivedSetupInt() +{ +	return UEINTX & (1<<RXSTPI); +} + +static inline void ClearSetupInt() +{ +	UEINTX = ~((1<<RXSTPI) | (1<<RXOUTI) | (1<<TXINI)); +} + +static inline void Stall() +{ +	UECONX = (1<<STALLRQ) | (1<<EPEN); +} + +static inline u8 ReadWriteAllowed() +{ +	return UEINTX & (1<<RWAL); +} + +static inline u8 Stalled() +{ +	return UEINTX & (1<<STALLEDI); +} + +static inline u8 FifoFree() +{ +	return UEINTX & (1<<FIFOCON); +} + +static inline void ReleaseRX() +{ +	UEINTX = 0x6B;	// FIFOCON=0 NAKINI=1 RWAL=1 NAKOUTI=0 RXSTPI=1 RXOUTI=0 STALLEDI=1 TXINI=1 +} + +static inline void ReleaseTX() +{ +	UEINTX = 0x3A;	// FIFOCON=0 NAKINI=0 RWAL=1 NAKOUTI=1 RXSTPI=1 RXOUTI=0 STALLEDI=1 TXINI=0 +} + +static inline u8 FrameNumber() +{ +	return UDFNUML; +} + +//================================================================== +//================================================================== + +#define EP_SINGLE_64 0x32	// EP0 +#define EP_DOUBLE_64 0x36	// Other endpoints + +static void InitEP(u8 index, u8 type, u8 size) +{ +	UENUM = index; +	UECONX = 1; +	UECFG0X = type; +	UECFG1X = size; +} + +//	API +void USBInit(void) +{ +	_timeout = 0; +	_usbConfiguration = 0; +	_ejected = 0; +	 +	UHWCON = 0x01;						// power internal reg (don't need this?) +	USBCON = (1<<USBE)|(1<<FRZCLK);		// clock frozen, usb enabled +	PLLCSR = 0x12;						// Need 16 MHz xtal +	while (!(PLLCSR & (1<<PLOCK)))		// wait for lock pll +		; +	USBCON = ((1<<USBE)|(1<<OTGPADE));	// start USB clock +	UDCON = 0;							// enable attach resistor +} + +u8 USBGetConfiguration(void) +{ +	return _usbConfiguration; +} + +u8 HasData(u8 ep) +{ +	SetEP(ep); +	return ReadWriteAllowed();	// count in fifo +} + +int USBGetChar(); +void Recv(u8 ep, u8* dst, u8 len) +{ +	SetEP(ep); +	while (len--) +	{ +		while (!ReadWriteAllowed()) +			; +		*dst++ = Recv8(); +		if (!ReadWriteAllowed())	// release empty buffer +			ReleaseRX(); +	} +} + +//	Transmit a packet to endpoint +void Transfer(u8 ep, const u8* data, int len) +{ +	u8 zero = ep & TRANSFER_ZERO; +	SetEP(ep & 7); +	while (len--) +	{ +		while (!ReadWriteAllowed()) +			;	// TODO Check for STALL etc + +		u8 d = (ep & TRANSFER_PGM) ? pgm_read_byte(data) : data[0]; +		data++; +		if (zero) +			d = 0; +		Send8(d); + +		if (!ReadWriteAllowed()) +			ReleaseTX(); +	} +	if (ep & TRANSFER_RELEASE) +		ReleaseTX(); +} + +extern const u8 _initEndpoints[] PROGMEM; +const u8 _initEndpoints[] =  +{ +	0, + +#ifdef CDC_ENABLED +	EP_TYPE_INTERRUPT_IN,		// CDC_ENDPOINT_ACM +	EP_TYPE_BULK_OUT,			// CDC_ENDPOINT_OUT +	EP_TYPE_BULK_IN,			// CDC_ENDPOINT_IN +#endif + +	EP_TYPE_INTERRUPT_IN,		// HID_ENDPOINT_INT +}; + +static void InitEndpoints() +{ +	for (u8 i = 1; i < sizeof(_initEndpoints); i++) +	{ +		UENUM = i; +		UECONX = 1; +		UECFG0X = pgm_read_byte(_initEndpoints+i); +		UECFG1X = EP_DOUBLE_64; +	} +	UERST = 0x7E;	// And reset them +	UERST = 0; +} + +typedef struct +{ +	u8 bmRequestType; +	u8 bRequest; +	u8 wValueL; +	u8 wValueH; +	u16 wIndex; +	u16 wLength; +} Setup; +Setup _setup; + +//bool USBHook(Setup& setup) +bool USBHook() +{ +	Setup& setup = _setup; +	u8 r = setup.bRequest; + +	//	CDC Requests +	if (CDC_GET_LINE_CODING == r) +	{ +		Send((const volatile u8*)&_usbLineInfo,7); +	} + +	else if (CDC_SET_LINE_CODING ==  r) +	{ +		WaitOUT(); +		Recv((volatile u8*)&_usbLineInfo,7); +		ClearOUT(); +	} + +	else if (CDC_SET_CONTROL_LINE_STATE == r) +	{ +		_usbLineInfo.lineState = setup.wValueL; +	} + +	return true; +} + +extern const u8 _rawHID[] PROGMEM; +#define LSB(_x) ((_x) & 0xFF) +#define MSB(_x) ((_x) >> 8) + +#define RAWHID_USAGE_PAGE	0xFFC0 +#define RAWHID_USAGE		0x0C00 +#define RAWHID_TX_SIZE 64 +#define RAWHID_RX_SIZE 64 + +const u8 _rawHID[] = +{ +	//	RAW HID +	0x06, LSB(RAWHID_USAGE_PAGE), MSB(RAWHID_USAGE_PAGE),	// 30 +	0x0A, LSB(RAWHID_USAGE), MSB(RAWHID_USAGE), + +	0xA1, 0x01,				// Collection 0x01 +    0x85, 0x03,             // REPORT_ID (3) +	0x75, 0x08,				// report size = 8 bits +	0x15, 0x00,				// logical minimum = 0 +	0x26, 0xFF, 0x00,		// logical maximum = 255 + +	0x95, 64,				// report count TX +	0x09, 0x01,				// usage +	0x81, 0x02,				// Input (array) + +	0x95, 64,				// report count RX +	0x09, 0x02,				// usage +	0x91, 0x02,				// Output (array) +	0xC0					// end collection +}; + +u8 _cdcComposite = 0; + +bool SendDescriptor() +{ +	Setup& setup = _setup; +	u8 desc_length = 0; +	const u8* desc_addr = 0; + +	u8 t = setup.wValueH; +	if (0x22 == t) +	{ +		desc_addr = _rawHID; +		desc_length = sizeof(desc_length); +	} else if (USB_DEVICE_DESCRIPTOR_TYPE == t) +	{ +		if (setup.wLength == 8) +			_cdcComposite = 1; +		desc_addr = _cdcComposite ?  (const u8*)&USB_DeviceDescriptorA : (const u8*)&USB_DeviceDescriptor; +	} +	else if (USB_CONFIGURATION_DESCRIPTOR_TYPE == t) +	{ +		desc_addr = (const u8*)&USB_ConfigDescriptor; +		desc_length = sizeof(USB_ConfigDescriptor); +	} +	else if (USB_STRING_DESCRIPTOR_TYPE == t) +	{ +		if (setup.wValueL == 0) +			desc_addr = (const u8*)&STRING_LANGUAGE; +		else +			return false; +	} else  +		return false; + +	if (desc_length == 0) +		desc_length = pgm_read_byte(desc_addr); +	if ((u8)setup.wLength < desc_length)		// bit of a cheat limiting to 255 bytes TODO (saved 8 bytes) +		desc_length = (u8)setup.wLength; + +	//	Send descriptor +	//	EP0 is 64 bytes long +	//	RWAL and FIFOCON don't work on EP0 +	u8 n = 0; +	do +	{ +		if (!WaitForINOrOUT()) +			return false; +		Send8(pgm_read_byte(&desc_addr[n++])); +		u8 clr = n & 0x3F; +		if (!clr) +			ClearIN();	// Fifo is full, release this packet +	} while (n < desc_length); +	return true; +} + +void USBSetupInterrupt() +{ +    SetEP(0); +	if (!ReceivedSetupInt()) +		return; + +	Setup& setup = _setup;	// global saves ~30 bytes +	Recv((u8*)&setup,8); +	ClearSetupInt(); + +	if (setup.bmRequestType & DEVICETOHOST) +		WaitIN(); +	else +		ClearIN(); + +    bool ok = true; +	u8 r = setup.bRequest; +	if (SET_ADDRESS == r) +	{ +		WaitIN(); +		UDADDR = setup.wValueL | (1<<ADDEN); +	} +	else if (SET_CONFIGURATION == r) +	{ +		_usbConfiguration = setup.wValueL; +		InitEndpoints(); +	} +	else if (GET_CONFIGURATION == r) +	{ +		Send8(_usbConfiguration); +	} +	else if (GET_STATUS == r) +	{ +		Send8(0);		// All good as far as I know +	} +	else if (GET_DESCRIPTOR == r) +	{ +		ok = SendDescriptor(); +	} +	else +	{ +		ok = USBHook(); +	} + +	if (ok) +		ClearIN(); +	else +		Stall(); +} + +void USBGeneralInterrupt() +{ +	u8 udint = UDINT; +	UDINT = 0; + +	//	End of Reset +	if (udint & (1<<EORSTI)) +	{ +		InitEP(0,EP_TYPE_CONTROL,EP_SINGLE_64);	// init ep0 +		_usbConfiguration = 0;			// not configured yet +	} + +	//	Start of Frame - happens every millisecond so we use it for TX and RX LED one-shot timing, too +	if (udint & (1<<SOFI)) +	{ +		// check whether the one-shot period has elapsed.  if so, turn off the LED +		if (TxLEDPulse && !(--TxLEDPulse)) +			TXLED0; +		if (RxLEDPulse && !(--RxLEDPulse)) +			RXLED0; +		 +		if (!_ejected) +			_timeout = 0; +	} +} + +void LEDPulse(); +int USBGetChar() +{ +	for(;;) +	{ +		USBSetupInterrupt(); +		USBGeneralInterrupt(); + +		//	Read a char +		if (HasData(CDC_RX)) +		{ +			u8 c = Recv8(); +			if (!ReadWriteAllowed()) +				ReleaseRX(); +			return c; +		}  + +		if (!--_timeout) { +			Reboot();	// USB not connected, run firmware +		} +		 +		_delay_us(100);	// stretch out the bootloader period to about 5 seconds after enumeration +		LEDPulse(); +	} +	return -1; +} diff --git a/bootloaders/diskloader/src/USBCore.h b/bootloaders/diskloader/src/USBCore.h new file mode 100644 index 0000000..537c0ec --- /dev/null +++ b/bootloaders/diskloader/src/USBCore.h @@ -0,0 +1,246 @@ + +// Copyright (c) 2010, Peter Barrett  +/* +** Permission to use, copy, modify, and/or distribute this software for   +** any purpose with or without fee is hereby granted, provided that the   +** above copyright notice and this permission notice appear in all copies.   +**   +** THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   +** WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   +** WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR   +** BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES   +** OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,   +** WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,   +** ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS   +** SOFTWARE.   +*/ + +#ifndef __USBCORE_H__ +#define __USBCORE_H__ + +#define GET_STATUS			0 +#define CLEAR_FEATURE		1 +#define SET_FEATURE			3 +#define SET_ADDRESS			5 +#define GET_DESCRIPTOR		6 +#define GET_CONFIGURATION	8 +#define SET_CONFIGURATION	9 +#define GET_INTERFACE		10 +#define SET_INTERFACE		11 + +// bmRequestType +#define HOSTTODEVICE	0x00 +#define DEVICETOHOST	0x80 +#define STANDARD		0x00 +#define CLASS			0x20 +#define VENDOR			0x40 +#define DEVICE			0x00 +#define INTERFACE		0x01 +#define ENDPOINT		0x02 +#define OTHER			0x03 + +#define CDC_SET_LINE_CODING		0x20 +#define CDC_GET_LINE_CODING		0x21 +#define CDC_SET_CONTROL_LINE_STATE	0x22 + +//	Descriptors + +#define USB_DEVICE_DESC_SIZE 18 +#define USB_CONFIGUARTION_DESC_SIZE 9 +#define USB_INTERFACE_DESC_SIZE 9 +#define USB_ENDPOINT_DESC_SIZE 7 + +#define USB_DEVICE_DESCRIPTOR_TYPE             1 +#define USB_CONFIGURATION_DESCRIPTOR_TYPE      2 +#define USB_STRING_DESCRIPTOR_TYPE             3 +#define USB_INTERFACE_DESCRIPTOR_TYPE          4 +#define USB_ENDPOINT_DESCRIPTOR_TYPE           5 + +#define USB_DEVICE_CLASS_COMMUNICATIONS        0x02 +#define USB_DEVICE_CLASS_HUMAN_INTERFACE       0x03 +#define USB_DEVICE_CLASS_STORAGE               0x08 +#define USB_DEVICE_CLASS_VENDOR_SPECIFIC       0xFF + +#define USB_CONFIG_POWERED_MASK                0x40 +#define USB_CONFIG_BUS_POWERED                 0x80 +#define USB_CONFIG_SELF_POWERED                0xC0 +#define USB_CONFIG_REMOTE_WAKEUP               0x20 + +// bMaxPower in Configuration Descriptor +#define USB_CONFIG_POWER_MA(mA)                ((mA)/2) + +// bEndpointAddress in Endpoint Descriptor +#define USB_ENDPOINT_DIRECTION_MASK            0x80 +#define USB_ENDPOINT_OUT(addr)                 ((addr) | 0x00) +#define USB_ENDPOINT_IN(addr)                  ((addr) | 0x80) + +#define USB_ENDPOINT_TYPE_MASK                 0x03 +#define USB_ENDPOINT_TYPE_CONTROL              0x00 +#define USB_ENDPOINT_TYPE_ISOCHRONOUS          0x01 +#define USB_ENDPOINT_TYPE_BULK                 0x02 +#define USB_ENDPOINT_TYPE_INTERRUPT            0x03 + +#define TOBYTES(x) ((x) & 0xFF),(((x) >> 8) & 0xFF) + +#define CDC_V1_10                               0x0110 +#define CDC_COMMUNICATION_INTERFACE_CLASS       0x02 + +#define CDC_CALL_MANAGEMENT                     0x01 +#define CDC_ABSTRACT_CONTROL_MODEL              0x02 +#define CDC_HEADER                              0x00 +#define CDC_ABSTRACT_CONTROL_MANAGEMENT         0x02 +#define CDC_UNION                               0x06 +#define CDC_CS_INTERFACE                        0x24 +#define CDC_CS_ENDPOINT                         0x25 +#define CDC_DATA_INTERFACE_CLASS                0x0A + + +//	Device +typedef struct { +	u8 len;				// 18 +	u8 dtype;			// 1 USB_DEVICE_DESCRIPTOR_TYPE +	u16 usbVersion;		// 0x200 +	u8	deviceClass; +	u8	deviceSubClass; +	u8	deviceProtocol; +	u8	packetSize0;	// Packet 0 +	u16	idVendor; +	u16	idProduct; +	u16	deviceVersion;	// 0x100 +	u8	iManufacturer; +	u8	iProduct; +	u8	iSerialNumber; +	u8	bNumConfigurations; +} DeviceDescriptor; + +//	Config +typedef struct { +	u8	len;			// 9 +	u8	dtype;			// 2 +	u16 clen;			// total length +	u8	numInterfaces; +	u8	config; +	u8	iconfig; +	u8	attributes; +	u8	maxPower; +} ConfigDescriptor; + +//	String + +//	Interface +typedef struct +{ +	u8 len;		// 9 +	u8 dtype;	// 4 +	u8 number; +	u8 alternate; +	u8 numEndpoints; +	u8 interfaceClass; +	u8 interfaceSubClass; +	u8 protocol; +	u8 iInterface; +} InterfaceDescriptor; + +//	Endpoint +typedef struct +{ +	u8 len;		// 7 +	u8 dtype;	// 5 +	u8 addr; +	u8 attr; +	u16 packetSize; +	u8 interval; +} EndpointDescriptor; + +// Interface Association Descriptor +// Used to bind 2 interfaces together in CDC compostite device +typedef struct +{ +	u8 len;				// 8 +	u8 dtype;			// 11 +	u8 firstInterface; +	u8 interfaceCount; +	u8 functionClass; +	u8 funtionSubClass; +	u8 functionProtocol; +	u8 iInterface; +} IADDescriptor; + +//	CDC CS interface descriptor +typedef struct +{ +	u8 len;		// 5 +	u8 dtype;	// 0x24 +	u8 subtype; +	u8 d0; +	u8 d1; +} CDCCSInterfaceDescriptor; + +typedef struct +{ +	u8 len;		// 4 +	u8 dtype;	// 0x24 +	u8 subtype; +	u8 d0; +} CDCCSInterfaceDescriptor4; + +typedef struct  +{ +	IADDescriptor				iad;	// Only needed on compound device + +	//	Control +	InterfaceDescriptor			cif;	//  +	CDCCSInterfaceDescriptor	header; +	CDCCSInterfaceDescriptor	callManagement; +	CDCCSInterfaceDescriptor4	controlManagement; +	CDCCSInterfaceDescriptor	functionalDescriptor; +	EndpointDescriptor			cifin; + +	//	Data +	InterfaceDescriptor			dif; +	EndpointDescriptor			in; +	EndpointDescriptor			out; +} CDCDescriptor; + +typedef struct +{ +	u8 len;			// 9 +	u8 dtype;		// 0x21 +	u8 addr; +	u8	versionL;	// 0x101 +	u8	versionH;	// 0x101 +	u8	country; +	u8	desctype;	// 0x22 report +	u8	descLenL; +	u8	descLenH; +} HIDDescDescriptor; + +typedef struct  +{ +	InterfaceDescriptor			hid; +	HIDDescDescriptor			desc; +	EndpointDescriptor			in; +} HIDDescriptor; + +#define D_DEVICE(_class,_subClass,_proto,_packetSize0,_vid,_pid,_version,_im,_ip,_is,_configs) \ +	{ 18, 1, 0x200, _class,_subClass,_proto,_packetSize0,_vid,_pid,_version,_im,_ip,_is,_configs } + +#define D_CONFIG(_totalLength,_interfaces) \ +	{ 9, 2, _totalLength,_interfaces, 1, 0, USB_CONFIG_BUS_POWERED, USB_CONFIG_POWER_MA(100) } + +#define D_INTERFACE(_n,_numEndpoints,_class,_subClass,_protocol) \ +	{ 9, 4, _n, 0, _numEndpoints, _class,_subClass, _protocol, 0 } + +#define D_ENDPOINT(_addr,_attr,_packetSize, _interval) \ +	{ 7, 5, _addr,_attr,_packetSize, _interval } + +#define D_IAD(_firstInterface, _count, _class, _subClass, _protocol) \ +	{ 8, 11, _firstInterface, _count, _class, _subClass, _protocol, 0 } + +#define D_HIDREPORT(_descriptorLength) \ +	{ 9, 0x21, 0x1, 0x1, 0, 1, 0x22, _descriptorLength, 0 } + +#define D_CDCCS(_subtype,_d0,_d1)	{ 5, 0x24, _subtype, _d0, _d1 } +#define D_CDCCS4(_subtype,_d0)		{ 4, 0x24, _subtype, _d0 } + +#endif
\ No newline at end of file diff --git a/bootloaders/diskloader/src/USBDesc.cpp b/bootloaders/diskloader/src/USBDesc.cpp new file mode 100644 index 0000000..ec7cf7d --- /dev/null +++ b/bootloaders/diskloader/src/USBDesc.cpp @@ -0,0 +1,67 @@ + + +/* Copyright (c) 2011, Peter Barrett   +**   +** Permission to use, copy, modify, and/or distribute this software for   +** any purpose with or without fee is hereby granted, provided that the   +** above copyright notice and this permission notice appear in all copies.   +**  +** THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   +** WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   +** WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR   +** BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES   +** OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,   +** WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,   +** ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS   +** SOFTWARE.   +*/ + +#include "Platform.h" + +//==================================================================================================== +//==================================================================================================== +//	Actual device descriptors + +const u16 STRING_LANGUAGE[2] = { +	(3<<8) | (2+2), +	0x0409	// English +}; + + +//#ifdef CDC_ENABLED +DeviceDescriptor USB_DeviceDescriptorA = D_DEVICE(0X02,0X00,0X00,64,USB_VID,USB_PID,0x100,0,IPRODUCT,ISERIAL,1); +//#else +DeviceDescriptor USB_DeviceDescriptor = D_DEVICE(0x00,0x00,0x00,64,USB_VID,USB_PID,0x100,0,IPRODUCT,ISERIAL,1); +//#endif + +Config USB_ConfigDescriptor = +{ +	D_CONFIG(sizeof(Config),INTERFACE_COUNT), + +#ifdef CDC_ENABLED +	//	CDC +	{ +		D_IAD(0,2,CDC_COMMUNICATION_INTERFACE_CLASS,CDC_ABSTRACT_CONTROL_MODEL,1), + +		//	CDC communication interface +		D_INTERFACE(CDC_ACM_INTERFACE,1,CDC_COMMUNICATION_INTERFACE_CLASS,CDC_ABSTRACT_CONTROL_MODEL,0), +		D_CDCCS(CDC_HEADER,0x10,0x01),								// Header (1.10 bcd) +		D_CDCCS(CDC_CALL_MANAGEMENT,1,1),							// Device handles call management +		D_CDCCS4(CDC_ABSTRACT_CONTROL_MANAGEMENT,2),				// SET_LINE_CODING, GET_LINE_CODING, SET_CONTROL_LINE_STATE supported +		D_CDCCS(CDC_UNION,CDC_ACM_INTERFACE,CDC_DATA_INTERFACE),	// Communication interface is master, data interface is slave 0 +		D_ENDPOINT(USB_ENDPOINT_IN (CDC_ENDPOINT_ACM),USB_ENDPOINT_TYPE_INTERRUPT,0x10,0x40), + +		//	CDC data interface +		D_INTERFACE(CDC_DATA_INTERFACE,2,CDC_DATA_INTERFACE_CLASS,0,0), +		D_ENDPOINT(USB_ENDPOINT_OUT(CDC_ENDPOINT_OUT),USB_ENDPOINT_TYPE_BULK,0x40,0), +		D_ENDPOINT(USB_ENDPOINT_IN (CDC_ENDPOINT_IN ),USB_ENDPOINT_TYPE_BULK,0x40,0) +	}, +#endif +	// HID +	{ +		D_INTERFACE(HID_INTERFACE,1,3,0,0), +		D_HIDREPORT(30), +		D_ENDPOINT(USB_ENDPOINT_IN (HID_ENDPOINT_INT),USB_ENDPOINT_TYPE_INTERRUPT,0x40,0x40) +	} +}; + diff --git a/bootloaders/diskloader/src/USBDesc.h b/bootloaders/diskloader/src/USBDesc.h new file mode 100644 index 0000000..589dfa9 --- /dev/null +++ b/bootloaders/diskloader/src/USBDesc.h @@ -0,0 +1,63 @@ + + +/* Copyright (c) 2011, Peter Barrett   +**   +** Permission to use, copy, modify, and/or distribute this software for   +** any purpose with or without fee is hereby granted, provided that the   +** above copyright notice and this permission notice appear in all copies.   +**  +** THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   +** WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   +** WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR   +** BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES   +** OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,   +** WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,   +** ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS   +** SOFTWARE.   +*/ + + +#ifdef CDC_ENABLED + +#define CDC_ACM_INTERFACE	0	// CDC ACM +#define CDC_DATA_INTERFACE	1	// CDC Data +#define CDC_ENDPOINT_ACM	1 +#define CDC_ENDPOINT_OUT	2 +#define CDC_ENDPOINT_IN		3 + +#define HID_INTERFACE		2	// HID Interface +#define HID_ENDPOINT_INT	4 + +#define INTERFACE_COUNT		3	// 2 for cdc + 1 for hid + +#else  + +#define HID_INTERFACE		2	// HID Interface +#define HID_ENDPOINT_INT	4 + +#define INTERFACE_COUNT		1	// 1 for hid + +#endif + +typedef struct +{ +	ConfigDescriptor	config; +#ifdef CDC_ENABLED +	CDCDescriptor		cdc; +#endif +	HIDDescriptor		hid; +} Config; + +extern Config USB_ConfigDescriptor PROGMEM; +extern DeviceDescriptor USB_DeviceDescriptor PROGMEM; +extern DeviceDescriptor USB_DeviceDescriptorA PROGMEM; + +extern const u16 STRING_LANGUAGE[2] PROGMEM; +extern const u16 STRING_SERIAL[13] PROGMEM; + +#define IMANUFACTURER	0 +#define IPRODUCT		0 +#define ISERIAL			1	// Only need this for MSC + +#define CDC_TX CDC_ENDPOINT_IN +#define CDC_RX CDC_ENDPOINT_OUT
\ No newline at end of file | 
