Readd incomplete MIDIToneGenerator project, which can now correctly generate up to...

[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 b595564..3c5d7cf 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Device.h
+++ b/LUFA/Drivers/USB/LowLevel/Device.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   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 2010  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


@@ -50,11 +50,13 @@
 #define __USBDEVICE_H__
 
        /* Includes: */
 #define __USBDEVICE_H__
 
        /* Includes: */

+               #include <avr/io.h>

                #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 "../HighLevel/StdDescriptors.h"

+               #include "USBInterrupt.h"

                #include "Endpoint.h"
 
        /* Preprocessor Checks: */
                #include "Endpoint.h"
 
        /* Preprocessor Checks: */


@@ -65,27 +67,30 @@
                #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.
                                 *
                                 *  \note Low Speed mode is not available on all USB AVR models.
                        #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.
                                 *
                                 *  \note Low Speed mode is not available on all USB AVR models.

-                                *        \n\n
+                                *        \n

                                 *
                                 *  \note Restrictions apply on the number, size and type of endpoints which can be used
                                 *
                                 *  \note Restrictions apply on the number, size and type of endpoints which can be used

-                                *        when running in low speed mode -- refer to the USB 2.0 standard.
+                                *        when running in low speed mode - refer to the USB 2.0 specification.

                                 */
                                #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,29 +103,16 @@
                         *        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
                         *        time option is used, this macro is unavailable.
                         *        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
                         *        time option is used, this macro is unavailable.

+                        *        \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
+                        *        before attempting to call this function.

                         *
                         *  \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);

-                                                       
-               /* Pseudo-Function Macros: */
-                       #if defined(__DOXYGEN__)                                
-                               /** 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 bool USB_Device_EnableSOFEvents(void);
-                               
-                               /** Disables the device mode Start Of Frame events. When disabled, this stop the firing of the
-                                *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
-                                */
-                               static inline bool USB_Device_DisableSOFEvents(void);
-                       #else
-                               #define USB_Device_EnableSOFEvents()    MACROS{ USB_INT_Enable(USB_INT_SOFI); }MACROE

 
 

-                               #define USB_Device_DisableSOFEvents()   MACROS{ USB_INT_Disable(USB_INT_SOFI); }MACROE
-                       #endif
-                       

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


@@ -149,13 +141,47 @@
                                                                                *   resumed.
                                                                                */
                        };
                                                                                *   resumed.
                                                                                */
                        };

-                       
+
+               /* Inline Functions: */
+                       /** 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 uint16_t USB_Device_GetFrameNumber(void)
+                       {
+                               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 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 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.


@@ -170,26 +196,52 @@
                         *
                         *  \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute.
                         *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
                         *
                         *  \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute.
                         *        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 
+                        *        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
                         *        switch.
                         *
                         *  \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.
                         */
                         *        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.
                         */

-                       uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress
+                       uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
+                                                           const uint8_t wIndex,
+                                                           const void** const DescriptorAddress

                        #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
                                                            , uint8_t* MemoryAddressSpace
                        #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
                                                            , uint8_t* MemoryAddressSpace

-                       #endif                  
-                                                           )
-                                                                                   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
+                       #endif
+                                                           ) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);

 
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
 
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)

-               /* Macros: */           
-                       #define USB_Device_SetLowSpeed()        MACROS{ UDCON |=  (1 << LSM);   }MACROE
-                       #define USB_Device_SetFullSpeed()       MACROS{ UDCON &= ~(1 << LSM);   }MACROE
+               /* Inline Functions: */
+                       #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))
+                       static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
+                       static inline void USB_Device_SetLowSpeed(void)
+                       {
+                               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_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
+                       static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
+                       {
+                               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
 
 /** @} */

+