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