[rtems-central commit] spec: Add APBUART functions

[Sebastian Huber]

Module:    rtems-central
Branch:    master
Commit:    24eb00e9ee9535c25a63e16af8d114dd44314d95
Changeset: http://git.rtems.org/rtems-central/commit/?id=24eb00e9ee9535c25a63e16af8d114dd44314d95

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Thu Jul 15 19:00:16 2021 +0200

spec: Add APBUART functions

---

 spec/dev/grlib/if/apbuart-header-2.yml       | 16 ++++++++++++
 spec/dev/grlib/if/apbuart-inbyte-polled.yml  | 37 ++++++++++++++++++++++++++
 spec/dev/grlib/if/apbuart-outbyte-polled.yml | 39 ++++++++++++++++++++++++++++
 spec/dev/grlib/if/apbuart-outbyte-wait.yml   | 33 +++++++++++++++++++++++
 4 files changed, 125 insertions(+)

diff --git a/spec/dev/grlib/if/apbuart-header-2.yml b/spec/dev/grlib/if/apbuart-header-2.yml
new file mode 100644
index 0000000..d7427a9
--- /dev/null
+++ b/spec/dev/grlib/if/apbuart-header-2.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This header file defines the APBUART interface.
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+index-entries: []
+interface-type: header-file
+links:
+- role: interface-placement
+  uid: /if/domain
+- role: interface-ingroup
+  uid: apbuart
+path: grlib/apbuart.h
+prefix: bsps/include
+type: interface
diff --git a/spec/dev/grlib/if/apbuart-inbyte-polled.yml b/spec/dev/grlib/if/apbuart-inbyte-polled.yml
new file mode 100644
index 0000000..408825d
--- /dev/null
+++ b/spec/dev/grlib/if/apbuart-inbyte-polled.yml
@@ -0,0 +1,37 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  Clears all errors and tries to get one character from the receiver FIFO.
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default:
+    attributes: null
+    body: null
+    params:
+    - ${apbuart:/name} *${.:/params[0]/name}
+    return: int
+  variants: []
+description: null
+enabled-by: true
+index-entries: []
+interface-type: function
+links:
+- role: interface-placement
+  uid: apbuart-header-2
+- role: interface-ingroup
+  uid: apbuart
+name: apbuart_inbyte_nonblocking
+notes: null
+params:
+- description: |
+    is the pointer to the APBUART register block.
+  dir: null
+  name: regs
+return:
+  return: |
+    Returns the first character of the receiver FIFO if it was non-empty.
+  return-values:
+  - description: |
+      The receiver FIFO was empty.
+    value: '-1'
+type: interface
diff --git a/spec/dev/grlib/if/apbuart-outbyte-polled.yml b/spec/dev/grlib/if/apbuart-outbyte-polled.yml
new file mode 100644
index 0000000..60c9457
--- /dev/null
+++ b/spec/dev/grlib/if/apbuart-outbyte-polled.yml
@@ -0,0 +1,39 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  Waits until an empty transmitter FIFO was observed and then stores the
+  character to the data register.
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default:
+    attributes: null
+    body: null
+    params:
+    - ${apbuart:/name} *${.:/params[0]/name}
+    - char ${.:/params[1]/name}
+    return: void
+  variants: []
+description: null
+enabled-by: true
+index-entries: []
+interface-type: function
+links:
+- role: interface-placement
+  uid: apbuart-header-2
+- role: interface-ingroup
+  uid: apbuart
+name: apbuart_outbyte_polled
+notes: null
+params:
+- description: |
+    is the pointer to the APBUART register block.
+  dir: null
+  name: regs
+- description: |
+    is the character to output.
+  dir: null
+  name: ch
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/dev/grlib/if/apbuart-outbyte-wait.yml b/spec/dev/grlib/if/apbuart-outbyte-wait.yml
new file mode 100644
index 0000000..7346158
--- /dev/null
+++ b/spec/dev/grlib/if/apbuart-outbyte-wait.yml
@@ -0,0 +1,33 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  Ensures that at least once an empty transmitter FIFO was observed.
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default:
+    attributes: null
+    body: null
+    params:
+    - const ${apbuart:/name} *${.:/params[0]/name}
+    return: void
+  variants: []
+description: null
+enabled-by: true
+index-entries: []
+interface-type: function
+links:
+- role: interface-placement
+  uid: apbuart-header-2
+- role: interface-ingroup
+  uid: apbuart
+name: apbuart_outbyte_wait
+notes: null
+params:
+- description: |
+    is the pointer to the APBUART register block.
+  dir: null
+  name: regs
+return:
+  return: null
+  return-values: []
+type: interface