| 1 | /* $Id$ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * HDAStreamPeriod.h - Stream period functions for HD Audio.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2017 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | */
|
|---|
| 17 |
|
|---|
| 18 | #ifndef HDA_STREAMPERIOD_H
|
|---|
| 19 | #define HDA_STREAMPERIOD_H
|
|---|
| 20 |
|
|---|
| 21 | #include <iprt/critsect.h>
|
|---|
| 22 | #ifdef DEBUG
|
|---|
| 23 | # include <iprt/time.h>
|
|---|
| 24 | #endif
|
|---|
| 25 |
|
|---|
| 26 | struct HDASTREAM;
|
|---|
| 27 | typedef HDASTREAM *PHDASTREAM;
|
|---|
| 28 |
|
|---|
| 29 | #ifdef DEBUG
|
|---|
| 30 | /**
|
|---|
| 31 | * Structure for debug information of an HDA stream's period.
|
|---|
| 32 | */
|
|---|
| 33 | typedef struct HDASTREAMPERIODDBGINFO
|
|---|
| 34 | {
|
|---|
| 35 | /** Host start time (in ns) of the period. */
|
|---|
| 36 | uint64_t tsStartNs;
|
|---|
| 37 | } HDASTREAMPERIODDBGINFO, *PHDASTREAMPERIODDBGINFO;
|
|---|
| 38 | #endif
|
|---|
| 39 |
|
|---|
| 40 | /** No flags set. */
|
|---|
| 41 | #define HDASTREAMPERIOD_FLAG_NONE 0
|
|---|
| 42 | /** The stream period has been initialized and is in a valid state. */
|
|---|
| 43 | #define HDASTREAMPERIOD_FLAG_VALID RT_BIT(0)
|
|---|
| 44 | /** The stream period is active. */
|
|---|
| 45 | #define HDASTREAMPERIOD_FLAG_ACTIVE RT_BIT(1)
|
|---|
| 46 |
|
|---|
| 47 | /**
|
|---|
| 48 | * Structure for keeping an HDA stream's (time) period.
|
|---|
| 49 | * This is needed in order to keep track of stream timing and interrupt delivery.
|
|---|
| 50 | */
|
|---|
| 51 | typedef struct HDASTREAMPERIOD
|
|---|
| 52 | {
|
|---|
| 53 | /** Associated HDA stream descriptor (SD) number. */
|
|---|
| 54 | uint8_t u8SD;
|
|---|
| 55 | /** The period's status flags. */
|
|---|
| 56 | uint8_t fStatus;
|
|---|
| 57 | uint8_t Padding1[6];
|
|---|
| 58 | /** Critical section for serializing access. */
|
|---|
| 59 | RTCRITSECT CritSect;
|
|---|
| 60 | uint32_t Padding2[1];
|
|---|
| 61 | /** Hertz (Hz) rate this period runs with. */
|
|---|
| 62 | uint32_t u32Hz;
|
|---|
| 63 | /** Period start time (in wall clock counts). */
|
|---|
| 64 | uint64_t u64StartWalClk;
|
|---|
| 65 | /** Period duration (in wall clock counts). */
|
|---|
| 66 | uint64_t u64DurationWalClk;
|
|---|
| 67 | /** The period's (relative) elapsed time (in wall clock counts). */
|
|---|
| 68 | uint64_t u64ElapsedWalClk;
|
|---|
| 69 | /** Delay (in wall clock counts) for tweaking the period timing. Optional. */
|
|---|
| 70 | int64_t i64DelayWalClk;
|
|---|
| 71 | /** Number of audio frames to transfer for this period. */
|
|---|
| 72 | uint32_t framesToTransfer;
|
|---|
| 73 | /** Number of audio frames already transfered. */
|
|---|
| 74 | uint32_t framesTransferred;
|
|---|
| 75 | /** Number of pending interrupts required for this period. */
|
|---|
| 76 | uint8_t cIntPending;
|
|---|
| 77 | uint8_t Padding3[7];
|
|---|
| 78 | #ifdef DEBUG
|
|---|
| 79 | /** Debugging information. */
|
|---|
| 80 | HDASTREAMPERIODDBGINFO Dbg;
|
|---|
| 81 | #endif
|
|---|
| 82 | } HDASTREAMPERIOD, *PHDASTREAMPERIOD;
|
|---|
| 83 |
|
|---|
| 84 | #ifdef IN_RING3
|
|---|
| 85 | int hdaStreamPeriodCreate(PHDASTREAMPERIOD pPeriod);
|
|---|
| 86 | void hdaStreamPeriodDestroy(PHDASTREAMPERIOD pPeriod);
|
|---|
| 87 | void hdaStreamPeriodInit(PHDASTREAMPERIOD pPeriod, uint8_t u8SD, uint16_t u16LVI, uint32_t u32CBL, PPDMAUDIOSTREAMCFG pStreamCfg);
|
|---|
| 88 | void hdaStreamPeriodReset(PHDASTREAMPERIOD pPeriod);
|
|---|
| 89 | int hdaStreamPeriodBegin(PHDASTREAMPERIOD pPeriod, uint64_t u64WalClk);
|
|---|
| 90 | void hdaStreamPeriodEnd(PHDASTREAMPERIOD pPeriod);
|
|---|
| 91 | void hdaStreamPeriodPause(PHDASTREAMPERIOD pPeriod);
|
|---|
| 92 | void hdaStreamPeriodResume(PHDASTREAMPERIOD pPeriod);
|
|---|
| 93 | bool hdaStreamPeriodLock(PHDASTREAMPERIOD pPeriod);
|
|---|
| 94 | void hdaStreamPeriodUnlock(PHDASTREAMPERIOD pPeriod);
|
|---|
| 95 | uint64_t hdaStreamPeriodFramesToWalClk(PHDASTREAMPERIOD pPeriod, uint32_t uFrames);
|
|---|
| 96 | uint64_t hdaStreamPeriodGetAbsEndWalClk(PHDASTREAMPERIOD pPeriod);
|
|---|
| 97 | uint64_t hdaStreamPeriodGetAbsElapsedWalClk(PHDASTREAMPERIOD pPeriod);
|
|---|
| 98 | uint32_t hdaStreamPeriodGetRemainingFrames(PHDASTREAMPERIOD pPeriod);
|
|---|
| 99 | bool hdaStreamPeriodHasElapsed(PHDASTREAMPERIOD pPeriod);
|
|---|
| 100 | bool hdaStreamPeriodHasPassedAbsWalClk(PHDASTREAMPERIOD pPeriod, uint64_t u64WalClk);
|
|---|
| 101 | bool hdaStreamPeriodNeedsInterrupt(PHDASTREAMPERIOD pPeriod);
|
|---|
| 102 | void hdaStreamPeriodAcquireInterrupt(PHDASTREAMPERIOD pPeriod);
|
|---|
| 103 | void hdaStreamPeriodReleaseInterrupt(PHDASTREAMPERIOD pPeriod);
|
|---|
| 104 | void hdaStreamPeriodInc(PHDASTREAMPERIOD pPeriod, uint32_t framesInc);
|
|---|
| 105 | bool hdaStreamPeriodIsComplete(PHDASTREAMPERIOD pPeriod);
|
|---|
| 106 | #endif /* IN_RING3 */
|
|---|
| 107 |
|
|---|
| 108 | #endif /* !HDA_STREAMPERIOD_H */
|
|---|
| 109 |
|
|---|
