include/bsp/uart-bridge.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsPowerPCQorIQUartBridge
0007  *
0008  * @brief UART to Intercom bridge API.
0009  */
0010
0011 /*
0012  * Copyright (C) 2011, 2015 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_POWERPC_QORIQ_UART_BRIDGE_H
0037 #define LIBBSP_POWERPC_QORIQ_UART_BRIDGE_H
0038
0039 #include <rtems/termiosdevice.h>
0040
0041 #include <bsp/intercom.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif /* __cplusplus */
0046
0047 /**
0048  * @defgroup QorIQUartBridge QorIQ - UART to Intercom Bridge Support
0049  *
0050  * @ingroup RTEMSBSPsPowerPCQorIQ
0051  *
0052  * @brief UART to Intercom bridge support.
0053  *
0054  * @{
0055  */
0056
0057 typedef struct {
0058   rtems_termios_device_context base;
0059   const char *device_path;
0060   intercom_type type;
0061   rtems_id transmit_task;
0062   rtems_chain_control transmit_fifo;
0063 } uart_bridge_master_context;
0064
0065 typedef struct {
0066   rtems_termios_device_context base;
0067   struct rtems_termios_tty *tty;
0068   intercom_type type;
0069   rtems_id transmit_task;
0070   rtems_chain_control transmit_fifo;
0071 } uart_bridge_slave_context;
0072
0073 bool qoriq_uart_bridge_master_probe(rtems_termios_device_context *base);
0074
0075 extern const rtems_termios_device_handler qoriq_uart_bridge_master;
0076
0077 extern const rtems_termios_device_handler qoriq_uart_bridge_slave;
0078
0079 /** @} */
0080
0081 #ifdef __cplusplus
0082 }
0083 #endif /* __cplusplus */
0084
0085 #endif /* LIBBSP_POWERPC_QORIQ_UART_BRIDGE_H */