Changeset 93422 in vbox for trunk

Timestamp:

Jan 24, 2022 8:03:33 PM (3 years ago)

Author:

vboxsync

Message:

doxygen: add initial documantation for VBoxDRMClient service, bugref:10134.

Location:

trunk

Files:

• doc/VBox-doc.c (modified) (1 diff)
• src/VBox/Additions/x11/VBoxClient/display-drm.cpp (modified) (6 diffs)

trunk/doc/VBox-doc.c

@@ -143 +143 @@
  *          - @ref pg_vgsvc_clipboard
  *      - VBoxControl.
- *      - VBoxVideo.
+ *      - Linux, Solaris and FreeBSD specific guest services and drivers.
+ *          - @ref pg_vboxdrmcliet (Linux only).
+ *          - VBoxClient.
+ *          - VBoxVideo.
+ *      - Windows Guests.
+ *          - VBoxTray.
  *      - crOpenGL.
- *      - VBoxClient / VBoxTray.
  *      - pam.
  *      - ...

trunk/src/VBox/Additions/x11/VBoxClient/display-drm.cpp

@@ -18 +18 @@
  */
 
-/*
- * General notes
+/** @page pg_vboxdrmcliet    VBoxDRMClient - The VMSVGA Guest Screen Resize Service
+ *
+ * The VMSVGA Guest Screen Resize Service is a service which communicates with a
+ * guest VMSVGA driver and triggers it to perform screen resize on a guest side.
  *
  * This service supposed to be started on early boot. On start it will try to find
  * compatible VMSVGA graphics card and terminate immediately if not found.
  * VMSVGA functionality implemented here is only supported starting from vmgfx
- * driver version 2.10 which was introduced in vanilla Linux kernel 4.6. When compatible
+ * driver version 2.10 which was introduced in Linux kernel 4.6. When compatible
  * graphics card is found, service will start a worker loop in order to receive screen
  * update data from host and apply it to local DRM stack.
  *
  * In addition, it will start a local IPC server in order to communicate with Desktop
- * Environment specific service(s). Currently, it will propagate to IPC client information
+ * Environment specific service(s). Currently, it will propagate to IPC client information regarding to
  * which display should be set as primary on Desktop Environment level. As well as
  * receive screen layout change events obtained on Desktop Environment level and send it
@@ -36 +38 @@
  * Logging is implemented in a way that errors are always printed out, VBClLogVerbose(1) and
  * VBClLogVerbose(2) are used for debugging purposes. Verbosity level 1 is for messages related
- * to daemon itself (excluding IPC), level 2 is for IPC communication debugging. In order to see
+ * to service itself (excluding IPC), level 2 is for IPC communication debugging. In order to see
  * logging on a host side it is enough to do:
  *
@@ -42 +44 @@
  *
  *
- * Threads
+ * Service is running the following threads:
  *
  * DrmResizeThread - this thread listens for display layout update events from host.
@@ -62 +64 @@
  *
  *
- * Locking
- *
- * g_ipcClientConnectionsListCritSect - protects access to list of IPC client connections.
+ * The following loack are utilized:
+ *
+ * #g_ipcClientConnectionsListCritSect - protects access to list of IPC client connections.
  *     It is used by each thread - DrmResizeThread, DrmIpcSRV and IpcCLT-XXX.
  *
- * g_monitorPositionsCritSect - serializes access to host interface when guest Desktop
+ * #g_monitorPositionsCritSect - serializes access to host interface when guest Desktop
  *     Environment reports display layout changes.
  */
@@ -869 +871 @@
 {
     int         rc;
+    /** DRM client thread (IpcCLT-%u). */
     RTTHREAD    hThread = 0;
     RTPROCESS   hProcess = 0;
@@ -980 +983 @@
 
     RTLOCALIPCSERVER hIpcServer;
+    /** DRM IPC server thread (DrmIpcSRV). */
     RTTHREAD vbDrmIpcThread;
     int rcDrmIpcThread = 0;
 
+    /** DRM resize thread: receive resize data from host and apply it to local DRM stack (DrmResizeThread). */
     RTTHREAD drmResizeThread;
     int rcDrmResizeThread = 0;