strmini.h File Reference

#include <ntddk.h>
#include <windef.h>
#include <ks.h>

Include dependency graph for strmini.h:

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

Go to the source code of this file.

Classes
struct	_HW_TIME_CONTEXT
struct	_HW_EVENT_DESCRIPTOR
struct	_HW_CLOCK_OBJECT
struct	_HW_STREAM_OBJECT
struct	_HW_STREAM_HEADER
struct	_HW_STREAM_INFORMATION
struct	_HW_STREAM_DESCRIPTOR
struct	_STREAM_TIME_REFERENCE
struct	_STREAM_DATA_INTERSECT_INFO
struct	_STREAM_PROPERTY_DESCRIPTOR
struct	_STREAM_METHOD_DESCRIPTOR
struct	KSSCATTER_GATHER
struct	_HW_STREAM_REQUEST_BLOCK
union	_HW_STREAM_REQUEST_BLOCK::_CommandData
struct	_ACCESS_RANGE
struct	_PORT_CONFIGURATION_INFORMATION
struct	_HW_INITIALIZATION_DATA

Macros
#define	STREAMAPI   __stdcall
#define	STREAM_SYSTEM_TIME_MASK   ((STREAM_SYSTEM_TIME)0x00000001FFFFFFFF)
#define	DebugPrint(x)
#define	DEBUG_BREAKPOINT()
#define	DEBUG_ASSERT(exp)
#define	CLOCK_SUPPORT_CAN_SET_ONBOARD_CLOCK   0x1
#define	CLOCK_SUPPORT_CAN_READ_ONBOARD_CLOCK   0x2
#define	CLOCK_SUPPORT_CAN_RETURN_STREAM_TIME   0x4
#define	STREAM_REQUEST_BLOCK_SIZE   sizeof(STREAM_REQUEST_BLOCK)
#define	SRB_HW_FLAGS_DATA_TRANSFER   0x01
#define	SRB_HW_FLAGS_STREAM_REQUEST   0x2
#define	STREAM_CLASS_VERSION_20   0x0200
#define	StreamClassRegisterMinidriver   StreamClassRegisterAdapter

Typedefs
typedef PHYSICAL_ADDRESS	STREAM_PHYSICAL_ADDRESS
typedef PHYSICAL_ADDRESS *	PSTREAM_PHYSICAL_ADDRESS
typedef struct _HW_TIME_CONTEXT	HW_TIME_CONTEXT
typedef struct _HW_TIME_CONTEXT *	PHW_TIME_CONTEXT
typedef struct _HW_EVENT_DESCRIPTOR	HW_EVENT_DESCRIPTOR
typedef struct _HW_EVENT_DESCRIPTOR *	PHW_EVENT_DESCRIPTOR
typedef VOID(STREAMAPI *	PHW_RECEIVE_STREAM_DATA_SRB) (IN struct _HW_STREAM_REQUEST_BLOCK *SRB)
typedef VOID(STREAMAPI *	PHW_RECEIVE_STREAM_CONTROL_SRB) (IN struct _HW_STREAM_REQUEST_BLOCK *SRB)
typedef NTSTATUS(STREAMAPI *	PHW_EVENT_ROUTINE) (IN PHW_EVENT_DESCRIPTOR EventDescriptor)
typedef VOID(STREAMAPI *	PHW_CLOCK_FUNCTION) (IN PHW_TIME_CONTEXT HwTimeContext)
typedef struct _HW_CLOCK_OBJECT	HW_CLOCK_OBJECT
typedef struct _HW_CLOCK_OBJECT *	PHW_CLOCK_OBJECT
typedef struct _HW_STREAM_OBJECT	HW_STREAM_OBJECT
typedef struct _HW_STREAM_OBJECT *	PHW_STREAM_OBJECT
typedef struct _HW_STREAM_HEADER	HW_STREAM_HEADER
typedef struct _HW_STREAM_HEADER *	PHW_STREAM_HEADER
typedef struct _HW_STREAM_INFORMATION	HW_STREAM_INFORMATION
typedef struct _HW_STREAM_INFORMATION *	PHW_STREAM_INFORMATION
typedef struct _HW_STREAM_DESCRIPTOR	HW_STREAM_DESCRIPTOR
typedef struct _HW_STREAM_DESCRIPTOR *	PHW_STREAM_DESCRIPTOR
typedef struct _STREAM_TIME_REFERENCE	STREAM_TIME_REFERENCE
typedef struct _STREAM_TIME_REFERENCE *	PSTREAM_TIME_REFERENCE
typedef struct _STREAM_DATA_INTERSECT_INFO	STREAM_DATA_INTERSECT_INFO
typedef struct _STREAM_DATA_INTERSECT_INFO *	PSTREAM_DATA_INTERSECT_INFO
typedef struct _STREAM_PROPERTY_DESCRIPTOR	STREAM_PROPERTY_DESCRIPTOR
typedef struct _STREAM_PROPERTY_DESCRIPTOR *	PSTREAM_PROPERTY_DESCRIPTOR
typedef struct _STREAM_METHOD_DESCRIPTOR	STREAM_METHOD_DESCRIPTOR
typedef struct _STREAM_METHOD_DESCRIPTOR *	PSTREAM_METHOD_DESCRIPTOR
typedef enum _SRB_COMMAND	SRB_COMMAND
typedef struct KSSCATTER_GATHER *	PKSSCATTER_GATHER
typedef struct _HW_STREAM_REQUEST_BLOCK	HW_STREAM_REQUEST_BLOCK
typedef struct _HW_STREAM_REQUEST_BLOCK *	PHW_STREAM_REQUEST_BLOCK
typedef struct _ACCESS_RANGE	ACCESS_RANGE
typedef struct _ACCESS_RANGE *	PACCESS_RANGE
typedef struct _PORT_CONFIGURATION_INFORMATION	PORT_CONFIGURATION_INFORMATION
typedef struct _PORT_CONFIGURATION_INFORMATION *	PPORT_CONFIGURATION_INFORMATION
typedef VOID(STREAMAPI *	PHW_RECEIVE_DEVICE_SRB) (IN PHW_STREAM_REQUEST_BLOCK SRB)
typedef VOID(STREAMAPI *	PHW_CANCEL_SRB) (IN PHW_STREAM_REQUEST_BLOCK SRB)
typedef VOID(STREAMAPI *	PHW_REQUEST_TIMEOUT_HANDLER) (IN PHW_STREAM_REQUEST_BLOCK SRB)
typedef BOOLEAN(STREAMAPI *	PHW_INTERRUPT) (IN PVOID DeviceExtension)
typedef VOID(STREAMAPI *	PHW_TIMER_ROUTINE) (IN PVOID Context)
typedef VOID(STREAMAPI *	PHW_PRIORITY_ROUTINE) (IN PVOID Context)
typedef VOID(STREAMAPI *	PHW_QUERY_CLOCK_ROUTINE) (IN PHW_TIME_CONTEXT TimeContext)
typedef BOOLEAN(STREAMAPI *	PHW_RESET_ADAPTER) (IN PVOID DeviceExtension)
typedef enum _STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE	STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE
typedef enum _STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE *	PSTREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE
typedef enum _STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE	STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE
typedef enum _STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE *	PSTREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE
typedef struct _HW_INITIALIZATION_DATA	HW_INITIALIZATION_DATA
typedef struct _HW_INITIALIZATION_DATA *	PHW_INITIALIZATION_DATA
typedef enum _STREAM_PRIORITY	STREAM_PRIORITY
typedef enum _STREAM_PRIORITY *	PSTREAM_PRIORITY

