summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/dpmem
diff options
context:
space:
mode:
Diffstat (limited to 'spec/if/rtems/dpmem')
-rw-r--r--spec/if/rtems/dpmem/create.yml46
-rw-r--r--spec/if/rtems/dpmem/delete.yml30
-rw-r--r--spec/if/rtems/dpmem/external-to-internal.yml38
-rw-r--r--spec/if/rtems/dpmem/group.yml21
-rw-r--r--spec/if/rtems/dpmem/header.yml12
-rw-r--r--spec/if/rtems/dpmem/ident.yml59
-rw-r--r--spec/if/rtems/dpmem/internal-to-external.yml38
7 files changed, 0 insertions, 244 deletions
diff --git a/spec/if/rtems/dpmem/create.yml b/spec/if/rtems/dpmem/create.yml
deleted file mode 100644
index 4a686736..00000000
--- a/spec/if/rtems/dpmem/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}
- - void *${.:/params[1]/name}
- - void *${.:/params[2]/name}
- - ${/if/c/uint32_t:/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_port_create
-notes: null
-params:
-- description: '%'
- dir: null
- name: name
-- description: '%'
- dir: null
- name: internal_start
-- description: '%'
- dir: null
- name: external_start
-- description: '%'
- dir: null
- name: length
-- description: '%'
- dir: null
- name: id
-return:
- return: null
- return-values: []
-type: interface
diff --git a/spec/if/rtems/dpmem/delete.yml b/spec/if/rtems/dpmem/delete.yml
deleted file mode 100644
index 6b5f31ce..00000000
--- a/spec/if/rtems/dpmem/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_port_delete
-notes: null
-params:
-- description: '%'
- dir: null
- name: id
-return:
- return: null
- return-values: []
-type: interface
diff --git a/spec/if/rtems/dpmem/external-to-internal.yml b/spec/if/rtems/dpmem/external-to-internal.yml
deleted file mode 100644
index 54012d05..00000000
--- a/spec/if/rtems/dpmem/external-to-internal.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}
- - void **${.:/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_port_external_to_internal
-notes: null
-params:
-- description: '%'
- dir: null
- name: id
-- description: '%'
- dir: null
- name: external
-- description: '%'
- dir: null
- name: internal
-return:
- return: null
- return-values: []
-type: interface
diff --git a/spec/if/rtems/dpmem/group.yml b/spec/if/rtems/dpmem/group.yml
deleted file mode 100644
index c07fde9f..00000000
--- a/spec/if/rtems/dpmem/group.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
- The Dual-Ported Memory Manager provides a mechanism for converting addresses
- between internal and external representations for multiple dual-ported memory
- areas (DPMA).
-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: RTEMSAPIClassicDPMem
-interface-type: group
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: ../group
-name: Dual-Ported Memory Manager
-text: |
- The Classic API shall provide an interface to the Dual-Ported Memory Manager.
-type: interface
diff --git a/spec/if/rtems/dpmem/header.yml b/spec/if/rtems/dpmem/header.yml
deleted file mode 100644
index 5aa6b51a..00000000
--- a/spec/if/rtems/dpmem/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 Dual-Ported Memory 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/dpmem.h
-prefix: cpukit/include
-type: interface
diff --git a/spec/if/rtems/dpmem/ident.yml b/spec/if/rtems/dpmem/ident.yml
deleted file mode 100644
index 5d609e02..00000000
--- a/spec/if/rtems/dpmem/ident.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
- Identifies a port 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 port identifier associated with the port 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_port_ident
-notes: |
- If the port name is not unique, then the port identifier will match the first
- port with that name in the search order. However, this port identifier is
- not guaranteed to correspond to the desired port. The port identifier is
- used with other dual-ported memory related directives to access the port.
-
- 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/dpmem/internal-to-external.yml b/spec/if/rtems/dpmem/internal-to-external.yml
deleted file mode 100644
index 5cb7531b..00000000
--- a/spec/if/rtems/dpmem/internal-to-external.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}
- - void **${.:/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_port_internal_to_external
-notes: null
-params:
-- description: '%'
- dir: null
- name: id
-- description: '%'
- dir: null
- name: internal
-- description: '%'
- dir: null
- name: external
-return:
- return: null
- return-values: []
-type: interface