org.freedesktop.bolt.xml 6.89 KB
Newer Older
1
2
3
4
5
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">

6
  <interface name="org.freedesktop.bolt1.Manager">
7
8
9
10
11
12
13
14
15

    <doc:doc>
      <doc:description>
        <doc:para>
          Thunderbolt device management.
        </doc:para>
      </doc:description>
    </doc:doc>

16
    <property name="Version" type="u" access="read">
17
18
19
20
21
      <doc:doc><doc:description><doc:para>
        Version of the daemon.
      </doc:para></doc:description></doc:doc>
    </property>

22
23
24
25
26
27
28
29
30
    <property name="Probing" type="b" access="read">
      <doc:doc><doc:description><doc:para>
	Indication that a new thunderbolt device has been connected
	and the manager is reacting to that. Probing should be
	true as long as the new device (and any possible attached
	peripherals) are initialized by the system.
      </doc:para></doc:description></doc:doc>
    </property>

31
32
    <!-- methods -->

33
34
35
36
37
38
39
40
41
42
43
44
45
46
    <method name="ListDevices">
      <arg name="devices" direction="out" type="ao">
        <doc:doc><doc:summary>An array of object paths for the devices.</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            List all known devices, i.e. connected or stored in the database.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
    <method name="DeviceByUid">
      <arg type='s' name='uid' direction='in'>
        <doc:doc><doc:summary>The unique id of the device. </doc:summary>
        </doc:doc>
      </arg>
      <arg name="device" direction="out" type="o">
        <doc:doc><doc:summary>Object path for the devices.</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            Return a device given its unique identifier.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

65
66
67
68
69
70
71
72
73
    <method name="EnrollDevice">
      <arg type='s' name='uid' direction='in'>
        <doc:doc><doc:summary>The unique id of the device.</doc:summary>
        </doc:doc>
      </arg>
      <arg type='u' name='policy' direction='in'>
        <doc:doc><doc:summary>Policy to use for the device.</doc:summary>
        </doc:doc>
      </arg>
74
75
76
77
      <arg type='u' name='flags' direction='in'>
        <doc:doc><doc:summary>Control aspects of enrollment.</doc:summary>
        </doc:doc>
      </arg>
78
79
80
81
82
83
84
      <arg name="device" direction="out" type="o">
        <doc:doc><doc:summary>Object path for the devices.</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
85
86
87
            Authorize a device, and on success, store the device in the database.
            If policy is set to "Auto", the device will be automatically authorized
            in the future.
88
89
90
91
92
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
    <method name="ForgetDevice">

      <arg type='s' name='uid' direction='in'>
        <doc:doc><doc:summary>The unique id of the device.</doc:summary>
        </doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            Remove the device and any associated inforamtion,
            such as the policy and its key, from the store.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
    <!-- signals -->

    <signal name="DeviceAdded">
      <arg name="device" type="o">
        <doc:doc><doc:summary>Object path of the new device.</doc:summary></doc:doc>
      </arg>

      <doc:doc><doc:description><doc:para>
        A new device was added.
      </doc:para></doc:description></doc:doc>
    </signal>

    <signal name="DeviceRemoved">
      <arg name="device" type="o">
        <doc:doc><doc:summary>Object path of the removed device.</doc:summary></doc:doc>
      </arg>

      <doc:doc><doc:description><doc:para>
        A device was removed.
      </doc:para></doc:description></doc:doc>
    </signal>


133
134
  </interface>

135
  <interface name="org.freedesktop.bolt1.Device">
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

    <doc:doc>
      <doc:description>
        <doc:para>
          Representation of a single Thunderbolt device.
        </doc:para>
      </doc:description>
    </doc:doc>

    <property name="Uid" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The unique-id of the device.
      </doc:para></doc:description></doc:doc>
    </property>

151
152
    <property name="Name" type="s" access="read">
      <doc:doc><doc:description><doc:para>
153
        The name of the device.
154
155
156
157
158
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Vendor" type="s" access="read">
      <doc:doc><doc:description><doc:para>
159
        The vendor of the device.
160
      </doc:para></doc:description></doc:doc>
161
162
163
164
165
166
    </property>

    <property name="Type" type="u" access="read">
      <doc:doc><doc:description><doc:para>
        The type of the device: 0 = Host, 1 = Peripheral
      </doc:para></doc:description></doc:doc>
167
168
    </property>

169
170
    <property name="Status" type="u" access="read">
      <doc:doc><doc:description><doc:para>
171
        The current status of the device.
172
173
174
      </doc:para></doc:description></doc:doc>
    </property>

175
176
177
178
179
180
181
182
    <property name="Parent" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The unique id of the parent the device. The only
        device without a parent will be the device that
        represents the host controller.
      </doc:para></doc:description></doc:doc>
    </property>

183
184
    <property name="SysfsPath" type="s" access="read">
      <doc:doc><doc:description><doc:para>
185
        The sysfs path of the device, if it is connected.
186
187
188
      </doc:para></doc:description></doc:doc>
    </property>

189
190
    <property name="Security" type="u" access="read">
      <doc:doc><doc:description><doc:para>
191
192
        The security level of the domain the device is
        connected to.
193
194
195
      </doc:para></doc:description></doc:doc>
    </property>

196
    <property name="Stored" type="b" access="read">
197
      <doc:doc><doc:description><doc:para>
198
        Indication if the device is stored.
199
200
201
202
203
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Policy" type="u" access="read">
      <doc:doc><doc:description><doc:para>
204
        The authorization policy of the device.
205
206
207
208
209
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Key" type="u" access="read">
      <doc:doc><doc:description><doc:para>
210
        If a key is associated with the device.
211
212
213
      </doc:para></doc:description></doc:doc>
    </property>

214
215
216
217
    <!-- methods -->

    <method name="Authorize">

218
219
220
221
222
     <arg type='u' name='flags' direction='in'>
        <doc:doc><doc:summary>Control aspects of authorization.</doc:summary>
        </doc:doc>
     </arg>

223
224
225
226
227
228
229
230
231
      <doc:doc>
        <doc:description>
          <doc:para>
            Authorize the device.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

232
233
234
  </interface>

</node>