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