/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
+ Permission to use, copy, modify, distribute, and sell this \r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in \r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting \r
+ documentation, and that the name of the author not be used in \r
+ advertising or publicity pertaining to distribution of the \r
software without specific, written prior permission.\r
\r
The author disclaim all warranties with regard to this\r
extern "C" {\r
#endif\r
\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_CDC_DRIVER)\r
+ #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.\r
+ #endif\r
+\r
/* Public Interface - May be used in end-application: */\r
/* Type Defines: */\r
/** Class state structure. An instance of this structure should be made within the user application,\r
uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r
uint16_t DataOUTPipeSize; /**< Size in bytes of the CDC interface's OUT data pipe */\r
uint16_t NotificationPipeSize; /**< Size in bytes of the CDC interface's IN notification pipe, if used */\r
-\r
+ \r
struct\r
{\r
uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*\r
- * masks.\r
+ * masks - to notify the device of changes to these values, call the\r
+ * \ref CDC_Host_SendControlLineStateChange() function.\r
*/\r
uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*\r
- * masks.\r
+ * masks. This value is updated each time \ref CDC_Host_USBTask() is called.\r
*/\r
- } ControlLineStates;\r
+ } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */\r
\r
struct\r
{\r
* CDCDevice_LineCodingParity_t enum\r
*/\r
uint8_t DataBits; /**< Bits of data per character of the virtual serial port */\r
- } LineEncoding;\r
+ } LineEncoding; /** Line encoding used in the virtual serial port, for the device's information. This is generally\r
+ * only used if the virtual serial port data is to be reconstructed on a physical UART. When set\r
+ * by the host application, the \ref CDC_Host_SetLineEncoding() function must be called to push\r
+ * the changes to the device.\r
+ */\r
} State; /**< State data for the USB class interface within the device. All elements in this section\r
* <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
* the interface is enumerated.\r
uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the\r
- * string is discarded.\r
+ * string is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the\r
+ * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
+ * packed into a single pipe packet, increasing data throughput.\r
+ *\r
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\r
*\r
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state\r
* \param[in] Data Pointer to the string to send to the device\r
uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length)\r
ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
\r
- /** Sends a given byte to the attached USB device, if connected. If a host is not connected when the function is called, the\r
- * byte is discarded.\r
+ /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the\r
+ * byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the\r
+ * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
+ * packed into a single pipe packet, increasing data throughput.\r
+ *\r
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\r
*\r
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state\r
* \param[in] Data Byte of data to send to the device\r
\r
/** Determines the number of bytes received by the CDC interface from the device, waiting to be read.\r
*\r
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\r
+ *\r
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state\r
*\r
* \return Total number of buffered bytes received from the device\r
* returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data\r
* underflow occurs.\r
*\r
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\r
+ *\r
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state\r
*\r
* \return Next received byte from the device, or 0 if no data received\r
*/\r
uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
+ /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.\r
+ *\r
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state\r
+ *\r
+ * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum\r
+ */\r
+ uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular\r
- * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf).\r
+ * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created\r
+ * stream is bidirectional and can be used for both input and output functions.\r
*\r
* \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions\r
* to the given CDC interface.\r
#define CDC_FOUND_NOTIFICATION_IN (1 << 2)\r
\r
/* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
+ #if defined(__INCLUDE_FROM_CDC_CLASS_HOST_C)\r
static int CDC_Host_putchar(char c, FILE* Stream);\r
static int CDC_Host_getchar(FILE* Stream);\r
static int CDC_Host_getchar_Blocking(FILE* Stream);\r
projects / pub / USBasp.git / blobdiff