c37158b2ec4000eda58f8d5e56cdc08cd3751927
[people/sha0/winvblock.git] / src / include / device.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 _DEVICE_H
22 #  define _DEVICE_H
23
24 /**
25  * @file
26  *
27  * Device specifics.
28  */
29
30 enum device__state {
31     device__state_not_started,
32     device__state_started,
33     device__state_stop_pending,
34     device__state_stopped,
35     device__state_remove_pending,
36     device__state_surprise_remove_pending,
37     device__state_deleted
38   };
39
40 /* Forward declaration. */
41 struct device__type;
42
43 /**
44  * Device PDO creation routine.
45  *
46  * @v dev               The device whose PDO should be created.
47  * @ret pdo             Points to the new PDO, or is NULL upon failure.
48  */
49 typedef PDEVICE_OBJECT STDCALL device__create_pdo_func(
50     IN struct device__type *
51   );
52
53 extern winvblock__lib_func device__create_pdo_func device__create_pdo;
54
55 /**
56  * Device initialization routine.
57  *
58  * @v dev               The device being initialized.
59  */
60 typedef winvblock__bool STDCALL device__init_func(IN struct device__type *);
61
62 /**
63  * Device PnP ID reponse routine.
64  *
65  * @v dev                       The device being queried for PnP IDs.
66  * @v query_type                The query type.
67  * @v buf                       Wide character, 512-element buffer for the
68  *                              ID response.
69  * @ret winvblock__uint32       The number of wide characters in the response.
70  */
71 typedef winvblock__uint32 STDCALL device__pnp_id_func(
72     IN struct device__type *,
73     IN BUS_QUERY_ID_TYPE,
74     IN OUT WCHAR (*)[512]
75   );
76
77 extern winvblock__lib_func device__pnp_id_func device__pnp_id;
78
79 /**
80  * Device close routine.
81  *
82  * @v dev               The device being closed.
83  */
84 typedef void STDCALL device__close_func(IN struct device__type *);
85
86 extern winvblock__lib_func device__close_func device__close;
87
88 /**
89  * Device deletion routine.
90  *
91  * @v dev_ptr           Points to the device to delete.
92  */
93 typedef void STDCALL device__free_func(IN struct device__type *);
94
95 extern winvblock__lib_func device__free_func device__free;
96
97 extern winvblock__lib_func struct device__type * device__create(void);
98
99 winvblock__def_struct(device__ops) {
100     device__create_pdo_func * create_pdo;
101     device__init_func * init;
102     device__pnp_id_func * pnp_id;
103     device__close_func * close;
104     device__free_func * free;
105   };
106
107 typedef void STDCALL device__thread_func(IN void *);
108
109 /**
110  * The prototype for a device IRP dispatch.
111  *
112  * @v dev               Points to the device.
113  * @v irp               Points to the IRP.
114  * @ret NTSTATUS        The status of processing the IRP for the device.
115  */
116 typedef NTSTATUS STDCALL device__dispatch_func(
117     IN struct device__type *,
118     IN PIRP
119   );
120
121 /**
122  * The prototype for a device IRP_MJ_DEVICE_CONTROL dispatch.
123  *
124  * @v dev               Points to the device.
125  * @v irp               Points to the IRP.
126  * @v code              The I/O control code.
127  * @ret NTSTATUS        The status of processing the IRP for the device.
128  */
129 typedef NTSTATUS STDCALL device__dev_ctl_func(
130     IN struct device__type *,
131     IN PIRP,
132     IN ULONG POINTER_ALIGNMENT
133   );
134
135 /**
136  * The prototype for a device IRP_MJ_SCSI dispatch.
137  *
138  * @v dev               Points to the device.
139  * @v irp               Points to the IRP.
140  * @v code              The SCSI function.
141  * @ret NTSTATUS        The status of processing the IRP for the device.
142  */
143 typedef NTSTATUS STDCALL device__scsi_func(
144     IN struct device__type *,
145     IN PIRP,
146     IN UCHAR
147   );
148
149 /**
150  * The prototype for a device IRP_MJ_PNP dispatch.
151  *
152  * @v dev               Points to the device.
153  * @v irp               Points to the IRP.
154  * @v code              The minor function.
155  * @ret NTSTATUS        The status of processing the IRP for the device.
156  */
157 typedef NTSTATUS STDCALL device__pnp_func(
158     IN struct device__type *,
159     IN PIRP,
160     IN UCHAR
161   );
162
163 /* IRP major function handler table. */
164 struct device__irp_mj {
165     device__dispatch_func * power;
166     device__dispatch_func * sys_ctl;
167     device__dev_ctl_func * dev_ctl;
168     device__scsi_func * scsi;
169     device__pnp_func * pnp;
170   };
171
172 /* Details common to all devices this driver works with */
173 struct device__type {
174     /* For debugging */
175     winvblock__bool IsBus;
176     /* A device's IRP dispatch routine. */
177     driver__dispatch_func * dispatch;
178     /* The device's thread routine. */
179     device__thread_func * thread;
180     /* The device's thread wakeup signal. */
181     KEVENT thread_wakeup;
182     /* The device's IRP queue. */
183     LIST_ENTRY irp_list;
184     /* The device's IRP queue lock. */
185     KSPIN_LOCK irp_list_lock;
186     /* Self is self-explanatory. */
187     PDEVICE_OBJECT Self;
188     /* Flag to create/delete a PDO on a threaded bus. */
189     winvblock__bool thread_pdo;
190     /* Points to the parent bus' DEVICE_OBJECT */
191     PDEVICE_OBJECT Parent;
192     /* The device's child ID relative to the parent bus. */
193     winvblock__uint32 dev_num;
194     /* Points to the driver. */
195     PDRIVER_OBJECT DriverObject;
196     /* Current state of the device. */
197     enum device__state state;
198     /* Previous state of the device. */
199     enum device__state old_state;
200     /* The next device in the parent bus' devices.  TODO: Don't do this. */
201     struct device__type * next_sibling_ptr;
202     /* The device operations. */
203     device__ops ops;
204     /* Tracking for the device module itself. */
205     LIST_ENTRY tracking;
206     /* Points to further extensions. */
207     winvblock__any_ptr ext;
208     /* How to handle IRPs based on major function code. */
209     struct device__irp_mj * irp_mj;
210   };
211
212 extern winvblock__lib_func struct device__type * device__get(PDEVICE_OBJECT);
213 extern winvblock__lib_func void device__set(
214     PDEVICE_OBJECT,
215     struct device__type *
216   );
217 extern device__dispatch_func device__pnp_query_id;
218
219 #endif  /* _DEVICE_H */