HDMI CEC Sink L2 Low-Level Test Specification and Procedure Documentation

Overview

This document describes the level 2 Low-Level Test Specification and Procedure Documentation for the HDMI CEC Sink module.

Acronyms, Terms and Abbreviations

HAL - Hardware Abstraction Layer, may include some common components
UT - Unit Test(s)
HDMI - High-Definition Multimedia Interface
CEC - Consumer Electronics Control
DUT - Device Under Test
API - Application Program Interface

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 - hdmi-cec-sink_High-Level_TestSpec.md
HDMI CEC HAL Interface file - hdmi_cec_driver.h

Level 2 Test Procedure

The following functions are intended to test the HDMI CEC HAL module's operation on sink devices according to the L2 Test specification.

Test 1

Title	Details
Function Name	`test_l2_hdmi_cec_sink_hal_GetDefaultLogicalAddress`
Description	Get the logical address of the `DUT` without actually adding the Logical Address and the API should return 0x0F as the default logical address.
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	Call the pre-requisite API HdmiCecOpen()	handle = 0	HDMI_CEC_IO_SUCCESS	Should be successful
02	Call the API HdmiCecGetLogicalAddress()	handle = valid handle, logicalAddress = 0	HDMI_CEC_IO_SUCCESS	Should be successful
03	Check the logical address		logicalAddress = 0x0F	Should be successful
04	Call the post-requisite API HdmiCecClose()	handle = valid handle	HDMI_CEC_IO_SUCCESS	Should be successful

graph TB
A[Call HdmiCecOpen] -->|HDMI_CEC_IO_SUCCESS| B[Call HdmiCecGetLogicalAddress]
A -->|Failure| A1[Test case fail]
B -->|HDMI_CEC_IO_SUCCESS| C[Check logical address]
B -->|Failure| B1[Test case fail]
C -->|Logical address is 0x0F| D[Call HdmiCecClose]
C -->|Logical address is not 0x0F| C1[Test case fail]
D -->|HDMI_CEC_IO_SUCCESS| E[Test case pass]
D -->|Failure| D1[Test case fail]

Test 2

Title	Details
Function Name	`test_l2_hdmi_cec_sink_hal_AddAndGetLogicalAddress`
Description	Setup all valid logical addresses b/w 0x00 to 0x0F for the `DUT` and retrieve each to ensure proper functionality, using HAL APIs.
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 Test 2

Variation / Steps	Description	Test Data	Expected Result	Notes
01	Open HDMI CEC HAL using HdmiCecOpen API	handle = valid pointer	HDMI_CEC_IO_SUCCESS	Should be successful
02	Loop over the range of valid logical addresses (0x00 to 0x0F)	i = 0 to 0x0F	N/A	N/A
03	Add logical address using HdmiCecAddLogicalAddress API	handle = valid handle, logicalAddress = i	HDMI_CEC_IO_SUCCESS	Should be successful
04	Retrieve logical address using HdmiCecGetLogicalAddress API	handle = valid handle, logicalAddress = valid pointer	HDMI_CEC_IO_SUCCESS, logicalAddress = i	Should be successful
05	Remove logical address using HdmiCecRemoveLogicalAddress API	handle = valid handle, logicalAddress = i	HDMI_CEC_IO_SUCCESS	Should be successful
06	Close HDMI CEC HAL using HdmiCecClose API	handle = valid handle	HDMI_CEC_IO_SUCCESS	Should be successful

graph TB
A[HdmiCecOpen] -->|HDMI_CEC_IO_SUCCESS| B{Loop 0x00 to 0x0F}
B --> |HDMI_CEC_IO_SUCCESS| C[HdmiCecAddLogicalAddress]
C --> |HDMI_CEC_IO_SUCCESS| D[HdmiCecGetLogicalAddress]
D --> |HDMI_CEC_IO_SUCCESS & Address Match| E[HdmiCecRemoveLogicalAddress]
E --> |HDMI_CEC_IO_SUCCESS| B
B --> |End of Loop| F[HdmiCecClose]
A -->|Failure| G[Test case fail]
F -->|Failure| K[Test case fail]
F -->|HDMI_CEC_IO_SUCCESS| L[Test case success]

Test 3

Title	Details
Function Name	`test_l2_hdmi_cec_sink_hal_RemoveLogicalAddress`
Description	Invoke the HAL API to delete the `DUT` logical address and verify that it is removed successfully.
Test Group	02
Test Case ID	003
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 3

