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
a56b6d83fcc1a1ba9e1bd15fd6f9a5d047034e7b
libaaruformat/docs/html/dump_8h_source.html

176 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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: include/aaruformat/structs/dump.h Source File</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('dump_8h_source.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">dump.h</div></div>
</div><!--header-->
<div class="contents">
<a href="dump_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * This file is part of the Aaru Data Preservation Suite.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (c) 2019-2025 Natalia Portillo.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * published by the Free Software Foundation; either version 2.1 of the</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * License, or (at your option) any later version.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * License along with this library; if not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef LIBAARUFORMAT_DUMP_H</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define LIBAARUFORMAT_DUMP_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;stdint.h&gt;</span> <span class="comment">/* Fixed-width integer types for on‑disk packed structures */</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#pragma pack(push, 1)</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span></div>
<div class="foldopen" id="foldopen00090" data-start="{" data-end="};">
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="structDumpHardwareHeader.html"> 90</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structDumpHardwareHeader.html">DumpHardwareHeader</a></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>{</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="structDumpHardwareHeader.html#aa5764ab144eef9a32c08f4475254442d"> 92</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareHeader.html#aa5764ab144eef9a32c08f4475254442d">identifier</a>; </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="structDumpHardwareHeader.html#aee1b5c61324635638fbfbb2518fb86d8"> 93</a></span> uint16_t <a class="code hl_variable" href="structDumpHardwareHeader.html#aee1b5c61324635638fbfbb2518fb86d8">entries</a>; </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="structDumpHardwareHeader.html#acc565625096da115c80e7e390e78a1fa"> 94</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareHeader.html#acc565625096da115c80e7e390e78a1fa">length</a>; </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="structDumpHardwareHeader.html#a0dbdec7b89e7081706cd07dfa00403a7"> 95</a></span> uint64_t <a class="code hl_variable" href="structDumpHardwareHeader.html#a0dbdec7b89e7081706cd07dfa00403a7">crc64</a>; </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="dump_8h.html#aa981a0ca569affe1e54ca0e382adb1cd"> 96</a></span>} <a class="code hl_struct" href="structDumpHardwareHeader.html">DumpHardwareHeader</a>;</div>
</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span></div>
<div class="foldopen" id="foldopen00112" data-start="{" data-end="};">
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html"> 112</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structDumpHardwareEntry.html">DumpHardwareEntry</a></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span>{</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#a38a2c1b15dc4cabc02b4124b3a52c8db"> 114</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#a38a2c1b15dc4cabc02b4124b3a52c8db">manufacturerLength</a>; </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#a81f6da3ced18e060c27a3bc3ac4387c3"> 115</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#a81f6da3ced18e060c27a3bc3ac4387c3">modelLength</a>; </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#aca3e85fe2b6b8dd49afde691e5cf1ee8"> 116</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#aca3e85fe2b6b8dd49afde691e5cf1ee8">revisionLength</a>; </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#a52948ae4f0d07e4d861e79def4a0deec"> 117</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#a52948ae4f0d07e4d861e79def4a0deec">firmwareLength</a>; </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#ab363d118785e94df2acc0c8dc1a9d1b5"> 118</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#ab363d118785e94df2acc0c8dc1a9d1b5">serialLength</a>; </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#a20025e2e89599dd60a83ca623fc9a200"> 119</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#a20025e2e89599dd60a83ca623fc9a200">softwareNameLength</a>; </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#a4b4d1afcec5c3a0ec0e5f61fc481171d"> 120</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#a4b4d1afcec5c3a0ec0e5f61fc481171d">softwareVersionLength</a>; </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#adea9ba6d578c27ee86524e7ff91dcbdd"> 121</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#adea9ba6d578c27ee86524e7ff91dcbdd">softwareOperatingSystemLength</a>; </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="structDumpHardwareEntry.html#a558ff77451f13188e00f5b8da4c595ad"> 122</a></span> uint32_t <a class="code hl_variable" href="structDumpHardwareEntry.html#a558ff77451f13188e00f5b8da4c595ad">extents</a>; </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="dump_8h.html#afd61d0986223157fbb7355586be9dcf1"> 123</a></span>} <a class="code hl_struct" href="structDumpHardwareEntry.html">DumpHardwareEntry</a>;</div>
</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="preprocessor">#pragma pack(pop)</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_DUMP_H</span></div>
<div class="ttc" id="astructDumpHardwareEntry_html"><div class="ttname"><a href="structDumpHardwareEntry.html">DumpHardwareEntry</a></div><div class="ttdoc">Per-environment length table describing subsequent UTF-8 strings and optional extent array.</div><div class="ttdef"><b>Definition</b> <a href="#l00112">dump.h:113</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_a20025e2e89599dd60a83ca623fc9a200"><div class="ttname"><a href="structDumpHardwareEntry.html#a20025e2e89599dd60a83ca623fc9a200">DumpHardwareEntry::softwareNameLength</a></div><div class="ttdeci">uint32_t softwareNameLength</div><div class="ttdoc">Length in bytes of dumping software name string.</div><div class="ttdef"><b>Definition</b> <a href="#l00119">dump.h:119</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_a38a2c1b15dc4cabc02b4124b3a52c8db"><div class="ttname"><a href="structDumpHardwareEntry.html#a38a2c1b15dc4cabc02b4124b3a52c8db">DumpHardwareEntry::manufacturerLength</a></div><div class="ttdeci">uint32_t manufacturerLength</div><div class="ttdoc">Length in bytes of manufacturer UTF-8 string.</div><div class="ttdef"><b>Definition</b> <a href="#l00114">dump.h:114</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_a4b4d1afcec5c3a0ec0e5f61fc481171d"><div class="ttname"><a href="structDumpHardwareEntry.html#a4b4d1afcec5c3a0ec0e5f61fc481171d">DumpHardwareEntry::softwareVersionLength</a></div><div class="ttdeci">uint32_t softwareVersionLength</div><div class="ttdoc">Length in bytes of dumping software version string.</div><div class="ttdef"><b>Definition</b> <a href="#l00120">dump.h:120</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_a52948ae4f0d07e4d861e79def4a0deec"><div class="ttname"><a href="structDumpHardwareEntry.html#a52948ae4f0d07e4d861e79def4a0deec">DumpHardwareEntry::firmwareLength</a></div><div class="ttdeci">uint32_t firmwareLength</div><div class="ttdoc">Length in bytes of firmware version string.</div><div class="ttdef"><b>Definition</b> <a href="#l00117">dump.h:117</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_a558ff77451f13188e00f5b8da4c595ad"><div class="ttname"><a href="structDumpHardwareEntry.html#a558ff77451f13188e00f5b8da4c595ad">DumpHardwareEntry::extents</a></div><div class="ttdeci">uint32_t extents</div><div class="ttdoc">Number of DumpExtent records following the strings (0 = none).</div><div class="ttdef"><b>Definition</b> <a href="#l00122">dump.h:122</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_a81f6da3ced18e060c27a3bc3ac4387c3"><div class="ttname"><a href="structDumpHardwareEntry.html#a81f6da3ced18e060c27a3bc3ac4387c3">DumpHardwareEntry::modelLength</a></div><div class="ttdeci">uint32_t modelLength</div><div class="ttdoc">Length in bytes of model UTF-8 string.</div><div class="ttdef"><b>Definition</b> <a href="#l00115">dump.h:115</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_ab363d118785e94df2acc0c8dc1a9d1b5"><div class="ttname"><a href="structDumpHardwareEntry.html#ab363d118785e94df2acc0c8dc1a9d1b5">DumpHardwareEntry::serialLength</a></div><div class="ttdeci">uint32_t serialLength</div><div class="ttdoc">Length in bytes of device serial number string.</div><div class="ttdef"><b>Definition</b> <a href="#l00118">dump.h:118</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_aca3e85fe2b6b8dd49afde691e5cf1ee8"><div class="ttname"><a href="structDumpHardwareEntry.html#aca3e85fe2b6b8dd49afde691e5cf1ee8">DumpHardwareEntry::revisionLength</a></div><div class="ttdeci">uint32_t revisionLength</div><div class="ttdoc">Length in bytes of revision / hardware revision string.</div><div class="ttdef"><b>Definition</b> <a href="#l00116">dump.h:116</a></div></div>
<div class="ttc" id="astructDumpHardwareEntry_html_adea9ba6d578c27ee86524e7ff91dcbdd"><div class="ttname"><a href="structDumpHardwareEntry.html#adea9ba6d578c27ee86524e7ff91dcbdd">DumpHardwareEntry::softwareOperatingSystemLength</a></div><div class="ttdeci">uint32_t softwareOperatingSystemLength</div><div class="ttdoc">Length in bytes of host operating system string.</div><div class="ttdef"><b>Definition</b> <a href="#l00121">dump.h:121</a></div></div>
<div class="ttc" id="astructDumpHardwareHeader_html"><div class="ttname"><a href="structDumpHardwareHeader.html">DumpHardwareHeader</a></div><div class="ttdoc">Header that precedes a sequence of dump hardware entries and their variable-length payload.</div><div class="ttdef"><b>Definition</b> <a href="#l00090">dump.h:91</a></div></div>
<div class="ttc" id="astructDumpHardwareHeader_html_a0dbdec7b89e7081706cd07dfa00403a7"><div class="ttname"><a href="structDumpHardwareHeader.html#a0dbdec7b89e7081706cd07dfa00403a7">DumpHardwareHeader::crc64</a></div><div class="ttdeci">uint64_t crc64</div><div class="ttdoc">CRC64-ECMA of the payload (byte-swapped for legacy v1 images, handled automatically).</div><div class="ttdef"><b>Definition</b> <a href="#l00095">dump.h:95</a></div></div>
<div class="ttc" id="astructDumpHardwareHeader_html_aa5764ab144eef9a32c08f4475254442d"><div class="ttname"><a href="structDumpHardwareHeader.html#aa5764ab144eef9a32c08f4475254442d">DumpHardwareHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::DumpHardwareBlock.</div><div class="ttdef"><b>Definition</b> <a href="#l00092">dump.h:92</a></div></div>
<div class="ttc" id="astructDumpHardwareHeader_html_acc565625096da115c80e7e390e78a1fa"><div class="ttname"><a href="structDumpHardwareHeader.html#acc565625096da115c80e7e390e78a1fa">DumpHardwareHeader::length</a></div><div class="ttdeci">uint32_t length</div><div class="ttdoc">Total payload bytes after this header (sum of entries, strings, and extents arrays).</div><div class="ttdef"><b>Definition</b> <a href="#l00094">dump.h:94</a></div></div>
<div class="ttc" id="astructDumpHardwareHeader_html_aee1b5c61324635638fbfbb2518fb86d8"><div class="ttname"><a href="structDumpHardwareHeader.html#aee1b5c61324635638fbfbb2518fb86d8">DumpHardwareHeader::entries</a></div><div class="ttdeci">uint16_t entries</div><div class="ttdoc">Number of DumpHardwareEntry records that follow.</div><div class="ttdef"><b>Definition</b> <a href="#l00093">dump.h:93</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li><li class="navelem"><a href="dump_8h.html">dump.h</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