Changeset 47376 in vbox for trunk/src/VBox/Main/idl

Timestamp:

Jul 24, 2013 3:13:52 PM (12 years ago)

Author:

vboxsync

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

87523

Message:

Main/USB: USB Controller implementation rework. Moved filter handling into a separate interface

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (10 diffs)

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

@@ -4127 +4127 @@
   <interface
     name="IMachine" extends="$unknown"
-    uuid="f6258810-a760-11e2-9e96-0800200c9a66"
+    uuid="00daa773-1d35-40ae-ac06-336aa64959ef"
     wsmap="managed"
     >
@@ -4535 +4535 @@
     </attribute>
 
+    <attribute name="USBDeviceFilters" type="IUSBDeviceFilters" readonly="yes">
+      <desc>
+        Associated USB device filters object.
+
+        <note>
+          If USB functionality is not available in the given edition of
+          VirtualBox, this method will set the result code to @c E_NOTIMPL.
+        </note>
+      </desc>
+    </attribute>
+
     <attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
       <desc>Associated audio adapter, always present.</desc>
@@ -7614 +7625 @@
         be returned if the host computer refuses to release it for some reason.
 
-        <see><link to="IUSBController::deviceFilters"/>,
+        <see><link to="IUSBDeviceFilters::deviceFilters"/>,
           <link to="USBDeviceState"/></see>
         <result name="VBOX_E_INVALID_VM_STATE">
@@ -7638 +7649 @@
         a possible automatic re-attachment.
 
-        <see><link to="IUSBController::deviceFilters"/>,
+        <see><link to="IUSBDeviceFilters::deviceFilters"/>,
           <link to="USBDeviceState"/></see>
 
@@ -8224 +8235 @@
         Unless the device is ignored by these filters, filters of all
         currently running virtual machines
-        (<link to="IUSBController::deviceFilters"/>) are applied to it.
+        (<link to="IUSBDeviceFilters::deviceFilters"/>) are applied to it.
 
         <note>
@@ -16311 +16322 @@
 
   <!--
-  // IUSBController
+  // IUSBDeviceFilters
   /////////////////////////////////////////////////////////////////////////
   -->
 
   <interface
-    name="IUSBController" extends="$unknown"
-    uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
+    name="IUSBDeviceFilters" extends="$unknown"
+    uuid="2ab550b2-53cc-4c2e-ae07-0adf4114e75c"
     wsmap="managed"
     >
-    <attribute name="enabled" type="boolean">
-      <desc>
-        Flag whether the USB controller is present in the
-        guest system. If disabled, the virtual guest hardware will
-        not contain any USB controller. Can only be changed when
-        the VM is powered off.
-      </desc>
-    </attribute>
-
-    <attribute name="enabledEHCI" type="boolean">
-      <desc>
-        Flag whether the USB EHCI controller is present in the
-        guest system. If disabled, the virtual guest hardware will
-        not contain a USB EHCI controller. Can only be changed when
-        the VM is powered off.
-      </desc>
-    </attribute>
-
-    <attribute name="proxyAvailable" type="boolean" readonly="yes">
-      <desc>
-        Flag whether there is an USB proxy available.
-      </desc>
-    </attribute>
-
-    <attribute name="USBStandard" type="unsigned short" readonly="yes">
-      <desc>
-        USB standard version which the controller implements.
-        This is a BCD which means that the major version is in the
-        high byte and minor version is in the low byte.
-      </desc>
-    </attribute>
 
     <attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
@@ -16464 +16444 @@
       </param>
     </method>
+
+  </interface>
+
+  <!--
+  // IUSBController
+  /////////////////////////////////////////////////////////////////////////
+  -->
+
+  <interface
+    name="IUSBController" extends="$unknown"
+    uuid="f12e6dda-2bad-40c4-8f2e-2d08fe8b74d4"
+    wsmap="managed"
+    >
+    <attribute name="enabled" type="boolean">
+      <desc>
+        Flag whether the USB controller is present in the
+        guest system. If disabled, the virtual guest hardware will
+        not contain any USB controller. Can only be changed when
+        the VM is powered off.
+      </desc>
+    </attribute>
+
+    <attribute name="enabledEHCI" type="boolean">
+      <desc>
+        Flag whether the USB EHCI controller is present in the
+        guest system. If disabled, the virtual guest hardware will
+        not contain a USB EHCI controller. Can only be changed when
+        the VM is powered off.
+      </desc>
+    </attribute>
+
+    <attribute name="proxyAvailable" type="boolean" readonly="yes">
+      <desc>
+        Flag whether there is an USB proxy available.
+      </desc>
+    </attribute>
+
+    <attribute name="USBStandard" type="unsigned short" readonly="yes">
+      <desc>
+        USB standard version which the controller implements.
+        This is a BCD which means that the major version is in the
+        high byte and minor version is in the low byte.
+      </desc>
+    </attribute>
 
   </interface>
@@ -16632 +16656 @@
       </note>
 
-      <see><link to="IUSBController::deviceFilters"/>,
+      <see><link to="IUSBDeviceFilters::deviceFilters"/>,
         <link to="IHostUSBDeviceFilter"/></see>
     </desc>
@@ -16747 +16771 @@
       either ignore the device, or put it to USBDeviceState_Held state, or do
       nothing. Unless the device is ignored by global filters, filters of all
-      currently running guests (<link to="IUSBController::deviceFilters"/>) are
+      currently running guests (<link to="IUSBDeviceFilters::deviceFilters"/>) are
       activated that can put it to USBDeviceState_Captured state.
 
@@ -16878 +16902 @@
         The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
         filters, because it makes sense only for
-        <link to="IUSBController::deviceFilters">machine USB filters</link>.
+        <link to="IUSBDeviceFilters::deviceFilters">machine USB filters</link>.
       </note>