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

Minor documentation improvements. Remove AS4 project generator script as it is buggy; replace with a better system in the future for both AS4 and AS6.

Browse Source
pull/1469/head
Dean Camera 12 years ago
parent 217f1eebc1
commit 4cd80263ff
7 changed files with 106 additions and 374 deletions
Show Stats Download Patch File Download Diff File

2
LUFA.pnproj
View File

File diff suppressed because one or more lines are too long

2
LUFA/DoxygenPages/BuildSystem.txt
Unescape View File

@ -25,7 +25,7 @@
* project's build makefile targets automatically. To call a build target, run <tt>make {TARGET_NAME}</tt> * project's build makefile targets automatically. To call a build target, run <tt>make {TARGET_NAME}</tt>
* from the command line, substituting in the appropriate target name. * from the command line, substituting in the appropriate target name.
* *
* \see \ref Sec_AppConfigParams for a copy of the sample LUFA project makefile. * \see \ref Sec_AppMakefileParams for a copy of the sample LUFA project makefile.
* *
* Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i> * Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>
* be supplied in the project makefile for the module to work, and one or more optional parameters which * be supplied in the project makefile for the module to work, and one or more optional parameters which

12
LUFA/DoxygenPages/CompilingApps.txt
Unescape View File

@ -14,23 +14,23 @@
* compilation of LUFA based applications. * compilation of LUFA based applications.
* *
* \subsection SSec_PreqWindows Windows Prerequisites * \subsection SSec_PreqWindows Windows Prerequisites
* On Windows, you will need a copy of the latest Atmel Toolchain, either downloaded and installed as a standalone * On Windows, you will need a copy of the latest Atmel Toolchain (<a>http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx</a>),
* package, or installed as part of Atmel Studio. You will need to ensure that the "bin" directory of the toolchain * either downloaded and installed as a standalone package, or installed as part of Atmel Studio. You will need to ensure
* is available in your system's <b>PATH</b> environment variable. * that the "bin" directory of the toolchain is available in your system's <b>PATH</b> environment variable.
* *
* In addition, you will need to install a ported version of the ZSH or BASH *nix shells, and a standard set of *nix * In addition, you will need to install a ported version of the ZSH or BASH *nix shells, and a standard set of *nix
* utilities such as <i>cut</i>, <i>find</i> and <i>sed</i>. These can be found in the "basic" system package of the * utilities such as <i>cut</i>, <i>find</i> and <i>sed</i>. These can be found in the "basic" system package of the
* of the MinGW installer (<a>http://www.mingw.org</a>). Once installed, add the "msys\1.0\bin" of the MinGW installation * of the MinGW installer (<a>http://www.mingw.org</a>). Once installed, add the "msys\1.0\bin" of the MinGW installation
* folder is added to your system's <b>PATH</b> environment variable. * folder is added to your system's <b>PATH</b> environment variable.
* *
* The bootloaders currently also require the "bc" application, which can be installed from * The bootloaders currently also require the \c bc command line application, which can be installed from
* <a>http://gnuwin32.sourceforge.net/downlinks/bc.php</a>. Once installed add the "GnuWin32\bin" path of the GnuWin32 * <a>http://gnuwin32.sourceforge.net/downlinks/bc.php</a>. Once installed add the "GnuWin32\bin" path of the GnuWin32
* installation folder to your system's <b>PATH</b> environment variable. * installation folder to your system's <b>PATH</b> environment variable.
* *
* \subsection SSec_PreqLinux Linux Prerequisites * \subsection SSec_PreqLinux Linux Prerequisites
* On Linux systems you will need to install the latest Linux distribution of the standalone Atmel Toolchain from the * On Linux systems you will need to install the latest Linux distribution of the standalone Atmel Toolchain from the
* Atmel website for general development, or use the latest avr-libc and avr-gcc packages for your chosen distribution's * Atmel website (<a>http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORLINUX.aspx</a>), or use the latest avr-libc and avr-gcc packages
* package manager. For full device support, the Atmel standalone package is recommended. * for your chosen distribution's package manager. For full device support, the Atmel standalone Toolchain package is recommended.
* *
* \section Sec_Compiling Compiling a LUFA Application * \section Sec_Compiling Compiling a LUFA Application
* Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for * Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for

2
LUFA/DoxygenPages/ConfiguringApps.txt
Unescape View File

@ -18,7 +18,7 @@
* *
* \see \ref Page_BuildSystem for information on the LUFA build system. * \see \ref Page_BuildSystem for information on the LUFA build system.
* *
* \section Sec_AppConfigParams The Default Application Template * \section Sec_AppMakefileParams The Default Application Makefile 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.
* *

419
LUFA/DoxygenPages/VIDAndPIDValues.txt
Unescape View File

@ -17,402 +17,177 @@
* demos share the same VID/PID value. * demos share the same VID/PID value.
* *
* <table> * <table>
*
* <tr> * <tr>
* <td> * <th>VID</th>
* <b>VID</b> * <th>PID</th>
* </td> * <th>Usage</th>
* <td>
* <b>PID</b>
* </td>
* <td>
* <b>Usage</b>
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2040</td>
* </td> * <td>Test VID/PID (See \ref Sec_Test_VIDPID)</td>
* <td> * </tr>
* 0x2040
* </td>
* <td>
* Test VID/PID (See below)
* </td>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2041</td>
* </td> * <td>Mouse Demo Application</td>
* <td>
* 0x2041
* </td>
* <td>
* Mouse Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2042</td>
* </td> * <td>Keyboard Demo Application</td>
* <td>
* 0x2042
* </td>
* <td>
* Keyboard Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2043</td>
* </td> * <td>Joystick Demo Application</td>
* <td>
* 0x2043
* </td>
* <td>
* Joystick Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2044</td>
* </td> * <td>CDC Demo Application</td>
* <td>
* 0x2044
* </td>
* <td>
* CDC Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2045</td>
* </td> * <td>Mass Storage Demo Application</td>
* <td>
* 0x2045
* </td>
* <td>
* Mass Storage Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2046</td>
* </td> * <td>Audio Output Demo Application</td>
* <td>
* 0x2046
* </td>
* <td>
* Audio Output Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2047</td>
* </td> * <td>Audio Input Demo Application</td>
* <td>
* 0x2047
* </td>
* <td>
* Audio Input Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2048</td>
* </td> * <td>MIDI Demo Application</td>
* <td>
* 0x2048
* </td>
* <td>
* MIDI Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2049</td>
* </td> * <td>MagStripe Project</td>
* <td>
* 0x2049
* </td>
* <td>
* MagStripe Project
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x204A</td>
* </td> * <td>CDC Bootloader</td>
* <td>
* 0x204A
* </td>
* <td>
* CDC Bootloader
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x204B</td>
* </td> * <td>USB to Serial Demo Application</td>
* <td>
* 0x204B
* </td>
* <td>
* USB to Serial Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x204C</td>
* </td> * <td>RNDIS Demo Application</td>
* <td>
* 0x204C
* </td>
* <td>
* RNDIS Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x204D</td>
* </td> * <td>Combined Keyboard and Mouse Demo Application</td>
* <td>
* 0x204D
* </td>
* <td>
* Combined Keyboard and Mouse Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x204E</td>
* </td> * <td>Dual CDC Demo Application</td>
* <td>
* 0x204E
* </td>
* <td>
* Dual CDC Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB
* </td>
* <td> * <td>
* 0x204F * 0x204F
* </td> * </td>
* <td> * <td>Generic HID Demo Application</td>
* Generic HID Demo Application
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2060</td>
* </td> * <td>Benito Programmer Project</td>
* <td>
* 0x2060
* </td>
* <td>
* Benito Programmer Project
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2061</td>
* </td> * <td>Combined Mass Storage and Keyboard Demo</td>
* <td>
* 0x2061
* </td>
* <td>
* Combined Mass Storage and Keyboard Demo
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2062</td>
* </td> * <td>Combined CDC and Mouse Demo</td>
* <td>
* 0x2062
* </td>
* <td>
* Combined CDC and Mouse Demo
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2063</td>
* </td> * <td>Mass Storage/HID Interface Datalogger Project</td>
* <td>
* 0x2063
* </td>
* <td>
* Mass Storage/HID Interface Datalogger Project
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2064</td>
* </td> * <td>Interfaceless Control-Only LUFA Devices</td>
* <td>
* 0x2064
* </td>
* <td>
* Interfaceless Control-Only LUFA Devices
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2065</td>
* </td> * <td>Test and Measurement Demo</td>
* <td>
* 0x2065
* </td>
* <td>
* Test and Measurement Demo
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB
* </td>
* <td> * <td>
* 0x2066 * 0x2066
* </td> * </td>
* <td> * <td>Multiple Report Keyboard/Mouse HID Demo</td>
* Multiple Report Keyboard/Mouse HID Demo
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2067</td>
* </td> * <td>HID Class Bootloader</td>
* <td>
* 0x2067
* </td>
* <td>
* HID Class Bootloader
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x2068</td>
* </td> * <td>Virtual Serial/Mass Storage Demo</td>
* <td>
* 0x2068
* </td>
* <td>
* Virtual Serial/Mass Storage Demo
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB
* </td>
* <td> * <td>
* 0x2069 * 0x2069
* </td> * </td>
* <td> * <td>Webserver Project</td>
* Webserver Project
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x206A</td>
* </td> * <td>Media Control Project</td>
* <td>
* 0x206A
* </td>
* <td>
* Media Control Project
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x206B</td>
* </td> * <td><i>Currently Unallocated</i></td>
* <td>
* 0x206B
* </td>
* <td>
* <i>Currently Unallocated</i>
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x206C</td>
* </td> * <td><i>Currently Unallocated</i></td>
* <td>
* 0x206C
* </td>
* <td>
* <i>Currently Unallocated</i>
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x206D</td>
* </td> * <td><i>Currently Unallocated</i></td>
* <td>
* 0x206D
* </td>
* <td>
* <i>Currently Unallocated</i>
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x206E</td>
* </td> * <td><i>Currently Unallocated</i></td>
* <td>
* 0x206E
* </td>
* <td>
* <i>Currently Unallocated</i>
* </td>
* </tr> * </tr>
*
* <tr> * <tr>
* <td> * <td>0x03EB</td>
* 0x03EB * <td>0x206F</td>
* </td> * <td><i>Currently Unallocated</i></td>
* <td>
* 0x206F
* </td>
* <td>
* <i>Currently Unallocated</i>
* </td>
* </tr> * </tr>
*
* </table> * </table>
* *
* \section Sec_Test_VIDPID The Test VID/PID Combination * \section Sec_Test_VIDPID The Test VID/PID Combination

1
Maintenance/AS4Template.aps
Unescape View File

@ -1 +0,0 @@
<AVRStudio><MANAGEMENT><ProjectName>%TARGET%</ProjectName><Created>%CREATED%</Created><LastEdit>%CREATED%</LastEdit><ICON>241</ICON><ProjectType>0</ProjectType><Created>%CREATED%</Created><Version>4</Version><Build>4, 18, 0, 685</Build><ProjectTypeName>AVR GCC</ProjectTypeName></MANAGEMENT><CODE_CREATION><ObjectFile>%TARGET%.elf</ObjectFile><EntryFile></EntryFile></CODE_CREATION><DEBUG_TARGET><CURRENT_TARGET></CURRENT_TARGET><CURRENT_PART></CURRENT_PART><BREAKPOINTS></BREAKPOINTS><IO_EXPAND><HIDE>false</HIDE></IO_EXPAND><REGISTERNAMES><Register>R00</Register><Register>R01</Register><Register>R02</Register><Register>R03</Register><Register>R04</Register><Register>R05</Register><Register>R06</Register><Register>R07</Register><Register>R08</Register><Register>R09</Register><Register>R10</Register><Register>R11</Register><Register>R12</Register><Register>R13</Register><Register>R14</Register><Register>R15</Register><Register>R16</Register><Register>R17</Register><Register>R18</Register><Register>R19</Register><Register>R20</Register><Register>R21</Register><Register>R22</Register><Register>R23</Register><Register>R24</Register><Register>R25</Register><Register>R26</Register><Register>R27</Register><Register>R28</Register><Register>R29</Register><Register>R30</Register><Register>R31</Register></REGISTERNAMES><COM></COM><COMType>0</COMType><WATCHNUM>0</WATCHNUM><WATCHNAMES><Pane0></Pane0><Pane1></Pane1><Pane2></Pane2><Pane3></Pane3></WATCHNAMES><BreakOnTrcaeFull>0</BreakOnTrcaeFull></DEBUG_TARGET><Debugger><Triggers></Triggers></Debugger><AVRGCCPLUGIN><FILES>%FILE_LIST%</FILES><CONFIGS><CONFIG><NAME>default</NAME><USESEXTERNALMAKEFILE>YES</USESEXTERNALMAKEFILE><EXTERNALMAKEFILE>makefile</EXTERNALMAKEFILE><PART>atmega128</PART><HEX>1</HEX><LIST>1</LIST><MAP>1</MAP><OUTPUTFILENAME>BootloaderCDC.elf</OUTPUTFILENAME><OUTPUTDIR>default\</OUTPUTDIR><ISDIRTY>1</ISDIRTY><OPTIONS/><INCDIRS/><LIBDIRS/><LIBS/><LINKOBJECTS/><OPTIONSFORALL>-Wall -gdwarf-2 -std=gnu99 -Os -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums</OPTIONSFORALL><LINKEROPTIONS></LINKEROPTIONS><SEGMENTS/></CONFIG></CONFIGS><LASTCONFIG>default</LASTCONFIG><USES_WINAVR>1</USES_WINAVR><GCC_LOC>C:\WinAVR-20100110\bin\avr-gcc.exe</GCC_LOC><MAKE_LOC>C:\WinAVR-20100110\utils\bin\make.exe</MAKE_LOC></AVRGCCPLUGIN><ProjectFiles><Files>%GCC_FILE_LIST%</Files></ProjectFiles><IOView><usergroups/><sort sorted="0" column="0" ordername="0" orderaddress="0" ordergroup="0"/></IOView><Files></Files><Events><Bookmarks></Bookmarks></Events><Trace><Filters></Filters></Trace></AVRStudio>

42
Maintenance/makefile
Unescape View File

@ -26,48 +26,6 @@ upgrade-doxygen:
done; done;
@echo Doxygen configuration update complete. @echo Doxygen configuration update complete.
# Generate AVR Studio 4 project files for each project from a template
make-as4-projects:
@echo Creating AVR Studio 4 project files for Demos...
@for project_makefile in `find $(LUFA_ROOT)/Demos $(LUFA_ROOT)/Projects $(LUFA_ROOT)/Bootloaders -name makefile*`; do \
target_name=`grep "TARGET *=" $$project_makefile | cut -d'=' -f2 | sed 's/ //g'`; \
target_folder=`dirname $$project_makefile`; \
as4_date=`date "+%-e-%b-%Y %-H:%-M:%-S"`; \
\
if ( test -n "$$target_name" ); then \
echo Creating AS4 project for project $$target_name; \
\
source_files="<OTHERFILE>`basename $$project_makefile`<\/OTHERFILE>"; \
gcc_source_files=""; \
for c_source_file in `find $$target_folder -name *.c`; do \
source_filename=`basename $$c_source_file`; \
\
source_files="$$source_files<SOURCEFILE>$$source_filename<\/SOURCEFILE>"; \
gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>"; \
done; \
for c_header_file in `find $$target_folder -name *.h`; do \
source_filename=`basename $$c_header_file`; \
\
source_files="$$source_files<HEADERFILE>$$source_filename<\/HEADERFILE>"; \
gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>"; \
done; \
for assembly_file in `find $$target_folder -name *.S`; do \
source_filename=`basename $$assembly_file`; \
\
source_files="$$source_files<OTHERFILE>$$source_filename<\/OTHERFILE>"; \
gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>"; \
done; \
\
sed "s/%TARGET%/$$target_name/g" AS4Template.aps > $$target_folder/$$target_name.aps.new; \
sed "s/%CREATED%/$$as4_date/g" $$target_folder/$$target_name.aps.new > $$target_folder/$$target_name.aps.new2; \
sed "s/%FILE_LIST%/$$source_files/g" $$target_folder/$$target_name.aps.new2 > $$target_folder/$$target_name.aps.new3; \
sed "s/%GCC_FILE_LIST%/$$gcc_source_files/g" $$target_folder/$$target_name.aps.new3 > $$target_folder/$$target_name.aps.new4; \
mv $$target_folder/$$target_name.aps.new4 $$target_folder/$$target_name.aps; \
rm $$target_folder/$$target_name.aps.new $$target_folder/$$target_name.aps.new2 $$target_folder/$$target_name.aps.new3; \
fi; \
done;
@echo AVR Studio 4 project generation complete.
# Make all possible bootloaders for all targets and configurations as set by the BootloaderTest build test # Make all possible bootloaders for all targets and configurations as set by the BootloaderTest build test
# and store them in a seperate directory called "Bootloaders" # and store them in a seperate directory called "Bootloaders"
make_bootloaders: make_bootloaders:

Write Preview
Loading…
Cancel
Save