-
Notifications
You must be signed in to change notification settings - Fork 17
/
org.freedesktop.UDisks2.xml
2769 lines (2325 loc) · 124 KB
/
org.freedesktop.UDisks2.xml
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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">
<!--
Copyright (C) 2011 David Zeuthen <[email protected]>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General
Public License along with this library; if not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330,
Boston, MA 02111-1307, USA.
-->
<!-- ********************************************************************** -->
<!--
org.freedesktop.UDisks2.Manager:
@short_description: Manager singleton
Interface for top-level manager singleton object located at the
object path <literal>/org/freedesktop/UDisks2/Manager</literal>.
-->
<interface name="org.freedesktop.UDisks2.Manager">
<!-- Version: The version of the daemon currently running -->
<property name="Version" type="s" access="read"/>
<!-- SupportedFilesystems: List of supported filesystem by UDisks2 -->
<property name="SupportedFilesystems" type="as" access="read"/>
<!-- SupportedEncryptionTypes: List of supported encryption types by UDisks2 -->
<property name="SupportedEncryptionTypes" type="as" access="read"/>
<property name="DefaultEncryptionType" type="s" access="read"/>
<!--
CanFormat:
@type: The filesystem type to be tested for formatting availability.
@available: Formatting availability and the required binary name if missing (i.e. no error and returns FALSE).
@since: 2.7.2
Tests for availability to create the given filesystem.
See the #org.freedesktop.UDisks2.Manager:SupportedFilesystems property
for a list of known types. Unknown or unsupported filesystems result in an error.
-->
<method name="CanFormat">
<arg name="type" direction="in" type="s"/>
<arg name="available" direction="out" type="(bs)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QPair<bool, QString>"/>
</method>
<!--
CanResize:
@type: The filesystem type to be tested for resize availability.
@available: Resizing availability, flags for allowed resizing (i.e. growing/shrinking support for online/offline) and the required binary name if missing (i.e. no error and returns FALSE).
@since: 2.7.2
Tests for availability to resize the given filesystem.
The mode flags indicate if growing and/or shriking resize is available if mounted/unmounted.
The mode corresponds to bitwise-OR combined BDFsResizeFlags of the libblockdev FS plugin:
BD_FS_OFFLINE_SHRINK = 2, shrinking resize allowed when unmounted
BD_FS_OFFLINE_GROW = 4, growing resize allowed when unmounted
BD_FS_ONLINE_SHRINK = 8, shrinking resize allowed when mounted
BD_FS_ONLINE_GROW = 16, growing resize allowed when mounted
Unknown filesystems or filesystems which do not support resizing result in errors.
-->
<method name="CanResize">
<arg name="type" direction="in" type="s"/>
<arg name="available" direction="out" type="(bts)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QPair<bool, QPair<quint64, QString>>"/>
</method>
<!--
CanCheck:
@type: The filesystem type to be tested for consistency check availability.
@available: Checking availability and the required binary name if missing (i.e. no error and returns FALSE).
@since: 2.7.2
Tests for availability to check the given filesystem.
Unsupported filesystems or filesystems which do not support checking result in errors.
-->
<method name="CanCheck">
<arg name="type" direction="in" type="s"/>
<arg name="available" direction="out" type="(bs)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QPair<bool, QString>"/>
</method>
<!--
CanRepair:
@type: The filesystem type to be tested for repair availability.
@available: Repair availability and the required binary name if missing (i.e. no error and returns FALSE).
@since: 2.7.2
Tests for availability repair the given filesystem.
Unsupported filesystems or filesystems which do not support repairing result in errors.
-->
<method name="CanRepair">
<arg name="type" direction="in" type="s"/>
<arg name="available" direction="out" type="(bs)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QPair<bool, QString>"/>
</method>
<!--
LoopSetup:
@fd: An index for the file descriptor to use.
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>offset</parameter> (of type 't'), <parameter>size</parameter> (of type 't'), <parameter>read-only</parameter> (of type 'b') and <parameter>no-part-scan</parameter> (of type 'b').
@resulting_device: An object path to the object implementing the #org.freedesktop.UDisks2.Block interface.
Creates a block device for the file represented by @fd.
-->
<method name="LoopSetup">
<annotation name="org.gtk.GDBus.C.UnixFD" value="1"/>
<arg name="fd" direction="in" type="h"/>
<arg name="options" direction="in" type="a{sv}"/>
<arg name="resulting_device" direction="out" type="o"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
</method>
<!--
MDRaidCreate:
@blocks: An array of object paths to objects implementing the #org.freedesktop.UDisks2.Block interface.
@level: The RAID level for the array.
@name: The name for the array.
@chunk: The chunk size (in bytes) or 0 if @level is <quote>raid1</quote>.
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
@resulting_array: An object path to the object implementing the #org.freedesktop.UDisks2.MDRaid interface.
@since: 2.0.0
Creates a new RAID array on the block devices specified by
@blocks. Each element in this array must be an object path to
an object implementing the #org.freedesktop.UDisks2.Block
interface.
Known and supported values for @level include
<quote>raid0</quote>, <quote>raid1</quote>,
<quote>raid4</quote>, <quote>raid5</quote>,
<quote>raid6</quote> and <quote>raid10</quote>.
Before the array is created, all devices in @blocks are
erased. Once created (but before the method returns), the RAID
array will be erased.
-->
<method name="MDRaidCreate">
<arg name="blocks" direction="in" type="ao"/>
<arg name="level" direction="in" type="s"/>
<arg name="name" direction="in" type="s"/>
<arg name="chunk" direction="in" type="t"/>
<arg name="options" direction="in" type="a{sv}"/>
<arg name="resulting_array" direction="out" type="o"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In4" value="QVariantMap"/>
</method>
<!--
EnableModules:
@enable: A boolean value indicating whether modules should be enabled. Currently only the %TRUE value is permitted.
Loads and activates modules. This action also causes all objects to receive "add" uevent that triggers additional module interfaces activation.
Modules cannot be deactivated for the moment. Any consecutive calls with modules already enabled equals to noop.
-->
<method name="EnableModules">
<arg name="enable" direction="in" type="b"/>
</method>
<!--
GetBlockDevices:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
@since: 2.7.2
Get list of all block devices (object paths of objects implementing the #org.freedesktop.UDisks2.Block interface) known to UDisks.
-->
<method name="GetBlockDevices">
<arg name="options" direction="in" type="a{sv}"/>
<arg name="block_objects" direction="out" type="ao"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
<!--
ResolveDevice:
@devspec: Dictionary with specification of a device.
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
@devices: List of object paths of all devices matching @devspec.
@since: 2.7.3
Get device(s) matching specification given in @devspec.
Currently supported keys for @devspec include:
<variablelist>
<varlistentry>
<term>path (type <literal>'s'</literal>)</term>
<listitem><para>
Device path (e.g. <quote>/dev/sda</quote>). This also includes symlinks in <quote>/dev</quote>
(both #org.freedesktop.UDisks2.Block:Device and #org.freedesktop.UDisks2.Block:Symlinks are used).
</para></listitem>
</varlistentry>
<varlistentry>
<term>label (type <literal>'s'</literal>)</term>
<listitem><para>
Filesystem label. #org.freedesktop.UDisks2.Block:IdLabel is used.
</para></listitem>
</varlistentry>
<varlistentry>
<term>uuid (type <literal>'s'</literal>)</term>
<listitem><para>
Filesystem UUID. #org.freedesktop.UDisks2.Block:IdUUID is used.
</para></listitem>
</varlistentry>
</variablelist>
It is possbile to specify multiple keys. In this case, only devices matching all values will be returned.
-->
<method name="ResolveDevice">
<arg name="devspec" direction="in" type="a{sv}"/>
<arg name="options" direction="in" type="a{sv}"/>
<arg name="devices" direction="out" type="ao"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
</method>
</interface>
<!--
org.freedesktop.UDisks2.Drive:
@short_description: Disk drives
This interface is used to represent both hard disks and disk
drives (with or without removable media).
This interface should not to be confused with the
#org.freedesktop.UDisks2.Block interface that is used for
low-level block devices the OS knows about. For example, if
<filename>/dev/sda</filename> and <filename>/dev/sdb</filename>
are block devices for two paths to the same drive, there will be
only one #org.freedesktop.UDisks2.Drive object but two
#org.freedesktop.UDisks2.Block objects.
-->
<interface name="org.freedesktop.UDisks2.Drive">
<!-- Vendor: A name for the vendor of the drive or blank if unknown. -->
<property name="Vendor" type="s" access="read"/>
<!-- Model: A name for the model of the drive or blank if unknown. -->
<property name="Model" type="s" access="read"/>
<!-- Revision: Firmware Revision or blank if unknown. -->
<property name="Revision" type="s" access="read"/>
<!-- Serial: Serial number of the drive or blank if unknown. -->
<property name="Serial" type="s" access="read"/>
<!-- WWN:
The <ulink
url="http://en.wikipedia.org/wiki/World_Wide_Name">World Wide
Name</ulink> of the drive or blank if unknown.
-->
<property name="WWN" type="s" access="read"/>
<!-- Id:
A unique and persistent identifier for the device or blank if
no such identifier is available.
This identifier is guaranteed to not include the slash
character '/' (U+002F SOLIDUS) which means it can be used as
a filename.
Examples:
<quote>ST32000542AS-6XW00W51</quote>,
<quote>HITACHI-HTS723232A7A364-E3834563KRG2HN</quote>,
<quote>INTEL-SSDSA2MH080G1GC-CVEM842101HD080DGN</quote>.
-->
<property name="Id" type="s" access="read"/>
<!-- Configuration:
A set of configuration directives that are applied to the
drive when it is connected (e.g. at start-up, hotplug or
resume).
This is an dict of items with the following known keys:
<variablelist>
<varlistentry>
<term>ata-pm-standby (type <literal>'i'</literal>)</term>
<listitem><para>
The spindown timeout for ATA drives (See ATA command <quote>STANDBY</quote>).
</para></listitem>
</varlistentry>
<varlistentry>
<term>ata-apm-level (type <literal>'i'</literal>)</term>
<listitem><para>
The APM level for ATA drives (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x05 and 0x85).
</para></listitem>
</varlistentry>
<varlistentry>
<term>ata-aam-level (type <literal>'i'</literal>)</term>
<listitem><para>
The AAM level for ATA drives (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x42 and 0xc2).
</para></listitem>
</varlistentry>
<varlistentry>
<term>ata-write-cache-enabled (type <literal>'b'</literal>)</term>
<listitem><para>
Whether the write-cache is enabled (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x82 and 0x02). Since 2.1.
</para></listitem>
</varlistentry>
<varlistentry>
<term>ata-read-lookahead-enabled (type <literal>'b'</literal>)</term>
<listitem><para>
Whether the read look-ahead is enabled (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x55 and 0xaa). Since 2.1.7.
</para></listitem>
</varlistentry>
</variablelist>
The contents of this property is read from the configuration
file <filename>/etc/udisks2/IDENTIFIER.conf</filename>
where <emphasis>IDENTIFIER</emphasis> is the value of the
#org.freedesktop.UDisks2.Drive:Id property. See <xref
linkend="udisks.8"/> for the file format of this file.
Use the org.freedesktop.UDisks2.Drive.SetConfiguration()
method to change the value of this property.
-->
<property name="Configuration" type="a{sv}" access="read">
<annotation name="org.qtproject.QtDBus.QtTypeName" value="QVariantMap"/>
</property>
<!-- Media: The kind of media currently in the drive or blank if unknown.
See the #org.freedesktop.UDisks2.Drive:MediaCompatibility property for known values.
-->
<property name="Media" type="s" access="read"/>
<!-- MediaCompatibility:
The physical kind of media the drive uses or the type of the drive or blank if unknown.
Known values include
<variablelist>
<varlistentry><term>thumb</term><listitem><para>The device is a thumb-drive with non-removable media (e.g. a USB stick)</para></listitem></varlistentry>
<varlistentry><term>flash</term><listitem><para>Flash Card</para></listitem></varlistentry>
<varlistentry><term>flash_cf</term><listitem><para>CompactFlash</para></listitem></varlistentry>
<varlistentry><term>flash_ms</term><listitem><para>MemoryStick</para></listitem></varlistentry>
<varlistentry><term>flash_sm</term><listitem><para>SmartMedia</para></listitem></varlistentry>
<varlistentry><term>flash_sd</term><listitem><para>Secure Digital</para></listitem></varlistentry>
<varlistentry><term>flash_sdhc</term><listitem><para>Secure Digital High Capacity</para></listitem></varlistentry>
<varlistentry><term>flash_sdxc</term><listitem><para>Secure Digital eXtended Capacity</para></listitem></varlistentry>
<varlistentry><term>flash_mmc</term><listitem><para>MultiMediaCard</para></listitem></varlistentry>
<varlistentry><term>floppy</term><listitem><para>Floppy Disk</para></listitem></varlistentry>
<varlistentry><term>floppy_zip</term><listitem><para>Zip Disk</para></listitem></varlistentry>
<varlistentry><term>floppy_jaz</term><listitem><para>Jaz Disk</para></listitem></varlistentry>
<varlistentry><term>optical</term><listitem><para>Optical Disc</para></listitem></varlistentry>
<varlistentry><term>optical_cd</term><listitem><para>Compact Disc</para></listitem></varlistentry>
<varlistentry><term>optical_cd_r</term><listitem><para>Compact Disc Recordable</para></listitem></varlistentry>
<varlistentry><term>optical_cd_rw</term><listitem><para>Compact Disc Rewritable</para></listitem></varlistentry>
<varlistentry><term>optical_dvd</term><listitem><para>Digital Versatile Disc</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_r</term><listitem><para>DVD-R</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_rw</term><listitem><para>DVD-RW</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_ram</term><listitem><para>DVD-RAM</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_plus_r</term><listitem><para>DVD+R</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_plus_rw</term><listitem><para>DVD+RW</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_plus_r_dl</term><listitem><para>DVD+R Dual Layer</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_plus_rw_dl</term><listitem><para>DVD+RW Dual Layer</para></listitem></varlistentry>
<varlistentry><term>optical_bd</term><listitem><para>Blu-ray Disc</para></listitem></varlistentry>
<varlistentry><term>optical_bd_r</term><listitem><para>Blu-ray Recordable</para></listitem></varlistentry>
<varlistentry><term>optical_bd_re</term><listitem><para>Blu-ray Rewritable</para></listitem></varlistentry>
<varlistentry><term>optical_hddvd</term><listitem><para>HD-DVD</para></listitem></varlistentry>
<varlistentry><term>optical_hddvd_r</term><listitem><para>HD-DVD Recordable</para></listitem></varlistentry>
<varlistentry><term>optical_hddvd_rw</term><listitem><para>HD-DVD Rewritable</para></listitem></varlistentry>
<varlistentry><term>optical_mo</term><listitem><para>Magneto Optical</para></listitem></varlistentry>
<varlistentry><term>optical_mrw</term><listitem><para>Can read Mount Rainer media</para></listitem></varlistentry>
<varlistentry><term>optical_mrw_w</term><listitem><para>Can write Mount Rainer media</para></listitem></varlistentry>
</variablelist>
-->
<property name="MediaCompatibility" type="as" access="read"/>
<!-- MediaRemovable:
Whether the media can be removed from the drive.
Note that this may be overridden from what the hardware
reports - for example, USB thumb drives often report that
they are using removable media while in fact the media
is not removable.
-->
<property name="MediaRemovable" type="b" access="read"/>
<!-- MediaAvailable: Set to %FALSE if no medium is available.
This is always %TRUE if #org.freedesktop.UDisks2.Drive:MediaChangeDetected is %FALSE.
-->
<property name="MediaAvailable" type="b" access="read"/>
<!-- MediaChangeDetected: Set to %TRUE only if media changes are detected.
Media changes are detected on all modern disk drives through
either polling or an asynchronous notification mechanism. The
only known disk drives that cannot report media changes are
PC floppy drives.
-->
<property name="MediaChangeDetected" type="b" access="read"/>
<!-- Size: The size of the drive (or the media currently in the drive).
This is always 0 if #org.freedesktop.UDisks2.Drive:MediaChangeDetected is %FALSE.
-->
<property name="Size" type="t" access="read"/>
<!-- TimeDetected: The time the drive was first detected.
This is expressed in micro-seconds since the Epoch Jan 1, 1970 0:00 UTC.
-->
<property name="TimeDetected" type="t" access="read"/>
<!-- TimeMediaDetected: The earliest time media was last detected or 0 if media is not available.
This is expressed in micro-seconds since the Epoch Jan 1, 1970 0:00 UTC.
-->
<property name="TimeMediaDetected" type="t" access="read"/>
<!-- Optical: %TRUE if the drive contains an optical disc. -->
<property name="Optical" type="b" access="read"/>
<!-- OpticalBlank: %TRUE if the disc is blank.
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE.
-->
<property name="OpticalBlank" type="b" access="read"/>
<!-- OpticalNumTracks: The number of tracks.
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE.
-->
<property name="OpticalNumTracks" type="u" access="read"/>
<!-- OpticalNumAudioTracks: The number of audio tracks.
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE.
-->
<property name="OpticalNumAudioTracks" type="u" access="read"/>
<!-- OpticalNumDataTracks: The number of data tracks.
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE.
-->
<property name="OpticalNumDataTracks" type="u" access="read"/>
<!-- OpticalNumSessions: The number of sessions.
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE.
-->
<property name="OpticalNumSessions" type="u" access="read"/>
<!-- RotationRate: The rotational rate of the drive.
<itemizedlist>
<listitem><para>-1 if known to be rotating media but rotation rate isn't known</para></listitem>
<listitem><para>0 if known to be non-rotating media</para></listitem>
<listitem><para>the rotation rate in rounds per minute otherwise</para></listitem>
</itemizedlist>
-->
<property name="RotationRate" type="i" access="read"/>
<!-- ConnectionBus:
The physical connection bus used for the drive as seen by the
user. This is typically used to draw a USB or Firewire emblem
on top of an icon in an user interface.
Note that this property has <emphasis>nothing</emphasis> to do
with the low-level command-set used (such as ATA-8) or what
low-level connection bus (such as SATA, eSATA, PATA, SAS2 etc)
is used.
Known values include:
<variablelist>
<varlistentry><term>usb</term><listitem><para>Connected via <ulink url="http://en.wikipedia.org/wiki/USB">USB</ulink></para></listitem></varlistentry>
<varlistentry><term>sdio</term><listitem><para>Connected via <ulink url="http://en.wikipedia.org/wiki/Secure_Digital#SDIO">SDIO</ulink></para></listitem></varlistentry>
<varlistentry><term>ieee1394</term><listitem><para>Connected via <ulink url="http://en.wikipedia.org/wiki/Firewire">Firewire</ulink></para></listitem></varlistentry>
</variablelist>
-->
<property name="ConnectionBus" type="s" access="read"/>
<!-- Seat:
A string identifying what seat the drive is plugged into, if any.
-->
<property name="Seat" type="s" access="read"/>
<!--
Removable:
A hint whether the drive and/or its media is considered
<emphasis>removable</emphasis> by the user.
This includes drives with removable media (cf. the
#org.freedesktop.UDisks2.Drive:MediaRemovable property), Flash
media such as SD cards and drives on hotpluggable buses such
as USB or Firewire (cf. the
#org.freedesktop.UDisks2.Drive:ConnectionBus property).
Note that this is only a <emphasis>guess</emphasis>.
-->
<property name="Removable" type="b" access="read"/>
<!-- Ejectable:
Whether the media can be ejected from the drive or the drive
accepts an eject command to switch its state so it displays
e.g. a "Safe To Remove" message to the user.
Note that this is only a <emphasis>guess</emphasis>.
-->
<property name="Ejectable" type="b" access="read"/>
<!-- SortKey:
A string that can be used for sorting drive objects.
-->
<property name="SortKey" type="s" access="read"/>
<!--
Eject:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Ejects media from the drive. This is only meaningful to do on
drives with removable media.
There are not a lot of guarantees associated with this method
so it should only be called in response to an user action.
On some hardware the media may be physically ejected while on
other hardware may simply eject the disc. On some hardware it
may not do anything physical but it may cause e.g. a display
on the hardware to show e.g. <quote>It is now safe to remove
the device</quote>.
-->
<method name="Eject">
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
<!--
SetConfiguration:
@value: The configuration value to set.
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Sets the configuration for the drive. This will store the
configuration in the file-system and also apply it to the
drive.
See the #org.freedesktop.UDisks2.Drive:Configuration property
for details about valid values and the location of the
configuration file that @value will be written to.
-->
<method name="SetConfiguration">
<arg name="value" direction="in" type="a{sv}"/>
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
</method>
<!--
PowerOff:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
@since: 2.0.0
Arranges for the drive to be safely removed and powered
off. On the OS side this includes ensuring that no process is
using the drive, then requesting that in-flight buffers and
caches are committed to stable storage. The exact steps for
powering off the drive depends on the drive itself and the
interconnect used. For drives connected through USB, the
effect is that the USB device will be deconfigured followed by
disabling the upstream hub port it is connected to.
Note that as some physical devices contain multiple drives
(for example 4-in-1 flash card reader USB devices) powering
off one drive may affect other drives. Applications can
examine the #org.freedesktop.UDisks2.Drive:SiblingId property
to determine such relationships.
There are not a lot of guarantees associated with this method
so it should only be called in response to an user
action. Usually the effect is that the drive disappears as if
it was unplugged.
This method only works if the
#org.freedesktop.UDisks2.Drive:CanPowerOff property
is set to %TRUE.
-->
<method name="PowerOff">
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
<!-- CanPowerOff:
@since: 2.0.0
Whether the drive can be safely removed / powered off. See
the org.freedesktop.UDisks2.Drive.PowerOff() method for more
information.
See <xref linkend="udisks.8"/> for how to influence the value of this property.
-->
<property name="CanPowerOff" type="b" access="read"/>
<!-- SiblingId:
@since: 2.0.0
An opaque token that, if non-blank, is used to group drives
that are part of the same physical device.
-->
<property name="SiblingId" type="s" access="read"/>
</interface>
<!--
org.freedesktop.UDisks2.Drive.Ata:
@short_description: Disk drives using the ATA command-set
Objects implementing this interface also implement the
#org.freedesktop.UDisks2.Drive interface.
-->
<interface name="org.freedesktop.UDisks2.Drive.Ata">
<!-- SmartSupported: Whether the drive supports SMART. -->
<property name="SmartSupported" type="b" access="read"/>
<!-- SmartEnabled: Whether SMART is enabled. -->
<property name="SmartEnabled" type="b" access="read"/>
<!-- SmartUpdated:
The point in time (seconds since the
<ulink url="http://en.wikipedia.org/wiki/Unix_epoch">Unix Epoch</ulink>)
that the SMART status was updated or 0 if never updated.
The value of the other properties related to SMART are not
meaningful if this proeprty is 0.
-->
<property name="SmartUpdated" type="t" access="read"/>
<!-- SmartFailing:
Set to %TRUE if disk is about to fail.
This value is read from the disk itself and does not include
any interpretation.
-->
<property name="SmartFailing" type="b" access="read"/>
<!-- SmartPowerOnSeconds:
The amount of time the disk has been powered on (according to SMART data) or 0 if unknown.
-->
<property name="SmartPowerOnSeconds" type="t" access="read"/>
<!-- SmartTemperature:
The temperature (in Kelvin) of the disk according to SMART data or 0 if unknown.
-->
<property name="SmartTemperature" type="d" access="read"/>
<!--
SmartNumAttributesFailing:
The number of attributes failing right now or -1 if unknown.
-->
<property name="SmartNumAttributesFailing" type="i" access="read"/>
<!--
SmartNumAttributesFailedInThePast:
The number of attributes that have failed in the past or -1 if unknown.
-->
<property name="SmartNumAttributesFailedInThePast" type="i" access="read"/>
<!--
SmartNumBadSectors:
The number of bad sectors (ie. pending and reallocated) or -1 if unknown.
-->
<property name="SmartNumBadSectors" type="x" access="read"/>
<!-- SmartSelftestStatus:
The status of the last self-test. Known values include
<variablelist>
<varlistentry><term>success</term>
<listitem><para>Last self-test was a success (or never ran).</para></listitem></varlistentry>
<varlistentry><term>aborted</term>
<listitem><para>Last self-test was aborted.</para></listitem></varlistentry>
<varlistentry><term>interrupted</term>
<listitem><para>Last self-test was interrupted.</para></listitem></varlistentry>
<varlistentry><term>fatal</term>
<listitem><para>Last self-test did not complete.</para></listitem></varlistentry>
<varlistentry><term>error_unknown</term>
<listitem><para>Last self-test failed (Unknown).</para></listitem></varlistentry>
<varlistentry><term>error_electrical</term>
<listitem><para>Last self-test failed (Electrical).</para></listitem></varlistentry>
<varlistentry><term>error_servo</term>
<listitem><para>Last self-test failed (Servo).</para></listitem></varlistentry>
<varlistentry><term>error_read</term>
<listitem><para>Last self-test failed (Read).</para></listitem></varlistentry>
<varlistentry><term>error_handling</term>
<listitem><para>Last self-test failed (Damage).</para></listitem></varlistentry>
<varlistentry><term>inprogress</term>
<listitem><para>Self-test is currently in progress.</para></listitem></varlistentry>
</variablelist>
-->
<property name="SmartSelftestStatus" type="s" access="read"/>
<!--
SmartSelftestPercentRemaining:
The percent remaining or -1 if unknown.
-->
<property name="SmartSelftestPercentRemaining" type="i" access="read"/>
<!--
SmartUpdate:
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>nowakeup</parameter> (of type 'b').
Reads SMART data from the drive and update relevant properties.
If the option @nowakeup is given and the disk is in a sleeping
state, the error
<literal>org.freedesktop.UDisks2.Error.WouldWakeup</literal> is
returned.
The option @atasmart_blob can be used to inject libatasmart
compatible blobs for testing how clients react to different
kinds of SMART data. This option may be removed in the future
without it being considered an ABI break.
-->
<method name="SmartUpdate">
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
<!--
SmartGetAttributes:
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>nowakeup</parameter> (of type 'b').
@attributes: The SMART attributes.
Get the SMART attributes.
Each attribute is a struct with the following members:
<variablelist>
<varlistentry><term>id (type 'y')</term>
<listitem><para>Attribute Identifier</para></listitem></varlistentry>
<varlistentry><term>name (type 's')</term>
<listitem><para>The identifier as a string.</para></listitem></varlistentry>
<varlistentry><term>flags (type 'q')</term>
<listitem><para>16-bit attribute flags (bit 0 is prefail/oldage, bit 1 is online/offline).</para></listitem></varlistentry>
<varlistentry><term>value (type 'i')</term>
<listitem><para>The current value or -1 if unknown.</para></listitem></varlistentry>
<varlistentry><term>worst (type 'i')</term>
<listitem><para>The worst value of -1 if unknown.</para></listitem></varlistentry>
<varlistentry><term>threshold (type 'i')</term>
<listitem><para>The threshold or -1 if unknown.</para></listitem></varlistentry>
<varlistentry><term>pretty (type 'x')</term>
<listitem><para>An interpretation of the value - must be ignored if @pretty_unit is 0.</para></listitem></varlistentry>
<varlistentry><term>pretty_unit (type 'i')</term>
<listitem><para>The unit of the @pretty value - the following units are known: 0 (unknown), 1 (dimensionless), 2 (milliseconds), 3 (sectors), 4 (millikelvin).</para></listitem></varlistentry>
<varlistentry><term>expansion (type 'a{sv}')</term>
<listitem><para>Currently unused. Intended for future expansion.</para></listitem></varlistentry>
</variablelist>
The @name parameter should be used as the authoritative identifier for the attribute since it is derived from the numerical @id and the disk's <literal>IDENTIFY</literal> data and thus handles ID collisions between drives of different make and model.
-->
<method name="SmartGetAttributes">
<arg name="options" direction="in" type="a{sv}"/>
<arg name="attributes" direction="out" type="a(ysqiiixia{sv})"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList<UDisks2::SmartAttribute>"/>
</method>
<!--
SmartSelftestStart:
@type: The type test to run.
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Starts a SMART selftest. The @type parameter is for the type
of test to start - valid values are <literal>short</literal>,
<literal>extended</literal> and <literal>conveyance</literal>.
Note that the method returns immediately after the test has
been started successfully.
-->
<method name="SmartSelftestStart">
<arg name="type" direction="in" type="s"/>
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
</method>
<!--
SmartSelftestAbort:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Aborts a running SMART selftest.
-->
<method name="SmartSelftestAbort">
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
<!--
SmartSetEnabled:
@value: %TRUE to enable SMART, %FALSE to disable SMART.
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
@since: 2.0.0
Sets whether SMART is enabled for the drive. This setting is
stored in the non-volatile memory in the drive itself and does
not need to be refreshed every time the drive is powered on or
connected.
Since this may require authentication and thus may fail, it is
implemented this way instead of the
#org.freedesktop.UDisks2.Drive.Ata:SmartEnabled property being
writable.
-->
<method name="SmartSetEnabled">
<arg name="value" direction="in" type="b"/>
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
</method>
<!-- PmSupported: Whether the drive supports power management. -->
<property name="PmSupported" type="b" access="read"/>
<!-- PmEnabled: Whether power management is enabled. -->
<property name="PmEnabled" type="b" access="read"/>
<!-- ApmSupported: Whether the drive supports Advanced Power Management (APM). -->
<property name="ApmSupported" type="b" access="read"/>
<!-- ApmEnabled: Whether Advanced Power Management (APM) is enabled. -->
<property name="ApmEnabled" type="b" access="read"/>
<!-- AamSupported: Whether the drive supports Automatic Acoustic Management (AAM). -->
<property name="AamSupported" type="b" access="read"/>
<!-- AamEnabled: Whether Automatic Acoustic Management (AAM) is enabled. -->
<property name="AamEnabled" type="b" access="read"/>
<!-- AamVendorRecommendedValue: The vendor-recommended AAM value (or 0 if AAM is not supported). -->
<property name="AamVendorRecommendedValue" type="i" access="read"/>
<!-- WriteCacheSupported:
@since: 2.0.0
Whether the drive supports configuring the write cache.
-->
<property name="WriteCacheSupported" type="b" access="read"/>
<!-- WriteCacheEnabled:
@since: 2.0.0
Whether the write-cache is enabled (or %FALSE if not supported).
-->
<property name="WriteCacheEnabled" type="b" access="read"/>
<!-- ReadLookaheadSupported:
@since: 2.1.7
Whether the drive supports configuring the read look-ahead.
-->
<property name="ReadLookaheadSupported" type="b" access="read"/>
<!-- ReadLookaheadEnabled:
@since: 2.1.7
Whether the read look-ahead is enabled (or %FALSE if not supported).
-->
<property name="ReadLookaheadEnabled" type="b" access="read"/>
<!--
PmGetState:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
@state: The current power state.
Get the current power mode status. This is implemented as a
method call as it involves sending a command from the host to
the drive and no change notification is available.
The format of @state is the result obtained from sending the
ATA command <quote>CHECK POWER MODE</quote> to the drive.
Known values include
<variablelist>
<varlistentry><term>0x00</term><listitem><para>Standby</para></listitem></varlistentry>
<varlistentry><term>0x80</term><listitem><para>Idle</para></listitem></varlistentry>
<varlistentry><term>0xff</term><listitem><para>Active/Idle</para></listitem></varlistentry>
</variablelist>
Typically user interfaces will report "Drive is spun down" if @state is
0x00 and "Drive is spun up" otherwise.
-->
<method name="PmGetState">
<arg name="options" direction="in" type="a{sv}"/>
<arg name="state" direction="out" type="y"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
<!--
PmStandby:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Force the drive to immediately enter the low power consumption
<emphasis>standby</emphasis> mode, usually causing it to spin
down. This is done by sending the ATA command
<quote>STANDBY IMMEDIATE</quote> to the drive.
-->
<method name="PmStandby">
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
<!--
PmWakeup:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Force the drive to immediately wake up (exiting the low power
consumption <emphasis>standby</emphasis> mode), usually
causing it to spin up. This is done by reading data from the
disk.
-->
<method name="PmWakeup">
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
<!-- SecurityEraseUnitMinutes:
The estimated amount of minutes it takes to complete the
<quote>SECURITY ERASE UNIT</quote> command or 0 if this
command is not available.
If set to 510 it means that it takes at least 508 minutes to
complete the operation.
-->
<property name="SecurityEraseUnitMinutes" type="i" access="read"/>
<!-- SecurityEnhancedEraseUnitMinutes:
The estimated amount of minutes it takes to complete the
<quote>SECURITY ERASE UNIT</quote> command with enhanced mode
specified or 0 if enhanced erase is not available.
If set to 510 it means that it takes at least 508 minutes to
complete the operation.
-->
<property name="SecurityEnhancedEraseUnitMinutes" type="i" access="read"/>
<!-- SecurityFrozen:
If set to %TRUE the unit is frozen.
-->
<property name="SecurityFrozen" type="b" access="read"/>
<!--
SecurityEraseUnit:
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>enhanced</parameter> (of type 'b').
Does all the necessary checks and preparations and then sends
the <quote>SECURITY ERASE UNIT</quote> command to the
drive. If the option @enhanced is set to %TRUE an
<emphasis>enhanced secure erase</emphasis> is requested.
All data on the drive will be irrevocably erased.
This operation takes either
#org.freedesktop.UDisks2.Drive.Ata:SecurityEraseUnitMinutes or
#org.freedesktop.UDisks2.Drive.Ata:SecurityEnhancedEraseUnitMinutes
minutes to complete depending on whether the @enhanced option
is %TRUE.
-->
<method name="SecurityEraseUnit">
<arg name="options" direction="in" type="a{sv}"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
</method>
</interface>
<!-- ********************************************************************** -->
<!--
org.freedesktop.UDisks2.Block:
@short_description: Block device
This interface represents a block device.
This should not be confused with the
#org.freedesktop.UDisks2.Drive interface that is used to represent
disk drives. For example, the #org.freedesktop.UDisks2.Block
interface is also used for block devices that do not correspond to
drives at all (e.g. <ulink
url="http://en.wikipedia.org/wiki/Loop_device">Loop
Devices</ulink>).
-->
<interface name="org.freedesktop.UDisks2.Block">
<!-- Device: The special device file for the block device e.g. <filename>/dev/sda2</filename>. -->
<property name="Device" type="ay" access="read"/>
<!-- PreferredDevice:
The special device file to present in the UI instead of the value
of the #org.freedesktop.UDisks2.Block:Device property.
For example this could be
e.g. <filename>/dev/mapper/mpathk</filename> for a multipath
device with special device file <filename>/dev/dm-9</filename>.
-->
<property name="PreferredDevice" type="ay" access="read"/>
<!-- Symlinks:
Known symlinks in <filename>/dev</filename> that points to
the device file in the
#org.freedesktop.UDisks2.Block:Device property.
For example, this array could include symlinks such as
<filename>/dev/disk/by-id/ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</filename>
and
<filename>/dev/disk/by-id/wwn-0x5001517387d61905</filename>.
-->
<property name="Symlinks" type="aay" access="read">
<annotation name="org.qtproject.QtDBus.QtTypeName" value="QByteArrayList"/>
</property>
<!-- DeviceNumber: The dev_t of the block device. -->
<property name="DeviceNumber" type="t" access="read"/>
<!-- Id:
@since: 2.0.0
A unique and persistent identifier for the device or blank if
no such identifier is available.