Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Class / Host / RNDIS.h @ 978b99e5

History | View | Annotate | Download (15.1 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
  permission notice and warranty disclaimer appear in supporting
17
  documentation, and that the name of the author not be used in
18
  advertising or publicity pertaining to distribution of the
19
  software without specific, written prior permission.
20

21
  The author disclaim all warranties with regard to this
22
  software, including all implied warranties of merchantability
23
  and fitness.  In no event shall the author be liable for any
24
  special, indirect or consequential damages or any damages
25
  whatsoever resulting from loss of use, data or profits, whether
26
  in an action of contract, negligence or other tortious action,
27
  arising out of or in connection with the use or performance of
28
  this software.
29
*/
30

    
31
/** \file
32
 *  \brief Host mode driver for the library USB RNDIS Class driver.
33
 *
34
 *  Host mode driver for the library USB RNDIS Class driver.
35
 *
36
 *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
37
 *        dispatch header located in LUFA/Drivers/USB.h.
38
 */
39

    
40
/** \ingroup Group_USBClassRNDIS
41
 *  \defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver
42
 *
43
 *  \section Sec_Dependencies Module Source Dependencies
44
 *  The following files must be built with any user project that uses this module:
45
 *    - LUFA/Drivers/USB/Class/Host/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_ModDescription Module Description
48
 *  Host Mode USB Class driver framework interface, for the Microsoft RNDIS Ethernet
49
 *  USB Class driver.
50
 *
51
 *  @{
52
 */
53

    
54
#ifndef __RNDIS_CLASS_HOST_H__
55
#define __RNDIS_CLASS_HOST_H__
56

    
57
        /* Includes: */
58
                #include "../../USB.h"
59
                #include "../Common/RNDIS.h"
60

    
61
        /* Enable C linkage for C++ Compilers: */
62
                #if defined(__cplusplus)
63
                        extern "C" {
64
                #endif
65

    
66
        /* Preprocessor Checks: */
67
                #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
68
                        #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
69
                #endif
70

    
71
        /* Public Interface - May be used in end-application: */
72
                /* Type Defines: */
73
                        /** \brief RNDIS Class Host Mode Configuration and State Structure.
74
                         *
75
                         *  Class state structure. An instance of this structure should be made within the user application,
76
                         *  and passed to each of the RNDIS class driver functions as the \c RNDISInterfaceInfo parameter. This
77
                         *  stores each RNDIS interface's configuration and state information.
78
                         */
79
                        typedef struct
80
                        {
81
                                const struct
82
                                {
83
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the RNDIS interface's IN data pipe. */
84
                                        bool     DataINPipeDoubleBank; /**< Indicates if the RNDIS interface's IN data pipe should use double banking. */
85

    
86
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the RNDIS interface's OUT data pipe. */
87
                                        bool     DataOUTPipeDoubleBank; /**< Indicates if the RNDIS interface's OUT data pipe should use double banking. */
88

    
89
                                        uint8_t  NotificationPipeNumber; /**< Pipe number of the RNDIS interface's IN notification endpoint, if used. */
90
                                        bool     NotificationPipeDoubleBank; /**< Indicates if the RNDIS interface's notification pipe should use double banking. */
91

    
92
                                        uint32_t HostMaxPacketSize; /**< Maximum size of a packet which can be buffered by the host. */
93
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
94
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
95
                                           */
96
                                struct
97
                                {
98
                                        bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
99
                                                        *   after \ref RNDIS_Host_ConfigurePipes() is called and the Host state machine is in the
100
                                                        *   Configured state.
101
                                                        */
102
                                        uint8_t ControlInterfaceNumber; /**< Interface index of the RNDIS control interface within the attached device. */
103

    
104
                                        uint16_t DataINPipeSize; /**< Size in bytes of the RNDIS interface's IN data pipe. */
105
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the RNDIS interface's OUT data pipe. */
106
                                        uint16_t NotificationPipeSize;  /**< Size in bytes of the RNDIS interface's IN notification pipe, if used. */
107

    
108
                                        uint32_t DeviceMaxPacketSize; /**< Maximum size of a packet which can be buffered by the attached RNDIS device. */
109

    
110
                                        uint32_t RequestID; /**< Request ID counter to give a unique ID for each command/response pair. */
111
                                } State; /**< State data for the USB class interface within the device. All elements in this section
112
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
113
                                                  *   the interface is enumerated.
114
                                                  */
115
                        } USB_ClassInfo_RNDIS_Host_t;
116

    
117
                /* Enums: */
118
                        /** Enum for the possible error codes returned by the \ref RNDIS_Host_ConfigurePipes() function. */
119
                        enum RNDIS_Host_EnumerationFailure_ErrorCodes_t
120
                        {
121
                                RNDIS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
122
                                RNDIS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
123
                                RNDIS_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible RNDIS interface was not found in the device's Configuration Descriptor. */
124
                                RNDIS_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
125
                        };
126

    
127
                /* Function Prototypes: */
128
                        /** Host interface configuration routine, to configure a given RNDIS host interface instance using the Configuration
129
                         *  Descriptor read from an attached USB device. This function automatically updates the given RNDIS Host instance's
130
                         *  state values and configures the pipes required to communicate with the interface if it is found within the device.
131
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
132
                         *  the Addressed state.
133
                         *
134
                         *  \param[in,out] RNDISInterfaceInfo      Pointer to a structure containing an RNDIS Class host configuration and state.
135
                         *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
136
                         *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
137
                         *
138
                         *  \return A value from the \ref RNDIS_Host_EnumerationFailure_ErrorCodes_t enum.
139
                         */
140
                        uint8_t RNDIS_Host_ConfigurePipes(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
141
                                                          uint16_t ConfigDescriptorSize,
142
                                                          void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
143

    
144
                        /** Sends a RNDIS KEEPALIVE command to the device, to ensure that it does not enter standby mode after periods
145
                         *  of long inactivity.
146
                         *
147
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
148
                         *
149
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the device returned a
150
                         *          logical command failure.
151
                         */
152
                        uint8_t RNDIS_Host_SendKeepAlive(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
153

    
154
                        /** Initializes the attached RNDIS device's RNDIS interface. This should be called after the device's pipes have been
155
                         *  configured via the call to \ref RNDIS_Host_ConfigurePipes().
156
                         *
157
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
158
                         *
159
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the
160
                         *          device returned a logical command failure.
161
                         */
162
                        uint8_t RNDIS_Host_InitializeDevice(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
163

    
164
                        /** Sets a given RNDIS property of an attached RNDIS device.
165
                         *
166
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
167
                         *  \param[in]     Oid                 OID number of the parameter to set.
168
                         *  \param[in]     Buffer              Pointer to where the property data is to be sourced from.
169
                         *  \param[in]     Length              Length in bytes of the property data to sent to the device.
170
                         *
171
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the
172
                         *          device returned a logical command failure.
173
                         */
174
                        uint8_t RNDIS_Host_SetRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
175
                                                            const uint32_t Oid,
176
                                                            void* Buffer,
177
                                                            const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
178

    
179
                        /** Gets a given RNDIS property of an attached RNDIS device.
180
                         *
181
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
182
                         *  \param[in]     Oid                 OID number of the parameter to get.
183
                         *  \param[in]     Buffer              Pointer to where the property data is to be written to.
184
                         *  \param[in]     MaxLength           Length in bytes of the destination buffer size.
185
                         *
186
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the
187
                         *          device returned a logical command failure.
188
                         */
189
                        uint8_t RNDIS_Host_QueryRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
190
                                                              const uint32_t Oid,
191
                                                              void* Buffer,
192
                                                              const uint16_t MaxLength) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
193

    
194
                        /** Determines if a packet is currently waiting for the host to read in and process.
195
                         *
196
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
197
                         *       call will fail.
198
                         *
199
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
200
                         *
201
                         *  \return Boolean \c true if a packet is waiting to be read in by the host, \c false otherwise.
202
                         */
203
                        bool RNDIS_Host_IsPacketReceived(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
204

    
205
                        /** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
206
                         *  only the packet contents for processing by the host in the nominated buffer.
207
                         *
208
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
209
                         *       call will fail.
210
                         *
211
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
212
                         *  \param[out]    Buffer              Pointer to a buffer where the packer data is to be written to.
213
                         *  \param[out]    PacketLength        Pointer to where the length in bytes of the read packet is to be stored.
214
                         *
215
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
216
                         */
217
                        uint8_t RNDIS_Host_ReadPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
218
                                                      void* Buffer,
219
                                                      uint16_t* const PacketLength) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2)
220
                                                      ATTR_NON_NULL_PTR_ARG(3);
221

    
222
                        /** Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header.
223
                         *
224
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
225
                         *       call will fail.
226
                         *
227
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
228
                         *  \param[in]     Buffer              Pointer to a buffer where the packer data is to be read from.
229
                         *  \param[in]     PacketLength        Length in bytes of the packet to send.
230
                         *
231
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
232
                         */
233
                        uint8_t RNDIS_Host_SendPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
234
                                                      void* Buffer,
235
                                                      const uint16_t PacketLength) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
236

    
237
                /* Inline Functions: */
238
                        /** General management task for a given RNDIS host class interface, required for the correct operation of the interface. This should
239
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
240
                         *
241
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
242
                         */
243
                        static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
244
                        static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo)
245
                        {
246
                                (void)RNDISInterfaceInfo;
247
                        }
248

    
249
        /* Private Interface - For use in library only: */
250
        #if !defined(__DOXYGEN__)
251
                /* Function Prototypes: */
252
                        #if defined(__INCLUDE_FROM_RNDIS_HOST_C)
253
                                static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
254
                                                                             void* Buffer,
255
                                                                             const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1)
256
                                                                             ATTR_NON_NULL_PTR_ARG(2);
257
                                static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
258
                                                                             void* Buffer,
259
                                                                             const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1)
260
                                                                             ATTR_NON_NULL_PTR_ARG(2);
261

    
262
                                static uint8_t DCOMP_RNDIS_Host_NextRNDISControlInterface(void* const CurrentDescriptor)
263
                                                                                          ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
264
                                static uint8_t DCOMP_RNDIS_Host_NextRNDISDataInterface(void* const CurrentDescriptor)
265
                                                                                       ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
266
                                static uint8_t DCOMP_RNDIS_Host_NextRNDISInterfaceEndpoint(void* const CurrentDescriptor)
267
                                                                                           ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
268
                        #endif
269
        #endif
270

    
271
        /* Disable C linkage for C++ Compilers: */
272
                #if defined(__cplusplus)
273
                        }
274
                #endif
275

    
276
#endif
277

    
278
/** @} */
279