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 #warning The CDC Host mode Class driver is currently incomplete and is for preview purposes only.
  38
  39 uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorSize,
  40                                 uint8_t* ConfigDescriptorData)
  41 {
  42         uint8_t  FoundEndpoints = 0;
  43
  44         memset(&CDCInterfaceInfo->State, 0x00, sizeof(CDCInterfaceInfo->State));
  45
  46         if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
  47           return CDC_ENUMERROR_InvalidConfigDescriptor;
  48
  49         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  50                                       DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  51         {
  52                 return CDC_ENUMERROR_NoCDCInterfaceFound;
  53         }
  54
  55         while (FoundEndpoints != (CDC_FOUND_DATAPIPE_IN | CDC_FOUND_DATAPIPE_OUT | CDC_FOUND_DATAPIPE_NOTIFICATION))
  56         {
  57                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  58                                               DComp_CDC_Host_NextInterfaceCDCDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  59                 {
  60                         if (FoundEndpoints & CDC_FOUND_DATAPIPE_NOTIFICATION)
  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_NextInterfaceCDCDataEndpoint) != 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_DATAPIPE_NOTIFICATION;
 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         return CDC_ENUMERROR_NoError;
 130 }
 131
 132 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor)
 133 {
 134         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 135         {
 136                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 137                                                                                 USB_Descriptor_Interface_t);
 138
 139                 if ((CurrentInterface->Class    == CDC_CONTROL_CLASS)    &&
 140                     (CurrentInterface->SubClass == CDC_CONTROL_SUBCLASS) &&
 141                         (CurrentInterface->Protocol == CDC_CONTROL_PROTOCOL))
 142                 {
 143                         return DESCRIPTOR_SEARCH_Found;
 144                 }
 145         }
 146
 147         return DESCRIPTOR_SEARCH_NotFound;
 148 }
 149
 150 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor)
 151 {
 152         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 153         {
 154                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 155                                                                                 USB_Descriptor_Interface_t);
 156
 157                 if ((CurrentInterface->Class    == CDC_DATA_CLASS)    &&
 158                     (CurrentInterface->SubClass == CDC_DATA_SUBCLASS) &&
 159                         (CurrentInterface->Protocol == CDC_DATA_PROTOCOL))
 160                 {
 161                         return DESCRIPTOR_SEARCH_Found;
 162                 }
 163         }
 164
 165         return DESCRIPTOR_SEARCH_NotFound;
 166 }
 167
 168 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor)
 169 {
 170         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
 171         {
 172                 USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
 173                                                                               USB_Descriptor_Endpoint_t);
 174
 175                 uint8_t EndpointType = (CurrentEndpoint->Attributes & EP_TYPE_MASK);
 176
 177                 if (((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT)) &&
 178                     !(Pipe_IsEndpointBound(CurrentEndpoint->EndpointAddress)))
 179                 {
 180                         return DESCRIPTOR_SEARCH_Found;
 181                 }
 182         }
 183         else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 184         {
 185                 return DESCRIPTOR_SEARCH_Fail;
 186         }
 187
 188         return DESCRIPTOR_SEARCH_NotFound;
 189 }
 190
 191 void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 192 {
 193
 194 }
 195
 196 #endif