<!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"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.16"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>UbixOS V2: C:/Dev/git/UbixOS/sys/include/net/inet_chksum.h 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> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</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 style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">UbixOS V2  <span id="projectnumber">2.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.16 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</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"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('inet__chksum_8h.html','');}); /* @license-end */ </script> <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"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">inet_chksum.h File Reference</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><code>#include "<a class="el" href="opt_8h_source.html">net/opt.h</a>"</code><br /> <code>#include "<a class="el" href="pbuf_8h_source.html">net/pbuf.h</a>"</code><br /> <code>#include "<a class="el" href="ip__addr_8h_source.html">net/ip_addr.h</a>"</code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for inet_chksum.h:</div> <div class="dyncontent"> <div class="center"><img src="inet__chksum_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2inet__chksum_8h" alt=""/></div> </div> </div><div class="textblock"><div class="dynheader"> This graph shows which files directly or indirectly include this file:</div> <div class="dyncontent"> <div class="center"><img src="inet__chksum_8h__dep__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2inet__chksum_8hdep" alt=""/></div> </div> </div> <p><a href="inet__chksum_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a6ffe83b4bdd1784a0671ee4778966a01"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="inet__chksum_8h.html#a6ffe83b4bdd1784a0671ee4778966a01">FOLD_U32T</a>(u)   (((u) >> 16) + ((u) & 0x0000ffffUL))</td></tr> <tr class="separator:a6ffe83b4bdd1784a0671ee4778966a01"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8b8abbe02c3da468346b45f3d5a356a3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="inet__chksum_8h.html#a8b8abbe02c3da468346b45f3d5a356a3">LWIP_CHKSUM_COPY_ALGORITHM</a>   0</td></tr> <tr class="separator:a8b8abbe02c3da468346b45f3d5a356a3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0196bd603262882d16b5264b52eafe18"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="inet__chksum_8h.html#a0196bd603262882d16b5264b52eafe18">SWAP_BYTES_IN_WORD</a>(w)   (((w) & 0xff) << 8) | (((w) & 0xff00) >> 8)</td></tr> <tr class="separator:a0196bd603262882d16b5264b52eafe18"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a34f1aa1587562a09e11b704b51bab043"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="inet__chksum_8h.html#a34f1aa1587562a09e11b704b51bab043">inet_chksum</a> (<a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> void *dataptr, <a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> len)</td></tr> <tr class="separator:a34f1aa1587562a09e11b704b51bab043"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab35967a50418358e194e8f80fdc3c865"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="inet__chksum_8h.html#ab35967a50418358e194e8f80fdc3c865">inet_chksum_pbuf</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p)</td></tr> <tr class="separator:ab35967a50418358e194e8f80fdc3c865"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa13cda42e7c262f5dee243ff6c28422f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="inet__chksum_8h.html#aa13cda42e7c262f5dee243ff6c28422f">ip_chksum_pseudo</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p, <a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> proto, <a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> proto_len, <a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *src, <a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *dest)</td></tr> <tr class="separator:aa13cda42e7c262f5dee243ff6c28422f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acfe7ab6c63ef998210c66bb4822b03b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="inet__chksum_8h.html#acfe7ab6c63ef998210c66bb4822b03b2">ip_chksum_pseudo_partial</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p, <a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> proto, <a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> proto_len, <a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> chksum_len, <a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *src, <a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *dest)</td></tr> <tr class="separator:acfe7ab6c63ef998210c66bb4822b03b2"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>IP checksum calculation functions </p> <p class="definition">Definition in file <a class="el" href="inet__chksum_8h_source.html">inet_chksum.h</a>.</p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="a6ffe83b4bdd1784a0671ee4778966a01"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6ffe83b4bdd1784a0671ee4778966a01">◆ </a></span>FOLD_U32T</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define FOLD_U32T</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">u</td><td>)</td> <td>   (((u) >> 16) + ((u) & 0x0000ffffUL))</td> </tr> </table> </div><div class="memdoc"> <p>Split an u32_t in two u16_ts and add them up </p> <p class="definition">Definition at line <a class="el" href="inet__chksum_8h_source.html#l00052">52</a> of file <a class="el" href="inet__chksum_8h_source.html">inet_chksum.h</a>.</p> </div> </div> <a id="a8b8abbe02c3da468346b45f3d5a356a3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8b8abbe02c3da468346b45f3d5a356a3">◆ </a></span>LWIP_CHKSUM_COPY_ALGORITHM</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_CHKSUM_COPY_ALGORITHM   0</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="inet__chksum_8h_source.html#l00067">67</a> of file <a class="el" href="inet__chksum_8h_source.html">inet_chksum.h</a>.</p> </div> </div> <a id="a0196bd603262882d16b5264b52eafe18"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0196bd603262882d16b5264b52eafe18">◆ </a></span>SWAP_BYTES_IN_WORD</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SWAP_BYTES_IN_WORD</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">w</td><td>)</td> <td>   (((w) & 0xff) << 8) | (((w) & 0xff00) >> 8)</td> </tr> </table> </div><div class="memdoc"> <p>Swap the bytes in an u16_t: much like <a class="el" href="def_8c.html#ad637280639de4066392e6b5614fa3e56">lwip_htons()</a> for little-endian </p> <p class="definition">Definition at line <a class="el" href="inet__chksum_8h_source.html#l00047">47</a> of file <a class="el" href="inet__chksum_8h_source.html">inet_chksum.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="a34f1aa1587562a09e11b704b51bab043"></a> <h2 class="memtitle"><span class="permalink"><a href="#a34f1aa1587562a09e11b704b51bab043">◆ </a></span>inet_chksum()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> inet_chksum </td> <td>(</td> <td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> void * </td> <td class="paramname"><em>dataptr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="inet__chksum_8c_source.html#l00555">555</a> of file <a class="el" href="inet__chksum_8c_source.html">inet_chksum.c</a>.</p> <p class="reference">References <a class="el" href="pbuf_8h_source.html#l00159">pbuf::len</a>, and <a class="el" href="inet__chksum_8c_source.html#l00057">LWIP_CHKSUM</a>.</p> </div> </div> <a id="ab35967a50418358e194e8f80fdc3c865"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab35967a50418358e194e8f80fdc3c865">◆ </a></span>inet_chksum_pbuf()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> inet_chksum_pbuf </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> * </td> <td class="paramname"><em>p</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate a checksum over a chain of pbufs (without pseudo-header, much like inet_chksum only pbufs are used).</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>pbuf chain over that the checksum should be calculated </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>checksum (as u16_t) to be saved directly in the protocol header </dd></dl> <p class="definition">Definition at line <a class="el" href="inet__chksum_8c_source.html#l00568">568</a> of file <a class="el" href="inet__chksum_8c_source.html">inet_chksum.c</a>.</p> <p class="reference">References <a class="el" href="inet__chksum_8h_source.html#l00052">FOLD_U32T</a>, <a class="el" href="pbuf_8h_source.html#l00159">pbuf::len</a>, <a class="el" href="inet__chksum_8c_source.html#l00057">LWIP_CHKSUM</a>, <a class="el" href="pbuf_8h_source.html#l00144">pbuf::next</a>, <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>, <a class="el" href="pbuf_8h_source.html#l00147">pbuf::payload</a>, and <a class="el" href="inet__chksum_8h_source.html#l00047">SWAP_BYTES_IN_WORD</a>.</p> </div> </div> <a id="aa13cda42e7c262f5dee243ff6c28422f"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa13cda42e7c262f5dee243ff6c28422f">◆ </a></span>ip_chksum_pseudo()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> ip_chksum_pseudo </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td> <td class="paramname"><em>proto</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> <td class="paramname"><em>proto_len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> * </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> * </td> <td class="paramname"><em>dest</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="inet__chksum_8c_source.html#l00379">379</a> of file <a class="el" href="inet__chksum_8c_source.html">inet_chksum.c</a>.</p> <p class="reference">References <a class="el" href="ip__addr_8h_source.html#l00301">ip_2_ip6</a>, and <a class="el" href="ip__addr_8h_source.html#l00296">IP_IS_V6</a>.</p> </div> </div> <a id="acfe7ab6c63ef998210c66bb4822b03b2"></a> <h2 class="memtitle"><span class="permalink"><a href="#acfe7ab6c63ef998210c66bb4822b03b2">◆ </a></span>ip_chksum_pseudo_partial()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> ip_chksum_pseudo_partial </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td> <td class="paramname"><em>proto</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> <td class="paramname"><em>proto_len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> <td class="paramname"><em>chksum_len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> * </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> * </td> <td class="paramname"><em>dest</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="inet__chksum_8c_source.html#l00526">526</a> of file <a class="el" href="inet__chksum_8c_source.html">inet_chksum.c</a>.</p> <p class="reference">References <a class="el" href="ip__addr_8h_source.html#l00301">ip_2_ip6</a>, and <a class="el" href="ip__addr_8h_source.html#l00296">IP_IS_V6</a>.</p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_e6bb53534ac0e427887cf7a94c0c004e.html">C:</a></li><li class="navelem"><a class="el" href="dir_d99d5d4662bf24521eef49da6a8cd34d.html">Dev</a></li><li class="navelem"><a class="el" href="dir_474a4b306371cf7e7f6fa12cb0b77df6.html">git</a></li><li class="navelem"><a class="el" href="dir_849109bbd106d461b128d63e5babcedf.html">UbixOS</a></li><li class="navelem"><a class="el" href="dir_6ec99f6d7d5182ba8913209ab70c9f18.html">sys</a></li><li class="navelem"><a class="el" href="dir_d1be8160e739b6eed1f7843efdbae1b3.html">include</a></li><li class="navelem"><a class="el" href="dir_8a452844cab5a537277ef786999bc939.html">net</a></li><li class="navelem"><a class="el" href="inet__chksum_8h.html">inet_chksum.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li> </ul> </div> </body> </html>