kingkevin
/
esp32-s2_dfu
1
0
Fork 0
Code Issues Releases Activity
esp32-s2_dfu/0.4/group___group___binary.html

247 lines
17 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
<title>tinyusb: Binary</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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 width="100%" cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">tinyusb
&#160;<span id="projectnumber">0.4</span>
</div>
</td>
<td align="right">
<a href="https://pledgie.com/campaigns/24694"><img border="0" src="https://pledgie.com/campaigns/24694.png?skin_name=chrome" alt="Click here to lend your support to tinyusb donation and make a donation at pledgie.com"></a>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</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">
$(document).ready(function(){initNavTree('group___group___binary.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></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> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Binary<div class="ingroups"><a class="el" href="group___group___common.html">Common Files</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa67325f45e71a327f9e4dbb8455f64ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa67325f45e71a327f9e4dbb8455f64ee"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___group___binary.html#gaa67325f45e71a327f9e4dbb8455f64ee">BIT_</a>(n)&#160;&#160;&#160;(1U &lt;&lt; (n))</td></tr>
<tr class="memdesc:gaa67325f45e71a327f9e4dbb8455f64ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">n-th Bit <br/></td></tr>
<tr class="separator:gaa67325f45e71a327f9e4dbb8455f64ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga52f110ca62427cecb50c01c08204d8ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga52f110ca62427cecb50c01c08204d8ac"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___group___binary.html#ga52f110ca62427cecb50c01c08204d8ac">BIT_SET_</a>(x, n)&#160;&#160;&#160;( (x) | <a class="el" href="group___group___binary.html#gaa67325f45e71a327f9e4dbb8455f64ee">BIT_</a>(n) )</td></tr>
<tr class="memdesc:ga52f110ca62427cecb50c01c08204d8ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">set n-th bit of x to 1 <br/></td></tr>
<tr class="separator:ga52f110ca62427cecb50c01c08204d8ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e873fd0547831dbe369afab3ac34aac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4e873fd0547831dbe369afab3ac34aac"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___group___binary.html#ga4e873fd0547831dbe369afab3ac34aac">BIT_CLR_</a>(x, n)&#160;&#160;&#160;( (x) &amp; (~<a class="el" href="group___group___binary.html#gaa67325f45e71a327f9e4dbb8455f64ee">BIT_</a>(n)) )</td></tr>
<tr class="memdesc:ga4e873fd0547831dbe369afab3ac34aac"><td class="mdescLeft">&#160;</td><td class="mdescRight">clear n-th bit of x <br/></td></tr>
<tr class="separator:ga4e873fd0547831dbe369afab3ac34aac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b95f183978653490c15f71b3028ad0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4b95f183978653490c15f71b3028ad0b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___group___binary.html#ga4b95f183978653490c15f71b3028ad0b">BIT_TEST_</a>(x, n)&#160;&#160;&#160;( ((x) &amp; <a class="el" href="group___group___binary.html#gaa67325f45e71a327f9e4dbb8455f64ee">BIT_</a>(n)) ? true : false )</td></tr>
<tr class="memdesc:ga4b95f183978653490c15f71b3028ad0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">check if n-th bit of x is 1 <br/></td></tr>
<tr class="separator:ga4b95f183978653490c15f71b3028ad0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab41e890e16c54266d9a06c74c86b9089"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>_B8__</b>(x)</td></tr>
<tr class="separator:gab41e890e16c54266d9a06c74c86b9089"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga80b79a1c9719ebbfe9773d8e47313e43"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga80b79a1c9719ebbfe9773d8e47313e43"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>BIN8</b>(d)&#160;&#160;&#160;((uint8_t) _B8__(0x##d##UL))</td></tr>
<tr class="separator:ga80b79a1c9719ebbfe9773d8e47313e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e21ef6fc74cf2f5f8dc7c60b049cab9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1e21ef6fc74cf2f5f8dc7c60b049cab9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>BIN16</b>(dmsb, dlsb)&#160;&#160;&#160;(((uint16_t)BIN8(dmsb)&lt;&lt;8) + BIN8(dlsb))</td></tr>
<tr class="separator:ga1e21ef6fc74cf2f5f8dc7c60b049cab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b406d1f3a4da5257ba760f808ac2b4f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>BIN32</b>(dmsb, db2, db3, dlsb)</td></tr>
<tr class="separator:ga3b406d1f3a4da5257ba760f808ac2b4f"><td class="memSeparator" colspan="2">&#160;</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:ga5871a61eb12e99ae7b092caf1ce2d658"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5871a61eb12e99ae7b092caf1ce2d658"></a>
static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>bit_set</b> (uint32_t value, uint8_t n) <a class="el" href="group___group___func_attr.html#gaa3a9548137fc3ca0ad1367d204891bd9">ATTR_CONST</a> <a class="el" href="group___group___i_a_r.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a></td></tr>
<tr class="separator:ga5871a61eb12e99ae7b092caf1ce2d658"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad812c72a4930eba34c6eec328f721491"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad812c72a4930eba34c6eec328f721491"></a>
static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>bit_clear</b> (uint32_t value, uint8_t n) <a class="el" href="group___group___func_attr.html#gaa3a9548137fc3ca0ad1367d204891bd9">ATTR_CONST</a> <a class="el" href="group___group___i_a_r.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a></td></tr>
<tr class="separator:gad812c72a4930eba34c6eec328f721491"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff4a3b9e2296b014c6d64762872d0872"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaff4a3b9e2296b014c6d64762872d0872"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___group___binary.html#gaff4a3b9e2296b014c6d64762872d0872">bit_test</a> (uint32_t value, uint8_t n)</td></tr>
<tr class="memdesc:gaff4a3b9e2296b014c6d64762872d0872"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a mask with n-bit lsb set to 1 <br/></td></tr>
<tr class="separator:gaff4a3b9e2296b014c6d64762872d0872"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc8fe4bb3325962bfe1a02a584609055"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabc8fe4bb3325962bfe1a02a584609055"></a>
static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>bit_mask</b> (uint8_t n) <a class="el" href="group___group___func_attr.html#gaa3a9548137fc3ca0ad1367d204891bd9">ATTR_CONST</a> <a class="el" href="group___group___i_a_r.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a></td></tr>
<tr class="separator:gabc8fe4bb3325962bfe1a02a584609055"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadccf3ba0dc6be2fba48a6c0b4e10edb3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadccf3ba0dc6be2fba48a6c0b4e10edb3"></a>
static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>bit_mask_range</b> (uint8_t start, uint32_t end) <a class="el" href="group___group___func_attr.html#gaa3a9548137fc3ca0ad1367d204891bd9">ATTR_CONST</a> <a class="el" href="group___group___i_a_r.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a></td></tr>
<tr class="separator:gadccf3ba0dc6be2fba48a6c0b4e10edb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31ec11b0ec4c14e3ff3adf72132fa2fa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga31ec11b0ec4c14e3ff3adf72132fa2fa"></a>
static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>bit_set_range</b> (uint32_t value, uint8_t start, uint8_t end, uint32_t pattern) <a class="el" href="group___group___func_attr.html#gaa3a9548137fc3ca0ad1367d204891bd9">ATTR_CONST</a> <a class="el" href="group___group___i_a_r.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a></td></tr>
<tr class="separator:ga31ec11b0ec4c14e3ff3adf72132fa2fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gab41e890e16c54266d9a06c74c86b9089"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define _B8__</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">(((x&amp;0x0000000FUL)?1:0) \</div>
<div class="line"> +((x&amp;0x000000F0UL)?2:0) \</div>
<div class="line"> +((x&amp;0x00000F00UL)?4:0) \</div>
<div class="line"> +((x&amp;0x0000F000UL)?8:0) \</div>
<div class="line"> +((x&amp;0x000F0000UL)?16:0) \</div>
<div class="line"> +((x&amp;0x00F00000UL)?32:0) \</div>
<div class="line"> +((x&amp;0x0F000000UL)?64:0) \</div>
<div class="line"> +((x&amp;0xF0000000UL)?128:0))</div>
</div><!-- fragment -->
<p>Definition at line <a class="el" href="binary_8h_source.html#l00107">107</a> of file <a class="el" href="binary_8h_source.html">binary.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga3b406d1f3a4da5257ba760f808ac2b4f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BIN32</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">dmsb, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">db2, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">db3, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">dlsb&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">(((uint32_t)BIN8(dmsb)&lt;&lt;24) \</div>
<div class="line"> + ((uint32_t)BIN8(db2)&lt;&lt;16) \</div>
<div class="line"> + ((uint32_t)BIN8(db3)&lt;&lt;8) \</div>
<div class="line"> + BIN8(dlsb))</div>
</div><!-- fragment -->
<p>Definition at line <a class="el" href="binary_8h_source.html#l00118">118</a> of file <a class="el" href="binary_8h_source.html">binary.h</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="footer">Generated on Thu Apr 17 2014 13:05:28 for tinyusb by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink