diff options
author | Jack Humbert <jack.humb@gmail.com> | 2017-07-07 21:33:29 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-07-07 21:33:29 +0200 |
commit | 9de443cbf10ac41bc15762c9c83f138f51dd3b9a (patch) | |
tree | d8ddcb428e0b7d9773a1e52c42b60bdca2658beb /tmk_core/protocol/lufa/LUFA-git/LUFA/DoxygenPages/WritingBoardDrivers.txt | |
parent | 88b3d051b21cb1ddacc6353c5d59b19f03f3a242 (diff) | |
parent | 1c26468ad5a0701e244c99cbcbc547c93b75d515 (diff) | |
download | qmk_firmware-9de443cbf10ac41bc15762c9c83f138f51dd3b9a.tar.gz qmk_firmware-9de443cbf10ac41bc15762c9c83f138f51dd3b9a.tar.xz |
Merge pull request #1471 from qmk/lufa_lib
Update LUFA and move it to /lib/lufa
Diffstat (limited to 'tmk_core/protocol/lufa/LUFA-git/LUFA/DoxygenPages/WritingBoardDrivers.txt')
-rw-r--r-- | tmk_core/protocol/lufa/LUFA-git/LUFA/DoxygenPages/WritingBoardDrivers.txt | 47 |
1 files changed, 0 insertions, 47 deletions
diff --git a/tmk_core/protocol/lufa/LUFA-git/LUFA/DoxygenPages/WritingBoardDrivers.txt b/tmk_core/protocol/lufa/LUFA-git/LUFA/DoxygenPages/WritingBoardDrivers.txt deleted file mode 100644 index b2ff07e66..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/LUFA/DoxygenPages/WritingBoardDrivers.txt +++ /dev/null @@ -1,47 +0,0 @@ -/** \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" - */ - |