/*

 * winddk.h

 *

 * Windows Device Driver Kit

 *

 * This file is part of the w32api package.

 *

 * Contributors:

 *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>

 *

 * THIS SOFTWARE IS NOT COPYRIGHTED

 *

 * This source code is offered for use in the public domain. You may

 * use, modify or distribute it freely.

 *

 * This code is distributed in the hope that it will be useful but

 * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY

 * DISCLAIMED. This includes but is not limited to warranties of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

 *

 */

#ifndef __WINDDK_H

#define __WINDDK_H

#if __GNUC__ >= 3

#pragma GCC system_header

#endif

#ifdef __cplusplus

extern "C" {

#endif

/*

** Definitions specific to this Device Driver Kit

*/

#define DDKAPI __stdcall

#define DDKFASTAPI __fastcall

#define DDKCDECLAPI __cdecl

#if defined(_NTOSKRNL_)

#ifndef NTOSAPI

#define NTOSAPI DECL_EXPORT

#endif

#define DECLARE_INTERNAL_OBJECT(x) typedef struct _##x; typedef struct _##x *P##x;

#define DECLARE_INTERNAL_OBJECT2(x,y) typedef struct _##x; typedef struct _##x *P##y;

#else

#ifndef NTOSAPI

#define NTOSAPI DECL_IMPORT

#endif

#define DECLARE_INTERNAL_OBJECT(x) struct _##x; typedef struct _##x *P##x;

#define DECLARE_INTERNAL_OBJECT2(x,y) struct _##x; typedef struct _##x *P##y;

#endif

/* Pseudo modifiers for parameters 

   We don't use these unnecessary defines in the w32api headers. Define

   them by default since that is what people expect, but allow users

   to avoid the pollution.  */

#ifndef _NO_W32_PSEUDO_MODIFIERS

#define IN

#define OUT

#define OPTIONAL

#define UNALLIGNED

#endif

#define CONST const

#define VOLATILE volatile

#define RESTRICTED_POINTER

#define POINTER_ALIGNMENT

#ifdef NONAMELESSUNION

# define _DDK_DUMMYUNION_MEMBER(name) DUMMYUNIONNAME.name

# define _DDK_DUMMYUNION_N_MEMBER(n, name) DUMMYUNIONNAME##n.name

#else

# define _DDK_DUMMYUNION_MEMBER(name) name

# define _DDK_DUMMYUNION_N_MEMBER(n, name) name

#endif

/*

** Forward declarations

*/

struct _IRP;

struct _MDL;

struct _KAPC;

struct _KDPC;

struct _KPCR;

struct _KPRCB;

struct _KTSS;

struct _FILE_OBJECT;

struct _DMA_ADAPTER;

struct _DEVICE_OBJECT;

struct _DRIVER_OBJECT;

struct _SECTION_OBJECT;

struct _IO_STATUS_BLOCK;

struct _DEVICE_DESCRIPTION;

struct _SCATTER_GATHER_LIST;

DECLARE_INTERNAL_OBJECT(ADAPTER_OBJECT)

DECLARE_INTERNAL_OBJECT(DMA_ADAPTER)

DECLARE_INTERNAL_OBJECT(IO_STATUS_BLOCK)

DECLARE_INTERNAL_OBJECT(SECTION_OBJECT)

#if 1

/* FIXME: Unknown definitions */

struct _SET_PARTITION_INFORMATION_EX;

typedef ULONG WAIT_TYPE;

typedef HANDLE TRACEHANDLE;

typedef PVOID PWMILIB_CONTEXT;

typedef PVOID PSYSCTL_IRP_DISPOSITION;

typedef ULONG LOGICAL;

#endif

/*

** Routines specific to this DDK

*/

#define TAG(_a, _b, _c, _d) (ULONG) \

	(((_a) << 0) + ((_b) << 8) + ((_c) << 16) + ((_d) << 24))

#ifdef __GNUC__

static __inline struct _KPCR * KeGetCurrentKPCR(

  VOID)

{

  ULONG Value;

  __asm__ __volatile__ (

#if (__GNUC__ >= 3)

    /* support -masm=intel */

    "mov{l} {%%fs:0x18, %0|%0, %%fs:0x18}\n\t"

#else

    "movl %%fs:0x18, %0\n\t"

#endif

     : "=r" (Value)

     : /* no inputs */

  );

  return (struct _KPCR *) Value;

}

#elif defined( __WATCOMC__ )

extern struct _KPCR * KeGetCurrentKPCR( void );

#pragma aux KeGetCurrentKPCR = \

  "mov eax, fs:[0x18]" \

  value [ eax ];

#endif

/*

** Simple structures

*/

typedef LONG KPRIORITY;

typedef UCHAR KIRQL, *PKIRQL;

typedef ULONG_PTR KSPIN_LOCK, *PKSPIN_LOCK;

typedef ULONG_PTR KAFFINITY, *PKAFFINITY;

typedef CCHAR KPROCESSOR_MODE;

typedef enum _MODE {

  KernelMode,

  UserMode,

  MaximumMode

} MODE;

/* Structures not exposed to drivers */

typedef struct _IO_TIMER *PIO_TIMER;

typedef struct _EPROCESS *PEPROCESS;

typedef struct _ETHREAD *PETHREAD;

typedef struct _KINTERRUPT *PKINTERRUPT;

typedef struct _OBJECT_TYPE *POBJECT_TYPE;

typedef struct _KTHREAD *PKTHREAD, *PRKTHREAD;

typedef struct _COMPRESSED_DATA_INFO *PCOMPRESSED_DATA_INFO;

typedef struct _HAL_DISPATCH_TABLE *PHAL_DISPATCH_TABLE;

typedef struct _HAL_PRIVATE_DISPATCH_TABLE *PHAL_PRIVATE_DISPATCH_TABLE;

typedef struct _DRIVE_LAYOUT_INFORMATION *PDRIVE_LAYOUT_INFORMATION;

typedef struct _DRIVE_LAYOUT_INFORMATION_EX *PDRIVE_LAYOUT_INFORMATION_EX;

/* Constants */

#define	MAXIMUM_PROCESSORS                32

#define MAXIMUM_WAIT_OBJECTS              64

#define METHOD_BUFFERED                   0

#define METHOD_IN_DIRECT                  1

#define METHOD_OUT_DIRECT                 2

#define METHOD_NEITHER                    3

#define LOW_PRIORITY                      0

#define LOW_REALTIME_PRIORITY             16

#define HIGH_PRIORITY                     31

#define MAXIMUM_PRIORITY                  32

#define FILE_SUPERSEDED                   0x00000000

#define FILE_OPENED                       0x00000001

#define FILE_CREATED                      0x00000002

#define FILE_OVERWRITTEN                  0x00000003

#define FILE_EXISTS                       0x00000004

#define FILE_DOES_NOT_EXIST               0x00000005

/* also in winnt.h */

#define FILE_LIST_DIRECTORY               0x00000001

#define FILE_READ_DATA                    0x00000001

#define FILE_ADD_FILE                     0x00000002

#define FILE_WRITE_DATA                   0x00000002

#define FILE_ADD_SUBDIRECTORY             0x00000004

#define FILE_APPEND_DATA                  0x00000004

#define FILE_CREATE_PIPE_INSTANCE         0x00000004

#define FILE_READ_EA                      0x00000008

#define FILE_WRITE_EA                     0x00000010

#define FILE_EXECUTE                      0x00000020

#define FILE_TRAVERSE                     0x00000020

#define FILE_DELETE_CHILD                 0x00000040

#define FILE_READ_ATTRIBUTES              0x00000080

#define FILE_WRITE_ATTRIBUTES             0x00000100

#define FILE_SHARE_READ                   0x00000001

#define FILE_SHARE_WRITE                  0x00000002

#define FILE_SHARE_DELETE                 0x00000004

#define FILE_SHARE_VALID_FLAGS            0x00000007

#define FILE_ATTRIBUTE_READONLY           0x00000001

#define FILE_ATTRIBUTE_HIDDEN             0x00000002

#define FILE_ATTRIBUTE_SYSTEM             0x00000004

#define FILE_ATTRIBUTE_DIRECTORY          0x00000010

#define FILE_ATTRIBUTE_ARCHIVE            0x00000020

#define FILE_ATTRIBUTE_DEVICE             0x00000040

#define FILE_ATTRIBUTE_NORMAL             0x00000080

#define FILE_ATTRIBUTE_TEMPORARY          0x00000100

#define FILE_ATTRIBUTE_SPARSE_FILE        0x00000200

#define FILE_ATTRIBUTE_REPARSE_POINT      0x00000400

#define FILE_ATTRIBUTE_COMPRESSED         0x00000800

#define FILE_ATTRIBUTE_OFFLINE            0x00001000

#define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000

#define FILE_ATTRIBUTE_ENCRYPTED          0x00004000

#define FILE_ATTRIBUTE_VALID_FLAGS        0x00007fb7

#define FILE_ATTRIBUTE_VALID_SET_FLAGS    0x000031a7

#define FILE_COPY_STRUCTURED_STORAGE      0x00000041

#define FILE_STRUCTURED_STORAGE           0x00000441

#define FILE_VALID_OPTION_FLAGS           0x00ffffff

#define FILE_VALID_PIPE_OPTION_FLAGS      0x00000032

#define FILE_VALID_MAILSLOT_OPTION_FLAGS  0x00000032

#define FILE_VALID_SET_FLAGS              0x00000036

#define FILE_SUPERSEDE                    0x00000000

#define FILE_OPEN                         0x00000001

#define FILE_CREATE                       0x00000002

#define FILE_OPEN_IF                      0x00000003

#define FILE_OVERWRITE                    0x00000004

#define FILE_OVERWRITE_IF                 0x00000005

#define FILE_MAXIMUM_DISPOSITION          0x00000005

#define FILE_DIRECTORY_FILE               0x00000001

#define FILE_WRITE_THROUGH                0x00000002

#define FILE_SEQUENTIAL_ONLY              0x00000004

#define FILE_NO_INTERMEDIATE_BUFFERING    0x00000008

#define FILE_SYNCHRONOUS_IO_ALERT         0x00000010

#define FILE_SYNCHRONOUS_IO_NONALERT      0x00000020

#define FILE_NON_DIRECTORY_FILE           0x00000040

#define FILE_CREATE_TREE_CONNECTION       0x00000080

#define FILE_COMPLETE_IF_OPLOCKED         0x00000100

#define FILE_NO_EA_KNOWLEDGE              0x00000200

#define FILE_OPEN_FOR_RECOVERY            0x00000400

#define FILE_RANDOM_ACCESS                0x00000800

#define FILE_DELETE_ON_CLOSE              0x00001000

#define FILE_OPEN_BY_FILE_ID              0x00002000

#define FILE_OPEN_FOR_BACKUP_INTENT       0x00004000

#define FILE_NO_COMPRESSION               0x00008000

#define FILE_RESERVE_OPFILTER             0x00100000

#define FILE_OPEN_REPARSE_POINT           0x00200000

#define FILE_OPEN_NO_RECALL               0x00400000

#define FILE_OPEN_FOR_FREE_SPACE_QUERY    0x00800000

#define FILE_ANY_ACCESS                   0x00000000

#define FILE_SPECIAL_ACCESS               FILE_ANY_ACCESS

#define FILE_READ_ACCESS                  0x00000001

#define FILE_WRITE_ACCESS                 0x00000002

#define FILE_ALL_ACCESS \

  (STANDARD_RIGHTS_REQUIRED | \

   SYNCHRONIZE | \

   0x1FF)

#define FILE_GENERIC_EXECUTE \

  (STANDARD_RIGHTS_EXECUTE | \

   FILE_READ_ATTRIBUTES | \

   FILE_EXECUTE | \

   SYNCHRONIZE)

#define FILE_GENERIC_READ \

  (STANDARD_RIGHTS_READ | \

   FILE_READ_DATA | \

   FILE_READ_ATTRIBUTES | \

   FILE_READ_EA | \

   SYNCHRONIZE)

#define FILE_GENERIC_WRITE \

  (STANDARD_RIGHTS_WRITE | \

   FILE_WRITE_DATA | \

   FILE_WRITE_ATTRIBUTES | \

   FILE_WRITE_EA | \

   FILE_APPEND_DATA | \

   SYNCHRONIZE)

/* end winnt.h */

#define DIRECTORY_QUERY (0x0001)

#define DIRECTORY_TRAVERSE (0x0002)

#define DIRECTORY_CREATE_OBJECT (0x0004)

#define DIRECTORY_CREATE_SUBDIRECTORY (0x0008)

#define DIRECTORY_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | 0xF)

/* Exported object types */

extern NTOSAPI POBJECT_TYPE ExDesktopObjectType;

extern NTOSAPI POBJECT_TYPE ExEventObjectType;

extern NTOSAPI POBJECT_TYPE ExSemaphoreObjectType;

extern NTOSAPI POBJECT_TYPE ExWindowStationObjectType;

extern NTOSAPI POBJECT_TYPE IoAdapterObjectType;

extern NTOSAPI ULONG IoDeviceHandlerObjectSize;

extern NTOSAPI POBJECT_TYPE IoDeviceHandlerObjectType;

extern NTOSAPI POBJECT_TYPE IoDeviceObjectType;

extern NTOSAPI POBJECT_TYPE IoDriverObjectType;

extern NTOSAPI POBJECT_TYPE IoFileObjectType;

extern NTOSAPI POBJECT_TYPE LpcPortObjectType;

extern NTOSAPI POBJECT_TYPE MmSectionObjectType;

extern NTOSAPI POBJECT_TYPE SeTokenObjectType;

extern NTOSAPI CCHAR KeNumberProcessors;

extern NTOSAPI PHAL_DISPATCH_TABLE HalDispatchTable;

extern NTOSAPI PHAL_PRIVATE_DISPATCH_TABLE HalPrivateDispatchTable;

/*

** IRP function codes

*/

#define IRP_MJ_CREATE                     0x00

#define IRP_MJ_CREATE_NAMED_PIPE          0x01

#define IRP_MJ_CLOSE                      0x02

#define IRP_MJ_READ                       0x03

#define IRP_MJ_WRITE                      0x04

#define IRP_MJ_QUERY_INFORMATION          0x05

#define IRP_MJ_SET_INFORMATION            0x06

#define IRP_MJ_QUERY_EA                   0x07

#define IRP_MJ_SET_EA                     0x08

#define IRP_MJ_FLUSH_BUFFERS              0x09

#define IRP_MJ_QUERY_VOLUME_INFORMATION   0x0a

#define IRP_MJ_SET_VOLUME_INFORMATION     0x0b

#define IRP_MJ_DIRECTORY_CONTROL          0x0c

#define IRP_MJ_FILE_SYSTEM_CONTROL        0x0d

#define IRP_MJ_DEVICE_CONTROL             0x0e

#define IRP_MJ_INTERNAL_DEVICE_CONTROL    0x0f

#define IRP_MJ_SCSI                       0x0f

#define IRP_MJ_SHUTDOWN                   0x10

#define IRP_MJ_LOCK_CONTROL               0x11

#define IRP_MJ_CLEANUP                    0x12

#define IRP_MJ_CREATE_MAILSLOT            0x13

#define IRP_MJ_QUERY_SECURITY             0x14

#define IRP_MJ_SET_SECURITY               0x15

#define IRP_MJ_POWER                      0x16

#define IRP_MJ_SYSTEM_CONTROL             0x17

#define IRP_MJ_DEVICE_CHANGE              0x18

#define IRP_MJ_QUERY_QUOTA                0x19

#define IRP_MJ_SET_QUOTA                  0x1a

#define IRP_MJ_PNP                        0x1b

#define IRP_MJ_PNP_POWER                  0x1b

#define IRP_MJ_MAXIMUM_FUNCTION           0x1b

#define IRP_MN_QUERY_DIRECTORY            0x01

#define IRP_MN_NOTIFY_CHANGE_DIRECTORY    0x02

#define IRP_MN_USER_FS_REQUEST            0x00

#define IRP_MN_MOUNT_VOLUME               0x01

#define IRP_MN_VERIFY_VOLUME              0x02

#define IRP_MN_LOAD_FILE_SYSTEM           0x03

#define IRP_MN_TRACK_LINK                 0x04

#define IRP_MN_KERNEL_CALL                0x04

#define IRP_MN_LOCK                       0x01

#define IRP_MN_UNLOCK_SINGLE              0x02

#define IRP_MN_UNLOCK_ALL                 0x03

#define IRP_MN_UNLOCK_ALL_BY_KEY          0x04

#define IRP_MN_NORMAL                     0x00

#define IRP_MN_DPC                        0x01

#define IRP_MN_MDL                        0x02

#define IRP_MN_COMPLETE                   0x04

#define IRP_MN_COMPRESSED                 0x08

#define IRP_MN_MDL_DPC                    (IRP_MN_MDL | IRP_MN_DPC)

#define IRP_MN_COMPLETE_MDL               (IRP_MN_COMPLETE | IRP_MN_MDL)

#define IRP_MN_COMPLETE_MDL_DPC           (IRP_MN_COMPLETE_MDL | IRP_MN_DPC)

#define IRP_MN_SCSI_CLASS                 0x01

#define IRP_MN_START_DEVICE               0x00

#define IRP_MN_QUERY_REMOVE_DEVICE        0x01

#define IRP_MN_REMOVE_DEVICE              0x02

#define IRP_MN_CANCEL_REMOVE_DEVICE       0x03

#define IRP_MN_STOP_DEVICE                0x04

#define IRP_MN_QUERY_STOP_DEVICE          0x05

#define IRP_MN_CANCEL_STOP_DEVICE         0x06

#define IRP_MN_QUERY_DEVICE_RELATIONS       0x07

#define IRP_MN_QUERY_INTERFACE              0x08

#define IRP_MN_QUERY_CAPABILITIES           0x09

#define IRP_MN_QUERY_RESOURCES              0x0A

#define IRP_MN_QUERY_RESOURCE_REQUIREMENTS  0x0B

#define IRP_MN_QUERY_DEVICE_TEXT            0x0C

#define IRP_MN_FILTER_RESOURCE_REQUIREMENTS 0x0D

#define IRP_MN_READ_CONFIG                  0x0F

#define IRP_MN_WRITE_CONFIG                 0x10

#define IRP_MN_EJECT                        0x11

#define IRP_MN_SET_LOCK                     0x12

#define IRP_MN_QUERY_ID                     0x13

#define IRP_MN_QUERY_PNP_DEVICE_STATE       0x14

#define IRP_MN_QUERY_BUS_INFORMATION        0x15

#define IRP_MN_DEVICE_USAGE_NOTIFICATION    0x16

#define IRP_MN_SURPRISE_REMOVAL             0x17

#define IRP_MN_QUERY_LEGACY_BUS_INFORMATION 0x18

#define IRP_MN_WAIT_WAKE                  0x00

#define IRP_MN_POWER_SEQUENCE             0x01

#define IRP_MN_SET_POWER                  0x02

#define IRP_MN_QUERY_POWER                0x03

#define IRP_MN_QUERY_ALL_DATA             0x00

#define IRP_MN_QUERY_SINGLE_INSTANCE      0x01

#define IRP_MN_CHANGE_SINGLE_INSTANCE     0x02

#define IRP_MN_CHANGE_SINGLE_ITEM         0x03

#define IRP_MN_ENABLE_EVENTS              0x04

#define IRP_MN_DISABLE_EVENTS             0x05

#define IRP_MN_ENABLE_COLLECTION          0x06

#define IRP_MN_DISABLE_COLLECTION         0x07

#define IRP_MN_REGINFO                    0x08

#define IRP_MN_EXECUTE_METHOD             0x09

#define IRP_MN_REGINFO_EX                 0x0b

typedef enum _IO_ALLOCATION_ACTION {

  KeepObject = 1,

  DeallocateObject,

  DeallocateObjectKeepRegisters

} IO_ALLOCATION_ACTION, *PIO_ALLOCATION_ACTION;

typedef IO_ALLOCATION_ACTION

(DDKAPI *PDRIVER_CONTROL)(

  /*IN*/ struct _DEVICE_OBJECT  *DeviceObject,

  /*IN*/ struct _IRP  *Irp,

  /*IN*/ PVOID  MapRegisterBase,

  /*IN*/ PVOID  Context);

typedef VOID

(DDKAPI *PDRIVER_LIST_CONTROL)(

  /*IN*/ struct _DEVICE_OBJECT  *DeviceObject,

  /*IN*/ struct _IRP  *Irp,

  /*IN*/ struct _SCATTER_GATHER_LIST  *ScatterGather,

  /*IN*/ PVOID  Context);

typedef NTSTATUS

(DDKAPI *PDRIVER_ADD_DEVICE)(

  /*IN*/ struct _DRIVER_OBJECT  *DriverObject,

  /*IN*/ struct _DEVICE_OBJECT  *PhysicalDeviceObject);

typedef NTSTATUS

(DDKAPI *PIO_COMPLETION_ROUTINE)(

  /*IN*/ struct _DEVICE_OBJECT  *DeviceObject,

  /*IN*/ struct _IRP  *Irp,

  /*IN*/ PVOID  Context);

typedef VOID

(DDKAPI *PDRIVER_CANCEL)(

  /*IN*/ struct _DEVICE_OBJECT  *DeviceObject,

  /*IN*/ struct _IRP  *Irp);

typedef VOID

(DDKAPI *PKDEFERRED_ROUTINE)(

  /*IN*/ struct _KDPC  *Dpc,

  /*IN*/ PVOID  DeferredContext,

  /*IN*/ PVOID  SystemArgument1,

  /*IN*/ PVOID  SystemArgument2);

typedef NTSTATUS

(DDKAPI *PDRIVER_DISPATCH)(

  /*IN*/ struct _DEVICE_OBJECT  *DeviceObject,

  /*IN*/ struct _IRP  *Irp);

typedef VOID

(DDKAPI *PIO_DPC_ROUTINE)(

  /*IN*/ struct _KDPC  *Dpc,

  /*IN*/ struct _DEVICE_OBJECT  *DeviceObject,

  /*IN*/ struct _IRP  *Irp,

  /*IN*/ PVOID  Context);

typedef NTSTATUS

(DDKAPI *PMM_DLL_INITIALIZE)(

  /*IN*/ PUNICODE_STRING  RegistryPath);

typedef NTSTATUS

(DDKAPI *PMM_DLL_UNLOAD)(

  VOID);

typedef NTSTATUS

(DDKAPI *PDRIVER_ENTRY)( 

  /*IN*/ struct _DRIVER_OBJECT  *DriverObject, 

  /*IN*/ PUNICODE_STRING  RegistryPath); 

typedef NTSTATUS

(DDKAPI *PDRIVER_INITIALIZE)(

  /*IN*/ struct _DRIVER_OBJECT  *DriverObject, 

  /*IN*/ PUNICODE_STRING  RegistryPath);

typedef BOOLEAN

(DDKAPI *PKSERVICE_ROUTINE)(

  /*IN*/ struct _KINTERRUPT  *Interrupt,

  /*IN*/ PVOID  ServiceContext);

typedef VOID

(DDKAPI *PIO_TIMER_ROUTINE)(

  /*IN*/ struct _DEVICE_OBJECT  *DeviceObject,

  /*IN*/ PVOID  Context);

typedef VOID

(DDKAPI *PDRIVER_REINITIALIZE)( 

  /*IN*/ struct _DRIVER_OBJECT  *DriverObject,