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="create_voutput">
  27             <arg name="name" type="string" summary=""/>
  28             <arg name="id" type="new_id" interface="wl_tdm_voutput"/>
  29         </request>
  30
  31     </interface>
  32
  33     <interface name="wl_tdm_output" version="1">
  34         <description summary="TDM client output object">
  35       When the DPMS of connection status of the output is changed, TDM server
  36       will send wl_tdm_output.mode and wl_tdm_output.dpms event.
  37         </description>
  38
  39         <event name="mode">
  40             <arg name="width" type="uint"/>
  41             <arg name="height" type="uint"/>
  42             <arg name="refresh" type="uint"/>
  43             <arg name="error" type="uint" summary="error status enumeration"/>
  44         </event>
  45
  46         <event name="connection">
  47             <arg name="value" type="uint"/>
  48             <arg name="error" type="uint" summary="error status enumeration"/>
  49         </event>
  50
  51         <event name="dpms">
  52             <arg name="value" type="uint"/>
  53             <arg name="error" type="uint" summary="error status enumeration"/>
  54         </event>
  55
  56         <request name="destroy" type="destructor"/>
  57
  58         <request name="create_vblank">
  59             <arg name="id" type="new_id" interface="wl_tdm_vblank"/>
  60         </request>
  61
  62         <request name="watch_output_changes">
  63             <arg name="enable" type="uint"/>
  64         </request>
  65
  66         <request name="get_connection"/>
  67
  68         <request name="get_mode"/>
  69
  70         <request name="get_dpms"/>
  71
  72     </interface>
  73
  74     <interface name="wl_tdm_voutput" version="1">
  75         <description summary="TDM client virtual output object">
  76         </description>
  77
  78         <request name="destroy" type="destructor"/>
  79
  80         <request name="set_available_modes">
  81             <arg name="modes" type="array"/>
  82         </request>
  83
  84         <request name="set_physical_size">
  85             <arg name="mmwidth" type="uint" summary=""/>
  86             <arg name="mmheight" type="uint" summary=""/>
  87         </request>
  88
  89         <request name="set_mode">
  90             <arg name="index" type="uint"/>
  91         </request>
  92
  93         <request name="connect"/>
  94
  95         <request name="disconnect"/>
  96
  97         <request name="commit_done"/>
  98
  99         <event name="buffer_set_with_id">
 100             <arg name="wl_buffer" type="new_id" interface="wl_buffer"/>
 101             <arg name="width" type="int"/>
 102             <arg name="height" type="int"/>
 103             <arg name="format" type="uint"/>
 104             <arg name="bpp" type="int"/>
 105             <arg name="size" type="int"/>
 106             <arg name="num_plane" type="int"/>
 107             <arg name="plane_buf_idx" type="array"/>
 108             <arg name="plane_offset" type="array"/>
 109             <arg name="plane_stride" type="array"/>
 110             <arg name="plane_size" type="array"/>
 111             <arg name="flags" type="uint"/>
 112             <arg name="num_buf" type="int"/>
 113             <arg name="buf0" type="uint"/>
 114             <arg name="buf1" type="uint"/>
 115             <arg name="buf2" type="uint"/>
 116         </event>
 117
 118         <event name="buffer_set_with_fd">
 119             <arg name="wl_buffer" type="new_id" interface="wl_buffer"/>
 120             <arg name="width" type="int"/>
 121             <arg name="height" type="int"/>
 122             <arg name="format" type="uint"/>
 123             <arg name="bpp" type="int"/>
 124             <arg name="size" type="int"/>
 125             <arg name="num_plane" type="int"/>
 126             <arg name="plane_buf_idx" type="array"/>
 127             <arg name="plane_offset" type="array"/>
 128             <arg name="plane_stride" type="array"/>
 129             <arg name="plane_size" type="array"/>
 130             <arg name="flags" type="uint"/>
 131             <arg name="num_buf" type="int"/>
 132             <arg name="buf0" type="fd"/>
 133             <arg name="buf1" type="fd"/>
 134             <arg name="buf2" type="fd"/>
 135         </event>
 136
 137         <event name="destroy_buffer">
 138             <arg name="buffer" type="object" interface="wl_buffer"/>
 139         </event>
 140
 141         <event name="attach_buffer">
 142             <arg name="buffer" type="object" interface="wl_buffer"/>
 143         </event>
 144
 145         <event name="commit"/>
 146
 147         <event name="ack_message">
 148             <arg name="msg" type="uint" enum="message" summary=""/>
 149         </event>
 150
 151         <enum name="message">
 152             <entry name="unknown" value="0" summary=""/>
 153             <entry name="added" value="1" summary=""/>
 154             <entry name="permission_denied" value="2" summary=""/>
 155         </enum>
 156     </interface>
 157
 158     <interface name="wl_tdm_vblank" version="1">
 159
 160         <event name="stamp">
 161             <arg name="stamp" type="uint"/>
 162         </event>
 163
 164         <event name="done">
 165             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
 166             <arg name="sequence" type="uint" summary="the sequence number of the vblank"/>
 167             <arg name="tv_sec" type="uint" summary="sec of the vblank"/>
 168             <arg name="tv_usec" type="uint" summary="usec of the vblank"/>
 169             <arg name="error" type="uint" summary="error status enumeration"/>
 170         </event>
 171
 172         <event name="ttrace">
 173             <arg name="enable" type="uint"/>
 174         </event>
 175
 176         <request name="destroy" type="destructor"/>
 177
 178         <request name="set_name">
 179             <arg name="name" type="string"/>
 180         </request>
 181
 182         <request name="set_fps">
 183             <arg name="fps" type="uint"/>
 184         </request>
 185
 186         <request name="set_offset">
 187             <arg name="offset" type="int"/>
 188         </request>
 189
 190         <request name="set_enable_fake">
 191             <arg name="enable_fake" type="uint"/>
 192         </request>
 193
 194         <request name="wait_vblank">
 195             <description summary="Wait for a HW vblank">
 196           When wl_tdm_vblank.wait_vblank is called, TDM server will send the
 197           wl_tdm_vblank.done event after interval vblanks. If enable_fake == 1,
 198           TDM server will send the done event always. Otherwise, TDM server will
 199           send the done event with TDM error value.
 200             </description>
 201
 202             <arg name="interval" type="uint"/>
 203             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
 204             <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
 205             <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
 206         </request>
 207
 208         <request name="wait_vblank_seq">
 209             <arg name="sequence" type="uint" summary="the target sequence number"/>
 210             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
 211             <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
 212             <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
 213         </request>
 214
 215     </interface>
 216
 217 </protocol>