Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.Drive.Ata.html

raw
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>org.freedesktop.UDisks2.Drive.Ata: UDisks Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="UDisks Reference Manual">
8 <link rel="up" href="ch03.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.35.1 (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="5"><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="ch03.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.ReadLookaheadSupported" title='The "ReadLookaheadSupported" property'>ReadLookaheadSupported</a> readable b
77 <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html#gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ReadLookaheadEnabled" title='The "ReadLookaheadEnabled" property'>ReadLookaheadEnabled</a> readable b
78 <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
79 <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
80 <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
81 </pre>
82 </div>
83 <div class="refsect1">
84 <a name="gdbus-interface-org-freedesktop-UDisks2-Drive-Ata"></a><h2>Description</h2>
85 <p>
86 Objects implementing this interface also implement the
87 <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.
88 </p>
89 </div>
90 <div class="refsect1">
91 <a name="gdbus-methods-org.freedesktop.UDisks2.Drive.Ata"></a><h2>Method Details</h2>
92 <div class="refsect2">
93 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartUpdate"></a><h3>The SmartUpdate() method</h3>
94 <pre class="programlisting">
95 SmartUpdate (IN a{sv} options);
96 </pre>
97 <p>
98 Reads SMART data from the drive and update relevant properties.
99 </p>
100 <p>
101 If the option <em class="parameter"><code>nowakeup</code></em> is given and the disk is in a sleeping
102 state, the error
103 <code class="literal">org.freedesktop.UDisks2.Error.WouldWakeup</code> is
104 returned.
105 </p>
106 <p>
107 The option <em class="parameter"><code>atasmart_blob</code></em> (of type 's' representing a path to
108 the blob file) can be used to inject libatasmart-compatible
109 blobs for testing how clients react to different kinds of SMART
110 data. Only valid when backed with the
111 <code class="literal">libblockdev_libatasmart</code> plugin. This option
112 may be removed in the future without it being considered an ABI
113 break. Deprecated since 2.11.0.
114 </p>
115 <div class="variablelist"><table border="0" class="variablelist">
116 <colgroup>
117 <col align="left" valign="top">
118 <col>
119 </colgroup>
120 <tbody><tr>
121 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
122 <td><p>
123 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').
124 </p></td>
125 </tr></tbody>
126 </table></div>
127 </div>
128 <hr>
129 <div class="refsect2">
130 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartGetAttributes"></a><h3>The SmartGetAttributes() method</h3>
131 <pre class="programlisting">
132 SmartGetAttributes (IN a{sv} options,
133 OUT a(ysqiiixia{sv}) attributes);
134 </pre>
135 <p>
136 Get the SMART attributes.
137 Each attribute is a struct with the following members:
138 </p>
139 <div class="variablelist"><table border="0" class="variablelist">
140 <colgroup>
141 <col align="left" valign="top">
142 <col>
143 </colgroup>
144 <tbody>
145 <tr>
146 <td><p><span class="term">id (type 'y')</span></p></td>
147 <td><p>Attribute Identifier</p></td>
148 </tr>
149 <tr>
150 <td><p><span class="term">name (type 's')</span></p></td>
151 <td><p>The identifier as a string.</p></td>
152 </tr>
153 <tr>
154 <td><p><span class="term">flags (type 'q')</span></p></td>
155 <td><p>16-bit attribute flags (bit 0 is prefail/oldage, bit 1 is online/offline).</p></td>
156 </tr>
157 <tr>
158 <td><p><span class="term">value (type 'i')</span></p></td>
159 <td><p>The current value or -1 if unknown.</p></td>
160 </tr>
161 <tr>
162 <td><p><span class="term">worst (type 'i')</span></p></td>
163 <td><p>The worst value of -1 if unknown.</p></td>
164 </tr>
165 <tr>
166 <td><p><span class="term">threshold (type 'i')</span></p></td>
167 <td><p>The threshold or -1 if unknown.</p></td>
168 </tr>
169 <tr>
170 <td><p><span class="term">pretty (type 'x')</span></p></td>
171 <td><p>An interpretation of the value - must be ignored if <em class="parameter"><code>pretty_unit</code></em> is 0.</p></td>
172 </tr>
173 <tr>
174 <td><p><span class="term">pretty_unit (type 'i')</span></p></td>
175 <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>
176 </tr>
177 <tr>
178 <td><p><span class="term">expansion (type 'a{sv}')</span></p></td>
179 <td><p>Currently unused. Intended for future expansion.</p></td>
180 </tr>
181 </tbody>
182 </table></div>
183 <p>
184 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.
185 </p>
186 <div class="variablelist"><table border="0" class="variablelist">
187 <colgroup>
188 <col align="left" valign="top">
189 <col>
190 </colgroup>
191 <tbody>
192 <tr>
193 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
194 <td><p>
195 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').
196 </p></td>
197 </tr>
198 <tr>
199 <td><p><span class="term"><code class="literal">OUT a(ysqiiixia{sv}) <em class="parameter"><code>attributes</code></em></code>:</span></p></td>
200 <td><p>
201 The SMART attributes.
202 </p></td>
203 </tr>
204 </tbody>
205 </table></div>
206 </div>
207 <hr>
208 <div class="refsect2">
209 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestStart"></a><h3>The SmartSelftestStart() method</h3>
210 <pre class="programlisting">
211 SmartSelftestStart (IN s type,
212 IN a{sv} options);
213 </pre>
214 <p>
215 Starts a SMART selftest. The <em class="parameter"><code>type</code></em> parameter is for the type
216 of test to start - valid values are <code class="literal">short</code>,
217 <code class="literal">extended</code>, <code class="literal">conveyance</code> and
218 <code class="literal">offline</code> (since 2.11.0).
219 </p>
220 <p>
221 Note that the method returns immediately after the test has
222 been started successfully.
223 </p>
224 <div class="variablelist"><table border="0" class="variablelist">
225 <colgroup>
226 <col align="left" valign="top">
227 <col>
228 </colgroup>
229 <tbody>
230 <tr>
231 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
232 <td><p>
233 The type test to run.
234 </p></td>
235 </tr>
236 <tr>
237 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
238 <td><p>
239 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
240 </p></td>
241 </tr>
242 </tbody>
243 </table></div>
244 </div>
245 <hr>
246 <div class="refsect2">
247 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestAbort"></a><h3>The SmartSelftestAbort() method</h3>
248 <pre class="programlisting">
249 SmartSelftestAbort (IN a{sv} options);
250 </pre>
251 <p>
252 Aborts a running SMART selftest.
253 </p>
254 <div class="variablelist"><table border="0" class="variablelist">
255 <colgroup>
256 <col align="left" valign="top">
257 <col>
258 </colgroup>
259 <tbody><tr>
260 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
261 <td><p>
262 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
263 </p></td>
264 </tr></tbody>
265 </table></div>
266 </div>
267 <hr>
268 <div class="refsect2">
269 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SmartSetEnabled"></a><h3>The SmartSetEnabled() method</h3>
270 <pre class="programlisting">
271 SmartSetEnabled (IN b value,
272 IN a{sv} options);
273 </pre>
274 <p>
275 Sets whether SMART is enabled for the drive. This setting is
276 stored in the non-volatile memory in the drive itself and does
277 not need to be refreshed every time the drive is powered on or
278 connected.
279 </p>
280 <p>
281 Since this may require authentication and thus may fail, it is
282 implemented this way instead of the
283 <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
284 writable.
285 </p>
286 <div class="variablelist"><table border="0" class="variablelist">
287 <colgroup>
288 <col align="left" valign="top">
289 <col>
290 </colgroup>
291 <tbody>
292 <tr>
293 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>value</code></em></code>:</span></p></td>
294 <td><p>
295 <code class="constant">TRUE</code> to enable SMART, <code class="constant">FALSE</code> to disable SMART.
296 </p></td>
297 </tr>
298 <tr>
299 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
300 <td><p>
301 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
302 </p></td>
303 </tr>
304 </tbody>
305 </table></div>
306 <p class="since">Since 2.0.0</p>
307 </div>
308 <hr>
309 <div class="refsect2">
310 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmGetState"></a><h3>The PmGetState() method</h3>
311 <pre class="programlisting">
312 PmGetState (IN a{sv} options,
313 OUT y state);
314 </pre>
315 <p>
316 Get the current power mode status. This is implemented as a
317 method call as it involves sending a command from the host to
318 the drive and no change notification is available.
319 </p>
320 <p>
321 The format of <em class="parameter"><code>state</code></em> is the result obtained from sending the
322 ATA command <span class="quote">“<span class="quote">CHECK POWER MODE</span>”</span> to the drive.
323 Known values include
324 </p>
325 <div class="variablelist"><table border="0" class="variablelist">
326 <colgroup>
327 <col align="left" valign="top">
328 <col>
329 </colgroup>
330 <tbody>
331 <tr>
332 <td><p><span class="term">0x00</span></p></td>
333 <td><p>Standby</p></td>
334 </tr>
335 <tr>
336 <td><p><span class="term">0x80</span></p></td>
337 <td><p>Idle</p></td>
338 </tr>
339 <tr>
340 <td><p><span class="term">0xff</span></p></td>
341 <td><p>Active/Idle</p></td>
342 </tr>
343 </tbody>
344 </table></div>
345 <p>
346 Typically user interfaces will report "Drive is spun down" if <em class="parameter"><code>state</code></em> is
347 0x00 and "Drive is spun up" otherwise.
348 </p>
349 <div class="variablelist"><table border="0" class="variablelist">
350 <colgroup>
351 <col align="left" valign="top">
352 <col>
353 </colgroup>
354 <tbody>
355 <tr>
356 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
357 <td><p>
358 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
359 </p></td>
360 </tr>
361 <tr>
362 <td><p><span class="term"><code class="literal">OUT y <em class="parameter"><code>state</code></em></code>:</span></p></td>
363 <td><p>
364 The current power state.
365 </p></td>
366 </tr>
367 </tbody>
368 </table></div>
369 </div>
370 <hr>
371 <div class="refsect2">
372 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmStandby"></a><h3>The PmStandby() method</h3>
373 <pre class="programlisting">
374 PmStandby (IN a{sv} options);
375 </pre>
376 <p>
377 Force the drive to immediately enter the low power consumption
378 <span class="emphasis"><em>standby</em></span> mode, usually causing it to spin
379 down. This is done by sending the ATA command
380 <span class="quote">“<span class="quote">STANDBY IMMEDIATE</span>”</span> to the drive.
381 </p>
382 <div class="variablelist"><table border="0" class="variablelist">
383 <colgroup>
384 <col align="left" valign="top">
385 <col>
386 </colgroup>
387 <tbody><tr>
388 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
389 <td><p>
390 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
391 </p></td>
392 </tr></tbody>
393 </table></div>
394 </div>
395 <hr>
396 <div class="refsect2">
397 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.PmWakeup"></a><h3>The PmWakeup() method</h3>
398 <pre class="programlisting">
399 PmWakeup (IN a{sv} options);
400 </pre>
401 <p>
402 Force the drive to immediately wake up (exiting the low power
403 consumption <span class="emphasis"><em>standby</em></span> mode), usually
404 causing it to spin up. This is done by reading data from the
405 disk.
406 </p>
407 <div class="variablelist"><table border="0" class="variablelist">
408 <colgroup>
409 <col align="left" valign="top">
410 <col>
411 </colgroup>
412 <tbody><tr>
413 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
414 <td><p>
415 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
416 </p></td>
417 </tr></tbody>
418 </table></div>
419 </div>
420 <hr>
421 <div class="refsect2">
422 <a name="gdbus-method-org-freedesktop-UDisks2-Drive-Ata.SecurityEraseUnit"></a><h3>The SecurityEraseUnit() method</h3>
423 <pre class="programlisting">
424 SecurityEraseUnit (IN a{sv} options);
425 </pre>
426 <p>
427 Does all the necessary checks and preparations and then sends
428 the <span class="quote">“<span class="quote">SECURITY ERASE UNIT</span>”</span> command to the
429 drive. If the option <em class="parameter"><code>enhanced</code></em> is set to <code class="constant">TRUE</code> an
430 <span class="emphasis"><em>enhanced secure erase</em></span> is requested.
431 </p>
432 <p>
433 All data on the drive will be irrevocably erased.
434 </p>
435 <p>
436 This operation takes either
437 <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
438 <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>
439 minutes to complete depending on whether the <em class="parameter"><code>enhanced</code></em> option
440 is <code class="constant">TRUE</code>.
441 </p>
442 <div class="variablelist"><table border="0" class="variablelist">
443 <colgroup>
444 <col align="left" valign="top">
445 <col>
446 </colgroup>
447 <tbody><tr>
448 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
449 <td><p>
450 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').
451 </p></td>
452 </tr></tbody>
453 </table></div>
454 </div>
455 </div>
456 <div class="refsect1">
457 <a name="gdbus-properties-org.freedesktop.UDisks2.Drive.Ata"></a><h2>Property Details</h2>
458 <div class="refsect2">
459 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSupported"></a><h3>The "SmartSupported" property</h3>
460 <pre class="programlisting">
461 SmartSupported readable b
462 </pre>
463 <p>
464 Whether the drive supports SMART.
465 </p>
466 </div>
467 <hr>
468 <div class="refsect2">
469 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartEnabled"></a><h3>The "SmartEnabled" property</h3>
470 <pre class="programlisting">
471 SmartEnabled readable b
472 </pre>
473 <p>
474 Whether SMART is enabled.
475 </p>
476 </div>
477 <hr>
478 <div class="refsect2">
479 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartUpdated"></a><h3>The "SmartUpdated" property</h3>
480 <pre class="programlisting">
481 SmartUpdated readable t
482 </pre>
483 <p>
484 </p>
485 <p>
486 The point in time (seconds since the
487 <a class="ulink" href="http://en.wikipedia.org/wiki/Unix_epoch" target="_top">Unix Epoch</a>)
488 that the SMART status was updated or 0 if never updated.
489 </p>
490 <p>
491 The value of the other properties related to SMART are not
492 meaningful if this property is 0.
493 </p>
494 </div>
495 <hr>
496 <div class="refsect2">
497 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartFailing"></a><h3>The "SmartFailing" property</h3>
498 <pre class="programlisting">
499 SmartFailing readable b
500 </pre>
501 <p>
502 </p>
503 <p>
504 Set to <code class="constant">TRUE</code> if disk is about to fail.
505 </p>
506 <p>
507 This value is read from the disk itself and does not include
508 any interpretation.
509 </p>
510 </div>
511 <hr>
512 <div class="refsect2">
513 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartPowerOnSeconds"></a><h3>The "SmartPowerOnSeconds" property</h3>
514 <pre class="programlisting">
515 SmartPowerOnSeconds readable t
516 </pre>
517 <p>
518 </p>
519 <p>
520 The amount of time the disk has been powered on (according to SMART data) or 0 if unknown.
521 </p>
522 </div>
523 <hr>
524 <div class="refsect2">
525 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartTemperature"></a><h3>The "SmartTemperature" property</h3>
526 <pre class="programlisting">
527 SmartTemperature readable d
528 </pre>
529 <p>
530 </p>
531 <p>
532 The temperature (in Kelvin) of the disk according to SMART data or 0 if unknown.
533 </p>
534 </div>
535 <hr>
536 <div class="refsect2">
537 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumAttributesFailing"></a><h3>The "SmartNumAttributesFailing" property</h3>
538 <pre class="programlisting">
539 SmartNumAttributesFailing readable i
540 </pre>
541 <p>
542 </p>
543 <p>
544 The number of attributes failing right now or -1 if unknown.
545 </p>
546 </div>
547 <hr>
548 <div class="refsect2">
549 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumAttributesFailedInThePast"></a><h3>The "SmartNumAttributesFailedInThePast" property</h3>
550 <pre class="programlisting">
551 SmartNumAttributesFailedInThePast readable i
552 </pre>
553 <p>
554 </p>
555 <p>
556 The number of attributes that have failed in the past or -1 if unknown.
557 </p>
558 </div>
559 <hr>
560 <div class="refsect2">
561 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartNumBadSectors"></a><h3>The "SmartNumBadSectors" property</h3>
562 <pre class="programlisting">
563 SmartNumBadSectors readable x
564 </pre>
565 <p>
566 </p>
567 <p>
568 The number of bad sectors (ie. pending and reallocated) or -1 if unknown.
569 </p>
570 </div>
571 <hr>
572 <div class="refsect2">
573 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestStatus"></a><h3>The "SmartSelftestStatus" property</h3>
574 <pre class="programlisting">
575 SmartSelftestStatus readable s
576 </pre>
577 <p>
578 </p>
579 <p>
580 The status of the last self-test. Known values include
581 </p>
582 <div class="variablelist"><table border="0" class="variablelist">
583 <colgroup>
584 <col align="left" valign="top">
585 <col>
586 </colgroup>
587 <tbody>
588 <tr>
589 <td><p><span class="term">success</span></p></td>
590 <td><p>Last self-test was a success (or never ran).</p></td>
591 </tr>
592 <tr>
593 <td><p><span class="term">aborted</span></p></td>
594 <td><p>Last self-test was aborted.</p></td>
595 </tr>
596 <tr>
597 <td><p><span class="term">interrupted</span></p></td>
598 <td><p>Last self-test was interrupted.</p></td>
599 </tr>
600 <tr>
601 <td><p><span class="term">fatal</span></p></td>
602 <td><p>Last self-test did not complete.</p></td>
603 </tr>
604 <tr>
605 <td><p><span class="term">error_unknown</span></p></td>
606 <td><p>Last self-test failed (Unknown).</p></td>
607 </tr>
608 <tr>
609 <td><p><span class="term">error_electrical</span></p></td>
610 <td><p>Last self-test failed (Electrical).</p></td>
611 </tr>
612 <tr>
613 <td><p><span class="term">error_servo</span></p></td>
614 <td><p>Last self-test failed (Servo).</p></td>
615 </tr>
616 <tr>
617 <td><p><span class="term">error_read</span></p></td>
618 <td><p>Last self-test failed (Read).</p></td>
619 </tr>
620 <tr>
621 <td><p><span class="term">error_handling</span></p></td>
622 <td><p>Last self-test failed (Damage).</p></td>
623 </tr>
624 <tr>
625 <td><p><span class="term">inprogress</span></p></td>
626 <td><p>Self-test is currently in progress.</p></td>
627 </tr>
628 </tbody>
629 </table></div>
630 <p>
631 </p>
632 </div>
633 <hr>
634 <div class="refsect2">
635 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SmartSelftestPercentRemaining"></a><h3>The "SmartSelftestPercentRemaining" property</h3>
636 <pre class="programlisting">
637 SmartSelftestPercentRemaining readable i
638 </pre>
639 <p>
640 </p>
641 <p>
642 The percent remaining or -1 if unknown.
643 </p>
644 </div>
645 <hr>
646 <div class="refsect2">
647 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.PmSupported"></a><h3>The "PmSupported" property</h3>
648 <pre class="programlisting">
649 PmSupported readable b
650 </pre>
651 <p>
652 Whether the drive supports power management.
653 </p>
654 </div>
655 <hr>
656 <div class="refsect2">
657 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.PmEnabled"></a><h3>The "PmEnabled" property</h3>
658 <pre class="programlisting">
659 PmEnabled readable b
660 </pre>
661 <p>
662 Whether power management is enabled.
663 </p>
664 </div>
665 <hr>
666 <div class="refsect2">
667 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ApmSupported"></a><h3>The "ApmSupported" property</h3>
668 <pre class="programlisting">
669 ApmSupported readable b
670 </pre>
671 <p>
672 Whether the drive supports Advanced Power Management (APM).
673 </p>
674 </div>
675 <hr>
676 <div class="refsect2">
677 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ApmEnabled"></a><h3>The "ApmEnabled" property</h3>
678 <pre class="programlisting">
679 ApmEnabled readable b
680 </pre>
681 <p>
682 Whether Advanced Power Management (APM) is enabled.
683 </p>
684 </div>
685 <hr>
686 <div class="refsect2">
687 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamSupported"></a><h3>The "AamSupported" property</h3>
688 <pre class="programlisting">
689 AamSupported readable b
690 </pre>
691 <p>
692 Whether the drive supports Automatic Acoustic Management (AAM).
693 </p>
694 </div>
695 <hr>
696 <div class="refsect2">
697 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamEnabled"></a><h3>The "AamEnabled" property</h3>
698 <pre class="programlisting">
699 AamEnabled readable b
700 </pre>
701 <p>
702 Whether Automatic Acoustic Management (AAM) is enabled.
703 </p>
704 </div>
705 <hr>
706 <div class="refsect2">
707 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.AamVendorRecommendedValue"></a><h3>The "AamVendorRecommendedValue" property</h3>
708 <pre class="programlisting">
709 AamVendorRecommendedValue readable i
710 </pre>
711 <p>
712 The vendor-recommended AAM value (or 0 if AAM is not supported).
713 </p>
714 </div>
715 <hr>
716 <div class="refsect2">
717 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.WriteCacheSupported"></a><h3>The "WriteCacheSupported" property</h3>
718 <pre class="programlisting">
719 WriteCacheSupported readable b
720 </pre>
721 <p>
722 </p>
723 <p>
724 <em class="parameter"><code>since</code></em>: 2.0.0
725 Whether the drive supports configuring the write cache.
726 </p>
727 </div>
728 <hr>
729 <div class="refsect2">
730 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.WriteCacheEnabled"></a><h3>The "WriteCacheEnabled" property</h3>
731 <pre class="programlisting">
732 WriteCacheEnabled readable b
733 </pre>
734 <p>
735 </p>
736 <p>
737 <em class="parameter"><code>since</code></em>: 2.0.0
738 Whether the write-cache is enabled (or <code class="constant">FALSE</code> if not supported).
739 </p>
740 </div>
741 <hr>
742 <div class="refsect2">
743 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ReadLookaheadSupported"></a><h3>The "ReadLookaheadSupported" property</h3>
744 <pre class="programlisting">
745 ReadLookaheadSupported readable b
746 </pre>
747 <p>
748 </p>
749 <p>
750 <em class="parameter"><code>since</code></em>: 2.1.7
751 Whether the drive supports configuring the read look-ahead.
752 </p>
753 </div>
754 <hr>
755 <div class="refsect2">
756 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.ReadLookaheadEnabled"></a><h3>The "ReadLookaheadEnabled" property</h3>
757 <pre class="programlisting">
758 ReadLookaheadEnabled readable b
759 </pre>
760 <p>
761 </p>
762 <p>
763 <em class="parameter"><code>since</code></em>: 2.1.7
764 Whether the read look-ahead is enabled (or <code class="constant">FALSE</code> if not supported).
765 </p>
766 </div>
767 <hr>
768 <div class="refsect2">
769 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityEraseUnitMinutes"></a><h3>The "SecurityEraseUnitMinutes" property</h3>
770 <pre class="programlisting">
771 SecurityEraseUnitMinutes readable i
772 </pre>
773 <p>
774 </p>
775 <p>
776 The estimated amount of minutes it takes to complete the
777 <span class="quote">“<span class="quote">SECURITY ERASE UNIT</span>”</span> command or 0 if this
778 command is not available.
779 </p>
780 <p>
781 If set to 510 it means that it takes at least 508 minutes to
782 complete the operation.
783 </p>
784 </div>
785 <hr>
786 <div class="refsect2">
787 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityEnhancedEraseUnitMinutes"></a><h3>The "SecurityEnhancedEraseUnitMinutes" property</h3>
788 <pre class="programlisting">
789 SecurityEnhancedEraseUnitMinutes readable i
790 </pre>
791 <p>
792 </p>
793 <p>
794 The estimated amount of minutes it takes to complete the
795 <span class="quote">“<span class="quote">SECURITY ERASE UNIT</span>”</span> command with enhanced mode
796 specified or 0 if enhanced erase is not available.
797 </p>
798 <p>
799 If set to 510 it means that it takes at least 508 minutes to
800 complete the operation.
801 </p>
802 </div>
803 <hr>
804 <div class="refsect2">
805 <a name="gdbus-property-org-freedesktop-UDisks2-Drive-Ata.SecurityFrozen"></a><h3>The "SecurityFrozen" property</h3>
806 <pre class="programlisting">
807 SecurityFrozen readable b
808 </pre>
809 <p>
810 </p>
811 <p>
812 If set to <code class="constant">TRUE</code> the unit is frozen.
813 </p>
814 </div>
815 </div>
816 </div>
817 <div class="footer">
818 <hr>Generated by GTK-Doc V1.35.1</div>
819 </body>
820 </html>