Add coverity example (#870)

* Add coverity example * Update for CI * Fix for CI 2 * Update kernel_misra.config * Rename coverity example to coverity * Update FreeRTOSConfig.h for coverity project * Update MISRA.md * Move coverity config to coverity_misra.config * Update coverity misra config * Add README.md file * Update FreeRTOSConfig.h for coverity * Fix uncrustify and spell * Update README.md for relative link path Update README.md for relative link path * Update README.md for relative link 2 * Update MISRA.md for relateive path * Fix for format * Update coverity_misra.config * Update configuration folder * Update README.md for link * Code review suggestions Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com> --------- Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com> Co-authored-by: Ubuntu <ubuntu@ip-172-31-34-245.ap-northeast-1.compute.internal> Co-authored-by: Rahul Kar <118818625+kar-rahul-aws@users.noreply.github.com> Co-authored-by: Soren Ptak <ptaksoren@gmail.com> Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com> Co-authored-by: Gaurav Aggarwal <aggarg@amazon.com>
2025-09-01 20:03:50 -04:00 · 2023-12-08 03:24:20 +08:00 · 2023-12-08 03:24:20 +08:00 · 5dbfd380f0
commit 5dbfd380f0
parent ac7fc396a0
7 changed files with 343 additions and 44 deletions
--- a/examples/coverity/coverity_misra.config
+++ b/examples/coverity/coverity_misra.config
@ -0,0 +1,97 @@
+// MISRA C-2012 Rules
+
+{
+    version : "2.0",
+    standard : "c2012",
+    title: "Coverity MISRA Configuration",
+    deviations : [
+        // Disable the following rules.
+        {
+            deviation: "Rule 3.1",
+            reason: "We post HTTP links in code comments which contain // inside comments blocks."
+        },
+        {
+            deviation: "Rule 14.4",
+            reason: "do while( 0 ) pattern is used in macros to prevent extra semi-colon."
+        },
+
+        // Disable the following advisory rules and directives.
+        {
+            deviation: "Directive 4.4",
+            reason: "Code snippet is used in comment to help explanation."
+        },
+        {
+            deviation: "Directive 4.5",
+            reason: "Allow names that MISRA considers ambiguous."
+        },
+        {
+            deviation: "Directive 4.6",
+            reason: "Allow port to use primitive type with typedefs."
+        },
+        {
+            deviation: "Directive 4.8",
+            reason: "HeapRegion_t and HeapStats_t are used only in heap files but declared in portable.h which is included in multiple source files. As a result, these definitions appear in multiple source files where they are not used."
+        },
+        {
+            deviation: "Directive 4.9",
+            reason: "FreeRTOS-Kernel is optimised to work on small micro-controllers. To achieve that, function-like macros are used."
+        },
+        {
+            deviation: "Rule 2.3",
+            reason: "FreeRTOS defines types which is used in application."
+        },
+        {
+            deviation: "Rule 2.4",
+            reason: "Allow to define unused tag."
+        },
+        {
+            deviation: "Rule 2.5",
+            reason: "Allow to define unused macro."
+        },
+        {
+            deviation: "Rule 5.9",
+            reason: "Allow to define identifier with the same name in structure and global variable."
+        },
+        {
+            deviation: "Rule 8.7",
+            reason: "API functions are not used by the library outside of the files they are defined; however, they must be externally visible in order to be used by an application."
+        },
+        {
+            deviation: "Rule 8.9",
+            reason: "Allow to object to be defined in wider scope for debug purpose."
+        },
+        {
+            deviation: "Rule 8.13",
+            reason: "Allow to not to use const-qualified type for callback function."
+        },
+        {
+            deviation: "Rule 11.4",
+            reason: "Allow to convert between a pointer to object and an interger type for stack alignment."
+        },
+        {
+            deviation: "Rule 15.4",
+            reason: "Allow to use multiple break statements in a loop."
+        },
+        {
+            deviation: "Rule 15.5",
+            reason: "Allow to use multiple points of exit."
+        },
+        {
+            deviation: "Rule 17.8",
+            reason: "Allow to update the parameters of a function."
+        },
+        {
+            deviation: "Rule 18.4",
+            reason: "Allow to use pointer arithmetic."
+        },
+        {
+            deviation: "Rule 19.2",
+            reason: "Allow to use union."
+        },
+        {
+            deviation: "Rule 20.5",
+            reason: "Allow to use #undef for MPU wrappers."
+        }
+    ]
+}
+