CDCClassHost.h 22.2 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2018.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2018  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
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
  software without specific, written prior permission.

21
  The author disclaims all warranties with regard to this
22
23
24
25
26
27
28
29
30
31
32
33
34
35
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *  \brief Host mode driver for the library USB CDC Class driver.
 *
 *  Host mode driver for the library USB CDC Class driver.
 *
36
37
 *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
 *        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_USBClassCDCHost_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/CDCClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_USBClassCDCHost_ModDescription Module Description
48
49
50
51
52
53
54
55
56
57
 *  Host Mode USB Class driver framework interface, for the CDC USB Class driver.
 *
 *  @{
 */

#ifndef __CDC_CLASS_HOST_H__
#define __CDC_CLASS_HOST_H__

	/* Includes: */
		#include "../../USB.h"
58
		#include "../Common/CDCClassCommon.h"
59
60

		#include <stdio.h>
61

62
63
64
65
66
67
68
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_CDC_DRIVER)
69
			#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
70
71
72
73
74
75
76
		#endif

	/* Public Interface - May be used in end-application: */
		/* Type Defines: */
			/** \brief CDC Class Host Mode Configuration and State Structure.
			 *
			 *  Class state structure. An instance of this structure should be made within the user application,
77
			 *  and passed to each of the CDC class driver functions as the \c CDCInterfaceInfo parameter. This
78
79
80
81
			 *  stores each CDC interface's configuration and state information.
			 */
			typedef struct
			{
82
				struct
83
				{
84
85
86
					USB_Pipe_Table_t DataINPipe; /**< Data IN Pipe configuration table. */
					USB_Pipe_Table_t DataOUTPipe; /**< Data OUT Pipe configuration table. */
					USB_Pipe_Table_t NotificationPipe; /**< Notification IN Pipe configuration table. */
87
88
89
90
91
92
93
				} Config; /**< Config data for the USB class interface within the device. All elements in this section
				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
				           */
				struct
				{
					bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
					                *   after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the
94
					                *   Configured state.
95
					                */
96
					uint8_t  ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device. */
97

98
99
					struct
					{
100
101
102
103
104
105
106
						uint16_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_*
						                        *   masks - to notify the device of changes to these values, call the
						                        *   \ref CDC_Host_SendControlLineStateChange() function.
						                        */
						uint16_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_*
						                        *   masks. This value is updated each time \ref CDC_Host_USBTask() is called.
						                        */
107
					} ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
108

109
110
111
112
113
114
					CDC_LineEncoding_t LineEncoding; /**< Line encoding used in the virtual serial port, for the device's information.
					                                  *   This is generally only used if the virtual serial port data is to be
					                                  *   reconstructed on a physical UART. When set by the host application, the
					                                  *   \ref CDC_Host_SetLineEncoding() function must be called to push the changes
					                                  *   to the device.
					                                  */
115
116
117
118
119
				} State; /**< State data for the USB class interface within the device. All elements in this section
						  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
						  *   the interface is enumerated.
						  */
			} USB_ClassInfo_CDC_Host_t;
120

121
122
		/* Enums: */
			/** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
123
			enum CDC_Host_EnumerationFailure_ErrorCodes_t
124
			{
125
126
				CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
				CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
127
				CDC_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor. */
128
				CDC_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
129
			};
130

131
132
133
134
		/* Function Prototypes: */
			/** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
			 *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
			 *
135
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state.
136
137
			 */
			void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
138

139
140
141
142
143
144
			/** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
			 *  Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
			 *  state values and configures the pipes required to communicate with the interface if it is found within the device.
			 *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
			 *  the Addressed state.
			 *
145
146
147
			 *  \param[in,out] CDCInterfaceInfo      Pointer to a structure containing an CDC Class host configuration and state.
			 *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
			 *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.
148
			 *
149
			 *  \return A value from the \ref CDC_Host_EnumerationFailure_ErrorCodes_t enum.
150
			 */
151
152
			uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
			                                uint16_t ConfigDescriptorSize,
153
			                                void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
154

155
			/** Sets the line encoding for the attached device's virtual serial port. This should be called when the \c LineEncoding
156
157
			 *  values of the interface have been changed to push the new settings to the USB device.
			 *
158
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
159
			 *
160
			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
161
162
163
164
165
			 */
			uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

			/** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
			 *  control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
166
			 *  notification. This should be called each time the CDC class driver's \c ControlLineStates.HostToDevice value is updated
167
168
			 *  to push the new states to the USB device.
			 *
169
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
170
			 *
171
			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
172
173
			 */
			uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
174

175
			/** Sends a Send Break request to the device. This is generally used to separate data or to indicate a special condition
176
177
			 *  to the receiving device.
			 *
178
179
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
			 *  \param[in]     Duration          Duration of the break, in milliseconds.
180
			 *
181
			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
182
			 */
183
184
			uint8_t CDC_Host_SendBreak(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
			                           const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
185

186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
			/** Sends a given null-terminated string to the attached USB device, if connected. If a device is not connected when the
			 *  function is called, the string is discarded. Bytes will be queued for transmission to the device until either the pipe
			 *  bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows
			 *  for multiple bytes to be packed into a single pipe packet, increasing data throughput.
			 *
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
			 *       call will fail.
			 *
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
			 *  \param[in]     String            Pointer to the null terminated string to send to the device.
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
			 */
			uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
			                            const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);

