include/bsp/raspberrypi-uart.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsAArch64RaspberryPi
0007  *
0008  * @brief Raspberry Pi 4B Console Device Definitions
0009  */
0010
0011 /*
0012  * Copyright (C) 2023 Utkarsh Verma
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_AARCH64_RASPBERRYPI_BSP_RASPBERRYPI_UART_H
0037 #define LIBBSP_AARCH64_RASPBERRYPI_BSP_RASPBERRYPI_UART_H
0038
0039 #include <bspopts.h>
0040 #include <bsp/irq.h>
0041 #include <bsp/raspberrypi.h>
0042 #include <bsp/rpi-gpio.h>
0043 #include <dev/serial/arm-pl011.h>
0044
0045 /*
0046  * This macro exists to serve as a common point of definition for the
0047  * parameters of the UARTs present in the Raspberry Pi 4. It is used in
0048  * multiple locations with different rendering macros to prevent duplication
0049  * of information.
0050  */
0051 #define RASPBERRYPI_CONSOLE_DEVICES(CONSOLE_DEVICE_DEFINITION_RENDERER) \
0052     CONSOLE_DEVICE_DEFINITION_RENDERER( \
0053       0, "/dev/ttyAMA0", BCM2711_UART0_BASE,BCM2711_UART0_SIZE, \
0054       BSP_PL011_CLOCK_FREQ, BCM2711_IRQ_PL011_UART, arm_pl011_context, \
0055       &arm_pl011_fns, arm_pl011_write_polled, 15, 14, GPIO_AF0) \
0056     CONSOLE_DEVICE_DEFINITION_RENDERER( \
0057       2, "/dev/ttyAMA1", BCM2711_UART2_BASE, BCM2711_UART2_SIZE, \
0058       BSP_PL011_CLOCK_FREQ, BCM2711_IRQ_PL011_UART, arm_pl011_context, \
0059       &arm_pl011_fns, arm_pl011_write_polled, 1, 0, GPIO_AF4) \
0060     CONSOLE_DEVICE_DEFINITION_RENDERER( \
0061       3, "/dev/ttyAMA2", BCM2711_UART3_BASE, BCM2711_UART3_SIZE, \
0062       BSP_PL011_CLOCK_FREQ, BCM2711_IRQ_PL011_UART, arm_pl011_context, \
0063       &arm_pl011_fns, arm_pl011_write_polled, 5, 4, GPIO_AF4) \
0064     CONSOLE_DEVICE_DEFINITION_RENDERER( \
0065       4, "/dev/ttyAMA3", BCM2711_UART4_BASE, BCM2711_UART4_SIZE, \
0066       BSP_PL011_CLOCK_FREQ, BCM2711_IRQ_PL011_UART, arm_pl011_context, \
0067       &arm_pl011_fns, arm_pl011_write_polled, 9, 8, GPIO_AF4) \
0068     CONSOLE_DEVICE_DEFINITION_RENDERER( \
0069      5, "/dev/ttyAMA4", BCM2711_UART5_BASE, BCM2711_UART5_SIZE, \
0070       BSP_PL011_CLOCK_FREQ, BCM2711_IRQ_PL011_UART, arm_pl011_context, \
0071       &arm_pl011_fns, arm_pl011_write_polled, 13, 12, GPIO_AF4)
0072 #endif /* LIBBSP_AARCH64_RASPBERRYPI_BSP_RASPBERRYPI_UART_H */