2025-10-11 01:35:43 +01:00
<!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: src/blocks/dump.c File 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" >   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('blocks_2dump_8c.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.c File Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "textblock" > < code > #include < inttypes.h> < / code > < br / >
< code > #include < limits.h> < / code > < br / >
< code > #include < stdint.h> < / code > < br / >
< code > #include < stdio.h> < / code > < br / >
< code > #include < stdlib.h> < / code > < br / >
< code > #include < string.h> < / code > < br / >
< code > #include " < a class = "el" href = "consts_8h_source.html" > aaruformat/consts.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "context_8h_source.html" > aaruformat/context.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "decls_8h_source.html" > aaruformat/decls.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "endian_8h_source.html" > aaruformat/endian.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "enums_8h_source.html" > aaruformat/enums.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "dump_8h_source.html" > aaruformat/structs/dump.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "index_8h_source.html" > aaruformat/structs/index.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "internal_8h_source.html" > internal.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "log_8h_source.html" > log.h< / a > " < / code > < br / >
< / div >
< p > < a href = "blocks_2dump_8c_source.html" > Go to the source code of this file.< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 id = "header-func-members" class = "groupheader" > < a id = "func-members" name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a5145c01023659313140eb978a393b6eb" id = "r_a5145c01023659313140eb978a393b6eb" > < td class = "memItemLeft" align = "right" valign = "top" > static void  < / 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  < / 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 >
2025-10-21 14:23:35 +01:00
< tr class = "memitem:aff8ea771002a521b511e11ce1ff8b3d3" id = "r_aff8ea771002a521b511e11ce1ff8b3d3" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / 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 >
2025-10-11 01:35:43 +01:00
< tr class = "memitem:a0e2cfc858c0551bc9bef11d5bdb85aac" id = "r_a0e2cfc858c0551bc9bef11d5bdb85aac" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / 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" >   < / td > < td class = "mdescRight" > Processes a dump hardware block from the image stream. < br / > < / td > < / tr >
< / table >
< a name = "doc-func-members" id = "doc-func-members" > < / a > < h2 id = "header-doc-func-members" class = "groupheader" > Function Documentation< / h2 >
< a id = "a5145c01023659313140eb978a393b6eb" name = "a5145c01023659313140eb978a393b6eb" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a5145c01023659313140eb978a393b6eb" > ◆   < / a > < / span > free_dump_hardware_entries_array()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void free_dump_hardware_entries_array < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "structDumpHardwareEntriesWithData.html" > DumpHardwareEntriesWithData< / a > *< / td > < td class = "paramname" > < span class = "paramname" > < em > entries< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t< / td > < td class = "paramname" > < span class = "paramname" > < em > count< / em > < / span >   )< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel static" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 >
2025-10-21 14:23:35 +01:00
< 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 >
2025-10-11 01:35:43 +01:00
< / div >
< / div >
< a id = "a0e2cfc858c0551bc9bef11d5bdb85aac" name = "a0e2cfc858c0551bc9bef11d5bdb85aac" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0e2cfc858c0551bc9bef11d5bdb85aac" > ◆   < / a > < / span > process_dumphw_block()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void process_dumphw_block < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "structaaruformat__context.html" > aaruformat_context< / a > *< / td > < td class = "paramname" > < span class = "paramname" > < em > ctx< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const < a class = "el" href = "structIndexEntry.html" > IndexEntry< / a > *< / td > < td class = "paramname" > < span class = "paramname" > < em > entry< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Processes a dump hardware block from the image stream. < / p >
< p > Reads a dump hardware block from the image and updates the context with its contents.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > ctx< / td > < td > Pointer to the aaruformat context. < / td > < / tr >
< tr > < td class = "paramname" > entry< / td > < td > Pointer to the index entry describing the dump hardware block. < / td > < / tr >
< / table >
< / dd >
< / dl >
2025-10-21 14:23:35 +01:00
< 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 >
2025-10-11 01:35:43 +01:00
2025-12-12 12:25:02 +00:00
< 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#l00341" > DumpHardwareEntriesWithData::entry< / a > , < a class = "el" href = "context_8h_source.html#l00342" > 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#l00346" > 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#l00343" > DumpHardwareEntriesWithData::manufacturer< / a > , < a class = "el" href = "dump_8h_source.html#l00114" > DumpHardwareEntry::manufacturerLength< / a > , < a class = "el" href = "context_8h_source.html#l00344" > 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#l00345" > DumpHardwareEntriesWithData::revision< / a > , < a class = "el" href = "dump_8h_source.html#l00116" > DumpHardwareEntry::revisionLength< / a > , < a class = "el" href = "context_8h_source.html#l00347" > DumpHardwareEntriesWithData::serial< / a > , < a class = "el" href = "dump_8h_source.html#l00118" > DumpHardwareEntry::serialLength< / a > , < a class = "el" href = "context_8h_source.html#l00348" > DumpHardwareEntriesWithData::softwareName< / a > , < a class = "el" href = "dump_8h_source.html#l00119" > DumpHardwareEntry::softwareNameLength< / a > , < a class = "el" href = "context_8h_source.html#l00350" > DumpHardwareEntriesWithData::softwareOperatingSystem< / a > , < a class = "el" href = "dump_8h_source.html#l00121" > DumpHardwareEntry::softwareOperatingSystemLength< / a > , < a class = "el" href = "context_8h_source.html#l00349" > 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 >
2025-10-11 01:35:43 +01:00
2025-10-21 14:23:35 +01:00
< p class = "reference" > Referenced by < a class = "el" href = "open_8c_source.html#l00223" > aaruf_open()< / a > .< / p >
2025-10-11 01:35:43 +01:00
< / div >
< / div >
2025-10-21 14:23:35 +01:00
< a id = "aff8ea771002a521b511e11ce1ff8b3d3" name = "aff8ea771002a521b511e11ce1ff8b3d3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aff8ea771002a521b511e11ce1ff8b3d3" > ◆   < / a > < / span > read_dump_string()< / h2 >
2025-10-11 01:35:43 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > bool read_dump_string < / td >
< td > (< / td >
< td class = "paramtype" > FILE *< / td > < td class = "paramname" > < span class = "paramname" > < em > stream< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const char *< / td > < td class = "paramname" > < span class = "paramname" > < em > field_name< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2025-10-21 14:23:35 +01:00
< td class = "paramtype" > const uint32_t< / td > < td class = "paramname" > < span class = "paramname" > < em > length< / em > < / span > , < / td >
2025-10-11 01:35:43 +01:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > remaining< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t **< / td > < td class = "paramname" > < span class = "paramname" > < em > destination< / em > < / span >   )< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel static" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p class = "definition" > Definition at line < a class = "el" href = "blocks_2dump_8c_source.html#l00064" > 64< / a > of file < a class = "el" href = "blocks_2dump_8c_source.html" > dump.c< / a > .< / p >
< p class = "reference" > References < a class = "el" href = "log_8h_source.html#l00025" > TRACE< / a > .< / p >
2025-10-21 14:23:35 +01:00
< p class = "reference" > Referenced by < a class = "el" href = "blocks_2dump_8c_source.html#l00107" > process_dumphw_block()< / a > .< / p >
2025-10-11 01:35:43 +01:00
< / div >
< / div >
< a id = "a2976d361aeda7bcc7b9ad40be6b7901d" name = "a2976d361aeda7bcc7b9ad40be6b7901d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2976d361aeda7bcc7b9ad40be6b7901d" > ◆   < / a > < / span > reset_dump_hardware_context()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void reset_dump_hardware_context < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "structaaruformat__context.html" > aaruformat_context< / a > *< / td > < td class = "paramname" > < span class = "paramname" > < em > ctx< / em > < / span > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel static" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p class = "definition" > Definition at line < a class = "el" href = "blocks_2dump_8c_source.html#l00054" > 54< / a > of file < a class = "el" href = "blocks_2dump_8c_source.html" > dump.c< / a > .< / p >
< 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 >
2025-10-21 14:23:35 +01:00
< p class = "reference" > Referenced by < a class = "el" href = "blocks_2dump_8c_source.html#l00107" > process_dumphw_block()< / a > .< / p >
2025-10-11 01:35:43 +01:00
< / div >
< / div >
< / 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 = "dir_68267d1309a1af8e8297ef4c3efbcdba.html" > src< / a > < / li > < li class = "navelem" > < a href = "dir_b2e0cd1ddd0a904cb261e9b68779deb4.html" > blocks< / a > < / li > < li class = "navelem" > < a href = "blocks_2dump_8c.html" > dump.c< / 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 >