diff options
Diffstat (limited to 'lib/vusb/Readme.txt')
-rw-r--r-- | lib/vusb/Readme.txt | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/lib/vusb/Readme.txt b/lib/vusb/Readme.txt new file mode 100644 index 000000000..84d27f997 --- /dev/null +++ b/lib/vusb/Readme.txt | |||
@@ -0,0 +1,83 @@ | |||
1 | This is the Readme file for V-USB and related code. V-USB is Objective | ||
2 | Development's firmware-only USB driver for Atmel's(r) AVR(r) microcontrollers. | ||
3 | For more information please visit http://www.obdev.at/vusb/. | ||
4 | |||
5 | To avoid name confusion: This project was formerly known as AVR-USB. Due to | ||
6 | a trademark issue, it was renamed to V-USB in April 2009. | ||
7 | |||
8 | |||
9 | WHAT IS INCLUDED IN THIS PACKAGE? | ||
10 | ================================= | ||
11 | This package consists of the device side USB driver firmware, library code | ||
12 | for device and host and fully working examples for device and host: | ||
13 | |||
14 | Readme.txt .............. The file you are currently reading. | ||
15 | usbdrv .................. V-USB firmware, to be included in your project. | ||
16 | examples ................ Example code for device and host side. | ||
17 | libs-device ............. Useful code snippets for the device firmware. | ||
18 | libs-host ............... Useful code snippets for host-side drivers. | ||
19 | circuits ................ Example circuits using this driver. | ||
20 | Changelog.txt ........... Documentation of changes between versions. | ||
21 | License.txt ............. Free Open Source license for this package (GPL). | ||
22 | CommercialLicense.txt ... Alternative commercial license for this package. | ||
23 | USB-ID-FAQ.txt .......... General infos about USB Product- and Vendor-IDs. | ||
24 | USB-IDs-for-free.txt .... List and terms of use for free shared PIDs. | ||
25 | |||
26 | Each subdirectory contains a separate Readme file which explains its | ||
27 | contents. We recommend that you also read the Readme.txt file in the | ||
28 | usbdrv subdirectory. | ||
29 | |||
30 | |||
31 | PREREQUISITES | ||
32 | ============= | ||
33 | The AVR code of V-USB is written in C and assembler. You need either | ||
34 | avr-gcc or IAR CC to compile the project. We recommend avr-gcc because it | ||
35 | is free and easily available. Gcc version 3 generates slightly more | ||
36 | efficient code than version 4 for V-USB. Not every release is tested with | ||
37 | the IAR compiler. Previous versions have been tested with IAR 4.10B/W32 and | ||
38 | 4.12A/W32 on an ATmega8 with the "small" and "tiny" memory model. | ||
39 | |||
40 | Ready made avr-gcc tool chains are available for most operating systems: | ||
41 | * Windows: WinAVR http://winavr.sourceforge.net/ | ||
42 | * Mac: CrossPack for AVR Development http://www.obdev.at/crosspack/ | ||
43 | * Linux and other Unixes: Most free Unixes have optional packages for AVR | ||
44 | development. If not, follow the instructions at | ||
45 | http://www.nongnu.org/avr-libc/user-manual/install_tools.html | ||
46 | |||
47 | Our host side examples are compiled with gcc on all platforms. Gcc is the | ||
48 | default C compiler on Mac, Linux and many other Unixes. On windows, we | ||
49 | recommend MinGW (http://www.mingw.org/). Use the automated MinGW installer | ||
50 | for least troubles. You also need MSYS from the same site to work with | ||
51 | standard Makefiles. | ||
52 | |||
53 | Most examples also depend on libusb. Libusb is available from | ||
54 | http://libusb.sourceforge.net/ for Unix and | ||
55 | http://libusb-win32.sourceforge.net/ for Windows. | ||
56 | |||
57 | |||
58 | TECHNICAL DOCUMENTATION | ||
59 | ======================= | ||
60 | The API reference of the driver firmware can be found in usbdrv/usbdrv.h. | ||
61 | Documentation for host and device library files are in the respective header | ||
62 | files. For more information, see our documentation wiki at | ||
63 | http://www.obdev.at/goto.php?t=vusb-wiki. | ||
64 | |||
65 | See the file usbdrv/Readme.txt for more info about the driver itself. | ||
66 | |||
67 | |||
68 | LICENSE | ||
69 | ======= | ||
70 | V-USB and related code is distributed under the terms of the GNU General | ||
71 | Public License (GPL) version 2 (see License.txt for details) and the GNU | ||
72 | General Public License (GPL) version 3. It is your choice whether you apply | ||
73 | the terms of version 2 or version 3. In addition to the terms of the GPL, we | ||
74 | strongly encourage you to publish your entire project and mail OBJECTIVE | ||
75 | DEVELOPMENT a link to your publication. | ||
76 | |||
77 | Alternatively, we offer a commercial license without the restrictions of the | ||
78 | GPL. See CommercialLicense.txt for details. | ||
79 | |||
80 | |||
81 | ---------------------------------------------------------------------------- | ||
82 | (c) 2010 by OBJECTIVE DEVELOPMENT Software GmbH. | ||
83 | http://www.obdev.at/ | ||