LUFA/Drivers/USB/Core/PipeStream.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 "USBMode.h"
  33
  34 #if defined(USB_CAN_BE_HOST)
  35
  36 #include "PipeStream.h"
  37
  38 uint8_t Pipe_Discard_Stream(uint16_t Length,
  39                             uint16_t* const BytesProcessed)
  40 {
  41         uint8_t  ErrorCode;
  42         uint16_t BytesInTransfer = 0;
  43
  44         Pipe_SetPipeToken(PIPE_TOKEN_IN);
  45
  46         if ((ErrorCode = Pipe_WaitUntilReady()))
  47           return ErrorCode;
  48
  49         if (BytesProcessed != NULL)
  50           Length -= *BytesProcessed;
  51
  52         while (Length)
  53         {
  54                 if (!(Pipe_IsReadWriteAllowed()))
  55                 {
  56                         Pipe_ClearIN();
  57
  58                         if (BytesProcessed != NULL)
  59                         {
  60                                 *BytesProcessed += BytesInTransfer;
  61                                 return PIPE_RWSTREAM_IncompleteTransfer;
  62                         }
  63
  64                         if ((ErrorCode = Pipe_WaitUntilReady()))
  65                           return ErrorCode;
  66                 }
  67                 else
  68                 {
  69                         Pipe_Discard_8();
  70
  71                         Length--;
  72                         BytesInTransfer++;
  73                 }
  74         }
  75
  76         return PIPE_RWSTREAM_NoError;
  77 }
  78
  79 uint8_t Pipe_Null_Stream(uint16_t Length,
  80                          uint16_t* const BytesProcessed)
  81 {
  82         uint8_t  ErrorCode;
  83         uint16_t BytesInTransfer = 0;
  84
  85         Pipe_SetPipeToken(PIPE_TOKEN_OUT);
  86
  87         if ((ErrorCode = Pipe_WaitUntilReady()))
  88           return ErrorCode;
  89
  90         if (BytesProcessed != NULL)
  91           Length -= *BytesProcessed;
  92
  93         while (Length)
  94         {
  95                 if (!(Pipe_IsReadWriteAllowed()))
  96                 {
  97                         Pipe_ClearOUT();
  98
  99                         if (BytesProcessed != NULL)
 100                         {
 101                                 *BytesProcessed += BytesInTransfer;
 102                                 return PIPE_RWSTREAM_IncompleteTransfer;
 103                         }
 104
 105                         USB_USBTask();
 106
 107                         if ((ErrorCode = Pipe_WaitUntilReady()))
 108                           return ErrorCode;
 109                 }
 110                 else
 111                 {
 112                         Pipe_Write_8(0);
 113
 114                         Length--;
 115                         BytesInTransfer++;
 116                 }
 117         }
 118
 119         return PIPE_RWSTREAM_NoError;
 120 }
 121
 122 /* The following abuses the C preprocessor in order to copy-past common code with slight alterations,
 123  * so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */
 124
 125 #define  TEMPLATE_FUNC_NAME                        Pipe_Write_Stream_LE
 126 #define  TEMPLATE_BUFFER_TYPE                      const void*
 127 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 128 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 129 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 130 #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream += Amount
 131 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_8(*BufferPtr)
 132 #include "Template/Template_Pipe_RW.c"
 133
 134 #define  TEMPLATE_FUNC_NAME                        Pipe_Write_Stream_BE
 135 #define  TEMPLATE_BUFFER_TYPE                      const void*
 136 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 137 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 138 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 139 #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream -= Amount
 140 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_8(*BufferPtr)
 141 #include "Template/Template_Pipe_RW.c"
 142
 143 #define  TEMPLATE_FUNC_NAME                        Pipe_Read_Stream_LE
 144 #define  TEMPLATE_BUFFER_TYPE                      void*
 145 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 146 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 147 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 148 #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream += Amount
 149 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *BufferPtr = Pipe_Read_8()
 150 #include "Template/Template_Pipe_RW.c"
 151
 152 #define  TEMPLATE_FUNC_NAME                        Pipe_Read_Stream_BE
 153 #define  TEMPLATE_BUFFER_TYPE                      void*
 154 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 155 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 156 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 157 #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream -= Amount
 158 #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *BufferPtr = Pipe_Read_8()
 159 #include "Template/Template_Pipe_RW.c"
 160
 161 #if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
 162         #define  TEMPLATE_FUNC_NAME                        Pipe_Write_PStream_LE
 163         #define  TEMPLATE_BUFFER_TYPE                      const void*
 164         #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 165         #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 166         #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 167         #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream += Amount
 168         #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_8(pgm_read_byte(BufferPtr))
 169         #include "Template/Template_Pipe_RW.c"
 170
 171         #define  TEMPLATE_FUNC_NAME                        Pipe_Write_PStream_BE
 172         #define  TEMPLATE_BUFFER_TYPE                      const void*
 173         #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 174         #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 175         #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 176         #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream -= Amount
 177         #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_8(pgm_read_byte(BufferPtr))
 178         #include "Template/Template_Pipe_RW.c"
 179 #endif
 180
 181 #if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE)
 182         #define  TEMPLATE_FUNC_NAME                        Pipe_Write_EStream_LE
 183         #define  TEMPLATE_BUFFER_TYPE                      const void*
 184         #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 185         #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 186         #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 187         #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream += Amount
 188         #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_8(eeprom_read_byte(BufferPtr))
 189         #include "Template/Template_Pipe_RW.c"
 190
 191         #define  TEMPLATE_FUNC_NAME                        Pipe_Write_EStream_BE
 192         #define  TEMPLATE_BUFFER_TYPE                      const void*
 193         #define  TEMPLATE_TOKEN                            PIPE_TOKEN_OUT
 194         #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearOUT()
 195         #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 196         #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream -= Amount
 197         #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Pipe_Write_8(eeprom_read_byte(BufferPtr))
 198         #include "Template/Template_Pipe_RW.c"
 199
 200         #define  TEMPLATE_FUNC_NAME                        Pipe_Read_EStream_LE
 201         #define  TEMPLATE_BUFFER_TYPE                      void*
 202         #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 203         #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 204         #define  TEMPLATE_BUFFER_OFFSET(Length)            0
 205         #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream += Amount
 206         #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_update_byte(BufferPtr, Pipe_Read_8())
 207         #include "Template/Template_Pipe_RW.c"
 208
 209         #define  TEMPLATE_FUNC_NAME                        Pipe_Read_EStream_BE
 210         #define  TEMPLATE_BUFFER_TYPE                      void*
 211         #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 212         #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 213         #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
 214         #define  TEMPLATE_BUFFER_MOVE(BufferPtr, Amount)   DataStream -= Amount
 215         #define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_update_byte(BufferPtr, Pipe_Read_8())
 216         #include "Template/Template_Pipe_RW.c"
 217 #endif
 218
 219 #endif
 220