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

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Pipe.c

diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.c b/LUFA/Drivers/USB/LowLevel/Pipe.c
index 0131930..82a9c1a 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Pipe.c
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.c
@@ -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


@@ -33,25 +33,81 @@
 
 #if defined(USB_CAN_BE_HOST)
 
 
 #if defined(USB_CAN_BE_HOST)
 

-#define  __INCLUDE_FROM_PIPE_C

 #include "Pipe.h"
 
 uint8_t USB_ControlPipeSize = PIPE_CONTROLPIPE_DEFAULT_SIZE;
 
 #include "Pipe.h"
 
 uint8_t USB_ControlPipeSize = PIPE_CONTROLPIPE_DEFAULT_SIZE;
 

-bool Pipe_ConfigurePipe(const uint8_t Number, const uint8_t Type, const uint8_t Token, const uint8_t EndpointNumber,
-                                               const uint16_t Size, const uint8_t Banks)
+bool Pipe_ConfigurePipe(const uint8_t Number,
+                        const uint8_t Type,
+                        const uint8_t Token,
+                        const uint8_t EndpointNumber,
+                        const uint16_t Size,
+                        const uint8_t Banks)

 {
 {

+#if defined(ORDERED_EP_CONFIG)

        Pipe_SelectPipe(Number);
        Pipe_EnablePipe();
 
        UPCFG1X = 0;
        Pipe_SelectPipe(Number);
        Pipe_EnablePipe();
 
        UPCFG1X = 0;

-       
+

        UPCFG0X = ((Type << EPTYPE0) | Token | ((EndpointNumber & PIPE_EPNUM_MASK) << PEPNUM0));
        UPCFG1X = ((1 << ALLOC) | Banks | Pipe_BytesToEPSizeMask(Size));
 
        Pipe_SetInfiniteINRequests();
 
        return Pipe_IsConfigured();
        UPCFG0X = ((Type << EPTYPE0) | Token | ((EndpointNumber & PIPE_EPNUM_MASK) << PEPNUM0));
        UPCFG1X = ((1 << ALLOC) | Banks | Pipe_BytesToEPSizeMask(Size));
 
        Pipe_SetInfiniteINRequests();
 
        return Pipe_IsConfigured();

+#else  
+       for (uint8_t PNum = Number; PNum < PIPE_TOTAL_PIPES; PNum++)
+       {
+               uint8_t UPCFG0XTemp;
+               uint8_t UPCFG1XTemp;
+               uint8_t UPCFG2XTemp;
+               uint8_t UPCONXTemp;
+               uint8_t UPINRQXTemp;
+               uint8_t UPIENXTemp;
+
+               Pipe_SelectPipe(PNum);
+               
+               if (PNum == Number)
+               {
+                       UPCFG0XTemp = ((Type << EPTYPE0) | Token | ((EndpointNumber & PIPE_EPNUM_MASK) << PEPNUM0));
+                       UPCFG1XTemp = ((1 << ALLOC) | Banks | Pipe_BytesToEPSizeMask(Size));
+                       UPCFG2XTemp = 0;
+                       UPCONXTemp  = ((1 << PEN) | (1 << INMODE));
+                       UPINRQXTemp = 0;
+                       UPIENXTemp  = 0;
+               }
+               else
+               {
+                       UPCFG0XTemp = UPCFG0X;
+                       UPCFG1XTemp = UPCFG1X;
+                       UPCFG2XTemp = UPCFG2X;
+                       UPCONXTemp  = UPCONX;
+                       UPINRQXTemp = UPINRQX;
+                       UPIENXTemp  = UPIENX;
+               }
+
+               if (!(UPCFG1XTemp & (1 << ALLOC)))
+                 continue;
+                 
+               Pipe_DisablePipe();
+               UPCFG1X &= (1 << ALLOC);
+
+               Pipe_EnablePipe();
+               UPCFG0X = UPCFG0XTemp;
+               UPCFG1X = UPCFG1XTemp;
+               UPCFG2X = UPCFG2XTemp;
+               UPCONX  = UPCONXTemp;
+               UPINRQX = UPINRQXTemp;
+               UPIENX  = UPIENXTemp;
+
+               if (!(Pipe_IsConfigured()))
+                 return false;         
+       }
+               
+       Pipe_SelectPipe(Number);        
+       return true;
+#endif

 }
 
 void Pipe_ClearPipes(void)
 }
 
 void Pipe_ClearPipes(void)


