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

Add doxygen documentation

Browse Source
This commit is contained in:
Natalia Portillo
2025-10-11 01:35:43 +01:00
parent 61850a9520
commit 697b755b1e
646 changed files with 124953 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
docs/html/structDumpHardwareHeader.html Normal file
View File

@@ -0,0 +1,218 @@
<!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: DumpHardwareHeader 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('structDumpHardwareHeader.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">DumpHardwareHeader Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Header that precedes a sequence of dump hardware entries and their variable-length payload.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="dump_8h_source.html">aaruformat/structs/dump.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:aa5764ab144eef9a32c08f4475254442d" id="r_aa5764ab144eef9a32c08f4475254442d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa5764ab144eef9a32c08f4475254442d">identifier</a></td></tr>
<tr class="memdesc:aa5764ab144eef9a32c08f4475254442d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block identifier, must be BlockType::DumpHardwareBlock. <br /></td></tr>
<tr class="memitem:aee1b5c61324635638fbfbb2518fb86d8" id="r_aee1b5c61324635638fbfbb2518fb86d8"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aee1b5c61324635638fbfbb2518fb86d8">entries</a></td></tr>
<tr class="memdesc:aee1b5c61324635638fbfbb2518fb86d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <a class="el" href="structDumpHardwareEntry.html" title="Per-environment length table describing subsequent UTF-8 strings and optional extent array.">DumpHardwareEntry</a> records that follow. <br /></td></tr>
<tr class="memitem:acc565625096da115c80e7e390e78a1fa" id="r_acc565625096da115c80e7e390e78a1fa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc565625096da115c80e7e390e78a1fa">length</a></td></tr>
<tr class="memdesc:acc565625096da115c80e7e390e78a1fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total payload bytes after this header (sum of entries, strings, and extents arrays). <br /></td></tr>
<tr class="memitem:a0dbdec7b89e7081706cd07dfa00403a7" id="r_a0dbdec7b89e7081706cd07dfa00403a7"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0dbdec7b89e7081706cd07dfa00403a7">crc64</a></td></tr>
<tr class="memdesc:a0dbdec7b89e7081706cd07dfa00403a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA of the payload (byte-swapped for legacy v1 images, handled automatically). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header that precedes a sequence of dump hardware entries and their variable-length payload. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00090">90</a> of file <a class="el" href="dump_8h_source.html">dump.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="a0dbdec7b89e7081706cd07dfa00403a7" name="a0dbdec7b89e7081706cd07dfa00403a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dbdec7b89e7081706cd07dfa00403a7">&#9670;&#160;</a></span>crc64</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t DumpHardwareHeader::crc64</td>
</tr>
</table>
</div><div class="memdoc">
<p>CRC64-ECMA of the payload (byte-swapped for legacy v1 images, handled automatically). </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00095">95</a> of file <a class="el" href="dump_8h_source.html">dump.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="aee1b5c61324635638fbfbb2518fb86d8" name="aee1b5c61324635638fbfbb2518fb86d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee1b5c61324635638fbfbb2518fb86d8">&#9670;&#160;</a></span>entries</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t DumpHardwareHeader::entries</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of <a class="el" href="structDumpHardwareEntry.html" title="Per-environment length table describing subsequent UTF-8 strings and optional extent array.">DumpHardwareEntry</a> records that follow. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00093">93</a> of file <a class="el" href="dump_8h_source.html">dump.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>, <a class="el" href="blocks_2dump_8c_source.html#l00054">reset_dump_hardware_context()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="aa5764ab144eef9a32c08f4475254442d" name="aa5764ab144eef9a32c08f4475254442d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5764ab144eef9a32c08f4475254442d">&#9670;&#160;</a></span>identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareHeader::identifier</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block identifier, must be BlockType::DumpHardwareBlock. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00092">92</a> of file <a class="el" href="dump_8h_source.html">dump.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="acc565625096da115c80e7e390e78a1fa" name="acc565625096da115c80e7e390e78a1fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc565625096da115c80e7e390e78a1fa">&#9670;&#160;</a></span>length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareHeader::length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total payload bytes after this header (sum of entries, strings, and extents arrays). </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00094">94</a> of file <a class="el" href="dump_8h_source.html">dump.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>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/structs/<a class="el" href="dump_8h_source.html">dump.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="structDumpHardwareHeader.html">DumpHardwareHeader</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>