RTEMS 6.1-rc1
apbuart.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-2-Clause */
2
11/*
12 * Copyright (C) 2021 embedded brains GmbH & Co. KG
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
34 */
35
36/*
37 * This file is part of the RTEMS quality process and was automatically
38 * generated. If you find something that needs to be fixed or
39 * worded better please post a report or patch to an RTEMS mailing list
40 * or raise a bug report:
41 *
42 * https://www.rtems.org/bugs.html
43 *
44 * For information on updating and regenerating please refer to the How-To
45 * section in the Software Requirements Engineering chapter of the
46 * RTEMS Software Engineering manual. The manual is provided as a part of
47 * a release. For development sources please refer to the online
48 * documentation at:
49 *
50 * https://docs.rtems.org
51 */
52
53/* Generated from spec:/dev/grlib/if/apbuart-header-2 */
54
55#ifndef _GRLIB_APBUART_H
56#define _GRLIB_APBUART_H
57
58#include <grlib/apbuart-regs.h>
59
60#ifdef __cplusplus
61extern "C" {
62#endif
63
64/* Generated from spec:/dev/grlib/if/apbuart-inbyte-nonblocking */
65
80
81/* Generated from spec:/dev/grlib/if/apbuart-outbyte-polled */
82
93void apbuart_outbyte_polled( apbuart *regs, char ch );
94
95/* Generated from spec:/dev/grlib/if/apbuart-outbyte-wait */
96
104void apbuart_outbyte_wait( const apbuart *regs );
105
106#ifdef __cplusplus
107}
108#endif
109
110#endif /* _GRLIB_APBUART_H */
This header file defines the APBUART register block interface.
int apbuart_inbyte_nonblocking(apbuart *regs)
Clears all errors and tries to get one character from the receiver FIFO.
Definition: apbuart_polled.c:56
void apbuart_outbyte_wait(const apbuart *regs)
Ensures that at least once an empty transmitter FIFO was observed.
Definition: apbuart_polled.c:43
void apbuart_outbyte_polled(apbuart *regs, char ch)
Waits until an empty transmitter FIFO was observed and then stores the character to the data register...
Definition: apbuart_polled.c:50
This structure defines the APBUART register block memory map.
Definition: apbuart-regs.h:248