summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/barrier/ident.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/if/rtems/barrier/ident.yml')
-rw-r--r--spec/if/rtems/barrier/ident.yml60
1 files changed, 0 insertions, 60 deletions
diff --git a/spec/if/rtems/barrier/ident.yml b/spec/if/rtems/barrier/ident.yml
deleted file mode 100644
index b75f8b2a..00000000
--- a/spec/if/rtems/barrier/ident.yml
+++ /dev/null
@@ -1,60 +0,0 @@
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
- Identifies a barrier object by the specified object name.
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-definition:
- default:
- body: null
- params:
- - ${../types/name:/name} ${.:/params[0]/name}
- - ${../types/id:/name} *${.:/params[1]/name}
- return: ${../status/code:/name}
- variants: []
-description: |
- This directive obtains the barrier identifier associated with the barrier
- name specified in ``${.:/params[0]/name}``.
-enabled-by: true
-interface-type: function
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: group
-name: rtems_barrier_ident
-notes: |
- If the barrier name is not unique, then the barrier identifier will match the
- first barrier with that name in the search order. However, this barrier
- identifier is not guaranteed to correspond to the desired barrier. The
- barrier identifier is used with other barrier related directives to access
- the barrier.
-
- The objects are searched from lowest to the highest index. Only the local
- node is searched.
-params:
-- description: is the object name to look up.
- dir: null
- name: name
-- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
- dir: out
- name: id
-return:
- return: null
- return-values:
- - description: |
- The requested operation was successful.
- value: ${../status/successful:/name}
- - description: |
- The ${.:/params[1]/name} parameter was ${/if/c/null:/name}.
- value: ${../status/invalid-address:/name}
- - description: |
- The ${.:/params[0]/name} parameter was 0.
- value: ${../status/invalid-name:/name}
- - description: |
- There was no object with the specified name on the local node.
- value: ${../status/invalid-name:/name}
-type: interface