diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-16 11:48:29 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-16 16:33:00 +0200 |
commit | 3bdf817950eadd75a2785b62220eb0b04533b9fd (patch) | |
tree | ed221c6de813e7a473e2882af6326bf2e5b44bd1 /spec/if/rtems/dpmem/ident.yml | |
parent | spec: Specify rtems_task_construct() (diff) | |
download | rtems-central-3bdf817950eadd75a2785b62220eb0b04533b9fd.tar.bz2 |
spec: Group items by component
Diffstat (limited to 'spec/if/rtems/dpmem/ident.yml')
-rw-r--r-- | spec/if/rtems/dpmem/ident.yml | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/spec/if/rtems/dpmem/ident.yml b/spec/if/rtems/dpmem/ident.yml deleted file mode 100644 index 5d609e02..00000000 --- a/spec/if/rtems/dpmem/ident.yml +++ /dev/null @@ -1,59 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: | - Identifies a port 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 port identifier associated with the port 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_port_ident -notes: | - If the port name is not unique, then the port identifier will match the first - port with that name in the search order. However, this port identifier is - not guaranteed to correspond to the desired port. The port identifier is - used with other dual-ported memory related directives to access the port. - - 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 |