[bus] Rename bus__process_work_items to WvBusProcessWorkItems
[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     struct device__type * device;
44     PDEVICE_OBJECT LowerDeviceObject;
45     PDEVICE_OBJECT PhysicalDeviceObject;
46     winvblock__uint32 Children;
47     struct device__type * first_child;
48     KSPIN_LOCK SpinLock;
49     LIST_ENTRY tracking;
50     winvblock__any_ptr ext;
51     device__free_func * prev_free;
52     UNICODE_STRING dev_name;
53     UNICODE_STRING dos_dev_name;
54     winvblock__bool named;
55     LIST_ENTRY work_items;
56     KSPIN_LOCK work_items_lock;
57     KEVENT work_signal;
58     WV_FP_BUS_THREAD thread;
59     winvblock__bool Stop;
60     struct {
61         LIST_ENTRY Nodes;
62         USHORT NodeCount;
63       } BusPrivate_;
64   } WV_S_BUS_T, * WV_SP_BUS_T;
65
66 /* A child PDO node on a bus.  Treat this as an opaque type. */
67 typedef struct WV_BUS_NODE {
68     struct {
69         LIST_ENTRY Link;
70         PDEVICE_OBJECT Pdo;
71         WV_SP_BUS_T Bus;
72       } BusPrivate_;
73   } WV_S_BUS_NODE, * WV_SP_BUS_NODE;
74
75 /* Exports. */
76 extern NTSTATUS STDCALL WvBusGetDevCapabilities(
77     IN PDEVICE_OBJECT,
78     IN PDEVICE_CAPABILITIES
79   );
80 extern winvblock__lib_func void WvBusInit(WV_SP_BUS_T);
81 extern winvblock__lib_func WV_SP_BUS_T WvBusCreate(void);
82 extern winvblock__lib_func winvblock__bool STDCALL WvBusAddChild(
83     IN OUT WV_SP_BUS_T,
84     IN struct device__type *
85   );
86 extern winvblock__lib_func WV_SP_BUS_T WvBusFromDev(struct device__type *);
87 extern winvblock__lib_func void WvBusProcessWorkItems(WV_SP_BUS_T);
88 extern winvblock__lib_func NTSTATUS bus__start_thread(WV_SP_BUS_T);
89 extern winvblock__lib_func winvblock__bool STDCALL WvBusInitNode(
90     OUT WV_SP_BUS_NODE,
91     IN PDEVICE_OBJECT
92   );
93 extern winvblock__lib_func NTSTATUS STDCALL WvBusAddNode(
94     WV_SP_BUS_T,
95     WV_SP_BUS_NODE
96   );
97 extern winvblock__lib_func NTSTATUS STDCALL WvBusRemoveNode(WV_SP_BUS_NODE);
98
99 #endif  /* WV_M_BUS_H_ */