Enumerations
enum	STREAM_DEBUG_LEVEL {   DebugLevelFatal = 0 , DebugLevelError , DebugLevelWarning , DebugLevelInfo ,   DebugLevelTrace , DebugLevelVerbose , DebugLevelMaximum }
enum	TIME_FUNCTION { TIME_GET_STREAM_TIME , TIME_READ_ONBOARD_CLOCK , TIME_SET_ONBOARD_CLOCK }
enum	_SRB_COMMAND {   SRB_READ_DATA , SRB_WRITE_DATA , SRB_GET_STREAM_STATE , SRB_SET_STREAM_STATE ,   SRB_SET_STREAM_PROPERTY , SRB_GET_STREAM_PROPERTY , SRB_OPEN_MASTER_CLOCK , SRB_INDICATE_MASTER_CLOCK ,   SRB_UNKNOWN_STREAM_COMMAND , SRB_SET_STREAM_RATE , SRB_PROPOSE_DATA_FORMAT , SRB_CLOSE_MASTER_CLOCK ,   SRB_PROPOSE_STREAM_RATE , SRB_SET_DATA_FORMAT , SRB_GET_DATA_FORMAT , SRB_BEGIN_FLUSH ,   SRB_END_FLUSH , SRB_GET_STREAM_INFO = 0x100 , SRB_OPEN_STREAM , SRB_CLOSE_STREAM ,   SRB_OPEN_DEVICE_INSTANCE , SRB_CLOSE_DEVICE_INSTANCE , SRB_GET_DEVICE_PROPERTY , SRB_SET_DEVICE_PROPERTY ,   SRB_INITIALIZE_DEVICE , SRB_CHANGE_POWER_STATE , SRB_UNINITIALIZE_DEVICE , SRB_UNKNOWN_DEVICE_COMMAND ,   SRB_PAGING_OUT_DRIVER , SRB_GET_DATA_INTERSECTION , SRB_INITIALIZATION_COMPLETE , SRB_SURPRISE_REMOVAL ,   SRB_DEVICE_METHOD , SRB_STREAM_METHOD , SRB_NOTIFY_IDLE_STATE }
enum	STREAM_BUFFER_TYPE { PerRequestExtension , DmaBuffer , SRBDataBuffer }
enum	_STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE {   ReadyForNextStreamDataRequest , ReadyForNextStreamControlRequest , HardwareStarved , StreamRequestComplete ,   SignalMultipleStreamEvents , SignalStreamEvent , DeleteStreamEvent , StreamNotificationMaximum }
enum	_STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE {   ReadyForNextDeviceRequest , DeviceRequestComplete , SignalMultipleDeviceEvents , SignalDeviceEvent ,   DeleteDeviceEvent , SignalMultipleDeviceInstanceEvents , DeviceNotificationMaximum }
enum	_STREAM_PRIORITY { High , Dispatch , Low , LowToHigh }

