forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Minor documentation improvements.

Browse Source
pull/1469/head
Dean Camera 13 years ago
parent c41bbf9fcc
commit e7e45baef1
3 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File

11
LUFA/DoxygenPages/ConfiguringApps.txt
Unescape View File

@ -8,21 +8,20 @@
* *
* If the target microcontroller model, architecture, clock speed, board or other settings are different from the current * If the target microcontroller model, architecture, clock speed, board or other settings are different from the current
* settings, they must be changed and the project recompiled from the source code before being programmed into the microcontroller. * settings, they must be changed and the project recompiled from the source code before being programmed into the microcontroller.
* Most project configuration options are located in the "makefile" build script inside each LUFA application's folder, however * Most project configuration options are located in the <tt>makefile</tt> build script inside each LUFA application's folder,
* some demo or application-specific configuration settings (such as the output format in the AudioOut demo) are located in one or * however some demo or application-specific configuration settings are located in one or more of the source files of the project.
* more of the source files of the project. See each project's individual documentation for application-specific configuration * See each project's individual documentation for application-specific configuration values.
* values.
* *
* Each project "makefile" contains all the script and configuration data required to compile each project. When opened with * Each project "makefile" contains all the script and configuration data required to compile each project. When opened with
* any regular basic text editor such as Notepad or WordPad (ensure that the save format is a pure ASCII text format) the * any regular basic text editor such as Notepad or WordPad (ensure that the save format is a pure ASCII text format) the
* build configuration settings may be altered. * build configuration settings may be altered.
* *
* \see \ref Page_BuildSystem for information on the LUFA build system.
*
* \section Sec_AppConfigParams The Default Application Template * \section Sec_AppConfigParams The Default Application Template
* *
* Below is a copy of the default LUFA application makefile, which can be used as a template for each application. * Below is a copy of the default LUFA application makefile, which can be used as a template for each application.
* *
* \see \ref Page_BuildSystem for information on the LUFA build system.
*
* \verbinclude makefile_template * \verbinclude makefile_template
* *
* Inside each makefile, a number of configuration variables are listed with the syntax "<VARIABLE NAME> = <VALUE>". For * Inside each makefile, a number of configuration variables are listed with the syntax "<VARIABLE NAME> = <VALUE>". For

22
LUFA/DoxygenPages/KnownIssues.txt
Unescape View File

@ -12,6 +12,16 @@
* \section Sec_KnownIssuesXXXXXX Version XXXXXX * \section Sec_KnownIssuesXXXXXX Version XXXXXX
* - AVR8 Architecture * - AVR8 Architecture
* - No known issues. * - No known issues.
* - UC3 Architecture
* \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
*
* - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
* although the architecture is supported in the LUFA core library.
* - DMA transfers to and from the USB controller are not yet implemented for this release.
* - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
* altered USB controller design.
* - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
* streams are not available on the UC3 architecture, due to a lack of suitable library support.
* - XMEGA Architecture * - XMEGA Architecture
* \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
* *
@ -23,21 +33,9 @@
* - Multiple-bank endpoints are not currently supported in this release. * - Multiple-bank endpoints are not currently supported in this release.
* - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata * - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
* relating to the USB controller. * relating to the USB controller.
* - UC3 Architecture
* \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
*
* - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
* although the architecture is supported in the LUFA core library.
* - DMA transfers to and from the USB controller are not yet implemented for this release.
* - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
* altered USB controller design.
* - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
* streams are not available on the UC3 architecture, due to a lack of suitable library support.
* - Architecture Independent * - Architecture Independent
* - The HID parser fails for array type elements that have a MIN and MAX usage applied; each element * - The HID parser fails for array type elements that have a MIN and MAX usage applied; each element
* in the array will receive a unique incrementing usage from the MIN value, up to MAX. * in the array will receive a unique incrementing usage from the MIN value, up to MAX.
* - The current application makefiles do not work if the output directory is not the same directory
* as the makefile itself.
* - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
* and a lengthy USB operation is initiated. * and a lengthy USB operation is initiated.
* - Build System * - Build System

9
LUFA/DoxygenPages/ProgrammingApps.txt
Unescape View File

@ -9,8 +9,8 @@
* Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your * Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your
* application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the * application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the
* reprogramming of an AVR device must be performed using a special piece of programming hardware, through one of the * reprogramming of an AVR device must be performed using a special piece of programming hardware, through one of the
* supported AVR programming protocols - ISP, HVSP, HVPP, JTAG or dW. This can be done through a custom programmer, * supported AVR programming protocols - ISP, HVSP, HVPP, JTAG, dW or PDI. This can be done through a custom programmer,
* a third party programmer, or an official Atmel AVR tool - for more information, see the Atmel.com website. * a third party programmer, or an official Atmel AVR tool - for more information, see the <a>atmel.com</a> website.
* *
* Alternatively, you can use the bootloader. From the Atmel factory, each USB AVR comes preloaded with the Atmel * Alternatively, you can use the bootloader. From the Atmel factory, each USB AVR comes preloaded with the Atmel
* DFU (Device Firmware Update) class bootloader, a small piece of AVR firmware which allows the remainder of the * DFU (Device Firmware Update) class bootloader, a small piece of AVR firmware which allows the remainder of the
@ -19,9 +19,12 @@
* or broken without an external programming device. They have disadvantages however; they cannot change the fuses of * or broken without an external programming device. They have disadvantages however; they cannot change the fuses of
* the AVR (special configuration settings that control the operation of the chip itself) and a small portion of the * the AVR (special configuration settings that control the operation of the chip itself) and a small portion of the
* AVR's FLASH program memory must be reserved to contain the bootloader firmware, and thus cannot be used by the * AVR's FLASH program memory must be reserved to contain the bootloader firmware, and thus cannot be used by the
* loaded application. Atmel's DFU bootloader is either 4KB (for the smaller USB AVRs) or 8KB (for the larger USB AVRs). * loaded application.
* *
* If you wish to use the DFU bootloader to program in your application, refer to your DFU programmer's documentation. * If you wish to use the DFU bootloader to program in your application, refer to your DFU programmer's documentation.
* Atmel provides a free utility called FLIP which is USB AVR compatible, and an open source (Linux compatible) * Atmel provides a free utility called FLIP which is USB AVR compatible, and an open source (Linux compatible)
* alternative exists called "dfu-programmer". * alternative exists called "dfu-programmer".
*
* \see \ref Page_BuildModule_DFU for information on the LUFA build system DFU module, for automatic DFU bootloader
* programming makefile targets.
*/ */

Write Preview
Loading…
Cancel
Save