Document CDC Host class driver functions and enums.

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

diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.c b/LUFA/Drivers/USB/Class/Device/RNDIS.c
index 7ac8470..13d82a5 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/RNDIS.c
+++ b/LUFA/Drivers/USB/Class/Device/RNDIS.c
@@ -65,7 +65,7 @@ static const uint32_t PROGMEM AdapterSupportedOIDList[]  =
                OID_802_3_XMIT_MORE_COLLISIONS,\r
        };\r
 \r
                OID_802_3_XMIT_MORE_COLLISIONS,\r
        };\r
 \r

-void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo)\r
+void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)\r

 {\r
        if (!(Endpoint_IsSETUPReceived()))\r
          return;\r
 {\r
        if (!(Endpoint_IsSETUPReceived()))\r
          return;\r


@@ -110,8 +110,10 @@ void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_Device_t* RNDISInterf
        }\r
 }\r
 \r
        }\r
 }\r
 \r

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

 {\r
 {\r

+       memset(&RNDISInterfaceInfo->State, 0x00, sizeof(RNDISInterfaceInfo->State));\r
+\r

        if (!(Endpoint_ConfigureEndpoint(RNDISInterfaceInfo->Config.DataINEndpointNumber, EP_TYPE_BULK,\r
                                                                 ENDPOINT_DIR_IN, RNDISInterfaceInfo->Config.DataINEndpointSize,\r
                                                                 ENDPOINT_BANK_SINGLE)))\r
        if (!(Endpoint_ConfigureEndpoint(RNDISInterfaceInfo->Config.DataINEndpointNumber, EP_TYPE_BULK,\r
                                                                 ENDPOINT_DIR_IN, RNDISInterfaceInfo->Config.DataINEndpointSize,\r
                                                                 ENDPOINT_BANK_SINGLE)))\r


@@ -136,9 +138,9 @@ bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* RNDISInterfac
        return true;\r
 }\r
 \r
        return true;\r
 }\r
 \r

-void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo)\r
+void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)\r

 {\r
 {\r

-       if (!(USB_IsConnected))\r
+       if (USB_DeviceState != DEVICE_STATE_Configured)\r

          return;\r
 \r
        RNDIS_Message_Header_t* MessageHeader = (RNDIS_Message_Header_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
          return;\r
 \r
        RNDIS_Message_Header_t* MessageHeader = (RNDIS_Message_Header_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r


@@ -165,13 +167,13 @@ void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo)
        \r
        if ((RNDISInterfaceInfo->State.CurrRNDISState == RNDIS_Data_Initialized) && !(MessageHeader->MessageLength))\r
        {\r
        \r
        if ((RNDISInterfaceInfo->State.CurrRNDISState == RNDIS_Data_Initialized) && !(MessageHeader->MessageLength))\r
        {\r

-               RNDIS_PACKET_MSG_t RNDISPacketHeader;\r
+               RNDIS_Packet_Message_t RNDISPacketHeader;\r

 \r
                Endpoint_SelectEndpoint(RNDISInterfaceInfo->Config.DataOUTEndpointNumber);\r
 \r
                if (Endpoint_IsOUTReceived() && !(RNDISInterfaceInfo->State.FrameIN.FrameInBuffer))\r
                {\r
 \r
                Endpoint_SelectEndpoint(RNDISInterfaceInfo->Config.DataOUTEndpointNumber);\r
 \r
                if (Endpoint_IsOUTReceived() && !(RNDISInterfaceInfo->State.FrameIN.FrameInBuffer))\r
                {\r

-                       Endpoint_Read_Stream_LE(&RNDISPacketHeader, sizeof(RNDIS_PACKET_MSG_t), NO_STREAM_CALLBACK);\r
+                       Endpoint_Read_Stream_LE(&RNDISPacketHeader, sizeof(RNDIS_Packet_Message_t), NO_STREAM_CALLBACK);\r

 \r
                        if (RNDISPacketHeader.DataLength > ETHERNET_FRAME_SIZE_MAX)\r
                        {\r
 \r
                        if (RNDISPacketHeader.DataLength > ETHERNET_FRAME_SIZE_MAX)\r
                        {\r


@@ -192,14 +194,14 @@ void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo)
                \r
                if (Endpoint_IsINReady() && RNDISInterfaceInfo->State.FrameOUT.FrameInBuffer)\r
                {\r
                \r
                if (Endpoint_IsINReady() && RNDISInterfaceInfo->State.FrameOUT.FrameInBuffer)\r
                {\r

-                       memset(&RNDISPacketHeader, 0, sizeof(RNDIS_PACKET_MSG_t));\r
+                       memset(&RNDISPacketHeader, 0, sizeof(RNDIS_Packet_Message_t));\r

 \r
                        RNDISPacketHeader.MessageType   = REMOTE_NDIS_PACKET_MSG;\r
 \r
                        RNDISPacketHeader.MessageType   = REMOTE_NDIS_PACKET_MSG;\r

-                       RNDISPacketHeader.MessageLength = (sizeof(RNDIS_PACKET_MSG_t) + RNDISInterfaceInfo->State.FrameOUT.FrameLength);\r
-                       RNDISPacketHeader.DataOffset    = (sizeof(RNDIS_PACKET_MSG_t) - sizeof(RNDIS_Message_Header_t));\r
+                       RNDISPacketHeader.MessageLength = (sizeof(RNDIS_Packet_Message_t) + RNDISInterfaceInfo->State.FrameOUT.FrameLength);\r
+                       RNDISPacketHeader.DataOffset    = (sizeof(RNDIS_Packet_Message_t) - sizeof(RNDIS_Message_Header_t));\r

                        RNDISPacketHeader.DataLength    = RNDISInterfaceInfo->State.FrameOUT.FrameLength;\r
 \r
                        RNDISPacketHeader.DataLength    = RNDISInterfaceInfo->State.FrameOUT.FrameLength;\r
 \r

-                       Endpoint_Write_Stream_LE(&RNDISPacketHeader, sizeof(RNDIS_PACKET_MSG_t), NO_STREAM_CALLBACK);\r
+                       Endpoint_Write_Stream_LE(&RNDISPacketHeader, sizeof(RNDIS_Packet_Message_t), NO_STREAM_CALLBACK);\r

                        Endpoint_Write_Stream_LE(RNDISInterfaceInfo->State.FrameOUT.FrameData, RNDISPacketHeader.DataLength, NO_STREAM_CALLBACK);\r
                        Endpoint_ClearIN();\r
                        \r
                        Endpoint_Write_Stream_LE(RNDISInterfaceInfo->State.FrameOUT.FrameData, RNDISPacketHeader.DataLength, NO_STREAM_CALLBACK);\r
                        Endpoint_ClearIN();\r
                        \r


@@ -208,7 +210,7 @@ void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo)
        }\r
 }                                                      \r
 \r
        }\r
 }                                                      \r
 \r

-void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo)\r
+void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)\r

 {\r
        /* Note: Only a single buffer is used for both the received message and its response to save SRAM. Because of\r
                 this, response bytes should be filled in order so that they do not clobber unread data in the buffer. */\r
 {\r
        /* Note: Only a single buffer is used for both the received message and its response to save SRAM. Because of\r
                 this, response bytes should be filled in order so that they do not clobber unread data in the buffer. */\r


@@ -220,11 +222,13 @@ void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDIS
                case REMOTE_NDIS_INITIALIZE_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                        \r
                case REMOTE_NDIS_INITIALIZE_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                        \r

-                       RNDIS_INITIALIZE_MSG_t*   INITIALIZE_Message  = (RNDIS_INITIALIZE_MSG_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
-                       RNDIS_INITIALIZE_CMPLT_t* INITIALIZE_Response = (RNDIS_INITIALIZE_CMPLT_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       RNDIS_Initialize_Message_t*  INITIALIZE_Message  =\r
+                                      (RNDIS_Initialize_Message_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       RNDIS_Initialize_Complete_t* INITIALIZE_Response =\r
+                                      (RNDIS_Initialize_Complete_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r

                        \r
                        INITIALIZE_Response->MessageType           = REMOTE_NDIS_INITIALIZE_CMPLT;\r
                        \r
                        INITIALIZE_Response->MessageType           = REMOTE_NDIS_INITIALIZE_CMPLT;\r

-                       INITIALIZE_Response->MessageLength         = sizeof(RNDIS_INITIALIZE_CMPLT_t);\r
+                       INITIALIZE_Response->MessageLength         = sizeof(RNDIS_Initialize_Complete_t);\r

                        INITIALIZE_Response->RequestId             = INITIALIZE_Message->RequestId;\r
                        INITIALIZE_Response->Status                = REMOTE_NDIS_STATUS_SUCCESS;\r
                        \r
                        INITIALIZE_Response->RequestId             = INITIALIZE_Message->RequestId;\r
                        INITIALIZE_Response->Status                = REMOTE_NDIS_STATUS_SUCCESS;\r
                        \r


@@ -233,7 +237,7 @@ void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDIS
                        INITIALIZE_Response->DeviceFlags           = REMOTE_NDIS_DF_CONNECTIONLESS;\r
                        INITIALIZE_Response->Medium                = REMOTE_NDIS_MEDIUM_802_3;\r
                        INITIALIZE_Response->MaxPacketsPerTransfer = 1;\r
                        INITIALIZE_Response->DeviceFlags           = REMOTE_NDIS_DF_CONNECTIONLESS;\r
                        INITIALIZE_Response->Medium                = REMOTE_NDIS_MEDIUM_802_3;\r
                        INITIALIZE_Response->MaxPacketsPerTransfer = 1;\r

-                       INITIALIZE_Response->MaxTransferSize       = (sizeof(RNDIS_PACKET_MSG_t) + ETHERNET_FRAME_SIZE_MAX);\r
+                       INITIALIZE_Response->MaxTransferSize       = (sizeof(RNDIS_Packet_Message_t) + ETHERNET_FRAME_SIZE_MAX);\r

                        INITIALIZE_Response->PacketAlignmentFactor = 0;\r
                        INITIALIZE_Response->AFListOffset          = 0;\r
                        INITIALIZE_Response->AFListSize            = 0;\r
                        INITIALIZE_Response->PacketAlignmentFactor = 0;\r
                        INITIALIZE_Response->AFListOffset          = 0;\r
                        INITIALIZE_Response->AFListSize            = 0;\r


@@ -251,17 +255,17 @@ void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDIS
                case REMOTE_NDIS_QUERY_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                                                \r
                case REMOTE_NDIS_QUERY_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                                                \r

-                       RNDIS_QUERY_MSG_t*   QUERY_Message  = (RNDIS_QUERY_MSG_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
-                       RNDIS_QUERY_CMPLT_t* QUERY_Response = (RNDIS_QUERY_CMPLT_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
-                       uint32_t             Query_Oid      = QUERY_Message->Oid;\r
+                       RNDIS_Query_Message_t*  QUERY_Message  = (RNDIS_Query_Message_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       RNDIS_Query_Complete_t* QUERY_Response = (RNDIS_Query_Complete_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       uint32_t                Query_Oid      = QUERY_Message->Oid;\r

                                                \r
                        void*     QueryData                 = &RNDISInterfaceInfo->State.RNDISMessageBuffer[sizeof(RNDIS_Message_Header_t) +\r
                                                                                                      QUERY_Message->InformationBufferOffset];\r
                                                \r
                        void*     QueryData                 = &RNDISInterfaceInfo->State.RNDISMessageBuffer[sizeof(RNDIS_Message_Header_t) +\r
                                                                                                      QUERY_Message->InformationBufferOffset];\r

-                       void*     ResponseData              = &RNDISInterfaceInfo->State.RNDISMessageBuffer[sizeof(RNDIS_QUERY_CMPLT_t)];               \r
+                       void*     ResponseData              = &RNDISInterfaceInfo->State.RNDISMessageBuffer[sizeof(RNDIS_Query_Complete_t)];            \r

                        uint16_t  ResponseSize;\r
 \r
                        QUERY_Response->MessageType         = REMOTE_NDIS_QUERY_CMPLT;\r
                        uint16_t  ResponseSize;\r
 \r
                        QUERY_Response->MessageType         = REMOTE_NDIS_QUERY_CMPLT;\r

-                       QUERY_Response->MessageLength       = sizeof(RNDIS_QUERY_CMPLT_t);\r
+                       QUERY_Response->MessageLength       = sizeof(RNDIS_Query_Complete_t);\r

                                                \r
                        if (RNDIS_Device_ProcessNDISQuery(RNDISInterfaceInfo, Query_Oid, QueryData, QUERY_Message->InformationBufferLength,\r
                                                          ResponseData, &ResponseSize))\r
                                                \r
                        if (RNDIS_Device_ProcessNDISQuery(RNDISInterfaceInfo, Query_Oid, QueryData, QUERY_Message->InformationBufferLength,\r
                                                          ResponseData, &ResponseSize))\r


@@ -270,7 +274,7 @@ void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDIS
                                QUERY_Response->MessageLength          += ResponseSize;\r
                                                        \r
                                QUERY_Response->InformationBufferLength = ResponseSize;\r
                                QUERY_Response->MessageLength          += ResponseSize;\r
                                                        \r
                                QUERY_Response->InformationBufferLength = ResponseSize;\r

-                               QUERY_Response->InformationBufferOffset = (sizeof(RNDIS_QUERY_CMPLT_t) - sizeof(RNDIS_Message_Header_t));\r
+                               QUERY_Response->InformationBufferOffset = (sizeof(RNDIS_Query_Complete_t) - sizeof(RNDIS_Message_Header_t));\r

                        }\r
                        else\r
                        {                               \r
                        }\r
                        else\r
                        {                               \r


@@ -284,12 +288,12 @@ void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDIS
                case REMOTE_NDIS_SET_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                        \r
                case REMOTE_NDIS_SET_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                        \r

-                       RNDIS_SET_MSG_t*   SET_Message  = (RNDIS_SET_MSG_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
-                       RNDIS_SET_CMPLT_t* SET_Response = (RNDIS_SET_CMPLT_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
-                       uint32_t           SET_Oid      = SET_Message->Oid;\r
+                       RNDIS_Set_Message_t*  SET_Message  = (RNDIS_Set_Message_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       RNDIS_Set_Complete_t* SET_Response = (RNDIS_Set_Complete_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       uint32_t              SET_Oid      = SET_Message->Oid;\r

 \r
                        SET_Response->MessageType       = REMOTE_NDIS_SET_CMPLT;\r
 \r
                        SET_Response->MessageType       = REMOTE_NDIS_SET_CMPLT;\r

-                       SET_Response->MessageLength     = sizeof(RNDIS_SET_CMPLT_t);\r
+                       SET_Response->MessageLength     = sizeof(RNDIS_Set_Complete_t);\r

                        SET_Response->RequestId         = SET_Message->RequestId;\r
 \r
                        void* SetData                   = &RNDISInterfaceInfo->State.RNDISMessageBuffer[sizeof(RNDIS_Message_Header_t) +\r
                        SET_Response->RequestId         = SET_Message->RequestId;\r
 \r
                        void* SetData                   = &RNDISInterfaceInfo->State.RNDISMessageBuffer[sizeof(RNDIS_Message_Header_t) +\r


@@ -304,10 +308,10 @@ void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDIS
                case REMOTE_NDIS_RESET_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                        \r
                case REMOTE_NDIS_RESET_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                        \r

-                       RNDIS_RESET_CMPLT_t* RESET_Response = (RNDIS_RESET_CMPLT_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       RNDIS_Reset_Complete_t* RESET_Response = (RNDIS_Reset_Complete_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r

 \r
                        RESET_Response->MessageType         = REMOTE_NDIS_RESET_CMPLT;\r
 \r
                        RESET_Response->MessageType         = REMOTE_NDIS_RESET_CMPLT;\r

-                       RESET_Response->MessageLength       = sizeof(RNDIS_RESET_CMPLT_t);\r
+                       RESET_Response->MessageLength       = sizeof(RNDIS_Reset_Complete_t);\r

                        RESET_Response->Status              = REMOTE_NDIS_STATUS_SUCCESS;\r
                        RESET_Response->AddressingReset     = 0;\r
 \r
                        RESET_Response->Status              = REMOTE_NDIS_STATUS_SUCCESS;\r
                        RESET_Response->AddressingReset     = 0;\r
 \r


@@ -315,11 +319,13 @@ void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDIS
                case REMOTE_NDIS_KEEPALIVE_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                        \r
                case REMOTE_NDIS_KEEPALIVE_MSG:\r
                        RNDISInterfaceInfo->State.ResponseReady = true;\r
                        \r

-                       RNDIS_KEEPALIVE_MSG_t*   KEEPALIVE_Message  = (RNDIS_KEEPALIVE_MSG_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
-                       RNDIS_KEEPALIVE_CMPLT_t* KEEPALIVE_Response = (RNDIS_KEEPALIVE_CMPLT_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       RNDIS_KeepAlive_Message_t*  KEEPALIVE_Message  =\r
+                                       (RNDIS_KeepAlive_Message_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r
+                       RNDIS_KeepAlive_Complete_t* KEEPALIVE_Response =\r
+                                       (RNDIS_KeepAlive_Complete_t*)&RNDISInterfaceInfo->State.RNDISMessageBuffer;\r

 \r
                        KEEPALIVE_Response->MessageType     = REMOTE_NDIS_KEEPALIVE_CMPLT;\r
 \r
                        KEEPALIVE_Response->MessageType     = REMOTE_NDIS_KEEPALIVE_CMPLT;\r

-                       KEEPALIVE_Response->MessageLength   = sizeof(RNDIS_KEEPALIVE_CMPLT_t);\r
+                       KEEPALIVE_Response->MessageLength   = sizeof(RNDIS_KeepAlive_Complete_t);\r

                        KEEPALIVE_Response->RequestId       = KEEPALIVE_Message->RequestId;\r
                        KEEPALIVE_Response->Status          = REMOTE_NDIS_STATUS_SUCCESS;\r
                        \r
                        KEEPALIVE_Response->RequestId       = KEEPALIVE_Message->RequestId;\r
                        KEEPALIVE_Response->Status          = REMOTE_NDIS_STATUS_SUCCESS;\r
                        \r


@@ -327,9 +333,9 @@ void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDIS
        }\r
 }\r
 \r
        }\r
 }\r
 \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_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

 {\r
        switch (OId)\r
        {\r
 {\r
        switch (OId)\r
        {\r


@@ -439,8 +445,8 @@ static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* RNDISInt
        }\r
 }\r
 \r
        }\r
 }\r
 \r

-static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo, uint32_t OId, void* SetData,\r
-                                        uint16_t SetSize)\r
+static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, const uint32_t OId, void* SetData,\r
+                                        const uint16_t SetSize)\r

 {\r
        switch (OId)\r
        {\r
 {\r
        switch (OId)\r
        {\r