Changeset 71773 in vbox

Timestamp:

Apr 9, 2018 2:35:02 PM (7 years ago)

Author:

vboxsync

Message:

Msi: docs cleanups

Location:

trunk/src/VBox/Devices/Bus

Files:

• MsiCommon.cpp (modified) (4 diffs)
• MsiCommon.h (modified) (1 diff)
• MsixCommon.cpp (modified) (4 diffs)

trunk/src/VBox/Devices/Bus/MsiCommon.cpp

@@ -117 +117 @@
 }
 
+/**
+ * PCI config space accessors for MSI registers.
+ */
 void MsiR3PciConfigWrite(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev,
                          uint32_t u32Address, uint32_t val, unsigned len)
@@ -202 +205 @@
 }
 
+/**
+ * Initializes MSI support for the given PCI device.
+ */
 int MsiR3Init(PPDMPCIDEV pDev, PPDMMSIREG pMsiReg)
 {
@@ -266 +272 @@
 
 
+/**
+ * Checks if MSI is enabled for the given PCI device.
+ *
+ * (Must use MSINotify() for notifications when true.)
+ */
 bool MsiIsEnabled(PPDMPCIDEV pDev)
 {
@@ -271 +282 @@
 }
 
+/**
+ * Device notification (aka interrupt).
+ */
 void MsiNotify(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, int iVector, int iLevel, uint32_t uTagSrc)
 {

trunk/src/VBox/Devices/Bus/MsiCommon.h

@@ -16 +16 @@
  */
 
-/* Maybe belongs to types.h */
-#ifdef IN_RING3
-typedef PCPDMPCIHLPR3 PCPDMPCIHLP;
-#endif
+#ifndef ___MSI_COMMON_H___
+#define ___MSI_COMMON_H___
 
-#ifdef IN_RING0
-typedef PCPDMPCIHLPR0 PCPDMPCIHLP;
-#endif
-
-#ifdef IN_RC
-typedef PCPDMPCIHLPRC PCPDMPCIHLP;
-#endif
+typedef CTX_SUFF(PCPDMPCIHLP) PCPDMPCIHLP;
 
 #ifdef IN_RING3
-/* Init MSI support in the device. */
 int      MsiR3Init(PPDMPCIDEV pDev, PPDMMSIREG pMsiReg);
+void     MsiR3PciConfigWrite(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, uint32_t u32Address, uint32_t val, unsigned len);
 #endif
-
-/* If MSI is enabled, so that MSINotify() shall be used for notifications.  */
 bool     MsiIsEnabled(PPDMPCIDEV pDev);
-
-/* Device notification (aka interrupt). */
 void     MsiNotify(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, int iVector, int iLevel, uint32_t uTagSrc);
 
 #ifdef IN_RING3
-/* PCI config space accessors for MSI registers */
-void     MsiR3PciConfigWrite(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, uint32_t u32Address, uint32_t val, unsigned len);
+int      MsixR3Init(PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, PPDMMSIREG pMsiReg);
+void     MsixR3PciConfigWrite(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, uint32_t u32Address, uint32_t val, unsigned len);
+#endif
+bool     MsixIsEnabled(PPDMPCIDEV pDev);
+void     MsixNotify(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, int iVector, int iLevel, uint32_t uTagSrc);
+
 #endif
 
-#ifdef IN_RING3
-/* Init MSI-X support in the device. */
-int      MsixR3Init(PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, PPDMMSIREG pMsiReg);
-#endif
-
-/* If MSI-X is enabled, so that MSIXNotify() shall be used for notifications.  */
-bool     MsixIsEnabled(PPDMPCIDEV pDev);
-
-/* Device notification (aka interrupt). */
-void     MsixNotify(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, int iVector, int iLevel, uint32_t uTagSrc);
-
-#ifdef IN_RING3
-/* PCI config space accessors for MSI-X */
-void     MsixR3PciConfigWrite(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, uint32_t u32Address, uint32_t val, unsigned len);
-#endif

trunk/src/VBox/Devices/Bus/MsixCommon.cpp

@@ -177 +177 @@
 }
 
+/**
+ * Initalizes MSI-X support for the given PCI device.
+ */
 int MsixR3Init(PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, PPDMMSIREG pMsiReg)
 {
@@ -248 +251 @@
 #endif /* IN_RING3 */
 
+/**
+ * Checks if MSI-X is enabled for the tiven PCI device.
+ *
+ * (Must use MSIXNotify() for notifications when true.)
+ */
 bool MsixIsEnabled(PPDMPCIDEV pDev)
 {
@@ -253 +261 @@
 }
 
+/**
+ * Device notification (aka interrupt).
+ */
 void MsixNotify(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, int iVector, int iLevel, uint32_t uTagSrc)
 {
@@ -296 +307 @@
 }
 
-
+/**
+ * PCI config space accessors for MSI-X.
+ */
 void MsixR3PciConfigWrite(PPDMDEVINS pDevIns, PCPDMPCIHLP pPciHlp, PPDMPCIDEV pDev, uint32_t u32Address, uint32_t val, unsigned len)
 {