* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing\r
* the given CDC interface is selected.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*\r
* \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
*/\r
/** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be\r
* linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*/\r
void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** General management task for a given CDC class interface, required for the correct operation of the interface. This should\r
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*/\r
void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
* user program by declaring a handler function with the same name and parameters listed here. The new line encoding\r
* settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*/\r
void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
* are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as\r
* a mask of CDC_CONTROL_LINE_OUT_* masks.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*/\r
void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
* string is discarded.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
* \param[in] Data Pointer to the string to send to the host\r
* \param[in] Length Size in bytes of the string to send to the host\r
*\r
/** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the\r
* byte is discarded.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
* \param[in] Data Byte of data to send to the host\r
*\r
* \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r
\r
/** Determines the number of bytes received by the CDC interface from the host, waiting to be read.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*\r
* \return Total number of buffered bytes received from the host\r
*/\r
* returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data\r
* underflow occurs.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*\r
* \return Next received byte from the host, or 0 if no data received\r
*/\r
\r
/** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*\r
* \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r
*/\r
* until they are cleared via a second notification. This should be called each time the CDC class driver's \r
* ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.\r
*\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
*/\r
void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
projects / pub / USBasp.git / blobdiff