Add more const-ness to the stream endpoint/pipe functions where possible.

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Device.h

diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h
index fdf4ee9..55f4346 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Device.h
+++ b/LUFA/Drivers/USB/LowLevel/Device.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+

   dean [at] fourwalledcubicle [dot] com
   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
   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
   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
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -54,7 +54,7 @@
                #include <avr/pgmspace.h>
                #include <avr/eeprom.h>
 
                #include <avr/pgmspace.h>
                #include <avr/eeprom.h>
 

-               #include "../../../Common/Common.h"     
+               #include "../../../Common/Common.h"

                #include "../HighLevel/StdDescriptors.h"
                #include "USBInterrupt.h"
                #include "Endpoint.h"
                #include "../HighLevel/StdDescriptors.h"
                #include "USBInterrupt.h"
                #include "Endpoint.h"


@@ -67,9 +67,11 @@
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
                #endif
                #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: */
        /* Public Interface - May be used in end-application: */
                /* Macros: */

+                       /** \name USB Device Mode Option Masks */
+                       //@{

                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
                                /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
                                 *  USB interface should be initialized in low speed (1.5Mb/s) mode.
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
                                /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
                                 *  USB interface should be initialized in low speed (1.5Mb/s) mode.


@@ -82,12 +84,13 @@
                                 */
                                #define USB_DEVICE_OPT_LOWSPEED            (1 << 0)
                        #endif
                                 */
                                #define USB_DEVICE_OPT_LOWSPEED            (1 << 0)
                        #endif

-                       
+

                        /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
                         *  USB interface should be initialized in full speed (12Mb/s) mode.
                         */
                        #define USB_DEVICE_OPT_FULLSPEED               (0 << 0)
                        /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
                         *  USB interface should be initialized in full speed (12Mb/s) mode.
                         */
                        #define USB_DEVICE_OPT_FULLSPEED               (0 << 0)

-
+                       //@}
+                       

                /* Function Prototypes: */
                        /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
                         *  be taken out of suspended mode, and communications should resume.
                /* Function Prototypes: */
                        /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
                         *  be taken out of suspended mode, and communications should resume.


