[rtems-docs commit] c-user: Document rtems_object_get_local_node()

Sebastian Huber sebh at rtems.org
Fri Dec 20 06:18:13 UTC 2019


Module:    rtems-docs
Branch:    master
Commit:    2e02ee051a5817240e316d11398bcafd079daefc
Changeset: http://git.rtems.org/rtems-docs/commit/?id=2e02ee051a5817240e316d11398bcafd079daefc

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Thu Dec 19 11:06:33 2019 +0100

c-user: Document rtems_object_get_local_node()

Close #3841.

---

 c-user/object_services.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/c-user/object_services.rst b/c-user/object_services.rst
index 544ff02..860ce8c 100644
--- a/c-user/object_services.rst
+++ b/c-user/object_services.rst
@@ -49,6 +49,8 @@ them.  The object related services provided by RTEMS are:
 
 - rtems_object_get_class_information_ - obtain class information
 
+- rtems_object_get_local_node_ - obtain local node
+
 Background
 ==========
 
@@ -785,3 +787,29 @@ DESCRIPTION:
 
 NOTES:
     This directive is strictly local and does not impact task scheduling.
+
+.. raw:: latex
+
+   \clearpage
+
+.. index:: obtain local node
+.. index:: rtems_object_get_local_node
+
+.. _rtems_object_get_local_node:
+
+OBJECT_GET_LOCAL_NODE - Obtain Local Node
+-----------------------------------------
+
+CALLING SEQUENCE:
+    .. code-block:: c
+
+        uint16_t rtems_object_get_local_node( void );
+
+DIRECTIVE STATUS CODES:
+    NONE
+
+DESCRIPTION:
+    This service returns the local MPCI node.
+
+NOTES:
+    This directive is strictly local and does not impact task scheduling.



More information about the vc mailing list