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