summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2019-12-19 11:06:33 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2019-12-19 13:33:08 +0100
commit2e02ee051a5817240e316d11398bcafd079daefc (patch)
treee9a8f5a1b9f1f03178c4abe22d7d5ff861097258
parentc-user: Clarify CONFIGURE_MAXIMUM_SEMAPHORES (diff)
downloadrtems-docs-2e02ee051a5817240e316d11398bcafd079daefc.tar.bz2
c-user: Document rtems_object_get_local_node()
Close #3841.
-rw-r--r--c-user/object_services.rst28
1 files changed, 28 insertions, 0 deletions
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.