~behda/+junk/udisks2.original

« back to all changes in this revision

Viewing changes to doc/html/gdbus-org.freedesktop.UDisks2.Drive.Ata.html

  • Committer: behda
  • Date: 2014-05-24 15:15:11 UTC
  • Revision ID: pauvitk@gmail.com-20140524151511-3vtr0uubjewx3z2j
Initial commit of source code and Debian packaging.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>UDisks Reference Manual: org.freedesktop.UDisks2.Drive.Ata</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 
7
<link rel="home" href="index.html" title="UDisks Reference Manual">
 
8
<link rel="up" href="ch02.html" title="D-Bus Interfaces">
 
9
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Drive.html" title="org.freedesktop.UDisks2.Drive">
 
10
<link rel="next" href="gdbus-org.freedesktop.UDisks2.MDRaid.html" title="org.freedesktop.UDisks2.MDRaid">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#gdbus-org.freedesktop.UDisks2.Drive.Ata.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span> 
 
19
                  <a href="#gdbus-org.freedesktop.UDisks2.Drive.Ata.properties" class="shortcut">Properties</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Drive.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.MDRaid.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
 
26
<div class="refentry">
 
27
<a name="gdbus-org.freedesktop.UDisks2.Drive.Ata"></a><div class="titlepage"></div>
 
28
<div class="refnamediv"><table width="100%"><tr>
 
29
<td valign="top">
 
30
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Drive-Ata.top_of_page"></a>org.freedesktop.UDisks2.Drive.Ata</span></h2>
 
31
<p>org.freedesktop.UDisks2.Drive.Ata — Disk drives using the ATA command-set</p>
 
32
</td>
 
33
<td class="gallery_image" valign="top" align="right"></td>
 
34
</tr></table></div>
 
35
<div class="refsynopsisdiv">
 
36
<h2>Methods</h2>
 
37
<pre class="synopsis">
 
38
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartUpdate" title="The SmartUpdate() method">SmartUpdate</a>        (IN  a{sv}            options);
 
39
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartGetAttributes" title="The SmartGetAttributes() method">SmartGetAttributes</a> (IN  a{sv}            options,
 
40
                    OUT a(ysqiiixia{sv}) attributes);
 
41
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestStart" title="The SmartSelftestStart() method">SmartSelftestStart</a> (IN  s                type,
 
42
                    IN  a{sv}            options);
 
43
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestAbort" title="The SmartSelftestAbort() method">SmartSelftestAbort</a> (IN  a{sv}            options);
 
44
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSetEnabled" title="The SmartSetEnabled() method">SmartSetEnabled</a>    (IN  b                value,
 
45
                    IN  a{sv}            options);
 
46
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmGetState" title="The PmGetState() method">PmGetState</a>         (IN  a{sv}            options,
 
47
                    OUT y                state);
 
48
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmStandby" title="The PmStandby() method">PmStandby</a>          (IN  a{sv}            options);
 
49
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmWakeup" title="The PmWakeup() method">PmWakeup</a>           (IN  a{sv}            options);
 
50
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SecurityEraseUnit" title="The SecurityEraseUnit() method">SecurityEraseUnit</a>  (IN  a{sv}            options);
 
51
</pre>
 
52
</div>
 
53
<div class="refsect1">
 
54
<a name="id-1.3.3.4.4"></a><h2>Properties</h2>
 
55
<pre class="synopsis">
 
56
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSupported" title='The "SmartSupported" property'>SmartSupported</a>                     readable   b
 
57
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartEnabled" title='The "SmartEnabled" property'>SmartEnabled</a>                       readable   b
 
58
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartUpdated" title='The "SmartUpdated" property'>SmartUpdated</a>                       readable   t
 
59
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartFailing" title='The "SmartFailing" property'>SmartFailing</a>                       readable   b
 
60
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartPowerOnSeconds" title='The "SmartPowerOnSeconds" property'>SmartPowerOnSeconds</a>                readable   t
 
61
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartTemperature" title='The "SmartTemperature" property'>SmartTemperature</a>                   readable   d
 
62
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumAttributesFailing" title='The "SmartNumAttributesFailing" property'>SmartNumAttributesFailing</a>          readable   i
 
63
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumAttributesFailedInThePast" title='The "SmartNumAttributesFailedInThePast" property'>SmartNumAttributesFailedInThePast</a>  readable   i
 
64
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumBadSectors" title='The "SmartNumBadSectors" property'>SmartNumBadSectors</a>                 readable   x
 
65
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestStatus" title='The "SmartSelftestStatus" property'>SmartSelftestStatus</a>                readable   s
 
66
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestPercentRemaining" title='The "SmartSelftestPercentRemaining" property'>SmartSelftestPercentRemaining</a>      readable   i
 
67
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.PmSupported" title='The "PmSupported" property'>PmSupported</a>                        readable   b
 
68
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.PmEnabled" title='The "PmEnabled" property'>PmEnabled</a>                          readable   b
 
69
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ApmSupported" title='The "ApmSupported" property'>ApmSupported</a>                       readable   b
 
70
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ApmEnabled" title='The "ApmEnabled" property'>ApmEnabled</a>                         readable   b
 
71
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamSupported" title='The "AamSupported" property'>AamSupported</a>                       readable   b
 
72
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamEnabled" title='The "AamEnabled" property'>AamEnabled</a>                         readable   b
 
73
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamVendorRecommendedValue" title='The "AamVendorRecommendedValue" property'>AamVendorRecommendedValue</a>          readable   i
 
74
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.WriteCacheSupported" title='The "WriteCacheSupported" property'>WriteCacheSupported</a>                readable   b
 
75
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.WriteCacheEnabled" title='The "WriteCacheEnabled" property'>WriteCacheEnabled</a>                  readable   b
 
76
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityEraseUnitMinutes" title='The "SecurityEraseUnitMinutes" property'>SecurityEraseUnitMinutes</a>           readable   i
 
77
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityEnhancedEraseUnitMinutes" title='The "SecurityEnhancedEraseUnitMinutes" property'>SecurityEnhancedEraseUnitMinutes</a>   readable   i
 
78
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityFrozen" title='The "SecurityFrozen" property'>SecurityFrozen</a>                     readable   b
 
79
</pre>
 
80
</div>
 
81
<div class="refsect1">
 
82
<a name="gdbus-interface-org-freedesktop-UDisks2-Drive-Ata"></a><h2>Description</h2>
 
83
<p>    Objects implementing this interface also implement the
 
84
    <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</a> interface.
 
85
</p>
 
86
</div>
 
87
<div class="refsect1">
 
88
<a name="gdbus-methods-org.freedesktop.UDisks2.Drive.Ata"></a><h2>Method Details</h2>
 
89
<div class="refsect2">
 
90
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartUpdate"></a><h3>The SmartUpdate() method</h3>
 
91
<pre class="programlisting">
 
92
SmartUpdate (IN  a{sv} options);
 
93
</pre>
 
94
<p>        Reads SMART data from the drive and update relevant properties.
 
95
</p>
 
96
<p>        If the option <em class="parameter"><code>nowakeup</code></em> is given and the disk is in a sleeping
 
97
        state, the error
 
98
        <code class="literal">org.freedesktop.UDisks2.Error.WouldWakeup</code> is
 
99
        returned.
 
100
</p>
 
101
<p>        The option <em class="parameter"><code>atasmart_blob</code></em> can be used to inject libatasmart
 
102
        compatible blobs for testing how clients react to different
 
103
        kinds of SMART data. This option may be removed in the future
 
104
        with it being considered an ABI break.
 
105
</p>
 
106
<div class="variablelist"><table border="0" class="variablelist">
 
107
<colgroup>
 
108
<col align="left" valign="top">
 
109
<col>
 
110
</colgroup>
 
111
<tbody><tr>
 
112
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
113
<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>nowakeup</code></em> (of type 'b').</p></td>
 
114
</tr></tbody>
 
115
</table></div>
 
116
</div>
 
117
<hr>
 
118
<div class="refsect2">
 
119
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartGetAttributes"></a><h3>The SmartGetAttributes() method</h3>
 
