LUFA/Drivers/USB/Core/UC3B/OTG_UC3B.h

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