Changeset 81890 in vbox for trunk/src/VBox/Devices/Storage/DevAHCI.cpp

Timestamp:

Nov 16, 2019 1:26:10 AM (5 years ago)

Author:

vboxsync

Message:

DevAHCI: Doxygen. bugref:9218

File:

• trunk/src/VBox/Devices/Storage/DevAHCI.cpp (modified) (18 diffs)

trunk/src/VBox/Devices/Storage/DevAHCI.cpp

@@ -1043 +1043 @@
  * @returns nothing.
  * @param   pDevIns     The device instance.
- * @param   pAhciPort   The port to kick.
+ * @param   pAhciPort   The port to kick, shared bits.
  */
 static void ahciIoThreadKick(PPDMDEVINS pDevIns, PAHCIPORT pAhciPort)
@@ -2019 +2019 @@
  * Hardware reset used for machine power on and reset.
  *
- * @param pAhciPort     The port to reset.
+ * @param pAhciPort     The port to reset, shared bits.
  */
 static void ahciPortHwReset(PAHCIPORT pAhciPort)
@@ -2269 +2269 @@
 
 /**
- * @callback_method_impl{IOMMMIONEWWRITE}
+ * @callback_method_impl{FNIOMMMIONEWWRITE}
  */
 static DECLCALLBACK(VBOXSTRICTRC) ahciMMIORead(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS off, void *pv, unsigned cb)
@@ -2285 +2285 @@
 
 /**
- * @callback_method_impl{IOMMMIONEWWRITE}
+ * @callback_method_impl{FNIOMMMIONEWWRITE}
  */
 static DECLCALLBACK(VBOXSTRICTRC) ahciMMIOWrite(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS off, void const *pv, unsigned cb)
@@ -2527 +2527 @@
  *
  * @returns nothing
- * @param   pAhciPort     The port the command FIS was read from.
+ * @param   pAhciPort     The port the command FIS was read from (shared bits).
  * @param   cmdFis        The FIS to print info from.
  */
@@ -2609 +2609 @@
  *
  * @returns nothing
- * @param   pAhciPort   Pointer to the port the command header was read from.
+ * @param   pAhciPort   Pointer to the port the command header was read from
+ *                      (shared bits).
  * @param   pCmdHdr     The command header to print info from.
  */
@@ -2644 +2645 @@
  * @returns nothing
  * @param   pDevIns     The device instance.
- * @param   pAhciPort   Pointer to the port which "receives" the FIS.
+ * @param   pAhciPort   Pointer to the port which "receives" the FIS (shared bits).
  */
 static void ahciPostFirstD2HFisIntoMemory(PPDMDEVINS pDevIns, PAHCIPORT pAhciPort)
@@ -2687 +2688 @@
  * @returns VBox status code
  * @param   pDevIns     The device instance.
- * @param   pAhciPort  The port which "receives" the FIS.
+ * @param   pAhciPort  The port which "receives" the FIS(shared bits).
  * @param   uFisType   The type of the FIS.
  * @param   pCmdFis    Pointer to the FIS which is to be posted into memory.
@@ -2930 +2931 @@
  * @param   pDevIns     The device instance.
  * @param   pThis       The shared AHCI state.
- * @param   pAhciPort   The port the device is attached to, shared bits.
+ * @param   pAhciPort   The port the device is attached to, shared bits(shared
+ *                      bits).
  * @param   pAhciReq    The state to get the tag number from.
  */
@@ -2959 +2961 @@
  * @param   pDevIns     The device instance.
  * @param   pThis       The shared AHCI state.
- * @param   pAhciPort   The device to reset.
+ * @param   pAhciPort   The device to reset(shared bits).
  * @param   pAhciReq    The task state.
  */
@@ -2981 +2983 @@
  * @param   pDevIns     The device instance.
  * @param   pThis       The shared AHCI state.
- * @param   pAhciPort   The port of the SATA controller.
+ * @param   pAhciPort   The port of the SATA controller (shared bits).
  * @param   cbTransfer  Transfer size of the request.
  * @param   pCmdFis     Pointer to the command FIS from the guest.
@@ -3049 +3051 @@
  * @param   pDevIns     The device instance.
  * @param   pThis       The shared AHCI state.
- * @param   pAhciPort   The port of the SATA controller.
+ * @param   pAhciPort   The port of the SATA controller (shared bits).
  * @param   uTag        The tag of the request.
  * @param   pCmdFis     Pointer to the command FIS from the guest.
@@ -3423 +3425 @@
  * @returns VBox status code.
  * @param   pDevIns     The device instance.
- * @param   pThis       The AHCI controller device instance.
  * @param   pAhciReq    AHCI request structure.
  * @param   pcbPrdt     Where to store the size of the guest buffer.
@@ -3472 +3473 @@
  * @returns VBox status code.
  * @param   pDevIns         The device instance.
- * @param   pAhciPort       AHCI port state.
+ * @param   pAhciPort       AHCI port state, shared bits.
  * @param   pAhciReq        The request handling the TRIM request.
  * @param   idxRangeStart   Index of the first range to start copying.
@@ -3573 +3574 @@
  *
  * @returns nothing.
- * @param   pAhciPort   The AHCI port, shared bits.
  * @param   pAhciPortR3 The AHCI port, ring-3 bits.
  * @param   pAhciReq    The request to free.
@@ -4252 +4252 @@
  * @param   pDevIns     The device instance.
  * @param   pThis       The shared AHCI state.
- * @param   pAhciPort   The AHCI port of the request.
+ * @param   pAhciPort   The AHCI port of the request, shared bits.
  * @param   pAhciReq    The state of the actual task.
  */
@@ -4347 +4347 @@
  * @param   pThis       The shared AHCI state.
  * @param   pThisCC     The ring-3 AHCI state.
- * @param   pAhciPort   The port the request is for.
+ * @param   pAhciPort   The port the request is for, shared bits.
+ * @param   pAhciPortR3 The port the request is for, ring-3 bits.
  * @param   pAhciReq    The request to submit.
  * @param   enmType     The request type.
@@ -4424 +4425 @@
  * @param   pDevIns     The device instance.
  * @param   pThis       The shared AHCI state.
- * @param   pAhciPort   The AHCI port the request is for.
+ * @param   pAhciPort   The AHCI port the request is for, shared bits.
  * @param   pAhciReq    Request structure to copy the command to.
  */