/* Copyright (c) 2010, Peter Barrett ** ** Sleep/Wakeup/SystemControl support added by Michael Dreher ** ** 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 "USBAPI.h" #if defined(USBCON) #define EP_TYPE_CONTROL (0x00) #define EP_TYPE_BULK_IN ((1< len) n = len; { LockEP lock(ep); // Frame may have been released by the SOF interrupt handler if (!ReadWriteAllowed()) continue; len -= n; if (ep & TRANSFER_ZERO) { while (n--) Send8(0); } else if (ep & TRANSFER_PGM) { while (n--) Send8(pgm_read_byte(data++)); } else { while (n--) Send8(*data++); } if (!ReadWriteAllowed() || ((len == 0) && (ep & TRANSFER_RELEASE))) // Release full buffer ReleaseTX(); } } TXLED1; // light the TX LED TxLEDPulse = TX_RX_LED_PULSE_MS; return r; } 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 #ifdef HID_ENABLED EP_TYPE_INTERRUPT_IN // HID_ENDPOINT_INT #endif }; #define EP_SINGLE_64 0x32 // EP0 #define EP_DOUBLE_64 0x36 // Other endpoints // edit by NicoHood #define EP_SINGLE_16 0x12 static void InitEP(u8 index, u8 type, u8 size) { UENUM = index; UECONX = (1 << EPEN); UECFG0X = type; UECFG1X = size; } static void InitEndpoints() { for (u8 i = 1; i < sizeof(_initEndpoints); i++) { UENUM = i; UECONX = (1 << EPEN); UECFG0X = pgm_read_byte(_initEndpoints + i); // edit by NicoHood #if USB_EP_SIZE == 16 UECFG1X = EP_SINGLE_16; #elif USB_EP_SIZE == 64 UECFG1X = EP_DOUBLE_64; #else #error Unsupported value for USB_EP_SIZE #endif } UERST = 0x7E; // And reset them UERST = 0; } // Handle CLASS_INTERFACE requests static bool ClassInterfaceRequest(Setup& setup) { u8 i = setup.wIndex; #ifdef CDC_ENABLED if (CDC_ACM_INTERFACE == i) return CDC_Setup(setup); #endif #ifdef HID_ENABLED if (HID_INTERFACE == i) return HID_Setup(setup); #endif return false; } int _cmark; int _cend; void InitControl(int end) { SetEP(0); _cmark = 0; _cend = end; } static bool SendControl(u8 d) { if (_cmark < _cend) { if (!WaitForINOrOUT()) return false; Send8(d); if (!((_cmark + 1) & 0x3F)) ClearIN(); // Fifo is full, release this packet } _cmark++; return true; }; // Clipped by _cmark/_cend int USB_SendControl(u8 flags, const void* d, int len) { int sent = len; const u8* data = (const u8*)d; bool pgm = flags & TRANSFER_PGM; while (len--) { u8 c = pgm ? pgm_read_byte(data++) : *data++; if (!SendControl(c)) return -1; } return sent; } // Send a USB descriptor string. The string is stored in PROGMEM as a // plain ASCII string but is sent out as UTF-16 with the correct 2-byte // prefix static bool USB_SendStringDescriptor(const u8*string_P, u8 string_len) { SendControl(2 + string_len * 2); SendControl(3); for (u8 i = 0; i < string_len; i++) { bool r = SendControl(pgm_read_byte(&string_P[i])); r &= SendControl(0); // high byte if (!r) { return false; } } return true; } // Does not timeout or cross fifo boundaries // Will only work for transfers <= 64 bytes // TODO int USB_RecvControl(void* d, int len) { WaitOUT(); Recv((u8*)d, len); ClearOUT(); return len; } int SendInterfaces() { int total = 0; u8 interfaces = 0; #ifdef CDC_ENABLED total = CDC_GetInterface(&interfaces); #endif #ifdef HID_ENABLED total += HID_GetInterface(&interfaces); #endif return interfaces; } // Construct a dynamic configuration descriptor // This really needs dynamic endpoint allocation etc // TODO static bool SendConfiguration(int maxlen) { // Count and measure interfaces InitControl(0); int interfaces = SendInterfaces(); ConfigDescriptor config = D_CONFIG(_cmark + sizeof(ConfigDescriptor), interfaces); // Now send them InitControl(maxlen); USB_SendControl(0, &config, sizeof(ConfigDescriptor)); SendInterfaces(); return true; } u8 _cdcComposite = 0; static bool SendDescriptor(Setup& setup) { u8 t = setup.wValueH; if (USB_CONFIGURATION_DESCRIPTOR_TYPE == t) return SendConfiguration(setup.wLength); InitControl(setup.wLength); #ifdef HID_ENABLED if (HID_REPORT_DESCRIPTOR_TYPE == t) return HID_GetDescriptor(t); #endif const u8* desc_addr = 0; 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_STRING_DESCRIPTOR_TYPE == t) { if (setup.wValueL == 0) { desc_addr = (const u8*)&STRING_LANGUAGE; } else if (setup.wValueL == IPRODUCT) { return USB_SendStringDescriptor(STRING_PRODUCT, strlen(USB_PRODUCT)); } else if (setup.wValueL == IMANUFACTURER) { return USB_SendStringDescriptor(STRING_MANUFACTURER, strlen(USB_MANUFACTURER)); } else return false; } if (desc_addr == 0) return false; u8 desc_length = pgm_read_byte(desc_addr); USB_SendControl(TRANSFER_PGM, desc_addr, desc_length); return true; } // Endpoint 0 interrupt ISR(USB_COM_vect) { SetEP(0); if (!ReceivedSetupInt()) return; Setup setup; Recv((u8*)&setup, 8); ClearSetupInt(); u8 requestType = setup.bmRequestType; if (requestType & REQUEST_DEVICETOHOST) WaitIN(); else ClearIN(); bool ok = true; if (REQUEST_STANDARD == (requestType & REQUEST_TYPE)) { // Standard Requests u8 r = setup.bRequest; u16 wValue = (setup.wValueH << 8) | setup.wValueL; if (GET_STATUS == r) { if (requestType == (REQUEST_DEVICETOHOST | REQUEST_STANDARD | REQUEST_DEVICE)) { Send8(_usbCurrentStatus); Send8(0); } else { // TODO: handle the HALT state of an endpoint here // see "Figure 9-6. Information Returned by a GetStatus() Request to an Endpoint" in usb_20.pdf for more information Send8(0); Send8(0); } } else if (CLEAR_FEATURE == r) { if ((requestType == (REQUEST_HOSTTODEVICE | REQUEST_STANDARD | REQUEST_DEVICE)) && (wValue == DEVICE_REMOTE_WAKEUP)) { _usbCurrentStatus &= ~FEATURE_REMOTE_WAKEUP_ENABLED; } } else if (SET_FEATURE == r) { if ((requestType == (REQUEST_HOSTTODEVICE | REQUEST_STANDARD | REQUEST_DEVICE)) && (wValue == DEVICE_REMOTE_WAKEUP)) { _usbCurrentStatus |= FEATURE_REMOTE_WAKEUP_ENABLED; } } else if (SET_ADDRESS == r) { WaitIN(); UDADDR = setup.wValueL | (1 << ADDEN); } else if (GET_DESCRIPTOR == r) { ok = SendDescriptor(setup); } else if (SET_DESCRIPTOR == r) { ok = false; } else if (GET_CONFIGURATION == r) { Send8(1); } else if (SET_CONFIGURATION == r) { if (REQUEST_DEVICE == (requestType & REQUEST_RECIPIENT)) { InitEndpoints(); _usbConfiguration = setup.wValueL; } else ok = false; } else if (GET_INTERFACE == r) { } else if (SET_INTERFACE == r) { } } else { InitControl(setup.wLength); // Max length of transfer ok = ClassInterfaceRequest(setup); } if (ok) ClearIN(); else { Stall(); } } void USB_Flush(u8 ep) { SetEP(ep); if (FifoByteCount()) ReleaseTX(); } static inline void USB_ClockDisable() { #if defined(OTGPADE) USBCON = (USBCON & ~(1 << OTGPADE)) | (1 << FRZCLK); // freeze clock and disable VBUS Pad #else // u2 Series USBCON = (1 << FRZCLK); // freeze clock #endif PLLCSR &= ~(1 << PLLE); // stop PLL } static inline void USB_ClockEnable() { #if defined(UHWCON) UHWCON |= (1 << UVREGE); // power internal reg #endif USBCON = (1 << USBE) | (1 << FRZCLK); // clock frozen, usb enabled // ATmega32U4 #if defined(PINDIV) #if F_CPU == 16000000UL PLLCSR |= (1 << PINDIV); // Need 16 MHz xtal #elif F_CPU == 8000000UL PLLCSR &= ~(1 << PINDIV); // Need 8 MHz xtal #else #error "Clock rate of F_CPU not supported" #endif #elif defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega8U2__) // for the u2 Series the datasheet is confusing. On page 40 its called PINDIV and on page 290 its called PLLP0 #if F_CPU == 16000000UL // Need 16 MHz xtal PLLCSR |= (1 << PLLP0); #elif F_CPU == 8000000UL // Need 8 MHz xtal PLLCSR &= ~(1 << PLLP0); #endif // AT90USB646, AT90USB647, AT90USB1286, AT90USB1287 #elif defined(PLLP2) #if F_CPU == 16000000UL #if defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) // For Atmel AT90USB128x only. Do not use with Atmel AT90USB64x. PLLCSR = (PLLCSR & ~(1 << PLLP1)) | ((1 << PLLP2) | (1 << PLLP0)); // Need 16 MHz xtal #elif defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) // For AT90USB64x only. Do not use with AT90USB128x. PLLCSR = (PLLCSR & ~(1 << PLLP0)) | ((1 << PLLP2) | (1 << PLLP1)); // Need 16 MHz xtal #else #error "USB Chip not supported, please defined method of USB PLL initialization" #endif #elif F_CPU == 8000000UL // for Atmel AT90USB128x and AT90USB64x PLLCSR = (PLLCSR & ~(1 << PLLP2)) | ((1 << PLLP1) | (1 << PLLP0)); // Need 8 MHz xtal #else #error "Clock rate of F_CPU not supported" #endif #else #error "USB Chip not supported, please defined method of USB PLL initialization" #endif PLLCSR |= (1 << PLLE); while (!(PLLCSR & (1 << PLOCK))) // wait for lock pll { } // Some tests on specific versions of macosx (10.7.3), reported some // strange behaviors when the board is reset using the serial // port touch at 1200 bps. This delay fixes this behavior. delay(1); #if defined(OTGPADE) USBCON = (USBCON & ~(1 << FRZCLK)) | (1 << OTGPADE); // start USB clock, enable VBUS Pad #else USBCON &= ~(1 << FRZCLK); // start USB clock #endif #if defined(RSTCPU) #if defined(LSM) UDCON &= ~((1 << RSTCPU) | (1 << LSM) | (1 << RMWKUP) | (1 << DETACH)); // enable attach resistor, set full speed mode #else // u2 Series UDCON &= ~((1 << RSTCPU) | (1 << RMWKUP) | (1 << DETACH)); // enable attach resistor, set full speed mode #endif #else // AT90USB64x and AT90USB128x don't have RSTCPU UDCON &= ~((1 << LSM) | (1 << RMWKUP) | (1 << DETACH)); // enable attach resistor, set full speed mode #endif } // General interrupt ISR(USB_GEN_vect) { u8 udint = UDINT; UDINT &= ~((1 << EORSTI) | (1 << SOFI)); // clear the IRQ flags for the IRQs which are handled here, except WAKEUPI and SUSPI (see below) // End of Reset if (udint & (1 << EORSTI)) { InitEP(0, EP_TYPE_CONTROL, EP_SINGLE_64); // init ep0 _usbConfiguration = 0; // not configured yet UEIENX = 1 << RXSTPE; // Enable interrupts for ep0 } // Start of Frame - happens every millisecond so we use it for TX and RX LED one-shot timing, too if (udint & (1 << SOFI)) { #ifdef CDC_ENABLED USB_Flush(CDC_TX); // Send a tx frame if found #endif // check whether the one-shot period has elapsed. if so, turn off the LED if (TxLEDPulse && !(--TxLEDPulse)) TXLED0; if (RxLEDPulse && !(--RxLEDPulse)) RXLED0; } // the WAKEUPI interrupt is triggered as soon as there are non-idle patterns on the data // lines. Thus, the WAKEUPI interrupt can occur even if the controller is not in the "suspend" mode. // Therefore the we enable it only when USB is suspended if (udint & (1 << WAKEUPI)) { UDIEN = (UDIEN & ~(1 << WAKEUPE)) | (1 << SUSPE); // Disable interrupts for WAKEUP and enable interrupts for SUSPEND //TODO // WAKEUPI shall be cleared by software (USB clock inputs must be enabled before). //USB_ClockEnable(); UDINT &= ~(1 << WAKEUPI); _usbSuspendState = (_usbSuspendState & ~(1 << SUSPI)) | (1 << WAKEUPI); } else if (udint & (1 << SUSPI)) // only one of the WAKEUPI / SUSPI bits can be active at time { UDIEN = (UDIEN & ~(1 << SUSPE)) | (1 << WAKEUPE); // Disable interrupts for SUSPEND and enable interrupts for WAKEUP //TODO //USB_ClockDisable(); UDINT &= ~((1 << WAKEUPI) | (1 << SUSPI)); // clear any already pending WAKEUP IRQs and the SUSPI request _usbSuspendState = (_usbSuspendState & ~(1 << WAKEUPI)) | (1 << SUSPI); } } // VBUS or counting frames // Any frame counting? u8 USBConnected() { u8 f = UDFNUML; delay(3); return f != UDFNUML; } //======================================================================= //======================================================================= USBDevice_ USBDevice; USBDevice_::USBDevice_() { } void USBDevice_::attach() { _usbConfiguration = 0; _usbCurrentStatus = 0; _usbSuspendState = 0; USB_ClockEnable(); UDINT &= ~((1 << WAKEUPI) | (1 << SUSPI)); // clear already pending WAKEUP / SUSPEND requests UDIEN = (1 << EORSTE) | (1 << SOFE) | (1 << SUSPE); // Enable interrupts for EOR (End of Reset), SOF (start of frame) and SUSPEND TX_RX_LED_INIT; } void USBDevice_::detach() { } // Check for interrupts // TODO: VBUS detection bool USBDevice_::configured() { return _usbConfiguration; } void USBDevice_::poll() { } bool USBDevice_::wakeupHost() { // clear any previous wakeup request which might have been set but could be processed at that time // e.g. because the host was not suspended at that time UDCON &= ~(1 << RMWKUP); if (!(UDCON & (1 << RMWKUP)) && (_usbSuspendState & (1 << SUSPI)) && (_usbCurrentStatus & FEATURE_REMOTE_WAKEUP_ENABLED)) { // This short version will only work, when the device has not been suspended. Currently the // Arduino core doesn't handle SUSPEND at all, so this is ok. USB_ClockEnable(); UDCON |= (1 << RMWKUP); // send the wakeup request return true; } return false; } #endif /* if defined(USBCON) */