stream.h File Reference

#include <strmini.h>
#include <debug.h>

Include dependency graph for stream.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	STREAM_CLASS_DRIVER_EXTENSION
struct	MEMORY_RESOURCE_LIST
struct	STREAM_DEVICE_EXTENSION
struct	HW_STREAM_REQUEST_BLOCK_EXT

Macros
#define	STREAMDEBUG_LEVEL   DebugLevelMaximum

Typedefs
typedef BOOLEAN(NTAPI *	SYNCHRONIZE_FUNC) (IN PKINTERRUPT Interrupt, IN PKSYNCHRONIZE_ROUTINE SynchronizeRoutine, IN PVOID SynchronizeContext)
typedef struct STREAM_CLASS_DRIVER_EXTENSION *	PSTREAM_CLASS_DRIVER_EXTENSION
typedef struct MEMORY_RESOURCE_LIST *	PMEMORY_RESOURCE_LIST
typedef struct STREAM_DEVICE_EXTENSION *	PSTREAM_DEVICE_EXTENSION
typedef struct HW_STREAM_REQUEST_BLOCK_EXT *	PHW_STREAM_REQUEST_BLOCK_EXT

Functions
NTSTATUS NTAPI	StreamClassCreateFilter (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
NTSTATUS NTAPI	StreamClassPnp (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
NTSTATUS NTAPI	StreamClassPower (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
NTSTATUS NTAPI	StreamClassSystemControl (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
NTSTATUS NTAPI	StreamClassCleanup (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
NTSTATUS NTAPI	StreamClassFlushBuffers (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
NTSTATUS NTAPI	StreamClassDeviceControl (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
NTSTATUS NTAPI	StreamClassAddDevice (IN PDRIVER_OBJECT DriverObject, IN PDEVICE_OBJECT PhysicalDeviceObject)
BOOLEAN NTAPI	StreamClassSynchronize (IN PKINTERRUPT Interrupt, IN PKSYNCHRONIZE_ROUTINE SynchronizeRoutine, IN PVOID SynchronizeContext)
BOOLEAN NTAPI	StreamClassInterruptRoutine (IN PKINTERRUPT Interrupt, IN PVOID ServiceContext)
VOID NTAPI	StreamClassInterruptDpc (IN PKDPC Dpc, IN PVOID DeferredContext, IN PVOID SystemArgument1, IN PVOID SystemArgument2)
VOID	CompleteIrp (IN PIRP Irp, IN NTSTATUS Status, IN ULONG_PTR Information)

Macro Definition Documentation

STREAMDEBUG_LEVEL

#define STREAMDEBUG_LEVEL   DebugLevelMaximum

Definition at line 8 of file stream.h.

Typedef Documentation

PHW_STREAM_REQUEST_BLOCK_EXT

typedef struct HW_STREAM_REQUEST_BLOCK_EXT * PHW_STREAM_REQUEST_BLOCK_EXT

PMEMORY_RESOURCE_LIST

typedef struct MEMORY_RESOURCE_LIST * PMEMORY_RESOURCE_LIST

PSTREAM_CLASS_DRIVER_EXTENSION

typedef struct STREAM_CLASS_DRIVER_EXTENSION * PSTREAM_CLASS_DRIVER_EXTENSION

PSTREAM_DEVICE_EXTENSION

typedef struct STREAM_DEVICE_EXTENSION * PSTREAM_DEVICE_EXTENSION

SYNCHRONIZE_FUNC

typedef BOOLEAN(NTAPI * SYNCHRONIZE_FUNC) (IN PKINTERRUPT Interrupt, IN PKSYNCHRONIZE_ROUTINE SynchronizeRoutine, IN PVOID SynchronizeContext)

Definition at line 10 of file stream.h.

Function Documentation

CompleteIrp()

VOID CompleteIrp	(	IN PIRP	Irp,
		IN NTSTATUS	Status,
		IN ULONG_PTR	Information
	)

Definition at line 12 of file pnp.c.

{
    Irp->IoStatus.Status = Status;
    Irp->IoStatus.Information = Information;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
}

Referenced by _Dispatch_type_(), AfdEventReceiveDatagramHandler(), FxPkgIo::DispatchStep1(), FxPkgIo::DispatchStep2(), Ext2LockControl(), StreamClassStartDevice(), UDFCommonDeviceControl(), UDFMountVolume(), and VfatDispatchRequest().

StreamClassAddDevice()

NTSTATUS NTAPI StreamClassAddDevice	(	IN PDRIVER_OBJECT	DriverObject,
		IN PDEVICE_OBJECT	PhysicalDeviceObject
	)

Definition at line 13 of file driver.c.

{
    PSTREAM_CLASS_DRIVER_EXTENSION DriverObjectExtension;
    PDEVICE_OBJECT DeviceObject, LowerDeviceObject;
    PSTREAM_DEVICE_EXTENSION DeviceExtension;
    PKSOBJECT_CREATE_ITEM ItemList;
    NTSTATUS Status;
 
    /* Fetch driver object extension */
    DriverObjectExtension = IoGetDriverObjectExtension(DriverObject, (PVOID)StreamClassAddDevice);
    if (!DriverObjectExtension)
    {
        /* Failed to get driver extension */
        return STATUS_DEVICE_DOES_NOT_EXIST;
    }
    /* Allocate Create Item */
    ItemList = ExAllocatePool(NonPagedPool, sizeof(KSOBJECT_CREATE_ITEM));
    if (!ItemList)
    {
        /* Failed to allocated Create Item */
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* Create the FDO */
    Status = IoCreateDevice(DriverObject, DriverObjectExtension->Data.DeviceExtensionSize + sizeof(STREAM_DEVICE_EXTENSION), NULL, FILE_DEVICE_KS, FILE_AUTOGENERATED_DEVICE_NAME | FILE_DEVICE_SECURE_OPEN, 0, &DeviceObject);
    if (!NT_SUCCESS(Status))
    {
        /* Failed to create the FDO */
        ExFreePool(ItemList);
        return Status;
    }
 
    /* Attach to device stack */
    LowerDeviceObject = IoAttachDeviceToDeviceStack(DeviceObject, PhysicalDeviceObject);
    if (!LowerDeviceObject)
    {
        /* Failed to attach */
        IoDeleteDevice(DeviceObject);
        ExFreePool(ItemList);
        return STATUS_UNSUCCESSFUL;
    }
 
    /* Zero Create item */
    RtlZeroMemory(ItemList, sizeof(KSOBJECT_CREATE_ITEM));
    /* Setup object class */
    RtlInitUnicodeString(&ItemList->ObjectClass, L"GLOBAL");
    /* Setup CreateDispatch routine */
    ItemList->Create = StreamClassCreateFilter;
 
    /* Get device extension */
    DeviceExtension = (PSTREAM_DEVICE_EXTENSION)DeviceObject->DeviceExtension;
    /* Zero device extension */
    RtlZeroMemory(DeviceExtension, sizeof(STREAM_DEVICE_EXTENSION));
    /* Initialize Ks streaming */
    Status = KsAllocateDeviceHeader(&DeviceExtension->Header, 1, ItemList);
    if (!NT_SUCCESS(Status))
    {
        /* Cleanup resources */
        IoDetachDevice(LowerDeviceObject);
        IoDeleteDevice(DeviceObject);
        ExFreePool(ItemList);
        return Status;
    }
 
    /* Store lower device object */
    DeviceExtension->LowerDeviceObject = LowerDeviceObject;
 
    /* Store physical device object */
    DeviceExtension->PhysicalDeviceObject = PhysicalDeviceObject;
    /* Store driver object extension */
    DeviceExtension->DriverExtension = DriverObjectExtension;
    /* Initialize memory list */
    InitializeListHead(&DeviceExtension->MemoryResourceList);
    /* Setup device extension */
    DeviceExtension->DeviceExtension = (PVOID) (DeviceExtension + 1);
    /* Init interrupt dpc */
    KeInitializeDpc(&DeviceExtension->InterruptDpc, StreamClassInterruptDpc, (PVOID)DeviceExtension);
 
    /* Set device transfer method */
    DeviceObject->Flags |= DO_DIRECT_IO | DO_POWER_PAGABLE;
    /* Clear init flag */
    DeviceObject->Flags &= ~ DO_DEVICE_INITIALIZING;
 
    return Status;
}

Referenced by StreamClassAddDevice(), StreamClassRegisterAdapter(), and StreamClassStartDevice().

StreamClassCleanup()

NTSTATUS NTAPI StreamClassCleanup	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 39 of file control.c.

{
    Irp->IoStatus.Information = 0;
    Irp->IoStatus.Status = STATUS_SUCCESS;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return STATUS_SUCCESS;
}

Referenced by StreamClassRegisterAdapter().

StreamClassCreateFilter()

NTSTATUS NTAPI StreamClassCreateFilter	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 261 of file filter.c.

{
    NTSTATUS Status;
    DPRINT1("StreamClassCreateFilter Called\n");
 
    /* Init filter */
    Status = InitializeFilterWithKs(DeviceObject, Irp);
 
    Irp->IoStatus.Status = Status;
    Irp->IoStatus.Information = 0;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return Status;
}

Referenced by StreamClassAddDevice().

StreamClassDeviceControl()

NTSTATUS NTAPI StreamClassDeviceControl	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 63 of file control.c.

{
    Irp->IoStatus.Information = 0;
    Irp->IoStatus.Status = STATUS_SUCCESS;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return STATUS_SUCCESS;
}

Referenced by StreamClassRegisterAdapter().

StreamClassFlushBuffers()

NTSTATUS NTAPI StreamClassFlushBuffers	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 51 of file control.c.

{
    Irp->IoStatus.Information = 0;
    Irp->IoStatus.Status = STATUS_SUCCESS;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return STATUS_SUCCESS;
}

Referenced by StreamClassRegisterAdapter().

StreamClassInterruptDpc()

VOID NTAPI StreamClassInterruptDpc	(	IN PKDPC	Dpc,
		IN PVOID	DeferredContext,
		IN PVOID	SystemArgument1,
		IN PVOID	SystemArgument2
	)

Definition at line 74 of file pnp.c.

{
    //TODO
    //read/write data
}

Referenced by StreamClassAddDevice().

StreamClassInterruptRoutine()

BOOLEAN NTAPI StreamClassInterruptRoutine	(	IN PKINTERRUPT	Interrupt,
		IN PVOID	ServiceContext
	)

Definition at line 87 of file pnp.c.

{
    BOOLEAN Ret = FALSE;
    PSTREAM_DEVICE_EXTENSION DeviceExtension = (PSTREAM_DEVICE_EXTENSION)ServiceContext;
 
    /* Does the driver implement HwInterrupt routine */
    if (DeviceExtension->DriverExtension->Data.HwInterrupt)
    {
        /* Check if the interrupt was coming from this device */
        Ret = DeviceExtension->DriverExtension->Data.HwInterrupt(DeviceExtension->DeviceExtension);
        if (Ret)
        {
            /* Interrupt has from this device, schedule a Dpc for us */
            KeInsertQueueDpc(&DeviceExtension->InterruptDpc, NULL, NULL);
        }
    }
    /* Return result */
    return Ret;
}

Referenced by StreamClassStartDevice().

StreamClassPnp()

NTSTATUS NTAPI StreamClassPnp	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 456 of file pnp.c.

{
    PIO_STACK_LOCATION IoStack;
 
    /* Get current irp stack location */
    IoStack = IoGetCurrentIrpStackLocation(Irp);
 
    switch (IoStack->MinorFunction)
    {
        case IRP_MN_START_DEVICE:
        {
            return StreamClassStartDevice(DeviceObject, Irp);
        }
    }
 
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return STATUS_NOT_SUPPORTED;
}

Referenced by StreamClassRegisterAdapter().

StreamClassPower()

NTSTATUS NTAPI StreamClassPower	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 15 of file control.c.

{
    Irp->IoStatus.Information = 0;
    Irp->IoStatus.Status = STATUS_SUCCESS;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return STATUS_SUCCESS;
}

Referenced by StreamClassRegisterAdapter().

StreamClassSynchronize()

BOOLEAN NTAPI StreamClassSynchronize	(	IN PKINTERRUPT	Interrupt,
		IN PKSYNCHRONIZE_ROUTINE	SynchronizeRoutine,
		IN PVOID	SynchronizeContext
	)

Definition at line 61 of file pnp.c.

{
    /* This function is used when the driver either implements synchronization on its own
     * or if there is no interrupt assigned
     */
    return SynchronizeRoutine(SynchronizeContext);
}

Referenced by StreamClassStartDevice().

StreamClassSystemControl()

NTSTATUS NTAPI StreamClassSystemControl	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 27 of file control.c.

{
    Irp->IoStatus.Information = 0;
    Irp->IoStatus.Status = STATUS_SUCCESS;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return STATUS_SUCCESS;
}

Referenced by StreamClassRegisterAdapter().