summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/sem/ident.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/if/rtems/sem/ident.yml')
-rw-r--r--spec/if/rtems/sem/ident.yml86
1 files changed, 0 insertions, 86 deletions
diff --git a/spec/if/rtems/sem/ident.yml b/spec/if/rtems/sem/ident.yml
deleted file mode 100644
index 580679be..00000000
--- a/spec/if/rtems/sem/ident.yml
+++ /dev/null
@@ -1,86 +0,0 @@
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
- Identifies a semaphore 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}
- - ${/if/c/uint32_t:/name} ${.:/params[1]/name}
- - ${../types/id:/name} *${.:/params[2]/name}
- return: ${../status/code:/name}
- variants: []
-description: |
- This directive obtains the semaphore identifier associated with the semaphore
- name specified in ``${.:/params[0]/name}``.
-
- The node to search is specified in ``${.:/params[1]/name}``. It shall be
-
- * a valid node number,
-
- * the constant ${../object/search-all-nodes:/name} to search in all nodes,
-
- * the constant ${../object/search-local-node:/name} to search in the local
- node only, or
-
- * the constant ${../object/search-other-nodes:/name} to search in all nodes
- except the local node.
-enabled-by: true
-interface-type: function
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: group
-name: rtems_semaphore_ident
-notes: |
- If the semaphore name is not unique, then the semaphore identifier will match
- the first semaphore with that name in the search order. However, this
- semaphore identifier is not guaranteed to correspond to the desired
- semaphore. The semaphore identifier is used with other semaphore related
- directives to access the semaphore.
-
- If node is ${../object/search-all-nodes:/name}, all nodes are searched with
- the local node being searched first. All other nodes are searched with the
- lowest numbered node searched first.
-
- If node is a valid node number which does not represent the local node, then
- only the semaphores exported by the designated node are searched.
-
- This directive does not generate activity on remote nodes. It accesses only
- the local copy of the global object table.
-params:
-- description: is the object name to look up.
- dir: null
- name: name
-- description: is the node or node set to search for a matching object.
- dir: null
- name: node
-- 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[2]/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 specified nodes.
- value: ${../status/invalid-name:/name}
- - description: |
- In multiprocessing configurations, the specified node was invalid.
- value: ${../status/invalid-node:/name}
-type: interface