Fixed PDI/TPI programming speed of ~250KHz in the AVRISP-MKII Clone project, instead...

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

diff --git a/LUFA/Drivers/USB/LowLevel/USBController.h b/LUFA/Drivers/USB/LowLevel/USBController.h
index 8a2fec7..47233bc 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/USBController.h
+++ b/LUFA/Drivers/USB/LowLevel/USBController.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


@@ -37,7 +37,7 @@
  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  */
  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  */

- 
+

 /** \ingroup Group_USB
  *  @defgroup Group_USBManagement USB Interface Management
  *
 /** \ingroup Group_USB
  *  @defgroup Group_USBManagement USB Interface Management
  *


@@ -53,7 +53,7 @@
                #include <avr/io.h>
                #include <avr/interrupt.h>
                #include <stdbool.h>
                #include <avr/io.h>
                #include <avr/interrupt.h>
                #include <stdbool.h>

-               
+

                #include "../HighLevel/USBMode.h"
 
                #include "../../../Common/Common.h"
                #include "../HighLevel/USBMode.h"
 
                #include "../../../Common/Common.h"


@@ -61,7 +61,7 @@
                #include "../HighLevel/Events.h"
                #include "../HighLevel/USBTask.h"
                #include "USBInterrupt.h"
                #include "../HighLevel/Events.h"
                #include "../HighLevel/USBTask.h"
                #include "USBInterrupt.h"

-               
+

                #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
                        #include "Host.h"
                        #include "OTG.h"
                #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
                        #include "Host.h"
                        #include "OTG.h"


@@ -69,7 +69,7 @@
                        #include "../HighLevel/HostStandardReq.h"
                        #include "../HighLevel/PipeStream.h"
                #endif
                        #include "../HighLevel/HostStandardReq.h"
                        #include "../HighLevel/PipeStream.h"
                #endif

-               
+

                #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
                        #include "Device.h"
                        #include "Endpoint.h"
                #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
                        #include "Device.h"
                        #include "Endpoint.h"


@@ -90,7 +90,7 @@
                #if !defined(F_CLOCK)
                        #error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled input clock in your project makefile.
                #endif
                #if !defined(F_CLOCK)
                        #error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled input clock in your project makefile.
                #endif

-       
+

                #if (F_CLOCK == 8000000)
                        #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
                             defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
                #if (F_CLOCK == 8000000)
                        #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
                             defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \


@@ -116,13 +116,15 @@
                                #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP0))
                        #endif
                #endif
                                #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP0))
                        #endif
                #endif

-               
+

                #if !defined(USB_PLL_PSC)
                #if !defined(USB_PLL_PSC)

-                       #error No PLL prescale value available for chosen F_CPU value and AVR model.
+                       #error No PLL prescale value available for chosen F_CLOCK value and AVR model.

                #endif
                #endif

-               
+

        /* Public Interface - May be used in end-application: */
        /* Public Interface - May be used in end-application: */

-               /* Macros: */                   
+               /* Macros: */
+                       /** \name USB Controller Option Masks */
+                       //@{

                        /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
                         *  regulator should be enabled to regulate the data pin voltages to within the USB standard.
                         *
                        /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
                         *  regulator should be enabled to regulate the data pin voltages to within the USB standard.
                         *


@@ -136,7 +138,7 @@
                         *  \note See USB AVR data sheet for more information on the internal pad regulator.
                         */
                        #define USB_OPT_REG_ENABLED                (0 << 1)
                         *  \note See USB AVR data sheet for more information on the internal pad regulator.
                         */
                        #define USB_OPT_REG_ENABLED                (0 << 1)

-                       
+

                        /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application
                         *  will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
                         *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
                        /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application
                         *  will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
                         *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.


@@ -148,7 +150,10 @@
                         *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
                         */
                        #define USB_OPT_AUTO_PLL                   (0 << 2)
                         *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
                         */
                        #define USB_OPT_AUTO_PLL                   (0 << 2)

