summaryrefslogblamecommitdiffstats
path: root/private/ntos/ndis/ndis30/wrapper.h
blob: 8885bd8001afe2c416858efbd07e0c4434d5a87d (plain) (tree)
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
























































































































































































































































































































































































































































































                                                                                                             
#include <ntddk.h>
#include <ndismain.h>
#include <ndismac.h>
#include <ndismini.h>


#if defined(BUILD_FOR_3_5) || defined(BUILD_FOR_3_1)

#define Increment(a,b) ExInterlockedIncrementLong(a,b)
#define Decrement(a,b) ExInterlockedDecrementLong(a,b)

#else

#define Increment(a,b) InterlockedIncrement(a)
#define Decrement(a,b) InterlockedDecrement(a)

#endif

#if defined(BUILD_FOR_3_1)

#define FASTCALL

#define MmLockPagableImageSection(a) NULL
#define MmUnlockPagableImageSection(a)

#define COMPUTE_PAGES_SPANNED(Va, Size) \
    ((((ULONG)Va & (PAGE_SIZE -1)) + (Size) + (PAGE_SIZE - 1)) >> PAGE_SHIFT)

#define Int32x32To64(a,b) RtlEnlargedIntegerMultiply((a),(b)).QuadPart

#define ExAllocatePoolWithTag(a,b,c) ExAllocatePool((a),(b))

NTSTATUS
NTAPI
RtlCharToInteger (
    PCSZ String,
    ULONG Base,
    PULONG Value
    );

#endif

#if defined(BUILD_FOR_3_5)
#define	MmLockPagableCodeSection(x) MmLockPagableImageSection(x)
#endif

#define ACQUIRE_SPIN_LOCK(_SpinLock) KeAcquireSpinLock(&(_SpinLock)->SpinLock, &(_SpinLock)->OldIrql)
#define RELEASE_SPIN_LOCK(_SpinLock) KeReleaseSpinLock(&(_SpinLock)->SpinLock, (_SpinLock)->OldIrql)
#define ACQUIRE_SPIN_LOCK_DPC(_SpinLock) KeAcquireSpinLockAtDpcLevel(&(_SpinLock)->SpinLock)
#define RELEASE_SPIN_LOCK_DPC(_SpinLock) KeReleaseSpinLockFromDpcLevel(&(_SpinLock)->SpinLock)


#if DBG
#define NDISDBG 0
#endif
#if !defined(NDISDBG)
#define NDISDBG 0
#endif

#if NDISDBG

#if defined(MEMPRINT)
#include "memprint.h"   //DavidTr's memprint program at ntos\srv
#endif // MEMPRINT

extern int      NdisMsgLevel;
extern BOOLEAN  NdisChkErrorFlag;

#define TRACE_NONE         0x0000
#define TRACE_IMPT         0x0001
#define TRACE_ALL          0x0002

#define IF_TRACE(level) if ( NdisMsgLevel >= (level) )   //for tracing

#define IF_ERROR_CHK  if (NdisChkErrorFlag)       // for parameter checking

#define DbgIsNonPaged(_Address) \
    ( MmIsNonPagedSystemAddressValid((PVOID)(_Address)) )

#define DbgIsPacket(_Packet) \
    ( ((_Packet)->Private.Pool->PacketLength) > sizeof(_Packet) )

#define DbgIsNull(_Ptr)  ( ((PVOID)(_Ptr)) == NULL )

#define NdisPrint1(fmt)                DbgPrint(fmt)
#define NdisPrint2(fmt,v1)             DbgPrint(fmt,v1)
#define NdisPrint3(fmt,v1,v2)          DbgPrint(fmt,v1,v2)
#define NdisPrint4(fmt,v1,v2,v3)       DbgPrint(fmt,v1,v2,v3)
#define NdisPrint5(fmt,v1,v2,v3,v4)    DbgPrint(fmt,v1,v2,v3,v4)

#else // NDISDBG

#define IF_TRACE(level)   if (FALSE)
#define IF_ERROR_CHK      if (FALSE)

#define DbgIsNonPaged(_Address) TRUE
#define DbgIsPacket(_Packet)    TRUE
#define DbgIsNull(_Ptr)         FALSE

#define NdisPrint1(fmt)
#define NdisPrint2(fmt,v1)
#define NdisPrint3(fmt,v1,v2)
#define NdisPrint4(fmt,v1,v2,v3)
#define NdisPrint5(fmt,v1,v2,v3,v4)

#endif // NDISDBG


#if DBG
#define MINIPORT_AT_DPC_LEVEL (KeGetCurrentIrql() == DISPATCH_LEVEL)
#else
#define MINIPORT_AT_DPC_LEVEL 1
#endif


//
//  This is the number of extra OIDs that ARCnet with Ethernet encapsulation
//  supports.
//
#define ARC_NUMBER_OF_EXTRA_OIDS    2



//
// Internal wrapper data structures.
//

//
// NDIS_WRAPPER_CONTEXT
//
// This data structure contains internal data items for use by the wrapper.
//

typedef struct _NDIS_WRAPPER_CONTEXT {

    //
    // Mac/miniport defined shutdown context.
    //

    PVOID ShutdownContext;

    //
    // Mac/miniport registered shutdown handler.
    //

    ADAPTER_SHUTDOWN_HANDLER  ShutdownHandler;

#if !defined(BUILD_FOR_3_1)
    //
    // Kernel bugcheck record for bugcheck handling.
    //

    KBUGCHECK_CALLBACK_RECORD BugcheckCallbackRecord;
#endif

    //
    // Miniport assigned resources for PCI, PCMCIA, EISA, etc.
    //

    PCM_RESOURCE_LIST AssignedSlotResources;

    //
    // HAL common buffer cache.
    //

    PVOID SharedMemoryPage[2];
    ULONG SharedMemoryLeft[2];
    NDIS_PHYSICAL_ADDRESS SharedMemoryAddress[2];

} NDIS_WRAPPER_CONTEXT, *PNDIS_WRAPPER_CONTEXT;

//
// Lock/unlock miniport macros.
//

#define LOCK_MINIPORT(_M_, _L) \
{                           \
    if (_M_->LockAcquired) { \
        _L = FALSE;         \
    } else {                \
        _L = TRUE;          \
        _M_->LockAcquired = TRUE; \
    }                       \
}

#define UNLOCK_MINIPORT(_M_, _L) \
{                             \
    if (_L) {                 \
        _M_->LockAcquired = FALSE; \
    }                         \
}


NDIS_STATUS
NdisInitialInit(
    PDRIVER_OBJECT Driver OPTIONAL
    );

VOID
FASTCALL
MiniportProcessDeferred(
    PNDIS_MINIPORT_BLOCK Miniport
    );

NDIS_STATUS
NdisMTransferDataSync(
    IN NDIS_HANDLE NdisBindingHandle,
    IN NDIS_HANDLE MacReceiveContext,
    IN UINT ByteOffset,
    IN UINT BytesToTransfer,
    IN OUT PNDIS_PACKET Packet,
    OUT PUINT BytesTransferred
    );

#define MINIPORT_DISABLE_INTERRUPT(_M_)                                                 \
{                                                                                       \
    ASSERT(_M_->DriverHandle->MiniportCharacteristics.DisableInterruptHandler != NULL); \
    (_M_->DriverHandle->MiniportCharacteristics.DisableInterruptHandler)(               \
                _M_->MiniportAdapterContext                                             \
                );                                                                      \
}

#define MINIPORT_SYNC_DISABLE_INTERRUPT(_M_)                                            \
{                                                                                       \
    if (_M_->DriverHandle->MiniportCharacteristics.DisableInterruptHandler != NULL) {   \
        KeSynchronizeExecution(                                                         \
                (_M_)->Interrupt->InterruptObject,                                      \
                (PKSYNCHRONIZE_ROUTINE)(_M_->DriverHandle->MiniportCharacteristics.DisableInterruptHandler),\
                _M_->MiniportAdapterContext                                             \
                );                                                                      \
    }                                                                                   \
}

#define CHECK_FOR_NORMAL_INTERRUPTS(_Miniport)                                          \
    _Miniport->NormalInterrupts = (BOOLEAN)(!_Miniport->HaltingMiniport &&              \
                                            !_Miniport->InInitialize &&                 \
                                            (_Miniport->Interrupt != NULL) &&           \
                                            !_Miniport->Interrupt->IsrRequested &&      \
                                            !_Miniport->Interrupt->SharedInterrupt)

//
// general reference/dereference functions
//

BOOLEAN
NdisReferenceRef(
    IN PREFERENCE RefP
    );


BOOLEAN
NdisDereferenceRef(
    PREFERENCE RefP
    );


VOID
NdisInitializeRef(
    PREFERENCE RefP
    );


BOOLEAN
NdisCloseRef(
    PREFERENCE RefP
    );


/*++
BOOLEAN
NdisReferenceProtocol(
    IN PNDIS_PROTOCOL_BLOCK ProtP
    );
--*/

#define NdisReferenceProtocol(ProtP) \
    NdisReferenceRef(&(ProtP)->Ref)



BOOLEAN
QueueOpenOnProtocol(
    IN PNDIS_OPEN_BLOCK OpenP,
    IN PNDIS_PROTOCOL_BLOCK ProtP
    );


