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 uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorSize,
  38                                 uint8_t* ConfigDescriptorData)
  39 {
  40         uint8_t FoundEndpoints = 0;
  41
  42         memset(&CDCInterfaceInfo->State, 0x00, sizeof(CDCInterfaceInfo->State));
  43
  44         if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
  45           return CDC_ENUMERROR_InvalidConfigDescriptor;
  46
  47         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  48                                       DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  49         {
  50                 return CDC_ENUMERROR_NoCDCInterfaceFound;
  51         }
  52
  53         CDCInterfaceInfo->State.ControlInterfaceNumber =
  54 #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES)
  55                              DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).InterfaceNumber;
  56 #else
  57                              DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).bInterfaceNumber;
  58 #endif
  59
  60         while (FoundEndpoints != (CDC_FOUND_NOTIFICATION_IN | CDC_FOUND_DATAPIPE_IN | CDC_FOUND_DATAPIPE_OUT))
  61         {
  62                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  63                                               DComp_CDC_Host_NextCDCInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  64                 {
  65                         if (FoundEndpoints & CDC_FOUND_NOTIFICATION_IN)
  66                         {
  67                                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  68                                                               DComp_CDC_Host_NextCDCDataInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  69                                 {
  70                                         return CDC_ENUMERROR_NoCDCInterfaceFound;
  71                                 }
  72                         }
  73                         else
  74                         {
  75                                 FoundEndpoints = 0;
  76
  77                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
  78                                 Pipe_DisablePipe();
  79                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
  80                                 Pipe_DisablePipe();
  81                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.NotificationPipeNumber);
  82                                 Pipe_DisablePipe();
  83
  84                                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  85                                                               DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  86                                 {
  87                                         return CDC_ENUMERROR_NoCDCInterfaceFound;
  88                                 }
  89                         }
  90
  91                         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  92                                                       DComp_CDC_Host_NextCDCInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  93                         {
  94                                 return CDC_ENUMERROR_EndpointsNotFound;
  95                         }
  96                 }
  97
  98                 USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
  99
 100                 if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)
 101                 {
 102                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 103                         {
 104                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.NotificationPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
 105                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 106                                 CDCInterfaceInfo->State.NotificationPipeSize = EndpointData->EndpointSize;
 107
 108                                 Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);
 109
 110                                 FoundEndpoints |= CDC_FOUND_NOTIFICATION_IN;
 111                         }
 112                 }
 113                 else
 114                 {
 115                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 116                         {
 117                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_IN,
 118                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 119                                 CDCInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;
 120
 121                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_IN;
 122                         }
 123                         else
 124                         {
 125                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_OUT,
 126                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 127                                 CDCInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;
 128
 129                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_OUT;
 130                         }
 131                 }
 132         }
 133
 134         CDCInterfaceInfo->State.Active = true;
 135         return CDC_ENUMERROR_NoError;
 136 }
 137
 138 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor)
 139 {
 140         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 141         {
 142                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 143                                                                                 USB_Descriptor_Interface_t);
 144
 145                 if ((CurrentInterface->Class    == CDC_CONTROL_CLASS)    &&
 146                     (CurrentInterface->SubClass == CDC_CONTROL_SUBCLASS) &&
 147                         (CurrentInterface->Protocol == CDC_CONTROL_PROTOCOL))
 148                 {
 149                         return DESCRIPTOR_SEARCH_Found;
 150                 }
 151         }
 152
 153         return DESCRIPTOR_SEARCH_NotFound;
 154 }
 155
 156 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor)
 157 {
 158         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 159         {
 160                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 161                                                                                 USB_Descriptor_Interface_t);
 162
 163                 if ((CurrentInterface->Class    == CDC_DATA_CLASS)    &&
 164                     (CurrentInterface->SubClass == CDC_DATA_SUBCLASS) &&
 165                         (CurrentInterface->Protocol == CDC_DATA_PROTOCOL))
 166                 {
 167                         return DESCRIPTOR_SEARCH_Found;
 168                 }
 169         }
 170
 171         return DESCRIPTOR_SEARCH_NotFound;
 172 }
 173
 174 static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* CurrentDescriptor)
 175 {
 176         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
 177         {
 178                 USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
 179                                                                               USB_Descriptor_Endpoint_t);
 180
 181                 uint8_t EndpointType = (CurrentEndpoint->Attributes & EP_TYPE_MASK);
 182
 183                 if (((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT)) &&
 184                     !(Pipe_IsEndpointBound(CurrentEndpoint->EndpointAddress)))
 185                 {
 186                         return DESCRIPTOR_SEARCH_Found;
 187                 }
 188         }
 189         else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 190         {
 191                 return DESCRIPTOR_SEARCH_Fail;
 192         }
 193
 194         return DESCRIPTOR_SEARCH_NotFound;
 195 }
 196
 197 void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 198 {
 199         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 200           return;
 201
 202         Pipe_SelectPipe(CDCInterfaceInfo->Config.NotificationPipeNumber);
 203         Pipe_Unfreeze();
 204
 205         if (Pipe_IsINReceived())
 206         {
 207                 USB_Request_Header_t Notification;
 208                 Pipe_Read_Stream_LE(&Notification, sizeof(Notification), NO_STREAM_CALLBACK);
 209
 210                 if ((Notification.bRequest      == NOTIF_SerialState) &&
 211                     (Notification.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)))
 212                 {
 213                         Pipe_Read_Stream_LE(&CDCInterfaceInfo->State.ControlLineStates.DeviceToHost,
 214                                             sizeof(CDCInterfaceInfo->State.ControlLineStates.DeviceToHost),
 215                                             NO_STREAM_CALLBACK);
 216
 217                 }
 218
 219                 Pipe_ClearIN();
 220
 221                 EVENT_CDC_Host_ControLineStateChanged(CDCInterfaceInfo);
 222         }
 223
 224         Pipe_Freeze();
 225 }
 226
 227 uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 228 {
 229         USB_ControlRequest = (USB_Request_Header_t)
 230         {
 231                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 232                 .bRequest      = REQ_SetLineEncoding,
 233                 .wValue        = 0,
 234                 .wIndex        = CDCInterfaceInfo->State.ControlInterfaceNumber,
 235                 .wLength       = sizeof(CDCInterfaceInfo->State.LineEncoding),
 236         };
 237
 238         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 239
 240         return USB_Host_SendControlRequest(&CDCInterfaceInfo->State.LineEncoding);
 241 }
 242
 243 uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 244 {
 245         USB_ControlRequest = (USB_Request_Header_t)
 246         {
 247                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 248                 .bRequest      = REQ_SetControlLineState,
 249                 .wValue        = CDCInterfaceInfo->State.ControlLineStates.HostToDevice,
 250                 .wIndex        = CDCInterfaceInfo->State.ControlInterfaceNumber,
 251                 .wLength       = 0,
 252         };
 253
 254         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 255
 256         return USB_Host_SendControlRequest(NULL);
 257 }
 258
 259 uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length)
 260 {
 261         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 262           return;
 263
 264         uint8_t ErrorCode;
 265
 266         Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
 267         Pipe_Unfreeze();
 268         ErrorCode = Pipe_Write_Stream_LE(Data, Length, NO_STREAM_CALLBACK);
 269         Pipe_Freeze();
 270
 271         return ErrorCode;
 272 }
 273
 274 uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data)
 275 {
 276         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 277           return;
 278
 279         uint8_t ErrorCode = PIPE_READYWAIT_NoError;
 280
 281         Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
 282         Pipe_Unfreeze();
 283
 284         if (!(Pipe_IsReadWriteAllowed()))
 285         {
 286                 Pipe_ClearOUT();
 287                 ErrorCode = Pipe_WaitUntilReady();
 288         }
 289
 290         Pipe_Write_Byte(Data);
 291         Pipe_Freeze();
 292
 293         return ErrorCode;
 294 }
 295
 296 uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 297 {
 298         uint16_t BytesInPipe = 0;
 299
 300         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 301           return BytesInPipe;
 302
 303         Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
 304         Pipe_Unfreeze();
 305
 306         if (Pipe_IsINReceived() && !(Pipe_BytesInPipe()))
 307           Pipe_ClearIN();
 308
 309         BytesInPipe = Pipe_BytesInPipe();
 310         Pipe_Freeze();
 311
 312         return BytesInPipe;
 313 }
 314
 315 uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 316 {
 317         uint8_t ReceivedByte = 0;
 318
 319         if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.Active))
 320           return ReceivedByte;
 321
 322         Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
 323         Pipe_Unfreeze();
 324
 325         ReceivedByte = Pipe_Read_Byte();
 326
 327         if (!(Pipe_BytesInPipe()))
 328           Pipe_ClearIN();
 329
 330         Pipe_Freeze();
 331
 332         return ReceivedByte;
 333 }
 334
 335 void CDC_Host_Event_Stub(void)
 336 {
 337
 338 }
 339
 340 #endif