include/bsp/console.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsAArch64RaspberryPi
0007  *
0008  * @brief Console Configuration
0009  */
0010
0011 /*
0012  * Copyright (C) 2023 Utkarsh Verma
0013  * Copyright (C) 2024 Ning Yang
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef LIBBSP_AARCH64_RASPBERRYPI_BSP_CONSOLE_H
0038 #define LIBBSP_AARCH64_RASPBERRYPI_BSP_CONSOLE_H
0039
0040 #include <bspopts.h>
0041 #include <bsp/raspberrypi-uart.h>
0042
0043 #define CONSOLE_DEVICES RASPBERRYPI_CONSOLE_DEVICES
0044
0045 #define CONSOLE_DEVICE_PORT2ENUM(port_no) UART##port_no
0046 #define CONSOLE_DEVICE_ENUM(port_no, ...) CONSOLE_DEVICE_PORT2ENUM(port_no),
0047
0048 typedef enum {
0049   CONSOLE_DEVICES(CONSOLE_DEVICE_ENUM)
0050   CONSOLE_DEVICE_COUNT,
0051 } raspberrypi_console_device_port;
0052
0053 /**
0054  * @brief Initialize gpio of UART and install UART to the dev directory.
0055  *
0056  * @param uart_num The optional devices are UART0, UART2, UART3, UART4, UART5.
0057  *
0058  * @retval RTEMS_SUCCESSFUL Successful operation.
0059  * @retval RTEMS_INVALID_NUMBER This status code indicates that a specified
0060  *         number was invalid.
0061  * @retval RTEMS_NO_MEMORY Not enough memory to create a device node.
0062  * @retval RTEMS_UNSATISFIED Creation of the device file failed.
0063  * @retval RTEMS_INCORRECT_STATE Termios is not initialized.
0064  */
0065 rtems_status_code raspberrypi_uart_init(
0066   raspberrypi_console_device_port uart_num
0067 );
0068
0069 #undef CONSOLE_DEVICE_ENUM
0070
0071 #endif /* LIBBSP_AARCH64_RASPBERRYPI_BSP_CONSOLE_H */