include/bsp/ecc_priv.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsAArch64XilinxZynqMP
0007  *
0008  * @brief This header file provides internal APIs for managing ECC events.
0009  */
0010
0011 /*
0012  * Copyright (C) 2024 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_ECC_PRIV_H
0038 #define LIBBSP_AARCH64_XILINX_ZYNQMP_BSP_ECC_PRIV_H
0039
0040 /**
0041  * @addtogroup RTEMSBSPsAArch64
0042  *
0043  * @{
0044  */
0045
0046 #include <bspopts.h>
0047
0048 #ifndef ASM
0049
0050 #include <rtems.h>
0051
0052 #ifdef __cplusplus
0053 extern "C" {
0054 #endif /* __cplusplus */
0055
0056 #include <bsp/ecc.h>
0057
0058 /**
0059  * @brief Initialize ECC reporting support
0060  *
0061  * This initializes the base ECC event reporting support for the platform.
0062  */
0063 void zynqmp_ecc_init( void );
0064
0065 /**
0066  * @brief Initialize BSP-specific ECC reporting
0067  *
0068  * Various BSPs may have different ECC capabilities. This allows those BSPs to
0069  * initialize those facilities as necessary.
0070  */
0071 void zynqmp_ecc_init_bsp( void );
0072
0073 /**
0074  * @brief Configure Cache ECC reporting
0075  */
0076 rtems_status_code zynqmp_configure_cache_ecc( void );
0077
0078 /**
0079  * @brief Configure On-Chip Memory (OCM) ECC reporting
0080  */
0081 rtems_status_code zynqmp_configure_ocm_ecc( void );
0082
0083 /**
0084  * @brief Configure DDR Memory ECC reporting
0085  */
0086 rtems_status_code zynqmp_configure_ddr_ecc( void );
0087
0088 /**
0089  * @brief Invoke the ECC error handler
0090  *
0091  * @param event The ECC error event type to be raised
0092  * @param data The details associated with the raised ECC error
0093  */
0094 void zynqmp_invoke_ecc_handler( ECC_Event_Type event, void *data );
0095
0096 #ifdef __cplusplus
0097 }
0098 #endif /* __cplusplus */
0099
0100 #endif /* ASM */
0101
0102 /** @} */
0103
0104 #endif /* LIBBSP_AARCH64_XILINX_ZYNQMP_BSP_ECC_PRIV_H */