LUFA/ManPages/WritingBoardDrivers.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \page Page_WritingBoardDrivers Writing LUFA Board Drivers
   8  *
   9  *  LUFA ships with several basic pre-made board drivers, to control hardware present on the supported board
  10  *  hardware - such as Dataflash ICs, LEDs, Joysticks, or other hardware peripherals. When compiling an application
  11  *  which makes use of one or more board drivers located in LUFA/Drivers/Board, you must also indicate what board
  12  *  hardware you are using in your project makefile. This is done by defining the BOARD macro using the -D switch
  13  *  passed to the compiler, with a constant of BOARD_{Name}. For example <b>-DBOARD=BOARD_USBKEY</b> instructs the
  14  *  compiler to use the USBKEY board hardware drivers.
  15  *
  16  *  If your application does not use *any* board level drivers, you can omit the definition of the BOARD macro.
  17  *  However, some users may wish to write their own custom board hardware drivers which are to remain compatible
  18  *  with the LUFA hardware API. To do this, the BOARD macro should be defined to the value BOARD_USER. This indicates
  19  *  that the board level drivers should be located in a folder named "Board" located inside the application's folder.
  20  *
  21  *  When used, the driver stub files located in the DriverStubs folder should be copied to the user Board directory,
  22  *  and fleshed out to include the values and code needed to control the custom board hardware. Once done, the existing
  23  *  LUFA board level APIs (accessed in the regular LUFA/Drivers/Board/ folder) will redirect to the user board drivers,
  24  *  maintaining code compatibility and allowing for a different board to be selected through the project makefile with
  25  *  no code changes.
  26  */