[bus] Rename bus__finalize to bus__module_shutdown
[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 _BUS_H
22 #  define _BUS_H
23
24 /**
25  * @file
26  *
27  * Bus specifics.
28  */
29
30 struct bus__type {
31     device__type_ptr device;
32     PDEVICE_OBJECT LowerDeviceObject;
33     PDEVICE_OBJECT PhysicalDeviceObject;
34     winvblock__uint32 Children;
35     device__type_ptr first_child_ptr;
36     KSPIN_LOCK SpinLock;
37     LIST_ENTRY tracking;
38     winvblock__any_ptr ext;
39     device__free_func * prev_free;
40     UNICODE_STRING dev_name;
41     UNICODE_STRING dos_dev_name;
42     winvblock__bool named;
43   };
44
45 extern NTSTATUS STDCALL bus__get_dev_capabilities(
46     IN PDEVICE_OBJECT,
47     IN PDEVICE_CAPABILITIES
48   );
49
50 extern NTSTATUS bus__module_init(void);
51 extern void bus__module_shutdown(void);
52
53 /**
54  * Create a new bus.
55  *
56  * @ret bus_ptr         The address of a new bus, or NULL for failure.
57  *
58  * This function should not be confused with a PDO creation routine, which is
59  * actually implemented for each device type.  This routine will allocate a
60  * bus__type, track it in a global list, as well as populate the bus
61  * with default values.
62  */
63 extern winvblock__lib_func struct bus__type * bus__create(void);
64
65 /**
66  * Add a child node to the bus.
67  *
68  * @v bus_ptr           Points to the bus receiving the child.
69  * @v dev_ptr           Points to the child device to add.
70  *
71  * Returns TRUE for success, FALSE for failure.
72  */
73 extern winvblock__lib_func winvblock__bool STDCALL bus__add_child(
74     IN OUT struct bus__type * bus_ptr,
75     IN device__type_ptr dev_ptr
76   );
77
78 /**
79  * Get a pointer to the bus device's extension space.
80  *
81  * @ret         A pointer to the bus device's extension space, or NULL.
82  */
83 extern winvblock__lib_func struct bus__type * bus__boot(void);
84
85 extern winvblock__lib_func struct bus__type * bus__get(device__type_ptr dev);
86
87 #endif  /* _BUS_H */