projects / pub / USBasp.git / blob
? search:


f7bdee01983fd925028b688b024c529e31eb382c
[pub/USBasp.git] / 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 Sec_Dependencies Module Source Dependencies
35 * The following files must be built with any user project that uses this module:
36 * - LUFA/Drivers/USB/Class/Device/CDC.c
37 *
38 * \section Module Description
39 * Device Mode USB Class driver framework interface, for the CDC USB Class driver.
40 *
41 * @{
42 */
43
44 #ifndef _CDC_CLASS_DEVICE_H_
45 #define _CDC_CLASS_DEVICE_H_
46
47 /* Includes: */
48 #include "../../USB.h"
49 #include "../Common/CDC.h"
50
51 #include <stdio.h>
52 #include <string.h>
53
54 /* Enable C linkage for C++ Compilers: */
55 #if defined(__cplusplus)
56 extern "C" {
57 #endif
58
59 /* Public Interface - May be used in end-application: */
60 /* Type Defines: */
61 /** Class state structure. An instance of this structure should be made for each CDC interface
62 * within the user application, and passed to each of the CDC class driver functions as the
63 * CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.
64 */
65 typedef struct
66 {
67 const struct
68 {
69 uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
70
71 uint8_t DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */
72 uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */
73 bool DataINEndpointDoubleBank; /** Indicates if the CDC interface's IN data endpoint should use double banking */
74
75 uint8_t DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */
76 uint16_t DataOUTEndpointSize; /**< Size in bytes of the CDC interface's OUT data endpoint */
77 bool DataOUTEndpointDoubleBank; /** Indicates if the CDC interface's OUT data endpoint should use double banking */
78
79 uint8_t NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */
80 uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
81 bool NotificationEndpointDoubleBank; /** Indicates if the CDC interface's notification endpoint should use double banking */
82 } Config; /**< Config data for the USB class interface within the device. All elements in this section
83 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
84 */
85 struct
86 {
87 struct
88 {
89 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
90 * masks.
91 */
92 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
93 * masks.
94 */
95 } ControlLineStates;
96
97 struct
98 {
99 uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
100 uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the
101 * CDCDevice_CDC_LineCodingFormats_t enum
102 */
103 uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the
104 * CDCDevice_LineCodingParity_t enum
105 */
106 uint8_t DataBits; /**< Bits of data per character of the virtual serial port */
107 } LineEncoding;
108 } State; /**< State data for the USB class interface within the device. All elements in this section
109 * are reset to their defaults when the interface is enumerated.
110 */
111 } USB_ClassInfo_CDC_Device_t;
112
113 /* Function Prototypes: */
114 /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
115 * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
116 * the given CDC interface is selected.
117 *
118 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
119 *
120 * \return Boolean true if the endpoints were successfully configured, false otherwise
121 */
122 bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
123
124 /** Processes incoming control requests from the host, that are directed to the given CDC class interface. This should be
125 * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
126 *
127 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
128 */
129 void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
130
131 /** General management task for a given CDC class interface, required for the correct operation of the interface. This should
132 * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
133 *
134 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
135 */
136 void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
137
138 /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a
139 * line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the
140 * user program by declaring a handler function with the same name and parameters listed here. The new line encoding
141 * settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.
142 *
143 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
144 */
145 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
146
147 /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
148 * control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
149 * user program by declaring a handler function with the same name and parameters listed here. The new control line states
150 * are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
151 * a mask of CDC_CONTROL_LINE_OUT_* masks.
152 *
153 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
154 */
155 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
156
157 /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the
158 * string is discarded.
159 *
160 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
161 * \param[in] Data Pointer to the string to send to the host
162 * \param[in] Length Size in bytes of the string to send to the host
163 *
164 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
165 */
166 uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const Data, const uint16_t Length)
167 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
168
169 /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
170 * byte is discarded.
171 *
172 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
173 * \param[in] Data Byte of data to send to the host
174 *
175 * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
176 */
177 uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
178
179 /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.
180 *
181 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
182 *
183 * \return Total number of buffered bytes received from the host
184 */
185 uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
186
187 /** 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
188 * returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data
189 * underflow occurs.
190 *
191 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
192 *
193 * \return Next received byte from the host, or 0 if no data received
194 */
195 uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
196
197 /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
198 *
199 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
200 *
201 * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
202 */
203 uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
204
205 /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial
206 * control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist
207 * until they are cleared via a second notification. This should be called each time the CDC class driver's
208 * ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
209 *
210 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
211 */
212 void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
213
214 /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
215 * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf).
216 *
217 * Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
218 * fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
219 * be used when the read data is processed byte-per-bye (via getc()) or when the user application will implement its own
220 * line buffering.
221 *
222 * \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
223 * to the given CDC interface.
224 *
225 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
226 * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
227 */
228 void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);
229
230 /** Identical to CDC_Device_CreateStream(), except that reads are blocking until the calling stream function terminates
231 * the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
232 *
233 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
234 * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
235 */
236 void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);
237
238 /* Private Interface - For use in library only: */
239 #if !defined(__DOXYGEN__)
240 /* Function Prototypes: */
241 #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)
242 static int CDC_Device_putchar(char c, FILE* Stream);
243 static int CDC_Device_getchar(FILE* Stream);
244 static int CDC_Device_getchar_Blocking(FILE* Stream);
245
246 void CDC_Device_Event_Stub(void);
247 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
248 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
249 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
250 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
251 #endif
252
253 #endif
254
255 /* Disable C linkage for C++ Compilers: */
256 #if defined(__cplusplus)
257 }
258 #endif
259
260 #endif
261
262 /** @} */
USB isp AVR programmer