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(&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(&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                                         /* Descriptor not found, error out */
  75                                         return CDC_ENUMERROR_NoCDCInterfaceFound;
  76                                 }
  77                         }
  78                         else
  79                         {
  80                                 FoundEndpoints = 0;
  81
  82                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
  83                                 Pipe_DisablePipe();
  84                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
  85                                 Pipe_DisablePipe();
  86                                 Pipe_SelectPipe(CDCInterfaceInfo->Config.NotificationPipeNumber);
  87                                 Pipe_DisablePipe();
  88
  89                                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  90                                                               DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  91                                 {
  92                                         return CDC_ENUMERROR_NoCDCInterfaceFound;
  93                                 }
  94                         }
  95
  96                         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  97                                                       DComp_CDC_Host_NextInterfaceCDCDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  98                         {
  99                                 return CDC_ENUMERROR_NoEndpointFound;
 100                         }
 101                 }
 102
 103                 USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
 104
 105                 if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)
 106                 {
 107                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 108                         {
 109                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.NotificationPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
 110                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 111                                 CDCInterfaceInfo->State.NotificationPipeSize = EndpointData->EndpointSize;
 112
 113                                 Pipe_SetInfiniteINRequests();
 114                                 Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);
 115
 116                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_NOTIFICATION;
 117                         }
 118                 }
 119                 else
 120                 {
 121                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 122                         {
 123                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_IN,
 124                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 125                                 CDCInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;
 126
 127                                 Pipe_SetInfiniteINRequests();
 128                                 Pipe_Unfreeze();
 129
 130                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_IN;
 131                         }
 132                         else
 133                         {
 134                                 Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_OUT,
 135                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 136                                 CDCInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;
 137
 138                                 Pipe_Unfreeze();
 139
 140                                 FoundEndpoints |= CDC_FOUND_DATAPIPE_OUT;
 141                         }
 142                 }
 143         }
 144
 145         return CDC_ENUMERROR_NoError;
 146 }
 147
 148 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor)
 149 {
 150         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 151         {
 152                 /* Check the CDC descriptor class, subclass and protocol, break out if correct control interface found */
 153                 if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class    == CDC_CONTROL_CLASS)    &&
 154                     (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == CDC_CONTROL_SUBCLASS) &&
 155                     (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == CDC_CONTROL_PROTOCOL))
 156                 {
 157                         return DESCRIPTOR_SEARCH_Found;
 158                 }
 159         }
 160
 161         return DESCRIPTOR_SEARCH_NotFound;
 162 }
 163
 164 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor)
 165 {
 166         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 167         {
 168                 /* Check the CDC descriptor class, subclass and protocol, break out if correct data interface found */
 169                 if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class    == CDC_DATA_CLASS)    &&
 170                     (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == CDC_DATA_SUBCLASS) &&
 171                     (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == CDC_DATA_PROTOCOL))
 172                 {
 173                         return DESCRIPTOR_SEARCH_Found;
 174                 }
 175         }
 176
 177         return DESCRIPTOR_SEARCH_NotFound;
 178 }
 179
 180 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor)
 181 {
 182         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
 183         {
 184                 uint8_t EndpointType = (DESCRIPTOR_CAST(CurrentDescriptor,
 185                                                         USB_Descriptor_Endpoint_t).Attributes & EP_TYPE_MASK);
 186
 187                 if ((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT))
 188                   return DESCRIPTOR_SEARCH_Found;
 189         }
 190         else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 191         {
 192                 return DESCRIPTOR_SEARCH_Fail;
 193         }
 194
 195         return DESCRIPTOR_SEARCH_NotFound;
 196 }
 197
 198 void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 199 {
 200         uint8_t ErrorCode;
 201
 202         switch (USB_HostState)
 203         {
 204                 case HOST_STATE_Addressed:
 205                         if ((ErrorCode = CDC_Host_ProcessConfigDescriptor(CDCInterfaceInfo)) != CDC_ENUMERROR_NoError)
 206                         {
 207                                 USB_HostState = HOST_STATE_Unattached;
 208                         }
 209
 210                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 211                         {
 212                                 USB_HostState = HOST_STATE_Unattached;
 213                         }
 214
 215                         USB_HostState = HOST_STATE_Configured;
 216                         break;
 217                 case HOST_STATE_Configured:
 218
 219                         USB_HostState = HOST_STATE_Ready;
 220                         break;
 221         }
 222 }
 223
 224 #endif