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 PKSPIN_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(
116 PKSSTREAM_HEADER Header
;
117 NTSTATUS Status
= STATUS_SUCCESS
;
118 PIO_STACK_LOCATION IoStack
;
119 ULONG NumHeaders
, NumData
, Index
;
122 PC_ASSERT(KeGetCurrentIrql() == PASSIVE_LEVEL
);
124 // get current irp stack location
125 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
127 if (!Irp
->MdlAddress
)
129 // ioctl from KsStudio
130 // Wdmaud already probes buffers, therefore no need to probe it again
131 // probe the stream irp
132 if (IoStack
->Parameters
.DeviceIoControl
.IoControlCode
== IOCTL_KS_WRITE_STREAM
)
133 Status
= KsProbeStreamIrp(Irp
, KSSTREAM_WRITE
| KSPROBE_ALLOCATEMDL
| KSPROBE_PROBEANDLOCK
| KSPROBE_SYSTEMADDRESS
, 0);
134 else if (IoStack
->Parameters
.DeviceIoControl
.IoControlCode
== IOCTL_KS_READ_STREAM
)
135 Status
= KsProbeStreamIrp(Irp
, KSSTREAM_READ
| KSPROBE_ALLOCATEMDL
| KSPROBE_PROBEANDLOCK
| KSPROBE_SYSTEMADDRESS
, 0);
140 if (!NT_SUCCESS(Status
))
142 DPRINT("KsProbeStreamIrp failed with %x\n", Status
);
147 // get first stream header
148 Header
= (PKSSTREAM_HEADER
)Irp
->AssociatedIrp
.SystemBuffer
;
150 // calculate num headers
151 NumHeaders
= IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
/ Header
->Size
;
153 // assume headers of same length
154 PC_ASSERT(IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
% Header
->Size
== 0);
157 // get first audio buffer
158 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);
171 // prepare all headers
172 for(Index
= 0; Index
< NumHeaders
; Index
++)
178 Header
->Data
= MmGetSystemAddressForMdlSafe(Mdl
, NormalPagePriority
);
182 // insufficient resources
183 ExFreePool(Irp
->AssociatedIrp
.SystemBuffer
);
184 Irp
->AssociatedIrp
.SystemBuffer
= NULL
;
185 // complete and forget request
186 Irp
->IoStatus
.Status
= STATUS_INSUFFICIENT_RESOURCES
;
187 Irp
->IoStatus
.Information
= 0;
189 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
190 return STATUS_INSUFFICIENT_RESOURCES
;
193 // increment num mappings
194 InterlockedIncrement(&m_NumMappings
);
196 // increment available data
197 InterlockedExchangeAdd((PLONG
)&m_NumDataAvailable
,
198 (max(Header
->DataUsed
, Header
->FrameExtent
)));
200 NumData
+= max(Header
->DataUsed
, Header
->FrameExtent
);
202 // move to next header
203 Header
= (PKSSTREAM_HEADER
)((ULONG_PTR
)Header
+ Header
->Size
);
209 DPRINT("StreamHeaders %u NumData %u FrameSize %u NumDataAvailable %u\n", NumHeaders
, NumData
, m_MaxFrameSize
, m_NumDataAvailable
);
212 // mark irp as pending
213 IoMarkIrpPending(Irp
);
215 // add irp to cancelable queue
216 KsAddIrpToCancelableQueue(&m_IrpList
, &m_IrpListLock
, Irp
, KsListEntryTail
, NULL
);
224 CIrpQueue::GetMapping(
226 OUT PULONG BufferSize
)
230 //PIO_STACK_LOCATION IoStack;
231 PKSSTREAM_HEADER StreamHeader
;
233 // check if there is an irp in the partially processed
237 if (m_Irp
->Cancel
== FALSE
)
240 Offset
= m_CurrentOffset
;
244 // irp has been cancelled
245 m_Irp
->IoStatus
.Status
= STATUS_CANCELLED
;
246 IoCompleteRequest(m_Irp
, IO_NO_INCREMENT
);
252 // get a fresh new irp from the queue
253 m_Irp
= Irp
= KsRemoveIrpFromCancelableQueue(&m_IrpList
, &m_IrpListLock
, KsListEntryHead
, KsAcquireAndRemoveOnlySingleItem
);
254 m_CurrentOffset
= Offset
= 0;
260 return STATUS_UNSUCCESSFUL
;
261 // no irp available, use silence buffer
262 *Buffer
= (PUCHAR
)m_SilenceBuffer
;
263 *BufferSize
= m_MaxFrameSize
;
264 // flag for port wave pci driver
265 m_OutOfMapping
= TRUE
;
266 // indicate flag to restart fast buffering
267 m_StartStream
= FALSE
;
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 m_CurrentOffset
+= 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 StreamHeader
= (PKSSTREAM_HEADER
)m_Irp
->AssociatedIrp
.SystemBuffer
;
352 // loop all stream headers
353 for(Index
= 0; Index
< STREAMHEADER_COUNT(m_Irp
); Index
++)
355 PC_ASSERT(StreamHeader
);
357 // add size of buffer
358 // depends on if the buffer is input / output
359 if (StreamHeader
->DataUsed
)
360 Size
= StreamHeader
->DataUsed
;
362 Size
= StreamHeader
->FrameExtent
;
367 // get next stream header
368 StreamHeader
= (PKSSTREAM_HEADER
)((ULONG_PTR
)StreamHeader
+ StreamHeader
->Size
);
371 if (m_ConnectDetails
->Interface
.Id
== KSINTERFACE_STANDARD_LOOPED_STREAMING
)
373 // looped streaming repeat the buffers untill
374 // the caller decides to stop the streams
376 // reset stream header index
377 m_Irp
->Tail
.Overlay
.DriverContext
[OFFSET_HEADERINDEX
] = UlongToPtr(0);
379 KsAddIrpToCancelableQueue(&m_IrpList
, &m_IrpListLock
, m_Irp
, KsListEntryTail
, NULL
);
384 // increment available data
385 InterlockedExchangeAdd((PLONG
)&m_NumDataAvailable
, NumData
);
390 m_Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
391 m_Irp
->IoStatus
.Information
= NumData
;
393 // complete the request
394 IoCompleteRequest(m_Irp
, IO_SOUND_INCREMENT
);
395 // remove irp as it is complete
403 CIrpQueue::NumMappings()
406 // returns the amount of mappings available
407 return m_NumMappings
;
414 // returns the amount of audio stream data available
415 return m_NumDataAvailable
;
421 CIrpQueue::MinimumDataAvailable()
428 if (m_MinimumDataThreshold
< m_NumDataAvailable
)
430 m_StartStream
= TRUE
;
442 CIrpQueue::CancelBuffers()
445 m_StartStream
= FALSE
;
451 CIrpQueue::UpdateFormat(
452 PKSDATAFORMAT DataFormat
)
454 m_DataFormat
= (PKSDATAFORMAT_WAVEFORMATEX
)DataFormat
;
455 m_MinimumDataThreshold
= m_DataFormat
->WaveFormatEx
.nAvgBytesPerSec
/ 3;
456 m_StartStream
= FALSE
;
457 m_NumDataAvailable
= 0;
462 CIrpQueue::GetMappingWithTag(
464 OUT PPHYSICAL_ADDRESS PhysicalAddress
,
465 OUT PVOID
*VirtualAddress
,
466 OUT PULONG ByteCount
,
469 PKSSTREAM_HEADER StreamHeader
;
473 PC_ASSERT(Tag
!= NULL
);
475 // get an irp from the queue
476 Irp
= KsRemoveIrpFromCancelableQueue(&m_IrpList
, &m_IrpListLock
, KsListEntryHead
, KsAcquireAndRemoveOnlySingleItem
);
478 // check if there is an irp
482 m_OutOfMapping
= TRUE
;
483 m_StartStream
= FALSE
;
484 return STATUS_UNSUCCESSFUL
;
487 //FIXME support more than one stream header
488 PC_ASSERT(STREAMHEADER_COUNT(Irp
) == 1);
490 // HACK get stream header
491 StreamHeader
= (PKSSTREAM_HEADER
)Irp
->Tail
.Overlay
.DriverContext
[2];
493 // store mapping in the free list
494 ExInterlockedInsertTailList(&m_FreeIrpList
, &Irp
->Tail
.Overlay
.ListEntry
, &m_IrpListLock
);
497 *PhysicalAddress
= MmGetPhysicalAddress(StreamHeader
->Data
);
498 *VirtualAddress
= StreamHeader
->Data
;
499 *ByteCount
= StreamHeader
->DataUsed
;
501 // decrement mapping count
502 InterlockedDecrement(&m_NumMappings
);
503 // decrement num data available
504 m_NumDataAvailable
-= StreamHeader
->DataUsed
;
507 Irp
->Tail
.Overlay
.DriverContext
[3] = Tag
;
510 return STATUS_SUCCESS
;
515 CIrpQueue::ReleaseMappingWithTag(
519 PLIST_ENTRY CurEntry
;
520 PKSSTREAM_HEADER StreamHeader
;
522 DPRINT("CIrpQueue::ReleaseMappingWithTag Tag %p\n", Tag
);
524 // remove irp from used list
525 CurEntry
= ExInterlockedRemoveHeadList(&m_FreeIrpList
, &m_IrpListLock
);
529 // get irp from list entry
530 Irp
= (PIRP
)CONTAINING_RECORD(CurEntry
, IRP
, Tail
.Overlay
.ListEntry
);
532 // HACK get stream header
533 StreamHeader
= (PKSSTREAM_HEADER
)Irp
->Tail
.Overlay
.DriverContext
[2];
535 // driver must release items in the same order
536 PC_ASSERT(Irp
->Tail
.Overlay
.DriverContext
[3] == Tag
);
538 // irp has been processed completly
539 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
541 // frame extend contains the original request size, DataUsed contains the real buffer size
542 // is different when kmixer performs channel conversion, upsampling etc
544 Irp
->IoStatus
.Information
= StreamHeader
->FrameExtent
;
546 // free stream header, no tag as wdmaud.drv allocates it atm
547 ExFreePool(StreamHeader
);
549 // complete the request
550 IoCompleteRequest(Irp
, IO_SOUND_INCREMENT
);
552 return STATUS_SUCCESS
;
557 CIrpQueue::HasLastMappingFailed()
559 return m_OutOfMapping
;
564 CIrpQueue::PrintQueueStatus()
571 CIrpQueue::SetMinimumDataThreshold(
572 ULONG MinimumDataThreshold
)
575 m_MinimumDataThreshold
= MinimumDataThreshold
;
580 CIrpQueue::GetMinimumDataThreshold()
582 return m_MinimumDataThreshold
;
589 IN IIrpQueue
**Queue
)
591 CIrpQueue
*This
= new(NonPagedPool
, TAG_PORTCLASS
)CIrpQueue(NULL
);
593 return STATUS_INSUFFICIENT_RESOURCES
;
597 *Queue
= (IIrpQueue
*)This
;
598 return STATUS_SUCCESS
;