validation/bsps/tr-fatal-clock-xil-ttc-irq-install.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup DevClockXilTtcValFatalIrqInstall
0007  */
0008
0009 /*
0010  * Copyright (C) 2024 embedded brains GmbH & Co. KG
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032  */
0033
0034 /*
0035  * This file is part of the RTEMS quality process and was automatically
0036  * generated.  If you find something that needs to be fixed or
0037  * worded better please post a report or patch to an RTEMS mailing list
0038  * or raise a bug report:
0039  *
0040  * https://www.rtems.org/bugs.html
0041  *
0042  * For information on updating and regenerating please refer to the How-To
0043  * section in the Software Requirements Engineering chapter of the
0044  * RTEMS Software Engineering manual.  The manual is provided as a part of
0045  * a release.  For development sources please refer to the online
0046  * documentation at:
0047  *
0048  * https://docs.rtems.org
0049  */
0050
0051 #ifdef HAVE_CONFIG_H
0052 #include "config.h"
0053 #endif
0054
0055 #include <bsp.h>
0056 #include <rtems.h>
0057 #include <bsp/fatal.h>
0058 #include <rtems/sysinit.h>
0059
0060 #include "tr-fatal-clock-xil-ttc-irq-install.h"
0061
0062 #include <rtems/test.h>
0063
0064 /**
0065  * @defgroup DevClockXilTtcValFatalIrqInstall \
0066  *   spec:/dev/clock/xil-ttc/val/fatal-irq-install
0067  *
0068  * @ingroup TestsuitesBspsFatalClockXilTtcIrqInstall
0069  *
0070  * @brief Tests a fatal error.
0071  *
0072  * This test case performs the following actions:
0073  *
0074  * - The test action is carried out by the OccupyClockInterrupt() system
0075  *   initialization handler.
0076  *
0077  *   - Check that the expected fatal source is present.
0078  *
0079  *   - Check that the expected fatal code is present.
0080  *
0081  * @{
0082  */
0083
0084 /**
0085  * @brief Test context for spec:/dev/clock/xil-ttc/val/fatal-irq-install test
0086  *   case.
0087  */
0088 typedef struct {
0089   /**
0090    * @brief This member contains a copy of the corresponding
0091    *   DevClockXilTtcValFatalIrqInstall_Run() parameter.
0092    */
0093   rtems_fatal_source source;
0094
0095   /**
0096    * @brief This member contains a copy of the corresponding
0097    *   DevClockXilTtcValFatalIrqInstall_Run() parameter.
0098    */
0099   rtems_fatal_code code;
0100 } DevClockXilTtcValFatalIrqInstall_Context;
0101
0102 static DevClockXilTtcValFatalIrqInstall_Context
0103   DevClockXilTtcValFatalIrqInstall_Instance;
0104
0105 static void ClockInterrupt( void *arg )
0106 {
0107   (void) arg;
0108 }
0109
0110 static rtems_interrupt_entry interrupt_entry = RTEMS_INTERRUPT_ENTRY_INITIALIZER(
0111   ClockInterrupt,
0112   NULL,
0113   "Clock"
0114 );
0115
0116 static void OccupyClockInterrupt( void )
0117 {
0118   (void) rtems_interrupt_entry_install(
0119     XIL_CLOCK_TTC_IRQ,
0120     RTEMS_INTERRUPT_UNIQUE,
0121     &interrupt_entry
0122   );
0123 }
0124
0125 RTEMS_SYSINIT_ITEM(
0126   OccupyClockInterrupt,
0127   RTEMS_SYSINIT_DEVICE_DRIVERS,
0128   RTEMS_SYSINIT_ORDER_FIRST
0129 );
0130
0131 static T_fixture DevClockXilTtcValFatalIrqInstall_Fixture = {
0132   .setup = NULL,
0133   .stop = NULL,
0134   .teardown = NULL,
0135   .scope = NULL,
0136   .initial_context = &DevClockXilTtcValFatalIrqInstall_Instance
0137 };
0138
0139 /**
0140  * @brief The test action is carried out by the OccupyClockInterrupt() system
0141  *   initialization handler.
0142  */
0143 static void DevClockXilTtcValFatalIrqInstall_Action_0(
0144   DevClockXilTtcValFatalIrqInstall_Context *ctx
0145 )
0146 {
0147   /* Nothing to do */
0148
0149   /*
0150    * Check that the expected fatal source is present.
0151    */
0152   T_step_eq_int( 0, ctx->source, RTEMS_FATAL_SOURCE_BSP );
0153
0154   /*
0155    * Check that the expected fatal code is present.
0156    */
0157   T_step_eq_ulong(
0158     1,
0159     ctx->code,
0160     XIL_FATAL_TTC_IRQ_INSTALL
0161   );
0162 }
0163
0164 void DevClockXilTtcValFatalIrqInstall_Run(
0165   rtems_fatal_source source,
0166   rtems_fatal_code   code
0167 )
0168 {
0169   DevClockXilTtcValFatalIrqInstall_Context *ctx;
0170
0171   ctx = &DevClockXilTtcValFatalIrqInstall_Instance;
0172   ctx->source = source;
0173   ctx->code = code;
0174
0175   ctx = T_case_begin(
0176     "DevClockXilTtcValFatalIrqInstall",
0177     &DevClockXilTtcValFatalIrqInstall_Fixture
0178   );
0179
0180   T_plan( 2 );
0181
0182   DevClockXilTtcValFatalIrqInstall_Action_0( ctx );
0183
0184   T_case_end();
0185 }
0186
0187 /** @} */