[bus] Minor style/cosmetic changes
[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 winvblock__def_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_GetDeviceCapabilities(
46     IN PDEVICE_OBJECT DeviceObject,
47     IN PDEVICE_CAPABILITIES DeviceCapabilities
48   );
49
50 /**
51  * Initialize the global, bus-common environment.
52  *
53  * @ret ntstatus        STATUS_SUCCESS or the NTSTATUS for a failure.
54  */
55 extern NTSTATUS bus__init(void);
56
57 /**
58  * Tear down the global, bus-common environment.
59  */
60 extern void bus__finalize(void);
61
62 /**
63  * Create a new bus.
64  *
65  * @ret bus_ptr         The address of a new bus, or NULL for failure.
66  *
67  * This function should not be confused with a PDO creation routine, which is
68  * actually implemented for each device type.  This routine will allocate a
69  * bus__type, track it in a global list, as well as populate the bus
70  * with default values.
71  */
72 extern winvblock__lib_func bus__type_ptr bus__create(void);
73
74 /**
75  * Add a child node to the bus.
76  *
77  * @v bus_ptr           Points to the bus receiving the child.
78  * @v dev_ptr           Points to the child device to add.
79  *
80  * Returns TRUE for success, FALSE for failure.
81  */
82 extern winvblock__lib_func winvblock__bool STDCALL bus__add_child(
83     IN OUT bus__type_ptr bus_ptr,
84     IN device__type_ptr dev_ptr
85   );
86
87 /**
88  * Get a pointer to the bus device's extension space.
89  *
90  * @ret         A pointer to the bus device's extension space, or NULL.
91  */
92 extern winvblock__lib_func bus__type_ptr bus__boot(void);
93
94 extern winvblock__lib_func bus__type_ptr bus__get(device__type_ptr dev);
95
96 #endif  /* _BUS_H */