xref: /OK3568_Linux_fs/external/xserver/config/dbus-api (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1D-BUS Configuration API v2
2----------------------------
3
4The X server will register the bus name org.x.config.displayN, and the
5object /org/x/config/N, where N is the display number.
6
7Currently only hotplugging of input devices is supported.
8
9org.x.config.input:
10    org.x.config.input.version:
11        Returns one unsigned int32, which is the API version.
12
13    org.x.config.input.add:
14        Takes an argument of key/value option pairs in arrays, e.g.:
15         [ss][ss][ss][ss]
16        is the signature for four options.  These options will be passed
17        to the input driver as with any others.
18        Option names beginning with _ are not allowed; they are reserved
19        for internal use.
20
21        Returns a number of signed int32s.  Positive integers are the
22        device IDs of new devices; negative numbers are X error codes,
23        as defined in X.h.  BadMatch will be returned if the options
24        given do not match any device.  BadValue is returned for a malformed
25        message.  (Example: 8 is new device ID 8; -8 is BadMatch.)
26
27        Notably, BadAlloc is never returned: the server internally signals
28        to D-BUS that the attempt failed for lack of memory.
29
30    org.x.config.input.remove:
31        Takes one uint32 argument, which is the device ID to remove, i.e.:
32         u
33        is the signature.
34
35        Returns one signed int32 which represents an X status as defined in
36        X.h. See org.x.config.input.add. Error codes are negative numbers.
37
38    org.x.config.input.listDevices:
39        Lists the currently active devices. No argument.
40        Return value is sequence of [<id> <name>] [<id> <name>] ..., i.e. [us].
41