LUFA/Drivers/USB/Class/Device/CDC.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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_DEVICE)
  33
  34 #define  INCLUDE_FROM_CDC_CLASS_DEVICE_C
  35 #include "CDC.h"
  36
  37 void CDC_Device_Event_Stub(void)
  38 {
  39
  40 }
  41
  42 void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)
  43 {
  44         if (!(Endpoint_IsSETUPReceived()))
  45           return;
  46
  47         if (USB_ControlRequest.wIndex != CDCInterfaceInfo->Config.ControlInterfaceNumber)
  48           return;
  49
  50         switch (USB_ControlRequest.bRequest)
  51         {
  52                 case REQ_GetLineEncoding:
  53                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  54                         {
  55                                 Endpoint_ClearSETUP();
  56                                 Endpoint_Write_Control_Stream_LE(&CDCInterfaceInfo->State.LineEncoding, sizeof(CDCInterfaceInfo->State.LineEncoding));
  57                                 Endpoint_ClearOUT();
  58                         }
  59
  60                         break;
  61                 case REQ_SetLineEncoding:
  62                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  63                         {
  64                                 Endpoint_ClearSETUP();
  65                                 Endpoint_Read_Control_Stream_LE(&CDCInterfaceInfo->State.LineEncoding, sizeof(CDCInterfaceInfo->State.LineEncoding));
  66                                 Endpoint_ClearIN();
  67
  68                                 EVENT_CDC_Device_LineEncodingChanged(CDCInterfaceInfo);
  69                         }
  70
  71                         break;
  72                 case REQ_SetControlLineState:
  73                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  74                         {
  75                                 Endpoint_ClearSETUP();
  76
  77                                 CDCInterfaceInfo->State.ControlLineStates.HostToDevice = USB_ControlRequest.wValue;
  78
  79                                 EVENT_CDC_Device_ControLineStateChanged(CDCInterfaceInfo);
  80
  81                                 Endpoint_ClearStatusStage();
  82                         }
  83
  84                         break;
  85         }
  86 }
  87
  88 bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)
  89 {
  90         memset(&CDCInterfaceInfo->State, 0x00, sizeof(CDCInterfaceInfo->State));
  91
  92         if (!(Endpoint_ConfigureEndpoint(CDCInterfaceInfo->Config.DataINEndpointNumber, EP_TYPE_BULK,
  93                                                                  ENDPOINT_DIR_IN, CDCInterfaceInfo->Config.DataINEndpointSize,
  94                                                                  CDCInterfaceInfo->Config.DataINEndpointDoubleBank ? ENDPOINT_BANK_DOUBLE : ENDPOINT_BANK_SINGLE)))
  95         {
  96                 return false;
  97         }
  98
  99         if (!(Endpoint_ConfigureEndpoint(CDCInterfaceInfo->Config.DataOUTEndpointNumber, EP_TYPE_BULK,
 100                                          ENDPOINT_DIR_OUT, CDCInterfaceInfo->Config.DataOUTEndpointSize,
 101                                          CDCInterfaceInfo->Config.DataOUTEndpointDoubleBank ? ENDPOINT_BANK_DOUBLE : ENDPOINT_BANK_SINGLE)))
 102         {
 103                 return false;
 104         }
 105
 106         if (!(Endpoint_ConfigureEndpoint(CDCInterfaceInfo->Config.NotificationEndpointNumber, EP_TYPE_INTERRUPT,
 107                                          ENDPOINT_DIR_IN, CDCInterfaceInfo->Config.NotificationEndpointSize,
 108                                          CDCInterfaceInfo->Config.NotificationEndpointDoubleBank ? ENDPOINT_BANK_DOUBLE : ENDPOINT_BANK_SINGLE)))
 109         {
 110                 return false;
 111         }
 112
 113         return true;
 114 }
 115
 116 void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)
 117 {
 118         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 119           return;
 120
 121         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataOUTEndpointNumber);
 122
 123         if (Endpoint_IsOUTReceived() && !(Endpoint_BytesInEndpoint()))
 124           Endpoint_ClearOUT();
 125
 126         CDC_Device_Flush(CDCInterfaceInfo);
 127 }
 128
 129 uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const Data, const uint16_t Length)
 130 {
 131         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 132           return ENDPOINT_RWSTREAM_DeviceDisconnected;
 133
 134         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataINEndpointNumber);
 135         return Endpoint_Write_Stream_LE(Data, Length, NO_STREAM_CALLBACK);
 136 }
 137
 138 uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, const uint8_t Data)
 139 {
 140         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 141           return ENDPOINT_RWSTREAM_DeviceDisconnected;
 142
 143         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataINEndpointNumber);
 144
 145         if (!(Endpoint_IsReadWriteAllowed()))
 146         {
 147                 Endpoint_ClearIN();
 148
 149                 uint8_t ErrorCode;
 150
 151                 if ((ErrorCode = Endpoint_WaitUntilReady()) != ENDPOINT_READYWAIT_NoError)
 152                   return ErrorCode;
 153         }
 154
 155         Endpoint_Write_Byte(Data);
 156         return ENDPOINT_READYWAIT_NoError;
 157 }
 158
 159 uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 160 {
 161         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 162           return ENDPOINT_RWSTREAM_DeviceDisconnected;
 163
 164         uint8_t ErrorCode;
 165
 166         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataINEndpointNumber);
 167
 168         if (!(Endpoint_BytesInEndpoint()))
 169           return ENDPOINT_READYWAIT_NoError;
 170
 171         bool BankFull = !(Endpoint_IsReadWriteAllowed());
 172
 173         Endpoint_ClearIN();
 174
 175         if (BankFull)
 176         {
 177                 if ((ErrorCode = Endpoint_WaitUntilReady()) != ENDPOINT_READYWAIT_NoError)
 178                   return ErrorCode;
 179
 180                 Endpoint_ClearIN();
 181         }
 182
 183         return ENDPOINT_READYWAIT_NoError;
 184 }
 185
 186 uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 187 {
 188         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 189           return 0;
 190
 191         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataOUTEndpointNumber);
 192
 193         if (Endpoint_IsOUTReceived())
 194         {
 195                 if (!(Endpoint_BytesInEndpoint()))
 196                   Endpoint_ClearOUT();
 197
 198                 return Endpoint_BytesInEndpoint();
 199         }
 200         else
 201         {
 202                 return 0;
 203         }
 204 }
 205
 206 uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)
 207 {
 208         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 209           return 0;
 210
 211         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataOUTEndpointNumber);
 212
 213         uint8_t DataByte = Endpoint_Read_Byte();
 214
 215         if (!(Endpoint_BytesInEndpoint()))
 216           Endpoint_ClearOUT();
 217
 218         return DataByte;
 219 }
 220
 221 void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 222 {
 223         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 224           return;
 225
 226         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.NotificationEndpointNumber);
 227
 228         USB_Request_Header_t Notification = (USB_Request_Header_t)
 229                 {
 230                         .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
 231                         .bRequest      = NOTIF_SerialState,
 232                         .wValue        = 0,
 233                         .wIndex        = 0,
 234                         .wLength       = sizeof(CDCInterfaceInfo->State.ControlLineStates.DeviceToHost),
 235                 };
 236
 237         Endpoint_Write_Stream_LE(&Notification, sizeof(USB_Request_Header_t), NO_STREAM_CALLBACK);
 238         Endpoint_Write_Stream_LE(&CDCInterfaceInfo->State.ControlLineStates.DeviceToHost,
 239                                  sizeof(CDCInterfaceInfo->State.ControlLineStates.DeviceToHost),
 240                                  NO_STREAM_CALLBACK);
 241         Endpoint_ClearIN();
 242 }
 243
 244 void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream)
 245 {
 246         *Stream = (FILE)FDEV_SETUP_STREAM(CDC_Device_putchar, CDC_Device_getchar, _FDEV_SETUP_RW);
 247         fdev_set_udata(Stream, CDCInterfaceInfo);
 248 }
 249
 250 void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream)
 251 {
 252         *Stream = (FILE)FDEV_SETUP_STREAM(CDC_Device_putchar, CDC_Device_getchar_Blocking, _FDEV_SETUP_RW);
 253         fdev_set_udata(Stream, CDCInterfaceInfo);
 254 }
 255
 256 static int CDC_Device_putchar(char c, FILE* Stream)
 257 {
 258         return CDC_Device_SendByte((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream), c) ? _FDEV_ERR : 0;
 259 }
 260
 261 static int CDC_Device_getchar(FILE* Stream)
 262 {
 263         if (!(CDC_Device_BytesReceived((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream))))
 264           return _FDEV_EOF;
 265
 266         return CDC_Device_ReceiveByte((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream));
 267 }
 268
 269 static int CDC_Device_getchar_Blocking(FILE* Stream)
 270 {
 271         while (!(CDC_Device_BytesReceived((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream))))
 272         {
 273                 if (USB_DeviceState == DEVICE_STATE_Unattached)
 274                   return _FDEV_EOF;
 275
 276                 CDC_Device_USBTask((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream));
 277                 USB_USBTask();
 278         }
 279
 280         return CDC_Device_ReceiveByte((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream));
 281 }
 282
 283 #endif