Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / RNDIS.h

diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h
index 8855aac..d5da838 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h
@@ -47,7 +47,6 @@
        /* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/RNDIS.h"\r
        /* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/RNDIS.h"\r

-               #include "RNDISConstants.h"\r

                \r
                #include <string.h>\r
        \r
                \r
                #include <string.h>\r
        \r


@@ -70,12 +69,15 @@
 \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  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

+                                       bool     DataINEndpointDoubleBank; /** Indicates if the RNDIS interface's IN data endpoint should use double banking */\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  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

+                                       bool     DataOUTEndpointDoubleBank; /** Indicates if the RNDIS interface's OUT data endpoint should use double banking */\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
                                        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

+                                       bool     NotificationEndpointDoubleBank; /** Indicates if the RNDIS interface's notification endpoint should use double banking */\r

                                        \r
                                        char*         AdapterVendorDescription; /**< String description of the adapter vendor */\r
                                        MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter */\r
                                        \r
                                        char*         AdapterVendorDescription; /**< String description of the adapter vendor */\r
                                        MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter */\r


@@ -103,39 +105,42 @@
        \r
                /* Function Prototypes: */\r
                        /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library\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
+                        *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r

                         *  containing the given HID interface is selected.\r
                         *\r
                         *  containing the given HID interface is selected.\r
                         *\r

-                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state\r

                         *\r
                         *\r

-                        *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+                        *  \return Boolean true if the endpoints were successfully configured, false otherwise\r

                         */\r
                         */\r

-                       bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo);\r
+                       bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \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
+                       /** Processes incoming 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_Device_UnhandledControlRequest() event.\r

                         *\r
                         *\r

-                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state\r

                         */             \r
                         */             \r

-                       void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo);\r
+                       void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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
                        \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[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state\r

                         */\r
                         */\r

-                       void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo);\r
+                       void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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
                \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_Device_t* const RNDISInterfaceInfo);\r
+                       static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)\r
+                                                                           ATTR_NON_NULL_PTR_ARG(1);\r

                        static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, \r
                                                                  const uint32_t OId, void* const QueryData, const uint16_t QuerySize,\r
                        static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, \r
                                                                  const uint32_t OId, void* const QueryData, const uint16_t QuerySize,\r

-                                                                                             void* ResponseData, uint16_t* const ResponseSize);\r
+                                                                                             void* ResponseData, uint16_t* const ResponseSize) ATTR_NON_NULL_PTR_ARG(1)\r
+                                                                 ATTR_NON_NULL_PTR_ARG(5) ATTR_NON_NULL_PTR_ARG(6);\r

                        static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, const uint32_t OId,\r
                        static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, const uint32_t OId,\r

-                                                               void* SetData, const uint16_t SetSize); \r
+                                                               void* SetData, const uint16_t SetSize) ATTR_NON_NULL_PTR_ARG(1)\r
+                                                               ATTR_NON_NULL_PTR_ARG(3);\r

                #endif\r
                \r
        #endif\r
                #endif\r
                \r
        #endif\r