Changeset 73768 in vbox

Timestamp:

Aug 19, 2018 7:07:19 PM (6 years ago)

Author:

vboxsync

Message:

Main,FE/VBoxManage: Allow changing the UART type of the serial ports through the API

Location:

trunk

Files:

• include/VBox/settings.h (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageInfo.cpp (modified) (6 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageModifyVM.cpp (modified) (3 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (3 diffs)
• src/VBox/Main/include/SerialPortImpl.h (modified) (1 diff)
• src/VBox/Main/src-client/ConsoleImpl2.cpp (modified) (1 diff)
• src/VBox/Main/src-server/SerialPortImpl.cpp (modified) (1 diff)
• src/VBox/Main/xml/Settings.cpp (modified) (5 diffs)

trunk/include/VBox/settings.h

@@ -596 +596 @@
     com::Utf8Str    strPath;
     bool            fServer;
+    UartType_T      uartType;
 };
 

trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

@@ -608 +608 @@
                      "                                             file <file>|\n"
                      "                                             <devicename>]\n"
+                     "                            [--uarttype<1-N> 16450|16550A|16750\n"
 #if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS)
                      "                            [--lpt<1-N> off|<I/O base> <IRQ>]\n"

trunk/src/VBox/Frontends/VBoxManage/VBoxManageInfo.cpp

@@ -1493 +1493 @@
                 Bstr path;
                 BOOL fServer;
+                UartType_T UartType;
                 uart->COMGETTER(IRQ)(&ulIRQ);
                 uart->COMGETTER(IOBase)(&ulIOBase);
@@ -1498 +1499 @@
                 uart->COMGETTER(Server)(&fServer);
                 uart->COMGETTER(HostMode)(&HostMode);
+                uart->COMGETTER(UartType)(&UartType);
 
                 if (details == VMINFO_MACHINEREADABLE)
@@ -1510 +1512 @@
                             RTPrintf("uartmode%d=\"disconnected\"\n", currentUART + 1);
                         else
-                            RTPrintf(", disconnected\n");
+                            RTPrintf(", disconnected");
                         break;
                     case PortMode_RawFile:
@@ -1525 +1527 @@
                                      fServer ? "tcpserver" : "tcpclient", path.raw());
                         else
-                            RTPrintf(", attached to tcp (%s) '%ls'\n",
+                            RTPrintf(", attached to tcp (%s) '%ls'",
                                      fServer ? "server" : "client", path.raw());
                         break;
@@ -1533 +1535 @@
                                      fServer ? "server" : "client", path.raw());
                         else
-                            RTPrintf(", attached to pipe (%s) '%ls'\n",
+                            RTPrintf(", attached to pipe (%s) '%ls'",
                                      fServer ? "server" : "client", path.raw());
                         break;
@@ -1541 +1543 @@
                                      path.raw());
                         else
-                            RTPrintf(", attached to device '%ls'\n", path.raw());
+                            RTPrintf(", attached to device '%ls'", path.raw());
+                        break;
+                }
+                switch (UartType)
+                {
+                    default:
+                    case UartType_U16450:
+                        if (details == VMINFO_MACHINEREADABLE)
+                            RTPrintf("uarttype%d=\"16450\"\n", currentUART + 1);
+                        else
+                            RTPrintf(", 16450\n");
+                        break;
+                    case UartType_U16550A:
+                        if (details == VMINFO_MACHINEREADABLE)
+                            RTPrintf("uarttype%d=\"16550A\"\n", currentUART + 1);
+                        else
+                            RTPrintf(", 16550A\n");
+                        break;
+                    case UartType_U16750:
+                        if (details == VMINFO_MACHINEREADABLE)
+                            RTPrintf("uarttype%d=\"16750\"\n", currentUART + 1);
+                        else
+                            RTPrintf(", 16750\n");
                         break;
                 }

trunk/src/VBox/Frontends/VBoxManage/VBoxManageModifyVM.cpp

@@ -147 +147 @@
     MODIFYVM_HIDKBD,
     MODIFYVM_UARTMODE,
+    MODIFYVM_UARTTYPE,
     MODIFYVM_UART,
 #if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS)
