include/grlib/cons.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*  Console driver interface to UART drivers
0004  *
0005  *  - First console device that has System Console flag set will be
0006  *    system console.
0007  *  - If none of the registered console devices has system console set,
0008  *    the first is registered device is used, unless it has
0009  *
0010  *  COPYRIGHT (c) 2010.
0011  *  Cobham Gaisler AB.
0012  *
0013  * Redistribution and use in source and binary forms, with or without
0014  * modification, are permitted provided that the following conditions
0015  * are met:
0016  * 1. Redistributions of source code must retain the above copyright
0017  *    notice, this list of conditions and the following disclaimer.
0018  * 2. Redistributions in binary form must reproduce the above copyright
0019  *    notice, this list of conditions and the following disclaimer in the
0020  *    documentation and/or other materials provided with the distribution.
0021  *
0022  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0023  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0024  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0025  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0026  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0027  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0028  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0029  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0030  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0031  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0032  * POSSIBILITY OF SUCH DAMAGE.
0033  */
0034
0035 #ifndef __CONS_H__
0036 #define __CONS_H__
0037
0038 #include <rtems/termiostypes.h>
0039
0040 struct console_dev;
0041
0042 #define CONSOLE_FLAG_SYSCON             0x01
0043 #define CONSOLE_FLAG_SYSCON_GRANT       0x02
0044
0045 struct console_dev {
0046     rtems_termios_device_context base;
0047     /* Set CONSOLE_FLAG_SYSCON to request this device to be system console
0048      * and/or debug console. CONSOLE_FLAG_SYSCON_GRANT will be set on the
0049      * device which was selected as system console.
0050      */
0051     int flags;
0052     char *fsname; /* File system prefix */
0053     const rtems_termios_device_handler *handler;
0054 };
0055
0056 extern void console_dev_register(struct console_dev *dev);
0057 #if 0
0058 extern void console_dev_unregister(struct console_dev *dev);
0059 #endif
0060
0061 #endif