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

Update documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2025-10-21 14:23:35 +01:00
parent f53092c941
commit 55b688c522
109 changed files with 6592 additions and 6502 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/html/blocks_2dump_8c.html
View File

@@ -114,7 +114,7 @@ $(function(){initNavTree('blocks_2dump_8c.html','',''); });
Functions</h2></td></tr>
<tr class="memitem:a5145c01023659313140eb978a393b6eb" id="r_a5145c01023659313140eb978a393b6eb"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5145c01023659313140eb978a393b6eb">free_dump_hardware_entries_array</a> (<a class="el" href="structDumpHardwareEntriesWithData.html">DumpHardwareEntriesWithData</a> *entries, uint16_t count)</td></tr>
<tr class="memitem:a2976d361aeda7bcc7b9ad40be6b7901d" id="r_a2976d361aeda7bcc7b9ad40be6b7901d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2976d361aeda7bcc7b9ad40be6b7901d">reset_dump_hardware_context</a> (<a class="el" href="structaaruformat__context.html">aaruformat_context</a> *ctx)</td></tr>
<tr class="memitem:aa79263803528183e28811dfb50e9bdad" id="r_aa79263803528183e28811dfb50e9bdad"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa79263803528183e28811dfb50e9bdad">read_dump_string</a> (FILE *stream, const char *field_name, uint32_t length, uint32_t *remaining, uint8_t **destination)</td></tr>
<tr class="memitem:aff8ea771002a521b511e11ce1ff8b3d3" id="r_aff8ea771002a521b511e11ce1ff8b3d3"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff8ea771002a521b511e11ce1ff8b3d3">read_dump_string</a> (FILE *stream, const char *field_name, const uint32_t length, uint32_t *remaining, uint8_t **destination)</td></tr>
<tr class="memitem:a0e2cfc858c0551bc9bef11d5bdb85aac" id="r_a0e2cfc858c0551bc9bef11d5bdb85aac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e2cfc858c0551bc9bef11d5bdb85aac">process_dumphw_block</a> (<a class="el" href="structaaruformat__context.html">aaruformat_context</a> *ctx, const <a class="el" href="structIndexEntry.html">IndexEntry</a> *entry)</td></tr>
<tr class="memdesc:a0e2cfc858c0551bc9bef11d5bdb85aac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processes a dump hardware block from the image stream. <br /></td></tr>
</table>
@@ -148,7 +148,7 @@ Functions</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="blocks_2dump_8c_source.html#l00036">36</a> of file <a class="el" href="blocks_2dump_8c_source.html">dump.c</a>.</p>
<p class="reference">Referenced by <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="blocks_2dump_8c_source.html#l00054">reset_dump_hardware_context()</a>.</p>
<p class="reference">Referenced by <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="blocks_2dump_8c_source.html#l00054">reset_dump_hardware_context()</a>.</p>
</div>
</div>
@@ -181,16 +181,16 @@ Functions</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="blocks_2dump_8c_source.html#l00108">108</a> of file <a class="el" href="blocks_2dump_8c_source.html">dump.c</a>.</p>
<p class="definition">Definition at line <a class="el" href="blocks_2dump_8c_source.html#l00107">107</a> of file <a class="el" href="blocks_2dump_8c_source.html">dump.c</a>.</p>
<p class="reference">References <a class="el" href="crc64_8c_source.html#l00160">aaruf_crc64_data()</a>, <a class="el" href="consts_8h_source.html#l00071">AARUF_VERSION_V1</a>, <a class="el" href="index_8h_source.html#l00110">IndexEntry::blockType</a>, <a class="el" href="endian_8h_source.html#l00081">bswap_64</a>, <a class="el" href="helpers_8c_source.html#l00459">compare_extents()</a>, <a class="el" href="dump_8h_source.html#l00095">DumpHardwareHeader::crc64</a>, <a class="el" href="context_8h_source.html#l00212">aaruformat_context::dump_hardware_entries_with_data</a>, <a class="el" href="context_8h_source.html#l00232">aaruformat_context::dump_hardware_header</a>, <a class="el" href="enums_8h_source.html#l00156">DumpHardwareBlock</a>, <a class="el" href="dump_8h_source.html#l00093">DumpHardwareHeader::entries</a>, <a class="el" href="context_8h_source.html#l00315">DumpHardwareEntriesWithData::entry</a>, <a class="el" href="context_8h_source.html#l00316">DumpHardwareEntriesWithData::extents</a>, <a class="el" href="dump_8h_source.html#l00122">DumpHardwareEntry::extents</a>, <a class="el" href="log_8h_source.html#l00040">FATAL</a>, <a class="el" href="context_8h_source.html#l00320">DumpHardwareEntriesWithData::firmware</a>, <a class="el" href="dump_8h_source.html#l00117">DumpHardwareEntry::firmwareLength</a>, <a class="el" href="blocks_2dump_8c_source.html#l00036">free_dump_hardware_entries_array()</a>, <a class="el" href="context_8h_source.html#l00175">aaruformat_context::header</a>, <a class="el" href="dump_8h_source.html#l00092">DumpHardwareHeader::identifier</a>, <a class="el" href="header_8h_source.html#l00110">AaruHeaderV2::imageMajorVersion</a>, <a class="el" href="context_8h_source.html#l00176">aaruformat_context::imageStream</a>, <a class="el" href="dump_8h_source.html#l00094">DumpHardwareHeader::length</a>, <a class="el" href="context_8h_source.html#l00317">DumpHardwareEntriesWithData::manufacturer</a>, <a class="el" href="dump_8h_source.html#l00114">DumpHardwareEntry::manufacturerLength</a>, <a class="el" href="context_8h_source.html#l00318">DumpHardwareEntriesWithData::model</a>, <a class="el" href="dump_8h_source.html#l00115">DumpHardwareEntry::modelLength</a>, <a class="el" href="index_8h_source.html#l00112">IndexEntry::offset</a>, <a class="el" href="blocks_2dump_8c_source.html#l00064">read_dump_string()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00054">reset_dump_hardware_context()</a>, <a class="el" href="context_8h_source.html#l00319">DumpHardwareEntriesWithData::revision</a>, <a class="el" href="dump_8h_source.html#l00116">DumpHardwareEntry::revisionLength</a>, <a class="el" href="context_8h_source.html#l00321">DumpHardwareEntriesWithData::serial</a>, <a class="el" href="dump_8h_source.html#l00118">DumpHardwareEntry::serialLength</a>, <a class="el" href="context_8h_source.html#l00322">DumpHardwareEntriesWithData::softwareName</a>, <a class="el" href="dump_8h_source.html#l00119">DumpHardwareEntry::softwareNameLength</a>, <a class="el" href="context_8h_source.html#l00324">DumpHardwareEntriesWithData::softwareOperatingSystem</a>, <a class="el" href="dump_8h_source.html#l00121">DumpHardwareEntry::softwareOperatingSystemLength</a>, <a class="el" href="context_8h_source.html#l00323">DumpHardwareEntriesWithData::softwareVersion</a>, <a class="el" href="dump_8h_source.html#l00120">DumpHardwareEntry::softwareVersionLength</a>, and <a class="el" href="log_8h_source.html#l00025">TRACE</a>.</p>
<p class="reference">References <a class="el" href="crc64_8c_source.html#l00160">aaruf_crc64_data()</a>, <a class="el" href="consts_8h_source.html#l00071">AARUF_VERSION_V1</a>, <a class="el" href="index_8h_source.html#l00110">IndexEntry::blockType</a>, <a class="el" href="endian_8h_source.html#l00081">bswap_64</a>, <a class="el" href="helpers_8c_source.html#l00459">compare_extents()</a>, <a class="el" href="dump_8h_source.html#l00095">DumpHardwareHeader::crc64</a>, <a class="el" href="context_8h_source.html#l00212">aaruformat_context::dump_hardware_entries_with_data</a>, <a class="el" href="context_8h_source.html#l00232">aaruformat_context::dump_hardware_header</a>, <a class="el" href="enums_8h_source.html#l00156">DumpHardwareBlock</a>, <a class="el" href="dump_8h_source.html#l00093">DumpHardwareHeader::entries</a>, <a class="el" href="context_8h_source.html#l00316">DumpHardwareEntriesWithData::entry</a>, <a class="el" href="context_8h_source.html#l00317">DumpHardwareEntriesWithData::extents</a>, <a class="el" href="dump_8h_source.html#l00122">DumpHardwareEntry::extents</a>, <a class="el" href="log_8h_source.html#l00040">FATAL</a>, <a class="el" href="context_8h_source.html#l00321">DumpHardwareEntriesWithData::firmware</a>, <a class="el" href="dump_8h_source.html#l00117">DumpHardwareEntry::firmwareLength</a>, <a class="el" href="blocks_2dump_8c_source.html#l00036">free_dump_hardware_entries_array()</a>, <a class="el" href="context_8h_source.html#l00175">aaruformat_context::header</a>, <a class="el" href="dump_8h_source.html#l00092">DumpHardwareHeader::identifier</a>, <a class="el" href="header_8h_source.html#l00110">AaruHeaderV2::imageMajorVersion</a>, <a class="el" href="context_8h_source.html#l00176">aaruformat_context::imageStream</a>, <a class="el" href="dump_8h_source.html#l00094">DumpHardwareHeader::length</a>, <a class="el" href="context_8h_source.html#l00318">DumpHardwareEntriesWithData::manufacturer</a>, <a class="el" href="dump_8h_source.html#l00114">DumpHardwareEntry::manufacturerLength</a>, <a class="el" href="context_8h_source.html#l00319">DumpHardwareEntriesWithData::model</a>, <a class="el" href="dump_8h_source.html#l00115">DumpHardwareEntry::modelLength</a>, <a class="el" href="index_8h_source.html#l00112">IndexEntry::offset</a>, <a class="el" href="blocks_2dump_8c_source.html#l00064">read_dump_string()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00054">reset_dump_hardware_context()</a>, <a class="el" href="context_8h_source.html#l00320">DumpHardwareEntriesWithData::revision</a>, <a class="el" href="dump_8h_source.html#l00116">DumpHardwareEntry::revisionLength</a>, <a class="el" href="context_8h_source.html#l00322">DumpHardwareEntriesWithData::serial</a>, <a class="el" href="dump_8h_source.html#l00118">DumpHardwareEntry::serialLength</a>, <a class="el" href="context_8h_source.html#l00323">DumpHardwareEntriesWithData::softwareName</a>, <a class="el" href="dump_8h_source.html#l00119">DumpHardwareEntry::softwareNameLength</a>, <a class="el" href="context_8h_source.html#l00325">DumpHardwareEntriesWithData::softwareOperatingSystem</a>, <a class="el" href="dump_8h_source.html#l00121">DumpHardwareEntry::softwareOperatingSystemLength</a>, <a class="el" href="context_8h_source.html#l00324">DumpHardwareEntriesWithData::softwareVersion</a>, <a class="el" href="dump_8h_source.html#l00120">DumpHardwareEntry::softwareVersionLength</a>, and <a class="el" href="log_8h_source.html#l00025">TRACE</a>.</p>
<p class="reference">Referenced by <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
<p class="reference">Referenced by <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>.</p>
</div>
</div>
<a id="aa79263803528183e28811dfb50e9bdad" name="aa79263803528183e28811dfb50e9bdad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa79263803528183e28811dfb50e9bdad">&#9670;&#160;</a></span>read_dump_string()</h2>
<a id="aff8ea771002a521b511e11ce1ff8b3d3" name="aff8ea771002a521b511e11ce1ff8b3d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff8ea771002a521b511e11ce1ff8b3d3">&#9670;&#160;</a></span>read_dump_string()</h2>
<div class="memitem">
<div class="memproto">
@@ -211,7 +211,7 @@ Functions</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>length</em></span>, </td>
<td class="paramtype">const uint32_t</td> <td class="paramname"><span class="paramname"><em>length</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -235,7 +235,7 @@ Functions</h2></td></tr>
<p class="reference">References <a class="el" href="log_8h_source.html#l00025">TRACE</a>.</p>
<p class="reference">Referenced by <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>.</p>
</div>
</div>
@@ -266,7 +266,7 @@ Functions</h2></td></tr>
<p class="reference">References <a class="el" href="context_8h_source.html#l00212">aaruformat_context::dump_hardware_entries_with_data</a>, <a class="el" href="context_8h_source.html#l00232">aaruformat_context::dump_hardware_header</a>, <a class="el" href="dump_8h_source.html#l00093">DumpHardwareHeader::entries</a>, and <a class="el" href="blocks_2dump_8c_source.html#l00036">free_dump_hardware_entries_array()</a>.</p>
<p class="reference">Referenced by <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>.</p>
</div>
</div>