Changeset 4147 in vbox

Timestamp:

Aug 14, 2007 12:01:46 PM (17 years ago)

Author:

vboxsync

Message:

Corrected style and docs of the PDMICHAR::pfnSetParameters method.

Location:

trunk

Files:

• include/VBox/pdmifs.h (modified) (1 diff)
• src/VBox/Devices/Serial/DrvChar.cpp (modified) (3 diffs)

trunk/include/VBox/pdmifs.h

@@ -1126 +1126 @@
      * @returns VBox status code.
      * @param   pInterface      Pointer to the interface structure containing the called function pointer.
-     * @param   speed           Speed of the serial connection.
-     * @param   parity          Enable parity
-     * @param   data_bits       Number of data bits
-     * @param   stop_bits       Number of stop bits
-     * @thread  Any thread.
-     */
-    DECLR3CALLBACKMEMBER(int, pfnSetParameters,(PPDMICHAR pInterface, int speed, int parity, int data_bits, int stop_bits));
+     * @param   Bps             Speed of the serial connection. (bits per second)
+     * @param   chParity        Parity method: 'E' - even, 'O' - odd, 'N' - none.
+     * @param   cDataBits       Number of data bits.
+     * @param   cStopBits       Number of stop bits.
+     * @thread  Any thread.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnSetParameters,(PPDMICHAR pInterface, unsigned Bps, char chParity, unsigned cDataBits, unsigned cStopBits));
 
 } PDMICHAR;

trunk/src/VBox/Devices/Serial/DrvChar.cpp

@@ -128 +128 @@
 
 /** @copydoc PDMICHAR::pfnSetParameters */
-static DECLCALLBACK(int) drvCharSetParameters(PPDMICHAR pInterface, int speed, int parity, int data_bits, int stop_bits)
-{
-    PDRVCHAR pData = PDMICHAR_2_DRVCHAR(pInterface);
-
-    LogFlow(("%s: speed=%d parity=%c data_bits=%d stop_bits=%d\n", __FUNCTION__, speed, parity, data_bits, stop_bits));
+static DECLCALLBACK(int) drvCharSetParameters(PPDMICHAR pInterface, unsigned Bps, char chParity, unsigned cDataBits, unsigned cStopBits)
+{
+    /*PDRVCHAR pData = PDMICHAR_2_DRVCHAR(pInterface); - unused*/
+
+    LogFlow(("%s: Bps=%u chParity=%c cDataBits=%u cStopBits=%u\n", __FUNCTION__, Bps, chParity, cDataBits, cStopBits));
     return VINF_SUCCESS;
 }
@@ -159 +159 @@
          * Write the character to the attached stream (if present).
          */
-        if (    !pData->fShutdown 
+        if (    !pData->fShutdown
             &&  pData->pDrvStream)
         {
@@ -329 +329 @@
     PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatBytesWritten,    STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_BYTES, "Nr of bytes written",         "/Devices/Char%d/Written", pDrvIns->iInstance);
     PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatBytesRead,       STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_BYTES, "Nr of bytes read",            "/Devices/Char%d/Read", pDrvIns->iInstance);
-    
+
     return VINF_SUCCESS;
 }