LUFA/Drivers/USB/Class/Host/CDC.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 #include "../../HighLevel/USBMode.h"
  32 #if defined(USB_CAN_BE_HOST)
  33
  34 #define  INCLUDE_FROM_CDC_CLASS_HOST_C
  35 #include "CDC.h"
  36
  37 #warning The CDC Host mode Class driver is currently incomplete and is for preview purposes only.
  38
  39 uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorSize,
  40                                 uint8_t* ConfigDescriptorData)
  41 {
  42         uint8_t  FoundEndpoints = 0;
  43
  44         memset(&CDCInterfaceInfo->State, 0x00, sizeof(CDCInterfaceInfo->State));
  45
  46         if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
  47           return CDC_ENUMERROR_InvalidConfigDescriptor;
  48
  49         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  50                                       DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  51         {
  52                 return CDC_ENUMERROR_NoCDCInterfaceFound;
  53         }
  54
  55         CDCInterfaceInfo->State.ControlInterfaceNumber =
  56 #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES)
  57                           DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).InterfaceNumber;
  58 #else
  59                           DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).bInterfaceNumber;
  60 #endif
  61
  62         while (FoundEndpoints != (CDC_FOUND_DATAPIPE_IN | CDC_FOUND_DATAPIPE_OUT | CDC_FOUND_DATAPIPE_NOTIFICATION))
  63         {
  64                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  65                                               DComp_CDC_Host_NextInterfaceCDCDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  66                 {
  67                         if (FoundEndpoints & CDC_FOUND_DATAPIPE_NOTIFICATION)
  68                         {
  69                                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  70                                                               DComp_CDC_Host_NextCDCDataInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  71                                 {
  72                                         return CDC_ENUMERROR_NoCDCInterfaceFound;
  73                                 }
  74                         }
  75                         else
  76                         {
  77                                 FoundEndpoints = 0;
  78
  79                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
  80                                 Pipe_DisablePipe();
  81                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
  82                                 Pipe_DisablePipe();
  83                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.NotificationPipeNumber);
  84                                 Pipe_DisablePipe();
  85
  86                                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  87                                                               DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  88                                 {
  89                                         return CDC_ENUMERROR_NoCDCInterfaceFound;
  90                                 }
  91                         }
  92
  93                         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  94                                                       DComp_CDC_Host_NextInterfaceCDCDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  95                         {
  96                                 return CDC_ENUMERROR_EndpointsNotFound;
  97                         }
  98                 }
  99
 100                 USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
 101
 102                 if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)
 103                 {
 104                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 105                         {
 106                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.NotificationPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
 107                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 108                                 CDCInterfaceInfo->State.NotificationPipeSize = EndpointData->EndpointSize;
 109
 110                                 Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);
 111
 112                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_NOTIFICATION;
 113                         }
 114                 }
 115                 else
 116                 {
 117                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 118                         {
 119                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_IN,
 120                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 121                                 CDCInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;
 122
 123                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_IN;
 124                         }
 125                         else
 126                         {
 127                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_OUT,
 128                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 129                                 CDCInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;
 130
 131                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_OUT;
 132                         }
 133                 }
 134         }
 135
 136         CDCInterfaceInfo->State.Active = true;
 137         return CDC_ENUMERROR_NoError;
 138 }
 139
 140 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor)
 141 {
 142         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 143         {
 144                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 145                                                                                 USB_Descriptor_Interface_t);
 146
 147                 if ((CurrentInterface->Class    == CDC_CONTROL_CLASS)    &&
 148                     (CurrentInterface->SubClass == CDC_CONTROL_SUBCLASS) &&
 149                         (CurrentInterface->Protocol == CDC_CONTROL_PROTOCOL))
 150                 {
 151                         return DESCRIPTOR_SEARCH_Found;
 152                 }
 153         }
 154
 155         return DESCRIPTOR_SEARCH_NotFound;
 156 }
 157
 158 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor)
 159 {
 160         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 161         {
 162                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 163                                                                                 USB_Descriptor_Interface_t);
 164
 165                 if ((CurrentInterface->Class    == CDC_DATA_CLASS)    &&
 166                     (CurrentInterface->SubClass == CDC_DATA_SUBCLASS) &&
 167                         (CurrentInterface->Protocol == CDC_DATA_PROTOCOL))
 168                 {
 169                         return DESCRIPTOR_SEARCH_Found;
 170                 }
 171         }
 172
 173         return DESCRIPTOR_SEARCH_NotFound;
 174 }
 175
 176 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor)
 177 {
 178         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
 179         {
 180                 USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
 181                                                                               USB_Descriptor_Endpoint_t);
 182
 183                 uint8_t EndpointType = (CurrentEndpoint->Attributes & EP_TYPE_MASK);
 184
 185                 if (((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT)) &&
 186                     !(Pipe_IsEndpointBound(CurrentEndpoint->EndpointAddress)))
 187                 {
 188                         return DESCRIPTOR_SEARCH_Found;
 189                 }
 190         }
 191         else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 192         {
 193                 return DESCRIPTOR_SEARCH_Fail;
 194         }
 195
 196         return DESCRIPTOR_SEARCH_NotFound;
 197 }
 198
 199 void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 200 {
 201         EVENT_CDC_Host_ControLineStateChanged(CDCInterfaceInfo);
 202 }
 203
 204 uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 205 {
 206         USB_ControlRequest = (USB_Request_Header_t)
 207         {
 208                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 209                 .bRequest      = REQ_SetControlLineState,
 210                 .wValue        = 0,
 211                 .wIndex        = CDCInterfaceInfo->State.ControlInterfaceNumber,
 212                 .wLength       = sizeof(CDCInterfaceInfo->State.LineEncoding),
 213         };
 214
 215         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 216
 217         return USB_Host_SendControlRequest(&CDCInterfaceInfo->State.LineEncoding);
 218 }
 219
 220 uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 221 {
 222         USB_ControlRequest = (USB_Request_Header_t)
 223         {
 224                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 225                 .bRequest      = REQ_SetControlLineState,
 226                 .wValue        = CDCInterfaceInfo->State.ControlLineStates.HostToDevice,
 227                 .wIndex        = CDCInterfaceInfo->State.ControlInterfaceNumber,
 228                 .wLength       = 0,
 229         };
 230
 231         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 232
 233         return USB_Host_SendControlRequest(NULL);
 234 }
 235
 236 void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length)
 237 {
 238         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 239           return;
 240
 241         Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
 242         Pipe_Unfreeze();
 243         Pipe_Write_Stream_LE(Data, Length, NO_STREAM_CALLBACK);
 244         Pipe_Freeze();
 245 }
 246
 247 void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data)
 248 {
 249         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 250           return;
 251
 252         Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
 253         Pipe_Unfreeze();
 254
 255         if (!(Pipe_IsReadWriteAllowed()))
 256         {
 257                 Pipe_ClearOUT();
 258                 Pipe_WaitUntilReady();
 259         }
 260
 261         Pipe_Write_Byte(Data);
 262         Pipe_Freeze();
 263 }
 264
 265 uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 266 {
 267         uint16_t BytesInPipe = 0;
 268
 269         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 270           return BytesInPipe;
 271
 272         Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
 273         Pipe_Unfreeze();
 274
 275         if (Pipe_IsINReceived() && !(Pipe_BytesInPipe()))
 276           Pipe_ClearIN();
 277
 278         BytesInPipe = Pipe_BytesInPipe();
 279         Pipe_Freeze();
 280
 281         return BytesInPipe;
 282 }
 283
 284 uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 285 {
 286         uint8_t ReceivedByte = 0;
 287
 288         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 289           return ReceivedByte;
 290
 291         Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
 292         Pipe_Unfreeze();
 293
 294         ReceivedByte = Pipe_Read_Byte();
 295
 296         if (!(Pipe_BytesInPipe()))
 297           Pipe_ClearIN();
 298
 299         Pipe_Freeze();
 300
 301         return ReceivedByte;
 302 }
 303
 304 void CDC_Host_Event_Stub(void)
 305 {
 306
 307 }
 308
 309 #endif