LUFA/Drivers/Board/USBKEY/HWB.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 disclaim 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  *
  33  *  Board specific HWB driver header for the USBKEY.
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the HWB driver
  36  *        dispatch header located in LUFA/Drivers/Board/HWB.h.
  37  */
  38
  39 /** \ingroup Group_HWB
  40  *  @defgroup Group_HWB_USBKEY USBKEY
  41  *
  42  *  @{
  43  */
  44
  45 #ifndef __HWB_USBKEY_H__
  46 #define __HWB_USBKEY_H__
  47
  48         /* Includes: */
  49                 #include <avr/io.h>
  50                 #include <stdbool.h>
  51
  52                 #include "../../../Common/Common.h"
  53
  54         /* Enable C linkage for C++ Compilers: */
  55                 #if defined(__cplusplus)
  56                         extern "C" {
  57                 #endif
  58
  59         /* Preprocessor Checks: */
  60                 #if !defined(INCLUDE_FROM_HWB_H)
  61                         #error Do not include this file directly. Include LUFA/Drivers/Board/HWB.h instead.
  62                 #endif
  63
  64         /* Public Interface - May be used in end-application: */
  65                 /* Inline Functions: */
  66                 #if !defined(__DOXYGEN__)
  67                         static inline void HWB_Init(void)
  68                         {
  69                                 DDRE  &= ~(1 << 2);
  70                                 PORTE |=  (1 << 2);
  71                         }
  72
  73                         static inline bool HWB_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
  74                         static inline bool HWB_GetStatus(void)
  75                         {
  76                                 return (!(PINE & (1 << 2)));
  77                         }
  78                 #endif
  79
  80         /* Disable C linkage for C++ Compilers: */
  81                 #if defined(__cplusplus)
  82                         }
  83                 #endif
  84
  85 #endif
  86
  87 /** @} */