Upgrade doxygen configuration files to the latest version.

[pub/lufa.git] / LUFA / Drivers / USB / Core / USBController.h

diff --git a/LUFA/Drivers/USB/Core/USBController.h b/LUFA/Drivers/USB/Core/USBController.h
index 44a10e3..8aa2712 100644 (file)
--- a/LUFA/Drivers/USB/Core/USBController.h
+++ b/LUFA/Drivers/USB/Core/USBController.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2021.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -64,7 +64,7 @@
 
        /* Defines: */
                /** \name Endpoint Direction Masks */
-               //@{
+               /**@{*/
                /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
                 *  direction for comparing with the \c ENDPOINT_DIR_* masks.
                 */
@@ -79,10 +79,10 @@
                 *  the index of the address within a device to obtain the full endpoint address.
                 */
                #define ENDPOINT_DIR_IN                    0x80
-               //@}
+               /**@}*/
 
                /** \name Pipe Direction Masks */
-               //@{
+               /**@{*/
                /** Pipe direction mask, for masking against pipe addresses to retrieve the pipe's
                 *  direction for comparing with the \c PIPE_DIR_* masks.
                 */
@@ -97,10 +97,10 @@
                 *  the index of the address within a device to obtain the full endpoint address.
                 */
                #define PIPE_DIR_IN                        0x80
-               //@}
+               /**@}*/
 
                /** \name Endpoint/Pipe Type Masks */
-               //@{
+               /**@{*/
                /** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared
                 *  with the \c EP_TYPE_* masks to determine the exact type of the endpoint.
                 */
@@ -129,7 +129,21 @@
                 *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
                 */
                #define EP_TYPE_INTERRUPT                  0x03
-               //@}
+               /**@}*/
+
+       /* Enums: */
+               /** Enum for the possible USB controller modes, for initialization via \ref USB_Init() and indication back to the
+                *  user application via \ref USB_CurrentMode.
+                */
+               enum USB_Modes_t
+               {
+                       USB_MODE_None   = 0, /**< Indicates that the controller is currently not initialized in any specific USB mode. */
+                       USB_MODE_Device = 1, /**< Indicates that the controller is currently initialized in USB Device mode. */
+                       USB_MODE_Host   = 2, /**< Indicates that the controller is currently initialized in USB Host mode. */
+                       USB_MODE_UID    = 3, /**< Indicates that the controller should determine the USB mode from the UID pin of the
+                                             *   USB connector.
+                                             */
+               };
 
        /* Architecture Includes: */
                #if (ARCH == ARCH_AVR8)