Changeset 4a93980 in rtems


Ignore:
Timestamp:
Apr 16, 2014, 1:17:32 PM (5 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
2be51cc
Parents:
6809383d
git-author:
Sebastian Huber <sebastian.huber@…> (04/16/14 13:17:32)
git-committer:
Sebastian Huber <sebastian.huber@…> (04/17/14 06:06:38)
Message:

doc: rtems_get_current_processor()

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/smp.t

    r6809383d r4a93980  
    1616@itemize @bullet
    1717@item @code{rtems_get_processor_count} - Get processor count
     18@item @code{rtems_get_current_processor} - Get current processor index
    1819@item @code{rtems_task_get_affinity} - Obtain Task Affinity
    1920@item @code{rtems_task_set_affinity} - Set Task Affinity
     
    259260
    260261@c
     262@c rtems_get_current_processor
     263@c
     264@page
     265@subsection GET_CURRENT_PROCESSOR - Get current processor index
     266
     267@subheading CALLING SEQUENCE:
     268
     269@ifset is-C
     270@example
     271uint32_t rtems_get_current_processor(void);
     272@end example
     273@end ifset
     274
     275@ifset is-Ada
     276@end ifset
     277
     278@subheading DIRECTIVE STATUS CODES:
     279
     280The index of the current processor.
     281
     282@subheading DESCRIPTION:
     283
     284On uni-processor configurations a value of zero will be returned.
     285
     286On SMP configurations an architecture specific method is used to obtain the
     287index of the current processor in the system.  The set of processor indices is
     288the range of integers starting with zero up to the processor count minus one.
     289
     290Outside of sections with disabled thread dispatching the current processor
     291index may change after every instruction since the thread may migrate from one
     292processor to another.  Sections with disabled interrupts are sections with
     293thread dispatching disabled.
     294
     295@subheading NOTES:
     296
     297None.
     298
     299@c
    261300@c rtems_task_get_affinity
    262301@c
Note: See TracChangeset for help on using the changeset viewer.