reactos/drivers/wdm/audio/backpln/portcls/irpstream.cpp

   1 /*
   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
   7  */
   8
   9 #include "private.hpp"
  10
  11
  12 class CIrpQueue : public IIrpQueue
  13 {
  14 public:
  15     STDMETHODIMP QueryInterface( REFIID InterfaceId, PVOID* Interface);
  16
  17     STDMETHODIMP_(ULONG) AddRef()
  18     {
  19         InterlockedIncrement(&m_Ref);
  20         return m_Ref;
  21     }
  22     STDMETHODIMP_(ULONG) Release()
  23     {
  24         InterlockedDecrement(&m_Ref);
  25
  26         if (!m_Ref)
  27         {
  28             delete this;
  29             return 0;
  30         }
  31         return m_Ref;
  32     }
  33     IMP_IIrpQueue;
  34     CIrpQueue(IUnknown *OuterUnknown){}
  35     virtual ~CIrpQueue(){}
  36
  37 protected:
  38     volatile ULONG m_CurrentOffset;
  39     LONG m_NumMappings;
  40     ULONG m_NumDataAvailable;
  41     BOOL m_StartStream;
  42     PKSPIN_CONNECT m_ConnectDetails;
  43     PKSDATAFORMAT_WAVEFORMATEX m_DataFormat;
  44
  45     KSPIN_LOCK m_IrpListLock;
  46     LIST_ENTRY m_IrpList;
  47     LIST_ENTRY m_FreeIrpList;
  48     PIRP m_Irp;
  49     PVOID m_SilenceBuffer;
  50
  51     ULONG m_OutOfMapping;
  52     ULONG m_MaxFrameSize;
  53     ULONG m_Alignment;
  54     ULONG m_MinimumDataThreshold;
  55
  56     LONG m_Ref;
  57
  58 };
  59
  60 #define OFFSET_HEADERINDEX  (0)
  61 #define OFFSET_STREAMHEADER (2)
  62 #define OFFSET_HEADERCOUNT  (3)
  63
  64
  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])
  68
  69
  70 NTSTATUS
  71 NTAPI
  72 CIrpQueue::QueryInterface(
  73     IN  REFIID refiid,
  74     OUT PVOID* Output)
  75 {
  76     if (IsEqualGUIDAligned(refiid, IID_IUnknown))
  77     {
  78         *Output = PVOID(PUNKNOWN(this));
  79         PUNKNOWN(*Output)->AddRef();
  80         return STATUS_SUCCESS;
  81     }
  82
  83     return STATUS_UNSUCCESSFUL;
  84 }
  85
  86 NTSTATUS
  87 NTAPI
  88 CIrpQueue::Init(
  89     IN KSPIN_CONNECT *ConnectDetails,
  90     IN PKSDATAFORMAT DataFormat,
  91     IN PDEVICE_OBJECT DeviceObject,
  92     IN ULONG FrameSize,
  93     IN ULONG Alignment,
  94     IN PVOID SilenceBuffer)
  95 {
  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;
 102
 103     InitializeListHead(&m_IrpList);
 104     InitializeListHead(&m_FreeIrpList);
 105     KeInitializeSpinLock(&m_IrpListLock);
 106
 107     return STATUS_SUCCESS;
 108 }
 109
 110 NTSTATUS
 111 NTAPI
 112 CIrpQueue::AddMapping(
 113     IN PIRP Irp,
 114     OUT PULONG Data)
 115 {
 116     PKSSTREAM_HEADER Header;
 117     NTSTATUS Status = STATUS_SUCCESS;
 118     PIO_STACK_LOCATION IoStack;
 119     ULONG NumHeaders, NumData, Index;
 120     PMDL Mdl;
 121
 122     PC_ASSERT(KeGetCurrentIrql() == PASSIVE_LEVEL);
 123
 124     // get current irp stack location
 125     IoStack = IoGetCurrentIrpStackLocation(Irp);
 126
 127     if (!Irp->MdlAddress)
 128     {
 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);
 136         else
 137             PC_ASSERT(0);
 138
 139         // check for success
 140         if (!NT_SUCCESS(Status))
 141         {
 142             DPRINT("KsProbeStreamIrp failed with %x\n", Status);
 143             return Status;
 144         }
 145     }
 146
 147     // get first stream header
 148
 149    if (Irp->RequestorMode == UserMode)
 150        Header = (PKSSTREAM_HEADER)Irp->AssociatedIrp.SystemBuffer;
 151    else
 152        Header = (PKSSTREAM_HEADER)Irp->UserBuffer;
 153
 154     // sanity check
 155     PC_ASSERT(Header);
 156
 157     // calculate num headers
 158     NumHeaders = IoStack->Parameters.DeviceIoControl.OutputBufferLength / Header->Size;
 159
 160     // assume headers of same length
 161     PC_ASSERT(IoStack->Parameters.DeviceIoControl.OutputBufferLength % Header->Size == 0);
 162
 163
 164     // get first audio buffer
 165     Mdl = Irp->MdlAddress;
 166     // sanity check
 167     PC_ASSERT(Mdl);
 168
 169     // store the current stream header
 170     Irp->Tail.Overlay.DriverContext[OFFSET_STREAMHEADER] = (PVOID)Header;
 171     // store header count
 172     Irp->Tail.Overlay.DriverContext[OFFSET_HEADERCOUNT] = UlongToPtr(NumHeaders);
 173
 174     // store current header index
 175     Irp->Tail.Overlay.DriverContext[OFFSET_HEADERINDEX] = UlongToPtr(0);
 176
 177     NumData = 0;
 178     // prepare all headers
 179     for(Index = 0; Index < NumHeaders; Index++)
 180     {
 181         // sanity checks
 182         PC_ASSERT(Header);
 183         PC_ASSERT(Mdl);
 184
 185         if (Irp->RequestorMode == UserMode)
 186         {
 187             Header->Data = MmGetSystemAddressForMdlSafe(Mdl, NormalPagePriority);
 188         }
 189
 190         if (!Header->Data)
 191         {
 192             // insufficient resources
 193             ExFreePool(Irp->AssociatedIrp.SystemBuffer);
 194             Irp->AssociatedIrp.SystemBuffer = NULL;
 195             // complete and forget request
 196             Irp->IoStatus.Status = STATUS_INSUFFICIENT_RESOURCES;
 197             Irp->IoStatus.Information = 0;
 198
 199             IoCompleteRequest(Irp, IO_NO_INCREMENT);
 200             return STATUS_INSUFFICIENT_RESOURCES;
 201         }
 202
 203         // increment num mappings
 204         InterlockedIncrement(&m_NumMappings);
 205
 206         // increment available data
 207         InterlockedExchangeAdd((PLONG)&m_NumDataAvailable,
 208                                       (max(Header->DataUsed, Header->FrameExtent)));
 209
 210         NumData += max(Header->DataUsed, Header->FrameExtent);
 211
 212         // move to next header
 213         Header = (PKSSTREAM_HEADER)((ULONG_PTR)Header + Header->Size);
 214
 215         // move to next mdl
 216         Mdl = Mdl->Next;
 217     }
 218
 219     DPRINT("StreamHeaders %u NumData %u FrameSize %u NumDataAvailable %u\n", NumHeaders, NumData, m_MaxFrameSize, m_NumDataAvailable);
 220     *Data = NumData;
 221
 222     // mark irp as pending
 223     IoMarkIrpPending(Irp);
 224
 225     // add irp to cancelable queue
 226     KsAddIrpToCancelableQueue(&m_IrpList, &m_IrpListLock, Irp, KsListEntryTail, NULL);
 227
 228     // done
 229     return Status;
 230 }
 231
 232 NTSTATUS
 233 NTAPI
 234 CIrpQueue::GetMapping(
 235     OUT PUCHAR * Buffer,
 236     OUT PULONG BufferSize)
 237 {
 238     PIRP Irp;
 239     ULONG Offset;
 240     //PIO_STACK_LOCATION IoStack;
 241     PKSSTREAM_HEADER StreamHeader;
 242
 243     // check if there is an irp in the partially processed
 244     if (m_Irp)
 245     {
 246         // use last irp
 247         if (m_Irp->Cancel == FALSE)
 248         {
 249             Irp = m_Irp;
 250             Offset = m_CurrentOffset;
 251         }
 252         else
 253         {
 254             // irp has been cancelled
 255             m_Irp->IoStatus.Status = STATUS_CANCELLED;
 256             IoCompleteRequest(m_Irp, IO_NO_INCREMENT);
 257             m_Irp = Irp = NULL;
 258         }
 259     }
 260     else
 261     {
 262         // get a fresh new irp from the queue
 263         m_Irp = Irp = KsRemoveIrpFromCancelableQueue(&m_IrpList, &m_IrpListLock, KsListEntryHead, KsAcquireAndRemoveOnlySingleItem);
 264         m_CurrentOffset = Offset = 0;
 265     }
 266
 267     if (!Irp)
 268     {
 269         DPRINT("NoIrp\n");
 270         // no irp available, use silence buffer
 271         *Buffer = (PUCHAR)m_SilenceBuffer;
 272         *BufferSize = m_MaxFrameSize;
 273         // flag for port wave pci driver
 274         m_OutOfMapping = TRUE;
 275         // indicate flag to restart fast buffering
 276         m_StartStream = FALSE;
 277         return STATUS_SUCCESS;
 278     }
 279
 280     // get stream header
 281     StreamHeader = (PKSSTREAM_HEADER)Irp->Tail.Overlay.DriverContext[2];
 282
 283     // sanity check
 284     PC_ASSERT(StreamHeader);
 285
 286     // store buffersize
 287     if (StreamHeader->DataUsed)
 288         *BufferSize = StreamHeader->DataUsed - Offset;
 289     else
 290         *BufferSize = StreamHeader->FrameExtent - Offset;
 291
 292     PC_ASSERT(*BufferSize);
 293
 294     // store buffer
 295     *Buffer = &((PUCHAR)StreamHeader->Data)[Offset];
 296
 297     // unset flag that no irps are available
 298     m_OutOfMapping = FALSE;
 299
 300     return STATUS_SUCCESS;
 301 }
 302
 303 VOID
 304 NTAPI
 305 CIrpQueue::UpdateMapping(
 306     IN ULONG BytesWritten)
 307 {
 308     PKSSTREAM_HEADER StreamHeader;
 309     ULONG Size, NumData, Index;
 310
 311     if (!m_Irp)
 312     {
 313         // silence buffer was used
 314         return;
 315     }
 316
 317     // get stream header
 318     StreamHeader = (PKSSTREAM_HEADER)STREAMHEADER_CURRENT(m_Irp);
 319
 320     // sanity check
 321    // ASSERT(StreamHeader);
 322
 323     // add to current offset
 324     InterlockedExchangeAdd((volatile PLONG)&m_CurrentOffset, (LONG)BytesWritten);
 325
 326     // decrement available data counter
 327     m_NumDataAvailable -= BytesWritten;
 328
 329     if (StreamHeader->DataUsed)
 330         Size = StreamHeader->DataUsed;
 331     else
 332         Size = StreamHeader->FrameExtent;
 333
 334     PC_ASSERT(Size);
 335
 336     if (m_CurrentOffset >= Size)
 337     {
 338         if (STREAMHEADER_INDEX(m_Irp) + 1 < STREAMHEADER_COUNT(m_Irp))
 339         {
 340             // the irp has at least one more stream header
 341             m_Irp->Tail.Overlay.DriverContext[OFFSET_HEADERINDEX] = UlongToPtr(STREAMHEADER_INDEX(m_Irp) + 1);
 342
 343             // get next stream header
 344             StreamHeader = (PKSSTREAM_HEADER)((ULONG_PTR)StreamHeader + StreamHeader->Size);
 345
 346             // store next stream header
 347             STREAMHEADER_CURRENT(m_Irp) = (PVOID)StreamHeader;
 348
 349             // reset current offset
 350             m_CurrentOffset = 0;
 351
 352             // done
 353             return;
 354         }
 355
 356        // irp has been processed completly
 357
 358         NumData = 0;
 359         if (m_Irp->RequestorMode == KernelMode)
 360             StreamHeader = (PKSSTREAM_HEADER)m_Irp->UserBuffer;
 361         else
 362             StreamHeader = (PKSSTREAM_HEADER)m_Irp->AssociatedIrp.SystemBuffer;
 363
 364         // loop all stream headers
 365         for(Index = 0; Index < STREAMHEADER_COUNT(m_Irp); Index++)
 366         {
 367             PC_ASSERT(StreamHeader);
 368
 369             // add size of buffer
 370             // depends on if the buffer is input / output
 371             if (StreamHeader->DataUsed)
 372                 Size = StreamHeader->DataUsed;
 373             else
 374                 Size = StreamHeader->FrameExtent;
 375
 376             // increment size
 377             NumData += Size;
 378
 379             // get next stream header
 380             StreamHeader = (PKSSTREAM_HEADER)((ULONG_PTR)StreamHeader + StreamHeader->Size);
 381         }
 382
 383         if (m_ConnectDetails->Interface.Id == KSINTERFACE_STANDARD_LOOPED_STREAMING)
 384         {
 385             // looped streaming repeat the buffers untill
 386             // the caller decides to stop the streams
 387
 388             // reset stream header index
 389             m_Irp->Tail.Overlay.DriverContext[OFFSET_HEADERINDEX] = UlongToPtr(0);
 390             // re-insert irp
 391             KsAddIrpToCancelableQueue(&m_IrpList, &m_IrpListLock, m_Irp, KsListEntryTail, NULL);
 392             // clear current irp
 393             m_Irp = NULL;
 394             // reset offset
 395             m_CurrentOffset = 0;
 396             // increment available data
 397             InterlockedExchangeAdd((PLONG)&m_NumDataAvailable, NumData);
 398             // done
 399             return;
 400         }
 401
 402         m_Irp->IoStatus.Status = STATUS_SUCCESS;
 403         m_Irp->IoStatus.Information = NumData;
 404
 405         // complete the request
 406         IoCompleteRequest(m_Irp, IO_SOUND_INCREMENT);
 407         // remove irp as it is complete
 408         m_Irp = NULL;
 409         m_CurrentOffset = 0;
 410     }
 411 }
 412
 413 ULONG
 414 NTAPI
 415 CIrpQueue::NumMappings()
 416 {
 417
 418     // returns the amount of mappings available
 419     return m_NumMappings;
 420 }
 421
 422 ULONG
 423 NTAPI
 424 CIrpQueue::NumData()
 425 {
 426     // returns the amount of audio stream data available
 427     return m_NumDataAvailable;
 428 }
 429
 430
 431 BOOL
 432 NTAPI
 433 CIrpQueue::MinimumDataAvailable()
 434 {
 435     BOOL Result;
 436
 437     if (m_StartStream)
 438         return TRUE;
 439
 440     if (m_MinimumDataThreshold < m_NumDataAvailable)
 441     {
 442         m_StartStream = TRUE;
 443         Result = TRUE;
 444     }
 445     else
 446     {
 447         Result = FALSE;
 448     }
 449     return Result;
 450 }
 451
 452 BOOL
 453 NTAPI
 454 CIrpQueue::CancelBuffers()
 455 {
 456     // is there an active irp
 457     if (m_Irp)
 458     {
 459         // re-insert it to cancelable queue
 460         KsAddIrpToCancelableQueue(&m_IrpList, &m_IrpListLock, m_Irp, KsListEntryTail, NULL);
 461         //set it to zero
 462         m_Irp = NULL;
 463     }
 464
 465     // cancel all irps
 466     KsCancelIo(&m_IrpList, &m_IrpListLock);
 467     // reset stream start flag
 468     m_StartStream = FALSE;
 469     // reset number of mappings
 470     m_NumMappings = 0;
 471     // reset number of data available
 472     m_NumDataAvailable = 0;
 473
 474     // done
 475     return TRUE;
 476 }
 477
 478 VOID
 479 NTAPI
 480 CIrpQueue::UpdateFormat(
 481     PKSDATAFORMAT DataFormat)
 482 {
 483     m_DataFormat = (PKSDATAFORMAT_WAVEFORMATEX)DataFormat;
 484     m_MinimumDataThreshold = m_DataFormat->WaveFormatEx.nAvgBytesPerSec / 3;
 485     m_StartStream = FALSE;
 486     m_NumDataAvailable = 0;
 487 }
 488
 489 NTSTATUS
 490 NTAPI
 491 CIrpQueue::GetMappingWithTag(
 492     IN PVOID Tag,
 493     OUT PPHYSICAL_ADDRESS  PhysicalAddress,
 494     OUT PVOID  *VirtualAddress,
 495     OUT PULONG  ByteCount,
 496     OUT PULONG  Flags)
 497 {
 498     PKSSTREAM_HEADER StreamHeader;
 499     PIRP Irp;
 500
 501     *Flags = 0;
 502     PC_ASSERT(Tag != NULL);
 503
 504     // get an irp from the queue
 505     Irp = KsRemoveIrpFromCancelableQueue(&m_IrpList, &m_IrpListLock, KsListEntryHead, KsAcquireAndRemoveOnlySingleItem);
 506
 507     // check if there is an irp
 508     if (!Irp)
 509     {
 510         // no irp available
 511         m_OutOfMapping = TRUE;
 512         m_StartStream = FALSE;
 513         return STATUS_UNSUCCESSFUL;
 514     }
 515
 516     //FIXME support more than one stream header
 517     PC_ASSERT(STREAMHEADER_COUNT(Irp) == 1);
 518
 519     // HACK get stream header
 520     StreamHeader = (PKSSTREAM_HEADER)Irp->Tail.Overlay.DriverContext[2];
 521
 522     // store mapping in the free list
 523     ExInterlockedInsertTailList(&m_FreeIrpList, &Irp->Tail.Overlay.ListEntry, &m_IrpListLock);
 524
 525     // return mapping
 526     *PhysicalAddress = MmGetPhysicalAddress(StreamHeader->Data);
 527     *VirtualAddress = StreamHeader->Data;
 528     *ByteCount = StreamHeader->DataUsed;
 529
 530     // decrement mapping count
 531     InterlockedDecrement(&m_NumMappings);
 532     // decrement num data available
 533     m_NumDataAvailable -= StreamHeader->DataUsed;
 534
 535     // store tag in irp
 536     Irp->Tail.Overlay.DriverContext[3] = Tag;
 537
 538     // done
 539     return STATUS_SUCCESS;
 540 }
 541
 542 NTSTATUS
 543 NTAPI
 544 CIrpQueue::ReleaseMappingWithTag(
 545     IN PVOID Tag)
 546 {
 547     PIRP Irp;
 548     PLIST_ENTRY CurEntry;
 549     PKSSTREAM_HEADER StreamHeader;
 550
 551     DPRINT("CIrpQueue::ReleaseMappingWithTag Tag %p\n", Tag);
 552
 553     // remove irp from used list
 554     CurEntry = ExInterlockedRemoveHeadList(&m_FreeIrpList, &m_IrpListLock);
 555     // sanity check
 556     PC_ASSERT(CurEntry);
 557
 558     // get irp from list entry
 559     Irp = (PIRP)CONTAINING_RECORD(CurEntry, IRP, Tail.Overlay.ListEntry);
 560
 561     // HACK get stream header
 562     StreamHeader = (PKSSTREAM_HEADER)Irp->Tail.Overlay.DriverContext[2];
 563
 564     // driver must release items in the same order
 565     PC_ASSERT(Irp->Tail.Overlay.DriverContext[3] == Tag);
 566
 567     // irp has been processed completly
 568     Irp->IoStatus.Status = STATUS_SUCCESS;
 569
 570     // frame extend contains the original request size, DataUsed contains the real buffer size
 571     // is different when kmixer performs channel conversion, upsampling etc
 572
 573     Irp->IoStatus.Information = StreamHeader->FrameExtent;
 574
 575     // complete the request
 576     IoCompleteRequest(Irp, IO_SOUND_INCREMENT);
 577
 578     return STATUS_SUCCESS;
 579 }
 580
 581 BOOL
 582 NTAPI
 583 CIrpQueue::HasLastMappingFailed()
 584 {
 585     return m_OutOfMapping;
 586 }
 587
 588 ULONG
 589 NTAPI
 590 CIrpQueue::GetCurrentIrpOffset()
 591 {
 592
 593     return m_CurrentOffset;
 594 }
 595
 596 VOID
 597 NTAPI
 598 CIrpQueue::SetMinimumDataThreshold(
 599     ULONG MinimumDataThreshold)
 600 {
 601
 602     m_MinimumDataThreshold = MinimumDataThreshold;
 603 }
 604
 605 ULONG
 606 NTAPI
 607 CIrpQueue::GetMinimumDataThreshold()
 608 {
 609     return m_MinimumDataThreshold;
 610 }
 611
 612
 613 NTSTATUS
 614 NTAPI
 615 NewIrpQueue(
 616     IN IIrpQueue **Queue)
 617 {
 618     CIrpQueue *This = new(NonPagedPool, TAG_PORTCLASS)CIrpQueue(NULL);
 619     if (!This)
 620         return STATUS_INSUFFICIENT_RESOURCES;
 621
 622     This->AddRef();
 623
 624     *Queue = (IIrpQueue*)This;
 625     return STATUS_SUCCESS;
 626 }
 627