projects / pub / USBasp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Add file-level brief documentation.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / CDC.h
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 /** \file
32 * \brief Device mode driver for the library USB CDC Class driver.
33 *
34 * \note This file should not be included directly. It is automatically included as needed by the class driver
35 * dispatch header located in LUFA/Drivers/USB/Class/CDC.h.
36 */
37
38 /** \ingroup Group_USBClassCDC
39 * @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver
40 *
41 * \section Sec_Dependencies Module Source Dependencies
42 * The following files must be built with any user project that uses this module:
43 * - LUFA/Drivers/USB/Class/Device/CDC.c
44 *
45 * \section Module Description
46 * Device Mode USB Class driver framework interface, for the CDC USB Class driver.
47 *
48 * \note There are several major drawbacks to the CDC-ACM standard USB class, however
49 * it is very standardized and thus usually available as a built-in driver on
50 * most platforms, and so is a better choice than a proprietary serial class.
51 *
52 * One major issue with CDC-ACM is that it requires two Interface descriptors,
53 * which will upset most hosts when part of a multi-function "Composite" USB
54 * device, as each interface will be loaded into a separate driver instance. To
55 * conbat this, you should use the "Interface Association Descriptor" addendum to
56 * the USB standard which is available on most OSes when creating Composite devices.
57 *
58 * Another major oversight is that there is no mechanism for the host to notify the
59 * device that there is a data sink on the host side ready to accept data. This
60 * means that the device may try to send data while the host isn't listening, causing
61 * lengthy blocking timeouts in the transmission routines. To combat this, it is
62 * recommended that the virtual serial line DTR (Data Terminal Ready) be used where
63 * possible to determine if a host application is ready for data.
64 *
65 * @{
66 */
67
68 #ifndef _CDC_CLASS_DEVICE_H_
69 #define _CDC_CLASS_DEVICE_H_
70
71 /* Includes: */
72 #include "../../USB.h"
73 #include "../Common/CDC.h"
74
75 #include <stdio.h>
76 #include <string.h>
77
78 /* Enable C linkage for C++ Compilers: */
79 #if defined(__cplusplus)
80 extern "C" {
81 #endif
82
83 /* Preprocessor Checks: */
84 #if !defined(__INCLUDE_FROM_CDC_DRIVER)
85 #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.
86 #endif
87
88 /* Public Interface - May be used in end-application: */
89 /* Type Defines: */
90 /** Class state structure. An instance of this structure should be made for each CDC interface
91 * within the user application, and passed to each of the CDC class driver functions as the
92 * CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.
93 */
94 typedef struct
95 {
96 const struct
97 {
98 uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
99
100 uint8_t DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */
101 uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */
102 bool DataINEndpointDoubleBank; /** Indicates if the CDC interface's IN data endpoint should use double banking */
103
104 uint8_t DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */
105 uint16_t DataOUTEndpointSize; /**< Size in bytes of the CDC interface's OUT data endpoint */
106 bool DataOUTEndpointDoubleBank; /** Indicates if the CDC interface's OUT data endpoint should use double banking */
107
108 uint8_t NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */
109 uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
110 bool NotificationEndpointDoubleBank; /** Indicates if the CDC interface's notification endpoint should use double banking */
111 } Config; /**< Config data for the USB class interface within the device. All elements in this section
112 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
113 */
114 struct
115 {
116 struct
117 {
118 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
119 * masks. This value is updated each time \ref CDC_Device_USBTask() is called.
120 */
121 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
122 * masks - to notify the host of changes to these values, call the
123 * \ref CDC_Device_SendControlLineStateChange() function.
124 */
125 } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
126
127 struct
128 {
129 uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
130 uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the
131 * CDCDevice_CDC_LineCodingFormats_t enum
132 */
133 uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the
134 * CDCDevice_LineCodingParity_t enum
135 */
136 uint8_t DataBits; /**< Bits of data per character of the virtual serial port */
137 } LineEncoding; /** Line encoding used in the virtual serial port, for the device's information. This is generally
138 * only used if the virtual serial port data is to be reconstructed on a physical UART.
139 */
140 } State; /**< State data for the USB class interface within the device. All elements in this section
141 * are reset to their defaults when the interface is enumerated.
142 */
143 } USB_ClassInfo_CDC_Device_t;
144
145 /* Function Prototypes: */
146 /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
147 * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
148 * the given CDC interface is selected.
149 *
150 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
151 *
152 * \return Boolean true if the endpoints were successfully configured, false otherwise
153 */
154 bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
155
156 /** Processes incoming control requests from the host, that are directed to the given CDC class interface. This should be
157 * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
158 *
159 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
160 */
161 void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
162
163 /** General management task for a given CDC class interface, required for the correct operation of the interface. This should
164 * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
165 *
166 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
167 */
168 void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
169
170 /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a
171 * line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the
172 * user program by declaring a handler function with the same name and parameters listed here. The new line encoding
173 * settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.
174 *
175 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
176 */
177 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
178
179 /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
180 * control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
181 * user program by declaring a handler function with the same name and parameters listed here. The new control line states
182 * are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
183 * a mask of CDC_CONTROL_LINE_OUT_* masks.
184 *
185 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
186 */
187 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
188
189 /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the
190 * string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the
191 * \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
192 * packed into a single endpoint packet, increasing data throughput.
193 *
194 * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
195 * the call will fail.
196 *
197 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
198 * \param[in] Data Pointer to the string to send to the host
199 * \param[in] Length Size in bytes of the string to send to the host
200 *
201 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
202 */
203 uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const Data, const uint16_t Length)
204 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
205
206 /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
207 * byte is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the
208 * \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
209 * packed into a single endpoint packet, increasing data throughput.
210 *
211 * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
212 * the call will fail.
213 *
214 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
215 * \param[in] Data Byte of data to send to the host
216 *
217 * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
218 */
219 uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
220
221 /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.
222 *
223 * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
224 * the call will fail.
225 *
226 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
227 *
228 * \return Total number of buffered bytes received from the host
229 */
230 uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
231
232 /** 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
233 * returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data
234 * underflow occurs.
235 *
236 * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
237 * the call will fail.
238 *
239 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
240 *
241 * \return Next received byte from the host, or 0 if no data received
242 */
243 uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
244
245 /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
246 *
247 * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
248 * the call will fail.
249 *
250 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
251 *
252 * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
253 */
254 uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
255
256 /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial
257 * control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist
258 * until they are cleared via a second notification. This should be called each time the CDC class driver's
259 * ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
260 *
261 * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
262 * the call will fail.
263 *
264 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
265 */
266 void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
267
268 /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
269 * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
270 * stream is bidirectional and can be used for both input and output functions.
271 *
272 * Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
273 * fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
274 * be used when the read data is processed byte-per-bye (via getc()) or when the user application will implement its own
275 * line buffering.
276 *
277 * \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
278 * to the given CDC interface.
279 *
280 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
281 * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
282 */
283 void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);
284
285 /** Identical to CDC_Device_CreateStream(), except that reads are blocking until the calling stream function terminates
286 * the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
287 *
288 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
289 * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
290 */
291 void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);
292
293 /* Private Interface - For use in library only: */
294 #if !defined(__DOXYGEN__)
295 /* Function Prototypes: */
296 #if defined(__INCLUDE_FROM_CDC_CLASS_DEVICE_C)
297 static int CDC_Device_putchar(char c, FILE* Stream);
298 static int CDC_Device_getchar(FILE* Stream);
299 static int CDC_Device_getchar_Blocking(FILE* Stream);
300
301 void CDC_Device_Event_Stub(void);
302 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
303 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
304 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
305 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
306 #endif
307
308 #endif
309
310 /* Disable C linkage for C++ Compilers: */
311 #if defined(__cplusplus)
312 }
313 #endif
314
315 #endif
316
317 /** @} */
USB isp AVR programmer