4c626d0a1aa7726738007112f868645bb4c11b1f
[people/sha0/winvblock.git] / 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 WvDriverCompletePendingIrp(IN PIRP);
45 /* Note the exception to the function naming convention. */
46 extern winvblock__lib_func NTSTATUS STDCALL Error(IN PCHAR, IN NTSTATUS);
47 /* Note the exception to the function naming convention. */
48 extern NTSTATUS STDCALL DriverEntry(
49     IN PDRIVER_OBJECT,
50     IN PUNICODE_STRING
51   );
52
53 /* The physical/function device object's (PDO's/FDO's) DeviceExtension */
54 winvblock__def_struct(driver__dev_ext) {
55     struct WV_DEV_T * device;
56   };
57
58 /* The prototype for a device IRP dispatch. */
59 typedef NTSTATUS STDCALL driver__dispatch_func(
60     IN PDEVICE_OBJECT,
61     IN PIRP
62   );
63 /* PnP IDs for a dummy device. */
64 typedef struct WV_DRIVER_DUMMY_IDS {
65     winvblock__uint32 DevOffset;
66     winvblock__uint32 DevLen;
67     winvblock__uint32 InstanceOffset;
68     winvblock__uint32 InstanceLen;
69     winvblock__uint32 HardwareOffset;
70     winvblock__uint32 HardwareLen;
71     winvblock__uint32 CompatOffset;
72     winvblock__uint32 CompatLen;
73     const WCHAR * Ids;
74   } WV_S_DRIVER_DUMMY_IDS, * WV_SP_DRIVER_DUMMY_IDS;
75
76 /* Macro support for dummy ID generation. */
77 #define WV_M_DRIVER_DUMMY_IDS_X_ENUM(prefix_, name_, literal_)  \
78   prefix_ ## name_ ## Offset_,                                  \
79   prefix_ ## name_ ## Len_ = sizeof (literal_),                 \
80   prefix_ ## name_ ## End_ =                                    \
81     prefix_ ## name_ ## Offset_ + prefix_ ## name_ ## Len_ - 1,
82
83 #define WV_M_DRIVER_DUMMY_IDS_X_LITERALS(prefix_, name_, literal_) \
84   literal_ L"\0"
85
86 #define WV_M_DRIVER_DUMMY_IDS_X_FILL(prefix_, name_, literal_)  \
87   prefix_ ## name_ ## Offset_,                                  \
88   prefix_ ## name_ ## Len_,
89
90 /**
91  * Generate a static const WV_S_DRIVER_DUMMY_IDS object.
92  *
93  * @v DummyIds          The name of the desired object.  Also used as prefix.
94  * @v XMacro            The x-macro with the ID text.
95  *
96  * This macro will produce the following:
97  *   enum values:
98  *     [DummyIds]DevOffset_
99  *     [DummyIds]DevLen_
100  *     [DummyIds]DevEnd_
101  *     [DummyIds]InstanceOffset_
102  *     [DummyIds]InstanceLen_
103  *     [DummyIds]InstanceEnd_
104  *     [DummyIds]HardwareOffset_
105  *     [DummyIds]HardwareLen_
106  *     [DummyIds]HardwareEnd_
107  *     [DummyIds]CompatOffset_
108  *     [DummyIds]CompatLen_
109  *     [DummyIds]CompatEnd_
110  *     [DummyIds]Len_
111  *   WCHAR[]:
112  *     [DummyIds]String_
113  *   static const WV_S_DRIVER_DUMMY_IDS:
114  *     [DummyIds]
115  */
116 #define WV_M_DRIVER_DUMMY_ID_GEN(DummyIds, XMacro)    \
117                                                       \
118 enum {                                                \
119     XMacro(WV_M_DRIVER_DUMMY_IDS_X_ENUM, DummyIds)    \
120     DummyIds ## Len_                                  \
121   };                                                  \
122                                                       \
123 static const WCHAR DummyIds ## String_[] =            \
124   XMacro(WV_M_DRIVER_DUMMY_IDS_X_LITERALS, DummyIds); \
125                                                       \
126 static const WV_S_DRIVER_DUMMY_IDS DummyIds = {       \
127     XMacro(WV_M_DRIVER_DUMMY_IDS_X_FILL, DummyIds)    \
128     DummyIds ## String_                               \
129   }
130
131 extern winvblock__lib_func NTSTATUS STDCALL driver__complete_irp(
132     IN PIRP,
133     IN ULONG_PTR,
134     IN NTSTATUS
135   );
136 extern winvblock__lib_func winvblock__bool STDCALL WvDriverBusAddDev(
137     IN WV_SP_DEV_T
138   );
139 extern NTSTATUS STDCALL WvDriverGetDevCapabilities(
140     IN PDEVICE_OBJECT,
141     IN PDEVICE_CAPABILITIES
142   );
143 extern winvblock__lib_func NTSTATUS STDCALL WvDriverAddDummy(
144     IN WV_FP_DEV_PNP_ID,
145     IN DEVICE_TYPE,
146     IN ULONG
147   );
148 extern winvblock__lib_func NTSTATUS STDCALL WvDriverDummyIds(
149     IN PIRP,
150     IN WV_SP_DRIVER_DUMMY_IDS
151   );
152
153 #endif  /* WV_M_DRIVER_H_ */