2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Kernel Streaming
4 * FILE: drivers/wdm/audio/backpln/portcls/irpstream.cpp
5 * PURPOSE: IRP Stream handling
6 * PROGRAMMER: Johannes Anderwald
12 class CIrpQueue
: public IIrpQueue
15 STDMETHODIMP
QueryInterface( REFIID InterfaceId
, PVOID
* Interface
);
17 STDMETHODIMP_(ULONG
) AddRef()
19 InterlockedIncrement(&m_Ref
);
22 STDMETHODIMP_(ULONG
) Release()
24 InterlockedDecrement(&m_Ref
);
34 CIrpQueue(IUnknown
*OuterUnknown
){}
35 virtual ~CIrpQueue(){}
38 volatile ULONG m_CurrentOffset
;
40 ULONG m_NumDataAvailable
;
41 PKSPIN_CONNECT m_ConnectDetails
;
42 KSPIN_LOCK m_IrpListLock
;
44 LIST_ENTRY m_FreeIrpList
;
46 PVOID m_SilenceBuffer
;
56 #define OFFSET_HEADERINDEX (0)
57 #define OFFSET_STREAMHEADER (2)
58 #define OFFSET_HEADERCOUNT (3)
61 #define STREAMHEADER_INDEX(Irp) (PtrToUlong(Irp->Tail.Overlay.DriverContext[OFFSET_HEADERINDEX]))
62 #define STREAMHEADER_COUNT(Irp) (PtrToUlong(Irp->Tail.Overlay.DriverContext[OFFSET_HEADERCOUNT]))
63 #define STREAMHEADER_CURRENT(Irp) (Irp->Tail.Overlay.DriverContext[OFFSET_STREAMHEADER])
68 CIrpQueue::QueryInterface(
72 if (IsEqualGUIDAligned(refiid
, IID_IUnknown
))
74 *Output
= PVOID(PUNKNOWN(this));
75 PUNKNOWN(*Output
)->AddRef();
76 return STATUS_SUCCESS
;
79 return STATUS_UNSUCCESSFUL
;
85 IN KSPIN_CONNECT
*ConnectDetails
,
88 IN PVOID SilenceBuffer
)
90 m_ConnectDetails
= ConnectDetails
;
91 m_MaxFrameSize
= FrameSize
;
92 m_SilenceBuffer
= SilenceBuffer
;
93 m_Alignment
= Alignment
;
95 InitializeListHead(&m_IrpList
);
96 InitializeListHead(&m_FreeIrpList
);
97 KeInitializeSpinLock(&m_IrpListLock
);
99 return STATUS_SUCCESS
;
104 CIrpQueue::AddMapping(
108 PKSSTREAM_HEADER Header
;
109 NTSTATUS Status
= STATUS_SUCCESS
;
110 PIO_STACK_LOCATION IoStack
;
111 ULONG NumHeaders
, NumData
, Index
;
114 PC_ASSERT(KeGetCurrentIrql() == PASSIVE_LEVEL
);
116 // get current irp stack location
117 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
119 if (!Irp
->MdlAddress
)
121 // ioctl from KsStudio
122 // Wdmaud already probes buffers, therefore no need to probe it again
123 // probe the stream irp
124 if (IoStack
->Parameters
.DeviceIoControl
.IoControlCode
== IOCTL_KS_WRITE_STREAM
)
125 Status
= KsProbeStreamIrp(Irp
, KSSTREAM_WRITE
| KSPROBE_ALLOCATEMDL
| KSPROBE_PROBEANDLOCK
| KSPROBE_SYSTEMADDRESS
, 0);
126 else if (IoStack
->Parameters
.DeviceIoControl
.IoControlCode
== IOCTL_KS_READ_STREAM
)
127 Status
= KsProbeStreamIrp(Irp
, KSSTREAM_READ
| KSPROBE_ALLOCATEMDL
| KSPROBE_PROBEANDLOCK
| KSPROBE_SYSTEMADDRESS
, 0);
132 if (!NT_SUCCESS(Status
))
134 DPRINT("KsProbeStreamIrp failed with %x\n", Status
);
139 // get first stream header
141 if (Irp
->RequestorMode
== UserMode
)
142 Header
= (PKSSTREAM_HEADER
)Irp
->AssociatedIrp
.SystemBuffer
;
144 Header
= (PKSSTREAM_HEADER
)Irp
->UserBuffer
;
149 // calculate num headers
150 NumHeaders
= IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
/ Header
->Size
;
152 // assume headers of same length
153 PC_ASSERT(IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
% Header
->Size
== 0);
156 // get first audio buffer
157 Mdl
= Irp
->MdlAddress
;
161 // store the current stream header
162 Irp
->Tail
.Overlay
.DriverContext
[OFFSET_STREAMHEADER
] = (PVOID
)Header
;
163 // store header count
164 Irp
->Tail
.Overlay
.DriverContext
[OFFSET_HEADERCOUNT
] = UlongToPtr(NumHeaders
);
166 // store current header index
167 Irp
->Tail
.Overlay
.DriverContext
[OFFSET_HEADERINDEX
] = UlongToPtr(0);
170 // prepare all headers
171 for(Index
= 0; Index
< NumHeaders
; Index
++)
177 if (Irp
->RequestorMode
== UserMode
)
179 Header
->Data
= MmGetSystemAddressForMdlSafe(Mdl
, NormalPagePriority
);
184 // insufficient resources
185 ExFreePool(Irp
->AssociatedIrp
.SystemBuffer
);
186 Irp
->AssociatedIrp
.SystemBuffer
= NULL
;
187 // complete and forget request
188 Irp
->IoStatus
.Status
= STATUS_INSUFFICIENT_RESOURCES
;
189 Irp
->IoStatus
.Information
= 0;
191 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
192 return STATUS_INSUFFICIENT_RESOURCES
;
195 // increment num mappings
196 InterlockedIncrement(&m_NumMappings
);
198 // increment available data
199 InterlockedExchangeAdd((PLONG
)&m_NumDataAvailable
,
200 (max(Header
->DataUsed
, Header
->FrameExtent
)));
202 NumData
+= max(Header
->DataUsed
, Header
->FrameExtent
);
204 // move to next header
205 Header
= (PKSSTREAM_HEADER
)((ULONG_PTR
)Header
+ Header
->Size
);
211 DPRINT("StreamHeaders %u NumData %u FrameSize %u NumDataAvailable %u\n", NumHeaders
, NumData
, m_MaxFrameSize
, m_NumDataAvailable
);
214 // mark irp as pending
215 IoMarkIrpPending(Irp
);
217 // add irp to cancelable queue
218 KsAddIrpToCancelableQueue(&m_IrpList
, &m_IrpListLock
, Irp
, KsListEntryTail
, NULL
);
220 // disable mapping failed status
221 m_OutOfMapping
= FALSE
;
229 CIrpQueue::GetMapping(
231 OUT PULONG BufferSize
)
235 //PIO_STACK_LOCATION IoStack;
236 PKSSTREAM_HEADER StreamHeader
;
238 // check if there is an irp in the partially processed
242 if (m_Irp
->Cancel
== FALSE
)
245 Offset
= m_CurrentOffset
;
249 // irp has been cancelled
250 m_Irp
->IoStatus
.Status
= STATUS_CANCELLED
;
251 IoCompleteRequest(m_Irp
, IO_NO_INCREMENT
);
257 // get a fresh new irp from the queue
258 m_Irp
= Irp
= KsRemoveIrpFromCancelableQueue(&m_IrpList
, &m_IrpListLock
, KsListEntryHead
, KsAcquireAndRemoveOnlySingleItem
);
259 m_CurrentOffset
= Offset
= 0;
265 // no irp available, use silence buffer
266 *Buffer
= (PUCHAR
)m_SilenceBuffer
;
267 *BufferSize
= m_MaxFrameSize
;
268 return STATUS_SUCCESS
;
272 StreamHeader
= (PKSSTREAM_HEADER
)Irp
->Tail
.Overlay
.DriverContext
[2];
275 PC_ASSERT(StreamHeader
);
278 if (StreamHeader
->DataUsed
)
279 *BufferSize
= StreamHeader
->DataUsed
- Offset
;
281 *BufferSize
= StreamHeader
->FrameExtent
- Offset
;
283 PC_ASSERT(*BufferSize
);
286 *Buffer
= &((PUCHAR
)StreamHeader
->Data
)[Offset
];
288 // unset flag that no irps are available
289 m_OutOfMapping
= FALSE
;
291 return STATUS_SUCCESS
;
296 CIrpQueue::UpdateMapping(
297 IN ULONG BytesWritten
)
299 PKSSTREAM_HEADER StreamHeader
;
300 ULONG Size
, NumData
, Index
;
304 // silence buffer was used
309 StreamHeader
= (PKSSTREAM_HEADER
)STREAMHEADER_CURRENT(m_Irp
);
312 // ASSERT(StreamHeader);
314 // add to current offset
315 InterlockedExchangeAdd((volatile PLONG
)&m_CurrentOffset
, (LONG
)BytesWritten
);
317 // decrement available data counter
318 m_NumDataAvailable
-= BytesWritten
;
320 if (StreamHeader
->DataUsed
)
321 Size
= StreamHeader
->DataUsed
;
323 Size
= StreamHeader
->FrameExtent
;
327 if (m_CurrentOffset
>= Size
)
329 if (STREAMHEADER_INDEX(m_Irp
) + 1 < STREAMHEADER_COUNT(m_Irp
))
331 // the irp has at least one more stream header
332 m_Irp
->Tail
.Overlay
.DriverContext
[OFFSET_HEADERINDEX
] = UlongToPtr(STREAMHEADER_INDEX(m_Irp
) + 1);
334 // get next stream header
335 StreamHeader
= (PKSSTREAM_HEADER
)((ULONG_PTR
)StreamHeader
+ StreamHeader
->Size
);
337 // store next stream header
338 STREAMHEADER_CURRENT(m_Irp
) = (PVOID
)StreamHeader
;
340 // reset current offset
347 // irp has been processed completly
350 if (m_Irp
->RequestorMode
== KernelMode
)
351 StreamHeader
= (PKSSTREAM_HEADER
)m_Irp
->UserBuffer
;
353 StreamHeader
= (PKSSTREAM_HEADER
)m_Irp
->AssociatedIrp
.SystemBuffer
;
355 // loop all stream headers
356 for(Index
= 0; Index
< STREAMHEADER_COUNT(m_Irp
); Index
++)
358 PC_ASSERT(StreamHeader
);
360 // add size of buffer
361 // depends on if the buffer is input / output
362 if (StreamHeader
->DataUsed
)
363 Size
= StreamHeader
->DataUsed
;
365 Size
= StreamHeader
->FrameExtent
;
370 // get next stream header
371 StreamHeader
= (PKSSTREAM_HEADER
)((ULONG_PTR
)StreamHeader
+ StreamHeader
->Size
);
374 if (m_ConnectDetails
->Interface
.Id
== KSINTERFACE_STANDARD_LOOPED_STREAMING
)
376 // looped streaming repeat the buffers untill
377 // the caller decides to stop the streams
379 // reset stream header index
380 m_Irp
->Tail
.Overlay
.DriverContext
[OFFSET_HEADERINDEX
] = UlongToPtr(0);
382 KsAddIrpToCancelableQueue(&m_IrpList
, &m_IrpListLock
, m_Irp
, KsListEntryTail
, NULL
);
387 // increment available data
388 InterlockedExchangeAdd((PLONG
)&m_NumDataAvailable
, NumData
);
393 m_Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
394 m_Irp
->IoStatus
.Information
= NumData
;
396 // complete the request
397 IoCompleteRequest(m_Irp
, IO_SOUND_INCREMENT
);
398 // remove irp as it is complete
408 // returns the amount of audio stream data available
409 return m_NumDataAvailable
;
414 CIrpQueue::CancelBuffers()
416 // is there an active irp
419 // re-insert it to cancelable queue
420 KsAddIrpToCancelableQueue(&m_IrpList
, &m_IrpListLock
, m_Irp
, KsListEntryTail
, NULL
);
426 KsCancelIo(&m_IrpList
, &m_IrpListLock
);
427 // reset number of mappings
429 // reset number of data available
430 m_NumDataAvailable
= 0;
438 CIrpQueue::GetMappingWithTag(
440 OUT PPHYSICAL_ADDRESS PhysicalAddress
,
441 OUT PVOID
*VirtualAddress
,
442 OUT PULONG ByteCount
,
445 PKSSTREAM_HEADER StreamHeader
;
449 PC_ASSERT(Tag
!= NULL
);
451 // get an irp from the queue
452 Irp
= KsRemoveIrpFromCancelableQueue(&m_IrpList
, &m_IrpListLock
, KsListEntryHead
, KsAcquireAndRemoveOnlySingleItem
);
454 // check if there is an irp
458 m_OutOfMapping
= TRUE
;
459 return STATUS_NOT_FOUND
;
462 //FIXME support more than one stream header
463 PC_ASSERT(STREAMHEADER_COUNT(Irp
) == 1);
465 // HACK get stream header
466 StreamHeader
= (PKSSTREAM_HEADER
)Irp
->Tail
.Overlay
.DriverContext
[2];
468 // store mapping in the free list
469 ExInterlockedInsertTailList(&m_FreeIrpList
, &Irp
->Tail
.Overlay
.ListEntry
, &m_IrpListLock
);
472 *PhysicalAddress
= MmGetPhysicalAddress(StreamHeader
->Data
);
473 *VirtualAddress
= StreamHeader
->Data
;
474 *ByteCount
= StreamHeader
->DataUsed
;
476 // decrement mapping count
477 InterlockedDecrement(&m_NumMappings
);
478 // decrement num data available
479 m_NumDataAvailable
-= StreamHeader
->DataUsed
;
482 Irp
->Tail
.Overlay
.DriverContext
[3] = Tag
;
485 return STATUS_SUCCESS
;
490 CIrpQueue::ReleaseMappingWithTag(
494 PLIST_ENTRY CurEntry
;
495 PKSSTREAM_HEADER StreamHeader
;
497 DPRINT("CIrpQueue::ReleaseMappingWithTag Tag %p\n", Tag
);
499 // remove irp from used list
500 CurEntry
= ExInterlockedRemoveHeadList(&m_FreeIrpList
, &m_IrpListLock
);
504 // get irp from list entry
505 Irp
= (PIRP
)CONTAINING_RECORD(CurEntry
, IRP
, Tail
.Overlay
.ListEntry
);
507 // HACK get stream header
508 StreamHeader
= (PKSSTREAM_HEADER
)Irp
->Tail
.Overlay
.DriverContext
[2];
510 // driver must release items in the same order
511 PC_ASSERT(Irp
->Tail
.Overlay
.DriverContext
[3] == Tag
);
513 // irp has been processed completly
514 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
516 // frame extend contains the original request size, DataUsed contains the real buffer size
517 // is different when kmixer performs channel conversion, upsampling etc
519 Irp
->IoStatus
.Information
= StreamHeader
->FrameExtent
;
521 // complete the request
522 IoCompleteRequest(Irp
, IO_SOUND_INCREMENT
);
524 return STATUS_SUCCESS
;
529 CIrpQueue::HasLastMappingFailed()
531 return m_OutOfMapping
;
536 CIrpQueue::GetCurrentIrpOffset()
539 return m_CurrentOffset
;
544 CIrpQueue::GetAcquiredTagRange(
551 PLIST_ENTRY CurEntry
;
553 KeAcquireSpinLock(&m_IrpListLock
, &OldLevel
);
555 if (!IsListEmpty(&m_FreeIrpList
))
558 CurEntry
= RemoveHeadList(&m_FreeIrpList
);
559 // get irp from list entry
560 Irp
= (PIRP
)CONTAINING_RECORD(CurEntry
, IRP
, Tail
.Overlay
.ListEntry
);
562 // get tag of first acquired buffer
563 *FirstTag
= Irp
->Tail
.Overlay
.DriverContext
[3];
566 InsertHeadList(&m_FreeIrpList
, &Irp
->Tail
.Overlay
.ListEntry
);
569 CurEntry
= RemoveTailList(&m_FreeIrpList
);
570 // get irp from list entry
571 Irp
= (PIRP
)CONTAINING_RECORD(CurEntry
, IRP
, Tail
.Overlay
.ListEntry
);
573 // get tag of first acquired buffer
574 *LastTag
= Irp
->Tail
.Overlay
.DriverContext
[3];
577 InsertTailList(&m_FreeIrpList
, &Irp
->Tail
.Overlay
.ListEntry
);
584 KeReleaseSpinLock(&m_IrpListLock
, OldLevel
);
592 IN IIrpQueue
**Queue
)
594 CIrpQueue
*This
= new(NonPagedPool
, TAG_PORTCLASS
)CIrpQueue(NULL
);
596 return STATUS_INSUFFICIENT_RESOURCES
;
600 *Queue
= (IIrpQueue
*)This
;
601 return STATUS_SUCCESS
;