aboutsummaryrefslogtreecommitdiff
path: root/bootloaders/caterina/src
diff options
context:
space:
mode:
Diffstat (limited to 'bootloaders/caterina/src')
-rw-r--r--bootloaders/caterina/src/Caterina.cpp251
-rw-r--r--bootloaders/caterina/src/Platform.h49
-rw-r--r--bootloaders/caterina/src/USBCore.cpp510
-rw-r--r--bootloaders/caterina/src/USBCore.h246
-rw-r--r--bootloaders/caterina/src/USBDesc.cpp83
-rw-r--r--bootloaders/caterina/src/USBDesc.h60
6 files changed, 1199 insertions, 0 deletions
diff --git a/bootloaders/caterina/src/Caterina.cpp b/bootloaders/caterina/src/Caterina.cpp
new file mode 100644
index 0000000..7ef6fa8
--- /dev/null
+++ b/bootloaders/caterina/src/Caterina.cpp
@@ -0,0 +1,251 @@
+
+
+#include "Platform.h"
+
+// This bootloader creates a composite Serial device
+//
+// The serial interface supports a STK500v1 protocol that is very similar to optiboot
+//
+// 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
+ ::);
+}
+
+uint8_t _flashbuf[128];
+uint8_t _inSync;
+uint8_t _ok;
+extern volatile uint8_t _ejected;
+extern volatile uint16_t _timeout;
+
+void Program(uint8_t ep, uint16_t page, uint8_t count)
+{
+ uint8_t 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;
+ uint16_t* p = (uint16_t*)page;
+ uint16_t* b = (uint16_t*)_flashbuf;
+ for (uint8_t i = 0; i < count; i++)
+ boot_page_fill(p++, b[i]);
+
+ boot_page_write(page);
+ boot_spm_busy_wait();
+ boot_rww_enable ();
+}
+
+void StartSketch();
+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 uint8_t _readSize[] PROGMEM;
+const uint8_t _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 uint8_t _consts[] PROGMEM;
+const uint8_t _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()
+{
+ uint8_t MCUSR_state = MCUSR; // store the reason for the reset
+ MCUSR &= ~(1 << WDRF); // must clear the watchdog reset flag before disabling and reenabling WDT
+ wdt_disable();
+ TX_LED_OFF();
+ RX_LED_OFF();
+ L_LED_OFF();
+ if (MCUSR_state & (1<<WDRF) && (pgm_read_word(0) != 0xFFFF)) {
+ StartSketch(); // if the reset was caused by WDT and if a sketch is already present then run the sketch instead of the bootloader
+ }
+ BOARD_INIT();
+ USBInit();
+
+ _inSync = STK_INSYNC;
+ _ok = STK_OK;
+
+ if (pgm_read_word(0) != 0xFFFF)
+ _ejected = 1;
+
+ for(;;)
+ {
+ uint8_t* packet = _flashbuf;
+ uint16_t address = 0;
+ for (;;)
+ {
+ uint8_t cmd = getch();
+
+ // Read packet contents
+ uint8_t len;
+ const uint8_t* rs = _readSize;
+ for(;;)
+ {
+ uint8_t 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
+ uint8_t send = 0;
+ const uint8_t* pgm = _consts+7; // 0
+ if (STK_GET_PARAMETER == cmd)
+ {
+ uint8_t 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 = *((uint16_t*)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 uint8_t*)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
+uint16_t _pulse;
+void LEDPulse()
+{
+ _pulse += 4;
+ uint8_t p = _pulse >> 9;
+ if (p > 63)
+ p = 127-p;
+ p += p;
+ if (((uint8_t)_pulse) > p)
+ L_LED_OFF();
+ else
+ L_LED_ON();
+}
+
+void StartSketch()
+{
+ TX_LED_OFF(); // switch off the RX and TX LEDs before starting the user sketch
+ RX_LED_OFF();
+ UDCON = 1; // Detach USB
+ UDIEN = 0;
+ asm volatile ( // Reset vector to run firmware
+ "clr r30\n"
+ "clr r31\n"
+ "ijmp\n"
+ ::);
+}
+
+void Reset()
+{
+ wdt_enable(WDTO_15MS); // reset the microcontroller to reinitialize all IO and other registers
+ for (;;)
+ ;
+}
diff --git a/bootloaders/caterina/src/Platform.h b/bootloaders/caterina/src/Platform.h
new file mode 100644
index 0000000..9d18e80
--- /dev/null
+++ b/bootloaders/caterina/src/Platform.h
@@ -0,0 +1,49 @@
+
+#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>
+
+#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_PID_LEONARDO_BOOTLOADER 0x0030
+#define USB_PID_MICRO_BOOTLOADER 0x0031
+#define USB_VID 0x2341 // arduino LLC vid
+#define USB_PID ARDUINO_MODEL_PID // passed in by Makefile - 0x0034 for Leonardo, 0x0035 for MIcro
+
+#define USB_SERIAL_STRING '0','0','0','0','0','0','0','0','1','7','0','1'
+
+#define OEM_NAME 'l','e','o','n','a','r','d','o' // 8 chars
+#define BOARD_INIT() DDRC |= (1<<7); DDRB |= (1<<0); DDRD |= (1<<5); CPU_PRESCALE(0); DISABLE_JTAG();
+#define L_LED_OFF() PORTC &= ~(1<<7)
+#define L_LED_ON() PORTC |= (1<<7)
+#define TX_LED_OFF() PORTD |= (1<<5)
+#define TX_LED_ON() PORTD &= ~(1<<5)
+#define RX_LED_OFF() PORTB |= (1<<0)
+#define RX_LED_ON() PORTB &= ~(1<<0)
+
+#define TRANSFER_PGM 0x80
+#define TRANSFER_RELEASE 0x40
+#define TRANSFER_ZERO 0x20
+
+void Transfer(uint8_t ep, const uint8_t* data, int len);
+void Recv(uint8_t ep, uint8_t* dst, uint8_t len);
+void Program(uint8_t ep, uint16_t page, uint8_t count);
+
+/* HID is not fully-supported in the bootloader - can be enabled
+ for testing, but note the descriptor report and other parts are
+ not complete */
+//#define HID_ENABLED
+
+#include "USBCore.h"
+#include "USBDesc.h"
+
+
diff --git a/bootloaders/caterina/src/USBCore.cpp b/bootloaders/caterina/src/USBCore.cpp
new file mode 100644
index 0000000..ac5d081
--- /dev/null
+++ b/bootloaders/caterina/src/USBCore.cpp
@@ -0,0 +1,510 @@
+
+
+/* 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
+uint8_t TxLEDPulse; /**< Milliseconds remaining for data Tx LED pulse */
+uint8_t RxLEDPulse; /**< Milliseconds remaining for data Rx LED pulse */
+
+void Reset();
+
+//==================================================================
+//==================================================================
+
+typedef struct
+{
+ uint32_t dwDTERate;
+ uint8_t bCharFormat;
+ uint8_t bParityType;
+ uint8_t bDataBits;
+ uint8_t lineState;
+} LineInfo;
+
+static volatile LineInfo _usbLineInfo = { 57600, 0x00, 0x00, 0x00, 0x00 };
+
+//==================================================================
+//==================================================================
+
+// 4 bytes of RAM
+volatile uint8_t _usbConfiguration;
+volatile uint8_t _ejected;
+volatile uint16_t _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 uint8_t 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 uint8_t* data, uint8_t count)
+{
+ TX_LED_ON(); // light the TX LED
+ TxLEDPulse = TX_RX_LED_PULSE_MS;
+ while (count--)
+ UEDATX = *data++;
+}
+
+void Recv(volatile uint8_t* data, uint8_t count)
+{
+ RX_LED_ON(); // light the RX LED
+ RxLEDPulse = TX_RX_LED_PULSE_MS;
+ while (count--)
+ *data++ = UEDATX;
+}
+
+static inline uint8_t Recv8()
+{
+ RX_LED_ON(); // light the RX LED
+ RxLEDPulse = TX_RX_LED_PULSE_MS;
+ return UEDATX;
+}
+
+static inline void Send8(uint8_t d)
+{
+ TX_LED_ON(); // light the TX LED
+ TxLEDPulse = TX_RX_LED_PULSE_MS;
+ UEDATX = d;
+}
+
+static inline void SetEP(uint8_t ep)
+{
+ UENUM = ep;
+}
+
+static inline uint8_t FifoByteCount()
+{
+ return UEBCLX;
+}
+
+static inline uint8_t 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 uint8_t ReadWriteAllowed()
+{
+ return UEINTX & (1<<RWAL);
+}
+
+static inline uint8_t Stalled()
+{
+ return UEINTX & (1<<STALLEDI);
+}
+
+static inline uint8_t 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 uint8_t FrameNumber()
+{
+ return UDFNUML;
+}
+
+//==================================================================
+//==================================================================
+
+#define EP_SINGLE_64 0x32 // EP0
+#define EP_DOUBLE_64 0x36 // Other endpoints
+
+static void InitEP(uint8_t index, uint8_t type, uint8_t 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
+}
+
+uint8_t USBGetConfiguration(void)
+{
+ return _usbConfiguration;
+}
+
+uint8_t HasData(uint8_t ep)
+{
+ SetEP(ep);
+ return ReadWriteAllowed(); // count in fifo
+}
+
+int USBGetChar();
+void Recv(uint8_t ep, uint8_t* dst, uint8_t len)
+{
+ SetEP(ep);
+ while (len--)
+ {
+ while (!ReadWriteAllowed())
+ ;
+ *dst++ = Recv8();
+ if (!ReadWriteAllowed()) // release empty buffer
+ ReleaseRX();
+ }
+}
+
+// Transmit a packet to endpoint
+void Transfer(uint8_t ep, const uint8_t* data, int len)
+{
+ uint8_t zero = ep & TRANSFER_ZERO;
+ SetEP(ep & 7);
+ while (len--)
+ {
+ while (!ReadWriteAllowed())
+ ; // TODO Check for STALL etc
+
+ uint8_t 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 uint8_t _initEndpoints[] PROGMEM;
+const uint8_t _initEndpoints[] =
+{
+ 0,
+
+ EP_TYPE_INTERRUPT_IN, // CDC_ENDPOINT_ACM
+ EP_TYPE_BULK_OUT, // CDC_ENDPOINT_OUT
+ EP_TYPE_BULK_IN, // CDC_ENDPOINT_IN
+
+#ifdef HID_ENABLED
+ EP_TYPE_INTERRUPT_IN, // HID_ENDPOINT_INT
+#endif
+};
+
+static void InitEndpoints()
+{
+ for (uint8_t 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
+{
+ uint8_t bmRequestType;
+ uint8_t bRequest;
+ uint8_t wValueL;
+ uint8_t wValueH;
+ uint16_t wIndex;
+ uint16_t wLength;
+} Setup;
+Setup _setup;
+
+//bool USBHook(Setup& setup)
+bool USBHook()
+{
+ Setup& setup = _setup;
+ uint8_t r = setup.bRequest;
+
+ // CDC Requests
+ if (CDC_GET_LINE_CODING == r)
+ {
+ Send((const volatile uint8_t*)&_usbLineInfo,7);
+ }
+
+ else if (CDC_SET_LINE_CODING == r)
+ {
+ WaitOUT();
+ Recv((volatile uint8_t*)&_usbLineInfo,7);
+ ClearOUT();
+ }
+
+ else if (CDC_SET_CONTROL_LINE_STATE == r)
+ {
+ _usbLineInfo.lineState = setup.wValueL;
+ }
+
+ return true;
+}
+
+extern const uint8_t _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 uint8_t _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
+};
+
+uint8_t _cdcComposite = 0;
+
+bool SendDescriptor()
+{
+ Setup& setup = _setup;
+ uint16_t desc_length = 0;
+ const uint8_t* desc_addr = 0;
+
+ uint8_t t = setup.wValueH;
+ if (0x22 == t)
+ {
+#ifdef HID_ENABLED
+ desc_addr = _rawHID;
+ desc_length = sizeof(desc_length);
+#endif
+ } else if (USB_DEVICE_DESCRIPTOR_TYPE == t)
+ {
+ desc_addr = (const uint8_t*)&USB_DeviceDescriptor;
+ }
+ else if (USB_CONFIGURATION_DESCRIPTOR_TYPE == t)
+ {
+ desc_addr = (const uint8_t*)&USB_ConfigDescriptor;
+ desc_length = sizeof(USB_ConfigDescriptor);
+ }
+ else if (USB_STRING_DESCRIPTOR_TYPE == t)
+ {
+ if (setup.wValueL == 0)
+ desc_addr = (const uint8_t*)&STRING_LANGUAGE;
+ else if (setup.wValueL == IPRODUCT)
+ desc_addr = (const uint8_t*)&STRING_IPRODUCT;
+ else if (setup.wValueL == ISERIAL)
+ desc_addr = (const uint8_t*)&STRING_SERIAL;
+ else if (setup.wValueL == IMANUFACTURER)
+ desc_addr = (const uint8_t*)&STRING_IMANUFACTURER;
+ else
+ return false;
+ } else
+ return false;
+
+ if (desc_length == 0)
+ desc_length = pgm_read_byte(desc_addr);
+ if (setup.wLength < desc_length)
+ desc_length = setup.wLength;
+
+ // Send descriptor
+ // EP0 is 64 bytes long
+ // RWAL and FIFOCON don't work on EP0
+ uint16_t n = 0;
+ do
+ {
+ if (!WaitForINOrOUT())
+ return false;
+ Send8(pgm_read_byte(&desc_addr[n++]));
+ uint8_t 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((uint8_t*)&setup,8);
+ ClearSetupInt();
+
+ if (setup.bmRequestType & DEVICETOHOST)
+ WaitIN();
+ else
+ ClearIN();
+
+ bool ok = true;
+ uint8_t 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()
+{
+ uint8_t 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))
+ TX_LED_OFF();
+ if (RxLEDPulse && !(--RxLEDPulse))
+ RX_LED_OFF();
+
+ if (!_ejected)
+ _timeout = 0;
+ }
+}
+
+void LEDPulse();
+int USBGetChar()
+{
+ for(;;)
+ {
+ USBSetupInterrupt();
+ USBGeneralInterrupt();
+
+ // Read a char
+ if (HasData(CDC_RX))
+ {
+ uint8_t c = Recv8();
+ if (!ReadWriteAllowed())
+ ReleaseRX();
+ return c;
+ }
+
+ if (!--_timeout) {
+ Reset();
+ }
+
+ _delay_us(100); // stretch out the bootloader period to about 5 seconds after enumeration
+ LEDPulse();
+ }
+ return -1;
+}
diff --git a/bootloaders/caterina/src/USBCore.h b/bootloaders/caterina/src/USBCore.h
new file mode 100644
index 0000000..313ae3b
--- /dev/null
+++ b/bootloaders/caterina/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 {
+ uint8_t len; // 18
+ uint8_t dtype; // 1 USB_DEVICE_DESCRIPTOR_TYPE
+ uint16_t usbVersion; // 0x200
+ uint8_t deviceClass;
+ uint8_t deviceSubClass;
+ uint8_t deviceProtocol;
+ uint8_t packetSize0; // Packet 0
+ uint16_t idVendor;
+ uint16_t idProduct;
+ uint16_t deviceVersion; // 0x100
+ uint8_t iManufacturer;
+ uint8_t iProduct;
+ uint8_t iSerialNumber;
+ uint8_t bNumConfigurations;
+} DeviceDescriptor;
+
+// Config
+typedef struct {
+ uint8_t len; // 9
+ uint8_t dtype; // 2
+ uint16_t clen; // total length
+ uint8_t numInterfaces;
+ uint8_t config;
+ uint8_t iconfig;
+ uint8_t attributes;
+ uint8_t maxPower;
+} ConfigDescriptor;
+
+// String
+
+// Interface
+typedef struct
+{
+ uint8_t len; // 9
+ uint8_t dtype; // 4
+ uint8_t number;
+ uint8_t alternate;
+ uint8_t numEndpoints;
+ uint8_t interfaceClass;
+ uint8_t interfaceSubClass;
+ uint8_t protocol;
+ uint8_t iInterface;
+} InterfaceDescriptor;
+
+// Endpoint
+typedef struct
+{
+ uint8_t len; // 7
+ uint8_t dtype; // 5
+ uint8_t addr;
+ uint8_t attr;
+ uint16_t packetSize;
+ uint8_t interval;
+} EndpointDescriptor;
+
+// Interface Association Descriptor
+// Used to bind 2 interfaces together in CDC compostite device
+typedef struct
+{
+ uint8_t len; // 8
+ uint8_t dtype; // 11
+ uint8_t firstInterface;
+ uint8_t interfaceCount;
+ uint8_t functionClass;
+ uint8_t funtionSubClass;
+ uint8_t functionProtocol;
+ uint8_t iInterface;
+} IADDescriptor;
+
+// CDC CS interface descriptor
+typedef struct
+{
+ uint8_t len; // 5
+ uint8_t dtype; // 0x24
+ uint8_t subtype;
+ uint8_t d0;
+ uint8_t d1;
+} CDCCSInterfaceDescriptor;
+
+typedef struct
+{
+ uint8_t len; // 4
+ uint8_t dtype; // 0x24
+ uint8_t subtype;
+ uint8_t 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
+{
+ uint8_t len; // 9
+ uint8_t dtype; // 0x21
+ uint8_t addr;
+ uint8_t versionL; // 0x101
+ uint8_t versionH; // 0x101
+ uint8_t country;
+ uint8_t desctype; // 0x22 report
+ uint8_t descLenL;
+ uint8_t 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/caterina/src/USBDesc.cpp b/bootloaders/caterina/src/USBDesc.cpp
new file mode 100644
index 0000000..a634d4d
--- /dev/null
+++ b/bootloaders/caterina/src/USBDesc.cpp
@@ -0,0 +1,83 @@
+
+
+/* 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 uint16_t STRING_LANGUAGE[2] = {
+ (3<<8) | (2+2),
+ 0x0409 // English
+};
+
+const uint16_t STRING_SERIAL[13] = {
+ (3<<8) | (2+2*12),
+ USB_SERIAL_STRING
+};
+
+const uint16_t STRING_IPRODUCT[28] = {
+ (3<<8) | (2+2*27),
+#if USB_PID == USB_PID_LEONARDO_BOOTLOADER
+ 'A','r','d','u','i','n','o',' ','L','e','o','n','a','r','d','o',' ','b','o','o','t','l','o','a','d','e','r'
+#elif USB_PID == USB_PID_MICRO_BOOTLOADER
+ 'A','r','d','u','i','n','o',' ','M','i','c','r','o',' ','b','o','o','t','l','o','a','d','e','r',' ',' ',' '
+#endif
+};
+
+const uint16_t STRING_IMANUFACTURER[12] = {
+ (3<<8) | (2+2*11),
+ 'A','r','d','u','i','n','o',' ','L','L','C'
+};
+
+
+DeviceDescriptor USB_DeviceDescriptor = D_DEVICE(0X02,0X00,0X00,64,USB_VID,USB_PID,0x100,0,IPRODUCT,ISERIAL,1);
+
+Config USB_ConfigDescriptor =
+{
+ D_CONFIG(sizeof(Config),INTERFACE_COUNT),
+
+ // 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)
+ },
+
+#ifdef HID_ENABLED
+ // 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)
+ }
+#endif
+};
+
diff --git a/bootloaders/caterina/src/USBDesc.h b/bootloaders/caterina/src/USBDesc.h
new file mode 100644
index 0000000..fa962e9
--- /dev/null
+++ b/bootloaders/caterina/src/USBDesc.h
@@ -0,0 +1,60 @@
+
+
+/* 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.
+*/
+
+#ifndef HID_ENABLED // HID is NOT 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 INTERFACE_COUNT 2 // 2 for CDC
+#else // HID is 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
+#endif
+
+typedef struct
+{
+ ConfigDescriptor config;
+ CDCDescriptor cdc;
+#ifdef HID_ENABLED
+ HIDDescriptor hid;
+#endif
+} Config;
+
+extern Config USB_ConfigDescriptor PROGMEM;
+extern DeviceDescriptor USB_DeviceDescriptor PROGMEM;
+extern DeviceDescriptor USB_DeviceDescriptorA PROGMEM;
+
+extern const uint16_t STRING_LANGUAGE[2] PROGMEM;
+extern const uint16_t STRING_IPRODUCT[28] PROGMEM;
+extern const uint16_t STRING_IMANUFACTURER[12] PROGMEM;
+extern const uint16_t STRING_SERIAL[13] PROGMEM;
+
+#define IMANUFACTURER 1
+#define IPRODUCT 2
+#define ISERIAL 3
+
+#define CDC_TX CDC_ENDPOINT_IN
+#define CDC_RX CDC_ENDPOINT_OUT \ No newline at end of file
generated by cgit v1.2.3-18-g5258 (git 2.32.0) at 2024-11-22 06:44:04 +0000