Initial publish

1 files changed, 238 insertions, 0 deletions

diff --git a/general/umdfSkeleton/device.cpp b/general/umdfSkeleton/device.cpp
new file mode 100644
index 00000000..677f39e6
--- /dev/null
+++ b/general/umdfSkeleton/device.cpp
@@ -0,0 +1,238 @@
+/*++
+ 
+Copyright (C) Microsoft Corporation, All Rights Reserved.
+
+Module Name:
+
+    Device.cpp
+
+Abstract:
+
+    This module contains the implementation of the UMDF Skeleton sample driver's
+    device callback object.
+
+    The skeleton sample device does very little.  It does not implement either
+    of the PNP interfaces so once the device is setup, it won't ever get any
+    callbacks until the device is removed.
+
+Environment:
+
+   Windows User-Mode Driver Framework (WUDF)
+
+--*/
+
+#include "internal.h"
+#include "device.tmh"
+
+HRESULT
+CMyDevice::CreateInstance(
+    _In_ IWDFDriver *FxDriver,
+    _In_ IWDFDeviceInitialize * FxDeviceInit,
+    _Out_ PCMyDevice *Device
+    )
+/*++
+ 
+  Routine Description:
+
+    This method creates and initializs an instance of the skeleton driver's 
+    device callback object.
+
+  Arguments:
+
+    FxDeviceInit - the settings for the device.
+
+    Device - a location to store the referenced pointer to the device object.
+
+  Return Value:
+
+    Status
+
+--*/
+{
+    PCMyDevice device;
+    HRESULT hr;
+
+    //
+    // Allocate a new instance of the device class.
+    //
+
+    device = new CMyDevice();
+
+    if (NULL == device)
+    {
+        return E_OUTOFMEMORY;
+    }
+
+    //
+    // Initialize the instance.
+    //
+
+    hr = device->Initialize(FxDriver, FxDeviceInit);
+
+    if (SUCCEEDED(hr)) 
+    {
+        *Device = device;
+    } 
+    else 
+    {
+        device->Release();
+    }
+
+    return hr;
+}
+
+HRESULT
+CMyDevice::Initialize(
+    _In_ IWDFDriver           * FxDriver,
+    _In_ IWDFDeviceInitialize * FxDeviceInit
+    )
+/*++
+ 
+  Routine Description:
+
+    This method initializes the device callback object and creates the
+    partner device object.
+
+    The method should perform any device-specific configuration that:
+        *  could fail (these can't be done in the constructor)
+        *  must be done before the partner object is created -or-
+        *  can be done after the partner object is created and which aren't 
+           influenced by any device-level parameters the parent (the driver
+           in this case) might set.
+
+  Arguments:
+
+    FxDeviceInit - the settings for this device.
+
+  Return Value:
+
+    status.
+
+--*/
+{
+    IWDFDevice *fxDevice;
+    HRESULT hr;
+
+    //
+    // Configure things like the locking model before we go to create our 
+    // partner device.
+    //
+
+    //
+    // Set no locking unless you need an automatic callbacks synchronization
+    //
+
+    FxDeviceInit->SetLockingConstraint(None);
+
+    //
+    // TODO: If you're writing a filter driver then indicate that here. 
+    //
+    // FxDeviceInit->SetFilter();
+    //
+        
+    //
+    // TODO: Any per-device initialization which must be done before 
+    //       creating the partner object.
+    //
+
+    //
+    // Create a new FX device object and assign the new callback object to 
+    // handle any device level events that occur.
+    //
+
+    //
+    // QueryIUnknown references the IUnknown interface that it returns
+    // (which is the same as referencing the device).  We pass that to 
+    // CreateDevice, which takes its own reference if everything works.
+    //
+
+    {
+        IUnknown *unknown = this->QueryIUnknown();
+
+        hr = FxDriver->CreateDevice(FxDeviceInit, unknown, &fxDevice);
+
+        unknown->Release();
+    }
+
+    //
+    // If that succeeded then set our FxDevice member variable.
+    //
+
+    if (SUCCEEDED(hr)) 
+    {
+        m_FxDevice = fxDevice;
+
+        //
+        // Drop the reference we got from CreateDevice.  Since this object
+        // is partnered with the framework object they have the same 
+        // lifespan - there is no need for an additional reference.
+        //
+
+        fxDevice->Release();
+    }
+
+    return hr;
+}
+
+HRESULT
+CMyDevice::Configure(
+    VOID
+    )
+/*++
+ 
+  Routine Description:
+
+    This method is called after the device callback object has been initialized 
+    and returned to the driver.  It would setup the device's queues and their 
+    corresponding callback objects.
+
+  Arguments:
+
+    FxDevice - the framework device object for which we're handling events.
+
+  Return Value:
+
+    status
+
+--*/
+{
+    //
+    // TODO: Setup your device queues and I/O forwarding.
+    //
+
+    return S_OK;
+}
+
+HRESULT
+CMyDevice::QueryInterface(
+    _In_ REFIID InterfaceId,
+    _Out_ PVOID *Object
+    )
+/*++
+ 
+  Routine Description:
+
+    This method is called to get a pointer to one of the object's callback
+    interfaces.  
+
+    Since the skeleton driver doesn't support any of the device events, this
+    method simply calls the base class's BaseQueryInterface.
+
+    If the skeleton is extended to include device event interfaces then this 
+    method must be changed to check the IID and return pointers to them as
+    appropriate.
+
+  Arguments:
+
+    InterfaceId - the interface being requested
+
+    Object - a location to store the interface pointer if successful
+
+  Return Value:
+
+    S_OK or E_NOINTERFACE
+
+--*/
+{
+    return CUnknown::QueryInterface(InterfaceId, Object);
+}