summaryrefslogtreecommitdiffstats
path: root/spec/rtems/intr/if/lock-destroy.yml
blob: d8f0416b39704e0fdd335657defd681a2ba629d0 (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: |
  Destroys the ISR lock.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: null
    body: ${/score/isr/if/lock-destroy:/name}( ${.:/params[0]/name} )
    params:
    - ${lock:/name} *${.:/params[0]/name}
    return: void
  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-ctx-any
- role: constraint
  uid: /constraint/directive-no-preempt
name: rtems_interrupt_lock_destroy
notes: |
  The lock must have been dynamically initialized by ${lock-initialize:/name},
  statically defined by ${lock-define:/name}, or statically initialized by
  ${lock-initializer:/name}.

  Concurrent lock use during the destruction or concurrent destruction leads to
  unpredictable results.
params:
- description: |
    is the ISR lock to destroy.
  dir: inout
  name: _lock
return: null
type: interface