From 462c917ad0064fa4acb318dd397369370bc00387 Mon Sep 17 00:00:00 2001
From: Anna Bridge <Anna.Bridge@arm.com>
Date: Wed, 24 Feb 2016 19:35:16 +0000
Subject: [PATCH] Add a c based re-entrant critical section API

This includes a generic critical section implementation.  This
implementation also allow a user to start a critical section while
interrupts are already disabled.
---
 hal/api/critical.h    | 56 +++++++++++++++++++++++++++++++++++
 hal/common/critical.c | 68 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 124 insertions(+)
 create mode 100644 hal/api/critical.h
 create mode 100644 hal/common/critical.c

diff --git a/hal/api/critical.h b/hal/api/critical.h
new file mode 100644
index 0000000000..c08617db6e
--- /dev/null
+++ b/hal/api/critical.h
@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2015-2016, ARM Limited, All Rights Reserved
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef __MBED_UTIL_CRITICAL_H__
+#define __MBED_UTIL_CRITICAL_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** Mark the start of a critical section
+  *
+  * This function should be called to mark the start of a critical section of code.
+  * \note
+  * NOTES:
+  * 1) The use of this style of critical section is targetted at C based implementations.
+  * 2) These critical sections can be nested.
+  * 3) The interrupt enable state on entry to the first critical section (of a nested set, or single
+  *    section) will be preserved on exit from the section.
+  * 4) This implementation will currently only work on code running in privileged mode.
+  */
+void core_util_critical_section_enter();
+
+/** Mark the end of a critical section
+  *
+  * This function should be called to mark the end of a critical section of code.
+  * \note
+  * NOTES:
+  * 1) The use of this style of critical section is targetted at C based implementations.
+  * 2) These critical sections can be nested.
+  * 3) The interrupt enable state on entry to the first critical section (of a nested set, or single
+  *    section) will be preserved on exit from the section.
+  * 4) This implementation will currently only work on code running in privileged mode.
+  */
+void core_util_critical_section_exit();
+
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
+
+#endif // __MBED_UTIL_CRITICAL_H__
diff --git a/hal/common/critical.c b/hal/common/critical.c
new file mode 100644
index 0000000000..92414affd3
--- /dev/null
+++ b/hal/common/critical.c
@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2015-2016, ARM Limited, All Rights Reserved
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+#include <stdint.h>
+#include <stddef.h>
+#include "cmsis.h"
+#include <assert.h>
+
+// Module include
+#include "critical.h"
+
+static volatile uint32_t interrupt_enable_counter = 0;
+static volatile uint32_t critical_primask = 0;
+
+void core_util_critical_section_enter()
+{
+    uint32_t primask = __get_PRIMASK(); /* get the current interrupt enabled state */
+    __disable_irq();
+
+    /* Save the interrupt enabled state as it was prior to any nested critical section lock use */
+    if (!interrupt_enable_counter) {
+        critical_primask = primask & 0x1;
+    }
+
+    /* If the interrupt_enable_counter overflows or we are in a nested critical section and interrupts
+       are enabled, then something has gone badly wrong thus assert an error.
+    */
+     assert(interrupt_enable_counter < UINT32_MAX); 
+    if (interrupt_enable_counter > 0) {
+        assert(primask & 0x1);
+    }
+    interrupt_enable_counter++;
+}
+
+void core_util_critical_section_exit()
+{
+    /* If critical_section_enter has not previously been called, do nothing */
+    if (interrupt_enable_counter) {
+
+        uint32_t primask = __get_PRIMASK(); /* get the current interrupt enabled state */
+
+        assert(primask & 0x1); /* Interrupts must be disabled on invoking an exit from a critical section */
+
+        interrupt_enable_counter--;
+
+        /* Only re-enable interrupts if we are exiting the last of the nested critical sections and
+           interrupts were enabled on entry to the first critical section.
+        */
+        if (!interrupt_enable_counter && !critical_primask) {
+            __enable_irq();
+        }
+    }
+}