@@ -334 +335 @@
     { "--keyboard",                 MODIFYVM_HIDKBD,                    RTGETOPT_REQ_STRING },
     { "--uartmode",                 MODIFYVM_UARTMODE,                  RTGETOPT_REQ_STRING | RTGETOPT_FLAG_INDEX },
+    { "--uarttype",                 MODIFYVM_UARTTYPE,                  RTGETOPT_REQ_STRING | RTGETOPT_FLAG_INDEX },
     { "--uart",                     MODIFYVM_UART,                      RTGETOPT_REQ_STRING | RTGETOPT_FLAG_INDEX },
 #if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS)
@@ -2157 +2159 @@
             }
 
+            case MODIFYVM_UARTTYPE:
+            {
+                ComPtr<ISerialPort> uart;
+
+                CHECK_ERROR_BREAK(sessionMachine, GetSerialPort(GetOptState.uIndex - 1, uart.asOutParam()));
+                ASSERT(uart);
+
+                if (!RTStrICmp(ValueUnion.psz, "16450"))
+                {
+                    CHECK_ERROR(uart, COMSETTER(UartType)(UartType_U16450));
+                }
+                else if (!RTStrICmp(ValueUnion.psz, "16550A"))
+                {
+                    CHECK_ERROR(uart, COMSETTER(UartType)(UartType_U16550A));
+                }
+                else if (!RTStrICmp(ValueUnion.psz, "16750"))
+                {
+                    CHECK_ERROR(uart, COMSETTER(UartType)(UartType_U16750));
+                }
+                else
+                    return errorSyntax(USAGE_MODIFYVM,
+                                       "Invalid argument to '%s'",
+                                       GetOptState.pDef->pszLong);
+                break;
+            }
+
             case MODIFYVM_UART:
             {

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -593 +593 @@
       <desc>Settings version "1.17", written by VirtualBox 6.0.x.</desc>
       <!--
-          Machine changes: nested hardware virtualization.
+          Machine changes: nested hardware virtualization, UART type selection.
       -->
     </const>
@@ -18388 +18388 @@
   </enum>
 
+  <enum
+    name="UartType"
+    uuid="c8899d39-0b90-4265-9d02-1e38bd4d1b39"
+    >
+    <desc>
+      The UART type represents the emulated UART chip for the serial port device.
+    </desc>
+
+    <const name="U16450"            value="0">
+      <desc>The most basic emulated UART which doesn't support FIFO operation.</desc>
+    </const>
+    <const name="U16550A"           value="1">
+      <desc>
+        The successor of the 16450 UART introducing a 16 byte FIFO to reduce
+        operational overhead.
+      </desc>
+    </const>
+    <const name="U16750"            value="2">
+      <desc>
+        This UART developed by Texas Instruments introduced a 64 byte FIFO
+        and hardware flow control.
+      </desc>
+    </const>
+  </enum>
+
   <interface
     name="ISerialPort" extends="$unknown"
     uuid="cb0a4a29-43a3-9040-0c25-34845db7b042"
     wsmap="managed"
-    reservedAttributes="2"
+    reservedAttributes="1"
     >
 
@@ -18470 +18495 @@
         value is an error. Otherwise, the value of this property is ignored.
       </desc>
+    </attribute>
+
+    <attribute name="uartType" type="UartType">
+      <desc>Selects the emulated UART implementation.</desc>
     </attribute>
 

trunk/src/VBox/Main/include/SerialPortImpl.h

@@ -79 +79 @@
     HRESULT getPath(com::Utf8Str &aPath);
     HRESULT setPath(const com::Utf8Str &aPath);
+    HRESULT getUartType(UartType_T *aUartType);
+    HRESULT setUartType(UartType_T aUartType);
 
     struct Data;

trunk/src/VBox/Main/src-client/ConsoleImpl2.cpp

@@ -2706 +2706 @@
             hrc = serialPort->COMGETTER(Server)(&fServer);                                  H();
             hrc = serialPort->COMGETTER(Path)(bstr.asOutParam());                           H();
+            UartType_T eUartType;
+            const char *pszUartType;
+            hrc = serialPort->COMGETTER(UartType)(&eUartType);                              H();
+            switch (eUartType)
+            {
+                case UartType_U16450: pszUartType = "16450"; break;
+                case UartType_U16750: pszUartType = "16750"; break;
+                default: AssertFailed(); RT_FALL_THRU();
+                case UartType_U16550A: pszUartType = "16550A"; break;
+            }
+            InsertConfigString(pCfg, "UartType", pszUartType);
+
             PortMode_T eHostMode;
             hrc = serialPort->COMGETTER(HostMode)(&eHostMode);                              H();

trunk/src/VBox/Main/src-server/SerialPortImpl.cpp

@@ -476 +476 @@
         m->bd.backup();
         m->bd->fServer = RT_BOOL(aServer);
+
+        m->fModified = true;
+        // leave the lock before informing callbacks
+        alock.release();
+
+        AutoWriteLock mlock(m->pMachine COMMA_LOCKVAL_SRC_POS);
+        m->pMachine->i_setModified(Machine::IsModified_SerialPorts);
+        mlock.release();
+
+        m->pMachine->i_onSerialPortChange(this);
+    }
+
+    return S_OK;
+}
+
+HRESULT SerialPort::getUartType(UartType_T *aUartType)
+{
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    *aUartType = m->bd->uartType;
+
+    return S_OK;
+}
+
+HRESULT SerialPort::setUartType(UartType_T aUartType)
+{
+    /* the machine needs to be mutable */
+    AutoMutableOrSavedOrRunningStateDependency adep(m->pMachine);
+    if (FAILED(adep.rc())) return adep.rc();
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    if (m->bd->uartType != aUartType)
+    {
+        m->bd.backup();
+        m->bd->uartType = aUartType;
 
         m->fModified = true;

trunk/src/VBox/Main/xml/Settings.cpp

@@ -2495 +2495 @@
     ulIRQ(4),
     portMode(PortMode_Disconnected),
-    fServer(false)
+    fServer(false),
+    uartType(UartType_U16550A)
 {
 }
@@ -2513 +2514 @@
             && portMode          == s.portMode
             && strPath           == s.strPath
-            && fServer           == s.fServer);
+            && fServer           == s.fServer
+            && uartType          == s.uartType);
 }
 
