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