Debian Codegraph @

doc/html/udisks2-ATA-commands.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>ATA commands: 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="ref-daemon-core.html" title="Core">
9 <link rel="prev" href="UDisksState.html" title="UDisksState">
10 <link rel="next" href="udisks2-UDisksModuleManager.html" title="UDisksModuleManager">
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="#udisks2-ATA-commands.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ref-daemon-core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="UDisksState.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="udisks2-UDisksModuleManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="udisks2-ATA-commands"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="udisks2-ATA-commands.top_of_page"></a>ATA commands</span></h2>
30 <p>ATA commands — Helper routines for ATA commands</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="udisks2-ATA-commands.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_proto_type">
39 <col class="functions_proto_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <span class="returnvalue">gboolean</span>
45 </td>
46 <td class="function_name">
47 <a class="link" href="udisks2-ATA-commands.html#udisks-ata-send-command-sync" title="udisks_ata_send_command_sync ()">udisks_ata_send_command_sync</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">gboolean</span>
53 </td>
54 <td class="function_name">
55 <a class="link" href="udisks2-ATA-commands.html#udisks-ata-get-pm-state" title="udisks_ata_get_pm_state ()">udisks_ata_get_pm_state</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="define_keyword">#define</td>
60 <td class="function_name">
61 <a class="link" href="udisks2-ATA-commands.html#UDISKS-ATA-PM-STATE-AWAKE:CAPS" title="UDISKS_ATA_PM_STATE_AWAKE()">UDISKS_ATA_PM_STATE_AWAKE</a><span class="c_punctuation">()</span>
62 </td>
63 </tr>
64 </tbody>
65 </table></div>
66 </div>
67 <div class="refsect1">
68 <a name="udisks2-ATA-commands.other"></a><h2>Types and Values</h2>
69 <div class="informaltable"><table class="informaltable" width="100%" border="0">
70 <colgroup>
71 <col width="150px" class="other_proto_type">
72 <col class="other_proto_name">
73 </colgroup>
74 <tbody>
75 <tr>
76 <td class="datatype_keyword">enum</td>
77 <td class="function_name"><a class="link" href="udisks2-ATA-commands.html#UDisksAtaCommandProtocol" title="enum UDisksAtaCommandProtocol">UDisksAtaCommandProtocol</a></td>
78 </tr>
79 <tr>
80 <td class="datatype_keyword"> </td>
81 <td class="function_name"><a class="link" href="udisks2-ATA-commands.html#UDisksAtaCommandInput" title="UDisksAtaCommandInput">UDisksAtaCommandInput</a></td>
82 </tr>
83 <tr>
84 <td class="datatype_keyword"> </td>
85 <td class="function_name"><a class="link" href="udisks2-ATA-commands.html#UDisksAtaCommandOutput" title="UDisksAtaCommandOutput">UDisksAtaCommandOutput</a></td>
86 </tr>
87 </tbody>
88 </table></div>
89 </div>
90 <div class="refsect1">
91 <a name="udisks2-ATA-commands.description"></a><h2>Description</h2>
92 <p>Helper routines for sending ATA commands to a device.</p>
93 </div>
94 <div class="refsect1">
95 <a name="udisks2-ATA-commands.functions_details"></a><h2>Functions</h2>
96 <div class="refsect2">
97 <a name="udisks-ata-send-command-sync"></a><h3>udisks_ata_send_command_sync ()</h3>
98 <pre class="programlisting"><span class="returnvalue">gboolean</span>
99 udisks_ata_send_command_sync (<em class="parameter"><code><span class="type">gint</span> fd</code></em>,
100 <em class="parameter"><code><span class="type">gint</span> timeout_msec</code></em>,
101 <em class="parameter"><code><a class="link" href="udisks2-ATA-commands.html#UDisksAtaCommandProtocol" title="enum UDisksAtaCommandProtocol"><span class="type">UDisksAtaCommandProtocol</span></a> protocol</code></em>,
102 <em class="parameter"><code><a class="link" href="udisks2-ATA-commands.html#UDisksAtaCommandInput" title="UDisksAtaCommandInput"><span class="type">UDisksAtaCommandInput</span></a> *input</code></em>,
103 <em class="parameter"><code><a class="link" href="udisks2-ATA-commands.html#UDisksAtaCommandOutput" title="UDisksAtaCommandOutput"><span class="type">UDisksAtaCommandOutput</span></a> *output</code></em>,
104 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
105 <p>Sends a command to an ATA device. Blocks the calling thread while the command is pending.</p>
106 <div class="refsect3">
107 <a name="udisks-ata-send-command-sync.parameters"></a><h4>Parameters</h4>
108 <div class="informaltable"><table class="informaltable" width="100%" border="0">
109 <colgroup>
110 <col width="150px" class="parameters_name">
111 <col class="parameters_description">
112 <col width="200px" class="parameters_annotations">
113 </colgroup>
114 <tbody>
115 <tr>
116 <td class="parameter_name"><p>fd</p></td>
117 <td class="parameter_description"><p>A file descriptor for a ATA device.</p></td>
118 <td class="parameter_annotations"> </td>
119 </tr>
120 <tr>
121 <td class="parameter_name"><p>timeout_msec</p></td>
122 <td class="parameter_description"><p>Timeout in milli-seconds for the command. Use -1 for the default (5 seconds) timeout and <code class="literal">G_MAXINT</code> for no timeout.</p></td>
123 <td class="parameter_annotations"> </td>
124 </tr>
125 <tr>
126 <td class="parameter_name"><p>protocol</p></td>
127 <td class="parameter_description"><p>The direction of the command.</p></td>
128 <td class="parameter_annotations"> </td>
129 </tr>
130 <tr>
131 <td class="parameter_name"><p>input</p></td>
132 <td class="parameter_description"><p>The input for the command.</p></td>
133 <td class="parameter_annotations"> </td>
134 </tr>
135 <tr>
136 <td class="parameter_name"><p>output</p></td>
137 <td class="parameter_description"><p>The output for the command.</p></td>
138 <td class="parameter_annotations"> </td>
139 </tr>
140 <tr>
141 <td class="parameter_name"><p>error</p></td>
142 <td class="parameter_description"><p>Return location for error or <code class="literal">NULL</code>.</p></td>
143 <td class="parameter_annotations"> </td>
144 </tr>
145 </tbody>
146 </table></div>
147 </div>
148 <div class="refsect3">
149 <a name="udisks-ata-send-command-sync.returns"></a><h4>Returns</h4>
150 <p> <code class="literal">TRUE</code> if the command succeeded, <code class="literal">FALSE</code> if <em class="parameter"><code>error</code></em>
151 is set.</p>
152 </div>
153 </div>
154 <hr>
155 <div class="refsect2">
156 <a name="udisks-ata-get-pm-state"></a><h3>udisks_ata_get_pm_state ()</h3>
157 <pre class="programlisting"><span class="returnvalue">gboolean</span>
158 udisks_ata_get_pm_state (<em class="parameter"><code>const <span class="type">gchar</span> *device</code></em>,
159 <em class="parameter"><code><span class="type">GError</span> **error</code></em>,
160 <em class="parameter"><code><span class="type">guchar</span> *pm_state</code></em>);</pre>
161 <p>Get the current power mode state.</p>
162 <p>The format of <em class="parameter"><code>pm_state</code></em>
163 is the result obtained from sending the
164 ATA command <code class="literal">CHECK POWER MODE</code> to the drive.</p>
165 <p>Known values include:</p>
166 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
167 <li class="listitem"><p><code class="literal">0x00</code>: Device is in PM2: Standby state.</p></li>
168 <li class="listitem"><p><code class="literal">0x40</code>: Device is in the PM0: Active state, the NV Cache power mode is enabled, and the spindle is spun down or spinning down.</p></li>
169 <li class="listitem"><p><code class="literal">0x41</code>: Device is in the PM0: Active state, the NV Cache power mode is enabled, and the spindle is spun up or spinning up.</p></li>
170 <li class="listitem"><p><code class="literal">0x80</code>: Device is in PM1: Idle state.</p></li>
171 <li class="listitem"><p><code class="literal">0xff</code>: Device is in the PM0: Active state or PM1: Idle State.</p></li>
172 </ul></div>
173 <p>Typically user interfaces will report "Drive is spun down" if <em class="parameter"><code>pm_state</code></em>
174 is
175 0x00 and "Drive is spun up" otherwise.</p>
176 <div class="refsect3">
177 <a name="udisks-ata-get-pm-state.parameters"></a><h4>Parameters</h4>
178 <div class="informaltable"><table class="informaltable" width="100%" border="0">
179 <colgroup>
180 <col width="150px" class="parameters_name">
181 <col class="parameters_description">
182 <col width="200px" class="parameters_annotations">
183 </colgroup>
184 <tbody>
185 <tr>
186 <td class="parameter_name"><p>device</p></td>
187 <td class="parameter_description"><p>ATA drive block device path.</p></td>
188 <td class="parameter_annotations"> </td>
189 </tr>
190 <tr>
191 <td class="parameter_name"><p>error</p></td>
192 <td class="parameter_description"><p>Return location for error.</p></td>
193 <td class="parameter_annotations"> </td>
194 </tr>
195 <tr>
196 <td class="parameter_name"><p>pm_state</p></td>
197 <td class="parameter_description"><p>Return location for the current power state value.</p></td>
198 <td class="parameter_annotations"> </td>
199 </tr>
200 </tbody>
201 </table></div>
202 </div>
203 <div class="refsect3">
204 <a name="udisks-ata-get-pm-state.returns"></a><h4>Returns</h4>
205 <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if <em class="parameter"><code>error</code></em>
206 is set.</p>
207 </div>
208 </div>
209 <hr>
210 <div class="refsect2">
211 <a name="UDISKS-ATA-PM-STATE-AWAKE:CAPS"></a><h3>UDISKS_ATA_PM_STATE_AWAKE()</h3>
212 <pre class="programlisting">#define UDISKS_ATA_PM_STATE_AWAKE(pm_state) (pm_state &gt;= 0x41)
213 </pre>
214 <p>Decodes the power state value as returned by <a class="link" href="udisks2-ATA-commands.html#udisks-ata-get-pm-state" title="udisks_ata_get_pm_state ()"><span class="type">udisks_ata_get_pm_state</span></a>.</p>
215 <div class="refsect3">
216 <a name="UDISKS-ATA-PM-STATE-AWAKE.parameters"></a><h4>Parameters</h4>
217 <div class="informaltable"><table class="informaltable" width="100%" border="0">
218 <colgroup>
219 <col width="150px" class="parameters_name">
220 <col class="parameters_description">
221 <col width="200px" class="parameters_annotations">
222 </colgroup>
223 <tbody><tr>
224 <td class="parameter_name"><p>pm_state</p></td>
225 <td class="parameter_description"><p>The power state value.</p></td>
226 <td class="parameter_annotations"> </td>
227 </tr></tbody>
228 </table></div>
229 </div>
230 <div class="refsect3">
231 <a name="UDISKS-ATA-PM-STATE-AWAKE.returns"></a><h4>Returns</h4>
232 <p> <code class="literal">TRUE</code> when the drive is awake, <code class="literal">FALSE</code> when sleeping.</p>
233 </div>
234 </div>
235 </div>
236 <div class="refsect1">
237 <a name="udisks2-ATA-commands.other_details"></a><h2>Types and Values</h2>
238 <div class="refsect2">
239 <a name="UDisksAtaCommandProtocol"></a><h3>enum UDisksAtaCommandProtocol</h3>
240 <p>Enumeration used to specify the protocol of an ATA command</p>
241 <div class="refsect3">
242 <a name="UDisksAtaCommandProtocol.members"></a><h4>Members</h4>
243 <div class="informaltable"><table class="informaltable" width="100%" border="0">
244 <colgroup>
245 <col width="300px" class="enum_members_name">
246 <col class="enum_members_description">
247 <col width="200px" class="enum_members_annotations">
248 </colgroup>
249 <tbody>
250 <tr>
251 <td class="enum_member_name"><p><a name="UDISKS-ATA-COMMAND-PROTOCOL-NONE:CAPS"></a>UDISKS_ATA_COMMAND_PROTOCOL_NONE</p></td>
252 <td class="enum_member_description">
253 <p>Non-data</p>
254 </td>
255 <td class="enum_member_annotations"> </td>
256 </tr>
257 <tr>
258 <td class="enum_member_name"><p><a name="UDISKS-ATA-COMMAND-PROTOCOL-DRIVE-TO-HOST:CAPS"></a>UDISKS_ATA_COMMAND_PROTOCOL_DRIVE_TO_HOST</p></td>
259 <td class="enum_member_description">
260 <p>PIO Data-In</p>
261 </td>
262 <td class="enum_member_annotations"> </td>
263 </tr>
264 <tr>
265 <td class="enum_member_name"><p><a name="UDISKS-ATA-COMMAND-PROTOCOL-HOST-TO-DRIVE:CAPS"></a>UDISKS_ATA_COMMAND_PROTOCOL_HOST_TO_DRIVE</p></td>
266 <td class="enum_member_description">
267 <p>PIO Data-Out</p>
268 </td>
269 <td class="enum_member_annotations"> </td>
270 </tr>
271 </tbody>
272 </table></div>
273 </div>
274 </div>
275 <hr>
276 <div class="refsect2">
277 <a name="UDisksAtaCommandInput"></a><h3>UDisksAtaCommandInput</h3>
278 <pre class="programlisting">typedef struct {
279 guint8 command;
280 guint8 feature;
281 guint8 count;
282 guint8 device;
283 guint32 lba;
284 gsize buffer_size;
285 guchar *buffer;
286 } UDisksAtaCommandInput;
287 </pre>
288 <p>Struct used for input data when sending ATA commands.</p>
289 <div class="refsect3">
290 <a name="UDisksAtaCommandInput.members"></a><h4>Members</h4>
291 <div class="informaltable"><table class="informaltable" width="100%" border="0">
292 <colgroup>
293 <col width="300px" class="struct_members_name">
294 <col class="struct_members_description">
295 <col width="200px" class="struct_members_annotations">
296 </colgroup>
297 <tbody>
298 <tr>
299 <td class="struct_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="UDisksAtaCommandInput.command"></a>command</code></em>;</p></td>
300 <td class="struct_member_description"><p>Command</p></td>
301 <td class="struct_member_annotations"> </td>
302 </tr>
303 <tr>
304 <td class="struct_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="UDisksAtaCommandInput.feature"></a>feature</code></em>;</p></td>
305 <td class="struct_member_description"><p>Feature</p></td>
306 <td class="struct_member_annotations"> </td>
307 </tr>
308 <tr>
309 <td class="struct_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="UDisksAtaCommandInput.count"></a>count</code></em>;</p></td>
310 <td class="struct_member_description"><p>Count</p></td>
311 <td class="struct_member_annotations"> </td>
312 </tr>
313 <tr>
314 <td class="struct_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="UDisksAtaCommandInput.device"></a>device</code></em>;</p></td>
315 <td class="struct_member_description"><p>Device</p></td>
316 <td class="struct_member_annotations"> </td>
317 </tr>
318 <tr>
319 <td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="UDisksAtaCommandInput.lba"></a>lba</code></em>;</p></td>
320 <td class="struct_member_description"><p>LBA</p></td>
321 <td class="struct_member_annotations"> </td>
322 </tr>
323 <tr>
324 <td class="struct_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="UDisksAtaCommandInput.buffer-size"></a>buffer_size</code></em>;</p></td>
325 <td class="struct_member_description"><p>Size of the <em class="parameter"><code>buffer</code></em>
326 member or 0</p></td>
327 <td class="struct_member_annotations"> </td>
328 </tr>
329 <tr>
330 <td class="struct_member_name"><p><span class="type">guchar</span> *<em class="structfield"><code><a name="UDisksAtaCommandInput.buffer"></a>buffer</code></em>;</p></td>
331 <td class="struct_member_description"><p>Data to send to device or <code class="literal">NULL</code></p></td>
332 <td class="struct_member_annotations"> </td>
333 </tr>
334 </tbody>
335 </table></div>
336 </div>
337 </div>
338 <hr>
339 <div class="refsect2">
340 <a name="UDisksAtaCommandOutput"></a><h3>UDisksAtaCommandOutput</h3>
341 <pre class="programlisting">typedef struct {
342 guint8 error;
343 guint8 count;
344 guint8 device;
345 guint8 status;
346 guint32 lba;
347 gsize buffer_size;
348 guchar *buffer;
349 } UDisksAtaCommandOutput;
350 </pre>
351 <p>Struct used for output data when sending ATA commands.</p>
352 <div class="refsect3">
353 <a name="UDisksAtaCommandOutput.members"></a><h4>Members</h4>
354 <div class="informaltable"><table class="informaltable" width="100%" border="0">
355 <colgroup>
356 <col width="300px" class="struct_members_name">
357 <col class="struct_members_description">
358 <col width="200px" class="struct_members_annotations">
359 </colgroup>
360 <tbody>
361 <tr>
362 <td class="struct_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="UDisksAtaCommandOutput.error"></a>error</code></em>;</p></td>
363 <td class="struct_member_description"><p>Error</p></td>
364 <td class="struct_member_annotations"> </td>
365 </tr>
366 <tr>
367 <td class="struct_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="UDisksAtaCommandOutput.count"></a>count</code></em>;</p></td>
368 <td class="struct_member_description"><p>Count</p></td>
369 <td class="struct_member_annotations"> </td>
370 </tr>
371 <tr>
372 <td class="struct_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="UDisksAtaCommandOutput.device"></a>device</code></em>;</p></td>
373 <td class="struct_member_description"><p>Device</p></td>
374 <td class="struct_member_annotations"> </td>
375 </tr>
376 <tr>
377 <td class="struct_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="UDisksAtaCommandOutput.status"></a>status</code></em>;</p></td>
378 <td class="struct_member_description"><p>Status</p></td>
379 <td class="struct_member_annotations"> </td>
380 </tr>
381 <tr>
382 <td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="UDisksAtaCommandOutput.lba"></a>lba</code></em>;</p></td>
383 <td class="struct_member_description"><p>LBA</p></td>
384 <td class="struct_member_annotations"> </td>
385 </tr>
386 <tr>
387 <td class="struct_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="UDisksAtaCommandOutput.buffer-size"></a>buffer_size</code></em>;</p></td>
388 <td class="struct_member_description"><p>Size of the <em class="parameter"><code>buffer</code></em>
389 member or 0</p></td>
390 <td class="struct_member_annotations"> </td>
391 </tr>
392 <tr>
393 <td class="struct_member_name"><p><span class="type">guchar</span> *<em class="structfield"><code><a name="UDisksAtaCommandOutput.buffer"></a>buffer</code></em>;</p></td>
394 <td class="struct_member_description"><p>Pointer to where to receive data from the device or <code class="literal">NULL</code></p></td>
395 <td class="struct_member_annotations"> </td>
396 </tr>
397 </tbody>
398 </table></div>
399 </div>
400 </div>
401 </div>
402 </div>
403 <div class="footer">
404 <hr>Generated by GTK-Doc V1.35.1</div>
405 </body>
406 </html>