include/ddk/ndiswan.h

   1 /*
   2  * ndiswan.h
   3  *
   4  * Definitions for NDIS WAN miniport drivers
   5  *
   6  * This file is part of the w32api package.
   7  *
   8  * Contributors:
   9  *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10  *
  11  * THIS SOFTWARE IS NOT COPYRIGHTED
  12  *
  13  * This source code is offered for use in the public domain. You may
  14  * use, modify or distribute it freely.
  15  *
  16  * This code is distributed in the hope that it will be useful but
  17  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18  * DISCLAIMED. This includes but is not limited to warranties of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20  *
  21  */
  22
  23 #ifndef __NDISWAN_H
  24 #define __NDISWAN_H
  25
  26 #include "ndis.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 #define NDIS_USE_WAN_WRAPPER                            0x00000001
  33
  34 #define NDIS_STATUS_TAPI_INDICATION                     ((NDIS_STATUS)0x40010080L)
  35
  36 /* NDIS_WAN_INFO.FramingBits constants */
  37 #define RAS_FRAMING                     0x00000001
  38 #define RAS_COMPRESSION                 0x00000002
  39
  40 #define ARAP_V1_FRAMING                 0x00000004
  41 #define ARAP_V2_FRAMING                 0x00000008
  42 #define ARAP_FRAMING                    (ARAP_V1_FRAMING | ARAP_V2_FRAMING)
  43
  44 #define PPP_MULTILINK_FRAMING           0x00000010
  45 #define PPP_SHORT_SEQUENCE_HDR_FORMAT   0x00000020
  46 #define PPP_MC_MULTILINK_FRAMING        0x00000040
  47
  48 #define PPP_FRAMING                     0x00000100
  49 #define PPP_COMPRESS_ADDRESS_CONTROL    0x00000200
  50 #define PPP_COMPRESS_PROTOCOL_FIELD     0x00000400
  51 #define PPP_ACCM_SUPPORTED              0x00000800
  52
  53 #define SLIP_FRAMING                    0x00001000
  54 #define SLIP_VJ_COMPRESSION             0x00002000
  55 #define SLIP_VJ_AUTODETECT              0x00004000
  56
  57 #define MEDIA_NRZ_ENCODING              0x00010000
  58 #define MEDIA_NRZI_ENCODING             0x00020000
  59 #define MEDIA_NLPID                     0x00040000
  60
  61 #define RFC_1356_FRAMING                0x00100000
  62 #define RFC_1483_FRAMING                0x00200000
  63 #define RFC_1490_FRAMING                0x00400000
  64 #define LLC_ENCAPSULATION               0x00800000
  65
  66 #define SHIVA_FRAMING                   0x01000000
  67 #define NBF_PRESERVE_MAC_ADDRESS        0x01000000
  68
  69 #define PASS_THROUGH_MODE               0x10000000
  70 #define RAW_PASS_THROUGH_MODE           0x20000000
  71
  72 #define TAPI_PROVIDER                   0x80000000
  73
  74 typedef struct _NDIS_WAN_INFO {
  75   OUT ULONG  MaxFrameSize;
  76   OUT ULONG  MaxTransmit;
  77   OUT ULONG  HeaderPadding;
  78   OUT ULONG  TailPadding;
  79   OUT ULONG  Endpoints;
  80   OUT UINT  MemoryFlags;
  81   OUT NDIS_PHYSICAL_ADDRESS  HighestAcceptableAddress;
  82   OUT ULONG  FramingBits;
  83   OUT ULONG  DesiredACCM;
  84 } NDIS_WAN_INFO, *PNDIS_WAN_INFO;
  85
  86 typedef struct _NDIS_WAN_GET_LINK_INFO {
  87   IN NDIS_HANDLE  NdisLinkHandle;
  88   OUT ULONG  MaxSendFrameSize;
  89   OUT ULONG  MaxRecvFrameSize;
  90   OUT ULONG  HeaderPadding;
  91   OUT ULONG  TailPadding;
  92   OUT ULONG  SendFramingBits;
  93   OUT ULONG  RecvFramingBits;
  94   OUT ULONG  SendCompressionBits;
  95   OUT ULONG  RecvCompressionBits;
  96   OUT ULONG  SendACCM;
  97   OUT ULONG  RecvACCM;
  98 } NDIS_WAN_GET_LINK_INFO, *PNDIS_WAN_GET_LINK_INFO;
  99
 100 typedef struct _NDIS_WAN_SET_LINK_INFO {
 101   IN NDIS_HANDLE  NdisLinkHandle;
 102   IN ULONG  MaxSendFrameSize;
 103   IN ULONG  MaxRecvFrameSize;
 104   IN ULONG  HeaderPadding;
 105   IN ULONG  TailPadding;
 106   IN ULONG  SendFramingBits;
 107   IN ULONG  RecvFramingBits;
 108   IN ULONG  SendCompressionBits;
 109   IN ULONG  RecvCompressionBits;
 110   IN ULONG  SendACCM;
 111   IN ULONG  RecvACCM;
 112 } NDIS_WAN_SET_LINK_INFO, *PNDIS_WAN_SET_LINK_INFO;
 113
 114 /* NDIS_WAN_COMPRESS_INFO.MSCompType constants */
 115 #define NDISWAN_COMPRESSION                     0x00000001
 116 #define NDISWAN_ENCRYPTION                      0x00000010
 117 #define NDISWAN_40_ENCRYPTION                   0x00000020
 118 #define NDISWAN_128_ENCRYPTION                  0x00000040
 119 #define NDISWAN_56_ENCRYPTION                   0x00000080
 120 #define NDISWAN_HISTORY_LESS                    0x01000000
 121
 122 /* NDIS_WAN_COMPRESS_INFO.CompType constants */
 123 #define COMPTYPE_OUI                                                                                    0
 124 #define COMPTYPE_NT31RAS                                                                        254
 125 #define COMPTYPE_NONE                                                                                   255
 126
 127 typedef struct _NDIS_WAN_COMPRESS_INFO {
 128         UCHAR  SessionKey[8];
 129         ULONG  MSCompType;
 130         UCHAR  CompType;
 131         USHORT  CompLength;
 132         _ANONYMOUS_UNION union {
 133                 struct {
 134                         UCHAR  CompOUI[3];
 135                         UCHAR  CompSubType;
 136                         UCHAR  CompValues[32];
 137                 } Proprietary;
 138                 struct {
 139                         UCHAR  CompValues[32];
 140                 } Public;
 141         } DUMMYUNIONNAME;
 142 } NDIS_WAN_COMPRESS_INFO;
 143
 144 typedef NDIS_WAN_COMPRESS_INFO *PNDIS_WAN_COMPRESS_INFO;
 145
 146 typedef struct _NDIS_WAN_GET_COMP_INFO {
 147   IN NDIS_HANDLE  NdisLinkHandle;
 148   OUT NDIS_WAN_COMPRESS_INFO  SendCapabilities;
 149   OUT NDIS_WAN_COMPRESS_INFO  RecvCapabilities;
 150 } NDIS_WAN_GET_COMP_INFO, *PNDIS_WAN_GET_COMP_INFO;
 151
 152 typedef struct _NDIS_WAN_SET_COMP_INFO {
 153   IN NDIS_HANDLE  NdisLinkHandle;
 154   IN NDIS_WAN_COMPRESS_INFO  SendCapabilities;
 155   IN NDIS_WAN_COMPRESS_INFO  RecvCapabilities;
 156 } NDIS_WAN_SET_COMP_INFO, *PNDIS_WAN_SET_COMP_INFO;
 157
 158 typedef struct _NDIS_WAN_GET_STATS_INFO {
 159   IN NDIS_HANDLE  NdisLinkHandle;
 160   OUT ULONG  BytesSent;
 161   OUT ULONG  BytesRcvd;
 162   OUT ULONG  FramesSent;
 163   OUT ULONG  FramesRcvd;
 164   OUT ULONG  CRCErrors;
 165   OUT ULONG  TimeoutErrors;
 166   OUT ULONG  AlignmentErrors;
 167   OUT ULONG  SerialOverrunErrors;
 168   OUT ULONG  FramingErrors;
 169   OUT ULONG  BufferOverrunErrors;
 170   OUT ULONG  BytesTransmittedUncompressed;
 171   OUT ULONG  BytesReceivedUncompressed;
 172   OUT ULONG  BytesTransmittedCompressed;
 173   OUT ULONG  BytesReceivedCompressed;
 174 } NDIS_WAN_GET_STATS_INFO, *PNDIS_WAN_GET_STATS_INFO;
 175
 176 #define NdisMWanInitializeWrapper(NdisWrapperHandle,    \
 177                                   SystemSpecific1,              \
 178                                   SystemSpecific2,              \
 179                                   SystemSpecific3)              \
 180 {                                                     \
 181         NdisMInitializeWrapper(NdisWrapperHandle,               \
 182                          SystemSpecific1,                       \
 183                          SystemSpecific2,                       \
 184                          SystemSpecific3);                      \
 185 }
 186
 187 typedef struct _NDIS_WAN_CO_INFO {
 188   OUT ULONG  MaxFrameSize;
 189   OUT ULONG  MaxSendWindow;
 190   OUT ULONG  FramingBits;
 191   OUT ULONG  DesiredACCM;
 192 } NDIS_WAN_CO_INFO, *PNDIS_WAN_CO_INFO;
 193
 194 typedef struct _NDIS_WAN_CO_GET_LINK_INFO {
 195   OUT ULONG  MaxSendFrameSize;
 196   OUT ULONG  MaxRecvFrameSize;
 197   OUT ULONG  SendFramingBits;
 198   OUT ULONG  RecvFramingBits;
 199   OUT ULONG  SendCompressionBits;
 200   OUT ULONG  RecvCompressionBits;
 201   OUT ULONG  SendACCM;
 202   OUT ULONG  RecvACCM;
 203 } NDIS_WAN_CO_GET_LINK_INFO, *PNDIS_WAN_CO_GET_LINK_INFO;
 204
 205 typedef struct _NDIS_WAN_CO_SET_LINK_INFO {
 206   IN ULONG  MaxSendFrameSize;
 207   IN ULONG  MaxRecvFrameSize;
 208   IN ULONG  SendFramingBits;
 209   IN ULONG  RecvFramingBits;
 210   IN ULONG  SendCompressionBits;
 211   IN ULONG  RecvCompressionBits;
 212   IN ULONG  SendACCM;
 213   IN ULONG  RecvACCM;
 214 } NDIS_WAN_CO_SET_LINK_INFO, *PNDIS_WAN_CO_SET_LINK_INFO;
 215
 216 typedef struct _NDIS_WAN_CO_GET_COMP_INFO {
 217   OUT NDIS_WAN_COMPRESS_INFO  SendCapabilities;
 218   OUT NDIS_WAN_COMPRESS_INFO  RecvCapabilities;
 219 } NDIS_WAN_CO_GET_COMP_INFO, *PNDIS_WAN_CO_GET_COMP_INFO;
 220
 221 typedef struct _NDIS_WAN_CO_SET_COMP_INFO {
 222   IN NDIS_WAN_COMPRESS_INFO  SendCapabilities;
 223   IN NDIS_WAN_COMPRESS_INFO  RecvCapabilities;
 224 } NDIS_WAN_CO_SET_COMP_INFO, *PNDIS_WAN_CO_SET_COMP_INFO;
 225
 226 typedef struct _NDIS_WAN_CO_GET_STATS_INFO {
 227   OUT ULONG  BytesSent;
 228   OUT ULONG  BytesRcvd;
 229   OUT ULONG  FramesSent;
 230   OUT ULONG  FramesRcvd;
 231   OUT ULONG  CRCErrors;
 232   OUT ULONG  TimeoutErrors;
 233   OUT ULONG  AlignmentErrors;
 234   OUT ULONG  SerialOverrunErrors;
 235   OUT ULONG  FramingErrors;
 236   OUT ULONG  BufferOverrunErrors;
 237   OUT ULONG  BytesTransmittedUncompressed;
 238   OUT ULONG  BytesReceivedUncompressed;
 239   OUT ULONG  BytesTransmittedCompressed;
 240   OUT ULONG  BytesReceivedCompressed;
 241 } NDIS_WAN_CO_GET_STATS_INFO, *PNDIS_WAN_CO_GET_STATS_INFO;
 242
 243 #ifdef __cplusplus
 244 }
 245 #endif
 246
 247 #endif /* __NDISWAN_H */