Files
moslab-code/doc/source/html/bitops_8h.html
2025-09-12 15:55:45 +02:00

179 lines
15 KiB
HTML

<!-- HTML header for doxygen 1.9.1-->
<!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.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>L4Re Operating System Framework: l4/util/bitops.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="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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="l4re-awesome.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="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">L4Re Operating System Framework
</div>
<div id="projectbrief">Interface and Usage Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.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('bitops_8h.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">bitops.h File Reference<div class="ingroups"><a class="el" href="group__l4util__api.html">Utility Functions</a> &raquo; <a class="el" href="group__l4util__bitops.html">Bit Manipulation</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>bit manipulation functions
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="l4_2sys_2l4int_8h_source.html">l4/sys/l4int.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="compiler_8h_source.html">l4/sys/compiler.h</a>&gt;</code><br />
<code>#include &lt;l4/util/bitops_arch.h&gt;</code><br />
<code>#include &lt;<a class="el" href="l4_2util_2atomic_8h_source.html">l4/util/atomic.h</a>&gt;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Include dependency graph for bitops.h:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="bitops_8h__incl.svg" width="367" height="256"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="bitops_8h__dep__incl.svg" width="391" height="212"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="bitops_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae04f8fdb0ba7298bd9622fdeaec84af1" id="r_ae04f8fdb0ba7298bd9622fdeaec84af1"><td class="memItemLeft" align="right" valign="top"><a id="ae04f8fdb0ba7298bd9622fdeaec84af1" name="ae04f8fdb0ba7298bd9622fdeaec84af1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>l4util_test_and_clear_bit</b>(b, dest)</td></tr>
<tr class="memdesc:ae04f8fdb0ba7298bd9622fdeaec84af1"><td class="mdescLeft">&#160;</td><td class="mdescRight">define some more usual names <br /></td></tr>
</table><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:ga1e5017ce33e0af71dc00a526ffa46f0b" id="r_ga1e5017ce33e0af71dc00a526ffa46f0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#ga1e5017ce33e0af71dc00a526ffa46f0b">l4util_set_bit</a> (int b, volatile <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *dest)</td></tr>
<tr class="memdesc:ga1e5017ce33e0af71dc00a526ffa46f0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set bit in memory. <br /></td></tr>
<tr class="memitem:gab1ab1fd14748d27abd7862942b5ae46b" id="r_gab1ab1fd14748d27abd7862942b5ae46b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#gab1ab1fd14748d27abd7862942b5ae46b">l4util_clear_bit</a> (int b, volatile <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *dest)</td></tr>
<tr class="memdesc:gab1ab1fd14748d27abd7862942b5ae46b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear bit in memory. <br /></td></tr>
<tr class="memitem:gaf84c2a88f1ff6e02fd813a5c8c8210ea" id="r_gaf84c2a88f1ff6e02fd813a5c8c8210ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#gaf84c2a88f1ff6e02fd813a5c8c8210ea">l4util_complement_bit</a> (int b, volatile <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *dest)</td></tr>
<tr class="memdesc:gaf84c2a88f1ff6e02fd813a5c8c8210ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Complement bit in memory. <br /></td></tr>
<tr class="memitem:gab7c484d395cb55509f16ad13adff2e92" id="r_gab7c484d395cb55509f16ad13adff2e92"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#gab7c484d395cb55509f16ad13adff2e92">l4util_test_bit</a> (int b, const volatile <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *dest)</td></tr>
<tr class="memdesc:gab7c484d395cb55509f16ad13adff2e92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test bit (return value of bit). <br /></td></tr>
<tr class="memitem:gaa19a970e0ccba655837ac519d5adfdf0" id="r_gaa19a970e0ccba655837ac519d5adfdf0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#gaa19a970e0ccba655837ac519d5adfdf0">l4util_bts</a> (int b, volatile <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *dest)</td></tr>
<tr class="memdesc:gaa19a970e0ccba655837ac519d5adfdf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit test and set. <br /></td></tr>
<tr class="memitem:ga54de534dc4cb8daba99590f38edfd12c" id="r_ga54de534dc4cb8daba99590f38edfd12c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#ga54de534dc4cb8daba99590f38edfd12c">l4util_btr</a> (int b, volatile <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *dest)</td></tr>
<tr class="memdesc:ga54de534dc4cb8daba99590f38edfd12c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit test and reset. <br /></td></tr>
<tr class="memitem:ga473ec530a3eb2d06a2d13a9df3184229" id="r_ga473ec530a3eb2d06a2d13a9df3184229"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#ga473ec530a3eb2d06a2d13a9df3184229">l4util_btc</a> (int b, volatile <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *dest)</td></tr>
<tr class="memdesc:ga473ec530a3eb2d06a2d13a9df3184229"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit test and complement. <br /></td></tr>
<tr class="memitem:ga530be11fa91000db4c4539558e115bd2" id="r_ga530be11fa91000db4c4539558e115bd2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#ga530be11fa91000db4c4539558e115bd2">l4util_bsr</a> (<a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> word)</td></tr>
<tr class="memdesc:ga530be11fa91000db4c4539558e115bd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit scan reverse. <br /></td></tr>
<tr class="memitem:ga3906818d29569abd0c82fc7ec35687f7" id="r_ga3906818d29569abd0c82fc7ec35687f7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#ga3906818d29569abd0c82fc7ec35687f7">l4util_bsf</a> (<a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> word)</td></tr>
<tr class="memdesc:ga3906818d29569abd0c82fc7ec35687f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit scan forward. <br /></td></tr>
<tr class="memitem:ga6372526aa85a7f0d425ab706aa5e29d0" id="r_ga6372526aa85a7f0d425ab706aa5e29d0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#ga6372526aa85a7f0d425ab706aa5e29d0">l4util_find_first_set_bit</a> (const void *dest, <a class="el" href="group__l4__basic__types.html#ga08c1e83a068ded7add134b188cd44967">l4_size_t</a> size)</td></tr>
<tr class="memdesc:ga6372526aa85a7f0d425ab706aa5e29d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the first set bit in a memory region. <br /></td></tr>
<tr class="memitem:gaac1a9ad2db5efada47175656682e0eb7" id="r_gaac1a9ad2db5efada47175656682e0eb7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#gaac1a9ad2db5efada47175656682e0eb7">l4util_find_first_zero_bit</a> (const void *dest, <a class="el" href="group__l4__basic__types.html#ga08c1e83a068ded7add134b188cd44967">l4_size_t</a> size)</td></tr>
<tr class="memdesc:gaac1a9ad2db5efada47175656682e0eb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the first zero bit in a memory region. <br /></td></tr>
<tr class="memitem:ga30375b2869622616b5b5957261e9cb64" id="r_ga30375b2869622616b5b5957261e9cb64"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4util__bitops.html#ga30375b2869622616b5b5957261e9cb64">l4util_next_power2</a> (unsigned long val)</td></tr>
<tr class="memdesc:ga30375b2869622616b5b5957261e9cb64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the next power of 2 for a given number. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>bit manipulation functions </p>
<dl class="section date"><dt>Date</dt><dd>07/03/2001 </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Lars Reuther <a href="#" onclick="location.href='mai'+'lto:'+'reu'+'th'+'er@'+'os'+'.in'+'f.'+'tu-'+'dr'+'esd'+'en'+'.de'; return false;">reuth<span class="obfuscator">.nosp@m.</span>er@o<span class="obfuscator">.nosp@m.</span>s.inf<span class="obfuscator">.nosp@m.</span>.tu-<span class="obfuscator">.nosp@m.</span>dresd<span class="obfuscator">.nosp@m.</span>en.d<span class="obfuscator">.nosp@m.</span>e</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="bitops_8h_source.html">bitops.h</a>.</p>
</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 -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>l4</b></li><li class="navelem"><b>util</b></li><li class="navelem"><a href="bitops_8h.html">bitops.h</a></li>
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
</ul>
</div>
</body>
</html>