Variation / Steps	Description	Test Data	Expected Result	Notes
01	Open the HDMI CEC HAL using HdmiCecOpen API	handle = valid handle	HDMI_CEC_IO_SUCCESS	Should be successful
02	Add a logical address using HdmiCecAddLogicalAddress API	handle = valid handle, logicalAddress = 0x00	HDMI_CEC_IO_SUCCESS	Should be successful
03	Get the logical address using HdmiCecGetLogicalAddress API	handle = valid handle, logicalAddress = valid buffer	HDMI_CEC_IO_SUCCESS , logicalAddress = 0x00	Should be successful
04	Remove the logical address using HdmiCecRemoveLogicalAddress API	handle = valid handle, logicalAddress = 0x00	HDMI_CEC_IO_SUCCESS	Should be successful
05	Get the logical address using HdmiCecGetLogicalAddress API	handle = valid handle, logicalAddress = valid buffer	HDMI_CEC_IO_SUCCESS , logicalAddress = 0x0F	Should be successful
06	Close the HDMI CEC HAL using HdmiCecClose API	handle = valid handle	HDMI_CEC_IO_SUCCESS	Should be successful

graph TB
A[HdmiCecOpen] -- "HDMI_CEC_IO_SUCCESS" --> B[HdmiCecAddLogicalAddress]
A -- "Failure" --> A1[Test case fail]
B -- "HDMI_CEC_IO_SUCCESS" --> C[HdmiCecGetLogicalAddress]
B -- "Failure" --> B1[Test case fail]
C -- "HDMI_CEC_IO_SUCCESS & Logical Address = current logical address" --> D[HdmiCecRemoveLogicalAddress]
C -- "Failure" --> C1[Test case fail]
D --"HDMI_CEC_IO_SUCCESS" -->E[HdmiCecGetLogicalAddress]
D -- "Failure" --> D1[Test case fail]
E -- "HDMI_CEC_IO_SUCCESS & Logical Address = 0x0F" --> F[HdmiCecClose]
E -- "Failure" --> E1[Test case fail]
F -- "HDMI_CEC_IO_SUCCESS" --> G[Test case pass]
F -- "Failure" --> F1[Test case fail]

Test 4

Title	Details
Function Name	`test_l2_hdmi_cec_sink_hal_BroadcastHdmiCecCommand`
Description	After deleting the `DUT` logical address, try to send a broadcast CEC Command (as per 1.4b HDMI CEC spec) and confirm transmission is successful.
Test Group	02
Test Case ID	004
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 4

Variation / Steps	Description	Test Data	Expected Result	Notes
01	Open HDMI CEC using HdmiCecOpen	handle = valid buffer	HDMI_CEC_IO_SUCCESS	Should be successful
02	Add logical address using HdmiCecAddLogicalAddress	handle = valid handle, logicalAddresses = 0x0	HDMI_CEC_IO_SUCCESS	Should be successful
03	Remove logical address using HdmiCecRemoveLogicalAddress	handle = valid handle, logicalAddresses = 0x0	HDMI_CEC_IO_SUCCESS	Should be successful
04	Broadast CEC message using HdmiCecTx	handle = valid handle, buf = {0x0F, 0x84, 0x00, 0x00}, len = sizeof(buf), result = valid buffer	HDMI_CEC_IO_SUCCESS	Should be successful
05	Check the result of transmission	result = valid buffer	HDMI_CEC_IO_SENT_BUT_NOT_ACKD	Should be successful
06	Close HDMI CEC using HdmiCecClose	handle = valid handle	HDMI_CEC_IO_SUCCESS	Should be successful

graph TB
A[HdmiCecOpen] -- "HDMI_CEC_IO_SUCCESS" --> B[HdmiCecAddLogicalAddress]
A -- "Failure" --> A1[Test case fail]
B -- "HDMI_CEC_IO_SUCCESS" --> C[HdmiCecRemoveLogicalAddress]
B -- "Failure" --> B1[Test case fail]
C -- "HDMI_CEC_IO_SUCCESS" --> D[HdmiCecTx]
C -- "Failure" --> C1[Test case fail]
D -- "HDMI_CEC_IO_SUCCESS" --> E[Check HdmiCecTx result]
D -- "Failure" --> D1[Test case fail]
E -- "HDMI_CEC_IO_SENT_AND_ACKD" --> F[HdmiCecClose]
E -- "Failure" --> E1[Test case fail]
F -- "HDMI_CEC_IO_SUCCESS" --> G[Test case success]
F -- "Failure" --> F1[Test case fail]

