summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--spec/groups/api/classic/region.yml18
-rw-r--r--spec/if/impl/heap/header.yml11
-rw-r--r--spec/if/impl/heap/information-block.yml10
-rw-r--r--spec/if/rtems/region/create.yml50
-rw-r--r--spec/if/rtems/region/delete.yml30
-rw-r--r--spec/if/rtems/region/extend.yml38
-rw-r--r--spec/if/rtems/region/get-free-information.yml34
-rw-r--r--spec/if/rtems/region/get-information.yml34
-rw-r--r--spec/if/rtems/region/get-segment-size.yml38
-rw-r--r--spec/if/rtems/region/get-segment.yml46
-rw-r--r--spec/if/rtems/region/header.yml11
-rw-r--r--spec/if/rtems/region/ident.yml34
-rw-r--r--spec/if/rtems/region/resize-segment.yml42
-rw-r--r--spec/if/rtems/region/return-segment.yml34
14 files changed, 430 insertions, 0 deletions
diff --git a/spec/groups/api/classic/region.yml b/spec/groups/api/classic/region.yml
new file mode 100644
index 00000000..fd85baea
--- /dev/null
+++ b/spec/groups/api/classic/region.yml
@@ -0,0 +1,18 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: API
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: |
+ The Region Manager provides facilities to dynamically allocate memory in
+ variable sized units.
+enabled-by: true
+identifier: RTEMSAPIClassicRegion
+interface-type: group
+links:
+- role: interface-placement
+ uid: /if/rtems/region/header
+- role: interface-ingroup
+ uid: /groups/api/classic
+name: Region Manager
+type: interface
diff --git a/spec/if/impl/heap/header.yml b/spec/if/impl/heap/header.yml
new file mode 100644
index 00000000..99e90741
--- /dev/null
+++ b/spec/if/impl/heap/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/implementation
+path: rtems/score/heapinfo.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/if/impl/heap/information-block.yml b/spec/if/impl/heap/information-block.yml
new file mode 100644
index 00000000..303bd27a
--- /dev/null
+++ b/spec/if/impl/heap/information-block.yml
@@ -0,0 +1,10 @@
+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: unspecified
+links:
+- role: interface-placement
+ uid: header
+name: Heap_Information_block
+type: interface
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
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-12 16:48:18 +0000