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="index" type="uint" summary=""/>
  82             <arg name="clock" type="uint" summary=""/>
  83             <arg name="hdisplay" type="uint" summary=""/>
  84             <arg name="hsync_start" type="uint" summary=""/>
  85             <arg name="hsync_end" type="uint" summary=""/>
  86             <arg name="htotal" type="uint" summary=""/>
  87             <arg name="hskew" type="uint" summary=""/>
  88             <arg name="vdisplay" type="uint" summary=""/>
  89             <arg name="vsync_start" type="uint" summary=""/>
  90             <arg name="vsync_end" type="uint" summary=""/>
  91             <arg name="vtotal" type="uint" summary=""/>
  92             <arg name="vscan" type="uint" summary=""/>
  93             <arg name="vrefresh" type="uint" summary=""/>
  94             <arg name="flags" type="uint" summary=""/>
  95             <arg name="type" type="uint" summary=""/>
  96             <arg name="name" type="string" summary=""/>
  97         </request>
  98
  99         <request name="connect"/>
 100
 101         <request name="disconnect"/>
 102
 103         <event name="ack_message">
 104             <arg name="msg" type="uint" enum="message" summary=""/>
 105         </event>
 106         <enum name="message">
 107             <entry name="unknown" value="0" summary=""/>
 108             <entry name="added" value="1" summary=""/>
 109             <entry name="permission_denied" value="2" summary=""/>
 110         </enum>
 111     </interface>
 112
 113     <interface name="wl_tdm_vblank" version="1">
 114
 115         <event name="stamp">
 116             <arg name="stamp" type="uint"/>
 117         </event>
 118
 119         <event name="done">
 120             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
 121             <arg name="sequence" type="uint" summary="the sequence number of the vblank"/>
 122             <arg name="tv_sec" type="uint" summary="sec of the vblank"/>
 123             <arg name="tv_usec" type="uint" summary="usec of the vblank"/>
 124             <arg name="error" type="uint" summary="error status enumeration"/>
 125         </event>
 126
 127         <event name="ttrace">
 128             <arg name="enable" type="uint"/>
 129         </event>
 130
 131         <request name="destroy" type="destructor"/>
 132
 133         <request name="set_name">
 134             <arg name="name" type="string"/>
 135         </request>
 136
 137         <request name="set_fps">
 138             <arg name="fps" type="uint"/>
 139         </request>
 140
 141         <request name="set_offset">
 142             <arg name="offset" type="int"/>
 143         </request>
 144
 145         <request name="set_enable_fake">
 146             <arg name="enable_fake" type="uint"/>
 147         </request>
 148
 149         <request name="wait_vblank">
 150             <description summary="Wait for a HW vblank">
 151           When wl_tdm_vblank.wait_vblank is called, TDM server will send the
 152           wl_tdm_vblank.done event after interval vblanks. If enable_fake == 1,
 153           TDM server will send the done event always. Otherwise, TDM server will
 154           send the done event with TDM error value.
 155             </description>
 156
 157             <arg name="interval" type="uint"/>
 158             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
 159             <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
 160             <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
 161         </request>
 162
 163         <request name="wait_vblank_seq">
 164             <arg name="sequence" type="uint" summary="the target sequence number"/>
 165             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
 166             <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
 167             <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
 168         </request>
 169
 170     </interface>
 171
 172 </protocol>