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 static uint8_t CDC_Host_ProcessConfigDescriptor(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
  38 {
  39         uint8_t* ConfigDescriptorData;
  40         uint16_t ConfigDescriptorSize;
  41         uint8_t  FoundEndpoints = 0;
  42
  43         if (USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)
  44           return CDC_ENUMERROR_ControlError;
  45
  46         if (ConfigDescriptorSize > 512)
  47           return CDC_ENUMERROR_DescriptorTooLarge;
  48
  49         ConfigDescriptorData = alloca(ConfigDescriptorSize);
  50
  51         USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData);
  52
  53         if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
  54           return CDC_ENUMERROR_InvalidConfigDataReturned;
  55
  56         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  57                                       DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  58         {
  59                 return CDC_ENUMERROR_NoCDCInterfaceFound;
  60         }
  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                         /* Check to see if the control interface's notification pipe has been found, if so search for the data interface */
  68                         if (FoundEndpoints & CDC_FOUND_DATAPIPE_NOTIFICATION)
  69                         {
  70                                 /* Get the next CDC data interface from the configuration descriptor (CDC class has two CDC interfaces) */
  71                                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  72                                                               DComp_CDC_Host_NextCDCDataInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  73                                 {
  74                                         return CDC_ENUMERROR_NoCDCInterfaceFound;
  75                                 }
  76                         }
  77                         else
  78                         {
  79                                 FoundEndpoints = 0;
  80
  81                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
  82                                 Pipe_DisablePipe();
  83                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
  84                                 Pipe_DisablePipe();
  85                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.NotificationPipeNumber);
  86                                 Pipe_DisablePipe();
  87
  88                                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  89                                                               DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  90                                 {
  91                                         return CDC_ENUMERROR_NoCDCInterfaceFound;
  92                                 }
  93                         }
  94
  95                         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  96                                                       DComp_CDC_Host_NextInterfaceCDCDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  97                         {
  98                                 return CDC_ENUMERROR_NoEndpointFound;
  99                         }
 100                 }
 101
 102                 USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
 103
 104                 if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)
 105                 {
 106                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 107                         {
 108                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.NotificationPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
 109                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 110                                 CDCInterfaceInfo->State.NotificationPipeSize = EndpointData->EndpointSize;
 111
 112                                 Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);
 113
 114                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_NOTIFICATION;
 115                         }
 116                 }
 117                 else
 118                 {
 119                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 120                         {
 121                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_IN,
 122                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 123                                 CDCInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;
 124
 125                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_IN;
 126                         }
 127                         else
 128                         {
 129                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_OUT,
 130                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 131                                 CDCInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;
 132
 133                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_OUT;
 134                         }
 135                 }
 136         }
 137
 138         return CDC_ENUMERROR_NoError;
 139 }
 140
 141 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor)
 142 {
 143         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 144         {
 145                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 146                                                                                 USB_Descriptor_Interface_t);
 147
 148                 if ((CurrentInterface->Class    == CDC_CONTROL_CLASS)    &&
 149                     (CurrentInterface->SubClass == CDC_CONTROL_SUBCLASS) &&
 150                         (CurrentInterface->Protocol == CDC_CONTROL_PROTOCOL))
 151                 {
 152                         return DESCRIPTOR_SEARCH_Found;
 153                 }
 154         }
 155
 156         return DESCRIPTOR_SEARCH_NotFound;
 157 }
 158
 159 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor)
 160 {
 161         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 162         {
 163                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 164                                                                                 USB_Descriptor_Interface_t);
 165
 166                 if ((CurrentInterface->Class    == CDC_DATA_CLASS)    &&
 167                     (CurrentInterface->SubClass == CDC_DATA_SUBCLASS) &&
 168                         (CurrentInterface->Protocol == CDC_DATA_PROTOCOL))
 169                 {
 170                         return DESCRIPTOR_SEARCH_Found;
 171                 }
 172         }
 173
 174         return DESCRIPTOR_SEARCH_NotFound;
 175 }
 176
 177 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor)
 178 {
 179         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
 180         {
 181                 USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
 182                                                                               USB_Descriptor_Endpoint_t)
 183
 184                 uint8_t EndpointType = (CurrentEndpoint->Attributes & EP_TYPE_MASK);
 185
 186                 if ((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT))
 187                   return DESCRIPTOR_SEARCH_Found;
 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         uint8_t ErrorCode;
 200
 201         switch (USB_HostState)
 202         {
 203                 case HOST_STATE_Addressed:
 204                         if ((ErrorCode = CDC_Host_ProcessConfigDescriptor(CDCInterfaceInfo)) != CDC_ENUMERROR_NoError)
 205                         {
 206                                 USB_HostState = HOST_STATE_Unattached;
 207                         }
 208
 209                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 210                         {
 211                                 USB_HostState = HOST_STATE_Unattached;
 212                         }
 213
 214                         USB_HostState = HOST_STATE_Configured;
 215                         break;
 216                 case HOST_STATE_Configured:
 217                         USB_HostState = HOST_STATE_Ready;
 218                         break;
 219         }
 220 }
 221
 222 #endif