\r
#include "CDCHost.h"\r
\r
+/** LUFA CDC Class driver interface configuration and state information. This structure is\r
+ * passed to all CDC Class driver functions, so that multiple instances of the same class\r
+ * within a device can be differentiated from one another.\r
+ */\r
+USB_ClassInfo_CDC_t VirtualSerial_CDC_Interface;\r
+\r
/** Main program entry point. This routine configures the hardware required by the application, then\r
* starts the scheduler to run the application tasks.\r
*/\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
- /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library\r
- * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
- * given Audio interface is selected.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- *\r
- * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
- */\r
- bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be\r
- * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- */\r
- void Audio_Device_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /** General management task for a given Audio 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 AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- */\r
- void Audio_Device_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
- \r
- /** Reads the next 8-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \return Signed 8-bit audio sample from the audio interface\r
- */\r
- int8_t Audio_Device_ReadSample8(void);\r
-\r
- /** Reads the next 16-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \return Signed 16-bit audio sample from the audio interface\r
- */\r
- int16_t Audio_Device_ReadSample16(void);\r
-\r
- /** Reads the next 24-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \return Signed 24-bit audio sample from the audio interface\r
- */\r
- int32_t Audio_Device_ReadSample24(void);\r
-\r
- /** Writes the next 8-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \param Sample Signed 8-bit audio sample\r
- */\r
- void Audio_Device_WriteSample8(int8_t Sample);\r
-\r
- /** Writes the next 16-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \param Sample Signed 16-bit audio sample\r
- */\r
- void Audio_Device_WriteSample16(int16_t Sample);\r
-\r
- /** Writes the next 24-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \param Sample Signed 24-bit audio sample\r
- */\r
- void Audio_Device_WriteSample24(int32_t Sample);\r
-\r
- /** Determines if the given audio interface is ready for a sample to be read from it.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- *\r
- * \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
- */\r
- bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- *\r
- * \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
- */\r
- bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
+ /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
+ * given Audio interface is selected.\r
+ *\r
+ * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ *\r
+ * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+ */\r
+ bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+\r
+ /** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be\r
+ * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ *\r
+ * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ */\r
+ void Audio_Device_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+\r
+ /** General management task for a given Audio 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 AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ */\r
+ void Audio_Device_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+ \r
+ /** Reads the next 8-bit audio sample from the current audio interface.\r
+ *\r
+ * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+ * the correct endpoint is selected and ready for data.\r
+ *\r
+ * \return Signed 8-bit audio sample from the audio interface\r
+ */\r
+ int8_t Audio_Device_ReadSample8(void);\r
+\r
+ /** Reads the next 16-bit audio sample from the current audio interface.\r
+ *\r
+ * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+ * the correct endpoint is selected and ready for data.\r
+ *\r
+ * \return Signed 16-bit audio sample from the audio interface\r
+ */\r
+ int16_t Audio_Device_ReadSample16(void);\r
+\r
+ /** Reads the next 24-bit audio sample from the current audio interface.\r
+ *\r
+ * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+ * the correct endpoint is selected and ready for data.\r
+ *\r
+ * \return Signed 24-bit audio sample from the audio interface\r
+ */\r
+ int32_t Audio_Device_ReadSample24(void);\r
+\r
+ /** Writes the next 8-bit audio sample to the current audio interface.\r
+ *\r
+ * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+ * the correct endpoint is selected and ready for data.\r
+ *\r
+ * \param Sample Signed 8-bit audio sample\r
+ */\r
+ void Audio_Device_WriteSample8(int8_t Sample);\r
+\r
+ /** Writes the next 16-bit audio sample to the current audio interface.\r
+ *\r
+ * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+ * the correct endpoint is selected and ready for data.\r
+ *\r
+ * \param Sample Signed 16-bit audio sample\r
+ */\r
+ void Audio_Device_WriteSample16(int16_t Sample);\r
+\r
+ /** Writes the next 24-bit audio sample to the current audio interface.\r
+ *\r
+ * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+ * the correct endpoint is selected and ready for data.\r
+ *\r
+ * \param Sample Signed 24-bit audio sample\r
+ */\r
+ void Audio_Device_WriteSample24(int32_t Sample);\r
+\r
+ /** Determines if the given audio interface is ready for a sample to be read from it.\r
+ *\r
+ * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ *\r
+ * \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
+ */\r
+ bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+\r
+ /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
+ *\r
+ * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ *\r
+ * \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
+ */\r
+ bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r
- void CDC_Device_Event_Stub(void);\r
- void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
- ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);\r
- void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
- ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);\r
- #endif\r
- \r
- /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library\r
- * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
- * given CDC interface is selected.\r
- *\r
- * \param 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
- bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */ \r
+ /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
+ * given CDC interface is selected.\r
+ *\r
+ * \param 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
+ bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\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_UnhandledControlPacket() event.\r
- *\r
- * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
- */\r
- void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\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_UnhandledControlPacket() event.\r
+ *\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ */\r
+ void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
- */\r
- void CDC_Device_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ */\r
+ void CDC_Device_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
\r
- /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a\r
- * line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the\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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
- */\r
- void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
- \r
- /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a\r
- * control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the\r
- * user program by declaring a handler function with the same name and parameters listed here. The new control line states\r
- * are available in the ControlLineState value inside the CDC interface structure passed as a parameter, set as a mask of\r
- * CDC_CONTROL_LINE_OUT_* masks.\r
- *\r
- * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
- */ \r
- void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a\r
+ * line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the\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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ */\r
+ void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ \r
+ /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a\r
+ * control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the\r
+ * user program by declaring a handler function with the same name and parameters listed here. The new control line states\r
+ * are available in the ControlLineState value inside the CDC interface structure passed as a parameter, set as a mask of\r
+ * CDC_CONTROL_LINE_OUT_* masks.\r
+ *\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ */ \r
+ void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
- * \param Data Pointer to the string to send to the host\r
- * \param Length Size in bytes of the string to send to the host\r
- */\r
- void CDC_Device_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);\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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
- * \param Data Byte of data to send to the host\r
- */\r
- void CDC_Device_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);\r
- \r
- /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.\r
- *\r
- * \param 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
- uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
- \r
- /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function\r
- * returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data\r
- * underflow occurs.\r
- *\r
- * \param 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
- uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
- \r
- /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial control\r
- * lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist until they are\r
- * cleared via a second notification.\r
- *\r
- * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
- * \param LineStateMask Mask of CDC_CONTROL_LINE_IN_* masks giving the current control line states\r
- */\r
- void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);\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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param Data Pointer to the string to send to the host\r
+ * \param Length Size in bytes of the string to send to the host\r
+ */\r
+ void CDC_Device_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);\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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param Data Byte of data to send to the host\r
+ */\r
+ void CDC_Device_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);\r
+ \r
+ /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.\r
+ *\r
+ * \param 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
+ uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ \r
+ /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function\r
+ * returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data\r
+ * underflow occurs.\r
+ *\r
+ * \param 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
+ uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ \r
+ /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial control\r
+ * lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist until they are\r
+ * cleared via a second notification.\r
+ *\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ * \param LineStateMask Mask of CDC_CONTROL_LINE_IN_* masks giving the current control line states\r
+ */\r
+ void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);\r
\r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Function Prototypes: */\r
+ #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r
+ void CDC_Device_Event_Stub(void);\r
+ void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
+ ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);\r
+ void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
+ ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);\r
+ #endif\r
+\r
+ #endif\r
+ \r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
}\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
- /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library\r
- * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
- * containing the given HID interface is selected.\r
- *\r
- * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
- *\r
- * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
- */\r
- bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
- \r
- /** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be\r
- * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
- *\r
- * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
- */ \r
- void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
+ /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given HID interface is selected.\r
+ *\r
+ * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
+ *\r
+ * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+ */\r
+ bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
+ \r
+ /** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be\r
+ * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ *\r
+ * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
+ */ \r
+ void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
\r
- /** General management task for a given HID 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 HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
- */\r
- void HID_Device_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
- \r
- /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either\r
- * HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
- * user is responsible for the creation of the next HID input report to be sent to the host.\r
- *\r
- * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
- * \param ReportID If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should\r
- * be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
- * given HID interface, this parameter should be ignored.\r
- * \param ReportData Pointer to a buffer where the generated HID report should be stored.\r
- *\r
- * \return Number of bytes in the generated input report, or zero if no report is to be sent\r
- */\r
- uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
+ /** General management task for a given HID 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 HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
+ */\r
+ void HID_Device_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
+ \r
+ /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either\r
+ * HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
+ * user is responsible for the creation of the next HID input report to be sent to the host.\r
+ *\r
+ * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
+ * \param ReportID If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should\r
+ * be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
+ * given HID interface, this parameter should be ignored.\r
+ * \param ReportData Pointer to a buffer where the generated HID report should be stored.\r
+ *\r
+ * \return Number of bytes in the generated input report, or zero if no report is to be sent\r
+ */\r
+ uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
\r
- /** HID class driver callback for the user processing of a received HID input report. This callback may fire in response to\r
- * either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback\r
- * the user is responsible for the processing of the received HID output report from the host.\r
- *\r
- * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
- * \param ReportID Report ID of the received output report. If multiple reports are not received via the given HID\r
- * interface, this parameter should be ignored.\r
- * \param ReportData Pointer to a buffer where the received HID report is stored.\r
- * \param ReportSize Size in bytes of the received report from the host.\r
- */\r
- void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData,\r
- uint16_t ReportSize);\r
+ /** HID class driver callback for the user processing of a received HID input report. This callback may fire in response to\r
+ * either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback\r
+ * the user is responsible for the processing of the received HID output report from the host.\r
+ *\r
+ * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
+ * \param ReportID Report ID of the received output report. If multiple reports are not received via the given HID\r
+ * interface, this parameter should be ignored.\r
+ * \param ReportData Pointer to a buffer where the received HID report is stored.\r
+ * \param ReportSize Size in bytes of the received report from the host.\r
+ */\r
+ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData,\r
+ uint16_t ReportSize);\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
- /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library\r
- * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
- * containing the given MIDI interface is selected.\r
- *\r
- * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
- *\r
- * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
- */\r
- bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
- \r
- /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be\r
- * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
- *\r
- * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
- */ \r
- void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
+ /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given MIDI interface is selected.\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ *\r
+ * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+ */\r
+ bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+ \r
+ /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be\r
+ * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ */ \r
+ void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
\r
- /** General management task for a given MIDI 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 MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
- */\r
- void MIDI_Device_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+ /** General management task for a given MIDI 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 MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ */\r
+ void MIDI_Device_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
\r
- /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
- *\r
- * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
- * \param Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
- */\r
- void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
+ /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ * \param Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
+ */\r
+ void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
\r
- /** Receives a MIDI event packet from the host.\r
- *\r
- * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
- * \param Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
- *\r
- * \return Boolean true if a MIDI event packet was received, false otherwise\r
- */\r
- bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
+ /** Receives a MIDI event packet from the host.\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ * \param Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
+ *\r
+ * \return Boolean true if a MIDI event packet was received, false otherwise\r
+ */\r
+ bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_MS_CLASS_DEVICE_C)\r
- static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
- static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
- static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);\r
- #endif\r
- \r
- /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library\r
- * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
- * containing the given Mass Storage interface is selected.\r
- *\r
- * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
- *\r
- * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
- */\r
- bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
- \r
- /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be\r
- * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
- *\r
- * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
- */ \r
- void MS_Device_ProcessControlPacket(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
+ /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given Mass Storage interface is selected.\r
+ *\r
+ * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
+ *\r
+ * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+ */\r
+ bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ \r
+ /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be\r
+ * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ *\r
+ * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
+ */ \r
+ void MS_Device_ProcessControlPacket(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
\r
- /** General management task for a given Mass Storage 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 MSInterfaceInfo Pointer to a structure containing a Mass Storage configuration and state.\r
- */\r
- void MS_Device_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ /** General management task for a given Mass Storage 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 MSInterfaceInfo Pointer to a structure containing a Mass Storage configuration and state.\r
+ */\r
+ void MS_Device_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ \r
+ /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the\r
+ * host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible\r
+ * for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure\r
+ * inside the Mass Storage class state structure passed as a parameter to the callback function.\r
+ *\r
+ * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
+ *\r
+ * \return Boolean true if the SCSI command was successfully processed, false otherwise\r
+ */\r
+ bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ \r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Function Prototypes: */\r
+ #if defined(INCLUDE_FROM_MS_CLASS_DEVICE_C)\r
+ static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);\r
+ #endif\r
\r
- /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the\r
- * host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible\r
- * for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure\r
- * inside the Mass Storage class state structure passed as a parameter to the callback function.\r
- *\r
- * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
- *\r
- * \return Boolean true if the SCSI command was successfully processed, false otherwise\r
- */\r
- bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ #endif\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
+ /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given HID interface is selected.\r
+ *\r
+ * \param RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.\r
+ *\r
+ * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+ */\r
+ bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
+\r
+ /** Processes incomming control requests from the host, that are directed to the given RNDIS class interface. This should be\r
+ * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ *\r
+ * \param RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.\r
+ */ \r
+ void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
+ \r
+ /** General management task for a given HID 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 RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.\r
+ */\r
+ void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
+ \r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Function Prototypes: */\r
#if defined(INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)\r
static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo, \r
static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo, uint32_t OId,\r
void* SetData, uint16_t SetSize); \r
#endif\r
-\r
- /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library\r
- * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
- * containing the given HID interface is selected.\r
- *\r
- * \param RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.\r
- *\r
- * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
- */\r
- bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
-\r
- /** Processes incomming control requests from the host, that are directed to the given RNDIS class interface. This should be\r
- * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
- *\r
- * \param RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.\r
- */ \r
- void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
- \r
- /** General management task for a given HID 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 RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.\r
- */\r
- void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);\r
\r
+ #endif\r
+ \r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
}\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
- if (ConfigDescriptorSize > MAX_CONFIG_DESCRIPTOR_SIZE)\r
+ if (ConfigDescriptorSize > 512)\r
return DescriptorTooLarge;\r
\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
- static uint8_t CDC_Host_ProcessConfigDescriptor(void);\r
- static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);\r
- static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);\r
- static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);\r
- #endif\r
- \r
- void CDC_Host_Task(void);\r
- \r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
+ void CDC_Host_Task(void);\r
+\r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Macros: */\r
+ #define CDC_CONTROL_CLASS 0x02\r
+ #define CDC_CONTROL_SUBCLASS 0x02\r
+ #define CDC_CONTROL_PROTOCOL 0x01\r
+ #define CDC_DATA_CLASS 0x0A\r
+ #define CDC_DATA_SUBCLASS 0x00\r
+ #define CDC_DATA_PROTOCOL 0x00\r
+\r
+ /* Function Prototypes: */\r
+ #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
+ static uint8_t CDC_Host_ProcessConfigDescriptor(void);\r
+ static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);\r
+ static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);\r
+ static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);\r
+ #endif\r
+ \r
+ #endif\r
+ \r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
}\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Function Prototypes: */\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
projects / pub / USBasp.git / commitdiff