include/grlib/apbuart.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSDeviceGRLIBAPBUART
0007  *
0008  * @brief This header file defines the APBUART interface.
0009  */
0010
0011 /*
0012  * Copyright (C) 2021 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 /*
0037  * This file is part of the RTEMS quality process and was automatically
0038  * generated.  If you find something that needs to be fixed or
0039  * worded better please post a report or patch to an RTEMS mailing list
0040  * or raise a bug report:
0041  *
0042  * https://www.rtems.org/bugs.html
0043  *
0044  * For information on updating and regenerating please refer to the How-To
0045  * section in the Software Requirements Engineering chapter of the
0046  * RTEMS Software Engineering manual.  The manual is provided as a part of
0047  * a release.  For development sources please refer to the online
0048  * documentation at:
0049  *
0050  * https://docs.rtems.org
0051  */
0052
0053 /* Generated from spec:/dev/grlib/if/apbuart-header-2 */
0054
0055 #ifndef _GRLIB_APBUART_H
0056 #define _GRLIB_APBUART_H
0057
0058 #include <grlib/apbuart-regs.h>
0059
0060 #ifdef __cplusplus
0061 extern "C" {
0062 #endif
0063
0064 /* Generated from spec:/dev/grlib/if/apbuart-inbyte-nonblocking */
0065
0066 /**
0067  * @ingroup RTEMSDeviceGRLIBAPBUART
0068  *
0069  * @brief Clears all errors and tries to get one character from the receiver
0070  *   FIFO.
0071  *
0072  * @param regs is the pointer to the APBUART register block.
0073  *
0074  * @retval -1 The receiver FIFO was empty.
0075  *
0076  * @return Returns the first character of the receiver FIFO if it was
0077  *   non-empty.
0078  */
0079 int apbuart_inbyte_nonblocking( apbuart *regs );
0080
0081 /* Generated from spec:/dev/grlib/if/apbuart-outbyte-polled */
0082
0083 /**
0084  * @ingroup RTEMSDeviceGRLIBAPBUART
0085  *
0086  * @brief Waits until an empty transmitter FIFO was observed and then stores
0087  *   the character to the data register.
0088  *
0089  * @param regs is the pointer to the APBUART register block.
0090  *
0091  * @param ch is the character to output.
0092  */
0093 void apbuart_outbyte_polled( apbuart *regs, char ch );
0094
0095 /* Generated from spec:/dev/grlib/if/apbuart-outbyte-wait */
0096
0097 /**
0098  * @ingroup RTEMSDeviceGRLIBAPBUART
0099  *
0100  * @brief Ensures that at least once an empty transmitter FIFO was observed.
0101  *
0102  * @param regs is the pointer to the APBUART register block.
0103  */
0104 void apbuart_outbyte_wait( const apbuart *regs );
0105
0106 #ifdef __cplusplus
0107 }
0108 #endif
0109
0110 #endif /* _GRLIB_APBUART_H */