]> begriffs open source - cmsis/blob - main/Driver/group__usart__data__bits.html
Update documentation for branch main
[cmsis] / main / Driver / group__usart__data__bits.html
1 <!-- HTML header for doxygen 1.9.6-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>CMSIS-Driver: USART Data Bits</title>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="tabs.js"></script>
13 <script type="text/javascript" src="footer.js"></script>
14 <script type="text/javascript" src="navtree.js"></script>
15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
16 <script type="text/javascript" src="resize.js"></script>
17 <script type="text/javascript" src="navtreedata.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
24   $(document).ready(function() { init_search(); });
25 /* @license-end */
26 </script>
27 <script type="text/javascript" src="darkmode_toggle.js"></script>
28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
32 <link href="version.css" rel="stylesheet" type="text/css"/>
33 <script type="text/javascript" src="../../version.js"></script>
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 55px;">
41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
43    <div id="projectname">CMSIS-Driver
44    &#160;<span id="projectnumber"><script type="text/javascript">
45      <!--
46      writeHeader.call(this);
47      writeVersionDropdown.call(this, "CMSIS-Driver");
48      //-->
49     </script>
50    </span>
51    </div>
52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
53   </td>
54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
55         <span class="left">
56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
58                onfocus="searchBox.OnSearchFieldFocus(true)" 
59                onblur="searchBox.OnSearchFieldFocus(false)" 
60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
61           </span><span class="right">
62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
63           </span>
64         </div>
65 </td>
66   <!--END !PROJECT_NAME-->
67  </tr>
68  </tbody>
69 </table>
70 </div>
71 <!-- end header part -->
72 <div id="CMSISnav" class="tabs1">
73   <ul class="tablist">
74     <script type="text/javascript">
75       writeComponentTabs.call(this);
76     </script>
77   </ul>
78 </div>
79 <script type="text/javascript">
80   writeSubComponentTabs.call(this);
81 </script>
82 <!-- Generated by Doxygen 1.9.6 -->
83 <script type="text/javascript">
84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
85 var searchBox = new SearchBox("searchBox", "search/",'.html');
86 /* @license-end */
87 </script>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
101 $(document).ready(function(){initNavTree('group__usart__data__bits.html',''); initResizable(); });
102 /* @license-end */
103 </script>
104 <div id="doc-content">
105 <!-- window showing the filter options -->
106 <div id="MSearchSelectWindow"
107      onmouseover="return searchBox.OnSearchSelectShow()"
108      onmouseout="return searchBox.OnSearchSelectHide()"
109      onkeydown="return searchBox.OnSearchSelectKey(event)">
110 </div>
111
112 <!-- iframe showing the search results (closed by default) -->
113 <div id="MSearchResultsWindow">
114 <div id="MSearchResults">
115 <div class="SRPage">
116 <div id="SRIndex">
117 <div id="SRResults"></div>
118 <div class="SRStatus" id="Loading">Loading...</div>
119 <div class="SRStatus" id="Searching">Searching...</div>
120 <div class="SRStatus" id="NoMatches">No Matches</div>
121 </div>
122 </div>
123 </div>
124 </div>
125
126 <div class="header">
127   <div class="summary">
128 <a href="#define-members">Macros</a>  </div>
129   <div class="headertitle"><div class="title">USART Data Bits<div class="ingroups"><a class="el" href="group__usart__interface__gr.html">USART Interface</a> &raquo; <a class="el" href="group__USART__control.html">USART Control Codes</a></div></div></div>
130 </div><!--header-->
131 <div class="contents">
132
133 <p>Defines the number of data bits.  
134 <a href="#details">More...</a></p>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
137 Macros</h2></td></tr>
138 <tr class="memitem:ga981ff25b4ff806f743d1af4575b87339"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#ga981ff25b4ff806f743d1af4575b87339">ARM_USART_DATA_BITS_5</a>&#160;&#160;&#160;(5UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td></tr>
139 <tr class="memdesc:ga981ff25b4ff806f743d1af4575b87339"><td class="mdescLeft">&#160;</td><td class="mdescRight">5 Data bits  <br /></td></tr>
140 <tr class="separator:ga981ff25b4ff806f743d1af4575b87339"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ga92ba3d6cea5cd5c0b661667539a9e43c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#ga92ba3d6cea5cd5c0b661667539a9e43c">ARM_USART_DATA_BITS_6</a>&#160;&#160;&#160;(6UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td></tr>
142 <tr class="memdesc:ga92ba3d6cea5cd5c0b661667539a9e43c"><td class="mdescLeft">&#160;</td><td class="mdescRight">6 Data bit  <br /></td></tr>
143 <tr class="separator:ga92ba3d6cea5cd5c0b661667539a9e43c"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:gad86a2d971ce521c6f6eda28d4f8786a4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#gad86a2d971ce521c6f6eda28d4f8786a4">ARM_USART_DATA_BITS_7</a>&#160;&#160;&#160;(7UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td></tr>
145 <tr class="memdesc:gad86a2d971ce521c6f6eda28d4f8786a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">7 Data bits  <br /></td></tr>
146 <tr class="separator:gad86a2d971ce521c6f6eda28d4f8786a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:gadc5e8d17b5c69cd7f9135b849c2a4586"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">ARM_USART_DATA_BITS_8</a>&#160;&#160;&#160;(0UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td></tr>
148 <tr class="memdesc:gadc5e8d17b5c69cd7f9135b849c2a4586"><td class="mdescLeft">&#160;</td><td class="mdescRight">8 Data bits (default)  <br /></td></tr>
149 <tr class="separator:gadc5e8d17b5c69cd7f9135b849c2a4586"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:gae238a08198dc7ac6178ae0a2a95a2764"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#gae238a08198dc7ac6178ae0a2a95a2764">ARM_USART_DATA_BITS_9</a>&#160;&#160;&#160;(1UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td></tr>
151 <tr class="memdesc:gae238a08198dc7ac6178ae0a2a95a2764"><td class="mdescLeft">&#160;</td><td class="mdescRight">9 Data bits  <br /></td></tr>
152 <tr class="separator:gae238a08198dc7ac6178ae0a2a95a2764"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 </table>
154 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
155 <p>Defines the number of data bits. </p>
156 <h2 class="groupheader">Macro Definition Documentation</h2>
157 <a id="ga981ff25b4ff806f743d1af4575b87339" name="ga981ff25b4ff806f743d1af4575b87339"></a>
158 <h2 class="memtitle"><span class="permalink"><a href="#ga981ff25b4ff806f743d1af4575b87339">&#9670;&#160;</a></span>ARM_USART_DATA_BITS_5</h2>
159
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname">#define ARM_USART_DATA_BITS_5&#160;&#160;&#160;(5UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td>
165         </tr>
166       </table>
167 </div><div class="memdoc">
168
169 <p>5 Data bits </p>
170 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
171
172 </div>
173 </div>
174 <a id="ga92ba3d6cea5cd5c0b661667539a9e43c" name="ga92ba3d6cea5cd5c0b661667539a9e43c"></a>
175 <h2 class="memtitle"><span class="permalink"><a href="#ga92ba3d6cea5cd5c0b661667539a9e43c">&#9670;&#160;</a></span>ARM_USART_DATA_BITS_6</h2>
176
177 <div class="memitem">
178 <div class="memproto">
179       <table class="memname">
180         <tr>
181           <td class="memname">#define ARM_USART_DATA_BITS_6&#160;&#160;&#160;(6UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td>
182         </tr>
183       </table>
184 </div><div class="memdoc">
185
186 <p>6 Data bit </p>
187 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
188
189 </div>
190 </div>
191 <a id="gad86a2d971ce521c6f6eda28d4f8786a4" name="gad86a2d971ce521c6f6eda28d4f8786a4"></a>
192 <h2 class="memtitle"><span class="permalink"><a href="#gad86a2d971ce521c6f6eda28d4f8786a4">&#9670;&#160;</a></span>ARM_USART_DATA_BITS_7</h2>
193
194 <div class="memitem">
195 <div class="memproto">
196       <table class="memname">
197         <tr>
198           <td class="memname">#define ARM_USART_DATA_BITS_7&#160;&#160;&#160;(7UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td>
199         </tr>
200       </table>
201 </div><div class="memdoc">
202
203 <p>7 Data bits </p>
204 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
205
206 </div>
207 </div>
208 <a id="gadc5e8d17b5c69cd7f9135b849c2a4586" name="gadc5e8d17b5c69cd7f9135b849c2a4586"></a>
209 <h2 class="memtitle"><span class="permalink"><a href="#gadc5e8d17b5c69cd7f9135b849c2a4586">&#9670;&#160;</a></span>ARM_USART_DATA_BITS_8</h2>
210
211 <div class="memitem">
212 <div class="memproto">
213       <table class="memname">
214         <tr>
215           <td class="memname">#define ARM_USART_DATA_BITS_8&#160;&#160;&#160;(0UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td>
216         </tr>
217       </table>
218 </div><div class="memdoc">
219
220 <p>8 Data bits (default) </p>
221 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
222
223 </div>
224 </div>
225 <a id="gae238a08198dc7ac6178ae0a2a95a2764" name="gae238a08198dc7ac6178ae0a2a95a2764"></a>
226 <h2 class="memtitle"><span class="permalink"><a href="#gae238a08198dc7ac6178ae0a2a95a2764">&#9670;&#160;</a></span>ARM_USART_DATA_BITS_9</h2>
227
228 <div class="memitem">
229 <div class="memproto">
230       <table class="memname">
231         <tr>
232           <td class="memname">#define ARM_USART_DATA_BITS_9&#160;&#160;&#160;(1UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">ARM_USART_DATA_BITS_Pos</a>)</td>
233         </tr>
234       </table>
235 </div><div class="memdoc">
236
237 <p>9 Data bits </p>
238 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
239
240 </div>
241 </div>
242 </div><!-- contents -->
243 </div><!-- doc-content -->
244 <!-- start footer part -->
245 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
246   <ul>
247     <li class="footer">
248       <script type="text/javascript">
249         <!--
250         writeFooter.call(this);
251         //-->
252       </script> 
253     </li>
254   </ul>
255 </div>
256 </body>
257 </html>