| 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.NVMe.Namespace: 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.NVMe.Controller.html" title="org.freedesktop.UDisks2.NVMe.Controller"> |
| 10 |
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Manager.NVMe.html" title="org.freedesktop.UDisks2.Manager.NVMe"> |
| 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.NVMe.Namespace.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span> |
| 19 |
<a href="#gdbus-org.freedesktop.UDisks2.NVMe.Namespace.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.NVMe.Controller.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.Manager.NVMe.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.NVMe.Namespace"></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-NVMe-Namespace.top_of_page"></a>org.freedesktop.UDisks2.NVMe.Namespace</span></h2> |
| 31 |
<p>org.freedesktop.UDisks2.NVMe.Namespace — NVMe namespace device</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.NVMe.Namespace.html#gdbus-method-org-freedesktop-UDisks2-NVMe-Namespace.FormatNamespace" title="The FormatNamespace() method">FormatNamespace</a> (IN a{sv} options); |
| 39 |
</pre> |
| 40 |
</div> |
| 41 |
<div class="refsect1"> |
| 42 |
<a name="id-1.3.3.15.4"></a><h2>Properties</h2> |
| 43 |
<pre class="synopsis"> |
| 44 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NSID" title='The "NSID" property'>NSID</a> readable u |
| 45 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NGUID" title='The "NGUID" property'>NGUID</a> readable s |
| 46 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.EUI64" title='The "EUI64" property'>EUI64</a> readable s |
| 47 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.UUID" title='The "UUID" property'>UUID</a> readable s |
| 48 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.WWN" title='The "WWN" property'>WWN</a> readable s |
| 49 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.LBAFormats" title='The "LBAFormats" property'>LBAFormats</a> readable a(qqy) |
| 50 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.FormattedLBASize" title='The "FormattedLBASize" property'>FormattedLBASize</a> readable (qqy) |
| 51 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NamespaceSize" title='The "NamespaceSize" property'>NamespaceSize</a> readable t |
| 52 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NamespaceCapacity" title='The "NamespaceCapacity" property'>NamespaceCapacity</a> readable t |
| 53 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NamespaceUtilization" title='The "NamespaceUtilization" property'>NamespaceUtilization</a> readable t |
| 54 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.FormatPercentRemaining" title='The "FormatPercentRemaining" property'>FormatPercentRemaining</a> readable i |
| 55 |
</pre> |
| 56 |
</div> |
| 57 |
<div class="refsect1"> |
| 58 |
<a name="gdbus-interface-org-freedesktop-UDisks2-NVMe-Namespace"></a><h2>Description</h2> |
| 59 |
<p> |
| 60 |
This interface represents a namespace device in a NVM subsystem. |
| 61 |
</p> |
| 62 |
</div> |
| 63 |
<div class="refsect1"> |
| 64 |
<a name="gdbus-methods-org.freedesktop.UDisks2.NVMe.Namespace"></a><h2>Method Details</h2> |
| 65 |
<div class="refsect2"> |
| 66 |
<a name="gdbus-method-org-freedesktop-UDisks2-NVMe-Namespace.FormatNamespace"></a><h3>The FormatNamespace() method</h3> |
| 67 |
<pre class="programlisting"> |
| 68 |
FormatNamespace (IN a{sv} options); |
| 69 |
</pre> |
| 70 |
<p> |
| 71 |
Performs low level format of the NVM media, destroying all data and metadata in the current namespace. |
| 72 |
</p> |
| 73 |
<p> |
| 74 |
The optional <em class="parameter"><code>lba_data_size</code></em> parameter indicates the LBA Data Size in bytes to use (see the related |
| 75 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.LBAFormats" title='The "LBAFormats" property'>"LBAFormats"</a> property) and similarly the <em class="parameter"><code>metadata_size</code></em> parameter |
| 76 |
denotes the number of metadata bytes provided per LBA. If not specified, the current active format is used. |
| 77 |
</p> |
| 78 |
<p> |
| 79 |
The optional <em class="parameter"><code>secure_erase</code></em> parameter can be used to perform secure erase - valid values are |
| 80 |
<code class="literal">user_data</code> where the user data are overwritten by a pattern, and <code class="literal">crypto_erase</code> |
| 81 |
which removes the encryption key with which the user data was previously encrypted. |
| 82 |
</p> |
| 83 |
<p> |
| 84 |
This call blocks until the format operation has finished. |
| 85 |
</p> |
| 86 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 87 |
<colgroup> |
| 88 |
<col align="left" valign="top"> |
| 89 |
<col> |
| 90 |
</colgroup> |
| 91 |
<tbody><tr> |
| 92 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 93 |
<td><p> |
| 94 |
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>lba_data_size</code></em> (of type 'q'), <em class="parameter"><code>metadata_size</code></em> (of type 'q') and <em class="parameter"><code>secure_erase</code></em> (of type 's'). |
| 95 |
</p></td> |
| 96 |
</tr></tbody> |
| 97 |
</table></div> |
| 98 |
<p class="since">Since 2.10.0</p> |
| 99 |
</div> |
| 100 |
</div> |
| 101 |
<div class="refsect1"> |
| 102 |
<a name="gdbus-properties-org.freedesktop.UDisks2.NVMe.Namespace"></a><h2>Property Details</h2> |
| 103 |
<div class="refsect2"> |
| 104 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NSID"></a><h3>The "NSID" property</h3> |
| 105 |
<pre class="programlisting"> |
| 106 |
NSID readable u |
| 107 |
</pre> |
| 108 |
<p> |
| 109 |
</p> |
| 110 |
<p> |
| 111 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 112 |
</p> |
| 113 |
<p> |
| 114 |
The Namespace Identifier. |
| 115 |
</p> |
| 116 |
</div> |
| 117 |
<hr> |
| 118 |
<div class="refsect2"> |
| 119 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NGUID"></a><h3>The "NGUID" property</h3> |
| 120 |
<pre class="programlisting"> |
| 121 |
NGUID readable s |
| 122 |
</pre> |
| 123 |
<p> |
| 124 |
</p> |
| 125 |
<p> |
| 126 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 127 |
</p> |
| 128 |
<p> |
| 129 |
The Namespace Globally Unique Identifier. |
| 130 |
</p> |
| 131 |
<p> |
| 132 |
A 128-bit value that is globally unique and assigned to the namespace when the namespace |
| 133 |
is created. Remains fixed throughout the life of the namespace. |
| 134 |
</p> |
| 135 |
</div> |
| 136 |
<hr> |
| 137 |
<div class="refsect2"> |
| 138 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.EUI64"></a><h3>The "EUI64" property</h3> |
| 139 |
<pre class="programlisting"> |
| 140 |
EUI64 readable s |
| 141 |
</pre> |
| 142 |
<p> |
| 143 |
</p> |
| 144 |
<p> |
| 145 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 146 |
</p> |
| 147 |
<p> |
| 148 |
The IEEE Extended Unique Identifier. |
| 149 |
</p> |
| 150 |
<p> |
| 151 |
A 64-bit value that is globally unique and assigned to the namespace when the namespace |
| 152 |
is created. Remains fixed throughout the life of the namespace. |
| 153 |
</p> |
| 154 |
</div> |
| 155 |
<hr> |
| 156 |
<div class="refsect2"> |
| 157 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.UUID"></a><h3>The "UUID" property</h3> |
| 158 |
<pre class="programlisting"> |
| 159 |
UUID readable s |
| 160 |
</pre> |
| 161 |
<p> |
| 162 |
</p> |
| 163 |
<p> |
| 164 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 165 |
</p> |
| 166 |
<p> |
| 167 |
The Namespace UUID. |
| 168 |
</p> |
| 169 |
<p> |
| 170 |
Contains a 128-bit Universally Unique Identifier (UUID) as specified in RFC 4122. |
| 171 |
</p> |
| 172 |
</div> |
| 173 |
<hr> |
| 174 |
<div class="refsect2"> |
| 175 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.WWN"></a><h3>The "WWN" property</h3> |
| 176 |
<pre class="programlisting"> |
| 177 |
WWN readable s |
| 178 |
</pre> |
| 179 |
<p> |
| 180 |
</p> |
| 181 |
<p> |
| 182 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 183 |
</p> |
| 184 |
<p> |
| 185 |
The <a class="ulink" href="http://en.wikipedia.org/wiki/World_Wide_Name" target="_top">World Wide |
| 186 |
Name</a> of the namespace or blank if unknown. |
| 187 |
</p> |
| 188 |
</div> |
| 189 |
<hr> |
| 190 |
<div class="refsect2"> |
| 191 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.LBAFormats"></a><h3>The "LBAFormats" property</h3> |
| 192 |
<pre class="programlisting"> |
| 193 |
LBAFormats readable a(qqy) |
| 194 |
</pre> |
| 195 |
<p> |
| 196 |
</p> |
| 197 |
<p> |
| 198 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 199 |
</p> |
| 200 |
<p> |
| 201 |
List of LBA formats supported by the controller. |
| 202 |
</p> |
| 203 |
<p> |
| 204 |
This is an array of triplets of (<em class="parameter"><code>size</code></em>, <em class="parameter"><code>metadata_size</code></em>, <em class="parameter"><code>performance</code></em>) where <em class="parameter"><code>size</code></em> |
| 205 |
denotes LBA Data Size in bytes, <em class="parameter"><code>metadata_size</code></em> denotes the number of metadata bytes |
| 206 |
provided per LBA and <em class="parameter"><code>performance</code></em> indicates the relative performance relative |
| 207 |
to other formats in the list. |
| 208 |
</p> |
| 209 |
<p> |
| 210 |
Known values for <code class="literal">performance</code> include: |
| 211 |
</p> |
| 212 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 213 |
<colgroup> |
| 214 |
<col align="left" valign="top"> |
| 215 |
<col> |
| 216 |
</colgroup> |
| 217 |
<tbody> |
| 218 |
<tr> |
| 219 |
<td><p><span class="term">0</span></p></td> |
| 220 |
<td><p>Unknown relative performance index</p></td> |
| 221 |
</tr> |
| 222 |
<tr> |
| 223 |
<td><p><span class="term">1</span></p></td> |
| 224 |
<td><p>Best performance</p></td> |
| 225 |
</tr> |
| 226 |
<tr> |
| 227 |
<td><p><span class="term">2</span></p></td> |
| 228 |
<td><p>Better performance</p></td> |
| 229 |
</tr> |
| 230 |
<tr> |
| 231 |
<td><p><span class="term">3</span></p></td> |
| 232 |
<td><p>Good performance</p></td> |
| 233 |
</tr> |
| 234 |
<tr> |
| 235 |
<td><p><span class="term">4</span></p></td> |
| 236 |
<td><p>Degraded performance</p></td> |
| 237 |
</tr> |
| 238 |
</tbody> |
| 239 |
</table></div> |
| 240 |
<p> |
| 241 |
</p> |
| 242 |
</div> |
| 243 |
<hr> |
| 244 |
<div class="refsect2"> |
| 245 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.FormattedLBASize"></a><h3>The "FormattedLBASize" property</h3> |
| 246 |
<pre class="programlisting"> |
| 247 |
FormattedLBASize readable (qqy) |
| 248 |
</pre> |
| 249 |
<p> |
| 250 |
</p> |
| 251 |
<p> |
| 252 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 253 |
</p> |
| 254 |
<p> |
| 255 |
The actual LBA data size, the metadata size and the relative performance index |
| 256 |
that the namespace has been formatted with. |
| 257 |
</p> |
| 258 |
<p> |
| 259 |
Similar to <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.LBAFormats" title='The "LBAFormats" property'>"LBAFormats"</a> this is a triplet |
| 260 |
of (<em class="parameter"><code>size</code></em>, <em class="parameter"><code>metadata_size</code></em>, <em class="parameter"><code>performance</code></em>) where <em class="parameter"><code>size</code></em> denotes LBA Data Size |
| 261 |
in bytes, <em class="parameter"><code>metadata_size</code></em> denotes the number of metadata bytes provided per LBA |
| 262 |
and <em class="parameter"><code>performance</code></em> indicates the relative performance relative to other formats |
| 263 |
indicated in the <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.LBAFormats" title='The "LBAFormats" property'>"LBAFormats"</a> property. |
| 264 |
</p> |
| 265 |
</div> |
| 266 |
<hr> |
| 267 |
<div class="refsect2"> |
| 268 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NamespaceSize"></a><h3>The "NamespaceSize" property</h3> |
| 269 |
<pre class="programlisting"> |
| 270 |
NamespaceSize readable t |
| 271 |
</pre> |
| 272 |
<p> |
| 273 |
</p> |
| 274 |
<p> |
| 275 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 276 |
</p> |
| 277 |
<p> |
| 278 |
The total size of the namespace in logical blocks. The number of logical |
| 279 |
blocks is based on the formatted LBA size (see |
| 280 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.FormattedLBASize" title='The "FormattedLBASize" property'>"FormattedLBASize"</a>). |
| 281 |
</p> |
| 282 |
</div> |
| 283 |
<hr> |
| 284 |
<div class="refsect2"> |
| 285 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NamespaceCapacity"></a><h3>The "NamespaceCapacity" property</h3> |
| 286 |
<pre class="programlisting"> |
| 287 |
NamespaceCapacity readable t |
| 288 |
</pre> |
| 289 |
<p> |
| 290 |
</p> |
| 291 |
<p> |
| 292 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 293 |
</p> |
| 294 |
<p> |
| 295 |
The maximum number of logical blocks that may be allocated in the namespace. |
| 296 |
The number of logical blocks is based on the formatted LBA size (see |
| 297 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.FormattedLBASize" title='The "FormattedLBASize" property'>"FormattedLBASize"</a>). |
| 298 |
</p> |
| 299 |
</div> |
| 300 |
<hr> |
| 301 |
<div class="refsect2"> |
| 302 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NamespaceUtilization"></a><h3>The "NamespaceUtilization" property</h3> |
| 303 |
<pre class="programlisting"> |
| 304 |
NamespaceUtilization readable t |
| 305 |
</pre> |
| 306 |
<p> |
| 307 |
</p> |
| 308 |
<p> |
| 309 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 310 |
</p> |
| 311 |
<p> |
| 312 |
The current number of logical blocks allocated in the namespace. This value |
| 313 |
is less than or equal to the <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.NamespaceCapacity" title='The "NamespaceCapacity" property'>"NamespaceCapacity"</a>. |
| 314 |
The number of logical blocks is based on the formatted LBA size (see |
| 315 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.FormattedLBASize" title='The "FormattedLBASize" property'>"FormattedLBASize"</a>). |
| 316 |
</p> |
| 317 |
</div> |
| 318 |
<hr> |
| 319 |
<div class="refsect2"> |
| 320 |
<a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Namespace.FormatPercentRemaining"></a><h3>The "FormatPercentRemaining" property</h3> |
| 321 |
<pre class="programlisting"> |
| 322 |
FormatPercentRemaining readable i |
| 323 |
</pre> |
| 324 |
<p> |
| 325 |
The percent remaining of a running format operation or -1 if unknown (e.g. not reported by the drive). |
| 326 |
</p> |
| 327 |
<p class="since">Since 2.10.0</p> |
| 328 |
</div> |
| 329 |
</div> |
| 330 |
</div> |
| 331 |
<div class="footer"> |
| 332 |
<hr>Generated by GTK-Doc V1.35.1</div> |
| 333 |
</body> |
| 334 |
</html> |