Functions
VOID	StreamClassAbortOutstandingRequests (_In_ PVOID HwDeviceExtension, _In_opt_ PHW_STREAM_OBJECT HwStreamObject, _In_ NTSTATUS Status)
VOID STREAMAPI	StreamClassCallAtNewPriority (_In_opt_ PHW_STREAM_OBJECT StreamObject, _In_ PVOID HwDeviceExtension, _In_ STREAM_PRIORITY Priority, _In_ PHW_PRIORITY_ROUTINE PriorityRoutine, _In_ PVOID Context)
VOID STREAMAPI	StreamClassCompleteRequestAndMarkQueueReady (_In_ PHW_STREAM_REQUEST_BLOCK Srb)
__analysis_noreturn VOID STREAMAPI	StreamClassDebugAssert (_In_ PCHAR File, _In_ ULONG Line, _In_ PCHAR AssertText, _In_ ULONG AssertValue)
VOID __cdecl	StreamClassDebugPrint (_In_ STREAM_DEBUG_LEVEL DebugPrintLevel, _In_ PCCHAR DebugMessage,...)
VOID __cdecl	StreamClassDeviceNotification (IN STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE NotificationType, IN PVOID HwDeviceExtension, IN PHW_STREAM_REQUEST_BLOCK pSrb, IN PKSEVENT_ENTRY EventEntry, IN GUID *EventSet, IN ULONG EventId)
VOID STREAMAPI	StreamClassFilterReenumerateStreams (_In_ PVOID HwInstanceExtension, _In_ ULONG StreamDescriptorSize)
PVOID STREAMAPI	StreamClassGetDmaBuffer (_In_ PVOID HwDeviceExtension)
PKSEVENT_ENTRY	StreamClassGetNextEvent (_In_opt_ PVOID HwInstanceExtension_OR_HwDeviceExtension, _In_opt_ PHW_STREAM_OBJECT HwStreamObject, _In_opt_ GUID *EventGuid, _In_ ULONG EventItem, _In_opt_ PKSEVENT_ENTRY CurrentEvent)
STREAM_PHYSICAL_ADDRESS STREAMAPI	StreamClassGetPhysicalAddress (_In_ PVOID HwDeviceExtension, _In_opt_ PHW_STREAM_REQUEST_BLOCK HwSRB, _In_ PVOID VirtualAddress, _In_ STREAM_BUFFER_TYPE Type, _Out_ ULONG *Length)
VOID	StreamClassQueryMasterClock (_In_ PHW_STREAM_OBJECT HwStreamObject, _In_ HANDLE MasterClockHandle, _In_ TIME_FUNCTION TimeFunction, _In_ PHW_QUERY_CLOCK_ROUTINE ClockCallbackRoutine)
	_IRQL_requires_max_ (DISPATCH_LEVEL) VOID STREAMAPI StreamClassQueryMasterClockSync(_In_ HANDLE MasterClockHandle
	_IRQL_requires_max_ (PASSIVE_LEVEL) BOOLEAN STREAMAPI StreamClassReadWriteConfig(_In_ PVOID HwDeviceExtension
	Queries information details about a security descriptor.
_In_ BOOLEAN	_Inout_updates_bytes_ (Length) PVOID Buffer
VOID STREAMAPI	StreamClassReenumerateStreams (_In_ PVOID HwDeviceExtension, _In_ ULONG StreamDescriptorSize)
	_IRQL_requires_max_ (APC_LEVEL) NTSTATUS StreamClassRegisterFilterWithNoKSPins(_In_ PDEVICE_OBJECT DeviceObject
	Probes and locks virtual pages in memory for the specified process.
_In_ const GUID _In_ ULONG	_In_reads_ (PinCount) BOOL *PinDirection
_In_ const GUID _In_ ULONG	_In_reads_opt_ (PinCount) GUID *CategoryList)
VOID STREAMAPI	StreamClassScheduleTimer (_In_opt_ PHW_STREAM_OBJECT StreamObject, _In_ PVOID HwDeviceExtension, _In_ ULONG NumberOfMicroseconds, _In_ PHW_TIMER_ROUTINE TimerRoutine, _In_ PVOID Context)
VOID __cdecl	StreamClassStreamNotification (_In_ STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE NotificationType, _In_ PHW_STREAM_OBJECT StreamObject,...)

Variables
__GNU_EXTENSION typedef unsigned __int64	STREAM_SYSTEM_TIME
__GNU_EXTENSION typedef unsigned __int64 *	PSTREAM_SYSTEM_TIME
__GNU_EXTENSION typedef unsigned __int64	STREAM_TIMESTAMP
__GNU_EXTENSION typedef unsigned __int64 *	PSTREAM_TIMESTAMP
_Inout_ PHW_TIME_CONTEXT	TimeContext
_In_ BOOLEAN	Read
_In_ BOOLEAN _In_ ULONG	Offset
_In_ BOOLEAN _In_ ULONG _In_ ULONG	Length
_In_ PVOID	Argument2
_In_ PVOID _In_ PHW_INITIALIZATION_DATA	HwInitializationData
_In_ const GUID *	InterfaceClassGUID
_In_ const GUID _In_ ULONG	PinCount

Macro Definition Documentation

CLOCK_SUPPORT_CAN_READ_ONBOARD_CLOCK

#define CLOCK_SUPPORT_CAN_READ_ONBOARD_CLOCK   0x2

Definition at line 82 of file strmini.h.

CLOCK_SUPPORT_CAN_RETURN_STREAM_TIME

#define CLOCK_SUPPORT_CAN_RETURN_STREAM_TIME   0x4

Definition at line 83 of file strmini.h.

CLOCK_SUPPORT_CAN_SET_ONBOARD_CLOCK

#define CLOCK_SUPPORT_CAN_SET_ONBOARD_CLOCK   0x1

Definition at line 81 of file strmini.h.

DEBUG_ASSERT

#define DEBUG_ASSERT

(

exp

)

Definition at line 33 of file strmini.h.

DEBUG_BREAKPOINT

#define DEBUG_BREAKPOINT

(

)

Definition at line 32 of file strmini.h.

DebugPrint

#define DebugPrint

(

x

)

Definition at line 31 of file strmini.h.

SRB_HW_FLAGS_DATA_TRANSFER

#define SRB_HW_FLAGS_DATA_TRANSFER   0x01

Definition at line 271 of file strmini.h.

SRB_HW_FLAGS_STREAM_REQUEST

#define SRB_HW_FLAGS_STREAM_REQUEST   0x2

Definition at line 272 of file strmini.h.

STREAM_CLASS_VERSION_20

#define STREAM_CLASS_VERSION_20   0x0200

Definition at line 340 of file strmini.h.

STREAM_REQUEST_BLOCK_SIZE

#define STREAM_REQUEST_BLOCK_SIZE   sizeof(STREAM_REQUEST_BLOCK)

Definition at line 169 of file strmini.h.

STREAM_SYSTEM_TIME_MASK

#define STREAM_SYSTEM_TIME_MASK   ((STREAM_SYSTEM_TIME)0x00000001FFFFFFFF)

Definition at line 9 of file strmini.h.

STREAMAPI

#define STREAMAPI   __stdcall

Definition at line 8 of file strmini.h.

StreamClassRegisterMinidriver

#define StreamClassRegisterMinidriver   StreamClassRegisterAdapter

Definition at line 498 of file strmini.h.

Typedef Documentation

ACCESS_RANGE

typedef struct _ACCESS_RANGE ACCESS_RANGE

HW_CLOCK_OBJECT

typedef struct _HW_CLOCK_OBJECT HW_CLOCK_OBJECT

HW_EVENT_DESCRIPTOR

typedef struct _HW_EVENT_DESCRIPTOR HW_EVENT_DESCRIPTOR

HW_INITIALIZATION_DATA

typedef struct _HW_INITIALIZATION_DATA HW_INITIALIZATION_DATA

HW_STREAM_DESCRIPTOR

typedef struct _HW_STREAM_DESCRIPTOR HW_STREAM_DESCRIPTOR

HW_STREAM_HEADER

typedef struct _HW_STREAM_HEADER HW_STREAM_HEADER

HW_STREAM_INFORMATION

typedef struct _HW_STREAM_INFORMATION HW_STREAM_INFORMATION

HW_STREAM_OBJECT

typedef struct _HW_STREAM_OBJECT HW_STREAM_OBJECT

HW_STREAM_REQUEST_BLOCK

typedef struct _HW_STREAM_REQUEST_BLOCK HW_STREAM_REQUEST_BLOCK

HW_TIME_CONTEXT

typedef struct _HW_TIME_CONTEXT HW_TIME_CONTEXT

PACCESS_RANGE

typedef struct _ACCESS_RANGE * PACCESS_RANGE

PHW_CANCEL_SRB

typedef VOID(STREAMAPI * PHW_CANCEL_SRB) (IN PHW_STREAM_REQUEST_BLOCK SRB)

Definition at line 309 of file strmini.h.

PHW_CLOCK_FUNCTION

typedef VOID(STREAMAPI * PHW_CLOCK_FUNCTION) (IN PHW_TIME_CONTEXT HwTimeContext)

Definition at line 73 of file strmini.h.

PHW_CLOCK_OBJECT

typedef struct _HW_CLOCK_OBJECT * PHW_CLOCK_OBJECT

PHW_EVENT_DESCRIPTOR

typedef struct _HW_EVENT_DESCRIPTOR * PHW_EVENT_DESCRIPTOR

PHW_EVENT_ROUTINE

typedef NTSTATUS(STREAMAPI * PHW_EVENT_ROUTINE) (IN PHW_EVENT_DESCRIPTOR EventDescriptor)

Definition at line 72 of file strmini.h.

PHW_INITIALIZATION_DATA

typedef struct _HW_INITIALIZATION_DATA * PHW_INITIALIZATION_DATA

PHW_INTERRUPT

typedef BOOLEAN(STREAMAPI * PHW_INTERRUPT) (IN PVOID DeviceExtension)

Definition at line 311 of file strmini.h.

PHW_PRIORITY_ROUTINE

typedef VOID(STREAMAPI * PHW_PRIORITY_ROUTINE) (IN PVOID Context)

Definition at line 313 of file strmini.h.

PHW_QUERY_CLOCK_ROUTINE

typedef VOID(STREAMAPI * PHW_QUERY_CLOCK_ROUTINE) (IN PHW_TIME_CONTEXT TimeContext)

Definition at line 314 of file strmini.h.

PHW_RECEIVE_DEVICE_SRB

typedef VOID(STREAMAPI * PHW_RECEIVE_DEVICE_SRB) (IN PHW_STREAM_REQUEST_BLOCK SRB)

Definition at line 308 of file strmini.h.

PHW_RECEIVE_STREAM_CONTROL_SRB

typedef VOID(STREAMAPI * PHW_RECEIVE_STREAM_CONTROL_SRB) (IN struct _HW_STREAM_REQUEST_BLOCK *SRB)

Definition at line 71 of file strmini.h.

PHW_RECEIVE_STREAM_DATA_SRB

typedef VOID(STREAMAPI * PHW_RECEIVE_STREAM_DATA_SRB) (IN struct _HW_STREAM_REQUEST_BLOCK *SRB)

Definition at line 70 of file strmini.h.

PHW_REQUEST_TIMEOUT_HANDLER

typedef VOID(STREAMAPI * PHW_REQUEST_TIMEOUT_HANDLER) (IN PHW_STREAM_REQUEST_BLOCK SRB)

Definition at line 310 of file strmini.h.

PHW_RESET_ADAPTER

typedef BOOLEAN(STREAMAPI * PHW_RESET_ADAPTER) (IN PVOID DeviceExtension)

Definition at line 315 of file strmini.h.

PHW_STREAM_DESCRIPTOR

typedef struct _HW_STREAM_DESCRIPTOR * PHW_STREAM_DESCRIPTOR

PHW_STREAM_HEADER

typedef struct _HW_STREAM_HEADER * PHW_STREAM_HEADER

PHW_STREAM_INFORMATION

typedef struct _HW_STREAM_INFORMATION * PHW_STREAM_INFORMATION

PHW_STREAM_OBJECT

typedef struct _HW_STREAM_OBJECT * PHW_STREAM_OBJECT

PHW_STREAM_REQUEST_BLOCK

typedef struct _HW_STREAM_REQUEST_BLOCK * PHW_STREAM_REQUEST_BLOCK

PHW_TIME_CONTEXT

typedef struct _HW_TIME_CONTEXT * PHW_TIME_CONTEXT

PHW_TIMER_ROUTINE

typedef VOID(STREAMAPI * PHW_TIMER_ROUTINE) (IN PVOID Context)

Definition at line 312 of file strmini.h.

PKSSCATTER_GATHER

typedef struct KSSCATTER_GATHER * PKSSCATTER_GATHER

PORT_CONFIGURATION_INFORMATION

typedef struct _PORT_CONFIGURATION_INFORMATION PORT_CONFIGURATION_INFORMATION

PPORT_CONFIGURATION_INFORMATION

typedef struct _PORT_CONFIGURATION_INFORMATION * PPORT_CONFIGURATION_INFORMATION

PSTREAM_DATA_INTERSECT_INFO

typedef struct _STREAM_DATA_INTERSECT_INFO * PSTREAM_DATA_INTERSECT_INFO

PSTREAM_METHOD_DESCRIPTOR

typedef struct _STREAM_METHOD_DESCRIPTOR * PSTREAM_METHOD_DESCRIPTOR

PSTREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE

typedef enum _STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE * PSTREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE

PSTREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE

typedef enum _STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE * PSTREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE

PSTREAM_PHYSICAL_ADDRESS

typedef PHYSICAL_ADDRESS * PSTREAM_PHYSICAL_ADDRESS

Definition at line 37 of file strmini.h.

PSTREAM_PRIORITY

typedef enum _STREAM_PRIORITY * PSTREAM_PRIORITY

PSTREAM_PROPERTY_DESCRIPTOR

typedef struct _STREAM_PROPERTY_DESCRIPTOR * PSTREAM_PROPERTY_DESCRIPTOR

PSTREAM_TIME_REFERENCE

typedef struct _STREAM_TIME_REFERENCE * PSTREAM_TIME_REFERENCE

SRB_COMMAND

typedef enum _SRB_COMMAND SRB_COMMAND

STREAM_DATA_INTERSECT_INFO

typedef struct _STREAM_DATA_INTERSECT_INFO STREAM_DATA_INTERSECT_INFO

STREAM_METHOD_DESCRIPTOR

typedef struct _STREAM_METHOD_DESCRIPTOR STREAM_METHOD_DESCRIPTOR

STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE

typedef enum _STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE

STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE

typedef enum _STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE

STREAM_PHYSICAL_ADDRESS

typedef PHYSICAL_ADDRESS STREAM_PHYSICAL_ADDRESS

Definition at line 37 of file strmini.h.

STREAM_PRIORITY

typedef enum _STREAM_PRIORITY STREAM_PRIORITY

STREAM_PROPERTY_DESCRIPTOR

typedef struct _STREAM_PROPERTY_DESCRIPTOR STREAM_PROPERTY_DESCRIPTOR

STREAM_TIME_REFERENCE

typedef struct _STREAM_TIME_REFERENCE STREAM_TIME_REFERENCE

Enumeration Type Documentation

_SRB_COMMAND

enum _SRB_COMMAND

Enumerator
SRB_READ_DATA
SRB_WRITE_DATA
SRB_GET_STREAM_STATE
SRB_SET_STREAM_STATE
SRB_SET_STREAM_PROPERTY
SRB_GET_STREAM_PROPERTY
SRB_OPEN_MASTER_CLOCK
SRB_INDICATE_MASTER_CLOCK
SRB_UNKNOWN_STREAM_COMMAND
SRB_SET_STREAM_RATE
SRB_PROPOSE_DATA_FORMAT
SRB_CLOSE_MASTER_CLOCK
SRB_PROPOSE_STREAM_RATE
SRB_SET_DATA_FORMAT
SRB_GET_DATA_FORMAT
SRB_BEGIN_FLUSH
SRB_END_FLUSH
SRB_GET_STREAM_INFO
SRB_OPEN_STREAM
SRB_CLOSE_STREAM
SRB_OPEN_DEVICE_INSTANCE
SRB_CLOSE_DEVICE_INSTANCE
SRB_GET_DEVICE_PROPERTY
SRB_SET_DEVICE_PROPERTY
SRB_INITIALIZE_DEVICE
SRB_CHANGE_POWER_STATE
SRB_UNINITIALIZE_DEVICE
SRB_UNKNOWN_DEVICE_COMMAND
SRB_PAGING_OUT_DRIVER
SRB_GET_DATA_INTERSECTION
SRB_INITIALIZATION_COMPLETE
SRB_SURPRISE_REMOVAL
SRB_DEVICE_METHOD
SRB_STREAM_METHOD
SRB_NOTIFY_IDLE_STATE

Definition at line 171 of file strmini.h.

                          {
  SRB_READ_DATA,
  SRB_WRITE_DATA,
  SRB_GET_STREAM_STATE,
  SRB_SET_STREAM_STATE,
  SRB_SET_STREAM_PROPERTY,
  SRB_GET_STREAM_PROPERTY,
  SRB_OPEN_MASTER_CLOCK,
 
  SRB_INDICATE_MASTER_CLOCK,
  SRB_UNKNOWN_STREAM_COMMAND,
  SRB_SET_STREAM_RATE,
  SRB_PROPOSE_DATA_FORMAT,
  SRB_CLOSE_MASTER_CLOCK,
  SRB_PROPOSE_STREAM_RATE,
  SRB_SET_DATA_FORMAT,
  SRB_GET_DATA_FORMAT,
  SRB_BEGIN_FLUSH,
  SRB_END_FLUSH,
 
  SRB_GET_STREAM_INFO = 0x100,
  SRB_OPEN_STREAM,
  SRB_CLOSE_STREAM,
  SRB_OPEN_DEVICE_INSTANCE,
  SRB_CLOSE_DEVICE_INSTANCE,
  SRB_GET_DEVICE_PROPERTY,
  SRB_SET_DEVICE_PROPERTY,
  SRB_INITIALIZE_DEVICE,
  SRB_CHANGE_POWER_STATE,
  SRB_UNINITIALIZE_DEVICE,
  SRB_UNKNOWN_DEVICE_COMMAND,
  SRB_PAGING_OUT_DRIVER,
  SRB_GET_DATA_INTERSECTION,
  SRB_INITIALIZATION_COMPLETE,
  SRB_SURPRISE_REMOVAL
 
#if (NTDDI_VERSION >= NTDDI_WINXP)
 ,SRB_DEVICE_METHOD
 ,SRB_STREAM_METHOD
#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1)
 ,SRB_NOTIFY_IDLE_STATE
#endif
#endif
} SRB_COMMAND;

_STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE

enum _STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE

Enumerator
ReadyForNextDeviceRequest
DeviceRequestComplete
SignalMultipleDeviceEvents
SignalDeviceEvent
DeleteDeviceEvent
SignalMultipleDeviceInstanceEvents
DeviceNotificationMaximum

Definition at line 328 of file strmini.h.

                                                         {
  ReadyForNextDeviceRequest,
  DeviceRequestComplete,
  SignalMultipleDeviceEvents,
  SignalDeviceEvent,
  DeleteDeviceEvent,
#if (NTDDI_VERSION >= NTDDI_WINXP)
  SignalMultipleDeviceInstanceEvents,
#endif
  DeviceNotificationMaximum
} STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE, *PSTREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE;

_STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE

enum _STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE

Enumerator
ReadyForNextStreamDataRequest
ReadyForNextStreamControlRequest
HardwareStarved
StreamRequestComplete
SignalMultipleStreamEvents
SignalStreamEvent
DeleteStreamEvent
StreamNotificationMaximum

Definition at line 317 of file strmini.h.

                                                         {
  ReadyForNextStreamDataRequest,
  ReadyForNextStreamControlRequest,
  HardwareStarved,
  StreamRequestComplete,
  SignalMultipleStreamEvents,
  SignalStreamEvent,
  DeleteStreamEvent,
  StreamNotificationMaximum
} STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE, *PSTREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE;

_STREAM_PRIORITY

enum _STREAM_PRIORITY

Enumerator
High
Dispatch
Low
LowToHigh

Definition at line 377 of file strmini.h.

                              {
  High,
  Dispatch,
  Low,
  LowToHigh
} STREAM_PRIORITY, *PSTREAM_PRIORITY;

STREAM_BUFFER_TYPE

enum STREAM_BUFFER_TYPE

Enumerator
PerRequestExtension
DmaBuffer
SRBDataBuffer

Definition at line 274 of file strmini.h.

             {
  PerRequestExtension,
  DmaBuffer,
  SRBDataBuffer
} STREAM_BUFFER_TYPE;

STREAM_DEBUG_LEVEL

enum STREAM_DEBUG_LEVEL

Enumerator
DebugLevelFatal
DebugLevelError
DebugLevelWarning
DebugLevelInfo
DebugLevelTrace
DebugLevelVerbose
DebugLevelMaximum

Definition at line 11 of file strmini.h.

             {
  DebugLevelFatal = 0,
  DebugLevelError,
  DebugLevelWarning,
  DebugLevelInfo,
  DebugLevelTrace,
  DebugLevelVerbose,
  DebugLevelMaximum
} STREAM_DEBUG_LEVEL;

TIME_FUNCTION

enum TIME_FUNCTION

Enumerator
TIME_GET_STREAM_TIME
TIME_READ_ONBOARD_CLOCK
TIME_SET_ONBOARD_CLOCK

Definition at line 41 of file strmini.h.

             {
  TIME_GET_STREAM_TIME,
  TIME_READ_ONBOARD_CLOCK,
  TIME_SET_ONBOARD_CLOCK
} TIME_FUNCTION;

Function Documentation

_In_reads_()

_In_ const GUID _In_ ULONG _In_reads_

(

PinCount

)

_In_reads_opt_()

_In_ const GUID _In_ ULONG _In_reads_opt_

(

PinCount

)

_Inout_updates_bytes_()

_In_ BOOLEAN _Inout_updates_bytes_

(

Length

)

_IRQL_requires_max_() [1/3]

_IRQL_requires_max_

(

APC_LEVEL

)

Probes and locks virtual pages in memory for the specified process.

Parameters

[in,out]	MemoryDescriptorList	Memory Descriptor List (MDL) containing the buffer to be probed and locked.
[in]	Process	The process for which the buffer should be probed and locked.
[in]	AccessMode	Access mode for probing the pages. Can be KernelMode or UserMode.
[in]	LockOperation	The type of the probing and locking operation. Can be IoReadAccess, IoWriteAccess or IoModifyAccess.

Returns

Nothing.

See also

MmProbeAndLockPages

Remarks

Must be called at IRQL <= APC_LEVEL

Probes and locks virtual pages in memory for the specified process.

Frees previously reserved amount of memory in system virtual address space.

Parameters

[in]	NumberOfBytes	Size, in bytes, of memory to reserve.
[in]	PoolTag	Pool Tag identifying the buffer. Usually consists from 4 characters in reversed order.

Returns

A pointer to the 1st memory block of the reserved buffer in case of success, NULL otherwise.

Remarks

Must be called at IRQL <= APC_LEVEL

Parameters

[in]	BaseAddress	A pointer to the 1st memory block of the reserved buffer.
[in]	PoolTag	Pool Tag identifying the buffer. Usually consists from 4 characters in reversed order.

Returns

Nothing.

See also

MmAllocateMappingAddress

Remarks

Must be called at IRQL <= APC_LEVEL

Definition at line 37 of file cddata.c.

{
    THREAD_CONTEXT ThreadContext = {0};
    PIRP_CONTEXT IrpContext = NULL;
    BOOLEAN Wait;
 
#ifdef CD_SANITY
    PVOID PreviousTopLevel;
#endif
 
    NTSTATUS Status;
 
#if DBG
 
    KIRQL SaveIrql = KeGetCurrentIrql();
 
#endif
 
    ASSERT_OPTIONAL_IRP( Irp );
 
    UNREFERENCED_PARAMETER( DeviceObject );
 
    FsRtlEnterFileSystem();
 
#ifdef CD_SANITY
    PreviousTopLevel = IoGetTopLevelIrp();
#endif
 
    //
    //  Loop until this request has been completed or posted.
    //
 
    do {
 
        //
        //  Use a try-except to handle the exception cases.
        //
 
        _SEH2_TRY {
 
            //
            //  If the IrpContext is NULL then this is the first pass through
            //  this loop.
            //
 
            if (IrpContext == NULL) {
 
                //
                //  Decide if this request is waitable an allocate the IrpContext.
                //  If the file object in the stack location is NULL then this
                //  is a mount which is always waitable.  Otherwise we look at
                //  the file object flags.
                //
 
                if (IoGetCurrentIrpStackLocation( Irp )->FileObject == NULL) {
 
                    Wait = TRUE;
 
                } else {
 
                    Wait = CanFsdWait( Irp );
                }
 
                IrpContext = CdCreateIrpContext( Irp, Wait );
 
                //
                //  Update the thread context information.
                //
 
                CdSetThreadContext( IrpContext, &ThreadContext );
 
#ifdef CD_SANITY
                NT_ASSERT( !CdTestTopLevel ||
                        SafeNodeType( IrpContext->TopLevel ) == CDFS_NTC_IRP_CONTEXT );
#endif
 
            //
            //  Otherwise cleanup the IrpContext for the retry.
            //
 
            } else {
 
                //
                //  Set the MORE_PROCESSING flag to make sure the IrpContext
                //  isn't inadvertently deleted here.  Then cleanup the
                //  IrpContext to perform the retry.
                //
 
                SetFlag( IrpContext->Flags, IRP_CONTEXT_FLAG_MORE_PROCESSING );
                CdCleanupIrpContext( IrpContext, FALSE );
            }
 
            //
            //  Case on the major irp code.
            //
 
            switch (IrpContext->MajorFunction) {
 
            case IRP_MJ_CREATE :
 
                Status = CdCommonCreate( IrpContext, Irp );
                break;
 
            case IRP_MJ_CLOSE :
 
                Status = CdCommonClose( IrpContext, Irp );
                break;
 
            case IRP_MJ_READ :
 
                //
                //  If this is an Mdl complete request, don't go through
                //  common read.
                //
 
                if (FlagOn( IrpContext->MinorFunction, IRP_MN_COMPLETE )) {
 
                    Status = CdCompleteMdl( IrpContext, Irp );
 
                } else {
 
                    Status = CdCommonRead( IrpContext, Irp );
                }
 
                break;
 
            case IRP_MJ_WRITE :
 
                Status = CdCommonWrite( IrpContext, Irp );
                break;
 
            case IRP_MJ_QUERY_INFORMATION :
 
                Status = CdCommonQueryInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_SET_INFORMATION :
 
                Status = CdCommonSetInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_QUERY_VOLUME_INFORMATION :
 
                Status = CdCommonQueryVolInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_DIRECTORY_CONTROL :
 
                Status = CdCommonDirControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_FILE_SYSTEM_CONTROL :
 
                Status = CdCommonFsControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_DEVICE_CONTROL :
 
                Status = CdCommonDevControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_LOCK_CONTROL :
 
                Status = CdCommonLockControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_CLEANUP :
 
                Status = CdCommonCleanup( IrpContext, Irp );
                break;
 
            case IRP_MJ_PNP :
 
                Status = CdCommonPnp( IrpContext, Irp );
                break;
 
            case IRP_MJ_SHUTDOWN :
 
                Status = CdCommonShutdown( IrpContext, Irp );
                break;
 
            default :
 
                Status = STATUS_INVALID_DEVICE_REQUEST;
                CdCompleteRequest( IrpContext, Irp, Status );
            }
 
        } _SEH2_EXCEPT( CdExceptionFilter( IrpContext, _SEH2_GetExceptionInformation() )) {
 
            Status = CdProcessException( IrpContext, Irp, _SEH2_GetExceptionCode() );
        } _SEH2_END;
 
    } while (Status == STATUS_CANT_WAIT);
 
#ifdef CD_SANITY
    NT_ASSERT( !CdTestTopLevel ||
            (PreviousTopLevel == IoGetTopLevelIrp()) );
#endif
 
    FsRtlExitFileSystem();
 
    NT_ASSERT( SaveIrql == KeGetCurrentIrql( ));
 
    return Status;
}

_IRQL_requires_max_() [2/3]

_IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 347 of file common.c.

{
    NTSTATUS                    status;
    BOOLEAN                     requestSent = FALSE;
 
    BOOLEAN                     shouldRetry = TRUE;
    PCDB                        cdb = (PCDB)DeviceExtension->PowerContext.Srb.Cdb;
    ULONG                       timeoutValue = DeviceExtension->TimeOutValue;
    ULONG                       retryCount = 1;
 
    // reset some fields.
    DeviceExtension->PowerContext.RetryIntervalIn100ns = 0;
    status = PowerContextReuseRequest(DeviceExtension);
    RequestClearSendTime(DeviceExtension->PowerContext.PowerRequest);
 
    if (!NT_SUCCESS(status))
    {
        return status;
    }
 
    // set proper timeout value and max retry count.
    switch(DeviceExtension->PowerContext.PowerChangeState.PowerDown)
    {
    case PowerDownDeviceInitial:
    case PowerDownDeviceQuiesced:
    case PowerDownDeviceStopped:
        break;
 
    case PowerDownDeviceLocked:
        // Case of issuing SYNC CACHE command. Do not use power irp timeout remaining time in this case
        // as we want to give best try on SYNC CACHE command.
        retryCount = MAXIMUM_RETRIES;
        timeoutValue = DeviceExtension->TimeOutValue;
        break;
 
    case PowerDownDeviceFlushed:
    {
        // Case of issuing STOP UNIT command
        // As "Imme" bit is set to '1', this command should be completed in short time.
        // This command is at low importance, failure of this command has very small impact.
        ULONG secondsRemaining = 0;
 
#if (WINVER >= 0x0601)
        // this API is introduced in Windows7
        PoQueryWatchdogTime(DeviceExtension->LowerPdo, &secondsRemaining);
#endif
 
        if (secondsRemaining == 0)
        {
            // not able to retrieve remaining time from PoQueryWatchdogTime API, use default values.
            retryCount = MAXIMUM_RETRIES;
            timeoutValue = SCSI_CDROM_TIMEOUT;
        }
        else
        {
            // plan to leave about 30 seconds to lower level drivers if possible.
            if (secondsRemaining >= 32)
            {
                retryCount = (secondsRemaining - 30)/SCSI_CDROM_TIMEOUT + 1;
                timeoutValue = SCSI_CDROM_TIMEOUT;
 
                if (retryCount > MAXIMUM_RETRIES)
                {
                    retryCount = MAXIMUM_RETRIES;
                }
 
                if (retryCount == 1)
                {
                    timeoutValue = secondsRemaining - 30;
                }
            }
            else
            {
                // issue the command with minimal timeout value and do not retry on it.
                retryCount = 1;
                timeoutValue = 2;
            }
        }
    }
        break;
    default:
        NT_ASSERT( FALSE );
        status = STATUS_NOT_IMPLEMENTED;
        return status;
    }
 
    DeviceExtension->PowerContext.RetryCount = retryCount;
 
    // issue command.
    while (shouldRetry)
    {
 
        // set SRB fields.
        DeviceExtension->PowerContext.Srb.SrbFlags = SRB_FLAGS_NO_DATA_TRANSFER |
                                                     SRB_FLAGS_DISABLE_SYNCH_TRANSFER |
                                                     SRB_FLAGS_NO_QUEUE_FREEZE |
                                                     SRB_FLAGS_BYPASS_LOCKED_QUEUE |
                                                     SRB_FLAGS_D3_PROCESSING;
 
        DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_EXECUTE_SCSI;
        DeviceExtension->PowerContext.Srb.TimeOutValue = timeoutValue;
 
        if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceInitial)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_LOCK_QUEUE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceLocked)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_QUIESCE_DEVICE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
        {
            // Case of issuing SYNC CACHE command.
            DeviceExtension->PowerContext.Srb.CdbLength = 10;
            cdb->SYNCHRONIZE_CACHE10.OperationCode = SCSIOP_SYNCHRONIZE_CACHE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceFlushed)
        {
            // Case of issuing STOP UNIT command.
            DeviceExtension->PowerContext.Srb.CdbLength = 6;
            cdb->START_STOP.OperationCode = SCSIOP_START_STOP_UNIT;
            cdb->START_STOP.Start = 0;
            cdb->START_STOP.Immediate = 1;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceStopped)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_UNLOCK_QUEUE;
        }
 
        // Set up completion routine and context if requested
        if (CompletionRoutine)
        {
            WdfRequestSetCompletionRoutine(DeviceExtension->PowerContext.PowerRequest,
                                           CompletionRoutine,
                                           Context);
        }
 
        status = RequestSend(DeviceExtension,
                             DeviceExtension->PowerContext.PowerRequest,
                             DeviceExtension->IoTarget,
                             CompletionRoutine ? 0 : WDF_REQUEST_SEND_OPTION_SYNCHRONOUS,
                             &requestSent);
 
        if (requestSent)
        {
            if ((CompletionRoutine == NULL) &&
                (SRB_STATUS(DeviceExtension->PowerContext.Srb.SrbStatus) != SRB_STATUS_SUCCESS))
            {
                TracePrint((TRACE_LEVEL_ERROR,
                            TRACE_FLAG_POWER,
                            "%p\tError occured when issuing %s command to device. Srb %p, Status %x\n",
                            DeviceExtension->PowerContext.PowerRequest,
                            (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced) ? "SYNC CACHE" : "STOP UNIT",
                            &DeviceExtension->PowerContext.Srb,
                            DeviceExtension->PowerContext.Srb.SrbStatus));
 
                NT_ASSERT(!(TEST_FLAG(DeviceExtension->PowerContext.Srb.SrbStatus, SRB_STATUS_QUEUE_FROZEN)));
 
                shouldRetry = RequestSenseInfoInterpret(DeviceExtension,
                                                        DeviceExtension->PowerContext.PowerRequest,
                                                        &(DeviceExtension->PowerContext.Srb),
                                                        retryCount - DeviceExtension->PowerContext.RetryCount,
                                                        &status,
                                                        &(DeviceExtension->PowerContext.RetryIntervalIn100ns));
 
                if (shouldRetry && (DeviceExtension->PowerContext.RetryCount-- == 0))
                {
                    shouldRetry = FALSE;
                }
            }
            else
            {
                // succeeded, do not need to retry.
                shouldRetry = FALSE;
            }
 
        }
        else
        {
            // request failed to be sent
            shouldRetry = FALSE;
        }
 
        if (shouldRetry)
        {
            LARGE_INTEGER t;
            t.QuadPart = -DeviceExtension->PowerContext.RetryIntervalIn100ns;
            KeDelayExecutionThread(KernelMode, FALSE, &t);
 
            status = PowerContextReuseRequest(DeviceExtension);
            if (!NT_SUCCESS(status))
            {
                shouldRetry = FALSE;
            }
        }
    }
 
    if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
    {
        // record SYNC CACHE command completion time stamp.
        KeQueryTickCount(&DeviceExtension->PowerContext.Step1CompleteTime);
    }
 
    return status;
}

