summaryrefslogtreecommitdiffstats
path: root/spec/rtems/intr/if/lock-initialize.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/intr/if/lock-initialize.yml')
-rw-r--r--spec/rtems/intr/if/lock-initialize.yml18
1 files changed, 12 insertions, 6 deletions
diff --git a/spec/rtems/intr/if/lock-initialize.yml b/spec/rtems/intr/if/lock-initialize.yml
index 69a3a443..d9922e7f 100644
--- a/spec/rtems/intr/if/lock-initialize.yml
+++ b/spec/rtems/intr/if/lock-initialize.yml
@@ -1,7 +1,8 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+ Initializes the ISR lock.
copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default: |
@@ -17,12 +18,17 @@ links:
- role: interface-ingroup
uid: group
name: rtems_interrupt_lock_initialize
-notes: null
+notes: |
+ ISR locks may also be statically defined by ${lock-define:/name} or
+ statically initialized by ${lock-initializer:/name}.
params:
-- description: '%'
- dir: null
+- description: |
+ is the ISR lock to initialize.
+ dir: out
name: _lock
-- description: '%'
+- 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: