summaryrefslogtreecommitdiff
path: root/spec/if/rtems/scheduler/map-priority-from-posix.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-05 09:56:10 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-03 10:22:45 +0200
commita243fc680198fa93453d2e49b9590b2bc4f882cd (patch)
treeaf90f47926662e6b58a41d0eaa62928669f77d8c /spec/if/rtems/scheduler/map-priority-from-posix.yml
parent54e2231a9274bf15faa99261ad0d4878fb90f7c8 (diff)
spec: Add /if/rtems/tasks/*
Diffstat (limited to 'spec/if/rtems/scheduler/map-priority-from-posix.yml')
-rw-r--r--spec/if/rtems/scheduler/map-priority-from-posix.yml53
1 files changed, 53 insertions, 0 deletions
diff --git a/spec/if/rtems/scheduler/map-priority-from-posix.yml b/spec/if/rtems/scheduler/map-priority-from-posix.yml
new file mode 100644
index 00000000..a0dbeb3c
--- /dev/null
+++ b/spec/if/rtems/scheduler/map-priority-from-posix.yml
@@ -0,0 +1,53 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Maps a POSIX thread priority to the corresponding Classic API task priority.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default:
+ body: null
+ params:
+ - ${../types/id:/name} ${.:/params[0]/name}
+ - int ${.:/params[1]/name}
+ - ${../tasks/priority:/name} *${.:/params[2]/name}
+ return: ${../status/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: ../tasks/header
+- role: interface-ingroup
+ uid: /groups/api/classic/tasks
+name: rtems_scheduler_map_priority_from_posix
+notes: null
+params:
+- description: is the scheduler instance identifier.
+ dir: null
+ name: scheduler_id
+- description: is the POSIX thread priority to map.
+ dir: null
+ name: posix_priority
+- description: |
+ is the pointer to a Classic API task priority variable. The Classic API
+ task priority value corresponding to the specified POSIX thread priority
+ value will be stored in this variable, in case of a successful operation.
+ dir: out
+ name: priority
+return:
+ return: null
+ return-values:
+ - description: |
+ The requested operation was successful.
+ value: ${../status/successful:/name}
+ - description: |
+ The ${.:/params[2]/name} parameter was ${/if/c/null:/name}.
+ value: ${../status/invalid-address:/name}
+ - description: |
+ The scheduler instance identifier was invalid.
+ value: ${../status/invalid-id:/name}
+ - description: |
+ The POSIX thread priority was invalid.
+ value: ${../status/invalid-priority:/name}
+type: interface