summaryrefslogtreecommitdiffstats
path: root/spec/rtems/basedefs/if/define-global-symbol.yml
blob: 33b50e9b80e64d22cf2cbef80466a2d533bef084 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Defines a global symbol with the name and value.
copyrights:
- Copyright (C) 2018, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default: ''
  variants:
  - definition: |
      ${/compiler/if/asm:/name}(
        "\t.globl " ${xstring:/name}( ${symbol-name:/name}( _name ) )
        "\n\t.set " ${xstring:/name}( ${symbol-name:/name}( _name ) )
        ", " ${string:/name}( _value ) "\n"
      )
    enabled-by:
    - defined(${/compiler/if/user-label-prefix:/name})
description: |
  This macro shall be placed at file scope.
enabled-by: true
index-entries: []
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: RTEMS_DEFINE_GLOBAL_SYMBOL
notes: null
params:
- description: |
    is the user defined name of the symbol.  The name shall be a valid
    designator.  On the name a macro expansion is performed and afterwards it
    is stringified.
  dir: null
  name: _name
- description: |
    is the value of the symbol.  On the value a macro expansion is performed
    and afterwards it is stringified.  It shall expand to an integer expression
    understood by the assembler.
  dir: null
  name: _value
return:
  return: null
  return-values: []
type: interface