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(void)
  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 ControlError;
  45
  46         if (ConfigDescriptorSize > 512)
  47           return DescriptorTooLarge;
  48
  49         ConfigDescriptorData = alloca(ConfigDescriptorSize);
  50
  51         USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);
  52
  53         if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
  54           return InvalidConfigDataReturned;
  55
  56         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  57                                       DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  58         {
  59                 return NoCDCInterfaceFound;
  60         }
  61
  62         while (FoundEndpoints != ((1 << CDC_NOTIFICATIONPIPE) | (1 << CDC_DATAPIPE_IN) | (1 << CDC_DATAPIPE_OUT)))
  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 & (1 << CDC_NOTIFICATIONPIPE))
  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 NoCDCInterfaceFound;
  76                                 }
  77                         }
  78                         else
  79                         {
  80                                 FoundEndpoints = 0;
  81
  82                                 Pipe_SelectPipe(CDC_NOTIFICATIONPIPE);
  83                                 Pipe_DisablePipe();
  84                                 Pipe_SelectPipe(CDC_DATAPIPE_IN);
  85                                 Pipe_DisablePipe();
  86                                 Pipe_SelectPipe(CDC_DATAPIPE_OUT);
  87                                 Pipe_DisablePipe();
  88
  89                                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  90                                                               DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  91                                 {
  92                                         return NoCDCInterfaceFound;
  93                                 }
  94                         }
  95
  96                         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  97                                                       DComp_CDC_Host_NextInterfaceCDCDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  98                         {
  99                                 return 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(CDC_NOTIFICATIONPIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
 110                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 111
 112                                 Pipe_SetInfiniteINRequests();
 113                                 Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);
 114
 115                                 FoundEndpoints |= (1 << CDC_NOTIFICATIONPIPE);
 116                         }
 117                 }
 118                 else
 119                 {
 120                         if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 121                         {
 122                                 Pipe_ConfigurePipe(CDC_DATAPIPE_IN, EP_TYPE_BULK, PIPE_TOKEN_IN,
 123                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 124
 125                                 Pipe_SetInfiniteINRequests();
 126                                 Pipe_Unfreeze();
 127
 128                                 FoundEndpoints |= (1 << CDC_DATAPIPE_IN);
 129                         }
 130                         else
 131                         {
 132                                 Pipe_ConfigurePipe(CDC_DATAPIPE_OUT, EP_TYPE_BULK, PIPE_TOKEN_OUT,
 133                                                                    EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
 134
 135                                 Pipe_Unfreeze();
 136
 137                                 FoundEndpoints |= (1 << CDC_DATAPIPE_OUT);
 138                         }
 139                 }
 140         }
 141
 142         return SuccessfulConfigRead;
 143 }
 144
 145 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor)
 146 {
 147         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 148         {
 149                 /* Check the CDC descriptor class, subclass and protocol, break out if correct control interface found */
 150                 if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class    == CDC_CONTROL_CLASS)    &&
 151                     (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == CDC_CONTROL_SUBCLASS) &&
 152                     (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == CDC_CONTROL_PROTOCOL))
 153                 {
 154                         return DESCRIPTOR_SEARCH_Found;
 155                 }
 156         }
 157
 158         return DESCRIPTOR_SEARCH_NotFound;
 159 }
 160
 161 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor)
 162 {
 163         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 164         {
 165                 /* Check the CDC descriptor class, subclass and protocol, break out if correct data interface found */
 166                 if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class    == CDC_DATA_CLASS)    &&
 167                     (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == CDC_DATA_SUBCLASS) &&
 168                     (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).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                 uint8_t EndpointType = (DESCRIPTOR_CAST(CurrentDescriptor,
 182                                                         USB_Descriptor_Endpoint_t).Attributes & EP_TYPE_MASK);
 183
 184                 if ((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT))
 185                   return DESCRIPTOR_SEARCH_Found;
 186         }
 187         else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 188         {
 189                 return DESCRIPTOR_SEARCH_Fail;
 190         }
 191
 192         return DESCRIPTOR_SEARCH_NotFound;
 193 }
 194
 195 void CDC_Host_Task(void)
 196 {
 197         uint8_t ErrorCode;
 198
 199         switch (USB_HostState)
 200         {
 201                 case HOST_STATE_Addressed:
 202                         USB_ControlRequest = (USB_Request_Header_t)
 203                                 {
 204                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 205                                         .bRequest      = REQ_SetConfiguration,
 206                                         .wValue        = 1,
 207                                         .wIndex        = 0,
 208                                         .wLength       = 0,
 209                                 };
 210
 211                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 212
 213                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 214                         {
 215                                 USB_HostState = HOST_STATE_Unattached;
 216                         }
 217
 218                         USB_HostState = HOST_STATE_Configured;
 219                         break;
 220                 case HOST_STATE_Configured:
 221                         if ((ErrorCode = CDC_Host_ProcessConfigDescriptor()) != SuccessfulConfigRead)
 222                         {
 223                                 USB_HostState = HOST_STATE_Unattached;
 224                         }
 225
 226                         USB_HostState = HOST_STATE_Ready;
 227                         break;
 228         }
 229 }
 230
 231 #endif