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