_IRQL_requires_max_() [3/3]

_IRQL_requires_max_

(

PASSIVE_LEVEL

)

Queries information details about a security descriptor.

Computes the quota size of a security descriptor.

Assigns a security descriptor for a new object.

An extended function that assigns a security descriptor for a new object.

Frees a security descriptor.

An extended function that sets new information data to a security descriptor.

Modifies some information data about a security descriptor.

Parameters

[in]	SecurityInformation	Security information details to be queried from a security descriptor.
[out]	SecurityDescriptor	The returned security descriptor with security information data.
[in,out]	Length	The returned length of a security descriptor.
[in,out]	ObjectsSecurityDescriptor	The returned object security descriptor.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the specific information about the security descriptor has been queried. STATUS_BUFFER_TOO_SMALL is returned if the buffer size is too small to contain the queried info about the security descriptor.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

See SeSetSecurityDescriptorInfoEx.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	AutoInheritFlags	Flags bitmask inheritation, influencing how the security descriptor can be inherited and if it can be in the first place.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

Returns STATUS_SUCCESS if the operations have been completed without problems and that new info has been set to the security descriptor. STATUS_NO_SECURITY_ON_OBJECT is returned if the object does not have a security descriptor. STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the new security descriptor with new info set has failed.

Parameters

