diff options
Diffstat (limited to 'spec/rtems/status')
39 files changed, 817 insertions, 0 deletions
diff --git a/spec/rtems/status/if/already-suspended.yml b/spec/rtems/status/if/already-suspended.yml new file mode 100644 index 00000000..30b0ae3a --- /dev/null +++ b/spec/rtems/status/if/already-suspended.yml @@ -0,0 +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) +definition: + default: '15' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_ALREADY_SUSPENDED +notes: null +type: interface diff --git a/spec/rtems/status/if/called-from-isr.yml b/spec/rtems/status/if/called-from-isr.yml new file mode 100644 index 00000000..6092755a --- /dev/null +++ b/spec/rtems/status/if/called-from-isr.yml @@ -0,0 +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) +definition: + default: '18' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_CALLED_FROM_ISR +notes: null +type: interface diff --git a/spec/rtems/status/if/code-to-errno.yml b/spec/rtems/status/if/code-to-errno.yml new file mode 100644 index 00000000..40547ff4 --- /dev/null +++ b/spec/rtems/status/if/code-to-errno.yml @@ -0,0 +1,74 @@ +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) +definition: + default: + body: null + params: + - ${code:/name} ${.:/params[0]/name} + return: int + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_status_code_to_errno +notes: null +params: +- description: is the status code to map. + dir: null + name: status_code +return: + return: null + return-values: + - description: | + The status code is ${successful:/name}. + value: '0' + - description: | + The status code is ${invalid-number:/name}. + value: EBADF + - description: | + The status code is ${resource-in-use:/name}. + value: EBUSY + - description: | + The status code is ${interrupted:/name}. + value: EINTR + - description: | + The status code is ${invalid-clock:/name}, + ${invalid-name:/name}, or ${invalid-node:/name}. + value: EINVAL + - description: | + 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:/name}. + value: ENODEV + - description: | + The status code is ${no-memory:/name}. + value: ENOMEM + - description: | + The status code is ${not-configured:/name} or + ${not-implemented:/name}. + value: ENOSYS + - description: | + The status code is ${not-owner-of-resource:/name}. + value: EPERM + - description: | + The status code is ${timeout:/name}. + value: ETIMEDOUT +type: interface diff --git a/spec/rtems/status/if/code.yml b/spec/rtems/status/if/code.yml new file mode 100644 index 00000000..36ac265f --- /dev/null +++ b/spec/rtems/status/if/code.yml @@ -0,0 +1,77 @@ +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-type: enum +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +- role: interface-enumerator + uid: successful +- role: interface-enumerator + uid: task-exitted +- role: interface-enumerator + uid: mp-not-configured +- role: interface-enumerator + uid: invalid-name +- role: interface-enumerator + uid: invalid-id +- role: interface-enumerator + uid: too-many +- role: interface-enumerator + uid: timeout +- role: interface-enumerator + uid: object-was-deleted +- role: interface-enumerator + uid: invalid-size +- role: interface-enumerator + uid: invalid-address +- role: interface-enumerator + uid: invalid-number +- role: interface-enumerator + uid: not-defined +- role: interface-enumerator + uid: resource-in-use +- role: interface-enumerator + uid: unsatisfied +- role: interface-enumerator + uid: incorrect-state +- role: interface-enumerator + uid: already-suspended +- role: interface-enumerator + uid: illegal-on-self +- role: interface-enumerator + uid: illegal-on-remote-object +- role: interface-enumerator + uid: called-from-isr +- role: interface-enumerator + uid: invalid-priority +- role: interface-enumerator + uid: invalid-clock +- role: interface-enumerator + uid: invalid-node +- role: interface-enumerator + uid: not-configured +- role: interface-enumerator + uid: not-owner-of-resource +- role: interface-enumerator + uid: not-implemented +- role: interface-enumerator + uid: internal-error +- role: interface-enumerator + uid: no-memory +- role: interface-enumerator + uid: io-error +- role: interface-enumerator + uid: interrupted +- role: interface-enumerator + uid: proxy-blocking +name: rtems_status_code +notes: null +type: interface diff --git a/spec/rtems/status/if/first.yml b/spec/rtems/status/if/first.yml new file mode 100644 index 00000000..5f704e9c --- /dev/null +++ b/spec/rtems/status/if/first.yml @@ -0,0 +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) +definition: + default: ${successful:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_STATUS_CODES_FIRST +notes: null +type: interface diff --git a/spec/rtems/status/if/group.yml b/spec/rtems/status/if/group.yml new file mode 100644 index 00000000..04f0b518 --- /dev/null +++ b/spec/rtems/status/if/group.yml @@ -0,0 +1,18 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This group contains the Classic API status codes and support functions. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: null +enabled-by: true +identifier: RTEMSAPIClassicStatus +interface-type: group +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: ../../if/group +name: Directive Status Codes +text: | + The Classic API shall provide an interface to directive status codes. +type: interface diff --git a/spec/rtems/status/if/header.yml b/spec/rtems/status/if/header.yml new file mode 100644 index 00000000..f3ed7d78 --- /dev/null +++ b/spec/rtems/status/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 status codes provided by 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/status.h +prefix: cpukit/include +type: interface diff --git a/spec/rtems/status/if/illegal-on-remote-object.yml b/spec/rtems/status/if/illegal-on-remote-object.yml new file mode 100644 index 00000000..924c6e16 --- /dev/null +++ b/spec/rtems/status/if/illegal-on-remote-object.yml @@ -0,0 +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) +definition: + default: '17' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_ILLEGAL_ON_REMOTE_OBJECT +notes: null +type: interface diff --git a/spec/rtems/status/if/illegal-on-self.yml b/spec/rtems/status/if/illegal-on-self.yml new file mode 100644 index 00000000..d7479333 --- /dev/null +++ b/spec/rtems/status/if/illegal-on-self.yml @@ -0,0 +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) +definition: + default: '16' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_ILLEGAL_ON_SELF +notes: null +type: interface diff --git a/spec/rtems/status/if/incorrect-state.yml b/spec/rtems/status/if/incorrect-state.yml new file mode 100644 index 00000000..9c30f28b --- /dev/null +++ b/spec/rtems/status/if/incorrect-state.yml @@ -0,0 +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) +definition: + default: '14' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INCORRECT_STATE +notes: null +type: interface diff --git a/spec/rtems/status/if/internal-error.yml b/spec/rtems/status/if/internal-error.yml new file mode 100644 index 00000000..fed91daa --- /dev/null +++ b/spec/rtems/status/if/internal-error.yml @@ -0,0 +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) +definition: + default: '25' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INTERNAL_ERROR +notes: null +type: interface diff --git a/spec/rtems/status/if/interrupted.yml b/spec/rtems/status/if/interrupted.yml new file mode 100644 index 00000000..c79fa7fb --- /dev/null +++ b/spec/rtems/status/if/interrupted.yml @@ -0,0 +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) +definition: + default: '28' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INTERRUPTED +notes: null +type: interface diff --git a/spec/rtems/status/if/invalid-address.yml b/spec/rtems/status/if/invalid-address.yml new file mode 100644 index 00000000..e6cb9212 --- /dev/null +++ b/spec/rtems/status/if/invalid-address.yml @@ -0,0 +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) +definition: + default: '9' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INVALID_ADDRESS +notes: null +type: interface diff --git a/spec/rtems/status/if/invalid-clock.yml b/spec/rtems/status/if/invalid-clock.yml new file mode 100644 index 00000000..6bcd7284 --- /dev/null +++ b/spec/rtems/status/if/invalid-clock.yml @@ -0,0 +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) +definition: + default: '20' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INVALID_CLOCK +notes: null +type: interface diff --git a/spec/rtems/status/if/invalid-id.yml b/spec/rtems/status/if/invalid-id.yml new file mode 100644 index 00000000..d51875ea --- /dev/null +++ b/spec/rtems/status/if/invalid-id.yml @@ -0,0 +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) +definition: + default: '4' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INVALID_ID +notes: null +type: interface diff --git a/spec/rtems/status/if/invalid-name.yml b/spec/rtems/status/if/invalid-name.yml new file mode 100644 index 00000000..980951fb --- /dev/null +++ b/spec/rtems/status/if/invalid-name.yml @@ -0,0 +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) +definition: + default: '3' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INVALID_NAME +notes: null +type: interface diff --git a/spec/rtems/status/if/invalid-node.yml b/spec/rtems/status/if/invalid-node.yml new file mode 100644 index 00000000..98bce397 --- /dev/null +++ b/spec/rtems/status/if/invalid-node.yml @@ -0,0 +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) +definition: + default: '21' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INVALID_NODE +notes: null +type: interface diff --git a/spec/rtems/status/if/invalid-number.yml b/spec/rtems/status/if/invalid-number.yml new file mode 100644 index 00000000..f4c3bd00 --- /dev/null +++ b/spec/rtems/status/if/invalid-number.yml @@ -0,0 +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) +definition: + default: '10' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INVALID_NUMBER +notes: null +type: interface diff --git a/spec/rtems/status/if/invalid-priority.yml b/spec/rtems/status/if/invalid-priority.yml new file mode 100644 index 00000000..4a4dbcb5 --- /dev/null +++ b/spec/rtems/status/if/invalid-priority.yml @@ -0,0 +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) +definition: + default: '19' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INVALID_PRIORITY +notes: null +type: interface diff --git a/spec/rtems/status/if/invalid-size.yml b/spec/rtems/status/if/invalid-size.yml new file mode 100644 index 00000000..fc42cae7 --- /dev/null +++ b/spec/rtems/status/if/invalid-size.yml @@ -0,0 +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) +definition: + default: '8' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_INVALID_SIZE +notes: null +type: interface diff --git a/spec/rtems/status/if/io-error.yml b/spec/rtems/status/if/io-error.yml new file mode 100644 index 00000000..f75a11e6 --- /dev/null +++ b/spec/rtems/status/if/io-error.yml @@ -0,0 +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) +definition: + default: '27' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_IO_ERROR +notes: null +type: interface diff --git a/spec/rtems/status/if/is-equal.yml b/spec/rtems/status/if/is-equal.yml new file mode 100644 index 00000000..b3706501 --- /dev/null +++ b/spec/rtems/status/if/is-equal.yml @@ -0,0 +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) +definition: + default: + body: | + return ${.:/params[0]/name} == ${.:/params[1]/name}; + params: + - ${code:/name} ${.:/params[0]/name} + - ${code:/name} ${.:/params[1]/name} + return: ${/c/if/bool:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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 +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/status/if/is-successful.yml b/spec/rtems/status/if/is-successful.yml new file mode 100644 index 00000000..71dce793 --- /dev/null +++ b/spec/rtems/status/if/is-successful.yml @@ -0,0 +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) +definition: + default: + body: | + return ${.:/params[0]/name} == ${successful:/name}; + params: + - ${code:/name} ${.:/params[0]/name} + return: ${/c/if/bool:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/status/if/last.yml b/spec/rtems/status/if/last.yml new file mode 100644 index 00000000..fdcebffe --- /dev/null +++ b/spec/rtems/status/if/last.yml @@ -0,0 +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) +definition: + default: ${proxy-blocking:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_STATUS_CODES_LAST +notes: null +type: interface diff --git a/spec/rtems/status/if/mp-not-configured.yml b/spec/rtems/status/if/mp-not-configured.yml new file mode 100644 index 00000000..47f3c259 --- /dev/null +++ b/spec/rtems/status/if/mp-not-configured.yml @@ -0,0 +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) +definition: + default: '2' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_MP_NOT_CONFIGURED +notes: null +type: interface diff --git a/spec/rtems/status/if/no-memory.yml b/spec/rtems/status/if/no-memory.yml new file mode 100644 index 00000000..00fbf207 --- /dev/null +++ b/spec/rtems/status/if/no-memory.yml @@ -0,0 +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) +definition: + default: '26' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_NO_MEMORY +notes: null +type: interface diff --git a/spec/rtems/status/if/not-configured.yml b/spec/rtems/status/if/not-configured.yml new file mode 100644 index 00000000..4ab79cb9 --- /dev/null +++ b/spec/rtems/status/if/not-configured.yml @@ -0,0 +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) +definition: + default: '22' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_NOT_CONFIGURED +notes: null +type: interface diff --git a/spec/rtems/status/if/not-defined.yml b/spec/rtems/status/if/not-defined.yml new file mode 100644 index 00000000..8f3b93d6 --- /dev/null +++ b/spec/rtems/status/if/not-defined.yml @@ -0,0 +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) +definition: + default: '11' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_NOT_DEFINED +notes: null +type: interface diff --git a/spec/rtems/status/if/not-implemented.yml b/spec/rtems/status/if/not-implemented.yml new file mode 100644 index 00000000..d344da20 --- /dev/null +++ b/spec/rtems/status/if/not-implemented.yml @@ -0,0 +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) +definition: + default: '24' + variants: [] +description: | + This is a hint that you have stumbled across an opportunity to submit code to + the RTEMS Project. +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_NOT_IMPLEMENTED +notes: null +type: interface diff --git a/spec/rtems/status/if/not-owner-of-resource.yml b/spec/rtems/status/if/not-owner-of-resource.yml new file mode 100644 index 00000000..bd0697c8 --- /dev/null +++ b/spec/rtems/status/if/not-owner-of-resource.yml @@ -0,0 +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) +definition: + default: '23' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_NOT_OWNER_OF_RESOURCE +notes: null +type: interface diff --git a/spec/rtems/status/if/object-was-deleted.yml b/spec/rtems/status/if/object-was-deleted.yml new file mode 100644 index 00000000..56d3035a --- /dev/null +++ b/spec/rtems/status/if/object-was-deleted.yml @@ -0,0 +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) +definition: + default: '7' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_OBJECT_WAS_DELETED +notes: null +type: interface diff --git a/spec/rtems/status/if/proxy-blocking.yml b/spec/rtems/status/if/proxy-blocking.yml new file mode 100644 index 00000000..f588a6e9 --- /dev/null +++ b/spec/rtems/status/if/proxy-blocking.yml @@ -0,0 +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) +definition: + default: '29' + variants: [] +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. +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/rtems/status/if/resource-in-use.yml b/spec/rtems/status/if/resource-in-use.yml new file mode 100644 index 00000000..21d609ed --- /dev/null +++ b/spec/rtems/status/if/resource-in-use.yml @@ -0,0 +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) +definition: + default: '12' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_RESOURCE_IN_USE +notes: null +type: interface diff --git a/spec/rtems/status/if/successful.yml b/spec/rtems/status/if/successful.yml new file mode 100644 index 00000000..93ccda45 --- /dev/null +++ b/spec/rtems/status/if/successful.yml @@ -0,0 +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) +definition: + default: '0' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_SUCCESSFUL +notes: null +type: interface diff --git a/spec/rtems/status/if/task-exitted.yml b/spec/rtems/status/if/task-exitted.yml new file mode 100644 index 00000000..30e0df9c --- /dev/null +++ b/spec/rtems/status/if/task-exitted.yml @@ -0,0 +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) +definition: + default: '1' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_TASK_EXITTED +notes: null +type: interface diff --git a/spec/rtems/status/if/text.yml b/spec/rtems/status/if/text.yml new file mode 100644 index 00000000..6e0c9e49 --- /dev/null +++ b/spec/rtems/status/if/text.yml @@ -0,0 +1,32 @@ +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) +definition: + default: + body: null + params: + - ${code:/name} ${.:/params[0]/name} + return: const char * + variants: [] +description: | + The text for each status code is the enumerator constant. +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_status_text +notes: null +params: +- description: is the status code. + dir: null + name: status_code +return: + return: Otherwise, a text describing the status code. + return-values: + - description: The passed status code is invalid. + value: '"?"' +type: interface diff --git a/spec/rtems/status/if/timeout.yml b/spec/rtems/status/if/timeout.yml new file mode 100644 index 00000000..3693682e --- /dev/null +++ b/spec/rtems/status/if/timeout.yml @@ -0,0 +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) +definition: + default: '6' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_TIMEOUT +notes: null +type: interface diff --git a/spec/rtems/status/if/too-many.yml b/spec/rtems/status/if/too-many.yml new file mode 100644 index 00000000..ccdaa6f1 --- /dev/null +++ b/spec/rtems/status/if/too-many.yml @@ -0,0 +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) +definition: + default: '5' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_TOO_MANY +notes: null +type: interface diff --git a/spec/rtems/status/if/unsatisfied.yml b/spec/rtems/status/if/unsatisfied.yml new file mode 100644 index 00000000..95d2a3af --- /dev/null +++ b/spec/rtems/status/if/unsatisfied.yml @@ -0,0 +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) +definition: + default: '13' + variants: [] +description: null +enabled-by: true +interface-type: enumerator +links: [] +name: RTEMS_UNSATISFIED +notes: null +type: interface |