aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f0f364fd0e7336051f4882ba5ac0d178d8219f24
libaaruformat/docs/html/structDumpHardwareEntriesWithData.html

352 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: DumpHardwareEntriesWithData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('structDumpHardwareEntriesWithData.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">DumpHardwareEntriesWithData Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>In-memory representation of a dump hardware entry plus decoded variable-length fields &amp; extents.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="context_8h_source.html">aaruformat/context.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a9b5f7b438c99ede6988179b7b89915df" id="r_a9b5f7b438c99ede6988179b7b89915df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structDumpHardwareEntry.html">DumpHardwareEntry</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b5f7b438c99ede6988179b7b89915df">entry</a></td></tr>
<tr class="memdesc:a9b5f7b438c99ede6988179b7b89915df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fixed-size header with lengths &amp; counts. <br /></td></tr>
<tr class="memitem:a34453672c41a27c7d1b9a5df28f7df1a" id="r_a34453672c41a27c7d1b9a5df28f7df1a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structDumpExtent.html">DumpExtent</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a34453672c41a27c7d1b9a5df28f7df1a">extents</a></td></tr>
<tr class="memdesc:a34453672c41a27c7d1b9a5df28f7df1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of extents (entry.extents elements) or NULL. <br /></td></tr>
<tr class="memitem:a4dbc57a5f46892c5e0cde65c55c11e33" id="r_a4dbc57a5f46892c5e0cde65c55c11e33"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4dbc57a5f46892c5e0cde65c55c11e33">manufacturer</a></td></tr>
<tr class="memdesc:a4dbc57a5f46892c5e0cde65c55c11e33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Manufacturer string (UTF-8) or NULL. <br /></td></tr>
<tr class="memitem:a160651cc2a5247b99c9ebe38511cc475" id="r_a160651cc2a5247b99c9ebe38511cc475"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a160651cc2a5247b99c9ebe38511cc475">model</a></td></tr>
<tr class="memdesc:a160651cc2a5247b99c9ebe38511cc475"><td class="mdescLeft">&#160;</td><td class="mdescRight">Model string or NULL. <br /></td></tr>
<tr class="memitem:a05cc1da940a0009621038a0327719a91" id="r_a05cc1da940a0009621038a0327719a91"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a05cc1da940a0009621038a0327719a91">revision</a></td></tr>
<tr class="memdesc:a05cc1da940a0009621038a0327719a91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware revision string or NULL. <br /></td></tr>
<tr class="memitem:a04e71aaa515a5a88171f5730e371abbf" id="r_a04e71aaa515a5a88171f5730e371abbf"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a04e71aaa515a5a88171f5730e371abbf">firmware</a></td></tr>
<tr class="memdesc:a04e71aaa515a5a88171f5730e371abbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Firmware version string or NULL. <br /></td></tr>
<tr class="memitem:a6d328a63bbde6fc49d5a507a22801107" id="r_a6d328a63bbde6fc49d5a507a22801107"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6d328a63bbde6fc49d5a507a22801107">serial</a></td></tr>
<tr class="memdesc:a6d328a63bbde6fc49d5a507a22801107"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serial number string or NULL. <br /></td></tr>
<tr class="memitem:a31b56a2fa1f210aaa023eb031572e70b" id="r_a31b56a2fa1f210aaa023eb031572e70b"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a31b56a2fa1f210aaa023eb031572e70b">softwareName</a></td></tr>
<tr class="memdesc:a31b56a2fa1f210aaa023eb031572e70b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump software name or NULL. <br /></td></tr>
<tr class="memitem:a5766ab6474f43fac96fb0342136766cc" id="r_a5766ab6474f43fac96fb0342136766cc"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5766ab6474f43fac96fb0342136766cc">softwareVersion</a></td></tr>
<tr class="memdesc:a5766ab6474f43fac96fb0342136766cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump software version or NULL. <br /></td></tr>
<tr class="memitem:acfd385853ac00bbdbd5ef603aebfb44d" id="r_acfd385853ac00bbdbd5ef603aebfb44d"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acfd385853ac00bbdbd5ef603aebfb44d">softwareOperatingSystem</a></td></tr>
<tr class="memdesc:acfd385853ac00bbdbd5ef603aebfb44d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Host operating system string or NULL. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>In-memory representation of a dump hardware entry plus decoded variable-length fields &amp; extents. </p>
<p>All string pointers are NUL-terminated UTF-8 copies of on-disk data (or NULL if absent). extents array may be NULL when no ranges were recorded. Freed during context teardown. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00313">313</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a9b5f7b438c99ede6988179b7b89915df" name="a9b5f7b438c99ede6988179b7b89915df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b5f7b438c99ede6988179b7b89915df">&#9670;&#160;</a></span>entry</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structDumpHardwareEntry.html">DumpHardwareEntry</a> DumpHardwareEntriesWithData::entry</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fixed-size header with lengths &amp; counts. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00315">315</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a34453672c41a27c7d1b9a5df28f7df1a" name="a34453672c41a27c7d1b9a5df28f7df1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34453672c41a27c7d1b9a5df28f7df1a">&#9670;&#160;</a></span>extents</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structDumpExtent.html">DumpExtent</a>* DumpHardwareEntriesWithData::extents</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array of extents (entry.extents elements) or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00316">316</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a04e71aaa515a5a88171f5730e371abbf" name="a04e71aaa515a5a88171f5730e371abbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04e71aaa515a5a88171f5730e371abbf">&#9670;&#160;</a></span>firmware</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* DumpHardwareEntriesWithData::firmware</td>
</tr>
</table>
</div><div class="memdoc">
<p>Firmware version string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00320">320</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a4dbc57a5f46892c5e0cde65c55c11e33" name="a4dbc57a5f46892c5e0cde65c55c11e33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dbc57a5f46892c5e0cde65c55c11e33">&#9670;&#160;</a></span>manufacturer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* DumpHardwareEntriesWithData::manufacturer</td>
</tr>
</table>
</div><div class="memdoc">
<p>Manufacturer string (UTF-8) or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00317">317</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a160651cc2a5247b99c9ebe38511cc475" name="a160651cc2a5247b99c9ebe38511cc475"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a160651cc2a5247b99c9ebe38511cc475">&#9670;&#160;</a></span>model</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* DumpHardwareEntriesWithData::model</td>
</tr>
</table>
</div><div class="memdoc">
<p>Model string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00318">318</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a05cc1da940a0009621038a0327719a91" name="a05cc1da940a0009621038a0327719a91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05cc1da940a0009621038a0327719a91">&#9670;&#160;</a></span>revision</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* DumpHardwareEntriesWithData::revision</td>
</tr>
</table>
</div><div class="memdoc">
<p>Hardware revision string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00319">319</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a6d328a63bbde6fc49d5a507a22801107" name="a6d328a63bbde6fc49d5a507a22801107"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d328a63bbde6fc49d5a507a22801107">&#9670;&#160;</a></span>serial</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* DumpHardwareEntriesWithData::serial</td>
</tr>
</table>
</div><div class="memdoc">
<p>Serial number string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00321">321</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a31b56a2fa1f210aaa023eb031572e70b" name="a31b56a2fa1f210aaa023eb031572e70b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31b56a2fa1f210aaa023eb031572e70b">&#9670;&#160;</a></span>softwareName</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* DumpHardwareEntriesWithData::softwareName</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump software name or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00322">322</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="acfd385853ac00bbdbd5ef603aebfb44d" name="acfd385853ac00bbdbd5ef603aebfb44d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfd385853ac00bbdbd5ef603aebfb44d">&#9670;&#160;</a></span>softwareOperatingSystem</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* DumpHardwareEntriesWithData::softwareOperatingSystem</td>
</tr>
</table>
</div><div class="memdoc">
<p>Host operating system string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00324">324</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a5766ab6474f43fac96fb0342136766cc" name="a5766ab6474f43fac96fb0342136766cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5766ab6474f43fac96fb0342136766cc">&#9670;&#160;</a></span>softwareVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* DumpHardwareEntriesWithData::softwareVersion</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump software version or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00323">323</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/<a class="el" href="context_8h_source.html">context.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structDumpHardwareEntriesWithData.html">DumpHardwareEntriesWithData</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink