]> begriffs open source - cmsis/blob - CMSIS/Documentation/Core/html/coreMISRA_Exceptions_pg.html
adding documentation for section 'Core'
[cmsis] / CMSIS / Documentation / Core / html / coreMISRA_Exceptions_pg.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>MISRA-C:2004 Compliance Exceptions</title>
7 <title>CMSIS-CORE: MISRA-C:2004 Compliance Exceptions</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="cmsis.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="printComponentTabs.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17   $(document).ready(initResizable);
18   $(window).load(resizeHeight);
19 </script>
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23   $(document).ready(function() { searchBox.OnSelectItem(0); });
24 </script>
25 </head>
26 <body>
27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
28 <div id="titlearea">
29 <table cellspacing="0" cellpadding="0">
30  <tbody>
31  <tr style="height: 46px;">
32   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
33   <td style="padding-left: 0.5em;">
34    <div id="projectname">CMSIS-CORE
35    &#160;<span id="projectnumber">Version 5.0.0 - Beta</span>
36    </div>
37    <div id="projectbrief">CMSIS-CORE support for Cortex-M processor-based devices</div>
38   </td>
39  </tr>
40  </tbody>
41 </table>
42 </div>
43 <!-- end header part -->
44 <div id="CMSISnav" class="tabs1">
45     <ul class="tablist">
46       <script type="text/javascript">
47                 <!--
48                 writeComponentTabs.call(this);
49                 //-->
50       </script>
51           </ul>
52 </div>
53 <!-- Generated by Doxygen 1.8.6 -->
54 <script type="text/javascript">
55 var searchBox = new SearchBox("searchBox", "search",false,'Search');
56 </script>
57   <div id="navrow1" class="tabs">
58     <ul class="tablist">
59       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
60       <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
61       <li><a href="modules.html"><span>Reference</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80 </div><!-- top -->
81 <div id="side-nav" class="ui-resizable side-nav-resizable">
82   <div id="nav-tree">
83     <div id="nav-tree-contents">
84       <div id="nav-sync" class="sync"></div>
85     </div>
86   </div>
87   <div id="splitbar" style="-moz-user-select:none;" 
88        class="ui-resizable-handle">
89   </div>
90 </div>
91 <script type="text/javascript">
92 $(document).ready(function(){initNavTree('coreMISRA_Exceptions_pg.html','');});
93 </script>
94 <div id="doc-content">
95 <!-- window showing the filter options -->
96 <div id="MSearchSelectWindow"
97      onmouseover="return searchBox.OnSearchSelectShow()"
98      onmouseout="return searchBox.OnSearchSelectHide()"
99      onkeydown="return searchBox.OnSearchSelectKey(event)">
100 <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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
101
102 <!-- iframe showing the search results (closed by default) -->
103 <div id="MSearchResultsWindow">
104 <iframe src="javascript:void(0)" frameborder="0" 
105         name="MSearchResults" id="MSearchResults">
106 </iframe>
107 </div>
108
109 <div class="header">
110   <div class="headertitle">
111 <div class="title">MISRA-C:2004 Compliance Exceptions </div>  </div>
112 </div><!--header-->
113 <div class="contents">
114 <div class="textblock"><p>CMSIS-CORE uses the common coding rules for CMSIS components that are documented under <a href="../../General/html/index.html"><b>Introduction</b></a>.</p>
115 <p>CMSIS-CORE violates the following MISRA-C:2004 rules:</p>
116 <ul>
117 <li>Required Rule 8.5, object/function definition in header file.<br/>
118  Violated since function definitions in header files are used for function inlining'.</li>
119 <li>Advisory Rule 12.4, Side effects on right hand side of logical operator.<br/>
120  Violated because volatile is used for core register definitions.</li>
121 <li>Advisory Rule 14.7, Return statement before end of function.<br/>
122  Violated to simplify code logic.</li>
123 <li>Required Rule 18.4, declaration of union type or object of union type: '{...}'.<br/>
124  Violated since unions are used for effective representation of core registers.</li>
125 <li>Advisory Rule 19.4, Disallowed definition for macro.<br/>
126  Violated since macros are used for assembler keywords.</li>
127 <li>Advisory Rule 19.7, Function-like macro defined.<br/>
128  Violated since function-like macros are used to generate more efficient code.</li>
129 <li>Advisory Rule 19.16, all preprocessing directives must be valid.<br/>
130  Violated to set default settings for macros.</li>
131 </ul>
132 <p>CMSIS-CORE violates the following MISRA-C:2012 rules:</p>
133 <ul>
134 <li>Directive 4.9, function-like macro defined.<br/>
135  Violated since function-like macros are used to generate more efficient code.</li>
136 <li>Rule 1.3, multiple use of '#/##' operators in macro definition.<br/>
137  Violated since function-like macros are used to generate more efficient code.</li>
138 <li>Rule 11.4, conversion between a pointer and integer type.<br/>
139  Violated because of core register access.</li>
140 <li>Rule 11.6, cast from unsigned long to pointer.<br/>
141  Violated because of core register access.</li>
142 <li>Rule 13.5, side effects on right hand side of logical operator.<br/>
143  Violated because of shift operand is used in macros and functions.</li>
144 <li>Rule 14.4, conditional expression should have essentially Boolean type.<br/>
145  Violated since macros with several instructions are used.</li>
146 <li>Rule 15.5, return statement before end of function.<br/>
147  Violated to simplify code logic.</li>
148 <li>Rule 20.10, '#/##' operators used.<br/>
149  Violated since function-like macros are used to generate more efficient code.</li>
150 <li>Rule 21.1, reserved to the compiler.<br/>
151  Violated since macros with leading underscores are used.</li>
152 </ul>
153 <p>&lt;device&gt;.h files generated by <b>SVDConv.exe</b> violate the following MISRA-C:2004 rules:</p>
154 <ul>
155 <li>Advisory Rule 20.2, Re-use of C90 identifier pattern.<br/>
156  Violated since CMSIS macros begin with '__'. Since CMSIS is developed and verified with various compilers this approach is acceptable and avoids conflicts with user symbols.</li>
157 <li>Advisory Rule 19.1, Declaration before #include.<br/>
158  Violated since Interrupt Number Definition Type (IRQn_Type) must be defined before including the core header file. </li>
159 </ul>
160 </div></div><!-- contents -->
161 </div><!-- doc-content -->
162 <!-- start footer part -->
163 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
164   <ul>
165     <li class="footer">Generated on Tue Sep 13 2016 16:45:26 for CMSIS-CORE by ARM Ltd. All rights reserved.
166         <!--
167     <a href="http://www.doxygen.org/index.html">
168     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
169         -->
170         </li>
171   </ul>
172 </div>
173 </body>
174 </html>