reactos/drivers/network/tcpip/datalink/lan.c

   1 /*
   2  * COPYRIGHT:   See COPYING in the top level directory
   3  * PROJECT:     ReactOS TCP/IP protocol driver
   4  * FILE:        datalink/lan.c
   5  * PURPOSE:     Local Area Network media routines
   6  * PROGRAMMERS: Casper S. Hornstrup (chorns@users.sourceforge.net)
   7  * REVISIONS:
   8  *   CSH 01/08-2000 Created
   9  */
  10
  11 #include "precomp.h"
  12
  13 UINT TransferDataCalled = 0;
  14 UINT TransferDataCompleteCalled = 0;
  15 UINT LanReceiveWorkerCalled = 0;
  16 BOOLEAN LanReceiveWorkerBusy = FALSE;
  17
  18 #define CCS_ROOT L"\\Registry\\Machine\\SYSTEM\\CurrentControlSet"
  19 #define TCPIP_GUID L"{4D36E972-E325-11CE-BFC1-08002BE10318}"
  20
  21 #define NGFP(_Packet)                                             \
  22     {                                                             \
  23         PVOID _Header;                                            \
  24         ULONG _ContigSize, _TotalSize;                            \
  25         PNDIS_BUFFER _NdisBuffer;                                 \
  26                                                                   \
  27         TI_DbgPrint(MID_TRACE,("Checking Packet %x\n", _Packet)); \
  28         NdisGetFirstBufferFromPacket(_Packet,                     \
  29                                      &_NdisBuffer,                \
  30                                      &_Header,                    \
  31                                      &_ContigSize,                \
  32                                      &_TotalSize);                \
  33         TI_DbgPrint(MID_TRACE,("NdisBuffer: %x\n", _NdisBuffer)); \
  34         TI_DbgPrint(MID_TRACE,("Header    : %x\n", _Header));     \
  35         TI_DbgPrint(MID_TRACE,("ContigSize: %x\n", _ContigSize)); \
  36         TI_DbgPrint(MID_TRACE,("TotalSize : %x\n", _TotalSize));  \
  37     }
  38
  39 typedef struct _LAN_WQ_ITEM {
  40     LIST_ENTRY ListEntry;
  41     PNDIS_PACKET Packet;
  42     PLAN_ADAPTER Adapter;
  43     UINT BytesTransferred;
  44 } LAN_WQ_ITEM, *PLAN_WQ_ITEM;
  45
  46 NDIS_HANDLE NdisProtocolHandle = (NDIS_HANDLE)NULL;
  47 BOOLEAN ProtocolRegistered     = FALSE;
  48 LIST_ENTRY AdapterListHead;
  49 KSPIN_LOCK AdapterListLock;
  50
  51 NDIS_STATUS NDISCall(
  52     PLAN_ADAPTER Adapter,
  53     NDIS_REQUEST_TYPE Type,
  54     NDIS_OID OID,
  55     PVOID Buffer,
  56     UINT Length)
  57 /*
  58  * FUNCTION: Send a request to NDIS
  59  * ARGUMENTS:
  60  *     Adapter     = Pointer to a LAN_ADAPTER structure
  61  *     Type        = Type of request (Set or Query)
  62  *     OID         = Value to be set/queried for
  63  *     Buffer      = Pointer to a buffer to use
  64  *     Length      = Number of bytes in Buffer
  65  * RETURNS:
  66  *     Status of operation
  67  */
  68 {
  69     NDIS_REQUEST Request;
  70     NDIS_STATUS NdisStatus;
  71
  72     Request.RequestType = Type;
  73     if (Type == NdisRequestSetInformation) {
  74         Request.DATA.SET_INFORMATION.Oid                     = OID;
  75         Request.DATA.SET_INFORMATION.InformationBuffer       = Buffer;
  76         Request.DATA.SET_INFORMATION.InformationBufferLength = Length;
  77     } else {
  78         Request.DATA.QUERY_INFORMATION.Oid                     = OID;
  79         Request.DATA.QUERY_INFORMATION.InformationBuffer       = Buffer;
  80         Request.DATA.QUERY_INFORMATION.InformationBufferLength = Length;
  81     }
  82
  83     if (Adapter->State != LAN_STATE_RESETTING) {
  84         NdisRequest(&NdisStatus, Adapter->NdisHandle, &Request);
  85     } else {
  86         NdisStatus = NDIS_STATUS_NOT_ACCEPTED;
  87     }
  88
  89     /* Wait for NDIS to complete the request */
  90     if (NdisStatus == NDIS_STATUS_PENDING) {
  91         KeWaitForSingleObject(&Adapter->Event,
  92                               UserRequest,
  93                               KernelMode,
  94                               FALSE,
  95                               NULL);
  96         NdisStatus = Adapter->NdisStatus;
  97     }
  98
  99     return NdisStatus;
 100 }
 101
 102
 103 VOID FreeAdapter(
 104     PLAN_ADAPTER Adapter)
 105 /*
 106  * FUNCTION: Frees memory for a LAN_ADAPTER structure
 107  * ARGUMENTS:
 108  *     Adapter = Pointer to LAN_ADAPTER structure to free
 109  */
 110 {
 111     ExFreePoolWithTag(Adapter, LAN_ADAPTER_TAG);
 112 }
 113
 114
 115 NTSTATUS TcpipLanGetDwordOid
 116 ( PIP_INTERFACE Interface,
 117   NDIS_OID Oid,
 118   PULONG Result ) {
 119     /* Get maximum frame size */
 120     if( Interface->Context ) {
 121         return NDISCall((PLAN_ADAPTER)Interface->Context,
 122                         NdisRequestQueryInformation,
 123                         Oid,
 124                         Result,
 125                         sizeof(ULONG));
 126     } else switch( Oid ) { /* Loopback Case */
 127     case OID_GEN_HARDWARE_STATUS:
 128         *Result = NdisHardwareStatusReady;
 129         return STATUS_SUCCESS;
 130
 131     default:
 132         return STATUS_INVALID_PARAMETER;
 133     }
 134 }
 135
 136
 137 VOID NTAPI ProtocolOpenAdapterComplete(
 138     NDIS_HANDLE BindingContext,
 139     NDIS_STATUS Status,
 140     NDIS_STATUS OpenErrorStatus)
 141 /*
 142  * FUNCTION: Called by NDIS to complete opening of an adapter
 143  * ARGUMENTS:
 144  *     BindingContext  = Pointer to a device context (LAN_ADAPTER)
 145  *     Status          = Status of the operation
 146  *     OpenErrorStatus = Additional status information
 147  */
 148 {
 149     PLAN_ADAPTER Adapter = (PLAN_ADAPTER)BindingContext;
 150
 151     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 152
 153     Adapter->NdisStatus = Status;
 154
 155     KeSetEvent(&Adapter->Event, 0, FALSE);
 156 }
 157
 158
 159 VOID NTAPI ProtocolCloseAdapterComplete(
 160     NDIS_HANDLE BindingContext,
 161     NDIS_STATUS Status)
 162 /*
 163  * FUNCTION: Called by NDIS to complete closing an adapter
 164  * ARGUMENTS:
 165  *     BindingContext = Pointer to a device context (LAN_ADAPTER)
 166  *     Status         = Status of the operation
 167  */
 168 {
 169     PLAN_ADAPTER Adapter = (PLAN_ADAPTER)BindingContext;
 170
 171     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 172
 173     Adapter->NdisStatus = Status;
 174
 175     KeSetEvent(&Adapter->Event, 0, FALSE);
 176 }
 177
 178
 179 VOID NTAPI ProtocolResetComplete(
 180     NDIS_HANDLE BindingContext,
 181     NDIS_STATUS Status)
 182 /*
 183  * FUNCTION: Called by NDIS to complete resetting an adapter
 184  * ARGUMENTS:
 185  *     BindingContext = Pointer to a device context (LAN_ADAPTER)
 186  *     Status         = Status of the operation
 187  */
 188 {
 189     PLAN_ADAPTER Adapter = (PLAN_ADAPTER)BindingContext;
 190
 191     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 192
 193     Adapter->NdisStatus = Status;
 194
 195     KeSetEvent(&Adapter->Event, 0, FALSE);
 196 }
 197
 198
 199 VOID NTAPI ProtocolRequestComplete(
 200     NDIS_HANDLE BindingContext,
 201     PNDIS_REQUEST NdisRequest,
 202     NDIS_STATUS Status)
 203 /*
 204  * FUNCTION: Called by NDIS to complete a request
 205  * ARGUMENTS:
 206  *     BindingContext = Pointer to a device context (LAN_ADAPTER)
 207  *     NdisRequest    = Pointer to an object describing the request
 208  *     Status         = Status of the operation
 209  */
 210 {
 211     PLAN_ADAPTER Adapter = (PLAN_ADAPTER)BindingContext;
 212
 213     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 214
 215     /* Save status of request and signal an event */
 216     Adapter->NdisStatus = Status;
 217
 218     KeSetEvent(&Adapter->Event, 0, FALSE);
 219 }
 220
 221
 222 VOID NTAPI ProtocolSendComplete(
 223     NDIS_HANDLE BindingContext,
 224     PNDIS_PACKET Packet,
 225     NDIS_STATUS Status)
 226 /*
 227  * FUNCTION: Called by NDIS to complete sending process
 228  * ARGUMENTS:
 229  *     BindingContext = Pointer to a device context (LAN_ADAPTER)
 230  *     Packet         = Pointer to a packet descriptor
 231  *     Status         = Status of the operation
 232  */
 233 {
 234     FreeNdisPacket(Packet);
 235 }
 236
 237 VOID LanReceiveWorker( PVOID Context ) {
 238     UINT PacketType;
 239     PLAN_WQ_ITEM WorkItem = (PLAN_WQ_ITEM)Context;
 240     PNDIS_PACKET Packet;
 241     PLAN_ADAPTER Adapter;
 242     UINT BytesTransferred;
 243     PNDIS_BUFFER NdisBuffer;
 244     IP_PACKET IPPacket;
 245
 246     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 247
 248     Packet = WorkItem->Packet;
 249     Adapter = WorkItem->Adapter;
 250     BytesTransferred = WorkItem->BytesTransferred;
 251
 252     ExFreePoolWithTag(WorkItem, WQ_CONTEXT_TAG);
 253
 254     IPInitializePacket(&IPPacket, 0);
 255
 256     IPPacket.NdisPacket = Packet;
 257
 258     NdisGetFirstBufferFromPacket(Packet,
 259                                  &NdisBuffer,
 260                                  &IPPacket.Header,
 261                                  &IPPacket.ContigSize,
 262                                  &IPPacket.TotalSize);
 263
 264     IPPacket.ContigSize = IPPacket.TotalSize = BytesTransferred;
 265     /* Determine which upper layer protocol that should receive
 266        this packet and pass it to the correct receive handler */
 267
 268     TI_DbgPrint(MID_TRACE,
 269                 ("ContigSize: %d, TotalSize: %d, BytesTransferred: %d\n",
 270                  IPPacket.ContigSize, IPPacket.TotalSize,
 271                  BytesTransferred));
 272
 273     PacketType = PC(IPPacket.NdisPacket)->PacketType;
 274     IPPacket.Position = 0;
 275
 276     TI_DbgPrint
 277         (DEBUG_DATALINK,
 278          ("Ether Type = %x ContigSize = %d Total = %d\n",
 279           PacketType, IPPacket.ContigSize, IPPacket.TotalSize));
 280
 281     switch (PacketType) {
 282     case ETYPE_IPv4:
 283     case ETYPE_IPv6:
 284         TI_DbgPrint(MID_TRACE,("Received IP Packet\n"));
 285         IPReceive(Adapter->Context, &IPPacket);
 286         break;
 287     case ETYPE_ARP:
 288         TI_DbgPrint(MID_TRACE,("Received ARP Packet\n"));
 289         ARPReceive(Adapter->Context, &IPPacket);
 290     default:
 291         IPPacket.Free(&IPPacket);
 292         break;
 293     }
 294
 295     FreeNdisPacket( Packet );
 296 }
 297
 298 VOID LanSubmitReceiveWork(
 299     NDIS_HANDLE BindingContext,
 300     PNDIS_PACKET Packet,
 301     NDIS_STATUS Status,
 302     UINT BytesTransferred) {
 303     PLAN_WQ_ITEM WQItem = ExAllocatePoolWithTag(NonPagedPool, sizeof(LAN_WQ_ITEM),
 304                                                 WQ_CONTEXT_TAG);
 305     PLAN_ADAPTER Adapter = (PLAN_ADAPTER)BindingContext;
 306
 307     TI_DbgPrint(DEBUG_DATALINK,("called\n"));
 308
 309     if (!WQItem) return;
 310
 311     WQItem->Packet = Packet;
 312     WQItem->Adapter = Adapter;
 313     WQItem->BytesTransferred = BytesTransferred;
 314
 315     if (!ChewCreate( LanReceiveWorker, WQItem ))
 316         ExFreePoolWithTag(WQItem, WQ_CONTEXT_TAG);
 317 }
 318
 319 VOID NTAPI ProtocolTransferDataComplete(
 320     NDIS_HANDLE BindingContext,
 321     PNDIS_PACKET Packet,
 322     NDIS_STATUS Status,
 323     UINT BytesTransferred)
 324 /*
 325  * FUNCTION: Called by NDIS to complete reception of data
 326  * ARGUMENTS:
 327  *     BindingContext   = Pointer to a device context (LAN_ADAPTER)
 328  *     Packet           = Pointer to a packet descriptor
 329  *     Status           = Status of the operation
 330  *     BytesTransferred = Number of bytes transferred
 331  * NOTES:
 332  *     If the packet was successfully received, determine the protocol
 333  *     type and pass it to the correct receive handler
 334  */
 335 {
 336     ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL);
 337
 338     TI_DbgPrint(DEBUG_DATALINK,("called\n"));
 339
 340     TransferDataCompleteCalled++;
 341     ASSERT(TransferDataCompleteCalled <= TransferDataCalled);
 342
 343     if( Status != NDIS_STATUS_SUCCESS ) return;
 344
 345     LanSubmitReceiveWork( BindingContext, Packet, Status, BytesTransferred );
 346 }
 347
 348 NDIS_STATUS NTAPI ProtocolReceive(
 349     NDIS_HANDLE BindingContext,
 350     NDIS_HANDLE MacReceiveContext,
 351     PVOID HeaderBuffer,
 352     UINT HeaderBufferSize,
 353     PVOID LookaheadBuffer,
 354     UINT LookaheadBufferSize,
 355     UINT PacketSize)
 356 /*
 357  * FUNCTION: Called by NDIS when a packet has been received on the physical link
 358  * ARGUMENTS:
 359  *     BindingContext      = Pointer to a device context (LAN_ADAPTER)
 360  *     MacReceiveContext   = Handle used by underlying NIC driver
 361  *     HeaderBuffer        = Pointer to a buffer containing the packet header
 362  *     HeaderBufferSize    = Number of bytes in HeaderBuffer
 363  *     LookaheadBuffer     = Pointer to a buffer containing buffered packet data
 364  *     LookaheadBufferSize = Size of LookaheadBuffer. May be less than asked for
 365  *     PacketSize          = Overall size of the packet (not including header)
 366  * RETURNS:
 367  *     Status of operation
 368  */
 369 {
 370     USHORT EType;
 371     UINT PacketType, BytesTransferred;
 372     UINT temp;
 373     IP_PACKET IPPacket;
 374     PCHAR BufferData;
 375     NDIS_STATUS NdisStatus;
 376     PNDIS_PACKET NdisPacket;
 377     PLAN_ADAPTER Adapter = (PLAN_ADAPTER)BindingContext;
 378     PETH_HEADER EHeader  = (PETH_HEADER)HeaderBuffer;
 379
 380     TI_DbgPrint(DEBUG_DATALINK, ("Called. (packetsize %d)\n",PacketSize));
 381
 382     if (Adapter->State != LAN_STATE_STARTED) {
 383         TI_DbgPrint(DEBUG_DATALINK, ("Adapter is stopped.\n"));
 384         return NDIS_STATUS_NOT_ACCEPTED;
 385     }
 386
 387     if (HeaderBufferSize < Adapter->HeaderSize) {
 388         TI_DbgPrint(DEBUG_DATALINK, ("Runt frame received.\n"));
 389         return NDIS_STATUS_NOT_ACCEPTED;
 390     }
 391
 392     if (Adapter->Media == NdisMedium802_3) {
 393         /* Ethernet and IEEE 802.3 frames can be destinguished by
 394            looking at the IEEE 802.3 length field. This field is
 395            less than or equal to 1500 for a valid IEEE 802.3 frame
 396            and larger than 1500 is it's a valid EtherType value.
 397            See RFC 1122, section 2.3.3 for more information */
 398         /* FIXME: Test for Ethernet and IEEE 802.3 frame */
 399         if (((EType = EHeader->EType) != ETYPE_IPv4) && (EType != ETYPE_ARP)) {
 400             TI_DbgPrint(DEBUG_DATALINK, ("Not IP or ARP frame. EtherType (0x%X).\n", EType));
 401             return NDIS_STATUS_NOT_ACCEPTED;
 402         }
 403         /* We use EtherType constants to destinguish packet types */
 404         PacketType = EType;
 405     } else {
 406         TI_DbgPrint(MIN_TRACE, ("Unsupported media.\n"));
 407         /* FIXME: Support other medias */
 408         return NDIS_STATUS_NOT_ACCEPTED;
 409     }
 410
 411     /* Get a transfer data packet */
 412
 413     TI_DbgPrint(DEBUG_DATALINK, ("Adapter: %x (MTU %d)\n",
 414                                  Adapter, Adapter->MTU));
 415
 416     NdisStatus = AllocatePacketWithBuffer( &NdisPacket, NULL,
 417                                            PacketSize );
 418     if( NdisStatus != NDIS_STATUS_SUCCESS ) {
 419         return NDIS_STATUS_NOT_ACCEPTED;
 420     }
 421
 422     PC(NdisPacket)->PacketType = PacketType;
 423
 424     TI_DbgPrint(DEBUG_DATALINK, ("pretransfer LookaheadBufferSize %d packsize %d\n",LookaheadBufferSize,PacketSize));
 425
 426     GetDataPtr( NdisPacket, 0, &BufferData, &temp );
 427
 428     IPPacket.NdisPacket = NdisPacket;
 429     IPPacket.Position = 0;
 430
 431     TransferDataCalled++;
 432
 433     if (LookaheadBufferSize == PacketSize)
 434     {
 435         /* Optimized code path for packets that are fully contained in
 436          * the lookahead buffer. */
 437         NdisCopyLookaheadData(BufferData,
 438                               LookaheadBuffer,
 439                               LookaheadBufferSize,
 440                               Adapter->MacOptions);
 441     }
 442     else
 443     {
 444         NdisTransferData(&NdisStatus, Adapter->NdisHandle,
 445                          MacReceiveContext, 0, PacketSize,
 446                          NdisPacket, &BytesTransferred);
 447     }
 448     TI_DbgPrint(DEBUG_DATALINK, ("Calling complete\n"));
 449
 450     if (NdisStatus != NDIS_STATUS_PENDING)
 451         ProtocolTransferDataComplete(BindingContext,
 452                                      NdisPacket,
 453                                      NdisStatus,
 454                                      PacketSize);
 455
 456     TI_DbgPrint(DEBUG_DATALINK, ("leaving\n"));
 457
 458     return NDIS_STATUS_SUCCESS;
 459 }
 460
 461
 462 VOID NTAPI ProtocolReceiveComplete(
 463     NDIS_HANDLE BindingContext)
 464 /*
 465  * FUNCTION: Called by NDIS when we're done receiving data
 466  * ARGUMENTS:
 467  *     BindingContext = Pointer to a device context (LAN_ADAPTER)
 468  */
 469 {
 470     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 471 }
 472
 473
 474 VOID NTAPI ProtocolStatus(
 475     NDIS_HANDLE BindingContext,
 476     NDIS_STATUS GeneralStatus,
 477     PVOID StatusBuffer,
 478     UINT StatusBufferSize)
 479 /*
 480  * FUNCTION: Called by NDIS when the underlying driver has changed state
 481  * ARGUMENTS:
 482  *     BindingContext   = Pointer to a device context (LAN_ADAPTER)
 483  *     GeneralStatus    = A general status code
 484  *     StatusBuffer     = Pointer to a buffer with medium-specific data
 485  *     StatusBufferSize = Number of bytes in StatusBuffer
 486  */
 487 {
 488     PLAN_ADAPTER Adapter = BindingContext;
 489
 490     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 491
 492     switch(GeneralStatus)
 493     {
 494       case NDIS_STATUS_MEDIA_CONNECT:
 495          DbgPrint("NDIS_STATUS_MEDIA_CONNECT\n");
 496          break;
 497
 498       case NDIS_STATUS_MEDIA_DISCONNECT:
 499          DbgPrint("NDIS_STATUS_MEDIA_DISCONNECT\n");
 500          break;
 501
 502       case NDIS_STATUS_RESET_START:
 503          Adapter->State = LAN_STATE_RESETTING;
 504          break;
 505
 506       case NDIS_STATUS_RESET_END:
 507          Adapter->State = LAN_STATE_STARTED;
 508          break;
 509
 510       default:
 511          DbgPrint("Unhandled status: %x", GeneralStatus);
 512          break;
 513     }
 514 }
 515
 516 NDIS_STATUS NTAPI
 517 ProtocolPnPEvent(
 518     NDIS_HANDLE NdisBindingContext,
 519     PNET_PNP_EVENT PnPEvent)
 520 {
 521     switch(PnPEvent->NetEvent)
 522     {
 523       case NetEventSetPower:
 524          DbgPrint("Device transitioned to power state %ld\n", PnPEvent->Buffer);
 525          return NDIS_STATUS_SUCCESS;
 526
 527       case NetEventQueryPower:
 528          DbgPrint("Device wants to go into power state %ld\n", PnPEvent->Buffer);
 529          return NDIS_STATUS_SUCCESS;
 530
 531       case NetEventQueryRemoveDevice:
 532          DbgPrint("Device is about to be removed\n");
 533          return NDIS_STATUS_SUCCESS;
 534
 535       case NetEventCancelRemoveDevice:
 536          DbgPrint("Device removal cancelled\n");
 537          return NDIS_STATUS_SUCCESS;
 538
 539       default:
 540          DbgPrint("Unhandled event type: %ld\n", PnPEvent->NetEvent);
 541          return NDIS_STATUS_SUCCESS;
 542     }
 543 }
 544
 545 VOID NTAPI ProtocolStatusComplete(
 546     NDIS_HANDLE NdisBindingContext)
 547 /*
 548  * FUNCTION: Called by NDIS when a status-change has occurred
 549  * ARGUMENTS:
 550  *     BindingContext = Pointer to a device context (LAN_ADAPTER)
 551  */
 552 {
 553     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 554 }
 555
 556 VOID NTAPI ProtocolBindAdapter(
 557     OUT PNDIS_STATUS   Status,
 558     IN  NDIS_HANDLE    BindContext,
 559     IN  PNDIS_STRING   DeviceName,
 560     IN  PVOID          SystemSpecific1,
 561     IN  PVOID          SystemSpecific2)
 562 /*
 563  * FUNCTION: Called by NDIS during NdisRegisterProtocol to set up initial
 564  *           bindings, and periodically thereafer as new adapters come online
 565  * ARGUMENTS:
 566  *     Status: Return value to NDIS
 567  *     BindContext: Handle provided by NDIS to track pending binding operations
 568  *     DeviceName: Name of the miniport device to bind to
 569  *     SystemSpecific1: Pointer to a registry path with protocol-specific configuration information
 570  *     SystemSpecific2: Unused & must not be touched
 571  */
 572 {
 573     /* XXX confirm that this is still true, or re-word the following comment */
 574     /* we get to ignore BindContext because we will never pend an operation with NDIS */
 575     TI_DbgPrint(DEBUG_DATALINK, ("Called with registry path %wZ for %wZ\n", SystemSpecific1, DeviceName));
 576     *Status = LANRegisterAdapter(DeviceName, SystemSpecific1);
 577 }
 578
 579
 580 VOID LANTransmit(
 581     PVOID Context,
 582     PNDIS_PACKET NdisPacket,
 583     UINT Offset,
 584     PVOID LinkAddress,
 585     USHORT Type)
 586 /*
 587  * FUNCTION: Transmits a packet
 588  * ARGUMENTS:
 589  *     Context     = Pointer to context information (LAN_ADAPTER)
 590  *     NdisPacket  = Pointer to NDIS packet to send
 591  *     Offset      = Offset in packet where data starts
 592  *     LinkAddress = Pointer to link address of destination (NULL = broadcast)
 593  *     Type        = LAN protocol type (LAN_PROTO_*)
 594  */
 595 {
 596     NDIS_STATUS NdisStatus;
 597     PETH_HEADER EHeader;
 598     PCHAR Data, OldData;
 599     UINT Size, OldSize;
 600     PLAN_ADAPTER Adapter = (PLAN_ADAPTER)Context;
 601     KIRQL OldIrql;
 602     PNDIS_PACKET XmitPacket;
 603
 604     TI_DbgPrint(DEBUG_DATALINK,
 605                 ("Called( NdisPacket %x, Offset %d, Adapter %x )\n",
 606                  NdisPacket, Offset, Adapter));
 607
 608     if (Adapter->State != LAN_STATE_STARTED) {
 609         (*PC(NdisPacket)->DLComplete)(PC(NdisPacket)->Context, NdisPacket, NDIS_STATUS_NOT_ACCEPTED);
 610         return;
 611     }
 612
 613     TI_DbgPrint(DEBUG_DATALINK,
 614                 ("Adapter Address [%02x %02x %02x %02x %02x %02x]\n",
 615                  Adapter->HWAddress[0] & 0xff,
 616                  Adapter->HWAddress[1] & 0xff,
 617                  Adapter->HWAddress[2] & 0xff,
 618                  Adapter->HWAddress[3] & 0xff,
 619                  Adapter->HWAddress[4] & 0xff,
 620                  Adapter->HWAddress[5] & 0xff));
 621
 622     GetDataPtr( NdisPacket, 0, &OldData, &OldSize );
 623
 624     NdisStatus = AllocatePacketWithBuffer(&XmitPacket, NULL, OldSize + Adapter->HeaderSize);
 625     if (NdisStatus != NDIS_STATUS_SUCCESS) {
 626         (*PC(NdisPacket)->DLComplete)(PC(NdisPacket)->Context, NdisPacket, NDIS_STATUS_RESOURCES);
 627         return;
 628     }
 629
 630     GetDataPtr(XmitPacket, 0, &Data, &Size);
 631
 632     RtlCopyMemory(Data + Adapter->HeaderSize, OldData, OldSize);
 633
 634     (*PC(NdisPacket)->DLComplete)(PC(NdisPacket)->Context, NdisPacket, NDIS_STATUS_SUCCESS);
 635
 636         switch (Adapter->Media) {
 637         case NdisMedium802_3:
 638             EHeader = (PETH_HEADER)Data;
 639
 640             if (LinkAddress) {
 641                 /* Unicast address */
 642                 RtlCopyMemory(EHeader->DstAddr, LinkAddress, IEEE_802_ADDR_LENGTH);
 643             } else {
 644                 /* Broadcast address */
 645                 RtlFillMemory(EHeader->DstAddr, IEEE_802_ADDR_LENGTH, 0xFF);
 646             }
 647
 648             RtlCopyMemory(EHeader->SrcAddr, Adapter->HWAddress, IEEE_802_ADDR_LENGTH);
 649
 650             switch (Type) {
 651             case LAN_PROTO_IPv4:
 652                 EHeader->EType = ETYPE_IPv4;
 653                 break;
 654             case LAN_PROTO_ARP:
 655                 EHeader->EType = ETYPE_ARP;
 656                 break;
 657             case LAN_PROTO_IPv6:
 658                 EHeader->EType = ETYPE_IPv6;
 659                 break;
 660             default:
 661                 ASSERT(FALSE);
 662                 return;
 663             }
 664             break;
 665
 666         default:
 667             /* FIXME: Support other medias */
 668             break;
 669         }
 670
 671         TI_DbgPrint( MID_TRACE, ("LinkAddress: %x\n", LinkAddress));
 672         if( LinkAddress ) {
 673             TI_DbgPrint
 674                 ( MID_TRACE,
 675                   ("Link Address [%02x %02x %02x %02x %02x %02x]\n",
 676                    ((PCHAR)LinkAddress)[0] & 0xff,
 677                    ((PCHAR)LinkAddress)[1] & 0xff,
 678                    ((PCHAR)LinkAddress)[2] & 0xff,
 679                    ((PCHAR)LinkAddress)[3] & 0xff,
 680                    ((PCHAR)LinkAddress)[4] & 0xff,
 681                    ((PCHAR)LinkAddress)[5] & 0xff));
 682         }
 683
 684         if (Adapter->MTU < Size) {
 685             /* This is NOT a pointer. MSDN explicitly says so. */
 686             NDIS_PER_PACKET_INFO_FROM_PACKET(NdisPacket,
 687                                              TcpLargeSendPacketInfo) = (PVOID)((ULONG_PTR)Adapter->MTU);
 688         }
 689
 690         TcpipAcquireSpinLock( &Adapter->Lock, &OldIrql );
 691         TI_DbgPrint(MID_TRACE, ("NdisSend\n"));
 692         NdisSend(&NdisStatus, Adapter->NdisHandle, XmitPacket);
 693         TI_DbgPrint(MID_TRACE, ("NdisSend %s\n",
 694                                 NdisStatus == NDIS_STATUS_PENDING ?
 695                                 "Pending" : "Complete"));
 696         TcpipReleaseSpinLock( &Adapter->Lock, OldIrql );
 697
 698         /* I had a talk with vizzini: these really ought to be here.
 699          * we're supposed to see these completed by ndis *only* when
 700          * status_pending is returned.  Note that this is different from
 701          * the situation with IRPs. */
 702         if (NdisStatus != NDIS_STATUS_PENDING)
 703             ProtocolSendComplete((NDIS_HANDLE)Context, XmitPacket, NdisStatus);
 704 }
 705
 706 static NTSTATUS
 707 OpenRegistryKey( PNDIS_STRING RegistryPath, PHANDLE RegHandle ) {
 708     OBJECT_ATTRIBUTES Attributes;
 709     NTSTATUS Status;
 710
 711     InitializeObjectAttributes(&Attributes, RegistryPath, OBJ_CASE_INSENSITIVE, 0, 0);
 712     Status = ZwOpenKey(RegHandle, KEY_ALL_ACCESS, &Attributes);
 713     return Status;
 714 }
 715
 716 static NTSTATUS ReadStringFromRegistry( HANDLE RegHandle,
 717                                         PWCHAR RegistryValue,
 718                                         PUNICODE_STRING String ) {
 719     UNICODE_STRING ValueName;
 720     UNICODE_STRING UnicodeString;
 721     NTSTATUS Status;
 722     ULONG ResultLength;
 723     UCHAR buf[1024];
 724     PKEY_VALUE_PARTIAL_INFORMATION Information = (PKEY_VALUE_PARTIAL_INFORMATION)buf;
 725
 726     RtlInitUnicodeString(&ValueName, RegistryValue);
 727     Status =
 728         ZwQueryValueKey(RegHandle,
 729                         &ValueName,
 730                         KeyValuePartialInformation,
 731                         Information,
 732                         sizeof(buf),
 733                         &ResultLength);
 734
 735     if (!NT_SUCCESS(Status))
 736         return Status;
 737     /* IP address is stored as a REG_MULTI_SZ - we only pay attention to the first one though */
 738     TI_DbgPrint(MIN_TRACE, ("Information DataLength: 0x%x\n", Information->DataLength));
 739
 740     UnicodeString.Buffer = (PWCHAR)&Information->Data;
 741     UnicodeString.Length = Information->DataLength - sizeof(WCHAR);
 742     UnicodeString.MaximumLength = Information->DataLength;
 743
 744     String->Buffer =
 745         (PWCHAR)ExAllocatePool( NonPagedPool,
 746                                 UnicodeString.MaximumLength + sizeof(WCHAR) );
 747
 748     if( !String->Buffer ) return STATUS_NO_MEMORY;
 749
 750     String->MaximumLength = UnicodeString.MaximumLength;
 751     RtlCopyUnicodeString( String, &UnicodeString );
 752
 753     return STATUS_SUCCESS;
 754 }
 755
 756 /*
 757  * Utility to copy and append two unicode strings.
 758  *
 759  * IN OUT PUNICODE_STRING ResultFirst -> First string and result
 760  * IN     PUNICODE_STRING Second      -> Second string to append
 761  * IN     BOOL            Deallocate  -> TRUE: Deallocate First string before
 762  *                                       overwriting.
 763  *
 764  * Returns NTSTATUS.
 765  */
 766
 767 NTSTATUS NTAPI AppendUnicodeString(PUNICODE_STRING ResultFirst,
 768                                    PUNICODE_STRING Second,
 769                                    BOOLEAN Deallocate) {
 770     NTSTATUS Status;
 771     UNICODE_STRING Ustr = *ResultFirst;
 772     PWSTR new_string = ExAllocatePool
 773         (PagedPool,
 774          (ResultFirst->Length + Second->Length + sizeof(WCHAR)));
 775     if( !new_string ) {
 776         return STATUS_NO_MEMORY;
 777     }
 778     memcpy( new_string, ResultFirst->Buffer, ResultFirst->Length );
 779     memcpy( new_string + ResultFirst->Length / sizeof(WCHAR),
 780             Second->Buffer, Second->Length );
 781     if( Deallocate ) RtlFreeUnicodeString(ResultFirst);
 782     ResultFirst->Length = Ustr.Length + Second->Length;
 783     ResultFirst->MaximumLength = ResultFirst->Length;
 784     new_string[ResultFirst->Length / sizeof(WCHAR)] = 0;
 785     Status = RtlCreateUnicodeString(ResultFirst,new_string) ?
 786         STATUS_SUCCESS : STATUS_NO_MEMORY;
 787     ExFreePool(new_string);
 788     return Status;
 789 }
 790
 791 static NTSTATUS CheckForDeviceDesc( PUNICODE_STRING EnumKeyName,
 792                                     PUNICODE_STRING TargetKeyName,
 793                                     PUNICODE_STRING Name,
 794                                     PUNICODE_STRING DeviceDesc ) {
 795     UNICODE_STRING RootDevice = { 0, 0, NULL }, LinkageKeyName = { 0, 0, NULL };
 796     UNICODE_STRING DescKeyName = { 0, 0, NULL }, Linkage = { 0, 0, NULL };
 797     UNICODE_STRING BackSlash = { 0, 0, NULL };
 798     HANDLE DescKey = NULL, LinkageKey = NULL;
 799     NTSTATUS Status;
 800
 801     TI_DbgPrint(DEBUG_DATALINK,("EnumKeyName %wZ\n", EnumKeyName));
 802
 803     RtlInitUnicodeString(&BackSlash, L"\\");
 804     RtlInitUnicodeString(&Linkage, L"\\Linkage");
 805
 806     RtlInitUnicodeString(&DescKeyName, L"");
 807     AppendUnicodeString( &DescKeyName, EnumKeyName, FALSE );
 808     AppendUnicodeString( &DescKeyName, &BackSlash, TRUE );
 809     AppendUnicodeString( &DescKeyName, TargetKeyName, TRUE );
 810
 811     RtlInitUnicodeString(&LinkageKeyName, L"");
 812     AppendUnicodeString( &LinkageKeyName, &DescKeyName, FALSE );
 813     AppendUnicodeString( &LinkageKeyName, &Linkage, TRUE );
 814
 815     Status = OpenRegistryKey( &LinkageKeyName, &LinkageKey );
 816     if( !NT_SUCCESS(Status) ) goto cleanup;
 817
 818     Status = ReadStringFromRegistry( LinkageKey, L"RootDevice", &RootDevice );
 819     if( !NT_SUCCESS(Status) ) goto cleanup;
 820
 821     if( RtlCompareUnicodeString( &RootDevice, Name, TRUE ) == 0 ) {
 822         Status = OpenRegistryKey( &DescKeyName, &DescKey );
 823         if( !NT_SUCCESS(Status) ) goto cleanup;
 824
 825         Status = ReadStringFromRegistry( DescKey, L"DriverDesc", DeviceDesc );
 826         if( !NT_SUCCESS(Status) ) goto cleanup;
 827
 828         TI_DbgPrint(DEBUG_DATALINK,("ADAPTER DESC: %wZ\n", DeviceDesc));
 829     } else Status = STATUS_UNSUCCESSFUL;
 830
 831 cleanup:
 832     RtlFreeUnicodeString( &RootDevice );
 833     RtlFreeUnicodeString( &LinkageKeyName );
 834     RtlFreeUnicodeString( &DescKeyName );
 835     if( LinkageKey ) NtClose( LinkageKey );
 836     if( DescKey ) NtClose( DescKey );
 837
 838     TI_DbgPrint(DEBUG_DATALINK,("Returning %x\n", Status));
 839
 840     return Status;
 841 }
 842
 843 static NTSTATUS FindDeviceDescForAdapter( PUNICODE_STRING Name,
 844                                           PUNICODE_STRING DeviceDesc ) {
 845     UNICODE_STRING EnumKeyName, TargetKeyName;
 846     HANDLE EnumKey;
 847     NTSTATUS Status;
 848     ULONG i;
 849     KEY_BASIC_INFORMATION *Kbio =
 850         ExAllocatePool(NonPagedPool, sizeof(KEY_BASIC_INFORMATION));
 851     ULONG KbioLength = sizeof(KEY_BASIC_INFORMATION), ResultLength;
 852
 853     RtlInitUnicodeString( DeviceDesc, NULL );
 854
 855     if( !Kbio ) return STATUS_INSUFFICIENT_RESOURCES;
 856
 857     RtlInitUnicodeString
 858         (&EnumKeyName, CCS_ROOT L"\\Control\\Class\\" TCPIP_GUID);
 859
 860     Status = OpenRegistryKey( &EnumKeyName, &EnumKey );
 861
 862     if( !NT_SUCCESS(Status) ) {
 863         TI_DbgPrint(DEBUG_DATALINK,("Couldn't open Enum key %wZ: %x\n",
 864                                     &EnumKeyName, Status));
 865         ExFreePool( Kbio );
 866         return Status;
 867     }
 868
 869     for( i = 0; NT_SUCCESS(Status); i++ ) {
 870         Status = ZwEnumerateKey( EnumKey, i, KeyBasicInformation,
 871                                  Kbio, KbioLength, &ResultLength );
 872
 873         if( Status == STATUS_BUFFER_TOO_SMALL || Status == STATUS_BUFFER_OVERFLOW ) {
 874             ExFreePool( Kbio );
 875             KbioLength = ResultLength;
 876             Kbio = ExAllocatePool( NonPagedPool, KbioLength );
 877             if( !Kbio ) {
 878                 TI_DbgPrint(DEBUG_DATALINK,("Failed to allocate memory\n"));
 879                 NtClose( EnumKey );
 880                 return STATUS_NO_MEMORY;
 881             }
 882
 883             Status = ZwEnumerateKey( EnumKey, i, KeyBasicInformation,
 884                                      Kbio, KbioLength, &ResultLength );
 885
 886             if( !NT_SUCCESS(Status) ) {
 887                 TI_DbgPrint(DEBUG_DATALINK,("Couldn't enum key child %d\n", i));
 888                 NtClose( EnumKey );
 889                 ExFreePool( Kbio );
 890                 return Status;
 891             }
 892         }
 893
 894         if( NT_SUCCESS(Status) ) {
 895             TargetKeyName.Length = TargetKeyName.MaximumLength =
 896                 Kbio->NameLength;
 897             TargetKeyName.Buffer = Kbio->Name;
 898
 899             Status = CheckForDeviceDesc
 900                 ( &EnumKeyName, &TargetKeyName, Name, DeviceDesc );
 901             if( NT_SUCCESS(Status) ) {
 902                 NtClose( EnumKey );
 903                 ExFreePool( Kbio );
 904                 return Status;
 905             } else Status = STATUS_SUCCESS;
 906         }
 907     }
 908
 909     NtClose( EnumKey );
 910     ExFreePool( Kbio );
 911     return STATUS_UNSUCCESSFUL;
 912 }
 913
 914 VOID GetName( PUNICODE_STRING RegistryKey,
 915               PUNICODE_STRING OutName ) {
 916     PWCHAR Ptr;
 917     UNICODE_STRING PartialRegistryKey;
 918
 919     PartialRegistryKey.Buffer =
 920         RegistryKey->Buffer + wcslen(CCS_ROOT L"\\Services\\");
 921     Ptr = PartialRegistryKey.Buffer;
 922
 923     while( *Ptr != L'\\' &&
 924            ((PCHAR)Ptr) < ((PCHAR)RegistryKey->Buffer) + RegistryKey->Length )
 925         Ptr++;
 926
 927     PartialRegistryKey.Length = PartialRegistryKey.MaximumLength =
 928         (Ptr - PartialRegistryKey.Buffer) * sizeof(WCHAR);
 929
 930     RtlInitUnicodeString( OutName, L"" );
 931     AppendUnicodeString( OutName, &PartialRegistryKey, FALSE );
 932 }
 933
 934 BOOLEAN BindAdapter(
 935     PLAN_ADAPTER Adapter,
 936     PNDIS_STRING RegistryPath)
 937 /*
 938  * FUNCTION: Binds a LAN adapter to IP layer
 939  * ARGUMENTS:
 940  *     Adapter = Pointer to LAN_ADAPTER structure
 941  * NOTES:
 942  *    We set the lookahead buffer size, set the packet filter and
 943  *    bind the adapter to IP layer
 944  */
 945 {
 946     PIP_INTERFACE IF;
 947     NDIS_STATUS NdisStatus;
 948     LLIP_BIND_INFO BindInfo;
 949     IP_ADDRESS DefaultMask, Router;
 950     ULONG Lookahead = LOOKAHEAD_SIZE, Unused;
 951     NTSTATUS Status;
 952     OBJECT_ATTRIBUTES ObjectAttributes;
 953     HANDLE ParameterHandle;
 954     PKEY_VALUE_PARTIAL_INFORMATION KeyValueInfo;
 955     UNICODE_STRING IPAddress = RTL_CONSTANT_STRING(L"IPAddress");
 956     UNICODE_STRING Netmask = RTL_CONSTANT_STRING(L"SubnetMask");
 957     UNICODE_STRING Gateway = RTL_CONSTANT_STRING(L"DefaultGateway");
 958     UNICODE_STRING RegistryDataU;
 959     ANSI_STRING RegistryDataA;
 960
 961     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
 962
 963     Adapter->State = LAN_STATE_OPENING;
 964
 965     NdisStatus = NDISCall(Adapter,
 966                           NdisRequestSetInformation,
 967                           OID_GEN_CURRENT_LOOKAHEAD,
 968                           &Lookahead,
 969                           sizeof(ULONG));
 970     if (NdisStatus != NDIS_STATUS_SUCCESS) {
 971         TI_DbgPrint(DEBUG_DATALINK, ("Could not set lookahead buffer size (0x%X).\n", NdisStatus));
 972         return FALSE;
 973     }
 974
 975     /* Bind the adapter to IP layer */
 976     BindInfo.Context       = Adapter;
 977     BindInfo.HeaderSize    = Adapter->HeaderSize;
 978     BindInfo.MinFrameSize  = Adapter->MinFrameSize;
 979     BindInfo.MTU           = Adapter->MTU;
 980     BindInfo.Address       = (PUCHAR)&Adapter->HWAddress;
 981     BindInfo.AddressLength = Adapter->HWAddressLength;
 982     BindInfo.Transmit      = LANTransmit;
 983
 984     IF = IPCreateInterface(&BindInfo);
 985
 986     if (!IF) {
 987         TI_DbgPrint(MIN_TRACE, ("Insufficient resources.\n"));
 988         return FALSE;
 989     }
 990
 991     /*
 992      * Query per-adapter configuration from the registry
 993      * In case anyone is curious:  there *is* an Ndis configuration api
 994      * for this sort of thing, but it doesn't really support things like
 995      * REG_MULTI_SZ very well, and there is a note in the DDK that says that
 996      * protocol drivers developed for win2k and above just use the native
 997      * services (ZwOpenKey, etc).
 998      */
 999
1000     GetName( RegistryPath, &IF->Name );
1001
1002     Status = FindDeviceDescForAdapter( &IF->Name, &IF->Description );
1003     if (!NT_SUCCESS(Status)) {
1004         TI_DbgPrint(MIN_TRACE, ("Failed to get device description.\n"));
1005         IPDestroyInterface(IF);
1006         return FALSE;
1007     }
1008
1009     TI_DbgPrint(DEBUG_DATALINK,("Adapter Description: %wZ\n",
1010                 &IF->Description));
1011
1012     DbgPrint("Opening %wZ\n", RegistryPath);
1013
1014     InitializeObjectAttributes(&ObjectAttributes,
1015                                RegistryPath,
1016                                OBJ_CASE_INSENSITIVE,
1017                                0,
1018                                NULL);
1019
1020     AddrInitIPv4(&DefaultMask, 0);
1021
1022     Status = ZwOpenKey(&ParameterHandle, KEY_READ, &ObjectAttributes);
1023     if (!NT_SUCCESS(Status))
1024     {
1025         IF->Unicast = DefaultMask;
1026         IF->Netmask = DefaultMask;
1027     }
1028     else
1029     {
1030         KeyValueInfo = ExAllocatePool(PagedPool, sizeof(KEY_VALUE_PARTIAL_INFORMATION) + 16 * sizeof(WCHAR));
1031         if (!KeyValueInfo)
1032         {
1033             ZwClose(ParameterHandle);
1034             IPDestroyInterface(IF);
1035             return FALSE;
1036         }
1037
1038         RegistryDataU.MaximumLength = 16 + sizeof(WCHAR);
1039         RegistryDataU.Buffer = (PWCHAR)KeyValueInfo->Data;
1040
1041         Status = ZwQueryValueKey(ParameterHandle,
1042                                  &IPAddress,
1043                                  KeyValuePartialInformation,
1044                                  KeyValueInfo,
1045                                  sizeof(KEY_VALUE_PARTIAL_INFORMATION) + 16 * sizeof(WCHAR),
1046                                  &Unused);
1047         if (NT_SUCCESS(Status))
1048         {
1049             RegistryDataU.Length = KeyValueInfo->DataLength;
1050
1051             RtlUnicodeStringToAnsiString(&RegistryDataA,
1052                                          &RegistryDataU,
1053                                          TRUE);
1054
1055             AddrInitIPv4(&IF->Unicast, inet_addr(RegistryDataA.Buffer));
1056
1057             RtlFreeAnsiString(&RegistryDataA);
1058
1059         }
1060         else
1061         {
1062             IF->Unicast = DefaultMask;
1063         }
1064
1065         Status = ZwQueryValueKey(ParameterHandle,
1066                                  &Netmask,
1067                                  KeyValuePartialInformation,
1068                                  KeyValueInfo,
1069                                  sizeof(KEY_VALUE_PARTIAL_INFORMATION) + 16 * sizeof(WCHAR),
1070                                  &Unused);
1071         if (NT_SUCCESS(Status))
1072         {
1073             RegistryDataU.Length = KeyValueInfo->DataLength;
1074
1075             RtlUnicodeStringToAnsiString(&RegistryDataA,
1076                                          &RegistryDataU,
1077                                          TRUE);
1078
1079             AddrInitIPv4(&IF->Netmask, inet_addr(RegistryDataA.Buffer));
1080
1081             RtlFreeAnsiString(&RegistryDataA);
1082         }
1083         else
1084         {
1085             IF->Netmask = DefaultMask;
1086         }
1087
1088         Status = ZwQueryValueKey(ParameterHandle,
1089                                  &Gateway,
1090                                  KeyValuePartialInformation,
1091                                  KeyValueInfo,
1092                                  sizeof(KEY_VALUE_PARTIAL_INFORMATION) + 16 * sizeof(WCHAR),
1093                                  &Unused);
1094         if (NT_SUCCESS(Status))
1095         {
1096             RegistryDataU.Length = KeyValueInfo->DataLength;
1097
1098             RtlUnicodeStringToAnsiString(&RegistryDataA,
1099                                          &RegistryDataU,
1100                                          TRUE);
1101
1102             AddrInitIPv4(&Router, inet_addr(RegistryDataA.Buffer));
1103
1104             RtlFreeAnsiString(&RegistryDataA);
1105
1106             if (!AddrIsUnspecified(&Router)) RouterCreateRoute(&DefaultMask, &DefaultMask, &Router, IF, 1);
1107         }
1108
1109         ZwClose(ParameterHandle);
1110     }
1111
1112     IF->Broadcast.Type = IP_ADDRESS_V4;
1113     IF->Broadcast.Address.IPv4Address =
1114         IF->Unicast.Address.IPv4Address |
1115         ~IF->Netmask.Address.IPv4Address;
1116
1117     TI_DbgPrint(DEBUG_DATALINK,("BCAST(IF) %s\n", A2S(&IF->Broadcast)));
1118
1119     /* Get maximum link speed */
1120     NdisStatus = NDISCall(Adapter,
1121                           NdisRequestQueryInformation,
1122                           OID_GEN_LINK_SPEED,
1123                           &IF->Speed,
1124                           sizeof(UINT));
1125
1126     if( !NT_SUCCESS(NdisStatus) )
1127         IF->Speed = IP_DEFAULT_LINK_SPEED;
1128
1129     /* Register interface with IP layer */
1130     IPRegisterInterface(IF);
1131
1132     /* Set packet filter so we can send and receive packets */
1133     NdisStatus = NDISCall(Adapter,
1134                           NdisRequestSetInformation,
1135                           OID_GEN_CURRENT_PACKET_FILTER,
1136                           &Adapter->PacketFilter,
1137                           sizeof(UINT));
1138
1139     if (NdisStatus != NDIS_STATUS_SUCCESS) {
1140         TI_DbgPrint(DEBUG_DATALINK, ("Could not set packet filter (0x%X).\n", NdisStatus));
1141         IPUnregisterInterface(IF);
1142         IPDestroyInterface(IF);
1143         return FALSE;
1144     }
1145
1146     Adapter->Context = IF;
1147     Adapter->State = LAN_STATE_STARTED;
1148     return TRUE;
1149 }
1150
1151
1152 VOID UnbindAdapter(
1153     PLAN_ADAPTER Adapter)
1154 /*
1155  * FUNCTION: Unbinds a LAN adapter from IP layer
1156  * ARGUMENTS:
1157  *     Adapter = Pointer to LAN_ADAPTER structure
1158  */
1159 {
1160     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
1161
1162     if (Adapter->State == LAN_STATE_STARTED) {
1163         PIP_INTERFACE IF = Adapter->Context;
1164
1165         IPUnregisterInterface(IF);
1166
1167         IPDestroyInterface(IF);
1168     }
1169 }
1170
1171
1172 NDIS_STATUS LANRegisterAdapter(
1173     PNDIS_STRING AdapterName,
1174     PNDIS_STRING RegistryPath)
1175 /*
1176  * FUNCTION: Registers protocol with an NDIS adapter
1177  * ARGUMENTS:
1178  *     AdapterName = Pointer to string with name of adapter to register
1179  *     Adapter     = Address of pointer to a LAN_ADAPTER structure
1180  * RETURNS:
1181  *     Status of operation
1182  */
1183 {
1184     PLAN_ADAPTER IF;
1185     NDIS_STATUS NdisStatus;
1186     NDIS_STATUS OpenStatus;
1187     UINT MediaIndex;
1188     NDIS_MEDIUM MediaArray[MAX_MEDIA];
1189     UINT AddressOID;
1190     UINT Speed;
1191
1192     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
1193
1194     IF = ExAllocatePoolWithTag(NonPagedPool, sizeof(LAN_ADAPTER), LAN_ADAPTER_TAG);
1195     if (!IF) {
1196         TI_DbgPrint(MIN_TRACE, ("Insufficient resources.\n"));
1197         return NDIS_STATUS_RESOURCES;
1198     }
1199
1200     RtlZeroMemory(IF, sizeof(LAN_ADAPTER));
1201
1202     /* Put adapter in stopped state */
1203     IF->State = LAN_STATE_STOPPED;
1204
1205     /* Initialize protecting spin lock */
1206     KeInitializeSpinLock(&IF->Lock);
1207
1208     KeInitializeEvent(&IF->Event, SynchronizationEvent, FALSE);
1209
1210     /* Initialize array with media IDs we support */
1211     MediaArray[MEDIA_ETH] = NdisMedium802_3;
1212
1213     TI_DbgPrint(DEBUG_DATALINK,("opening adapter %wZ\n", AdapterName));
1214     /* Open the adapter. */
1215     NdisOpenAdapter(&NdisStatus,
1216                     &OpenStatus,
1217                     &IF->NdisHandle,
1218                     &MediaIndex,
1219                     MediaArray,
1220                     MAX_MEDIA,
1221                     NdisProtocolHandle,
1222                     IF,
1223                     AdapterName,
1224                     0,
1225                     NULL);
1226
1227     /* Wait until the adapter is opened */
1228     if (NdisStatus == NDIS_STATUS_PENDING)
1229         KeWaitForSingleObject(&IF->Event, UserRequest, KernelMode, FALSE, NULL);
1230     else if (NdisStatus != NDIS_STATUS_SUCCESS) {
1231         TI_DbgPrint(DEBUG_DATALINK,("denying adapter %wZ\n", AdapterName));
1232         ExFreePoolWithTag(IF, LAN_ADAPTER_TAG);
1233         return NdisStatus;
1234     }
1235
1236     IF->Media = MediaArray[MediaIndex];
1237
1238     /* Fill LAN_ADAPTER structure with some adapter specific information */
1239     switch (IF->Media) {
1240     case NdisMedium802_3:
1241         IF->HWAddressLength = IEEE_802_ADDR_LENGTH;
1242         IF->BCastMask       = BCAST_ETH_MASK;
1243         IF->BCastCheck      = BCAST_ETH_CHECK;
1244         IF->BCastOffset     = BCAST_ETH_OFFSET;
1245         IF->HeaderSize      = sizeof(ETH_HEADER);
1246         IF->MinFrameSize    = 60;
1247         AddressOID          = OID_802_3_CURRENT_ADDRESS;
1248         IF->PacketFilter    =
1249             NDIS_PACKET_TYPE_BROADCAST |
1250             NDIS_PACKET_TYPE_DIRECTED  |
1251             NDIS_PACKET_TYPE_MULTICAST;
1252         break;
1253
1254     default:
1255         /* Unsupported media */
1256         TI_DbgPrint(MIN_TRACE, ("Unsupported media.\n"));
1257         ExFreePoolWithTag(IF, LAN_ADAPTER_TAG);
1258         return NDIS_STATUS_NOT_SUPPORTED;
1259     }
1260
1261     /* Get maximum frame size */
1262     NdisStatus = NDISCall(IF,
1263                           NdisRequestQueryInformation,
1264                           OID_GEN_MAXIMUM_FRAME_SIZE,
1265                           &IF->MTU,
1266                           sizeof(UINT));
1267     if (NdisStatus != NDIS_STATUS_SUCCESS) {
1268         TI_DbgPrint(DEBUG_DATALINK,("denying adapter %wZ (NDISCall)\n", AdapterName));
1269         ExFreePoolWithTag(IF, LAN_ADAPTER_TAG);
1270         return NdisStatus;
1271     }
1272
1273     /* Get maximum packet size */
1274     NdisStatus = NDISCall(IF,
1275                           NdisRequestQueryInformation,
1276                           OID_GEN_MAXIMUM_TOTAL_SIZE,
1277                           &IF->MaxPacketSize,
1278                           sizeof(UINT));
1279     if (NdisStatus != NDIS_STATUS_SUCCESS) {
1280         TI_DbgPrint(MIN_TRACE, ("Query for maximum packet size failed.\n"));
1281         ExFreePoolWithTag(IF, LAN_ADAPTER_TAG);
1282         return NdisStatus;
1283     }
1284
1285     /* Get maximum number of packets we can pass to NdisSend(Packets) at one time */
1286     NdisStatus = NDISCall(IF,
1287                           NdisRequestQueryInformation,
1288                           OID_GEN_MAXIMUM_SEND_PACKETS,
1289                           &IF->MaxSendPackets,
1290                           sizeof(UINT));
1291     if (NdisStatus != NDIS_STATUS_SUCCESS)
1292         /* Legacy NIC drivers may not support this query, if it fails we
1293            assume it can send at least one packet per call to NdisSend(Packets) */
1294         IF->MaxSendPackets = 1;
1295
1296     /* Get current hardware address */
1297     NdisStatus = NDISCall(IF,
1298                           NdisRequestQueryInformation,
1299                           AddressOID,
1300                           &IF->HWAddress,
1301                           IF->HWAddressLength);
1302     if (NdisStatus != NDIS_STATUS_SUCCESS) {
1303         TI_DbgPrint(MIN_TRACE, ("Query for current hardware address failed.\n"));
1304         ExFreePoolWithTag(IF, LAN_ADAPTER_TAG);
1305         return NdisStatus;
1306     }
1307
1308     /* Get maximum link speed */
1309     NdisStatus = NDISCall(IF,
1310                           NdisRequestQueryInformation,
1311                           OID_GEN_LINK_SPEED,
1312                           &Speed,
1313                           sizeof(UINT));
1314     if (NdisStatus != NDIS_STATUS_SUCCESS) {
1315         TI_DbgPrint(MIN_TRACE, ("Query for maximum link speed failed.\n"));
1316         ExFreePoolWithTag(IF, LAN_ADAPTER_TAG);
1317         return NdisStatus;
1318     }
1319
1320     /* Convert returned link speed to bps (it is in 100bps increments) */
1321     IF->Speed = Speed * 100L;
1322
1323     /* Bind adapter to IP layer */
1324     if( !BindAdapter(IF, RegistryPath) ) {
1325         TI_DbgPrint(DEBUG_DATALINK,("denying adapter %wZ (BindAdapter)\n", AdapterName));
1326         ExFreePoolWithTag(IF, LAN_ADAPTER_TAG);
1327         return NDIS_STATUS_NOT_ACCEPTED;
1328     }
1329
1330     /* Add adapter to the adapter list */
1331     ExInterlockedInsertTailList(&AdapterListHead,
1332                                 &IF->ListEntry,
1333                                 &AdapterListLock);
1334
1335     TI_DbgPrint(DEBUG_DATALINK, ("Leaving.\n"));
1336
1337     return NDIS_STATUS_SUCCESS;
1338 }
1339
1340
1341 NDIS_STATUS LANUnregisterAdapter(
1342     PLAN_ADAPTER Adapter)
1343 /*
1344  * FUNCTION: Unregisters protocol with NDIS adapter
1345  * ARGUMENTS:
1346  *     Adapter = Pointer to a LAN_ADAPTER structure
1347  * RETURNS:
1348  *     Status of operation
1349  */
1350 {
1351     KIRQL OldIrql;
1352     NDIS_HANDLE NdisHandle;
1353     NDIS_STATUS NdisStatus = NDIS_STATUS_SUCCESS;
1354
1355     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
1356
1357     /* Unlink the adapter from the list */
1358     RemoveEntryList(&Adapter->ListEntry);
1359
1360     /* Unbind adapter from IP layer */
1361     UnbindAdapter(Adapter);
1362
1363     TcpipAcquireSpinLock(&Adapter->Lock, &OldIrql);
1364     NdisHandle = Adapter->NdisHandle;
1365     if (NdisHandle) {
1366         Adapter->NdisHandle = NULL;
1367         TcpipReleaseSpinLock(&Adapter->Lock, OldIrql);
1368
1369         NdisCloseAdapter(&NdisStatus, NdisHandle);
1370         if (NdisStatus == NDIS_STATUS_PENDING) {
1371             TcpipWaitForSingleObject(&Adapter->Event,
1372                                      UserRequest,
1373                                      KernelMode,
1374                                      FALSE,
1375                                      NULL);
1376             NdisStatus = Adapter->NdisStatus;
1377         }
1378     } else
1379         TcpipReleaseSpinLock(&Adapter->Lock, OldIrql);
1380
1381     FreeAdapter(Adapter);
1382
1383     return NdisStatus;
1384 }
1385
1386 VOID
1387 NTAPI
1388 LANUnregisterProtocol(VOID)
1389 /*
1390  * FUNCTION: Unregisters this protocol driver with NDIS
1391  * NOTES: Does not care wether we are already registered
1392  */
1393 {
1394     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
1395
1396     if (ProtocolRegistered) {
1397         NDIS_STATUS NdisStatus;
1398         PLIST_ENTRY CurrentEntry;
1399         PLIST_ENTRY NextEntry;
1400         PLAN_ADAPTER Current;
1401         KIRQL OldIrql;
1402
1403         TcpipAcquireSpinLock(&AdapterListLock, &OldIrql);
1404
1405         /* Search the list and remove every adapter we find */
1406         CurrentEntry = AdapterListHead.Flink;
1407         while (CurrentEntry != &AdapterListHead) {
1408             NextEntry = CurrentEntry->Flink;
1409             Current = CONTAINING_RECORD(CurrentEntry, LAN_ADAPTER, ListEntry);
1410             /* Unregister it */
1411             LANUnregisterAdapter(Current);
1412             CurrentEntry = NextEntry;
1413         }
1414
1415         TcpipReleaseSpinLock(&AdapterListLock, OldIrql);
1416
1417         NdisDeregisterProtocol(&NdisStatus, NdisProtocolHandle);
1418         ProtocolRegistered = FALSE;
1419     }
1420 }
1421
1422 VOID
1423 NTAPI
1424 ProtocolUnbindAdapter(
1425     PNDIS_STATUS Status,
1426     NDIS_HANDLE ProtocolBindingContext,
1427     NDIS_HANDLE UnbindContext)
1428 {
1429     /* We don't pend any unbinding so we can just ignore UnbindContext */
1430     *Status = LANUnregisterAdapter((PLAN_ADAPTER)ProtocolBindingContext);
1431 }
1432
1433 NTSTATUS LANRegisterProtocol(
1434     PNDIS_STRING Name)
1435 /*
1436  * FUNCTION: Registers this protocol driver with NDIS
1437  * ARGUMENTS:
1438  *     Name = Name of this protocol driver
1439  * RETURNS:
1440  *     Status of operation
1441  */
1442 {
1443     NDIS_STATUS NdisStatus;
1444     NDIS_PROTOCOL_CHARACTERISTICS ProtChars;
1445
1446     TI_DbgPrint(DEBUG_DATALINK, ("Called.\n"));
1447
1448     InitializeListHead(&AdapterListHead);
1449     KeInitializeSpinLock(&AdapterListLock);
1450
1451     /* Set up protocol characteristics */
1452     RtlZeroMemory(&ProtChars, sizeof(NDIS_PROTOCOL_CHARACTERISTICS));
1453     ProtChars.MajorNdisVersion               = NDIS_VERSION_MAJOR;
1454     ProtChars.MinorNdisVersion               = NDIS_VERSION_MINOR;
1455     ProtChars.Name.Length                    = Name->Length;
1456     ProtChars.Name.Buffer                    = Name->Buffer;
1457     ProtChars.Name.MaximumLength             = Name->MaximumLength;
1458     ProtChars.OpenAdapterCompleteHandler     = ProtocolOpenAdapterComplete;
1459     ProtChars.CloseAdapterCompleteHandler    = ProtocolCloseAdapterComplete;
1460     ProtChars.ResetCompleteHandler           = ProtocolResetComplete;
1461     ProtChars.RequestCompleteHandler         = ProtocolRequestComplete;
1462     ProtChars.SendCompleteHandler            = ProtocolSendComplete;
1463     ProtChars.TransferDataCompleteHandler    = ProtocolTransferDataComplete;
1464     ProtChars.ReceiveHandler                 = ProtocolReceive;
1465     ProtChars.ReceiveCompleteHandler         = ProtocolReceiveComplete;
1466     ProtChars.StatusHandler                  = ProtocolStatus;
1467     ProtChars.StatusCompleteHandler          = ProtocolStatusComplete;
1468     ProtChars.BindAdapterHandler             = ProtocolBindAdapter;
1469     ProtChars.PnPEventHandler                = ProtocolPnPEvent;
1470     ProtChars.UnbindAdapterHandler           = ProtocolUnbindAdapter;
1471     ProtChars.UnloadHandler                  = LANUnregisterProtocol;
1472
1473     /* Try to register protocol */
1474     NdisRegisterProtocol(&NdisStatus,
1475                          &NdisProtocolHandle,
1476                          &ProtChars,
1477                          sizeof(NDIS_PROTOCOL_CHARACTERISTICS));
1478     if (NdisStatus != NDIS_STATUS_SUCCESS)
1479     {
1480         TI_DbgPrint(DEBUG_DATALINK, ("NdisRegisterProtocol failed, status 0x%x\n", NdisStatus));
1481         return (NTSTATUS)NdisStatus;
1482     }
1483
1484     ProtocolRegistered = TRUE;
1485
1486     return STATUS_SUCCESS;
1487 }
1488
1489 /* EOF */