src/include/driver.h

   1 /**
   2  * Copyright (C) 2009-2010, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
   3  * Copyright 2006-2008, V.
   4  * For WinAoE contact information, see http://winaoe.org/
   5  *
   6  * This file is part of WinVBlock, derived from WinAoE.
   7  *
   8  * WinVBlock is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * WinVBlock is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with WinVBlock.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21 #ifndef WV_M_DRIVER_H_
  22 #  define WV_M_DRIVER_H_
  23
  24 /**
  25  * @file
  26  *
  27  * Driver specifics.
  28  */
  29
  30 /* For testing and debugging */
  31 #if 0
  32 #  define RIS
  33 #  define DEBUGIRPS
  34 #  define DEBUGMOSTPROTOCOLCALLS
  35 #  define DEBUGALLPROTOCOLCALLS
  36 #endif
  37
  38 #define POOLSIZE 2048
  39
  40 /* An unfortunate forward declaration.  Definition resolved in device.h */
  41 struct WV_DEV_T;
  42
  43 extern PDRIVER_OBJECT WvDriverObj;
  44 extern winvblock__lib_func void STDCALL Driver_CompletePendingIrp(IN PIRP);
  45 /* Note the exception to the function naming convention. */
  46 extern winvblock__lib_func NTSTATUS STDCALL Error(IN PCHAR, IN NTSTATUS);
  47 extern winvblock__lib_func struct WV_BUS_T * driver__bus(void);
  48 /* Note the exception to the function naming convention. */
  49 extern NTSTATUS STDCALL DriverEntry(
  50     IN PDRIVER_OBJECT,
  51     IN PUNICODE_STRING
  52   );
  53
  54 /* The physical/function device object's (PDO's/FDO's) DeviceExtension */
  55 winvblock__def_struct(driver__dev_ext) {
  56     struct WV_DEV_T * device;
  57   };
  58
  59 /* The prototype for a device IRP dispatch. */
  60 typedef NTSTATUS STDCALL driver__dispatch_func(
  61     IN PDEVICE_OBJECT,
  62     IN PIRP
  63   );
  64
  65 extern winvblock__lib_func NTSTATUS STDCALL driver__complete_irp(
  66     IN PIRP,
  67     IN ULONG_PTR,
  68     IN NTSTATUS
  69   );
  70
  71 #endif  /* WV_M_DRIVER_H_ */