blob: ecd1d64e62015a85383c392d8eb5578f7d07ff85 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Maps a Classic API task priority to the corresponding POSIX thread priority.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
default:
body: null
params:
- ${../types/id:/name} ${.:/params[0]/name}
- ${../tasks/priority:/name} ${.:/params[1]/name}
- int *${.:/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: ../tasks/group
name: rtems_scheduler_map_priority_to_posix
notes: null
params:
- description: is the scheduler instance identifier.
dir: null
name: scheduler_id
- description: is the Classic API task priority to map.
dir: null
name: priority
- description: |
is the pointer to a POSIX thread priority variable. The POSIX thread
priority value corresponding to the specified Classic API task priority
value will be stored in this variable, in case of a successful operation.
dir: out
name: posix_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 Classic API task priority was invalid.
value: ${../status/invalid-priority:/name}
type: interface
|