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