3 Copyright (C) Dean Camera, 2012.
\r
5 dean [at] fourwalledcubicle [dot] com
\r
10 Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
\r
12 Permission to use, copy, modify, distribute, and sell this
\r
13 software and its documentation for any purpose is hereby granted
\r
14 without fee, provided that the above copyright notice appear in
\r
15 all copies and that both that the copyright notice and this
\r
16 permission notice and warranty disclaimer appear in supporting
\r
17 documentation, and that the name of the author not be used in
\r
18 advertising or publicity pertaining to distribution of the
\r
19 software without specific, written prior permission.
\r
21 The author disclaim all warranties with regard to this
\r
22 software, including all implied warranties of merchantability
\r
23 and fitness. In no event shall the author be liable for any
\r
24 special, indirect or consequential damages or any damages
\r
25 whatsoever resulting from loss of use, data or profits, whether
\r
26 in an action of contract, negligence or other tortious action,
\r
27 arising out of or in connection with the use or performance of
\r
32 * \brief Host mode driver for the library USB CDC Class driver.
\r
34 * Host mode driver for the library USB CDC Class driver.
\r
36 * \note This file should not be included directly. It is automatically included as needed by the USB module driver
\r
37 * dispatch header located in LUFA/Drivers/USB.h.
\r
40 /** \ingroup Group_USBClassCDC
\r
41 * \defgroup Group_USBClassCDCHost CDC Class Host Mode Driver
\r
43 * \section Sec_Dependencies Module Source Dependencies
\r
44 * The following files must be built with any user project that uses this module:
\r
45 * - LUFA/Drivers/USB/Class/Host/CDCClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
\r
47 * \section Sec_ModDescription Module Description
\r
48 * Host Mode USB Class driver framework interface, for the CDC USB Class driver.
\r
53 #ifndef __CDC_CLASS_HOST_H__
\r
54 #define __CDC_CLASS_HOST_H__
\r
57 #include "../../USB.h"
\r
58 #include "../Common/CDCClassCommon.h"
\r
62 /* Enable C linkage for C++ Compilers: */
\r
63 #if defined(__cplusplus)
\r
67 /* Preprocessor Checks: */
\r
68 #if !defined(__INCLUDE_FROM_CDC_DRIVER)
\r
69 #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
\r
72 /* Public Interface - May be used in end-application: */
\r
74 /** \brief CDC Class Host Mode Configuration and State Structure.
\r
76 * Class state structure. An instance of this structure should be made within the user application,
\r
77 * and passed to each of the CDC class driver functions as the \c CDCInterfaceInfo parameter. This
\r
78 * stores each CDC interface's configuration and state information.
\r
84 USB_Pipe_Table_t DataINPipe; /**< Data IN Pipe configuration table. */
\r
85 USB_Pipe_Table_t DataOUTPipe; /**< Data OUT Pipe configuration table. */
\r
86 USB_Pipe_Table_t NotificationPipe; /**< Notification IN Pipe configuration table. */
\r
87 } Config; /**< Config data for the USB class interface within the device. All elements in this section
\r
88 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
\r
92 bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
\r
93 * after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the
\r
96 uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device. */
\r
100 uint16_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_*
\r
101 * masks - to notify the device of changes to these values, call the
\r
102 * \ref CDC_Host_SendControlLineStateChange() function.
\r
104 uint16_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_*
\r
105 * masks. This value is updated each time \ref CDC_Host_USBTask() is called.
\r
107 } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
\r
109 CDC_LineEncoding_t LineEncoding; /**< Line encoding used in the virtual serial port, for the device's information.
\r
110 * This is generally only used if the virtual serial port data is to be
\r
111 * reconstructed on a physical UART. When set by the host application, the
\r
112 * \ref CDC_Host_SetLineEncoding() function must be called to push the changes
\r
115 } State; /**< State data for the USB class interface within the device. All elements in this section
\r
116 * <b>may</b> be set to initial values, but may also be ignored to default to sane values when
\r
117 * the interface is enumerated.
\r
119 } USB_ClassInfo_CDC_Host_t;
\r
122 /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
\r
123 enum CDC_Host_EnumerationFailure_ErrorCodes_t
\r
125 CDC_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully. */
\r
126 CDC_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor. */
\r
127 CDC_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor. */
\r
128 CDC_ENUMERROR_PipeConfigurationFailed = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
\r
131 /* Function Prototypes: */
\r
132 /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
\r
133 * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
\r
135 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state.
\r
137 void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
139 /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
\r
140 * Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
\r
141 * state values and configures the pipes required to communicate with the interface if it is found within the device.
\r
142 * This should be called once after the stack has enumerated the attached device, while the host state machine is in
\r
143 * the Addressed state.
\r
145 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state.
\r
146 * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor.
\r
147 * \param[in] ConfigDescriptorData Pointer to a buffer containing the attached device's Configuration Descriptor.
\r
149 * \return A value from the \ref CDC_Host_EnumerationFailure_ErrorCodes_t enum.
\r
151 uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
\r
152 uint16_t ConfigDescriptorSize,
\r
153 void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
\r
155 /** Sets the line encoding for the attached device's virtual serial port. This should be called when the \c LineEncoding
\r
156 * values of the interface have been changed to push the new settings to the USB device.
\r
158 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
160 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
\r
162 uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
164 /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
\r
165 * control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
\r
166 * notification. This should be called each time the CDC class driver's \c ControlLineStates.HostToDevice value is updated
\r
167 * to push the new states to the USB device.
\r
169 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
171 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
\r
173 uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
175 /** Sends a Send Break request to the device. This is generally used to separate data or to indicate a special condition
\r
176 * to the receiving device.
\r
178 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
179 * \param[in] Duration Duration of the break, in milliseconds.
\r
181 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
\r
183 uint8_t CDC_Host_SendBreak(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
\r
184 const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
\r
186 /** Sends a given data buffer to the attached USB device, if connected. If a device is not connected when the function is
\r
187 * called, the data will be discarded. Bytes will be queued for transmission to the device until either the pipe bank
\r
188 * becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows for
\r
189 * multiple bytes to be packed into a single pipe packet, increasing data throughput.
\r
191 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
\r
194 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
195 * \param[in] Buffer Pointer to a buffer containing the data to send to the device.
\r
196 * \param[in] Length Length of the data to send to the device.
\r
198 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
\r
200 uint8_t CDC_Host_SendData(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
\r
201 const uint8_t* const Buffer,
\r
202 const uint16_t Length);
\r
204 /** Sends a given null-terminated string to the attached USB device, if connected. If a device is not connected when the
\r
205 * function is called, the string is discarded. Bytes will be queued for transmission to the device until either the pipe
\r
206 * bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows
\r
207 * for multiple bytes to be packed into a single pipe packet, increasing data throughput.
\r
209 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
\r
212 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
213 * \param[in] String Pointer to the null terminated string to send to the device.
\r
215 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
\r
217 uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
\r
218 const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
\r
220 /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
\r
221 * byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
\r
222 * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
\r
223 * packed into a single pipe packet, increasing data throughput.
\r
225 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
\r
228 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
229 * \param[in] Data Byte of data to send to the device.
\r
231 * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
\r
233 uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
\r
234 const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
\r
236 /** Determines the number of bytes received by the CDC interface from the device, waiting to be read. This indicates the number
\r
237 * of bytes in the IN pipe bank only, and thus the number of calls to \ref CDC_Host_ReceiveByte() which are guaranteed to succeed
\r
238 * immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be
\r
239 * released back to the USB controller until all bytes are read.
\r
241 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
\r
244 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
246 * \return Total number of buffered bytes received from the device.
\r
248 uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
250 /** 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
\r
251 * returns a negative value. The \ref CDC_Host_BytesReceived() function may be queried in advance to determine how many bytes
\r
252 * are currently buffered in the CDC interface's data receive pipe.
\r
254 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
\r
257 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
259 * \return Next received byte from the device, or a negative value if no data received.
\r
261 int16_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
263 /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
\r
265 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
\r
268 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
270 * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
\r
272 uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
274 #if defined(FDEV_SETUP_STREAM) || defined(__DOXYGEN__)
\r
275 /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
\r
276 * functions in the standard \c <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
\r
277 * stream is bidirectional and can be used for both input and output functions.
\r
279 * Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
\r
280 * fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
\r
281 * be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
\r
284 * \note The created stream can be given as \c stdout if desired to direct the standard output from all \c <stdio.h> functions
\r
285 * to the given CDC interface.
\r
288 * \note This function is not available on all microcontroller architectures.
\r
290 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.
\r
291 * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed.
\r
293 void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
\r
294 FILE* const Stream);
\r
296 /** Identical to \ref CDC_Host_CreateStream(), except that reads are blocking until the calling stream function terminates
\r
297 * the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
\r
299 * \note This function is not available on all microcontroller architectures.
\r
301 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.
\r
302 * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed.
\r
304 void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
\r
305 FILE* const Stream);
\r
308 /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
\r
309 * the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
\r
310 * user program by declaring a handler function with the same name and parameters listed here. The new control line states
\r
311 * are available in the \c ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
\r
312 * a mask of \c CDC_CONTROL_LINE_IN_* masks.
\r
314 * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
\r
316 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
318 /* Private Interface - For use in library only: */
\r
319 #if !defined(__DOXYGEN__)
\r
320 /* Function Prototypes: */
\r
321 #if defined(__INCLUDE_FROM_CDC_HOST_C)
\r
322 #if defined(FDEV_SETUP_STREAM)
\r
323 static int CDC_Host_putchar(char c,
\r
324 FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
\r
325 static int CDC_Host_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
\r
326 static int CDC_Host_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
\r
329 void CDC_Host_Event_Stub(void) ATTR_CONST;
\r
331 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
\r
332 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
\r
334 static uint8_t DCOMP_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor)
\r
335 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
\r
336 static uint8_t DCOMP_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor)
\r
337 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
\r
338 static uint8_t DCOMP_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor)
\r
339 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
\r
343 /* Disable C linkage for C++ Compilers: */
\r
344 #if defined(__cplusplus)
\r
projects / qmk_firmware.git / blob