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/message | |
parent | 724df1c5ef711c9399cd8c33b23aee40304d0332 (diff) |
spec: Group items by component
Diffstat (limited to 'spec/if/rtems/message')
-rw-r--r-- | spec/if/rtems/message/broadcast.yml | 42 | ||||
-rw-r--r-- | spec/if/rtems/message/create.yml | 46 | ||||
-rw-r--r-- | spec/if/rtems/message/delete.yml | 30 | ||||
-rw-r--r-- | spec/if/rtems/message/flush.yml | 34 | ||||
-rw-r--r-- | spec/if/rtems/message/get-number-pending.yml | 34 | ||||
-rw-r--r-- | spec/if/rtems/message/group.yml | 20 | ||||
-rw-r--r-- | spec/if/rtems/message/header.yml | 12 | ||||
-rw-r--r-- | spec/if/rtems/message/ident.yml | 86 | ||||
-rw-r--r-- | spec/if/rtems/message/receive.yml | 46 | ||||
-rw-r--r-- | spec/if/rtems/message/send.yml | 38 | ||||
-rw-r--r-- | spec/if/rtems/message/urgent.yml | 38 |
11 files changed, 0 insertions, 426 deletions
diff --git a/spec/if/rtems/message/broadcast.yml b/spec/if/rtems/message/broadcast.yml deleted file mode 100644 index e62a4bee..00000000 --- a/spec/if/rtems/message/broadcast.yml +++ /dev/null @@ -1,42 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' -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/id:/name} ${.:/params[0]/name} - - const void *${.:/params[1]/name} - - ${/if/c/size_t:/name} ${.:/params[2]/name} - - ${/if/c/uint32_t:/name} *${.:/params[3]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_message_queue_broadcast -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: buffer -- description: '%' - dir: null - name: size -- description: '%' - dir: null - name: count -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/message/create.yml b/spec/if/rtems/message/create.yml deleted file mode 100644 index 345af9fe..00000000 --- a/spec/if/rtems/message/create.yml +++ /dev/null @@ -1,46 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' -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} - - ${/if/c/size_t:/name} ${.:/params[2]/name} - - ${../attr/attribute:/name} ${.:/params[3]/name} - - ${../types/id:/name} *${.:/params[4]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_message_queue_create -notes: null -params: -- description: '%' - dir: null - name: name -- description: '%' - dir: null - name: count -- description: '%' - dir: null - name: max_message_size -- description: '%' - dir: null - name: attribute_set -- description: '%' - dir: null - name: id -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/message/delete.yml b/spec/if/rtems/message/delete.yml deleted file mode 100644 index acf90742..00000000 --- a/spec/if/rtems/message/delete.yml +++ /dev/null @@ -1,30 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' -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/id:/name} ${.:/params[0]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_message_queue_delete -notes: null -params: -- description: '%' - dir: null - name: id -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/message/flush.yml b/spec/if/rtems/message/flush.yml deleted file mode 100644 index fe130b24..00000000 --- a/spec/if/rtems/message/flush.yml +++ /dev/null @@ -1,34 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' -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/id:/name} ${.:/params[0]/name} - - ${/if/c/uint32_t:/name} *${.:/params[1]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_message_queue_flush -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: count -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/message/get-number-pending.yml b/spec/if/rtems/message/get-number-pending.yml deleted file mode 100644 index 964ecc4b..00000000 --- a/spec/if/rtems/message/get-number-pending.yml +++ /dev/null @@ -1,34 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' -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/id:/name} ${.:/params[0]/name} - - ${/if/c/uint32_t:/name} *${.:/params[1]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_message_queue_get_number_pending -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: count -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/message/group.yml b/spec/if/rtems/message/group.yml deleted file mode 100644 index 579b70a2..00000000 --- a/spec/if/rtems/message/group.yml +++ /dev/null @@ -1,20 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: | - The Message Manager provides communication and synchronization capabilities - using RTEMS message queues. -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -description: null -enabled-by: true -identifier: RTEMSAPIClassicMessage -interface-type: group -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: ../group -name: Message Manager -text: | - The Classic API shall provide an interface to the Message Manager. -type: interface diff --git a/spec/if/rtems/message/header.yml b/spec/if/rtems/message/header.yml deleted file mode 100644 index 2dba7f70..00000000 --- a/spec/if/rtems/message/header.yml +++ /dev/null @@ -1,12 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: This header file defines the Message Manager API. -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-type: header-file -links: -- role: interface-placement - uid: /if/domains/api -path: rtems/rtems/message.h -prefix: cpukit/include -type: interface diff --git a/spec/if/rtems/message/ident.yml b/spec/if/rtems/message/ident.yml deleted file mode 100644 index 58717c89..00000000 --- a/spec/if/rtems/message/ident.yml +++ /dev/null @@ -1,86 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: | - Identifies a message queue 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 message queue identifier associated with the - message queue 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_message_queue_ident -notes: | - If the message queue name is not unique, then the message queue identifier - will match the first message queue with that name in the search order. - However, this message queue identifier is not guaranteed to correspond to the - desired message queue. The message queue identifier is used with other - message related directives to access the message queue. - - 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 message queues 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 diff --git a/spec/if/rtems/message/receive.yml b/spec/if/rtems/message/receive.yml deleted file mode 100644 index 73f9dcdc..00000000 --- a/spec/if/rtems/message/receive.yml +++ /dev/null @@ -1,46 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' -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/id:/name} ${.:/params[0]/name} - - void *${.:/params[1]/name} - - ${/if/c/size_t:/name} *${.:/params[2]/name} - - ${../options/option:/name} ${.:/params[3]/name} - - ${../types/interval:/name} ${.:/params[4]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_message_queue_receive -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: buffer -- description: '%' - dir: null - name: size -- description: '%' - dir: null - name: option_set -- description: '%' - dir: null - name: timeout -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/message/send.yml b/spec/if/rtems/message/send.yml deleted file mode 100644 index 0c035b99..00000000 --- a/spec/if/rtems/message/send.yml +++ /dev/null @@ -1,38 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' -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/id:/name} ${.:/params[0]/name} - - const void *${.:/params[1]/name} - - ${/if/c/size_t:/name} ${.:/params[2]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_message_queue_send -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: buffer -- description: '%' - dir: null - name: size -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/message/urgent.yml b/spec/if/rtems/message/urgent.yml deleted file mode 100644 index 13fb07a9..00000000 --- a/spec/if/rtems/message/urgent.yml +++ /dev/null @@ -1,38 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' -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/id:/name} ${.:/params[0]/name} - - const void *${.:/params[1]/name} - - ${/if/c/size_t:/name} ${.:/params[2]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_message_queue_urgent -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: buffer -- description: '%' - dir: null - name: size -return: - return: null - return-values: [] -type: interface |