summaryrefslogtreecommitdiffstats
path: root/private/ntos/ndis/ndistapi/private.h
blob: 5129f0ac5311229d790b73f56727927b9019bda3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
/*++ BUILD Version: 0000    // Increment this if a change has global effects

Copyright (c) 1994  Microsoft Corporation

Module Name:

    private.h

Abstract:

    Private definitions for NdisTapi.sys

Author:

    Dan Knudson (DanKn)    20-Feb-1994

Revision History:

--*/


//
// Various definitions
//

typedef enum _PROVIDER_STATUS
{
    PROVIDER_STATUS_ONLINE,
    PROVIDER_STATUS_OFFLINE,
    PROVIDER_STATUS_PENDING_INIT

} PROVIDER_STATUS, *PPROVIDER_STATUS;


typedef NDIS_STATUS (*REQUEST_PROC)(NDIS_HANDLE, PNDIS_REQUEST);


typedef struct _PROVIDER_INFO
{
    PROVIDER_STATUS Status;

    NDIS_HANDLE     ProviderHandle;

    REQUEST_PROC    RequestProc;

    ULONG           ProviderID;

    ULONG           NumDevices;

    ULONG           DeviceIDBase;

    struct _PROVIDER_INFO  *Next;

} PROVIDER_INFO, *PPROVIDER_INFO;


typedef enum _NDISTAPI_STATUS
{
    NDISTAPI_STATUS_CONNECTED,
    NDISTAPI_STATUS_DISCONNECTED,
    NDISTAPI_STATUS_CONNECTING,
    NDISTAPI_STATUS_DISCONNECTING

} NDISTAPI_STATUS, *PNDISTAPI_STATUS;


typedef struct _DEVICE_EXTENSION
{
    //
    // The following are set only in DriverEntry and are not
    // modified elsewhere
    //

    //
    // Pointer to the NdisTapi device object
    //

    PDEVICE_OBJECT  DeviceObject;

    //
    // Length in bytes of the event data buf
    //

    ULONG           EventDataQueueLength;

    //
    // Pointer to a circular event data buf
    //

    PCHAR           EventData;



    //
    // Synchronizes access to the device extension following fields
    //

    KSPIN_LOCK      SpinLock;

    //
    // Whether TAPI has the the connection wrapper open
    //

    NDISTAPI_STATUS Status;

    //
    // Event we use for synchronizing provider inits
    //

    KEVENT          SyncEvent;

    //
    // The connection wrapper's device ID base as passed down by TAPI
    // when it connected.
    //

    ULONG           NdisTapiDeviceIDBase;

    //
    // The number of line devices we told told TAPI we supported when
    // it opened us (some of which may not actually be online at any
    // given time)
    //

    ULONG           NdisTapiNumDevices;

    //
    // Whether we have an outstanding provider init request
    //

    BOOLEAN         ProviderInitPending;

    //
    // Pointer to a list of registered providers. (Some may actually
    // not be currently registered, but they were at one point so we've
    // saved a placeholder for them should they come back online at some
    // point.)
    //

    PPROVIDER_INFO  Providers;

    //
    //
    //

    BOOLEAN         CleanupWasInitiated;

    //
    // A special queue for QUERY/SET_INFO requests
    //

    KDEVICE_QUEUE   DeviceQueue;



    //
    // Synchronizes access to the events buffer & related fields
    //

    KSPIN_LOCK      EventSpinLock;

    //
    // Value return to provider for next NEWCALL msg
    //

    ULONG           htCall;

    //
    // Outstanding get-events request
    //

    PIRP            EventsRequestIrp;

    //
    // Pointer to next place to PUT event data (from provider)
    //

    PCHAR           DataIn;

    //
    // Pointer to next place to GET event data (for user-mode request)
    //

    PCHAR           DataOut;

    //
    // Number of valid events in queue
    //

    ULONG           EventCount;


    //
    //
    //

    PFILE_OBJECT    TapiSrvFileObject;

    //
    //
    //

    PFILE_OBJECT    NCPAFileObject;

} DEVICE_EXTENSION, *PDEVICE_EXTENSION;


typedef struct _PROVIDER_REQUEST
{
    NDIS_REQUEST    NdisRequest;

    PPROVIDER_INFO  Provider;

    //
    // This field is a placeholder for an NDIS_TAPI_XXX structure, the
    // first ULONG of which is always a request ID.
    //

    ULONG           Data[1];

} PROVIDER_REQUEST, *PPROVIDER_REQUEST;


//
// Our global device extension
//

PDEVICE_EXTENSION DeviceExtension;



#if DBG

//
// A var which determines the verboseness of the msgs printed by DBGOUT()
//
//

ULONG NdisTapiDebugLevel = 0;

//
// DbgPrint wrapper
//

#define DBGOUT(arg) DbgPrt arg

#else

#define DBGOUT(arg)

#endif