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 ULONG m_CurrentOffset
;
40 ULONG m_NumDataAvailable
;
42 KSPIN_CONNECT
* m_ConnectDetails
;
43 PKSDATAFORMAT_WAVEFORMATEX m_DataFormat
;
45 KSPIN_LOCK m_IrpListLock
;
47 LIST_ENTRY m_FreeIrpList
;
49 PVOID m_SilenceBuffer
;
54 ULONG m_MinimumDataThreshold
;
60 #define OFFSET_HEADERINDEX (0)
61 #define OFFSET_STREAMHEADER (2)
62 #define OFFSET_HEADERCOUNT (3)
65 #define STREAMHEADER_INDEX(Irp) (PtrToUlong(Irp->Tail.Overlay.DriverContext[OFFSET_HEADERINDEX]))
66 #define STREAMHEADER_COUNT(Irp) (PtrToUlong(Irp->Tail.Overlay.DriverContext[OFFSET_HEADERCOUNT]))
67 #define STREAMHEADER_CURRENT(Irp) (Irp->Tail.Overlay.DriverContext[OFFSET_STREAMHEADER])
72 CIrpQueue::QueryInterface(
76 if (IsEqualGUIDAligned(refiid
, IID_IUnknown
))
78 *Output
= PVOID(PUNKNOWN(this));
79 PUNKNOWN(*Output
)->AddRef();
80 return STATUS_SUCCESS
;
83 return STATUS_UNSUCCESSFUL
;
89 IN KSPIN_CONNECT
*ConnectDetails
,
90 IN PKSDATAFORMAT DataFormat
,
91 IN PDEVICE_OBJECT DeviceObject
,
94 IN PVOID SilenceBuffer
)
96 m_ConnectDetails
= ConnectDetails
;
97 m_DataFormat
= (PKSDATAFORMAT_WAVEFORMATEX
)DataFormat
;
98 m_MaxFrameSize
= FrameSize
;
99 m_SilenceBuffer
= SilenceBuffer
;
100 m_Alignment
= Alignment
;
101 m_MinimumDataThreshold
= ((PKSDATAFORMAT_WAVEFORMATEX
)DataFormat
)->WaveFormatEx
.nAvgBytesPerSec
/ 3;
103 InitializeListHead(&m_IrpList
);
104 InitializeListHead(&m_FreeIrpList
);
105 KeInitializeSpinLock(&m_IrpListLock
);
107 return STATUS_SUCCESS
;
112 CIrpQueue::AddMapping(
117 PKSSTREAM_HEADER Header
;
118 NTSTATUS Status
= STATUS_SUCCESS
;
119 PIO_STACK_LOCATION IoStack
;
120 ULONG NumHeaders
, NumData
, Index
;
123 PC_ASSERT(KeGetCurrentIrql() == PASSIVE_LEVEL
);
125 // get current irp stack location
126 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
130 if (!Irp
->MdlAddress
)
132 // ioctl from KsStudio
133 // Wdmaud already probes buffers, therefore no need to probe it again
134 // probe the stream irp
135 if (IoStack
->Parameters
.DeviceIoControl
.IoControlCode
== IOCTL_KS_WRITE_STREAM
)
136 Status
= KsProbeStreamIrp(Irp
, KSSTREAM_WRITE
| KSPROBE_ALLOCATEMDL
| KSPROBE_PROBEANDLOCK
| KSPROBE_ALLOWFORMATCHANGE
| KSPROBE_SYSTEMADDRESS
, 0);
138 Status
= KsProbeStreamIrp(Irp
, KSSTREAM_READ
| KSPROBE_ALLOCATEMDL
| KSPROBE_PROBEANDLOCK
| KSPROBE_ALLOWFORMATCHANGE
| KSPROBE_SYSTEMADDRESS
, 0);
141 if (!NT_SUCCESS(Status
))
143 DPRINT("KsProbeStreamIrp failed with %x\n", Status
);
148 // get first stream header
149 Header
= (PKSSTREAM_HEADER
)Irp
->AssociatedIrp
.SystemBuffer
;
151 // calculate num headers
152 NumHeaders
= IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
/ Header
->Size
;
154 // assume headers of same length
155 PC_ASSERT(IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
% Header
->Size
== 0);
158 // get first audio buffer
159 Mdl
= Irp
->MdlAddress
;
162 // store the current stream header
163 Irp
->Tail
.Overlay
.DriverContext
[OFFSET_STREAMHEADER
] = (PVOID
)Header
;
164 // store header count
165 Irp
->Tail
.Overlay
.DriverContext
[OFFSET_HEADERCOUNT
] = UlongToPtr(NumHeaders
);
167 // store current header index
168 Irp
->Tail
.Overlay
.DriverContext
[OFFSET_HEADERINDEX
] = UlongToPtr(0);
172 // prepare all headers
173 for(Index
= 0; Index
< NumHeaders
; Index
++)
179 Header
->Data
= MmGetSystemAddressForMdlSafe(Mdl
, NormalPagePriority
);
183 // insufficient resources
184 ExFreePool(Irp
->AssociatedIrp
.SystemBuffer
);
185 Irp
->AssociatedIrp
.SystemBuffer
= NULL
;
186 // complete and forget request
187 Irp
->IoStatus
.Status
= STATUS_INSUFFICIENT_RESOURCES
;
188 Irp
->IoStatus
.Information
= 0;
190 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
191 return STATUS_INSUFFICIENT_RESOURCES
;
194 // increment num mappings
195 InterlockedIncrement(&m_NumMappings
);
197 // increment available data
198 InterlockedExchangeAdd((PLONG
)&m_NumDataAvailable
,
199 (max(Header
->DataUsed
, Header
->FrameExtent
)));
201 NumData
+= max(Header
->DataUsed
, Header
->FrameExtent
);
203 // move to next header
204 Header
= (PKSSTREAM_HEADER
)((ULONG_PTR
)Header
+ Header
->Size
);
210 DPRINT("StreamHeaders %u NumData %u FrameSize %u NumDataAvailable %u\n", NumHeaders
, NumData
, m_MaxFrameSize
, m_NumDataAvailable
);
213 // mark irp as pending
214 IoMarkIrpPending(Irp
);
216 // add irp to cancelable queue
217 KsAddIrpToCancelableQueue(&m_IrpList
, &m_IrpListLock
, Irp
, KsListEntryTail
, NULL
);
225 CIrpQueue::GetMapping(
227 OUT PULONG BufferSize
)
231 //PIO_STACK_LOCATION IoStack;
232 PKSSTREAM_HEADER StreamHeader
;
234 // check if there is an irp in the partially processed
238 if (m_Irp
->Cancel
== FALSE
)
241 Offset
= m_CurrentOffset
;
245 // irp has been cancelled
246 m_Irp
->IoStatus
.Status
= STATUS_CANCELLED
;
247 IoCompleteRequest(m_Irp
, IO_NO_INCREMENT
);
253 // get a fresh new irp from the queue
254 m_Irp
= Irp
= KsRemoveIrpFromCancelableQueue(&m_IrpList
, &m_IrpListLock
, KsListEntryHead
, KsAcquireAndRemoveOnlySingleItem
);
255 m_CurrentOffset
= Offset
= 0;
261 return STATUS_UNSUCCESSFUL
;
262 // no irp available, use silence buffer
263 *Buffer
= (PUCHAR
)m_SilenceBuffer
;
264 *BufferSize
= m_MaxFrameSize
;
265 // flag for port wave pci driver
266 m_OutOfMapping
= TRUE
;
267 // indicate flag to restart fast buffering
268 m_StartStream
= FALSE
;
269 return STATUS_SUCCESS
;
273 StreamHeader
= (PKSSTREAM_HEADER
)Irp
->Tail
.Overlay
.DriverContext
[2];
276 PC_ASSERT(StreamHeader
);
279 if (StreamHeader
->DataUsed
)
280 *BufferSize
= StreamHeader
->DataUsed
- Offset
;
282 *BufferSize
= StreamHeader
->FrameExtent
- Offset
;
284 PC_ASSERT(*BufferSize
);
287 *Buffer
= &((PUCHAR
)StreamHeader
->Data
)[Offset
];
289 // unset flag that no irps are available
290 m_OutOfMapping
= FALSE
;
292 return STATUS_SUCCESS
;
297 CIrpQueue::UpdateMapping(
298 IN ULONG BytesWritten
)
300 PKSSTREAM_HEADER StreamHeader
;
301 ULONG Size
, NumData
, Index
;
305 // silence buffer was used
310 StreamHeader
= (PKSSTREAM_HEADER
)STREAMHEADER_CURRENT(m_Irp
);
313 // ASSERT(StreamHeader);
315 // add to current offset
316 m_CurrentOffset
+= BytesWritten
;
318 // decrement available data counter
319 m_NumDataAvailable
-= BytesWritten
;
321 if (StreamHeader
->DataUsed
)
322 Size
= StreamHeader
->DataUsed
;
324 Size
= StreamHeader
->FrameExtent
;
328 if (m_CurrentOffset
>= Size
)
330 if (STREAMHEADER_INDEX(m_Irp
) + 1 < STREAMHEADER_COUNT(m_Irp
))
332 // the irp has at least one more stream header
333 m_Irp
->Tail
.Overlay
.DriverContext
[OFFSET_HEADERINDEX
] = UlongToPtr(STREAMHEADER_INDEX(m_Irp
) + 1);
335 // get next stream header
336 StreamHeader
= (PKSSTREAM_HEADER
)((ULONG_PTR
)StreamHeader
+ StreamHeader
->Size
);
338 // store next stream header
339 STREAMHEADER_CURRENT(m_Irp
) = (PVOID
)StreamHeader
;
341 // reset current offset
348 // irp has been processed completly
351 StreamHeader
= (PKSSTREAM_HEADER
)m_Irp
->AssociatedIrp
.SystemBuffer
;
353 // loop all stream headers
354 for(Index
= 0; Index
< STREAMHEADER_COUNT(m_Irp
); Index
++)
356 PC_ASSERT(StreamHeader
);
358 // add size of buffer
359 // depends on if the buffer is input / output
360 if (StreamHeader
->DataUsed
)
361 Size
= StreamHeader
->DataUsed
;
363 Size
= StreamHeader
->FrameExtent
;
368 // get next stream header
369 StreamHeader
= (PKSSTREAM_HEADER
)((ULONG_PTR
)StreamHeader
+ StreamHeader
->Size
);
372 m_Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
373 m_Irp
->IoStatus
.Information
= NumData
;
376 PC_ASSERT_IRQL(DISPATCH_LEVEL
);
377 MmUnlockPages(m_Irp
->MdlAddress
);
378 IoFreeMdl(m_Irp
->MdlAddress
);
379 m_Irp
->MdlAddress
= NULL
;
380 ExFreePool(m_Irp
->AssociatedIrp
.SystemBuffer
);
381 m_Irp
->AssociatedIrp
.SystemBuffer
= NULL
;
384 // complete the request
385 IoCompleteRequest(m_Irp
, IO_SOUND_INCREMENT
);
386 // remove irp as it is complete
394 CIrpQueue::NumMappings()
397 // returns the amount of mappings available
398 return m_NumMappings
;
405 // returns the amount of audio stream data available
406 return m_NumDataAvailable
;
412 CIrpQueue::MinimumDataAvailable()
419 if (m_MinimumDataThreshold
< m_NumDataAvailable
)
421 m_StartStream
= TRUE
;
433 CIrpQueue::CancelBuffers()
436 m_StartStream
= FALSE
;
442 CIrpQueue::UpdateFormat(
443 PKSDATAFORMAT DataFormat
)
445 m_DataFormat
= (PKSDATAFORMAT_WAVEFORMATEX
)DataFormat
;
446 m_MinimumDataThreshold
= m_DataFormat
->WaveFormatEx
.nAvgBytesPerSec
/ 3;
447 m_StartStream
= FALSE
;
448 m_NumDataAvailable
= 0;
453 CIrpQueue::GetMappingWithTag(
455 OUT PPHYSICAL_ADDRESS PhysicalAddress
,
456 OUT PVOID
*VirtualAddress
,
457 OUT PULONG ByteCount
,
460 PKSSTREAM_HEADER StreamHeader
;
464 PC_ASSERT(Tag
!= NULL
);
466 // get an irp from the queue
467 Irp
= KsRemoveIrpFromCancelableQueue(&m_IrpList
, &m_IrpListLock
, KsListEntryHead
, KsAcquireAndRemoveOnlySingleItem
);
469 // check if there is an irp
473 m_OutOfMapping
= TRUE
;
474 m_StartStream
= FALSE
;
475 return STATUS_UNSUCCESSFUL
;
478 //FIXME support more than one stream header
479 PC_ASSERT(STREAMHEADER_COUNT(Irp
) == 1);
481 // HACK get stream header
482 StreamHeader
= (PKSSTREAM_HEADER
)Irp
->Tail
.Overlay
.DriverContext
[2];
484 // store mapping in the free list
485 ExInterlockedInsertTailList(&m_FreeIrpList
, &Irp
->Tail
.Overlay
.ListEntry
, &m_IrpListLock
);
488 *PhysicalAddress
= MmGetPhysicalAddress(StreamHeader
->Data
);
489 *VirtualAddress
= StreamHeader
->Data
;
490 *ByteCount
= StreamHeader
->DataUsed
;
492 // decrement mapping count
493 InterlockedDecrement(&m_NumMappings
);
494 // decrement num data available
495 m_NumDataAvailable
-= StreamHeader
->DataUsed
;
498 Irp
->Tail
.Overlay
.DriverContext
[3] = Tag
;
501 return STATUS_SUCCESS
;
506 CIrpQueue::ReleaseMappingWithTag(
510 PLIST_ENTRY CurEntry
;
511 PKSSTREAM_HEADER StreamHeader
;
513 DPRINT("CIrpQueue::ReleaseMappingWithTag Tag %p\n", Tag
);
515 // remove irp from used list
516 CurEntry
= ExInterlockedRemoveHeadList(&m_FreeIrpList
, &m_IrpListLock
);
520 // get irp from list entry
521 Irp
= (PIRP
)CONTAINING_RECORD(CurEntry
, IRP
, Tail
.Overlay
.ListEntry
);
523 // HACK get stream header
524 StreamHeader
= (PKSSTREAM_HEADER
)Irp
->Tail
.Overlay
.DriverContext
[2];
526 // driver must release items in the same order
527 PC_ASSERT(Irp
->Tail
.Overlay
.DriverContext
[3] == Tag
);
529 // irp has been processed completly
530 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
532 // frame extend contains the original request size, DataUsed contains the real buffer size
533 // is different when kmixer performs channel conversion, upsampling etc
535 Irp
->IoStatus
.Information
= StreamHeader
->FrameExtent
;
537 // free stream header, no tag as wdmaud.drv allocates it atm
538 ExFreePool(StreamHeader
);
540 // complete the request
541 IoCompleteRequest(Irp
, IO_SOUND_INCREMENT
);
543 return STATUS_SUCCESS
;
548 CIrpQueue::HasLastMappingFailed()
550 return m_OutOfMapping
;
555 CIrpQueue::PrintQueueStatus()
562 CIrpQueue::SetMinimumDataThreshold(
563 ULONG MinimumDataThreshold
)
566 m_MinimumDataThreshold
= MinimumDataThreshold
;
571 CIrpQueue::GetMinimumDataThreshold()
573 return m_MinimumDataThreshold
;
580 IN IIrpQueue
**Queue
)
582 CIrpQueue
*This
= new(NonPagedPool
, TAG_PORTCLASS
)CIrpQueue(NULL
);
584 return STATUS_INSUFFICIENT_RESOURCES
;
588 *Queue
= (IIrpQueue
*)This
;
589 return STATUS_SUCCESS
;