LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
Main Page
Related Pages
Modules
Data Structures
Files
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
Pages
RNDISClassDevice.h
Go to the documentation of this file.
1
/*
2
* @brief Device mode driver for the library USB RNDIS Class driver
3
*
4
* @note
5
* Copyright(C) NXP Semiconductors, 2012
6
* Copyright(C) Dean Camera, 2011, 2012
7
* All rights reserved.
8
*
9
* @par
10
* Software that is described herein is for illustrative purposes only
11
* which provides customers with programming information regarding the
12
* LPC products. This software is supplied "AS IS" without any warranties of
13
* any kind, and NXP Semiconductors and its licensor disclaim any and
14
* all warranties, express or implied, including all implied warranties of
15
* merchantability, fitness for a particular purpose and non-infringement of
16
* intellectual property rights. NXP Semiconductors assumes no responsibility
17
* or liability for the use of the software, conveys no license or rights under any
18
* patent, copyright, mask work right, or any other intellectual property rights in
19
* or to any products. NXP Semiconductors reserves the right to make changes
20
* in the software without notification. NXP Semiconductors also makes no
21
* representation or warranty that such application will be suitable for the
22
* specified use without further testing or modification.
23
*
24
* @par
25
* Permission to use, copy, modify, and distribute this software and its
26
* documentation is hereby granted, under NXP Semiconductors' and its
27
* licensor's relevant copyrights in the software, without fee, provided that it
28
* is used in conjunction with NXP Semiconductors microcontrollers. This
29
* copyright, permission, and disclaimer notice must appear in all copies of
30
* this code.
31
*/
32
46
#ifndef _RNDIS_CLASS_DEVICE_H_
47
#define _RNDIS_CLASS_DEVICE_H_
48
49
/* Includes: */
50
#include "../../USB.h"
51
#include "../Common/RNDISClassCommon.h"
52
53
/* Enable C linkage for C++ Compilers: */
54
#if defined(__cplusplus)
55
extern
"C"
{
56
#endif
57
58
/* Preprocessor Checks: */
59
#if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
60
#error Do not include this file directly. Include LPCUSBlib/Drivers/USB.h instead.
61
#endif
62
63
/* Public Interface - May be used in end-application: */
64
/* Type Defines: */
72
typedef
struct
{
73
const
struct
{
74
uint8_t
ControlInterfaceNumber
;
76
uint8_t
DataINEndpointNumber
;
77
uint16_t
DataINEndpointSize
;
78
bool
DataINEndpointDoubleBank
;
80
uint8_t
DataOUTEndpointNumber
;
81
uint16_t
DataOUTEndpointSize
;
82
bool
DataOUTEndpointDoubleBank
;
84
uint8_t
NotificationEndpointNumber
;
85
uint16_t
NotificationEndpointSize
;
86
bool
NotificationEndpointDoubleBank
;
88
char
*
AdapterVendorDescription
;
89
MAC_Address_t
AdapterMACAddress
;
90
} Config;
94
struct
{
95
uint8_t RNDISMessageBuffer[
RNDIS_MESSAGE_BUFFER_SIZE
];
98
bool
ResponseReady
;
99
uint8_t
CurrRNDISState
;
100
uint32_t
CurrPacketFilter
;
101
} State;
105
}
USB_ClassInfo_RNDIS_Device_t
;
106
107
/* Function Prototypes: */
117
bool
RNDIS_Device_ConfigureEndpoints
(
USB_ClassInfo_RNDIS_Device_t
*
const
RNDISInterfaceInfo)
ATTR_NON_NULL_PTR_ARG
(1);
118
126
void
RNDIS_Device_ProcessControlRequest
(
USB_ClassInfo_RNDIS_Device_t
*
const
RNDISInterfaceInfo)
ATTR_NON_NULL_PTR_ARG
(1);
127
135
void
RNDIS_Device_USBTask
(
USB_ClassInfo_RNDIS_Device_t
*
const
RNDISInterfaceInfo)
ATTR_NON_NULL_PTR_ARG
(1);
136
147
bool
RNDIS_Device_IsPacketReceived
(
USB_ClassInfo_RNDIS_Device_t
*
const
RNDISInterfaceInfo);
148
162
uint8_t
RNDIS_Device_ReadPacket
(
USB_ClassInfo_RNDIS_Device_t
*
const
RNDISInterfaceInfo,
163
void
*Buffer,
164
uint16_t *
const
PacketLength);
165
178
uint8_t
RNDIS_Device_SendPacket
(
USB_ClassInfo_RNDIS_Device_t
*
const
RNDISInterfaceInfo,
179
void
*Buffer,
180
const
uint16_t PacketLength);
181
182
/* Private Interface - For use in library only: */
183
#if !defined(__DOXYGEN__)
184
/* Function Prototypes: */
185
#if defined(__INCLUDE_FROM_RNDIS_DEVICE_C)
186
static
void
RNDIS_Device_ProcessRNDISControlMessage
(
USB_ClassInfo_RNDIS_Device_t
*
const
RNDISInterfaceInfo)
187
ATTR_NON_NULL_PTR_ARG
(1);
188
189
static
bool
RNDIS_Device_ProcessNDISQuery
(
USB_ClassInfo_RNDIS_Device_t
*
const
RNDISInterfaceInfo,
190
const
uint32_t
OId,
191
void
*
const
QueryData,
192
const
uint16_t QuerySize,
193
void
*ResponseData,
194
uint16_t *
const
ResponseSize)
ATTR_NON_NULL_PTR_ARG
(1)
195
ATTR_NON_NULL_PTR_ARG
(5)
ATTR_NON_NULL_PTR_ARG
(6);
196
197
static
bool
RNDIS_Device_ProcessNDISSet
(
USB_ClassInfo_RNDIS_Device_t
*const RNDISInterfaceInfo,
198
const
uint32_t
OId,
199
const
void
*SetData,
200
const uint16_t SetSize) ATTR_NON_NULL_PTR_ARG(1)
201
ATTR_NON_NULL_PTR_ARG(3);
202
203
#endif
204
205
#endif
206
207
/* Disable C linkage for C++ Compilers: */
208
#if defined(__cplusplus)
209
}
210
#endif
211
212
#endif
213
software
LPCUSBLib
Drivers
USB
Class
Device
RNDISClassDevice.h
Generated on Fri Nov 16 2012 13:36:45 for LPCOpen Platform by
1.8.2