From 7446038f7b600c5e7597c6a0ce67679fbbed8de4 Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Mon, 22 Jun 2020 08:36:48 +0200
Subject: spec: Add /if/rtems/region/*

---
 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/header.yml               | 11 ++++++
 spec/if/rtems/region/ident.yml                | 34 ++++++++++++++++++
 spec/if/rtems/region/resize-segment.yml       | 42 ++++++++++++++++++++++
 spec/if/rtems/region/return-segment.yml       | 34 ++++++++++++++++++
 11 files changed, 391 insertions(+)
 create mode 100644 spec/if/rtems/region/create.yml
 create mode 100644 spec/if/rtems/region/delete.yml
 create mode 100644 spec/if/rtems/region/extend.yml
 create mode 100644 spec/if/rtems/region/get-free-information.yml
 create mode 100644 spec/if/rtems/region/get-information.yml
 create mode 100644 spec/if/rtems/region/get-segment-size.yml
 create mode 100644 spec/if/rtems/region/get-segment.yml
 create mode 100644 spec/if/rtems/region/header.yml
 create mode 100644 spec/if/rtems/region/ident.yml
 create mode 100644 spec/if/rtems/region/resize-segment.yml
 create 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
new file mode 100644
index 00000000..c2a22de2
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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
new file mode 100644
index 00000000..858531b3
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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
new file mode 100644
index 00000000..e37c590f
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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
new file mode 100644
index 00000000..df348a9b
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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
new file mode 100644
index 00000000..fb0d728d
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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
new file mode 100644
index 00000000..b9601f96
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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
new file mode 100644
index 00000000..5941bfa4
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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/header.yml b/spec/if/rtems/region/header.yml
new file mode 100644
index 00000000..06949537
--- /dev/null
+++ b/spec/if/rtems/region/header.yml
@@ -0,0 +1,11 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+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
new file mode 100644
index 00000000..40238e6b
--- /dev/null
+++ b/spec/if/rtems/region/ident.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:
+    - ${../types/name:/name} ${.:/params[0]/name}
+    - ${../types/id:/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: /groups/api/classic/region
+name: rtems_region_ident
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: name
+- description: '%'
+  dir: null
+  name: id
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/region/resize-segment.yml b/spec/if/rtems/region/resize-segment.yml
new file mode 100644
index 00000000..532ab96a
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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
new file mode 100644
index 00000000..57cbbf50
--- /dev/null
+++ b/spec/if/rtems/region/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:
+    - ${../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: /groups/api/classic/region
+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