@@ -60,13 +116,10 @@ void Pipe_ClearPipes(void)
 
        for (uint8_t PNum = 0; PNum < PIPE_TOTAL_PIPES; PNum++)
        {
 
        for (uint8_t PNum = 0; PNum < PIPE_TOTAL_PIPES; PNum++)
        {

-               Pipe_ResetPipe(PNum);

                Pipe_SelectPipe(PNum);
                Pipe_SelectPipe(PNum);

-               UPIENX = 0;
-               UPINTX = 0;
-               Pipe_ClearError();
-               Pipe_ClearErrorFlags();
-               Pipe_DeallocateMemory();
+               UPIENX  = 0;
+               UPINTX  = 0;
+               UPCFG1X = 0;

                Pipe_DisablePipe();
        }
 }
                Pipe_DisablePipe();
        }
 }


@@ -78,17 +131,20 @@ bool Pipe_IsEndpointBound(const uint8_t EndpointAddress)
        for (uint8_t PNum = 0; PNum < PIPE_TOTAL_PIPES; PNum++)
        {
                Pipe_SelectPipe(PNum);
        for (uint8_t PNum = 0; PNum < PIPE_TOTAL_PIPES; PNum++)
        {
                Pipe_SelectPipe(PNum);

-               
-               uint8_t PipeToken = Pipe_GetPipeToken();
+
+               if (!(Pipe_IsConfigured()))
+                 continue;
+
+               uint8_t PipeToken        = Pipe_GetPipeToken();

                bool    PipeTokenCorrect = true;
 
                if (PipeToken != PIPE_TOKEN_SETUP)
                  PipeTokenCorrect = (PipeToken == ((EndpointAddress & PIPE_EPDIR_MASK) ? PIPE_TOKEN_IN : PIPE_TOKEN_OUT));
                bool    PipeTokenCorrect = true;
 
                if (PipeToken != PIPE_TOKEN_SETUP)
                  PipeTokenCorrect = (PipeToken == ((EndpointAddress & PIPE_EPDIR_MASK) ? PIPE_TOKEN_IN : PIPE_TOKEN_OUT));

-               
-               if (Pipe_IsConfigured() && PipeTokenCorrect && (Pipe_BoundEndpointNumber() == (EndpointAddress & PIPE_EPNUM_MASK)))
+
+               if (PipeTokenCorrect && (Pipe_BoundEndpointNumber() == (EndpointAddress & PIPE_EPNUM_MASK)))

                  return true;
        }
                  return true;
        }

-       
+

        Pipe_SelectPipe(PrevPipeNumber);
        return false;
 }
        Pipe_SelectPipe(PrevPipeNumber);
        return false;
 }