@@ -3637 +3639 @@
         pelmPort->getAttributeValue("server", port.fServer);
 
+        Utf8Str strUartType;
+        if (pelmPort->getAttributeValue("uartType", strUartType))
+        {
+            if (strUartType == "16450")
+                port.uartType = UartType_U16450;
+            else if (strUartType == "16550A")
+                port.uartType = UartType_U16550A;
+            else if (strUartType == "16750")
+                port.uartType = UartType_U16750;
+            else
+                throw ConfigFileError(this, pelmPort, N_("Invalid value '%s' in UART/Port/@uartType attribute"), strUartType.c_str());
+        }
+
         ll.push_back(port);
     }
@@ -6011 +6026 @@
             }
             pelmPort->setAttribute("hostMode", pcszHostMode);
+
+            if (   m->sv >= SettingsVersion_v1_17
+                && port.uartType != UartType_U16550A)
+            {
+                const char *pcszUartType;
+
+                switch (port.uartType)
+                {
+                    case UartType_U16450: pcszUartType = "16450"; break;
+                    case UartType_U16550A: pcszUartType = "16550A"; break;
+                    case UartType_U16750: pcszUartType = "16750"; break;
+                    default: pcszUartType = "16550A"; break;
+                }
+                pelmPort->setAttribute("uartType", pcszUartType);
+            }
         }
     }
@@ -6982 +7012 @@
             return;
         }
+
+        /*
+         * Check if any serial port uses a non 16550A serial port.
+         */
+        for (SerialPortsList::const_iterator it = hardwareMachine.llSerialPorts.begin();
+             it != hardwareMachine.llSerialPorts.end();
+             ++it)
+        {
+            const SerialPort &port = *it;
+            if (port.uartType != UartType_U16550A)
+            {
+                m->sv = SettingsVersion_v1_17;
+                return;
+            }
+        }
     }