LUFA/Drivers/USB/LowLevel/Pipe.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 #define  __INCLUDE_FROM_USB_DRIVER
  32 #include "../HighLevel/USBMode.h"
  33
  34 #if defined(USB_CAN_BE_HOST)
  35
  36 #define  __INCLUDE_FROM_PIPE_C
  37 #include "Pipe.h"
  38
  39 uint8_t USB_ControlPipeSize = PIPE_CONTROLPIPE_DEFAULT_SIZE;
  40
  41 bool Pipe_ConfigurePipe(const uint8_t Number, const uint8_t Type, const uint8_t Token, const uint8_t EndpointNumber,
  42                                                 const uint16_t Size, const uint8_t Banks)
  43 {
  44         Pipe_SelectPipe(Number);
  45         Pipe_EnablePipe();
  46
  47         UPCFG1X = 0;
  48
  49         UPCFG0X = ((Type << EPTYPE0) | Token | ((EndpointNumber & PIPE_EPNUM_MASK) << PEPNUM0));
  50         UPCFG1X = ((1 << ALLOC) | Banks | Pipe_BytesToEPSizeMask(Size));
  51
  52         Pipe_SetInfiniteINRequests();
  53
  54         return Pipe_IsConfigured();
  55 }
  56
  57 void Pipe_ClearPipes(void)
  58 {
  59         UPINT = 0;
  60
  61         for (uint8_t PNum = 0; PNum < PIPE_TOTAL_PIPES; PNum++)
  62         {
  63                 Pipe_ResetPipe(PNum);
  64                 Pipe_SelectPipe(PNum);
  65                 UPIENX = 0;
  66                 UPINTX = 0;
  67                 Pipe_ClearError();
  68                 Pipe_ClearErrorFlags();
  69                 Pipe_DeallocateMemory();
  70                 Pipe_DisablePipe();
  71         }
  72 }
  73
  74 bool Pipe_IsEndpointBound(const uint8_t EndpointAddress)
  75 {
  76         uint8_t PrevPipeNumber = Pipe_GetCurrentPipe();
  77
  78         for (uint8_t PNum = 0; PNum < PIPE_TOTAL_PIPES; PNum++)
  79         {
  80                 Pipe_SelectPipe(PNum);
  81
  82                 uint8_t PipeToken = Pipe_GetPipeToken();
  83                 bool    PipeTokenCorrect = true;
  84
  85                 if (PipeToken != PIPE_TOKEN_SETUP)
  86                   PipeTokenCorrect = (PipeToken == ((EndpointAddress & PIPE_EPDIR_MASK) ? PIPE_TOKEN_IN : PIPE_TOKEN_OUT));
  87
  88                 if (Pipe_IsConfigured() && PipeTokenCorrect && (Pipe_BoundEndpointNumber() == (EndpointAddress & PIPE_EPNUM_MASK)))
  89                   return true;
  90         }
  91
  92         Pipe_SelectPipe(PrevPipeNumber);
  93         return false;
  94 }
  95
  96 uint8_t Pipe_WaitUntilReady(void)
  97 {
  98         #if (USB_STREAM_TIMEOUT_MS < 0xFF)
  99         uint8_t  TimeoutMSRem = USB_STREAM_TIMEOUT_MS;
 100         #else
 101         uint16_t TimeoutMSRem = USB_STREAM_TIMEOUT_MS;
 102         #endif
 103
 104         for (;;)
 105         {
 106                 if (Pipe_GetPipeToken() == PIPE_TOKEN_IN)
 107                 {
 108                         if (Pipe_IsINReceived())
 109                           return PIPE_READYWAIT_NoError;
 110                 }
 111                 else
 112                 {
 113                         if (Pipe_IsOUTReady())
 114                           return PIPE_READYWAIT_NoError;
 115                 }
 116
 117                 if (Pipe_IsStalled())
 118                   return PIPE_READYWAIT_PipeStalled;
 119                 else if (USB_HostState == HOST_STATE_Unattached)
 120                   return PIPE_READYWAIT_DeviceDisconnected;
 121
 122                 if (USB_INT_HasOccurred(USB_INT_HSOFI))
 123                 {
 124                         USB_INT_Clear(USB_INT_HSOFI);
 125
 126                         if (!(TimeoutMSRem--))
 127                           return PIPE_READYWAIT_Timeout;
 128                 }
 129         }
 130 }
 131
 132 uint8_t Pipe_Discard_Stream(uint16_t Length
 133 #if !defined(NO_STREAM_CALLBACKS)
 134                                  , StreamCallbackPtr_t Callback
 135 #endif
 136                                                                  )
 137 {
 138         uint8_t  ErrorCode;
 139
 140         Pipe_SetPipeToken(PIPE_TOKEN_IN);
 141
 142         if ((ErrorCode = Pipe_WaitUntilReady()))
 143           return ErrorCode;
 144
 145         #if defined(FAST_STREAM_TRANSFERS)
 146         uint8_t BytesRemToAlignment = (Pipe_BytesInPipe() & 0x07);
 147
 148         if (Length >= 8)
 149         {
 150                 Length -= BytesRemToAlignment;
 151
 152                 switch (BytesRemToAlignment)
 153                 {
 154                         default:
 155                                 do
 156                                 {
 157                                         if (!(Pipe_IsReadWriteAllowed()))
 158                                         {
 159                                                 Pipe_ClearIN();
 160
 161                                                 #if !defined(NO_STREAM_CALLBACKS)
 162                                                 if ((Callback != NULL) && (Callback() == STREAMCALLBACK_Abort))
 163                                                   return PIPE_RWSTREAM_CallbackAborted;
 164                                                 #endif
 165
 166                                                 if ((ErrorCode = Pipe_WaitUntilReady()))
 167                                                   return ErrorCode;
 168                                         }
 169
 170                                         Length -= 8;
 171
 172                                         Pipe_Discard_Byte();
 173                         case 7: Pipe_Discard_Byte();
 174                         case 6: Pipe_Discard_Byte();
 175                         case 5: Pipe_Discard_Byte();
 176                         case 4: Pipe_Discard_Byte();
 177                         case 3: Pipe_Discard_Byte();
 178                         case 2: Pipe_Discard_Byte();
 179                         case 1: Pipe_Discard_Byte();
 180                                 } while (Length >= 8);
 181                 }
 182         }
 183         #endif
 184
 185         while (Length)
 186         {
 187                 if (!(Pipe_IsReadWriteAllowed()))
 188                 {
 189                         Pipe_ClearIN();
 190
 191                         #if !defined(NO_STREAM_CALLBACKS)
 192                         if ((Callback != NULL) && (Callback() == STREAMCALLBACK_Abort))
 193                           return PIPE_RWSTREAM_CallbackAborted;
 194                         #endif
 195
 196                         if ((ErrorCode = Pipe_WaitUntilReady()))
 197                           return ErrorCode;
 198                 }
 199                 else
 200                 {
 201                         Pipe_Discard_Byte();
 202                         Length--;
 203                 }
 204         }
 205
 206         return PIPE_RWSTREAM_NoError;
 207 }
 208
 209 /* The following abuses the C preprocessor in order to copy-past common code with slight alterations,
 210  * so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */
 211
 212 #define  TEMPLATE_FUNC_NAME                        Pipe_Write_Stream_LE
 213 #define  TEMPLATE_BUFFER_TYPE                      const void*
 214 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 215 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 216 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 217 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(*((uint8_t*)BufferPtr++))
 218 #include "Template/Template_Pipe_RW.c"
 219
 220 #define  TEMPLATE_FUNC_NAME                        Pipe_Write_PStream_LE
 221 #define  TEMPLATE_BUFFER_TYPE                      const void*
 222 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 223 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 224 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 225 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(pgm_read_byte((uint8_t*)BufferPtr++))
 226 #include "Template/Template_Pipe_RW.c"
 227
 228 #define  TEMPLATE_FUNC_NAME                        Pipe_Write_EStream_LE
 229 #define  TEMPLATE_BUFFER_TYPE                      const void*
 230 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 231 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 232 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 233 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(eeprom_read_byte((uint8_t*)BufferPtr++))
 234 #include "Template/Template_Pipe_RW.c"
 235
 236 #define  TEMPLATE_FUNC_NAME                        Pipe_Write_Stream_BE
 237 #define  TEMPLATE_BUFFER_TYPE                      const void*
 238 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 239 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 240 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 241 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(*((uint8_t*)BufferPtr--))
 242 #include "Template/Template_Pipe_RW.c"
 243
 244 #define  TEMPLATE_FUNC_NAME                        Pipe_Write_PStream_BE
 245 #define  TEMPLATE_BUFFER_TYPE                      const void*
 246 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 247 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 248 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 249 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(pgm_read_byte((uint8_t*)BufferPtr--))
 250 #include "Template/Template_Pipe_RW.c"
 251
 252 #define  TEMPLATE_FUNC_NAME                        Pipe_Write_EStream_BE
 253 #define  TEMPLATE_BUFFER_TYPE                      const void*
 254 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 255 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 256 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 257 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_Byte(eeprom_read_byte((uint8_t*)BufferPtr--))
 258 #include "Template/Template_Pipe_RW.c"
 259
 260 #define  TEMPLATE_FUNC_NAME                        Pipe_Read_Stream_LE
 261 #define  TEMPLATE_BUFFER_TYPE                      void*
 262 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 263 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 264 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 265 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *((uint8_t*)BufferPtr++) = Pipe_Read_Byte()
 266 #include "Template/Template_Pipe_RW.c"
 267
 268 #define  TEMPLATE_FUNC_NAME                        Pipe_Read_EStream_LE
 269 #define  TEMPLATE_BUFFER_TYPE                      void*
 270 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 271 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 272 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 273 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr++, Pipe_Read_Byte())
 274 #include "Template/Template_Pipe_RW.c"
 275
 276 #define  TEMPLATE_FUNC_NAME                        Pipe_Read_Stream_BE
 277 #define  TEMPLATE_BUFFER_TYPE                      void*
 278 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 279 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 280 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 281 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *((uint8_t*)BufferPtr--) = Pipe_Read_Byte()
 282 #include "Template/Template_Pipe_RW.c"
 283
 284 #define  TEMPLATE_FUNC_NAME                        Pipe_Read_EStream_BE
 285 #define  TEMPLATE_BUFFER_TYPE                      void*
 286 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 287 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 288 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 289 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr--, Pipe_Read_Byte())
 290 #include "Template/Template_Pipe_RW.c"
 291
 292 #endif