diff options
author | Frank Kühndel <frank.kuehndel@embedded-brains.de> | 2021-12-09 16:17:07 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2022-03-24 11:10:49 +0100 |
commit | 565a7e6654f31087ff1c9572fd8df5c79661856a (patch) | |
tree | 1698fa1270fd74339a8e4037543141297b232c26 | |
parent | 6b2939048464c0d282fd7eb491fa9f3e24b02e84 (diff) |
validation: Test Timer Manager
The test source code is generated from specification items
by the "./spec2modules.py" script contained in the
git://git.rtems.org/rtems-central.git Git repository.
Please read the "How-To" section in the "Software Requirements Engineering"
chapter of the RTEMS Software Engineering manual to get more information about
the process.
Update #3716.
-rw-r--r-- | spec/build/testsuites/validation/validation-no-clock-0.yml | 11 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-cancel.c | 813 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-create.c | 535 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-delete.c | 362 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-fire-after.c | 1162 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-fire-when.c | 1286 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-ident.c | 114 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-initiate-server.c | 817 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-reset.c | 1058 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-server-fire-after.c | 1301 | ||||
-rw-r--r-- | testsuites/validation/tc-timer-server-fire-when.c | 1417 | ||||
-rw-r--r-- | testsuites/validation/tc-timer.c | 208 |
12 files changed, 9084 insertions, 0 deletions
diff --git a/spec/build/testsuites/validation/validation-no-clock-0.yml b/spec/build/testsuites/validation/validation-no-clock-0.yml index 1e05048e7e..66113c4390 100644 --- a/spec/build/testsuites/validation/validation-no-clock-0.yml +++ b/spec/build/testsuites/validation/validation-no-clock-0.yml @@ -93,6 +93,17 @@ source: - testsuites/validation/tc-task-suspend.c - testsuites/validation/tc-task-wake-after.c - testsuites/validation/tc-task-wake-when.c +- testsuites/validation/tc-timer.c +- testsuites/validation/tc-timer-cancel.c +- testsuites/validation/tc-timer-create.c +- testsuites/validation/tc-timer-delete.c +- testsuites/validation/tc-timer-fire-after.c +- testsuites/validation/tc-timer-fire-when.c +- testsuites/validation/tc-timer-ident.c +- testsuites/validation/tc-timer-initiate-server.c +- testsuites/validation/tc-timer-reset.c +- testsuites/validation/tc-timer-server-fire-after.c +- testsuites/validation/tc-timer-server-fire-when.c - testsuites/validation/tr-event-constant.c - testsuites/validation/tr-mtx-seize-try.c - testsuites/validation/tr-mtx-seize-wait.c diff --git a/testsuites/validation/tc-timer-cancel.c b/testsuites/validation/tc-timer-cancel.c new file mode 100644 index 0000000000..223848fdee --- /dev/null +++ b/testsuites/validation/tc-timer-cancel.c @@ -0,0 +1,813 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqCancel + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> + +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqCancel spec:/rtems/timer/req/cancel + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqCancel_Pre_Id_Valid, + RtemsTimerReqCancel_Pre_Id_Invalid, + RtemsTimerReqCancel_Pre_Id_NA +} RtemsTimerReqCancel_Pre_Id; + +typedef enum { + RtemsTimerReqCancel_Pre_Context_None, + RtemsTimerReqCancel_Pre_Context_Interrupt, + RtemsTimerReqCancel_Pre_Context_Server, + RtemsTimerReqCancel_Pre_Context_NA +} RtemsTimerReqCancel_Pre_Context; + +typedef enum { + RtemsTimerReqCancel_Pre_Clock_None, + RtemsTimerReqCancel_Pre_Clock_Ticks, + RtemsTimerReqCancel_Pre_Clock_Realtime, + RtemsTimerReqCancel_Pre_Clock_NA +} RtemsTimerReqCancel_Pre_Clock; + +typedef enum { + RtemsTimerReqCancel_Pre_State_Inactive, + RtemsTimerReqCancel_Pre_State_Scheduled, + RtemsTimerReqCancel_Pre_State_Pending, + RtemsTimerReqCancel_Pre_State_NA +} RtemsTimerReqCancel_Pre_State; + +typedef enum { + RtemsTimerReqCancel_Post_Status_Ok, + RtemsTimerReqCancel_Post_Status_InvId, + RtemsTimerReqCancel_Post_Status_NA +} RtemsTimerReqCancel_Post_Status; + +typedef enum { + RtemsTimerReqCancel_Post_Context_None, + RtemsTimerReqCancel_Post_Context_Interrupt, + RtemsTimerReqCancel_Post_Context_Server, + RtemsTimerReqCancel_Post_Context_Nop, + RtemsTimerReqCancel_Post_Context_NA +} RtemsTimerReqCancel_Post_Context; + +typedef enum { + RtemsTimerReqCancel_Post_Clock_None, + RtemsTimerReqCancel_Post_Clock_Ticks, + RtemsTimerReqCancel_Post_Clock_Realtime, + RtemsTimerReqCancel_Post_Clock_Nop, + RtemsTimerReqCancel_Post_Clock_NA +} RtemsTimerReqCancel_Post_Clock; + +typedef enum { + RtemsTimerReqCancel_Post_State_Inactive, + RtemsTimerReqCancel_Post_State_Nop, + RtemsTimerReqCancel_Post_State_NA +} RtemsTimerReqCancel_Post_State; + +typedef struct { + uint16_t Skip : 1; + uint16_t Pre_Id_NA : 1; + uint16_t Pre_Context_NA : 1; + uint16_t Pre_Clock_NA : 1; + uint16_t Pre_State_NA : 1; + uint16_t Post_Status : 2; + uint16_t Post_Context : 3; + uint16_t Post_Clock : 3; + uint16_t Post_State : 2; +} RtemsTimerReqCancel_Entry; + +typedef enum { + PRE_NONE = 0, + PRE_INTERRUPT = 1, + PRE_SERVER = 2 +} PreConditionContext; + +/** + * @brief Test context for spec:/rtems/timer/req/cancel test case. + */ +typedef struct { + /** + * @brief This member contains a valid id of a timer. + */ + rtems_id timer_id; + + /** + * @brief This member specifies the ``id`` parameter for the action. + */ + rtems_id id_param; + + /** + * @brief This member contains the return status of the action. + */ + rtems_status_code status; + + /** + * @brief This member contains the counter for invocations of the Timer + * Service Routine. + */ + int invocations; + + /** + * @brief This member specifies which pre-condition context (none, interrupt + * context, server context) must be created before the cancel action gets + * executed. + */ + PreConditionContext pre_cond_contex; + + /** + * @brief This member stores RTEMS internal clock and context settings of the + * timer before the execution of the test action. + */ + Timer_Classes pre_class; + + /** + * @brief This member stores the state of the timer before the execution of + * the test action. + */ + Timer_States pre_state; + + /** + * @brief This member stores the state of the timer after the execution of + * the test action. + */ + Timer_States post_state; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 4 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqCancel_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqCancel_Context; + +static RtemsTimerReqCancel_Context + RtemsTimerReqCancel_Instance; + +static const char * const RtemsTimerReqCancel_PreDesc_Id[] = { + "Valid", + "Invalid", + "NA" +}; + +static const char * const RtemsTimerReqCancel_PreDesc_Context[] = { + "None", + "Interrupt", + "Server", + "NA" +}; + +static const char * const RtemsTimerReqCancel_PreDesc_Clock[] = { + "None", + "Ticks", + "Realtime", + "NA" +}; + +static const char * const RtemsTimerReqCancel_PreDesc_State[] = { + "Inactive", + "Scheduled", + "Pending", + "NA" +}; + +static const char * const * const RtemsTimerReqCancel_PreDesc[] = { + RtemsTimerReqCancel_PreDesc_Id, + RtemsTimerReqCancel_PreDesc_Context, + RtemsTimerReqCancel_PreDesc_Clock, + RtemsTimerReqCancel_PreDesc_State, + NULL +}; + +static const rtems_time_of_day tod_now = { 2000, 1, 1, 0, 0, 0, 0 }; +static const rtems_time_of_day tod_schedule = { 2000, 1, 1, 1, 0, 0, 0 }; +static const rtems_time_of_day tod_fire = { 2000, 1, 2, 0, 0, 0, 0 }; + +static void TriggerTimer( void ) +{ + /* Fire the timer service routine for ticks and realtime clock */ + int i; + for ( i = 0; i < 5; i++ ) { + ClockTick(); + } + T_rsc_success( rtems_clock_set( &tod_fire ) ); +} + +static void TimerServiceRoutine( + rtems_id timer_id, + void *user_data +) +{ + RtemsTimerReqCancel_Context *ctx = user_data; + ++( ctx->invocations ); +} + +static void RtemsTimerReqCancel_Pre_Id_Prepare( + RtemsTimerReqCancel_Context *ctx, + RtemsTimerReqCancel_Pre_Id state +) +{ + switch ( state ) { + case RtemsTimerReqCancel_Pre_Id_Valid: { + /* + * While the ``id`` parameter is valid. + */ + ctx->id_param = ctx->timer_id; + break; + } + + case RtemsTimerReqCancel_Pre_Id_Invalid: { + /* + * While the ``id`` parameter is invalid. + */ + ctx->id_param = RTEMS_ID_NONE; + break; + } + + case RtemsTimerReqCancel_Pre_Id_NA: + break; + } +} + +static void RtemsTimerReqCancel_Pre_Context_Prepare( + RtemsTimerReqCancel_Context *ctx, + RtemsTimerReqCancel_Pre_Context state +) +{ + switch ( state ) { + case RtemsTimerReqCancel_Pre_Context_None: { + /* + * While the Timer Service Routine has never been scheduled since + * creation of the timer. See also none. + */ + ctx->pre_cond_contex = PRE_NONE; + break; + } + + case RtemsTimerReqCancel_Pre_Context_Interrupt: { + /* + * While the timer is in interrupt context. + */ + ctx->pre_cond_contex = PRE_INTERRUPT; + break; + } + + case RtemsTimerReqCancel_Pre_Context_Server: { + /* + * While the timer is in server context. + */ + ctx->pre_cond_contex = PRE_SERVER; + break; + } + + case RtemsTimerReqCancel_Pre_Context_NA: + break; + } +} + +static void RtemsTimerReqCancel_Pre_Clock_Prepare( + RtemsTimerReqCancel_Context *ctx, + RtemsTimerReqCancel_Pre_Clock state +) +{ + switch ( state ) { + case RtemsTimerReqCancel_Pre_Clock_None: { + /* + * While the timer has never been scheduled since creation of the timer. + */ + T_eq_int( ctx->pre_cond_contex, PRE_NONE ); + break; + } + + case RtemsTimerReqCancel_Pre_Clock_Ticks: { + /* + * While the clock used to determine when the timer will fire is the + * ticks based clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_after( + ctx->timer_id, + 1, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_after( + ctx->timer_id, + 1, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqCancel_Pre_Clock_Realtime: { + /* + * While the clock used to determine when the timer will fire is the + * realtime clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqCancel_Pre_Clock_NA: + break; + } +} + +static void RtemsTimerReqCancel_Pre_State_Prepare( + RtemsTimerReqCancel_Context *ctx, + RtemsTimerReqCancel_Pre_State state +) +{ + switch ( state ) { + case RtemsTimerReqCancel_Pre_State_Inactive: { + /* + * While the timer is in inactive state. + */ + TriggerTimer(); + T_eq_int( + ctx->invocations, + ( ctx->pre_cond_contex == PRE_NONE ) ? 0 : 1 + ); + ctx->invocations = 0; + ctx->pre_state = TIMER_INACTIVE; + break; + } + + case RtemsTimerReqCancel_Pre_State_Scheduled: { + /* + * While the timer is in scheduled state. + */ + /* The timer was already scheduled in the "Clock" pre-conditions. */ + ctx->pre_state = TIMER_SCHEDULED; + break; + } + + case RtemsTimerReqCancel_Pre_State_Pending: { + /* + * While the timer is in pending state. + */ + T_rsc_success( rtems_task_suspend( GetTimerServerTaskId() ) ); + TriggerTimer(); + T_eq_int( ctx->invocations, 0 ); + ctx->pre_state = TIMER_PENDING; + break; + } + + case RtemsTimerReqCancel_Pre_State_NA: + break; + } +} + +static void RtemsTimerReqCancel_Post_Status_Check( + RtemsTimerReqCancel_Context *ctx, + RtemsTimerReqCancel_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqCancel_Post_Status_Ok: { + /* + * The return status of rtems_timer_cancel() shall be RTEMS_SUCCESSFUL. + */ + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqCancel_Post_Status_InvId: { + /* + * The return status of rtems_timer_cancel() shall be RTEMS_INVALID_ID. + */ + T_rsc( ctx->status, RTEMS_INVALID_ID ); + break; + } + + case RtemsTimerReqCancel_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqCancel_Post_Context_Check( + RtemsTimerReqCancel_Context *ctx, + RtemsTimerReqCancel_Post_Context state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqCancel_Post_Context_None: { + /* + * The timer shall have never been scheduled. See also none. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqCancel_Post_Context_Interrupt: { + /* + * The timer shall be in interrupt context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, 0 ); + break; + } + + case RtemsTimerReqCancel_Post_Context_Server: { + /* + * The timer shall be in server context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, TIMER_CLASS_BIT_ON_TASK ); + break; + } + + case RtemsTimerReqCancel_Post_Context_Nop: { + /* + * Objects referenced by the ``id`` parameter in past call to + * rtems_timer_cancel() shall not be accessed by the rtems_timer_cancel() + * call. See also Nop. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqCancel_Post_Context_NA: + break; + } +} + +static void RtemsTimerReqCancel_Post_Clock_Check( + RtemsTimerReqCancel_Context *ctx, + RtemsTimerReqCancel_Post_Clock state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqCancel_Post_Clock_None: { + /* + * The timer shall have never been scheduled. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqCancel_Post_Clock_Ticks: { + /* + * The timer shall use the ticks based clock. + */ + T_eq_int( class & TIMER_CLASS_BIT_TIME_OF_DAY, 0 ); + break; + } + + case RtemsTimerReqCancel_Post_Clock_Realtime: { + /* + * The timer shall use the realtime clock. + */ + T_eq_int( + class & TIMER_CLASS_BIT_TIME_OF_DAY, + TIMER_CLASS_BIT_TIME_OF_DAY + ); + break; + } + + case RtemsTimerReqCancel_Post_Clock_Nop: { + /* + * Objects referenced by the ``id`` parameter in past call to + * rtems_timer_cancel() shall not be accessed by the rtems_timer_cancel() + * call. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqCancel_Post_Clock_NA: + break; + } +} + +static void RtemsTimerReqCancel_Post_State_Check( + RtemsTimerReqCancel_Context *ctx, + RtemsTimerReqCancel_Post_State state +) +{ + switch ( state ) { + case RtemsTimerReqCancel_Post_State_Inactive: { + /* + * The timer shall be in inactive state. + */ + /* Try to fire the timer service routine - which should not fire. */ + TriggerTimer(); + T_eq_int( ctx->invocations, 0 ); + break; + } + + case RtemsTimerReqCancel_Post_State_Nop: { + /* + * Objects referenced by the ``id`` parameter in past call to + * rtems_timer_cancel() shall not be accessed by the rtems_timer_cancel() + * call. + */ + T_eq_int( ctx->post_state, ctx->pre_state ); + break; + } + + case RtemsTimerReqCancel_Post_State_NA: + break; + } +} + +static void RtemsTimerReqCancel_Setup( RtemsTimerReqCancel_Context *ctx ) +{ + rtems_status_code status; + status = rtems_timer_initiate_server( + RTEMS_TIMER_SERVER_DEFAULT_PRIORITY, + RTEMS_MINIMUM_STACK_SIZE, + RTEMS_DEFAULT_ATTRIBUTES + ); + T_rsc_success( status ); +} + +static void RtemsTimerReqCancel_Setup_Wrap( void *arg ) +{ + RtemsTimerReqCancel_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqCancel_Setup( ctx ); +} + +/** + * @brief Make sure the timer server is not running and the realtime clock is + * not set after this test. + */ +static void RtemsTimerReqCancel_Teardown( RtemsTimerReqCancel_Context *ctx ) +{ + DeleteTimerServer(); + UnsetClock(); +} + +static void RtemsTimerReqCancel_Teardown_Wrap( void *arg ) +{ + RtemsTimerReqCancel_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqCancel_Teardown( ctx ); +} + +static void RtemsTimerReqCancel_Prepare( RtemsTimerReqCancel_Context *ctx ) +{ + rtems_status_code status; + status = rtems_timer_create( + rtems_build_name( 'T', 'I', 'M', 'E' ), + &ctx->timer_id + ); + T_rsc_success( status ); + + ctx->invocations = 0; + T_rsc_success( rtems_clock_set( &tod_now ) ); +} + +static void RtemsTimerReqCancel_Action( RtemsTimerReqCancel_Context *ctx ) +{ + ctx->pre_class = GetTimerClass( ctx->timer_id ); + ctx->status = rtems_timer_cancel( ctx->id_param ); + ctx->post_state = GetTimerState( ctx->timer_id ); + /* Ignoring return status: the timer server task may be suspended or not. */ + rtems_task_resume( GetTimerServerTaskId() ); +} + +static void RtemsTimerReqCancel_Cleanup( RtemsTimerReqCancel_Context *ctx ) +{ + T_rsc_success( rtems_timer_delete( ctx->timer_id ) ); +} + +static const RtemsTimerReqCancel_Entry +RtemsTimerReqCancel_Entries[] = { + { 1, 0, 0, 0, 0, RtemsTimerReqCancel_Post_Status_NA, + RtemsTimerReqCancel_Post_Context_NA, RtemsTimerReqCancel_Post_Clock_NA, + RtemsTimerReqCancel_Post_State_NA }, + { 0, 0, 0, 0, 0, RtemsTimerReqCancel_Post_Status_InvId, + RtemsTimerReqCancel_Post_Context_Nop, RtemsTimerReqCancel_Post_Clock_Nop, + RtemsTimerReqCancel_Post_State_Nop }, + { 0, 0, 0, 0, 0, RtemsTimerReqCancel_Post_Status_Ok, + RtemsTimerReqCancel_Post_Context_Server, + RtemsTimerReqCancel_Post_Clock_Ticks, + RtemsTimerReqCancel_Post_State_Inactive }, + { 0, 0, 0, 0, 0, RtemsTimerReqCancel_Post_Status_Ok, + RtemsTimerReqCancel_Post_Context_Server, + RtemsTimerReqCancel_Post_Clock_Realtime, + RtemsTimerReqCancel_Post_State_Inactive }, + { 0, 0, 0, 0, 0, RtemsTimerReqCancel_Post_Status_Ok, + RtemsTimerReqCancel_Post_Context_Interrupt, + RtemsTimerReqCancel_Post_Clock_Ticks, + RtemsTimerReqCancel_Post_State_Inactive }, + { 0, 0, 0, 0, 0, RtemsTimerReqCancel_Post_Status_Ok, + RtemsTimerReqCancel_Post_Context_Interrupt, + RtemsTimerReqCancel_Post_Clock_Realtime, + RtemsTimerReqCancel_Post_State_Inactive }, + { 0, 0, 0, 0, 0, RtemsTimerReqCancel_Post_Status_Ok, + RtemsTimerReqCancel_Post_Context_None, RtemsTimerReqCancel_Post_Clock_None, + RtemsTimerReqCancel_Post_State_Inactive } +}; + +static const uint8_t +RtemsTimerReqCancel_Map[] = { + 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 5, 5, 0, 0, 0, 0, 2, 2, 2, 3, 3, + 3, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, + 1, 1 +}; + +static size_t RtemsTimerReqCancel_Scope( void *arg, char *buf, size_t n ) +{ + RtemsTimerReqCancel_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( RtemsTimerReqCancel_PreDesc, buf, n, ctx->Map.pcs ); + } + + return 0; +} + +static T_fixture RtemsTimerReqCancel_Fixture = { + .setup = RtemsTimerReqCancel_Setup_Wrap, + .stop = NULL, + .teardown = RtemsTimerReqCancel_Teardown_Wrap, + .scope = RtemsTimerReqCancel_Scope, + .initial_context = &RtemsTimerReqCancel_Instance +}; + +static inline RtemsTimerReqCancel_Entry RtemsTimerReqCancel_PopEntry( + RtemsTimerReqCancel_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqCancel_Entries[ + RtemsTimerReqCancel_Map[ index ] + ]; +} + +static void RtemsTimerReqCancel_TestVariant( RtemsTimerReqCancel_Context *ctx ) +{ + RtemsTimerReqCancel_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqCancel_Pre_Context_Prepare( ctx, ctx->Map.pcs[ 1 ] ); + RtemsTimerReqCancel_Pre_Clock_Prepare( ctx, ctx->Map.pcs[ 2 ] ); + RtemsTimerReqCancel_Pre_State_Prepare( ctx, ctx->Map.pcs[ 3 ] ); + RtemsTimerReqCancel_Action( ctx ); + RtemsTimerReqCancel_Post_Status_Check( ctx, ctx->Map.entry.Post_Status ); + RtemsTimerReqCancel_Post_Context_Check( ctx, ctx->Map.entry.Post_Context ); + RtemsTimerReqCancel_Post_Clock_Check( ctx, ctx->Map.entry.Post_Clock ); + RtemsTimerReqCancel_Post_State_Check( ctx, ctx->Map.entry.Post_State ); +} + +/** + * @fn void T_case_body_RtemsTimerReqCancel( void ) + */ +T_TEST_CASE_FIXTURE( RtemsTimerReqCancel, &RtemsTimerReqCancel_Fixture ) +{ + RtemsTimerReqCancel_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqCancel_Pre_Id_Valid; + ctx->Map.pcs[ 0 ] < RtemsTimerReqCancel_Pre_Id_NA; + ++ctx->Map.pcs[ 0 ] + ) { + for ( + ctx->Map.pcs[ 1 ] = RtemsTimerReqCancel_Pre_Context_None; + ctx->Map.pcs[ 1 ] < RtemsTimerReqCancel_Pre_Context_NA; + ++ctx->Map.pcs[ 1 ] + ) { + for ( + ctx->Map.pcs[ 2 ] = RtemsTimerReqCancel_Pre_Clock_None; + ctx->Map.pcs[ 2 ] < RtemsTimerReqCancel_Pre_Clock_NA; + ++ctx->Map.pcs[ 2 ] + ) { + for ( + ctx->Map.pcs[ 3 ] = RtemsTimerReqCancel_Pre_State_Inactive; + ctx->Map.pcs[ 3 ] < RtemsTimerReqCancel_Pre_State_NA; + ++ctx->Map.pcs[ 3 ] + ) { + ctx->Map.entry = RtemsTimerReqCancel_PopEntry( ctx ); + + if ( ctx->Map.entry.Skip ) { + continue; + } + + RtemsTimerReqCancel_Prepare( ctx ); + RtemsTimerReqCancel_TestVariant( ctx ); + RtemsTimerReqCancel_Cleanup( ctx ); + } + } + } + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-create.c b/testsuites/validation/tc-timer-create.c new file mode 100644 index 0000000000..dea3a40175 --- /dev/null +++ b/testsuites/validation/tc-timer-create.c @@ -0,0 +1,535 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqCreate + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> +#include <string.h> + +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqCreate spec:/rtems/timer/req/create + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqCreate_Pre_Name_Valid, + RtemsTimerReqCreate_Pre_Name_Invalid, + RtemsTimerReqCreate_Pre_Name_NA +} RtemsTimerReqCreate_Pre_Name; + +typedef enum { + RtemsTimerReqCreate_Pre_Id_Valid, + RtemsTimerReqCreate_Pre_Id_Null, + RtemsTimerReqCreate_Pre_Id_NA +} RtemsTimerReqCreate_Pre_Id; + +typedef enum { + RtemsTimerReqCreate_Pre_Free_Yes, + RtemsTimerReqCreate_Pre_Free_No, + RtemsTimerReqCreate_Pre_Free_NA +} RtemsTimerReqCreate_Pre_Free; + +typedef enum { + RtemsTimerReqCreate_Post_Status_Ok, + RtemsTimerReqCreate_Post_Status_InvName, + RtemsTimerReqCreate_Post_Status_InvAddr, + RtemsTimerReqCreate_Post_Status_TooMany, + RtemsTimerReqCreate_Post_Status_NA +} RtemsTimerReqCreate_Post_Status; + +typedef enum { + RtemsTimerReqCreate_Post_Name_Valid, + RtemsTimerReqCreate_Post_Name_Invalid, + RtemsTimerReqCreate_Post_Name_NA +} RtemsTimerReqCreate_Post_Name; + +typedef enum { + RtemsTimerReqCreate_Post_IdVar_Set, + RtemsTimerReqCreate_Post_IdVar_Nop, + RtemsTimerReqCreate_Post_IdVar_NA +} RtemsTimerReqCreate_Post_IdVar; + +typedef struct { + uint16_t Skip : 1; + uint16_t Pre_Name_NA : 1; + uint16_t Pre_Id_NA : 1; + uint16_t Pre_Free_NA : 1; + uint16_t Post_Status : 3; + uint16_t Post_Name : 2; + uint16_t Post_IdVar : 2; +} RtemsTimerReqCreate_Entry; + +/** + * @brief Test context for spec:/rtems/timer/req/create test case. + */ +typedef struct { + /** + * @brief This member is used by the T_seize_objects() and + * T_surrender_objects() support functions. + */ + void *seized_objects; + + /** + * @brief This member may contain the object identifier returned by + * rtems_timer_create(). + */ + rtems_id id_value; + + /** + * @brief This member specifies the ``name`` parameter for the action. + */ + rtems_name name; + + /** + * @brief This member specifies the ``id`` parameter for the action. + */ + rtems_id *id; + + /** + * @brief This member contains the return status of the action. + */ + rtems_status_code status; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 3 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqCreate_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqCreate_Context; + +static RtemsTimerReqCreate_Context + RtemsTimerReqCreate_Instance; + +static const char * const RtemsTimerReqCreate_PreDesc_Name[] = { + "Valid", + "Invalid", + "NA" +}; + +static const char * const RtemsTimerReqCreate_PreDesc_Id[] = { + "Valid", + "Null", + "NA" +}; + +static const char * const RtemsTimerReqCreate_PreDesc_Free[] = { + "Yes", + "No", + "NA" +}; + +static const char * const * const RtemsTimerReqCreate_PreDesc[] = { + RtemsTimerReqCreate_PreDesc_Name, + RtemsTimerReqCreate_PreDesc_Id, + RtemsTimerReqCreate_PreDesc_Free, + NULL +}; + +#define NAME rtems_build_name( 'T', 'E', 'S', 'T' ) + +static rtems_status_code Create( void *arg, uint32_t *id ) +{ + return rtems_timer_create( rtems_build_name( 'S', 'I', 'Z', 'E' ), id ); +} + +static void RtemsTimerReqCreate_Pre_Name_Prepare( + RtemsTimerReqCreate_Context *ctx, + RtemsTimerReqCreate_Pre_Name state +) +{ + switch ( state ) { + case RtemsTimerReqCreate_Pre_Name_Valid: { + /* + * While the ``name`` parameter is valid. + */ + ctx->name = NAME; + break; + } + + case RtemsTimerReqCreate_Pre_Name_Invalid: { + /* + * While the ``name`` parameter is invalid. + */ + ctx->name = 0; + break; + } + + case RtemsTimerReqCreate_Pre_Name_NA: + break; + } +} + +static void RtemsTimerReqCreate_Pre_Id_Prepare( + RtemsTimerReqCreate_Context *ctx, + RtemsTimerReqCreate_Pre_Id state +) +{ + switch ( state ) { + case RtemsTimerReqCreate_Pre_Id_Valid: { + /* + * While the ``id`` parameter references an object of type rtems_id. + */ + ctx->id = &ctx->id_value; + break; + } + + case RtemsTimerReqCreate_Pre_Id_Null: { + /* + * While the ``id`` parameter is NULL. + */ + ctx->id = NULL; + break; + } + + case RtemsTimerReqCreate_Pre_Id_NA: + break; + } +} + +static void RtemsTimerReqCreate_Pre_Free_Prepare( + RtemsTimerReqCreate_Context *ctx, + RtemsTimerReqCreate_Pre_Free state +) +{ + switch ( state ) { + case RtemsTimerReqCreate_Pre_Free_Yes: { + /* + * While the system has at least one inactive timer object available. + */ + /* Ensured by the test suite configuration */ + break; + } + + case RtemsTimerReqCreate_Pre_Free_No: { + /* + * While the system has no inactive timer object available. + */ + ctx->seized_objects = T_seize_objects( Create, NULL ); + break; + } + + case RtemsTimerReqCreate_Pre_Free_NA: + break; + } +} + +static void RtemsTimerReqCreate_Post_Status_Check( + RtemsTimerReqCreate_Context *ctx, + RtemsTimerReqCreate_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqCreate_Post_Status_Ok: { + /* + * The return status of rtems_timer_create() shall be RTEMS_SUCCESSFUL. + */ + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqCreate_Post_Status_InvName: { + /* + * The return status of rtems_timer_create() shall be RTEMS_INVALID_NAME. + */ + T_rsc( ctx->status, RTEMS_INVALID_NAME ); + break; + } + + case RtemsTimerReqCreate_Post_Status_InvAddr: { + /* + * The return status of rtems_timer_create() shall be + * RTEMS_INVALID_ADDRESS. + */ + T_rsc( ctx->status, RTEMS_INVALID_ADDRESS ); + break; + } + + case RtemsTimerReqCreate_Post_Status_TooMany: { + /* + * The return status of rtems_timer_create() shall be RTEMS_TOO_MANY. + */ + T_rsc( ctx->status, RTEMS_TOO_MANY ); + break; + } + + case RtemsTimerReqCreate_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqCreate_Post_Name_Check( + RtemsTimerReqCreate_Context *ctx, + RtemsTimerReqCreate_Post_Name state +) +{ + rtems_status_code sc; + rtems_id id; + + switch ( state ) { + case RtemsTimerReqCreate_Post_Name_Valid: { + /* + * The unique object name shall identify the timer created by the + * rtems_timer_create() call. + */ + id = 0; + sc = rtems_timer_ident( NAME, &id ); + T_rsc_success( sc ); + T_eq_u32( id, ctx->id_value ); + break; + } + + case RtemsTimerReqCreate_Post_Name_Invalid: { + /* + * The unique object name shall not identify a timer. + */ + sc = rtems_timer_ident( NAME, &id ); + T_rsc( sc, RTEMS_INVALID_NAME ); + break; + } + + case RtemsTimerReqCreate_Post_Name_NA: + break; + } +} + +static void RtemsTimerReqCreate_Post_IdVar_Check( + RtemsTimerReqCreate_Context *ctx, + RtemsTimerReqCreate_Post_IdVar state +) +{ + switch ( state ) { + case RtemsTimerReqCreate_Post_IdVar_Set: { + /* + * The value of the object referenced by the ``id`` parameter shall be + * set to the object identifier of the created timer after the return of + * the rtems_timer_create() call. + */ + T_eq_ptr( ctx->id, &ctx->id_value ); + T_ne_u32( ctx->id_value, INVALID_ID ); + break; + } + + case RtemsTimerReqCreate_Post_IdVar_Nop: { + /* + * Objects referenced by the ``id`` parameter in past calls to + * rtems_timer_create() shall not be accessed by the rtems_timer_create() + * call. + */ + T_eq_u32( ctx->id_value, INVALID_ID ); + break; + } + + case RtemsTimerReqCreate_Post_IdVar_NA: + break; + } +} + +static void RtemsTimerReqCreate_Setup( RtemsTimerReqCreate_Context *ctx ) +{ + memset( ctx, 0, sizeof( *ctx ) ); + ctx->id_value = INVALID_ID; +} + +static void RtemsTimerReqCreate_Setup_Wrap( void *arg ) +{ + RtemsTimerReqCreate_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqCreate_Setup( ctx ); +} + +static void RtemsTimerReqCreate_Action( RtemsTimerReqCreate_Context *ctx ) +{ + ctx->status = rtems_timer_create( ctx->name, ctx->id ); +} + +static void RtemsTimerReqCreate_Cleanup( RtemsTimerReqCreate_Context *ctx ) +{ + if ( ctx->id_value != INVALID_ID ) { + rtems_status_code sc; + + sc = rtems_timer_delete( ctx->id_value ); + T_rsc_success( sc ); + + ctx->id_value = INVALID_ID; + } + + T_surrender_objects( &ctx->seized_objects, rtems_timer_delete ); +} + +static const RtemsTimerReqCreate_Entry +RtemsTimerReqCreate_Entries[] = { + { 0, 0, 0, 0, RtemsTimerReqCreate_Post_Status_InvName, + RtemsTimerReqCreate_Post_Name_Invalid, RtemsTimerReqCreate_Post_IdVar_Nop }, + { 0, 0, 0, 0, RtemsTimerReqCreate_Post_Status_InvAddr, + RtemsTimerReqCreate_Post_Name_Invalid, RtemsTimerReqCreate_Post_IdVar_Nop }, + { 0, 0, 0, 0, RtemsTimerReqCreate_Post_Status_Ok, + RtemsTimerReqCreate_Post_Name_Valid, RtemsTimerReqCreate_Post_IdVar_Set }, + { 0, 0, 0, 0, RtemsTimerReqCreate_Post_Status_TooMany, + RtemsTimerReqCreate_Post_Name_Invalid, RtemsTimerReqCreate_Post_IdVar_Nop } +}; + +static const uint8_t +RtemsTimerReqCreate_Map[] = { + 2, 3, 1, 1, 0, 0, 0, 0 +}; + +static size_t RtemsTimerReqCreate_Scope( void *arg, char *buf, size_t n ) +{ + RtemsTimerReqCreate_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( RtemsTimerReqCreate_PreDesc, buf, n, ctx->Map.pcs ); + } + + return 0; +} + +static T_fixture RtemsTimerReqCreate_Fixture = { + .setup = RtemsTimerReqCreate_Setup_Wrap, + .stop = NULL, + .teardown = NULL, + .scope = RtemsTimerReqCreate_Scope, + .initial_context = &RtemsTimerReqCreate_Instance +}; + +static inline RtemsTimerReqCreate_Entry RtemsTimerReqCreate_PopEntry( + RtemsTimerReqCreate_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqCreate_Entries[ + RtemsTimerReqCreate_Map[ index ] + ]; +} + +static void RtemsTimerReqCreate_TestVariant( RtemsTimerReqCreate_Context *ctx ) +{ + RtemsTimerReqCreate_Pre_Name_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqCreate_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 1 ] ); + RtemsTimerReqCreate_Pre_Free_Prepare( ctx, ctx->Map.pcs[ 2 ] ); + RtemsTimerReqCreate_Action( ctx ); + RtemsTimerReqCreate_Post_Status_Check( ctx, ctx->Map.entry.Post_Status ); + RtemsTimerReqCreate_Post_Name_Check( ctx, ctx->Map.entry.Post_Name ); + RtemsTimerReqCreate_Post_IdVar_Check( ctx, ctx->Map.entry.Post_IdVar ); +} + +/** + * @fn void T_case_body_RtemsTimerReqCreate( void ) + */ +T_TEST_CASE_FIXTURE( RtemsTimerReqCreate, &RtemsTimerReqCreate_Fixture ) +{ + RtemsTimerReqCreate_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqCreate_Pre_Name_Valid; + ctx->Map.pcs[ 0 ] < RtemsTimerReqCreate_Pre_Name_NA; + ++ctx->Map.pcs[ 0 ] + ) { + for ( + ctx->Map.pcs[ 1 ] = RtemsTimerReqCreate_Pre_Id_Valid; + ctx->Map.pcs[ 1 ] < RtemsTimerReqCreate_Pre_Id_NA; + ++ctx->Map.pcs[ 1 ] + ) { + for ( + ctx->Map.pcs[ 2 ] = RtemsTimerReqCreate_Pre_Free_Yes; + ctx->Map.pcs[ 2 ] < RtemsTimerReqCreate_Pre_Free_NA; + ++ctx->Map.pcs[ 2 ] + ) { + ctx->Map.entry = RtemsTimerReqCreate_PopEntry( ctx ); + RtemsTimerReqCreate_TestVariant( ctx ); + RtemsTimerReqCreate_Cleanup( ctx ); + } + } + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-delete.c b/testsuites/validation/tc-timer-delete.c new file mode 100644 index 0000000000..92032c80cf --- /dev/null +++ b/testsuites/validation/tc-timer-delete.c @@ -0,0 +1,362 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqDelete + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> +#include <string.h> + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqDelete spec:/rtems/timer/req/delete + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqDelete_Pre_Id_NoObj, + RtemsTimerReqDelete_Pre_Id_Timer, + RtemsTimerReqDelete_Pre_Id_NA +} RtemsTimerReqDelete_Pre_Id; + +typedef enum { + RtemsTimerReqDelete_Post_Status_Ok, + RtemsTimerReqDelete_Post_Status_InvId, + RtemsTimerReqDelete_Post_Status_NA +} RtemsTimerReqDelete_Post_Status; + +typedef enum { + RtemsTimerReqDelete_Post_Name_Valid, + RtemsTimerReqDelete_Post_Name_Invalid, + RtemsTimerReqDelete_Post_Name_NA +} RtemsTimerReqDelete_Post_Name; + +typedef struct { + uint8_t Skip : 1; + uint8_t Pre_Id_NA : 1; + uint8_t Post_Status : 2; + uint8_t Post_Name : 2; +} RtemsTimerReqDelete_Entry; + +/** + * @brief Test context for spec:/rtems/timer/req/delete test case. + */ +typedef struct { + rtems_id timer_id; + + rtems_id id; + + rtems_status_code status; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 1 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqDelete_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqDelete_Context; + +static RtemsTimerReqDelete_Context + RtemsTimerReqDelete_Instance; + +static const char * const RtemsTimerReqDelete_PreDesc_Id[] = { + "NoObj", + "Timer", + "NA" +}; + +static const char * const * const RtemsTimerReqDelete_PreDesc[] = { + RtemsTimerReqDelete_PreDesc_Id, + NULL +}; + +#define NAME rtems_build_name( 'T', 'E', 'S', 'T' ) + +static void RtemsTimerReqDelete_Pre_Id_Prepare( + RtemsTimerReqDelete_Context *ctx, + RtemsTimerReqDelete_Pre_Id state +) +{ + switch ( state ) { + case RtemsTimerReqDelete_Pre_Id_NoObj: { + /* + * While the ``id`` parameter is not associated with a timer. + */ + ctx->id = 0; + break; + } + + case RtemsTimerReqDelete_Pre_Id_Timer: { + /* + * While the ``id`` parameter is associated with a timer. + */ + ctx->id = ctx->timer_id; + break; + } + + case RtemsTimerReqDelete_Pre_Id_NA: + break; + } +} + +static void RtemsTimerReqDelete_Post_Status_Check( + RtemsTimerReqDelete_Context *ctx, + RtemsTimerReqDelete_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqDelete_Post_Status_Ok: { + /* + * The return status of rtems_timer_delete() shall be RTEMS_SUCCESSFUL. + */ + ctx->timer_id = 0; + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqDelete_Post_Status_InvId: { + /* + * The return status of rtems_timer_delete() shall be RTEMS_INVALID_ID. + */ + T_rsc( ctx->status, RTEMS_INVALID_ID ); + break; + } + + case RtemsTimerReqDelete_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqDelete_Post_Name_Check( + RtemsTimerReqDelete_Context *ctx, + RtemsTimerReqDelete_Post_Name state +) +{ + rtems_status_code sc; + rtems_id id; + + switch ( state ) { + case RtemsTimerReqDelete_Post_Name_Valid: { + /* + * The unique object name shall identify a timer. + */ + id = 0; + sc = rtems_timer_ident( NAME, &id ); + T_rsc_success( sc ); + T_eq_u32( id, ctx->timer_id ); + break; + } + + case RtemsTimerReqDelete_Post_Name_Invalid: { + /* + * The unique object name shall not identify a timer. + */ + sc = rtems_timer_ident( NAME, &id ); + T_rsc( sc, RTEMS_INVALID_NAME ); + break; + } + + case RtemsTimerReqDelete_Post_Name_NA: + break; + } +} + +static void RtemsTimerReqDelete_Setup( RtemsTimerReqDelete_Context *ctx ) +{ + memset( ctx, 0, sizeof( *ctx ) ); +} + +static void RtemsTimerReqDelete_Setup_Wrap( void *arg ) +{ + RtemsTimerReqDelete_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqDelete_Setup( ctx ); +} + +static void RtemsTimerReqDelete_Teardown( RtemsTimerReqDelete_Context *ctx ) +{ + if ( ctx->timer_id != 0 ) { + rtems_status_code sc; + + sc = rtems_timer_delete( ctx->timer_id ); + T_rsc_success( sc ); + } +} + +static void RtemsTimerReqDelete_Teardown_Wrap( void *arg ) +{ + RtemsTimerReqDelete_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqDelete_Teardown( ctx ); +} + +static void RtemsTimerReqDelete_Prepare( RtemsTimerReqDelete_Context *ctx ) +{ + if ( ctx->timer_id == 0 ) { + rtems_status_code sc; + + sc = rtems_timer_create( NAME, &ctx->timer_id ); + T_rsc_success( sc ); + } +} + +static void RtemsTimerReqDelete_Action( RtemsTimerReqDelete_Context *ctx ) +{ + ctx->status = rtems_timer_delete( ctx->id ); +} + +static const RtemsTimerReqDelete_Entry +RtemsTimerReqDelete_Entries[] = { + { 0, 0, RtemsTimerReqDelete_Post_Status_InvId, + RtemsTimerReqDelete_Post_Name_Valid }, + { 0, 0, RtemsTimerReqDelete_Post_Status_Ok, + RtemsTimerReqDelete_Post_Name_Invalid } +}; + +static const uint8_t +RtemsTimerReqDelete_Map[] = { + 0, 1 +}; + +static size_t RtemsTimerReqDelete_Scope( void *arg, char *buf, size_t n ) +{ + RtemsTimerReqDelete_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( RtemsTimerReqDelete_PreDesc, buf, n, ctx->Map.pcs ); + } + + return 0; +} + +static T_fixture RtemsTimerReqDelete_Fixture = { + .setup = RtemsTimerReqDelete_Setup_Wrap, + .stop = NULL, + .teardown = RtemsTimerReqDelete_Teardown_Wrap, + .scope = RtemsTimerReqDelete_Scope, + .initial_context = &RtemsTimerReqDelete_Instance +}; + +static inline RtemsTimerReqDelete_Entry RtemsTimerReqDelete_PopEntry( + RtemsTimerReqDelete_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqDelete_Entries[ + RtemsTimerReqDelete_Map[ index ] + ]; +} + +static void RtemsTimerReqDelete_TestVariant( RtemsTimerReqDelete_Context *ctx ) +{ + RtemsTimerReqDelete_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqDelete_Action( ctx ); + RtemsTimerReqDelete_Post_Status_Check( ctx, ctx->Map.entry.Post_Status ); + RtemsTimerReqDelete_Post_Name_Check( ctx, ctx->Map.entry.Post_Name ); +} + +/** + * @fn void T_case_body_RtemsTimerReqDelete( void ) + */ +T_TEST_CASE_FIXTURE( RtemsTimerReqDelete, &RtemsTimerReqDelete_Fixture ) +{ + RtemsTimerReqDelete_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqDelete_Pre_Id_NoObj; + ctx->Map.pcs[ 0 ] < RtemsTimerReqDelete_Pre_Id_NA; + ++ctx->Map.pcs[ 0 ] + ) { + ctx->Map.entry = RtemsTimerReqDelete_PopEntry( ctx ); + RtemsTimerReqDelete_Prepare( ctx ); + RtemsTimerReqDelete_TestVariant( ctx ); + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-fire-after.c b/testsuites/validation/tc-timer-fire-after.c new file mode 100644 index 0000000000..980ecdde2d --- /dev/null +++ b/testsuites/validation/tc-timer-fire-after.c @@ -0,0 +1,1162 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqFireAfter + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> + +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqFireAfter \ + * spec:/rtems/timer/req/fire-after + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqFireAfter_Pre_Ticks_Valid, + RtemsTimerReqFireAfter_Pre_Ticks_Is0, + RtemsTimerReqFireAfter_Pre_Ticks_NA +} RtemsTimerReqFireAfter_Pre_Ticks; + +typedef enum { + RtemsTimerReqFireAfter_Pre_Routine_Valid, + RtemsTimerReqFireAfter_Pre_Routine_Null, + RtemsTimerReqFireAfter_Pre_Routine_NA +} RtemsTimerReqFireAfter_Pre_Routine; + +typedef enum { + RtemsTimerReqFireAfter_Pre_Id_Valid, + RtemsTimerReqFireAfter_Pre_Id_Invalid, + RtemsTimerReqFireAfter_Pre_Id_NA +} RtemsTimerReqFireAfter_Pre_Id; + +typedef enum { + RtemsTimerReqFireAfter_Pre_Context_None, + RtemsTimerReqFireAfter_Pre_Context_Interrupt, + RtemsTimerReqFireAfter_Pre_Context_Server, + RtemsTimerReqFireAfter_Pre_Context_NA +} RtemsTimerReqFireAfter_Pre_Context; + +typedef enum { + RtemsTimerReqFireAfter_Pre_Clock_None, + RtemsTimerReqFireAfter_Pre_Clock_Ticks, + RtemsTimerReqFireAfter_Pre_Clock_Realtime, + RtemsTimerReqFireAfter_Pre_Clock_NA +} RtemsTimerReqFireAfter_Pre_Clock; + +typedef enum { + RtemsTimerReqFireAfter_Pre_State_Inactive, + RtemsTimerReqFireAfter_Pre_State_Scheduled, + RtemsTimerReqFireAfter_Pre_State_Pending, + RtemsTimerReqFireAfter_Pre_State_NA +} RtemsTimerReqFireAfter_Pre_State; + +typedef enum { + RtemsTimerReqFireAfter_Post_Status_Ok, + RtemsTimerReqFireAfter_Post_Status_InvId, + RtemsTimerReqFireAfter_Post_Status_InvAddr, + RtemsTimerReqFireAfter_Post_Status_InvNum, + RtemsTimerReqFireAfter_Post_Status_NA +} RtemsTimerReqFireAfter_Post_Status; + +typedef enum { + RtemsTimerReqFireAfter_Post_Context_None, + RtemsTimerReqFireAfter_Post_Context_Interrupt, + RtemsTimerReqFireAfter_Post_Context_Server, + RtemsTimerReqFireAfter_Post_Context_Nop, + RtemsTimerReqFireAfter_Post_Context_NA +} RtemsTimerReqFireAfter_Post_Context; + +typedef enum { + RtemsTimerReqFireAfter_Post_Clock_None, + RtemsTimerReqFireAfter_Post_Clock_Ticks, + RtemsTimerReqFireAfter_Post_Clock_Realtime, + RtemsTimerReqFireAfter_Post_Clock_Nop, + RtemsTimerReqFireAfter_Post_Clock_NA +} RtemsTimerReqFireAfter_Post_Clock; + +typedef enum { + RtemsTimerReqFireAfter_Post_State_Scheduled, + RtemsTimerReqFireAfter_Post_State_Nop, + RtemsTimerReqFireAfter_Post_State_NA +} RtemsTimerReqFireAfter_Post_State; + +typedef enum { + RtemsTimerReqFireAfter_Post_Interval_Param, + RtemsTimerReqFireAfter_Post_Interval_Nop, + RtemsTimerReqFireAfter_Post_Interval_NA +} RtemsTimerReqFireAfter_Post_Interval; + +typedef enum { + RtemsTimerReqFireAfter_Post_Routine_Param, + RtemsTimerReqFireAfter_Post_Routine_Nop, + RtemsTimerReqFireAfter_Post_Routine_NA +} RtemsTimerReqFireAfter_Post_Routine; + +typedef enum { + RtemsTimerReqFireAfter_Post_UserData_Param, + RtemsTimerReqFireAfter_Post_UserData_Nop, + RtemsTimerReqFireAfter_Post_UserData_NA +} RtemsTimerReqFireAfter_Post_UserData; + +typedef struct { + uint32_t Skip : 1; + uint32_t Pre_Ticks_NA : 1; + uint32_t Pre_Routine_NA : 1; + uint32_t Pre_Id_NA : 1; + uint32_t Pre_Context_NA : 1; + uint32_t Pre_Clock_NA : 1; + uint32_t Pre_State_NA : 1; + uint32_t Post_Status : 3; + uint32_t Post_Context : 3; + uint32_t Post_Clock : 3; + uint32_t Post_State : 2; + uint32_t Post_Interval : 2; + uint32_t Post_Routine : 2; + uint32_t Post_UserData : 2; +} RtemsTimerReqFireAfter_Entry; + +typedef enum { + PRE_NONE = 0, + PRE_INTERRUPT = 1, + PRE_SERVER = 2 +} PreConditionContext; + +typedef enum { + SCHEDULE_NONE = 0, + SCHEDULE_SOON = 1, + SCHEDULE_LATER = 2, + SCHEDULE_MAX = 5 +} Scheduling_Ticks; + +/** + * @brief Test context for spec:/rtems/timer/req/fire-after test case. + */ +typedef struct { + /** + * @brief This member contains a valid id of a timer. + */ + rtems_id timer_id; + + /** + * @brief This member specifies the ``id`` parameter for the action. + */ + rtems_id id_param; + + /** + * @brief This member specifies the ``ticks`` parameter for the action. + */ + rtems_interval ticks_param; + + /** + * @brief This member specifies the ``routine`` parameter for the action. + */ + rtems_timer_service_routine_entry routine_param; + + /** + * @brief This member contains the returned status code of the action. + */ + rtems_status_code status; + + /** + * @brief This member contains a counter for invocations of the Timer Service + * Routine. + */ + int invocations; + + /** + * @brief Function TriggerTimer() is used to figure out how many ticks (see + * tick) are needed till the Timer Service Routine gets executed. This + * member contains the number of ticks needed to fire the Timer Service + * Routine. + */ + Scheduling_Ticks ticks_till_fire; + + /** + * @brief This member contains the user data given to the Timer Service + * Routine when called. + */ + void *routine_user_data; + + /** + * @brief This member specifies which pre-condition context (none, interrupt + * context, server context) must be created before the + * rtems_timer_fire_after() action gets executed. + */ + PreConditionContext pre_cond_contex; + + /** + * @brief This member stores internal clock and context settings of the timer + * before the execution of the test action. + */ + Timer_Classes pre_class; + + /** + * @brief This member stores the state of the timer before the execution of + * the test action. + */ + Timer_States pre_state; + + /** + * @brief This member stores the state of the timer after the execution of + * the test action. + */ + Timer_States post_state; + + /** + * @brief This member stores the scheduling data of the timer before the + * execution of the test action. + */ + Timer_Scheduling_Data pre_scheduling_data; + + /** + * @brief This member stores the scheduling data of the timer after the + * execution of the test action. + */ + Timer_Scheduling_Data post_scheduling_data; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 6 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqFireAfter_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqFireAfter_Context; + +static RtemsTimerReqFireAfter_Context + RtemsTimerReqFireAfter_Instance; + +static const char * const RtemsTimerReqFireAfter_PreDesc_Ticks[] = { + "Valid", + "Is0", + "NA" +}; + +static const char * const RtemsTimerReqFireAfter_PreDesc_Routine[] = { + "Valid", + "Null", + "NA" +}; + +static const char * const RtemsTimerReqFireAfter_PreDesc_Id[] = { + "Valid", + "Invalid", + "NA" +}; + +static const char * const RtemsTimerReqFireAfter_PreDesc_Context[] = { + "None", + "Interrupt", + "Server", + "NA" +}; + +static const char * const RtemsTimerReqFireAfter_PreDesc_Clock[] = { + "None", + "Ticks", + "Realtime", + "NA" +}; + +static const char * const RtemsTimerReqFireAfter_PreDesc_State[] = { + "Inactive", + "Scheduled", + "Pending", + "NA" +}; + +static const char * const * const RtemsTimerReqFireAfter_PreDesc[] = { + RtemsTimerReqFireAfter_PreDesc_Ticks, + RtemsTimerReqFireAfter_PreDesc_Routine, + RtemsTimerReqFireAfter_PreDesc_Id, + RtemsTimerReqFireAfter_PreDesc_Context, + RtemsTimerReqFireAfter_PreDesc_Clock, + RtemsTimerReqFireAfter_PreDesc_State, + NULL +}; + +static const rtems_time_of_day tod_now = { 2000, 1, 1, 0, 0, 0, 0 }; +static const rtems_time_of_day tod_schedule = { 2000, 1, 1, 1, 0, 0, 0 }; +static const rtems_time_of_day tod_fire = { 2000, 1, 2, 0, 0, 0, 0 }; + +static Scheduling_Ticks TriggerTimer( const RtemsTimerReqFireAfter_Context *ctx ) +{ + int ticks_fired = SCHEDULE_NONE; + int invocations_old = ctx->invocations; + + /* Fire the timer service routine for ticks and realtime clock */ + int i; + for ( i = 1; i <= SCHEDULE_MAX; ++i ) { + ClockTick(); + if ( ctx->invocations > invocations_old ) { + ticks_fired = i; + break; + } + } + + T_rsc_success( rtems_clock_set( &tod_fire ) ); + + return ticks_fired; +} + +static void TimerServiceRoutine( + rtems_id timer_id, + void *user_data +) +{ + RtemsTimerReqFireAfter_Context *ctx = user_data; + ++( ctx->invocations ); + ctx->routine_user_data = user_data; +} + +static void RtemsTimerReqFireAfter_Pre_Ticks_Prepare( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Pre_Ticks state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Pre_Ticks_Valid: { + /* + * While the ``ticks`` parameter is a positive (greater 0) number. + */ + ctx->ticks_param = SCHEDULE_LATER; + break; + } + + case RtemsTimerReqFireAfter_Pre_Ticks_Is0: { + /* + * While the ``ticks`` parameter is 0. + */ + ctx->ticks_param = 0; + break; + } + + case RtemsTimerReqFireAfter_Pre_Ticks_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Pre_Routine_Prepare( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Pre_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Pre_Routine_Valid: { + /* + * While the ``routine`` parameter references an object of type + * rtems_timer_service_routine_entry. + */ + ctx->routine_param = TimerServiceRoutine; + break; + } + + case RtemsTimerReqFireAfter_Pre_Routine_Null: { + /* + * While the ``routine`` parameter is NULL.. + */ + ctx->routine_param = NULL; + break; + } + + case RtemsTimerReqFireAfter_Pre_Routine_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Pre_Id_Prepare( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Pre_Id state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Pre_Id_Valid: { + /* + * While the ``id`` parameter is valid. + */ + ctx->id_param = ctx->timer_id; + break; + } + + case RtemsTimerReqFireAfter_Pre_Id_Invalid: { + /* + * While the ``id`` parameter is invalid. + */ + ctx->id_param = RTEMS_ID_NONE; + break; + } + + case RtemsTimerReqFireAfter_Pre_Id_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Pre_Context_Prepare( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Pre_Context state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Pre_Context_None: { + /* + * While the Timer Service Routine has never been scheduled since + * creation of the timer. See also none. + */ + ctx->pre_cond_contex = PRE_NONE; + break; + } + + case RtemsTimerReqFireAfter_Pre_Context_Interrupt: { + /* + * While the timer is in interrupt context. + */ + ctx->pre_cond_contex = PRE_INTERRUPT; + break; + } + + case RtemsTimerReqFireAfter_Pre_Context_Server: { + /* + * While the timer is in server context. + */ + ctx->pre_cond_contex = PRE_SERVER; + break; + } + + case RtemsTimerReqFireAfter_Pre_Context_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Pre_Clock_Prepare( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Pre_Clock state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Pre_Clock_None: { + /* + * While the timer has never been scheduled since creation of the timer. + */ + T_eq_int( ctx->pre_cond_contex, PRE_NONE ); + break; + } + + case RtemsTimerReqFireAfter_Pre_Clock_Ticks: { + /* + * While the clock used to determine when the timer will fire is the + * ticks based clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_after( + ctx->timer_id, + SCHEDULE_SOON, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_after( + ctx->timer_id, + SCHEDULE_SOON, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqFireAfter_Pre_Clock_Realtime: { + /* + * While the clock used to determine when the timer will fire is the + * realtime clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqFireAfter_Pre_Clock_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Pre_State_Prepare( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Pre_State state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Pre_State_Inactive: { + /* + * While the timer is in inactive state. + */ + TriggerTimer( ctx ); + T_eq_int( + ctx->invocations, + ( ctx->pre_cond_contex == PRE_NONE ) ? 0 : 1 + ); + ctx->invocations = 0; + ctx->pre_state = TIMER_INACTIVE; + break; + } + + case RtemsTimerReqFireAfter_Pre_State_Scheduled: { + /* + * While the timer is in scheduled state. + */ + /* The timer was already scheduled in the "Clock" pre-conditions. */ + ctx->pre_state = TIMER_SCHEDULED; + break; + } + + case RtemsTimerReqFireAfter_Pre_State_Pending: { + /* + * While the timer is in pending state. + */ + T_rsc_success( rtems_task_suspend( GetTimerServerTaskId() ) ); + TriggerTimer( ctx ); + T_eq_int( ctx->invocations, 0 ); + ctx->pre_state = TIMER_PENDING; + break; + } + + case RtemsTimerReqFireAfter_Pre_State_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Post_Status_Check( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Post_Status_Ok: { + /* + * The return status of rtems_timer_fire_after() shall be + * RTEMS_SUCCESSFUL. + */ + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqFireAfter_Post_Status_InvId: { + /* + * The return status of rtems_timer_fire_after() shall be + * RTEMS_INVALID_ID. + */ + T_rsc( ctx->status, RTEMS_INVALID_ID ); + break; + } + + case RtemsTimerReqFireAfter_Post_Status_InvAddr: { + /* + * The return status of rtems_timer_fire_after() shall be + * RTEMS_INVALID_ADDRESS. + */ + T_rsc( ctx->status, RTEMS_INVALID_ADDRESS ); + break; + } + + case RtemsTimerReqFireAfter_Post_Status_InvNum: { + /* + * The return status of rtems_timer_fire_after() shall be + * RTEMS_INVALID_NUMBER. + */ + T_rsc( ctx->status, RTEMS_INVALID_NUMBER ); + break; + } + + case RtemsTimerReqFireAfter_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Post_Context_Check( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Post_Context state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqFireAfter_Post_Context_None: { + /* + * The timer shall have never been scheduled. See also none. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqFireAfter_Post_Context_Interrupt: { + /* + * The timer shall be in interrupt context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, 0 ); + break; + } + + case RtemsTimerReqFireAfter_Post_Context_Server: { + /* + * The timer shall be in server context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, TIMER_CLASS_BIT_ON_TASK ); + break; + } + + case RtemsTimerReqFireAfter_Post_Context_Nop: { + /* + * Objects referenced by the parameters in the past call to + * rtems_timer_fire_after() shall not be accessed by the + * rtems_timer_fire_after() call. See also Nop. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqFireAfter_Post_Context_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Post_Clock_Check( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Post_Clock state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqFireAfter_Post_Clock_None: { + /* + * The timer shall have never been scheduled. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqFireAfter_Post_Clock_Ticks: { + /* + * The timer shall use the ticks based clock. + */ + T_eq_int( class & TIMER_CLASS_BIT_TIME_OF_DAY, 0 ); + break; + } + + case RtemsTimerReqFireAfter_Post_Clock_Realtime: { + /* + * The timer shall use the realtime clock. + */ + T_eq_int( + class & TIMER_CLASS_BIT_TIME_OF_DAY, + TIMER_CLASS_BIT_TIME_OF_DAY + ); + break; + } + + case RtemsTimerReqFireAfter_Post_Clock_Nop: { + /* + * Objects referenced by the parameters in the past call to + * rtems_timer_fire_after() shall not be accessed by the + * rtems_timer_fire_after() call. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqFireAfter_Post_Clock_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Post_State_Check( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Post_State state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Post_State_Scheduled: { + /* + * The timer shall be in scheduled state. + */ + ctx->ticks_till_fire = TriggerTimer( ctx ); + T_eq_int( ctx->invocations, 1 ); + break; + } + + case RtemsTimerReqFireAfter_Post_State_Nop: { + /* + * Objects referenced by the parameters in the past call to + * rtems_timer_fire_after() shall not be accessed by the + * rtems_timer_fire_after() call. + */ + T_eq_int( ctx->post_state, ctx->pre_state ); + break; + } + + case RtemsTimerReqFireAfter_Post_State_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Post_Interval_Check( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Post_Interval state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Post_Interval_Param: { + /* + * The Timer Service Routine shall be invoked the number of ticks (see + * tick), which are provided by the ``ticks`` parameter in the past call + * to rtems_timer_fire_after(), after a point in time during the + * execution of the rtems_timer_fire_after() call. + */ + T_eq_int( ctx->ticks_till_fire, ctx->ticks_param ); + break; + } + + case RtemsTimerReqFireAfter_Post_Interval_Nop: { + /* + * If and when the Timer Service Routine will be invoked shall not be + * changed by the past call to rtems_timer_fire_after(). + */ + /* + * Whether the timer is scheduled has already been tested by the + * "Nop" "State" post-condition above. + */ + T_eq_u32( + ctx->post_scheduling_data.interval, + ctx->pre_scheduling_data.interval + ); + break; + } + + case RtemsTimerReqFireAfter_Post_Interval_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Post_Routine_Check( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Post_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Post_Routine_Param: { + /* + * The function reference used to invoke the Timer Service Routine when + * the timer will fire shall be the one provided by the ``routine`` + * parameter in the past call to rtems_timer_fire_after(). + */ + T_eq_int( ctx->invocations, 1 ); + break; + } + + case RtemsTimerReqFireAfter_Post_Routine_Nop: { + /* + * The function reference used for any invocation of the Timer Service + * Routine shall not be changed by the past call to + * rtems_timer_fire_after(). + */ + T_eq_ptr( + ctx->post_scheduling_data.routine, + ctx->pre_scheduling_data.routine + ); + break; + } + + case RtemsTimerReqFireAfter_Post_Routine_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Post_UserData_Check( + RtemsTimerReqFireAfter_Context *ctx, + RtemsTimerReqFireAfter_Post_UserData state +) +{ + switch ( state ) { + case RtemsTimerReqFireAfter_Post_UserData_Param: { + /* + * The user data argument for invoking the Timer Service Routine when the + * timer will fire shall be the one provided by the ``user_data`` + * parameter in the past call to rtems_timer_fire_after(). + */ + T_eq_ptr( ctx->routine_user_data, ctx ); + break; + } + + case RtemsTimerReqFireAfter_Post_UserData_Nop: { + /* + * The user data argument used for any invocation of the Timer Service + * Routine shall not be changed by the past call to + * rtems_timer_fire_after(). + */ + T_eq_ptr( + ctx->post_scheduling_data.user_data, + ctx->pre_scheduling_data.user_data + ); + break; + } + + case RtemsTimerReqFireAfter_Post_UserData_NA: + break; + } +} + +static void RtemsTimerReqFireAfter_Setup( RtemsTimerReqFireAfter_Context *ctx ) +{ + rtems_status_code status; + status = rtems_timer_initiate_server( + RTEMS_TIMER_SERVER_DEFAULT_PRIORITY, + RTEMS_MINIMUM_STACK_SIZE, + RTEMS_DEFAULT_ATTRIBUTES + ); + T_rsc_success( status ); +} + +static void RtemsTimerReqFireAfter_Setup_Wrap( void *arg ) +{ + RtemsTimerReqFireAfter_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqFireAfter_Setup( ctx ); +} + +/** + * @brief Make sure the timer server is not running and the realtime clock is + * not set after this test. + */ +static void RtemsTimerReqFireAfter_Teardown( + RtemsTimerReqFireAfter_Context *ctx +) +{ + DeleteTimerServer(); + UnsetClock(); +} + +static void RtemsTimerReqFireAfter_Teardown_Wrap( void *arg ) +{ + RtemsTimerReqFireAfter_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqFireAfter_Teardown( ctx ); +} + +static void RtemsTimerReqFireAfter_Prepare( + RtemsTimerReqFireAfter_Context *ctx +) +{ + rtems_status_code status; + status = rtems_timer_create( + rtems_build_name( 'T', 'I', 'M', 'E' ), + &ctx->timer_id + ); + T_rsc_success( status ); + + ctx->invocations = 0; + ctx->ticks_till_fire = SCHEDULE_NONE; + ctx->routine_user_data = NULL; + T_rsc_success( rtems_clock_set( &tod_now ) ); +} + +static void RtemsTimerReqFireAfter_Action( + RtemsTimerReqFireAfter_Context *ctx +) +{ + GetTimerSchedulingData( ctx->timer_id, &ctx->pre_scheduling_data ); + ctx->pre_class = GetTimerClass( ctx->timer_id ); + ctx->status = rtems_timer_fire_after( + ctx->id_param, + ctx->ticks_param, + ctx->routine_param, + ctx + ); + ctx->post_state = GetTimerState( ctx->timer_id ); + GetTimerSchedulingData( ctx->timer_id, &ctx->post_scheduling_data ); + /* Ignoring return status: the timer server task may be suspended or not. */ + rtems_task_resume( GetTimerServerTaskId() ); +} + +static void RtemsTimerReqFireAfter_Cleanup( + RtemsTimerReqFireAfter_Context *ctx +) +{ + T_rsc_success( rtems_timer_delete( ctx->timer_id ) ); +} + +static const RtemsTimerReqFireAfter_Entry +RtemsTimerReqFireAfter_Entries[] = { + { 1, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireAfter_Post_Status_NA, + RtemsTimerReqFireAfter_Post_Context_NA, + RtemsTimerReqFireAfter_Post_Clock_NA, RtemsTimerReqFireAfter_Post_State_NA, + RtemsTimerReqFireAfter_Post_Interval_NA, + RtemsTimerReqFireAfter_Post_Routine_NA, + RtemsTimerReqFireAfter_Post_UserData_NA }, + { 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireAfter_Post_Status_InvNum, + RtemsTimerReqFireAfter_Post_Context_Nop, + RtemsTimerReqFireAfter_Post_Clock_Nop, + RtemsTimerReqFireAfter_Post_State_Nop, + RtemsTimerReqFireAfter_Post_Interval_Nop, + RtemsTimerReqFireAfter_Post_Routine_Nop, + RtemsTimerReqFireAfter_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireAfter_Post_Status_InvAddr, + RtemsTimerReqFireAfter_Post_Context_Nop, + RtemsTimerReqFireAfter_Post_Clock_Nop, + RtemsTimerReqFireAfter_Post_State_Nop, + RtemsTimerReqFireAfter_Post_Interval_Nop, + RtemsTimerReqFireAfter_Post_Routine_Nop, + RtemsTimerReqFireAfter_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireAfter_Post_Status_Ok, + RtemsTimerReqFireAfter_Post_Context_Interrupt, + RtemsTimerReqFireAfter_Post_Clock_Ticks, + RtemsTimerReqFireAfter_Post_State_Scheduled, + RtemsTimerReqFireAfter_Post_Interval_Param, + RtemsTimerReqFireAfter_Post_Routine_Param, + RtemsTimerReqFireAfter_Post_UserData_Param }, + { 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireAfter_Post_Status_InvId, + RtemsTimerReqFireAfter_Post_Context_Nop, + RtemsTimerReqFireAfter_Post_Clock_Nop, + RtemsTimerReqFireAfter_Post_State_Nop, + RtemsTimerReqFireAfter_Post_Interval_Nop, + RtemsTimerReqFireAfter_Post_Routine_Nop, + RtemsTimerReqFireAfter_Post_UserData_Nop } +}; + +static const uint8_t +RtemsTimerReqFireAfter_Map[] = { + 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 3, 3, 3, 3, 3, + 3, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, 0, 0, 4, 4, 4, 4, + 4, 4, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 2, 2, 0, 0, 0, 0, 2, 2, 2, + 2, 2, 2, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 2, 2, 0, 0, 0, 0, 2, 2, + 2, 2, 2, 2, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 1, + 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, + 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, + 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, + 0, 0, 1, 1, 1, 1, 1, 1 +}; + +static size_t RtemsTimerReqFireAfter_Scope( void *arg, char *buf, size_t n ) +{ + RtemsTimerReqFireAfter_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( RtemsTimerReqFireAfter_PreDesc, buf, n, ctx->Map.pcs ); + } + + return 0; +} + +static T_fixture RtemsTimerReqFireAfter_Fixture = { + .setup = RtemsTimerReqFireAfter_Setup_Wrap, + .stop = NULL, + .teardown = RtemsTimerReqFireAfter_Teardown_Wrap, + .scope = RtemsTimerReqFireAfter_Scope, + .initial_context = &RtemsTimerReqFireAfter_Instance +}; + +static inline RtemsTimerReqFireAfter_Entry RtemsTimerReqFireAfter_PopEntry( + RtemsTimerReqFireAfter_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqFireAfter_Entries[ + RtemsTimerReqFireAfter_Map[ index ] + ]; +} + +static void RtemsTimerReqFireAfter_TestVariant( + RtemsTimerReqFireAfter_Context *ctx +) +{ + RtemsTimerReqFireAfter_Pre_Ticks_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqFireAfter_Pre_Routine_Prepare( ctx, ctx->Map.pcs[ 1 ] ); + RtemsTimerReqFireAfter_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 2 ] ); + RtemsTimerReqFireAfter_Pre_Context_Prepare( ctx, ctx->Map.pcs[ 3 ] ); + RtemsTimerReqFireAfter_Pre_Clock_Prepare( ctx, ctx->Map.pcs[ 4 ] ); + RtemsTimerReqFireAfter_Pre_State_Prepare( ctx, ctx->Map.pcs[ 5 ] ); + RtemsTimerReqFireAfter_Action( ctx ); + RtemsTimerReqFireAfter_Post_Status_Check( ctx, ctx->Map.entry.Post_Status ); + RtemsTimerReqFireAfter_Post_Context_Check( + ctx, + ctx->Map.entry.Post_Context + ); + RtemsTimerReqFireAfter_Post_Clock_Check( ctx, ctx->Map.entry.Post_Clock ); + RtemsTimerReqFireAfter_Post_State_Check( ctx, ctx->Map.entry.Post_State ); + RtemsTimerReqFireAfter_Post_Interval_Check( + ctx, + ctx->Map.entry.Post_Interval + ); + RtemsTimerReqFireAfter_Post_Routine_Check( + ctx, + ctx->Map.entry.Post_Routine + ); + RtemsTimerReqFireAfter_Post_UserData_Check( + ctx, + ctx->Map.entry.Post_UserData + ); +} + +/** + * @fn void T_case_body_RtemsTimerReqFireAfter( void ) + */ +T_TEST_CASE_FIXTURE( RtemsTimerReqFireAfter, &RtemsTimerReqFireAfter_Fixture ) +{ + RtemsTimerReqFireAfter_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqFireAfter_Pre_Ticks_Valid; + ctx->Map.pcs[ 0 ] < RtemsTimerReqFireAfter_Pre_Ticks_NA; + ++ctx->Map.pcs[ 0 ] + ) { + for ( + ctx->Map.pcs[ 1 ] = RtemsTimerReqFireAfter_Pre_Routine_Valid; + ctx->Map.pcs[ 1 ] < RtemsTimerReqFireAfter_Pre_Routine_NA; + ++ctx->Map.pcs[ 1 ] + ) { + for ( + ctx->Map.pcs[ 2 ] = RtemsTimerReqFireAfter_Pre_Id_Valid; + ctx->Map.pcs[ 2 ] < RtemsTimerReqFireAfter_Pre_Id_NA; + ++ctx->Map.pcs[ 2 ] + ) { + for ( + ctx->Map.pcs[ 3 ] = RtemsTimerReqFireAfter_Pre_Context_None; + ctx->Map.pcs[ 3 ] < RtemsTimerReqFireAfter_Pre_Context_NA; + ++ctx->Map.pcs[ 3 ] + ) { + for ( + ctx->Map.pcs[ 4 ] = RtemsTimerReqFireAfter_Pre_Clock_None; + ctx->Map.pcs[ 4 ] < RtemsTimerReqFireAfter_Pre_Clock_NA; + ++ctx->Map.pcs[ 4 ] + ) { + for ( + ctx->Map.pcs[ 5 ] = RtemsTimerReqFireAfter_Pre_State_Inactive; + ctx->Map.pcs[ 5 ] < RtemsTimerReqFireAfter_Pre_State_NA; + ++ctx->Map.pcs[ 5 ] + ) { + ctx->Map.entry = RtemsTimerReqFireAfter_PopEntry( ctx ); + + if ( ctx->Map.entry.Skip ) { + continue; + } + + RtemsTimerReqFireAfter_Prepare( ctx ); + RtemsTimerReqFireAfter_TestVariant( ctx ); + RtemsTimerReqFireAfter_Cleanup( ctx ); + } + } + } + } + } + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-fire-when.c b/testsuites/validation/tc-timer-fire-when.c new file mode 100644 index 0000000000..8d5584ebf0 --- /dev/null +++ b/testsuites/validation/tc-timer-fire-when.c @@ -0,0 +1,1286 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqFireWhen + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> + +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqFireWhen spec:/rtems/timer/req/fire-when + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqFireWhen_Pre_RtClock_Set, + RtemsTimerReqFireWhen_Pre_RtClock_Unset, + RtemsTimerReqFireWhen_Pre_RtClock_NA +} RtemsTimerReqFireWhen_Pre_RtClock; + +typedef enum { + RtemsTimerReqFireWhen_Pre_Routine_Valid, + RtemsTimerReqFireWhen_Pre_Routine_Null, + RtemsTimerReqFireWhen_Pre_Routine_NA +} RtemsTimerReqFireWhen_Pre_Routine; + +typedef enum { + RtemsTimerReqFireWhen_Pre_WallTime_Valid, + RtemsTimerReqFireWhen_Pre_WallTime_Invalid, + RtemsTimerReqFireWhen_Pre_WallTime_Past, + RtemsTimerReqFireWhen_Pre_WallTime_Null, + RtemsTimerReqFireWhen_Pre_WallTime_NA +} RtemsTimerReqFireWhen_Pre_WallTime; + +typedef enum { + RtemsTimerReqFireWhen_Pre_Id_Valid, + RtemsTimerReqFireWhen_Pre_Id_Invalid, + RtemsTimerReqFireWhen_Pre_Id_NA +} RtemsTimerReqFireWhen_Pre_Id; + +typedef enum { + RtemsTimerReqFireWhen_Pre_Context_None, + RtemsTimerReqFireWhen_Pre_Context_Interrupt, + RtemsTimerReqFireWhen_Pre_Context_Server, + RtemsTimerReqFireWhen_Pre_Context_NA +} RtemsTimerReqFireWhen_Pre_Context; + +typedef enum { + RtemsTimerReqFireWhen_Pre_Clock_None, + RtemsTimerReqFireWhen_Pre_Clock_Ticks, + RtemsTimerReqFireWhen_Pre_Clock_Realtime, + RtemsTimerReqFireWhen_Pre_Clock_NA +} RtemsTimerReqFireWhen_Pre_Clock; + +typedef enum { + RtemsTimerReqFireWhen_Pre_State_Inactive, + RtemsTimerReqFireWhen_Pre_State_Scheduled, + RtemsTimerReqFireWhen_Pre_State_Pending, + RtemsTimerReqFireWhen_Pre_State_NA +} RtemsTimerReqFireWhen_Pre_State; + +typedef enum { + RtemsTimerReqFireWhen_Post_Status_Ok, + RtemsTimerReqFireWhen_Post_Status_NotDef, + RtemsTimerReqFireWhen_Post_Status_InvId, + RtemsTimerReqFireWhen_Post_Status_InvAddr, + RtemsTimerReqFireWhen_Post_Status_InvClock, + RtemsTimerReqFireWhen_Post_Status_NA +} RtemsTimerReqFireWhen_Post_Status; + +typedef enum { + RtemsTimerReqFireWhen_Post_Context_None, + RtemsTimerReqFireWhen_Post_Context_Interrupt, + RtemsTimerReqFireWhen_Post_Context_Server, + RtemsTimerReqFireWhen_Post_Context_Nop, + RtemsTimerReqFireWhen_Post_Context_NA +} RtemsTimerReqFireWhen_Post_Context; + +typedef enum { + RtemsTimerReqFireWhen_Post_Clock_None, + RtemsTimerReqFireWhen_Post_Clock_Ticks, + RtemsTimerReqFireWhen_Post_Clock_Realtime, + RtemsTimerReqFireWhen_Post_Clock_Nop, + RtemsTimerReqFireWhen_Post_Clock_NA +} RtemsTimerReqFireWhen_Post_Clock; + +typedef enum { + RtemsTimerReqFireWhen_Post_State_Scheduled, + RtemsTimerReqFireWhen_Post_State_Nop, + RtemsTimerReqFireWhen_Post_State_NA +} RtemsTimerReqFireWhen_Post_State; + +typedef enum { + RtemsTimerReqFireWhen_Post_WallTime_Param, + RtemsTimerReqFireWhen_Post_WallTime_Nop, + RtemsTimerReqFireWhen_Post_WallTime_NA +} RtemsTimerReqFireWhen_Post_WallTime; + +typedef enum { + RtemsTimerReqFireWhen_Post_Routine_Param, + RtemsTimerReqFireWhen_Post_Routine_Nop, + RtemsTimerReqFireWhen_Post_Routine_NA +} RtemsTimerReqFireWhen_Post_Routine; + +typedef enum { + RtemsTimerReqFireWhen_Post_UserData_Param, + RtemsTimerReqFireWhen_Post_UserData_Nop, + RtemsTimerReqFireWhen_Post_UserData_NA +} RtemsTimerReqFireWhen_Post_UserData; + +typedef struct { + uint32_t Skip : 1; + uint32_t Pre_RtClock_NA : 1; + uint32_t Pre_Routine_NA : 1; + uint32_t Pre_WallTime_NA : 1; + uint32_t Pre_Id_NA : 1; + uint32_t Pre_Context_NA : 1; + uint32_t Pre_Clock_NA : 1; + uint32_t Pre_State_NA : 1; + uint32_t Post_Status : 3; + uint32_t Post_Context : 3; + uint32_t Post_Clock : 3; + uint32_t Post_State : 2; + uint32_t Post_WallTime : 2; + uint32_t Post_Routine : 2; + uint32_t Post_UserData : 2; +} RtemsTimerReqFireWhen_Entry; + +typedef enum { + PRE_NONE = 0, + PRE_INTERRUPT = 1, + PRE_SERVER = 2 +} PreConditionContext; + +typedef enum { + SCHEDULE_NONE = 0, + SCHEDULE_SOON = 1, + SCHEDULE_MAX = 5 +} Scheduling_Ticks; + +/** + * @brief Test context for spec:/rtems/timer/req/fire-when test case. + */ +typedef struct { + /** + * @brief This member contains a valid id of a timer. + */ + rtems_id timer_id; + + /** + * @brief This member specifies the ``id`` parameter for the action. + */ + rtems_id id_param; + + /** + * @brief This member specifies the ``wall_time`` parameter for the action. + */ + const rtems_time_of_day *wall_time_param; + + /** + * @brief This member specifies the ``routine`` parameter for the action. + */ + rtems_timer_service_routine_entry routine_param; + + /** + * @brief This member contains the returned status code of the action. + */ + rtems_status_code status; + + /** + * @brief This member contains a counter of invocations of the Timer Service + * Routine. + */ + int invocations; + + /** + * @brief Function TriggerTimer() is used to figure out when the Timer + * Service Routine gets executed. This member contains the time-of-day when + * the Timer Service Routine fires (see fire). + */ + rtems_time_of_day tod_till_fire; + + /** + * @brief This member contains the user data given to the Timer Service + * Routine when called. + */ + void *routine_user_data; + + /** + * @brief This member specifies which pre-condition context (none, interrupt + * context, server context) must be created before the + * rtems_timer_fire_when() action gets executed. + */ + PreConditionContext pre_cond_contex; + + /** + * @brief This member specifies the pre-condition state of the realtime + * clock. It should either be set to the value referenced by pre_cond_tod + * or if NULL, then the realtime clock should be not set. + */ + const rtems_time_of_day *pre_cond_tod; + + /** + * @brief This member stores internal clock and context settings of the timer + * before the execution of the test action. + */ + Timer_Classes pre_class; + + /** + * @brief This member stores the state of the timer before the execution of + * the test action. + */ + Timer_States pre_state; + + /** + * @brief This member stores the state of the timer after the execution of + * the test action. + */ + Timer_States post_state; + + /** + * @brief This member stores the scheduling data of the timer before the + * execution of the test action. + */ + Timer_Scheduling_Data pre_scheduling_data; + + /** + * @brief This member stores the scheduling data of the timer after the + * execution of the test action. + */ + Timer_Scheduling_Data post_scheduling_data; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 7 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqFireWhen_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqFireWhen_Context; + +static RtemsTimerReqFireWhen_Context + RtemsTimerReqFireWhen_Instance; + +static const char * const RtemsTimerReqFireWhen_PreDesc_RtClock[] = { + "Set", + "Unset", + "NA" +}; + +static const char * const RtemsTimerReqFireWhen_PreDesc_Routine[] = { + "Valid", + "Null", + "NA" +}; + +static const char * const RtemsTimerReqFireWhen_PreDesc_WallTime[] = { + "Valid", + "Invalid", + "Past", + "Null", + "NA" +}; + +static const char * const RtemsTimerReqFireWhen_PreDesc_Id[] = { + "Valid", + "Invalid", + "NA" +}; + +static const char * const RtemsTimerReqFireWhen_PreDesc_Context[] = { + "None", + "Interrupt", + "Server", + "NA" +}; + +static const char * const RtemsTimerReqFireWhen_PreDesc_Clock[] = { + "None", + "Ticks", + "Realtime", + "NA" +}; + +static const char * const RtemsTimerReqFireWhen_PreDesc_State[] = { + "Inactive", + "Scheduled", + "Pending", + "NA" +}; + +static const char * const * const RtemsTimerReqFireWhen_PreDesc[] = { + RtemsTimerReqFireWhen_PreDesc_RtClock, + RtemsTimerReqFireWhen_PreDesc_Routine, + RtemsTimerReqFireWhen_PreDesc_WallTime, + RtemsTimerReqFireWhen_PreDesc_Id, + RtemsTimerReqFireWhen_PreDesc_Context, + RtemsTimerReqFireWhen_PreDesc_Clock, + RtemsTimerReqFireWhen_PreDesc_State, + NULL +}; + +static const rtems_time_of_day tod_now = { 2000, 1, 1, 0, 0, 0, 0 }; +static const rtems_time_of_day tod_schedule = { 2000, 1, 1, 5, 0, 0, 0 }; +static const rtems_time_of_day tod_invalid = { 1985, 1, 1, 0, 0, 0, 0 }; +/* + * rtems_fire_when() ignores ticks and treads all wall times in the + * current second like being in the "past". This border case is tested. + */ +static const rtems_time_of_day tod_past = { 2000, 1, 1, 0, 0, 0, 50 }; + +static void TriggerTimer( + const RtemsTimerReqFireWhen_Context *ctx, + rtems_time_of_day *tod_fire +) +{ + rtems_time_of_day tod = tod_now; + int invocations_old = ctx->invocations; + int i; + + /* Fire the timer service routine for ticks and realtime clock */ + for ( i = 1; i <= SCHEDULE_MAX; ++i ) { + ClockTick(); + } + + for ( i = 1; i < 24; ++i ) { + tod.hour = i; + T_rsc_success( rtems_clock_set( &tod ) ); + if ( tod_fire != NULL && ctx->invocations > invocations_old ) { + *tod_fire = tod; + break; + } + } +} + +static void TimerServiceRoutine( + rtems_id timer_id, + void *user_data +) +{ + RtemsTimerReqFireWhen_Context *ctx = user_data; + ++( ctx->invocations ); + ctx->routine_user_data = user_data; +} + +static void RtemsTimerReqFireWhen_Pre_RtClock_Prepare( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Pre_RtClock state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Pre_RtClock_Set: { + /* + * While the realtime clock is set to a valid time-of-day. + */ + ctx->pre_cond_tod = &tod_now; + break; + } + + case RtemsTimerReqFireWhen_Pre_RtClock_Unset: { + /* + * While the realtime clock has never been set. + */ + ctx->pre_cond_tod = NULL; + break; + } + + case RtemsTimerReqFireWhen_Pre_RtClock_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Pre_Routine_Prepare( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Pre_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Pre_Routine_Valid: { + /* + * While the ``routine`` parameter references an object of type + * rtems_timer_service_routine_entry. + */ + ctx->routine_param = TimerServiceRoutine; + break; + } + + case RtemsTimerReqFireWhen_Pre_Routine_Null: { + /* + * While the ``routine`` parameter is NULL.. + */ + ctx->routine_param = NULL; + break; + } + + case RtemsTimerReqFireWhen_Pre_Routine_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Pre_WallTime_Prepare( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Pre_WallTime state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Pre_WallTime_Valid: { + /* + * While the ``wall_time`` parameter references a time at least one + * second in the future but not later than the last second of the year + * 2105. (Times after 2105 are invalid.) + */ + ctx->wall_time_param = &tod_schedule; + break; + } + + case RtemsTimerReqFireWhen_Pre_WallTime_Invalid: { + /* + * While the ``wall_time`` parameter is invalid. + */ + ctx->wall_time_param = &tod_invalid; + break; + } + + case RtemsTimerReqFireWhen_Pre_WallTime_Past: { + /* + * While the ``wall_time`` parameter references a time in the current + * second or in the past but not earlier than 1988. (Times before 1988 + * are invalid.) + */ + ctx->wall_time_param = &tod_past; + break; + } + + case RtemsTimerReqFireWhen_Pre_WallTime_Null: { + /* + * While the ``wall_time`` parameter is 0. + */ + ctx->wall_time_param = NULL; + break; + } + + case RtemsTimerReqFireWhen_Pre_WallTime_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Pre_Id_Prepare( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Pre_Id state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Pre_Id_Valid: { + /* + * While the ``id`` parameter is valid. + */ + ctx->id_param = ctx->timer_id; + break; + } + + case RtemsTimerReqFireWhen_Pre_Id_Invalid: { + /* + * While the ``id`` parameter is invalid. + */ + ctx->id_param = RTEMS_ID_NONE; + break; + } + + case RtemsTimerReqFireWhen_Pre_Id_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Pre_Context_Prepare( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Pre_Context state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Pre_Context_None: { + /* + * While the Timer Service Routine has never been scheduled since + * creation of the timer. See also none. + */ + ctx->pre_cond_contex = PRE_NONE; + break; + } + + case RtemsTimerReqFireWhen_Pre_Context_Interrupt: { + /* + * While the timer is in interrupt context. + */ + ctx->pre_cond_contex = PRE_INTERRUPT; + break; + } + + case RtemsTimerReqFireWhen_Pre_Context_Server: { + /* + * While the timer is in server context. + */ + ctx->pre_cond_contex = PRE_SERVER; + break; + } + + case RtemsTimerReqFireWhen_Pre_Context_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Pre_Clock_Prepare( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Pre_Clock state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Pre_Clock_None: { + /* + * While the timer has never been scheduled since creation of the timer. + */ + T_eq_int( ctx->pre_cond_contex, PRE_NONE ); + break; + } + + case RtemsTimerReqFireWhen_Pre_Clock_Ticks: { + /* + * While the clock used to determine when the timer will fire is the + * ticks based clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_after( + ctx->timer_id, + SCHEDULE_SOON, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_after( + ctx->timer_id, + SCHEDULE_SOON, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqFireWhen_Pre_Clock_Realtime: { + /* + * While the clock used to determine when the timer will fire is the + * realtime clock. + */ + rtems_status_code status; + T_rsc_success( rtems_clock_set( &tod_now ) ); + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqFireWhen_Pre_Clock_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Pre_State_Prepare( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Pre_State state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Pre_State_Inactive: { + /* + * While the timer is in inactive state. + */ + TriggerTimer( ctx, NULL ); + T_eq_int( + ctx->invocations, + ( ctx->pre_cond_contex == PRE_NONE ) ? 0 : 1 + ); + ctx->invocations = 0; + ctx->pre_state = TIMER_INACTIVE; + break; + } + + case RtemsTimerReqFireWhen_Pre_State_Scheduled: { + /* + * While the timer is in scheduled state. + */ + /* The timer was already scheduled in the "Clock" pre-conditions. */ + ctx->pre_state = TIMER_SCHEDULED; + break; + } + + case RtemsTimerReqFireWhen_Pre_State_Pending: { + /* + * While the timer is in pending state. + */ + T_rsc_success( rtems_task_suspend( GetTimerServerTaskId() ) ); + TriggerTimer( ctx, NULL ); + T_eq_int( ctx->invocations, 0 ); + ctx->pre_state = TIMER_PENDING; + break; + } + + case RtemsTimerReqFireWhen_Pre_State_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Post_Status_Check( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Post_Status_Ok: { + /* + * The return status of rtems_timer_fire_when() shall be + * RTEMS_SUCCESSFUL. + */ + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqFireWhen_Post_Status_NotDef: { + /* + * The return status of rtems_timer_fire_when() shall be + * RTEMS_NOT_DEFINED + */ + T_rsc( ctx->status, RTEMS_NOT_DEFINED ); + break; + } + + case RtemsTimerReqFireWhen_Post_Status_InvId: { + /* + * The return status of rtems_timer_fire_when() shall be + * RTEMS_INVALID_ID. + */ + T_rsc( ctx->status, RTEMS_INVALID_ID ); + break; + } + + case RtemsTimerReqFireWhen_Post_Status_InvAddr: { + /* + * The return status of rtems_timer_fire_when() shall be + * RTEMS_INVALID_ADDRESS. + */ + T_rsc( ctx->status, RTEMS_INVALID_ADDRESS ); + break; + } + + case RtemsTimerReqFireWhen_Post_Status_InvClock: { + /* + * The return status of rtems_timer_fire_when() shall be + * RTEMS_INVALID_CLOCK. + */ + T_rsc( ctx->status, RTEMS_INVALID_CLOCK ); + break; + } + + case RtemsTimerReqFireWhen_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Post_Context_Check( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Post_Context state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqFireWhen_Post_Context_None: { + /* + * The timer shall have never been scheduled. See also none. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqFireWhen_Post_Context_Interrupt: { + /* + * The timer shall be in interrupt context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, 0 ); + break; + } + + case RtemsTimerReqFireWhen_Post_Context_Server: { + /* + * The timer shall be in server context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, TIMER_CLASS_BIT_ON_TASK ); + break; + } + + case RtemsTimerReqFireWhen_Post_Context_Nop: { + /* + * Objects referenced by parameters in the past call to + * rtems_timer_fire_when() shall not be accessed by the + * rtems_timer_fire_when() call. See also Nop. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqFireWhen_Post_Context_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Post_Clock_Check( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Post_Clock state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqFireWhen_Post_Clock_None: { + /* + * The timer shall have never been scheduled. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqFireWhen_Post_Clock_Ticks: { + /* + * The timer shall use the ticks based clock. + */ + T_eq_int( class & TIMER_CLASS_BIT_TIME_OF_DAY, 0 ); + break; + } + + case RtemsTimerReqFireWhen_Post_Clock_Realtime: { + /* + * The timer shall use the realtime clock. + */ + T_eq_int( + class & TIMER_CLASS_BIT_TIME_OF_DAY, + TIMER_CLASS_BIT_TIME_OF_DAY + ); + break; + } + + case RtemsTimerReqFireWhen_Post_Clock_Nop: { + /* + * Objects referenced by parameters in the past call to + * rtems_timer_fire_when() shall not be accessed by the + * rtems_timer_fire_when() call. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqFireWhen_Post_Clock_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Post_State_Check( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Post_State state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Post_State_Scheduled: { + /* + * The timer shall be in scheduled state. + */ + TriggerTimer( ctx, &ctx->tod_till_fire ); + T_eq_int( ctx->invocations, 1 ); + break; + } + + case RtemsTimerReqFireWhen_Post_State_Nop: { + /* + * Objects referenced by parameters in the past call to + * rtems_timer_fire_when() shall not be accessed by the + * rtems_timer_fire_when() call. + */ + T_eq_int( ctx->post_state, ctx->pre_state ); + break; + } + + case RtemsTimerReqFireWhen_Post_State_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Post_WallTime_Check( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Post_WallTime state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Post_WallTime_Param: { + /* + * The Timer Service Routine shall be invoked at the wall time (see + * realtime clock) (ignoring ticks), which was provided by the + * ``wall_time`` parameter in the past call to rtems_timer_fire_when(). + */ + T_eq_mem( + &ctx->tod_till_fire, + ctx->wall_time_param, + sizeof( ctx->tod_till_fire ) + ); + break; + } + + case RtemsTimerReqFireWhen_Post_WallTime_Nop: { + /* + * If and when the Timer Service Routine will be invoked shall not be + * changed by the past call to rtems_timer_fire_when(). + */ + /* + * Whether the timer is scheduled has already been tested by the + * "Nop" "State" post-condition above. + */ + T_eq_u32( + ctx->post_scheduling_data.interval, + ctx->pre_scheduling_data.interval + ); + break; + } + + case RtemsTimerReqFireWhen_Post_WallTime_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Post_Routine_Check( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Post_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Post_Routine_Param: { + /* + * The function reference used to invoke the Timer Service Routine when + * the timer will fire shall be the one provided by the ``routine`` + * parameter in the past call to rtems_timer_fire_when(). + */ + T_eq_int( ctx->invocations, 1 ); + break; + } + + case RtemsTimerReqFireWhen_Post_Routine_Nop: { + /* + * The function reference used for any invocation of the Timer Service + * Routine shall not be changed by the past call to + * rtems_timer_fire_when(). + */ + T_eq_ptr( + ctx->post_scheduling_data.routine, + ctx->pre_scheduling_data.routine + ); + break; + } + + case RtemsTimerReqFireWhen_Post_Routine_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Post_UserData_Check( + RtemsTimerReqFireWhen_Context *ctx, + RtemsTimerReqFireWhen_Post_UserData state +) +{ + switch ( state ) { + case RtemsTimerReqFireWhen_Post_UserData_Param: { + /* + * The user data argument for invoking the Timer Service Routine when the + * timer will fire shall be the one provided by the ``user_data`` + * parameter in the past call to rtems_timer_fire_when(). + */ + T_eq_ptr( ctx->routine_user_data, ctx ); + break; + } + + case RtemsTimerReqFireWhen_Post_UserData_Nop: { + /* + * The user data argument used for any invocation of the Timer Service + * Routine shall not be changed by the past call to + * rtems_timer_fire_when(). + */ + T_eq_ptr( + ctx->post_scheduling_data.user_data, + ctx->pre_scheduling_data.user_data + ); + break; + } + + case RtemsTimerReqFireWhen_Post_UserData_NA: + break; + } +} + +static void RtemsTimerReqFireWhen_Setup( RtemsTimerReqFireWhen_Context *ctx ) +{ + rtems_status_code status; + status = rtems_timer_initiate_server( + RTEMS_TIMER_SERVER_DEFAULT_PRIORITY, + RTEMS_MINIMUM_STACK_SIZE, + RTEMS_DEFAULT_ATTRIBUTES + ); + T_rsc_success( status ); +} + +static void RtemsTimerReqFireWhen_Setup_Wrap( void *arg ) +{ + RtemsTimerReqFireWhen_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqFireWhen_Setup( ctx ); +} + +/** + * @brief Make sure the timer server is not running and the realtime clock is + * not set after this test. + */ +static void RtemsTimerReqFireWhen_Teardown( + RtemsTimerReqFireWhen_Context *ctx +) +{ + DeleteTimerServer(); + UnsetClock(); +} + +static void RtemsTimerReqFireWhen_Teardown_Wrap( void *arg ) +{ + RtemsTimerReqFireWhen_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqFireWhen_Teardown( ctx ); +} + +static void RtemsTimerReqFireWhen_Prepare( RtemsTimerReqFireWhen_Context *ctx ) +{ + rtems_status_code status; + status = rtems_timer_create( + rtems_build_name( 'T', 'I', 'M', 'E' ), + &ctx->timer_id + ); + T_rsc_success( status ); + + ctx->invocations = 0; + ctx->routine_user_data = NULL; +} + +static void RtemsTimerReqFireWhen_Action( RtemsTimerReqFireWhen_Context *ctx ) +{ + GetTimerSchedulingData( ctx->timer_id, &ctx->pre_scheduling_data ); + ctx->pre_class = GetTimerClass( ctx->timer_id ); + if ( ctx->pre_cond_tod == NULL ) { + UnsetClock(); + } else { + T_rsc_success( rtems_clock_set( ctx->pre_cond_tod ) ); + } + ctx->status = rtems_timer_fire_when( + ctx->id_param, + ctx->wall_time_param, + ctx->routine_param, + ctx + ); + ctx->post_state = GetTimerState( ctx->timer_id ); + GetTimerSchedulingData( ctx->timer_id, &ctx->post_scheduling_data ); + /* Ignoring return status: the timer server task may be suspended or not. */ + rtems_task_resume( GetTimerServerTaskId() ); +} + +static void RtemsTimerReqFireWhen_Cleanup( RtemsTimerReqFireWhen_Context *ctx ) +{ + T_rsc_success( rtems_timer_delete( ctx->timer_id ) ); +} + +static const RtemsTimerReqFireWhen_Entry +RtemsTimerReqFireWhen_Entries[] = { + { 1, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireWhen_Post_Status_NA, + RtemsTimerReqFireWhen_Post_Context_NA, RtemsTimerReqFireWhen_Post_Clock_NA, + RtemsTimerReqFireWhen_Post_State_NA, + RtemsTimerReqFireWhen_Post_WallTime_NA, + RtemsTimerReqFireWhen_Post_Routine_NA, + RtemsTimerReqFireWhen_Post_UserData_NA }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireWhen_Post_Status_InvAddr, + RtemsTimerReqFireWhen_Post_Context_Nop, + RtemsTimerReqFireWhen_Post_Clock_Nop, RtemsTimerReqFireWhen_Post_State_Nop, + RtemsTimerReqFireWhen_Post_WallTime_Nop, + RtemsTimerReqFireWhen_Post_Routine_Nop, + RtemsTimerReqFireWhen_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireWhen_Post_Status_NotDef, + RtemsTimerReqFireWhen_Post_Context_Nop, + RtemsTimerReqFireWhen_Post_Clock_Nop, RtemsTimerReqFireWhen_Post_State_Nop, + RtemsTimerReqFireWhen_Post_WallTime_Nop, + RtemsTimerReqFireWhen_Post_Routine_Nop, + RtemsTimerReqFireWhen_Post_UserData_Nop }, + { 1, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireWhen_Post_Status_NA, + RtemsTimerReqFireWhen_Post_Context_NA, RtemsTimerReqFireWhen_Post_Clock_NA, + RtemsTimerReqFireWhen_Post_State_NA, + RtemsTimerReqFireWhen_Post_WallTime_NA, + RtemsTimerReqFireWhen_Post_Routine_NA, + RtemsTimerReqFireWhen_Post_UserData_NA }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireWhen_Post_Status_InvClock, + RtemsTimerReqFireWhen_Post_Context_Nop, + RtemsTimerReqFireWhen_Post_Clock_Nop, RtemsTimerReqFireWhen_Post_State_Nop, + RtemsTimerReqFireWhen_Post_WallTime_Nop, + RtemsTimerReqFireWhen_Post_Routine_Nop, + RtemsTimerReqFireWhen_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireWhen_Post_Status_Ok, + RtemsTimerReqFireWhen_Post_Context_Interrupt, + RtemsTimerReqFireWhen_Post_Clock_Realtime, + RtemsTimerReqFireWhen_Post_State_Scheduled, + RtemsTimerReqFireWhen_Post_WallTime_Param, + RtemsTimerReqFireWhen_Post_Routine_Param, + RtemsTimerReqFireWhen_Post_UserData_Param }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqFireWhen_Post_Status_InvId, + RtemsTimerReqFireWhen_Post_Context_Nop, + RtemsTimerReqFireWhen_Post_Clock_Nop, RtemsTimerReqFireWhen_Post_State_Nop, + RtemsTimerReqFireWhen_Post_WallTime_Nop, + RtemsTimerReqFireWhen_Post_Routine_Nop, + RtemsTimerReqFireWhen_Post_UserData_Nop } +}; + +static const uint8_t +RtemsTimerReqFireWhen_Map[] = { + 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 5, 5, 0, 0, 0, 0, 5, 5, 5, 5, 5, + 5, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 6, 0, 6, 6, 0, 0, 0, 0, 6, 6, 6, 6, + 6, 6, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, 0, 0, 4, 4, 4, + 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, 0, 0, 4, 4, + 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, 0, 0, 4, + 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, 0, 0, + 4, 4, 4, 4, 4, 4, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, + 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, + 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, + 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, + 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, + 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, + 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, + 0, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, + 1, 0, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 1, 1, 0, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, 2, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, 3, + 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, 3, + 3, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, 3, + 3, 3, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, 2, + 3, 3, 3, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, 2, + 2, 3, 3, 3, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, 2, + 2, 2, 3, 3, 3, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 3, 3, 0, 0, 0, + 2, 2, 2, 3, 3, 3 +}; + +static size_t RtemsTimerReqFireWhen_Scope( void *arg, char *buf, size_t n ) +{ + RtemsTimerReqFireWhen_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( RtemsTimerReqFireWhen_PreDesc, buf, n, ctx->Map.pcs ); + } + + return 0; +} + +static T_fixture RtemsTimerReqFireWhen_Fixture = { + .setup = RtemsTimerReqFireWhen_Setup_Wrap, + .stop = NULL, + .teardown = RtemsTimerReqFireWhen_Teardown_Wrap, + .scope = RtemsTimerReqFireWhen_Scope, + .initial_context = &RtemsTimerReqFireWhen_Instance +}; + +static inline RtemsTimerReqFireWhen_Entry RtemsTimerReqFireWhen_PopEntry( + RtemsTimerReqFireWhen_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqFireWhen_Entries[ + RtemsTimerReqFireWhen_Map[ index ] + ]; +} + +static void RtemsTimerReqFireWhen_TestVariant( + RtemsTimerReqFireWhen_Context *ctx +) +{ + RtemsTimerReqFireWhen_Pre_RtClock_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqFireWhen_Pre_Routine_Prepare( ctx, ctx->Map.pcs[ 1 ] ); + RtemsTimerReqFireWhen_Pre_WallTime_Prepare( ctx, ctx->Map.pcs[ 2 ] ); + RtemsTimerReqFireWhen_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 3 ] ); + RtemsTimerReqFireWhen_Pre_Context_Prepare( ctx, ctx->Map.pcs[ 4 ] ); + RtemsTimerReqFireWhen_Pre_Clock_Prepare( ctx, ctx->Map.pcs[ 5 ] ); + RtemsTimerReqFireWhen_Pre_State_Prepare( ctx, ctx->Map.pcs[ 6 ] ); + RtemsTimerReqFireWhen_Action( ctx ); + RtemsTimerReqFireWhen_Post_Status_Check( ctx, ctx->Map.entry.Post_Status ); + RtemsTimerReqFireWhen_Post_Context_Check( ctx, ctx->Map.entry.Post_Context ); + RtemsTimerReqFireWhen_Post_Clock_Check( ctx, ctx->Map.entry.Post_Clock ); + RtemsTimerReqFireWhen_Post_State_Check( ctx, ctx->Map.entry.Post_State ); + RtemsTimerReqFireWhen_Post_WallTime_Check( + ctx, + ctx->Map.entry.Post_WallTime + ); + RtemsTimerReqFireWhen_Post_Routine_Check( ctx, ctx->Map.entry.Post_Routine ); + RtemsTimerReqFireWhen_Post_UserData_Check( + ctx, + ctx->Map.entry.Post_UserData + ); +} + +/** + * @fn void T_case_body_RtemsTimerReqFireWhen( void ) + */ +T_TEST_CASE_FIXTURE( RtemsTimerReqFireWhen, &RtemsTimerReqFireWhen_Fixture ) +{ + RtemsTimerReqFireWhen_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqFireWhen_Pre_RtClock_Set; + ctx->Map.pcs[ 0 ] < RtemsTimerReqFireWhen_Pre_RtClock_NA; + ++ctx->Map.pcs[ 0 ] + ) { + for ( + ctx->Map.pcs[ 1 ] = RtemsTimerReqFireWhen_Pre_Routine_Valid; + ctx->Map.pcs[ 1 ] < RtemsTimerReqFireWhen_Pre_Routine_NA; + ++ctx->Map.pcs[ 1 ] + ) { + for ( + ctx->Map.pcs[ 2 ] = RtemsTimerReqFireWhen_Pre_WallTime_Valid; + ctx->Map.pcs[ 2 ] < RtemsTimerReqFireWhen_Pre_WallTime_NA; + ++ctx->Map.pcs[ 2 ] + ) { + for ( + ctx->Map.pcs[ 3 ] = RtemsTimerReqFireWhen_Pre_Id_Valid; + ctx->Map.pcs[ 3 ] < RtemsTimerReqFireWhen_Pre_Id_NA; + ++ctx->Map.pcs[ 3 ] + ) { + for ( + ctx->Map.pcs[ 4 ] = RtemsTimerReqFireWhen_Pre_Context_None; + ctx->Map.pcs[ 4 ] < RtemsTimerReqFireWhen_Pre_Context_NA; + ++ctx->Map.pcs[ 4 ] + ) { + for ( + ctx->Map.pcs[ 5 ] = RtemsTimerReqFireWhen_Pre_Clock_None; + ctx->Map.pcs[ 5 ] < RtemsTimerReqFireWhen_Pre_Clock_NA; + ++ctx->Map.pcs[ 5 ] + ) { + for ( + ctx->Map.pcs[ 6 ] = RtemsTimerReqFireWhen_Pre_State_Inactive; + ctx->Map.pcs[ 6 ] < RtemsTimerReqFireWhen_Pre_State_NA; + ++ctx->Map.pcs[ 6 ] + ) { + ctx->Map.entry = RtemsTimerReqFireWhen_PopEntry( ctx ); + + if ( ctx->Map.entry.Skip ) { + continue; + } + + RtemsTimerReqFireWhen_Prepare( ctx ); + RtemsTimerReqFireWhen_TestVariant( ctx ); + RtemsTimerReqFireWhen_Cleanup( ctx ); + } + } + } + } + } + } + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-ident.c b/testsuites/validation/tc-timer-ident.c new file mode 100644 index 0000000000..5f121fc55b --- /dev/null +++ b/testsuites/validation/tc-timer-ident.c @@ -0,0 +1,114 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerValIdent + */ + +/* + * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include "tr-object-ident-local.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerValIdent spec:/rtems/timer/val/ident + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @brief Test the rtems_timer_ident() directive. + * + * This test case performs the following actions: + * + * - Run the generic object identification tests for Classic API timer class + * objects defined by /rtems/req/ident-local. + * + * @{ + */ + +static rtems_status_code ClassicTimerIdentAction( + rtems_name name, + rtems_id *id +) +{ + return rtems_timer_ident( name, id ); +} + +/** + * @brief Run the generic object identification tests for Classic API timer + * class objects defined by /rtems/req/ident-local. + */ +static void RtemsTimerValIdent_Action_0( void ) +{ + rtems_status_code sc; + rtems_id id_local_object; + + sc = rtems_timer_create( + ClassicObjectLocalIdentName, + &id_local_object + ); + T_assert_rsc_success( sc ); + + RtemsReqIdentLocal_Run( + id_local_object, + ClassicTimerIdentAction + ); + + sc = rtems_timer_delete( id_local_object ); + T_rsc_success( sc ); +} + +/** + * @fn void T_case_body_RtemsTimerValIdent( void ) + */ +T_TEST_CASE( RtemsTimerValIdent ) +{ + RtemsTimerValIdent_Action_0(); +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-initiate-server.c b/testsuites/validation/tc-timer-initiate-server.c new file mode 100644 index 0000000000..89bb445a6f --- /dev/null +++ b/testsuites/validation/tc-timer-initiate-server.c @@ -0,0 +1,817 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqInitiateServer + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> +#include <rtems/rtems/timerimpl.h> + +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqInitiateServer \ + * spec:/rtems/timer/req/initiate-server + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqInitiateServer_Pre_Priority_Valid, + RtemsTimerReqInitiateServer_Pre_Priority_Default, + RtemsTimerReqInitiateServer_Pre_Priority_Invalid, + RtemsTimerReqInitiateServer_Pre_Priority_NA +} RtemsTimerReqInitiateServer_Pre_Priority; + +typedef enum { + RtemsTimerReqInitiateServer_Pre_Stack_Allocatable, + RtemsTimerReqInitiateServer_Pre_Stack_TooLarge, + RtemsTimerReqInitiateServer_Pre_Stack_NA +} RtemsTimerReqInitiateServer_Pre_Stack; + +typedef enum { + RtemsTimerReqInitiateServer_Pre_Started_Yes, + RtemsTimerReqInitiateServer_Pre_Started_No, + RtemsTimerReqInitiateServer_Pre_Started_NA +} RtemsTimerReqInitiateServer_Pre_Started; + +typedef enum { + RtemsTimerReqInitiateServer_Pre_TaskObj_Available, + RtemsTimerReqInitiateServer_Pre_TaskObj_Unavailable, + RtemsTimerReqInitiateServer_Pre_TaskObj_NA +} RtemsTimerReqInitiateServer_Pre_TaskObj; + +typedef enum { + RtemsTimerReqInitiateServer_Post_Status_Ok, + RtemsTimerReqInitiateServer_Post_Status_IncStat, + RtemsTimerReqInitiateServer_Post_Status_InvPrio, + RtemsTimerReqInitiateServer_Post_Status_TooMany, + RtemsTimerReqInitiateServer_Post_Status_Unsat, + RtemsTimerReqInitiateServer_Post_Status_NA +} RtemsTimerReqInitiateServer_Post_Status; + +typedef enum { + RtemsTimerReqInitiateServer_Post_Started_Yes, + RtemsTimerReqInitiateServer_Post_Started_No, + RtemsTimerReqInitiateServer_Post_Started_NA +} RtemsTimerReqInitiateServer_Post_Started; + +typedef enum { + RtemsTimerReqInitiateServer_Post_TaskPrio_Set, + RtemsTimerReqInitiateServer_Post_TaskPrio_Nop, + RtemsTimerReqInitiateServer_Post_TaskPrio_NA +} RtemsTimerReqInitiateServer_Post_TaskPrio; + +typedef enum { + RtemsTimerReqInitiateServer_Post_TaskStack_Set, + RtemsTimerReqInitiateServer_Post_TaskStack_Nop, + RtemsTimerReqInitiateServer_Post_TaskStack_NA +} RtemsTimerReqInitiateServer_Post_TaskStack; + +typedef enum { + RtemsTimerReqInitiateServer_Post_TaskAttr_Set, + RtemsTimerReqInitiateServer_Post_TaskAttr_Nop, + RtemsTimerReqInitiateServer_Post_TaskAttr_NA +} RtemsTimerReqInitiateServer_Post_TaskAttr; + +typedef struct { + uint16_t Skip : 1; + uint16_t Pre_Priority_NA : 1; + uint16_t Pre_Stack_NA : 1; + uint16_t Pre_Started_NA : 1; + uint16_t Pre_TaskObj_NA : 1; + uint16_t Post_Status : 3; + uint16_t Post_Started : 2; + uint16_t Post_TaskPrio : 2; + uint16_t Post_TaskStack : 2; + uint16_t Post_TaskAttr : 2; +} RtemsTimerReqInitiateServer_Entry; + +/** + * @brief Test context for spec:/rtems/timer/req/initiate-server test case. + */ +typedef struct { + /** + * @brief If the Timer Server task exists before the action, its priority + * before the action. + */ + rtems_task_priority before_priority; + + /** + * @brief If the Timer Server task exists before the action, its stack size + * before the action. + */ + size_t before_stack_size; + + /** + * @brief If the Timer Server task exists before the action, whether the + * floating point attribute is set before the action. + */ + bool before_has_floating_point; + + /** + * @brief The ``priority`` parameter for the action. + */ + rtems_task_priority priority; + + /** + * @brief The ``stack_size`` parameter for the action. + */ + size_t stack_size; + + /** + * @brief The status value returned by the action + * rtems_timer_initiate_server(). + */ + rtems_status_code status; + + /** + * @brief This member is used by the T_seize_objects() and + * T_surrender_objects() support functions. + */ + void *task_objects; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 4 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqInitiateServer_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqInitiateServer_Context; + +static RtemsTimerReqInitiateServer_Context + RtemsTimerReqInitiateServer_Instance; + +static const char * const RtemsTimerReqInitiateServer_PreDesc_Priority[] = { + "Valid", + "Default", + "Invalid", + "NA" +}; + +static const char * const RtemsTimerReqInitiateServer_PreDesc_Stack[] = { + "Allocatable", + "TooLarge", + "NA" +}; + +static const char * const RtemsTimerReqInitiateServer_PreDesc_Started[] = { + "Yes", + "No", + "NA" +}; + +static const char * const RtemsTimerReqInitiateServer_PreDesc_TaskObj[] = { + "Available", + "Unavailable", + "NA" +}; + +static const char * const * const RtemsTimerReqInitiateServer_PreDesc[] = { + RtemsTimerReqInitiateServer_PreDesc_Priority, + RtemsTimerReqInitiateServer_PreDesc_Stack, + RtemsTimerReqInitiateServer_PreDesc_Started, + RtemsTimerReqInitiateServer_PreDesc_TaskObj, + NULL +}; + +static bool ExistTimerServer( void ) +{ + return GetTimerServerTaskId() != RTEMS_INVALID_ID; +} + +static rtems_task_priority GetTimerServerPriority( void ) +{ + return GetPriority( GetTimerServerTaskId() ); +} + +static size_t GetTimerServerStackSize( void ) +{ + rtems_tcb *tcb; + rtems_id server_task_id; + server_task_id = GetTimerServerTaskId(); + T_ne_u32( server_task_id, RTEMS_INVALID_ID ); + tcb = GetThread( server_task_id ); + T_not_null( tcb ); + return tcb->Start.Initial_stack.size; +} + +static bool HasTimerServerFloatingPoint( void ) +{ + rtems_tcb *tcb; + rtems_id server_task_id; + server_task_id = GetTimerServerTaskId(); + T_ne_u32( server_task_id, RTEMS_INVALID_ID ); + tcb = GetThread( server_task_id ); + T_not_null( tcb ); + return tcb->is_fp; +} + +static rtems_status_code AllocateTaskObject( void *arg, rtems_id *task_id ) +{ + (void) arg; + + return rtems_task_create( + rtems_build_name( 'T', 'A', ' ', 'N' ), + PRIO_LOW, + RTEMS_MINIMUM_STACK_SIZE, + RTEMS_DEFAULT_MODES, + RTEMS_DEFAULT_ATTRIBUTES, + task_id + ); +} + +static void RtemsTimerReqInitiateServer_Pre_Priority_Prepare( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Pre_Priority state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Pre_Priority_Valid: { + /* + * While the ``priority`` parameter is valid. + */ + ctx->priority = 13; + break; + } + + case RtemsTimerReqInitiateServer_Pre_Priority_Default: { + /* + * While the ``priority`` parameter is equal to + * RTEMS_TIMER_SERVER_DEFAULT_PRIORITY. + */ + ctx->priority = RTEMS_TIMER_SERVER_DEFAULT_PRIORITY; + break; + } + + case RtemsTimerReqInitiateServer_Pre_Priority_Invalid: { + /* + * While the ``priority`` parameter is invalid. + */ + ctx->priority = PRIO_INVALID; + break; + } + + case RtemsTimerReqInitiateServer_Pre_Priority_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Pre_Stack_Prepare( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Pre_Stack state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Pre_Stack_Allocatable: { + /* + * While the ``stack_size`` parameter specifies a task stack size which + * is allocatable by the system. + */ + ctx->stack_size = RTEMS_MINIMUM_STACK_SIZE; + break; + } + + case RtemsTimerReqInitiateServer_Pre_Stack_TooLarge: { + /* + * While the ``stack_size`` parameter specifies a task stack size which + * is not allocatable by the system. + */ + ctx->stack_size = SIZE_MAX; + break; + } + + case RtemsTimerReqInitiateServer_Pre_Stack_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Pre_Started_Prepare( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Pre_Started state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Pre_Started_Yes: { + /* + * While the Timer Server task is started. + */ + rtems_status_code status; + + if ( !ExistTimerServer() ) { + status = rtems_timer_initiate_server( + RTEMS_TIMER_SERVER_DEFAULT_PRIORITY, + RTEMS_MINIMUM_STACK_SIZE, + RTEMS_DEFAULT_ATTRIBUTES + ); + T_rsc_success( status ); + } + break; + } + + case RtemsTimerReqInitiateServer_Pre_Started_No: { + /* + * While the Timer Server task is not started. + */ + DeleteTimerServer(); + break; + } + + case RtemsTimerReqInitiateServer_Pre_Started_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Pre_TaskObj_Prepare( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Pre_TaskObj state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Pre_TaskObj_Available: { + /* + * While the system has at least one inactive task object available. + */ + /* The test clean up ensures that all tasks objects are free. */ + break; + } + + case RtemsTimerReqInitiateServer_Pre_TaskObj_Unavailable: { + /* + * While the system has no inactive task object available. + */ + ctx->task_objects = T_seize_objects( + AllocateTaskObject, + NULL + ); + break; + } + + case RtemsTimerReqInitiateServer_Pre_TaskObj_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Post_Status_Check( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Post_Status_Ok: { + /* + * The return status of rtems_timer_initiate_server() shall be + * RTEMS_SUCCESSFUL. + */ + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqInitiateServer_Post_Status_IncStat: { + /* + * The return status of rtems_timer_initiate_server() shall be + * RTEMS_INCORRECT_STATE + */ + T_rsc( ctx->status, RTEMS_INCORRECT_STATE ); + break; + } + + case RtemsTimerReqInitiateServer_Post_Status_InvPrio: { + /* + * The return status of rtems_timer_initiate_server() shall be + * RTEMS_INVALID_PRIORITY. + */ + T_rsc( ctx->status, RTEMS_INVALID_PRIORITY ); + break; + } + + case RtemsTimerReqInitiateServer_Post_Status_TooMany: { + /* + * The return status of rtems_timer_initiate_server() shall be + * RTEMS_TOO_MANY. + */ + T_rsc( ctx->status, RTEMS_TOO_MANY ); + break; + } + + case RtemsTimerReqInitiateServer_Post_Status_Unsat: { + /* + * The return status of rtems_timer_initiate_server() shall be + * RTEMS_UNSATISFIED. + */ + T_rsc( ctx->status, RTEMS_UNSATISFIED ); + break; + } + + case RtemsTimerReqInitiateServer_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Post_Started_Check( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Post_Started state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Post_Started_Yes: { + /* + * The Timer Server task shall be started after the + * rtems_timer_initiate_server() call. + */ + T_true( ExistTimerServer() ); + break; + } + + case RtemsTimerReqInitiateServer_Post_Started_No: { + /* + * The Timer Server task shall not be started after the + * rtems_timer_initiate_server() call. + */ + T_false( ExistTimerServer() ); + break; + } + + case RtemsTimerReqInitiateServer_Post_Started_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Post_TaskPrio_Check( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Post_TaskPrio state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Post_TaskPrio_Set: { + /* + * The priority of the Timer Server task shall be equal to the priority + * specified by the ``priority`` parameter in the + * rtems_timer_initiate_server() call. + */ + if ( ctx->priority == RTEMS_TIMER_SERVER_DEFAULT_PRIORITY ) { + T_eq_u32( GetTimerServerPriority(), 0 ); + } else { + T_eq_u32( GetTimerServerPriority(), ctx->priority ); + } + break; + } + + case RtemsTimerReqInitiateServer_Post_TaskPrio_Nop: { + /* + * The priority of the Timer Server task shall not be modified by the + * rtems_timer_initiate_server() call. + */ + T_eq_u32( GetTimerServerPriority(), ctx->before_priority ); + break; + } + + case RtemsTimerReqInitiateServer_Post_TaskPrio_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Post_TaskStack_Check( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Post_TaskStack state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Post_TaskStack_Set: { + /* + * The stack size of the Timer Server task shall be greater than or equal + * to the stack size specified by the ``stack_size`` parameter in the + * rtems_timer_initiate_server() call. + */ + T_ge_sz( GetTimerServerStackSize(), ctx->stack_size ); + break; + } + + case RtemsTimerReqInitiateServer_Post_TaskStack_Nop: { + /* + * The stack size of the Timer Server task shall not be modified by the + * rtems_timer_initiate_server() call. + */ + T_ge_sz( GetTimerServerStackSize(), ctx->before_stack_size ); + break; + } + + case RtemsTimerReqInitiateServer_Post_TaskStack_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Post_TaskAttr_Check( + RtemsTimerReqInitiateServer_Context *ctx, + RtemsTimerReqInitiateServer_Post_TaskAttr state +) +{ + switch ( state ) { + case RtemsTimerReqInitiateServer_Post_TaskAttr_Set: { + /* + * The task attributes of the Timer Server task shall be specified by the + * ``attribute_set`` parameter in the rtems_timer_initiate_server() call. + */ + T_true( HasTimerServerFloatingPoint() ); + break; + } + + case RtemsTimerReqInitiateServer_Post_TaskAttr_Nop: { + /* + * The task attributes of the Timer Server task shall not be modified by + * the rtems_timer_initiate_server() call. + */ + T_true( HasTimerServerFloatingPoint() == ctx->before_has_floating_point ); + break; + } + + case RtemsTimerReqInitiateServer_Post_TaskAttr_NA: + break; + } +} + +static void RtemsTimerReqInitiateServer_Setup( + RtemsTimerReqInitiateServer_Context *ctx +) +{ + ctx->task_objects = NULL; +} + +static void RtemsTimerReqInitiateServer_Setup_Wrap( void *arg ) +{ + RtemsTimerReqInitiateServer_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqInitiateServer_Setup( ctx ); +} + +/** + * @brief Make sure the time server in not running after this test. + */ +static void RtemsTimerReqInitiateServer_Teardown( + RtemsTimerReqInitiateServer_Context *ctx +) +{ + DeleteTimerServer(); +} + +static void RtemsTimerReqInitiateServer_Teardown_Wrap( void *arg ) +{ + RtemsTimerReqInitiateServer_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqInitiateServer_Teardown( ctx ); +} + +static void RtemsTimerReqInitiateServer_Action( + RtemsTimerReqInitiateServer_Context *ctx +) +{ + if ( ExistTimerServer() ) { + ctx->before_priority = GetTimerServerPriority(); + ctx->before_stack_size = GetTimerServerStackSize(); + ctx->before_has_floating_point = HasTimerServerFloatingPoint(); + } + + ctx->status = rtems_timer_initiate_server( + ctx->priority, + ctx->stack_size, + RTEMS_FLOATING_POINT + ); +} + +static void RtemsTimerReqInitiateServer_Cleanup( + RtemsTimerReqInitiateServer_Context *ctx +) +{ + T_surrender_objects( &ctx->task_objects, rtems_task_delete ); +} + +static const RtemsTimerReqInitiateServer_Entry +RtemsTimerReqInitiateServer_Entries[] = { + { 0, 0, 0, 0, 0, RtemsTimerReqInitiateServer_Post_Status_IncStat, + RtemsTimerReqInitiateServer_Post_Started_Yes, + RtemsTimerReqInitiateServer_Post_TaskPrio_Nop, + RtemsTimerReqInitiateServer_Post_TaskStack_Nop, + RtemsTimerReqInitiateServer_Post_TaskAttr_Nop }, + { 0, 0, 0, 0, 0, RtemsTimerReqInitiateServer_Post_Status_TooMany, + RtemsTimerReqInitiateServer_Post_Started_No, + RtemsTimerReqInitiateServer_Post_TaskPrio_NA, + RtemsTimerReqInitiateServer_Post_TaskStack_NA, + RtemsTimerReqInitiateServer_Post_TaskAttr_NA }, + { 0, 0, 0, 0, 0, RtemsTimerReqInitiateServer_Post_Status_InvPrio, + RtemsTimerReqInitiateServer_Post_Started_No, + RtemsTimerReqInitiateServer_Post_TaskPrio_NA, + RtemsTimerReqInitiateServer_Post_TaskStack_NA, + RtemsTimerReqInitiateServer_Post_TaskAttr_NA }, + { 0, 0, 0, 0, 0, RtemsTimerReqInitiateServer_Post_Status_Ok, + RtemsTimerReqInitiateServer_Post_Started_Yes, + RtemsTimerReqInitiateServer_Post_TaskPrio_Set, + RtemsTimerReqInitiateServer_Post_TaskStack_Set, + RtemsTimerReqInitiateServer_Post_TaskAttr_Set }, + { 0, 0, 0, 0, 0, RtemsTimerReqInitiateServer_Post_Status_Unsat, + RtemsTimerReqInitiateServer_Post_Started_No, + RtemsTimerReqInitiateServer_Post_TaskPrio_NA, + RtemsTimerReqInitiateServer_Post_TaskStack_NA, + RtemsTimerReqInitiateServer_Post_TaskAttr_NA } +}; + +static const uint8_t +RtemsTimerReqInitiateServer_Map[] = { + 0, 0, 3, 1, 0, 0, 4, 1, 0, 0, 3, 1, 0, 0, 4, 1, 0, 0, 2, 2, 0, 0, 2, 2 +}; + +static size_t RtemsTimerReqInitiateServer_Scope( + void *arg, + char *buf, + size_t n +) +{ + RtemsTimerReqInitiateServer_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( + RtemsTimerReqInitiateServer_PreDesc, + buf, + n, + ctx->Map.pcs + ); + } + + return 0; +} + +static T_fixture RtemsTimerReqInitiateServer_Fixture = { + .setup = RtemsTimerReqInitiateServer_Setup_Wrap, + .stop = NULL, + .teardown = RtemsTimerReqInitiateServer_Teardown_Wrap, + .scope = RtemsTimerReqInitiateServer_Scope, + .initial_context = &RtemsTimerReqInitiateServer_Instance +}; + +static inline RtemsTimerReqInitiateServer_Entry +RtemsTimerReqInitiateServer_PopEntry( + RtemsTimerReqInitiateServer_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqInitiateServer_Entries[ + RtemsTimerReqInitiateServer_Map[ index ] + ]; +} + +static void RtemsTimerReqInitiateServer_TestVariant( + RtemsTimerReqInitiateServer_Context *ctx +) +{ + RtemsTimerReqInitiateServer_Pre_Priority_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqInitiateServer_Pre_Stack_Prepare( ctx, ctx->Map.pcs[ 1 ] ); + RtemsTimerReqInitiateServer_Pre_Started_Prepare( ctx, ctx->Map.pcs[ 2 ] ); + RtemsTimerReqInitiateServer_Pre_TaskObj_Prepare( ctx, ctx->Map.pcs[ 3 ] ); + RtemsTimerReqInitiateServer_Action( ctx ); + RtemsTimerReqInitiateServer_Post_Status_Check( + ctx, + ctx->Map.entry.Post_Status + ); + RtemsTimerReqInitiateServer_Post_Started_Check( + ctx, + ctx->Map.entry.Post_Started + ); + RtemsTimerReqInitiateServer_Post_TaskPrio_Check( + ctx, + ctx->Map.entry.Post_TaskPrio + ); + RtemsTimerReqInitiateServer_Post_TaskStack_Check( + ctx, + ctx->Map.entry.Post_TaskStack + ); + RtemsTimerReqInitiateServer_Post_TaskAttr_Check( + ctx, + ctx->Map.entry.Post_TaskAttr + ); +} + +/** + * @fn void T_case_body_RtemsTimerReqInitiateServer( void ) + */ +T_TEST_CASE_FIXTURE( + RtemsTimerReqInitiateServer, + &RtemsTimerReqInitiateServer_Fixture +) +{ + RtemsTimerReqInitiateServer_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqInitiateServer_Pre_Priority_Valid; + ctx->Map.pcs[ 0 ] < RtemsTimerReqInitiateServer_Pre_Priority_NA; + ++ctx->Map.pcs[ 0 ] + ) { + for ( + ctx->Map.pcs[ 1 ] = RtemsTimerReqInitiateServer_Pre_Stack_Allocatable; + ctx->Map.pcs[ 1 ] < RtemsTimerReqInitiateServer_Pre_Stack_NA; + ++ctx->Map.pcs[ 1 ] + ) { + for ( + ctx->Map.pcs[ 2 ] = RtemsTimerReqInitiateServer_Pre_Started_Yes; + ctx->Map.pcs[ 2 ] < RtemsTimerReqInitiateServer_Pre_Started_NA; + ++ctx->Map.pcs[ 2 ] + ) { + for ( + ctx->Map.pcs[ 3 ] = RtemsTimerReqInitiateServer_Pre_TaskObj_Available; + ctx->Map.pcs[ 3 ] < RtemsTimerReqInitiateServer_Pre_TaskObj_NA; + ++ctx->Map.pcs[ 3 ] + ) { + ctx->Map.entry = RtemsTimerReqInitiateServer_PopEntry( ctx ); + RtemsTimerReqInitiateServer_TestVariant( ctx ); + RtemsTimerReqInitiateServer_Cleanup( ctx ); + } + } + } + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-reset.c b/testsuites/validation/tc-timer-reset.c new file mode 100644 index 0000000000..2b87717b43 --- /dev/null +++ b/testsuites/validation/tc-timer-reset.c @@ -0,0 +1,1058 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqReset + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> + +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqReset spec:/rtems/timer/req/reset + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqReset_Pre_Id_Valid, + RtemsTimerReqReset_Pre_Id_Invalid, + RtemsTimerReqReset_Pre_Id_NA +} RtemsTimerReqReset_Pre_Id; + +typedef enum { + RtemsTimerReqReset_Pre_Context_None, + RtemsTimerReqReset_Pre_Context_Interrupt, + RtemsTimerReqReset_Pre_Context_Server, + RtemsTimerReqReset_Pre_Context_NA +} RtemsTimerReqReset_Pre_Context; + +typedef enum { + RtemsTimerReqReset_Pre_Clock_None, + RtemsTimerReqReset_Pre_Clock_Ticks, + RtemsTimerReqReset_Pre_Clock_Realtime, + RtemsTimerReqReset_Pre_Clock_NA +} RtemsTimerReqReset_Pre_Clock; + +typedef enum { + RtemsTimerReqReset_Pre_State_Inactive, + RtemsTimerReqReset_Pre_State_Scheduled, + RtemsTimerReqReset_Pre_State_Pending, + RtemsTimerReqReset_Pre_State_NA +} RtemsTimerReqReset_Pre_State; + +typedef enum { + RtemsTimerReqReset_Post_Status_Ok, + RtemsTimerReqReset_Post_Status_InvId, + RtemsTimerReqReset_Post_Status_NotDef, + RtemsTimerReqReset_Post_Status_NA +} RtemsTimerReqReset_Post_Status; + +typedef enum { + RtemsTimerReqReset_Post_Context_None, + RtemsTimerReqReset_Post_Context_Interrupt, + RtemsTimerReqReset_Post_Context_Server, + RtemsTimerReqReset_Post_Context_Nop, + RtemsTimerReqReset_Post_Context_NA +} RtemsTimerReqReset_Post_Context; + +typedef enum { + RtemsTimerReqReset_Post_Clock_None, + RtemsTimerReqReset_Post_Clock_Ticks, + RtemsTimerReqReset_Post_Clock_Realtime, + RtemsTimerReqReset_Post_Clock_Nop, + RtemsTimerReqReset_Post_Clock_NA +} RtemsTimerReqReset_Post_Clock; + +typedef enum { + RtemsTimerReqReset_Post_State_Scheduled, + RtemsTimerReqReset_Post_State_Nop, + RtemsTimerReqReset_Post_State_NA +} RtemsTimerReqReset_Post_State; + +typedef enum { + RtemsTimerReqReset_Post_Interval_Last, + RtemsTimerReqReset_Post_Interval_Nop, + RtemsTimerReqReset_Post_Interval_NA +} RtemsTimerReqReset_Post_Interval; + +typedef enum { + RtemsTimerReqReset_Post_Routine_Last, + RtemsTimerReqReset_Post_Routine_Nop, + RtemsTimerReqReset_Post_Routine_NA +} RtemsTimerReqReset_Post_Routine; + +typedef enum { + RtemsTimerReqReset_Post_UserData_Last, + RtemsTimerReqReset_Post_UserData_Nop, + RtemsTimerReqReset_Post_UserData_NA +} RtemsTimerReqReset_Post_UserData; + +typedef struct { + uint32_t Skip : 1; + uint32_t Pre_Id_NA : 1; + uint32_t Pre_Context_NA : 1; + uint32_t Pre_Clock_NA : 1; + uint32_t Pre_State_NA : 1; + uint32_t Post_Status : 2; + uint32_t Post_Context : 3; + uint32_t Post_Clock : 3; + uint32_t Post_State : 2; + uint32_t Post_Interval : 2; + uint32_t Post_Routine : 2; + uint32_t Post_UserData : 2; +} RtemsTimerReqReset_Entry; + +typedef enum { + PRE_NONE = 0, + PRE_INTERRUPT = 1, + PRE_SERVER = 2 +} PreConditionContext; + +typedef enum { + SCHEDULE_NONE = 0, + SCHEDULE_SOON = 1, + SCHEDULE_LATER = 2, + SCHEDULE_MAX = 5 +} Scheduling_Ticks; + +/** + * @brief Test context for spec:/rtems/timer/req/reset test case. + */ +typedef struct { + /** + * @brief This member contains a valid id of a timer. + */ + rtems_id timer_id; + + /** + * @brief This member specifies the ``id`` parameter for the action. + */ + rtems_id id_param; + + /** + * @brief This member contains the returned status code of the action. + */ + rtems_status_code status; + + /** + * @brief This member contains the user data for Timer Service Routine "A". + */ + void *data_a; + + /** + * @brief This member contains the user data for Timer Service Routine "B". + */ + void *data_b; + + /** + * @brief This member contains the counter for invocations of Timer Service + * Routine "A". + */ + int invocations_a; + + /** + * @brief This member contains the counter for invocations of Timer Service + * Routine "B". + */ + int invocations_b; + + /** + * @brief This member contains the number of ticks needed to fire the Timer + * Service Routine. + */ + Scheduling_Ticks ticks_till_fire; + + /** + * @brief This member identifier the user data given to the Timer Service + * Routine when called. It either the address of member data_a or data_b. + */ + void **routine_user_data; + + /** + * @brief This member contains a reference to the user data to be used in the + * next call to the Timer Service Routine. + */ + void **scheduled_user_data;; + + /** + * @brief This member contains 1 if the Timer Service Routine "A" has been + * scheduled otherwise 0. + */ + int scheduled_invocations_a; + + /** + * @brief This member contains 1 if the Timer Service Routine "B" has been + * scheduled otherwise 0. + */ + int scheduled_invocations_b; + + /** + * @brief This member specifies the number of ticks till the scheduled Timer + * Service Routine should fire. + */ + Scheduling_Ticks scheduled_ticks_till_fire; + + /** + * @brief This member specifies which pre-condition context (none, interrupt + * context, server context) must be created before the rtems_timer_reset() + * action gets executed. + */ + PreConditionContext pre_cond_contex; + + /** + * @brief This member stores internal clock and context settings of the timer + * before the execution of the test action. + */ + Timer_Classes pre_class; + + /** + * @brief This member stores the state of the timer before the execution of + * the test action. + */ + Timer_States pre_state; + + /** + * @brief This member stores the state of the timer after the execution of + * the test action. + */ + Timer_States post_state; + + /** + * @brief This member stores the scheduling data of the timer before the + * execution of the test action. + */ + Timer_Scheduling_Data pre_scheduling_data; + + /** + * @brief This member stores the scheduling data of the timer after the + * execution of the test action. + */ + Timer_Scheduling_Data post_scheduling_data; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 4 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqReset_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqReset_Context; + +static RtemsTimerReqReset_Context + RtemsTimerReqReset_Instance; + +static const char * const RtemsTimerReqReset_PreDesc_Id[] = { + "Valid", + "Invalid", + "NA" +}; + +static const char * const RtemsTimerReqReset_PreDesc_Context[] = { + "None", + "Interrupt", + "Server", + "NA" +}; + +static const char * const RtemsTimerReqReset_PreDesc_Clock[] = { + "None", + "Ticks", + "Realtime", + "NA" +}; + +static const char * const RtemsTimerReqReset_PreDesc_State[] = { + "Inactive", + "Scheduled", + "Pending", + "NA" +}; + +static const char * const * const RtemsTimerReqReset_PreDesc[] = { + RtemsTimerReqReset_PreDesc_Id, + RtemsTimerReqReset_PreDesc_Context, + RtemsTimerReqReset_PreDesc_Clock, + RtemsTimerReqReset_PreDesc_State, + NULL +}; + +static const rtems_time_of_day tod_now = { 2000, 1, 1, 0, 0, 0, 0 }; +static const rtems_time_of_day tod_schedule = { 2000, 1, 1, 1, 0, 0, 0 }; +static const rtems_time_of_day tod_fire = { 2000, 1, 2, 0, 0, 0, 0 }; + +static Scheduling_Ticks TriggerTimer( const RtemsTimerReqReset_Context *ctx ) +{ + int ticks_fired = SCHEDULE_NONE; + int invocations_old = ctx->invocations_a + ctx->invocations_b; + + /* Fire the timer service routine for ticks and realtime clock */ + int i; + for ( i = 1; i <= SCHEDULE_MAX; ++i ) { + ClockTick(); + if ( ctx->invocations_a + ctx->invocations_b > invocations_old ) { + ticks_fired = i; + break; + } + } + + T_rsc_success( rtems_clock_set( &tod_fire ) ); + + return ticks_fired; +} + +static void TimerServiceRoutineA( + rtems_id timer_id, + void *user_data +) +{ + RtemsTimerReqReset_Context *ctx = + *(RtemsTimerReqReset_Context **) user_data; + ++( ctx->invocations_a ); + ctx->routine_user_data = user_data; +} + +static void TimerServiceRoutineB( + rtems_id timer_id, + void *user_data +) +{ + RtemsTimerReqReset_Context *ctx = + *(RtemsTimerReqReset_Context **) user_data; + ++( ctx->invocations_b ); + ctx->routine_user_data = user_data; +} + +static void RtemsTimerReqReset_Pre_Id_Prepare( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Pre_Id state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Pre_Id_Valid: { + /* + * While the ``id`` parameter is valid. + */ + ctx->id_param = ctx->timer_id; + break; + } + + case RtemsTimerReqReset_Pre_Id_Invalid: { + /* + * While the ``id`` parameter is invalid. + */ + ctx->id_param = RTEMS_ID_NONE; + break; + } + + case RtemsTimerReqReset_Pre_Id_NA: + break; + } +} + +static void RtemsTimerReqReset_Pre_Context_Prepare( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Pre_Context state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Pre_Context_None: { + /* + * While the Timer Service Routine has never been scheduled since + * creation of the timer. See also none. + */ + ctx->pre_cond_contex = PRE_NONE; + break; + } + + case RtemsTimerReqReset_Pre_Context_Interrupt: { + /* + * While the timer is in interrupt context. + */ + ctx->pre_cond_contex = PRE_INTERRUPT; + break; + } + + case RtemsTimerReqReset_Pre_Context_Server: { + /* + * While the timer is in server context. + */ + ctx->pre_cond_contex = PRE_SERVER; + break; + } + + case RtemsTimerReqReset_Pre_Context_NA: + break; + } +} + +static void RtemsTimerReqReset_Pre_Clock_Prepare( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Pre_Clock state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Pre_Clock_None: { + /* + * While the timer has never been scheduled since creation of the timer. + */ + T_eq_int( ctx->pre_cond_contex, PRE_NONE ); + break; + } + + case RtemsTimerReqReset_Pre_Clock_Ticks: { + /* + * While the clock used to determine when the timer will fire is the + * ticks based clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + ctx->scheduled_ticks_till_fire = SCHEDULE_SOON; + ctx->scheduled_invocations_a = 1; + ctx->scheduled_user_data = &ctx->data_a; + status = rtems_timer_fire_after( + ctx->timer_id, + ctx->scheduled_ticks_till_fire, + TimerServiceRoutineA, + ctx->scheduled_user_data + ); + } else { + ctx->scheduled_ticks_till_fire = SCHEDULE_LATER; + ctx->scheduled_invocations_b = 1; + ctx->scheduled_user_data = &ctx->data_b; + status = rtems_timer_server_fire_after( + ctx->timer_id, + ctx->scheduled_ticks_till_fire, + TimerServiceRoutineB, + ctx->scheduled_user_data + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqReset_Pre_Clock_Realtime: { + /* + * While the clock used to determine when the timer will fire is the + * realtime clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutineA, + &ctx->data_a + ); + } else { + status = rtems_timer_server_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutineB, + &ctx->data_b + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqReset_Pre_Clock_NA: + break; + } +} + +static void RtemsTimerReqReset_Pre_State_Prepare( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Pre_State state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Pre_State_Inactive: { + /* + * While the timer is in inactive state. + */ + TriggerTimer( ctx ); + T_eq_int( + ctx->invocations_a + ctx->invocations_b, + ( ctx->pre_cond_contex == PRE_NONE ) ? 0 : 1 + ); + ctx->invocations_a = 0; + ctx->invocations_b = 0; + ctx->pre_state = TIMER_INACTIVE; + break; + } + + case RtemsTimerReqReset_Pre_State_Scheduled: { + /* + * While the timer is in scheduled state. + */ + /* The timer was already scheduled in the "Clock" pre-conditions. */ + ctx->pre_state = TIMER_SCHEDULED; + break; + } + + case RtemsTimerReqReset_Pre_State_Pending: { + /* + * While the timer is in pending state. + */ + T_rsc_success( rtems_task_suspend( GetTimerServerTaskId() ) ); + TriggerTimer( ctx ); + T_eq_int( ctx->invocations_a + ctx->invocations_b, 0 ); + ctx->pre_state = TIMER_PENDING; + break; + } + + case RtemsTimerReqReset_Pre_State_NA: + break; + } +} + +static void RtemsTimerReqReset_Post_Status_Check( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Post_Status_Ok: { + /* + * The return status of rtems_timer_reset() shall be RTEMS_SUCCESSFUL. + */ + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqReset_Post_Status_InvId: { + /* + * The return status of rtems_timer_reset() shall be RTEMS_INVALID_ID. + */ + T_rsc( ctx->status, RTEMS_INVALID_ID ); + break; + } + + case RtemsTimerReqReset_Post_Status_NotDef: { + /* + * The return status of rtems_timer_reset() shall be RTEMS_NOT_DEFINED + */ + T_rsc( ctx->status, RTEMS_NOT_DEFINED ); + break; + } + + case RtemsTimerReqReset_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqReset_Post_Context_Check( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Post_Context state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqReset_Post_Context_None: { + /* + * The timer shall have never been scheduled. See also none. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqReset_Post_Context_Interrupt: { + /* + * The timer shall be in interrupt context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, 0 ); + break; + } + + case RtemsTimerReqReset_Post_Context_Server: { + /* + * The timer shall be in server context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, TIMER_CLASS_BIT_ON_TASK ); + break; + } + + case RtemsTimerReqReset_Post_Context_Nop: { + /* + * Objects referenced by the ``id`` parameter in past call to + * rtems_timer_reset() shall not be accessed by the rtems_timer_reset() + * call. See also Nop. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqReset_Post_Context_NA: + break; + } +} + +static void RtemsTimerReqReset_Post_Clock_Check( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Post_Clock state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqReset_Post_Clock_None: { + /* + * The timer shall have never been scheduled. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqReset_Post_Clock_Ticks: { + /* + * The timer shall use the ticks based clock. + */ + T_eq_int( class & TIMER_CLASS_BIT_TIME_OF_DAY, 0 ); + break; + } + + case RtemsTimerReqReset_Post_Clock_Realtime: { + /* + * The timer shall use the realtime clock. + */ + T_eq_int( + class & TIMER_CLASS_BIT_TIME_OF_DAY, + TIMER_CLASS_BIT_TIME_OF_DAY + ); + break; + } + + case RtemsTimerReqReset_Post_Clock_Nop: { + /* + * Objects referenced by the ``id`` parameter in past call to + * rtems_timer_reset() shall not be accessed by the rtems_timer_reset() + * call. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqReset_Post_Clock_NA: + break; + } +} + +static void RtemsTimerReqReset_Post_State_Check( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Post_State state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Post_State_Scheduled: { + /* + * The timer shall be in scheduled state. + */ + ctx->ticks_till_fire = TriggerTimer( ctx ); + T_eq_int( ctx->invocations_a + ctx->invocations_b, 1 ); + break; + } + + case RtemsTimerReqReset_Post_State_Nop: { + /* + * Objects referenced by the ``id`` parameter in past call to + * rtems_timer_reset() shall not be accessed by the rtems_timer_reset() + * call. + */ + T_eq_int( ctx->post_state, ctx->pre_state ); + break; + } + + case RtemsTimerReqReset_Post_State_NA: + break; + } +} + +static void RtemsTimerReqReset_Post_Interval_Check( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Post_Interval state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Post_Interval_Last: { + /* + * The Timer Service Routine shall be invoked the same number of ticks + * (see tick), as defined by the last scheduled interval, after a point + * in time during the execution of the rtems_timer_reset() call. + */ + T_eq_int( ctx->ticks_till_fire, ctx->scheduled_ticks_till_fire ); + break; + } + + case RtemsTimerReqReset_Post_Interval_Nop: { + /* + * If and when the Timer Service Routine will be invoked shall not be + * changed by the past call to rtems_timer_reset(). + */ + /* + * Whether the timer is scheduled has already been tested by the + * "Nop" "State" post-condition above. + */ + T_eq_u32( + ctx->post_scheduling_data.interval, + ctx->pre_scheduling_data.interval + ); + break; + } + + case RtemsTimerReqReset_Post_Interval_NA: + break; + } +} + +static void RtemsTimerReqReset_Post_Routine_Check( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Post_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Post_Routine_Last: { + /* + * The function reference used to invoke the Timer Service Routine when + * the timer will fire shall be the same one as the last one scheduled. + */ + T_eq_int( ctx->invocations_a, ctx->scheduled_invocations_a ); + T_eq_int( ctx->invocations_b, ctx->scheduled_invocations_b ); + break; + } + + case RtemsTimerReqReset_Post_Routine_Nop: { + /* + * The function reference used for any invocation of the Timer Service + * Routine shall not be changed by the past call to rtems_timer_reset(). + */ + T_eq_ptr( + ctx->post_scheduling_data.routine, + ctx->pre_scheduling_data.routine + ); + break; + } + + case RtemsTimerReqReset_Post_Routine_NA: + break; + } +} + +static void RtemsTimerReqReset_Post_UserData_Check( + RtemsTimerReqReset_Context *ctx, + RtemsTimerReqReset_Post_UserData state +) +{ + switch ( state ) { + case RtemsTimerReqReset_Post_UserData_Last: { + /* + * The user data argument for invoking the Timer Service Routine when the + * timer will fire shall be the same as the last scheduled user data + * argument. + */ + T_eq_ptr( ctx->routine_user_data, ctx->scheduled_user_data); + break; + } + + case RtemsTimerReqReset_Post_UserData_Nop: { + /* + * The user data argument used for any invocation of the Timer Service + * Routine shall not be changed by the past call to rtems_timer_reset(). + */ + T_eq_ptr( + ctx->post_scheduling_data.user_data, + ctx->pre_scheduling_data.user_data + ); + break; + } + + case RtemsTimerReqReset_Post_UserData_NA: + break; + } +} + +static void RtemsTimerReqReset_Setup( RtemsTimerReqReset_Context *ctx ) +{ + rtems_status_code status; + status = rtems_timer_initiate_server( + RTEMS_TIMER_SERVER_DEFAULT_PRIORITY, + RTEMS_MINIMUM_STACK_SIZE, + RTEMS_DEFAULT_ATTRIBUTES + ); + T_rsc_success( status ); +} + +static void RtemsTimerReqReset_Setup_Wrap( void *arg ) +{ + RtemsTimerReqReset_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqReset_Setup( ctx ); +} + +/** + * @brief Make sure the timer server is not running and the realtime clock is + * not set after this test. + */ +static void RtemsTimerReqReset_Teardown( RtemsTimerReqReset_Context *ctx ) +{ + DeleteTimerServer(); + UnsetClock(); +} + +static void RtemsTimerReqReset_Teardown_Wrap( void *arg ) +{ + RtemsTimerReqReset_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqReset_Teardown( ctx ); +} + +static void RtemsTimerReqReset_Prepare( RtemsTimerReqReset_Context *ctx ) +{ + rtems_status_code status; + status = rtems_timer_create( + rtems_build_name( 'T', 'I', 'M', 'E' ), + &ctx->timer_id + ); + T_rsc_success( status ); + + ctx->data_a = ctx; + ctx->data_b = ctx; + ctx->invocations_a = 0; + ctx->invocations_b = 0; + ctx->ticks_till_fire = SCHEDULE_NONE; + ctx->routine_user_data = NULL; + ctx->scheduled_invocations_a = 0; + ctx->scheduled_invocations_b = 0; + ctx->scheduled_ticks_till_fire = SCHEDULE_NONE; + T_rsc_success( rtems_clock_set( &tod_now ) ); +} + +static void RtemsTimerReqReset_Action( RtemsTimerReqReset_Context *ctx ) +{ + GetTimerSchedulingData( ctx->timer_id, &ctx->pre_scheduling_data ); + ctx->pre_class = GetTimerClass( ctx->timer_id ); + ctx->status = rtems_timer_reset( ctx->id_param ); + ctx->post_state = GetTimerState( ctx->timer_id ); + GetTimerSchedulingData( ctx->timer_id, &ctx->post_scheduling_data ); + /* Ignoring return status: the timer server task may be suspended or not. */ + rtems_task_resume( GetTimerServerTaskId() ); +} + +static void RtemsTimerReqReset_Cleanup( RtemsTimerReqReset_Context *ctx ) +{ + T_rsc_success( rtems_timer_delete( ctx->timer_id ) ); +} + +static const RtemsTimerReqReset_Entry +RtemsTimerReqReset_Entries[] = { + { 1, 0, 0, 0, 0, RtemsTimerReqReset_Post_Status_NA, + RtemsTimerReqReset_Post_Context_NA, RtemsTimerReqReset_Post_Clock_NA, + RtemsTimerReqReset_Post_State_NA, RtemsTimerReqReset_Post_Interval_NA, + RtemsTimerReqReset_Post_Routine_NA, RtemsTimerReqReset_Post_UserData_NA }, + { 0, 0, 0, 0, 0, RtemsTimerReqReset_Post_Status_InvId, + RtemsTimerReqReset_Post_Context_Nop, RtemsTimerReqReset_Post_Clock_Nop, + RtemsTimerReqReset_Post_State_Nop, RtemsTimerReqReset_Post_Interval_Nop, + RtemsTimerReqReset_Post_Routine_Nop, RtemsTimerReqReset_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, RtemsTimerReqReset_Post_Status_NotDef, + RtemsTimerReqReset_Post_Context_Nop, RtemsTimerReqReset_Post_Clock_Nop, + RtemsTimerReqReset_Post_State_Nop, RtemsTimerReqReset_Post_Interval_Nop, + RtemsTimerReqReset_Post_Routine_Nop, RtemsTimerReqReset_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, RtemsTimerReqReset_Post_Status_Ok, + RtemsTimerReqReset_Post_Context_Server, + RtemsTimerReqReset_Post_Clock_Ticks, + RtemsTimerReqReset_Post_State_Scheduled, + RtemsTimerReqReset_Post_Interval_Last, + RtemsTimerReqReset_Post_Routine_Last, RtemsTimerReqReset_Post_UserData_Last }, + { 0, 0, 0, 0, 0, RtemsTimerReqReset_Post_Status_Ok, + RtemsTimerReqReset_Post_Context_Interrupt, + RtemsTimerReqReset_Post_Clock_Ticks, + RtemsTimerReqReset_Post_State_Scheduled, + RtemsTimerReqReset_Post_Interval_Last, + RtemsTimerReqReset_Post_Routine_Last, RtemsTimerReqReset_Post_UserData_Last } +}; + +static const uint8_t +RtemsTimerReqReset_Map[] = { + 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 2, 2, 0, 0, 0, 0, 3, 3, 3, 2, 2, + 2, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, + 1, 1 +}; + +static size_t RtemsTimerReqReset_Scope( void *arg, char *buf, size_t n ) +{ + RtemsTimerReqReset_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( RtemsTimerReqReset_PreDesc, buf, n, ctx->Map.pcs ); + } + + return 0; +} + +static T_fixture RtemsTimerReqReset_Fixture = { + .setup = RtemsTimerReqReset_Setup_Wrap, + .stop = NULL, + .teardown = RtemsTimerReqReset_Teardown_Wrap, + .scope = RtemsTimerReqReset_Scope, + .initial_context = &RtemsTimerReqReset_Instance +}; + +static inline RtemsTimerReqReset_Entry RtemsTimerReqReset_PopEntry( + RtemsTimerReqReset_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqReset_Entries[ + RtemsTimerReqReset_Map[ index ] + ]; +} + +static void RtemsTimerReqReset_TestVariant( RtemsTimerReqReset_Context *ctx ) +{ + RtemsTimerReqReset_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqReset_Pre_Context_Prepare( ctx, ctx->Map.pcs[ 1 ] ); + RtemsTimerReqReset_Pre_Clock_Prepare( ctx, ctx->Map.pcs[ 2 ] ); + RtemsTimerReqReset_Pre_State_Prepare( ctx, ctx->Map.pcs[ 3 ] ); + RtemsTimerReqReset_Action( ctx ); + RtemsTimerReqReset_Post_Status_Check( ctx, ctx->Map.entry.Post_Status ); + RtemsTimerReqReset_Post_Context_Check( ctx, ctx->Map.entry.Post_Context ); + RtemsTimerReqReset_Post_Clock_Check( ctx, ctx->Map.entry.Post_Clock ); + RtemsTimerReqReset_Post_State_Check( ctx, ctx->Map.entry.Post_State ); + RtemsTimerReqReset_Post_Interval_Check( ctx, ctx->Map.entry.Post_Interval ); + RtemsTimerReqReset_Post_Routine_Check( ctx, ctx->Map.entry.Post_Routine ); + RtemsTimerReqReset_Post_UserData_Check( ctx, ctx->Map.entry.Post_UserData ); +} + +/** + * @fn void T_case_body_RtemsTimerReqReset( void ) + */ +T_TEST_CASE_FIXTURE( RtemsTimerReqReset, &RtemsTimerReqReset_Fixture ) +{ + RtemsTimerReqReset_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqReset_Pre_Id_Valid; + ctx->Map.pcs[ 0 ] < RtemsTimerReqReset_Pre_Id_NA; + ++ctx->Map.pcs[ 0 ] + ) { + for ( + ctx->Map.pcs[ 1 ] = RtemsTimerReqReset_Pre_Context_None; + ctx->Map.pcs[ 1 ] < RtemsTimerReqReset_Pre_Context_NA; + ++ctx->Map.pcs[ 1 ] + ) { + for ( + ctx->Map.pcs[ 2 ] = RtemsTimerReqReset_Pre_Clock_None; + ctx->Map.pcs[ 2 ] < RtemsTimerReqReset_Pre_Clock_NA; + ++ctx->Map.pcs[ 2 ] + ) { + for ( + ctx->Map.pcs[ 3 ] = RtemsTimerReqReset_Pre_State_Inactive; + ctx->Map.pcs[ 3 ] < RtemsTimerReqReset_Pre_State_NA; + ++ctx->Map.pcs[ 3 ] + ) { + ctx->Map.entry = RtemsTimerReqReset_PopEntry( ctx ); + + if ( ctx->Map.entry.Skip ) { + continue; + } + + RtemsTimerReqReset_Prepare( ctx ); + RtemsTimerReqReset_TestVariant( ctx ); + RtemsTimerReqReset_Cleanup( ctx ); + } + } + } + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-server-fire-after.c b/testsuites/validation/tc-timer-server-fire-after.c new file mode 100644 index 0000000000..50e639e7c1 --- /dev/null +++ b/testsuites/validation/tc-timer-server-fire-after.c @@ -0,0 +1,1301 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqServerFireAfter + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> + +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqServerFireAfter \ + * spec:/rtems/timer/req/server-fire-after + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqServerFireAfter_Pre_Server_Init, + RtemsTimerReqServerFireAfter_Pre_Server_NotInit, + RtemsTimerReqServerFireAfter_Pre_Server_NA +} RtemsTimerReqServerFireAfter_Pre_Server; + +typedef enum { + RtemsTimerReqServerFireAfter_Pre_Ticks_Valid, + RtemsTimerReqServerFireAfter_Pre_Ticks_Is0, + RtemsTimerReqServerFireAfter_Pre_Ticks_NA +} RtemsTimerReqServerFireAfter_Pre_Ticks; + +typedef enum { + RtemsTimerReqServerFireAfter_Pre_Routine_Valid, + RtemsTimerReqServerFireAfter_Pre_Routine_Null, + RtemsTimerReqServerFireAfter_Pre_Routine_NA +} RtemsTimerReqServerFireAfter_Pre_Routine; + +typedef enum { + RtemsTimerReqServerFireAfter_Pre_Id_Valid, + RtemsTimerReqServerFireAfter_Pre_Id_Invalid, + RtemsTimerReqServerFireAfter_Pre_Id_NA +} RtemsTimerReqServerFireAfter_Pre_Id; + +typedef enum { + RtemsTimerReqServerFireAfter_Pre_Context_None, + RtemsTimerReqServerFireAfter_Pre_Context_Interrupt, + RtemsTimerReqServerFireAfter_Pre_Context_Server, + RtemsTimerReqServerFireAfter_Pre_Context_NA +} RtemsTimerReqServerFireAfter_Pre_Context; + +typedef enum { + RtemsTimerReqServerFireAfter_Pre_Clock_None, + RtemsTimerReqServerFireAfter_Pre_Clock_Ticks, + RtemsTimerReqServerFireAfter_Pre_Clock_Realtime, + RtemsTimerReqServerFireAfter_Pre_Clock_NA +} RtemsTimerReqServerFireAfter_Pre_Clock; + +typedef enum { + RtemsTimerReqServerFireAfter_Pre_State_Inactive, + RtemsTimerReqServerFireAfter_Pre_State_Scheduled, + RtemsTimerReqServerFireAfter_Pre_State_Pending, + RtemsTimerReqServerFireAfter_Pre_State_NA +} RtemsTimerReqServerFireAfter_Pre_State; + +typedef enum { + RtemsTimerReqServerFireAfter_Post_Status_Ok, + RtemsTimerReqServerFireAfter_Post_Status_InvId, + RtemsTimerReqServerFireAfter_Post_Status_InvAddr, + RtemsTimerReqServerFireAfter_Post_Status_InvNum, + RtemsTimerReqServerFireAfter_Post_Status_IncStat, + RtemsTimerReqServerFireAfter_Post_Status_NA +} RtemsTimerReqServerFireAfter_Post_Status; + +typedef enum { + RtemsTimerReqServerFireAfter_Post_Context_None, + RtemsTimerReqServerFireAfter_Post_Context_Interrupt, + RtemsTimerReqServerFireAfter_Post_Context_Server, + RtemsTimerReqServerFireAfter_Post_Context_Nop, + RtemsTimerReqServerFireAfter_Post_Context_NA +} RtemsTimerReqServerFireAfter_Post_Context; + +typedef enum { + RtemsTimerReqServerFireAfter_Post_Clock_None, + RtemsTimerReqServerFireAfter_Post_Clock_Ticks, + RtemsTimerReqServerFireAfter_Post_Clock_Realtime, + RtemsTimerReqServerFireAfter_Post_Clock_Nop, + RtemsTimerReqServerFireAfter_Post_Clock_NA +} RtemsTimerReqServerFireAfter_Post_Clock; + +typedef enum { + RtemsTimerReqServerFireAfter_Post_State_Scheduled, + RtemsTimerReqServerFireAfter_Post_State_Nop, + RtemsTimerReqServerFireAfter_Post_State_NA +} RtemsTimerReqServerFireAfter_Post_State; + +typedef enum { + RtemsTimerReqServerFireAfter_Post_Interval_Param, + RtemsTimerReqServerFireAfter_Post_Interval_Nop, + RtemsTimerReqServerFireAfter_Post_Interval_NA +} RtemsTimerReqServerFireAfter_Post_Interval; + +typedef enum { + RtemsTimerReqServerFireAfter_Post_Routine_Param, + RtemsTimerReqServerFireAfter_Post_Routine_Nop, + RtemsTimerReqServerFireAfter_Post_Routine_NA +} RtemsTimerReqServerFireAfter_Post_Routine; + +typedef enum { + RtemsTimerReqServerFireAfter_Post_UserData_Param, + RtemsTimerReqServerFireAfter_Post_UserData_Nop, + RtemsTimerReqServerFireAfter_Post_UserData_NA +} RtemsTimerReqServerFireAfter_Post_UserData; + +typedef struct { + uint32_t Skip : 1; + uint32_t Pre_Server_NA : 1; + uint32_t Pre_Ticks_NA : 1; + uint32_t Pre_Routine_NA : 1; + uint32_t Pre_Id_NA : 1; + uint32_t Pre_Context_NA : 1; + uint32_t Pre_Clock_NA : 1; + uint32_t Pre_State_NA : 1; + uint32_t Post_Status : 3; + uint32_t Post_Context : 3; + uint32_t Post_Clock : 3; + uint32_t Post_State : 2; + uint32_t Post_Interval : 2; + uint32_t Post_Routine : 2; + uint32_t Post_UserData : 2; +} RtemsTimerReqServerFireAfter_Entry; + +typedef enum { + PRE_NONE = 0, + PRE_INTERRUPT = 1, + PRE_SERVER = 2 +} PreConditionContext; + +typedef enum { + SCHEDULE_NONE = 0, + SCHEDULE_VERY_SOON = 1, + SCHEDULE_SOON = 2, + SCHEDULE_LATER = 3, + SCHEDULE_MAX = 5 +} Scheduling_Ticks; + +/** + * @brief Test context for spec:/rtems/timer/req/server-fire-after test case. + */ +typedef struct { + /** + * @brief This member contains a valid id of a timer. + */ + rtems_id timer_id; + + /** + * @brief This member contains a valid id of a second timer. + * + * This timer is used reach branch coverage in an if-statement which only + * serves performance optimization. + */ + rtems_id timer_cover_id; + + /** + * @brief This member specifies the ``id`` parameter for the action. + */ + rtems_id id_param; + + /** + * @brief This member specifies the ``ticks`` parameter for the action. + */ + rtems_interval ticks_param; + + /** + * @brief This member specifies the ``routine`` parameter for the action. + */ + rtems_timer_service_routine_entry routine_param; + + /** + * @brief This member contains the returned status code of the action. + */ + rtems_status_code status; + + /** + * @brief This member contains a counter for invocations of the Timer Service + * Routine. + */ + int invocations; + + /** + * @brief Function TriggerTimer() is used to figure out how many ticks (see + * tick) are needed till the Timer Service Routine gets executed. This + * member contains the number of ticks needed to fire the Timer Service + * Routine. + */ + Scheduling_Ticks ticks_till_fire; + + /** + * @brief This member contains the user data given to the Timer Service + * Routine when called. + */ + void *routine_user_data; + + /** + * @brief This member specifies which pre-condition context (none, interrupt + * context, server context) must be created before the + * rtems_timer_server_fire_after() action gets executed. + */ + PreConditionContext pre_cond_contex; + + /** + * @brief This member stores internal clock and context settings of the timer + * before the execution of the test action. + */ + Timer_Classes pre_class; + + /** + * @brief This member stores the state of the timer before the execution of + * the test action. + */ + Timer_States pre_state; + + /** + * @brief This member stores the state of the timer after the execution of + * the test action. + */ + Timer_States post_state; + + /** + * @brief This member stores the scheduling data of the timer before the + * execution of the test action. + */ + Timer_Scheduling_Data pre_scheduling_data; + + /** + * @brief This member stores the scheduling data of the timer after the + * execution of the test action. + */ + Timer_Scheduling_Data post_scheduling_data; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 7 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqServerFireAfter_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqServerFireAfter_Context; + +static RtemsTimerReqServerFireAfter_Context + RtemsTimerReqServerFireAfter_Instance; + +static const char * const RtemsTimerReqServerFireAfter_PreDesc_Server[] = { + "Init", + "NotInit", + "NA" +}; + +static const char * const RtemsTimerReqServerFireAfter_PreDesc_Ticks[] = { + "Valid", + "Is0", + "NA" +}; + +static const char * const RtemsTimerReqServerFireAfter_PreDesc_Routine[] = { + "Valid", + "Null", + "NA" +}; + +static const char * const RtemsTimerReqServerFireAfter_PreDesc_Id[] = { + "Valid", + "Invalid", + "NA" +}; + +static const char * const RtemsTimerReqServerFireAfter_PreDesc_Context[] = { + "None", + "Interrupt", + "Server", + "NA" +}; + +static const char * const RtemsTimerReqServerFireAfter_PreDesc_Clock[] = { + "None", + "Ticks", + "Realtime", + "NA" +}; + +static const char * const RtemsTimerReqServerFireAfter_PreDesc_State[] = { + "Inactive", + "Scheduled", + "Pending", + "NA" +}; + +static const char * const * const RtemsTimerReqServerFireAfter_PreDesc[] = { + RtemsTimerReqServerFireAfter_PreDesc_Server, + RtemsTimerReqServerFireAfter_PreDesc_Ticks, + RtemsTimerReqServerFireAfter_PreDesc_Routine, + RtemsTimerReqServerFireAfter_PreDesc_Id, + RtemsTimerReqServerFireAfter_PreDesc_Context, + RtemsTimerReqServerFireAfter_PreDesc_Clock, + RtemsTimerReqServerFireAfter_PreDesc_State, + NULL +}; + +static const rtems_time_of_day tod_now = { 2000, 1, 1, 0, 0, 0, 0 }; +static const rtems_time_of_day tod_schedule = { 2000, 1, 1, 1, 0, 0, 0 }; +static const rtems_time_of_day tod_fire = { 2000, 1, 2, 0, 0, 0, 0 }; + +static Scheduling_Ticks TriggerTimer( const RtemsTimerReqServerFireAfter_Context *ctx ) +{ + int ticks_fired = SCHEDULE_NONE; + int invocations_old = ctx->invocations; + + /* Fire the timer service routine for ticks and realtime clock */ + int i; + for ( i = 1; i <= SCHEDULE_MAX; ++i ) { + ClockTick(); + if ( ctx->invocations > invocations_old ) { + ticks_fired = i; + break; + } + } + + T_rsc_success( rtems_clock_set( &tod_fire ) ); + + return ticks_fired; +} + +static void TimerServiceRoutine( + rtems_id timer_id, + void *user_data +) +{ + RtemsTimerReqServerFireAfter_Context *ctx = user_data; + ++( ctx->invocations ); + ctx->routine_user_data = user_data; +} + +/* + * This service routine is used reach branch coverage in an if-statement + * which only serves performance optimization. + */ +static void TimerServiceRoutineCover( + rtems_id timer_cover_id, + void *user_data +) +{ + (void) timer_cover_id; + (void) user_data; +} + +static void RtemsTimerReqServerFireAfter_Pre_Server_Prepare( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Pre_Server state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Pre_Server_Init: { + /* + * While the Timer Server task has been successfully initialized by a + * call to rtems_timer_initiate_server(). + */ + rtems_status_code status; + status = rtems_timer_initiate_server( + RTEMS_TIMER_SERVER_DEFAULT_PRIORITY, + RTEMS_MINIMUM_STACK_SIZE, + RTEMS_DEFAULT_ATTRIBUTES + ); + T_rsc_success( status ); + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Server_NotInit: { + /* + * While the Timer Server task has not been initialized and does not + * exist. + */ + DeleteTimerServer(); + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Server_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Pre_Ticks_Prepare( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Pre_Ticks state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Pre_Ticks_Valid: { + /* + * While the ``ticks`` parameter is a positive (greater 0) number. + */ + ctx->ticks_param = SCHEDULE_LATER; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Ticks_Is0: { + /* + * While the ``ticks`` parameter is 0. + */ + ctx->ticks_param = 0; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Ticks_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Pre_Routine_Prepare( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Pre_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Pre_Routine_Valid: { + /* + * While the ``routine`` parameter references an object of type + * rtems_timer_service_routine_entry. + */ + ctx->routine_param = TimerServiceRoutine; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Routine_Null: { + /* + * While the ``routine`` parameter is NULL.. + */ + ctx->routine_param = NULL; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Routine_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Pre_Id_Prepare( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Pre_Id state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Pre_Id_Valid: { + /* + * While the ``id`` parameter is valid. + */ + ctx->id_param = ctx->timer_id; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Id_Invalid: { + /* + * While the ``id`` parameter is invalid. + */ + ctx->id_param = RTEMS_ID_NONE; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Id_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Pre_Context_Prepare( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Pre_Context state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Pre_Context_None: { + /* + * While the Timer Service Routine has never been scheduled since + * creation of the timer. See also none. + */ + ctx->pre_cond_contex = PRE_NONE; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Context_Interrupt: { + /* + * While the timer is in interrupt context. + */ + ctx->pre_cond_contex = PRE_INTERRUPT; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Context_Server: { + /* + * While the timer is in server context. + */ + ctx->pre_cond_contex = PRE_SERVER; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Context_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Pre_Clock_Prepare( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Pre_Clock state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Pre_Clock_None: { + /* + * While the timer has never been scheduled since creation of the timer. + */ + T_eq_int( ctx->pre_cond_contex, PRE_NONE ); + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Clock_Ticks: { + /* + * While the clock used to determine when the timer will fire is the + * ticks based clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_after( + ctx->timer_id, + SCHEDULE_SOON, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_after( + ctx->timer_id, + SCHEDULE_SOON, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Clock_Realtime: { + /* + * While the clock used to determine when the timer will fire is the + * realtime clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqServerFireAfter_Pre_Clock_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Pre_State_Prepare( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Pre_State state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Pre_State_Inactive: { + /* + * While the timer is in inactive state. + */ + TriggerTimer( ctx ); + T_eq_int( + ctx->invocations, + ( ctx->pre_cond_contex == PRE_NONE ) ? 0 : 1 + ); + ctx->invocations = 0; + ctx->pre_state = TIMER_INACTIVE; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_State_Scheduled: { + /* + * While the timer is in scheduled state. + */ + /* The timer was already scheduled in the "Clock" pre-conditions. */ + ctx->pre_state = TIMER_SCHEDULED; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_State_Pending: { + /* + * While the timer is in pending state. + */ + rtems_status_code status; + if ( ctx->pre_cond_contex == PRE_SERVER ) { + /* + * This call to rtems_timer_fire_after() serves to reach branch coverage + * in an if-statement which only serves performance optimization. + * + * cpukit/rtems/src/timerserver.c:70 else-branch was not reached: + * if ( wakeup ) { + * (void) rtems_event_system_send( ts->server_id, RTEMS_EVENT_SYSTEM_SERVER ); + * } + */ + status = rtems_timer_server_fire_after( + ctx->timer_cover_id, + SCHEDULE_VERY_SOON, + TimerServiceRoutineCover, + ctx + ); + T_rsc_success( status ); + } + + T_rsc_success( rtems_task_suspend( GetTimerServerTaskId() ) ); + TriggerTimer( ctx ); + T_eq_int( ctx->invocations, 0 ); + ctx->pre_state = TIMER_PENDING; + break; + } + + case RtemsTimerReqServerFireAfter_Pre_State_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Post_Status_Check( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Post_Status_Ok: { + /* + * The return status of rtems_timer_server_fire_after() shall be + * RTEMS_SUCCESSFUL. + */ + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Status_InvId: { + /* + * The return status of rtems_timer_server_fire_after() shall be + * RTEMS_INVALID_ID. + */ + T_rsc( ctx->status, RTEMS_INVALID_ID ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Status_InvAddr: { + /* + * The return status of rtems_timer_server_fire_after() shall be + * RTEMS_INVALID_ADDRESS. + */ + T_rsc( ctx->status, RTEMS_INVALID_ADDRESS ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Status_InvNum: { + /* + * The return status of rtems_timer_server_fire_after() shall be + * RTEMS_INVALID_NUMBER. + */ + T_rsc( ctx->status, RTEMS_INVALID_NUMBER ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Status_IncStat: { + /* + * The return status of rtems_timer_server_fire_after() shall be + * RTEMS_INCORRECT_STATE. + */ + T_rsc( ctx->status, RTEMS_INCORRECT_STATE ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Post_Context_Check( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Post_Context state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqServerFireAfter_Post_Context_None: { + /* + * The timer shall have never been scheduled. See also none. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Context_Interrupt: { + /* + * The timer shall be in interrupt context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, 0 ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Context_Server: { + /* + * The timer shall be in server context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, TIMER_CLASS_BIT_ON_TASK ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Context_Nop: { + /* + * Objects referenced by the parameters in the past call to + * rtems_timer_server_fire_after() shall not be accessed by the + * rtems_timer_server_fire_after() call. See also Nop. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Context_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Post_Clock_Check( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Post_Clock state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqServerFireAfter_Post_Clock_None: { + /* + * The timer shall have never been scheduled. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Clock_Ticks: { + /* + * The timer shall use the ticks based clock. + */ + T_eq_int( class & TIMER_CLASS_BIT_TIME_OF_DAY, 0 ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Clock_Realtime: { + /* + * The timer shall use the realtime clock. + */ + T_eq_int( + class & TIMER_CLASS_BIT_TIME_OF_DAY, + TIMER_CLASS_BIT_TIME_OF_DAY + ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Clock_Nop: { + /* + * Objects referenced by the parameters in the past call to + * rtems_timer_server_fire_after() shall not be accessed by the + * rtems_timer_server_fire_after() call. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Clock_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Post_State_Check( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Post_State state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Post_State_Scheduled: { + /* + * The timer shall be in scheduled state. + */ + ctx->ticks_till_fire = TriggerTimer( ctx ); + T_eq_int( ctx->invocations, 1 ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_State_Nop: { + /* + * Objects referenced by the parameters in the past call to + * rtems_timer_server_fire_after() shall not be accessed by the + * rtems_timer_server_fire_after() call. + */ + T_eq_int( ctx->post_state, ctx->pre_state ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_State_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Post_Interval_Check( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Post_Interval state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Post_Interval_Param: { + /* + * The Timer Service Routine shall be invoked the number of ticks (see + * tick), which are provided by the ``ticks`` parameter in the past call + * to rtems_timer_server_fire_after(), after a point in time during the + * execution of the rtems_timer_server_fire_after() call. + */ + T_eq_int( ctx->ticks_till_fire, ctx->ticks_param ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Interval_Nop: { + /* + * If and when the Timer Service Routine will be invoked shall not be + * changed by the past call to rtems_timer_server_fire_after(). + */ + /* + * Whether the timer is scheduled has already been tested by the + * "Nop" "State" post-condition above. + */ + T_eq_u32( + ctx->post_scheduling_data.interval, + ctx->pre_scheduling_data.interval + ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Interval_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Post_Routine_Check( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Post_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Post_Routine_Param: { + /* + * The function reference used to invoke the Timer Service Routine when + * the timer will fire shall be the one provided by the ``routine`` + * parameter in the past call to rtems_timer_server_fire_after(). + */ + T_eq_int( ctx->invocations, 1 ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Routine_Nop: { + /* + * The function reference used for any invocation of the Timer Service + * Routine shall not be changed by the past call to + * rtems_timer_server_fire_after(). + */ + T_eq_ptr( + ctx->post_scheduling_data.routine, + ctx->pre_scheduling_data.routine + ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_Routine_NA: + break; + } +} + +static void RtemsTimerReqServerFireAfter_Post_UserData_Check( + RtemsTimerReqServerFireAfter_Context *ctx, + RtemsTimerReqServerFireAfter_Post_UserData state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireAfter_Post_UserData_Param: { + /* + * The user data argument for invoking the Timer Service Routine when the + * timer will fire shall be the one provided by the ``user_data`` + * parameter in the past call to rtems_timer_server_fire_after(). + */ + T_eq_ptr( ctx->routine_user_data, ctx ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_UserData_Nop: { + /* + * The user data argument used for any invocation of the Timer Service + * Routine shall not be changed by the past call to + * rtems_timer_server_fire_after(). + */ + T_eq_ptr( + ctx->post_scheduling_data.user_data, + ctx->pre_scheduling_data.user_data + ); + break; + } + + case RtemsTimerReqServerFireAfter_Post_UserData_NA: + break; + } +} + +/** + * @brief Make sure the realtime clock is not set after this test. + */ +static void RtemsTimerReqServerFireAfter_Teardown( + RtemsTimerReqServerFireAfter_Context *ctx +) +{ + UnsetClock(); +} + +static void RtemsTimerReqServerFireAfter_Teardown_Wrap( void *arg ) +{ + RtemsTimerReqServerFireAfter_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqServerFireAfter_Teardown( ctx ); +} + +static void RtemsTimerReqServerFireAfter_Prepare( + RtemsTimerReqServerFireAfter_Context *ctx +) +{ + rtems_status_code status; + status = rtems_timer_create( + rtems_build_name( 'T', 'I', 'M', 'E' ), + &ctx->timer_id + ); + T_rsc_success( status ); + + status = rtems_timer_create( + rtems_build_name( 'C', 'O', 'V', 'R' ), + &ctx->timer_cover_id + ); + T_rsc_success( status ); + + ctx->invocations = 0; + ctx->ticks_till_fire = SCHEDULE_NONE; + ctx->routine_user_data = NULL; + T_rsc_success( rtems_clock_set( &tod_now ) ); +} + +static void RtemsTimerReqServerFireAfter_Action( + RtemsTimerReqServerFireAfter_Context *ctx +) +{ + GetTimerSchedulingData( ctx->timer_id, &ctx->pre_scheduling_data ); + ctx->pre_class = GetTimerClass( ctx->timer_id ); + ctx->status = rtems_timer_server_fire_after( + ctx->id_param, + ctx->ticks_param, + ctx->routine_param, + ctx + ); + ctx->post_state = GetTimerState( ctx->timer_id ); + GetTimerSchedulingData( ctx->timer_id, &ctx->post_scheduling_data ); + /* Ignoring return status: the timer server task may be suspended or not. */ + rtems_task_resume( GetTimerServerTaskId() ); +} + +static void RtemsTimerReqServerFireAfter_Cleanup( + RtemsTimerReqServerFireAfter_Context *ctx +) +{ + T_rsc_success( rtems_timer_delete( ctx->timer_cover_id ) ); + T_rsc_success( rtems_timer_delete( ctx->timer_id ) ); + DeleteTimerServer(); +} + +static const RtemsTimerReqServerFireAfter_Entry +RtemsTimerReqServerFireAfter_Entries[] = { + { 1, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireAfter_Post_Status_NA, + RtemsTimerReqServerFireAfter_Post_Context_NA, + RtemsTimerReqServerFireAfter_Post_Clock_NA, + RtemsTimerReqServerFireAfter_Post_State_NA, + RtemsTimerReqServerFireAfter_Post_Interval_NA, + RtemsTimerReqServerFireAfter_Post_Routine_NA, + RtemsTimerReqServerFireAfter_Post_UserData_NA }, + { 1, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireAfter_Post_Status_NA, + RtemsTimerReqServerFireAfter_Post_Context_NA, + RtemsTimerReqServerFireAfter_Post_Clock_NA, + RtemsTimerReqServerFireAfter_Post_State_NA, + RtemsTimerReqServerFireAfter_Post_Interval_NA, + RtemsTimerReqServerFireAfter_Post_Routine_NA, + RtemsTimerReqServerFireAfter_Post_UserData_NA }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireAfter_Post_Status_InvNum, + RtemsTimerReqServerFireAfter_Post_Context_Nop, + RtemsTimerReqServerFireAfter_Post_Clock_Nop, + RtemsTimerReqServerFireAfter_Post_State_Nop, + RtemsTimerReqServerFireAfter_Post_Interval_Nop, + RtemsTimerReqServerFireAfter_Post_Routine_Nop, + RtemsTimerReqServerFireAfter_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireAfter_Post_Status_IncStat, + RtemsTimerReqServerFireAfter_Post_Context_Nop, + RtemsTimerReqServerFireAfter_Post_Clock_Nop, + RtemsTimerReqServerFireAfter_Post_State_Nop, + RtemsTimerReqServerFireAfter_Post_Interval_Nop, + RtemsTimerReqServerFireAfter_Post_Routine_Nop, + RtemsTimerReqServerFireAfter_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireAfter_Post_Status_InvAddr, + RtemsTimerReqServerFireAfter_Post_Context_Nop, + RtemsTimerReqServerFireAfter_Post_Clock_Nop, + RtemsTimerReqServerFireAfter_Post_State_Nop, + RtemsTimerReqServerFireAfter_Post_Interval_Nop, + RtemsTimerReqServerFireAfter_Post_Routine_Nop, + RtemsTimerReqServerFireAfter_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireAfter_Post_Status_Ok, + RtemsTimerReqServerFireAfter_Post_Context_Server, + RtemsTimerReqServerFireAfter_Post_Clock_Ticks, + RtemsTimerReqServerFireAfter_Post_State_Scheduled, + RtemsTimerReqServerFireAfter_Post_Interval_Param, + RtemsTimerReqServerFireAfter_Post_Routine_Param, + RtemsTimerReqServerFireAfter_Post_UserData_Param }, + { 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireAfter_Post_Status_InvId, + RtemsTimerReqServerFireAfter_Post_Context_Nop, + RtemsTimerReqServerFireAfter_Post_Clock_Nop, + RtemsTimerReqServerFireAfter_Post_State_Nop, + RtemsTimerReqServerFireAfter_Post_Interval_Nop, + RtemsTimerReqServerFireAfter_Post_Routine_Nop, + RtemsTimerReqServerFireAfter_Post_UserData_Nop } +}; + +static const uint8_t +RtemsTimerReqServerFireAfter_Map[] = { + 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 5, 5, 0, 0, 0, 0, 5, 5, 5, 5, 5, + 5, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 6, 0, 6, 6, 0, 0, 0, 0, 6, 6, 6, 6, + 6, 6, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, 0, 0, 4, 4, 4, + 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, 0, 0, 4, 4, + 4, 4, 4, 4, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 2, 2, 0, 0, 0, 0, 2, + 2, 2, 2, 2, 2, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 2, 2, 0, 0, 0, 0, + 2, 2, 2, 2, 2, 2, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 2, 2, 0, 0, 0, + 0, 2, 2, 2, 2, 2, 2, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 2, 2, 0, 0, + 0, 0, 2, 2, 2, 2, 2, 2, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, + 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, + 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, + 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, + 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, + 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, + 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1 +}; + +static size_t RtemsTimerReqServerFireAfter_Scope( + void *arg, + char *buf, + size_t n +) +{ + RtemsTimerReqServerFireAfter_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( + RtemsTimerReqServerFireAfter_PreDesc, + buf, + n, + ctx->Map.pcs + ); + } + + return 0; +} + +static T_fixture RtemsTimerReqServerFireAfter_Fixture = { + .setup = NULL, + .stop = NULL, + .teardown = RtemsTimerReqServerFireAfter_Teardown_Wrap, + .scope = RtemsTimerReqServerFireAfter_Scope, + .initial_context = &RtemsTimerReqServerFireAfter_Instance +}; + +static inline RtemsTimerReqServerFireAfter_Entry +RtemsTimerReqServerFireAfter_PopEntry( + RtemsTimerReqServerFireAfter_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqServerFireAfter_Entries[ + RtemsTimerReqServerFireAfter_Map[ index ] + ]; +} + +static void RtemsTimerReqServerFireAfter_TestVariant( + RtemsTimerReqServerFireAfter_Context *ctx +) +{ + RtemsTimerReqServerFireAfter_Pre_Server_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqServerFireAfter_Pre_Ticks_Prepare( ctx, ctx->Map.pcs[ 1 ] ); + RtemsTimerReqServerFireAfter_Pre_Routine_Prepare( ctx, ctx->Map.pcs[ 2 ] ); + RtemsTimerReqServerFireAfter_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 3 ] ); + RtemsTimerReqServerFireAfter_Pre_Context_Prepare( ctx, ctx->Map.pcs[ 4 ] ); + RtemsTimerReqServerFireAfter_Pre_Clock_Prepare( ctx, ctx->Map.pcs[ 5 ] ); + RtemsTimerReqServerFireAfter_Pre_State_Prepare( ctx, ctx->Map.pcs[ 6 ] ); + RtemsTimerReqServerFireAfter_Action( ctx ); + RtemsTimerReqServerFireAfter_Post_Status_Check( + ctx, + ctx->Map.entry.Post_Status + ); + RtemsTimerReqServerFireAfter_Post_Context_Check( + ctx, + ctx->Map.entry.Post_Context + ); + RtemsTimerReqServerFireAfter_Post_Clock_Check( + ctx, + ctx->Map.entry.Post_Clock + ); + RtemsTimerReqServerFireAfter_Post_State_Check( + ctx, + ctx->Map.entry.Post_State + ); + RtemsTimerReqServerFireAfter_Post_Interval_Check( + ctx, + ctx->Map.entry.Post_Interval + ); + RtemsTimerReqServerFireAfter_Post_Routine_Check( + ctx, + ctx->Map.entry.Post_Routine + ); + RtemsTimerReqServerFireAfter_Post_UserData_Check( + ctx, + ctx->Map.entry.Post_UserData + ); +} + +/** + * @fn void T_case_body_RtemsTimerReqServerFireAfter( void ) + */ +T_TEST_CASE_FIXTURE( + RtemsTimerReqServerFireAfter, + &RtemsTimerReqServerFireAfter_Fixture +) +{ + RtemsTimerReqServerFireAfter_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqServerFireAfter_Pre_Server_Init; + ctx->Map.pcs[ 0 ] < RtemsTimerReqServerFireAfter_Pre_Server_NA; + ++ctx->Map.pcs[ 0 ] + ) { + for ( + ctx->Map.pcs[ 1 ] = RtemsTimerReqServerFireAfter_Pre_Ticks_Valid; + ctx->Map.pcs[ 1 ] < RtemsTimerReqServerFireAfter_Pre_Ticks_NA; + ++ctx->Map.pcs[ 1 ] + ) { + for ( + ctx->Map.pcs[ 2 ] = RtemsTimerReqServerFireAfter_Pre_Routine_Valid; + ctx->Map.pcs[ 2 ] < RtemsTimerReqServerFireAfter_Pre_Routine_NA; + ++ctx->Map.pcs[ 2 ] + ) { + for ( + ctx->Map.pcs[ 3 ] = RtemsTimerReqServerFireAfter_Pre_Id_Valid; + ctx->Map.pcs[ 3 ] < RtemsTimerReqServerFireAfter_Pre_Id_NA; + ++ctx->Map.pcs[ 3 ] + ) { + for ( + ctx->Map.pcs[ 4 ] = RtemsTimerReqServerFireAfter_Pre_Context_None; + ctx->Map.pcs[ 4 ] < RtemsTimerReqServerFireAfter_Pre_Context_NA; + ++ctx->Map.pcs[ 4 ] + ) { + for ( + ctx->Map.pcs[ 5 ] = RtemsTimerReqServerFireAfter_Pre_Clock_None; + ctx->Map.pcs[ 5 ] < RtemsTimerReqServerFireAfter_Pre_Clock_NA; + ++ctx->Map.pcs[ 5 ] + ) { + for ( + ctx->Map.pcs[ 6 ] = RtemsTimerReqServerFireAfter_Pre_State_Inactive; + ctx->Map.pcs[ 6 ] < RtemsTimerReqServerFireAfter_Pre_State_NA; + ++ctx->Map.pcs[ 6 ] + ) { + ctx->Map.entry = RtemsTimerReqServerFireAfter_PopEntry( ctx ); + + if ( ctx->Map.entry.Skip ) { + continue; + } + + RtemsTimerReqServerFireAfter_Prepare( ctx ); + RtemsTimerReqServerFireAfter_TestVariant( ctx ); + RtemsTimerReqServerFireAfter_Cleanup( ctx ); + } + } + } + } + } + } + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer-server-fire-when.c b/testsuites/validation/tc-timer-server-fire-when.c new file mode 100644 index 0000000000..a918405058 --- /dev/null +++ b/testsuites/validation/tc-timer-server-fire-when.c @@ -0,0 +1,1417 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerReqServerFireWhen + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> + +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerReqServerFireWhen \ + * spec:/rtems/timer/req/server-fire-when + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @{ + */ + +typedef enum { + RtemsTimerReqServerFireWhen_Pre_Server_Init, + RtemsTimerReqServerFireWhen_Pre_Server_NotInit, + RtemsTimerReqServerFireWhen_Pre_Server_NA +} RtemsTimerReqServerFireWhen_Pre_Server; + +typedef enum { + RtemsTimerReqServerFireWhen_Pre_RtClock_Set, + RtemsTimerReqServerFireWhen_Pre_RtClock_Unset, + RtemsTimerReqServerFireWhen_Pre_RtClock_NA +} RtemsTimerReqServerFireWhen_Pre_RtClock; + +typedef enum { + RtemsTimerReqServerFireWhen_Pre_Routine_Valid, + RtemsTimerReqServerFireWhen_Pre_Routine_Null, + RtemsTimerReqServerFireWhen_Pre_Routine_NA +} RtemsTimerReqServerFireWhen_Pre_Routine; + +typedef enum { + RtemsTimerReqServerFireWhen_Pre_WallTime_Valid, + RtemsTimerReqServerFireWhen_Pre_WallTime_Invalid, + RtemsTimerReqServerFireWhen_Pre_WallTime_Past, + RtemsTimerReqServerFireWhen_Pre_WallTime_Null, + RtemsTimerReqServerFireWhen_Pre_WallTime_NA +} RtemsTimerReqServerFireWhen_Pre_WallTime; + +typedef enum { + RtemsTimerReqServerFireWhen_Pre_Id_Valid, + RtemsTimerReqServerFireWhen_Pre_Id_Invalid, + RtemsTimerReqServerFireWhen_Pre_Id_NA +} RtemsTimerReqServerFireWhen_Pre_Id; + +typedef enum { + RtemsTimerReqServerFireWhen_Pre_Context_None, + RtemsTimerReqServerFireWhen_Pre_Context_Interrupt, + RtemsTimerReqServerFireWhen_Pre_Context_Server, + RtemsTimerReqServerFireWhen_Pre_Context_NA +} RtemsTimerReqServerFireWhen_Pre_Context; + +typedef enum { + RtemsTimerReqServerFireWhen_Pre_Clock_None, + RtemsTimerReqServerFireWhen_Pre_Clock_Ticks, + RtemsTimerReqServerFireWhen_Pre_Clock_Realtime, + RtemsTimerReqServerFireWhen_Pre_Clock_NA +} RtemsTimerReqServerFireWhen_Pre_Clock; + +typedef enum { + RtemsTimerReqServerFireWhen_Pre_State_Inactive, + RtemsTimerReqServerFireWhen_Pre_State_Scheduled, + RtemsTimerReqServerFireWhen_Pre_State_Pending, + RtemsTimerReqServerFireWhen_Pre_State_NA +} RtemsTimerReqServerFireWhen_Pre_State; + +typedef enum { + RtemsTimerReqServerFireWhen_Post_Status_Ok, + RtemsTimerReqServerFireWhen_Post_Status_NotDef, + RtemsTimerReqServerFireWhen_Post_Status_InvId, + RtemsTimerReqServerFireWhen_Post_Status_InvAddr, + RtemsTimerReqServerFireWhen_Post_Status_InvClock, + RtemsTimerReqServerFireWhen_Post_Status_IncStat, + RtemsTimerReqServerFireWhen_Post_Status_NA +} RtemsTimerReqServerFireWhen_Post_Status; + +typedef enum { + RtemsTimerReqServerFireWhen_Post_Context_None, + RtemsTimerReqServerFireWhen_Post_Context_Interrupt, + RtemsTimerReqServerFireWhen_Post_Context_Server, + RtemsTimerReqServerFireWhen_Post_Context_Nop, + RtemsTimerReqServerFireWhen_Post_Context_NA +} RtemsTimerReqServerFireWhen_Post_Context; + +typedef enum { + RtemsTimerReqServerFireWhen_Post_Clock_None, + RtemsTimerReqServerFireWhen_Post_Clock_Ticks, + RtemsTimerReqServerFireWhen_Post_Clock_Realtime, + RtemsTimerReqServerFireWhen_Post_Clock_Nop, + RtemsTimerReqServerFireWhen_Post_Clock_NA +} RtemsTimerReqServerFireWhen_Post_Clock; + +typedef enum { + RtemsTimerReqServerFireWhen_Post_State_Scheduled, + RtemsTimerReqServerFireWhen_Post_State_Nop, + RtemsTimerReqServerFireWhen_Post_State_NA +} RtemsTimerReqServerFireWhen_Post_State; + +typedef enum { + RtemsTimerReqServerFireWhen_Post_WallTime_Param, + RtemsTimerReqServerFireWhen_Post_WallTime_Nop, + RtemsTimerReqServerFireWhen_Post_WallTime_NA +} RtemsTimerReqServerFireWhen_Post_WallTime; + +typedef enum { + RtemsTimerReqServerFireWhen_Post_Routine_Param, + RtemsTimerReqServerFireWhen_Post_Routine_Nop, + RtemsTimerReqServerFireWhen_Post_Routine_NA +} RtemsTimerReqServerFireWhen_Post_Routine; + +typedef enum { + RtemsTimerReqServerFireWhen_Post_UserData_Param, + RtemsTimerReqServerFireWhen_Post_UserData_Nop, + RtemsTimerReqServerFireWhen_Post_UserData_NA +} RtemsTimerReqServerFireWhen_Post_UserData; + +typedef struct { + uint32_t Skip : 1; + uint32_t Pre_Server_NA : 1; + uint32_t Pre_RtClock_NA : 1; + uint32_t Pre_Routine_NA : 1; + uint32_t Pre_WallTime_NA : 1; + uint32_t Pre_Id_NA : 1; + uint32_t Pre_Context_NA : 1; + uint32_t Pre_Clock_NA : 1; + uint32_t Pre_State_NA : 1; + uint32_t Post_Status : 3; + uint32_t Post_Context : 3; + uint32_t Post_Clock : 3; + uint32_t Post_State : 2; + uint32_t Post_WallTime : 2; + uint32_t Post_Routine : 2; + uint32_t Post_UserData : 2; +} RtemsTimerReqServerFireWhen_Entry; + +typedef enum { + PRE_NONE = 0, + PRE_INTERRUPT = 1, + PRE_SERVER = 2 +} PreConditionContext; + +typedef enum { + SCHEDULE_NONE = 0, + SCHEDULE_SOON = 1, + SCHEDULE_MAX = 5 +} Scheduling_Ticks; + +/** + * @brief Test context for spec:/rtems/timer/req/server-fire-when test case. + */ +typedef struct { + /** + * @brief This member contains a valid id of a timer. + */ + rtems_id timer_id; + + /** + * @brief This member specifies the ``id`` parameter for the action. + */ + rtems_id id_param; + + /** + * @brief This member specifies the ``wall_time`` parameter for the action. + */ + const rtems_time_of_day *wall_time_param; + + /** + * @brief This member specifies the ``routine`` parameter for the action. + */ + rtems_timer_service_routine_entry routine_param; + + /** + * @brief This member contains the returned status code of the action. + */ + rtems_status_code status; + + /** + * @brief This member contains a counter of invocations of the Timer Service + * Routine. + */ + int invocations; + + /** + * @brief Function TriggerTimer() is used to figure out when the Timer + * Service Routine gets executed. This member contains the time-of-day when + * the Timer Service Routine fires (see fire). + */ + rtems_time_of_day tod_till_fire; + + /** + * @brief This member contains the user data given to the Timer Service + * Routine when called. + */ + void *routine_user_data; + + /** + * @brief This member specifies which pre-condition context (none, interrupt + * context, server context) must be created before the + * rtems_timer_server_fire_when() action gets executed. + */ + PreConditionContext pre_cond_contex; + + /** + * @brief This member specifies the pre-condition state of the realtime + * clock. It should either be set to the value referenced by pre_cond_tod + * or if NULL, then the realtime clock should be not set. + */ + const rtems_time_of_day *pre_cond_tod; + + /** + * @brief This member stores internal clock and context settings of the timer + * before the execution of the test action. + */ + Timer_Classes pre_class; + + /** + * @brief This member stores the state of the timer before the execution of + * the test action. + */ + Timer_States pre_state; + + /** + * @brief This member stores the state of the timer after the execution of + * the test action. + */ + Timer_States post_state; + + /** + * @brief This member stores the scheduling data of the timer before the + * execution of the test action. + */ + Timer_Scheduling_Data pre_scheduling_data; + + /** + * @brief This member stores the scheduling data of the timer after the + * execution of the test action. + */ + Timer_Scheduling_Data post_scheduling_data; + + struct { + /** + * @brief This member defines the pre-condition states for the next action. + */ + size_t pcs[ 8 ]; + + /** + * @brief If this member is true, then the test action loop is executed. + */ + bool in_action_loop; + + /** + * @brief This member contains the next transition map index. + */ + size_t index; + + /** + * @brief This member contains the current transition map entry. + */ + RtemsTimerReqServerFireWhen_Entry entry; + + /** + * @brief If this member is true, then the current transition variant + * should be skipped. + */ + bool skip; + } Map; +} RtemsTimerReqServerFireWhen_Context; + +static RtemsTimerReqServerFireWhen_Context + RtemsTimerReqServerFireWhen_Instance; + +static const char * const RtemsTimerReqServerFireWhen_PreDesc_Server[] = { + "Init", + "NotInit", + "NA" +}; + +static const char * const RtemsTimerReqServerFireWhen_PreDesc_RtClock[] = { + "Set", + "Unset", + "NA" +}; + +static const char * const RtemsTimerReqServerFireWhen_PreDesc_Routine[] = { + "Valid", + "Null", + "NA" +}; + +static const char * const RtemsTimerReqServerFireWhen_PreDesc_WallTime[] = { + "Valid", + "Invalid", + "Past", + "Null", + "NA" +}; + +static const char * const RtemsTimerReqServerFireWhen_PreDesc_Id[] = { + "Valid", + "Invalid", + "NA" +}; + +static const char * const RtemsTimerReqServerFireWhen_PreDesc_Context[] = { + "None", + "Interrupt", + "Server", + "NA" +}; + +static const char * const RtemsTimerReqServerFireWhen_PreDesc_Clock[] = { + "None", + "Ticks", + "Realtime", + "NA" +}; + +static const char * const RtemsTimerReqServerFireWhen_PreDesc_State[] = { + "Inactive", + "Scheduled", + "Pending", + "NA" +}; + +static const char * const * const RtemsTimerReqServerFireWhen_PreDesc[] = { + RtemsTimerReqServerFireWhen_PreDesc_Server, + RtemsTimerReqServerFireWhen_PreDesc_RtClock, + RtemsTimerReqServerFireWhen_PreDesc_Routine, + RtemsTimerReqServerFireWhen_PreDesc_WallTime, + RtemsTimerReqServerFireWhen_PreDesc_Id, + RtemsTimerReqServerFireWhen_PreDesc_Context, + RtemsTimerReqServerFireWhen_PreDesc_Clock, + RtemsTimerReqServerFireWhen_PreDesc_State, + NULL +}; + +static const rtems_time_of_day tod_now = { 2000, 1, 1, 0, 0, 0, 0 }; +static const rtems_time_of_day tod_schedule = { 2000, 1, 1, 5, 0, 0, 0 }; +static const rtems_time_of_day tod_invalid = { 1985, 1, 1, 0, 0, 0, 0 }; +static const rtems_time_of_day tod_past = { 1999, 12, 31, 23, 59, 59, 1 }; + +static void TriggerTimer( + const RtemsTimerReqServerFireWhen_Context *ctx, + rtems_time_of_day *tod_fire +) +{ + rtems_time_of_day tod = tod_now; + int invocations_old = ctx->invocations; + int i; + + /* Fire the timer service routine for ticks and realtime clock */ + for ( i = 1; i <= SCHEDULE_MAX; ++i ) { + ClockTick(); + } + + for ( i = 1; i < 24; ++i ) { + tod.hour = i; + T_rsc_success( rtems_clock_set( &tod ) ); + if ( tod_fire != NULL && ctx->invocations > invocations_old ) { + *tod_fire = tod; + break; + } + } +} + +static void TimerServiceRoutine( + rtems_id timer_id, + void *user_data +) +{ + RtemsTimerReqServerFireWhen_Context *ctx = user_data; + ++( ctx->invocations ); + ctx->routine_user_data = user_data; +} + +static void RtemsTimerReqServerFireWhen_Pre_Server_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Pre_Server state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Pre_Server_Init: { + /* + * While the Timer Server task has been successfully initialized by a + * call to rtems_timer_initiate_server(). + */ + rtems_status_code status; + status = rtems_timer_initiate_server( + RTEMS_TIMER_SERVER_DEFAULT_PRIORITY, + RTEMS_MINIMUM_STACK_SIZE, + RTEMS_DEFAULT_ATTRIBUTES + ); + T_rsc_success( status ); + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Server_NotInit: { + /* + * While the Timer Server task has not been initialized and does not + * exist. + */ + DeleteTimerServer(); + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Server_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Pre_RtClock_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Pre_RtClock state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Pre_RtClock_Set: { + /* + * While the realtime clock is set to a valid time-of-day. + */ + ctx->pre_cond_tod = &tod_now; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_RtClock_Unset: { + /* + * While the realtime clock has never been set. + */ + ctx->pre_cond_tod = NULL; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_RtClock_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Pre_Routine_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Pre_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Pre_Routine_Valid: { + /* + * While the ``routine`` parameter references an object of type + * rtems_timer_service_routine_entry. + */ + ctx->routine_param = TimerServiceRoutine; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Routine_Null: { + /* + * While the ``routine`` parameter is NULL.. + */ + ctx->routine_param = NULL; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Routine_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Pre_WallTime_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Pre_WallTime state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Pre_WallTime_Valid: { + /* + * While the ``wall_time`` parameter references a time at least one + * second in the future but not later than the last second of the year + * 2105. (Times after 2105 are invalid.) + */ + ctx->wall_time_param = &tod_schedule; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_WallTime_Invalid: { + /* + * While the ``wall_time`` parameter is invalid. + */ + ctx->wall_time_param = &tod_invalid; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_WallTime_Past: { + /* + * While the ``wall_time`` parameter references a time in the current + * second or in the past but not earlier than 1988. (Times before 1988 + * are invalid.) + */ + ctx->wall_time_param = &tod_past; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_WallTime_Null: { + /* + * While the ``wall_time`` parameter is 0. + */ + ctx->wall_time_param = NULL; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_WallTime_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Pre_Id_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Pre_Id state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Pre_Id_Valid: { + /* + * While the ``id`` parameter is valid. + */ + ctx->id_param = ctx->timer_id; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Id_Invalid: { + /* + * While the ``id`` parameter is invalid. + */ + ctx->id_param = RTEMS_ID_NONE; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Id_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Pre_Context_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Pre_Context state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Pre_Context_None: { + /* + * While the Timer Service Routine has never been scheduled since + * creation of the timer. See also none. + */ + ctx->pre_cond_contex = PRE_NONE; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Context_Interrupt: { + /* + * While the timer is in interrupt context. + */ + ctx->pre_cond_contex = PRE_INTERRUPT; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Context_Server: { + /* + * While the timer is in server context. + */ + ctx->pre_cond_contex = PRE_SERVER; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Context_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Pre_Clock_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Pre_Clock state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Pre_Clock_None: { + /* + * While the timer has never been scheduled since creation of the timer. + */ + T_eq_int( ctx->pre_cond_contex, PRE_NONE ); + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Clock_Ticks: { + /* + * While the clock used to determine when the timer will fire is the + * ticks based clock. + */ + rtems_status_code status; + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_after( + ctx->timer_id, + SCHEDULE_SOON, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_after( + ctx->timer_id, + SCHEDULE_SOON, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Clock_Realtime: { + /* + * While the clock used to determine when the timer will fire is the + * realtime clock. + */ + rtems_status_code status; + T_rsc_success( rtems_clock_set( &tod_now ) ); + + if ( ctx->pre_cond_contex == PRE_INTERRUPT ) { + status = rtems_timer_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } else { + status = rtems_timer_server_fire_when( + ctx->timer_id, + &tod_schedule, + TimerServiceRoutine, + ctx + ); + } + T_rsc_success( status ); + break; + } + + case RtemsTimerReqServerFireWhen_Pre_Clock_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Pre_State_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Pre_State state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Pre_State_Inactive: { + /* + * While the timer is in inactive state. + */ + TriggerTimer( ctx, NULL ); + T_eq_int( + ctx->invocations, + ( ctx->pre_cond_contex == PRE_NONE ) ? 0 : 1 + ); + ctx->invocations = 0; + ctx->pre_state = TIMER_INACTIVE; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_State_Scheduled: { + /* + * While the timer is in scheduled state. + */ + /* The timer was already scheduled in the "Clock" pre-conditions. */ + ctx->pre_state = TIMER_SCHEDULED; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_State_Pending: { + /* + * While the timer is in pending state. + */ + T_rsc_success( rtems_task_suspend( GetTimerServerTaskId() ) ); + TriggerTimer( ctx, NULL ); + T_eq_int( ctx->invocations, 0 ); + ctx->pre_state = TIMER_PENDING; + break; + } + + case RtemsTimerReqServerFireWhen_Pre_State_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Post_Status_Check( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Post_Status state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Post_Status_Ok: { + /* + * The return status of rtems_timer_server_fire_when() shall be + * RTEMS_SUCCESSFUL. + */ + T_rsc_success( ctx->status ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Status_NotDef: { + /* + * The return status of rtems_timer_server_fire_when() shall be + * RTEMS_NOT_DEFINED + */ + T_rsc( ctx->status, RTEMS_NOT_DEFINED ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Status_InvId: { + /* + * The return status of rtems_timer_server_fire_when() shall be + * RTEMS_INVALID_ID. + */ + T_rsc( ctx->status, RTEMS_INVALID_ID ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Status_InvAddr: { + /* + * The return status of rtems_timer_server_fire_when() shall be + * RTEMS_INVALID_ADDRESS. + */ + T_rsc( ctx->status, RTEMS_INVALID_ADDRESS ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Status_InvClock: { + /* + * The return status of rtems_timer_server_fire_when() shall be + * RTEMS_INVALID_CLOCK. + */ + T_rsc( ctx->status, RTEMS_INVALID_CLOCK ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Status_IncStat: { + /* + * The return status of rtems_timer_server_fire_when() shall be + * RTEMS_INCORRECT_STATE. + */ + T_rsc( ctx->status, RTEMS_INCORRECT_STATE ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Status_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Post_Context_Check( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Post_Context state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqServerFireWhen_Post_Context_None: { + /* + * The timer shall have never been scheduled. See also none. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Context_Interrupt: { + /* + * The timer shall be in interrupt context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, 0 ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Context_Server: { + /* + * The timer shall be in server context. + */ + T_eq_int( class & TIMER_CLASS_BIT_ON_TASK, TIMER_CLASS_BIT_ON_TASK ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Context_Nop: { + /* + * Objects referenced by parameters in the past call to + * rtems_timer_server_fire_when() shall not be accessed by the + * rtems_timer_server_fire_when() call. See also Nop. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Context_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Post_Clock_Check( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Post_Clock state +) +{ + Timer_Classes class; + class = GetTimerClass( ctx->timer_id ); + + switch ( state ) { + case RtemsTimerReqServerFireWhen_Post_Clock_None: { + /* + * The timer shall have never been scheduled. + */ + T_eq_int( class, TIMER_DORMANT ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Clock_Ticks: { + /* + * The timer shall use the ticks based clock. + */ + T_eq_int( class & TIMER_CLASS_BIT_TIME_OF_DAY, 0 ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Clock_Realtime: { + /* + * The timer shall use the realtime clock. + */ + T_eq_int( + class & TIMER_CLASS_BIT_TIME_OF_DAY, + TIMER_CLASS_BIT_TIME_OF_DAY + ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Clock_Nop: { + /* + * Objects referenced by parameters in the past call to + * rtems_timer_server_fire_when() shall not be accessed by the + * rtems_timer_server_fire_when() call. + */ + T_eq_int( class, ctx->pre_class ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Clock_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Post_State_Check( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Post_State state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Post_State_Scheduled: { + /* + * The timer shall be in scheduled state. + */ + TriggerTimer( ctx, &ctx->tod_till_fire ); + T_eq_int( ctx->invocations, 1 ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_State_Nop: { + /* + * Objects referenced by parameters in the past call to + * rtems_timer_server_fire_when() shall not be accessed by the + * rtems_timer_server_fire_when() call. + */ + T_eq_int( ctx->post_state, ctx->pre_state ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_State_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Post_WallTime_Check( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Post_WallTime state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Post_WallTime_Param: { + /* + * The Timer Service Routine shall be invoked at the wall time (see + * realtime clock) (ignoring ticks), which was provided by the + * ``wall_time`` parameter in the past call to + * rtems_timer_server_fire_when(). + */ + T_eq_mem( + &ctx->tod_till_fire, + ctx->wall_time_param, + sizeof( ctx->tod_till_fire ) + ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_WallTime_Nop: { + /* + * If and when the Timer Service Routine will be invoked shall not be + * changed by the past call to rtems_timer_server_fire_when(). + */ + /* + * Whether the timer is scheduled has already been tested by the + * "Nop" "State" post-condition above. + */ + T_eq_u32( + ctx->post_scheduling_data.interval, + ctx->pre_scheduling_data.interval + ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_WallTime_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Post_Routine_Check( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Post_Routine state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Post_Routine_Param: { + /* + * The function reference used to invoke the Timer Service Routine when + * the timer will fire shall be the one provided by the ``routine`` + * parameter in the past call to rtems_timer_server_fire_when(). + */ + T_eq_int( ctx->invocations, 1 ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Routine_Nop: { + /* + * The function reference used for any invocation of the Timer Service + * Routine shall not be changed by the past call to + * rtems_timer_server_fire_when(). + */ + T_eq_ptr( + ctx->post_scheduling_data.routine, + ctx->pre_scheduling_data.routine + ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_Routine_NA: + break; + } +} + +static void RtemsTimerReqServerFireWhen_Post_UserData_Check( + RtemsTimerReqServerFireWhen_Context *ctx, + RtemsTimerReqServerFireWhen_Post_UserData state +) +{ + switch ( state ) { + case RtemsTimerReqServerFireWhen_Post_UserData_Param: { + /* + * The user data argument for invoking the Timer Service Routine when the + * timer will fire shall be the one provided by the ``user_data`` + * parameter in the past call to rtems_timer_server_fire_when(). + */ + T_eq_ptr( ctx->routine_user_data, ctx ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_UserData_Nop: { + /* + * The user data argument used for any invocation of the Timer Service + * Routine shall not be changed by the past call to + * rtems_timer_server_fire_when(). + */ + T_eq_ptr( + ctx->post_scheduling_data.user_data, + ctx->pre_scheduling_data.user_data + ); + break; + } + + case RtemsTimerReqServerFireWhen_Post_UserData_NA: + break; + } +} + +/** + * @brief Make sure the realtime clock is not set after this test. + */ +static void RtemsTimerReqServerFireWhen_Teardown( + RtemsTimerReqServerFireWhen_Context *ctx +) +{ + UnsetClock(); +} + +static void RtemsTimerReqServerFireWhen_Teardown_Wrap( void *arg ) +{ + RtemsTimerReqServerFireWhen_Context *ctx; + + ctx = arg; + ctx->Map.in_action_loop = false; + RtemsTimerReqServerFireWhen_Teardown( ctx ); +} + +static void RtemsTimerReqServerFireWhen_Prepare( + RtemsTimerReqServerFireWhen_Context *ctx +) +{ + rtems_status_code status; + status = rtems_timer_create( + rtems_build_name( 'T', 'I', 'M', 'E' ), + &ctx->timer_id + ); + T_rsc_success( status ); + + ctx->invocations = 0; + ctx->routine_user_data = NULL; +} + +static void RtemsTimerReqServerFireWhen_Action( + RtemsTimerReqServerFireWhen_Context *ctx +) +{ + GetTimerSchedulingData( ctx->timer_id, &ctx->pre_scheduling_data ); + ctx->pre_class = GetTimerClass( ctx->timer_id ); + if ( ctx->pre_cond_tod == NULL ) { + UnsetClock(); + } else { + T_rsc_success( rtems_clock_set( ctx->pre_cond_tod ) ); + } + ctx->status = rtems_timer_server_fire_when( + ctx->id_param, + ctx->wall_time_param, + ctx->routine_param, + ctx + ); + ctx->post_state = GetTimerState( ctx->timer_id ); + GetTimerSchedulingData( ctx->timer_id, &ctx->post_scheduling_data ); + /* Ignoring return status: the timer server task may be suspended or not. */ + rtems_task_resume( GetTimerServerTaskId() ); +} + +static void RtemsTimerReqServerFireWhen_Cleanup( + RtemsTimerReqServerFireWhen_Context *ctx +) +{ + T_rsc_success( rtems_timer_delete( ctx->timer_id ) ); + DeleteTimerServer(); +} + +static const RtemsTimerReqServerFireWhen_Entry +RtemsTimerReqServerFireWhen_Entries[] = { + { 1, 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireWhen_Post_Status_NA, + RtemsTimerReqServerFireWhen_Post_Context_NA, + RtemsTimerReqServerFireWhen_Post_Clock_NA, + RtemsTimerReqServerFireWhen_Post_State_NA, + RtemsTimerReqServerFireWhen_Post_WallTime_NA, + RtemsTimerReqServerFireWhen_Post_Routine_NA, + RtemsTimerReqServerFireWhen_Post_UserData_NA }, + { 1, 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireWhen_Post_Status_NA, + RtemsTimerReqServerFireWhen_Post_Context_NA, + RtemsTimerReqServerFireWhen_Post_Clock_NA, + RtemsTimerReqServerFireWhen_Post_State_NA, + RtemsTimerReqServerFireWhen_Post_WallTime_NA, + RtemsTimerReqServerFireWhen_Post_Routine_NA, + RtemsTimerReqServerFireWhen_Post_UserData_NA }, + { 1, 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireWhen_Post_Status_NA, + RtemsTimerReqServerFireWhen_Post_Context_NA, + RtemsTimerReqServerFireWhen_Post_Clock_NA, + RtemsTimerReqServerFireWhen_Post_State_NA, + RtemsTimerReqServerFireWhen_Post_WallTime_NA, + RtemsTimerReqServerFireWhen_Post_Routine_NA, + RtemsTimerReqServerFireWhen_Post_UserData_NA }, + { 0, 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireWhen_Post_Status_IncStat, + RtemsTimerReqServerFireWhen_Post_Context_Nop, + RtemsTimerReqServerFireWhen_Post_Clock_Nop, + RtemsTimerReqServerFireWhen_Post_State_Nop, + RtemsTimerReqServerFireWhen_Post_WallTime_Nop, + RtemsTimerReqServerFireWhen_Post_Routine_Nop, + RtemsTimerReqServerFireWhen_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireWhen_Post_Status_InvAddr, + RtemsTimerReqServerFireWhen_Post_Context_Nop, + RtemsTimerReqServerFireWhen_Post_Clock_Nop, + RtemsTimerReqServerFireWhen_Post_State_Nop, + RtemsTimerReqServerFireWhen_Post_WallTime_Nop, + RtemsTimerReqServerFireWhen_Post_Routine_Nop, + RtemsTimerReqServerFireWhen_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireWhen_Post_Status_NotDef, + RtemsTimerReqServerFireWhen_Post_Context_Nop, + RtemsTimerReqServerFireWhen_Post_Clock_Nop, + RtemsTimerReqServerFireWhen_Post_State_Nop, + RtemsTimerReqServerFireWhen_Post_WallTime_Nop, + RtemsTimerReqServerFireWhen_Post_Routine_Nop, + RtemsTimerReqServerFireWhen_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, 0, + RtemsTimerReqServerFireWhen_Post_Status_InvClock, + RtemsTimerReqServerFireWhen_Post_Context_Nop, + RtemsTimerReqServerFireWhen_Post_Clock_Nop, + RtemsTimerReqServerFireWhen_Post_State_Nop, + RtemsTimerReqServerFireWhen_Post_WallTime_Nop, + RtemsTimerReqServerFireWhen_Post_Routine_Nop, + RtemsTimerReqServerFireWhen_Post_UserData_Nop }, + { 0, 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireWhen_Post_Status_Ok, + RtemsTimerReqServerFireWhen_Post_Context_Server, + RtemsTimerReqServerFireWhen_Post_Clock_Realtime, + RtemsTimerReqServerFireWhen_Post_State_Scheduled, + RtemsTimerReqServerFireWhen_Post_WallTime_Param, + RtemsTimerReqServerFireWhen_Post_Routine_Param, + RtemsTimerReqServerFireWhen_Post_UserData_Param }, + { 0, 0, 0, 0, 0, 0, 0, 0, 0, RtemsTimerReqServerFireWhen_Post_Status_InvId, + RtemsTimerReqServerFireWhen_Post_Context_Nop, + RtemsTimerReqServerFireWhen_Post_Clock_Nop, + RtemsTimerReqServerFireWhen_Post_State_Nop, + RtemsTimerReqServerFireWhen_Post_WallTime_Nop, + RtemsTimerReqServerFireWhen_Post_Routine_Nop, + RtemsTimerReqServerFireWhen_Post_UserData_Nop } +}; + +static const uint8_t +RtemsTimerReqServerFireWhen_Map[] = { + 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 7, 0, 7, 7, 0, 0, 0, 0, 7, 7, 7, 7, 7, + 7, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8, 8, 0, 8, 8, 0, 0, 0, 0, 8, 8, 8, 8, + 8, 8, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 6, 0, 6, 6, 0, 0, 0, 0, 6, 6, 6, + 6, 6, 6, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 6, 0, 6, 6, 0, 0, 0, 0, 6, 6, + 6, 6, 6, 6, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 6, 0, 6, 6, 0, 0, 0, 0, 6, + 6, 6, 6, 6, 6, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 6, 0, 6, 6, 0, 0, 0, 0, + 6, 6, 6, 6, 6, 6, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, 0, + 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, 0, + 0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, 0, + 0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 4, + 0, 0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, + 4, 0, 0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, + 4, 4, 0, 0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, + 0, 4, 4, 0, 0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, + 4, 0, 4, 4, 0, 0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 4, 4, 0, 4, 4, 0, 0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 4, 4, 0, 4, 4, 0, 0, 0, 0, 4, 4, 4, 4, 4, 4, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, 5, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, 2, + 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, 2, + 2, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, 2, + 2, 2, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, 5, + 2, 2, 2, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, 5, + 5, 2, 2, 2, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, 5, + 5, 5, 2, 2, 2, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 5, 0, 2, 2, 2, 0, 0, 0, + 5, 5, 5, 2, 2, 2, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, 0, 0, + 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, 0, + 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, + 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, + 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, + 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, + 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, + 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, + 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 3, 3, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, 1, 1, 1, 1, 1, + 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, 1, 1, 1, 1, + 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, 1, 1, 1, + 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, 1, 1, + 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, 1, + 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, 1, + 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, 0, + 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, 0, + 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, 0, + 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, 2, + 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, 2, + 2, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, 2, + 2, 2, 0, 0, 0, 1, 1, 1, 1, 1, 1, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 3, 0, + 2, 2, 2, 0, 0, 0, 1, 1, 1, 1, 1, 1 +}; + +static size_t RtemsTimerReqServerFireWhen_Scope( + void *arg, + char *buf, + size_t n +) +{ + RtemsTimerReqServerFireWhen_Context *ctx; + + ctx = arg; + + if ( ctx->Map.in_action_loop ) { + return T_get_scope( + RtemsTimerReqServerFireWhen_PreDesc, + buf, + n, + ctx->Map.pcs + ); + } + + return 0; +} + +static T_fixture RtemsTimerReqServerFireWhen_Fixture = { + .setup = NULL, + .stop = NULL, + .teardown = RtemsTimerReqServerFireWhen_Teardown_Wrap, + .scope = RtemsTimerReqServerFireWhen_Scope, + .initial_context = &RtemsTimerReqServerFireWhen_Instance +}; + +static inline RtemsTimerReqServerFireWhen_Entry +RtemsTimerReqServerFireWhen_PopEntry( + RtemsTimerReqServerFireWhen_Context *ctx +) +{ + size_t index; + + index = ctx->Map.index; + ctx->Map.index = index + 1; + return RtemsTimerReqServerFireWhen_Entries[ + RtemsTimerReqServerFireWhen_Map[ index ] + ]; +} + +static void RtemsTimerReqServerFireWhen_TestVariant( + RtemsTimerReqServerFireWhen_Context *ctx +) +{ + RtemsTimerReqServerFireWhen_Pre_Server_Prepare( ctx, ctx->Map.pcs[ 0 ] ); + RtemsTimerReqServerFireWhen_Pre_RtClock_Prepare( ctx, ctx->Map.pcs[ 1 ] ); + RtemsTimerReqServerFireWhen_Pre_Routine_Prepare( ctx, ctx->Map.pcs[ 2 ] ); + RtemsTimerReqServerFireWhen_Pre_WallTime_Prepare( ctx, ctx->Map.pcs[ 3 ] ); + RtemsTimerReqServerFireWhen_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 4 ] ); + RtemsTimerReqServerFireWhen_Pre_Context_Prepare( ctx, ctx->Map.pcs[ 5 ] ); + RtemsTimerReqServerFireWhen_Pre_Clock_Prepare( ctx, ctx->Map.pcs[ 6 ] ); + RtemsTimerReqServerFireWhen_Pre_State_Prepare( ctx, ctx->Map.pcs[ 7 ] ); + RtemsTimerReqServerFireWhen_Action( ctx ); + RtemsTimerReqServerFireWhen_Post_Status_Check( + ctx, + ctx->Map.entry.Post_Status + ); + RtemsTimerReqServerFireWhen_Post_Context_Check( + ctx, + ctx->Map.entry.Post_Context + ); + RtemsTimerReqServerFireWhen_Post_Clock_Check( + ctx, + ctx->Map.entry.Post_Clock + ); + RtemsTimerReqServerFireWhen_Post_State_Check( + ctx, + ctx->Map.entry.Post_State + ); + RtemsTimerReqServerFireWhen_Post_WallTime_Check( + ctx, + ctx->Map.entry.Post_WallTime + ); + RtemsTimerReqServerFireWhen_Post_Routine_Check( + ctx, + ctx->Map.entry.Post_Routine + ); + RtemsTimerReqServerFireWhen_Post_UserData_Check( + ctx, + ctx->Map.entry.Post_UserData + ); +} + +/** + * @fn void T_case_body_RtemsTimerReqServerFireWhen( void ) + */ +T_TEST_CASE_FIXTURE( + RtemsTimerReqServerFireWhen, + &RtemsTimerReqServerFireWhen_Fixture +) +{ + RtemsTimerReqServerFireWhen_Context *ctx; + + ctx = T_fixture_context(); + ctx->Map.in_action_loop = true; + ctx->Map.index = 0; + + for ( + ctx->Map.pcs[ 0 ] = RtemsTimerReqServerFireWhen_Pre_Server_Init; + ctx->Map.pcs[ 0 ] < RtemsTimerReqServerFireWhen_Pre_Server_NA; + ++ctx->Map.pcs[ 0 ] + ) { + for ( + ctx->Map.pcs[ 1 ] = RtemsTimerReqServerFireWhen_Pre_RtClock_Set; + ctx->Map.pcs[ 1 ] < RtemsTimerReqServerFireWhen_Pre_RtClock_NA; + ++ctx->Map.pcs[ 1 ] + ) { + for ( + ctx->Map.pcs[ 2 ] = RtemsTimerReqServerFireWhen_Pre_Routine_Valid; + ctx->Map.pcs[ 2 ] < RtemsTimerReqServerFireWhen_Pre_Routine_NA; + ++ctx->Map.pcs[ 2 ] + ) { + for ( + ctx->Map.pcs[ 3 ] = RtemsTimerReqServerFireWhen_Pre_WallTime_Valid; + ctx->Map.pcs[ 3 ] < RtemsTimerReqServerFireWhen_Pre_WallTime_NA; + ++ctx->Map.pcs[ 3 ] + ) { + for ( + ctx->Map.pcs[ 4 ] = RtemsTimerReqServerFireWhen_Pre_Id_Valid; + ctx->Map.pcs[ 4 ] < RtemsTimerReqServerFireWhen_Pre_Id_NA; + ++ctx->Map.pcs[ 4 ] + ) { + for ( + ctx->Map.pcs[ 5 ] = RtemsTimerReqServerFireWhen_Pre_Context_None; + ctx->Map.pcs[ 5 ] < RtemsTimerReqServerFireWhen_Pre_Context_NA; + ++ctx->Map.pcs[ 5 ] + ) { + for ( + ctx->Map.pcs[ 6 ] = RtemsTimerReqServerFireWhen_Pre_Clock_None; + ctx->Map.pcs[ 6 ] < RtemsTimerReqServerFireWhen_Pre_Clock_NA; + ++ctx->Map.pcs[ 6 ] + ) { + for ( + ctx->Map.pcs[ 7 ] = RtemsTimerReqServerFireWhen_Pre_State_Inactive; + ctx->Map.pcs[ 7 ] < RtemsTimerReqServerFireWhen_Pre_State_NA; + ++ctx->Map.pcs[ 7 ] + ) { + ctx->Map.entry = RtemsTimerReqServerFireWhen_PopEntry( ctx ); + + if ( ctx->Map.entry.Skip ) { + continue; + } + + RtemsTimerReqServerFireWhen_Prepare( ctx ); + RtemsTimerReqServerFireWhen_TestVariant( ctx ); + RtemsTimerReqServerFireWhen_Cleanup( ctx ); + } + } + } + } + } + } + } + } +} + +/** @} */ diff --git a/testsuites/validation/tc-timer.c b/testsuites/validation/tc-timer.c new file mode 100644 index 0000000000..a7a25222bb --- /dev/null +++ b/testsuites/validation/tc-timer.c @@ -0,0 +1,208 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseRtemsTimerValTimer + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * This file is part of the RTEMS quality process and was automatically + * generated. If you find something that needs to be fixed or + * worded better please post a report or patch to an RTEMS mailing list + * or raise a bug report: + * + * https://www.rtems.org/bugs.html + * + * For information on updating and regenerating please refer to the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <rtems.h> +#include <rtems/score/atomic.h> + +#include "ts-config.h" +#include "tx-support.h" + +#include <rtems/test.h> + +/** + * @defgroup RTEMSTestCaseRtemsTimerValTimer spec:/rtems/timer/val/timer + * + * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0 + * + * @brief Tests general timer behaviour. + * + * This test case performs the following actions: + * + * - Create a couple of timers. + * + * - Schedule some timers at the same time point. + * + * - Fire the timers and check that they fired in the expected order. + * + * - Clean up all used resources. + * + * @{ + */ + +/** + * @brief Test context for spec:/rtems/timer/val/timer test case. + */ +typedef struct { + /** + * @brief This member contains the timer identifiers. + */ + rtems_id timer_ids[ TEST_MAXIMUM_TIMERS ]; + + /** + * @brief This member contains the counter. + */ + Atomic_Uint counter; + + /** + * @brief This member contains the timer counter snapshots. + */ + unsigned int counter_snapshots[ TEST_MAXIMUM_TIMERS ]; +} RtemsTimerValTimer_Context; + +static RtemsTimerValTimer_Context + RtemsTimerValTimer_Instance; + +typedef RtemsTimerValTimer_Context Context; + +static void Timer( rtems_id timer, void *arg ) +{ + Context *ctx; + unsigned int *counter; + + ctx = T_fixture_context(); + counter = arg; + *counter = _Atomic_Fetch_add_uint( + &ctx->counter, + 1, + ATOMIC_ORDER_RELAXED + ) + 1; +} + +static void Fire( Context *ctx, size_t i, rtems_interval ticks ) +{ + rtems_status_code sc; + + ctx->counter_snapshots[ i ] = 0; + sc = rtems_timer_fire_after( + ctx->timer_ids[ i ], + ticks, + Timer, + &ctx->counter_snapshots[ i ] + ); + T_rsc_success( sc ); +} + +static T_fixture RtemsTimerValTimer_Fixture = { + .setup = NULL, + .stop = NULL, + .teardown = NULL, + .scope = NULL, + .initial_context = &RtemsTimerValTimer_Instance +}; + +/** + * @brief Create a couple of timers. + */ +static void RtemsTimerValTimer_Action_0( RtemsTimerValTimer_Context *ctx ) +{ + rtems_status_code sc; + size_t i; + + T_assert_eq_sz( TEST_MAXIMUM_TIMERS, 10 ); + + _Atomic_Init_uint( &ctx->counter, 0 ); + + for ( i = 0; i < TEST_MAXIMUM_TIMERS ; ++i ) { + sc = rtems_timer_create( + rtems_build_name( 'T', 'E', 'S', 'T' ), + &ctx->timer_ids[ i ] + ); + T_rsc_success( sc ); + } + + /* + * Schedule some timers at the same time point. + */ + Fire( ctx, 3, 2 ); + Fire( ctx, 0, 1 ); + Fire( ctx, 7, 3 ); + Fire( ctx, 4, 2 ); + Fire( ctx, 5, 2 ); + Fire( ctx, 8, 3 ); + Fire( ctx, 9, 3 ); + Fire( ctx, 1, 1 ); + Fire( ctx, 2, 1 ); + Fire( ctx, 6, 2 ); + + /* + * Fire the timers and check that they fired in the expected order. + */ + FinalClockTick(); + + for ( i = 0; i < TEST_MAXIMUM_TIMERS ; ++i ) { + T_eq_sz( ctx->counter_snapshots[ i ], i + 1 ); + } + + /* + * Clean up all used resources. + */ + for ( i = 0; i < TEST_MAXIMUM_TIMERS ; ++i ) { + sc = rtems_timer_delete( ctx->timer_ids[ i ] ); + T_rsc_success( sc ); + } +} + +/** + * @fn void T_case_body_RtemsTimerValTimer( void ) + */ +T_TEST_CASE_FIXTURE( RtemsTimerValTimer, &RtemsTimerValTimer_Fixture ) +{ + RtemsTimerValTimer_Context *ctx; + + ctx = T_fixture_context(); + + RtemsTimerValTimer_Action_0( ctx ); +} + +/** @} */ |