Test 5

Title	Details
Function Name	`test_l2_hdmi_cec_sink_hal_VerifyPhysicalAddress`
Description	Verify the valid physical address allocated through the HAL function.
Test Group	02
Test Case ID	005
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 5

Variation / Steps	Description	Test Data	Expected Result	Notes
01	Call the pre-requisite API HdmiCecOpen()	handle = valid handle	HDMI_CEC_IO_SUCCESS	Should be successful
02	Call the API HdmiCecGetPhysicalAddress()	handle = valid handle, physicalAddress = valid address	HDMI_CEC_IO_SUCCESS	Should be successful
03	Check the return status of HdmiCecGetPhysicalAddress()	status = return status of HdmiCecGetPhysicalAddress()	HDMI_CEC_IO_SUCCESS	Should be successful
04	Verify that the physical address obtained is equal to 0.0.0.0	physicalAddress = obtained physical address	physicalAddress == 0x0000 (as per HDMI Spec 1.4b and section 8.7.2)	Should be successful
05	Call the post-requisite API HdmiCecClose()	handle = valid handle	HDMI_CEC_IO_SUCCESS	Should be successful

graph TB
A[HdmiCecOpen] -->|HDMI_CEC_IO_SUCCESS| B[HdmiCecGetPhysicalAddress]
B -->|HDMI_CEC_IO_SUCCESS| C{Verify Physical Address == 0.0.0.0}
B -->|Failure| B1[Test case fail]
C -->|Success| D[HdmiCecClose]
C -->|Failure| C1[Test case fail]
D -->|HDMI_CEC_IO_SUCCESS| E[Test case success]
D -->|Failure| D1[Test case fail]
A -->|Failure| A1[Test case fail]

Test 6

Title	Details
Function Name	`test_l2_hdmi_cec_sink_hal_TransmitCECCommand`
Description	DUT transmits a CEC Command (as per 1.4b HDMI CEC spec) to get the CEC version of the device that doesn't exist.
Test Group	02
Test Case ID	006
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 6

Variation / Steps	Description	Test Data	Expected Result	Notes
01	Open HDMI CEC HAL using HdmiCecOpen	handle = valid buffer	HDMI_CEC_IO_SUCCESS	Should be successful
02	Add logical address using HdmiCecAddLogicalAddress	handle = valid handle, logicalAddresses = 0x0	HDMI_CEC_IO_SUCCESS	Should be successful
03	Transmit CEC command using HdmiCecTx for a non existing device	handle = valid handle, buf = {0x47, 0x9F}, len = sizeof(buf), result = valid buffer	HDMI_CEC_IO_SUCCESS, result = HDMI_CEC_IO_SENT_BUT_NOT_ACKD	Should be successful
04	Remove logical address using HdmiCecRemoveLogicalAddress	handle = valid handle, logicalAddresses = 0x4	HDMI_CEC_IO_SUCCESS	Should be successful
05	Close HDMI CEC HAL using HdmiCecClose	handle = valid handle	HDMI_CEC_IO_SUCCESS	Should be successful

graph TB
A[HdmiCecOpen] -- "HDMI_CEC_IO_SUCCESS" --> B[HdmiCecAddLogicalAddress]
A -- "Not HDMI_CEC_IO_SUCCESS" --> A1[Test case fail]
B -- "HDMI_CEC_IO_SUCCESS" --> C[Prepare CEC message]
B -- "Not HDMI_CEC_IO_SUCCESS" --> B1[Test case fail]
C --> D[HdmiCecTx]
D -- "HDMI_CEC_IO_SENT_BUT_NOT_ACKD" --> E[HdmiCecRemoveLogicalAddress]
D -- "Not HDMI_CEC_IO_SENT_BUT_NOT_ACKD" --> D1[Test case fail]
E -- "HDMI_CEC_IO_SUCCESS" --> F[HdmiCecClose]
E -- "Not HDMI_CEC_IO_SUCCESS" --> E1[Test case fail]
F -- "HDMI_CEC_IO_SUCCESS" --> G[Test case success]
F -- "Not HDMI_CEC_IO_SUCCESS" --> F1[Test case fail]