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

   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 /** \ingroup Group_USBClassCDC
  32  *  @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver
  33  *
  34  *  \section Module Description
  35  *  Device Mode USB Class driver framework interface, for the CDC USB Class driver.
  36  *
  37  *  @{
  38  */
  39
  40 #ifndef _CDC_CLASS_DEVICE_H_
  41 #define _CDC_CLASS_DEVICE_H_
  42
  43         /* Includes: */
  44                 #include "../../USB.h"
  45                 #include "../Common/CDC.h"
  46
  47                 #include <string.h>
  48
  49         /* Enable C linkage for C++ Compilers: */
  50                 #if defined(__cplusplus)
  51                         extern "C" {
  52                 #endif
  53
  54         /* Public Interface - May be used in end-application: */
  55                 /* Function Prototypes: */
  56                         /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
  57                          *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
  58                          *  given CDC interface is selected.
  59                          *
  60                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
  61                          *
  62                          *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
  63                          */
  64                         bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
  65
  66                         /** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be
  67                          *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
  68                          *
  69                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
  70                          */
  71                         void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
  72
  73                         /** General management task for a given CDC class interface, required for the correct operation of the interface. This should
  74                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
  75                          *
  76                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
  77                          */
  78                         void CDC_Device_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
  79
  80                         /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a
  81                          *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the
  82                          *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding
  83                          *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.
  84                          *
  85                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
  86                          */
  87                         void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
  88
  89                         /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
  90                          *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
  91                          *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
  92                          *  are available in the ControlLineState value inside the CDC interface structure passed as a parameter, set as a mask of
  93                          *  CDC_CONTROL_LINE_OUT_* masks.
  94                          *
  95                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
  96                          */
  97                         void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
  98
  99                         /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the
 100                          *  string is discarded.
 101                          *
 102                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 103                          *  \param Data  Pointer to the string to send to the host
 104                          *  \param Length  Size in bytes of the string to send to the host
 105                          */
 106                         void CDC_Device_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);
 107
 108                         /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
 109                          *  byte is discarded.
 110                          *
 111                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 112                          *  \param Data  Byte of data to send to the host
 113                          */
 114                         void CDC_Device_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);
 115
 116                         /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.
 117                          *
 118                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 119                          *
 120                          *  \return Total number of buffered bytes received from the host
 121                          */
 122                         uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
 123
 124                         /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function
 125                          *  returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data
 126                          *  underflow occurs.
 127                          *
 128                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 129                          *
 130                          *  \return Next received byte from the host, or 0 if no data received
 131                          */
 132                         uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
 133
 134                         /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial control
 135                          *  lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist until they are
 136                          *  cleared via a second notification.
 137                          *
 138                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 139                          *  \param LineStateMask  Mask of CDC_CONTROL_LINE_IN_* masks giving the current control line states
 140                          */
 141                         void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);
 142
 143         /* Private Interface - For use in library only: */
 144         #if !defined(__DOXYGEN__)
 145                 /* Function Prototypes: */
 146                         #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)
 147                                 void CDC_Device_Event_Stub(void);
 148                                 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)
 149                                                                                                                   ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);
 150                                 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)
 151                                                                                                                          ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);
 152                         #endif
 153
 154         #endif
 155
 156         /* Disable C linkage for C++ Compilers: */
 157                 #if defined(__cplusplus)
 158                         }
 159                 #endif
 160
 161 #endif
 162
 163 /** @} */