From aec1727fa3a62bfb5acf83325775262bc751b8a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frank=20K=C3=BChndel?= Date: Thu, 8 Apr 2021 15:07:13 +0200 Subject: spec: Add spec items for clock manager Adding the specification items to rtems-central for those methods of the clock manager which are mentioned in the space profile. The SRS requirements and their tests can be generated from these specification items. --- spec/rtems/clock/req/get-ticks-per-second.yml | 16 + spec/rtems/clock/req/get-ticks-since-boot.yml | 17 + spec/rtems/clock/req/get-tod.yml | 261 +++++++++++++++ spec/rtems/clock/req/get-uptime.yml | 118 +++++++ spec/rtems/clock/req/set.yml | 450 ++++++++++++++++++++++++++ spec/rtems/clock/val/clock.yml | 67 ++++ 6 files changed, 929 insertions(+) create mode 100644 spec/rtems/clock/req/get-ticks-per-second.yml create mode 100644 spec/rtems/clock/req/get-ticks-since-boot.yml create mode 100644 spec/rtems/clock/req/get-tod.yml create mode 100644 spec/rtems/clock/req/get-uptime.yml create mode 100644 spec/rtems/clock/req/set.yml create mode 100644 spec/rtems/clock/val/clock.yml diff --git a/spec/rtems/clock/req/get-ticks-per-second.yml b/spec/rtems/clock/req/get-ticks-per-second.yml new file mode 100644 index 00000000..13e8d1a4 --- /dev/null +++ b/spec/rtems/clock/req/get-ticks-per-second.yml @@ -0,0 +1,16 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +links: +- role: requirement-refinement + uid: ../if/get-ticks-per-second +non-functional-type: interface +rationale: null +references: [] +requirement-type: non-functional +text: | + The ${../if/get-ticks-per-second:/name} function shall + return the number of clock ticks per second which is defined indirectly + by the CONFIGURE_MICROSECONDS_PER_TICK configuration option.. +type: requirement diff --git a/spec/rtems/clock/req/get-ticks-since-boot.yml b/spec/rtems/clock/req/get-ticks-since-boot.yml new file mode 100644 index 00000000..141d1fc7 --- /dev/null +++ b/spec/rtems/clock/req/get-ticks-since-boot.yml @@ -0,0 +1,17 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +links: +- role: requirement-refinement + uid: ../if/get-ticks-since-boot +non-functional-type: interface +rationale: null +references: [] +requirement-type: non-functional +text: | + The ${../if/get-ticks-since-boot:/name} function shall + return the number of ${/glossary/clock-tick:/plural} since a + point in time during the system initialization or the last overflow + of the ${/glossary/clock-tick:/term} counter. +type: requirement diff --git a/spec/rtems/clock/req/get-tod.yml b/spec/rtems/clock/req/get-tod.yml new file mode 100644 index 00000000..db64fcb8 --- /dev/null +++ b/spec/rtems/clock/req/get-tod.yml @@ -0,0 +1,261 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +functional-type: action +links: +- role: interface-function + uid: ../if/get-tod +post-conditions: +- name: Status + states: + - name: Ok + test-code: | + T_rsc_success( ctx->set_tod_status ); + T_rsc_success( ctx->get_tod_status ); + text: | + The return status of ${../if/get-tod:/name} shall be + ${../../status/if/successful:/name} + - name: InvAddr + test-code: | + T_rsc( ctx->get_tod_status, RTEMS_INVALID_ADDRESS ); + text: | + The return status of ${../if/get-tod:/name} shall be + ${../../status/if/invalid-address:/name}. + - name: NotDef + test-code: | + T_rsc( ctx->get_tod_status, RTEMS_NOT_DEFINED ); + text: | + The return status of ${../if/get-tod:/name} shall be + ${../../status/if/not-defined:/name}. + test-epilogue: null + test-prologue: null +- name: Value + states: + - name: TimeOfDay + test-code: | + T_eq_ptr( ctx->get_tod_ref, &ctx->get_tod_value ); + T_eq_u32( ctx->get_tod_value.year, ctx->set_tod_value.year ); + T_eq_u32( ctx->get_tod_value.month, ctx->set_tod_value.month ); + T_eq_u32( ctx->get_tod_value.day, ctx->set_tod_value.day ); + T_eq_u32( ctx->get_tod_value.hour, ctx->set_tod_value.hour ); + T_eq_u32( ctx->get_tod_value.minute, ctx->set_tod_value.minute ); + T_eq_u32( ctx->get_tod_value.second, ctx->set_tod_value.second ); + T_ge_u32( ctx->get_tod_value.ticks, ctx->set_tod_value.ticks ); + T_lt_u32( ctx->get_tod_value.ticks, + ctx->set_tod_value.ticks + ctx->grace_ticks ); + text: | + The value of the object referenced by the + ${../if/get-tod:/params[0]/name} parameter shall be set to the value + of the ${/glossary/clock-realtime:/term} at a point in time + during the call to ${../if/get-tod:/name}. + - name: Unchanged + test-code: | + T_eq_u32( ctx->get_tod_value.year, 1 ); + T_eq_u32( ctx->get_tod_value.month, 1 ); + T_eq_u32( ctx->get_tod_value.day, 1 ); + T_eq_u32( ctx->get_tod_value.hour, 1 ); + T_eq_u32( ctx->get_tod_value.minute, 1 ); + T_eq_u32( ctx->get_tod_value.second, 1 ); + T_eq_u32( ctx->get_tod_value.ticks, 1 ); + text: | + Object referenced by the ${../if/get-tod:/params[0]/name} parameter + in past call to ${../if/get-tod:/name} shall not be modified + by the ${../if/get-tod:/name} call. + test-epilogue: null + test-prologue: null +pre-conditions: +- name: ToD + states: + - name: Arbitrary + test-code: | + ctx->set_tod_value = + (rtems_time_of_day) { 2023, 12, 27, 6, 7, 8, + rtems_clock_get_ticks_per_second() / 4 }; + text: | + While the ${/glossary/clock-realtime:/term} indicates an + arbitrary valid date and time between 1988-01-01T00:00:00.000000000Z and + 2514-05-30T01:53:03.999999999Z. + - name: Leap4 + test-code: | + ctx->set_tod_value = + (rtems_time_of_day) { 2096, 2, 29, 0, 0, 0, 0 }; + text: | + While the ${/glossary/clock-realtime:/term} indicates a + date for a leap year with the value of 29th of February. + - name: Leap100 + test-code: | + ctx->set_tod_value = + (rtems_time_of_day) { 2100, 2, 28, 23, 59, 59, + rtems_clock_get_ticks_per_second() - ctx->grace_ticks }; + text: | + While the ${/glossary/clock-realtime:/term} indicates a + date for a non-leap year with the value of 28th of February. + - name: Leap400 + test-code: | + ctx->set_tod_value = + (rtems_time_of_day) { 2000, 2, 29, 0, 0, 0, 0 }; + text: | + While the ${/glossary/clock-realtime:/term} indicates a + date for a leap year with the value of 29th of February. + - name: Youngest + test-code: | + ctx->set_tod_value = + (rtems_time_of_day) { 1988, 1, 1, 0, 0, 0, 0 }; + text: | + While the ${/glossary/clock-realtime:/term} indicates the + youngest date and time accepted (1988-01-01T00:00:00.000000000Z). + - name: Oldest + test-code: | + ctx->set_tod_value = + (rtems_time_of_day) { 2105, 12, 31, 23, 59, 59, + rtems_clock_get_ticks_per_second() - ctx->grace_ticks }; + text: | + While the ${/glossary/clock-realtime:/term} indicates the + oldest date and time accepted (2105-12-31T23:59:59.999999999Z). + - name: NotSet + test-code: | + ctx->isDef = false; + text: | + While the ${/glossary/clock-realtime:/term} has not been set before. + test-epilogue: null + test-prologue: null +- name: Param + states: + - name: Valid + test-code: | + ctx->get_tod_ref = &ctx->get_tod_value; + text: | + While the ${../if/get-tod:/params[0]/name} parameter references an + object of type ${../../type/if/time-of-day:/name}. + - name: 'Null' + test-code: | + ctx->get_tod_ref = NULL; + text: | + While the ${../if/get-tod:/params[0]/name} parameter is + ${/c/if/null:/name}. + test-epilogue: null + test-prologue: null +rationale: null +references: [] +requirement-type: functional +skip-reasons: {} +test-action: | + if ( ctx->isDef ) { + ctx->set_tod_status = rtems_clock_set( &ctx->set_tod_value ); + ctx->get_tod_status = rtems_clock_get_tod( ctx->get_tod_ref ); + } else { + ctx->get_tod_status = get_tod_before_set_tod( ctx->get_tod_ref ); + } +test-brief: null +test-cleanup: null +test-context: +- brief: null + description: null + member: rtems_status_code set_tod_status +- brief: null + description: null + member: rtems_time_of_day set_tod_value +- brief: null + description: null + member: rtems_time_of_day *get_tod_ref +- brief: null + description: null + member: rtems_time_of_day get_tod_value +- brief: null + description: null + member: rtems_status_code get_tod_status +- brief: Grace period in tick which may be passed between set and get ToD. + description: null + member: uint32_t grace_ticks +- brief: null + description: null + member: bool isDef +test-context-support: null +test-description: null +test-header: null +test-includes: +- rtems.h +test-local-includes: +- tc-clock-get-tod.h +test-prepare: | + ctx->get_tod_value = (rtems_time_of_day) { 1, 1, 1, 1, 1, 1, 1 }; + ctx->get_tod_ref = &ctx->get_tod_value; + ctx->set_tod_value = (rtems_time_of_day) { 2023, 4, 5, 6, 7, 8, 0 }; + ctx->isDef = true; +test-setup: + brief: null + code: | + /* Call rtems_clock_get_tod() once before rtems_clock_set() gets called */ + get_tod_before_set_tod( NULL ); + + ctx->grace_ticks = rtems_clock_get_ticks_per_second() * GRACE_PERIOD / 1000; + description: null +test-stop: null +test-support: | + rtems_status_code get_tod_before_set_tod( rtems_time_of_day *time_of_day ) + { + static rtems_time_of_day tod_buf = { 1, 1, 1, 1, 1, 1, 1 }; + static rtems_status_code status; + static bool has_been_called = false; + + if ( ! has_been_called ) { + status = rtems_clock_get_tod( &tod_buf ); + has_been_called = true; + } + + if ( NULL != time_of_day ) { + *time_of_day = tod_buf; + } + + return status; + } + + /* + * How much time may pass between a call to rtems_clock_set() and + * a follow up call to rtems_clock_get_tod() in milliseconds? + */ + #define GRACE_PERIOD 5 +test-target: testsuites/validation/tc-clock-get-tod.c +test-teardown: null +text: ${.:text-template} +transition-map: +- enabled-by: true + post-conditions: + Status: Ok + Value: TimeOfDay + pre-conditions: + ToD: + - Arbitrary + - Leap4 + - Leap100 + - Leap400 + - Youngest + - Oldest + Param: + - Valid +- enabled-by: true + post-conditions: + Status: InvAddr + Value: Unchanged + pre-conditions: + ToD: + - Arbitrary + - Leap4 + - Leap100 + - Leap400 + - Youngest + - Oldest + Param: + - 'Null' +- enabled-by: true + post-conditions: + Status: NotDef + Value: Unchanged + pre-conditions: + ToD: + - NotSet + Param: + - Valid + - 'Null' +type: requirement diff --git a/spec/rtems/clock/req/get-uptime.yml b/spec/rtems/clock/req/get-uptime.yml new file mode 100644 index 00000000..05ed4a7f --- /dev/null +++ b/spec/rtems/clock/req/get-uptime.yml @@ -0,0 +1,118 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +functional-type: action +links: +- role: interface-function + uid: ../if/get-uptime +post-conditions: +- name: Status + states: + - name: Ok + test-code: | + T_rsc_success( ctx->status ); + text: | + The return status of ${../if/get-uptime:/name} shall be + ${../../status/if/successful:/name} + - name: InvAddr + test-code: | + T_rsc( ctx->status, RTEMS_INVALID_ADDRESS ); + text: | + The return status of ${../if/get-uptime:/name} shall be + ${../../status/if/invalid-address:/name}. + test-epilogue: null + test-prologue: null +- name: Uptime + states: + - name: Set + test-code: | + T_eq_ptr( ctx->uptime, &ctx->uptime_value ); + T_gt_i64( ctx->uptime_value.tv_sec, 0LL ); + T_gt_long( ctx->uptime_value.tv_nsec, 0L ); + T_lt_long( ctx->uptime_value.tv_nsec, 1000000000L ); + text: | + The value of the object referenced by the + ${../if/get-uptime:/params[0]/name} parameter shall be set to + seconds and nanoseconds elapsed since a point in time during + the system initialization and a point in time during the + call of ${../if/get-uptime:/name} using ${/glossary/clock-monotonic:/term} + as result of the ${../if/get-uptime:/name} call. + - name: Unchanged + test-code: | + T_null( ctx->uptime ); + text: | + Objects referenced by the ${../if/get-uptime:/params[0]/name} parameter + in calls to ${../if/get-uptime:/name} shall not be modified by + the ${../if/get-uptime:/name} call. + test-epilogue: null + test-prologue: null +pre-conditions: +- name: Uptime + states: + - name: Valid + test-code: | + ctx->uptime = &ctx->uptime_value; + text: | + While the ${../if/get-uptime:/params[0]/name} parameter references an + object of type ${/c/if/timespec:/name}. + - name: 'Null' + test-code: | + ctx->uptime = NULL; + text: | + While the ${../if/get-uptime:/params[0]/name} parameter is + ${/c/if/null:/name}. + test-epilogue: null + test-prologue: null +rationale: null +references: [] +requirement-type: functional +skip-reasons: {} +test-action: | + ctx->status = rtems_clock_get_uptime( ctx->uptime ); +test-brief: null +test-cleanup: null +test-context: +- brief: null + description: null + member: rtems_status_code status +- brief: null + description: null + member: struct timespec *uptime +- brief: null + description: null + member: struct timespec uptime_value +test-context-support: null +test-description: null +test-header: null +test-includes: +- rtems.h +test-local-includes: [] +test-prepare: null +test-setup: + brief: null + code: | + ctx->uptime_value.tv_sec = -1; + ctx->uptime_value.tv_nsec = -1; + description: null +test-stop: null +test-support: null +test-target: testsuites/validation/tc-clock-get-uptime.c +test-teardown: null +text: ${.:text-template} +transition-map: +- enabled-by: true + post-conditions: + Status: InvAddr + Uptime: Unchanged + pre-conditions: + Uptime: + - 'Null' +- enabled-by: true + post-conditions: + Status: Ok + Uptime: Set + pre-conditions: + Uptime: + - Valid +type: requirement diff --git a/spec/rtems/clock/req/set.yml b/spec/rtems/clock/req/set.yml new file mode 100644 index 00000000..216b435e --- /dev/null +++ b/spec/rtems/clock/req/set.yml @@ -0,0 +1,450 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +functional-type: action +links: +- role: interface-function + uid: ../if/set +post-conditions: +- name: Status + states: + - name: Ok + test-code: | + T_rsc_success( ctx->status ); + text: | + The return status of ${../if/set:/name} shall be + ${../../status/if/successful:/name} + - name: InvAddr + test-code: | + T_rsc( ctx->status, RTEMS_INVALID_ADDRESS ); + text: | + The return status of ${../if/set:/name} shall be + ${../../status/if/invalid-address:/name}. + - name: InvClk + test-code: | + T_rsc( ctx->status, RTEMS_INVALID_CLOCK ); + text: | + The return status of ${../if/set:/name} shall be + ${../../status/if/invalid-clock:/name}. + test-epilogue: null + test-prologue: null +- name: Clock + states: + - name: Set + test-code: | + T_eq_ptr( ctx->target_tod, &ctx->target_tod_value ); + T_rsc_success( ctx->get_tod_after_status ); + T_eq_u32( ctx->tod_after.year, ctx->target_tod_value.year ); + T_eq_u32( ctx->tod_after.month, ctx->target_tod_value.month ); + T_eq_u32( ctx->tod_after.day, ctx->target_tod_value.day ); + T_eq_u32( ctx->tod_after.hour, ctx->target_tod_value.hour ); + T_eq_u32( ctx->tod_after.minute, ctx->target_tod_value.minute ); + T_eq_u32( ctx->tod_after.second, ctx->target_tod_value.second ); + T_ge_u32( ctx->tod_after.ticks, ctx->target_tod_value.ticks ); + T_lt_u32( ctx->tod_after.ticks, + ctx->target_tod_value.ticks + ctx->grace_ticks ); + text: | + The ${/glossary/clock-realtime:/term} shall be set + to the values of the object referenced by the + ${../if/set:/params[0]/name} parameter during + the ${../if/set:/name} call. + - name: Unchanged + test-code: | + T_rsc_success( ctx->get_tod_before_status ); + T_eq_u32( ctx->tod_after.year, ctx->tod_before.year ); + T_eq_u32( ctx->tod_after.month, ctx->tod_before.month ); + T_eq_u32( ctx->tod_after.day, ctx->tod_before.day ); + T_eq_u32( ctx->tod_after.hour, ctx->tod_before.hour ); + T_eq_u32( ctx->tod_after.minute, ctx->tod_before.minute ); + T_eq_u32( ctx->tod_after.second, ctx->tod_before.second ); + T_ge_u32( ctx->tod_after.ticks, ctx->tod_before.ticks ); + T_lt_u32( ctx->tod_after.ticks, + ctx->tod_before.ticks + 2 * ctx->grace_ticks ); + text: | + The state of the ${/glossary/clock-realtime:/term} shall not be changed + by the ${../if/set:/name} call. + test-epilogue: null + test-prologue: null +- name: Timer + states: + - name: Triggered + test-code: | + T_eq_int( ctx->timer_routine_counter, 1 ); + T_eq_u32( ctx->timer_routine_tod.year, 1989 ); + T_eq_u32( ctx->timer_routine_tod.month, 1 ); + T_eq_u32( ctx->timer_routine_tod.day, 1 ); + T_eq_u32( ctx->timer_routine_tod.minute, 0 ); + T_eq_u32( ctx->timer_routine_tod.second, 0 ); + T_ge_u32( ctx->timer_routine_tod.ticks, 0 ); + T_lt_u32( ctx->timer_routine_tod.ticks, 0 + ctx->grace_ticks ); + text: | + The timer routine shall be executed once after the + ${/glossary/clock-realtime:/term} has been set and before + the execution of the ${../if/set:/name} call terminates. + - name: Uncalled + test-code: | + T_eq_int( ctx->timer_routine_counter, 0 ); + text: | + The the timer routine shall not be invoked + during the ${../if/set:/name} call. + test-epilogue: null + test-prologue: null +pre-conditions: +- name: ToD + states: + - name: Valid + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 3, 11, 11, 10, 59, + rtems_clock_get_ticks_per_second() / 2 }; + text: | + While the ${../if/set:/params[0]/name} parameter references an + arbitrary valid date and time between 1988-01-01T00:00:00.000000000Z and + 2105-12-31T23:59:59.999999999Z. + - name: ValidLeap4 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2104, 2, 29, 0, 0, 0, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter references a + date for a leap year with the value of 29th of February. + - name: ValidLeap100 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2100, 2, 28, 23, 59, 59, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter references a + date for a non-leap century year with the value of 28th of February. + - name: ValidNoneLeap100 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2100, 3, 1, 0, 0, 0, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter references a + date for a non-leap century year with the value of 1st of March. + - name: ValidLeap400 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2000, 2, 29, 0, 0, 0, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter references a + date for a leap year with the value of 29th of February. + - name: Youngest + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 1988, 1, 1, 0, 0, 0, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter references the + youngest date and time accepted (1988-01-01T00:00:00.000000000Z). + - name: Oldest + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2105, 12, 31, 23, 59, 59, + rtems_clock_get_ticks_per_second() - ctx->grace_ticks }; + text: | + While the ${../if/set:/params[0]/name} parameter references the + oldest date and time accepted (2105-12-31T23:59:59.999999999Z). + - name: TooJung + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 1987, 12, 31, 23, 59, 59, + rtems_clock_get_ticks_per_second() - 1 }; + text: | + While the ${../if/set:/params[0]/name} parameter references a valid + date and time younger than 1988-01-01T00:00:00.000000000Z. + - name: TooOld + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2106, 1, 1, 0, 0, 0, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter references a valid + date and time older than 2105-12-31T23:59:59.999999999Z. + - name: InvMonth0 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 0, 11, 11, 10, 59, 1 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value of the month is 0. + - name: InvMonth + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 13, 11, 11, 10, 59, 1 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value of the month is larger than 12. + - name: InvDay0 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 3, 0, 11, 10, 59, 1 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value of the day is 0. + - name: InvDay + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 2, 29, 11, 10, 59, 1 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value of the day is larger than the days of the month. + - name: InvHour + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 3, 11, 24, 10, 59, 1 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value of the hour is larger than 23. + - name: InvMinute + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 3, 11, 11, 60, 59, 1 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value of the minute is larger than 59. + - name: InvSecond + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 3, 11, 11, 10, 60, 1 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value of the second is larger than 59. + - name: InvTicks + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2021, 3, 11, 11, 10, 60, + rtems_clock_get_ticks_per_second() }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value of the ticks are larger or equal + to the ticks per second. + - name: InvLeap4 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2104, 2, 30, 0, 0, 0, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value 30th of February does not exist in a leap year. + - name: InvLeap100 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2100, 2, 29, 0, 0, 0, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value 29th of February does not exist in a non-leap year. + - name: InvLeap400 + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 2000, 2, 30, 0, 0, 0, 0 }; + text: | + While the ${../if/set:/params[0]/name} parameter is invalid + because the value 30th of February does not exist in a leap year. + - name: AtTimer + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 1989, 1, 1, 0, 0, 0, 0 }; + _TOD_prepare_timer( ctx ); + text: | + While the ${../if/set:/params[0]/name} parameter references the + same point in time when a timer should fire. + - name: BeforeTimer + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 1988, 12, 31, 23, 59, 59, 0 }; + _TOD_prepare_timer( ctx ); + text: | + While the ${../if/set:/params[0]/name} parameter references a + point in time before a timer should fire. + - name: AfterTimer + test-code: | + ctx->target_tod_value = + (rtems_time_of_day) { 1989, 1, 1, 1, 0, 0, 0 }; + _TOD_prepare_timer( ctx ); + text: | + While the ${../if/set:/params[0]/name} parameter references a + point in time after a timer should fire. + - name: 'Null' + test-code: | + ctx->target_tod = NULL; + text: | + WHile the ${../if/set:/params[0]/name} parameter is + ${/c/if/null:/name}. + test-epilogue: null + test-prologue: null +rationale: null +references: [] +requirement-type: functional +skip-reasons: {} +test-action: | + ctx->get_tod_before_status = rtems_clock_get_tod( &ctx->tod_before ); + ctx->status = rtems_clock_set( ctx->target_tod ); + ctx->get_tod_after_status = rtems_clock_get_tod( &ctx->tod_after ); +test-brief: null +test-cleanup: null +test-context: +- brief: null + description: null + member: rtems_status_code status +- brief: null + description: null + member: rtems_time_of_day *target_tod +- brief: null + description: null + member: rtems_time_of_day target_tod_value +- brief: null + description: null + member: rtems_time_of_day tod_before +- brief: null + description: null + member: rtems_status_code get_tod_before_status +- brief: null + description: null + member: rtems_time_of_day tod_after +- brief: null + description: null + member: rtems_status_code get_tod_after_status +- brief: null + description: null + member: rtems_id timer_id +- brief: null + description: null + member: int timer_routine_counter +- brief: null + description: null + member: rtems_time_of_day timer_routine_tod +- brief: Grace period in tick which may be passed between set and get ToD. + description: null + member: uint32_t grace_ticks +test-context-support: null +test-description: null +test-header: null +test-includes: +- rtems.h +test-local-includes: +- tc-clock-get-tod.h +test-prepare: | + rtems_status_code status; + + status = rtems_timer_cancel( ctx->timer_id ); + T_rsc_success( status ); + ctx->timer_routine_counter = 0; + ctx->timer_routine_tod = (rtems_time_of_day) { 0, 0, 0, 0, 0, 0, 0 }; +test-setup: + brief: null + code: | + rtems_status_code status; + rtems_name timer_name = rtems_build_name( 'T', 'M', 'R', '0' ); + ctx->timer_id = RTEMS_ID_NONE; + + /* Call rtems_clock_get_tod() once before rtems_clock_set() gets called */ + get_tod_before_set_tod( NULL ); + + ctx->grace_ticks = rtems_clock_get_ticks_per_second() * GRACE_PERIOD / 1000; + ctx->target_tod = &ctx->target_tod_value; + + status = rtems_timer_create( timer_name, &ctx->timer_id ); + T_rsc_success( status ); + description: null +test-stop: null +test-support: | + /* + * How much time may pass between a call to rtems_clock_set() and + * a follow up call to rtems_clock_get_tod() in millisecond? + */ + #define GRACE_PERIOD 5 + + static rtems_timer_service_routine _TOD_timer_routine( + rtems_id timer_id, + void *user_data + ) + { + RtemsClockReqSet_Context *ctx = user_data; + rtems_status_code status; + ++ctx->timer_routine_counter; + status = rtems_clock_get_tod( &ctx->timer_routine_tod ); + T_rsc_success( status ); + } + + static void _TOD_prepare_timer( RtemsClockReqSet_Context *ctx ) + { + rtems_status_code status; + rtems_time_of_day tod = { 1988, 1, 1, 0, 0, 0, 0 }; + + status = rtems_clock_set( &tod ); + T_rsc_success( status ); + + tod.year = 1989; + status = rtems_timer_fire_when( + ctx->timer_id, + &tod, + _TOD_timer_routine, + ctx + ); + T_rsc_success( status ); + } +test-target: testsuites/validation/tc-clock-set.c +test-teardown: + brief: null + code: | + rtems_status_code status; + + if ( RTEMS_ID_NONE != ctx->timer_id ) { + status = rtems_timer_delete( ctx->timer_id ); + T_rsc_success( status ); + } + description: null +text: ${.:text-template} +transition-map: +- enabled-by: true + post-conditions: + Status: Ok + Clock: Set + Timer: Uncalled + pre-conditions: + ToD: + - Valid + - Youngest + - Oldest + - ValidLeap4 + - ValidLeap100 + - ValidNoneLeap100 + - ValidLeap400 + - BeforeTimer +- enabled-by: true + post-conditions: + Status: Ok + Clock: Set + Timer: Triggered + pre-conditions: + ToD: + - AtTimer + - AfterTimer +- enabled-by: true + post-conditions: + Status: InvAddr + Clock: Unchanged + Timer: Uncalled + pre-conditions: + ToD: + - 'Null' +- enabled-by: true + post-conditions: + Status: InvClk + Clock: Unchanged + Timer: Uncalled + pre-conditions: + ToD: + - TooJung + - TooOld + - InvMonth0 + - InvMonth + - InvDay0 + - InvDay + - InvHour + - InvMinute + - InvSecond + - InvTicks + - InvLeap4 + - InvLeap100 + - InvLeap400 +type: requirement diff --git a/spec/rtems/clock/val/clock.yml b/spec/rtems/clock/val/clock.yml new file mode 100644 index 00000000..b2689b4d --- /dev/null +++ b/spec/rtems/clock/val/clock.yml @@ -0,0 +1,67 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +links: [] +test-actions: +- action-brief: | + Use the ${../if/get-ticks-since-boot:/name} function. + action-code: | + rtems_interval result_0; + rtems_interval result_1; + int32_t difference; /* Note: rtems_interval = uint32_t (unsigned!) */ + + result_0 = rtems_clock_get_ticks_since_boot(); + do { + result_1 = rtems_clock_get_ticks_since_boot(); + } while( result_0 == result_1 ); + /* + * Because of the ones-complement, the overflow + * is handled correctly. result_0 = 0xFFFFFFFF will become -1 + * and result_1 = 0x0 will become 0. + */ + difference = (int32_t) result_1 - (int32_t) result_0; + checks: + - brief: | + Check that ${/glossary/clock-tick:/term} gets incremented. + code: | + T_step_eq_i32( ${step}, difference, 1 ); + links: + - role: validation + uid: ../req/get-ticks-since-boot + links: [] +- action-brief: | + Use the ${../if/get-ticks-per-second:/name} function. + action-code: | + rtems_interval result; + result = rtems_clock_get_ticks_per_second(); + checks: + - brief: | + Check that ${../if/get-ticks-per-second:/name} actually returns + 1us / CONFIGURE_MICROSECONDS_PER_TICK. + code: | + T_step_eq_u32( ${step}, result, 1000000UL / TEST_MICROSECONDS_PER_TICK ); + links: + - role: validation + uid: ../req/get-ticks-per-second + links: [] +test-brief: | + Tests the Clock Manager from ${/glossary/rtems:/term} the Classic + ${/glossary/api:/term}. +test-context: [] +test-context-support: null +test-description: | + These tests cover only the elements of + the Clock Manager ${/glossary/api:/term} which are listed in the + Space Profile. +test-header: null +test-includes: +- rtems.h +test-local-includes: +- ts-config.h +test-setup: null +test-stop: null +test-support: null +test-target: testsuites/validation/tc-clock.c +test-teardown: null +type: test-case -- cgit v1.2.3