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


cc7465d3acf3d1ec780220237f36cdcd67f848d9
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / CDC.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2011.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2011 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 Host mode driver for the library USB CDC Class driver.
33 *
34 * Host mode driver for the library USB CDC Class driver.
35 *
36 * \note This file should not be included directly. It is automatically included as needed by the USB module driver
37 * dispatch header located in LUFA/Drivers/USB.h.
38 */
39
40 /** \ingroup Group_USBClassCDC
41 * @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver
42 *
43 * \section Sec_Dependencies Module Source Dependencies
44 * The following files must be built with any user project that uses this module:
45 * - LUFA/Drivers/USB/Class/Host/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46 *
47 * \section Sec_ModDescription Module Description
48 * Host Mode USB Class driver framework interface, for the CDC USB Class driver.
49 *
50 * @{
51 */
52
53 #ifndef __CDC_CLASS_HOST_H__
54 #define __CDC_CLASS_HOST_H__
55
56 /* Includes: */
57 #include "../../USB.h"
58 #include "../Common/CDC.h"
59
60 #include <stdio.h>
61 #include <string.h>
62
63 /* Enable C linkage for C++ Compilers: */
64 #if defined(__cplusplus)
65 extern "C" {
66 #endif
67
68 /* Preprocessor Checks: */
69 #if !defined(__INCLUDE_FROM_CDC_DRIVER)
70 #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
71 #endif
72
73 #if defined(__INCLUDE_FROM_CDC_HOST_C) && defined(NO_STREAM_CALLBACKS)
74 #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
75 #endif
76
77 /* Public Interface - May be used in end-application: */
78 /* Type Defines: */
79 /** \brief CDC Class Host Mode Configuration and State Structure.
80 *
81 * Class state structure. An instance of this structure should be made within the user application,
82 * and passed to each of the CDC class driver functions as the \c CDCInterfaceInfo parameter. This
83 * stores each CDC interface's configuration and state information.
84 */
85 typedef struct
86 {
87 const struct
88 {
89 uint8_t DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe. */
90 bool DataINPipeDoubleBank; /**< Indicates if the CDC interface's IN data pipe should use double banking. */
91
92 uint8_t DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe. */
93 bool DataOUTPipeDoubleBank; /**< Indicates if the CDC interface's OUT data pipe should use double banking. */
94
95 uint8_t NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used. */
96 bool NotificationPipeDoubleBank; /**< Indicates if the CDC interface's notification pipe should use double banking. */
97 } Config; /**< Config data for the USB class interface within the device. All elements in this section
98 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
99 */
100 struct
101 {
102 bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
103 * after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the
104 * Configured state.
105 */
106 uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device. */
107
108 uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe. */
109 uint16_t DataOUTPipeSize; /**< Size in bytes of the CDC interface's OUT data pipe. */
110 uint16_t NotificationPipeSize; /**< Size in bytes of the CDC interface's IN notification pipe, if used. */
111
112 struct
113 {
114 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_*
115 * masks - to notify the device of changes to these values, call the
116 * \ref CDC_Host_SendControlLineStateChange() function.
117 */
118 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_*
119 * masks. This value is updated each time \ref CDC_Host_USBTask() is called.
120 */
121 } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
122
123 CDC_LineEncoding_t LineEncoding; /**< Line encoding used in the virtual serial port, for the device's information.
124 * This is generally only used if the virtual serial port data is to be
125 * reconstructed on a physical UART. When set by the host application, the
126 * \ref CDC_Host_SetLineEncoding() function must be called to push the changes
127 * to the device.
128 */
129 } State; /**< State data for the USB class interface within the device. All elements in this section
130 * <b>may</b> be set to initial values, but may also be ignored to default to sane values when
131 * the interface is enumerated.
132 */
133 } USB_ClassInfo_CDC_Host_t;
134
135 /* Enums: */
136 /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
137 enum CDC_Host_EnumerationFailure_ErrorCodes_t
138 {
139 CDC_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully. */
140 CDC_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor. */
141 CDC_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor. */
142 CDC_ENUMERROR_PipeConfigurationFailed = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
143 };
144
145 /* Function Prototypes: */
146 /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
147 * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
148 *
149 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state.
150 */
151 void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
152
153 /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
154 * Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
155 * state values and configures the pipes required to communicate with the interface if it is found within the device.
156 * This should be called once after the stack has enumerated the attached device, while the host state machine is in
157 * the Addressed state.
158 *
159 * \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other
160 * interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes
161 * within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.
162 *
163 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state.
164 * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor.
165 * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor.
166 *
167 * \return A value from the \ref CDC_Host_EnumerationFailure_ErrorCodes_t enum.
168 */
169 uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
170 uint16_t ConfigDescriptorSize,
171 void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
172
173 /** Sets the line encoding for the attached device's virtual serial port. This should be called when the \c LineEncoding
174 * values of the interface have been changed to push the new settings to the USB device.
175 *
176 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
177 *
178 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
179 */
180 uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
181
182 /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
183 * control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
184 * notification. This should be called each time the CDC class driver's \c ControlLineStates.HostToDevice value is updated
185 * to push the new states to the USB device.
186 *
187 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
188 *
189 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
190 */
191 uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
192
193 /** Sends a Send Break request to the device. This is generally used to separate data data or to indicate a special condition
194 * to the receiving device.
195 *
196 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
197 * \param[in] Duration Duration of the break, in milliseconds.
198 *
199 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
200 */
201 uint8_t CDC_Host_SendBreak(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
202 const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
203
204 /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the
205 * string is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
206 * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
207 * packed into a single pipe packet, increasing data throughput.
208 *
209 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
210 * call will fail.
211 *
212 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
213 * \param[in] Data Pointer to the string to send to the device.
214 * \param[in] Length Size in bytes of the string to send to the device.
215 *
216 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
217 */
218 uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
219 const char* const Data,
220 const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
221
222 /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
223 * byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
224 * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
225 * packed into a single pipe packet, increasing data throughput.
226 *
227 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
228 * call will fail.
229 *
230 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
231 * \param[in] Data Byte of data to send to the device.
232 *
233 * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
234 */
235 uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
236 const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
237
238 /** Determines the number of bytes received by the CDC interface from the device, waiting to be read. This indicates the number
239 * of bytes in the IN pipe bank only, and thus the number of calls to \ref CDC_Host_ReceiveByte() which are guaranteed to succeed
240 * immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be
241 * released back to the USB controller until all bytes are read.
242 *
243 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
244 * call will fail.
245 *
246 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
247 *
248 * \return Total number of buffered bytes received from the device.
249 */
250 uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
251
252 /** Reads a byte of data from the device. If no data is waiting to be read of if a USB device is not connected, the function
253 * returns a negative value. The \ref CDC_Host_BytesReceived() function may be queried in advance to determine how many bytes
254 * are currently buffered in the CDC interface's data receive pipe.
255 *
256 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
257 * call will fail.
258 *
259 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
260 *
261 * \return Next received byte from the device, or a negative value if no data received.
262 */
263 int16_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
264
265 /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
266 *
267 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
268 * call will fail.
269 *
270 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
271 *
272 * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
273 */
274 uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
275
276 /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
277 * functions in the avr-libc \c <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
278 * stream is bidirectional and can be used for both input and output functions.
279 *
280 * \note The created stream can be given as stdout if desired to direct the standard output from all \c <stdio.h> functions
281 * to the given CDC interface.
282 *
283 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.
284 * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed.
285 */
286 void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
287 FILE* const Stream);
288
289 /** Identical to CDC_Host_CreateStream(), except that reads are blocking until the calling stream function terminates
290 * the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
291 *
292 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.
293 * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed.
294 */
295 void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
296 FILE* const Stream);
297
298 /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
299 * the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
300 * user program by declaring a handler function with the same name and parameters listed here. The new control line states
301 * are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
302 * a mask of \c CDC_CONTROL_LINE_IN_* masks.
303 *
304 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
305 */
306 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
307
308 /* Private Interface - For use in library only: */
309 #if !defined(__DOXYGEN__)
310 /* Function Prototypes: */
311 #if defined(__INCLUDE_FROM_CDC_HOST_C)
312 static int CDC_Host_putchar(char c,
313 FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
314 static int CDC_Host_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
315 static int CDC_Host_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
316
317 void CDC_Host_Event_Stub(void) ATTR_CONST;
318 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
319 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
320
321 static uint8_t DCOMP_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
322 static uint8_t DCOMP_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
323 static uint8_t DCOMP_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
324 #endif
325 #endif
326
327 /* Disable C linkage for C++ Compilers: */
328 #if defined(__cplusplus)
329 }
330 #endif
331
332 #endif
333
334 /** @} */
335
USB isp AVR programmer