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