Changeset d1f2f22 in rtems


Ignore:
Timestamp:
Apr 16, 2014, 1:59:21 PM (5 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
babb1a2c
Parents:
89c1a21
git-author:
Sebastian Huber <sebastian.huber@…> (04/16/14 13:59:21)
git-committer:
Sebastian Huber <sebastian.huber@…> (04/17/14 06:06:39)
Message:

doc: rtems_scheduler_get_processor_set()

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/smp.t

    r89c1a21 rd1f2f22  
    1818@item @code{rtems_get_current_processor} - Get current processor index
    1919@item @code{rtems_scheduler_ident} - Get ID of a scheduler
     20@item @code{rtems_scheduler_get_processor_set} - Get processor set of a scheduler
    2021@item @code{rtems_task_get_affinity} - Get task processor affinity
    2122@item @code{rtems_task_set_affinity} - Set task processor affinity
     
    335336
    336337@c
     338@c rtems_scheduler_get_processor_set
     339@c
     340@page
     341@subsection SCHEDULER_GET_PROCESSOR_SET - Get processor set of a scheduler
     342
     343@subheading CALLING SEQUENCE:
     344
     345@ifset is-C
     346@example
     347rtems_status_code rtems_scheduler_get_processor_set(
     348  rtems_id   scheduler_id,
     349  size_t     cpusetsize,
     350  cpu_set_t *cpuset
     351);
     352@end example
     353@end ifset
     354
     355@ifset is-Ada
     356@end ifset
     357
     358@subheading DIRECTIVE STATUS CODES:
     359
     360@code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
     361@code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@*
     362@code{@value{RPREFIX}INVALID_ID} - invalid scheduler id@*
     363@code{@value{RPREFIX}INVALID_NUMBER} - the affinity set buffer is too small for
     364set of processors owned by the scheduler
     365
     366@subheading DESCRIPTION:
     367
     368Returns the processor set owned by the scheduler in @code{cpuset}.  A set bit
     369in the processor set means that this processor is owned by the scheduler and a
     370cleared bit means the opposite.
     371
     372@subheading NOTES:
     373
     374None.
     375
     376@c
    337377@c rtems_task_get_affinity
    338378@c
Note: See TracChangeset for help on using the changeset viewer.