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         <event name="debug_message">
  12             <arg name="message" type="string"/>
  13         </event>
  14
  15         <event name="debug_done" />
  16
  17         <request name="debug">
  18             <arg name="options" type="string" summary="debug options"/>
  19         </request>
  20
  21         <request name="create_output">
  22             <arg name="name" type="string" summary="output's name. 'primary' or 'default' can be used for default."/>
  23             <arg name="id" type="new_id" interface="wl_tdm_output"/>
  24         </request>
  25
  26         <request name="set_client_vblank_fps">
  27             <arg name="pid" type="uint"/>
  28             <arg name="name" type="string"/>
  29             <arg name="fps" type="uint"/>
  30         </request>
  31
  32     </interface>
  33
  34     <interface name="wl_tdm_output" version="1">
  35         <description summary="TDM client output object">
  36       When the DPMS of connection status of the output is changed, TDM server
  37       will send wl_tdm_output.mode and wl_tdm_output.dpms event.
  38         </description>
  39
  40         <event name="mode">
  41             <arg name="width" type="uint"/>
  42             <arg name="height" type="uint"/>
  43             <arg name="refresh" type="uint"/>
  44             <arg name="error" type="uint" summary="error status enumeration"/>
  45         </event>
  46
  47         <event name="connection">
  48             <arg name="value" type="uint"/>
  49             <arg name="error" type="uint" summary="error status enumeration"/>
  50         </event>
  51
  52         <event name="dpms">
  53             <arg name="value" type="uint"/>
  54             <arg name="error" type="uint" summary="error status enumeration"/>
  55         </event>
  56
  57         <request name="destroy" type="destructor"/>
  58
  59         <request name="create_vblank">
  60             <arg name="id" type="new_id" interface="wl_tdm_vblank"/>
  61         </request>
  62
  63         <request name="watch_output_changes">
  64             <arg name="enable" type="uint"/>
  65         </request>
  66
  67         <request name="get_connection"/>
  68
  69         <request name="get_mode"/>
  70
  71         <request name="get_dpms"/>
  72
  73     </interface>
  74
  75     <interface name="wl_tdm_vblank" version="1">
  76
  77         <event name="stamp">
  78             <arg name="stamp" type="uint"/>
  79         </event>
  80
  81         <event name="done">
  82             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
  83             <arg name="sequence" type="uint" summary="the sequence number of the vblank"/>
  84             <arg name="tv_sec" type="uint" summary="sec of the vblank"/>
  85             <arg name="tv_usec" type="uint" summary="usec of the vblank"/>
  86             <arg name="error" type="uint" summary="error status enumeration"/>
  87         </event>
  88
  89         <request name="destroy" type="destructor"/>
  90
  91         <request name="set_name">
  92             <arg name="name" type="string"/>
  93         </request>
  94
  95         <request name="set_fps">
  96             <arg name="fps" type="uint"/>
  97         </request>
  98
  99         <request name="set_offset">
 100             <arg name="offset" type="int"/>
 101         </request>
 102
 103         <request name="set_enable_fake">
 104             <arg name="enable_fake" type="uint"/>
 105         </request>
 106
 107         <request name="wait_vblank">
 108             <description summary="Wait for a HW vblank">
 109           When wl_tdm_vblank.wait_vblank is called, TDM server will send the
 110           wl_tdm_vblank.done event after interval vblanks. If enable_fake == 1,
 111           TDM server will send the done event always. Otherwise, TDM server will
 112           send the done event with TDM error value.
 113             </description>
 114
 115             <arg name="interval" type="uint"/>
 116             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
 117             <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
 118             <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
 119         </request>
 120
 121         <request name="wait_vblank_seq">
 122             <arg name="sequence" type="uint" summary="the target sequence number"/>
 123             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
 124             <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
 125             <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
 126         </request>
 127
 128     </interface>
 129
 130 </protocol>