[bus,driver] Put bus IRP_MJ_SYSTEM_CONTROL handler in driver
[people/sha0/winvblock.git] / src / include / bus.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_BUS_H_
22 #  define WV_M_BUS_H_
23
24 /**
25  * @file
26  *
27  * Bus specifics.
28  */
29
30 /**
31  * A bus thread routine.
32  *
33  * @v bus       The bus to be used in the thread routine.
34  *
35  * If you implement your own bus thread routine, you should call
36  * WvBusProcessWorkItems() within its loop.
37  */
38 typedef void STDCALL WV_F_BUS_THREAD(IN WV_SP_BUS_T);
39 typedef WV_F_BUS_THREAD * WV_FP_BUS_THREAD;
40
41 /* The bus type. */
42 typedef struct WV_BUS_T {
43     WV_S_DEV_T Dev;
44     PDEVICE_OBJECT LowerDeviceObject;
45     PDEVICE_OBJECT PhysicalDeviceObject;
46     PDEVICE_OBJECT Fdo;
47     winvblock__uint32 Children;
48     WV_SP_DEV_T first_child;
49     WV_FP_BUS_THREAD Thread;
50     KEVENT ThreadSignal;
51     winvblock__bool Stop;
52     KEVENT ThreadStopped;
53     struct {
54         LIST_ENTRY Nodes;
55         USHORT NodeCount;
56         LIST_ENTRY WorkItems;
57         KSPIN_LOCK WorkItemsLock;
58       } BusPrivate_;
59   } WV_S_BUS_T, * WV_SP_BUS_T;
60
61 /* A child PDO node on a bus.  Treat this as an opaque type. */
62 typedef struct WV_BUS_NODE {
63     struct {
64         LIST_ENTRY Link;
65         PDEVICE_OBJECT Pdo;
66         WV_SP_BUS_T Bus;
67         /* The child's unit number relative to the parent bus. */
68         winvblock__uint32 Num;
69       } BusPrivate_;
70   } WV_S_BUS_NODE, * WV_SP_BUS_NODE;
71
72 /* Exports. */
73 extern NTSTATUS STDCALL WvBusGetDevCapabilities(
74     IN PDEVICE_OBJECT,
75     IN PDEVICE_CAPABILITIES
76   );
77 extern winvblock__lib_func void WvBusInit(WV_SP_BUS_T);
78 extern winvblock__lib_func WV_SP_BUS_T WvBusCreate(void);
79 extern winvblock__lib_func winvblock__bool STDCALL WvBusAddChild(
80     IN OUT WV_SP_BUS_T,
81     IN WV_SP_DEV_T
82   );
83 extern winvblock__lib_func WV_SP_BUS_T WvBusFromDev(WV_SP_DEV_T);
84 extern winvblock__lib_func void WvBusProcessWorkItems(WV_SP_BUS_T);
85 extern winvblock__lib_func void WvBusCancelWorkItems(WV_SP_BUS_T);
86 extern winvblock__lib_func NTSTATUS WvBusStartThread(WV_SP_BUS_T);
87 extern winvblock__lib_func winvblock__bool STDCALL WvBusInitNode(
88     OUT WV_SP_BUS_NODE,
89     IN PDEVICE_OBJECT
90   );
91 extern winvblock__lib_func NTSTATUS STDCALL WvBusAddNode(
92     WV_SP_BUS_T,
93     WV_SP_BUS_NODE
94   );
95 extern winvblock__lib_func NTSTATUS STDCALL WvBusRemoveNode(WV_SP_BUS_NODE);
96 extern winvblock__lib_func NTSTATUS STDCALL WvBusEnqueueIrp(WV_SP_BUS_T, PIRP);
97 extern winvblock__lib_func NTSTATUS STDCALL WvBusSysCtl(
98     IN WV_SP_BUS_T,
99     IN PIRP
100   );
101
102 #endif  /* WV_M_BUS_H_ */