-
+                       //@}
+                       
+                       /** \name Endpoint/Pipe Type Masks */
+                       //@{

                        /** Mask for a CONTROL type endpoint or pipe.
                         *
                         *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
                        /** Mask for a CONTROL type endpoint or pipe.
                         *
                         *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.


@@ -172,18 +177,19 @@
                         *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
                         */
                        #define EP_TYPE_INTERRUPT                  0x03
                         *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
                         */
                        #define EP_TYPE_INTERRUPT                  0x03

+                       //@}

 
                        #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
                                /** Constant for the maximum software timeout period of the USB data stream transfer functions
                                 *  (both control and standard) when in either device or host mode. If the next packet of a stream
                                 *  is not received or acknowledged within this time period, the stream function will fail.
                                 *
 
                        #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
                                /** Constant for the maximum software timeout period of the USB data stream transfer functions
                                 *  (both control and standard) when in either device or host mode. If the next packet of a stream
                                 *  is not received or acknowledged within this time period, the stream function will fail.
                                 *

-                                *  This value may be overridden in the user project makefile as the value of the 
+                                *  This value may be overridden in the user project makefile as the value of the

                                 *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
                                 */
                                #define USB_STREAM_TIMEOUT_MS       100
                        #endif
                                 *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
                                 */
                                #define USB_STREAM_TIMEOUT_MS       100
                        #endif

-               
+

                /* Inline Functions: */
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
                                /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power),
                /* Inline Functions: */
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
                                /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power),


@@ -246,21 +252,21 @@
                         *                      PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
                         *                      mode speed.
                         *
                         *                      PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
                         *                      mode speed.
                         *

-                        *  \note To reduce the FLASH requirements of the library if only device or host mode is required, 
+                        *  \note To reduce the FLASH requirements of the library if only device or host mode is required,

                         *        the mode can be statically set in the project makefile by defining the token USB_DEVICE_ONLY
                         *        the mode can be statically set in the project makefile by defining the token USB_DEVICE_ONLY

-                        *        (for device mode) or USB_HOST_ONLY (for host mode), passing the token to the compiler 
+                        *        (for device mode) or USB_HOST_ONLY (for host mode), passing the token to the compiler

                         *        via the -D switch. If the mode is statically set, this parameter does not exist in the
                         *        function prototype.
                         *        \n\n
                         *
                         *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,
                         *        via the -D switch. If the mode is statically set, this parameter does not exist in the
                         *        function prototype.
                         *        \n\n
                         *
                         *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,

-                        *        the options may be set statically in the same manner as the mode (see the Mode parameter of 
+                        *        the options may be set statically in the same manner as the mode (see the Mode parameter of

                         *        this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token,
                         *        defined to the appropriate options masks. When the options are statically set, this
                         *        parameter does not exist in the function prototype.
                         *        \n\n
                         *        this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token,
                         *        defined to the appropriate options masks. When the options are statically set, this
                         *        parameter does not exist in the function prototype.
                         *        \n\n

-                        *        
-                        *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB 
+                        *
+                        *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB

                         *        AVR models which only implement the USB device mode in hardware.
                         *
                         *  \see Device.h for the USB_DEVICE_OPT_* masks.
                         *        AVR models which only implement the USB device mode in hardware.
                         *
                         *  \see Device.h for the USB_DEVICE_OPT_* masks.


@@ -280,7 +286,7 @@
                                       const uint8_t Options
                                       #endif
                                       );
                                       const uint8_t Options
                                       #endif
                                       );

-                       
+

                        /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
                         *  memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
                         *  is restarted with the \ref USB_Init() function.
                        /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
                         *  memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
                         *  is restarted with the \ref USB_Init() function.


@@ -314,7 +320,7 @@
                        #elif defined(USB_DEVICE_ONLY)
                                #define USB_CurrentMode USB_MODE_Device
                        #endif
                        #elif defined(USB_DEVICE_ONLY)
                                #define USB_CurrentMode USB_MODE_Device
                        #endif

-                       
+

                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
                                /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
                                 *  was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.
                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
                                /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
                                 *  was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.


@@ -348,12 +354,12 @@
                                #if defined(USB_CAN_BE_DEVICE)
                                static void USB_Init_Device(void);
                                #endif
                                #if defined(USB_CAN_BE_DEVICE)
                                static void USB_Init_Device(void);
                                #endif

