ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.

Browse source
This commit is contained in:
Dean Camera 2011-02-20 13:08:29 +00:00
parent 1daa5e16f9
commit 5e73190582
98 changed files with 256 additions and 590 deletions
Download patch file Download diff file Expand all files Collapse all files

8
LUFA/ManPages/CompileTimeTokens.txt
View file

@ -120,17 +120,17 @@
* \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens
* This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode.
*
* <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
* <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
* Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one
* of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime.
*
* <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
* <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
* Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM.
*
* <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
* <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
* Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.
*
* <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n
* <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_StdDescriptors ) \n
* Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This
* allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing
* allocated resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the

5
LUFA/ManPages/SoftwareBootloaderJump.txt
View file

@ -12,12 +12,15 @@
* hardware). This might be required because the device does not have any physical user input, or simply
* just to streamline the device upgrade process on the host PC.
*
* The following C code snippet may be used to enter the bootloader upon request by the user application.
* The following C code snippets may be used to enter the bootloader upon request by the user application.
* By using the watchdog to physically reset the controller, it is ensured that all system hardware is
* completely reset to their defaults before the bootloader is run. This is important; since bootloaders
* are written to occupy a very limited space, they usually make assumptions about the register states based
* on the default values after a hard-reset of the chip.
*
* \section Sec_SoftareBootAVR8 AVR8 Architecture
* The following software bootloader jump code is written for the AVR8 architecture.
*
* \code
* #include <avr/wdt.h>
* #include <avr/io.h>