testsuites/validation/tc-dev-clock-xil-ttc.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup DevClockXilTtcValTickCatchUp
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 <rtems.h>
0056 #include <sys/time.h>
0057
0058 #include <rtems/test.h>
0059
0060 /**
0061  * @defgroup DevClockXilTtcValTickCatchUp \
0062  *   spec:/dev/clock/xil-ttc/val/tick-catch-up
0063  *
0064  * @ingroup TestsuitesBspsValidationBsp0
0065  *
0066  * @brief Tests some Xilinx TTC clock driver functions.
0067  *
0068  * This test case performs the following actions:
0069  *
0070  * - Synchronize with the clock tick.  Disable interrupts.  Busy wait three
0071  *   clock tick intervals.  Enable interrupts.
0072  *
0073  *   - Check that exactly three clock ticks happened once interrupts are
0074  *     enabled again.
0075  *
0076  * @{
0077  */
0078
0079 /**
0080  * @brief Synchronize with the clock tick.  Disable interrupts.  Busy wait
0081  *   three clock tick intervals.  Enable interrupts.
0082  */
0083 static void DevClockXilTtcValTickCatchUp_Action_0( void )
0084 {
0085   uint32_t              ns_per_tick;
0086   uint64_t              three_ticks_interval;
0087   rtems_interrupt_level level;
0088   rtems_interval        t_0;
0089   rtems_interval        t_1;
0090   rtems_interval        t_2;
0091   uint64_t              m_0;
0092   uint64_t              m_1;
0093
0094   ns_per_tick = rtems_configuration_get_nanoseconds_per_tick();
0095   three_ticks_interval = ( 7 * (uint64_t) nstosbt( ns_per_tick ) ) / 2;
0096   t_0 = rtems_clock_get_ticks_since_boot();
0097
0098   /* Synchronize with clock tick */
0099   do {
0100     t_1 = rtems_clock_get_ticks_since_boot();
0101     m_0 = (uint64_t) rtems_clock_get_monotonic_sbintime();
0102   } while ( t_0 == t_1 );
0103
0104   rtems_interrupt_local_disable( level );
0105
0106   do {
0107     m_1 = (uint64_t) rtems_clock_get_monotonic_sbintime();
0108   } while ( m_1 - m_0 <= three_ticks_interval );
0109
0110   rtems_interrupt_local_enable( level );
0111
0112   /*
0113    * Make sure the clock interrupt was serviced after the interrupt enable.
0114    */
0115   do {
0116     t_2 = rtems_clock_get_ticks_since_boot();
0117   } while ( t_1 == t_2 );
0118
0119   /*
0120    * Check that exactly three clock ticks happened once interrupts are enabled
0121    * again.
0122    */
0123   T_step_eq_u32( 0, t_2 - t_1, 3 );
0124 }
0125
0126 /**
0127  * @fn void T_case_body_DevClockXilTtcValTickCatchUp( void )
0128  */
0129 T_TEST_CASE( DevClockXilTtcValTickCatchUp )
0130 {
0131   T_plan( 1 );
0132
0133   DevClockXilTtcValTickCatchUp_Action_0();
0134 }
0135
0136 /** @} */