File: org.freedesktop.bolt.xml

package info (click to toggle)
bolt 0.9.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,812 kB
  • sloc: ansic: 28,978; python: 2,814; xml: 460; javascript: 269; sh: 180; makefile: 12
file content (511 lines) | stat: -rw-r--r-- 16,229 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
<!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">

  <interface name="org.freedesktop.bolt1.Manager">

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

    <property name="Version" type="u" access="read">
      <doc:doc><doc:description><doc:para>
        Version of the daemon.
      </doc:para></doc:description></doc:doc>
    </property>

    <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>

    <property name="DefaultPolicy" type="s" access="read">
      <doc:doc><doc:description><doc:para>
	The policy to use during enrollment when "default" was
	specified.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="SecurityLevel" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The security level of the system.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="AuthMode" type="s" access="readwrite">
      <doc:doc><doc:description><doc:para>
	The authorization mode of the daemon. Currently supported
	values are "enabled" if it is authorizing devices or
	"disabled" if authorization is disabled.
      </doc:para></doc:description></doc:doc>
    </property>


    <property name="PowerState" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        State of the ForcePower setting of the bolt daemon.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Generation" type="u" access="read">
      <doc:doc><doc:description><doc:para>
        The maximum generation of any of Thunderbolt controller
        associated with the device. It will contain 4 for USB4,
	3 for Thunderbolt 3.
      </doc:para></doc:description></doc:doc>
    </property>

    <!-- methods -->

    <method name="ListDomains">
      <arg name="domains" direction="out" type="ao">
        <doc:doc><doc:summary>An array of object paths for the domains.</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            List all active thunderbolt domains.
	  </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <method name="DomainById">
      <arg type='s' name='id' direction='in'>
	<doc:doc><doc:summary>The id of the domain. </doc:summary></doc:doc>
      </arg>
      <arg name="domain" direction="out" type="o">
	<doc:doc><doc:summary>Object path for the domain.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
	<doc:description>
	  <doc:para>
	    Return a domain given its identifier.
	  </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <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>

    <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>

    <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='s' name='policy' direction='in'>
        <doc:doc><doc:summary>Policy to use for the device.</doc:summary>
        </doc:doc>
      </arg>
      <arg type='s' name='flags' direction='in'>
        <doc:doc><doc:summary>Control aspects of enrollment.</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>
            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.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <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 information,
            such as the policy and its key, from the store.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <!-- 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>

    <signal name="DomainAdded">
      <arg name="domain" type="o">
        <doc:doc><doc:summary>Object path of the domain.</doc:summary></doc:doc>
      </arg>

      <doc:doc><doc:description><doc:para>
        A thunderbolt domain was added.
      </doc:para></doc:description></doc:doc>
    </signal>

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

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

  </interface>

  <interface name="org.freedesktop.bolt1.Power">

    <doc:doc>
      <doc:description>
        <doc:para>
          Thunderbolt force power management.
        </doc:para>
      </doc:description>
    </doc:doc>

    <property name="Supported" type="b" access="read">
      <doc:doc><doc:description><doc:para>
	Is there system level support for force powering the
	thunderbolt controller.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="State" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        State of the ForcePower setting of the bolt daemon.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Timeout" type="u" access="read">
      <doc:doc><doc:description><doc:para>
	The minimum amount of time the controller will be powered.
	This timeout will get reset with every new activity on the
	thundrbolt bus while the controller is being force powered.
      </doc:para></doc:description></doc:doc>
    </property>

    <!-- methods -->
    <method name="ForcePower">
      <arg type='s' name='who' direction='in'>
        <doc:doc><doc:summary>Who is requesting the force power op.</doc:summary>
        </doc:doc>
      </arg>
      <arg type='s' name='flags' direction='in'>
        <doc:doc><doc:summary>Control aspects of the force power operation.</doc:summary>
        </doc:doc>
      </arg>
      <arg name="guard_fd" direction="out" type="h">
	<doc:doc><doc:summary>File descriptor reference to the guard.</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            Force power the thunderbolt controller, if supported.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <method name="ListGuards">

      <arg type='a(ssu)' name='guards' direction='out'>
        <doc:doc>
          <doc:summary>
            <doc:para>
	      Array of guard information, containing the "id", "who" and the pid
	      of the guard.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
	    List active internal and external power guards.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

  </interface>

  <interface name="org.freedesktop.bolt1.Device">

    <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>

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

    <property name="Vendor" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The vendor of the device.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Type" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The type of the device, i.e. 'host' or 'peripheral'
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Generation" type="u" access="read">
      <doc:doc><doc:description><doc:para>
        The generation of the Thunderbolt controller associated
	with the device. It will contain 4 for USB4, 3 for
	Thunderbolt 3.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Status" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The current status of the device.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="AuthFlags" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        Details of authorization information, including
	if they device was securily authorized via key
	verification ('secure') or does not support
	this method ('nokey'). The flag 'boot' indicates
	that the devices was already authorized by
	the firmware during pre-boot.
	If no downstream PCIe tunnels are authorized
	the 'nopcie' flag will be set.
      </doc:para></doc:description></doc:doc>
    </property>

    <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>

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

    <property name="Domain" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        When a device is connected, it always is connected
	via a thunderbolt domain, directly or via a chain of
	other devices. This is the identifier of the domain.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Stored" type="b" access="read">
      <doc:doc><doc:description><doc:para>
        Indication if the device is stored.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="Policy" type="s" access="readwrite">
      <doc:doc><doc:description><doc:para>
        The authorization policy of the device.
      </doc:para></doc:description></doc:doc>
    </property>

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

    <property name="Label" type="s" access="readwrite">
      <doc:doc><doc:description><doc:para>
        If set, a name that was given to the device by
	the user. Can only be set when device is stored.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="ConnectTime" type="t" access="read">
      <doc:doc><doc:description><doc:para>
        Point in time (since Epoch, in seconds) when the
	device was connected (0 if it is not connected).
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="AuthorizeTime" type="t" access="read">
      <doc:doc><doc:description><doc:para>
        Point in time (since Epoch, in seconds) when the
	device was authorized (0 if it is not authorized).
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="StoreTime" type="t" access="read">
      <doc:doc><doc:description><doc:para>
        Point in time (since Epoch, in seconds) when the
	device was stored (0 if it is not stored).
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="LinkSpeed" type="a{su}" access="read">
      <doc:doc><doc:description><doc:para>
        Information about the link speed, i.e. with how
	many lanes the device is connected to its parent
	and what rate (in Gb/s) the lanes have. Separate
	information is reported for transmission (tx) and
	reception (rx). All lanes in one direction have
	the same rate.
      </doc:para></doc:description></doc:doc>
    </property>

    <!-- methods -->

    <method name="Authorize">

     <arg type='s' name='flags' direction='in'>
        <doc:doc><doc:summary>Control aspects of authorization.</doc:summary>
        </doc:doc>
     </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            Authorize the device.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

  </interface>

  <interface name="org.freedesktop.bolt1.Domain">

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

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

    <property name="Id" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The (sysfs) id of the domain.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="SysfsPath" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The sysfs path of the domain, if it is connected.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="SecurityLevel" type="s" access="read">
      <doc:doc><doc:description><doc:para>
        The security level of the domain.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="BootACL" type="as" access="readwrite">
      <doc:doc><doc:description><doc:para>
        The boot access control list.
      </doc:para></doc:description></doc:doc>
    </property>

    <property name="IOMMU" type="b" access="read">
      <doc:doc><doc:description><doc:para>
        The input output memory management unit (IOMMU)
	can used on recent hardware in combination with
	recent kernel versions to protect against attacks,
	like direct memory access (DMA) attacks, at the
	hardware level. If this property is true than
	IOMMU hardware protection is active.
      </doc:para></doc:description></doc:doc>
    </property>

  </interface>

</node>