[in]

SecurityDescriptor

A security descriptor to be freed from memory.

Returns

Returns STATUS_SUCCESS.

Parameters

[in]	_ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	_ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	ObjectType	The type of the new object.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	AutoInheritFlags	Automatic inheritance flags that influence how access control entries within ACLs from security descriptors are inherited.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the security descriptor has been assigned to the new object. STATUS_NO_TOKEN is returned if the caller hasn't supplied a valid argument to a security subject context. STATUS_INVALID_OWNER is returned if the caller hasn't supplied a parent descriptor that belongs to the main user (owner). STATUS_INVALID_PRIMARY_GROUP is returned by the same reason as with the previous NTSTATUS code. The two NTSTATUS codes are returned if the calling thread stated that the owner and/or group is defaulted to the parent descriptor (SEF_DEFAULT_OWNER_FROM_PARENT and/or SEF_DEFAULT_GROUP_FROM_PARENT respectively). STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the descriptor buffer has failed. A failure NTSTATUS is returned otherwise.

Parameters

[in]	ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

See SeAssignSecurityEx.

Parameters

[in]	SecurityDescriptor	A security descriptor.
[out]	QuotaInfoSize	The returned quota size of the given security descriptor to the caller. The function may return 0 to this parameter if the descriptor doesn't have a group or a discretionary access control list (DACL) even.

