summaryrefslogtreecommitdiff
path: root/spec/if/rtems/status
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-25 09:52:00 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commit8821c7d4313148585caaf6f93e85346537746587 (patch)
tree6eedae16d1e957de7a3628d78c4e053d92ea1ec7 /spec/if/rtems/status
parent37d648b805563bc20bc296414ed3f086da190306 (diff)
Rename interface attributes
Diffstat (limited to 'spec/if/rtems/status')
-rw-r--r--spec/if/rtems/status/already-suspended.yml14
-rw-r--r--spec/if/rtems/status/called-from-isr.yml16
-rw-r--r--spec/if/rtems/status/code-to-errno.yml76
-rw-r--r--spec/if/rtems/status/code.yml12
-rw-r--r--spec/if/rtems/status/first.yml16
-rw-r--r--spec/if/rtems/status/header.yml6
-rw-r--r--spec/if/rtems/status/illegal-on-remote-object.yml14
-rw-r--r--spec/if/rtems/status/illegal-on-self.yml16
-rw-r--r--spec/if/rtems/status/incorrect-state.yml16
-rw-r--r--spec/if/rtems/status/internal-error.yml14
-rw-r--r--spec/if/rtems/status/interrupted.yml16
-rw-r--r--spec/if/rtems/status/invalid-address.yml14
-rw-r--r--spec/if/rtems/status/invalid-clock.yml14
-rw-r--r--spec/if/rtems/status/invalid-id.yml14
-rw-r--r--spec/if/rtems/status/invalid-name.yml14
-rw-r--r--spec/if/rtems/status/invalid-node.yml14
-rw-r--r--spec/if/rtems/status/invalid-number.yml14
-rw-r--r--spec/if/rtems/status/invalid-priority.yml14
-rw-r--r--spec/if/rtems/status/invalid-size.yml14
-rw-r--r--spec/if/rtems/status/io-error.yml14
-rw-r--r--spec/if/rtems/status/is-equal.yml40
-rw-r--r--spec/if/rtems/status/is-successful.yml36
-rw-r--r--spec/if/rtems/status/last.yml16
-rw-r--r--spec/if/rtems/status/mp-not-configured.yml14
-rw-r--r--spec/if/rtems/status/no-memory.yml16
-rw-r--r--spec/if/rtems/status/not-configured.yml14
-rw-r--r--spec/if/rtems/status/not-defined.yml14
-rw-r--r--spec/if/rtems/status/not-implemented.yml16
-rw-r--r--spec/if/rtems/status/not-owner-of-resource.yml14
-rw-r--r--spec/if/rtems/status/object-was-deleted.yml16
-rw-r--r--spec/if/rtems/status/proxy-blocking.yml19
-rw-r--r--spec/if/rtems/status/resource-in-use.yml14
-rw-r--r--spec/if/rtems/status/successful.yml14
-rw-r--r--spec/if/rtems/status/task-exitted.yml14
-rw-r--r--spec/if/rtems/status/text.yml30
-rw-r--r--spec/if/rtems/status/timeout.yml14
-rw-r--r--spec/if/rtems/status/too-many.yml16
-rw-r--r--spec/if/rtems/status/unsatisfied.yml14
38 files changed, 336 insertions, 337 deletions
diff --git a/spec/if/rtems/status/already-suspended.yml b/spec/if/rtems/status/already-suspended.yml
index 4b72cd7d..30b0ae3a 100644
--- a/spec/if/rtems/status/already-suspended.yml
+++ b/spec/if/rtems/status/already-suspended.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the thread was already suspended.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the thread was already suspended.
-interface-definition:
+definition:
default: '15'
variants: []
-interface-description: null
-interface-name: RTEMS_ALREADY_SUSPENDED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_ALREADY_SUSPENDED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/called-from-isr.yml b/spec/if/rtems/status/called-from-isr.yml
index 3a8afaa6..6092755a 100644
--- a/spec/if/rtems/status/called-from-isr.yml
+++ b/spec/if/rtems/status/called-from-isr.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the operation should not be called from this
+ execution environment.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the operation should not be called from this
- execution environment.
-interface-definition:
+definition:
default: '18'
variants: []
-interface-description: null
-interface-name: RTEMS_CALLED_FROM_ISR
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_CALLED_FROM_ISR
+notes: null
type: interface
diff --git a/spec/if/rtems/status/code-to-errno.yml b/spec/if/rtems/status/code-to-errno.yml
index 3bf138bb..054f2ea3 100644
--- a/spec/if/rtems/status/code-to-errno.yml
+++ b/spec/if/rtems/status/code-to-errno.yml
@@ -1,73 +1,73 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Maps the specified RTEMS status code to a POSIX error number.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Maps the specified RTEMS status code to a POSIX error number.
-interface-definition:
+definition:
default:
params:
- - ${code:/interface-name} ${.:/interface-params[0]/name}
+ - ${code:/name} ${.:/params[0]/name}
return: int
variants: []
-interface-description: null
-interface-name: rtems_status_code_to_errno
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/classic/status
+name: rtems_status_code_to_errno
+notes: null
+params:
- description: is the status code to map.
dir: null
name: status_code
-interface-return:
+return:
return: null
return-values:
- description: |
- The status code is ${successful:/interface-name}.
+ The status code is ${successful:/name}.
value: '0'
- description: |
- The status code is ${invalid-number:/interface-name}.
+ The status code is ${invalid-number:/name}.
value: EBADF
- description: |
- The status code is ${resource-in-use:/interface-name}.
+ The status code is ${resource-in-use:/name}.
value: EBUSY
- description: |
- The status code is ${interrupted:/interface-name}.
+ The status code is ${interrupted:/name}.
value: EINTR
- description: |
- The status code is ${invalid-clock:/interface-name},
- ${invalid-name:/interface-name}, or ${invalid-node:/interface-name}.
+ The status code is ${invalid-clock:/name},
+ ${invalid-name:/name}, or ${invalid-node:/name}.
value: EINVAL
- description: |
- The status code is ${already-suspended:/interface-name},
- ${called-from-isr:/interface-name},
- ${illegal-on-remote-object:/interface-name},
- ${illegal-on-self:/interface-name}, ${incorrect-state:/interface-name},
- ${internal-error:/interface-name}, ${invalid-address:/interface-name},
- ${invalid-id:/interface-name}, ${invalid-priority:/interface-name},
- ${invalid-size:/interface-name}, ${io-error:/interface-name},
- ${mp-not-configured:/interface-name}, ${not-defined:/interface-name},
- ${object-was-deleted:/interface-name}, ${proxy-blocking:/interface-name},
- ${task-exitted:/interface-name}, or ${too-many:/interface-name}.
+ The status code is ${already-suspended:/name},
+ ${called-from-isr:/name},
+ ${illegal-on-remote-object:/name},
+ ${illegal-on-self:/name}, ${incorrect-state:/name},
+ ${internal-error:/name}, ${invalid-address:/name},
+ ${invalid-id:/name}, ${invalid-priority:/name},
+ ${invalid-size:/name}, ${io-error:/name},
+ ${mp-not-configured:/name}, ${not-defined:/name},
+ ${object-was-deleted:/name}, ${proxy-blocking:/name},
+ ${task-exitted:/name}, or ${too-many:/name}.
value: EIO
- description: |
- The status code is ${unsatisfied:/interface-name}.
+ The status code is ${unsatisfied:/name}.
value: ENODEV
- description: |
- The status code is ${no-memory:/interface-name}.
+ The status code is ${no-memory:/name}.
value: ENOMEM
- description: |
- The status code is ${not-configured:/interface-name} or
- ${not-implemented:/interface-name}.
+ The status code is ${not-configured:/name} or
+ ${not-implemented:/name}.
value: ENOSYS
- description: |
- The status code is ${not-owner-of-resource:/interface-name}.
+ The status code is ${not-owner-of-resource:/name}.
value: EPERM
- description: |
- The status code is ${timeout:/interface-name}.
+ The status code is ${timeout:/name}.
value: ETIMEDOUT
-interface-type: function
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/classic/status
type: interface
diff --git a/spec/if/rtems/status/code.yml b/spec/if/rtems/status/code.yml
index 9a09e653..0e86a34a 100644
--- a/spec/if/rtems/status/code.yml
+++ b/spec/if/rtems/status/code.yml
@@ -1,13 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This enumeration provides status codes for directives of the Classic API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition-kind: typedef-only
+description: null
enabled-by: true
-interface-brief: |
- This enumeration provides status codes for directives of the Classic API.
-interface-definition-kind: typedef-only
-interface-description: null
-interface-name: rtems_status_code
-interface-notes: null
interface-type: enum
links:
- role: interface-placement
@@ -74,4 +72,6 @@ links:
uid: interrupted
- role: interface-enumerator
uid: proxy-blocking
+name: rtems_status_code
+notes: null
type: interface
diff --git a/spec/if/rtems/status/first.yml b/spec/if/rtems/status/first.yml
index 2380936d..52faaf9f 100644
--- a/spec/if/rtems/status/first.yml
+++ b/spec/if/rtems/status/first.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This is the lowest valid value for a Classic API status code.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This is the lowest valid value for a Classic API status code.
-interface-definition:
- default: ${successful:/interface-name}
+definition:
+ default: ${successful:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_STATUS_CODES_FIRST
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/classic/status
+name: RTEMS_STATUS_CODES_FIRST
+notes: null
type: interface
diff --git a/spec/if/rtems/status/header.yml b/spec/if/rtems/status/header.yml
index 9662ff09..54ce85e3 100644
--- a/spec/if/rtems/status/header.yml
+++ b/spec/if/rtems/status/header.yml
@@ -1,10 +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)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/rtems/status.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/rtems/status.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/rtems/status/illegal-on-remote-object.yml b/spec/if/rtems/status/illegal-on-remote-object.yml
index e27177b3..924c6e16 100644
--- a/spec/if/rtems/status/illegal-on-remote-object.yml
+++ b/spec/if/rtems/status/illegal-on-remote-object.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the operation is illegal on a remote object.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the operation is illegal on a remote object.
-interface-definition:
+definition:
default: '17'
variants: []
-interface-description: null
-interface-name: RTEMS_ILLEGAL_ON_REMOTE_OBJECT
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_ILLEGAL_ON_REMOTE_OBJECT
+notes: null
type: interface
diff --git a/spec/if/rtems/status/illegal-on-self.yml b/spec/if/rtems/status/illegal-on-self.yml
index c2876449..d7479333 100644
--- a/spec/if/rtems/status/illegal-on-self.yml
+++ b/spec/if/rtems/status/illegal-on-self.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the operation is illegal on the calling
+ thread.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the operation is illegal on the calling
- thread.
-interface-definition:
+definition:
default: '16'
variants: []
-interface-description: null
-interface-name: RTEMS_ILLEGAL_ON_SELF
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_ILLEGAL_ON_SELF
+notes: null
type: interface
diff --git a/spec/if/rtems/status/incorrect-state.yml b/spec/if/rtems/status/incorrect-state.yml
index 0f6ae8b0..9c30f28b 100644
--- a/spec/if/rtems/status/incorrect-state.yml
+++ b/spec/if/rtems/status/incorrect-state.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that an object is in wrong state for the requested
+ operation.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that an object is in wrong state for the requested
- operation.
-interface-definition:
+definition:
default: '14'
variants: []
-interface-description: null
-interface-name: RTEMS_INCORRECT_STATE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INCORRECT_STATE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/internal-error.yml b/spec/if/rtems/status/internal-error.yml
index 5d6616a5..fed91daa 100644
--- a/spec/if/rtems/status/internal-error.yml
+++ b/spec/if/rtems/status/internal-error.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that an internal RTEMS inconsistency was detected.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that an internal RTEMS inconsistency was detected.
-interface-definition:
+definition:
default: '25'
variants: []
-interface-description: null
-interface-name: RTEMS_INTERNAL_ERROR
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INTERNAL_ERROR
+notes: null
type: interface
diff --git a/spec/if/rtems/status/interrupted.yml b/spec/if/rtems/status/interrupted.yml
index f5833c7c..c79fa7fb 100644
--- a/spec/if/rtems/status/interrupted.yml
+++ b/spec/if/rtems/status/interrupted.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code is used internally to indicate a blocking device driver call
+ has been interrupted and should be reflected to the caller as interrupted.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2019 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code is used internally to indicate a blocking device driver call
- has been interrupted and should be reflected to the caller as interrupted.
-interface-definition:
+definition:
default: '28'
variants: []
-interface-description: null
-interface-name: RTEMS_INTERRUPTED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INTERRUPTED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-address.yml b/spec/if/rtems/status/invalid-address.yml
index e6730ef6..e6cb9212 100644
--- a/spec/if/rtems/status/invalid-address.yml
+++ b/spec/if/rtems/status/invalid-address.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified address is invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified address is invalid.
-interface-definition:
+definition:
default: '9'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_ADDRESS
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_ADDRESS
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-clock.yml b/spec/if/rtems/status/invalid-clock.yml
index ff4bcecb..6bcd7284 100644
--- a/spec/if/rtems/status/invalid-clock.yml
+++ b/spec/if/rtems/status/invalid-clock.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified date/time was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified date/time was invalid.
-interface-definition:
+definition:
default: '20'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_CLOCK
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_CLOCK
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-id.yml b/spec/if/rtems/status/invalid-id.yml
index 32b81d30..d51875ea 100644
--- a/spec/if/rtems/status/invalid-id.yml
+++ b/spec/if/rtems/status/invalid-id.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the object identifier was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the object identifier was invalid.
-interface-definition:
+definition:
default: '4'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_ID
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_ID
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-name.yml b/spec/if/rtems/status/invalid-name.yml
index 14fe0325..980951fb 100644
--- a/spec/if/rtems/status/invalid-name.yml
+++ b/spec/if/rtems/status/invalid-name.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the object name was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the object name was invalid.
-interface-definition:
+definition:
default: '3'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_NAME
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_NAME
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-node.yml b/spec/if/rtems/status/invalid-node.yml
index 3cfb2454..98bce397 100644
--- a/spec/if/rtems/status/invalid-node.yml
+++ b/spec/if/rtems/status/invalid-node.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified node identifier was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified node identifier was invalid.
-interface-definition:
+definition:
default: '21'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_NODE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_NODE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-number.yml b/spec/if/rtems/status/invalid-number.yml
index 77aa3637..f4c3bd00 100644
--- a/spec/if/rtems/status/invalid-number.yml
+++ b/spec/if/rtems/status/invalid-number.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified number was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified number was invalid.
-interface-definition:
+definition:
default: '10'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_NUMBER
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_NUMBER
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-priority.yml b/spec/if/rtems/status/invalid-priority.yml
index f50840eb..4a4dbcb5 100644
--- a/spec/if/rtems/status/invalid-priority.yml
+++ b/spec/if/rtems/status/invalid-priority.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that an invalid thread priority was provided.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that an invalid thread priority was provided.
-interface-definition:
+definition:
default: '19'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_PRIORITY
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_PRIORITY
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-size.yml b/spec/if/rtems/status/invalid-size.yml
index db39f247..fc42cae7 100644
--- a/spec/if/rtems/status/invalid-size.yml
+++ b/spec/if/rtems/status/invalid-size.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified size was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified size was invalid.
-interface-definition:
+definition:
default: '8'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_SIZE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_SIZE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/io-error.yml b/spec/if/rtems/status/io-error.yml
index c08c5777..f75a11e6 100644
--- a/spec/if/rtems/status/io-error.yml
+++ b/spec/if/rtems/status/io-error.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates an driver IO error.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates an driver IO error.
-interface-definition:
+definition:
default: '27'
variants: []
-interface-description: null
-interface-name: RTEMS_IO_ERROR
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_IO_ERROR
+notes: null
type: interface
diff --git a/spec/if/rtems/status/is-equal.yml b/spec/if/rtems/status/is-equal.yml
index a9b43983..e3fd89c1 100644
--- a/spec/if/rtems/status/is-equal.yml
+++ b/spec/if/rtems/status/is-equal.yml
@@ -1,37 +1,37 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns true, if the left hand side status code is equal to the right hand
+ side status code, otherwise returns false.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- Returns true, if the left hand side status code is equal to the right hand
- side status code, otherwise returns false.
-interface-definition:
+definition:
default:
body: |
- return ${.:/interface-params[0]/name} == ${.:/interface-params[1]/name};
+ return ${.:/params[0]/name} == ${.:/params[1]/name};
params:
- - ${code:/interface-name} ${.:/interface-params[0]/name}
- - ${code:/interface-name} ${.:/interface-params[1]/name}
- return: ${/if/c/bool:/interface-name}
+ - ${code:/name} ${.:/params[0]/name}
+ - ${code:/name} ${.:/params[1]/name}
+ return: ${/if/c/bool:/name}
variants: []
-interface-description: null
-interface-name: rtems_are_statuses_equal
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/classic/status
+name: rtems_are_statuses_equal
+notes: null
+params:
- description: is the left hand side status code.
dir: null
name: left_status_code
- description: is the right hand side status code.
dir: null
name: right_status_code
-interface-return:
+return:
return: null
return-values: []
-interface-type: function
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/classic/status
type: interface
diff --git a/spec/if/rtems/status/is-successful.yml b/spec/if/rtems/status/is-successful.yml
index e871c8c3..281757c6 100644
--- a/spec/if/rtems/status/is-successful.yml
+++ b/spec/if/rtems/status/is-successful.yml
@@ -1,33 +1,33 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns true, if the status code is ${successful:/name}, otherwise
+ returns false.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- Returns true, if the status code is ${successful:/interface-name}, otherwise
- returns false.
-interface-definition:
+definition:
default:
body: |
- return ${.:/interface-params[0]/name} == ${successful:/interface-name};
+ return ${.:/params[0]/name} == ${successful:/name};
params:
- - ${code:/interface-name} ${.:/interface-params[0]/name}
- return: ${/if/c/bool:/interface-name}
+ - ${code:/name} ${.:/params[0]/name}
+ return: ${/if/c/bool:/name}
variants: []
-interface-description: null
-interface-name: rtems_is_status_successful
-interface-notes: null
-interface-params:
-- description: is the status code.
- dir: null
- name: status_code
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/classic/status
+name: rtems_is_status_successful
+notes: null
+params:
+- description: is the status code.
+ dir: null
+ name: status_code
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/status/last.yml b/spec/if/rtems/status/last.yml
index 71ffcd57..ec378a52 100644
--- a/spec/if/rtems/status/last.yml
+++ b/spec/if/rtems/status/last.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This is the highest valid value for a Classic API status code.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This is the highest valid value for a Classic API status code.
-interface-definition:
- default: ${proxy-blocking:/interface-name}
+definition:
+ default: ${proxy-blocking:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_STATUS_CODES_LAST
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/classic/status
+name: RTEMS_STATUS_CODES_LAST
+notes: null
type: interface
diff --git a/spec/if/rtems/status/mp-not-configured.yml b/spec/if/rtems/status/mp-not-configured.yml
index 4b617bc9..47f3c259 100644
--- a/spec/if/rtems/status/mp-not-configured.yml
+++ b/spec/if/rtems/status/mp-not-configured.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that multiprocessing is not configured.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that multiprocessing is not configured.
-interface-definition:
+definition:
default: '2'
variants: []
-interface-description: null
-interface-name: RTEMS_MP_NOT_CONFIGURED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_MP_NOT_CONFIGURED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/no-memory.yml b/spec/if/rtems/status/no-memory.yml
index f1974354..00fbf207 100644
--- a/spec/if/rtems/status/no-memory.yml
+++ b/spec/if/rtems/status/no-memory.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the directive attempted to allocate memory
+ but was unable to do so.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the directive attempted to allocate memory
- but was unable to do so.
-interface-definition:
+definition:
default: '26'
variants: []
-interface-description: null
-interface-name: RTEMS_NO_MEMORY
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NO_MEMORY
+notes: null
type: interface
diff --git a/spec/if/rtems/status/not-configured.yml b/spec/if/rtems/status/not-configured.yml
index bad4aeeb..4ab79cb9 100644
--- a/spec/if/rtems/status/not-configured.yml
+++ b/spec/if/rtems/status/not-configured.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the directive was not configured.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the directive was not configured.
-interface-definition:
+definition:
default: '22'
variants: []
-interface-description: null
-interface-name: RTEMS_NOT_CONFIGURED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NOT_CONFIGURED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/not-defined.yml b/spec/if/rtems/status/not-defined.yml
index 2e1ef7f7..8f3b93d6 100644
--- a/spec/if/rtems/status/not-defined.yml
+++ b/spec/if/rtems/status/not-defined.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the item has not been initialized.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the item has not been initialized.
-interface-definition:
+definition:
default: '11'
variants: []
-interface-description: null
-interface-name: RTEMS_NOT_DEFINED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NOT_DEFINED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/not-implemented.yml b/spec/if/rtems/status/not-implemented.yml
index 94001c87..d344da20 100644
--- a/spec/if/rtems/status/not-implemented.yml
+++ b/spec/if/rtems/status/not-implemented.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates the directive or requested portion of the
+ directive is not implemented.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates the directive or requested portion of the
- directive is not implemented.
-interface-definition:
+definition:
default: '24'
variants: []
-interface-description: |
+description: |
This is a hint that you have stumbled across an opportunity to submit code to
the RTEMS Project.
-interface-name: RTEMS_NOT_IMPLEMENTED
-interface-notes: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NOT_IMPLEMENTED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/not-owner-of-resource.yml b/spec/if/rtems/status/not-owner-of-resource.yml
index 528da17a..bd0697c8 100644
--- a/spec/if/rtems/status/not-owner-of-resource.yml
+++ b/spec/if/rtems/status/not-owner-of-resource.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the caller is not the owner of the resource.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the caller is not the owner of the resource.
-interface-definition:
+definition:
default: '23'
variants: []
-interface-description: null
-interface-name: RTEMS_NOT_OWNER_OF_RESOURCE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NOT_OWNER_OF_RESOURCE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/object-was-deleted.yml b/spec/if/rtems/status/object-was-deleted.yml
index 608e5371..56d3035a 100644
--- a/spec/if/rtems/status/object-was-deleted.yml
+++ b/spec/if/rtems/status/object-was-deleted.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates the object was deleted while the thread was
+ blocked waiting.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates the object was deleted while the thread was
- blocked waiting.
-interface-definition:
+definition:
default: '7'
variants: []
-interface-description: null
-interface-name: RTEMS_OBJECT_WAS_DELETED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_OBJECT_WAS_DELETED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/proxy-blocking.yml b/spec/if/rtems/status/proxy-blocking.yml
index b70e4d3b..f588a6e9 100644
--- a/spec/if/rtems/status/proxy-blocking.yml
+++ b/spec/if/rtems/status/proxy-blocking.yml
@@ -1,21 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This is the status is used internally to RTEMS when performing
+ operations on behalf of remote tasks.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This is the status is used internally to RTEMS when performing
- operations on behalf of remote tasks.
-interface-definition:
+definition:
default: '29'
variants: []
-interface-description: |
+description: |
This is referred to as proxying operations and this status indicates that the
operation could not be completed immediately and the proxy is blocking.
-interface-name: RTEMS_PROXY_BLOCKING
-interface-note: |
- This status will not be returned to the user.
-interface-notes: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_PROXY_BLOCKING
+notes: |
+ This status will not be returned to the user.
type: interface
diff --git a/spec/if/rtems/status/resource-in-use.yml b/spec/if/rtems/status/resource-in-use.yml
index ed87bfe6..21d609ed 100644
--- a/spec/if/rtems/status/resource-in-use.yml
+++ b/spec/if/rtems/status/resource-in-use.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the object still has resources in use.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the object still has resources in use.
-interface-definition:
+definition:
default: '12'
variants: []
-interface-description: null
-interface-name: RTEMS_RESOURCE_IN_USE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_RESOURCE_IN_USE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/successful.yml b/spec/if/rtems/status/successful.yml
index f7e1c9e6..93ccda45 100644
--- a/spec/if/rtems/status/successful.yml
+++ b/spec/if/rtems/status/successful.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates successful completion.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates successful completion.
-interface-definition:
+definition:
default: '0'
variants: []
-interface-description: null
-interface-name: RTEMS_SUCCESSFUL
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_SUCCESSFUL
+notes: null
type: interface
diff --git a/spec/if/rtems/status/task-exitted.yml b/spec/if/rtems/status/task-exitted.yml
index a0f8b0fc..30e0df9c 100644
--- a/spec/if/rtems/status/task-exitted.yml
+++ b/spec/if/rtems/status/task-exitted.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that a thread exited.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that a thread exited.
-interface-definition:
+definition:
default: '1'
variants: []
-interface-description: null
-interface-name: RTEMS_TASK_EXITTED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_TASK_EXITTED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/text.yml b/spec/if/rtems/status/text.yml
index 8e441f1c..eec9aac7 100644
--- a/spec/if/rtems/status/text.yml
+++ b/spec/if/rtems/status/text.yml
@@ -1,31 +1,31 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: Returns a text describing the specified status code.
copyrights:
- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: Returns a text describing the specified status code.
-interface-definition:
+definition:
default:
params:
- - ${code:/interface-name} ${.:/interface-params[0]/name}
+ - ${code:/name} ${.:/params[0]/name}
return: const char *
variants: []
-interface-description: |
+description: |
The text for each status code is the enumerator constant.
-interface-name: rtems_status_text
-interface-notes: null
-interface-params:
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/classic/status
+name: rtems_status_text
+notes: null
+params:
- description: is the status code.
dir: null
name: status_code
-interface-return:
+return:
return: Otherwise, a text describing the status code.
return-values:
- description: The passed status code is invalid.
value: '"?"'
-interface-type: function
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/classic/status
type: interface
diff --git a/spec/if/rtems/status/timeout.yml b/spec/if/rtems/status/timeout.yml
index a33e115f..3693682e 100644
--- a/spec/if/rtems/status/timeout.yml
+++ b/spec/if/rtems/status/timeout.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that a blocking directive timed out.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that a blocking directive timed out.
-interface-definition:
+definition:
default: '6'
variants: []
-interface-description: null
-interface-name: RTEMS_TIMEOUT
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_TIMEOUT
+notes: null
type: interface
diff --git a/spec/if/rtems/status/too-many.yml b/spec/if/rtems/status/too-many.yml
index 214d94fb..ccdaa6f1 100644
--- a/spec/if/rtems/status/too-many.yml
+++ b/spec/if/rtems/status/too-many.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates you have attempted to create too many instances of
+ a particular object class.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates you have attempted to create too many instances of
- a particular object class.
-interface-definition:
+definition:
default: '5'
variants: []
-interface-description: null
-interface-name: RTEMS_TOO_MANY
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_TOO_MANY
+notes: null
type: interface
diff --git a/spec/if/rtems/status/unsatisfied.yml b/spec/if/rtems/status/unsatisfied.yml
index e702fc15..95d2a3af 100644
--- a/spec/if/rtems/status/unsatisfied.yml
+++ b/spec/if/rtems/status/unsatisfied.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the request was not satisfied.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the request was not satisfied.
-interface-definition:
+definition:
default: '13'
variants: []
-interface-description: null
-interface-name: RTEMS_UNSATISFIED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_UNSATISFIED
+notes: null
type: interface