RTOS public apis (#1)

* Moved source files and internal headers to internal/ * Added doxygen commands
hugueskamba · Jul 3, 2019 · f4b986d · f4b986d
1 parent 7059221
commit f4b986d
Show file tree

Hide file tree

Showing 30 changed files with 97 additions and 71 deletions.
diff --git a/components/802.15.4_RF/atmel-rf-driver/source/NanostackRfPhyAtmel.cpp b/components/802.15.4_RF/atmel-rf-driver/source/NanostackRfPhyAtmel.cpp
@@ -32,6 +32,7 @@
 #include "SPI.h"
 #include "inttypes.h"
 #include "Timeout.h"
+#include "platform/mbed_error.h"
 
 #define TRACE_GROUP "AtRF"
 

diff --git a/components/802.15.4_RF/mcr20a-rf-driver/source/NanostackRfPhyMcr20a.cpp b/components/802.15.4_RF/mcr20a-rf-driver/source/NanostackRfPhyMcr20a.cpp
@@ -23,6 +23,7 @@
 #include <string.h>
 #include "rtos.h"
 #include "mbed_interface.h"
+#include "platform/mbed_error.h"
 
 using namespace mbed;
 using namespace rtos;

diff --git a/components/802.15.4_RF/stm-s2lp-rf-driver/source/NanostackRfPhys2lp.cpp b/components/802.15.4_RF/stm-s2lp-rf-driver/source/NanostackRfPhys2lp.cpp
@@ -29,6 +29,7 @@
 #include "Timeout.h"
 #include "Thread.h"
 #include "mbed_wait_api.h"
+#include "platform/mbed_error.h"
 
 using namespace mbed;
 using namespace rtos;

diff --git a/rtos/ConditionVariable.h b/rtos/ConditionVariable.h
@@ -30,10 +30,15 @@
 #include "platform/NonCopyable.h"
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api Public API */
 /** @{*/
 
 struct Waiter;
+/**
+ * \defgroup rtos_ConditionVariable ConditionVariable class
+ * @{
+ */
 
 /** The ConditionVariable class is a synchronization primitive that allows
  *   threads to wait until a particular condition occurs.
@@ -325,7 +330,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
 #endif // !defined(DOXYGEN_ONLY)
 };
 
-}
-#endif
-
 /** @}*/
+/** @}*/
+} // namespace rtos
+#endif
diff --git a/rtos/EventFlags.h b/rtos/EventFlags.h
@@ -30,7 +30,8 @@
 #include "platform/NonCopyable.h"
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 /**
  * \defgroup rtos_EventFlags EventFlags class

diff --git a/rtos/Kernel.h b/rtos/Kernel.h
@@ -26,7 +26,8 @@
 #include "cmsis_os2.h"
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 
 /** Functions in the Kernel namespace control RTOS kernel information. */
@@ -60,7 +61,6 @@ void attach_thread_terminate_hook(void (*fptr)(osThreadId_t id));
 
 } // namespace Kernel
 
+/** @}*/
 } // namespace rtos
 #endif
-
-/** @}*/
diff --git a/rtos/Mail.h b/rtos/Mail.h
@@ -28,7 +28,6 @@
 #include "Queue.h"
 #include "MemoryPool.h"
 #include "cmsis_os2.h"
-#include "mbed_rtos_storage.h"
 #include "mbed_rtos1_types.h"
 
 #include "platform/mbed_toolchain.h"
@@ -39,7 +38,8 @@ using namespace rtos;
 #endif
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 /**
  * \defgroup rtos_Mail Mail class

diff --git a/rtos/MemoryPool.h b/rtos/MemoryPool.h
@@ -29,9 +29,13 @@
 #include "mbed_rtos1_types.h"
 #include "mbed_rtos_storage.h"
 #include "platform/NonCopyable.h"
+#include "platform/mbed_assert.h"
+#include "Kernel.h"
+
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 /**
  * \defgroup rtos_MemoryPool MemoryPool class

diff --git a/rtos/Mutex.h b/rtos/Mutex.h
@@ -32,7 +32,8 @@
 #include "platform/mbed_toolchain.h"
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 
 class Mutex;

diff --git a/rtos/Queue.h b/rtos/Queue.h
@@ -25,11 +25,12 @@
 #include "cmsis_os2.h"
 #include "mbed_rtos1_types.h"
 #include "mbed_rtos_storage.h"
-#include "platform/mbed_error.h"
+#include "platform/mbed_assert.h"
 #include "platform/NonCopyable.h"
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 /**
  * \defgroup rtos_Queue Queue class

diff --git a/rtos/RtosTimer.h b/rtos/RtosTimer.h
@@ -31,7 +31,8 @@
 #include "mbed_rtos1_types.h"
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 /**
  * \defgroup rtos_RtosTimer RtosTimer class

diff --git a/rtos/Semaphore.h b/rtos/Semaphore.h
@@ -30,7 +30,8 @@
 #include "platform/NonCopyable.h"
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 /**
  * \defgroup rtos_Semaphore Semaphore class

diff --git a/rtos/TARGET_CORTEX/SysTimer.h b/rtos/TARGET_CORTEX/SysTimer.h
@@ -30,12 +30,11 @@
 namespace rtos {
 namespace internal {
 
+/** \ingroup rtos */
+/** \addtogroup mbed-os-internal */
+/** @{*/
+
 /**
- * @cond RTOS_INTERNAL
- *
- * @addtogroup rtos
- * @{
- *
  * @defgroup rtos_SysTimer SysTimer class
  * @{
  */
