protocol/tdm.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3 <protocol name="wl_tdm">
   4
   5     <interface name="wl_tdm" version="1">
   6
   7         <description summary="the private protocol for TDM">
   8       TDM uses the wayland protocol to communicate between tdm client and tdm server.
   9         </description>
  10
  11         <request name="create_output">
  12             <arg name="name" type="string" summary="output's name. 'primary' or 'default' can be used for default."/>
  13             <arg name="id" type="new_id" interface="wl_tdm_output"/>
  14         </request>
  15
  16     </interface>
  17
  18     <interface name="wl_tdm_output" version="1">
  19         <description summary="TDM client output object">
  20       When the DPMS of connection status of the output is changed, TDM server
  21       will send wl_tdm_output.mode and wl_tdm_output.dpms event.
  22         </description>
  23
  24         <event name="mode">
  25             <arg name="width" type="uint"/>
  26             <arg name="height" type="uint"/>
  27             <arg name="refresh" type="uint"/>
  28         </event>
  29
  30         <event name="connection">
  31             <arg name="value" type="uint"/>
  32         </event>
  33
  34         <event name="dpms">
  35             <arg name="value" type="uint"/>
  36         </event>
  37
  38         <request name="destroy" type="destructor"/>
  39
  40         <request name="create_vblank">
  41             <arg name="id" type="new_id" interface="wl_tdm_vblank"/>
  42         </request>
  43
  44     </interface>
  45
  46     <interface name="wl_tdm_vblank" version="1">
  47
  48         <event name="done">
  49             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
  50             <arg name="sequence" type="uint" summary="the sequence number of the vblank"/>
  51             <arg name="tv_sec" type="uint" summary="sec of the vblank"/>
  52             <arg name="tv_usec" type="uint" summary="usec of the vblank"/>
  53             <arg name="error" type="uint" summary="error status enumeration"/>
  54         </event>
  55
  56         <request name="destroy" type="destructor"/>
  57
  58         <request name="set_fps">
  59             <arg name="fps" type="uint"/>
  60         </request>
  61
  62         <request name="set_offset">
  63             <arg name="offset" type="int"/>
  64         </request>
  65
  66         <request name="set_enable_fake">
  67             <arg name="enable_fake" type="uint"/>
  68         </request>
  69
  70         <request name="wait_vblank">
  71             <description summary="Wait for a HW vblank">
  72           When wl_tdm_vblank.wait_vblank is called, TDM server will send the
  73           wl_tdm_vblank.done event after interval vblanks. If enable_fake == 1,
  74           TDM server will send the done event always. Otherwise, TDM server will
  75           send the done event with TDM error value.
  76             </description>
  77
  78             <arg name="interval" type="uint"/>
  79             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
  80             <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
  81             <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
  82         </request>
  83
  84     </interface>
  85
  86 </protocol>