summaryrefslogtreecommitdiffstats
path: root/spec/rtems/intr/if/lock-define.yml
blob: b8bdaa97c27fa260c2c655e604b6f155ab750e4a (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Defines an ISR lock object.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default: |
    ${/score/isr/if/lock-define:/name}( ${.:/params[0]/name}, ${.:/params[1]/name}, ${.:/params[2]/name} )
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: RTEMS_INTERRUPT_LOCK_DEFINE
notes: |
  Do not add a ";" after this macro.

  ISR locks may also be dynamically initialized by ${lock-initialize:/name} or
  statically by ${lock-initializer:/name}.
params:
- description: |
    is the storage-class specifier for the ISR lock to declare, for example ``extern``
    or ``static``.
  dir: null
  name: _specifier
- description: |
    is the ISR lock object designator.
  dir: null
  name: _designator
- description: |
    is the ISR lock name.  It shall be a string.  The name is only used where
    the system was built with profiling support enabled.
  dir: null
  name: _name
return: null
type: interface