Platform.h 3.5 KB

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