summaryrefslogtreecommitdiffstats
path: root/spec/rtems/config/if/resource-unlimited.yml
blob: 5ea8e7457a938610eb85388aab70ed288f439825 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Augments the resource number so that it indicates an unlimited resource.
copyrights:
- Copyright (C) 2020 embedded brains GmbH & Co. KG
definition:
  default:
    attributes: null
    body: ( ( ${.:/params[0]/name} ) | ${unlimited-objects:/name} )
    params:
    - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
    return: ${/c/if/uint32_t:/name}
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: macro
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-const
- role: constraint
  uid: /constraint/directive-no-preempt
name: rtems_resource_unlimited
notes: |
  This directive should be used to configure unlimited objects, see
  ${/doc/if/config-unlimited-objects:/name}.
params:
- description: is the resource number to augment.
  dir: null
  name: _resource
return:
  return: |
    Returns the resource number augmented to indicate an unlimited resource.
  return-values: []
type: interface