From a0e072da2a93fed7cf5f79808c1f610ae7328637 Mon Sep 17 00:00:00 2001 From: optixx Date: Tue, 9 Feb 2016 12:30:47 +0100 Subject: [PATCH] Switch to new vusb --- avr/bootloader/usbdrv/Changelog.txt | 96 ++++++++ avr/bootloader/usbdrv/CommercialLicense.txt | 62 ++--- avr/bootloader/usbdrv/License.txt | 12 +- avr/bootloader/usbdrv/Readme.txt | 106 +++++---- avr/bootloader/usbdrv/USBID-License.txt | 146 ------------ avr/bootloader/usbdrv/asmcommon.inc | 27 ++- avr/bootloader/usbdrv/iarcompat.h | 65 ------ avr/bootloader/usbdrv/oddebug.c | 3 +- avr/bootloader/usbdrv/oddebug.h | 8 +- avr/bootloader/usbdrv/usbconfig-prototype.h | 124 ++++++++-- avr/bootloader/usbdrv/usbdrv.c | 97 ++++---- avr/bootloader/usbdrv/usbdrv.h | 92 +++++--- avr/bootloader/usbdrv/usbdrvasm.S | 206 +++++++++++----- avr/bootloader/usbdrv/usbdrvasm.asm | 5 +- avr/bootloader/usbdrv/usbdrvasm12.inc | 245 +++++++++----------- avr/bootloader/usbdrv/usbdrvasm128.inc | 37 ++- avr/bootloader/usbdrv/usbdrvasm15.inc | 24 +- avr/bootloader/usbdrv/usbdrvasm16.inc | 36 +-- avr/bootloader/usbdrv/usbdrvasm165.inc | 21 +- avr/bootloader/usbdrv/usbdrvasm18-crc.inc | 1 - avr/bootloader/usbdrv/usbdrvasm20.inc | 21 +- avr/bootloader/usbdrv/usbportability.h | 7 +- 22 files changed, 770 insertions(+), 671 deletions(-) delete mode 100644 avr/bootloader/usbdrv/USBID-License.txt delete mode 100644 avr/bootloader/usbdrv/iarcompat.h diff --git a/avr/bootloader/usbdrv/Changelog.txt b/avr/bootloader/usbdrv/Changelog.txt index 186d066..79b5215 100644 --- a/avr/bootloader/usbdrv/Changelog.txt +++ b/avr/bootloader/usbdrv/Changelog.txt @@ -231,3 +231,99 @@ Scroll down to the bottom to see the most recent changes. - Added 20 MHz module contributed by Jeroen Benschop. * Release 2008-05-13 + + - Fixed bug in libs-host/hiddata.c function usbhidGetReport(): length + was not incremented, pointer to length was incremented instead. + - Added code to command line tool(s) which claims an interface. This code + is disabled by default, but may be necessary on newer Linux kernels. + - Added usbconfig.h option "USB_CFG_CHECK_DATA_TOGGLING". + - New header "usbportability.h" prepares ports to other development + environments. + - Long transfers (above 254 bytes) did not work when usbFunctionRead() was + used to supply the data. Fixed this bug. [Thanks to Alexander Neumann!] + - In hiddata.c (example code for sending/receiving data over HID), use + USB_RECIP_DEVICE instead of USB_RECIP_INTERFACE for control transfers so + that we need not claim the interface. + - in usbPoll() loop 20 times polling for RESET state instead of 10 times. + This accounts for the higher clock rates we now support. + - Added a module for 12.8 MHz RC oscillator with PLL in receiver loop. + - Added hook to SOF code so that oscillator can be tuned to USB frame clock. + - Added timeout to waitForJ loop. Helps preventing unexpected hangs. + - Added example code for oscillator tuning to libs-device (thanks to + Henrik Haftmann for the idea to this routine). + - Implemented option USB_CFG_SUPPRESS_INTR_CODE. + +* Release 2008-10-22 + + - Fixed libs-device/osctune.h: OSCCAL is memory address on ATMega88 and + similar, not offset of 0x20 needs to be added. + - Allow distribution under GPLv3 for those who have to link against other + code distributed under GPLv3. + +* Release 2008-11-26 + + - Removed libusb-win32 dependency for hid-data example in Makefile.windows. + It was never required and confused many people. + - Added extern uchar usbRxToken to usbdrv.h. + - Integrated a module with CRC checks at 18 MHz by Lukas Schrittwieser. + +* Release 2009-03-23 + + - Hid-mouse example used settings from hid-data example, fixed that. + - Renamed project to V-USB due to a trademark issue with Atmel(r). + - Changed CommercialLicense.txt and USBID-License.txt to make the + background of USB ID registration clearer. + +* Release 2009-04-15 + + - Changed CommercialLicense.txt to reflect the new range of PIDs from + Jason Kotzin. + - Removed USBID-License.txt in favor of USB-IDs-for-free.txt and + USB-ID-FAQ.txt + - Fixed a bug in the 12.8 MHz module: End Of Packet decection was made in + the center between bit 0 and 1 of each byte. This is where the data lines + are expected to change and the sampled data may therefore be nonsense. + We therefore check EOP ONLY if bits 0 AND 1 have both been read as 0 on D-. + - Fixed a bitstuffing problem in the 16 MHz module: If bit 6 was stuffed, + the unstuffing code in the receiver routine was 1 cycle too long. If + multiple bytes had the unstuffing in bit 6, the error summed up until the + receiver was out of sync. + - Included option for faster CRC routine. + Thanks to Slawomir Fras (BoskiDialer) for this code! + - Updated bits in Configuration Descriptor's bmAttributes according to + USB 1.1 (in particular bit 7, it is a must-be-set bit now). + +* Release 2009-08-22 + + - Moved first DBG1() after odDebugInit() in all examples. + - Use vector INT0_vect instead of SIG_INTERRUPT0 if defined. This makes + V-USB compatible with the new "p" suffix devices (e.g. ATMega328p). + - USB_CFG_CLOCK_KHZ setting is now required in usbconfig.h (no default any + more). + - New option USB_CFG_DRIVER_FLASH_PAGE allows boot loaders on devices with + more than 64 kB flash. + - Built-in configuration descriptor allows custom definition for second + endpoint now. + +* Release 2010-07-15 + + - Fixed bug in usbDriverSetup() which prevented descriptor sizes above 255 + bytes. + - Avoid a compiler warning for unused parameter in usbHandleResetHook() when + compiler option -Wextra is enabled. + - Fixed wrong hex value for some IDs in USB-IDs-for-free.txt. + - Keep a define for USBATTR_BUSPOWER, although the flag does not exist + in USB 1.1 any more. Set it to 0. This is for backward compatibility. + +* Release 2012-01-09 + + - Define a separate (defined) type for usbMsgPtr so that projects using a + tiny memory model can define it to an 8 bit type in usbconfig.h. This + change also saves a couple of bytes when using a scalar 16 bit type. + - Inserted "const" keyword for all PROGMEM declarations because new GCC + requires it. + - Fixed problem with dependence of usbportability.h on usbconfig.h. This + problem occurred with IAR CC only. + - Prepared repository for github.com. + +* Release 2012-12-06 \ No newline at end of file diff --git a/avr/bootloader/usbdrv/CommercialLicense.txt b/avr/bootloader/usbdrv/CommercialLicense.txt index 654f16d..de1a2b0 100644 --- a/avr/bootloader/usbdrv/CommercialLicense.txt +++ b/avr/bootloader/usbdrv/CommercialLicense.txt @@ -1,5 +1,5 @@ -AVR-USB Driver Software License Agreement -Version 2008-04-15 +V-USB Driver Software License Agreement +Version 2012-07-09 THIS LICENSE AGREEMENT GRANTS YOU CERTAIN RIGHTS IN A SOFTWARE. YOU CAN ENTER INTO THIS AGREEMENT AND ACQUIRE THE RIGHTS OUTLINED BELOW BY PAYING @@ -13,8 +13,8 @@ Grosse Schiffgasse 1A/7, 1020 Wien, AUSTRIA. 1.2 "You" shall mean the Licensee. -1.3 "AVR-USB" shall mean all files included in the package distributed under -the name "avrusb" by OBJECTIVE DEVELOPMENT (http://www.obdev.at/avrusb/) +1.3 "V-USB" shall mean all files included in the package distributed under +the name "vusb" by OBJECTIVE DEVELOPMENT (http://www.obdev.at/vusb/) unless otherwise noted. This includes the firmware-only USB device implementation for Atmel AVR microcontrollers, some simple device examples and host side software examples and libraries. @@ -23,21 +23,31 @@ and host side software examples and libraries. 2 LICENSE GRANTS 2.1 Source Code. OBJECTIVE DEVELOPMENT shall furnish you with the source -code of AVR-USB. +code of V-USB. 2.2 Distribution and Use. OBJECTIVE DEVELOPMENT grants you the -non-exclusive right to use and distribute AVR-USB with your hardware +non-exclusive right to use, copy and distribute V-USB with your hardware product(s), restricted by the limitations in section 3 below. 2.3 Modifications. OBJECTIVE DEVELOPMENT grants you the right to modify -your copy of AVR-USB according to your needs. +the source code and your copy of V-USB according to your needs. -2.4 USB IDs. OBJECTIVE DEVELOPMENT grants you the exclusive rights to use -USB Product ID(s) sent to you in e-mail after receiving your payment in -conjunction with USB Vendor ID 5824. OBJECTIVE DEVELOPMENT has acquired an -exclusive license for this pair of USB identifiers from Wouter van Ooijen -(www.voti.nl), who has licensed the VID from the USB Implementers Forum, -Inc. (www.usb.org). +2.4 USB IDs. OBJECTIVE DEVELOPMENT furnishes you with one or two USB +Product ID(s), sent to you in e-mail. These Product IDs are reserved +exclusively for you. OBJECTIVE DEVELOPMENT has obtained USB Product ID +ranges under the Vendor ID 5824 from Wouter van Ooijen (Van Ooijen +Technische Informatica, www.voti.nl) and under the Vendor ID 8352 from +Jason Kotzin (now flirc.tv, Inc.). Both owners of the Vendor IDs have +obtained these IDs from the USB Implementers Forum, Inc. (www.usb.org). +OBJECTIVE DEVELOPMENT disclaims all liability which might arise from the +assignment of USB IDs. + +2.5 USB Certification. Although not part of this agreement, we want to make +it clear that you cannot become USB certified when you use V-USB or a USB +Product ID assigned by OBJECTIVE DEVELOPMENT. AVR microcontrollers don't +meet the electrical specifications required by the USB specification and +the USB Implementers Forum certifies only members who bought a Vendor ID of +their own. 3 LICENSE RESTRICTIONS @@ -46,21 +56,21 @@ Inc. (www.usb.org). applicable. Which one is determined by the amount you pay to OBJECTIVE DEVELOPMENT, see section 4 ("Payment") below. -Hobby License: You may use AVR-USB according to section 2 above in no more +Hobby License: You may use V-USB according to section 2 above in no more than 5 hardware units. These units must not be sold for profit. -Entry Level License: You may use AVR-USB according to section 2 above in no +Entry Level License: You may use V-USB according to section 2 above in no more than 150 hardware units. -Professional License: You may use AVR-USB according to section 2 above in +Professional License: You may use V-USB according to section 2 above in any number of hardware units, except for large scale production ("unlimited fair use"). Quantities below 10,000 units are not considered large scale production. If your reach quantities which are obviously large scale production, you must pay a license fee of 0.10 EUR per unit for all units above 10,000. -3.2 Rental. You may not rent, lease, or lend AVR-USB or otherwise encumber -any copy of AVR-USB, or any of the rights granted herein. +3.2 Rental. You may not rent, lease, or lend V-USB or otherwise encumber +any copy of V-USB, or any of the rights granted herein. 3.3 Transfer. You may not transfer your rights under this Agreement to another party without OBJECTIVE DEVELOPMENT's prior written consent. If @@ -78,7 +88,7 @@ non-exclusive. by third parties. In particular, you are not allowed to use the USB logo or other trademarks owned by the USB Implementers Forum, Inc. without their consent. Since such consent depends on USB certification, it should be -noted that AVR-USB will not pass certification because it does not +noted that V-USB will not pass certification because it does not implement checksum verification and the microcontroller ports do not meet the electrical specifications. @@ -88,15 +98,15 @@ the electrical specifications. The payment amount depends on the variation of this agreement (according to section 3.1) into which you want to enter. Concrete prices are listed on OBJECTIVE DEVELOPMENT's web site, usually at -http://www.obdev.at/avrusb/license.html. You agree to pay the amount listed +http://www.obdev.at/vusb/license.html. You agree to pay the amount listed there to OBJECTIVE DEVELOPMENT or OBJECTIVE DEVELOPMENT's payment processor or reseller. 5 COPYRIGHT AND OWNERSHIP -AVR-USB is protected by copyright laws and international copyright -treaties, as well as other intellectual property laws and treaties. AVR-USB +V-USB is protected by copyright laws and international copyright +treaties, as well as other intellectual property laws and treaties. V-USB is licensed, not sold. @@ -112,12 +122,12 @@ and limitation of liability shall survive termination of this agreement. 7 DISCLAIMER OF WARRANTY AND LIABILITY -LIMITED WARRANTY. AVR-USB IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +LIMITED WARRANTY. V-USB IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, OBJECTIVE DEVELOPMENT AND ITS SUPPLIERS HEREBY DISCLAIM ALL WARRANTIES, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND -NON-INFRINGEMENT, WITH REGARD TO AVR-USB, AND THE PROVISION OF OR FAILURE +NON-INFRINGEMENT, WITH REGARD TO V-USB, AND THE PROVISION OF OR FAILURE TO PROVIDE SUPPORT SERVICES. THIS LIMITED WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS. YOU MAY HAVE OTHERS, WHICH VARY FROM STATE/JURISDICTION TO STATE/JURISDICTION. @@ -127,11 +137,11 @@ IN NO EVENT SHALL OBJECTIVE DEVELOPMENT OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR ANY OTHER PECUNIARY -LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE AVR-USB OR THE +LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE V-USB OR THE PROVISION OF OR FAILURE TO PROVIDE SUPPORT SERVICES, EVEN IF OBJECTIVE DEVELOPMENT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN ANY CASE, OBJECTIVE DEVELOPMENT'S ENTIRE LIABILITY UNDER ANY PROVISION OF THIS -AGREEMENT SHALL BE LIMITED TO THE AMOUNT ACTUALLY PAID BY YOU FOR AVR-USB. +AGREEMENT SHALL BE LIMITED TO THE AMOUNT ACTUALLY PAID BY YOU FOR V-USB. 8 MISCELLANEOUS TERMS diff --git a/avr/bootloader/usbdrv/License.txt b/avr/bootloader/usbdrv/License.txt index f6a232e..4460cfb 100644 --- a/avr/bootloader/usbdrv/License.txt +++ b/avr/bootloader/usbdrv/License.txt @@ -1,16 +1,18 @@ -OBJECTIVE DEVELOPMENT GmbH's AVR-USB driver software is distributed under the -terms and conditions of the GNU GPL version 2, see the text below. In addition -to the requirements in the GPL, we STRONGLY ENCOURAGE you to do the following: +OBJECTIVE DEVELOPMENT GmbH's V-USB driver software is distributed under the +terms and conditions of the GNU GPL version 2 or the GNU GPL version 3. It is +your choice whether you apply the terms of version 2 or version 3. The full +text of GPLv2 is included below. In addition to the requirements in the GPL, +we STRONGLY ENCOURAGE you to do the following: (1) Publish your entire project on a web site and drop us a note with the URL. -Use the form at http://www.obdev.at/avrusb/feedback.html for your submission. +Use the form at http://www.obdev.at/vusb/feedback.html for your submission. (2) Adhere to minimum publication standards. Please include AT LEAST: - a circuit diagram in PDF, PNG or GIF format - full source code for the host software - a Readme.txt file in ASCII format which describes the purpose of the project and what can be found in which directories and which files - - a reference to http://www.obdev.at/avrusb/ + - a reference to http://www.obdev.at/vusb/ (3) If you improve the driver firmware itself, please give us a free license to your modifications for our commercial license offerings. diff --git a/avr/bootloader/usbdrv/Readme.txt b/avr/bootloader/usbdrv/Readme.txt index cb1a70e..970dc66 100644 --- a/avr/bootloader/usbdrv/Readme.txt +++ b/avr/bootloader/usbdrv/Readme.txt @@ -1,6 +1,6 @@ This is the Readme file to Objective Development's firmware-only USB driver for Atmel AVR microcontrollers. For more information please visit -http://www.obdev.at/avrusb/ +http://www.obdev.at/vusb/ This directory contains the USB firmware only. Copy it as-is to your own project and add all .c and .S files to your project (these files are marked @@ -33,26 +33,26 @@ The driver consists of the following files: defined to a value greater than 0. Link this module to your code! oddebug.h .............. Interface definitions of the debug module. - iarcompat.h ............ Compatibility definitions for IAR C-compiler. + usbportability.h ....... Header with compiler-dependent stuff. usbdrvasm.asm .......... Compatibility stub for IAR-C-compiler. Use this module instead of usbdrvasm.S when you assembler with IAR's tools. License.txt ............ Open Source license for this driver. CommercialLicense.txt .. Optional commercial license for this driver. - USBID-License.txt ...... Terms and conditions for using particular USB ID - values for particular purposes. + USB-ID-FAQ.txt ......... General infos about USB Product- and Vendor-IDs. + USB-IDs-for-free.txt ... List and terms of use for free shared PIDs. (*) ... These files should be linked to your project. CPU CORE CLOCK FREQUENCY ======================== -We supply assembler modules for clock frequencies of 12 MHz, 15 MHz, 16 MHz and -16.5 MHz. Other clock rates are not supported. The actual clock rate must be -configured in usbdrv.h unless you use the default 12 MHz. +We supply assembler modules for clock frequencies of 12 MHz, 12.8 MHz, 15 MHz, +16 MHz, 16.5 MHz 18 MHz and 20 MHz. Other clock rates are not supported. The +actual clock rate must be configured in usbconfig.h. 12 MHz Clock -This is the traditional clock rate of AVR-USB because it's the lowest clock +This is the traditional clock rate of V-USB because it's the lowest clock rate where the timing constraints of the USB spec can be met. 15 MHz Clock @@ -67,19 +67,29 @@ if you need the slightly higher clock rate for performance reasons. Since 16 MHz is not divisible by the USB low speed bit clock of 1.5 MHz, the code is somewhat tricky and has to insert a leap cycle every third byte. -16.5 MHz Clock -The assembler module for this clock rate differs from the other modules because -it has been built for an RC oscillator with only 1% precision. The receiver -code inserts leap cycles to compensate for clock deviations. 1% is also the -precision which can be achieved by calibrating the internal RC oscillator of -the AVR. Please note that only AVRs with internal 64 MHz PLL oscillator can be -used since the 8 MHz RC oscillator cannot be trimmed up to 16.5 MHz. This -includes the very popular ATTiny25, ATTiny45, ATTiny85 series as well as the -ATTiny26. +12.8 MHz and 16.5 MHz Clock +The assembler modules for these clock rates differ from the other modules +because they have been built for an RC oscillator with only 1% precision. The +receiver code inserts leap cycles to compensate for clock deviations. 1% is +also the precision which can be achieved by calibrating the internal RC +oscillator of the AVR. Please note that only AVRs with internal 64 MHz PLL +oscillator can reach 16.5 MHz with the RC oscillator. This includes the very +popular ATTiny25, ATTiny45, ATTiny85 series as well as the ATTiny26. Almost +all AVRs can reach 12.8 MHz, although this is outside the specified range. -See the EasyLogger example at http://www.obdev.at/avrusb/easylogger.html for +See the EasyLogger example at http://www.obdev.at/vusb/easylogger.html for code which calibrates the RC oscillator based on the USB frame clock. +18 MHz Clock +This module is closer to the USB specification because it performs an on the +fly CRC check for incoming packets. Packets with invalid checksum are +discarded as required by the spec. If you also implement checks for data +PID toggling on application level (see option USB_CFG_CHECK_DATA_TOGGLING +in usbconfig.h for more info), this ensures data integrity. Due to the CRC +tables and alignment requirements, this code is bigger than modules for other +clock rates. To activate this module, you must define USB_CFG_CHECK_CRC to 1 +and USB_CFG_CLOCK_KHZ to 18000 in usbconfig.h. + 20 MHz Clock This module is for people who won't do it with less than the maximum. Since 20 MHz is not divisible by the USB low speed bit clock of 1.5 MHz, the code @@ -94,53 +104,69 @@ can assign PIDs at will. Since an entry level cost of 1,500 USD is too high for most small companies and hobbyists, we provide some VID/PID pairs for free. See the file -USBID-License.txt for details. +USB-IDs-for-free.txt for details. Objective Development also has some license offerings which include product -IDs. See http://www.obdev.at/avrusb/ for details. +IDs. See http://www.obdev.at/vusb/ for details. DEVELOPMENT SYSTEM ================== This driver has been developed and optimized for the GNU compiler version 3 -(gcc 3). It does work well with gcc 4, but with bigger code size. We recommend -that you use the GNU compiler suite because it is freely available. AVR-USB -has also been ported to the IAR compiler and assembler. It has been tested -with IAR 4.10B/W32 and 4.12A/W32 on an ATmega8 with the "small" and "tiny" -memory model. Not every release is tested with IAR CC and the driver may -therefore fail to compile with IAR. Please note that gcc is more efficient for -usbdrv.c because this module has been deliberately optimized for gcc. +and 4. We recommend that you use the GNU compiler suite because it is freely +available. V-USB has also been ported to the IAR compiler and assembler. It +has been tested with IAR 4.10B/W32 and 4.12A/W32 on an ATmega8 with the +"small" and "tiny" memory model. Not every release is tested with IAR CC and +the driver may therefore fail to compile with IAR. Please note that gcc is +more efficient for usbdrv.c because this module has been deliberately +optimized for gcc. + +Gcc version 3 produces smaller code than version 4 due to new optimizing +capabilities which don't always improve things on 8 bit CPUs. The code size +generated by gcc 4 can be reduced with the compiler options +-fno-move-loop-invariants, -fno-tree-scev-cprop and +-fno-inline-small-functions in addition to -Os. On devices with more than +8k of flash memory, we also recommend the linker option --relax (written as +-Wl,--relax for gcc) to convert absolute calls into relative where possible. + +For more information about optimizing options see: + + http://www.tty1.net/blog/2008-04-29-avr-gcc-optimisations_en.html + +These optimizations are good for gcc 4.x. Version 3.x of gcc does not support +most of these options and produces good code anyway. -USING AVR-USB FOR FREE -====================== +USING V-USB FOR FREE +==================== The AVR firmware driver is published under the GNU General Public License -Version 2 (GPL2). See the file "License.txt" for details. +Version 2 (GPL2) and the GNU General Public License Version 3 (GPL3). It is +your choice whether you apply the terms of version 2 or version 3. -If you decide for the free GPL2, we STRONGLY ENCOURAGE you to do the following -things IN ADDITION to the obligations from the GPL2: +If you decide for the free GPL2 or GPL3, we STRONGLY ENCOURAGE you to do the +following things IN ADDITION to the obligations from the GPL: (1) Publish your entire project on a web site and drop us a note with the URL. -Use the form at http://www.obdev.at/avrusb/feedback.html for your submission. +Use the form at http://www.obdev.at/vusb/feedback.html for your submission. If you don't have a web site, you can publish the project in obdev's documentation wiki at -http://www.obdev.at/goto.php?t=avrusb-wiki&p=hosted-projects. +http://www.obdev.at/goto.php?t=vusb-wiki&p=hosted-projects. (2) Adhere to minimum publication standards. Please include AT LEAST: - a circuit diagram in PDF, PNG or GIF format - full source code for the host software - a Readme.txt file in ASCII format which describes the purpose of the project and what can be found in which directories and which files - - a reference to http://www.obdev.at/avrusb/ + - a reference to http://www.obdev.at/vusb/ (3) If you improve the driver firmware itself, please give us a free license to your modifications for our commercial license offerings. -COMMERCIAL LICENSES FOR AVR-USB -=============================== -If you don't want to publish your source code under the terms of the GPL2, -you can simply pay money for AVR-USB. As an additional benefit you get -USB PIDs for free, licensed exclusively to you. See the file +COMMERCIAL LICENSES FOR V-USB +============================= +If you don't want to publish your source code under the terms of the GPL, +you can simply pay money for V-USB. As an additional benefit you get +USB PIDs for free, reserved exclusively to you. See the file "CommercialLicense.txt" for details. diff --git a/avr/bootloader/usbdrv/USBID-License.txt b/avr/bootloader/usbdrv/USBID-License.txt deleted file mode 100644 index 984c9ee..0000000 --- a/avr/bootloader/usbdrv/USBID-License.txt +++ /dev/null @@ -1,146 +0,0 @@ -Royalty-Free Non-Exclusive License USB Product-ID -================================================= - -Version 2008-04-07 - -OBJECTIVE DEVELOPMENT Software GmbH hereby grants you the non-exclusive -right to use three USB.org vendor-ID (VID) / product-ID (PID) pairs with -products based on Objective Development's firmware-only USB driver for -Atmel AVR microcontrollers: - - * VID = 5824 (=0x16c0) / PID = 1500 (=0x5dc) for devices implementing no - USB device class (vendor-class devices with USB class = 0xff). Devices - using this pair will be referred to as "VENDOR CLASS" devices. - - * VID = 5824 (=0x16c0) / PID = 1503 (=0x5df) for HID class devices - (excluding mice and keyboards). Devices using this pair will be referred - to as "HID CLASS" devices. - - * VID = 5824 (=0x16c0) / PID = 1505 (=0x5e1) for CDC class modem devices - Devices using this pair will be referred to as "CDC-ACM CLASS" devices. - - * VID = 5824 (=0x16c0) / PID = 1508 (=0x5e4) for MIDI class devices - Devices using this pair will be referred to as "MIDI CLASS" devices. - -Since the granted right is non-exclusive, the same VID/PID pairs may be -used by many companies and individuals for different products. To avoid -conflicts, your device and host driver software MUST adhere to the rules -outlined below. - -OBJECTIVE DEVELOPMENT Software GmbH has licensed these VID/PID pairs from -Wouter van Ooijen (see www.voti.nl), who has licensed the VID from the USB -Implementers Forum, Inc. (see www.usb.org). The VID is registered for the -company name "Van Ooijen Technische Informatica". - - -RULES AND RESTRICTIONS -====================== - -(1) The USB device MUST provide a textual representation of the -manufacturer and product identification. The manufacturer identification -MUST be available at least in USB language 0x0409 (English/US). - -(2) The textual manufacturer identification MUST contain either an Internet -domain name (e.g. "mycompany.com") registered and owned by you, or an -e-mail address under your control (e.g. "myname@gmx.net"). You can embed -the domain name or e-mail address in any string you like, e.g. "Objective -Development http://www.obdev.at/avrusb/". - -(3) You are responsible for retaining ownership of the domain or e-mail -address for as long as any of your products are in use. - -(4) You may choose any string for the textual product identification, as -long as this string is unique within the scope of your textual manufacturer -identification. - -(5) Matching of device-specific drivers MUST be based on the textual -manufacturer and product identification in addition to the usual VID/PID -matching. This means that operating system features which are based on -VID/PID matching only (e.g. Windows kernel level drivers, automatic actions -when the device is plugged in etc) MUST NOT be used. The driver matching -MUST be a comparison of the entire strings, NOT a sub-string match. For -CDC-ACM CLASS and MIDI CLASS devices, a generic class driver should be used -and the matching is based on the USB device class. - -(6) The extent to which VID/PID matching is allowed for non device-specific -drivers or features depends on the operating system and particular VID/PID -pair used: - - * Mac OS X, Linux, FreeBSD and other Unixes: No VID/PID matching is - required and hence no VID/PID-only matching is allowed at all. - - * Windows: The operating system performs VID/PID matching for the kernel - level driver. You are REQUIRED to use libusb-win32 (see - http://libusb-win32.sourceforge.net/) as the kernel level driver for - VENDOR CLASS devices. HID CLASS devices all use the generic HID class - driver shipped with Windows, except mice and keyboards. You therefore - MUST NOT use any of the shared VID/PID pairs for mice or keyboards. - CDC-ACM CLASS devices require a ".inf" file which matches on the VID/PID - pair. This ".inf" file MUST load the "usbser" driver to configure the - device as modem (COM-port). - -(7) OBJECTIVE DEVELOPMENT Software GmbH disclaims all liability for any -problems which are caused by the shared use of these VID/PID pairs. You -have been warned that the sharing of VID/PID pairs may cause problems. If -you want to avoid them, get your own VID/PID pair for exclusive use. - - -HOW TO IMPLEMENT THESE RULES -============================ - -The following rules are for VENDOR CLASS and HID CLASS devices. CDC-ACM -CLASS and MIDI CLASS devices use the operating system's class driver and -don't need a custom driver. - -The host driver MUST iterate over all devices with the given VID/PID -numbers in their device descriptors and query the string representation for -the manufacturer name in USB language 0x0409 (English/US). It MUST compare -the ENTIRE string with your textual manufacturer identification chosen in -(2) above. A substring search for your domain or e-mail address is NOT -acceptable. The driver MUST NOT touch the device (other than querying the -descriptors) unless the strings match. - -For all USB devices with matching VID/PID and textual manufacturer -identification, the host driver must query the textual product -identification and string-compare it with the name of the product it can -control. It may only initialize the device if the product matches exactly. - -Objective Development provides examples for these matching rules with the -"PowerSwitch" project (using libusb) and with the "Automator" project -(using Windows calls on Windows and libusb on Unix). - - -Technical Notes: -================ - -Sharing the same VID/PID pair among devices is possible as long as ALL -drivers which match the VID/PID also perform matching on the textual -identification strings. This is easy on all operating systems except -Windows, since Windows establishes a static connection between the VID/PID -pair and a kernel level driver. All devices with the same VID/PID pair must -therefore use THE SAME kernel level driver. - -We therefore demand that you use libusb-win32 for VENDOR CLASS devices. -This is a generic kernel level driver which allows all types of USB access -for user space applications. This is only a partial solution of the -problem, though, because different device drivers may come with different -versions of libusb-win32 and they may not work with the libusb version of -the respective other driver. You are therefore encouraged to test your -driver against a broad range of libusb-win32 versions. Do not use new -features in new versions, or check for their existence before you use them. -When a new libusb-win32 becomes available, make sure that your driver is -compatible with it. - -For HID CLASS devices it is necessary that all those devices bind to the -same kernel driver: Microsoft's generic USB HID driver. This is true for -all HID devices except those with a specialized driver. Currently, the only -HIDs with specialized drivers are mice and keyboards. You therefore MUST -NOT use a shared VID/PID with mouse and keyboard devices. - -Sharing the same VID/PID among different products is unusual and probably -violates the USB specification. If you do it, you do it at your own risk. - -To avoid possible incompatibilities, we highly recommend that you get your -own VID/PID pair if you intend to sell your product. Objective -Development's commercial licenses for AVR-USB include a PID for -unrestricted exclusive use. diff --git a/avr/bootloader/usbdrv/asmcommon.inc b/avr/bootloader/usbdrv/asmcommon.inc index 819c0bd..d2a4f7c 100644 --- a/avr/bootloader/usbdrv/asmcommon.inc +++ b/avr/bootloader/usbdrv/asmcommon.inc @@ -1,11 +1,10 @@ /* Name: asmcommon.inc - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Christian Starkjohann * Creation Date: 2007-11-05 * Tabsize: 4 * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * Revision: $Id$ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ /* Do not link this file! Link usbdrvasm.S instead, which includes the @@ -103,8 +102,11 @@ sofError: reti handleData: - lds token, usbCurrentTok;[18] - tst token ;[20] +#if USB_CFG_CHECK_CRC + CRC_CLEANUP_AND_CHECK ; jumps to ignorePacket if CRC error +#endif + lds shift, usbCurrentTok;[18] + tst shift ;[20] breq doReturn ;[21] lds x2, usbRxLen ;[22] tst x2 ;[24] @@ -113,8 +115,11 @@ handleData: ; recognized if usbPoll() was called less frequently than once every 4 ms. cpi cnt, 4 ;[26] zero sized data packets are status phase only -- ignore and ack brmi sendAckAndReti ;[27] keep rx buffer clean -- we must not NAK next SETUP +#if USB_CFG_CHECK_DATA_TOGGLING + sts usbCurrentDataToken, token ; store for checking by C code +#endif sts usbRxLen, cnt ;[28] store received data, swap buffers - sts usbRxToken, token ;[30] + sts usbRxToken, shift ;[30] lds x2, usbInputBufOffset;[32] swap buffers ldi cnt, USB_BUFSIZE ;[34] sub cnt, x2 ;[35] @@ -131,7 +136,11 @@ handleIn: ldi x1, USBPID_NAK ;[34] prepare value for usbTxLen #if USB_CFG_HAVE_INTRIN_ENDPOINT andi x3, 0xf ;[35] x3 contains endpoint +#if USB_CFG_SUPPRESS_INTR_CODE + brne sendNakAndReti ;[36] +#else brne handleIn1 ;[36] +#endif #endif lds cnt, usbTxLen ;[37] sbrc cnt, 4 ;[39] all handshake tokens have bit 4 set @@ -150,7 +159,7 @@ handleIn: ; RAM this way and avoid potential problems with endless retries. The rest of ; the driver assumes error-free transfers anyway. -#if USB_CFG_HAVE_INTRIN_ENDPOINT /* placed here due to relative jump range */ +#if !USB_CFG_SUPPRESS_INTR_CODE && USB_CFG_HAVE_INTRIN_ENDPOINT /* placed here due to relative jump range */ handleIn1: ;[38] #if USB_CFG_HAVE_INTRIN_ENDPOINT3 ; 2006-06-10 as suggested by O.Tamura: support second INTR IN / BULK IN endpoint @@ -164,9 +173,8 @@ handleIn1: ;[38] ldi YL, lo8(usbTxBuf1) ;[46] ldi YH, hi8(usbTxBuf1) ;[47] rjmp usbSendAndReti ;[48] 50 + 12 = 62 until SOP -#endif -#if USB_CFG_HAVE_INTRIN_ENDPOINT && USB_CFG_HAVE_INTRIN_ENDPOINT3 +#if USB_CFG_HAVE_INTRIN_ENDPOINT3 handleIn3: lds cnt, usbTxLen3 ;[41] sbrc cnt, 4 ;[43] @@ -176,3 +184,4 @@ handleIn3: ldi YH, hi8(usbTxBuf3) ;[48] rjmp usbSendAndReti ;[49] 51 + 12 = 63 until SOP #endif +#endif diff --git a/avr/bootloader/usbdrv/iarcompat.h b/avr/bootloader/usbdrv/iarcompat.h deleted file mode 100644 index 2485eb4..0000000 --- a/avr/bootloader/usbdrv/iarcompat.h +++ /dev/null @@ -1,65 +0,0 @@ -/* Name: iarcompat.h - * Project: AVR USB driver - * Author: Christian Starkjohann - * Creation Date: 2006-03-01 - * Tabsize: 4 - * Copyright: (c) 2006 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * This Revision: $Id: iarcompat.h 533 2008-02-28 15:35:25Z cs $ - */ - -/* -General Description: -This header is included when we compile with the IAR C-compiler and assembler. -It defines macros for cross compatibility between gcc and IAR-cc. - -Thanks to Oleg Semyonov for his help with the IAR tools port! -*/ - -#ifndef __iarcompat_h_INCLUDED__ -#define __iarcompat_h_INCLUDED__ - -#if defined __IAR_SYSTEMS_ICC__ || defined __IAR_SYSTEMS_ASM__ - -/* Enable bit definitions */ -#ifndef ENABLE_BIT_DEFINITIONS -# define ENABLE_BIT_DEFINITIONS 1 -#endif - -/* Include IAR headers */ -#include -#ifndef __IAR_SYSTEMS_ASM__ -# include -#endif - -#define __attribute__(arg) - -#ifdef __IAR_SYSTEMS_ASM__ -# define __ASSEMBLER__ -#endif - -#ifdef __HAS_ELPM__ -# define PROGMEM __farflash -#else -# define PROGMEM __flash -#endif - -#define PRG_RDB(addr) (*(PROGMEM char *)(addr)) - -/* The following definitions are not needed by the driver, but may be of some - * help if you port a gcc based project to IAR. - */ -#define cli() __disable_interrupt() -#define sei() __enable_interrupt() -#define wdt_reset() __watchdog_reset() - -/* Depending on the device you use, you may get problems with the way usbdrv.h - * handles the differences between devices. Since IAR does not use #defines - * for MCU registers, we can't check for the existence of a particular - * register with an #ifdef. If the autodetection mechanism fails, include - * definitions for the required USB_INTR_* macros in your usbconfig.h. See - * usbconfig-prototype.h and usbdrv.h for details. - */ - -#endif /* defined __IAR_SYSTEMS_ICC__ || defined __IAR_SYSTEMS_ASM__ */ -#endif /* __iarcompat_h_INCLUDED__ */ diff --git a/avr/bootloader/usbdrv/oddebug.c b/avr/bootloader/usbdrv/oddebug.c index bd528e2..19bf142 100644 --- a/avr/bootloader/usbdrv/oddebug.c +++ b/avr/bootloader/usbdrv/oddebug.c @@ -4,8 +4,7 @@ * Creation Date: 2005-01-16 * Tabsize: 4 * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * This Revision: $Id: oddebug.c 275 2007-03-20 09:58:28Z cs $ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ #include "oddebug.h" diff --git a/avr/bootloader/usbdrv/oddebug.h b/avr/bootloader/usbdrv/oddebug.h index 1b11ef0..851f84d 100644 --- a/avr/bootloader/usbdrv/oddebug.h +++ b/avr/bootloader/usbdrv/oddebug.h @@ -4,8 +4,7 @@ * Creation Date: 2005-01-16 * Tabsize: 4 * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * This Revision: $Id: oddebug.h 275 2007-03-20 09:58:28Z cs $ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ #ifndef __oddebug_h_included__ @@ -29,10 +28,7 @@ the output and a memory block to dump in hex ('data' and 'len'). #endif /* make sure we have the UART defines: */ -#include "iarcompat.h" -#ifndef __IAR_SYSTEMS_ICC__ -# include -#endif +#include "usbportability.h" #ifndef uchar # define uchar unsigned char diff --git a/avr/bootloader/usbdrv/usbconfig-prototype.h b/avr/bootloader/usbdrv/usbconfig-prototype.h index 242d140..93721c2 100644 --- a/avr/bootloader/usbdrv/usbconfig-prototype.h +++ b/avr/bootloader/usbdrv/usbconfig-prototype.h @@ -1,11 +1,10 @@ /* Name: usbconfig.h - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Christian Starkjohann * Creation Date: 2005-04-01 * Tabsize: 4 * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * This Revision: $Id: usbconfig-prototype.h 600 2008-05-13 10:34:56Z cs $ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ #ifndef __usbconfig_h_included__ @@ -14,7 +13,7 @@ /* General Description: This file is an example configuration (with inline documentation) for the USB -driver. It configures AVR-USB for USB D+ connected to Port D bit 2 (which is +driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may wire the lines to any other port, as long as D+ is also wired to INT0 (or any other hardware interrupt, as long as it is the highest level interrupt, see @@ -44,11 +43,19 @@ section at the end of this file). * markers every millisecond.] */ #define USB_CFG_CLOCK_KHZ (F_CPU/1000) -/* Clock rate of the AVR in MHz. Legal values are 12000, 15000, 16000, 16500 - * and 20000. The 16.5 MHz version of the code requires no crystal, it - * tolerates +/- 1% deviation from the nominal frequency. All other rates - * require a precision of 2000 ppm and thus a crystal! - * Default if not specified: 12 MHz +/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000, + * 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code + * require no crystal, they tolerate +/- 1% deviation from the nominal + * frequency. All other rates require a precision of 2000 ppm and thus a + * crystal! + * Since F_CPU should be defined to your actual clock rate anyway, you should + * not need to modify this setting. + */ +#define USB_CFG_CHECK_CRC 0 +/* Define this to 1 if you want that the driver checks integrity of incoming + * data packets (CRC checks). CRC checks cost quite a bit of code size and are + * currently only available for 18 MHz crystal clock. You must choose + * USB_CFG_CLOCK_KHZ = 18000 if you enable this option. */ /* ----------------------- Optional Hardware Config ------------------------ */ @@ -94,6 +101,14 @@ section at the end of this file). * it is required by the standard. We have made it a config option because it * bloats the code considerably. */ +#define USB_CFG_SUPPRESS_INTR_CODE 0 +/* Define this to 1 if you want to declare interrupt-in endpoints, but don't + * want to send any data over them. If this macro is defined to 1, functions + * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if + * you need the interrupt-in endpoints in order to comply to an interface + * (e.g. HID), but never want to send any data. This option saves a couple + * of bytes in flash memory and the transmit buffers in RAM. + */ #define USB_CFG_INTR_POLL_INTERVAL 10 /* If you compile a version with endpoint 1 (interrupt-in), this is the poll * interval. The value is in milliseconds and must not be less than 10 ms for @@ -130,6 +145,11 @@ section at the end of this file). * of the macros usbDisableAllRequests() and usbEnableAllRequests() in * usbdrv.h. */ +#define USB_CFG_DRIVER_FLASH_PAGE 0 +/* If the device has more than 64 kBytes of flash, define this to the 64 k page + * where the driver's constants (descriptors) are located. Or in other words: + * Define this to 1 for boot loaders on the ATMega128. + */ #define USB_CFG_LONG_TRANSFERS 0 /* Define this to 1 if you want to send/receive blocks of more than 254 bytes * in a single control-in or control-out transfer. Note that the capability @@ -156,28 +176,67 @@ section at the end of this file). * counts SOF packets. This feature requires that the hardware interrupt is * connected to D- instead of D+. */ +/* #ifdef __ASSEMBLER__ + * macro myAssemblerMacro + * in YL, TCNT0 + * sts timer0Snapshot, YL + * endm + * #endif + * #define USB_SOF_HOOK myAssemblerMacro + * This macro (if defined) is executed in the assembler module when a + * Start Of Frame condition is detected. It is recommended to define it to + * the name of an assembler macro which is defined here as well so that more + * than one assembler instruction can be used. The macro may use the register + * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages + * immediately after an SOF pulse may be lost and must be retried by the host. + * What can you do with this hook? Since the SOF signal occurs exactly every + * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in + * designs running on the internal RC oscillator. + * Please note that Start Of Frame detection works only if D- is wired to the + * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES! + */ +#define USB_CFG_CHECK_DATA_TOGGLING 0 +/* define this macro to 1 if you want to filter out duplicate data packets + * sent by the host. Duplicates occur only as a consequence of communication + * errors, when the host does not receive an ACK. Please note that you need to + * implement the filtering yourself in usbFunctionWriteOut() and + * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable + * for each control- and out-endpoint to check for duplicate packets. + */ #define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0 /* define this macro to 1 if you want the function usbMeasureFrameLength() * compiled in. This function can be used to calibrate the AVR's RC oscillator. */ +#define USB_USE_FAST_CRC 0 +/* The assembler module has two implementations for the CRC algorithm. One is + * faster, the other is smaller. This CRC routine is only used for transmitted + * messages where timing is not critical. The faster routine needs 31 cycles + * per byte while the smaller one needs 61 to 69 cycles. The faster routine + * may be worth the 32 bytes bigger code size if you transmit lots of data and + * run the AVR close to its limit. + */ /* -------------------------- Device Description --------------------------- */ -#define USB_CFG_VENDOR_ID 0xc0, 0x16 +#define USB_CFG_VENDOR_ID 0xc0, 0x16 /* = 0x16c0 = 5824 = voti.nl */ /* USB vendor ID for the device, low byte first. If you have registered your - * own Vendor ID, define it here. Otherwise you use one of obdev's free shared - * VID/PID pairs. Be sure to read USBID-License.txt for rules! - * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc. - * + Use this VID/PID pair ONLY if you understand the implications! + * own Vendor ID, define it here. Otherwise you may use one of obdev's free + * shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules! + * *** IMPORTANT NOTE *** + * This template uses obdev's shared VID/PID pair for Vendor Class devices + * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand + * the implications! */ -#define USB_CFG_DEVICE_ID 0xdc, 0x05 +#define USB_CFG_DEVICE_ID 0xdc, 0x05 /* = 0x05dc = 1500 */ /* This is the ID of the product, low byte first. It is interpreted in the * scope of the vendor ID. If you have registered your own VID with usb.org * or if you have licensed a PID from somebody else, define it here. Otherwise - * you use obdev's free shared VID/PID pair. Be sure to read the rules in - * USBID-License.txt! - * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc. - * + Use this VID/PID pair ONLY if you understand the implications! + * you may use one of obdev's free shared VID/PID pairs. See the file + * USB-IDs-for-free.txt for details! + * *** IMPORTANT NOTE *** + * This template uses obdev's shared VID/PID pair for Vendor Class devices + * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand + * the implications! */ #define USB_CFG_DEVICE_VERSION 0x00, 0x01 /* Version number of the device: Minor number first, then major number. @@ -189,14 +248,14 @@ section at the end of this file). * are interpreted as Unicode (UTF-16) entities. * If you don't want a vendor name string, undefine these macros. * ALWAYS define a vendor name containing your Internet domain name if you use - * obdev's free shared VID/PID pair. See the file USBID-License.txt for + * obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for * details. */ #define USB_CFG_DEVICE_NAME 'T', 'e', 'm', 'p', 'l', 'a', 't', 'e' #define USB_CFG_DEVICE_NAME_LEN 8 /* Same as above for the device name. If you don't want a device name, undefine - * the macros. See the file USBID-License.txt before you assign a name if you - * use a shared VID/PID. + * the macros. See the file USB-IDs-for-free.txt before you assign a name if + * you use a shared VID/PID. */ /*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */ /*#define USB_CFG_SERIAL_NUMBER_LEN 0 */ @@ -243,7 +302,9 @@ section at the end of this file). * no properties are defined or if they are 0, the default descriptor is used. * Possible properties are: * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched - * at runtime via usbFunctionDescriptor(). + * at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is + * used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if + * you want RAM pointers. * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found * in static memory is in RAM, not in flash memory. * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash), @@ -275,6 +336,12 @@ section at the end of this file). * USB_CFG_DESCR_PROPS_HID_REPORT * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver) * + * Note about string descriptors: String descriptors are not just strings, they + * are Unicode strings prefixed with a 2 byte header. Example: + * int serialNumberDescriptor[] = { + * USB_STRING_DESCRIPTOR_HEADER(6), + * 'S', 'e', 'r', 'i', 'a', 'l' + * }; */ #define USB_CFG_DESCR_PROPS_DEVICE 0 @@ -288,6 +355,15 @@ section at the end of this file). #define USB_CFG_DESCR_PROPS_HID_REPORT 0 #define USB_CFG_DESCR_PROPS_UNKNOWN 0 + +#define usbMsgPtr_t unsigned short +/* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We define it to + * a scalar type here because gcc generates slightly shorter code for scalar + * arithmetics than for pointer arithmetics. Remove this define for backward + * type compatibility or define it to an 8 bit type if you use data in RAM only + * and all RAM is below 256 bytes (tiny memory model in IAR CC). + */ + /* ----------------------- Optional MCU Description ------------------------ */ /* The following configurations have working defaults in usbdrv.h. You @@ -303,6 +379,6 @@ section at the end of this file). /* #define USB_INTR_ENABLE_BIT INT0 */ /* #define USB_INTR_PENDING GIFR */ /* #define USB_INTR_PENDING_BIT INTF0 */ -/* #define USB_INTR_VECTOR SIG_INTERRUPT0 */ +/* #define USB_INTR_VECTOR INT0_vect */ #endif /* __usbconfig_h_included__ */ diff --git a/avr/bootloader/usbdrv/usbdrv.c b/avr/bootloader/usbdrv/usbdrv.c index a1ca892..d838935 100644 --- a/avr/bootloader/usbdrv/usbdrv.c +++ b/avr/bootloader/usbdrv/usbdrv.c @@ -1,18 +1,12 @@ /* Name: usbdrv.c - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Christian Starkjohann * Creation Date: 2004-12-29 * Tabsize: 4 * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * This Revision: $Id: usbdrv.c 591 2008-05-03 20:21:19Z cs $ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ -#include "iarcompat.h" -#ifndef __IAR_SYSTEMS_ICC__ -# include -# include -#endif #include "usbdrv.h" #include "oddebug.h" @@ -38,15 +32,18 @@ uchar usbTxBuf[USB_BUFSIZE];/* data to transmit with next IN, free if usbT #if USB_COUNT_SOF volatile uchar usbSofCount; /* incremented by assembler module every SOF */ #endif -#if USB_CFG_HAVE_INTRIN_ENDPOINT +#if USB_CFG_HAVE_INTRIN_ENDPOINT && !USB_CFG_SUPPRESS_INTR_CODE usbTxStatus_t usbTxStatus1; # if USB_CFG_HAVE_INTRIN_ENDPOINT3 usbTxStatus_t usbTxStatus3; # endif #endif +#if USB_CFG_CHECK_DATA_TOGGLING +uchar usbCurrentDataToken;/* when we check data toggling to ignore duplicate packets */ +#endif /* USB status registers / not shared with asm code */ -uchar *usbMsgPtr; /* data to transmit next -- ROM or RAM address */ +usbMsgPtr_t usbMsgPtr; /* data to transmit next -- ROM or RAM address */ static usbMsgLen_t usbMsgLen = USB_NO_MSG; /* remaining number of bytes */ static uchar usbMsgFlags; /* flag values see below */ @@ -56,7 +53,7 @@ static uchar usbMsgFlags; /* flag values see below */ /* optimizing hints: - do not post/pre inc/dec integer values in operations -- assign value of PRG_RDB() to register variables and don't use side effects in arg +- assign value of USB_READ_FLASH() to register variables and don't use side effects in arg - use narrow scope for variables which should be in X/Y/Z register - assign char sized expressions to variables to force 8 bit arithmetics */ @@ -68,7 +65,7 @@ optimizing hints: #if USB_CFG_DESCR_PROPS_STRING_0 == 0 #undef USB_CFG_DESCR_PROPS_STRING_0 #define USB_CFG_DESCR_PROPS_STRING_0 sizeof(usbDescriptorString0) -PROGMEM char usbDescriptorString0[] = { /* language descriptor */ +PROGMEM const char usbDescriptorString0[] = { /* language descriptor */ 4, /* sizeof(usbDescriptorString0): length of descriptor in bytes */ 3, /* descriptor type */ 0x09, 0x04, /* language index (0x0409 = US-English) */ @@ -78,7 +75,7 @@ PROGMEM char usbDescriptorString0[] = { /* language descriptor */ #if USB_CFG_DESCR_PROPS_STRING_VENDOR == 0 && USB_CFG_VENDOR_NAME_LEN #undef USB_CFG_DESCR_PROPS_STRING_VENDOR #define USB_CFG_DESCR_PROPS_STRING_VENDOR sizeof(usbDescriptorStringVendor) -PROGMEM int usbDescriptorStringVendor[] = { +PROGMEM const int usbDescriptorStringVendor[] = { USB_STRING_DESCRIPTOR_HEADER(USB_CFG_VENDOR_NAME_LEN), USB_CFG_VENDOR_NAME }; @@ -87,7 +84,7 @@ PROGMEM int usbDescriptorStringVendor[] = { #if USB_CFG_DESCR_PROPS_STRING_PRODUCT == 0 && USB_CFG_DEVICE_NAME_LEN #undef USB_CFG_DESCR_PROPS_STRING_PRODUCT #define USB_CFG_DESCR_PROPS_STRING_PRODUCT sizeof(usbDescriptorStringDevice) -PROGMEM int usbDescriptorStringDevice[] = { +PROGMEM const int usbDescriptorStringDevice[] = { USB_STRING_DESCRIPTOR_HEADER(USB_CFG_DEVICE_NAME_LEN), USB_CFG_DEVICE_NAME }; @@ -96,7 +93,7 @@ PROGMEM int usbDescriptorStringDevice[] = { #if USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER == 0 && USB_CFG_SERIAL_NUMBER_LEN #undef USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER #define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER sizeof(usbDescriptorStringSerialNumber) -PROGMEM int usbDescriptorStringSerialNumber[] = { +PROGMEM const int usbDescriptorStringSerialNumber[] = { USB_STRING_DESCRIPTOR_HEADER(USB_CFG_SERIAL_NUMBER_LEN), USB_CFG_SERIAL_NUMBER }; @@ -109,7 +106,7 @@ PROGMEM int usbDescriptorStringSerialNumber[] = { #if USB_CFG_DESCR_PROPS_DEVICE == 0 #undef USB_CFG_DESCR_PROPS_DEVICE #define USB_CFG_DESCR_PROPS_DEVICE sizeof(usbDescriptorDevice) -PROGMEM char usbDescriptorDevice[] = { /* USB device descriptor */ +PROGMEM const char usbDescriptorDevice[] = { /* USB device descriptor */ 18, /* sizeof(usbDescriptorDevice): length of descriptor in bytes */ USBDESCR_DEVICE, /* descriptor type */ 0x10, 0x01, /* USB version supported */ @@ -140,7 +137,7 @@ PROGMEM char usbDescriptorDevice[] = { /* USB device descriptor */ #if USB_CFG_DESCR_PROPS_CONFIGURATION == 0 #undef USB_CFG_DESCR_PROPS_CONFIGURATION #define USB_CFG_DESCR_PROPS_CONFIGURATION sizeof(usbDescriptorConfiguration) -PROGMEM char usbDescriptorConfiguration[] = { /* USB configuration descriptor */ +PROGMEM const char usbDescriptorConfiguration[] = { /* USB configuration descriptor */ 9, /* sizeof(usbDescriptorConfiguration): length of descriptor in bytes */ USBDESCR_CONFIG, /* descriptor type */ 18 + 7 * USB_CFG_HAVE_INTRIN_ENDPOINT + 7 * USB_CFG_HAVE_INTRIN_ENDPOINT3 + @@ -150,9 +147,9 @@ PROGMEM char usbDescriptorConfiguration[] = { /* USB configuration descriptor 1, /* index of this configuration */ 0, /* configuration name string index */ #if USB_CFG_IS_SELF_POWERED - USBATTR_SELFPOWER, /* attributes */ + (1 << 7) | USBATTR_SELFPOWER, /* attributes */ #else - (char)USBATTR_BUSPOWER, /* attributes */ + (1 << 7), /* attributes */ #endif USB_CFG_MAX_BUS_POWER/2, /* max USB current in 2mA units */ /* interface descriptor follows inline: */ @@ -185,7 +182,7 @@ PROGMEM char usbDescriptorConfiguration[] = { /* USB configuration descriptor #if USB_CFG_HAVE_INTRIN_ENDPOINT3 /* endpoint descriptor for endpoint 3 */ 7, /* sizeof(usbDescrEndpoint) */ USBDESCR_ENDPOINT, /* descriptor type = endpoint */ - (char)0x83, /* IN endpoint number 1 */ + (char)(0x80 | USB_CFG_EP3_NUMBER), /* IN endpoint number 3 */ 0x03, /* attrib: Interrupt endpoint */ 8, 0, /* maximum packet size */ USB_CFG_INTR_POLL_INTERVAL, /* in ms */ @@ -195,18 +192,9 @@ PROGMEM char usbDescriptorConfiguration[] = { /* USB configuration descriptor /* ------------------------------------------------------------------------- */ -/* We don't use prog_int or prog_int16_t for compatibility with various libc - * versions. Here's an other compatibility hack: - */ -#ifndef PRG_RDB -#define PRG_RDB(addr) pgm_read_byte(addr) -#endif - -/* ------------------------------------------------------------------------- */ - static inline void usbResetDataToggling(void) { -#if USB_CFG_HAVE_INTRIN_ENDPOINT +#if USB_CFG_HAVE_INTRIN_ENDPOINT && !USB_CFG_SUPPRESS_INTR_CODE USB_SET_DATATOKEN1(USB_INITIAL_DATATOKEN); /* reset data toggling for interrupt endpoint */ # if USB_CFG_HAVE_INTRIN_ENDPOINT3 USB_SET_DATATOKEN3(USB_INITIAL_DATATOKEN); /* reset data toggling for interrupt endpoint */ @@ -226,6 +214,7 @@ static inline void usbResetStall(void) /* ------------------------------------------------------------------------- */ +#if !USB_CFG_SUPPRESS_INTR_CODE #if USB_CFG_HAVE_INTRIN_ENDPOINT static void usbGenericSetInterrupt(uchar *data, uchar len, usbTxStatus_t *txStatus) { @@ -263,6 +252,7 @@ USB_PUBLIC void usbSetInterrupt3(uchar *data, uchar len) usbGenericSetInterrupt(data, len, &usbTxStatus3); } #endif +#endif /* USB_CFG_SUPPRESS_INTR_CODE */ /* ------------------ utilities for code following below ------------------- */ @@ -309,7 +299,7 @@ USB_PUBLIC void usbSetInterrupt3(uchar *data, uchar len) len = usbFunctionDescriptor(rq); \ }else{ \ len = USB_PROP_LENGTH(cfgProp); \ - usbMsgPtr = (uchar *)(staticName); \ + usbMsgPtr = (usbMsgPtr_t)(staticName); \ } \ } @@ -369,7 +359,8 @@ uchar flags = USB_FLG_MSGPTR_IS_ROM; */ static inline usbMsgLen_t usbDriverSetup(usbRequest_t *rq) { -uchar len = 0, *dataPtr = usbTxBuf + 9; /* there are 2 bytes free space at the end of the buffer */ +usbMsgLen_t len = 0; +uchar *dataPtr = usbTxBuf + 9; /* there are 2 bytes free space at the end of the buffer */ uchar value = rq->wValue.bytes[0]; #if USB_CFG_IMPLEMENT_HALT uchar index = rq->wIndex.bytes[0]; @@ -408,7 +399,7 @@ uchar index = rq->wIndex.bytes[0]; usbResetStall(); SWITCH_CASE(USBRQ_GET_INTERFACE) /* 10 */ len = 1; -#if USB_CFG_HAVE_INTRIN_ENDPOINT +#if USB_CFG_HAVE_INTRIN_ENDPOINT && !USB_CFG_SUPPRESS_INTR_CODE SWITCH_CASE(USBRQ_SET_INTERFACE) /* 11 */ usbResetDataToggling(); usbResetStall(); @@ -416,7 +407,7 @@ uchar index = rq->wIndex.bytes[0]; SWITCH_DEFAULT /* 7=SET_DESCRIPTOR, 12=SYNC_FRAME */ /* Should we add an optional hook here? */ SWITCH_END - usbMsgPtr = dataPtr; + usbMsgPtr = (usbMsgPtr_t)dataPtr; skipMsgPtrAssignment: return len; } @@ -436,7 +427,7 @@ usbRequest_t *rq = (void *)data; * 0xe1 11100001 (USBPID_OUT: data phase of setup transfer) * 0...0x0f for OUT on endpoint X */ - DBG2(0x10 + (usbRxToken & 0xf), data, len); /* SETUP=1d, SETUP-DATA=11, OUTx=1x */ + DBG2(0x10 + (usbRxToken & 0xf), data, len + 2); /* SETUP=1d, SETUP-DATA=11, OUTx=1x */ USB_RX_USER_HOOK(data, len) #if USB_CFG_IMPLEMENT_FN_WRITEOUT if(usbRxToken < 0x10){ /* OUT to endpoint != 0: endpoint number in usbRxToken */ @@ -459,9 +450,13 @@ usbRequest_t *rq = (void *)data; } #if USB_CFG_IMPLEMENT_FN_READ || USB_CFG_IMPLEMENT_FN_WRITE if(replyLen == USB_NO_MSG){ /* use user-supplied read/write function */ - /* do some conditioning on replyLen */ + /* do some conditioning on replyLen, but on IN transfers only */ if((rq->bmRequestType & USBRQ_DIR_MASK) != USBRQ_DIR_HOST_TO_DEVICE){ - replyLen = rq->wLength.bytes[0]; /* IN transfers only */ + if(sizeof(replyLen) < sizeof(rq->wLength.word)){ /* help compiler with optimizing */ + replyLen = rq->wLength.bytes[0]; + }else{ + replyLen = rq->wLength.word; + } } usbMsgFlags = USB_FLG_USE_USER_RW; }else /* The 'else' prevents that we limit a replyLen of USB_NO_MSG to the maximum transfer len. */ @@ -502,16 +497,18 @@ static uchar usbDeviceRead(uchar *data, uchar len) }else #endif { - uchar i = len, *r = usbMsgPtr; + uchar i = len; + usbMsgPtr_t r = usbMsgPtr; if(usbMsgFlags & USB_FLG_MSGPTR_IS_ROM){ /* ROM data */ do{ - uchar c = PRG_RDB(r); /* assign to char size variable to enforce byte ops */ + uchar c = USB_READ_FLASH(r); /* assign to char size variable to enforce byte ops */ *data++ = c; r++; }while(--i); }else{ /* RAM data */ do{ - *data++ = *r++; + *data++ = *((uchar *)r); + r++; }while(--i); } usbMsgPtr = r; @@ -561,6 +558,8 @@ uchar isReset = !notResetState; USB_RESET_HOOK(isReset); wasReset = isReset; } +#else + notResetState = notResetState; // avoid compiler warning #endif } @@ -592,17 +591,17 @@ uchar i; usbBuildTxBlock(); } } - for(i = 10; i > 0; i--){ + for(i = 20; i > 0; i--){ uchar usbLineStatus = USBIN & USBMASK; if(usbLineStatus != 0) /* SE0 has ended */ - break; - } - if(i == 0){ /* RESET condition, called multiple times during reset */ - usbNewDeviceAddr = 0; - usbDeviceAddr = 0; - usbResetStall(); - DBG1(0xff, 0, 0); + goto isNotReset; } + /* RESET condition, called multiple times during reset */ + usbNewDeviceAddr = 0; + usbDeviceAddr = 0; + usbResetStall(); + DBG1(0xff, 0, 0); +isNotReset: usbHandleResetHook(i); } @@ -618,7 +617,7 @@ USB_PUBLIC void usbInit(void) #endif USB_INTR_ENABLE |= (1 << USB_INTR_ENABLE_BIT); usbResetDataToggling(); -#if USB_CFG_HAVE_INTRIN_ENDPOINT +#if USB_CFG_HAVE_INTRIN_ENDPOINT && !USB_CFG_SUPPRESS_INTR_CODE usbTxLen1 = USBPID_NAK; #if USB_CFG_HAVE_INTRIN_ENDPOINT3 usbTxLen3 = USBPID_NAK; diff --git a/avr/bootloader/usbdrv/usbdrv.h b/avr/bootloader/usbdrv/usbdrv.h index ca7392f..3fe84d5 100644 --- a/avr/bootloader/usbdrv/usbdrv.h +++ b/avr/bootloader/usbdrv/usbdrv.h @@ -1,17 +1,16 @@ /* Name: usbdrv.h - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Christian Starkjohann * Creation Date: 2004-12-29 * Tabsize: 4 * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * This Revision: $Id: usbdrv.h 607 2008-05-13 15:57:28Z cs $ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ #ifndef __usbdrv_h_included__ #define __usbdrv_h_included__ #include "usbconfig.h" -#include "iarcompat.h" +#include "usbportability.h" /* Hardware Prerequisites: @@ -34,8 +33,8 @@ usbDeviceConnect() and usbDeviceDisconnect() further down in this file. Please adapt the values in usbconfig.h according to your hardware! -The device MUST be clocked at exactly 12 MHz, 15 MHz or 16 MHz -or at 16.5 MHz +/- 1%. See usbconfig-prototype.h for details. +The device MUST be clocked at exactly 12 MHz, 15 MHz, 16 MHz or 20 MHz +or at 12.8 MHz resp. 16.5 MHz +/- 1%. See usbconfig-prototype.h for details. Limitations: @@ -105,9 +104,9 @@ interrupt routine. Interrupt latency: The application must ensure that the USB interrupt is not disabled for more than 25 cycles (this is for 12 MHz, faster clocks allow longer latency). -This implies that all interrupt routines must either be declared as "INTERRUPT" -instead of "SIGNAL" (see "avr/signal.h") or that they are written in assembler -with "sei" as the first instruction. +This implies that all interrupt routines must either have the "ISR_NOBLOCK" +attribute set (see "avr/interrupt.h") or be written in assembler with "sei" +as the first instruction. Maximum interrupt duration / CPU cycle consumption: The driver handles all USB communication during the interrupt service @@ -122,7 +121,7 @@ USB messages, even if they address another (low-speed) device on the same bus. /* --------------------------- Module Interface ---------------------------- */ /* ------------------------------------------------------------------------- */ -#define USBDRV_VERSION 20080513 +#define USBDRV_VERSION 20121206 /* This define uniquely identifies a driver version. It is a decimal number * constructed from the driver's release date in the form YYYYMMDD. If the * driver's behavior or interface changes, you can use this constant to @@ -163,11 +162,24 @@ USB messages, even if they address another (low-speed) device on the same bus. */ #define USB_NO_MSG ((usbMsgLen_t)-1) /* constant meaning "no message" */ +#ifndef usbMsgPtr_t +#define usbMsgPtr_t uchar * +#endif +/* Making usbMsgPtr_t a define allows the user of this library to define it to + * an 8 bit type on tiny devices. This reduces code size, especially if the + * compiler supports a tiny memory model. + * The type can be a pointer or scalar type, casts are made where necessary. + * Although it's paradoxical, Gcc 4 generates slightly better code for scalar + * types than for pointers. + */ + struct usbRequest; /* forward declaration */ USB_PUBLIC void usbInit(void); /* This function must be called before interrupts are enabled and the main - * loop is entered. + * loop is entered. We exepct that the PORT and DDR bits for D+ and D- have + * not been changed from their default status (which is 0). If you have changed + * them, set both back to 0 (configure them as input with no internal pull-up). */ USB_PUBLIC void usbPoll(void); /* This function must be called at regular intervals from the main loop. @@ -176,7 +188,7 @@ USB_PUBLIC void usbPoll(void); * Please note that debug outputs through the UART take ~ 0.5ms per byte * at 19200 bps. */ -extern uchar *usbMsgPtr; +extern usbMsgPtr_t usbMsgPtr; /* This variable may be used to pass transmit data to the driver from the * implementation of usbFunctionWrite(). It is also used internally by the * driver for standard control requests. @@ -273,6 +285,8 @@ USB_PUBLIC uchar usbFunctionRead(uchar *data, uchar len); * to 1 in usbconfig.h and return 0xff in usbFunctionSetup().. */ #endif /* USB_CFG_IMPLEMENT_FN_READ */ + +extern uchar usbRxToken; /* may be used in usbFunctionWriteOut() below */ #if USB_CFG_IMPLEMENT_FN_WRITEOUT USB_PUBLIC void usbFunctionWriteOut(uchar *data, uchar len); /* This function is called by the driver when data is received on an interrupt- @@ -339,6 +353,12 @@ extern volatile uchar usbSofCount; * the macro USB_COUNT_SOF is defined to a value != 0. */ #endif +#if USB_CFG_CHECK_DATA_TOGGLING +extern uchar usbCurrentDataToken; +/* This variable can be checked in usbFunctionWrite() and usbFunctionWriteOut() + * to ignore duplicate packets. + */ +#endif #define USB_STRING_DESCRIPTOR_HEADER(stringLength) ((2*(stringLength)+2) | (3<<8)) /* This macro builds a descriptor header for a string descriptor given the @@ -380,11 +400,13 @@ extern volatile schar usbRxLen; * about the various methods to define USB descriptors. If you do nothing, * the default descriptors will be used. */ -#define USB_PROP_IS_DYNAMIC (1 << 14) +#define USB_PROP_IS_DYNAMIC (1u << 14) /* If this property is set for a descriptor, usbFunctionDescriptor() will be - * used to obtain the particular descriptor. + * used to obtain the particular descriptor. Data directly returned via + * usbMsgPtr are FLASH data by default, combine (OR) with USB_PROP_IS_RAM to + * return RAM data. */ -#define USB_PROP_IS_RAM (1 << 15) +#define USB_PROP_IS_RAM (1u << 15) /* If this property is set for a descriptor, the data is read from RAM * memory instead of Flash. The property is used for all methods to provide * external descriptors. @@ -438,43 +460,43 @@ extern volatile schar usbRxLen; #ifndef __ASSEMBLER__ extern #if !(USB_CFG_DESCR_PROPS_DEVICE & USB_PROP_IS_RAM) -PROGMEM +PROGMEM const #endif char usbDescriptorDevice[]; extern #if !(USB_CFG_DESCR_PROPS_CONFIGURATION & USB_PROP_IS_RAM) -PROGMEM +PROGMEM const #endif char usbDescriptorConfiguration[]; extern #if !(USB_CFG_DESCR_PROPS_HID_REPORT & USB_PROP_IS_RAM) -PROGMEM +PROGMEM const #endif char usbDescriptorHidReport[]; extern #if !(USB_CFG_DESCR_PROPS_STRING_0 & USB_PROP_IS_RAM) -PROGMEM +PROGMEM const #endif char usbDescriptorString0[]; extern #if !(USB_CFG_DESCR_PROPS_STRING_VENDOR & USB_PROP_IS_RAM) -PROGMEM +PROGMEM const #endif int usbDescriptorStringVendor[]; extern #if !(USB_CFG_DESCR_PROPS_STRING_PRODUCT & USB_PROP_IS_RAM) -PROGMEM +PROGMEM const #endif int usbDescriptorStringDevice[]; extern #if !(USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER & USB_PROP_IS_RAM) -PROGMEM +PROGMEM const #endif int usbDescriptorStringSerialNumber[]; @@ -501,22 +523,22 @@ int usbDescriptorStringSerialNumber[]; #if !defined __ASSEMBLER__ && (!defined USB_CFG_VENDOR_ID || !defined USB_CFG_DEVICE_ID) #warning "You should define USB_CFG_VENDOR_ID and USB_CFG_DEVICE_ID in usbconfig.h" /* If the user has not defined IDs, we default to obdev's free IDs. - * See USBID-License.txt for details. + * See USB-IDs-for-free.txt for details. */ #endif /* make sure we have a VID and PID defined, byte order is lowbyte, highbyte */ #ifndef USB_CFG_VENDOR_ID -# define USB_CFG_VENDOR_ID 0xc0, 0x16 /* 5824 in dec, stands for VOTI */ +# define USB_CFG_VENDOR_ID 0xc0, 0x16 /* = 0x16c0 = 5824 = voti.nl */ #endif #ifndef USB_CFG_DEVICE_ID # if USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH -# define USB_CFG_DEVICE_ID 0xdf, 0x05 /* 1503 in dec, shared PID for HIDs */ +# define USB_CFG_DEVICE_ID 0xdf, 0x05 /* = 0x5df = 1503, shared PID for HIDs */ # elif USB_CFG_INTERFACE_CLASS == 2 -# define USB_CFG_DEVICE_ID 0xe1, 0x05 /* 1505 in dec, shared PID for CDC Modems */ +# define USB_CFG_DEVICE_ID 0xe1, 0x05 /* = 0x5e1 = 1505, shared PID for CDC Modems */ # else -# define USB_CFG_DEVICE_ID 0xdc, 0x05 /* 1500 in dec, obdev's free PID */ +# define USB_CFG_DEVICE_ID 0xdc, 0x05 /* = 0x5dc = 1500, obdev's free PID */ # endif #endif @@ -546,6 +568,10 @@ int usbDescriptorStringSerialNumber[]; #define USB_CFG_EP3_NUMBER 3 #endif +#ifndef USB_CFG_HAVE_INTRIN_ENDPOINT3 +#define USB_CFG_HAVE_INTRIN_ENDPOINT3 0 +#endif + #define USB_BUFSIZE 11 /* PID, 8 bytes data, 2 bytes CRC */ /* ----- Try to find registers and bits responsible for ext interrupt 0 ----- */ @@ -558,7 +584,14 @@ int usbDescriptorStringSerialNumber[]; # endif #endif #ifndef USB_INTR_CFG_SET /* allow user to override our default */ -# define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) /* cfg for rising edge */ +# if defined(USB_COUNT_SOF) || defined(USB_SOF_HOOK) +# define USB_INTR_CFG_SET (1 << ISC01) /* cfg for falling edge */ + /* If any SOF logic is used, the interrupt must be wired to D- where + * we better trigger on falling edge + */ +# else +# define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) /* cfg for rising edge */ +# endif #endif #ifndef USB_INTR_CFG_CLR /* allow user to override our default */ # define USB_INTR_CFG_CLR 0 /* no bits to clear */ @@ -695,7 +728,8 @@ typedef struct usbRequest{ #define USBDESCR_HID_REPORT 0x22 #define USBDESCR_HID_PHYS 0x23 -#define USBATTR_BUSPOWER 0x80 +//#define USBATTR_BUSPOWER 0x80 // USB 1.1 does not define this value any more +#define USBATTR_BUSPOWER 0 #define USBATTR_SELFPOWER 0x40 #define USBATTR_REMOTEWAKE 0x20 diff --git a/avr/bootloader/usbdrv/usbdrvasm.S b/avr/bootloader/usbdrv/usbdrvasm.S index 2c06421..32ce8ef 100644 --- a/avr/bootloader/usbdrv/usbdrvasm.S +++ b/avr/bootloader/usbdrv/usbdrvasm.S @@ -1,11 +1,10 @@ /* Name: usbdrvasm.S - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Christian Starkjohann * Creation Date: 2007-06-13 * Tabsize: 4 * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * Revision: $Id$ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ /* @@ -15,16 +14,9 @@ general code (preprocessor acrobatics and CRC computation) and then includes the file appropriate for the given clock rate. */ -#include "iarcompat.h" -#ifndef __IAR_SYSTEMS_ASM__ - /* configs for io.h */ -# define __SFR_OFFSET 0 -# define _VECTOR(N) __vector_ ## N /* io.h does not define this for asm */ -# include /* for CPU I/O register definitions and vectors */ -# define macro .macro /* GNU Assembler macro definition */ -# define endm .endm /* End of GNU Assembler macro definition */ -#endif /* __IAR_SYSTEMS_ASM__ */ -#include "usbdrv.h" /* for common defs */ +#define __SFR_OFFSET 0 /* used by avr-libc's register definitions */ +#include "usbportability.h" +#include "usbdrv.h" /* for common defs */ /* register names */ #define x1 r16 @@ -33,24 +25,14 @@ the file appropriate for the given clock rate. #define cnt r19 #define x3 r20 #define x4 r21 -#define bitcnt r22 +#define x5 r22 +#define bitcnt x5 #define phase x4 #define leap x4 /* Some assembler dependent definitions and declarations: */ #ifdef __IAR_SYSTEMS_ASM__ - -# define nop2 rjmp $+2 /* jump to next instruction */ -# define XL r26 -# define XH r27 -# define YL r28 -# define YH r29 -# define ZL r30 -# define ZH r31 -# define lo8(x) LOW(x) -# define hi8(x) (((x)>>8) & 0xff) /* not HIGH to allow XLINK to make a proper range check */ - extern usbRxBuf, usbDeviceAddr, usbNewDeviceAddr, usbInputBufOffset extern usbCurrentTok, usbRxLen, usbRxToken, usbTxLen extern usbTxBuf, usbTxStatus1, usbTxStatus3 @@ -73,10 +55,12 @@ the file appropriate for the given clock rate. #else /* __IAR_SYSTEMS_ASM__ */ -# define nop2 rjmp .+0 /* jump to next instruction */ - # ifndef USB_INTR_VECTOR /* default to hardware interrupt INT0 */ -# define USB_INTR_VECTOR SIG_INTERRUPT0 +# ifdef INT0_vect +# define USB_INTR_VECTOR INT0_vect // this is the "new" define for the vector +# else +# define USB_INTR_VECTOR SIG_INTERRUPT0 // this is the "old" vector +# endif # endif .text .global USB_INTR_VECTOR @@ -158,16 +142,93 @@ RTMODEL "__rt_version", "3" #endif -; extern unsigned usbCrc16(unsigned char *data, unsigned char len); -; data: r24/25 -; len: r22 +#if USB_USE_FAST_CRC + +; This implementation is faster, but has bigger code size +; Thanks to Slawomir Fras (BoskiDialer) for this code! +; It implements the following C pseudo-code: +; unsigned table(unsigned char x) +; { +; unsigned value; +; +; value = (unsigned)x << 6; +; value ^= (unsigned)x << 7; +; if(parity(x)) +; value ^= 0xc001; +; return value; +; } +; unsigned usbCrc16(unsigned char *argPtr, unsigned char argLen) +; { +; unsigned crc = 0xffff; +; +; while(argLen--) +; crc = table(lo8(crc) ^ *argPtr++) ^ hi8(crc); +; return ~crc; +; } + +; extern unsigned usbCrc16(unsigned char *argPtr, unsigned char argLen); +; argPtr r24+25 / r16+r17 +; argLen r22 / r18 ; temp variables: -; r18: data byte -; r19: bit counter -; r20/21: polynomial -; r23: scratch -; r24/25: crc-sum -; r26/27=X: ptr +; byte r18 / r22 +; scratch r23 +; resCrc r24+r25 / r16+r17 +; ptr X / Z +usbCrc16: + mov ptrL, argPtrL + mov ptrH, argPtrH + ldi resCrcL, 0xFF + ldi resCrcH, 0xFF + rjmp usbCrc16LoopTest +usbCrc16ByteLoop: + ld byte, ptr+ + eor resCrcL, byte ; resCrcL is now 'x' in table() + mov byte, resCrcL ; compute parity of 'x' + swap byte + eor byte, resCrcL + mov scratch, byte + lsr byte + lsr byte + eor byte, scratch + inc byte + lsr byte + andi byte, 1 ; byte is now parity(x) + mov scratch, resCrcL + mov resCrcL, resCrcH + eor resCrcL, byte ; low byte of if(parity(x)) value ^= 0xc001; + neg byte + andi byte, 0xc0 + mov resCrcH, byte ; high byte of if(parity(x)) value ^= 0xc001; + clr byte + lsr scratch + ror byte + eor resCrcH, scratch + eor resCrcL, byte + lsr scratch + ror byte + eor resCrcH, scratch + eor resCrcL, byte +usbCrc16LoopTest: + subi argLen, 1 + brsh usbCrc16ByteLoop + com resCrcL + com resCrcH + ret + +#else /* USB_USE_FAST_CRC */ + +; This implementation is slower, but has less code size +; +; extern unsigned usbCrc16(unsigned char *argPtr, unsigned char argLen); +; argPtr r24+25 / r16+r17 +; argLen r22 / r18 +; temp variables: +; byte r18 / r22 +; bitCnt r19 +; poly r20+r21 +; scratch r23 +; resCrc r24+r25 / r16+r17 +; ptr X / Z usbCrc16: mov ptrL, argPtrL mov ptrH, argPtrH @@ -175,27 +236,30 @@ usbCrc16: ldi resCrcH, 0 ldi polyL, lo8(0xa001) ldi polyH, hi8(0xa001) - com argLen ; argLen = -argLen - 1 -crcByteLoop: - subi argLen, -1 - brcc crcReady ; modified loop to ensure that carry is set below + com argLen ; argLen = -argLen - 1: modified loop to ensure that carry is set + ldi bitCnt, 0 ; loop counter with starnd condition = end condition + rjmp usbCrcLoopEntry +usbCrcByteLoop: ld byte, ptr+ - ldi bitCnt, -8 ; strange loop counter to ensure that carry is set where we need it eor resCrcL, byte -crcBitLoop: - ror resCrcH ; carry is always set here +usbCrcBitLoop: + ror resCrcH ; carry is always set here (see brcs jumps to here) ror resCrcL - brcs crcNoXor + brcs usbCrcNoXor eor resCrcL, polyL eor resCrcH, polyH -crcNoXor: - subi bitCnt, -1 - brcs crcBitLoop - rjmp crcByteLoop -crcReady: +usbCrcNoXor: + subi bitCnt, 224 ; (8 * 224) % 256 = 0; this loop iterates 8 times + brcs usbCrcBitLoop +usbCrcLoopEntry: + subi argLen, -1 + brcs usbCrcByteLoop +usbCrcReady: ret ; Thanks to Reimar Doeffinger for optimizing this CRC routine! +#endif /* USB_USE_FAST_CRC */ + ; extern unsigned usbCrc16Append(unsigned char *data, unsigned char len); usbCrc16Append: rcall usbCrc16 @@ -296,19 +360,33 @@ usbMFTimeout: ;---------------------------------------------------------------------------- #ifndef USB_CFG_CLOCK_KHZ -# define USB_CFG_CLOCK_KHZ 12000 +# ifdef F_CPU +# define USB_CFG_CLOCK_KHZ (F_CPU/1000) +# else +# error "USB_CFG_CLOCK_KHZ not defined in usbconfig.h and no F_CPU set!" +# endif #endif -#if USB_CFG_CLOCK_KHZ == 12000 -# include "usbdrvasm12.inc" -#elif USB_CFG_CLOCK_KHZ == 15000 -# include "usbdrvasm15.inc" -#elif USB_CFG_CLOCK_KHZ == 16000 -# include "usbdrvasm16.inc" -#elif USB_CFG_CLOCK_KHZ == 16500 -# include "usbdrvasm165.inc" -#elif USB_CFG_CLOCK_KHZ == 20000 -# include "usbdrvasm20.inc" -#else -# error "USB_CFG_CLOCK_KHZ is not one of the supported rates!" -#endif +#if USB_CFG_CHECK_CRC /* separate dispatcher for CRC type modules */ +# if USB_CFG_CLOCK_KHZ == 18000 +# include "usbdrvasm18-crc.inc" +# else +# error "USB_CFG_CLOCK_KHZ is not one of the supported crc-rates!" +# endif +#else /* USB_CFG_CHECK_CRC */ +# if USB_CFG_CLOCK_KHZ == 12000 +# include "usbdrvasm12.inc" +# elif USB_CFG_CLOCK_KHZ == 12800 +# include "usbdrvasm128.inc" +# elif USB_CFG_CLOCK_KHZ == 15000 +# include "usbdrvasm15.inc" +# elif USB_CFG_CLOCK_KHZ == 16000 +# include "usbdrvasm16.inc" +# elif USB_CFG_CLOCK_KHZ == 16500 +# include "usbdrvasm165.inc" +# elif USB_CFG_CLOCK_KHZ == 20000 +# include "usbdrvasm20.inc" +# else +# error "USB_CFG_CLOCK_KHZ is not one of the supported non-crc-rates!" +# endif +#endif /* USB_CFG_CHECK_CRC */ diff --git a/avr/bootloader/usbdrv/usbdrvasm.asm b/avr/bootloader/usbdrv/usbdrvasm.asm index 4a5486f..fb66934 100644 --- a/avr/bootloader/usbdrv/usbdrvasm.asm +++ b/avr/bootloader/usbdrv/usbdrvasm.asm @@ -1,11 +1,10 @@ /* Name: usbdrvasm.asm - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Christian Starkjohann * Creation Date: 2006-03-01 * Tabsize: 4 * Copyright: (c) 2006 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * This Revision: $Id$ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ /* diff --git a/avr/bootloader/usbdrv/usbdrvasm12.inc b/avr/bootloader/usbdrv/usbdrvasm12.inc index 23b988c..d3bd056 100644 --- a/avr/bootloader/usbdrv/usbdrvasm12.inc +++ b/avr/bootloader/usbdrv/usbdrvasm12.inc @@ -1,11 +1,10 @@ /* Name: usbdrvasm12.inc - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Christian Starkjohann * Creation Date: 2004-12-29 * Tabsize: 4 * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * This Revision: $Id: usbdrvasm12.inc 483 2008-02-05 15:05:32Z cs $ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ /* Do not link this file! Link usbdrvasm.S instead, which includes the @@ -48,10 +47,13 @@ USB_INTR_VECTOR: ;---------------------------------------------------------------------------- ;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] ;sync up with J to K edge during sync pattern -- use fastest possible loops -;first part has no timeout because it waits for IDLE or SE1 (== disconnected) +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. waitForJ: - sbis USBIN, USBMINUS ;1 [40] wait for D- == 1 - rjmp waitForJ ;2 + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout waitForK: ;The following code results in a sampling window of 1/4 bit which meets the spec. sbis USBIN, USBMINUS @@ -69,6 +71,9 @@ waitForK: inc YL sts usbSofCount, YL #endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif rjmp sofError foundK: ;{3, 5} after falling D- edge, average delay: 4 cycles [we want 4 for center sampling] @@ -250,12 +255,12 @@ macro POP_STANDARD ; 12 cycles pop x1 pop shift pop YH -endm + endm macro POP_RETI ; 5 cycles pop YL out SREG, YL pop YL -endm + endm #include "asmcommon.inc" @@ -263,25 +268,16 @@ endm ; Transmitting data ;---------------------------------------------------------------------------- -bitstuff0: ;1 (for branch taken) - eor x1, x4 ;1 - ldi x2, 0 ;1 - out USBOUT, x1 ;1 <-- out - rjmp didStuff0 ;2 branch back 2 cycles earlier -bitstuff1: ;1 (for branch taken) - eor x1, x4 ;1 - rjmp didStuff1 ;2 we know that C is clear, jump back to do OUT and ror 0 into x2 -bitstuff2: ;1 (for branch taken) - eor x1, x4 ;1 - rjmp didStuff2 ;2 jump back 4 cycles earlier and do out and ror 0 into x2 -bitstuff3: ;1 (for branch taken) - eor x1, x4 ;1 - rjmp didStuff3 ;2 jump back earlier and ror 0 into x2 -bitstuff4: ;1 (for branch taken) - eor x1, x4 ;1 - ldi x2, 0 ;1 - out USBOUT, x1 ;1 <-- out - rjmp didStuff4 ;2 jump back 2 cycles earlier +txByteLoop: +txBitloop: +stuffN1Delay: ; [03] + ror shift ;[-5] [11] [59] + brcc doExorN1 ;[-4] [60] + subi x4, 1 ;[-3] + brne commonN1 ;[-2] + lsl shift ;[-1] compensate ror after rjmp stuffDelay + nop ;[00] stuffing consists of just waiting 8 cycles + rjmp stuffN1Delay ;[01] after ror, C bit is reliably clear sendNakAndReti: ;0 [-19] 19 cycles until SOP ldi x3, USBPID_NAK ;1 [-18] @@ -306,122 +302,91 @@ usbSendX3: ;0 [-16] ;usbSend: ;pointer to data in 'Y' ;number of bytes in 'cnt' -- including sync byte -;uses: x1...x4, shift, cnt, Y -;Numbers in brackets are time since first bit of sync pattern is sent -usbSendAndReti: ;0 [-13] timing: 13 cycles until SOP - in x2, USBDDR ;1 [-12] - ori x2, USBMASK ;1 [-11] - sbi USBOUT, USBMINUS;2 [-9] prepare idle state; D+ and D- must have been 0 (no pullups) - in x1, USBOUT ;1 [-8] port mirror for tx loop - out USBDDR, x2 ;1 [-7] <- acquire bus -; need not init x2 (bitstuff history) because sync starts with 0 - push x4 ;2 [-5] - ldi x4, USBMASK ;1 [-4] exor mask - ldi shift, 0x80 ;1 [-3] sync byte is first byte sent -txLoop: ; [62] - sbrs shift, 0 ;1 [-2] [62] - eor x1, x4 ;1 [-1] [63] - out USBOUT, x1 ;1 [0] <-- out bit 0 - ror shift ;1 [1] - ror x2 ;1 [2] -didStuff0: - cpi x2, 0xfc ;1 [3] - brsh bitstuff0 ;1 [4] - sbrs shift, 0 ;1 [5] - eor x1, x4 ;1 [6] - ror shift ;1 [7] -didStuff1: - out USBOUT, x1 ;1 [8] <-- out bit 1 - ror x2 ;1 [9] - cpi x2, 0xfc ;1 [10] - brsh bitstuff1 ;1 [11] - sbrs shift, 0 ;1 [12] - eor x1, x4 ;1 [13] - ror shift ;1 [14] -didStuff2: - ror x2 ;1 [15] - out USBOUT, x1 ;1 [16] <-- out bit 2 - cpi x2, 0xfc ;1 [17] - brsh bitstuff2 ;1 [18] - sbrs shift, 0 ;1 [19] - eor x1, x4 ;1 [20] - ror shift ;1 [21] -didStuff3: - ror x2 ;1 [22] - cpi x2, 0xfc ;1 [23] - out USBOUT, x1 ;1 [24] <-- out bit 3 - brsh bitstuff3 ;1 [25] - nop2 ;2 [27] - ld x3, y+ ;2 [29] - sbrs shift, 0 ;1 [30] - eor x1, x4 ;1 [31] - out USBOUT, x1 ;1 [32] <-- out bit 4 - ror shift ;1 [33] - ror x2 ;1 [34] -didStuff4: - cpi x2, 0xfc ;1 [35] - brsh bitstuff4 ;1 [36] - sbrs shift, 0 ;1 [37] - eor x1, x4 ;1 [38] - ror shift ;1 [39] -didStuff5: - out USBOUT, x1 ;1 [40] <-- out bit 5 - ror x2 ;1 [41] - cpi x2, 0xfc ;1 [42] - brsh bitstuff5 ;1 [43] - sbrs shift, 0 ;1 [44] - eor x1, x4 ;1 [45] - ror shift ;1 [46] -didStuff6: - ror x2 ;1 [47] - out USBOUT, x1 ;1 [48] <-- out bit 6 - cpi x2, 0xfc ;1 [49] - brsh bitstuff6 ;1 [50] - sbrs shift, 0 ;1 [51] - eor x1, x4 ;1 [52] - ror shift ;1 [53] -didStuff7: - ror x2 ;1 [54] - cpi x2, 0xfc ;1 [55] - out USBOUT, x1 ;1 [56] <-- out bit 7 - brsh bitstuff7 ;1 [57] - mov shift, x3 ;1 [58] - dec cnt ;1 [59] - brne txLoop ;1/2 [60/61] +;uses: x1...x2, x4, shift, cnt, Y [x1 = mirror USBOUT, x2 = USBMASK, x4 = bitstuff cnt] +;Numbers in brackets are time since first bit of sync pattern is sent (start of instruction) +usbSendAndReti: + in x2, USBDDR ;[-12] 12 cycles until SOP + ori x2, USBMASK ;[-11] + sbi USBOUT, USBMINUS ;[-10] prepare idle state; D+ and D- must have been 0 (no pullups) + out USBDDR, x2 ;[-8] <--- acquire bus + in x1, USBOUT ;[-7] port mirror for tx loop + ldi shift, 0x40 ;[-6] sync byte is first byte sent (we enter loop after ror) + ldi x2, USBMASK ;[-5] + push x4 ;[-4] +doExorN1: + eor x1, x2 ;[-2] [06] [62] + ldi x4, 6 ;[-1] [07] [63] +commonN1: +stuffN2Delay: + out USBOUT, x1 ;[00] [08] [64] <--- set bit + ror shift ;[01] + brcc doExorN2 ;[02] + subi x4, 1 ;[03] + brne commonN2 ;[04] + lsl shift ;[05] compensate ror after rjmp stuffDelay + rjmp stuffN2Delay ;[06] after ror, C bit is reliably clear +doExorN2: + eor x1, x2 ;[04] [12] + ldi x4, 6 ;[05] [13] +commonN2: + nop ;[06] [14] + subi cnt, 171 ;[07] [15] trick: (3 * 171) & 0xff = 1 + out USBOUT, x1 ;[08] [16] <--- set bit + brcs txBitloop ;[09] [25] [41] + +stuff6Delay: + ror shift ;[42] [50] + brcc doExor6 ;[43] + subi x4, 1 ;[44] + brne common6 ;[45] + lsl shift ;[46] compensate ror after rjmp stuffDelay + nop ;[47] stuffing consists of just waiting 8 cycles + rjmp stuff6Delay ;[48] after ror, C bit is reliably clear +doExor6: + eor x1, x2 ;[45] [53] + ldi x4, 6 ;[46] +common6: +stuff7Delay: + ror shift ;[47] [55] + out USBOUT, x1 ;[48] <--- set bit + brcc doExor7 ;[49] + subi x4, 1 ;[50] + brne common7 ;[51] + lsl shift ;[52] compensate ror after rjmp stuffDelay + rjmp stuff7Delay ;[53] after ror, C bit is reliably clear +doExor7: + eor x1, x2 ;[51] [59] + ldi x4, 6 ;[52] +common7: + ld shift, y+ ;[53] + tst cnt ;[55] + out USBOUT, x1 ;[56] <--- set bit + brne txByteLoop ;[57] + ;make SE0: - cbr x1, USBMASK ;1 [61] prepare SE0 [spec says EOP may be 15 to 18 cycles] - pop x4 ;2 [63] -;brackets are cycles from start of SE0 now - out USBOUT, x1 ;1 [0] <-- out SE0 -- from now 2 bits = 16 cycles until bus idle + cbr x1, USBMASK ;[58] prepare SE0 [spec says EOP may be 15 to 18 cycles] + lds x2, usbNewDeviceAddr;[59] + lsl x2 ;[61] we compare with left shifted address + subi YL, 2 + 20 ;[62] Only assign address on data packets, not ACK/NAK in x3 + sbci YH, 0 ;[63] + out USBOUT, x1 ;[00] <-- out SE0 -- from now 2 bits = 16 cycles until bus idle ;2006-03-06: moved transfer of new address to usbDeviceAddr from C-Code to asm: ;set address only after data packet was sent, not after handshake - lds x2, usbNewDeviceAddr;2 [2] - lsl x2; ;1 [3] we compare with left shifted address - subi YL, 20 + 2 ;1 [4] Only assign address on data packets, not ACK/NAK in x3 - sbci YH, 0 ;1 [5] - breq skipAddrAssign ;2 [7] - sts usbDeviceAddr, x2; if not skipped: SE0 is one cycle longer + breq skipAddrAssign ;[01] + sts usbDeviceAddr, x2 ; if not skipped: SE0 is one cycle longer skipAddrAssign: ;end of usbDeviceAddress transfer - ldi x2, 1< subtract 1/3 rjmp didUnstuff6 ;[08] unstuff7: @@ -124,7 +132,7 @@ unstuff7: in x2, USBIN ;[00] [10] re-sample bit 7 andi x2, USBMASK ;[01] andi shift, ~0x80;[02] - subi leap, 3 ;[03] since this is a short (10 cycle) bit, enforce leap bit + subi leap, 2 ;[03] total duration = 10 bits -> add 1/3 rjmp didUnstuff7 ;[04] unstuffEven: @@ -133,8 +141,8 @@ unstuffEven: andi shift, ~0x80;[01] andi x1, USBMASK ;[02] breq se0 ;[03] - subi leap, 3 ;[04] since this is a short (10 cycle) bit, enforce leap bit - nop ;[05] + subi leap, -1 ;[04] total duration = 11 bits -> subtract 1/3 + nop2 ;[05] rjmp didUnstuffE ;[06] unstuffOdd: @@ -143,8 +151,8 @@ unstuffOdd: andi shift, ~0x80;[01] andi x2, USBMASK ;[02] breq se0 ;[03] - subi leap, 3 ;[04] since this is a short (10 cycle) bit, enforce leap bit - nop ;[05] + subi leap, -1 ;[04] total duration = 11 bits -> subtract 1/3 + nop2 ;[05] rjmp didUnstuffO ;[06] rxByteLoop: @@ -208,13 +216,13 @@ macro POP_STANDARD ; 14 cycles pop x1 pop shift pop bitcnt -endm + endm macro POP_RETI ; 7 cycles pop YH pop YL out SREG, YL pop YL -endm + endm #include "asmcommon.inc" diff --git a/avr/bootloader/usbdrv/usbdrvasm165.inc b/avr/bootloader/usbdrv/usbdrvasm165.inc index 29623c2..ae91588 100644 --- a/avr/bootloader/usbdrv/usbdrvasm165.inc +++ b/avr/bootloader/usbdrv/usbdrvasm165.inc @@ -1,11 +1,10 @@ /* Name: usbdrvasm165.inc - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Christian Starkjohann * Creation Date: 2007-04-22 * Tabsize: 4 * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * Revision: $Id: usbdrvasm165.inc 607 2008-05-13 15:57:28Z cs $ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ /* Do not link this file! Link usbdrvasm.S instead, which includes the @@ -46,10 +45,13 @@ USB_INTR_VECTOR: ;---------------------------------------------------------------------------- ;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] ;sync up with J to K edge during sync pattern -- use fastest possible loops -;first part has no timeout because it waits for IDLE or SE1 (== disconnected) +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. waitForJ: - sbis USBIN, USBMINUS ;[-18] wait for D- == 1 - rjmp waitForJ + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout waitForK: ;The following code results in a sampling window of < 1/4 bit which meets the spec. sbis USBIN, USBMINUS ;[-15] @@ -69,6 +71,9 @@ waitForK: inc YL sts usbSofCount, YL #endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif rjmp sofError foundK: ;[-12] ;{3, 5} after falling D- edge, average delay: 4 cycles [we want 5 for center sampling] @@ -334,12 +339,12 @@ macro POP_STANDARD ; 16 cycles pop shift pop YH pop r0 -endm + endm macro POP_RETI ; 5 cycles pop YL out SREG, YL pop YL -endm + endm #include "asmcommon.inc" diff --git a/avr/bootloader/usbdrv/usbdrvasm18-crc.inc b/avr/bootloader/usbdrv/usbdrvasm18-crc.inc index f83347d..0ff2f42 100644 --- a/avr/bootloader/usbdrv/usbdrvasm18-crc.inc +++ b/avr/bootloader/usbdrv/usbdrvasm18-crc.inc @@ -5,7 +5,6 @@ * Tabsize: 4 * Copyright: (c) 2008 by Lukas Schrittwieser and OBJECTIVE DEVELOPMENT Software GmbH * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) - * Revision: $Id: usbdrvasm18-crc.inc 740 2009-04-13 18:23:31Z cs $ */ /* Do not link this file! Link usbdrvasm.S instead, which includes the diff --git a/avr/bootloader/usbdrv/usbdrvasm20.inc b/avr/bootloader/usbdrv/usbdrvasm20.inc index a59638c..5027edd 100644 --- a/avr/bootloader/usbdrv/usbdrvasm20.inc +++ b/avr/bootloader/usbdrv/usbdrvasm20.inc @@ -1,12 +1,11 @@ /* Name: usbdrvasm20.inc - * Project: AVR USB driver + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers * Author: Jeroen Benschop * Based on usbdrvasm16.inc from Christian Starkjohann * Creation Date: 2008-03-05 * Tabsize: 4 * Copyright: (c) 2008 by Jeroen Benschop and OBJECTIVE DEVELOPMENT Software GmbH - * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) - * Revision: $Id: usbdrvasm20.inc 607 2008-05-13 15:57:28Z cs $ + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) */ /* Do not link this file! Link usbdrvasm.S instead, which includes the @@ -57,10 +56,13 @@ USB_INTR_VECTOR: ;---------------------------------------------------------------------------- ;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] ;sync up with J to K edge during sync pattern -- use fastest possible loops -;first part has no timeout because it waits for IDLE or SE1 (== disconnected) +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. waitForJ: - sbis USBIN, USBMINUS ;[-21] wait for D- == 1 - rjmp waitForJ + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout waitForK: ;The following code results in a sampling window of < 1/4 bit which meets the spec. sbis USBIN, USBMINUS ;[-19] @@ -86,6 +88,9 @@ waitForK: inc YL sts usbSofCount, YL #endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif rjmp sofError foundK: ;[-16] ;{3, 5} after falling D- edge, average delay: 4 cycles @@ -232,13 +237,13 @@ macro POP_STANDARD ; 14 cycles pop x1 pop shift pop bitcnt -endm + endm macro POP_RETI ; 7 cycles pop YH pop YL out SREG, YL pop YL -endm + endm diff --git a/avr/bootloader/usbdrv/usbportability.h b/avr/bootloader/usbdrv/usbportability.h index ccd61b6..0a861d0 100644 --- a/avr/bootloader/usbdrv/usbportability.h +++ b/avr/bootloader/usbdrv/usbportability.h @@ -5,7 +5,6 @@ * Tabsize: 4 * Copyright: (c) 2008 by OBJECTIVE DEVELOPMENT Software GmbH * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) - * This Revision: $Id: usbportability.h 740 2009-04-13 18:23:31Z cs $ */ /* @@ -125,7 +124,11 @@ static inline void sei(void) # include #endif -#define USB_READ_FLASH(addr) pgm_read_byte(addr) +#if USB_CFG_DRIVER_FLASH_PAGE +# define USB_READ_FLASH(addr) pgm_read_byte_far(((long)USB_CFG_DRIVER_FLASH_PAGE << 16) | (long)(addr)) +#else +# define USB_READ_FLASH(addr) pgm_read_byte(addr) +#endif #define macro .macro #define endm .endm