[bus] Rename WvBusPower to WvlBusPower
[people/sha0/winvblock.git] / src / include / bus.h
1 /**
2  * Copyright (C) 2009-2011, 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 WVL_M_BUS_H_
22 #  define WVL_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  * WvlBusProcessWorkItems() within its loop.
37  */
38 typedef VOID STDCALL WVL_F_BUS_THREAD(IN WVL_SP_BUS_T);
39 typedef WVL_F_BUS_THREAD * WVL_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 WVL_F_BUS_PNP(IN WVL_SP_BUS_T, IN PIRP);
49 typedef WVL_F_BUS_PNP * WVL_FP_BUS_PNP;
50
51 /* Device state. */
52 typedef enum WVL_BUS_STATE {
53     WvlBusStateNotStarted,
54     WvlBusStateStarted,
55     WvlBusStateStopPending,
56     WvlBusStateStopped,
57     WvlBusStateRemovePending,
58     WvlBusStateSurpriseRemovePending,
59     WvlBusStateDeleted,
60     WvlBusStates
61   } WVL_E_BUS_STATE, * WVL_EP_BUS_STATE;
62
63 /* The bus type. */
64 typedef struct WVL_BUS_T {
65     PDEVICE_OBJECT LowerDeviceObject;
66     PDEVICE_OBJECT Pdo;
67     PDEVICE_OBJECT Fdo;
68     UINT32 Children;
69     WVL_FP_BUS_THREAD Thread;
70     KEVENT ThreadSignal;
71     BOOLEAN Stop;
72     WVL_E_BUS_STATE OldState;
73     WVL_E_BUS_STATE State;
74     WVL_FP_BUS_PNP QueryDevText;
75     struct {
76         LIST_ENTRY Nodes;
77         USHORT NodeCount;
78         LIST_ENTRY WorkItems;
79         KSPIN_LOCK WorkItemsLock;
80       } BusPrivate_;
81   } WVL_S_BUS_T, * WVL_SP_BUS_T;
82
83 /* A child PDO node on a bus.  Treat this as an opaque type. */
84 typedef struct WVL_BUS_NODE {
85     struct {
86         LIST_ENTRY Link;
87         PDEVICE_OBJECT Pdo;
88         WVL_SP_BUS_T Bus;
89         /* The child's unit number relative to the parent bus. */
90         UINT32 Num;
91       } BusPrivate_;
92   } WVL_S_BUS_NODE, * WVL_SP_BUS_NODE;
93
94 /**
95  * A custom work-item function.
96  *
97  * @v context           Function-specific data.
98  *
99  * If a driver needs to enqueue a work item which should execute in the
100  * context of the bus' controlling thread (this is the thread which calls
101  * WvlBusProcessWorkItems()), then this is the function prototype to be
102  * used.
103  */
104 typedef VOID STDCALL WVL_F_BUS_WORK_ITEM(PVOID);
105 typedef WVL_F_BUS_WORK_ITEM * WVL_FP_BUS_WORK_ITEM;
106
107 typedef struct WVL_BUS_CUSTOM_WORK_ITEM {
108     WVL_FP_BUS_WORK_ITEM Func;
109     PVOID Context;
110   } WVL_S_BUS_CUSTOM_WORK_ITEM, * WVL_SP_BUS_CUSTOM_WORK_ITEM;
111
112 /* Exports. */
113 extern WVL_M_LIB VOID WvlBusInit(WVL_SP_BUS_T);
114 extern WVL_M_LIB VOID WvlBusProcessWorkItems(WVL_SP_BUS_T);
115 extern WVL_M_LIB VOID WvlBusCancelWorkItems(WVL_SP_BUS_T);
116 extern WVL_M_LIB NTSTATUS WvlBusStartThread(
117     IN WVL_SP_BUS_T,
118     OUT PETHREAD *
119   );
120 extern WVL_M_LIB BOOLEAN STDCALL WvlBusInitNode(
121     OUT WVL_SP_BUS_NODE,
122     IN PDEVICE_OBJECT
123   );
124 extern WVL_M_LIB NTSTATUS STDCALL WvlBusAddNode(
125     WVL_SP_BUS_T,
126     WVL_SP_BUS_NODE
127   );
128 extern WVL_M_LIB NTSTATUS STDCALL WvlBusRemoveNode(WVL_SP_BUS_NODE);
129 extern WVL_M_LIB NTSTATUS STDCALL WvlBusEnqueueIrp(WVL_SP_BUS_T, PIRP);
130 extern WVL_M_LIB NTSTATUS STDCALL WvlBusEnqueueCustomWorkItem(
131     WVL_SP_BUS_T,
132     WVL_SP_BUS_CUSTOM_WORK_ITEM
133   );
134 extern WVL_M_LIB NTSTATUS STDCALL WvlBusSysCtl(
135     IN WVL_SP_BUS_T,
136     IN PIRP
137   );
138 extern WVL_M_LIB NTSTATUS STDCALL WvlBusPower(
139     IN WVL_SP_BUS_T,
140     IN PIRP
141   );
142 /* IRP_MJ_PNP dispatcher in bus/pnp.c */
143 extern WVL_M_LIB NTSTATUS STDCALL WvBusPnp(
144     IN WVL_SP_BUS_T,
145     IN PIRP,
146     IN UCHAR
147   );
148 extern WVL_M_LIB UINT32 STDCALL WvBusGetNodeNum(
149     IN WVL_SP_BUS_NODE
150   );
151 extern WVL_M_LIB WVL_SP_BUS_NODE STDCALL WvBusGetNextNode(
152     IN WVL_SP_BUS_T,
153     IN WVL_SP_BUS_NODE
154   );
155 extern WVL_M_LIB PDEVICE_OBJECT STDCALL WvBusGetNodePdo(
156     IN WVL_SP_BUS_NODE
157   );
158 extern WVL_M_LIB UINT32 STDCALL WvBusGetNodeCount(
159     WVL_SP_BUS_T
160   );
161
162 #endif  /* WVL_M_BUS_H_ */