add description for tdm protocol

Change-Id: Idbb753a959e4237676806f43a701e4366843fa59

diff --git a/protocol/tdm.xml b/protocol/tdm.xml
index 6fa7f3d..7564670 100644 (file)
--- a/protocol/tdm.xml
+++ b/protocol/tdm.xml
@@ -2,41 +2,59 @@
 
 <protocol name="wl_tdm">
 
-    <interface name="wl_tdm_vblank" version="1">
+    <interface name="wl_tdm" version="1">
 
-        <event name="done">
-            <arg name="sequence" type="uint"/>
-            <arg name="tv_sec" type="uint"/>
-            <arg name="tv_usec" type="uint"/>
-        </event>
+        <description summary="the private protocol for TDM">
+      TDM uses the wayland protocol to communicate between tdm client and tdm server.
+        </description>
+
+        <request name="create_client">
+            <arg name="id" type="new_id" interface="wl_tdm_client"/>
+        </request>
 
     </interface>
 
     <interface name="wl_tdm_client" version="1">
 
+        <description summary="tdm client resource">
+      TDM uses the wayland protocol to communicate between tdm client and tdm server.
+        </description>
+
         <enum name="error">
-            <entry name="invalid_name" value="0"/>
-            <entry name="operation_failed" value="1"/>
-            <entry name="dpms_off" value="2"/>
+            <entry name="invalid_name" value="0" summary="invalid output name"/>
+            <entry name="operation_failed" value="1" summary="operation failed"/>
+            <entry name="dpms_off" value="2" summary="DPMS off"/>
         </enum>
 
         <request name="destroy" type="destructor"/>
         <request name="wait_vblank">
+
+            <description summary="Wait for a HW vblank">
+          When wl_tdm_client.wait_vblank is called, wl_tdm_vblank resource is created.
+          And when TDM server gets the HW vblank, TDM server will send the 'done'
+          event of wl_tdm_vblank interface to let the TDM client get the HW vblank.
+          If 'sw_timer' param is 1, TDM server will use the SW timer in case of DPMS off.
+          And TDM server will create the fake vblank event and send it to TDM client.
+          Otherwise, TDM server will return 'dpms_off' error.
+            </description>
+
             <arg name="id" type="new_id" interface="wl_tdm_vblank"/>
-            <arg name="name" type="string"/>
-            <arg name="sw_timer" type="int"/>
-            <arg name="interval" type="int"/>
-            <arg name="req_sec" type="uint"/>
-            <arg name="req_usec" type="uint"/>
+            <arg name="name" type="string" summary="output's name"/>
+            <arg name="sw_timer" type="int" summary="0: not using SW timer, 1: using SW timer when DPMS off"/>
+            <arg name="interval" type="int" summary="vblank interval"/>
+            <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
+            <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
         </request>
 
     </interface>
 
-    <interface name="wl_tdm" version="1">
+    <interface name="wl_tdm_vblank" version="1">
 
-        <request name="create_client">
-            <arg name="id" type="new_id" interface="wl_tdm_client"/>
-        </request>
+        <event name="done">
+            <arg name="sequence" type="uint" summary="sequence of the HW vblank"/>
+            <arg name="tv_sec" type="uint" summary="sec of the HW vblank in kernel side"/>
+            <arg name="tv_usec" type="uint" summary="usec of the HW vblank in kernel side"/>
+        </event>
 
     </interface>