Split out the RFCOMM Control Channel command processing code into a seperate set...

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

diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h
index 7daaca8..111d60b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h
@@ -84,13 +84,13 @@
                                const struct
                                {
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the RNDIS interface's IN data pipe */
                                const struct
                                {
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the RNDIS interface's IN data pipe */

-                                       bool     DataINPipeDoubleBank; /** Indicates if the RNDIS interface's IN data pipe should use double banking */
+                                       bool     DataINPipeDoubleBank; /**< Indicates if the RNDIS interface's IN data pipe should use double banking */

 
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the RNDIS interface's OUT data pipe */
 
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the RNDIS interface's OUT data pipe */

-                                       bool     DataOUTPipeDoubleBank; /** Indicates if the RNDIS interface's OUT data pipe should use double banking */
+                                       bool     DataOUTPipeDoubleBank; /**< Indicates if the RNDIS interface's OUT data pipe should use double banking */

 
                                        uint8_t  NotificationPipeNumber; /**< Pipe number of the RNDIS interface's IN notification endpoint, if used */                 
 
                                        uint8_t  NotificationPipeNumber; /**< Pipe number of the RNDIS interface's IN notification endpoint, if used */                 

-                                       bool     NotificationPipeDoubleBank; /** Indicates if the RNDIS interface's notification pipe should use double banking */
+                                       bool     NotificationPipeDoubleBank; /**< Indicates if the RNDIS interface's notification pipe should use double banking */

                                        
                                        uint32_t HostMaxPacketSize; /**< Maximum size of a packet which can be buffered by the host */
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
                                        
                                        uint32_t HostMaxPacketSize; /**< Maximum size of a packet which can be buffered by the host */
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section


@@ -128,7 +128,7 @@
                        };
 
                /* Macros: */
                        };
 
                /* Macros: */

-                       /** Additional error code for RNDIS functions when a device returns a logical command failure */
+                       /** Additional error code for RNDIS functions when a device returns a logical command failure. */

                        #define RNDIS_COMMAND_FAILED                  0xC0      
 
                /* Function Prototypes: */
                        #define RNDIS_COMMAND_FAILED                  0xC0      
 
                /* Function Prototypes: */


@@ -138,9 +138,9 @@
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *

-                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] RNDISInterfaceInfo      Pointer to a structure containing an RNDIS Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor

                         *
                         *  \return A value from the \ref RNDISHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref RNDISHost_EnumerationFailure_ErrorCodes_t enum
                         */


@@ -170,9 +170,9 @@
                        /** Sets a given RNDIS property of an attached RNDIS device.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                        /** Sets a given RNDIS property of an attached RNDIS device.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state

-                        *  \param[in] Oid  OID number of the parameter to set
-                        *  \param[in] Buffer  Pointer to where the property data is to be sourced from
-                        *  \param[in] Length  Length in bytes of the property data to sent to the device
+                        *  \param[in]     Oid                 OID number of the parameter to set
+                        *  \param[in]     Buffer              Pointer to where the property data is to be sourced from
+                        *  \param[in]     Length              Length in bytes of the property data to sent to the device

                         *
                         *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
                         *          logical command failure
                         *
                         *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
                         *          logical command failure


@@ -183,9 +183,9 @@
                        /** Gets a given RNDIS property of an attached RNDIS device.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                        /** Gets a given RNDIS property of an attached RNDIS device.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state

-                        *  \param[in] Oid  OID number of the parameter to get
-                        *  \param[in] Buffer  Pointer to where the property data is to be written to
-                        *  \param[in] MaxLength  Length in bytes of the destination buffer size
+                        *  \param[in]     Oid                 OID number of the parameter to get
+                        *  \param[in]     Buffer              Pointer to where the property data is to be written to
+                        *  \param[in]     MaxLength           Length in bytes of the destination buffer size

                         *
                         *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
                         *          logical command failure
                         *
                         *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
                         *          logical command failure


@@ -202,8 +202,7 @@
                         *
                         *  \return Boolean true if a packet is waiting to be read in by the host, false otherwise
                         */
                         *
                         *  \return Boolean true if a packet is waiting to be read in by the host, false otherwise
                         */

-
-                       bool RNDIS_Host_IsPacketReceived(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo);
+                       bool RNDIS_Host_IsPacketReceived(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

                        
                        /** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
                         *  only the packet contents for processing by the host in the nominated buffer.
                        
                        /** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
                         *  only the packet contents for processing by the host in the nominated buffer.


@@ -212,8 +211,8 @@
                         *        call will fail.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state

-                        *  \param[out] Buffer  Pointer to a buffer where the packer data is to be written to
-                        *  \param[out] PacketLength  Pointer to where the length in bytes of the read packet is to be stored
+                        *  \param[out]    Buffer              Pointer to a buffer where the packer data is to be written to
+                        *  \param[out]    PacketLength        Pointer to where the length in bytes of the read packet is to be stored

                         *
                         *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
                         */


@@ -226,8 +225,8 @@
                         *        call will fail.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state

-                        *  \param[in] Buffer  Pointer to a buffer where the packer data is to be read from
-                        *  \param[in] PacketLength  Length in bytes of the packet to send
+                        *  \param[in]     Buffer              Pointer to a buffer where the packer data is to be read from
+                        *  \param[in]     PacketLength        Length in bytes of the packet to send

                         *
                         *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
                         */


@@ -240,7 +239,7 @@
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                         */
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                         */

-                       static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo);
+                       static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

                        static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo)
                        {
                                (void)RNDISInterfaceInfo;
                        static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo)
                        {
                                (void)RNDISInterfaceInfo;


@@ -263,13 +262,15 @@
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_RNDIS_CLASS_HOST_C)
                                static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_RNDIS_CLASS_HOST_C)
                                static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, 

-                                                                            void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+                                                                            void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1)
+                                                                            ATTR_NON_NULL_PTR_ARG(2);

                                static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
                                static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,

-                                                                            void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+                                                                            void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1)
+                                                                            ATTR_NON_NULL_PTR_ARG(2);

 
 

-                               static uint8_t DComp_RNDIS_Host_NextRNDISControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
-                               static uint8_t DComp_RNDIS_Host_NextRNDISDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
-                               static uint8_t DComp_RNDIS_Host_NextRNDISInterfaceEndpoint(void* const CurrentDescriptor);
+                               static uint8_t DCOMP_RNDIS_Host_NextRNDISControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+                               static uint8_t DCOMP_RNDIS_Host_NextRNDISDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+                               static uint8_t DCOMP_RNDIS_Host_NextRNDISInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

                        #endif  
        #endif
                                
                        #endif  
        #endif