Deep Sleep Manager L2 Low-Level Test Specification and Procedure Documentation

Overview

This document describes the L2 Low-Level Test Specification and Procedure Documentation for the Deep Sleep Manager module.

Acronyms, Terms and Abbreviations

HAL - Hardware Abstraction Layer, may include some common components
UT - Unit Test(s)
OEM - Original Equipment Manufacture
SoC - System on a Chip

Definitions

ut-core - Common Testing Framework https://github.com/rdkcentral/ut-core, which wraps an open-source framework that can be expanded to the requirements for future frameworks.

References

High Level Test Specification - DeepSleep Manager High Level TestSpec
HAL Interface file - DeepSleep Manager HAL header

Level 2 Test Procedure

The following functions are expected to test whether the module operates correctly.

Test 1

Title	Details
Function Name	`test_l2_deepSleepMgr_SetDeepSleepAndVerifyWakeup1`
Description	Set the deep sleep with a duration of one second and verify the wake-up source
Test Group	02
Test Case ID	001
Priority	High

Pre-Conditions None

Dependencies None

User Interaction If the user chooses to run the test in interactive mode, then the test case has to be selected via the console.

Test Procedure - Test 1

Variation / Steps	Description	Test Data	Expected Result	Notes
01	Initialize the deep sleep manager using PLAT_DS_INIT	None	DEEPSLEEPMGR_SUCCESS	Should be successful
02	Set the deep sleep with a duration of one second using PLAT_DS_SetDeepSleep	deep_sleep_timeout=1, isGPIOWakeup=valid pointer, networkStandby=false	DEEPSLEEPMGR_SUCCESS	Should be successful
03	PLAT_DS_DeepSleepWakeup shall be called after wakeup to do any postprocessing	None	DEEPSLEEPMGR_SUCCESS	Should be successful
04	Verify the wakeup source using PLAT_DS_GetLastWakeupReason	wakeupReason = Valid pointer	isGPIOWakeup=false, wakeup reason = DEEPSLEEP_WAKEUPREASON_TIMER	Should be successful
05	Terminate the deep sleep manager using PLAT_DS_TERM	None	DEEPSLEEPMGR_SUCCESS	Should be successful

graph TB
A[Call PLAT_DS_INIT] -->|DEEPSLEEPMGR_SUCCESS| B[Call PLAT_DS_SetDeepSleep]
A -->|Failure| A1[Test case fail]
B -->|DEEPSLEEPMGR_SUCCESS| C[Wait for 1 second]
B -->|Failure| B1[Test case fail]
C --> D[Call PLAT_DS_DeepSleepWakeup]
D --> |DEEPSLEEPMGR_SUCCESS| E[verify the wakeup source using PLAT_DS_GetLastWakeupReason]
D --> |Failure| D1[Test case fail]
E -->|DEEPSLEEPMGR_SUCCESS| F[Call PLAT_DS_TERM]
E -->|Failure| E1[Test case fail]
F -->|DEEPSLEEPMGR_SUCCESS| G[Test case success]
F -->|Failure| F1[Test case fail]

Test 2

Title	Details
Function Name	`test_l2_deepSleepMgr_SetDeepSleepAndVerifyWakeUp10`
Description	Set the deep sleep with a duration of ten seconds and verify the wake-up source
Test Group	02
Test Case ID	002
Priority	High

Pre-Conditions None

Dependencies None

User Interaction If the user chooses to run the test in interactive mode, then the test case has to be selected via the console.

Test Procedure - Test2

Variation / Steps	Description	Test Data	Expected Result	Notes
01	Initialize the deep sleep manager using PLAT_DS_INIT	None	DEEPSLEEPMGR_SUCCESS	Should be successful
02	Set the deep sleep with a duration of one second using PLAT_DS_SetDeepSleep	deep_sleep_timeout=10sec, isGPIOWakeup=valid pointer, networkStandby=false	DEEPSLEEPMGR_SUCCESS	Should be successful
03	PLAT_DS_DeepSleepWakeup shall be called after wakeup to do any postprocessing	None	DEEPSLEEPMGR_SUCCESS	Should be successful
04	Verify the wakeup source using PLAT_DS_GetLastWakeupReason	wakeupReason = Valid pointer	isGPIOWakeup=false, wakeup reason = DEEPSLEEP_WAKEUPREASON_TIMER	Should be successful
05	Terminate the deep sleep manager using PLAT_DS_TERM	None	DEEPSLEEPMGR_SUCCESS	Should be successful

graph TB
A[Call PLAT_DS_INIT] -->|DEEPSLEEPMGR_SUCCESS| B[Call PLAT_DS_SetDeepSleep]
A -->|Failure| A1[Test case fail]
B -->|DEEPSLEEPMGR_SUCCESS| C[Wait for 10 seconds]
B -->|Failure| B1[Test case fail]
C --> D[Call PLAT_DS_DeepSleepWakeup]
D --> |DEEPSLEEPMGR_SUCCESS| E[verify the wakeup source using PLAT_DS_GetLastWakeupReason]
D --> |Failure| D1[Test case fail]
E -->|DEEPSLEEPMGR_SUCCESS| F[Call PLAT_DS_TERM]
E -->|Failure| E1[Test case fail]
F -->|DEEPSLEEPMGR_SUCCESS| G[Test case success]
F -->|Failure| F1[Test case fail]