12 files changed, 437 insertions, 0 deletions
diff --git a/spec/rtems/region/if/create.yml b/spec/rtems/region/if/create.yml
new file mode 100644
index 00000000..eca13c24
--- /dev/null
+++ b/spec/rtems/region/if/create.yml
@@ -0,0 +1,50 @@
+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:
+    - ${../../type/if/name:/name} ${.:/params[0]/name}
+    - void *${.:/params[1]/name}
+    - ${/c/if/uintptr_t:/name} ${.:/params[2]/name}
+    - ${/c/if/uintptr_t:/name} ${.:/params[3]/name}
+    - ${../../attr/if/attribute:/name} ${.:/params[4]/name}
+    - ${../../type/if/id:/name} *${.:/params[5]/name}
+    return: ${../../status/if/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/rtems/region/if/delete.yml b/spec/rtems/region/if/delete.yml
new file mode 100644
index 00000000..4565f3b1
--- /dev/null
+++ b/spec/rtems/region/if/delete.yml
@@ -0,0 +1,30 @@
+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:
+    - ${../../type/if/id:/name} ${.:/params[0]/name}
+    return: ${../../status/if/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/rtems/region/if/extend.yml b/spec/rtems/region/if/extend.yml
new file mode 100644
index 00000000..e863d803
--- /dev/null
+++ b/spec/rtems/region/if/extend.yml
@@ -0,0 +1,38 @@
+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:
+    - ${../../type/if/id:/name} ${.:/params[0]/name}
+    - void *${.:/params[1]/name}
+    - ${/c/if/uintptr_t:/name} ${.:/params[2]/name}
+    return: ${../../status/if/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/rtems/region/if/get-free-information.yml b/spec/rtems/region/if/get-free-information.yml
new file mode 100644
index 00000000..9a8b85be
--- /dev/null
+++ b/spec/rtems/region/if/get-free-information.yml
@@ -0,0 +1,34 @@
+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:
+    - ${../../type/if/id:/name} ${.:/params[0]/name}
+    - ${/score/heap/if/information-block:/name} *${.:/params[1]/name}
+    return: ${../../status/if/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/rtems/region/if/get-information.yml b/spec/rtems/region/if/get-information.yml
new file mode 100644
index 00000000..bee6a1c2
--- /dev/null
+++ b/spec/rtems/region/if/get-information.yml
@@ -0,0 +1,34 @@
+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:
+    - ${../../type/if/id:/name} ${.:/params[0]/name}
+    - ${/score/heap/if/information-block:/name} *${.:/params[1]/name}
+    return: ${../../status/if/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/rtems/region/if/get-segment-size.yml b/spec/rtems/region/if/get-segment-size.yml
new file mode 100644
index 00000000..4b3e1d65
--- /dev/null
+++ b/spec/rtems/region/if/get-segment-size.yml
@@ -0,0 +1,38 @@
+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:
+    - ${../../type/if/id:/name} ${.:/params[0]/name}
+    - void *${.:/params[1]/name}
+    - ${/c/if/uintptr_t:/name} *${.:/params[2]/name}
+    return: ${../../status/if/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/rtems/region/if/get-segment.yml b/spec/rtems/region/if/get-segment.yml
new file mode 100644
index 00000000..e050fcd0
--- /dev/null
+++ b/spec/rtems/region/if/get-segment.yml
@@ -0,0 +1,46 @@
+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:
+    - ${../../type/if/id:/name} ${.:/params[0]/name}
+    - ${/c/if/uintptr_t:/name} ${.:/params[1]/name}
+    - ${../../option/if/option:/name} ${.:/params[2]/name}
+    - ${../../type/if/interval:/name} ${.:/params[3]/name}
+    - void **${.:/params[4]/name}
+    return: ${../../status/if/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/rtems/region/if/group.yml b/spec/rtems/region/if/group.yml
new file mode 100644
index 00000000..ca01b322
--- /dev/null
+++ b/spec/rtems/region/if/group.yml
@@ -0,0 +1,20 @@
+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: ../../if/group
+name: Region Manager
+text: |
+  The Classic API shall provide an interface to the Region Manager.
+type: interface
diff --git a/spec/rtems/region/if/header.yml b/spec/rtems/region/if/header.yml
new file mode 100644
index 00000000..9f456de6
--- /dev/null
+++ b/spec/rtems/region/if/header.yml
@@ -0,0 +1,12 @@
+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/domain
+path: rtems/rtems/region.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/region/if/ident.yml b/spec/rtems/region/if/ident.yml
new file mode 100644
index 00000000..cfce1445
--- /dev/null
+++ b/spec/rtems/region/if/ident.yml
@@ -0,0 +1,59 @@
+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:
+    - ${../../type/if/name:/name} ${.:/params[0]/name}
+    - ${../../type/if/id:/name} *${.:/params[1]/name}
+    return: ${../../status/if/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/if/successful:/name}
+  - description: |
+      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
+    value: ${../../status/if/invalid-address:/name}
+  - description: |
+      The ${.:/params[0]/name} parameter was 0.
+    value: ${../../status/if/invalid-name:/name}
+  - description: |
+      There was no object with the specified name on the local node.
+    value: ${../../status/if/invalid-name:/name}
+type: interface
diff --git a/spec/rtems/region/if/resize-segment.yml b/spec/rtems/region/if/resize-segment.yml
new file mode 100644
index 00000000..1da5c347
--- /dev/null
+++ b/spec/rtems/region/if/resize-segment.yml
@@ -0,0 +1,42 @@
+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:
+    - ${../../type/if/id:/name} ${.:/params[0]/name}
+    - void *${.:/params[1]/name}
+    - ${/c/if/uintptr_t:/name} ${.:/params[2]/name}
+    - ${/c/if/uintptr_t:/name} *${.:/params[3]/name}
+    return: ${../../status/if/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/rtems/region/if/return-segment.yml b/spec/rtems/region/if/return-segment.yml
new file mode 100644
index 00000000..3767cc5d
--- /dev/null
+++ b/spec/rtems/region/if/return-segment.yml
@@ -0,0 +1,34 @@
+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:
+    - ${../../type/if/id:/name} ${.:/params[0]/name}
+    - void *${.:/params[1]/name}
+    return: ${../../status/if/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