Platform: Separate internal APIs from public APIs

Also includes:
* rename `mbed_sleep_manager.c` to `mbed_power_mgmt.c` to match its
  header file
* create Doxygen groups for public and internal APIs
* use relative path to include header files where inconsistent
* update references to internal APIs throughout libraries
* update the copyright year for all modified files

Author: hugueskamba

drivers/InterruptManager.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
+ * Copyright (c) 2006-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,7 +18,7 @@
 #define MBED_INTERRUPTMANAGER_H
 
 #include "cmsis.h"
-#include "platform/CallChain.h"
+#include "platform/internal/CallChain.h"
 #include "platform/PlatformMutex.h"
 #include "platform/NonCopyable.h"
 #include <string.h>

drivers/RawSerial.h

@@ -21,7 +21,7 @@
 
 #if DEVICE_SERIAL || defined(DOXYGEN_ONLY)
 
-#include "mbed_toolchain.h"
+#include "platform/mbed_toolchain.h"
 #include "drivers/SerialBase.h"
 #include "platform/NonCopyable.h"
 #include <cstdarg>

platform/ATCmdParser.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2017 ARM Limited
+/* Copyright (c) 2017-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,13 +22,14 @@
 #define MBED_ATCMDPARSER_H
 
 #include <cstdarg>
-#include "Callback.h"
-#include "NonCopyable.h"
-#include "FileHandle.h"
+#include "platform/Callback.h"
+#include "platform/NonCopyable.h"
+#include "platform/FileHandle.h"
 
 namespace mbed {
 
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api Public API */
 /** @{*/
 /**
  * \defgroup platform_ATCmdParser ATCmdParser class

platform/CThunk.h

@@ -1,5 +1,5 @@
-
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_CThunk CThunk class
@@ -12,7 +12,7 @@
  * - supports an optional context parameter for the called function
  * - ideally suited for class object receiving interrupts (NVIC_SetVector)
  *
- * Copyright (c) 2014-2015 ARM Limited
+ * Copyright (c) 2014-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,15 +39,15 @@
 #ifndef __CTHUNK_H__
 #define __CTHUNK_H__
 
-#include "CThunkBase.h"
+#include "platform/internal/CThunkBase.h"
 
 /**
  * Class for created a pointer with data bound to it
  *
  * @note Synchronization level: Not protected
  */
 template<class T>
