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