Merge pull request #386 from skliper/fix18-deprecate-shmem

Fix #18, Deprecate shared memory APIs
nasa · Apr 6, 2020 · 8f293bd · 8f293bd
2 parents 126d319 + 592328b
commit 8f293bd
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/src/os/inc/osapi-os-core.h b/src/os/inc/osapi-os-core.h
@@ -1294,6 +1294,7 @@ int32 OS_IntGetMask        (uint32 *mask);
 int32 OS_IntAck             (int32 InterruptNumber);
 /**@}*/
 
+#ifndef OSAL_OMIT_DEPRECATED
 /**
  * @defgroup OSAPIShMem OSAL Shared memory APIs
  * @deprecated Not in current implementations
@@ -1302,42 +1303,44 @@ int32 OS_IntAck             (int32 InterruptNumber);
  */
 
 /*-------------------------------------------------------------------------------------*/
-/** @brief placeholder; not currently implemented
+/** @brief DEPRECATED - platform dependent, never implemented in framework OSALs
  * @deprecated Never implemented
  */
 int32 OS_ShMemInit          (void);
 
 /*-------------------------------------------------------------------------------------*/
-/** @brief placeholder; not currently implemented
+/** @brief DEPRECATED - platform dependent, never implemented in framework OSALs
  * @deprecated Never implemented
  */
 int32 OS_ShMemCreate        (uint32 *Id, uint32 NBytes, const char* SegName);
 
 /*-------------------------------------------------------------------------------------*/
-/** @brief placeholder; not currently implemented
+/** @brief DEPRECATED - platform dependent, never implemented in framework OSALs
  * @deprecated Never implemented
  */
 int32 OS_ShMemSemTake       (uint32 Id);
 
 /*-------------------------------------------------------------------------------------*/
-/** @brief placeholder; not currently implemented
+/** @brief DEPRECATED - platform dependent, never implemented in framework OSALs
  * @deprecated Never implemented
  */
 int32 OS_ShMemSemGive       (uint32 Id);
 
 /*-------------------------------------------------------------------------------------*/
-/** @brief placeholder; not currently implemented
+/** @brief DEPRECATED - platform dependent, never implemented in framework OSALs
  * @deprecated Never implemented
  */
 int32 OS_ShMemAttach        (cpuaddr * Address, uint32 Id);
 
 /*-------------------------------------------------------------------------------------*/
-/** @brief placeholder; not currently implemented
+/** @brief DEPRECATED - platform dependent, never implemented in framework OSALs
  * @deprecated Never implemented
  */
 int32 OS_ShMemGetIdByName   (uint32 *ShMemId, const char *SegName );
 /**@}*/
 
+#endif /* OSAL_OMIT_DEPRECATED */
+
 /** @defgroup OSAPIHeap OSAL Heap APIs
  * @{
  */

diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-base-impl-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-base-impl-stubs.c
@@ -123,6 +123,7 @@ void  OS_ConsoleOutput_Impl(uint32 local_id)
     UT_DEFAULT_IMPL(OS_ConsoleOutput_Impl);
 }
 
+#ifndef OSAL_OMIT_DEPRECATED
 /*
 ** Shared memory API
 */
@@ -132,6 +133,7 @@ UT_DEFAULT_STUB(OS_ShMemSemTake_Impl,(uint32 Id))
 UT_DEFAULT_STUB(OS_ShMemSemGive_Impl,(uint32 Id))
 UT_DEFAULT_STUB(OS_ShMemAttach_Impl,(uint32 * Address, uint32 Id))
 UT_DEFAULT_STUB(OS_ShMemGetIdByName_Impl,(uint32 *ShMemId, const char *SegName ))
+#endif /* OSAL_OMIT_DEPRECATED */
 
 
 /*