Returns

Returns STATUS_SUCCESS if the quota size of a security descriptor has been computed successfully. STATUS_UNKNOWN_REVISION is returned if the security descriptor has an invalid revision.

Definition at line 923 of file Messaging.c.

{
    PFLT_SERVER_PORT_OBJECT PortObject;
    NTSTATUS Status;
 
    /* The caller must allow at least one connection */
    if (MaxConnections == 0)
    {
        return STATUS_INVALID_PARAMETER;
    }
 
    /* The request must be for a kernel handle */
    if (!(ObjectAttributes->Attributes & OBJ_KERNEL_HANDLE))
    {
        return STATUS_INVALID_PARAMETER;
    }
 
    /*
     * Get rundown protection on the target to stop the owner
     * from unloading whilst this port object is open. It gets
     * removed in the FltpServerPortClose callback
     */
    Status = FltObjectReference(Filter);
    if (!NT_SUCCESS(Status))
    {
        return Status;
    }
 
    /* Create the server port object for this filter */
    Status = ObCreateObject(KernelMode,
                            ServerPortObjectType,
                            ObjectAttributes,
                            KernelMode,
                            NULL,
                            sizeof(FLT_SERVER_PORT_OBJECT),
                            0,
                            0,
                            (PVOID *)&PortObject);
    if (NT_SUCCESS(Status))
    {
        /* Zero out the struct */
        RtlZeroMemory(PortObject, sizeof(FLT_SERVER_PORT_OBJECT));
 
        /* Increment the ref count on the target filter */
        FltpObjectPointerReference((PFLT_OBJECT)Filter);
 
        /* Setup the filter port object */
        PortObject->Filter = Filter;
        PortObject->ConnectNotify = ConnectNotifyCallback;
        PortObject->DisconnectNotify = DisconnectNotifyCallback;
        PortObject->MessageNotify = MessageNotifyCallback;
        PortObject->Cookie = ServerPortCookie;
        PortObject->MaxConnections = MaxConnections;
 
        /* Insert the object */
        Status = ObInsertObject(PortObject,
                                NULL,
                                STANDARD_RIGHTS_ALL | FILE_READ_DATA,
                                0,
                                NULL,
                                (PHANDLE)ServerPort);
        if (NT_SUCCESS(Status))
        {
            /* Lock the connection list */
            ExAcquireFastMutex(&Filter->ConnectionList.mLock);
 
            /* Add the new port object to the connection list and increment the count */
            InsertTailList(&Filter->ConnectionList.mList, &PortObject->FilterLink);
            Filter->ConnectionList.mCount++;
 
            /* Unlock the connection list*/
            ExReleaseFastMutex(&Filter->ConnectionList.mLock);
        }
    }
 
    if (!NT_SUCCESS(Status))
    {
        /* Allow the filter to be cleaned up */
        FltObjectDereference(Filter);
    }
 
    return Status;
}

