uscrdbg.h

usblsccid-0.9.2: ED1x Smart Card Reader Driver

/*++

Copyright (c) 2004  QWY MicroSystem Inc.

Module Name:
    uscrdbg.h 

Abstract:
    USB SmartCard Reader driver for CCID/lsCCID compatible device.

Environment:
    kernel mode only

Notes:

Revision History:
    4/24/2005: Adapted from BULKUSB DDK sample.
--*/


#ifndef USCRDBGH_INCD
#define USCRDBGH_INCD

#if DBG

// Defines for debug verbosity level,
//   i.e., test USCR_KdPrintLevel( n, format....) against these values
//  Example:
//
// USCR_KdPrint( DBGLVL_MEDIUM ,("Entering DriverEntry(), RegistryPath=\n    %ws\n", RegistryPath->Buffer ));
// 
//  The above will print iff gDebugLevel >= DBGLVL_MEDIUM
//
#define DBGLVL_OFF				0		// if gDebugLevel set to this, there is NO debug output	
#define DBGLVL_MINIMUM			1		// minimum verbosity	
#define DBGLVL_DEFAULT			2		// default verbosity level if no registry override
#define DBGLVL_MEDIUM			3		// medium verbosity
#define DBGLVL_HIGH				4		// highest 'safe' level (without severely affecting timing )
#define DBGLVL_MAXIMUM			5		// maximum level, may be dangerous



#ifndef DBGSTR_PREFIX
#define DBGSTR_PREFIX "USCR: " 
#endif


// registry path used for parameters global to all instances of the driver
#define USCR_REGISTRY_PARAMETERS_PATH  \
	L"\\REGISTRY\\Machine\\System\\CurrentControlSet\\SERVICES\\USBLSCCID\\Parameters"



#define DPRINT DbgPrint

#define TRAP() DbgBreakPoint();


#define USCR_DBGOUTSIZE		512


typedef struct _USCR_DBGDATA {

	// mirrors device extension pending io count
	ULONG PendingIoCount;

	// count of pipe errors detected during the life of this device instance
	ULONG PipeErrorCount;

	// count of pipe resets performed during the life of this device instance
	ULONG ResetPipeCount;

	// count of pipe resets performed during the life of this device instance
	ULONG AbortPipeCount;

} USCR_DBGDATA, *PUSCR_DBGDATA;

//these declared in debug 'c' file
extern int gDebugLevel; 
extern int gExAllocCount;
extern PUSCR_DBGDATA gpDbg; 


static const PCHAR szIrpMajFuncDesc[] =
{  // note this depends on corresponding values to the indexes in wdm.h
   "IRP_MJ_CREATE",
   "IRP_MJ_CREATE_NAMED_PIPE",
   "IRP_MJ_CLOSE",
   "IRP_MJ_READ",
   "IRP_MJ_WRITE",
   "IRP_MJ_QUERY_INFORMATION",
   "IRP_MJ_SET_INFORMATION",
   "IRP_MJ_QUERY_EA",
   "IRP_MJ_SET_EA",
   "IRP_MJ_FLUSH_BUFFERS",
   "IRP_MJ_QUERY_VOLUME_INFORMATION",
   "IRP_MJ_SET_VOLUME_INFORMATION",
   "IRP_MJ_DIRECTORY_CONTROL",
   "IRP_MJ_FILE_SYSTEM_CONTROL",
   "IRP_MJ_DEVICE_CONTROL",
   "IRP_MJ_INTERNAL_DEVICE_CONTROL",
   "IRP_MJ_SHUTDOWN",
   "IRP_MJ_LOCK_CONTROL",
   "IRP_MJ_CLEANUP",
   "IRP_MJ_CREATE_MAILSLOT",
   "IRP_MJ_QUERY_SECURITY",
   "IRP_MJ_SET_SECURITY",
   "IRP_MJ_POWER",          
   "IRP_MJ_SYSTEM_CONTROL", 
   "IRP_MJ_DEVICE_CHANGE",  
   "IRP_MJ_QUERY_QUOTA",    
   "IRP_MJ_SET_QUOTA",      
   "IRP_MJ_PNP"            
};
//IRP_MJ_MAXIMUM_FUNCTION defined in wdm.h


