CMSIS RTOS V1: Introduce CMSIS RTOS V1 API header file

rgundi · nashif · commit d22cd76c9c22 · 2018-08-13T13:08:07.000-07:00
CMSIS RTOS API provides a generic RTOS interface for embedded
processors (actually for Cortex-M processors but are generic
enough to be used elsewhere). This header file is for V1 version.

Signed-off-by: Rajavardhan Gundi &lt;rajavardhan.gundi@intel.com&gt;
diff --git a/doc/porting/cmsis_rtos_v1.rst b/doc/porting/cmsis_rtos_v1.rst
@@ -0,0 +1,11 @@
+.. _cmsis_rtos_v1:
+
+CMSIS RTOS v1
+##########################
+
+Cortex-M Software Interface Standard (CMSIS) RTOS is a vendor-independent
+hardware abstraction layer for the ARM Cortex®-M processor series and defines
+generic tool interfaces. Though it was originally defined for ARM Cortex-M
+microcontrollers alone, it could be easily extended to other microcontrollers
+making it generic. For more information on CMSIS RTOS v1, please refer
+http://www.keil.com/pack/doc/CMSIS/RTOS/html/index.html
diff --git a/doc/porting/porting.rst b/doc/porting/porting.rst
@@ -4,11 +4,13 @@ Porting Guides
 ##############
 
 This section contains details regarding porting the Zephyr kernel to new
-architectures, SoCs and boards.
+architectures, SoCs and boards. This section also describes the standard
+API interfaces supported by Zephyr.
 
 .. toctree::
    :maxdepth: 1
 
    arch.rst
    board_porting.rst
    ip-stack-migrate.rst
+   porting_to_zephyr.rst
diff --git a/doc/porting/porting_to_zephyr.rst b/doc/porting/porting_to_zephyr.rst
@@ -0,0 +1,14 @@
+.. _porting_to_zephyr:
+
+Porting Applications to Zephyr
+##############################
+
+This section describes standard API interfaces supported by Zephyr.
+Applications written using standard API interfaces are supposed to
+be OS agnostic. Supporting such APIs in Zephyr would make it easier
+to port those applications to Zephyr.
+
+.. toctree::
+   :maxdepth: 1
+
+   cmsis_rtos_v1.rst
diff --git a/doc/zephyr.doxyfile.in b/doc/zephyr.doxyfile.in
@@ -806,7 +806,8 @@ RECURSIVE              = YES
 
 EXCLUDE                = @ZEPHYR_BASE@/include/spi_legacy.h \
                          @ZEPHYR_BASE@/include/net/http_legacy.h \
-                         @ZEPHYR_BASE@/include/misc/util.h
+                         @ZEPHYR_BASE@/include/misc/util.h \
+                         @ZEPHYR_BASE@/include/cmsis_rtos_v1/cmsis_os.h
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
diff --git a/include/cmsis_rtos_v1/cmsis_os.h b/include/cmsis_rtos_v1/cmsis_os.h
