include/xdk/ntddk.template.h

   1 /*
   2  * ntddk.h
   3  *
   4  * Windows NT Device Driver 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
  24 #pragma once
  25
  26 #define _NTDDK_
  27
  28 #if !defined(_NTHAL_) && !defined(_NTIFS_)
  29 #define _NTDDK_INCLUDED_
  30 #define _DDK_DRIVER_
  31 #endif
  32
  33 /* Dependencies */
  34
  35 #define NT_INCLUDED
  36 #define _CTYPE_DISABLE_MACROS
  37
  38 #include <wdm.h>
  39 #include <excpt.h>
  40 #include <ntdef.h>
  41 #include <ntstatus.h>
  42 #include <mce.h>
  43 #include <bugcodes.h>
  44 #include <ntiologc.h>
  45
  46 #include <stdarg.h> // FIXME
  47 #include <basetyps.h> // FIXME
  48
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 /* GUID and UUID */
  55 #ifndef _NTLSA_IFS_
  56 #ifndef _NTLSA_AUDIT_
  57 #define _NTLSA_AUDIT_
  58
  59 #ifndef GUID_DEFINED
  60 #include <guiddef.h>
  61 #endif
  62
  63 #endif /* _NTLSA_AUDIT_ */
  64 #endif /* _NTLSA_IFS_ */
  65
  66 typedef GUID UUID;
  67
  68 struct _LOADER_PARAMETER_BLOCK;
  69 struct _CREATE_DISK;
  70 struct _DRIVE_LAYOUT_INFORMATION_EX;
  71 struct _SET_PARTITION_INFORMATION_EX;
  72
  73 typedef struct _BUS_HANDLER *PBUS_HANDLER;
  74 typedef struct _DEVICE_HANDLER_OBJECT *PDEVICE_HANDLER_OBJECT;
  75 #if defined(_NTHAL_INCLUDED_)
  76 typedef struct _KAFFINITY_EX *PKAFFINITY_EX;
  77 #endif
  78 typedef struct _PEB *PPEB;
  79
  80 #ifndef _NTIMAGE_
  81
  82 typedef struct _IMAGE_NT_HEADERS *PIMAGE_NT_HEADERS32;
  83 typedef struct _IMAGE_NT_HEADERS64 *PIMAGE_NT_HEADERS64;
  84
  85 #ifdef _WIN64
  86 typedef PIMAGE_NT_HEADERS64 PIMAGE_NT_HEADERS;
  87 #else
  88 typedef PIMAGE_NT_HEADERS32 PIMAGE_NT_HEADERS;
  89 #endif
  90
  91 #endif /* _NTIMAGE_ */
  92
  93 $define (_NTDDK_)
  94 $include (extypes.h)
  95 $include (iotypes.h)
  96 $include (haltypes.h)
  97 $include (ketypes.h)
  98 $include (kdtypes.h)
  99 $include (mmtypes.h)
 100 $include (pstypes.h)
 101 $include (rtltypes.h)
 102 $include (setypes.h)
 103
 104 #if defined(_M_IX86)
 105 $include(x86/ke.h)
 106 $include(x86/mm.h)
 107 #elif defined(_M_AMD64)
 108 $include(amd64/ke.h)
 109 $include(amd64/mm.h)
 110 #elif defined(_M_IA64)
 111 $include(ia64/ke.h)
 112 #elif defined(_M_PPC)
 113 $include(ppc/ke.h)
 114 #elif defined(_M_MIPS)
 115 $include(mips/ke.h)
 116 #elif defined(_M_ARM)
 117 $include(arm/ke.h)
 118 #else
 119 #error Unknown Architecture
 120 #endif
 121
 122 $include (exfuncs.h)
 123 $include (halfuncs.h)
 124 $include (iofuncs.h)
 125 $include (kdfuncs.h)
 126 $include (kefuncs.h)
 127 $include (mmfuncs.h)
 128 $include (psfuncs.h)
 129 $include (rtlfuncs.h)
 130 $include (sefuncs.h)
 131 $include (zwfuncs.h)
 132
 133
 134 /* UNSORTED */
 135
 136 #define VER_SET_CONDITION(ConditionMask, TypeBitMask, ComparisonType) \
 137   ((ConditionMask) = VerSetConditionMask((ConditionMask),             \
 138   (TypeBitMask), (ComparisonType)))
 139
 140 #if (NTDDI_VERSION >= NTDDI_WIN2K)
 141 NTSYSAPI
 142 ULONGLONG
 143 NTAPI
 144 VerSetConditionMask(
 145   IN ULONGLONG ConditionMask,
 146   IN ULONG TypeMask,
 147   IN UCHAR Condition);
 148 #endif
 149
 150 typedef struct _KERNEL_USER_TIMES {
 151   LARGE_INTEGER CreateTime;
 152   LARGE_INTEGER ExitTime;
 153   LARGE_INTEGER KernelTime;
 154   LARGE_INTEGER UserTime;
 155 } KERNEL_USER_TIMES, *PKERNEL_USER_TIMES;
 156
 157 /* NtXxx Functions */
 158
 159 typedef enum _SYSTEM_FIRMWARE_TABLE_ACTION {
 160   SystemFirmwareTable_Enumerate,
 161   SystemFirmwareTable_Get
 162 } SYSTEM_FIRMWARE_TABLE_ACTION;
 163
 164 typedef struct _SYSTEM_FIRMWARE_TABLE_INFORMATION {
 165   ULONG ProviderSignature;
 166   SYSTEM_FIRMWARE_TABLE_ACTION Action;
 167   ULONG TableID;
 168   ULONG TableBufferLength;
 169   UCHAR TableBuffer[ANYSIZE_ARRAY];
 170 } SYSTEM_FIRMWARE_TABLE_INFORMATION, *PSYSTEM_FIRMWARE_TABLE_INFORMATION;
 171
 172 typedef NTSTATUS
 173 (__cdecl *PFNFTH)(
 174   IN OUT PSYSTEM_FIRMWARE_TABLE_INFORMATION SystemFirmwareTableInfo);
 175
 176 typedef struct _SYSTEM_FIRMWARE_TABLE_HANDLER {
 177   ULONG ProviderSignature;
 178   BOOLEAN Register;
 179   PFNFTH FirmwareTableHandler;
 180   PVOID DriverObject;
 181 } SYSTEM_FIRMWARE_TABLE_HANDLER, *PSYSTEM_FIRMWARE_TABLE_HANDLER;
 182
 183 typedef ULONG_PTR
 184 (NTAPI *PDRIVER_VERIFIER_THUNK_ROUTINE)(
 185   IN PVOID Context);
 186
 187 typedef struct _DRIVER_VERIFIER_THUNK_PAIRS {
 188   PDRIVER_VERIFIER_THUNK_ROUTINE PristineRoutine;
 189   PDRIVER_VERIFIER_THUNK_ROUTINE NewRoutine;
 190 } DRIVER_VERIFIER_THUNK_PAIRS, *PDRIVER_VERIFIER_THUNK_PAIRS;
 191
 192 #define DRIVER_VERIFIER_SPECIAL_POOLING             0x0001
 193 #define DRIVER_VERIFIER_FORCE_IRQL_CHECKING         0x0002
 194 #define DRIVER_VERIFIER_INJECT_ALLOCATION_FAILURES  0x0004
 195 #define DRIVER_VERIFIER_TRACK_POOL_ALLOCATIONS      0x0008
 196 #define DRIVER_VERIFIER_IO_CHECKING                 0x0010
 197
 198 #define SHARED_GLOBAL_FLAGS_ERROR_PORT_V        0x0
 199 #define SHARED_GLOBAL_FLAGS_ERROR_PORT          (1UL << SHARED_GLOBAL_FLAGS_ERROR_PORT_V)
 200
 201 #define SHARED_GLOBAL_FLAGS_ELEVATION_ENABLED_V 0x1
 202 #define SHARED_GLOBAL_FLAGS_ELEVATION_ENABLED   (1UL << SHARED_GLOBAL_FLAGS_ELEVATION_ENABLED_V)
 203
 204 #define SHARED_GLOBAL_FLAGS_VIRT_ENABLED_V      0x2
 205 #define SHARED_GLOBAL_FLAGS_VIRT_ENABLED        (1UL << SHARED_GLOBAL_FLAGS_VIRT_ENABLED_V)
 206
 207 #define SHARED_GLOBAL_FLAGS_INSTALLER_DETECT_ENABLED_V  0x3
 208 #define SHARED_GLOBAL_FLAGS_INSTALLER_DETECT_ENABLED    \
 209   (1UL << SHARED_GLOBAL_FLAGS_INSTALLER_DETECT_ENABLED_V)
 210
 211 #define SHARED_GLOBAL_FLAGS_SPARE_V                     0x4
 212 #define SHARED_GLOBAL_FLAGS_SPARE                       \
 213   (1UL << SHARED_GLOBAL_FLAGS_SPARE_V)
 214
 215 #define SHARED_GLOBAL_FLAGS_DYNAMIC_PROC_ENABLED_V      0x5
 216 #define SHARED_GLOBAL_FLAGS_DYNAMIC_PROC_ENABLED        \
 217   (1UL << SHARED_GLOBAL_FLAGS_DYNAMIC_PROC_ENABLED_V)
 218
 219 #define SHARED_GLOBAL_FLAGS_SEH_VALIDATION_ENABLED_V    0x6
 220 #define SHARED_GLOBAL_FLAGS_SEH_VALIDATION_ENABLED        \
 221   (1UL << SHARED_GLOBAL_FLAGS_SEH_VALIDATION_ENABLED_V)
 222
 223 #define EX_INIT_BITS(Flags, Bit) \
 224   *((Flags)) |= (Bit)             // Safe to use before concurrently accessible
 225
 226 #define EX_TEST_SET_BIT(Flags, Bit) \
 227   InterlockedBitTestAndSet ((PLONG)(Flags), (Bit))
 228
 229 #define EX_TEST_CLEAR_BIT(Flags, Bit) \
 230   InterlockedBitTestAndReset ((PLONG)(Flags), (Bit))
 231
 232 #define PCCARD_MAP_ERROR               0x01
 233 #define PCCARD_DEVICE_PCI              0x10
 234
 235 #define PCCARD_SCAN_DISABLED           0x01
 236 #define PCCARD_MAP_ZERO                0x02
 237 #define PCCARD_NO_TIMER                0x03
 238 #define PCCARD_NO_PIC                  0x04
 239 #define PCCARD_NO_LEGACY_BASE          0x05
 240 #define PCCARD_DUP_LEGACY_BASE         0x06
 241 #define PCCARD_NO_CONTROLLERS          0x07
 242
 243 #define MAXIMUM_EXPANSION_SIZE (KERNEL_LARGE_STACK_SIZE - (PAGE_SIZE / 2))
 244
 245 /* Filesystem runtime library routines */
 246
 247 #if (NTDDI_VERSION >= NTDDI_WIN2K)
 248 NTKERNELAPI
 249 BOOLEAN
 250 NTAPI
 251 FsRtlIsTotalDeviceFailure(
 252   IN NTSTATUS Status);
 253 #endif
 254
 255 #ifdef __cplusplus
 256 }
 257 #endif