@@ -126,7 +125,6 @@ class SysTimer: private mbed::TimerEvent, private mbed::NonCopyable<SysTimer> {
 /**
  * @}
  * @}
- * @endcond
  */
 
 }

diff --git a/rtos/TARGET_CORTEX/mbed_boot.h b/rtos/TARGET_CORTEX/mbed_boot.h
@@ -25,6 +25,10 @@ extern "C" {
 
 #include "mbed_rtx.h"
 
+/** \ingroup rtos */
+/** \addtogroup mbed-os-internal */
+/** @{*/
+
 /**
  * \defgroup boot Boot sequence
  * Boot sequence overview
@@ -158,6 +162,7 @@ void mbed_sdk_init(void);
  */
 void mbed_main(void);
 
+/**@}*/
 /**@}*/
 
 #ifdef __cplusplus

diff --git a/rtos/TARGET_CORTEX/mbed_rtos_storage.h b/rtos/TARGET_CORTEX/mbed_rtos_storage.h
@@ -26,31 +26,48 @@
 extern "C" {
 #endif
 
-/** \addtogroup rtos */
-/** @{*/
+#include "rtx_os.h"
+#include "mbed_rtx_conf.h"
 
-/** @brief RTOS primitives storage types for RTX
+/** \ingroup rtos */
+/** \addtogroup mbed-os-internal */
+/** @{*/
 
+/** \defgroup rtos_storage RTOS primitives storage types for RTX
  Types defined in this file should be utilized, when the direct RTOS C API usage is required, to provide backing memory
  for internal RTX data. Allocated object should be wrapped in attribute struct and passed to os*New call, for details
  see CMSIS-RTOS2 documentation.
 
- @note
  This file breaks abstraction layers and uses RTX internal types, but it limits the contamination to single, RTOS
  implementation specific, header file, therefore limiting scope of possible changes.
- */
-
-#include "rtx_os.h"
-#include "mbed_rtx_conf.h"
+  @{
+*/
 
+/** RTX Mutex storage */
 typedef osRtxMutex_t mbed_rtos_storage_mutex_t;
+
+/** RTX Semaphore storage */
 typedef osRtxSemaphore_t mbed_rtos_storage_semaphore_t;
+
+/** RTX Thread storage */
 typedef osRtxThread_t mbed_rtos_storage_thread_t;
+
+/** RTX Memory Pool storage */
 typedef osRtxMemoryPool_t mbed_rtos_storage_mem_pool_t;
+
+/** RTX Message Queue storage */
 typedef osRtxMessageQueue_t mbed_rtos_storage_msg_queue_t;
+
+/** RTX Event Flags storage */
 typedef osRtxEventFlags_t mbed_rtos_storage_event_flags_t;
+
+/** RTX Message storage */
 typedef osRtxMessage_t mbed_rtos_storage_message_t;
+
+/** RTX Timer storage */
 typedef osRtxTimer_t mbed_rtos_storage_timer_t;
+/** @}*/
+/** @}*/
 
 #define MBED_RTOS_STORAGE_MEM_POOL_MEM_SIZE(block_count, block_size) \
   osRtxMemoryPoolMemSize(block_count, block_size)
@@ -60,5 +77,3 @@ typedef osRtxTimer_t mbed_rtos_storage_timer_t;
 #endif
 
 #endif
-
-/** @}*/
diff --git a/rtos/TARGET_CORTEX/mbed_rtx_handlers.c b/rtos/TARGET_CORTEX/mbed_rtx_handlers.c
@@ -22,8 +22,8 @@
 #include "mbed_error.h"
 #include "mbed_interface.h"
 #include "RTX_Config.h"
-#include "rtos/rtos_handlers.h"
-#include "rtos/rtos_idle.h"
+#include "rtos/internal/rtos_handlers.h"
+#include "rtos/internal/rtos_idle.h"
 
 #ifdef RTE_Compiler_EventRecorder
 #include "EventRecorder.h"              // Keil::Compiler:Event Recorder

diff --git a/rtos/TARGET_CORTEX/mbed_rtx_idle.cpp b/rtos/TARGET_CORTEX/mbed_rtx_idle.cpp
@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 
-#include "rtos/rtos_idle.h"
+#include "rtos/internal/rtos_idle.h"
 #include "platform/mbed_power_mgmt.h"
 #include "TimerEvent.h"
 #include "lp_ticker_api.h"

diff --git a/rtos/ThisThread.h b/rtos/ThisThread.h
@@ -24,16 +24,11 @@
 
 #include <stdint.h>
 #include "cmsis_os2.h"
-#include "mbed_rtos1_types.h"
-#include "mbed_rtos_storage.h"
-#include "platform/Callback.h"
-#include "platform/mbed_toolchain.h"
-#include "platform/NonCopyable.h"
-#include "rtos/Semaphore.h"
-#include "rtos/Mutex.h"
+
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 /**
  * \defgroup rtos_ThisThread ThisThread namespace

diff --git a/rtos/Thread.h b/rtos/Thread.h
@@ -33,7 +33,8 @@
 #include "rtos/Mutex.h"
 
 namespace rtos {
-/** \addtogroup rtos */
+/** \ingroup rtos */
+/** \addtogroup mbed-os-api */
 /** @{*/
 /**
  * \defgroup rtos_Thread Thread class

diff --git a/rtos/ConditionVariable.cpp → rtos/internal/ConditionVariable.cpp b/rtos/ConditionVariable.cpp → rtos/internal/ConditionVariable.cpp
@@ -23,8 +23,8 @@
 #include "rtos/Kernel.h"
 #include "rtos/ThisThread.h"
 
-#include "mbed_error.h"
-#include "mbed_assert.h"
+#include "platform/mbed_error.h"
+#include "platform/mbed_assert.h"
 
 namespace rtos {
 

diff --git a/rtos/EventFlags.cpp → rtos/internal/EventFlags.cpp b/rtos/EventFlags.cpp → rtos/internal/EventFlags.cpp
@@ -21,8 +21,8 @@
  */
 #include "rtos/EventFlags.h"
 #include <string.h>
-#include "mbed_error.h"
-#include "mbed_assert.h"
+#include "platform/mbed_error.h"
+#include "platform/mbed_assert.h"
 
 namespace rtos {
 

diff --git a/rtos/Kernel.cpp → rtos/internal/Kernel.cpp b/rtos/Kernel.cpp → rtos/internal/Kernel.cpp
@@ -22,8 +22,8 @@
 
 #include "cmsis_os2.h"
 #include "rtos/Kernel.h"
-#include "rtos/rtos_idle.h"
-#include "rtos/rtos_handlers.h"
+#include "rtos_idle.h"
+#include "rtos_handlers.h"
 #include "platform/mbed_critical.h"
 
 namespace rtos {

diff --git a/rtos/Mutex.cpp → rtos/internal/Mutex.cpp b/rtos/Mutex.cpp → rtos/internal/Mutex.cpp
@@ -23,8 +23,8 @@
 #include "rtos/Kernel.h"
 
 #include <string.h>
-#include "mbed_error.h"
-#include "mbed_assert.h"
+#include "platform/mbed_error.h"
+#include "platform/mbed_assert.h"
 
 namespace rtos {
 

diff --git a/rtos/RtosTimer.cpp → rtos/internal/RtosTimer.cpp b/rtos/RtosTimer.cpp → rtos/internal/RtosTimer.cpp
diff --git a/rtos/Semaphore.cpp → rtos/internal/Semaphore.cpp b/rtos/Semaphore.cpp → rtos/internal/Semaphore.cpp
diff --git a/rtos/ThisThread.cpp → rtos/internal/ThisThread.cpp b/rtos/ThisThread.cpp → rtos/internal/ThisThread.cpp
@@ -24,7 +24,7 @@
 #include "rtos/ThisThread.h"
 
 #include "rtos/Kernel.h"
-#include "rtos/rtos_idle.h"
+#include "rtos_idle.h"
 #include "platform/mbed_assert.h"
 
 namespace rtos {

diff --git a/rtos/Thread.cpp → rtos/internal/Thread.cpp b/rtos/Thread.cpp → rtos/internal/Thread.cpp
@@ -21,8 +21,8 @@
  */
 #include "rtos/Thread.h"
 #include "rtos/ThisThread.h"
-#include "rtos/rtos_idle.h"
-#include "rtos/rtos_handlers.h"
+#include "rtos_idle.h"
+#include "rtos_handlers.h"
 #include "platform/mbed_assert.h"
 #include "platform/mbed_error.h"