202
203
204
205
			/** Sends a given data buffer to the attached USB device, if connected. If a device is not connected when the function is
			 *  called, the data will be discarded. Bytes will be queued for transmission to the device until either the pipe bank
			 *  becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows for
			 *  multiple bytes to be packed into a single pipe packet, increasing data throughput.
206
			 *
207
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
208
			 *       call will fail.
209
			 *
210
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
211
212
213
214
215
216
			 *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
			 *  \param[in]     Length            Length of the data to send to the device.
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
			 */
			uint8_t CDC_Host_SendData(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
217
			                          const void* const Buffer,
218
			                          const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
219

220
221
222
223
			/** Sends a given null terminated string from PROGMEM space to the attached USB device, if connected. If a device is not connected
			 *  when the function is called, the string is discarded. Bytes will be queued for transmission to the device until either
			 *  the pipe bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to
			 *  the device. This allows for multiple bytes to be packed into a single pipe packet, increasing data throughput.
224
225
226
227
			 *
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
			 *       the call will fail.
			 *
228
229
			 *  \note This function does not exist on architectures that do not have a separate flash memory space.
			 *
230
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
231
			 *  \param[in]     String            Pointer to the null terminated string to send to the host.
232
233
234
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
			 */
235
236
237
238
			#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
				uint8_t CDC_Host_SendString_P(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
			                                  const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
			#endif
239

240
241
			/** Sends a given data buffer from PROGMEM space to the attached USB device, if connected. If a device is not connected when the
			 *  function is called, the string is discarded. Bytes will be queued for transmission to the host until either the pipe
242
243
244
			 *  bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows
			 *  for multiple bytes to be packed into a single pipe packet, increasing data throughput.
			 *
245
246
247
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
			 *       the call will fail.
			 *
248
249
			 *  \note This function does not exist on architectures that do not have a separate flash memory space.
			 *
250
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
251
252
			 *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
			 *  \param[in]     Length            Length of the data to send to the host.
253
254
255
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
			 */
256
257
258
259
260
			#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
				uint8_t CDC_Host_SendData_P(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
			                                const void* const Buffer,
			                                const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
			#endif
261

262
263
			/** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
			 *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
264
			 *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
265
266
			 *  packed into a single pipe packet, increasing data throughput.
			 *
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
271
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
			 *  \param[in]     Data              Byte of data to send to the device.
272
			 *
273
			 *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
274
			 */
275
276
			uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
			                          const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
277

278
279
280
281
			/** Determines the number of bytes received by the CDC interface from the device, waiting to be read. This indicates the number
			 *  of bytes in the IN pipe bank only, and thus the number of calls to \ref CDC_Host_ReceiveByte() which are guaranteed to succeed
			 *  immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be
			 *  released back to the USB controller until all bytes are read.
282
			 *
283
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
284
			 *       call will fail.
285
			 *
286
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
287
			 *
288
			 *  \return Total number of buffered bytes received from the device.
289
290
291
292
			 */
			uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

			/** 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
293
294
			 *  returns a negative value. The \ref CDC_Host_BytesReceived() function may be queried in advance to determine how many bytes
			 *  are currently buffered in the CDC interface's data receive pipe.
295
			 *
296
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
297
			 *       call will fail.
298
			 *
299
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
300
			 *
301
			 *  \return Next received byte from the device, or a negative value if no data received.
302
			 */
303
			int16_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
304

305
306
			/** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
			 *
307
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
308
			 *       call will fail.
309
			 *
310
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
311
			 *
312
			 *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
313
314
315
			 */
			uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

316
			#if defined(FDEV_SETUP_STREAM) || defined(__DOXYGEN__)
317
			/** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
318
			 *  functions in the standard \c <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
319
320
			 *  stream is bidirectional and can be used for both input and output functions.
			 *
321
322
323
324
325
			 *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
			 *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
			 *  be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
			 *  line buffering.
			 *
326
			 *  \note The created stream can be given as \c stdout if desired to direct the standard output from all \c <stdio.h> functions
327
			 *        to the given CDC interface.
328
329
330
			 *        \n\n
			 *
			 *  \note This function is not available on all microcontroller architectures.
331
			 *
332
333
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
			 *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
334
			 */
335
			void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
336
			                           FILE* const Stream) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
337

338
			/** Identical to \ref CDC_Host_CreateStream(), except that reads are blocking until the calling stream function terminates
339
340
			 *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
			 *
341
342
			 *  \note This function is not available on all microcontroller architectures.
			 *
343
344
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
			 *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
345
			 */
346
			void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
347
			                                   FILE* const Stream) ATTR_NON_NULL_PTR_ARG(1)  ATTR_NON_NULL_PTR_ARG(2);
348
			#endif
349

350
351
352
			/** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
			 *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
			 *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
353
			 *  are available in the \c ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
354
			 *  a mask of \c CDC_CONTROL_LINE_IN_* masks.
355
			 *
356
			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
357
358
359
360
361
362
			 */
			void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Function Prototypes: */
363
			#if defined(__INCLUDE_FROM_CDC_HOST_C)
364
				#if defined(FDEV_SETUP_STREAM)
365
366
				static int CDC_Host_putchar(char c,
				                            FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
367
368
				static int CDC_Host_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
				static int CDC_Host_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
369
				#endif
370

371
				void CDC_Host_Event_Stub(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo);
372

373
374
				void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
				                                           ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
375

Dean Camera's avatar
Dean Camera committed
376
377
378
379
380
381
				static uint8_t DCOMP_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor)
				                                                      ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
				static uint8_t DCOMP_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor)
				                                                   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
				static uint8_t DCOMP_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor)
				                                                       ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
Dean Camera's avatar
Dean Camera committed
382
			#endif
383
	#endif
384

385
386
387
388
389
390
391
392
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

#endif

/** @} */
393