LUFA/Drivers/USB/Core/OTG.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2018.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2018  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 Common USB OTG definitions for all architectures.
  33  *  \copydetails Group_OTG
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  36  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  37  */
  38
  39 /** \ingroup Group_USB
  40  *  \defgroup Group_OTG USB On The Go (OTG) Management
  41  *  \brief USB OTG management definitions.
  42  *
  43  *  This module contains macros for embedded USB hosts with dual role On The Go capabilities, for managing role
  44  *  exchange. OTG is a way for two USB dual role devices to talk to one another directly without fixed device/host
  45  *  roles.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef __USBOTG_H__
  51 #define __USBOTG_H__
  52
  53         /* Includes: */
  54                 #include "../../../Common/Common.h"
  55                 #include "USBMode.h"
  56
  57         /* Enable C linkage for C++ Compilers: */
  58                 #if defined(__cplusplus)
  59                         extern "C" {
  60                 #endif
  61
  62         /* Preprocessor Checks: */
  63                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  64                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  65                 #endif
  66
  67         /* Architecture Includes: */
  68                 #if (ARCH == ARCH_AVR8)
  69                         #include "AVR8/OTG_AVR8.h"
  70                 #endif
  71
  72         /* Disable C linkage for C++ Compilers: */
  73                 #if defined(__cplusplus)
  74                         }
  75                 #endif
  76
  77 #endif
  78
  79 /** @} */
  80