keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Squashed 'tmk_core/' changes from caca2c0..dc0e46e

Browse Source 
dc0e46e Rename LUFA to LUFA-git
3bfa7fa Remove LUFA-120730
215b764 Merge commit 'afa0f22a9299686fd88f58ce09c5b521ac917e8f' as 'protocol/lufa/LUFA'
afa0f22 Squashed 'protocol/lufa/LUFA/' content from commit def7fca
c0c42fa Remove submodule of LUFA
30f897d Merge commit '87ced33feb74e79c3281dda36eb6d6d153399b41' as 'protocol/usb_hid/USB_Host_Shield_2.0'
87ced33 Squashed 'protocol/usb_hid/USB_Host_Shield_2.0/' content from commit aab4a69
14f6d49 Remove submodule of USB_Host_Shield_2.0

git-subtree-dir: tmk_core
git-subtree-split: dc0e46eaa4367d4e218f8816e3c117895820f07c
This commit is contained in:
tmk
2015-05-13 11:13:10 +09:00
parent 4d116a04e9
commit f6d56675f9
1575 changed files with 421901 additions and 63190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
protocol/lufa/LUFA-git/LUFA/DoxygenPages/WritingBoardDrivers.txt Normal file
View File

@ -0,0 +1,47 @@
/** \file
*
* This file contains special DoxyGen information for the generation of the main page and other special
* documentation pages. It is not a project source file.
*/
/** \page Page_WritingBoardDrivers Writing LUFA Board Drivers
*
* LUFA ships with several basic pre-made board drivers, to control hardware present on the supported board
* hardware - such as Dataflash ICs, LEDs, Joysticks, or other hardware peripherals. When compiling an application
* which makes use of one or more board drivers located in <i>LUFA/Drivers/Board</i>, you must also indicate which
* board hardware you are using in your project makefile. This is done by defining the <tt>BOARD</tt> macro using
* the <tt>-D</tt> switch passed to the compiler, with a constant of <tt>BOARD_{Name}</tt>. For example,
* <tt>-DBOARD=BOARD_USBKEY</tt> instructs the compiler to use the USBKEY board hardware drivers.
*
* If your application does not use <i>any</i> board level drivers, you can omit the definition of the <tt>BOARD</tt>
* macro. However, some users may wish to write their own custom board hardware drivers which are to remain compatible
* with the LUFA hardware API. To do this, the <tt>BOARD</tt> macro should be defined to the value <tt>BOARD_USER</tt>.
* This indicates that the board level drivers should be located in a folder named "Board" located inside the
* application's folder.
*
* When used, the driver stub files located in the <tt>LUFA/CodeTemplates/DriverStubs</tt> folder should be copied to
* the user application's <tt>Board/</tt> directory, and filled out to include the values and code needed to control
* the custom board hardware. Once done, the existing LUFA board level APIs (accessed in the regular
* <tt>LUFA/Drivers/Board/</tt> folder) will redirect to the user board drivers, maintaining code compatibility and
* allowing for a different board to be selected through the project makefile with no code changes.
*
* \section Sec_BoardTemplates Board Driver Templates
*
* The templates for each board driver are reproduced below.
*
* \subsection SSec_BoardTemplates_Board Template for USER <Board/Board.h>
* \include "DriverStubs/Board.h"
*
* \subsection SSec_BoardTemplates_Buttons Template for USER <Board/Buttons.h>
* \include "DriverStubs/Buttons.h"
*
* \subsection SSec_BoardTemplates_Dataflash Template for USER <Board/Dataflash.h>
* \include "DriverStubs/Dataflash.h"
*
* \subsection SSec_BoardTemplates_Joystick Template for USER <Board/Joystick.h>
* \include "DriverStubs/Joystick.h"
*
* \subsection SSec_BoardTemplates_LEDs Template for USER <Board/LEDs.h>
* \include "DriverStubs/LEDs.h"
*/