include/bsp/tms570-sci-driver.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsARMTMS570
0007  *
0008  * @brief This header file provides interfaces of the SCI support.
0009  */
0010
0011 /*
0012  * Copyright (C) 2014 Premysl Houdek <kom541000@gmail.com>
0013  *
0014  * Google Summer of Code 2014 at
0015  * Czech Technical University in Prague
0016  * Zikova 1903/4
0017  * 166 36 Praha 6
0018  * Czech Republic
0019  *
0020  * Redistribution and use in source and binary forms, with or without
0021  * modification, are permitted provided that the following conditions
0022  * are met:
0023  * 1. Redistributions of source code must retain the above copyright
0024  *    notice, this list of conditions and the following disclaimer.
0025  * 2. Redistributions in binary form must reproduce the above copyright
0026  *    notice, this list of conditions and the following disclaimer in the
0027  *    documentation and/or other materials provided with the distribution.
0028  *
0029  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0030  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0031  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0032  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0033  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0034  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0035  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0036  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0037  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0038  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0039  * POSSIBILITY OF SUCH DAMAGE.
0040  */
0041
0042 #ifndef TMS570_SCI_DRIVER
0043 #define TMS570_SCI_DRIVER
0044
0045 #include <rtems/termiostypes.h>
0046 #include <rtems/irq.h>
0047 #include <bsp/tms570.h>
0048
0049 #ifdef __cplusplus
0050 extern "C" {
0051 #endif /* __cplusplus */
0052
0053 /* Low-level driver specific data structure */
0054 typedef struct {
0055   rtems_termios_device_context base;
0056   const char *device_name;
0057   volatile tms570_sci_t *regs;
0058   int tx_chars_in_hw;
0059   rtems_vector_number irq;
0060 } tms570_sci_context;
0061
0062 extern const rtems_termios_device_handler tms570_sci_handler_polled;
0063
0064 extern const rtems_termios_device_handler tms570_sci_handler_interrupt;
0065
0066 extern tms570_sci_context driver_context_table[];
0067
0068 void tms570_sci_initialize(tms570_sci_context *ctx);
0069
0070 bool tms570_sci_set_attributes(
0071   rtems_termios_device_context *base,
0072   const struct termios *term
0073 );
0074
0075 /** @} */
0076
0077 #ifdef __cplusplus
0078 }
0079 #endif /* __cplusplus */
0080
0081 #endif /* TMS570_SCI_DRIVER */