testsuites/validation/tc-clock.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RtemsClockValClock
0007  */
0008
0009 /*
0010  * Copyright (C) 2021, 2022 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
0057 #include "ts-config.h"
0058 #include "tx-support.h"
0059
0060 #include <rtems/test.h>
0061
0062 /**
0063  * @defgroup RtemsClockValClock spec:/rtems/clock/val/clock
0064  *
0065  * @ingroup TestsuitesValidationNoClock0
0066  *
0067  * @brief Tests some @ref RTEMSAPIClassicClock directives.
0068  *
0069  * This test case performs the following actions:
0070  *
0071  * - Use the rtems_clock_get_ticks_since_boot() directive before and after
0072  *   exactly one clock tick.
0073  *
0074  *   - Check that clock tick gets incremented.
0075  *
0076  * - Use the rtems_clock_get_ticks_since_boot() directive before and after
0077  *   exactly one clock tick.
0078  *
0079  *   - Check that clock tick gets incremented.
0080  *
0081  * - Use the rtems_clock_get_ticks_per_second() directive.
0082  *
0083  *   - Check that rtems_clock_get_ticks_per_second() actually returns 1us /
0084  *     CONFIGURE_MICROSECONDS_PER_TICK.
0085  *
0086  * - Use the rtems_clock_get_ticks_per_second() directive.
0087  *
0088  *   - Check that rtems_clock_get_ticks_per_second() actually returns 1us /
0089  *     CONFIGURE_MICROSECONDS_PER_TICK.
0090  *
0091  * @{
0092  */
0093
0094 /**
0095  * @brief Use the rtems_clock_get_ticks_since_boot() directive before and after
0096  *   exactly one clock tick.
0097  */
0098 static void RtemsClockValClock_Action_0( void )
0099 {
0100   rtems_interval result_0;
0101   rtems_interval result_1;
0102
0103   result_0 = rtems_clock_get_ticks_since_boot();
0104   ClockTick();
0105   result_1 = rtems_clock_get_ticks_since_boot();
0106
0107   /*
0108    * Check that clock tick gets incremented.
0109    */
0110   T_step_eq_u32( 0, result_1 - result_0, 1 );
0111 }
0112
0113 /**
0114  * @brief Use the rtems_clock_get_ticks_since_boot() directive before and after
0115  *   exactly one clock tick.
0116  */
0117 static void RtemsClockValClock_Action_1( void )
0118 {
0119   rtems_interval result_0;
0120   rtems_interval result_1;
0121
0122   #undef rtems_clock_get_ticks_since_boot
0123
0124   result_0 = rtems_clock_get_ticks_since_boot();
0125   ClockTick();
0126   result_1 = rtems_clock_get_ticks_since_boot();
0127
0128   /*
0129    * Check that clock tick gets incremented.
0130    */
0131   T_step_eq_u32( 1, result_1 - result_0, 1 );
0132 }
0133
0134 /**
0135  * @brief Use the rtems_clock_get_ticks_per_second() directive.
0136  */
0137 static void RtemsClockValClock_Action_2( void )
0138 {
0139   rtems_interval result;
0140
0141   result = rtems_clock_get_ticks_per_second();
0142
0143   /*
0144    * Check that rtems_clock_get_ticks_per_second() actually returns 1us /
0145    * CONFIGURE_MICROSECONDS_PER_TICK.
0146    */
0147   T_step_eq_u32( 2, result, 1000000UL / TEST_MICROSECONDS_PER_TICK );
0148 }
0149
0150 /**
0151  * @brief Use the rtems_clock_get_ticks_per_second() directive.
0152  */
0153 static void RtemsClockValClock_Action_3( void )
0154 {
0155   rtems_interval result;
0156
0157   #undef rtems_clock_get_ticks_per_second
0158
0159   result = rtems_clock_get_ticks_per_second();
0160
0161   /*
0162    * Check that rtems_clock_get_ticks_per_second() actually returns 1us /
0163    * CONFIGURE_MICROSECONDS_PER_TICK.
0164    */
0165   T_step_eq_u32( 3, result, 1000000UL / TEST_MICROSECONDS_PER_TICK );
0166 }
0167
0168 /**
0169  * @fn void T_case_body_RtemsClockValClock( void )
0170  */
0171 T_TEST_CASE( RtemsClockValClock )
0172 {
0173   T_plan( 4 );
0174
0175   RtemsClockValClock_Action_0();
0176   RtemsClockValClock_Action_1();
0177   RtemsClockValClock_Action_2();
0178   RtemsClockValClock_Action_3();
0179 }
0180
0181 /** @} */