RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

rtems: Document rtems_task_set_scheduler() errors

Browse Source
This commit is contained in:
Sebastian Huber
2021-05-12 16:30:28 +02:00
parent 51f7a82f08
commit 6136918ddf
1 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
cpukit/include/rtems/rtems/tasks.h
View File

@@ -2142,13 +2142,30 @@ rtems_status_code rtems_task_get_scheduler(
* @retval ::RTEMS_INVALID_ID There was no scheduler associated with the
* identifier specified by ``scheduler_id``.
*
* @retval ::RTEMS_INVALID_PRIORITY There task priority specified in
* ``priority`` was invalid with respect to the scheduler specified by
* ``scheduler_id``.
* @retval ::RTEMS_INVALID_PRIORITY The task priority specified by ``priority``
* was invalid with respect to the scheduler specified by ``scheduler_id``.
*
* @retval ::RTEMS_INVALID_ID There was no task associated with the identifier
* specified by ``task_id``.
*
* @retval ::RTEMS_RESOURCE_IN_USE The task specified by ``task_id`` was
* enqueued on a wait queue.
*
* @retval ::RTEMS_RESOURCE_IN_USE The task specified by ``task_id`` had a
* current priority which consisted of more than the real priority.
*
* @retval ::RTEMS_RESOURCE_IN_USE The task specified by ``task_id`` had a
* helping scheduler.
*
* @retval ::RTEMS_RESOURCE_IN_USE The task specified by ``task_id`` was
* pinned.
*
* @retval ::RTEMS_UNSATISFIED The scheduler specified by ``scheduler_id``
* owned no processor.
*
* @retval ::RTEMS_UNSATISFIED The scheduler specified by ``scheduler_id`` did
* not support the affinity set of the task specified by ``task_id``.
*
* @retval ::RTEMS_ILLEGAL_ON_REMOTE_OBJECT The task resided on a remote node.
*
* @par Constraints