/*++
VOID
NdisDereferenceProtocol(
    PNDIS_PROTOCOL_BLOCK ProtP
    );
--*/
#define NdisDereferenceProtocol(ProtP) { \
    if (NdisDereferenceRef(&(ProtP)->Ref)) { \
        ExFreePool((PVOID)(ProtP)); \
    } \
}



VOID
NdisDeQueueOpenOnProtocol(
    PNDIS_OPEN_BLOCK OpenP,
    PNDIS_PROTOCOL_BLOCK ProtP
    );


BOOLEAN
NdisFinishOpen(
    PNDIS_OPEN_BLOCK OpenP
    );


VOID
NdisKillOpenAndNotifyProtocol(
    PNDIS_OPEN_BLOCK OldOpenP
    );


BOOLEAN
NdisKillOpen(
    PNDIS_OPEN_BLOCK OldOpenP
    );

/*++
BOOLEAN
NdisReferenceMac(
    IN PNDIS_MAC_BLOCK MacP
    );
--*/
#define NdisReferenceMac(MacP) \
    NdisReferenceRef(&(MacP)->Ref)

static
VOID
NdisDereferenceMac(
    PNDIS_MAC_BLOCK MacP
    );

BOOLEAN
NdisQueueAdapterOnMac(
    PNDIS_ADAPTER_BLOCK AdaptP,
    PNDIS_MAC_BLOCK MacP
    );

VOID
NdisDeQueueAdapterOnMac(
    PNDIS_ADAPTER_BLOCK AdaptP,
    PNDIS_MAC_BLOCK MacP
    );

/*++
BOOLEAN
NdisReferenceAdapter(
    IN PNDIS_ADAPTER_BLOCK AdaptP
    );
--*/
#define NdisReferenceAdapter(AdaptP) \
    NdisReferenceRef(&(AdaptP)->Ref)


BOOLEAN
NdisQueueOpenOnAdapter(
    PNDIS_OPEN_BLOCK OpenP,
    PNDIS_ADAPTER_BLOCK AdaptP
    );

VOID
NdisKillAdapter(
    PNDIS_ADAPTER_BLOCK OldAdaptP
    );

VOID
NdisDereferenceAdapter(
    PNDIS_ADAPTER_BLOCK AdaptP
    );

VOID
NdisDeQueueOpenOnAdapter(
    PNDIS_OPEN_BLOCK OpenP,
    PNDIS_ADAPTER_BLOCK AdaptP
    );

NDIS_STATUS
NdisCallDriverAddAdapter(
    IN PNDIS_MAC_BLOCK NewMacP
    );

/*++
BOOLEAN
NdisReferenceDriver(
    IN PNDIS_M_DRIVER_BLOCK DriverP
    );
--*/
#define NdisReferenceDriver(DriverP) \
    NdisReferenceRef(&(DriverP)->Ref)


VOID
NdisDereferenceDriver(
    PNDIS_M_DRIVER_BLOCK DriverP
    );

BOOLEAN
NdisQueueMiniportOnDriver(
    PNDIS_MINIPORT_BLOCK MiniportP,
    PNDIS_M_DRIVER_BLOCK DriverP
    );

VOID
NdisDequeueMiniportOnDriver(
    PNDIS_MINIPORT_BLOCK MiniportP,
    PNDIS_M_DRIVER_BLOCK DriverP
    );

BOOLEAN
NdisQueueOpenOnMiniport(
    PNDIS_M_OPEN_BLOCK OpenP,
    PNDIS_MINIPORT_BLOCK MiniportP
    );

VOID
NdisKillMiniport(
    PNDIS_MINIPORT_BLOCK OldMiniportP
    );

/*++
BOOLEAN
NdisReferenceMiniport(
    IN PNDIS_MINIPORT_BLOCK MiniportP
    );
--*/
#define NdisReferenceMiniport(MiniportP) \
    NdisReferenceRef(&(MiniportP)->Ref)

VOID
NdisDereferenceMiniport(
    PNDIS_MINIPORT_BLOCK MiniportP
    );

VOID
NdisDeQueueOpenOnMiniport(
    PNDIS_M_OPEN_BLOCK OpenP,
    PNDIS_MINIPORT_BLOCK MiniportP
    );

VOID
MiniportInitializePackage(
    VOID
    );

VOID
MiniportReferencePackage(
    VOID
    );

VOID
MiniportDereferencePackage(
    VOID
    );

NDIS_STATUS ArcConvertOidListToEthernet(
    IN  PNDIS_OID   pOidList,
    IN  PULONG      pcbOidList,
    IN  PNDIS_OID   pTmpBuffer
);

VOID
NdisBugcheckHandler(
    IN PNDIS_WRAPPER_CONTEXT WrapperContext,
    IN ULONG Size
    );