extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Type Defines: */\r
+ /** Configuration information structure for \ref USB_ClassInfo_RNDIS_Device_t RNDIS device interface structures. */\r
+ typedef struct\r
+ {\r
+ uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r
+\r
+ uint8_t DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */\r
+ uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */\r
+\r
+ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */\r
+ uint16_t DataOUTEndpointSize; /**< Size in bytes of the CDC interface's OUT data endpoint */\r
+\r
+ uint8_t NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */\r
+ uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r
+ \r
+ char* AdapterVendorDescription; /**< String description of the adapter vendor */\r
+ MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter */\r
+ } USB_ClassInfo_MS_Device_Config_t;\r
+ \r
+ /** Current State information structure for \ref USB_ClassInfo_RNDIS_Device_t RNDIS device interface structures. */\r
+ typedef struct\r
+ {\r
+ uint8_t RNDISMessageBuffer[RNDIS_MESSAGE_BUFFER_SIZE]; /**< Buffer to hold RNDIS messages to and from the host,\r
+ * managed by the class driver\r
+ */\r
+ bool ResponseReady; /**< Internal flag indicating if a RNDIS message is waiting to be returned to the host */\r
+ uint8_t CurrRNDISState; /**< Current RNDIS state of the adapter, a value from the RNDIS_States_t enum */\r
+ uint32_t CurrPacketFilter; /**< Current packet filter mode, used internally by the class driver */\r
+ Ethernet_Frame_Info_t FrameIN; /**< Structure holding the last received Ethernet frame from the host, for user\r
+ * processing\r
+ */\r
+ Ethernet_Frame_Info_t FrameOUT; /**< Structure holding the next Ethernet frame to send to the host, populated by the\r
+ * user application\r
+ */\r
+ } USB_ClassInfo_MS_Device_State_t;\r
+ \r
+ /** Class state structure. An instance of this structure should be made for each RNDIS interface\r
+ * within the user application, and passed to each of the RNDIS class driver functions as the\r
+ * RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.\r
+ */\r
+ typedef struct\r
+ {\r
+ const USB_ClassInfo_MS_Device_Config_t Config; /**< Config data for the USB class interface within\r
+ * the device. All elements in this section\r
+ * <b>must</b> be set or the interface will fail\r
+ * to enumerate and operate correctly.\r
+ */\r
+ \r
+ USB_ClassInfo_MS_Device_State_t State; /**< State data for the USB class interface within\r
+ * the device. All elements in this section\r
+ * <b>may</b> be set to initial values, but may\r
+ * also be ignored to default to sane values when\r
+ * the interface is enumerated.\r
+ */\r
+ } USB_ClassInfo_RNDIS_Device_t;\r
+ \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_Device_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_Device_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_Device_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 void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r
+ static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo, \r
uint32_t OId, void* QueryData, uint16_t QuerySize,\r
void* ResponseData, uint16_t* ResponseSize);\r
- static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo, uint32_t OId,\r
+ static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_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
projects / pub / USBasp.git / blobdiff