@@ -98,9 +101,9 @@
                         *  \note This macro should only be used if the device has indicated to the host that it
                         *        supports the Remote Wakeup feature in the device descriptors, and should only be
                         *        issued if the host is currently allowing remote wakeup events from the device (i.e.,
                         *  \note This macro should only be used if the device has indicated to the host that it
                         *        supports the Remote Wakeup feature in the device descriptors, and should only be
                         *        issued if the host is currently allowing remote wakeup events from the device (i.e.,

-                        *        the \ref USB_RemoteWakeupEnabled flag is set). When the NO_DEVICE_REMOTE_WAKEUP compile
+                        *        the \ref USB_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP compile

                         *        time option is used, this macro is unavailable.
                         *        time option is used, this macro is unavailable.

-                        *        \n
+                        *        \n\n

                         *
                         *  \note The USB clock must be running for this function to operate. If the stack is initialized with
                         *        the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
                         *
                         *  \note The USB clock must be running for this function to operate. If the stack is initialized with
                         *        the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running


@@ -109,7 +112,7 @@
                         *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
                         */
                        void USB_Device_SendRemoteWakeup(void);
                         *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
                         */
                        void USB_Device_SendRemoteWakeup(void);

-                       
+

                /* Type Defines: */
                        enum USB_Device_States_t
                        {
                /* Type Defines: */
                        enum USB_Device_States_t
                        {


@@ -138,49 +141,63 @@
                                                                                *   resumed.
                                                                                */
                        };
                                                                                *   resumed.
                                                                                */
                        };

-                       
+

                /* Inline Functions: */
                /* Inline Functions: */

-                       /** Enables the device mode Start Of Frame events. When enabled, this causes the
-                        *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
-                        *  at the start of each USB frame when enumerated in device mode.
-                        */
-                       static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
-                       static inline void USB_Device_EnableSOFEvents(void)
-                       {
-                               USB_INT_Enable(USB_INT_SOFI);
-                       }
-                               
-                       /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
-                        *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
+                       /** Returns the current USB frame number, when in device mode. Every millisecond the USB bus is active (i.e. enumerated to a host)
+                        *  the frame number is incremented by one.

                         */
                         */

-                       static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
-                       static inline void USB_Device_DisableSOFEvents(void)
+                       static inline uint16_t USB_Device_GetFrameNumber(void)

                        {
                        {

-                               USB_INT_Disable(USB_INT_SOFI);
+                               return UDFNUM;

                        }
                        }

-                       
+
+                       #if !defined(NO_SOF_EVENTS)
+                               /** Enables the device mode Start Of Frame events. When enabled, this causes the
+                                *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
+                                *  at the start of each USB frame when enumerated in device mode.
+                                *
+                                *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
+                                */
+                               static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
+                               static inline void USB_Device_EnableSOFEvents(void)
+                               {
+                                       USB_INT_Enable(USB_INT_SOFI);
+                               }
+
+                               /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
+                                *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
+                                *
+                                *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
+                                */
+                               static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
+                               static inline void USB_Device_DisableSOFEvents(void)
+                               {
+                                       USB_INT_Disable(USB_INT_SOFI);
+                               }
+                       #endif
+

                /* Function Prototypes: */
                        /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,
                /* Function Prototypes: */
                        /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,

-                        *  index and language ID. This function MUST be overridden in the user application (added with full, identical  
+                        *  index and language ID. This function MUST be overridden in the user application (added with full, identical

                         *  prototype and name so that the library can call it to retrieve descriptor data.
                         *
                         *  prototype and name so that the library can call it to retrieve descriptor data.
                         *

-                        *  \param[in] wValue               The type of the descriptor to retrieve in the upper byte, and the index in the 
+                        *  \param[in] wValue               The type of the descriptor to retrieve in the upper byte, and the index in the

                         *                                  lower byte (when more than one descriptor of the given type exists, such as the
                         *                                  case of string descriptors). The type may be one of the standard types defined
                         *                                  in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
                         *                                  lower byte (when more than one descriptor of the given type exists, such as the
                         *                                  case of string descriptors). The type may be one of the standard types defined
                         *                                  in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.

-                        *  \param[in] wIndex               The language ID of the string to return if the wValue type indicates DTYPE_String,
-                        *                                  otherwise zero for standard descriptors, or as defined in a class-specific
-                        *                                  standards.
+                        *  \param[in] wIndex               The language ID of the string to return if the \c wValue type indicates
+                        *                                  \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a
+                        *                                  class-specific standards.

                         *  \param[out] DescriptorAddress   Pointer to the descriptor in memory. This should be set by the routine to
                         *                                  the address of the descriptor.
                         *  \param[out] MemoryAddressSpace  A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
                         *                                  space in which the descriptor is stored. This parameter does not exist when one
                         *  \param[out] DescriptorAddress   Pointer to the descriptor in memory. This should be set by the routine to
                         *                                  the address of the descriptor.
                         *  \param[out] MemoryAddressSpace  A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
                         *                                  space in which the descriptor is stored. This parameter does not exist when one

-                        *                                  of the USE_*_DESCRIPTORS compile time options is used.
+                        *                                  of the \c USE_*_DESCRIPTORS compile time options is used.

                         *
                         *

-                        *  \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute.
+                        *  \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute.

                         *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
                         *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to

-                        *        allow the descriptors to be changed dynamically at runtime) either the USE_RAM_DESCRIPTORS or the 
-                        *        USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D
+                        *        allow the descriptors to be changed dynamically at runtime) either the \c USE_RAM_DESCRIPTORS or the
+                        *        \c USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D

                         *        switch.
                         *
                         *  \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.
                         *        switch.
                         *
                         *  \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.


@@ -202,21 +219,29 @@
                        {
                                UDCON |=  (1 << LSM);
                        }
                        {
                                UDCON |=  (1 << LSM);
                        }

-                       
+

                        static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_Device_SetFullSpeed(void)
                        {
                                UDCON &= ~(1 << LSM);
                        }
                        #endif
                        static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_Device_SetFullSpeed(void)
                        {
                                UDCON &= ~(1 << LSM);
                        }
                        #endif

-                       
+

                        static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
                        static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
                        {
                        static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
                        static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
                        {

-                               UDADDR = ((1 << ADDEN) | (Address & 0x7F));
-                       }                       
+                               UDADDR  = ((UDADDR & (1 << ADDEN)) | (Address & 0x7F));
+                               UDADDR |= (1 << ADDEN);
+                       }
+
+                       static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE;
+                       static inline bool USB_Device_IsAddressSet(void)
+                       {
+                               return (UDADDR & (1 << ADDEN));
+                       }

        #endif
 
 #endif
 
 /** @} */
        #endif
 
 #endif
 
 /** @} */

+