static const PCHAR szPnpMnFuncDesc[] =
{	// note this depends on corresponding values to the indexes in wdm.h 

    "IRP_MN_START_DEVICE",
    "IRP_MN_QUERY_REMOVE_DEVICE",
    "IRP_MN_REMOVE_DEVICE",
    "IRP_MN_CANCEL_REMOVE_DEVICE",
    "IRP_MN_STOP_DEVICE",
    "IRP_MN_QUERY_STOP_DEVICE",
    "IRP_MN_CANCEL_STOP_DEVICE",
    "IRP_MN_QUERY_DEVICE_RELATIONS",
    "IRP_MN_QUERY_INTERFACE",
    "IRP_MN_QUERY_CAPABILITIES",
    "IRP_MN_QUERY_RESOURCES",
    "IRP_MN_QUERY_RESOURCE_REQUIREMENTS",
    "IRP_MN_QUERY_DEVICE_TEXT",
    "IRP_MN_FILTER_RESOURCE_REQUIREMENTS",
    "IRP_MN_READ_CONFIG",
    "IRP_MN_WRITE_CONFIG",
    "IRP_MN_EJECT",
    "IRP_MN_SET_LOCK",
    "IRP_MN_QUERY_ID",
    "IRP_MN_QUERY_PNP_DEVICE_STATE",
    "IRP_MN_QUERY_BUS_INFORMATION",
    "IRP_MN_DEVICE_USAGE_NOTIFICATION",
	"IRP_MN_SURPRISE_REMOVAL"
};

#define IRP_PNP_MN_FUNCMAX	IRP_MN_SURPRISE_REMOVAL



static const PCHAR szSystemPowerState[] = 
{
    "PowerSystemUnspecified",
    "PowerSystemWorking",
    "PowerSystemSleeping1",
    "PowerSystemSleeping2",
    "PowerSystemSleeping3",
    "PowerSystemHibernate",
    "PowerSystemShutdown",
    "PowerSystemMaximum"
};

static const PCHAR szDevicePowerState[] = 
{
    "PowerDeviceUnspecified",
    "PowerDeviceD0",
    "PowerDeviceD1",
    "PowerDeviceD2",
    "PowerDeviceD3",
    "PowerDeviceMaximum"
};




BOOLEAN
USCR_GetRegistryDword(
    IN      PWCHAR    RegPath,
    IN      PWCHAR    ValueName,
    IN OUT  PULONG    Value
    );


#define USCR_KdPrintCond( ilev, cond, _x_) \
	if( gDebugLevel && ( ilev <= gDebugLevel ) && ( cond )) { \
			DPRINT( DBGSTR_PREFIX ); \
			DPRINT _x_ ; \
	}



#define USCR_KdPrint( ilev, _x_)  USCR_KdPrintCond( ilev, TRUE, _x_ )


#define USCR_TrapCond( ilev, cond ) if ( gDebugLevel && ( ilev <= gDebugLevel ) && (cond) ) TRAP()
#define USCR_Trap( ilev )	  USCR_TrapCond( ilev, TRUE )

#define ENTER(FunctionName) USCR_KdPrint(DBGLVL_HIGH, ("-> %s\n", #FunctionName));

#define EXIT(FunctionName) \
    { \
        USCR_KdPrint(DBGLVL_HIGH, ("<- %s\n", #FunctionName)); \
        return;  \
    }

#define RETURN(RetVal, FunctionName) \
    { \
        USCR_KdPrint(DBGLVL_HIGH, ("<- %s, ret = %x\n", #FunctionName, RetVal)); \
        return (RetVal); \
    }

#define USCR_ASSERT( cond ) ASSERT( cond )

#define USCR_StringForDevState( devState )  szDevicePowerState[ devState ] 

#define USCR_StringForSysState( sysState )  szSystemPowerState[ sysState ] 

#define USCR_StringForPnpMnFunc( mnfunc ) szPnpMnFuncDesc[ mnfunc ]

#define USCR_StringForIrpMjFunc(  mjfunc ) szIrpMajFuncDesc[ mjfunc ]

PVOID 
    USCR_ExAllocatePool(
        IN POOL_TYPE PoolType,
        IN ULONG NumberOfBytes
        );


VOID 
    USCR_ExFreePool(
        IN PVOID p
        );

void
hexdump(
	UCHAR *p,
	ULONG len
	);
#define HEXDUMP(buf,len) hexdump(buf,len)

void USCR_DumpCardCapabilities(PSMARTCARD_EXTENSION SmartcardExtension);
void USCR_ShowIoctlCode(PIRP Irp);
#else // if not DBG

// dummy definitions that go away in the retail build

#define USCR_KdPrintCond( ilev, cond, _x_) 
#define USCR_KdPrint( ilev, _x_)  
#define USCR_TrapCond( ilev, cond ) 
#define USCR_Trap( ilev )
#define USCR_ASSERT( cond )
#define USCR_StringForDevState( devState )
#define USCR_StringForSysState( sysState ) 
#define USCR_StringForPnpMnFunc( mnfunc )
#define USCR_StringForIrpMjFunc(  mjfunc ) 

#define USCR_ExAllocatePool( typ, siz )  ExAllocatePool( typ, siz )
#define USCR_ExFreePool( p )   ExFreePool( p )
#define ENTER(FunctionName)
#define EXIT(FunctionName)
#define RETURN(RetVal, FunctionName)
#define HEXDUMP(buf,len)
#define USCR_DumpCardCapabilities(PSMARTCARD_EXTENSION)
#endif //DBG

#endif // included