120
<pre class="programlisting">
 
121
SmartGetAttributes (IN  a{sv}            options,
 
122
                    OUT a(ysqiiixia{sv}) attributes);
 
123
</pre>
 
124
<p>        Get the SMART attributes.
 
125
        Each attribute is a struct with the following members:
 
126
        </p>
 
127
<div class="variablelist"><table border="0" class="variablelist">
 
128
<colgroup>
 
129
<col align="left" valign="top">
 
130
<col>
 
131
</colgroup>
 
132
<tbody>
 
133
<tr>
 
134
<td><p><span class="term">id (type 'y')</span></p></td>
 
135
<td><p>Attribute Identifier</p></td>
 
136
</tr>
 
137
<tr>
 
138
<td><p><span class="term">name (type 's')</span></p></td>
 
139
<td><p>The identifier as a string.</p></td>
 
140
</tr>
 
141
<tr>
 
142
<td><p><span class="term">flags (type 'q')</span></p></td>
 
143
<td><p>16-bit attribute flags (bit 0 is prefail/oldage, bit 1 is online/offline).</p></td>
 
144
</tr>
 
145
<tr>
 
146
<td><p><span class="term">value (type 'i')</span></p></td>
 
147
<td><p>The current value or -1 if unknown.</p></td>
 
148
</tr>
 
149
<tr>
 
150
<td><p><span class="term">worst (type 'i')</span></p></td>
 
151
<td><p>The worst value of -1 if unknown.</p></td>
 
152
</tr>
 
153
<tr>
 
154
<td><p><span class="term">threshold (type 'i')</span></p></td>
 
155
<td><p>The threshold or -1 if unknown.</p></td>
 
156
</tr>
 
157
<tr>
 
158
<td><p><span class="term">pretty (type 'x')</span></p></td>
 
159
<td><p>An interpretation of the value - must be ignored if <em class="parameter"><code>pretty_unit</code></em> is 0.</p></td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><span class="term">pretty_unit (type 'i')</span></p></td>
 
163
<td><p>The unit of the <em class="parameter"><code>pretty</code></em> value - the following units are known: 0 (unknown), 1 (dimensionless), 2 (milliseconds), 3 (sectors), 4 (millikelvin).</p></td>
 
164
</tr>
 
165
<tr>
 
166
<td><p><span class="term">expansion (type 'a{sv}')</span></p></td>
 
167
<td><p>Currently unused. Intended for future expansion.</p></td>
 
168
</tr>
 
169
</tbody>
 
170
</table></div>
 
171
<p>
 
172
        The <em class="parameter"><code>name</code></em> parameter should be used as the authoritative identifier for the attribute since it is derived from the numerical <em class="parameter"><code>id</code></em> and the disk's <code class="literal">IDENTIFY</code> data and thus handles ID collisions between drives of different make and model.
 
173
</p>
 
174
<div class="variablelist"><table border="0" class="variablelist">
 
175
<colgroup>
 
176
<col align="left" valign="top">
 
177
<col>
 
178
</colgroup>
 
179
<tbody>
 
180
<tr>
 
181
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
182
<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>nowakeup</code></em> (of type 'b').</p></td>
 
183
</tr>
 
184
<tr>
 
185
<td><p><span class="term"><code class="literal">OUT a(ysqiiixia{sv}) <em class="parameter"><code>attributes</code></em></code>:</span></p></td>
 
186
<td><p>The SMART attributes.</p></td>
 
187
</tr>
 
188
</tbody>
 
189
</table></div>
 
190
</div>
 
191
<hr>
 
192
<div class="refsect2">
 
193
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestStart"></a><h3>The SmartSelftestStart() method</h3>
 
194
<pre class="programlisting">
 
195
SmartSelftestStart (IN  s     type,
 
196
                    IN  a{sv} options);
 
197
</pre>
 
198
<p>        Starts a SMART selftest. The <em class="parameter"><code>type</code></em> parameter is for the type
 
199
        of test to start - valid values are <code class="literal">short</code>,
 
200
        <code class="literal">extended</code> and <code class="literal">conveyance</code>.
 
