Changeset 82213 in vbox for trunk/src/VBox/Devices/Input/DrvKeyboardQueue.cpp

Timestamp:

Nov 26, 2019 2:08:48 AM (5 years ago)

Author:

vboxsync

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

135027

Message:

doxygen fixes. bugref:9218

File:

• trunk/src/VBox/Devices/Input/DrvKeyboardQueue.cpp (modified) (8 diffs)

trunk/src/VBox/Devices/Input/DrvKeyboardQueue.cpp

@@ -83 +83 @@
     PDMQUEUEITEMCORE    Core;
     /** The keycode. */
-    uint32_t            u32UsageCode;
+    uint32_t            idUsage;
 } DRVKBDQUEUEITEM, *PDRVKBDQUEUEITEM;
 
@@ -212 +212 @@
 
 /**
- * Queues a scancode-based keyboard event.
+ * @interface_method_impl{PDMIKEYBOARDPORT,pfnPutEventScan}
+ *
  * Because of the event queueing the EMT context requirement is lifted.
- *
- * @returns VBox status code.
- * @param   pInterface          Pointer to this interface structure.
- * @param   u8ScanCode          The scan code to translate/queue.
  * @thread  Any thread.
  */
@@ -227 +224 @@
         return VINF_SUCCESS;
 
-    uint32_t    u32Usage = 0;
-    pDrv->XlatState = ScancodeToHidUsage(pDrv->XlatState, u8ScanCode, &u32Usage);
-
-    if (pDrv->XlatState == SS_IDLE) {
+    uint32_t idUsage = 0;
+    pDrv->XlatState = ScancodeToHidUsage(pDrv->XlatState, u8ScanCode, &idUsage);
+
+    if (pDrv->XlatState == SS_IDLE)
+    {
         PDRVKBDQUEUEITEM pItem = (PDRVKBDQUEUEITEM)PDMQueueAlloc(pDrv->pQueue);
         if (pItem)
@@ -239 +237 @@
              * key up into a key up/key down sequence.
              */
-            if (u32Usage == 0x80000090 || u32Usage == 0x80000091)
+            if (idUsage == UINT32_C(0x80000090) || idUsage == UINT32_C(0x80000091))
             {
                 PDRVKBDQUEUEITEM pItem2 = (PDRVKBDQUEUEITEM)PDMQueueAlloc(pDrv->pQueue);
@@ -249 +247 @@
                 {
                     /* Manufacture a key down event. */
-                    pItem2->u32UsageCode = u32Usage & ~0x80000000;
+                    pItem2->idUsage = idUsage & ~UINT32_C(0x80000000);
                     PDMQueueInsert(pDrv->pQueue, &pItem2->Core);
                 }
             }
 
-            pItem->u32UsageCode = u32Usage;
+            pItem->idUsage = idUsage;
             PDMQueueInsert(pDrv->pQueue, &pItem->Core);
 
@@ -269 +267 @@
 
 /**
- * Queues a HID-usage-based keyboard event.
+ * @interface_method_impl{PDMIKEYBOARDPORT,pfnPutEventHid}
+ *
  * Because of the event queueing the EMT context requirement is lifted.
- *
- * @returns VBox status code.
- * @param   pInterface          Pointer to this interface structure.
- * @param   u32UsageCode        The HID usage code to queue.
  * @thread  Any thread.
  */
-static DECLCALLBACK(int) drvKbdQueuePutEventHid(PPDMIKEYBOARDPORT pInterface, uint32_t u32UsageCode)
+static DECLCALLBACK(int) drvKbdQueuePutEventHid(PPDMIKEYBOARDPORT pInterface, uint32_t idUsage)
 {
     PDRVKBDQUEUE pDrv = IKEYBOARDPORT_2_DRVKBDQUEUE(pInterface);
@@ -287 +282 @@
     if (pItem)
     {
-        pItem->u32UsageCode = u32UsageCode;
+        pItem->idUsage = idUsage;
         PDMQueueInsert(pDrv->pQueue, &pItem->Core);
 
@@ -357 +352 @@
     PDRVKBDQUEUE        pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
     PDRVKBDQUEUEITEM    pItem = (PDRVKBDQUEUEITEM)pItemCore;
-    int rc = pThis->pUpPort->pfnPutEventHid(pThis->pUpPort, pItem->u32UsageCode);
+    int rc = pThis->pUpPort->pfnPutEventHid(pThis->pUpPort, pItem->idUsage);
     return RT_SUCCESS(rc);
 }