StreamClassAbortOutstandingRequests()

VOID StreamClassAbortOutstandingRequests	(	_In_ PVOID	HwDeviceExtension,
		_In_opt_ PHW_STREAM_OBJECT	HwStreamObject,
		_In_ NTSTATUS	Status
	)

StreamClassCallAtNewPriority()

VOID STREAMAPI StreamClassCallAtNewPriority	(	_In_opt_ PHW_STREAM_OBJECT	StreamObject,
		_In_ PVOID	HwDeviceExtension,
		_In_ STREAM_PRIORITY	Priority,
		_In_ PHW_PRIORITY_ROUTINE	PriorityRoutine,
		_In_ PVOID	Context
	)

StreamClassCompleteRequestAndMarkQueueReady()

VOID STREAMAPI StreamClassCompleteRequestAndMarkQueueReady

(

_In_ PHW_STREAM_REQUEST_BLOCK

Srb

)

StreamClassDebugAssert()

__analysis_noreturn VOID STREAMAPI StreamClassDebugAssert	(	_In_ PCHAR	File,
		_In_ ULONG	Line,
		_In_ PCHAR	AssertText,
		_In_ ULONG	AssertValue
	)

StreamClassDebugPrint()

VOID __cdecl StreamClassDebugPrint	(	_In_ STREAM_DEBUG_LEVEL	DebugPrintLevel,
		_In_ PCCHAR	DebugMessage,
			...
	)