201
</p>
 
202
<p>        Note that the method returns immediately after the test has
 
203
        been started successfully.
 
204
</p>
 
205
<div class="variablelist"><table border="0" class="variablelist">
 
206
<colgroup>
 
207
<col align="left" valign="top">
 
208
<col>
 
209
</colgroup>
 
210
<tbody>
 
211
<tr>
 
212
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
 
213
<td><p>The type test to run.</p></td>
 
214
</tr>
 
215
<tr>
 
216
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
217
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
 
218
</tr>
 
219
</tbody>
 
220
</table></div>
 
221
</div>
 
222
<hr>
 
223
<div class="refsect2">
 
224
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestAbort"></a><h3>The SmartSelftestAbort() method</h3>
 
225
<pre class="programlisting">
 
226
SmartSelftestAbort (IN  a{sv} options);
 
227
</pre>
 
228
<p>        Aborts a running SMART selftest.
 
229
</p>
 
230
<div class="variablelist"><table border="0" class="variablelist">
 
231
<colgroup>
 
232
<col align="left" valign="top">
 
233
<col>
 
234
</colgroup>
 
235
<tbody><tr>
 
236
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
237
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
 
238
</tr></tbody>
 
239
</table></div>
 
240
</div>
 
241
<hr>
 
242
<div class="refsect2">
 
243
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSetEnabled"></a><h3>The SmartSetEnabled() method</h3>
 
244
<pre class="programlisting">
 
245
SmartSetEnabled (IN  b     value,
 
246
                 IN  a{sv} options);
 
247
</pre>
 
248
<p>        Sets whether SMART is enabled for the drive. This setting is
 
249
        stored in the non-volatile memory in the drive itself and does
 
250
        not need to be refreshed every time the drive is powered on or
 
251
        connected.
 
252
</p>
 
253
<p>        Since this may require authentication and thus may fail, it is
 
254
        implemented this way instead of the
 
255
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartEnabled" title='The "SmartEnabled" property'>"SmartEnabled"</a> property being
 
256
        writable.
 
257
</p>
 
258
<div class="variablelist"><table border="0" class="variablelist">
 
259
<colgroup>
 
260
<col align="left" valign="top">
 
261
<col>
 
262
</colgroup>
 
263
<tbody>
 
264
<tr>
 
265
<td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>value</code></em></code>:</span></p></td>
 
266
<td><p><code class="constant">TRUE</code> to enable SMART, <code class="constant">FALSE</code> to disable SMART.</p></td>
 
267
</tr>
 
268
<tr>
 
269
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
270
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
 
271
</tr>
 
272
</tbody>
 
273
</table></div>
 
274
<p class="since">Since 2.1</p>
 
275
</div>
 
276
<hr>
 
277
<div class="refsect2">
 
278
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmGetState"></a><h3>The PmGetState() method</h3>
 
279
<pre class="programlisting">
 
280
PmGetState (IN  a{sv} options,
 
281
            OUT y     state);
 
282
</pre>
 
283
<p>        Get the current power mode status. This is implemented as a
 
284
        method call as it involves sending a command from the host to
 
285
        the drive and no change notification is available.
 
286
</p>
 
287
<p>        The format of <em class="parameter"><code>state</code></em> is the result obtained from sending the
 
288
        ATA command <span class="quote">“<span class="quote">CHECK POWER MODE</span>”</span> to the drive.
 
289
        Known values include
 
290
        </p>
 
291
<div class="variablelist"><table border="0" class="variablelist">
 
292
<colgroup>
 
293
<col align="left" valign="top">
 
294
<col>
 
295
</colgroup>
 
296
<tbody>
 
297
<tr>
 
298
<td><p><span class="term">0x00</span></p></td>
 
299
<td><p>Standby</p></td>
 
300
</tr>
 
301
<tr>
 
302
<td><p><span class="term">0x80</span></p></td>
 
303
<td><p>Idle</p></td>
 
304
</tr>
 
305
<tr>
 
306
<td><p><span class="term">0xff</span></p></td>
 
307
<td><p>Active/Idle</p></td>
 
308
</tr>
 
