X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/7aaced1e8bc81ebbf0a1f06fc443ea4707edd1dd..ef44b8c036daf4806a369dfdcd5adf72cf85b824:/LUFA/Drivers/USB/LowLevel/OTG.h

diff --git a/LUFA/Drivers/USB/LowLevel/OTG.h b/LUFA/Drivers/USB/LowLevel/OTG.h
index 5afa8b3a2..5e096ca7a 100644
--- a/LUFA/Drivers/USB/LowLevel/OTG.h
+++ b/LUFA/Drivers/USB/LowLevel/OTG.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -27,7 +27,7 @@
   arising out of or in connection with the use or performance of
   this software.
 */
- 
+
 /** \file
  *  \brief USB OTG mode definitions.
  *
@@ -54,26 +54,26 @@
 	/* Includes: */
 		#include <avr/io.h>
 		#include <stdbool.h>
-		
+
 		#include "../../../Common/Common.h"
 
 	/* Preprocessor Checks: */
 		#if !defined(__INCLUDE_FROM_USB_DRIVER)
 			#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
 		#endif
-		
+
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
 			/** Mask for the VBUS pulsing method of SRP, supported by some OTG devices.
 			 *
 			 *  \see \ref USB_OTG_Device_InitiateSRP().
-			 */			 
+			 */
 			#define USB_OTG_SRP_VBUS                   (1 << SRPSEL)
 
 			/** Mask for the Data + pulsing method of SRP, supported by some OTG devices.
 			 *
 			 *  \see \ref USB_OTG_Device_InitiateSRP().
-			 */			 
+			 */
 			#define USB_OTG_STP_DATA                   0
 
 		/* Inline Functions: */
@@ -85,7 +85,7 @@
 			{
 				OTGCON |=  (1 << HNPREQ);
 			}
-			
+
 			/** Cancel a Host Negotiation Protocol request. This stops a pending HNP request to the other
 			 *  connected device.
 			 */
@@ -94,17 +94,17 @@
 			{
 				OTGCON &= ~(1 << HNPREQ);
 			}
-			
+
 			/** Determines if the device is currently sending a HNP to an attached host.
 			 *
-			 *  \return Boolean true if currently sending a HNP to the other connected device, false otherwise
+			 *  \return Boolean \c true if currently sending a HNP to the other connected device, \c false otherwise
 			 */
 			static inline bool USB_OTG_Device_IsSendingHNP(void) ATTR_ALWAYS_INLINE;
 			static inline bool USB_OTG_Device_IsSendingHNP(void)
 			{
 				return ((OTGCON & (1 << HNPREQ)) ? true : false);
 			}
-			
+
 			/** Initiates a Session Request Protocol request. Most OTG devices turn off VBUS when the USB
 			 *  interface is not in use, to conserve power. Sending a SRP to a USB OTG device running in
 			 *  host mode indicates that VBUS should be applied and a session started.
@@ -129,7 +129,7 @@
 			{
 				OTGCON |=  (1 << HNPREQ);
 			}
-			
+
 			/** Rejects a HNP from a connected device, indicating that both devices should remain in their
 			 *  current device/host roles.
 			 */
@@ -138,17 +138,18 @@
 			{
 				OTGCON &= ~(1 << HNPREQ);
 			}
-			
+
 			/** Indicates if the connected device is not currently sending a HNP request.
 			 *
-			 *  \return Boolean true if a HNP is currently being issued by the connected device, false otherwise.
+			 *  \return Boolean \c true if a HNP is currently being issued by the connected device, \c false otherwise.
 			 */
 			static inline bool USB_OTG_Host_IsHNPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 			static inline bool USB_OTG_Host_IsHNPReceived(void)
 			{
 				return ((OTGCON & (1 << HNPREQ)) ? true : false);
 			}
-	
+
 #endif
-			
+
 /** @} */
+