Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 | /* * Copyright (c) 2016 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ #include <ztest.h> #include <zephyr/types.h> struct timer_data { int expire_cnt; int stop_cnt; s64_t timestamp; }; #define DURATION 100 #define PERIOD 50 #define EXPIRE_TIMES 4 #define WITHIN_ERROR(var, target, epsilon) \ (((var) >= (target)) && ((var) <= (target) + (epsilon))) static void duration_expire(struct k_timer *timer); static void duration_stop(struct k_timer *timer); /** TESTPOINT: init timer via K_TIMER_DEFINE */ K_TIMER_DEFINE(ktimer, duration_expire, duration_stop); static struct k_timer duration_timer; static struct k_timer period0_timer; static struct k_timer expire_timer; static struct k_timer sync_timer; static struct k_timer periodicity_timer; static struct k_timer status_timer; static struct k_timer status_anytime_timer; static struct k_timer status_sync_timer; static struct k_timer remain_timer; static ZTEST_BMEM struct timer_data tdata; extern void test_time_conversions(void); #define TIMER_ASSERT(exp, tmr) \ do { \ if (!(exp)) { \ k_timer_stop(tmr); \ zassert_true(exp, NULL); \ } \ } while (0) static void init_timer_data(void) { tdata.expire_cnt = 0; tdata.stop_cnt = 0; } /* entry routines */ static void duration_expire(struct k_timer *timer) { /** TESTPOINT: expire function */ s64_t interval = k_uptime_delta(&tdata.timestamp); tdata.expire_cnt++; if (tdata.expire_cnt == 1) { TIMER_ASSERT(interval >= DURATION, timer); } else { TIMER_ASSERT(interval >= PERIOD, timer); } if (tdata.expire_cnt >= EXPIRE_TIMES) { k_timer_stop(timer); } } static void duration_stop(struct k_timer *timer) { tdata.stop_cnt++; } static void period0_expire(struct k_timer *timer) { tdata.expire_cnt++; } static void status_expire(struct k_timer *timer) { /** TESTPOINT: status get upon timer expired */ TIMER_ASSERT(k_timer_status_get(timer) == 1, timer); /** TESTPOINT: remaining get upon timer expired */ TIMER_ASSERT(k_timer_remaining_get(timer) >= PERIOD, timer); if (tdata.expire_cnt >= EXPIRE_TIMES) { k_timer_stop(timer); } } static void busy_wait_ms(s32_t ms) { k_busy_wait(ms*1000); } static void status_stop(struct k_timer *timer) { /** TESTPOINT: remaining get upon timer stopped */ TIMER_ASSERT(k_timer_remaining_get(timer) == 0, timer); } /** * @brief Tests for the Timer kernel object * @defgroup kernel_timer_tests Timer * @ingroup all_tests * @{ * @} */ /** * @brief Test duration and period of Timer * * Validates initial duration and period of timer. * * It initializes the timer with k_timer_init(), then starts the timer * using k_timer_start() with specific initial duration and period. * Stops the timer using k_timer_stop() and checks for proper completion * of duration and period. * * @ingroup kernel_timer_tests * * @see k_timer_init(), k_timer_start(), k_timer_stop(), k_uptime_get(), * k_busy_wait() */ void test_timer_duration_period(void) { init_timer_data(); /** TESTPOINT: init timer via k_timer_init */ k_timer_start(&duration_timer, DURATION, PERIOD); tdata.timestamp = k_uptime_get(); busy_wait_ms(DURATION + PERIOD * EXPIRE_TIMES + PERIOD / 2); /** TESTPOINT: check expire and stop times */ TIMER_ASSERT(tdata.expire_cnt == EXPIRE_TIMES, &duration_timer); TIMER_ASSERT(tdata.stop_cnt == 1, &duration_timer); /* cleanup environemtn */ k_timer_stop(&duration_timer); } /** * @brief Test Timer with zero period value * * Validates initial timer duration, keeping timer period to zero. * Basically, acting as one-short timer. * It initializes the timer with k_timer_init(), then starts the timer * using k_timer_start() with specific initial duration and period as * zero. Stops the timer using k_timer_stop() and checks for proper * completion. * * @ingroup kernel_timer_tests * * @see k_timer_init(), k_timer_start(), k_timer_stop(), k_uptime_get(), * k_busy_wait() */ void test_timer_period_0(void) { init_timer_data(); /** TESTPOINT: set period 0 */ k_timer_start(&period0_timer, DURATION, K_NO_WAIT); tdata.timestamp = k_uptime_get(); busy_wait_ms(DURATION + 1); /** TESTPOINT: ensure it is one-short timer */ TIMER_ASSERT(tdata.expire_cnt == 1, &period0_timer); TIMER_ASSERT(tdata.stop_cnt == 0, &period0_timer); /* cleanup environemtn */ k_timer_stop(&period0_timer); } /** * @brief Test Timer without any timer expiry callback function * * Validates timer without any expiry_fn(set to NULL). expiry_fn() is a * function that is invoked each time the timer expires. * * It initializes the timer with k_timer_init(), then starts the timer * using k_timer_start(). Stops the timer using k_timer_stop() and * checks for expire_cnt to zero, as expiry_fn was not defined at all. * * @ingroup kernel_timer_tests * * @see k_timer_init(), k_timer_start(), k_timer_stop(), k_uptime_get(), * k_busy_wait() */ void test_timer_expirefn_null(void) { init_timer_data(); /** TESTPOINT: expire function NULL */ k_timer_start(&expire_timer, DURATION, PERIOD); busy_wait_ms(DURATION + PERIOD * EXPIRE_TIMES + PERIOD / 2); k_timer_stop(&expire_timer); /** TESTPOINT: expire handler is not invoked */ TIMER_ASSERT(tdata.expire_cnt == 0, &expire_timer); /** TESTPOINT: stop handler is invoked */ TIMER_ASSERT(tdata.stop_cnt == 1, &expire_timer); /* cleanup environment */ k_timer_stop(&expire_timer); } /* Wait for the next expiration of an OS timer tick, to synchronize * test start */ static void tick_sync(void) { k_timer_start(&sync_timer, K_NO_WAIT, K_MSEC(1)); k_timer_status_sync(&sync_timer); k_timer_stop(&sync_timer); } /** * @brief Test to check timer periodicity * * Timer test to check for the predictability with which the timer * expires depending on the period configured. * * It initializes the timer with k_timer_init(), then starts the timer * using k_timer_start() with specific period. It resets the timer’s * status to zero with k_timer_status_sync and identifies the delta * between each timer expiry to check for the timer expiration period * correctness. Finally, stops the timer using k_timer_stop(). * * @ingroup kernel_timer_tests * * @see k_timer_init(), k_timer_start(), k_timer_status_sync(), * k_timer_stop(), k_uptime_get(), k_uptime_delta() */ void test_timer_periodicity(void) { s64_t delta; /* Start at a tick boundary, otherwise a tick expiring between * the unlocked (and unlockable) start/uptime/sync steps below * will throw off the math. */ tick_sync(); init_timer_data(); /** TESTPOINT: set duration 0 */ k_timer_start(&periodicity_timer, K_NO_WAIT, PERIOD); /* clear the expiration that would have happened due to * whatever duration that was set. Since timer is likely * to fire before call to k_timer_status_sync(), we have * to synchronize twice to ensure that the timestamp will * be fetched as soon as possible after timer firing. */ k_timer_status_sync(&periodicity_timer); k_timer_status_sync(&periodicity_timer); tdata.timestamp = k_uptime_get(); for (int i = 0; i < EXPIRE_TIMES; i++) { /** TESTPOINT: expired times returned by status sync */ TIMER_ASSERT(k_timer_status_sync(&periodicity_timer) == 1, &periodicity_timer); delta = k_uptime_delta(&tdata.timestamp); /** TESTPOINT: check if timer fired within 1ms of the * expected period (firing time). * * Please note, that expected firing time is not the * one requested, as the kernel uses the ticks to manage * time. The actual perioid will be equal to [tick time] * multiplied by k_ms_to_ticks_ceil32(PERIOD). */ TIMER_ASSERT(WITHIN_ERROR(delta, k_ticks_to_ms_floor64(k_ms_to_ticks_ceil32(PERIOD)), 1), &periodicity_timer); } /* cleanup environment */ k_timer_stop(&periodicity_timer); } /** * @brief Test Timer status and time remaining before next expiry * * Timer test to validate timer status and next trigger expiry time * * It initializes the timer with k_timer_init(), then starts the timer * using k_timer_start() and checks for timer current status with * k_timer_status_get() and remaining time before next expiry using * k_timer_remaining_get(). Stops the timer using k_timer_stop(). * * @ingroup kernel_timer_tests * * @see k_timer_init(), k_timer_start(), k_timer_status_get(), * k_timer_remaining_get(), k_timer_stop() */ void test_timer_status_get(void) { init_timer_data(); k_timer_start(&status_timer, DURATION, PERIOD); /** TESTPOINT: status get upon timer starts */ TIMER_ASSERT(k_timer_status_get(&status_timer) == 0, &status_timer); /** TESTPOINT: remaining get upon timer starts */ TIMER_ASSERT(k_timer_remaining_get(&status_timer) >= DURATION / 2, &status_timer); /* cleanup environment */ k_timer_stop(&status_timer); } /** * @brief Test Timer status randomly after certain duration * * Validate timer status function using k_timer_status_get(). * * It initializes the timer with k_timer_init(), then starts the timer * using k_timer_start() with specific initial duration and period. * Checks for timer status randomly after certain duration. * Stops the timer using k_timer_stop(). * * @ingroup kernel_timer_tests * * @see k_timer_init(), k_timer_start(), k_timer_status_get(), * k_timer_stop(), k_busy_wait() */ void test_timer_status_get_anytime(void) { init_timer_data(); k_timer_start(&status_anytime_timer, DURATION, PERIOD); busy_wait_ms(DURATION + PERIOD * (EXPIRE_TIMES - 1) + PERIOD / 2); /** TESTPOINT: status get at any time */ TIMER_ASSERT(k_timer_status_get(&status_anytime_timer) == EXPIRE_TIMES, &status_anytime_timer); /* cleanup environment */ k_timer_stop(&status_anytime_timer); } /** * @brief Test Timer thread synchronization * * Validate thread synchronization by blocking the calling thread until * the timer expires. * * It initializes the timer with k_timer_init(), then starts the timer * using k_timer_start() and checks timer status with * k_timer_status_sync() for thread synchronization with expiry count. * Stops the timer using k_timer_stop. * * @ingroup kernel_timer_tests * * @see k_timer_init(), k_timer_start(), k_timer_status_sync(), * k_timer_stop() */ void test_timer_status_sync(void) { init_timer_data(); k_timer_start(&status_sync_timer, DURATION, PERIOD); for (int i = 0; i < EXPIRE_TIMES; i++) { /** TESTPOINT: check timer not expire */ TIMER_ASSERT(tdata.expire_cnt == i, &status_sync_timer); /** TESTPOINT: expired times returned by status sync */ TIMER_ASSERT(k_timer_status_sync(&status_sync_timer) == 1, &status_sync_timer); /** TESTPOINT: check timer not expire */ TIMER_ASSERT(tdata.expire_cnt == (i + 1), &status_sync_timer); } /* cleanup environment */ k_timer_stop(&status_sync_timer); } /** * @brief Test statically defined Timer init * * Validate statically defined timer init using K_TIMER_DEFINE * * It creates prototype of K_TIMER_DEFINE to statically define timer * init and starts the timer with k_timer_start() with specific initial * duration and period. Stops the timer using k_timer_stop() and checks * for proper completion of duration and period. * * @ingroup kernel_timer_tests * * @see k_timer_start(), K_TIMER_DEFINE(), k_timer_stop() * k_uptime_get(), k_busy_wait() */ void test_timer_k_define(void) { init_timer_data(); /** TESTPOINT: init timer via k_timer_init */ k_timer_start(&ktimer, DURATION, PERIOD); tdata.timestamp = k_uptime_get(); busy_wait_ms(DURATION + PERIOD * EXPIRE_TIMES + PERIOD / 2); /** TESTPOINT: check expire and stop times */ TIMER_ASSERT(tdata.expire_cnt == EXPIRE_TIMES, &ktimer); TIMER_ASSERT(tdata.stop_cnt == 1, &ktimer); /* cleanup environment */ k_timer_stop(&ktimer); init_timer_data(); /** TESTPOINT: init timer via k_timer_init */ k_timer_start(&ktimer, DURATION, PERIOD); /* Call the k_timer_start() again to make sure that * the initial timeout request gets cancelled and new * one will get added. */ busy_wait_ms(DURATION / 2); k_timer_start(&ktimer, DURATION, PERIOD); tdata.timestamp = k_uptime_get(); busy_wait_ms(DURATION + PERIOD * EXPIRE_TIMES + PERIOD / 2); /** TESTPOINT: check expire and stop times */ TIMER_ASSERT(tdata.expire_cnt == EXPIRE_TIMES, &ktimer); TIMER_ASSERT(tdata.stop_cnt == 1, &ktimer); /* cleanup environment */ k_timer_stop(&ktimer); } static void user_data_timer_handler(struct k_timer *timer); K_TIMER_DEFINE(timer0, user_data_timer_handler, NULL); K_TIMER_DEFINE(timer1, user_data_timer_handler, NULL); K_TIMER_DEFINE(timer2, user_data_timer_handler, NULL); K_TIMER_DEFINE(timer3, user_data_timer_handler, NULL); K_TIMER_DEFINE(timer4, user_data_timer_handler, NULL); static ZTEST_DMEM struct k_timer *user_data_timer[5] = { &timer0, &timer1, &timer2, &timer3, &timer4 }; static const intptr_t user_data[5] = { 0x1337, 0xbabe, 0xd00d, 0xdeaf, 0xfade }; static ZTEST_BMEM int user_data_correct[5]; static void user_data_timer_handler(struct k_timer *timer) { int timer_num = timer == user_data_timer[0] ? 0 : timer == user_data_timer[1] ? 1 : timer == user_data_timer[2] ? 2 : timer == user_data_timer[3] ? 3 : timer == user_data_timer[4] ? 4 : -1; if (timer_num == -1) { return; } intptr_t data_retrieved = (intptr_t)k_timer_user_data_get(timer); user_data_correct[timer_num] = user_data[timer_num] == data_retrieved; } /** * @brief Test user-specific data associated with timer * * Validate user-specific data associated with timer * * It creates prototype of K_TIMER_DEFINE and starts the timer using * k_timer_start() with specific initial duration, alongwith associated * user data using k_timer_user_data_set and k_timer_user_data_get(). * Stops the timer using k_timer_stop() and checks for correct data * retrieval after timer completion. * * @ingroup kernel_timer_tests * * @see K_TIMER_DEFINE(), k_timer_user_data_set(), k_timer_start(), * k_timer_user_data_get(), k_timer_stop() */ void test_timer_user_data(void) { int ii; for (ii = 0; ii < 5; ii++) { intptr_t check; k_timer_user_data_set(user_data_timer[ii], (void *)user_data[ii]); check = (intptr_t)k_timer_user_data_get(user_data_timer[ii]); zassert_true(check == user_data[ii], NULL); } for (ii = 0; ii < 5; ii++) { k_timer_start(user_data_timer[ii], 50 + ii * 50, K_NO_WAIT); } k_sleep(50 * ii + 50); for (ii = 0; ii < 5; ii++) { k_timer_stop(user_data_timer[ii]); } for (ii = 0; ii < 5; ii++) { zassert_true(user_data_correct[ii], NULL); } } /** * @brief Test accuracy of k_timer_remaining_get() * * Validate countdown of time to expiration * * Starts a timer, busy-waits for half the DURATION, then checks the * remaining time to expiration and stops the timer. The remaining time * should reflect the passage of at least the busy-wait interval. * * @ingroup kernel_timer_tests * * @see k_timer_init(), k_timer_start(), k_timer_stop(), * k_timer_remaining_get() */ void test_timer_remaining_get(void) { u32_t remaining; init_timer_data(); k_timer_start(&remain_timer, DURATION, K_NO_WAIT); busy_wait_ms(DURATION / 2); remaining = k_timer_remaining_get(&remain_timer); k_timer_stop(&remain_timer); /* * While the busy_wait_ms() works with the maximum possible resolution, * the k_timer api is limited by the system tick abstraction. As result * the value obtained through k_timer_remaining_get() could be larger * than actual remaining time with maximum error equal to one tick. */ zassert_true(remaining <= (DURATION / 2) + k_ticks_to_ms_floor64(1), NULL); } static void timer_init(struct k_timer *timer, k_timer_expiry_t expiry_fn, k_timer_stop_t stop_fn) { k_object_access_grant(timer, k_current_get()); k_timer_init(timer, expiry_fn, stop_fn); } void test_main(void) { timer_init(&duration_timer, duration_expire, duration_stop); timer_init(&period0_timer, period0_expire, NULL); timer_init(&expire_timer, NULL, duration_stop); timer_init(&sync_timer, NULL, NULL); timer_init(&periodicity_timer, NULL, NULL); timer_init(&status_timer, status_expire, status_stop); timer_init(&status_anytime_timer, NULL, NULL); timer_init(&status_sync_timer, duration_expire, duration_stop); timer_init(&remain_timer, NULL, NULL); k_thread_access_grant(k_current_get(), &ktimer, &timer0, &timer1, &timer2, &timer3, &timer4); ztest_test_suite(timer_api, ztest_unit_test(test_time_conversions), ztest_user_unit_test(test_timer_duration_period), ztest_user_unit_test(test_timer_period_0), ztest_user_unit_test(test_timer_expirefn_null), ztest_user_unit_test(test_timer_periodicity), ztest_user_unit_test(test_timer_status_get), ztest_user_unit_test(test_timer_status_get_anytime), ztest_user_unit_test(test_timer_status_sync), ztest_user_unit_test(test_timer_k_define), ztest_user_unit_test(test_timer_user_data), ztest_user_unit_test(test_timer_remaining_get)); ztest_run_test_suite(timer_api); } |