309
</tbody>
 
310
</table></div>
 
311
<p>
 
312
        Typically user interfaces will report "Drive is spun down" if <em class="parameter"><code>state</code></em> is
 
313
        0x00 and "Drive is spun up" otherwise.
 
314
</p>
 
315
<div class="variablelist"><table border="0" class="variablelist">
 
316
<colgroup>
 
317
<col align="left" valign="top">
 
318
<col>
 
319
</colgroup>
 
320
<tbody>
 
321
<tr>
 
322
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
323
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
 
324
</tr>
 
325
<tr>
 
326
<td><p><span class="term"><code class="literal">OUT y <em class="parameter"><code>state</code></em></code>:</span></p></td>
 
327
<td><p>The current power state.</p></td>
 
328
</tr>
 
329
</tbody>
 
330
</table></div>
 
331
</div>
 
332
<hr>
 
333
<div class="refsect2">
 
334
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmStandby"></a><h3>The PmStandby() method</h3>
 
335
<pre class="programlisting">
 
336
PmStandby (IN  a{sv} options);
 
337
</pre>
 
338
<p>        Force the drive to immediately enter the low power consumption
 
339
        <span class="emphasis"><em>standby</em></span> mode, usually causing it to spin
 
340
        down. This is done by sending the ATA command
 
341
        <span class="quote">“<span class="quote">STANDBY IMMEDIATE</span>”</span> to the drive.
 
342
</p>
 
343
<div class="variablelist"><table border="0" class="variablelist">
 
344
<colgroup>
 
345
<col align="left" valign="top">
 
346
<col>
 
347
</colgroup>
 
348
<tbody><tr>
 
349
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
350
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
 
351
</tr></tbody>
 
352
</table></div>
 
353
</div>
 
354
<hr>
 
355
<div class="refsect2">
 
356
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmWakeup"></a><h3>The PmWakeup() method</h3>
 
357
<pre class="programlisting">
 
358
PmWakeup (IN  a{sv} options);
 
359
</pre>
 
360
<p>        Force the drive to immediately wake up (exiting the low power
 
361
        consumption <span class="emphasis"><em>standby</em></span> mode), usually
 
362
        causing it to spin up. This is done by reading data from the
 
363
        disk.
 
364
</p>
 
365
<div class="variablelist"><table border="0" class="variablelist">
 
366
<colgroup>
 
367
<col align="left" valign="top">
 
368
<col>
 
369
</colgroup>
 
370
<tbody><tr>
 
371
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
372
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
 
373
</tr></tbody>
 
374
</table></div>
 
375
</div>
 
376
<hr>
 
377
<div class="refsect2">
 
378
<a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SecurityEraseUnit"></a><h3>The SecurityEraseUnit() method</h3>
 
379
<pre class="programlisting">
 
380
SecurityEraseUnit (IN  a{sv} options);
 
381
</pre>
 
382
<p>        Does all the necessary checks and preparations and then sends
 
383
        the <span class="quote">“<span class="quote">SECURITY ERASE UNIT</span>”</span> command to the
 
384
        drive. If the option <em class="parameter"><code>enhanced</code></em> is set to <code class="constant">TRUE</code> an
 
385
        <span class="emphasis"><em>enhanced secure erase</em></span> is requested.
 
386
</p>
 
387
<p>        All data on the drive will be irrevocably erased.
 
388
</p>
 
389
<p>        This operation takes either
 
390
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityEraseUnitMinutes" title='The "SecurityEraseUnitMinutes" property'>"SecurityEraseUnitMinutes"</a> or
 
391
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityEnhancedEraseUnitMinutes" title='The "SecurityEnhancedEraseUnitMinutes" property'>"SecurityEnhancedEraseUnitMinutes"</a>
 
392
        minutes to complete depending on whether the <em class="parameter"><code>enhanced</code></em> option
 
393
        is <code class="constant">TRUE</code>.
 
394
</p>
 
395
<div class="variablelist"><table border="0" class="variablelist">
 
396
<colgroup>
 
397
<col align="left" valign="top">
 
398
<col>
 
399
</colgroup>
 
