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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 #define  __INCLUDE_FROM_USB_DRIVER
  32 #include "../../Core/USBMode.h"
  33
  34 #if defined(USB_CAN_BE_DEVICE)
  35
  36 #define  __INCLUDE_FROM_CDC_DRIVER
  37 #define  __INCLUDE_FROM_CDC_DEVICE_C
  38 #include "CDCClassDevice.h"
  39
  40 void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
  41 {
  42         if (!(Endpoint_IsSETUPReceived()))
  43           return;
  44
  45         if (USB_ControlRequest.wIndex != CDCInterfaceInfo->Config.ControlInterfaceNumber)
  46           return;
  47
  48         switch (USB_ControlRequest.bRequest)
  49         {
  50                 case CDC_REQ_GetLineEncoding:
  51                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  52                         {
  53                                 Endpoint_ClearSETUP();
  54
  55                                 while (!(Endpoint_IsINReady()));
  56
  57                                 Endpoint_Write_32_LE(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS);
  58                                 Endpoint_Write_8(CDCInterfaceInfo->State.LineEncoding.CharFormat);
  59                                 Endpoint_Write_8(CDCInterfaceInfo->State.LineEncoding.ParityType);
  60                                 Endpoint_Write_8(CDCInterfaceInfo->State.LineEncoding.DataBits);
  61
  62                                 Endpoint_ClearIN();
  63                                 Endpoint_ClearStatusStage();
  64                         }
  65
  66                         break;
  67                 case CDC_REQ_SetLineEncoding:
  68                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  69                         {
  70                                 Endpoint_ClearSETUP();
  71
  72                                 while (!(Endpoint_IsOUTReceived()));
  73
  74                                 CDCInterfaceInfo->State.LineEncoding.BaudRateBPS = Endpoint_Read_32_LE();
  75                                 CDCInterfaceInfo->State.LineEncoding.CharFormat  = Endpoint_Read_8();
  76                                 CDCInterfaceInfo->State.LineEncoding.ParityType  = Endpoint_Read_8();
  77                                 CDCInterfaceInfo->State.LineEncoding.DataBits    = Endpoint_Read_8();
  78
  79                                 Endpoint_ClearOUT();
  80                                 Endpoint_ClearStatusStage();
  81
  82                                 EVENT_CDC_Device_LineEncodingChanged(CDCInterfaceInfo);
  83                         }
  84
  85                         break;
  86                 case CDC_REQ_SetControlLineState:
  87                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  88                         {
  89                                 Endpoint_ClearSETUP();
  90                                 Endpoint_ClearStatusStage();
  91
  92                                 CDCInterfaceInfo->State.ControlLineStates.HostToDevice = USB_ControlRequest.wValue;
  93
  94                                 EVENT_CDC_Device_ControLineStateChanged(CDCInterfaceInfo);
  95                         }
  96
  97                         break;
  98                 case CDC_REQ_SendBreak:
  99                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 100                         {
 101                                 Endpoint_ClearSETUP();
 102                                 Endpoint_ClearStatusStage();
 103
 104                                 EVENT_CDC_Device_BreakSent(CDCInterfaceInfo, (uint8_t)USB_ControlRequest.wValue);
 105                         }
 106
 107                         break;
 108         }
 109 }
 110
 111 bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 112 {
 113         memset(&CDCInterfaceInfo->State, 0x00, sizeof(CDCInterfaceInfo->State));
 114
 115         CDCInterfaceInfo->Config.DataINEndpoint.Type       = EP_TYPE_BULK;
 116         CDCInterfaceInfo->Config.DataOUTEndpoint.Type      = EP_TYPE_BULK;
 117         CDCInterfaceInfo->Config.NotificationEndpoint.Type = EP_TYPE_INTERRUPT;
 118
 119         if (!(Endpoint_ConfigureEndpointTable(&CDCInterfaceInfo->Config.DataINEndpoint, 1)))
 120           return false;
 121
 122         if (!(Endpoint_ConfigureEndpointTable(&CDCInterfaceInfo->Config.DataOUTEndpoint, 1)))
 123           return false;
 124
 125         if (!(Endpoint_ConfigureEndpointTable(&CDCInterfaceInfo->Config.NotificationEndpoint, 1)))
 126           return false;
 127
 128         return true;
 129 }
 130
 131 void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 132 {
 133         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 134           return;
 135
 136         #if !defined(NO_CLASS_DRIVER_AUTOFLUSH)
 137         CDC_Device_Flush(CDCInterfaceInfo);
 138         #endif
 139 }
 140
 141 uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 142                               const char* const String)
 143 {
 144         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 145           return ENDPOINT_RWSTREAM_DeviceDisconnected;
 146
 147         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataINEndpoint.Address);
 148         return Endpoint_Write_Stream_LE(String, strlen(String), NULL);
 149 }
 150
 151 uint8_t CDC_Device_SendData(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 152                             const char* const Buffer,
 153                             const uint16_t Length)
 154 {
 155         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 156           return ENDPOINT_RWSTREAM_DeviceDisconnected;
 157
 158         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataINEndpoint.Address);
 159         return Endpoint_Write_Stream_LE(Buffer, Length, NULL);
 160 }
 161
 162 uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 163                             const uint8_t Data)
 164 {
 165         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 166           return ENDPOINT_RWSTREAM_DeviceDisconnected;
 167
 168         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataINEndpoint.Address);
 169
 170         if (!(Endpoint_IsReadWriteAllowed()))
 171         {
 172                 Endpoint_ClearIN();
 173
 174                 uint8_t ErrorCode;
 175
 176                 if ((ErrorCode = Endpoint_WaitUntilReady()) != ENDPOINT_READYWAIT_NoError)
 177                   return ErrorCode;
 178         }
 179
 180         Endpoint_Write_8(Data);
 181         return ENDPOINT_READYWAIT_NoError;
 182 }
 183
 184 uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 185 {
 186         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 187           return ENDPOINT_RWSTREAM_DeviceDisconnected;
 188
 189         uint8_t ErrorCode;
 190
 191         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataINEndpoint.Address);
 192
 193         if (!(Endpoint_BytesInEndpoint()))
 194           return ENDPOINT_READYWAIT_NoError;
 195
 196         bool BankFull = !(Endpoint_IsReadWriteAllowed());
 197
 198         Endpoint_ClearIN();
 199
 200         if (BankFull)
 201         {
 202                 if ((ErrorCode = Endpoint_WaitUntilReady()) != ENDPOINT_READYWAIT_NoError)
 203                   return ErrorCode;
 204
 205                 Endpoint_ClearIN();
 206         }
 207
 208         return ENDPOINT_READYWAIT_NoError;
 209 }
 210
 211 uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 212 {
 213         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 214           return 0;
 215
 216         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataOUTEndpoint.Address);
 217
 218         if (Endpoint_IsOUTReceived())
 219         {
 220                 if (!(Endpoint_BytesInEndpoint()))
 221                 {
 222                         Endpoint_ClearOUT();
 223                         return 0;
 224                 }
 225                 else
 226                 {
 227                         return Endpoint_BytesInEndpoint();
 228                 }
 229         }
 230         else
 231         {
 232                 return 0;
 233         }
 234 }
 235
 236 int16_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 237 {
 238         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 239           return -1;
 240
 241         int16_t ReceivedByte = -1;
 242
 243         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.DataOUTEndpoint.Address);
 244
 245         if (Endpoint_IsOUTReceived())
 246         {
 247                 if (Endpoint_BytesInEndpoint())
 248                   ReceivedByte = Endpoint_Read_8();
 249
 250                 if (!(Endpoint_BytesInEndpoint()))
 251                   Endpoint_ClearOUT();
 252         }
 253
 254         return ReceivedByte;
 255 }
 256
 257 void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 258 {
 259         if ((USB_DeviceState != DEVICE_STATE_Configured) || !(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS))
 260           return;
 261
 262         Endpoint_SelectEndpoint(CDCInterfaceInfo->Config.NotificationEndpoint.Address);
 263
 264         USB_Request_Header_t Notification = (USB_Request_Header_t)
 265                 {
 266                         .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
 267                         .bRequest      = CDC_NOTIF_SerialState,
 268                         .wValue        = CPU_TO_LE16(0),
 269                         .wIndex        = CPU_TO_LE16(0),
 270                         .wLength       = CPU_TO_LE16(sizeof(CDCInterfaceInfo->State.ControlLineStates.DeviceToHost)),
 271                 };
 272
 273         Endpoint_Write_Stream_LE(&Notification, sizeof(USB_Request_Header_t), NULL);
 274         Endpoint_Write_Stream_LE(&CDCInterfaceInfo->State.ControlLineStates.DeviceToHost,
 275                                  sizeof(CDCInterfaceInfo->State.ControlLineStates.DeviceToHost),
 276                                  NULL);
 277         Endpoint_ClearIN();
 278 }
 279
 280 #if defined(FDEV_SETUP_STREAM)
 281 void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 282                              FILE* const Stream)
 283 {
 284         *Stream = (FILE)FDEV_SETUP_STREAM(CDC_Device_putchar, CDC_Device_getchar, _FDEV_SETUP_RW);
 285         fdev_set_udata(Stream, CDCInterfaceInfo);
 286 }
 287
 288 void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 289                                      FILE* const Stream)
 290 {
 291         *Stream = (FILE)FDEV_SETUP_STREAM(CDC_Device_putchar, CDC_Device_getchar_Blocking, _FDEV_SETUP_RW);
 292         fdev_set_udata(Stream, CDCInterfaceInfo);
 293 }
 294
 295 static int CDC_Device_putchar(char c,
 296                               FILE* Stream)
 297 {
 298         return CDC_Device_SendByte((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream), c) ? _FDEV_ERR : 0;
 299 }
 300
 301 static int CDC_Device_getchar(FILE* Stream)
 302 {
 303         int16_t ReceivedByte = CDC_Device_ReceiveByte((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream));
 304
 305         if (ReceivedByte < 0)
 306           return _FDEV_EOF;
 307
 308         return ReceivedByte;
 309 }
 310
 311 static int CDC_Device_getchar_Blocking(FILE* Stream)
 312 {
 313         int16_t ReceivedByte;
 314
 315         while ((ReceivedByte = CDC_Device_ReceiveByte((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream))) < 0)
 316         {
 317                 if (USB_DeviceState == DEVICE_STATE_Unattached)
 318                   return _FDEV_EOF;
 319
 320                 CDC_Device_USBTask((USB_ClassInfo_CDC_Device_t*)fdev_get_udata(Stream));
 321                 USB_USBTask();
 322         }
 323
 324         return ReceivedByte;
 325 }
 326 #endif
 327
 328 // cppcheck-suppress unusedFunction
 329 void CDC_Device_Event_Stub(void)
 330 {
 331
 332 }
 333
 334 #endif
 335