LUFA/Platform/Platform.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Architecture Specific Hardware Platform Drivers.
  33  *
  34  *  This file is the master dispatch header file for the device-specific hardware platform drivers, for low level
  35  *  hardware configuration and management. The platform drivers are a set of drivers which are designed to provide
  36  *  a high level management layer for the various low level system functions such as clock control and interrupt
  37  *  management.
  38  *
  39  *  User code may choose to either include this master dispatch header file to include all available platform
  40  *  driver header files for the current architecture, or may choose to only include the specific platform driver
  41  *  modules required for a particular application.
  42  */
  43
  44 /** \defgroup Group_PlatformDrivers System Platform Drivers - LUFA/Platform/Platform.h
  45  *  \brief Hardware platform drivers.
  46  *
  47  *  \section Sec_PlatformDrivers_Dependencies Module Source Dependencies
  48  *  The following files must be built with any user project that uses this module:
  49  *    - <b>UC3 Architecture Only:</b> LUFA/Platform/UC3/InterruptManagement.c <i>(Makefile source module name: LUFA_SRC_PLATFORM)</i>
  50  *    - <b>UC3 Architecture Only:</b> LUFA/Platform/UC3/Exception.S <i>(Makefile source module name: LUFA_SRC_PLATFORM)</i>
  51  *
  52  *  \section Sec_PlatformDrivers_ModDescription Module Description
  53  *  Device-specific hardware platform drivers, for low level hardware configuration and management. The platform
  54  *  drivers are a set of drivers which are designed to provide a high level management layer for the various low level
  55  *  system functions such as clock control and interrupt management.
  56  *
  57  *  User code may choose to either include this master dispatch header file to include all available platform
  58  *  driver header files for the current architecture, or may choose to only include the specific platform driver
  59  *  modules required for a particular application.
  60  *
  61  *  \note The exact APIs and availability of sub-modules within the platform driver group may vary depending on the
  62  *        target used - see individual target module documentation for the API specific to your target processor.
  63  */
  64
  65 #ifndef __LUFA_PLATFORM_H__
  66 #define __LUFA_PLATFORM_H__
  67
  68         /* Includes: */
  69                 #include "../Common/Common.h"
  70
  71         /* Includes: */
  72                 #if (ARCH == ARCH_UC3)
  73                         #include "UC3/ClockManagement.h"
  74                         #include "UC3/InterruptManagement.h"
  75                 #elif (ARCH == ARCH_XMEGA)
  76                         #include "XMEGA/ClockManagement.h"
  77                 #endif
  78
  79 #endif
  80