400
<tbody><tr>
 
401
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
 
402
<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>enhanced</code></em> (of type 'b').</p></td>
 
403
</tr></tbody>
 
404
</table></div>
 
405
</div>
 
406
</div>
 
407
<div class="refsect1">
 
408
<a name="gdbus-properties-org.freedesktop.UDisks2.Drive.Ata"></a><h2>Property Details</h2>
 
409
<div class="refsect2">
 
410
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSupported"></a><h3>The "SmartSupported" property</h3>
 
411
<pre class="programlisting">
 
412
SmartSupported  readable   b
 
413
</pre>
 
414
<p>Whether the drive supports SMART.</p>
 
415
</div>
 
416
<hr>
 
417
<div class="refsect2">
 
418
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartEnabled"></a><h3>The "SmartEnabled" property</h3>
 
419
<pre class="programlisting">
 
420
SmartEnabled  readable   b
 
421
</pre>
 
422
<p>Whether SMART is enabled.</p>
 
423
</div>
 
424
<hr>
 
425
<div class="refsect2">
 
426
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartUpdated"></a><h3>The "SmartUpdated" property</h3>
 
427
<pre class="programlisting">
 
428
SmartUpdated  readable   t
 
429
</pre>
 
430
<p>         The point in time (seconds since the
 
431
         <a class="ulink" href="http://en.wikipedia.org/wiki/Unix_epoch" target="_top">Unix Epoch</a>)
 
432
         that the SMART status was updated or 0 if never updated.
 
433
</p>
 
434
<p>         The value of the other properties related to SMART are not
 
435
         meaningful if this proeprty is 0.
 
436
</p>
 
437
</div>
 
438
<hr>
 
439
<div class="refsect2">
 
440
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartFailing"></a><h3>The "SmartFailing" property</h3>
 
441
<pre class="programlisting">
 
442
SmartFailing  readable   b
 
443
</pre>
 
444
<p>         Set to <code class="constant">TRUE</code> if disk is about to fail.
 
445
</p>
 
446
<p>         This value is read from the disk itself and does not include
 
447
         any interpretation.
 
448
</p>
 
449
</div>
 
450
<hr>
 
451
<div class="refsect2">
 
452
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartPowerOnSeconds"></a><h3>The "SmartPowerOnSeconds" property</h3>
 
453
<pre class="programlisting">
 
454
SmartPowerOnSeconds  readable   t
 
455
</pre>
 
456
<p>         The amount of time the disk has been powered on (according to SMART data) or 0 if unknown.
 
457
</p>
 
458
</div>
 
459
<hr>
 
460
<div class="refsect2">
 
461
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartTemperature"></a><h3>The "SmartTemperature" property</h3>
 
462
<pre class="programlisting">
 
463
SmartTemperature  readable   d
 
464
</pre>
 
465
<p>         The temperature (in Kelvin) of the disk according to SMART data or 0 if unknown.
 
466
</p>
 
467
</div>
 
468
<hr>
 
469
<div class="refsect2">
 
470
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumAttributesFailing"></a><h3>The "SmartNumAttributesFailing" property</h3>
 
471
<pre class="programlisting">
 
472
SmartNumAttributesFailing  readable   i
 
473
</pre>
 
474
<p>        The number of attributes failing right now or -1 if unknown.
 
475
</p>
 
476
</div>
 
477
<hr>
 
478
<div class="refsect2">
 
479
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumAttributesFailedInThePast"></a><h3>The "SmartNumAttributesFailedInThePast" property</h3>
 
480
<pre class="programlisting">
 
481
SmartNumAttributesFailedInThePast  readable   i
 
482
</pre>
 
483
<p>        The number of attributes that have failed in the past or -1 if unknown.
 
484
</p>
 
485
</div>
 
486
<hr>
 
487
<div class="refsect2">
 
488
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumBadSectors"></a><h3>The "SmartNumBadSectors" property</h3>
 
489
<pre class="programlisting">
 
490
SmartNumBadSectors  readable   x
 
491
</pre>
 
492
<p>        The number of bad sectors (ie. pending and reallocated) or -1 if unknown.
 
