wds_lib.h

Go to the documentation of this file.

/* @JUNGO_COPYRIGHT@ */
 
#ifndef _WDS_LIB_H_
#define _WDS_LIB_H_
 
/*********************************************************************
*  File: wds_lib.h - WD Shared (WDS) library header.                 *
*                    This file defines the WDS library's high-level  *
*                    interface                                       *
**********************************************************************/
 
#if defined(__KERNEL__)
    #include "kpstdlib.h"
#endif
 
#include "windrvr.h"
#include "wdc_lib.h"
 
#ifdef __cplusplus
    extern "C" {
#endif
 
/**************************************************************
  General definitions
 **************************************************************/
 
/* -------------------------------------------------------------------------
    IPC
   ------------------------------------------------------------------------- */
/* IPC API functions are not part of the standard WinDriver API, and not
 * included in the standard version of WinDriver. The functions are part of
 * "WinDriver for Server" API and require "WinDriver for Server" license.
 * Note that "WinDriver for Server" APIs are included in WinDriver evaluation
 * version. */
 
typedef struct {
    DWORD          dwNumProcs; 
    WD_IPC_PROCESS procInfo[WD_IPC_MAX_PROCS]; 
} WDS_IPC_SCAN_RESULT;
 
typedef struct {
    DWORD   dwSenderUID; 
    DWORD   dwMsgID; 
    UINT64  qwMsgData; 
} WDS_IPC_MSG_RX;
 
 
typedef void (*IPC_MSG_RX_HANDLER)(_In_ WDS_IPC_MSG_RX *pIpcRxMsg,
    _In_ void *pData);
 
BOOL DLLCALLCONV WDS_IsIpcRegistered(void);
 
DWORD DLLCALLCONV WDS_IpcRegister(_In_ const CHAR *pcProcessName,
    _In_ DWORD dwGroupID, _In_ DWORD dwSubGroupID, _In_ DWORD dwAction,
    _In_ IPC_MSG_RX_HANDLER pFunc, _In_ void *pData);
 
void DLLCALLCONV WDS_IpcUnRegister(void);
 
DWORD DLLCALLCONV WDS_IpcScanProcs(
    _Outptr_ WDS_IPC_SCAN_RESULT *pIpcScanResult);
 
 
DWORD DLLCALLCONV WDS_IpcUidUnicast(_In_ DWORD dwRecipientUID,
    _In_ DWORD dwMsgID, _In_ UINT64 qwMsgData);
 
DWORD DLLCALLCONV WDS_IpcSubGroupMulticast(_In_ DWORD dwRecipientSubGroupID,
    _In_ DWORD dwMsgID, _In_ UINT64 qwMsgData);
 
DWORD DLLCALLCONV WDS_IpcMulticast(_In_ DWORD dwMsgID, _In_ UINT64 qwMsgData);
 
/* -------------------------------------------------------------------------
    Shared Buffers (User-Mode <-> Kernel Mode) / (User-Mode <-> User-Mode)
   ------------------------------------------------------------------------- */
/*
 * Kernel buffers can be used to share data between:
 * 1) User-mode application and a Kernel PlugIn driver.
 * 2) Multiple user-mode applications.
 */
 
DWORD DLLCALLCONV WDS_SharedBufferAlloc(_In_ UINT64 qwBytes,
    _In_ DWORD dwOptions, _Outptr_ WD_KERNEL_BUFFER **ppKerBuf);
 
 
#define WDS_SharedBufferGetGlobalHandle(pKerBuf) ((pKerBuf)->hKerBuf)
 
DWORD DLLCALLCONV WDS_SharedBufferGet(_In_ DWORD hKerBuf,
    _Outptr_ WD_KERNEL_BUFFER **ppKerBuf);
 
 
DWORD DLLCALLCONV WDS_SharedBufferFree(_In_ WD_KERNEL_BUFFER *pKerBuf);
 
DWORD DLLCALLCONV WDS_SharedIntEnable(_In_ const CHAR *pcProcessName,
    _In_ DWORD dwGroupID, _In_ DWORD dwSubGroupID, _In_ DWORD dwAction,
    _In_ IPC_MSG_RX_HANDLER pFunc, _In_ void *pData);
 
DWORD DLLCALLCONV WDS_SharedIntDisableGlobal(void);
 
 
DWORD DLLCALLCONV WDS_SharedIntDisableLocal(void);
 
 
BOOL DLLCALLCONV WDS_IsSharedIntsEnabledLocally(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _WDS_LIB_H_ */