Changeset 67855 in vbox for trunk/src/VBox/Devices/Audio

Timestamp:

Jul 7, 2017 2:45:37 PM (8 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

116811

Message:

Audio/DevHDA.cpp: Docs.

File:

• trunk/src/VBox/Devices/Audio/DevHDA.cpp (modified) (9 diffs)

trunk/src/VBox/Devices/Audio/DevHDA.cpp

@@ -1481 +1481 @@
 
 #ifndef DEBUG
+/**
+ * Processes (de/asserts) the interrupt according to the HDA's current state.
+ *
+ * @returns IPRT status code.
+ * @param   pThis               HDA state.
+ */
 static int hdaProcessInterrupt(PHDASTATE pThis)
 #else
+/**
+ * Processes (de/asserts) the interrupt according to the HDA's current state.
+ * Debug version.
+ *
+ * @returns IPRT status code.
+ * @param   pThis               HDA state.
+ * @param   pszSource           Caller information.
+ */
 static int hdaProcessInterrupt(PHDASTATE pThis, const char *pszSource)
 #endif
@@ -1716 +1730 @@
 
 #ifdef IN_RING3
-
+/**
+ * Synchronizes the CORB / RIRB buffers between internal <-> device state.
+ *
+ * @returns IPRT status code.
+ * @param   pThis               HDA state.
+ * @param   fLocal              Specify true to synchronize HDA state's CORB buffer with the device state,
+ *                              or false to synchronize the device state's RIRB buffer with the HDA state.
+ *
+ * @todo r=andy Break this up into two functions?
+ */
 static int hdaCmdSync(PHDASTATE pThis, bool fLocal)
 {
@@ -1780 +1803 @@
 }
 
+/**
+ * Processes the next CORB buffer command in the queue.
+ * This will invoke the HDA codec verb dispatcher.
+ *
+ * @returns IPRT status code.
+ * @param   pThis               HDA state.
+ */
 static int hdaCORBCmdProcess(PHDASTATE pThis)
 {
@@ -1849 +1879 @@
 }
 
+/**
+ * Creates an HDA stream.
+ *
+ * @returns IPRT status code.
+ * @param   pStream             HDA stream to create.
+ * @param   pThis               HDA state to assign the HDA stream to.
+ */
 static int hdaStreamCreate(PHDASTREAM pStream, PHDASTATE pThis)
 {
@@ -1879 +1916 @@
 }
 
+/**
+ * Destroys an HDA stream.
+ *
+ * @param   pStream             HDA stream to destroy.
+ */
 static void hdaStreamDestroy(PHDASTREAM pStream)
 {
@@ -1915 +1957 @@
 }
 
+/**
+ * Initializes an HDA stream.
+ *
+ * @returns IPRT status code.
+ * @param   pStream             HDA stream to initialize.
+ * @param   uSD                 SD (stream descriptor) number to assign the HDA stream to.
+ */
 static int hdaStreamInit(PHDASTREAM pStream, uint8_t uSD)
 {
@@ -3628 +3677 @@
 }
 
-
+/**
+ * Increases the amount of transferred (audio) data of an HDA stream and
+ * reports this as needed to the guest.
+ *
+ * @param  pStream              HDA stream to increase amount for.
+ * @param  cbInc                Amount (in bytes) to increase.
+ */
 DECLINLINE(void) hdaStreamTransferInc(PHDASTREAM pStream, uint32_t cbInc)
 {
@@ -3645 +3700 @@
     hdaStreamUpdateLPIB(pStream, u32LPIB + cbInc);
 }
-
 
 /**
@@ -3691 +3745 @@
 }
 
+/**
+ * Adds audio streams of all attached LUNs to a given HDA audio mixer sink.
+ *
+ * @returns IPRT status code.
+ * @param   pThis               HDA state.
+ * @param   pSink               HDA mixer sink to add audio streams to.
+ * @param   pCfg                Audio stream configuration to use for the audio streams to add.
+ */
 static DECLCALLBACK(int) hdaMixerAddStream(PHDASTATE pThis, PHDAMIXERSINK pSink, PPDMAUDIOSTREAMCFG pCfg)
 {