- Timestamp:
- 04/16/14 13:25:42 (10 years ago)
- Branches:
- 4.11, 5, master
- Children:
- ed859d51
- Parents:
- 4a93980
- git-author:
- Sebastian Huber <sebastian.huber@…> (04/16/14 13:25:42)
- git-committer:
- Sebastian Huber <sebastian.huber@…> (04/17/14 06:06:38)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/user/smp.t
r4a93980 r2be51cc 17 17 @item @code{rtems_get_processor_count} - Get processor count 18 18 @item @code{rtems_get_current_processor} - Get current processor index 19 @item @code{rtems_task_get_affinity} - Obtain Task Affinity19 @item @code{rtems_task_get_affinity} - Get task processor affinity 20 20 @item @code{rtems_task_set_affinity} - Set Task Affinity 21 21 @end itemize … … 301 301 @c 302 302 @page 303 @subsection rtems_task_get_affinity - Obtain Task Affinity303 @subsection TASK_GET_AFFINITY - Get task processor affinity 304 304 305 305 @subheading CALLING SEQUENCE: … … 307 307 @ifset is-C 308 308 @example 309 #include <rtems.h>310 311 309 rtems_status_code rtems_task_get_affinity( 312 rtems_id 313 size_t 314 cpu_set_t 310 rtems_id id, 311 size_t cpusetsize, 312 cpu_set_t *cpuset 315 313 ); 316 314 @end example … … 320 318 @end ifset 321 319 322 @subheading STATUS CODES: 323 324 @table @b 325 @item RTEMS_UNSATISFIED 326 The @code{cpuset} pointer argument is invalid. 327 328 @item RTEMS_UNSATISFIED 329 The @code{cpusetsize} does not match the value of @code{affinitysetsize} 330 field in the thread attribute object. 331 332 @item RTEMS_INVALID_ID 333 The @code{id} is invalid. 334 335 @end table 320 @subheading DIRECTIVE STATUS CODES: 321 322 @code{@value{RPREFIX}SUCCESSFUL} - successful operation@* 323 @code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@* 324 @code{@value{RPREFIX}INVALID_ID} - invalid task id@* 325 @code{@value{RPREFIX}INVALID_NUMBER} - the affinity set buffer is too small for 326 the current processor affinity set of the task 336 327 337 328 @subheading DESCRIPTION: 338 329 339 The @code{rtems_task_get_affinity} routine is used to obtain the 340 @code{affinityset} field from the thread object @code{id}. 341 The value of this field is returned in @code{cpuset} 330 Returns the current processor affinity set of the task in @code{cpuset}. A set 331 bit in the affinity set means that the task can execute on this processor and a 332 cleared bit means the opposite. 342 333 343 334 @subheading NOTES: 344 335 345 N ONE336 None. 346 337 347 338 @c
Note: See TracChangeset
for help on using the changeset viewer.