[bus,driver] Put bus IRP_MJ_PNP handler in driver
[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 /* IRP_MJ_DEVICE_CONTROL dispatcher from bus/dev_ctl.c */
39 extern WV_F_DEV_CTL WvBusDevCtlDispatch;
40
41 /* Types. */
42 typedef enum WV_BUS_WORK_ITEM_CMD_ {
43     WvBusWorkItemCmdAddPdo_,
44     WvBusWorkItemCmdRemovePdo_,
45     WvBusWorkItemCmdProcessIrp_,
46     WvBusWorkItemCmds_
47   } WV_E_BUS_WORK_ITEM_CMD_, * WV_EP_BUS_WORK_ITEM_CMD_;
48
49 typedef struct WV_BUS_WORK_ITEM_ {
50     LIST_ENTRY Link;
51     WV_E_BUS_WORK_ITEM_CMD_ Cmd;
52     union {
53         WV_SP_BUS_NODE Node;
54         PIRP Irp;
55       } Context;
56   } WV_S_BUS_WORK_ITEM_, * WV_SP_BUS_WORK_ITEM_;
57
58 /* Forward declarations. */
59 static WV_F_DEV_FREE WvBusFree_;
60 static WV_F_DEV_CREATE_PDO WvBusCreatePdo_;
61 static WV_F_BUS_THREAD WvBusDefaultThread_;
62 static winvblock__bool WvBusAddWorkItem_(
63     WV_SP_BUS_T,
64     WV_SP_BUS_WORK_ITEM_
65   );
66 static WV_SP_BUS_WORK_ITEM_ WvBusGetWorkItem_(WV_SP_BUS_T);
67
68 /* Globals. */
69 WV_S_DEV_IRP_MJ WvBusIrpMj_ = {
70     (WV_FP_DEV_DISPATCH) 0,
71     (WV_FP_DEV_DISPATCH) 0,
72     WvBusDevCtlDispatch,
73     (WV_FP_DEV_SCSI) 0,
74     (WV_FP_DEV_PNP) 0,
75   };
76
77 /**
78  * Add a child node to the bus.
79  *
80  * @v Bus               Points to the bus receiving the child.
81  * @v Dev               Points to the child device to add.
82  * @ret                 TRUE for success, FALSE for failure.
83  */
84 winvblock__lib_func winvblock__bool STDCALL WvBusAddChild(
85     IN OUT WV_SP_BUS_T Bus,
86     IN OUT WV_SP_DEV_T Dev
87   ) {
88     /* The new node's device object. */
89     PDEVICE_OBJECT dev_obj;
90     /* Walks the child nodes. */
91     WV_SP_DEV_T walker;
92     winvblock__uint32 dev_num;
93
94     DBG("Entry\n");
95     if ((Bus == NULL) || (Dev == NULL)) {
96         DBG("No bus or no device!\n");
97         return FALSE;
98       }
99     /* Create the child device. */
100     dev_obj = WvDevCreatePdo(Dev);
101     if (dev_obj == NULL) {
102         DBG("PDO creation failed!\n");
103         WvDevFree(Dev);
104         return FALSE;
105       }
106
107     Dev->Parent = Bus->Dev.Self;
108     /*
109      * Initialize the device.  For disks, this routine is responsible for
110      * determining the disk's geometry appropriately for AoE/RAM/file disks.
111      */
112     Dev->Ops.Init(Dev);
113     dev_obj->Flags &= ~DO_DEVICE_INITIALIZING;
114     /* Add the new device's extension to the bus' list of children. */
115     dev_num = 0;
116     if (Bus->first_child == NULL) {
117         Bus->first_child = Dev;
118       } else {
119         walker = Bus->first_child;
120         /* If the first child device number isn't 0... */
121         if (walker->DevNum) {
122             /* We insert before. */
123             Dev->next_sibling_ptr = walker;
124             Bus->first_child = Dev;
125           } else {
126             while (walker->next_sibling_ptr != NULL) {
127                 /* If there's a gap in the device numbers for the bus... */
128                 if (walker->DevNum < walker->next_sibling_ptr->DevNum - 1) {
129                     /* Insert here, instead of at the end. */
130                     dev_num = walker->DevNum + 1;
131                     Dev->next_sibling_ptr = walker->next_sibling_ptr;
132                     walker->next_sibling_ptr = Dev;
133                     break;
134                   }
135                 walker = walker->next_sibling_ptr;
136                 dev_num = walker->DevNum + 1;
137               }
138             /* If we haven't already inserted the device... */
139             if (!Dev->next_sibling_ptr) {
140                 walker->next_sibling_ptr = Dev;
141                 dev_num = walker->DevNum + 1;
142               }
143           }
144       }
145     Dev->DevNum = dev_num;
146     Bus->Children++;
147     if (Bus->PhysicalDeviceObject != NULL) {
148         IoInvalidateDeviceRelations(
149             Bus->PhysicalDeviceObject,
150             BusRelations
151           );
152       }
153     DBG("Exit\n");
154     return TRUE;
155   }
156
157 /* Handle an IRP_MJ_SYSTEM_CONTROL IRP. */
158 winvblock__lib_func NTSTATUS STDCALL WvBusSysCtl(
159     IN WV_SP_BUS_T Bus,
160     IN PIRP Irp
161   ) {
162     PDEVICE_OBJECT lower = Bus->LowerDeviceObject;
163
164     if (lower) {
165         DBG("Passing IRP_MJ_SYSTEM_CONTROL down\n");
166         IoSkipCurrentIrpStackLocation(Irp);
167         return IoCallDriver(lower, Irp);
168       }
169     return driver__complete_irp(Irp, 0, STATUS_SUCCESS);
170   }
171
172 /* Handle a power IRP. */
173 winvblock__lib_func NTSTATUS STDCALL WvBusPower(
174     IN WV_SP_BUS_T Bus,
175     IN PIRP Irp
176   ) {
177     PDEVICE_OBJECT lower = Bus->LowerDeviceObject;
178
179     PoStartNextPowerIrp(Irp);
180     if (lower) {
181         IoSkipCurrentIrpStackLocation(Irp);
182         return PoCallDriver(lower, Irp);
183       }
184     return driver__complete_irp(Irp, 0, STATUS_SUCCESS);
185   }
186
187 NTSTATUS STDCALL WvBusGetDevCapabilities(
188     IN PDEVICE_OBJECT DevObj,
189     IN PDEVICE_CAPABILITIES DevCapabilities
190   ) {
191     IO_STATUS_BLOCK io_status;
192     KEVENT pnp_event;
193     NTSTATUS status;
194     PDEVICE_OBJECT target_obj;
195     PIO_STACK_LOCATION io_stack_loc;
196     PIRP pnp_irp;
197
198     RtlZeroMemory(DevCapabilities, sizeof *DevCapabilities);
199     DevCapabilities->Size = sizeof *DevCapabilities;
200     DevCapabilities->Version = 1;
201     DevCapabilities->Address = -1;
202     DevCapabilities->UINumber = -1;
203
204     KeInitializeEvent(&pnp_event, NotificationEvent, FALSE);
205     target_obj = IoGetAttachedDeviceReference(DevObj);
206     pnp_irp = IoBuildSynchronousFsdRequest(
207         IRP_MJ_PNP,
208         target_obj,
209         NULL,
210         0,
211         NULL,
212         &pnp_event,
213         &io_status
214       );
215     if (pnp_irp == NULL) {
216         status = STATUS_INSUFFICIENT_RESOURCES;
217       } else {
218         pnp_irp->IoStatus.Status = STATUS_NOT_SUPPORTED;
219         io_stack_loc = IoGetNextIrpStackLocation(pnp_irp);
220         RtlZeroMemory(io_stack_loc, sizeof *io_stack_loc);
221         io_stack_loc->MajorFunction = IRP_MJ_PNP;
222         io_stack_loc->MinorFunction = IRP_MN_QUERY_CAPABILITIES;
223         io_stack_loc->Parameters.DeviceCapabilities.Capabilities =
224           DevCapabilities;
225         status = IoCallDriver(target_obj, pnp_irp);
226         if (status == STATUS_PENDING) {
227             KeWaitForSingleObject(
228                 &pnp_event,
229                 Executive,
230                 KernelMode,
231                 FALSE,
232                 NULL
233               );
234             status = io_status.Status;
235           }
236       }
237     ObDereferenceObject(target_obj);
238     return status;
239   }
240
241 /* Initialize a bus. */
242 static winvblock__bool STDCALL WvBusDevInit_(IN WV_SP_DEV_T dev) {
243     return TRUE;
244   }
245
246 /**
247  * Initialize bus defaults.
248  *
249  * @v Bus               Points to the bus to initialize with defaults.
250  */
251 winvblock__lib_func void WvBusInit(WV_SP_BUS_T Bus) {
252     RtlZeroMemory(Bus, sizeof *Bus);
253     /* Populate non-zero bus device defaults. */
254     WvDevInit(&Bus->Dev);
255     Bus->Thread = WvBusDefaultThread_;
256     KeInitializeSpinLock(&Bus->BusPrivate_.WorkItemsLock);
257     InitializeListHead(&Bus->BusPrivate_.WorkItems);
258     KeInitializeEvent(&Bus->ThreadSignal, SynchronizationEvent, FALSE);
259     KeInitializeEvent(&Bus->ThreadStopped, SynchronizationEvent, FALSE);
260     Bus->Dev.Ops.CreatePdo = WvBusCreatePdo_;
261     Bus->Dev.Ops.Init = WvBusDevInit_;
262     Bus->Dev.Ops.Free = WvBusFree_;
263     Bus->Dev.ext = Bus;
264     Bus->Dev.IrpMj = &WvBusIrpMj_;
265     Bus->Dev.IsBus = TRUE;
266   }
267
268 /**
269  * Create a new bus.
270  *
271  * @ret WV_SP_BUS_T     The address of a new bus, or NULL for failure.
272  *
273  * This function should not be confused with a PDO creation routine, which is
274  * actually implemented for each device type.  This routine will allocate a
275  * WV_S_BUS_T as well as populate the bus with default values.
276  */
277 winvblock__lib_func WV_SP_BUS_T WvBusCreate(void) {
278     WV_SP_BUS_T bus;
279
280     /*
281      * Bus devices might be used for booting and should
282      * not be allocated from a paged memory pool.
283      */
284     bus = wv_malloc(sizeof *bus);
285     if (bus == NULL)
286       goto err_no_bus;
287
288     WvBusInit(bus);
289     return bus;
290
291     wv_free(bus);
292     err_no_bus:
293
294     return NULL;
295   }
296
297 /**
298  * Create a bus PDO.
299  *
300  * @v dev               Populate PDO dev. ext. space from these details.
301  * @ret PDEVICE_OBJECT  Points to the new PDO, or is NULL upon failure.
302  *
303  * Returns a Physical Device Object pointer on success, NULL for failure.
304  */
305 static PDEVICE_OBJECT STDCALL WvBusCreatePdo_(IN WV_SP_DEV_T dev) {
306     PDEVICE_OBJECT pdo = NULL;
307     WV_SP_BUS_T bus;
308     NTSTATUS status;
309
310     /* Note the bus device needing a PDO. */
311     if (dev == NULL) {
312         DBG("No device passed\n");
313         return NULL;
314       }
315     bus = WvBusFromDev(dev);
316     /* Create the PDO. */
317     status = IoCreateDevice(
318         dev->DriverObject,
319         sizeof (driver__dev_ext),
320         NULL,
321         FILE_DEVICE_CONTROLLER,
322         FILE_DEVICE_SECURE_OPEN,
323         FALSE,
324         &pdo
325       );
326     if (pdo == NULL) {
327         DBG("IoCreateDevice() failed!\n");
328         goto err_pdo;
329       }
330
331     /* Set associations for the bus, device, PDO. */
332     WvDevForDevObj(pdo, dev);
333     dev->Self = bus->PhysicalDeviceObject = pdo;
334
335     /* Set some DEVICE_OBJECT status. */
336     pdo->Flags |= DO_DIRECT_IO;         /* FIXME? */
337     pdo->Flags |= DO_POWER_INRUSH;      /* FIXME? */
338     pdo->Flags &= ~DO_DEVICE_INITIALIZING;
339     #ifdef RIS
340     dev->State = Started;
341     #endif
342
343     return pdo;
344
345     IoDeleteDevice(pdo);
346     err_pdo:
347
348     return NULL;
349   }
350
351 /**
352  * Default bus deletion operation.
353  *
354  * @v dev               Points to the bus device to delete.
355  */
356 static void STDCALL WvBusFree_(IN WV_SP_DEV_T dev) {
357     WV_SP_BUS_T bus = WvBusFromDev(dev);
358
359     wv_free(bus);
360   }
361
362 /**
363  * Get a bus from a device.
364  *
365  * @v dev       A pointer to a device.
366  * @ret         A pointer to the device's associated bus.
367  */
368 extern winvblock__lib_func WV_SP_BUS_T WvBusFromDev(WV_SP_DEV_T Dev) {
369     return Dev->ext;
370   }
371
372 /**
373  * Add a work item for a bus to process.
374  *
375  * @v bus                       The bus to process the work item.
376  * @v work_item                 The work item to add.
377  * @ret winvblock__bool         TRUE if added, else FALSE
378  *
379  * Note that this function will initialize the work item's completion signal.
380  */
381 static winvblock__bool WvBusAddWorkItem_(
382     WV_SP_BUS_T bus,
383     WV_SP_BUS_WORK_ITEM_ work_item
384   ) {
385     ExInterlockedInsertTailList(
386         &bus->BusPrivate_.WorkItems,
387         &work_item->Link,
388         &bus->BusPrivate_.WorkItemsLock
389       );
390
391     return TRUE;
392   }
393
394 /**
395  * Get (and dequeue) a work item from a bus' queue.
396  *
397  * @v bus                       The bus processing the work item.
398  * @ret WV_SP_BUS_WORK_ITEM_    The work item, or NULL for an empty queue.
399  */
400 static WV_SP_BUS_WORK_ITEM_ WvBusGetWorkItem_(
401     WV_SP_BUS_T bus
402   ) {
403     PLIST_ENTRY list_entry;
404
405     list_entry = ExInterlockedRemoveHeadList(
406         &bus->BusPrivate_.WorkItems,
407         &bus->BusPrivate_.WorkItemsLock
408       );
409     if (!list_entry)
410       return NULL;
411
412     return CONTAINING_RECORD(list_entry, WV_S_BUS_WORK_ITEM_, Link);
413   }
414
415 /**
416  * Add a PDO node to a bus' list of children.  Internal.
417  *
418  * @v bus               The bus to add the node to.
419  * @v new_node          The PDO node to add to the bus.
420  *
421  * Don't call this function yourself.  It expects to have exclusive
422  * access to the bus' list of children.
423  */
424 static void STDCALL WvBusAddNode_(WV_SP_BUS_T bus, WV_SP_BUS_NODE new_node) {
425     PLIST_ENTRY walker;
426
427     DBG("Adding PDO to bus...\n");
428     ObReferenceObject(new_node->BusPrivate_.Pdo);
429     bus->BusPrivate_.NodeCount++;
430     /* It's too bad about having both linked list and bus ref. */
431     new_node->BusPrivate_.Bus = bus;
432
433     /* Find a slot for the new child. */
434     walker = &bus->BusPrivate_.Nodes;
435     new_node->BusPrivate_.Num = 0;
436     while ((walker = walker->Flink) != &bus->BusPrivate_.Nodes) {
437         WV_SP_BUS_NODE node = CONTAINING_RECORD(
438             walker,
439             WV_S_BUS_NODE,
440             BusPrivate_.Link
441           );
442
443         if (
444             node->BusPrivate_.Num &&
445             (node->BusPrivate_.Link.Blink == &bus->BusPrivate_.Nodes)
446           ) {
447             /* The first node's unit number is != 0.  Insert here. */
448             break;
449           }
450         if (node->BusPrivate_.Num > new_node->BusPrivate_.Num) {
451             /* There is a gap so insert here. */
452             break;
453           }
454         /* Continue trying to find a slot. */
455         new_node->BusPrivate_.Num++;
456       } /* while */
457     /* Insert before walker. */
458     InsertTailList(walker, &new_node->BusPrivate_.Link);
459     return;
460   }
461
462 /**
463  * Process work items for a bus.
464  *
465  * @v Bus               The bus to process its work items.
466  */
467 winvblock__lib_func void WvBusProcessWorkItems(WV_SP_BUS_T Bus) {
468     WV_SP_BUS_WORK_ITEM_ work_item;
469     WV_SP_BUS_NODE node;
470     PIRP irp;
471     PIO_STACK_LOCATION io_stack_loc;
472     PDEVICE_OBJECT dev_obj;
473     PDRIVER_OBJECT driver_obj;
474
475     while (work_item = WvBusGetWorkItem_(Bus)) {
476         switch (work_item->Cmd) {
477             case WvBusWorkItemCmdAddPdo_:
478               node = work_item->Context.Node;
479               WvBusAddNode_(Bus, node);
480               break;
481
482             case WvBusWorkItemCmdRemovePdo_:
483               DBG("Removing PDO from bus...\n");
484
485               node = work_item->Context.Node;
486               RemoveEntryList(&node->BusPrivate_.Link);
487               ObDereferenceObject(node->BusPrivate_.Pdo);
488               Bus->BusPrivate_.NodeCount--;
489               break;
490
491             case WvBusWorkItemCmdProcessIrp_:
492               irp = work_item->Context.Irp;
493               io_stack_loc = IoGetCurrentIrpStackLocation(irp);
494               dev_obj = Bus->Dev.Self;
495               driver_obj = dev_obj->DriverObject;
496               driver_obj->MajorFunction[io_stack_loc->MajorFunction](
497                   dev_obj,
498                   irp
499                 );
500               break;
501
502             default:
503               DBG("Unknown work item type!\n");
504           }
505         wv_free(work_item);
506       }
507     return;
508   }
509
510 /**
511  * Cancel pending work items for a bus.
512  *
513  * @v Bus       The bus to cancel pending work items for.
514  */
515 winvblock__lib_func void WvBusCancelWorkItems(WV_SP_BUS_T Bus) {
516     WV_SP_BUS_WORK_ITEM_ work_item;
517
518     DBG("Canceling work items.\n");
519     while (work_item = WvBusGetWorkItem_(Bus))
520       wv_free(work_item);
521     return;
522   }
523
524 /* The WV_S_DEV_T::Ops.Free implementation for a threaded bus. */
525 static void STDCALL WvBusThreadFree_(IN WV_SP_DEV_T dev) {
526     WV_SP_BUS_T bus = WvBusFromDev(dev);
527
528     bus->Stop = TRUE;
529     KeSetEvent(&bus->ThreadSignal, 0, FALSE);
530     return;
531   }
532
533 /**
534  * The bus thread wrapper.
535  *
536  * @v context           The thread context.  In our case, it points to
537  *                      the bus that the thread should use in processing.
538  *
539  * Note that we do not attempt to free the bus data; this is a bus
540  * implementor's responsibility.  We do, however, set the ThreadStopped
541  * signal which should mean that resources can be freed, from a completed
542  * thread's perspective.
543  */
544 static void STDCALL WvBusThread_(IN void * context) {
545     WV_SP_BUS_T bus = context;
546
547     if (!bus || !bus->Thread) {
548         DBG("No bus or no thread!\n");
549         return;
550       }
551
552     bus->Thread(bus);
553     KeSetEvent(&bus->ThreadStopped, 0, FALSE);
554     return;
555   }
556
557 /**
558  * The default bus thread routine.
559  *
560  * @v bus       Points to the bus device for the thread to work with.
561  *
562  * Note that if you implement your own bus type using this library,
563  * you can override the thread routine with your own.  If you do so,
564  * your thread routine should call WvBusProcessWorkItems() within
565  * its loop.  To start a bus thread, use WvBusStartThread()
566  * If you implement your own thread routine, you are also responsible
567  * for calling WvBusCancelWorkItems() and freeing the bus.
568  */
569 static void STDCALL WvBusDefaultThread_(IN WV_SP_BUS_T bus) {
570     LARGE_INTEGER timeout;
571
572     /* Wake up at least every 30 seconds. */
573     timeout.QuadPart = -300000000LL;
574
575     /* Hook WV_S_DEV_T::Ops.Free() */
576     bus->Dev.Ops.Free = WvBusThreadFree_;
577
578     /* When WV_S_BUS_T::Stop is set, we shut down. */
579     while (!bus->Stop) {
580         DBG("Alive.\n");
581
582         /* Wait for the work signal or the timeout. */
583         KeWaitForSingleObject(
584             &bus->ThreadSignal,
585             Executive,
586             KernelMode,
587             FALSE,
588             &timeout
589           );
590         /* Reset the work signal. */
591         KeResetEvent(&bus->ThreadSignal);
592
593         WvBusProcessWorkItems(bus);
594       } /* while !bus->Stop */
595
596     WvBusCancelWorkItems(bus);
597     return;
598   }
599
600 /**
601  * Start a bus thread.
602  *
603  * @v Bus               The bus to start a thread for.
604  * @ret NTSTATUS        The status of the thread creation operation.
605  *
606  * Also see WV_F_BUS_THREAD in the header for details about the prototype
607  * for implementing your own bus thread routine.  You set WV_S_BUS_T::Thread
608  * to specify your own thread routine, then call this function to start it.
609  */
610 winvblock__lib_func NTSTATUS WvBusStartThread(
611     WV_SP_BUS_T Bus
612   ) {
613     OBJECT_ATTRIBUTES obj_attrs;
614     HANDLE thread_handle;
615
616     if (!Bus) {
617         DBG("No bus specified!\n");
618         return STATUS_INVALID_PARAMETER;
619       }
620
621     InitializeObjectAttributes(
622         &obj_attrs,
623         NULL,
624         OBJ_KERNEL_HANDLE,
625         NULL,
626         NULL
627       );
628     return PsCreateSystemThread(
629         &thread_handle,
630         THREAD_ALL_ACCESS,
631         &obj_attrs,
632         NULL,
633         NULL,
634         WvBusThread_,
635         Bus
636       );
637   }
638
639 /**
640  * Initialize a bus node with an associated PDO.
641  *
642  * @v Node              The node to initialize.
643  * @v Pdo               The PDO to associate the node with.
644  * @ret winvblock__bool FALSE for a NULL argument, otherwise TRUE
645  */
646 winvblock__lib_func winvblock__bool STDCALL WvBusInitNode(
647     OUT WV_SP_BUS_NODE Node,
648     IN PDEVICE_OBJECT Pdo
649   ) {
650     if (!Node || !Pdo)
651       return FALSE;
652
653     RtlZeroMemory(Node, sizeof *Node);
654     Node->BusPrivate_.Pdo = Pdo;
655     return TRUE;
656   }
657
658 /**
659  * Add a PDO node to a bus' list of children.
660  *
661  * @v Bus               The bus to add the node to.
662  * @v Node              The PDO node to add to the bus.
663  * @ret NTSTATUS        The status of the operation.
664  *
665  * Do not attempt to add the same node to more than one bus.
666  * When WvBusProcessWorkItems() is called for the bus, the
667  * node will be added.  This is usually from the bus' thread.
668  */
669 winvblock__lib_func NTSTATUS STDCALL WvBusAddNode(
670     WV_SP_BUS_T Bus,
671     WV_SP_BUS_NODE Node
672   ) {
673     WV_SP_BUS_WORK_ITEM_ work_item;
674
675     if (
676         !Bus ||
677         !Node ||
678         Bus->Dev.Self->DriverObject != Node->BusPrivate_.Pdo->DriverObject
679       )
680       return STATUS_INVALID_PARAMETER;
681
682     if (Bus->Stop)
683       return STATUS_NO_SUCH_DEVICE;
684
685     if (!(work_item = wv_malloc(sizeof *work_item)))
686       return STATUS_INSUFFICIENT_RESOURCES;
687
688     work_item->Cmd = WvBusWorkItemCmdAddPdo_;
689     work_item->Context.Node = Node;
690     if (!WvBusAddWorkItem_(Bus, work_item)) {
691         wv_free(work_item);
692         return STATUS_UNSUCCESSFUL;
693       }
694     /* Fire and forget. */
695     KeSetEvent(&Bus->ThreadSignal, 0, FALSE);
696     return STATUS_SUCCESS;
697   }
698
699 /**
700  * Remove a PDO node from a bus.
701  *
702  * @v Node              The PDO node to remove from its parent bus.
703  * @ret NTSTATUS        The status of the operation.
704  *
705  * When WvBusProcessWorkItems() is called for the bus, it will
706  * then remove the node.  This is usually from the bus' thread.
707  */
708 winvblock__lib_func NTSTATUS STDCALL WvBusRemoveNode(
709     WV_SP_BUS_NODE Node
710   ) {
711     WV_SP_BUS_T bus;
712     WV_SP_BUS_WORK_ITEM_ work_item;
713
714     if (!Node || !(bus = Node->BusPrivate_.Bus))
715       return STATUS_INVALID_PARAMETER;
716
717     if (bus->Stop)
718       return STATUS_NO_SUCH_DEVICE;
719
720     if (!(work_item = wv_malloc(sizeof *work_item)))
721       return STATUS_INSUFFICIENT_RESOURCES;
722
723     work_item->Cmd = WvBusWorkItemCmdRemovePdo_;
724     work_item->Context.Node = Node;
725     if (!WvBusAddWorkItem_(bus, work_item)) {
726         wv_free(work_item);
727         return STATUS_UNSUCCESSFUL;
728       }
729     /* Fire and forget. */
730     KeSetEvent(&bus->ThreadSignal, 0, FALSE);
731     return STATUS_SUCCESS;
732   }
733
734 /**
735  * Enqueue an IRP for a bus' thread to process.
736  *
737  * @v Bus               The bus for the IRP.
738  * @v Irp               The IRP for the bus.
739  * @ret NTSTATUS        The status of the operation.  Returns STATUS_PENDING
740  *                      if the IRP is successfully added to the queue.
741  */
742 winvblock__lib_func NTSTATUS STDCALL WvBusEnqueueIrp(
743     WV_SP_BUS_T Bus,
744     PIRP Irp
745   ) {
746     WV_SP_BUS_WORK_ITEM_ work_item;
747
748     if (!Bus || !Irp)
749       return STATUS_INVALID_PARAMETER;
750
751     if (Bus->Stop)
752       return STATUS_NO_SUCH_DEVICE;
753
754     if (!(work_item = wv_malloc(sizeof *work_item)))
755       return STATUS_INSUFFICIENT_RESOURCES;
756
757     work_item->Cmd = WvBusWorkItemCmdProcessIrp_;
758     work_item->Context.Irp = Irp;
759     IoMarkIrpPending(Irp);
760     if (!WvBusAddWorkItem_(Bus, work_item)) {
761         wv_free(work_item);
762         return STATUS_UNSUCCESSFUL;
763       }
764     /* Fire and forget. */
765     KeSetEvent(&Bus->ThreadSignal, 0, FALSE);
766     return STATUS_PENDING;
767   }