diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-07-15 19:00:16 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-07-21 16:27:58 +0200 |
commit | 24eb00e9ee9535c25a63e16af8d114dd44314d95 (patch) | |
tree | 6814397bd64a4f8c176c6095dfd5462e33ac0a75 | |
parent | spec: Add grlib register load/store (diff) | |
download | rtems-central-24eb00e9ee9535c25a63e16af8d114dd44314d95.tar.bz2 |
spec: Add APBUART functions
-rw-r--r-- | spec/dev/grlib/if/apbuart-header-2.yml | 16 | ||||
-rw-r--r-- | spec/dev/grlib/if/apbuart-inbyte-polled.yml | 37 | ||||
-rw-r--r-- | spec/dev/grlib/if/apbuart-outbyte-polled.yml | 39 | ||||
-rw-r--r-- | spec/dev/grlib/if/apbuart-outbyte-wait.yml | 33 |
4 files changed, 125 insertions, 0 deletions
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 00000000..d7427a94 --- /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 00000000..408825d7 --- /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 00000000..60c9457c --- /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 00000000..7346158d --- /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 |