@@ -96,11 +152,13 @@ bool Pipe_IsEndpointBound(const uint8_t EndpointAddress)
 uint8_t Pipe_WaitUntilReady(void)
 {
        #if (USB_STREAM_TIMEOUT_MS < 0xFF)
 uint8_t Pipe_WaitUntilReady(void)
 {
        #if (USB_STREAM_TIMEOUT_MS < 0xFF)

-       uint8_t  TimeoutMSRem = USB_STREAM_TIMEOUT_MS;  
+       uint8_t  TimeoutMSRem = USB_STREAM_TIMEOUT_MS;

        #else
        uint16_t TimeoutMSRem = USB_STREAM_TIMEOUT_MS;
        #endif
        #else
        uint16_t TimeoutMSRem = USB_STREAM_TIMEOUT_MS;
        #endif

-       
+
+       uint16_t PreviousFrameNumber = USB_Host_GetFrameNumber();
+

        for (;;)
        {
                if (Pipe_GetPipeToken() == PIPE_TOKEN_IN)
        for (;;)
        {
                if (Pipe_GetPipeToken() == PIPE_TOKEN_IN)


@@ -111,17 +169,19 @@ uint8_t Pipe_WaitUntilReady(void)
                else
                {
                        if (Pipe_IsOUTReady())
                else
                {
                        if (Pipe_IsOUTReady())

-                         return PIPE_READYWAIT_NoError;                
+                         return PIPE_READYWAIT_NoError;

                }
 
                if (Pipe_IsStalled())
                  return PIPE_READYWAIT_PipeStalled;
                else if (USB_HostState == HOST_STATE_Unattached)
                  return PIPE_READYWAIT_DeviceDisconnected;
                }
 
                if (Pipe_IsStalled())
                  return PIPE_READYWAIT_PipeStalled;
                else if (USB_HostState == HOST_STATE_Unattached)
                  return PIPE_READYWAIT_DeviceDisconnected;

-                         
-               if (USB_INT_HasOccurred(USB_INT_HSOFI))
+
+               uint16_t CurrentFrameNumber = USB_Host_GetFrameNumber();
+
+               if (CurrentFrameNumber != PreviousFrameNumber)

                {
                {

-                       USB_INT_Clear(USB_INT_HSOFI);
+                       PreviousFrameNumber = CurrentFrameNumber;

 
                        if (!(TimeoutMSRem--))
                          return PIPE_READYWAIT_Timeout;
 
                        if (!(TimeoutMSRem--))
                          return PIPE_READYWAIT_Timeout;


@@ -129,164 +189,5 @@ uint8_t Pipe_WaitUntilReady(void)
        }
 }
 
        }
 }
 

-uint8_t Pipe_Discard_Stream(uint16_t Length
-#if !defined(NO_STREAM_CALLBACKS)
-                                 , StreamCallbackPtr_t Callback

 #endif
 #endif

-                                                                )
-{
-       uint8_t  ErrorCode;
-       
-       Pipe_SetPipeToken(PIPE_TOKEN_IN);
-
-       if ((ErrorCode = Pipe_WaitUntilReady()))
-         return ErrorCode;
-
-       #if defined(FAST_STREAM_TRANSFERS)
-       uint8_t BytesRemToAlignment = (Pipe_BytesInPipe() & 0x07);
-
-       if (Length >= 8)
-       {
-               Length -= BytesRemToAlignment;
-
-               switch (BytesRemToAlignment)
-               {
-                       default:
-                               do
-                               {
-                                       if (!(Pipe_IsReadWriteAllowed()))
-                                       {
-                                               Pipe_ClearIN();
-                                                       
-                                               #if !defined(NO_STREAM_CALLBACKS)
-                                               if ((Callback != NULL) && (Callback() == STREAMCALLBACK_Abort))
-                                                 return PIPE_RWSTREAM_CallbackAborted;
-                                               #endif
-
-                                               if ((ErrorCode = Pipe_WaitUntilReady()))
-                                                 return ErrorCode;
-                                       }
-
-                                       Length -= 8;
-                                       
-                                       Pipe_Discard_Byte();
-                       case 7: Pipe_Discard_Byte();
-                       case 6: Pipe_Discard_Byte();
-                       case 5: Pipe_Discard_Byte();
-                       case 4: Pipe_Discard_Byte();
-                       case 3: Pipe_Discard_Byte();
-                       case 2: Pipe_Discard_Byte();
-                       case 1: Pipe_Discard_Byte();
-                               } while (Length >= 8);  
-               }
-       }
-       #endif

 
 

-       while (Length)
-       {
-               if (!(Pipe_IsReadWriteAllowed()))
-               {
-                       Pipe_ClearIN();
-                               
-                       #if !defined(NO_STREAM_CALLBACKS)
-                       if ((Callback != NULL) && (Callback() == STREAMCALLBACK_Abort))
-                         return PIPE_RWSTREAM_CallbackAborted;
-                       #endif
-
-                       if ((ErrorCode = Pipe_WaitUntilReady()))
-                         return ErrorCode;
-               }
-               else
-               {
-                       Pipe_Discard_Byte();
-                       Length--;
-               }
-       }
-
-       return PIPE_RWSTREAM_NoError;
-}
-
-/* The following abuses the C preprocessor in order to copy-past common code with slight alterations,
- * so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Write_Stream_LE
-#define  TEMPLATE_BUFFER_TYPE                      const void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            0
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(*((uint8_t*)BufferPtr++))
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Write_PStream_LE
-#define  TEMPLATE_BUFFER_TYPE                      const void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            0
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(pgm_read_byte((uint8_t*)BufferPtr++))
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Write_EStream_LE
-#define  TEMPLATE_BUFFER_TYPE                      const void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            0
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(eeprom_read_byte((uint8_t*)BufferPtr++))
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Write_Stream_BE
-#define  TEMPLATE_BUFFER_TYPE                      const void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(*((uint8_t*)BufferPtr--))
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Write_PStream_BE
-#define  TEMPLATE_BUFFER_TYPE                      const void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(pgm_read_byte((uint8_t*)BufferPtr--))
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Write_EStream_BE
-#define  TEMPLATE_BUFFER_TYPE                      const void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(eeprom_read_byte((uint8_t*)BufferPtr--))
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Read_Stream_LE
-#define  TEMPLATE_BUFFER_TYPE                      void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            0
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *((uint8_t*)BufferPtr++) = Pipe_Read_Byte()
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Read_EStream_LE
-#define  TEMPLATE_BUFFER_TYPE                      void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            0
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr++, Pipe_Read_Byte())
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Read_Stream_BE
-#define  TEMPLATE_BUFFER_TYPE                      void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *((uint8_t*)BufferPtr--) = Pipe_Read_Byte()
-#include "Template/Template_Pipe_RW.c"
-
-#define  TEMPLATE_FUNC_NAME                        Pipe_Read_EStream_BE
-#define  TEMPLATE_BUFFER_TYPE                      void*
-#define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
-#define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
-#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr--, Pipe_Read_Byte())
-#include "Template/Template_Pipe_RW.c"
-
-#endif