404 lines
26 KiB
HTML
404 lines
26 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: L4drivers::Register_tmpl< BITS, BLOCK > Class Template 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('classL4drivers_1_1Register__tmpl.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">L4drivers::Register_tmpl< BITS, BLOCK > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Single hardware register inside a <a class="el" href="structL4drivers_1_1Register__block__base.html" title="Abstract register block interface.">Register_block_base</a> interface.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="hw__register__block_source.html">hw_register_block</a>></code></p>
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for L4drivers::Register_tmpl< BITS, BLOCK >:</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="classL4drivers_1_1Register__tmpl__inherit__graph.svg" width="256" height="551"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for L4drivers::Register_tmpl< BITS, BLOCK >:</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="classL4drivers_1_1Register__tmpl__coll__graph.svg" width="180" height="319"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae2b1b861a8912ed8a7f0fb7b5c747d69" id="r_ae2b1b861a8912ed8a7f0fb7b5c747d69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classL4drivers_1_1Register__tmpl.html">Register_tmpl</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2b1b861a8912ed8a7f0fb7b5c747d69">operator=</a> (value_type val)</td></tr>
|
|
<tr class="memdesc:ae2b1b861a8912ed8a7f0fb7b5c747d69"><td class="mdescLeft"> </td><td class="mdescRight">write <em class="arg">val</em> into the hardware register. <br /></td></tr>
|
|
<tr class="memitem:adedbf83b447999e16e8a612a782b4b58" id="r_adedbf83b447999e16e8a612a782b4b58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#adedbf83b447999e16e8a612a782b4b58">write</a> (value_type val)</td></tr>
|
|
<tr class="memdesc:adedbf83b447999e16e8a612a782b4b58"><td class="mdescLeft"> </td><td class="mdescRight">write <em class="arg">val</em> into the hardware register. <br /></td></tr>
|
|
<tr class="memitem:a8d02a3822fe79a38c48aed84137825df" id="r_a8d02a3822fe79a38c48aed84137825df"><td class="memItemLeft" align="right" valign="top">value_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d02a3822fe79a38c48aed84137825df">set</a> (value_type set_bits)</td></tr>
|
|
<tr class="memdesc:a8d02a3822fe79a38c48aed84137825df"><td class="mdescLeft"> </td><td class="mdescRight">set bits in <em class="arg">set_bits</em> in the hardware register. <br /></td></tr>
|
|
<tr class="memitem:a3478144684715d38a6bee16debf7e11f" id="r_a3478144684715d38a6bee16debf7e11f"><td class="memItemLeft" align="right" valign="top">value_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3478144684715d38a6bee16debf7e11f">clear</a> (value_type clear_bits)</td></tr>
|
|
<tr class="memdesc:a3478144684715d38a6bee16debf7e11f"><td class="mdescLeft"> </td><td class="mdescRight">clears bits in <em class="arg">clear_bits</em> in the hardware register. <br /></td></tr>
|
|
<tr class="memitem:a3740a119363b8a50db65eca84181205b" id="r_a3740a119363b8a50db65eca84181205b"><td class="memItemLeft" align="right" valign="top">value_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3740a119363b8a50db65eca84181205b">modify</a> (value_type clear_bits, value_type set_bits)</td></tr>
|
|
<tr class="memdesc:a3740a119363b8a50db65eca84181205b"><td class="mdescLeft"> </td><td class="mdescRight">clears bits in <em class="arg">clear_bits</em> and sets bits in <em class="arg">set_bits</em> in the hardware register. <br /></td></tr>
|
|
<tr class="inherit_header pub_methods_classL4drivers_1_1Ro__register__tmpl"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classL4drivers_1_1Ro__register__tmpl')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classL4drivers_1_1Ro__register__tmpl.html">L4drivers::Ro_register_tmpl< BITS, BLOCK ></a></td></tr>
|
|
<tr class="memitem:af47629d54bba5b9c6e87795b1accdf18 inherit pub_methods_classL4drivers_1_1Ro__register__tmpl" id="r_af47629d54bba5b9c6e87795b1accdf18"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4drivers_1_1Ro__register__tmpl.html#af47629d54bba5b9c6e87795b1accdf18">operator value_type</a> () const</td></tr>
|
|
<tr class="memdesc:af47629d54bba5b9c6e87795b1accdf18 inherit pub_methods_classL4drivers_1_1Ro__register__tmpl"><td class="mdescLeft"> </td><td class="mdescRight">read the value from the hardware register. <br /></td></tr>
|
|
<tr class="memitem:a5ddc5388a6e962a3f559792ddfe34c27 inherit pub_methods_classL4drivers_1_1Ro__register__tmpl" id="r_a5ddc5388a6e962a3f559792ddfe34c27"><td class="memItemLeft" align="right" valign="top">value_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4drivers_1_1Ro__register__tmpl.html#a5ddc5388a6e962a3f559792ddfe34c27">read</a> () const</td></tr>
|
|
<tr class="memdesc:a5ddc5388a6e962a3f559792ddfe34c27 inherit pub_methods_classL4drivers_1_1Ro__register__tmpl"><td class="mdescLeft"> </td><td class="mdescRight">read the value from the hardware register. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<unsigned BITS, typename BLOCK><br />
|
|
class L4drivers::Register_tmpl< BITS, BLOCK ></div><p>Single hardware register inside a <a class="el" href="structL4drivers_1_1Register__block__base.html" title="Abstract register block interface.">Register_block_base</a> interface. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">BITS</td><td>The access width for the register in bits. </td></tr>
|
|
<tr><td class="paramname">BLOCK</td><td>the type of the <a class="el" href="structL4drivers_1_1Register__block__base.html" title="Abstract register block interface.">Register_block_base</a> interface. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Objects of this type must be used only in temporary contexts not in global, class, or object scope. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="hw__register__block_source.html#l00237">237</a> of file <a class="el" href="hw__register__block_source.html">hw_register_block</a>.</p>
|
|
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3478144684715d38a6bee16debf7e11f" name="a3478144684715d38a6bee16debf7e11f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3478144684715d38a6bee16debf7e11f">◆ </a></span>clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<unsigned BITS, typename BLOCK> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">value_type <a class="el" href="classL4drivers_1_1Register__tmpl.html">L4drivers::Register_tmpl</a>< BITS, BLOCK >::clear </td>
|
|
<td>(</td>
|
|
<td class="paramtype">value_type</td> <td class="paramname"><span class="paramname"><em>clear_bits</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>clears bits in <em class="arg">clear_bits</em> in the hardware register. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">clear_bits</td><td>bits to be cleared within the hardware register.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This is a read-modify-write function that does a logical and of the old value from the register with the negated value of <em class="arg">clear_bits</em>.</p>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">unsigned</span> old_value = <a class="code hl_function" href="classL4drivers_1_1Ro__register__tmpl.html#a5ddc5388a6e962a3f559792ddfe34c27">read</a>();</div>
|
|
<div class="line"><a class="code hl_function" href="#adedbf83b447999e16e8a612a782b4b58">write</a>(old_value & ~clear_bits);</div>
|
|
<div class="ttc" id="aclassL4drivers_1_1Register__tmpl_html_adedbf83b447999e16e8a612a782b4b58"><div class="ttname"><a href="#adedbf83b447999e16e8a612a782b4b58">L4drivers::Register_tmpl::write</a></div><div class="ttdeci">void write(value_type val)</div><div class="ttdoc">write val into the hardware register.</div><div class="ttdef"><b>Definition</b> <a href="hw__register__block_source.html#l00259">hw_register_block:259</a></div></div>
|
|
<div class="ttc" id="aclassL4drivers_1_1Ro__register__tmpl_html_a5ddc5388a6e962a3f559792ddfe34c27"><div class="ttname"><a href="classL4drivers_1_1Ro__register__tmpl.html#a5ddc5388a6e962a3f559792ddfe34c27">L4drivers::Ro_register_tmpl::read</a></div><div class="ttdeci">value_type read() const</div><div class="ttdoc">read the value from the hardware register.</div><div class="ttdef"><b>Definition</b> <a href="hw__register__block_source.html#l00224">hw_register_block:224</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="hw__register__block_source.html#l00290">290</a> of file <a class="el" href="hw__register__block_source.html">hw_register_block</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="hw__register__block_source.html#l00290">L4drivers::Register_tmpl< MAX_BITS, Block >::clear()</a>.</p>
|
|
<div id="dynsection-2" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4drivers_1_1Register__tmpl_a3478144684715d38a6bee16debf7e11f_icgraph.svg" width="155" height="75"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3740a119363b8a50db65eca84181205b" name="a3740a119363b8a50db65eca84181205b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3740a119363b8a50db65eca84181205b">◆ </a></span>modify()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<unsigned BITS, typename BLOCK> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">value_type <a class="el" href="classL4drivers_1_1Register__tmpl.html">L4drivers::Register_tmpl</a>< BITS, BLOCK >::modify </td>
|
|
<td>(</td>
|
|
<td class="paramtype">value_type</td> <td class="paramname"><span class="paramname"><em>clear_bits</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">value_type</td> <td class="paramname"><span class="paramname"><em>set_bits</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>clears bits in <em class="arg">clear_bits</em> and sets bits in <em class="arg">set_bits</em> in the hardware register. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">clear_bits</td><td>bits to be cleared within the hardware register. </td></tr>
|
|
<tr><td class="paramname">set_bits</td><td>bits to set in the hardware register.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This is a read-modify-write function that first does a logical and of the old value from the register with the negated value of <em class="arg">clear_bits</em> and then does a logical or with <em class="arg">set_bits</em>.</p>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">unsigned</span> old_value = <a class="code hl_function" href="classL4drivers_1_1Ro__register__tmpl.html#a5ddc5388a6e962a3f559792ddfe34c27">read</a>();</div>
|
|
<div class="line"><a class="code hl_function" href="#adedbf83b447999e16e8a612a782b4b58">write</a>((old_value & ~clear_bits) | set_bits);</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="hw__register__block_source.html#l00308">308</a> of file <a class="el" href="hw__register__block_source.html">hw_register_block</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="hw__register__block_source.html#l00308">L4drivers::Register_tmpl< MAX_BITS, Block >::modify()</a>.</p>
|
|
<div id="dynsection-3" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4drivers_1_1Register__tmpl_a3740a119363b8a50db65eca84181205b_icgraph.svg" width="155" height="75"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2b1b861a8912ed8a7f0fb7b5c747d69" name="ae2b1b861a8912ed8a7f0fb7b5c747d69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2b1b861a8912ed8a7f0fb7b5c747d69">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<unsigned BITS, typename BLOCK> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classL4drivers_1_1Register__tmpl.html">Register_tmpl</a> & <a class="el" href="classL4drivers_1_1Register__tmpl.html">L4drivers::Register_tmpl</a>< BITS, BLOCK >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">value_type</td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>write <em class="arg">val</em> into the hardware register. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">val</td><td>the value to write into the hardware register. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="hw__register__block_source.html#l00252">252</a> of file <a class="el" href="hw__register__block_source.html">hw_register_block</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d02a3822fe79a38c48aed84137825df" name="a8d02a3822fe79a38c48aed84137825df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d02a3822fe79a38c48aed84137825df">◆ </a></span>set()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<unsigned BITS, typename BLOCK> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">value_type <a class="el" href="classL4drivers_1_1Register__tmpl.html">L4drivers::Register_tmpl</a>< BITS, BLOCK >::set </td>
|
|
<td>(</td>
|
|
<td class="paramtype">value_type</td> <td class="paramname"><span class="paramname"><em>set_bits</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set bits in <em class="arg">set_bits</em> in the hardware register. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">set_bits</td><td>bits to be set within the hardware register.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This is a read-modify-write function that does a logical or of the old value from the register with <em class="arg">set_bits</em>.</p>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">unsigned</span> old_value = <a class="code hl_function" href="classL4drivers_1_1Ro__register__tmpl.html#a5ddc5388a6e962a3f559792ddfe34c27">read</a>();</div>
|
|
<div class="line"><a class="code hl_function" href="#adedbf83b447999e16e8a612a782b4b58">write</a>(old_value | set_bits);</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="hw__register__block_source.html#l00274">274</a> of file <a class="el" href="hw__register__block_source.html">hw_register_block</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="hw__register__block_source.html#l00274">L4drivers::Register_tmpl< MAX_BITS, Block >::set()</a>.</p>
|
|
<div id="dynsection-4" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4drivers_1_1Register__tmpl_a8d02a3822fe79a38c48aed84137825df_icgraph.svg" width="155" height="75"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adedbf83b447999e16e8a612a782b4b58" name="adedbf83b447999e16e8a612a782b4b58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adedbf83b447999e16e8a612a782b4b58">◆ </a></span>write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<unsigned BITS, typename BLOCK> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classL4drivers_1_1Register__tmpl.html">L4drivers::Register_tmpl</a>< BITS, BLOCK >::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">value_type</td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>write <em class="arg">val</em> into the hardware register. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">val</td><td>the value to write into the hardware register. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="hw__register__block_source.html#l00259">259</a> of file <a class="el" href="hw__register__block_source.html">hw_register_block</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="hw__register__block_source.html#l00252">L4drivers::Register_tmpl< MAX_BITS, Block >::operator=()</a>, and <a class="el" href="hw__register__block_source.html#l00259">L4drivers::Register_tmpl< MAX_BITS, Block >::write()</a>.</p>
|
|
<div id="dynsection-5" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4drivers_1_1Register__tmpl_adedbf83b447999e16e8a612a782b4b58_icgraph.svg" width="387" height="83"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>pkg/drivers-frst/include/<a class="el" href="hw__register__block_source.html">hw_register_block</a></li>
|
|
</ul>
|
|
</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>L4drivers</b></li><li class="navelem"><a href="classL4drivers_1_1Register__tmpl.html">Register_tmpl</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>
|