LUFA/Drivers/USB/Core/AVR8/OTG_AVR8.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 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  *  \brief USB OTG definitions for the AVR8 microcontrollers.
  33  *  \copydetails Group_OTG_AVR8
  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_OTG
  40  *  \defgroup Group_OTG_AVR8 USB On The Go (OTG) Management (AVR8)
  41  *  \brief USB OTG definitions for the AVR8 microcontrollers.
  42  *
  43  *  Architecture specific USB OTG definitions for the Atmel 8-bit AVR microcontrollers.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __USBOTG_AVR8_H__
  49 #define __USBOTG_AVR8_H__
  50
  51         /* Includes: */
  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_USB_DRIVER)
  61                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  62                 #endif
  63
  64         /* Public Interface - May be used in end-application: */
  65                 /* Macros: */
  66                         /** Mask for the VBUS pulsing method of SRP, supported by some OTG devices.
  67                          *
  68                          *  \see \ref USB_OTG_Device_InitiateSRP().
  69                          */
  70                         #define USB_OTG_SRP_VBUS                   (1 << SRPSEL)
  71
  72                         /** Mask for the Data + pulsing method of SRP, supported by some OTG devices.
  73                          *
  74                          *  \see \ref USB_OTG_Device_InitiateSRP().
  75                          */
  76                         #define USB_OTG_STP_DATA                   0
  77
  78                 /* Inline Functions: */
  79                         /** Initiate a Host Negotiation Protocol request. This indicates to the other connected device
  80                          *  that the device wishes to change device/host roles.
  81                          */
  82                         static inline void USB_OTG_Device_RequestHNP(void) ATTR_ALWAYS_INLINE;
  83                         static inline void USB_OTG_Device_RequestHNP(void)
  84                         {
  85                                 OTGCON |=  (1 << HNPREQ);
  86                         }
  87
  88                         /** Cancel a Host Negotiation Protocol request. This stops a pending HNP request to the other
  89                          *  connected device.
  90                          */
  91                         static inline void USB_OTG_Device_CancelHNPRequest(void) ATTR_ALWAYS_INLINE;
  92                         static inline void USB_OTG_Device_CancelHNPRequest(void)
  93                         {
  94                                 OTGCON &= ~(1 << HNPREQ);
  95                         }
  96
  97                         /** Determines if the device is currently sending a HNP to an attached host.
  98                          *
  99                          *  \return Boolean \c true if currently sending a HNP to the other connected device, \c false otherwise
 100                          */
 101                         static inline bool USB_OTG_Device_IsSendingHNP(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 102                         static inline bool USB_OTG_Device_IsSendingHNP(void)
 103                         {
 104                                 return ((OTGCON & (1 << HNPREQ)) ? true : false);
 105                         }
 106
 107                         /** Initiates a Session Request Protocol request. Most OTG devices turn off VBUS when the USB
 108                          *  interface is not in use, to conserve power. Sending a SRP to a USB OTG device running in
 109                          *  host mode indicates that VBUS should be applied and a session started.
 110                          *
 111                          *  There are two different methods of sending a SRP - either pulses on the VBUS line, or by
 112                          *  pulsing the Data + line via the internal pull-up resistor.
 113                          *
 114                          *  \param[in] SRPTypeMask  Mask indicating the type of SRP to use, either \ref USB_OTG_SRP_VBUS or
 115                          *                          \ref USB_OTG_STP_DATA.
 116                          */
 117                         static inline void USB_OTG_Device_InitiateSRP(const uint8_t SRPTypeMask) ATTR_ALWAYS_INLINE;
 118                         static inline void USB_OTG_Device_InitiateSRP(const uint8_t SRPTypeMask)
 119                         {
 120                                 OTGCON = ((OTGCON & ~(1 << SRPSEL)) | (SRPTypeMask | (1 << SRPREQ)));
 121                         }
 122
 123                         /** Accepts a HNP from a connected device, indicating that both devices should exchange
 124                          *  device/host roles.
 125                          */
 126                         static inline void USB_OTG_Host_AcceptHNP(void) ATTR_ALWAYS_INLINE;
 127                         static inline void USB_OTG_Host_AcceptHNP(void)
 128                         {
 129                                 OTGCON |=  (1 << HNPREQ);
 130                         }
 131
 132                         /** Rejects a HNP from a connected device, indicating that both devices should remain in their
 133                          *  current device/host roles.
 134                          */
 135                         static inline void USB_OTG_Host_RejectHNP(void) ATTR_ALWAYS_INLINE;
 136                         static inline void USB_OTG_Host_RejectHNP(void)
 137                         {
 138                                 OTGCON &= ~(1 << HNPREQ);
 139                         }
 140
 141                         /** Indicates if the connected device is currently sending a HNP request.
 142                          *
 143                          *  \return Boolean \c true if a HNP is currently being issued by the connected device, \c false otherwise.
 144                          */
 145                         static inline bool USB_OTG_Host_IsHNPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 146                         static inline bool USB_OTG_Host_IsHNPReceived(void)
 147                         {
 148                                 return ((OTGCON & (1 << HNPREQ)) ? true : false);
 149                         }
 150
 151         /* Disable C linkage for C++ Compilers: */
 152                 #if defined(__cplusplus)
 153                         }
 154                 #endif
 155
 156 #endif
 157
 158 /** @} */
 159