686509e15afb0551fff665a77b436000065c99e0
[people/sha0/winvblock.git] / src / winvblock / bus / bus.c
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
22 /**
23  * @file
24  *
25  * Bus specifics.
26  */
27
28 #include <ntddk.h>
29
30 #include "winvblock.h"
31 #include "wv_stdlib.h"
32 #include "portable.h"
33 #include "driver.h"
34 #include "device.h"
35 #include "bus.h"
36 #include "debug.h"
37
38 /* Types. */
39 typedef enum WV_BUS_WORK_ITEM_CMD_ {
40     WvBusWorkItemCmdAddPdo_,
41     WvBusWorkItemCmdRemovePdo_,
42     WvBusWorkItemCmdProcessIrp_,
43     WvBusWorkItemCmds_
44   } WV_E_BUS_WORK_ITEM_CMD_, * WV_EP_BUS_WORK_ITEM_CMD_;
45
46 typedef struct WV_BUS_WORK_ITEM_ {
47     LIST_ENTRY Link;
48     WV_E_BUS_WORK_ITEM_CMD_ Cmd;
49     union {
50         WV_SP_BUS_NODE Node;
51         PIRP Irp;
52       } Context;
53   } WV_S_BUS_WORK_ITEM_, * WV_SP_BUS_WORK_ITEM_;
54
55 /* Forward declarations. */
56 static WV_F_BUS_THREAD WvBusDefaultThread_;
57 static winvblock__bool WvBusAddWorkItem_(
58     WV_SP_BUS_T,
59     WV_SP_BUS_WORK_ITEM_
60   );
61 static WV_SP_BUS_WORK_ITEM_ WvBusGetWorkItem_(WV_SP_BUS_T);
62
63 /* Handle an IRP_MJ_SYSTEM_CONTROL IRP. */
64 winvblock__lib_func NTSTATUS STDCALL WvBusSysCtl(
65     IN WV_SP_BUS_T Bus,
66     IN PIRP Irp
67   ) {
68     PDEVICE_OBJECT lower = Bus->LowerDeviceObject;
69
70     if (lower) {
71         DBG("Passing IRP_MJ_SYSTEM_CONTROL down\n");
72         IoSkipCurrentIrpStackLocation(Irp);
73         return IoCallDriver(lower, Irp);
74       }
75     return driver__complete_irp(Irp, 0, STATUS_SUCCESS);
76   }
77
78 /* Handle a power IRP. */
79 winvblock__lib_func NTSTATUS STDCALL WvBusPower(
80     IN WV_SP_BUS_T Bus,
81     IN PIRP Irp
82   ) {
83     PDEVICE_OBJECT lower = Bus->LowerDeviceObject;
84
85     PoStartNextPowerIrp(Irp);
86     if (lower) {
87         IoSkipCurrentIrpStackLocation(Irp);
88         return PoCallDriver(lower, Irp);
89       }
90     return driver__complete_irp(Irp, 0, STATUS_SUCCESS);
91   }
92
93 /* Initialize a bus. */
94 static winvblock__bool STDCALL WvBusDevInit_(IN WV_SP_DEV_T dev) {
95     return TRUE;
96   }
97
98 /**
99  * Initialize bus defaults.
100  *
101  * @v Bus               Points to the bus to initialize with defaults.
102  */
103 winvblock__lib_func void WvBusInit(WV_SP_BUS_T Bus) {
104     RtlZeroMemory(Bus, sizeof *Bus);
105     /* Populate non-zero bus device defaults. */
106     WvDevInit(&Bus->Dev);
107     Bus->Thread = WvBusDefaultThread_;
108     InitializeListHead(&Bus->BusPrivate_.Nodes);
109     KeInitializeSpinLock(&Bus->BusPrivate_.WorkItemsLock);
110     InitializeListHead(&Bus->BusPrivate_.WorkItems);
111     KeInitializeEvent(&Bus->ThreadSignal, SynchronizationEvent, FALSE);
112     KeInitializeEvent(&Bus->ThreadStopped, SynchronizationEvent, FALSE);
113     Bus->Dev.Ops.Init = WvBusDevInit_;
114     Bus->Dev.ext = Bus;
115     Bus->Dev.IsBus = TRUE;
116   }
117
118 /**
119  * Create a new bus.
120  *
121  * @ret WV_SP_BUS_T     The address of a new bus, or NULL for failure.
122  *
123  * This function should not be confused with a PDO creation routine, which is
124  * actually implemented for each device type.  This routine will allocate a
125  * WV_S_BUS_T as well as populate the bus with default values.
126  */
127 winvblock__lib_func WV_SP_BUS_T WvBusCreate(void) {
128     WV_SP_BUS_T bus;
129
130     /*
131      * Bus devices might be used for booting and should
132      * not be allocated from a paged memory pool.
133      */
134     bus = wv_malloc(sizeof *bus);
135     if (bus == NULL)
136       goto err_no_bus;
137
138     WvBusInit(bus);
139     return bus;
140
141     wv_free(bus);
142     err_no_bus:
143
144     return NULL;
145   }
146
147 /**
148  * Add a work item for a bus to process.
149  *
150  * @v bus                       The bus to process the work item.
151  * @v work_item                 The work item to add.
152  * @ret winvblock__bool         TRUE if added, else FALSE
153  *
154  * Note that this function will initialize the work item's completion signal.
155  */
156 static winvblock__bool WvBusAddWorkItem_(
157     WV_SP_BUS_T bus,
158     WV_SP_BUS_WORK_ITEM_ work_item
159   ) {
160     ExInterlockedInsertTailList(
161         &bus->BusPrivate_.WorkItems,
162         &work_item->Link,
163         &bus->BusPrivate_.WorkItemsLock
164       );
165
166     return TRUE;
167   }
168
169 /**
170  * Get (and dequeue) a work item from a bus' queue.
171  *
172  * @v bus                       The bus processing the work item.
173  * @ret WV_SP_BUS_WORK_ITEM_    The work item, or NULL for an empty queue.
174  */
175 static WV_SP_BUS_WORK_ITEM_ WvBusGetWorkItem_(
176     WV_SP_BUS_T bus
177   ) {
178     PLIST_ENTRY list_entry;
179
180     list_entry = ExInterlockedRemoveHeadList(
181         &bus->BusPrivate_.WorkItems,
182         &bus->BusPrivate_.WorkItemsLock
183       );
184     if (!list_entry)
185       return NULL;
186
187     return CONTAINING_RECORD(list_entry, WV_S_BUS_WORK_ITEM_, Link);
188   }
189
190 /**
191  * Add a PDO node to a bus' list of children.  Internal.
192  *
193  * @v bus               The bus to add the node to.
194  * @v new_node          The PDO node to add to the bus.
195  *
196  * Don't call this function yourself.  It expects to have exclusive
197  * access to the bus' list of children.
198  */
199 static void STDCALL WvBusAddNode_(WV_SP_BUS_T bus, WV_SP_BUS_NODE new_node) {
200     PLIST_ENTRY walker;
201
202     DBG("Adding PDO to bus...\n");
203     ObReferenceObject(new_node->BusPrivate_.Pdo);
204     bus->BusPrivate_.NodeCount++;
205     /* It's too bad about having both linked list and bus ref. */
206     new_node->BusPrivate_.Bus = bus;
207
208     /* Find a slot for the new child. */
209     walker = &bus->BusPrivate_.Nodes;
210     new_node->BusPrivate_.Num = 0;
211     while ((walker = walker->Flink) != &bus->BusPrivate_.Nodes) {
212         WV_SP_BUS_NODE node = CONTAINING_RECORD(
213             walker,
214             WV_S_BUS_NODE,
215             BusPrivate_.Link
216           );
217
218         if (
219             node->BusPrivate_.Num &&
220             (node->BusPrivate_.Link.Blink == &bus->BusPrivate_.Nodes)
221           ) {
222             /* The first node's unit number is != 0.  Insert here. */
223             break;
224           }
225         if (node->BusPrivate_.Num > new_node->BusPrivate_.Num) {
226             /* There is a gap so insert here. */
227             break;
228           }
229         /* Continue trying to find a slot. */
230         new_node->BusPrivate_.Num++;
231       } /* while */
232     /* Insert before walker. */
233     InsertTailList(walker, &new_node->BusPrivate_.Link);
234     return;
235   }
236
237 /**
238  * Remove a PDO node from a bus.  Internal.
239  *
240  * @v bus             The bus to remove the node from.
241  * @v node            The PDO node to remove from its parent bus.
242  *
243  * Don't call this function yourself.  It expects to have exclusive
244  * access to the bus' list of children.
245  */
246 static void STDCALL WvBusRemoveNode_(
247     WV_SP_BUS_T bus,
248     WV_SP_BUS_NODE node
249   ) {
250     DBG("Removing PDO from bus...\n");
251     RemoveEntryList(&node->BusPrivate_.Link);
252     ObDereferenceObject(node->BusPrivate_.Pdo);
253     bus->BusPrivate_.NodeCount--;
254     return;    
255   }
256
257 /**
258  * Process work items for a bus.
259  *
260  * @v Bus               The bus to process its work items.
261  */
262 winvblock__lib_func void WvBusProcessWorkItems(WV_SP_BUS_T Bus) {
263     WV_SP_BUS_WORK_ITEM_ work_item;
264     WV_SP_BUS_NODE node;
265     PIRP irp;
266     PIO_STACK_LOCATION io_stack_loc;
267     PDEVICE_OBJECT dev_obj;
268     PDRIVER_OBJECT driver_obj;
269     winvblock__bool nodes_changed;
270
271     while (work_item = WvBusGetWorkItem_(Bus)) {
272         switch (work_item->Cmd) {
273             case WvBusWorkItemCmdAddPdo_:
274               node = work_item->Context.Node;
275               WvBusAddNode_(Bus, node);
276               nodes_changed = TRUE;
277               break;
278
279             case WvBusWorkItemCmdRemovePdo_:
280               node = work_item->Context.Node;
281               WvBusRemoveNode_(Bus, node);
282               nodes_changed = TRUE;
283               break;
284
285             case WvBusWorkItemCmdProcessIrp_:
286               irp = work_item->Context.Irp;
287               io_stack_loc = IoGetCurrentIrpStackLocation(irp);
288               dev_obj = Bus->Dev.Self;
289               driver_obj = dev_obj->DriverObject;
290               driver_obj->MajorFunction[io_stack_loc->MajorFunction](
291                   dev_obj,
292                   irp
293                 );
294               break;
295
296             default:
297               DBG("Unknown work item type!\n");
298           }
299         wv_free(work_item);
300       }
301     if (nodes_changed && Bus->PhysicalDeviceObject) {
302         nodes_changed = FALSE;
303         IoInvalidateDeviceRelations(
304             Bus->PhysicalDeviceObject,
305             BusRelations
306           );
307       }
308     return;
309   }
310
311 /**
312  * Cancel pending work items for a bus.
313  *
314  * @v Bus       The bus to cancel pending work items for.
315  */
316 winvblock__lib_func void WvBusCancelWorkItems(WV_SP_BUS_T Bus) {
317     WV_SP_BUS_WORK_ITEM_ work_item;
318
319     DBG("Canceling work items.\n");
320     while (work_item = WvBusGetWorkItem_(Bus))
321       wv_free(work_item);
322     return;
323   }
324
325 /**
326  * The bus thread wrapper.
327  *
328  * @v context           The thread context.  In our case, it points to
329  *                      the bus that the thread should use in processing.
330  *
331  * Note that we do not attempt to free the bus data; this is a bus
332  * implementor's responsibility.  We do, however, set the ThreadStopped
333  * signal which should mean that resources can be freed, from a completed
334  * thread's perspective.
335  */
336 static void STDCALL WvBusThread_(IN void * context) {
337     WV_SP_BUS_T bus = context;
338
339     if (!bus || !bus->Thread) {
340         DBG("No bus or no thread!\n");
341         return;
342       }
343
344     bus->Thread(bus);
345     KeSetEvent(&bus->ThreadStopped, 0, FALSE);
346     return;
347   }
348
349 /**
350  * The default bus thread routine.
351  *
352  * @v bus       Points to the bus device for the thread to work with.
353  *
354  * Note that if you implement your own bus type using this library,
355  * you can override the thread routine with your own.  If you do so,
356  * your thread routine should call WvBusProcessWorkItems() within
357  * its loop.  To start a bus thread, use WvBusStartThread()
358  * If you implement your own thread routine, you are also responsible
359  * for calling WvBusCancelWorkItems() and freeing the bus.
360  */
361 static void STDCALL WvBusDefaultThread_(IN WV_SP_BUS_T bus) {
362     LARGE_INTEGER timeout;
363
364     /* Wake up at least every 30 seconds. */
365     timeout.QuadPart = -300000000LL;
366
367     /* When WV_S_BUS_T::Stop is set, we shut down. */
368     while (!bus->Stop) {
369         DBG("Alive.\n");
370
371         /* Wait for the work signal or the timeout. */
372         KeWaitForSingleObject(
373             &bus->ThreadSignal,
374             Executive,
375             KernelMode,
376             FALSE,
377             &timeout
378           );
379         /* Reset the work signal. */
380         KeResetEvent(&bus->ThreadSignal);
381
382         WvBusProcessWorkItems(bus);
383       } /* while !bus->Stop */
384
385     WvBusCancelWorkItems(bus);
386     return;
387   }
388
389 /**
390  * Start a bus thread.
391  *
392  * @v Bus               The bus to start a thread for.
393  * @ret NTSTATUS        The status of the thread creation operation.
394  *
395  * Also see WV_F_BUS_THREAD in the header for details about the prototype
396  * for implementing your own bus thread routine.  You set WV_S_BUS_T::Thread
397  * to specify your own thread routine, then call this function to start it.
398  */
399 winvblock__lib_func NTSTATUS WvBusStartThread(
400     WV_SP_BUS_T Bus
401   ) {
402     OBJECT_ATTRIBUTES obj_attrs;
403     HANDLE thread_handle;
404
405     if (!Bus) {
406         DBG("No bus specified!\n");
407         return STATUS_INVALID_PARAMETER;
408       }
409
410     InitializeObjectAttributes(
411         &obj_attrs,
412         NULL,
413         OBJ_KERNEL_HANDLE,
414         NULL,
415         NULL
416       );
417     return PsCreateSystemThread(
418         &thread_handle,
419         THREAD_ALL_ACCESS,
420         &obj_attrs,
421         NULL,
422         NULL,
423         WvBusThread_,
424         Bus
425       );
426   }
427
428 /**
429  * Initialize a bus node with an associated PDO.
430  *
431  * @v Node              The node to initialize.
432  * @v Pdo               The PDO to associate the node with.
433  * @ret winvblock__bool FALSE for a NULL argument, otherwise TRUE
434  */
435 winvblock__lib_func winvblock__bool STDCALL WvBusInitNode(
436     OUT WV_SP_BUS_NODE Node,
437     IN PDEVICE_OBJECT Pdo
438   ) {
439     if (!Node || !Pdo)
440       return FALSE;
441
442     RtlZeroMemory(Node, sizeof *Node);
443     Node->BusPrivate_.Pdo = Pdo;
444     return TRUE;
445   }
446
447 /**
448  * Add a PDO node to a bus' list of children.
449  *
450  * @v Bus               The bus to add the node to.
451  * @v Node              The PDO node to add to the bus.
452  * @ret NTSTATUS        The status of the operation.
453  *
454  * Do not attempt to add the same node to more than one bus.
455  * When WvBusProcessWorkItems() is called for the bus, the
456  * node will be added.  This is usually from the bus' thread.
457  */
458 winvblock__lib_func NTSTATUS STDCALL WvBusAddNode(
459     WV_SP_BUS_T Bus,
460     WV_SP_BUS_NODE Node
461   ) {
462     WV_SP_BUS_WORK_ITEM_ work_item;
463
464     if (
465         !Bus ||
466         !Node ||
467         Bus->Dev.Self->DriverObject != Node->BusPrivate_.Pdo->DriverObject
468       )
469       return STATUS_INVALID_PARAMETER;
470
471     if (Bus->Stop)
472       return STATUS_NO_SUCH_DEVICE;
473
474     if (!(work_item = wv_malloc(sizeof *work_item)))
475       return STATUS_INSUFFICIENT_RESOURCES;
476
477     work_item->Cmd = WvBusWorkItemCmdAddPdo_;
478     work_item->Context.Node = Node;
479     if (!WvBusAddWorkItem_(Bus, work_item)) {
480         wv_free(work_item);
481         return STATUS_UNSUCCESSFUL;
482       }
483     /* Fire and forget. */
484     KeSetEvent(&Bus->ThreadSignal, 0, FALSE);
485     return STATUS_SUCCESS;
486   }
487
488 /**
489  * Remove a PDO node from a bus.
490  *
491  * @v Node              The PDO node to remove from its parent bus.
492  * @ret NTSTATUS        The status of the operation.
493  *
494  * When WvBusProcessWorkItems() is called for the bus, it will
495  * then remove the node.  This is usually from the bus' thread.
496  */
497 winvblock__lib_func NTSTATUS STDCALL WvBusRemoveNode(
498     WV_SP_BUS_NODE Node
499   ) {
500     WV_SP_BUS_T bus;
501     WV_SP_BUS_WORK_ITEM_ work_item;
502
503     if (!Node || !(bus = Node->BusPrivate_.Bus))
504       return STATUS_INVALID_PARAMETER;
505
506     if (bus->Stop)
507       return STATUS_NO_SUCH_DEVICE;
508
509     if (!(work_item = wv_malloc(sizeof *work_item)))
510       return STATUS_INSUFFICIENT_RESOURCES;
511
512     work_item->Cmd = WvBusWorkItemCmdRemovePdo_;
513     work_item->Context.Node = Node;
514     if (!WvBusAddWorkItem_(bus, work_item)) {
515         wv_free(work_item);
516         return STATUS_UNSUCCESSFUL;
517       }
518     /* Fire and forget. */
519     KeSetEvent(&bus->ThreadSignal, 0, FALSE);
520     return STATUS_SUCCESS;
521   }
522
523 /**
524  * Enqueue an IRP for a bus' thread to process.
525  *
526  * @v Bus               The bus for the IRP.
527  * @v Irp               The IRP for the bus.
528  * @ret NTSTATUS        The status of the operation.  Returns STATUS_PENDING
529  *                      if the IRP is successfully added to the queue.
530  */
531 winvblock__lib_func NTSTATUS STDCALL WvBusEnqueueIrp(
532     WV_SP_BUS_T Bus,
533     PIRP Irp
534   ) {
535     WV_SP_BUS_WORK_ITEM_ work_item;
536
537     if (!Bus || !Irp)
538       return STATUS_INVALID_PARAMETER;
539
540     if (Bus->Stop)
541       return STATUS_NO_SUCH_DEVICE;
542
543     if (!(work_item = wv_malloc(sizeof *work_item)))
544       return STATUS_INSUFFICIENT_RESOURCES;
545
546     work_item->Cmd = WvBusWorkItemCmdProcessIrp_;
547     work_item->Context.Irp = Irp;
548     IoMarkIrpPending(Irp);
549     if (!WvBusAddWorkItem_(Bus, work_item)) {
550         wv_free(work_item);
551         return STATUS_UNSUCCESSFUL;
552       }
553     /* Fire and forget. */
554     KeSetEvent(&Bus->ThreadSignal, 0, FALSE);
555     return STATUS_PENDING;
556   }