xilinx-zynqmp/include/bsp.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsAArch64XilinxZynqMP
0007  *
0008  * @brief This header file provides BSP-specific interfaces.
0009  */
0010
0011 /*
0012  * Copyright (C) 2020 On-Line Applications Research Corporation (OAR)
0013  * Written by Kinsey Moore <kinsey.moore@oarcorp.com>
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_XILINX_ZYNQMP_BSP_H
0038 #define LIBBSP_AARCH64_XILINX_ZYNQMP_BSP_H
0039
0040 #include <bspopts.h>
0041
0042 #define BSP_FEATURE_IRQ_EXTENSION
0043
0044 #define BSP_RESET_SMC
0045
0046 #define BSP_CPU_ON_USES_SMC
0047
0048 #ifndef ASM
0049
0050 #include <bsp/default-initial-extension.h>
0051 #include <bsp/start.h>
0052
0053 #include <rtems.h>
0054
0055 #include <dev/serial/zynq-uart-zynqmp.h>
0056
0057 #ifdef __cplusplus
0058 extern "C" {
0059 #endif /* __cplusplus */
0060
0061 struct rtems_termios_device_context;
0062
0063 /**
0064  * @defgroup RTEMSBSPsAArch64XilinxZynqMP \
0065  *   AMD Zynq UltraScale+ MPSoC and RFSoC - Application Processing Unit
0066  *
0067  * @ingroup RTEMSBSPsAArch64
0068  *
0069  * @brief This group contains the BSP for the Application Processing Unit (APU)
0070  *   contained in AMD Zynq UltraScale+ MPSoC and RFSoC devices.
0071  *
0072  * @{
0073  */
0074
0075 /*
0076  * DDRMC mapping
0077  */
0078 LINKER_SYMBOL(bsp_r0_ram_base)
0079 LINKER_SYMBOL(bsp_r0_ram_end)
0080 LINKER_SYMBOL(bsp_r1_ram_base)
0081 LINKER_SYMBOL(bsp_r1_ram_end)
0082
0083 #define BSP_ARM_GIC_CPUIF_BASE 0xf9020000
0084 #define BSP_ARM_GIC_DIST_BASE 0xf9010000
0085
0086 #define BSP_FDT_IS_SUPPORTED
0087 extern unsigned int zynqmp_dtb_len;
0088 extern unsigned char zynqmp_dtb[];
0089
0090 #define NANDPSU_BASEADDR 0xFF100000
0091
0092 /**
0093  * @brief Zynq UltraScale+ MPSoC specific set up of the MMU.
0094  *
0095  * Provide in the application to override the defaults in the BSP.
0096  */
0097 BSP_START_TEXT_SECTION void zynqmp_setup_mmu_and_cache(void);
0098
0099 /**
0100  * @brief Zynq UltraScale+ MPSoC specific set up of the MMU for non-primary
0101  * cores.
0102  *
0103  * Provide in the application to override the defaults in the BSP.
0104  */
0105 BSP_START_TEXT_SECTION void zynqmp_setup_secondary_cpu_mmu_and_cache( void );
0106
0107 void zynqmp_management_console_termios_init(void);
0108
0109 void zynqmp_debug_console_flush(void);
0110
0111 uint32_t zynqmp_clock_i2c0(void);
0112
0113 uint32_t zynqmp_clock_i2c1(void);
0114
0115 /**
0116  * @brief Zynq UltraScale+ MPSoC specific set up of a management console.
0117  *
0118  * Some systems may have a management interface which needs special
0119  * initialization. Provide in the application to override the defaults in the
0120  * BSP. This will only be called if the interface is found in the device tree.
0121  */
0122 void zynqmp_configure_management_console(
0123   struct rtems_termios_device_context *base
0124 );
0125
0126 /** @} */
0127
0128 #ifdef __cplusplus
0129 }
0130 #endif /* __cplusplus */
0131
0132 #endif /* ASM */
0133
0134 #endif /* LIBBSP_AARCH64_XILINX_ZYNQMP_BSP_H */