[PATCH 2/8] doc: rtems_get_current_processor()

[Sebastian Huber]

---
 doc/user/smp.t |   38 ++++++++++++++++++++++++++++++++++++++
 1 files changed, 38 insertions(+), 0 deletions(-)

diff --git a/doc/user/smp.t b/doc/user/smp.t
index b0d1189..3d565ef 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -258,6 +258,44 @@ maximum count of application configured processors.
 None.
 
 @c
+ at c rtems_get_current_processor
+ at c
+ at page
+ at subsection GET_CURRENT_PROCESSOR - Get current processor index
+
+ at subheading CALLING SEQUENCE:
+
+ at ifset is-C
+ at example
+uint32_t rtems_get_current_processor(void);
+ at end example
+ at end ifset
+
+ at ifset is-Ada
+ at end ifset
+
+ at subheading DIRECTIVE STATUS CODES:
+
+The index of the current processor.
+
+ at subheading DESCRIPTION:
+
+On uni-processor configurations a value of zero will be returned.
+
+On SMP configurations an architecture specific method is used to obtain the
+index of the current processor in the system.  The set of processor indices is
+the range of integers starting with zero up to the processor count minus one.
+
+Outside of sections with disabled thread dispatching the current processor
+index may change after every instruction since the thread may migrate from one
+processor to another.  Sections with disabled interrupts are sections with
+thread dispatching disabled.
+
+ at subheading NOTES:
+
+None.
+
+ at c
 @c rtems_task_get_affinity
 @c
 @page
-- 
1.7.7