summaryrefslogtreecommitdiffstats
path: root/spec/rtems/scheduler/if/map-priority-from-posix.yml
blob: 8126007e681e0a3e5f3d07187ff47adbdd95b5cc (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
54
55
56
57
58
59
60
61
62
63
64
65
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 & Co. KG
definition:
  default:
    attributes: null
    body: null
    params:
    - ${../../type/if/id:/name} ${.:/params[0]/name}
    - int ${.:/params[1]/name}
    - ${../../type/if/priority:/name} *${.:/params[2]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-any
- role: constraint
  uid: /constraint/directive-no-preempt
name: rtems_scheduler_map_priority_from_posix
notes: null
params:
- description: |
    is the scheduler identifier.
  dir: null
  name: scheduler_id
- description: |
    is the POSIX thread priority to map.
  dir: null
  name: posix_priority
- description: |
    is the pointer to an ${../../type/if/priority:/name} object.  When the
    directive call is successful, the Classic API task priority value
    corresponding to the specified POSIX thread priority value will be stored
    in this object.
  dir: out
  name: priority
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
    value: ${../../status/if/invalid-address:/name}
  - description: |
      There was no scheduler associated with the identifier specified by
      ${.:/params[0]/name}.
    value: ${../../status/if/invalid-id:/name}
  - description: |
      The POSIX thread priority was invalid.
    value: ${../../status/if/invalid-priority:/name}
type: interface