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


4bb16a50b98c24f923f7afe5a0933594ba73b61c
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / 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_USBClassCDCHost CDC Class Host 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/Host/CDC.c
37 *
38 * \section Module Description
39 * Host Mode USB Class driver framework interface, for the CDC USB Class driver.
40 *
41 * @{
42 */
43
44 #ifndef __CDC_CLASS_HOST_H__
45 #define __CDC_CLASS_HOST_H__
46
47 /* Includes: */
48 #include "../../USB.h"
49 #include "../Common/CDC.h"
50
51 /* Enable C linkage for C++ Compilers: */
52 #if defined(__cplusplus)
53 extern "C" {
54 #endif
55
56 /* Public Interface - May be used in end-application: */
57 /* Type Defines: */
58 /** Class state structure. An instance of this structure should be made within the user application,
59 * and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This
60 * stores each CDC interface's configuration and state information.
61 */
62 typedef struct
63 {
64 const struct
65 {
66 uint8_t DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */
67 uint8_t DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */
68 uint8_t NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */
69 } Config; /**< Config data for the USB class interface within the device. All elements in this section
70 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
71 */
72 struct
73 {
74 bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid
75 * after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the
76 * Configured state
77 */
78 uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */
79
80 uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */
81 uint16_t DataOUTPipeSize; /**< Size in bytes of the CDC interface's OUT data pipe */
82 uint16_t NotificationPipeSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
83
84 struct
85 {
86 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
87 * masks.
88 */
89 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
90 * masks.
91 */
92 } ControlLineStates;
93
94 struct
95 {
96 uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
97 uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the
98 * CDCDevice_CDC_LineCodingFormats_t enum
99 */
100 uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the
101 * CDCDevice_LineCodingParity_t enum
102 */
103 uint8_t DataBits; /**< Bits of data per character of the virtual serial port */
104 } LineEncoding;
105 } State; /**< State data for the USB class interface within the device. All elements in this section
106 * <b>may</b> be set to initial values, but may also be ignored to default to sane values when
107 * the interface is enumerated.
108 */
109 } USB_ClassInfo_CDC_Host_t;
110
111 /* Enums: */
112 /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
113 enum CDCHost_EnumerationFailure_ErrorCodes_t
114 {
115 CDC_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */
116 CDC_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */
117 CDC_ENUMERROR_NoCDCInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
118 CDC_ENUMERROR_EndpointsNotFound = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */
119 };
120
121 /* Function Prototypes: */
122 /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
123 * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
124 *
125 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state
126 */
127 void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
128
129 /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
130 * Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
131 * state values and configures the pipes required to communicate with the interface if it is found within the device.
132 * This should be called once after the stack has enumerated the attached device, while the host state machine is in
133 * the Addressed state.
134 *
135 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state
136 * \param[in] ConfigDescriptorLength Length of the attached device's Configuration Descriptor
137 * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
138 *
139 * \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum
140 */
141 uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,
142 uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);
143
144 /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding
145 * values of the interface have been changed to push the new settings to the USB device.
146 *
147 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
148 */
149 uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
150
151 /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
152 * control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
153 * notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated
154 * to push the new states to the USB device.
155 *
156 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
157 */
158 uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
159
160 /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the
161 * string is discarded.
162 *
163 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
164 * \param[in] Data Pointer to the string to send to the device
165 * \param[in] Length Size in bytes of the string to send to the device
166 */
167 void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1, 2);
168
169 /** Sends a given byte to the attached USB device, 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 host configuration and state
173 * \param[in] Data Byte of data to send to the device
174 */
175 void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
176
177 /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.
178 *
179 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
180 *
181 * \return Total number of buffered bytes received from the device
182 */
183 uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
184
185 /** 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
186 * returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is recieved to ensure that no data
187 * underflow occurs.
188 *
189 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
190 *
191 * \return Next received byte from the device, or 0 if no data received
192 */
193 uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
194
195 /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
196 * the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
197 * user program by declaring a handler function with the same name and parameters listed here. The new control line states
198 * are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
199 * a mask of CDC_CONTROL_LINE_IN_* masks.
200 *
201 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
202 */
203 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
204
205 /* Private Interface - For use in library only: */
206 #if !defined(__DOXYGEN__)
207 /* Macros: */
208 #define CDC_CONTROL_CLASS 0x02
209 #define CDC_CONTROL_SUBCLASS 0x02
210 #define CDC_CONTROL_PROTOCOL 0x01
211 #define CDC_DATA_CLASS 0x0A
212 #define CDC_DATA_SUBCLASS 0x00
213 #define CDC_DATA_PROTOCOL 0x00
214
215 #define CDC_FOUND_DATAPIPE_IN (1 << 0)
216 #define CDC_FOUND_DATAPIPE_OUT (1 << 1)
217 #define CDC_FOUND_DATAPIPE_NOTIFICATION (1 << 2)
218
219 /* Function Prototypes: */
220 #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)
221 void CDC_Host_Event_Stub(void);
222 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
223 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
224 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
225 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
226 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);
227 #endif
228 #endif
229
230 /* Disable C linkage for C++ Compilers: */
231 #if defined(__cplusplus)
232 }
233 #endif
234
235 #endif
236
237 /** @} */
USB isp AVR programmer