CDC.h 16.7 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting 
  documentation, and that the name of the author not be used in 
  advertising or publicity pertaining to distribution of the 
19
20
21
22
23
24
25
26
27
28
29
30
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

31
32
/** \ingroup Group_USBClassCDC
 *  @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver
33
 *
34
35
36
37
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
 *    - LUFA/Drivers/USB/Class/Device/CDC.c
 *
38
 *  \section Module Description
39
 *  Device Mode USB Class driver framework interface, for the CDC USB Class driver.
40
 *
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 *  \note There are several major drawbacks to the CDC-ACM standard USB class, however
 *        it is very standardized and thus usually available as a built-in driver on
 *        most platforms, and so is a better choice than a proprietary serial class.
 *        
 *        One major issue with CDC-ACM is that it requires two Interface descriptors,
 *        which will upset most hosts when part of a multi-function "Composite" USB
 *        device, as each interface will be loaded into a separate driver instance. To
 *        conbat this, you should use the "Interface Association Descriptor" addendum to
 *        the USB standard which is available on most OSes when creating Composite devices.
 *
 *        Another major oversight is that there is no mechanism for the host to notify the
 *        device that there is a data sink on the host side ready to accept data. This
 *        means that the device may try to send data while the host isn't listening, causing
 *        lengthy blocking timeouts in the transmission routines. To combat this, it is
 *        recommended that the virtual serial line DTR (Data Terminal Ready) be used where
 *        possible to determine if a host application is ready for data.
 *
58
59
60
 *  @{
 */
 
61
62
#ifndef _CDC_CLASS_DEVICE_H_
#define _CDC_CLASS_DEVICE_H_
63
64
65

	/* Includes: */
		#include "../../USB.h"
66
		#include "../Common/CDC.h"
67

68
		#include <stdio.h>
69
70
		#include <string.h>

71
72
73
74
75
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

76
	/* Public Interface - May be used in end-application: */
77
		/* Type Defines: */
78
79
80
81
			/** Class state structure. An instance of this structure should be made for each CDC interface
			 *  within the user application, and passed to each of the CDC class driver functions as the
			 *  CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.
			 */
82
83
			typedef struct
			{
84
85
86
				const struct
				{
					uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
87

88
89
					uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */
					uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */
90
					bool     DataINEndpointDoubleBank; /** Indicates if the CDC interface's IN data endpoint should use double banking */
91

92
93
					uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */
					uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */
94
					bool     DataOUTEndpointDoubleBank; /** Indicates if the CDC interface's OUT data endpoint should use double banking */
95

96
97
					uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */
					uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
98
					bool     NotificationEndpointDoubleBank; /** Indicates if the CDC interface's notification endpoint should use double banking */
99
100
101
				} Config; /**< Config data for the USB class interface within the device. All elements in this section
				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
				           */
102
103
				struct
				{
104
105
106
107
108
109
110
111
112
					struct
					{
						uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
											   *   masks.
											   */
						uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
											   *   masks.
											   */
					} ControlLineStates;
113

114
115
116
117
118
119
120
121
122
123
124
125
					struct
					{
						uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
						uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
											  *   CDCDevice_CDC_LineCodingFormats_t enum
											  */
						uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
											  *   CDCDevice_LineCodingParity_t enum
											  */
						uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
					} LineEncoding;			
				} State; /**< State data for the USB class interface within the device. All elements in this section
126
				          *   are reset to their defaults when the interface is enumerated.
127
				          */
128
129
			} USB_ClassInfo_CDC_Device_t;
		
130
131
		/* Function Prototypes: */		
			/** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
132
133
			 *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
			 *  the given CDC interface is selected.
134
			 *
135
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
136
			 *
137
			 *  \return Boolean true if the endpoints were successfully configured, false otherwise
138
			 */
139
			bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
140

141
			/** Processes incoming control requests from the host, that are directed to the given CDC class interface. This should be
142
			 *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
143
			 *
144
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
145
			 */
146
			void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
147

148
149
150
			/** General management task for a given CDC class interface, required for the correct operation of the interface. This should
			 *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
			 *
151
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
152
			 */
153
			void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
154

155
156
157
158
159
			/** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a
			 *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the
			 *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding
			 *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.
			 *
160
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
161
			 */
162
			void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
163
164
165
166
			
			/** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
			 *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
			 *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
167
168
			 *  are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
			 *  a mask of CDC_CONTROL_LINE_OUT_* masks.
169
			 *
170
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
171
			 */
172
			void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
173

174
			/** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the
175
176
177
			 *  string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the
			 *  \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be 
			 *  packed into a single endpoint packet, increasing data throughput.
178
			 *
179
180
181
			 *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
			 *        the call will fail.
			 *
182
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
183
184
			 *  \param[in] Data  Pointer to the string to send to the host
			 *  \param[in] Length  Size in bytes of the string to send to the host
185
186
			 *
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
187
			 */
188
189
			uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const Data, const uint16_t Length)
			                              ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
190
191
			
			/** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
192
193
194
			 *  byte is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the
			 *  \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be 
			 *  packed into a single endpoint packet, increasing data throughput.
195
			 *
196
197
198
			 *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
			 *        the call will fail.
			 *
199
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
200
			 *  \param[in] Data  Byte of data to send to the host
201
202
			 *
			 *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
203
			 */
204
			uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
205
206
			
			/** Determines the number of bytes received by the CDC interface from the host, waiting to be read.
207
208
209
			 *
			 *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
			 *        the call will fail.
210
			 *
211
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
212
213
214
			 *
			 *  \return Total number of buffered bytes received from the host
			 */
215
			uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
216
217
			
			/** 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
218
			 *  returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data
219
220
			 *  underflow occurs.
			 *
221
222
223
			 *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
			 *        the call will fail.
			 *
224
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
225
226
227
			 *
			 *  \return Next received byte from the host, or 0 if no data received
			 */
228
			uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
229
			
230
			/** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
231
232
233
			 *
			 *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
			 *        the call will fail.
234
			 *
235
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
236
237
			 *
			 *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
238
			 */
239
			uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
240
			
241
			/** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial
242
			 *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist
243
244
			 *  until they are cleared via a second notification. This should be called each time the CDC class driver's 
			 *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
245
			 *
246
247
248
			 *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
			 *        the call will fail.
			 *
249
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
250
			 */
251
			void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
252

253
			/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
254
255
			 *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
			 *  stream is bidirectional and can be used for both input and output functions.
256
			 *
257
258
259
260
261
			 *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
			 *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
			 *  be used when the read data is processed byte-per-bye (via getc()) or when the user application will implement its own
			 *  line buffering.
			 *
262
263
264
265
266
267
268
269
			 *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
			 *        to the given CDC interface.
			 *
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
			 *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed
			 */
			void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);

270
271
272
273
274
275
276
277
			/** Identical to CDC_Device_CreateStream(), except that reads are blocking until the calling stream function terminates
			 *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
			 *
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
			 *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed
			 */
			void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);

278
279
280
281
	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Function Prototypes: */
			#if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)
282
283
				static int CDC_Device_putchar(char c, FILE* Stream);
				static int CDC_Device_getchar(FILE* Stream);
284
				static int CDC_Device_getchar_Blocking(FILE* Stream);
285
				
286
				void CDC_Device_Event_Stub(void);
287
				void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
288
														  ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
289
				void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
290
															 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
291
292
293
294
			#endif

	#endif
	
295
296
297
298
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
299
300
		
#endif
301
302

/** @} */