include/xdk/wdm.template.h

   1 /*
   2  * wdm.h
   3  *
   4  * Windows NT WDM Driver Developer Kit
   5  *
   6  * This file is part of the ReactOS DDK package.
   7  *
   8  * Contributors:
   9  *   Amine Khaldi
  10  *   Timo Kreuzer (timo.kreuzer@reactos.org)
  11  *
  12  * THIS SOFTWARE IS NOT COPYRIGHTED
  13  *
  14  * This source code is offered for use in the public domain. You may
  15  * use, modify or distribute it freely.
  16  *
  17  * This code is distributed in the hope that it will be useful but
  18  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  19  * DISCLAIMED. This includes but is not limited to warranties of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  21  *
  22  */
  23 #pragma once
  24
  25 #ifndef _WDMDDK_
  26 #define _WDMDDK_
  27
  28 /* Included via ntddk.h? */
  29 #ifndef _NTDDK_
  30 #define _NTDDK_
  31 #define _WDM_INCLUDED_
  32 #define _DDK_DRIVER_
  33 #define NO_INTERLOCKED_INTRINSICS
  34 #endif /* _NTDDK_ */
  35
  36 /* Dependencies */
  37 #define NT_INCLUDED
  38 #include <excpt.h>
  39 #include <ntdef.h>
  40 #include <ntstatus.h>
  41
  42 #ifndef GUID_DEFINED
  43 #include <guiddef.h>
  44 #endif /* GUID_DEFINED */
  45
  46 #if (NTDDI_VERSION >= NTDDI_WINXP)
  47 #include <dpfilter.h>
  48 #endif
  49
  50 #include "intrin.h"
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 #if !defined(_NTHALDLL_) && !defined(_BLDR_)
  57 #define NTHALAPI DECLSPEC_IMPORT
  58 #else
  59 #define NTHALAPI
  60 #endif
  61
  62 /* For ReactOS */
  63 #if !defined(_NTOSKRNL_) && !defined(_BLDR_)
  64 #define NTKERNELAPI DECLSPEC_IMPORT
  65 #else
  66 #define NTKERNELAPI
  67 #endif
  68
  69 #if defined(_X86_) && !defined(_NTHAL_)
  70 #define _DECL_HAL_KE_IMPORT  DECLSPEC_IMPORT
  71 #elif defined(_X86_)
  72 #define _DECL_HAL_KE_IMPORT
  73 #else
  74 #define _DECL_HAL_KE_IMPORT NTKERNELAPI
  75 #endif
  76
  77 #if defined(_WIN64)
  78 #define POINTER_ALIGNMENT DECLSPEC_ALIGN(8)
  79 #else
  80 #define POINTER_ALIGNMENT
  81 #endif
  82
  83 /* Helper macro to enable gcc's extension.  */
  84 #ifndef __GNU_EXTENSION
  85 #ifdef __GNUC__
  86 #define __GNU_EXTENSION __extension__
  87 #else
  88 #define __GNU_EXTENSION
  89 #endif
  90 #endif
  91
  92 #if defined(_MSC_VER)
  93
  94 /* Indicate if #pragma alloc_text() is supported */
  95 #if defined(_M_IX86) || defined(_M_AMD64) || defined(_M_IA64)
  96 #define ALLOC_PRAGMA 1
  97 #endif
  98
  99 /* Indicate if #pragma data_seg() is supported */
 100 #if defined(_M_IX86) || defined(_M_AMD64)
 101 #define ALLOC_DATA_PRAGMA 1
 102 #endif
 103
 104 #endif
 105
 106 /* Forward declarations */
 107 struct _IRP;
 108 struct _MDL;
 109 struct _KAPC;
 110 struct _KDPC;
 111 struct _FILE_OBJECT;
 112 struct _DMA_ADAPTER;
 113 struct _DEVICE_OBJECT;
 114 struct _DRIVER_OBJECT;
 115 struct _IO_STATUS_BLOCK;
 116 struct _DEVICE_DESCRIPTION;
 117 struct _SCATTER_GATHER_LIST;
 118 struct _DRIVE_LAYOUT_INFORMATION;
 119 struct _COMPRESSED_DATA_INFO;
 120 struct _IO_RESOURCE_DESCRIPTOR;
 121
 122 /* Structures not exposed to drivers */
 123 typedef struct _OBJECT_TYPE *POBJECT_TYPE;
 124 typedef struct _HAL_DISPATCH_TABLE *PHAL_DISPATCH_TABLE;
 125 typedef struct _HAL_PRIVATE_DISPATCH_TABLE *PHAL_PRIVATE_DISPATCH_TABLE;
 126 typedef struct _DEVICE_HANDLER_OBJECT *PDEVICE_HANDLER_OBJECT;
 127 typedef struct _ADAPTER_OBJECT *PADAPTER_OBJECT;
 128 typedef struct _CALLBACK_OBJECT *PCALLBACK_OBJECT;
 129 typedef struct _ETHREAD *PETHREAD;
 130 typedef struct _EPROCESS *PEPROCESS;
 131 typedef struct _IO_TIMER *PIO_TIMER;
 132 typedef struct _KINTERRUPT *PKINTERRUPT;
 133 typedef struct _KPROCESS *PKPROCESS;
 134 typedef struct _KTHREAD *PKTHREAD, *PRKTHREAD;
 135 typedef struct _CONTEXT *PCONTEXT;
 136
 137
 138 $define (_WDMDDK_)
 139 $include (interlocked.h)
 140 $include (rtltypes.h)
 141 $include (ketypes.h)
 142 $include (mmtypes.h)
 143 $include (extypes.h)
 144 $include (setypes.h)
 145 $include (potypes.h)
 146 $include (cmtypes.h)
 147 $include (iotypes.h)
 148 $include (obtypes.h)
 149 $include (pstypes.h)
 150
 151 #if defined(_M_IX86)
 152 $include(x86/ke.h)
 153 #elif defined(_M_AMD64)
 154 $include(amd64/ke.h)
 155 #elif defined(_M_IA64)
 156 $include(ia64/ke.h)
 157 #elif defined(_M_PPC)
 158 $include(ppc/ke.h)
 159 #elif defined(_M_MIPS)
 160 $include(mips/ke.h)
 161 #elif defined(_M_ARM)
 162 $include(arm/ke.h)
 163 #else
 164 #error Unknown Architecture
 165 #endif
 166
 167 $include (rtlfuncs.h)
 168 $include (kefuncs.h)
 169 $include (mmfuncs.h)
 170 $include (sefuncs.h)
 171 $include (cmfuncs.h)
 172 $include (iofuncs.h)
 173 $include (pofuncs.h)
 174 $include (exfuncs.h)
 175 $include (obfuncs.h)
 176 $include (psfuncs.h)
 177 $include (wmifuncs.h)
 178 $include (kdfuncs.h)
 179 $include (halfuncs.h)
 180 $include (nttmapi.h)
 181 $include (zwfuncs.h)
 182
 183 /******************************************************************************
 184  *                          Unsorted                                          *
 185  ******************************************************************************/
 186
 187 /* GUID Comparison */
 188 #ifndef __IID_ALIGNED__
 189 #define __IID_ALIGNED__
 190 #ifdef __cplusplus
 191 inline int IsEqualGUIDAligned(REFGUID guid1, REFGUID guid2)
 192 {
 193     return ( (*(PLONGLONG)(&guid1) == *(PLONGLONG)(&guid2)) &&
 194              (*((PLONGLONG)(&guid1) + 1) == *((PLONGLONG)(&guid2) + 1)) );
 195 }
 196 #else
 197 #define IsEqualGUIDAligned(guid1, guid2) \
 198            ( (*(PLONGLONG)(guid1) == *(PLONGLONG)(guid2)) && \
 199              (*((PLONGLONG)(guid1) + 1) == *((PLONGLONG)(guid2) + 1)) )
 200 #endif /* __cplusplus */
 201 #endif /* !__IID_ALIGNED__ */
 202
 203 typedef enum {
 204     LT_DONT_CARE,
 205     LT_LOWEST_LATENCY
 206 } LATENCY_TIME;
 207
 208 #define MAXIMUM_SUSPEND_COUNT             MAXCHAR
 209
 210 #define MAXIMUM_FILENAME_LENGTH           256
 211
 212 #define OBJ_NAME_PATH_SEPARATOR     ((WCHAR)L'\\')
 213
 214 #define OBJECT_TYPE_CREATE (0x0001)
 215 #define OBJECT_TYPE_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | 0x1)
 216
 217 #define DIRECTORY_QUERY (0x0001)
 218 #define DIRECTORY_TRAVERSE (0x0002)
 219 #define DIRECTORY_CREATE_OBJECT (0x0004)
 220 #define DIRECTORY_CREATE_SUBDIRECTORY (0x0008)
 221 #define DIRECTORY_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | 0xF)
 222
 223 #define EVENT_QUERY_STATE (0x0001)
 224 #define EVENT_MODIFY_STATE (0x0002)
 225 #define EVENT_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 0x3)
 226
 227 #define SEMAPHORE_QUERY_STATE (0x0001)
 228 #define SEMAPHORE_MODIFY_STATE (0x0002)
 229 #define SEMAPHORE_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 0x3)
 230
 231 #define SYMBOLIC_LINK_QUERY               0x0001
 232 #define SYMBOLIC_LINK_ALL_ACCESS          (STANDARD_RIGHTS_REQUIRED | 0x1)
 233
 234 #define DUPLICATE_CLOSE_SOURCE            0x00000001
 235 #define DUPLICATE_SAME_ACCESS             0x00000002
 236 #define DUPLICATE_SAME_ATTRIBUTES         0x00000004
 237
 238 /* Global debug flag */
 239 extern ULONG NtGlobalFlag;
 240
 241 /* Service Start Types */
 242 #define SERVICE_BOOT_START             0x00000000
 243 #define SERVICE_SYSTEM_START           0x00000001
 244 #define SERVICE_AUTO_START             0x00000002
 245 #define SERVICE_DEMAND_START           0x00000003
 246 #define SERVICE_DISABLED               0x00000004
 247
 248 #ifndef _TRACEHANDLE_DEFINED
 249 #define _TRACEHANDLE_DEFINED
 250 typedef ULONG64 TRACEHANDLE, *PTRACEHANDLE;
 251 #endif
 252
 253
 254
 255 #ifdef __cplusplus
 256 }
 257 #endif
 258
 259 #endif /* !_WDMDDK_ */