493
</p>
 
494
</div>
 
495
<hr>
 
496
<div class="refsect2">
 
497
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestStatus"></a><h3>The "SmartSelftestStatus" property</h3>
 
498
<pre class="programlisting">
 
499
SmartSelftestStatus  readable   s
 
500
</pre>
 
501
<p>         The status of the last self-test. Known values include
 
502
        </p>
 
503
<div class="variablelist"><table border="0" class="variablelist">
 
504
<colgroup>
 
505
<col align="left" valign="top">
 
506
<col>
 
507
</colgroup>
 
508
<tbody>
 
509
<tr>
 
510
<td><p><span class="term">success</span></p></td>
 
511
<td><p>Last self-test was a success (or never ran).</p></td>
 
512
</tr>
 
513
<tr>
 
514
<td><p><span class="term">aborted</span></p></td>
 
515
<td><p>Last self-test was aborted.</p></td>
 
516
</tr>
 
517
<tr>
 
518
<td><p><span class="term">interrupted</span></p></td>
 
519
<td><p>Last self-test was interrupted.</p></td>
 
520
</tr>
 
521
<tr>
 
522
<td><p><span class="term">fatal</span></p></td>
 
523
<td><p>Last self-test did not complete.</p></td>
 
524
</tr>
 
525
<tr>
 
526
<td><p><span class="term">error_unknown</span></p></td>
 
527
<td><p>Last self-test failed (Unknown).</p></td>
 
528
</tr>
 
529
<tr>
 
530
<td><p><span class="term">error_electrical</span></p></td>
 
531
<td><p>Last self-test failed (Electrical).</p></td>
 
532
</tr>
 
533
<tr>
 
534
<td><p><span class="term">error_servo</span></p></td>
 
535
<td><p>Last self-test failed (Servo).</p></td>
 
536
</tr>
 
537
<tr>
 
538
<td><p><span class="term">error_read</span></p></td>
 
539
<td><p>Last self-test failed (Read).</p></td>
 
540
</tr>
 
541
<tr>
 
542
<td><p><span class="term">error_handling</span></p></td>
 
543
<td><p>Last self-test failed (Damage).</p></td>
 
544
</tr>
 
545
<tr>
 
546
<td><p><span class="term">inprogress</span></p></td>
 
547
<td><p>Self-test is currently in progress.</p></td>
 
548
</tr>
 
549
</tbody>
 
550
</table></div>
 
551
<p>
 
552
</p>
 
553
</div>
 
554
<hr>
 
555
<div class="refsect2">
 
556
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestPercentRemaining"></a><h3>The "SmartSelftestPercentRemaining" property</h3>
 
557
<pre class="programlisting">
 
558
SmartSelftestPercentRemaining  readable   i
 
559
</pre>
 
560
<p>        The percent remaining or -1 if unknown.
 
561
</p>
 
562
</div>
 
563
<hr>
 
564
<div class="refsect2">
 
565
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.PmSupported"></a><h3>The "PmSupported" property</h3>
 
566
<pre class="programlisting">
 
567
PmSupported  readable   b
 
568
</pre>
 
569
<p>Whether the drive supports power management.</p>
 
570
</div>
 
571
<hr>
 
572
<div class="refsect2">
 
573
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.PmEnabled"></a><h3>The "PmEnabled" property</h3>
 
574
<pre class="programlisting">
 
575
PmEnabled  readable   b
 
576
</pre>
 
577
<p>Whether power management is enabled.</p>
 
578
</div>
 
579
<hr>
 
580
<div class="refsect2">
 
581
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ApmSupported"></a><h3>The "ApmSupported" property</h3>
 
582
<pre class="programlisting">
 
583
ApmSupported  readable   b
 
584
</pre>
 
585
<p>Whether the drive supports Advanced Power Management (APM).</p>
 
586
</div>
 
587
<hr>
 
588
<div class="refsect2">
 
589
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ApmEnabled"></a><h3>The "ApmEnabled" property</h3>
 
590
<pre class="programlisting">
 
591
ApmEnabled  readable   b
 
592
</pre>
 
