main.c

Go to the documentation of this file.

/*
 * COPYRIGHT:   See COPYING in the top level directory
 * PROJECT:     ReactOS NDIS library
 * FILE:        ndis/main.c
 * PURPOSE:     Driver entry point
 * PROGRAMMERS: Casper S. Hornstrup (chorns@users.sourceforge.net)
 *              Vizzini (vizzini@plasmic.com)
 * REVISIONS:
 *   CSH 01/08-2000 Created
 *   20 Aug 2003 Vizzini - NDIS4/5 revisions
 *   3  Oct 2003 Vizzini - formatting and minor bugfixing
 */
 
#include "ndissys.h"
 
#if DBG
 
/* See debug.h for debug/trace constants */
ULONG DebugTraceLevel = MIN_TRACE;
 
#endif /* DBG */
 
LONG CancelId;
 
ULONG NdisEnableTxRxFlowControl;
 
static
CODE_SEG("INIT")
VOID
NdisReadRegistryEntries(VOID)
{
    RTL_QUERY_REGISTRY_TABLE QueryTable[2];
    ULONG AllowFlowControlUnderDebugger;
 
    /* Set defaults */
    NdisEnableTxRxFlowControl = TRUE;
    AllowFlowControlUnderDebugger = FALSE;
 
    RtlZeroMemory(QueryTable, sizeof(QueryTable));
 
    QueryTable[0].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_QUERY_REGISTRY_TYPECHECK;
    QueryTable[0].Name = L"AllowFlowControlUnderDebugger";
    QueryTable[0].EntryContext = &AllowFlowControlUnderDebugger;
    QueryTable[0].DefaultType = (REG_DWORD << RTL_QUERY_REGISTRY_TYPECHECK_SHIFT) | REG_DWORD;
    QueryTable[0].DefaultData = &AllowFlowControlUnderDebugger;
    QueryTable[0].DefaultLength = sizeof(ULONG);
 
    RtlQueryRegistryValues(RTL_REGISTRY_SERVICES,
                           L"NDIS\\Parameters",
                           QueryTable,
                           NULL,
                           NULL);
 
    /*
     * Disable flow control when a Kernel Debugger is attached.
     *
     * When the debugger stops at a breakpoint the NIC keeps frame reception,
     * which could eventually cause the receiver to run out of buffers.
     * At this point, the NIC may start spamming pause frames.
     * This is undesirable for some use cases.
     */
    if (KD_DEBUGGER_ENABLED)
        NdisEnableTxRxFlowControl = AllowFlowControlUnderDebugger;
}
 
VOID NTAPI MainUnload(
    PDRIVER_OBJECT DriverObject)
/*
 * FUNCTION: Unloads the driver
 * ARGUMENTS:
 *     DriverObject = Pointer to driver object created by the system
 */
{
  NDIS_DbgPrint(MAX_TRACE, ("Leaving.\n"));
}
 
CODE_SEG("INIT")
NTSTATUS
NTAPI
DriverEntry(
    PDRIVER_OBJECT DriverObject,
    PUNICODE_STRING RegistryPath)
/*
 * FUNCTION: Main driver entry point
 * ARGUMENTS:
 *     DriverObject = Pointer to a driver object for this driver
 *     RegistryPath = Registry node for configuration parameters
 * RETURNS:
 *     Status of driver initialization
 */
{
  NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));
 
  InitializeListHead(&ProtocolListHead);
  KeInitializeSpinLock(&ProtocolListLock);
 
  InitializeListHead(&MiniportListHead);
  KeInitializeSpinLock(&MiniportListLock);
 
  InitializeListHead(&AdapterListHead);
  KeInitializeSpinLock(&AdapterListLock);
 
  DriverObject->DriverUnload = MainUnload;
 
  CancelId = 0;
 
  NdisReadRegistryEntries();
 
  return STATUS_SUCCESS;
}
 
 
/*
 * @implemented
 */
VOID
_cdecl
NdisWriteErrorLogEntry(
    IN  NDIS_HANDLE     NdisAdapterHandle,
    IN  NDIS_ERROR_CODE ErrorCode,
    IN  ULONG           NumberOfErrorValues,
    ...)
/*
 * FUNCTION: Write a syslog error
 * ARGUMENTS:
 *     NdisAdapterHandle:  Handle passed into MiniportInitialize
 *     ErrorCode:  32-bit error code to be logged
 *     NumberOfErrorValues: number of errors to log
 *     Variable: list of log items
 * NOTES:
 *     - THIS IS >CDECL<
 *     - This needs to be fixed to do var args
 *     - FIXME - this needs to be properly implemented once we have an event log
 */
{
  NDIS_DbgPrint(MIN_TRACE, ("ERROR: ErrorCode 0x%x\n", ErrorCode));
  /* ASSERT(0); */
}
 
 
/*
 * @implemented
 */
NDIS_STATUS
EXPORT
NdisWriteEventLogEntry(
    IN  PVOID       LogHandle,
    IN  NDIS_STATUS EventCode,
    IN  ULONG       UniqueEventValue,
    IN  USHORT      NumStrings,
    IN  PVOID       StringsList OPTIONAL,
    IN  ULONG       DataSize,
    IN  PVOID       Data        OPTIONAL)
/*
 * FUNCTION: Log an event in the system event log
 * ARGUMENTS:
 *     LogHandle: pointer to the driver object of the protocol logging the event
 *     EventCode: NDIS_STATUS_XXX describing the event
 *     UniqueEventValue: identifies this instance of the error value
 *     NumStrings: number of strings in StringList
 *     StringList: list of strings to log
 *     DataSize: number of bytes in Data
 *     Data: binary dump data to help analyzing the event
 * NOTES:
 *     - NTAPI, not CDECL like WriteError...
 *     - FIXME Needs to use the real log interface, once there is one
 */
{
  /*
   * just returning true until we have an event log
   */
  NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));
  return NDIS_STATUS_SUCCESS;
}
 
/* EOF */