StreamClassDeviceNotification()

VOID __cdecl StreamClassDeviceNotification	(	IN STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE	NotificationType,
		IN PVOID	HwDeviceExtension,
		IN PHW_STREAM_REQUEST_BLOCK	pSrb,
		IN PKSEVENT_ENTRY	EventEntry,
		IN GUID *	EventSet,
		IN ULONG	EventId
	)

Definition at line 265 of file driver.c.

{
    PHW_STREAM_REQUEST_BLOCK_EXT RequestBlock;
    if (NotificationType == DeviceRequestComplete)
    {
        RequestBlock = (PHW_STREAM_REQUEST_BLOCK_EXT)pSrb;
 
        KeSetEvent(&RequestBlock->Event, 0, FALSE);
        return;
    }
 
    UNIMPLEMENTED;
}

StreamClassFilterReenumerateStreams()

VOID STREAMAPI StreamClassFilterReenumerateStreams	(	_In_ PVOID	HwInstanceExtension,
		_In_ ULONG	StreamDescriptorSize
	)

StreamClassGetDmaBuffer()

PVOID STREAMAPI StreamClassGetDmaBuffer

(

_In_ PVOID

HwDeviceExtension

)

StreamClassGetNextEvent()

PKSEVENT_ENTRY StreamClassGetNextEvent	(	_In_opt_ PVOID	HwInstanceExtension_OR_HwDeviceExtension,
		_In_opt_ PHW_STREAM_OBJECT	HwStreamObject,
		_In_opt_ GUID *	EventGuid,
		_In_ ULONG	EventItem,
		_In_opt_ PKSEVENT_ENTRY	CurrentEvent
	)

StreamClassGetPhysicalAddress()

STREAM_PHYSICAL_ADDRESS STREAMAPI StreamClassGetPhysicalAddress	(	_In_ PVOID	HwDeviceExtension,
		_In_opt_ PHW_STREAM_REQUEST_BLOCK	HwSRB,
		_In_ PVOID	VirtualAddress,
		_In_ STREAM_BUFFER_TYPE	Type,
		_Out_ ULONG *	Length
	)

StreamClassQueryMasterClock()

VOID StreamClassQueryMasterClock	(	_In_ PHW_STREAM_OBJECT	HwStreamObject,
		_In_ HANDLE	MasterClockHandle,
		_In_ TIME_FUNCTION	TimeFunction,
		_In_ PHW_QUERY_CLOCK_ROUTINE	ClockCallbackRoutine
	)

StreamClassReenumerateStreams()

VOID STREAMAPI StreamClassReenumerateStreams	(	_In_ PVOID	HwDeviceExtension,
		_In_ ULONG	StreamDescriptorSize
	)

StreamClassScheduleTimer()

VOID STREAMAPI StreamClassScheduleTimer	(	_In_opt_ PHW_STREAM_OBJECT	StreamObject,
		_In_ PVOID	HwDeviceExtension,
		_In_ ULONG	NumberOfMicroseconds,
		_In_ PHW_TIMER_ROUTINE	TimerRoutine,
		_In_ PVOID	Context
	)

StreamClassStreamNotification()

VOID __cdecl StreamClassStreamNotification	(	_In_ STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE	NotificationType,
		_In_ PHW_STREAM_OBJECT	StreamObject,
			...
	)

Variable Documentation

Argument2

_In_ PVOID Argument2

Definition at line 495 of file strmini.h.

HwInitializationData

_In_ PVOID _In_ PHW_INITIALIZATION_DATA HwInitializationData

Definition at line 496 of file strmini.h.

InterfaceClassGUID

_In_ const GUID* InterfaceClassGUID

Definition at line 504 of file strmini.h.

Length

_In_ BOOLEAN _In_ ULONG _In_ ULONG Length

Definition at line 482 of file strmini.h.

Offset

_In_ BOOLEAN _In_ ULONG Offset

Definition at line 481 of file strmini.h.

PinCount

_In_ const GUID _In_ ULONG PinCount

Definition at line 505 of file strmini.h.

Referenced by DECLARE_INTERFACE_(), EnumerateAudioFilter(), CKsProxy::GetPinName(), KsRegisterFilterWithNoKSPins(), MMixerAllocateTopology(), MMixerCreateTopology(), MMixerGetTopologyPinCount(), MMixerHandleAlternativeMixers(), MMixerInitializeMidiForFilter(), MMixerInitializeWaveInfo(), PcCreateSubdeviceDescriptor(), RtlAtomTestThread(), RtlQueryAtomInAtomTable(), test_NtAtom(), test_NtIntAtom(), and test_NtRefPinAtom().

PSTREAM_SYSTEM_TIME

__GNU_EXTENSION typedef unsigned __int64 * PSTREAM_SYSTEM_TIME

Definition at line 38 of file strmini.h.

PSTREAM_TIMESTAMP

__GNU_EXTENSION typedef unsigned __int64 * PSTREAM_TIMESTAMP

Definition at line 39 of file strmini.h.

Read

_In_ BOOLEAN Read

Definition at line 479 of file strmini.h.

Referenced by CONSOLE_ConInKey(), CONSOLE_ConInKeyPeek(), continue_binding(), DECLARE_INTERFACE_(), GetProtoGetNextEnt(), HwReadWriteData(), InternalGetBinaryType(), InternalIsOS2OrOldWin(), LoadColumnsStream(), LoadImageFromFileHandle(), CDefView::LoadViewState(), MimeProtocol_Read(), MimeProtocolSink_ReportData(), NtfsGetFreeClusters(), OslpGetSetBootStatusData(), PciReadWriteConfigSpace(), Protocol_Continue(), Protocol_Read(), Protocol_Start(), ProtocolEmul_Continue(), ProtocolEmul_Read(), ProtocolSink_ReportData(), ProtocolSink_ReportProgress(), RtlGetSetBootStatusData(), RxGetRegistryParameters(), Stream_Read(), StreamClassReadWriteConfig(), test_BindToStorage(), test_CreateBinding(), test_StreamLoad(), thread_proc(), and WdmAudReadWrite().

STREAM_SYSTEM_TIME

__GNU_EXTENSION typedef unsigned __int64 STREAM_SYSTEM_TIME

Definition at line 38 of file strmini.h.

STREAM_TIMESTAMP

__GNU_EXTENSION typedef unsigned __int64 STREAM_TIMESTAMP

Definition at line 39 of file strmini.h.

TimeContext

_Inout_ PHW_TIME_CONTEXT TimeContext

Definition at line 472 of file strmini.h.