-class CThunk: public CThunkBase {
+class CThunk: private CThunkBase {
 public:
     typedef void (T::*CCallbackSimple)(void);
     typedef void (T::*CCallback)(void *context);

platform/Callback.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2006-2015 ARM Limited
+ * Copyright (c) 2006-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,7 +24,8 @@
 #include "platform/mbed_toolchain.h"
 
 namespace mbed {
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_Callback Callback class

platform/CircularBuffer.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2015 ARM Limited
+ * Copyright (c) 2015-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -51,7 +51,8 @@ struct is_unsigned<unsigned long long> {
 };
 };
 
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_CircularBuffer CircularBuffer functions

platform/CriticalSectionLock.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017 ARM Limited
+ * Copyright (c) 2017-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,12 +18,12 @@
 #ifndef MBED_CRITICALSECTIONLOCK_H
 #define MBED_CRITICALSECTIONLOCK_H
 
-#include "platform/mbed_critical.h"
 #include "platform/mbed_toolchain.h"
 
 namespace mbed {
 
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_CriticalSectionLock CriticalSectionLock functions
@@ -57,15 +57,9 @@ namespace mbed {
   */
 class CriticalSectionLock {
 public:
-    CriticalSectionLock()
-    {
-        core_util_critical_section_enter();
-    }
+    CriticalSectionLock();
 
-    ~CriticalSectionLock()
-    {
-        core_util_critical_section_exit();
-    }
+    ~CriticalSectionLock();
 
     /** Mark the start of a critical section
      *  @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.
@@ -74,10 +68,7 @@ class CriticalSectionLock {
     MBED_DEPRECATED_SINCE("mbed-os-5.8",
                           "This function is inconsistent with RAII and is being removed in the future."
                           "Replaced by static function CriticalSectionLock::enable.")
-    void lock()
-    {
-        core_util_critical_section_enter();
-    }
+    void lock();
 
     /** Mark the end of a critical section
      *  @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.
@@ -86,24 +77,15 @@ class CriticalSectionLock {
     MBED_DEPRECATED_SINCE("mbed-os-5.8",
                           "This function is inconsistent with RAII and is being removed in the future."
                           "Replaced by static function CriticalSectionLock::disable.")
-    void unlock()
-    {
-        core_util_critical_section_exit();
-    }
+    void unlock();
 
     /** Mark the start of a critical section
      */
-    static void enable()
-    {
-        core_util_critical_section_enter();
-    }
+    static void enable();
 
     /** Mark the end of a critical section
      */
-    static void disable()
-    {
-        core_util_critical_section_exit();
-    }
+    static void disable();
 };
 
 /**@}*/

platform/DeepSleepLock.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2017 ARM Limited
+ * Copyright (c) 2017-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,12 +18,12 @@
 #define MBED_DEEPSLEEPLOCK_H
 
 #include <limits.h>
-#include "platform/mbed_power_mgmt.h"
-#include "platform/mbed_atomic.h"
+#include <stdint.h>
 
 namespace mbed {
 
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_DeepSleepLock DeepSleepLock functions
@@ -49,44 +49,17 @@ class DeepSleepLock {
     uint16_t _lock_count;
 
 public:
-    DeepSleepLock(): _lock_count(1)
-    {
-        sleep_manager_lock_deep_sleep();
-    }
+    DeepSleepLock();
 
-    ~DeepSleepLock()
-    {
-        if (_lock_count) {
-            sleep_manager_unlock_deep_sleep();
-        }
-    }
+    ~DeepSleepLock();
 
     /** Mark the start of a locked deep sleep section
      */
-    void lock()
-    {
-        uint16_t count = core_util_atomic_incr_u16(&_lock_count, 1);
-        if (1 == count) {
-            sleep_manager_lock_deep_sleep();
-        }
-        if (0 == count) {
-            MBED_ERROR1(MBED_MAKE_ERROR(MBED_MODULE_PLATFORM, MBED_ERROR_CODE_OVERFLOW), "DeepSleepLock overflow (> USHRT_MAX)", count);
-        }
-    }
+    void lock();
 
     /** Mark the end of a locked deep sleep section
      */
-    void unlock()
-    {
-        uint16_t count = core_util_atomic_decr_u16(&_lock_count, 1);
-        if (count == 0) {
-            sleep_manager_unlock_deep_sleep();
-        }
-        if (count == USHRT_MAX) {
-            core_util_critical_section_exit();
-            MBED_ERROR1(MBED_MAKE_ERROR(MBED_MODULE_PLATFORM, MBED_ERROR_CODE_UNDERFLOW), "DeepSleepLock underflow (< 0)", count);
-        }
-    }
+    void unlock();
 };
 
 /**@}*/

platform/DirHandle.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
+ * Copyright (c) 2006-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,12 +18,12 @@
 #define MBED_DIRHANDLE_H
 
 #include <stdint.h>
-#include "platform/platform.h"
-#include "platform/FileHandle.h"
+#include "platform/mbed_toolchain.h"
 #include "platform/NonCopyable.h"
 
 namespace mbed {
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_DirHandle DirHandle functions

platform/FileBase.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
+ * Copyright (c) 2006-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,7 +31,8 @@ typedef enum {
     FileSystemPathType
 } PathType;
 
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_FileBase FileBase class
@@ -72,4 +73,3 @@ class FileBase : private NonCopyable<FileBase> {
 } // namespace mbed
 
 #endif
-

platform/FileHandle.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2017 ARM Limited
+ * Copyright (c) 2017-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,13 +20,14 @@
 typedef int FILEHANDLE;
 
 #include <cstdio>
-#include "Callback.h"
+#include "platform/Callback.h"
 #include "platform/mbed_poll.h"
 #include "platform/platform.h"
 #include "platform/NonCopyable.h"
 
 namespace mbed {
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_FileHandle FileHandle functions

platform/FileLike.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
+ * Copyright (c) 2006-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,13 +17,13 @@
 #ifndef MBED_FILELIKE_H
 #define MBED_FILELIKE_H
 
-#include "platform/mbed_toolchain.h"
 #include "platform/FileBase.h"
 #include "platform/FileHandle.h"
 #include "platform/NonCopyable.h"
 
 namespace mbed {
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_FileLike FileLike class

platform/FilePath.h

@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
+ * Copyright (c) 2006-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,7 +23,8 @@
 #include "platform/FileLike.h"
 
 namespace mbed {
-/** \addtogroup platform */
+/** \ingroup platform */
+/** \addtogroup platform-public-api */
 /** @{*/
 /**
  * \defgroup platform_FilePath FilePath class