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_done">
  12             <arg name="message" type="string"/>
  13         </event>
  14
  15         <request name="create_output">
  16             <arg name="name" type="string" summary="output's name. 'primary' or 'default' can be used for default."/>
  17             <arg name="id" type="new_id" interface="wl_tdm_output"/>
  18         </request>
  19
  20         <request name="debug">
  21             <arg name="options" type="string" summary="debug options"/>
  22         </request>
  23
  24     </interface>
  25
  26     <interface name="wl_tdm_output" version="1">
  27         <description summary="TDM client output object">
  28       When the DPMS of connection status of the output is changed, TDM server
  29       will send wl_tdm_output.mode and wl_tdm_output.dpms event.
  30         </description>
  31
  32         <event name="mode">
  33             <arg name="width" type="uint"/>
  34             <arg name="height" type="uint"/>
  35             <arg name="refresh" type="uint"/>
  36         </event>
  37
  38         <event name="connection">
  39             <arg name="value" type="uint"/>
  40         </event>
  41
  42         <event name="dpms">
  43             <arg name="value" type="uint"/>
  44         </event>
  45
  46         <request name="destroy" type="destructor"/>
  47
  48         <request name="create_vblank">
  49             <arg name="id" type="new_id" interface="wl_tdm_vblank"/>
  50         </request>
  51
  52     </interface>
  53
  54     <interface name="wl_tdm_vblank" version="1">
  55
  56         <event name="done">
  57             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
  58             <arg name="sequence" type="uint" summary="the sequence number of the vblank"/>
  59             <arg name="tv_sec" type="uint" summary="sec of the vblank"/>
  60             <arg name="tv_usec" type="uint" summary="usec of the vblank"/>
  61             <arg name="error" type="uint" summary="error status enumeration"/>
  62         </event>
  63
  64         <request name="destroy" type="destructor"/>
  65
  66         <request name="set_fps">
  67             <arg name="fps" type="uint"/>
  68         </request>
  69
  70         <request name="set_offset">
  71             <arg name="offset" type="int"/>
  72         </request>
  73
  74         <request name="set_enable_fake">
  75             <arg name="enable_fake" type="uint"/>
  76         </request>
  77
  78         <request name="wait_vblank">
  79             <description summary="Wait for a HW vblank">
  80           When wl_tdm_vblank.wait_vblank is called, TDM server will send the
  81           wl_tdm_vblank.done event after interval vblanks. If enable_fake == 1,
  82           TDM server will send the done event always. Otherwise, TDM server will
  83           send the done event with TDM error value.
  84             </description>
  85
  86             <arg name="interval" type="uint"/>
  87             <arg name="req_id" type="uint" summary="wait_vblank request ID"/>
  88             <arg name="req_sec" type="uint" summary="sec of the request time in client side"/>
  89             <arg name="req_usec" type="uint" summary="usec of the request time in client side"/>
  90         </request>
  91
  92     </interface>
  93
  94 </protocol>