593
<p>Whether Advanced Power Management (APM) is enabled.</p>
 
594
</div>
 
595
<hr>
 
596
<div class="refsect2">
 
597
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamSupported"></a><h3>The "AamSupported" property</h3>
 
598
<pre class="programlisting">
 
599
AamSupported  readable   b
 
600
</pre>
 
601
<p>Whether the drive supports Automatic Acoustic Management (AAM).</p>
 
602
</div>
 
603
<hr>
 
604
<div class="refsect2">
 
605
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamEnabled"></a><h3>The "AamEnabled" property</h3>
 
606
<pre class="programlisting">
 
607
AamEnabled  readable   b
 
608
</pre>
 
609
<p>Whether Automatic Acoustic Management (AAM) is enabled.</p>
 
610
</div>
 
611
<hr>
 
612
<div class="refsect2">
 
613
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamVendorRecommendedValue"></a><h3>The "AamVendorRecommendedValue" property</h3>
 
614
<pre class="programlisting">
 
615
AamVendorRecommendedValue  readable   i
 
616
</pre>
 
617
<p>The vendor-recommended AAM value (or 0 if AAM is not supported).</p>
 
618
</div>
 
619
<hr>
 
620
<div class="refsect2">
 
621
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.WriteCacheSupported"></a><h3>The "WriteCacheSupported" property</h3>
 
622
<pre class="programlisting">
 
623
WriteCacheSupported  readable   b
 
624
</pre>
 
625
<p>         Whether the drive supports configuring the write cache.
 
626
</p>
 
627
<p class="since">Since 2.1</p>
 
628
</div>
 
629
<hr>
 
630
<div class="refsect2">
 
631
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.WriteCacheEnabled"></a><h3>The "WriteCacheEnabled" property</h3>
 
632
<pre class="programlisting">
 
633
WriteCacheEnabled  readable   b
 
634
</pre>
 
635
<p>         Whether the write-cache is enabled (or <code class="constant">FALSE</code> if not supported).
 
636
</p>
 
637
<p class="since">Since 2.1</p>
 
638
</div>
 
639
<hr>
 
640
<div class="refsect2">
 
641
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityEraseUnitMinutes"></a><h3>The "SecurityEraseUnitMinutes" property</h3>
 
642
<pre class="programlisting">
 
643
SecurityEraseUnitMinutes  readable   i
 
644
</pre>
 
645
<p>         The estimated amount of minutes it takes to complete the
 
646
         <span class="quote">“<span class="quote">SECURITY ERASE UNIT</span>”</span> command or 0 if this
 
647
         command is not available.
 
648
</p>
 
649
<p>         If set to 510 it means that it takes at least 508 minutes to
 
650
         complete the operation.
 
651
</p>
 
652
</div>
 
653
<hr>
 
654
<div class="refsect2">
 
655
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityEnhancedEraseUnitMinutes"></a><h3>The "SecurityEnhancedEraseUnitMinutes" property</h3>
 
656
<pre class="programlisting">
 
657
SecurityEnhancedEraseUnitMinutes  readable   i
 
658
</pre>
 
659
<p>         The estimated amount of minutes it takes to complete the
 
660
         <span class="quote">“<span class="quote">SECURITY ERASE UNIT</span>”</span> command with enhanced mode
 
661
         specified or 0 if enhanced erase is not available.
 
662
</p>
 
663
<p>         If set to 510 it means that it takes at least 508 minutes to
 
664
         complete the operation.
 
665
</p>
 
666
</div>
 
667
<hr>
 
668
<div class="refsect2">
 
669
<a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityFrozen"></a><h3>The "SecurityFrozen" property</h3>
 
670
<pre class="programlisting">
 
671
SecurityFrozen  readable   b
 
672
</pre>
 
673
<p>         If set to <code class="constant">TRUE</code> the unit is frozen.
 
674
</p>
 
675
</div>
 
676
</div>
 
677
</div>
 
678
<div class="footer">
 
679
<hr>
 
680
          Generated by GTK-Doc V1.20</div>
 
681
</body>
 
682
</html>
 
 
b'\\ No newline at end of file'