-                               
+

                                #if defined(USB_CAN_BE_HOST)
                                static void USB_Init_Host(void);
                                #endif
                        #endif
                                #if defined(USB_CAN_BE_HOST)
                                static void USB_Init_Host(void);
                                #endif
                        #endif

-       
+

                /* Inline Functions: */
                        static inline void USB_PLL_On(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_PLL_On(void)
                /* Inline Functions: */
                        static inline void USB_PLL_On(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_PLL_On(void)


@@ -361,13 +367,13 @@
                                PLLCSR  = USB_PLL_PSC;
                                PLLCSR |= (1 << PLLE);
                        }
                                PLLCSR  = USB_PLL_PSC;
                                PLLCSR |= (1 << PLLE);
                        }

-                       
+

                        static inline void USB_PLL_Off(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_PLL_Off(void)
                        {
                                PLLCSR  = 0;
                        }
                        static inline void USB_PLL_Off(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_PLL_Off(void)
                        {
                                PLLCSR  = 0;
                        }

-                       
+

                        static inline bool USB_PLL_IsReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
                        static inline bool USB_PLL_IsReady(void)
                        {
                        static inline bool USB_PLL_IsReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
                        static inline bool USB_PLL_IsReady(void)
                        {


@@ -381,7 +387,7 @@
                                UHWCON  |=  (1 << UVREGE);
                        #else
                                REGCR   &= ~(1 << REGDIS);
                                UHWCON  |=  (1 << UVREGE);
                        #else
                                REGCR   &= ~(1 << REGDIS);

-                       #endif                  
+                       #endif

                        }
 
                        static inline void USB_REG_Off(void) ATTR_ALWAYS_INLINE;
                        }
 
                        static inline void USB_REG_Off(void) ATTR_ALWAYS_INLINE;


@@ -391,9 +397,9 @@
                                UHWCON  &= ~(1 << UVREGE);
                        #else
                                REGCR   |=  (1 << REGDIS);
                                UHWCON  &= ~(1 << UVREGE);
                        #else
                                REGCR   |=  (1 << REGDIS);

-                       #endif                  
+                       #endif

                        }
                        }

-                       
+

                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
                        static inline void USB_OTGPAD_On(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_OTGPAD_On(void)
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
                        static inline void USB_OTGPAD_On(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_OTGPAD_On(void)


@@ -413,13 +419,13 @@
                        {
                                USBCON  |=  (1 << FRZCLK);
                        }
                        {
                                USBCON  |=  (1 << FRZCLK);
                        }

-                       
+

                        static inline void USB_CLK_Unfreeze(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_CLK_Unfreeze(void)
                        {
                                USBCON  &= ~(1 << FRZCLK);
                        }
                        static inline void USB_CLK_Unfreeze(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_CLK_Unfreeze(void)
                        {
                                USBCON  &= ~(1 << FRZCLK);
                        }

-                       
+

                        static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_Controller_Enable(void)
                        {
                        static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE;
                        static inline void USB_Controller_Enable(void)
                        {


@@ -436,11 +442,11 @@
                        static inline void USB_Controller_Reset(void)
                        {
                                const uint8_t Temp = USBCON;
                        static inline void USB_Controller_Reset(void)
                        {
                                const uint8_t Temp = USBCON;

-                               
+

                                USBCON = (Temp & ~(1 << USBE));
                                USBCON = (Temp |  (1 << USBE));
                        }
                                USBCON = (Temp & ~(1 << USBE));
                                USBCON = (Temp |  (1 << USBE));
                        }

-       
+

                        #if defined(USB_CAN_BE_BOTH)
                        static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
                        static inline uint8_t USB_GetUSBModeFromUID(void)
                        #if defined(USB_CAN_BE_BOTH)
                        static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
                        static inline uint8_t USB_GetUSBModeFromUID(void)


@@ -453,12 +459,13 @@
                        #endif
 
        #endif
                        #endif
 
        #endif

-       
+

        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif

-                       
+

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

+