qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families Including hardware based encryption

Go to file

Dean Camera 7aaced1e8b Remove USB_MODE_* macros, replace with a semantically linked USB_Modes_t enum. Moved the USB device selection logic for ENDPOINT_TOTAL_ENDPOINTS further up in Endpoint.h to where the endpoint bank capabilities are determined, to reduce the total number of device-specific logic. Change USB_Host_WaitMS() to test and disable the HSOFI interrupt before resuming the bus, so that it does not fire before the delay loop has run. Add missing const qualifier to the parameter of USB_Host_ClearPipeStall().		2010-10-12 12:22:11 +00:00
Bootloaders	Added new NO_SOF_EVENTS compile time option, enabled in the bootloaders to reduce the compiled binary size.	2010-10-07 11:55:20 +00:00
Demos	Remove USB_MODE_* macros, replace with a semantically linked USB_Modes_t enum.	2010-10-12 12:22:11 +00:00
LUFA	Remove USB_MODE_* macros, replace with a semantically linked USB_Modes_t enum.	2010-10-12 12:22:11 +00:00
Projects	Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules.	2010-10-10 06:23:45 +00:00
LUFA.pnproj	Added new NO_SOF_EVENTS compile time option, enabled in the bootloaders to reduce the compiled binary size.	2010-10-07 11:55:20 +00:00
README.txt	Spell check all source files once again to find any typos.	2010-07-29 16:20:45 +00:00
makefile	Add svn:eol-style property to source files, so that the line endings are correctly converted to the target system's native end of line style.	2010-05-08 03:12:14 +00:00

README.txt

                   _   _ _ ___ _  
                  | | | | | __/ \ 
                  | |_| U | _| o | - The Lightweight USB
                  |___|___|_||_n_|    Framework for AVRs
                =========================================
                          Written by Dean Camera
                  dean [at] fourwalledcubicle [dot] com

                 http://www.fourwalledcubicle.com/LUFA.php
                =========================================

               LUFA is donation supported. To support LUFA, 
             please donate at http://www.fourwalledcubicle.com.

                For Commercial Licensing information, see
               http://fourwalledcubicle.com/PurchaseLUFA.php


This package contains the complete LUFA library, demos, user-submitted
projects and bootloaders for use with compatible microcontroller models.
LUFA is a simple to use, lightweight framework which sits atop the hardware
USB controller in specific AVR microcontroller models, and allows for the
quick and easy creation of complex USB devices and hosts.

To get started, you will need to install the "Doxygen" documentation
generation tool. If you use Linux, this can be installed via the "doxygen"
package in your chosen package management tool - under Ubuntu, this can be
achieved by running the following command in the terminal:

   sudo apt-get install doxygen
	
Other package managers and distributions will have similar methods to
install Doxygen. In Windows, you can download a prebuilt installer for
Doxygen from its website, www.doxygen.org.

Once installed, you can then use the Doxygen tool to generate the library
documentation from the command line or terminal of your operating system. To
do this, open your terminal or command line to the root directory of the
LUFA package, and type the following command:

   make doxygen

Which will recursively generate documentation for all elements in the
library - the core, plus all demos, projects and bootloaders. Generated
documentation will then be available by opening the file "index.html" of the
created Documentation/html/ subdirectories inside each project folder.

The documentation for the library itself (but not the documentation for the
individual demos, projects or bootloaders) is also available as a separate
package from the project webpage for convenience if Doxygen cannot be
installed.