VirtualMedia dbus interface definition.
This interfaces definition was created on base of the VirtualMedia
design proposed in this document:
https://github.com/openbmc/docs/blob/master/designs/VirtualMedia.md
It also takes into account the design changes proposed in this review:
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/29573
Signed-off-by: Zbigniew Kurzynski <zbigniew.kurzynski@intel.com>
Change-Id: Ie5b1cdb9a8e01a54e79784837edf3b1d1f1fb017
diff --git a/xyz/openbmc_project/VirtualMedia/MountPoint.interface.yaml b/xyz/openbmc_project/VirtualMedia/MountPoint.interface.yaml
new file mode 100644
index 0000000..e21b3cf
--- /dev/null
+++ b/xyz/openbmc_project/VirtualMedia/MountPoint.interface.yaml
@@ -0,0 +1,73 @@
+description: >
+ Defines the object configuration like mounting mode, image paths,
+ timouts etc.
+
+properties:
+ - name: EndPointId
+ type: string
+ description: Name of the Network Block Devices that will be used.
+ flags:
+ - const
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: Mode
+ type: byte
+ description: Mounting mode, supported values are 0-proxy, 1-legacy.
+ flags:
+ - const
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: Device
+ type: string
+ description: Name of mounted device.
+ flags:
+ - const
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: Socket
+ type: string
+ description: Path to socket used to mount the image.
+ flags:
+ - const
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: Timeout
+ type: uint16
+ description: >
+ Client connection timeout in seconds.
+ If VirtualMedia cannot connect successfully with served
+ image the connection is dropped after that timeout.
+ flags:
+ - const
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: BlockSize
+ type: uint16
+ description: Size of data block.
+ flags:
+ - const
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: RemainingInactivityTimeout
+ type: uint16
+ description: >
+ Seconds to drop connection by server, for activated endpoint,
+ 0 otherwise.
+ flags:
+ - const
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: ImageURL
+ type: string
+ description: URL to mounted image.
+ flags:
+ - const
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure