dev/serial/zynq-uart.h

0001 /**
0002  * @file
0003  *
0004  * @ingroup RTEMSDeviceSerialZynq
0005  *
0006  * @brief This header file provides Zynq UART Termios driver interfaces.
0007  */
0008
0009 /*
0010  * SPDX-License-Identifier: BSD-2-Clause
0011  *
0012  * Copyright (C) 2013, 2024 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 #ifndef LIBBSP_ARM_XILINX_ZYNQ_UART_H
0037 #define LIBBSP_ARM_XILINX_ZYNQ_UART_H
0038
0039 #include <rtems/termiosdevice.h>
0040
0041 #ifdef __cplusplus
0042 extern "C" {
0043 #endif /* __cplusplus */
0044
0045 /**
0046  * @addtogroup RTEMSDeviceSerialZynq
0047  *
0048  * @{
0049  */
0050
0051 typedef struct {
0052   rtems_termios_device_context base;
0053   volatile struct zynq_uart *regs;
0054   int tx_queued;
0055   bool transmitting;
0056   rtems_vector_number irq;
0057 } zynq_uart_context;
0058
0059 extern const rtems_termios_device_handler zynq_uart_handler;
0060
0061 /** @} */
0062
0063 #ifdef __cplusplus
0064 }
0065 #endif /* __cplusplus */
0066
0067 #endif /* LIBBSP_ARM_XILINX_ZYNQ_UART_H */