From 3bdf817950eadd75a2785b62220eb0b04533b9fd Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 16 Sep 2020 11:48:29 +0200 Subject: spec: Group items by component --- spec/if/rtems/region/create.yml | 50 ----------------------- spec/if/rtems/region/delete.yml | 30 -------------- spec/if/rtems/region/extend.yml | 38 ----------------- spec/if/rtems/region/get-free-information.yml | 34 --------------- spec/if/rtems/region/get-information.yml | 34 --------------- spec/if/rtems/region/get-segment-size.yml | 38 ----------------- spec/if/rtems/region/get-segment.yml | 46 --------------------- spec/if/rtems/region/group.yml | 20 --------- spec/if/rtems/region/header.yml | 12 ------ spec/if/rtems/region/ident.yml | 59 --------------------------- spec/if/rtems/region/resize-segment.yml | 42 ------------------- spec/if/rtems/region/return-segment.yml | 34 --------------- 12 files changed, 437 deletions(-) delete mode 100644 spec/if/rtems/region/create.yml delete mode 100644 spec/if/rtems/region/delete.yml delete mode 100644 spec/if/rtems/region/extend.yml delete mode 100644 spec/if/rtems/region/get-free-information.yml delete mode 100644 spec/if/rtems/region/get-information.yml delete mode 100644 spec/if/rtems/region/get-segment-size.yml delete mode 100644 spec/if/rtems/region/get-segment.yml delete mode 100644 spec/if/rtems/region/group.yml delete mode 100644 spec/if/rtems/region/header.yml delete mode 100644 spec/if/rtems/region/ident.yml delete mode 100644 spec/if/rtems/region/resize-segment.yml delete mode 100644 spec/if/rtems/region/return-segment.yml (limited to 'spec/if/rtems/region') diff --git a/spec/if/rtems/region/create.yml b/spec/if/rtems/region/create.yml deleted file mode 100644 index 3eb4ae45..00000000 --- a/spec/if/rtems/region/create.yml +++ /dev/null @@ -1,50 +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} - - void *${.:/params[1]/name} - - ${/if/c/uintptr_t:/name} ${.:/params[2]/name} - - ${/if/c/uintptr_t:/name} ${.:/params[3]/name} - - ${../attr/attribute:/name} ${.:/params[4]/name} - - ${../types/id:/name} *${.:/params[5]/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_region_create -notes: null -params: -- description: '%' - dir: null - name: name -- description: '%' - dir: null - name: starting_address -- description: '%' - dir: null - name: length -- description: '%' - dir: null - name: page_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/region/delete.yml b/spec/if/rtems/region/delete.yml deleted file mode 100644 index 3c046c7e..00000000 --- a/spec/if/rtems/region/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_region_delete -notes: null -params: -- description: '%' - dir: null - name: id -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/region/extend.yml b/spec/if/rtems/region/extend.yml deleted file mode 100644 index 338e3a47..00000000 --- a/spec/if/rtems/region/extend.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} - - void *${.:/params[1]/name} - - ${/if/c/uintptr_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_region_extend -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: starting_address -- description: '%' - dir: null - name: length -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/region/get-free-information.yml b/spec/if/rtems/region/get-free-information.yml deleted file mode 100644 index 929aadf9..00000000 --- a/spec/if/rtems/region/get-free-information.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/impl/heap/information-block:/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_region_get_free_information -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: the_info -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/region/get-information.yml b/spec/if/rtems/region/get-information.yml deleted file mode 100644 index 4f655870..00000000 --- a/spec/if/rtems/region/get-information.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/impl/heap/information-block:/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_region_get_information -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: the_info -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/region/get-segment-size.yml b/spec/if/rtems/region/get-segment-size.yml deleted file mode 100644 index 993846e1..00000000 --- a/spec/if/rtems/region/get-segment-size.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} - - void *${.:/params[1]/name} - - ${/if/c/uintptr_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_region_get_segment_size -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: segment -- description: '%' - dir: null - name: size -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/region/get-segment.yml b/spec/if/rtems/region/get-segment.yml deleted file mode 100644 index 382ea863..00000000 --- a/spec/if/rtems/region/get-segment.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} - - ${/if/c/uintptr_t:/name} ${.:/params[1]/name} - - ${../options/option:/name} ${.:/params[2]/name} - - ${../types/interval:/name} ${.:/params[3]/name} - - void **${.:/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_region_get_segment -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: size -- description: '%' - dir: null - name: option_set -- description: '%' - dir: null - name: timeout -- description: '%' - dir: null - name: segment -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/region/group.yml b/spec/if/rtems/region/group.yml deleted file mode 100644 index 4a058ea8..00000000 --- a/spec/if/rtems/region/group.yml +++ /dev/null @@ -1,20 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: | - The Region Manager provides facilities to dynamically allocate memory in - variable sized units. -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: RTEMSAPIClassicRegion -interface-type: group -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: ../group -name: Region Manager -text: | - The Classic API shall provide an interface to the Region Manager. -type: interface diff --git a/spec/if/rtems/region/header.yml b/spec/if/rtems/region/header.yml deleted file mode 100644 index 0463cc18..00000000 --- a/spec/if/rtems/region/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 Region 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/region.h -prefix: cpukit/include -type: interface diff --git a/spec/if/rtems/region/ident.yml b/spec/if/rtems/region/ident.yml deleted file mode 100644 index 57b5ce9d..00000000 --- a/spec/if/rtems/region/ident.yml +++ /dev/null @@ -1,59 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: | - Identifies a region 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 region identifier associated with the region 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_region_ident -notes: | - If the region name is not unique, then the region identifier will match the - first region with that name in the search order. However, this region - identifier is not guaranteed to correspond to the desired region. The region - identifier is used with other region related directives to access the region. - - 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 diff --git a/spec/if/rtems/region/resize-segment.yml b/spec/if/rtems/region/resize-segment.yml deleted file mode 100644 index cc02db08..00000000 --- a/spec/if/rtems/region/resize-segment.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} - - void *${.:/params[1]/name} - - ${/if/c/uintptr_t:/name} ${.:/params[2]/name} - - ${/if/c/uintptr_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_region_resize_segment -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: segment -- description: '%' - dir: null - name: size -- description: '%' - dir: null - name: old_size -return: - return: null - return-values: [] -type: interface diff --git a/spec/if/rtems/region/return-segment.yml b/spec/if/rtems/region/return-segment.yml deleted file mode 100644 index 27eacee6..00000000 --- a/spec/if/rtems/region/return-segment.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} - - void *${.:/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_region_return_segment -notes: null -params: -- description: '%' - dir: null - name: id -- description: '%' - dir: null - name: segment -return: - return: null - return-values: [] -type: interface -- cgit v1.2.3