1 <?xml version="1.0" encoding="UTF-8"?>
3 <protocol name="wl_tdm">
5 <interface name="wl_tdm" version="1">
7 <description summary="the private protocol for TDM">
8 TDM uses the wayland protocol to communicate between tdm client and tdm server.
11 <event name="debug_message">
12 <arg name="message" type="string"/>
15 <event name="debug_done" />
17 <request name="debug">
18 <arg name="options" type="string" summary="debug options"/>
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"/>
26 <request name="create_voutput">
27 <arg name="name" type="string" summary=""/>
28 <arg name="id" type="new_id" interface="wl_tdm_voutput"/>
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.
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"/>
46 <event name="connection">
47 <arg name="value" type="uint"/>
48 <arg name="error" type="uint" summary="error status enumeration"/>
52 <arg name="value" type="uint"/>
53 <arg name="error" type="uint" summary="error status enumeration"/>
56 <request name="destroy" type="destructor"/>
58 <request name="create_vblank">
59 <arg name="id" type="new_id" interface="wl_tdm_vblank"/>
62 <request name="watch_output_changes">
63 <arg name="enable" type="uint"/>
66 <request name="get_connection"/>
68 <request name="get_mode"/>
70 <request name="get_dpms"/>
74 <interface name="wl_tdm_voutput" version="1">
75 <description summary="TDM client virtual output object">
78 <request name="destroy" type="destructor"/>
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=""/>
99 <request name="set_physical_size">
100 <arg name="mmwidth" type="uint" summary=""/>
101 <arg name="mmheight" type="uint" summary=""/>
104 <request name="connect"/>
106 <request name="disconnect"/>
108 <event name="ack_message">
109 <arg name="msg" type="uint" enum="message" summary=""/>
111 <enum name="message">
112 <entry name="unknown" value="0" summary=""/>
113 <entry name="added" value="1" summary=""/>
114 <entry name="permission_denied" value="2" summary=""/>
118 <interface name="wl_tdm_vblank" version="1">
121 <arg name="stamp" type="uint"/>
125 <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
126 <arg name="sequence" type="uint" summary="the sequence number of the vblank"/>
127 <arg name="tv_sec" type="uint" summary="sec of the vblank"/>
128 <arg name="tv_usec" type="uint" summary="usec of the vblank"/>
129 <arg name="error" type="uint" summary="error status enumeration"/>
132 <event name="ttrace">
133 <arg name="enable" type="uint"/>
136 <request name="destroy" type="destructor"/>
138 <request name="set_name">
139 <arg name="name" type="string"/>
142 <request name="set_fps">
143 <arg name="fps" type="uint"/>
146 <request name="set_offset">
147 <arg name="offset" type="int"/>
150 <request name="set_enable_fake">
151 <arg name="enable_fake" type="uint"/>
154 <request name="wait_vblank">
155 <description summary="Wait for a HW vblank">
156 When wl_tdm_vblank.wait_vblank is called, TDM server will send the
157 wl_tdm_vblank.done event after interval vblanks. If enable_fake == 1,
158 TDM server will send the done event always. Otherwise, TDM server will
159 send the done event with TDM error value.
162 <arg name="interval" type="uint"/>
163 <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
164 <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
165 <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
168 <request name="wait_vblank_seq">
169 <arg name="sequence" type="uint" summary="the target sequence number"/>
170 <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
171 <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
172 <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>