windows-nt/Source/XPSP1/NT/net/rras/ndis/ndiswan/wandefs.h
2020-09-26 16:20:57 +08:00

1025 lines
38 KiB
C

/*++
Copyright (c) 1990-1995 Microsoft Corporation
Module Name:
Wandefs.h
Abstract:
This file contains defines for the NdisWan driver.
Author:
Tony Bell (TonyBe) June 06, 1995
Environment:
Kernel Mode
Revision History:
TonyBe 06/06/95 Created
--*/
#ifndef _NDISWAN_DEFS_
#define _NDISWAN_DEFS_
//
// This needs to be added into ndis.h
//
#define SAP_TYPE_NDISWAN_PPP 0x00000004
//
// Device class currently used by RAS to query TAPI
// miniports for the connection wrapper ID
//
#define DEVICECLASS_NDISWAN_SAP L"NDIS"
//
// Define if we are going to pull the miniport name out of
// an ndis wrapper control structure!!!!!! (kinda dirty)
//
#define MINIPORT_NAME 1
//
// Version stuff
//
#define NDISWAN_MAJOR_VERSION 5
#define NDISWAN_MINOR_VERSION 0
//
// Maximum number of protocols we can support
//
#define MAX_PROTOCOLS 32
//
// Identifiers for protocol type being added to the
// protocol lookup table
//
#define PROTOCOL_TYPE 0
#define PPP_TYPE 1
//
// Flags for Send packet properties
//
#define SEND_ON_WIRE 0x00000001
#define SELF_DIRECTED 0x00000002
#define MAC_HEADER_LENGTH 14
#define PROTOCOL_HEADER_LENGTH 128
//
// Maximum length possible for a ppp header
// No addr/ctrl comp (2)
// No proto id comp
// multilink large sequence #'s (6)
// MPPC/MPPE (6)
// Protocol (2)
//
#define MAX_PPP_HEADER_LENGTH 14
// No addr/ctrl comp (4)
// No proto id comp
// multilink large sequence #'s (6)
// MPPC/MPPE (6)
// Protocol (2)
//
#define MAX_PPP_LLC_HEADER_LENGTH 16
//
// Known protocol ID's
//
#define PROTOCOL_PRIVATE_IO 0xAB00
#define PROTOCOL_IP 0x0800
#define PROTOCOL_IPX 0x8137
#define PROTOCOL_NBF 0x80D5
#define PROTOCOL_APPLETALK 0x80F3
//
// Returned from protocol table lookup if value is
// not found
//
#define RESERVED_PROTOCOLCB (IntToPtr(0xFFFFFFFF))
//
// OID Masks
//
#define OID_GEN 0x00000000
#define OID_CO_GEN 0x00000000
#define OID_802_3 0x01000000
#define OID_WAN 0x04000000
#define OID_PNP 0xFD000000
#define OID_QOS 0xFB000000
#define DEFAULT_MRU 1614
#define DEFAULT_MRRU 1614
#define DEFAULT_TUNNEL_MTU 1400
#define MAX_RECVDESC_COUNT 64
//
// Known PPP protocol ID's
//
#define PPP_PROTOCOL_PRIVATE_IO 0x00AB
#define PPP_PROTOCOL_IP 0x0021
#define PPP_PROTOCOL_APPLETALK 0x0029
#define PPP_PROTOCOL_UNCOMPRESSED_TCP 0x002F
#define PPP_PROTOCOL_COMPRESSED_TCP 0x002D
#define PPP_PROTOCOL_IPX 0x002B
#define PPP_PROTOCOL_NBF 0x003F
#define PPP_PROTOCOL_COMPRESSION 0x00FD
#define PPP_PROTOCOL_COMP_RESET 0x80FD
//
//
//
#define DEFAULT_MTU 1500
#define MAX_OUTSTANDING_PACKETS 10
#define ONE_HUNDRED_MILS 1000000
#define ONE_SECOND 10000000
#define TEN_SECONDS 100000000
#define MILS_TO_100NANOS 10000
#define SAMPLE_ARRAY_SIZE 10
#define DEFAULT_PACKETQUEUE_DEPTH 128*1024
#define DEFAULT_MIN_FRAG_SIZE 64
//
// Multilink defines
//
#define MULTILINK_BEGIN_FRAME 0x80
#define MULTILINK_END_FRAME 0x40
#define MULTILINK_COMPLETE_FRAME 0xC0
#define MULTILINK_FLAG_MASK 0xC0
#define MULTILINK_HOLE_FLAG 0x01
#define SHORT_SEQ_MASK 0x0FFF
#define TEST_SHORT_SEQ 0x0800
#define LONG_SEQ_MASK 0x0FFFFFF
#define TEST_LONG_SEQ 0x00800000
#define MCML_SHORTCLASS_MASK 0x30
#define MCML_LONGCLASS_MASK 0x3C
#define MAX_MCML 1
//
// Memory tags
//
#define BUNDLECB_TAG 'AnaW'
#define LINKPROTOCB_TAG 'BnaW'
#define SMALLDATADESC_TAG 'CnaW'
#define MEDIUMDATADESC_TAG 'DnaW'
#define LARGEDATADESC_TAG 'EnaW'
#define WANREQUEST_TAG 'FnaW'
#define LOOPBACKDESC_TAG 'GnaW'
#define VJCOMPRESS_TAG 'HnaW'
#define MINIPORTCB_TAG 'InaW'
#define OPENCB_TAG 'JnaW'
#define IOPACKET_TAG 'KnaW'
#define LINEUPINFO_TAG 'Lnaw'
#define NDISSTRING_TAG 'MnaW'
#define PROTOCOLTABLE_TAG 'NnaW'
#define CONNECTIONTABLE_TAG 'OnaW'
#define POOLDESC_TAG 'PnaW'
#define DATABUFFER_TAG 'QnaW'
#define WANPACKET_TAG 'RnaW'
#define AFSAPVCCB_TAG 'SnaW'
#define TRANSDRV_TAG 'TnaW'
#define BONDALLOC_TAG 'UnaW'
#define ENCRYPTCTX_TAG 'VnaW'
#define COMPCTX_TAG 'XnaW'
#define PROTOCOLCB_TAG 'ZnaW'
#define CACHEDKEY_TAG 'ANaW'
#if DBG
#define DBGPACKET_TAG 'znaW'
#define WANTRCEVENT_TAG 'ynaW'
#endif
#define RECVDESC_SIG 'vceR'
#define SENDESC_SIG 'dneS'
#define CLAFSAP_SIG ' lC'
#define CMAFSAP_SIG ' mC'
#define CMVC_SIG 'cVmC'
#define LINKCB_SIG 'kniL'
#define PROTOCB_SIG 'torP'
#define SEQ_EQ(_a, _b) ((int)((_a) - (_b)) == 0)
#define SEQ_LT(_a, _b, _t) (!SEQ_EQ(_a, _b) && ((int)((_a) - (_b)) & _t))
#define SEQ_LTE(_a, _b, _t) (SEQ_EQ(_a, _b) || ((int)((_a) - (_b)) & _t))
#define SEQ_GT(_a, _b, _t) (!SEQ_EQ(_a, _b) && !((int)((_a) - (_b)) & _t))
#define SEQ_GTE(_a, _b, _t) (SEQ_EQ(_a, _b) || !((int)((_a) - (_b)) & _t))
//
// Link State's
//
typedef enum _LinkState {
LINK_DOWN,
LINK_GOING_DOWN,
LINK_UP
} LinkState;
//
// Bundle State's
//
typedef enum _BundleState {
BUNDLE_DOWN,
BUNDLE_GOING_DOWN,
BUNDLE_UP
} BundleState;
//
// Protocol State's
//
typedef enum _ProtocolState {
PROTOCOL_UNROUTED,
PROTOCOL_UNROUTING,
PROTOCOL_ROUTING,
PROTOCOL_ROUTED
} ProtocolState;
//
// Cm Vc State's
//
typedef enum _CmVcState {
CMVC_CREATED,
CMVC_ACTIVE,
CMVC_CLOSE_DISPATCHED,
CMVC_CLOSING,
CMVC_DEACTIVE
} CmVcState;
typedef enum _ClCallState {
CL_CALL_CLOSED,
CL_CALL_CLOSE_PENDING,
CL_CALL_CONNECTED
} ClCallState;
typedef enum _TransDrvState {
TRANSDRV_OPENING,
TRANSDRV_REGISTERING,
TRANSDRV_OPENED,
TRANSDRV_CLOSED
} TransDrvState;
//
// Wan request types
//
typedef enum _WanRequestType {
ASYNC,
SYNC
} WanRequestType;
typedef enum _WanRequestOrigin {
NDISWAN,
NDISTAPI
} WanRequestOrigin;
typedef enum _RECV_TYPE {
RECV_LINK,
RECV_BUNDLE_PPP,
RECV_BUNDLE_DATA
} RECV_TYPE;
typedef enum _SEND_TYPE {
SEND_LINK,
SEND_BUNDLE_PPP,
SEND_BUNDLE_DATA
} SEND_TYPE;
typedef enum _BandwidthOnDemandState {
BonDSignaled,
BonDIdle,
BonDMonitor
} BandwithOnDemandState;
#ifdef CHECK_BUNDLE_LOCK
#define AcquireBundleLock(_pbcb) \
{ \
NdisAcquireSpinLock(&(_pbcb)->Lock); \
ASSERT(!(_pbcb)->LockAcquired); \
(_pbcb)->LockLine = __LINE__; \
(_pbcb)->LockFile = __FILE_SIG__; \
(_pbcb)->LockAcquired = TRUE; \
}
#define ReleaseBundleLock(_pbcb) \
{ \
(_pbcb)->LockLine = __LINE__; \
(_pbcb)->LockAcquired = FALSE; \
NdisReleaseSpinLock(&(_pbcb)->Lock); \
}
#else
#define AcquireBundleLock(_pbcb) \
NdisAcquireSpinLock(&(_pbcb)->Lock)
#define ReleaseBundleLock(_pbcb) \
NdisReleaseSpinLock(&(_pbcb)->Lock)
#endif
#define REF_NDISWANCB()\
InterlockedIncrement(&NdisWanCB.RefCount)
#define DEREF_NDISWANCB() \
NdisWanInterlockedDec(&NdisWanCB.RefCount)
#define REF_BUNDLECB(_pbcb) \
{ \
(_pbcb)->RefCount++; \
}
//
// Decrement the reference count on the bundle. If the count
// goes to zero we need to remove the bundle from the connection
// table and free it.
//
#define DEREF_BUNDLECB(_pbcb) \
{ \
if ((_pbcb) != NULL) { \
AcquireBundleLock(_pbcb); \
ASSERT((_pbcb)->RefCount > 0); \
if (--(_pbcb)->RefCount == 0) { \
DoDerefBundleCBWork(_pbcb); \
} else { \
ReleaseBundleLock(_pbcb); \
} \
} \
}
//
// Decrement the reference count on the bundle. If the count
// goes to zero we need to remove the bundle from the connection
// table and free it.
//
// Called with BundleCB->Lock held but returns with it released!
//
#define DEREF_BUNDLECB_LOCKED(_pbcb) \
{ \
if ((_pbcb) != NULL) { \
ASSERT((_pbcb)->RefCount > 0); \
if (--(_pbcb)->RefCount == 0) { \
DoDerefBundleCBWork(_pbcb); \
} else { \
ReleaseBundleLock(_pbcb); \
} \
} \
}
#define REF_LINKCB(_plcb) \
{ \
ASSERT((_plcb)->RefCount > 0); \
(_plcb)->RefCount++; \
}
//
// Decrement the reference count on the link. If the count
// goes to zero we need to remove the link from the connection
// table and free it.
//
#define DEREF_LINKCB(_plcb) \
{ \
if ((_plcb) != NULL) { \
NdisAcquireSpinLock(&(_plcb)->Lock); \
ASSERT((_plcb)->RefCount > 0); \
if (--(_plcb)->RefCount == 0) { \
DoDerefLinkCBWork(_plcb); \
} else { \
NdisReleaseSpinLock(&(_plcb)->Lock); \
} \
} \
}
//
// Decrement the reference count on the link. If the count
// goes to zero we need to remove the link from the connection
// table and free it.
//
// Called with LinkCB->Lock held but returns with it released!
//
#define DEREF_LINKCB_LOCKED(_plcb) \
{ \
if ((_plcb) != NULL) { \
PBUNDLECB _pbcb = (_plcb)->BundleCB; \
ASSERT((_plcb)->RefCount > 0); \
if (--(_plcb)->RefCount == 0) { \
DoDerefLinkCBWork(_plcb); \
} else { \
NdisReleaseSpinLock(&(_plcb)->Lock); \
} \
} \
}
#define REF_PROTOCOLCB(_ppcb) \
{ \
ASSERT((_ppcb)->RefCount > 0); \
(_ppcb)->RefCount++; \
}
#define DEREF_PROTOCOLCB(_ppcb) \
{ \
ASSERT((_ppcb)->RefCount > 0); \
if (--(_ppcb)->RefCount == 0) { \
ASSERT((_ppcb)->OutstandingFrames == 0); \
ASSERT((_ppcb)->State == PROTOCOL_UNROUTING); \
NdisWanSetSyncEvent(&(_ppcb)->UnrouteEvent); \
RemoveProtocolCBFromBundle(ProtocolCB); \
} \
}
#define REF_OPENCB(_pocb) \
InterlockedIncrement(&(_pocb)->RefCount)
#define DEREF_OPENCB(_pocb) \
{ \
if (InterlockedDecrement(&(_pocb)->RefCount) == 0) { \
NdisAcquireSpinLock(&(_pocb)->Lock); \
ProtoCloseWanAdapter(_pocb); \
} \
}
#define REF_MINIPORTCB(_pmcb) \
InterlockedIncrement(&(_pmcb)->RefCount)
#define DEREF_MINIPORTCB(_pmcb) \
{ \
if (InterlockedDecrement(&(_pmcb)->RefCount) == 0) { \
NdisWanFreeMiniportCB(_pmcb); \
} \
}
#define REF_CMVCCB(_pvccb) \
InterlockedIncrement(&(_pvccb)->RefCount)
#define DEREF_CMVCCB(_pvccb) \
{ \
if (InterlockedDecrement(&(_pvccb)->RefCount) == 0) { \
DoDerefCmVcCBWork(_pvccb); \
} \
}
#define REF_CLAFSAPCB(_pclaf) \
(_pclaf)->RefCount++;
#define DEREF_CLAFSAPCB(_pclaf) \
{ \
NdisAcquireSpinLock(&((_pclaf)->Lock)); \
if (--(_pclaf)->RefCount == 0) { \
DoDerefClAfSapCBWork(_pclaf); \
} else { \
NdisReleaseSpinLock(&((_pclaf)->Lock)); \
} \
}
#define DEREF_CLAFSAPCB_LOCKED(_pclaf) \
{ \
if (--(_pclaf)->RefCount == 0) { \
DoDerefClAfSapCBWork(_pclaf); \
} else { \
NdisReleaseSpinLock(&((_pclaf)->Lock)); \
} \
}
#define BUNDLECB_FROM_LINKCB(_ppbcb, _plcb) \
{ \
*(_ppbcb) = (PBUNDLECB)_plcb->BundleCB; \
}
#define BUNDLECB_FROM_BUNDLEH(_ppbcb, _bh) \
{ \
LOCK_STATE _ls; \
PBUNDLECB _bcb = NULL; \
NdisAcquireReadWriteLock(&ConnTableLock, FALSE, &_ls); \
if ((ULONG_PTR)(_bh) <= ConnectionTable->ulArraySize) { \
_bcb = *(ConnectionTable->BundleArray + (ULONG_PTR)(_bh));\
} \
if (_bcb != NULL) { \
NdisDprAcquireSpinLock(&(_bcb)->Lock); \
REF_BUNDLECB(_bcb); \
NdisDprReleaseSpinLock(&(_bcb)->Lock); \
} \
NdisReleaseReadWriteLock(&ConnTableLock, &_ls); \
*(_ppbcb) = _bcb; \
}
#define LINKCB_FROM_LINKH(_pplcb, _lh) \
{ \
LOCK_STATE _ls; \
PLINKCB _lcb = NULL; \
NdisAcquireReadWriteLock(&ConnTableLock, FALSE, &_ls); \
if ((ULONG_PTR)(_lh) <= ConnectionTable->ulArraySize) { \
_lcb = *(ConnectionTable->LinkArray + (ULONG_PTR)(_lh));\
} \
if (_lcb != NULL) { \
NdisDprAcquireSpinLock(&(_lcb)->Lock); \
REF_LINKCB(_lcb); \
NdisDprReleaseSpinLock(&(_lcb)->Lock); \
} \
NdisReleaseReadWriteLock(&ConnTableLock, &_ls); \
*(_pplcb) = _lcb; \
}
#define InsertTailGlobalList(_gl, _ple) \
{ \
NdisAcquireSpinLock(&(_gl.Lock)); \
InsertTailList(&(_gl.List), (_ple)); \
_gl.ulCount++; \
if (_gl.ulCount > _gl.ulMaxCount) { \
_gl.ulMaxCount = _gl.ulCount; \
} \
NdisReleaseSpinLock(&(_gl.Lock)); \
}
#define InsertTailGlobalListEx(_gl, _ple, _t, _pt) \
{ \
NdisAcquireSpinLock(&(_gl.Lock)); \
InsertTailList(&(_gl.List), (_ple)); \
_gl.ulCount++; \
if (_gl.ulCount > _gl.ulMaxCount) { \
_gl.ulMaxCount = _gl.ulCount; \
} \
if (!_gl.TimerScheduled) { \
LARGE_INTEGER _ft; \
_gl.TimerScheduled = TRUE; \
_ft.QuadPart = Int32x32To64(_t, -10000); \
KeSetTimerEx(&_gl.Timer, _ft, _pt, &_gl.Dpc); \
} \
NdisReleaseSpinLock(&(_gl.Lock)); \
}
#define InsertHeadGlobalList(_gl, _ple) \
{ \
NdisAcquireSpinLock(&(_gl.Lock)); \
InsertHeadList(&(_gl.List), (_ple)); \
_gl.ulCount++; \
if (_gl.ulCount > _gl.ulMaxCount) { \
_gl.ulMaxCount = _gl.ulCount; \
} \
NdisReleaseSpinLock(&(_gl.Lock)); \
}
#define InsertHeadGlobalListEx(_gl, _ple, _t, _pt) \
{ \
NdisAcquireSpinLock(&(_gl.Lock)); \
InsertHeadList(&(_gl.List), (_ple)); \
_gl.ulCount++; \
if (_gl.ulCount > _gl.ulMaxCount) { \
_gl.ulMaxCount = _gl.ulCount; \
} \
if (!_gl.TimerScheduled) { \
LARGE_INTEGER _ft; \
_gl.TimerScheduled = TRUE; \
_ft.QuadPart = Int32x32To64(_t, -10000); \
KeSetTimerEx(&_gl.Timer, _ft, _pt, &_gl.Dpc); \
} \
NdisReleaseSpinLock(&(_gl.Lock)); \
}
#define RemoveHeadGlobalList(_gl, _pple) \
{ \
NdisAcquireSpinLock(&(_gl.Lock)); \
*(_pple) = RemoveHeadList(&(_gl.List)); \
_gl.ulCount--; \
NdisReleaseSpinLock(&(_gl.Lock)); \
}
#define RemoveEntryGlobalList(_gl, _ple) \
{ \
NdisAcquireSpinLock(&(_gl.Lock)); \
RemoveEntryList(_ple); \
_gl.ulCount--; \
NdisReleaseSpinLock(&(_gl.Lock)); \
}
#if 0
//
// The Remote address (DEST address) is what we use to mutilplex
// sends across our single adapter/binding context. The address
// has the following format:
//
// XX XX YY YY YY YY
//
// XX = Randomly generated OUI
// YY = ProtocolCB
//
#define FillNdisWanHdrContext(_pAddr, _ppcb) \
*((ULONG UNALIGNED*)(&_pAddr[2])) = *((ULONG UNALIGNED*)(&_ppcb))
#define GetNdisWanHdrContext(_pAddr, _pppcb) \
*((ULONG UNALIGNED*)(_pppcb)) = *((ULONG UNALIGNED*)(&_pAddr[2]))
#endif
//
// The Remote address (DEST address) is what we use to mutilplex
// sends across our single adapter/binding context. The address
// has the following format:
//
// XX XX XX YY YY ZZ
//
// XX = Randomly generated OUI
// YY = Index into the active bundle connection table to get bundlecb
// ZZ = Index into the protocol table of a bundle to get protocolcb
//
#define FillNdisWanIndices(_pAddr, _bI, _pI) \
{ \
_pAddr[3] = (UCHAR)((USHORT)_bI >> 8); \
_pAddr[4] = (UCHAR)_bI; \
_pAddr[5] = (UCHAR)_pI; \
}
#define GetNdisWanIndices(_pAddr, _bI, _pI) \
{ \
_bI = ((USHORT)_pAddr[3] << 8) | _pAddr[4]; \
_pI = _pAddr[5]; \
ASSERT(_pI < MAX_PROTOCOLS); \
}
//
// In the Src address (from a NdisSend) the bundle index
// is stashed in the two high order bytes as shown below
// with the mask of valid bits given by the x's. The
// high byte is shifted to the left one bit so the number
// of possible bundles is now 0x7FFF
//
// XX XX YY YY YY YY
//
// XX = Bytes described below owned by NdisWan
// YY = Transports Receive context
//
// 0 1
// 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
// x x x x x x x 0 x x x x x x x x
//
#define FillTransportBundleIndex(_pAddr, _Index) \
{ \
_pAddr[0] = (UCHAR)((USHORT)_Index >> 7) & 0xFE; \
_pAddr[1] = (UCHAR)_Index; \
}
#define GetTransportBundleIndex(_pAddr) \
(((USHORT)_pAddr[0] << 7) & 0x7F) | _pAddr[1]
#define GetProtocolCBFromProtocolList(_pl, _pt, _pppcb) \
{ \
PPROTOCOLCB _pP; \
for (_pP = (PPROTOCOLCB)(_pl)->Flink; \
(PLIST_ENTRY)_pP != _pl; \
_pP = (PPROTOCOLCB)(_pP)->Linkage.Flink) { \
\
if (_pP->ProtocolType == _pt) { \
*(_pppcb) = _pP; \
break; \
} \
} \
if ((PVOID)_pP == (PVOID)_pl) { \
*(_pppcb) = NULL; \
} \
}
#define PROTOCOLCB_FROM_PROTOCOLH(_pBCB, _pPCB, _hP) \
{ \
if (_hP < MAX_PROTOCOLS) { \
_pPCB = _pBCB->ProtocolCBTable[_hP]; \
} else { \
_pPCB = NULL; \
} \
}
#define NetToHostShort(_ns) ( ((_ns & 0x00FF) << 8) | ((_ns & 0xFF00) >> 8) )
#define HostToNetShort(_hs) ( ((_hs & 0x00FF) << 8) | ((_hs & 0xFF00) >> 8) )
#define IsLinkSendWindowOpen(_plcb) \
((_plcb)->SendWindow > (_plcb)->OutstandingFrames)
#define IsSampleTableFull(_pST) ((_pST)->ulSampleCount == (_pST)->ulSampleArraySize)
#define IsSampleTableEmpty(_pST) ((_pST)->ulSampleCount == 0)
#define PMINIPORT_RESERVED_FROM_NDIS(_packet) \
((PNDISWAN_MINIPORT_RESERVED)((_packet)->MiniportReserved))
#define PPROTOCOL_RESERVED_FROM_NDIS(_packet) \
((PNDISWAN_PROTOCOL_RESERVED)((_packet)->ProtocolReserved))
#define PRECV_RESERVED_FROM_NDIS(_packet) \
((PNDISWAN_RECV_RESERVED)((_packet)->ProtocolReserved))
#define IsCompleteFrame(_fl) \
((_fl & MULTILINK_BEGIN_FRAME) && (_fl & MULTILINK_END_FRAME))
#define AddPPPProtocolID(_finf, _usID) \
{ \
PUCHAR _cp = _finf->ProtocolID.Pointer; \
if (_finf->ProtocolID.Length != 0) { \
ASSERT(_cp); \
if (!(_finf->FramingBits & PPP_COMPRESS_PROTOCOL_FIELD) || \
(_finf->Flags & (DO_COMPRESSION | DO_ENCRYPTION))) { \
*_cp++ = (UCHAR)(_usID >> 8); \
} \
*_cp = (UCHAR)_usID; \
} \
}
#define AddMultilinkInfo(_finf, _f, _seq, _mask) \
{ \
PUCHAR _cp = _finf->Multilink.Pointer; \
if (_finf->Multilink.Length != 0) { \
ASSERT(_cp); \
if (!(_finf->FramingBits & PPP_COMPRESS_PROTOCOL_FIELD)) { \
_cp++; \
} \
_cp++; \
_seq &= _mask; \
if (_finf->FramingBits & PPP_SHORT_SEQUENCE_HDR_FORMAT) { \
*_cp++ = _f | (UCHAR)(_finf->Class << 4) | (UCHAR)((_seq >> 8) & SHORT_SEQ_MASK); \
*_cp++ = (UCHAR)_seq; \
} else { \
*_cp++ = _f | (UCHAR)(_finf->Class << 2); \
*_cp++ = (UCHAR)(_seq >> 16); \
*_cp++ = (UCHAR)(_seq >> 8); \
*_cp = (UCHAR)_seq; \
} \
} \
}
#define AddCompressionInfo(_finf, _usCC) \
{ \
PUCHAR _cp = _finf->Compression.Pointer; \
if (_finf->Compression.Length != 0) { \
ASSERT(_cp); \
if (!(_finf->FramingBits & PPP_COMPRESS_PROTOCOL_FIELD)) { \
_cp++; \
} \
_cp++; \
*_cp++ = (UCHAR)(_usCC >> 8); \
*_cp = (UCHAR)_usCC; \
} \
}
#define UpdateFramingInfo(_finf, _pd) \
{ \
PUCHAR _sdb = (_pd); \
(_finf)->AddressControl.Pointer = (_sdb); \
(_sdb) += (_finf)->AddressControl.Length; \
(_finf)->Multilink.Pointer = (_sdb); \
(_sdb) += (_finf)->Multilink.Length; \
(_finf)->Compression.Pointer = (_sdb); \
(_sdb) += (_finf)->Compression.Length; \
(_finf)->ProtocolID.Pointer = (_sdb); \
}
#define NdisWanChangeMiniportAddress(_a, _addr) \
{ \
PNDIS_MINIPORT_BLOCK Miniport; \
\
Miniport = (PNDIS_MINIPORT_BLOCK)((_a)->MiniportHandle); \
ETH_COPY_NETWORK_ADDRESS(Miniport->EthDB->AdapterAddress, _addr); \
}
//
// Queue routines for the ProtocolCB's NdisPacket queues
//
#define InsertHeadPacketQueue(_ppq, _pnp, _pl) \
{ \
PMINIPORT_RESERVED_FROM_NDIS(_pnp)->Next = \
(_ppq)->HeadQueue; \
if ((_ppq)->HeadQueue == NULL) { \
(_ppq)->TailQueue = _pnp; \
} \
(_ppq)->HeadQueue = _pnp; \
(_ppq)->ByteDepth += (_pl-14); \
(_ppq)->PacketDepth += 1; \
if ((_ppq)->PacketDepth > (_ppq)->MaxPacketDepth) { \
(_ppq)->MaxPacketDepth = (_ppq)->PacketDepth; \
} \
}
#define InsertTailPacketQueue(_ppq, _pnp, _pl) \
{ \
PMINIPORT_RESERVED_FROM_NDIS(_pnp)->Next = NULL;\
if ((_ppq)->HeadQueue == NULL) { \
(_ppq)->HeadQueue = _pnp; \
} else { \
PMINIPORT_RESERVED_FROM_NDIS((_ppq)->TailQueue)->Next = _pnp; \
} \
(_ppq)->TailQueue = _pnp; \
(_ppq)->ByteDepth += (_pl-14); \
(_ppq)->PacketDepth += 1; \
if ((_ppq)->PacketDepth > (_ppq)->MaxPacketDepth) { \
(_ppq)->MaxPacketDepth = (_ppq)->PacketDepth; \
} \
}
#define RemoveHeadPacketQueue(_ppq) \
(_ppq)->HeadQueue; \
{ \
PNDIS_PACKET _cp = (_ppq)->HeadQueue; \
PNDIS_PACKET _np = \
PMINIPORT_RESERVED_FROM_NDIS(_cp)->Next; \
if (_np == NULL) { \
(_ppq)->TailQueue = NULL; \
} \
(_ppq)->HeadQueue = _np; \
(_ppq)->ByteDepth -= ((_cp)->Private.TotalLength-14); \
(_ppq)->PacketDepth -= 1; \
}
#define IsPacketQueueEmpty(_ppq) ((_ppq)->HeadQueue == NULL)
#define NdisWanDoReceiveComplete(_pa) \
{ \
NdisReleaseSpinLock(&(_pa)->Lock); \
NdisMEthIndicateReceiveComplete((_pa)->MiniportHandle); \
NdisAcquireSpinLock(&(_pa)->Lock); \
}
//
// OS specific code
//
#ifdef NT
//
// NT stuff
//
#define NdisWanInitializeNotificationEvent(_pEvent) \
KeInitializeEvent(_pEvent, NotificationEvent, FALSE)
#define NdisWanSetNotificationEvent(_pEvent) \
KeSetEvent(_pEvent, 0, FALSE)
#define NdisWanClearNotificationEvent(_pEvent) \
KeClearEvent(_pEvent)
#define NdisWanWaitForNotificationEvent(_pEvent) \
KeWaitForSingleObject(_pEvent, Executive, KernelMode, TRUE, NULL)
#define NdisWanInitializeSyncEvent(_pEvent) \
KeInitializeEvent(_pEvent, SynchronizationEvent, FALSE)
#define NdisWanSetSyncEvent(_pEvent) \
KeSetEvent(_pEvent, 1, FALSE)
#define NdisWanClearSyncEvent(_pEvent) \
KeClearEvent(_pEvent)
#define NdisWanWaitForSyncEvent(_pEvent) \
KeWaitForSingleObject(_pEvent, UserRequest, KernelMode, FALSE, NULL)
#if 0
#if DBG && !defined(_WIN64)
#define CheckDataBufferList(_e) \
{ \
PSINGLE_LIST_ENTRY _le; \
KIRQL _irql; \
KeAcquireSpinLock(&DataBufferList.Lock, &_irql); \
_le = DataBufferList.L.ListHead.Next.Next; \
while (_le != NULL) { \
if ((PSINGLE_LIST_ENTRY)_e == _le) { \
DbgPrint("NDISWAN: Corrupt DataBufferList Free!\n"); \
DbgPrint("NDISWAN: List %x Entry %x\n", &DataBufferList, _e);\
DbgBreakPoint(); \
} \
_le = _le->Next; \
} \
KeReleaseSpinLock(&DataBufferList.Lock, _irql); \
}
#else
#define CheckDataBufferList(_e)
#endif
#endif
#if 0
#define NdisWanFreeDataBuffer(_e) \
{ \
NdisFreeToNPagedLookasideList(&DataBufferList, _e); \
}
#define NdisWanAllocateDataBuffer() \
NdisAllocateFromNPagedLookasideList(&DataBufferList)
#endif
#define NdisWanAllocateMemory(_AllocatedMemory, _Size, _t) \
{ \
(PVOID)*(_AllocatedMemory) = (PVOID)ExAllocatePoolWithTag(NonPagedPool, _Size, _t); \
if ((PVOID)*(_AllocatedMemory) != NULL) { \
NdisZeroMemory((PUCHAR)*(_AllocatedMemory), _Size); \
} \
}
#define NdisWanAllocatePriorityMemory(_AllocatedMemory, _Size, _t, _p) \
{ \
(PVOID)*(_AllocatedMemory) = (PVOID)ExAllocatePoolWithTagPriority(NonPagedPool, _Size, _t, _p);\
if ((PVOID)*(_AllocatedMemory) != NULL) { \
NdisZeroMemory((PUCHAR)*(_AllocatedMemory), _Size); \
} \
}
#define NdisWanFreeMemory(_AllocatedMemory) \
ExFreePool(_AllocatedMemory)
#define NdisWanAllocateNdisBuffer(_ppnb, _pd, _dl) \
{ \
NDIS_STATUS _s; \
NdisAllocateBuffer(&(_s), _ppnb, NULL, _pd, _dl); \
if (_s != NDIS_STATUS_SUCCESS) { \
*(_ppnb) = NULL; \
} \
}
#define NdisWanFreeNdisBuffer(_pnb) NdisFreeBuffer(_pnb)
#define NdisWanMoveMemory(_Dest, _Src, _Length) \
RtlMoveMemory(_Dest, _Src, _Length)
#define NdisWanGetSystemTime(_pTime) \
{ \
LARGE_INTEGER _tc; \
ULONG _ti; \
KeQueryTickCount(&_tc); \
_ti = KeQueryTimeIncrement(); \
(_pTime)->QuadPart = _tc.QuadPart * _ti; \
}
#define NdisWanCalcTimeDiff(_pDest, _pEnd, _pBegin) \
(_pDest)->QuadPart = (_pEnd)->QuadPart - (_pBegin)->QuadPart
#define NdisWanInitWanTime(_pTime, _Val) \
(_pTime)->QuadPart = _Val
#define NdisWanMultiplyWanTime(_pDest, _pMulti1, _pMulti2) \
(_pDest)->QuadPart = (_pMulti1)->QuadPart * (_pMulti2)->QuadPart
#define NdisWanDivideWanTime(_pDest, _pDivi1, _pDivi2) \
(_pDest)->QuadPart = (_pDivi1)->QuadPart / (_pDivi2)->QuadPart
#define NdisWanIsTimeDiffLess(_pTime1, _pTime2) \
((_pTime1)->QuadPart < (_pTime2)->QuadPart)
#define NdisWanIsTimeDiffGreater(_pTime1, _pTime2) \
((_pTime1)->QuadPart > (_pTime2)->QuadPart)
#define NdisWanIsTimeEqual(_pTime1, _pTime2) \
((_pTime1)->QuadPart == (_pTime2)->QuadPart)
#define NdisWanUppercaseNdisString(_pns1, _pns2, _b) \
RtlUpcaseUnicodeString(_pns1, _pns2, _b)
#define MDL_ADDRESS(_MDL_) MmGetSystemAddressForMdl(_MDL_)
#define NdisWanInterlockedInc(_pul) \
InterlockedIncrement(_pul)
#define NdisWanInterlockedDec(_pul) \
InterlockedDecrement(_pul)
#define NdisWanInterlockedExchange(_pul, _ul) \
InterlockedExchange(_pul, _ul)
#define NdisWanInterlockedExchangeAdd(_pul, _ul) \
InterlockedExchangeAdd(_pul, _ul)
#define NdisWanInterlockedInsertTailList(_phead, _pentry, _plock) \
ExInterlockedInsertTailList(_phead, _pentry, _plock)
#define NdisWanInterlockedInsertHeadList(_phead, _pentry, _plock) \
ExInterlockedInsertHeadList(_phead, _pentry, _plock)
#define NdisWanInterlockedRemoveHeadList(_phead, _plock) \
ExInterlockedRemoveHeadList(_phead, _plock)
#define NdisWanRaiseIrql(_pirql) \
KeRaiseIrql(DISPATCH_LEVEL, _pirql)
#define NdisWanLowerIrql(_irql) \
KeLowerIrql(_irql)
//
// Wait for event structure. Used for async completion notification.
//
typedef KEVENT WAN_EVENT;
typedef WAN_EVENT *PWAN_EVENT;
typedef LARGE_INTEGER WAN_TIME;
typedef WAN_TIME *PWAN_TIME;
typedef KIRQL WAN_IRQL;
typedef WAN_IRQL *PWAN_IRQL;
#else // end NT stuff
//
// Win95 stuff
//
typedef ULONG WAN_TIME;
typedef WAN_TIME *PWAN_TIME;
#endif // end of Win95 stuff
#endif // end of _NDISWAN_DEFS_