[bus] Add QueryDevText member to WV_S_BUS_T
[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 /**
42  * A bus PnP routine.
43  *
44  * @v bus               The bus to receive the PnP IRP.
45  * @v irp               The IRP to process.
46  * @ret NTSTATUS        The status of the operation.
47  */
48 typedef NTSTATUS STDCALL WV_F_BUS_PNP(IN WV_SP_BUS_T, IN PIRP);
49 typedef WV_F_BUS_PNP * WV_FP_BUS_PNP;
50
51 /* Device state. */
52 typedef enum WV_BUS_STATE {
53     WvBusStateNotStarted,
54     WvBusStateStarted,
55     WvBusStateStopPending,
56     WvBusStateStopped,
57     WvBusStateRemovePending,
58     WvBusStateSurpriseRemovePending,
59     WvBusStateDeleted,
60     WvBusStates
61   } WV_E_BUS_STATE, * WV_EP_BUS_STATE;
62
63 /* The bus type. */
64 typedef struct WV_BUS_T {
65     WV_S_DEV_T Dev;
66     PDEVICE_OBJECT LowerDeviceObject;
67     PDEVICE_OBJECT PhysicalDeviceObject;
68     PDEVICE_OBJECT Fdo;
69     winvblock__uint32 Children;
70     WV_SP_DEV_T first_child;
71     WV_FP_BUS_THREAD Thread;
72     KEVENT ThreadSignal;
73     winvblock__bool Stop;
74     KEVENT ThreadStopped;
75     WV_E_BUS_STATE OldState;
76     WV_E_BUS_STATE State;
77     WV_FP_BUS_PNP QueryDevText;
78     struct {
79         LIST_ENTRY Nodes;
80         USHORT NodeCount;
81         LIST_ENTRY WorkItems;
82         KSPIN_LOCK WorkItemsLock;
83       } BusPrivate_;
84   } WV_S_BUS_T, * WV_SP_BUS_T;
85
86 /* A child PDO node on a bus.  Treat this as an opaque type. */
87 typedef struct WV_BUS_NODE {
88     struct {
89         LIST_ENTRY Link;
90         PDEVICE_OBJECT Pdo;
91         WV_SP_BUS_T Bus;
92         /* The child's unit number relative to the parent bus. */
93         winvblock__uint32 Num;
94       } BusPrivate_;
95   } WV_S_BUS_NODE, * WV_SP_BUS_NODE;
96
97 /* Exports. */
98 extern winvblock__lib_func void WvBusInit(WV_SP_BUS_T);
99 extern winvblock__lib_func WV_SP_BUS_T WvBusCreate(void);
100 extern winvblock__lib_func void WvBusProcessWorkItems(WV_SP_BUS_T);
101 extern winvblock__lib_func void WvBusCancelWorkItems(WV_SP_BUS_T);
102 extern winvblock__lib_func NTSTATUS WvBusStartThread(WV_SP_BUS_T);
103 extern winvblock__lib_func winvblock__bool STDCALL WvBusInitNode(
104     OUT WV_SP_BUS_NODE,
105     IN PDEVICE_OBJECT
106   );
107 extern winvblock__lib_func NTSTATUS STDCALL WvBusAddNode(
108     WV_SP_BUS_T,
109     WV_SP_BUS_NODE
110   );
111 extern winvblock__lib_func NTSTATUS STDCALL WvBusRemoveNode(WV_SP_BUS_NODE);
112 extern winvblock__lib_func NTSTATUS STDCALL WvBusEnqueueIrp(WV_SP_BUS_T, PIRP);
113 extern winvblock__lib_func NTSTATUS STDCALL WvBusSysCtl(
114     IN WV_SP_BUS_T,
115     IN PIRP
116   );
117 extern winvblock__lib_func NTSTATUS STDCALL WvBusPower(
118     IN WV_SP_BUS_T,
119     IN PIRP
120   );
121 /* IRP_MJ_PNP dispatcher in bus/pnp.c */
122 extern winvblock__lib_func NTSTATUS STDCALL WvBusPnp(
123     IN WV_SP_BUS_T,
124     IN PIRP,
125     IN UCHAR
126   );
127
128 #endif  /* WV_M_BUS_H_ */