HPK Public Documentation

Table of Contents

• Acronyms, Terms and Abbreviations
• Description
• Hardware Porting Kit
• How to build the test suite
• Levels of Test for Vendor Layer
• Executing the L1 L2 and L3 test suites via automation on the target
• Executing L1 and L2 test suites manually on the target
• Release History
• Reference

Acronyms, Terms and Abbreviations

• HPK - Hardware Porting Kit
• HAL - Hardware Abstraction Layer
• API - Application Programming Interface
• NA - Not Applicable

Description

This is the public documentation to support the Hardware Porting Kit (HPK), for any vendor / third party to read. This document will be the consolidating jump point for all documentation with links to other open documentations.

Hardware Porting Kit

The Hardware Porting Kit (HPK) is a collection resources that simplify the process of adapting existing software to run on a new hardware platform. It provides a framework for making the necessary changes to the software to account for the differences between the hardware vendors.

It will provide both Hardware Abstraction Layer (API) Header files, and software tests to ensure compatibility with the RDK Middleware Stack.

The components and their respective repositories are listed below:

#	Component Name	Repositories
1	Deep Sleep Manager	HAL Interface/Test Suit
2	Power Manager	HAL Interface/Test Suit
3	Device Settings	HALInterface/Test Suit
4	HDMI CEC	HAL Interface/Test Suit
5	RMF Audio Capture	HAL Interface/Test Suit
6	RDK-V TVSettings	HAL Interface/Test Suit
7	RDK-V WiFi	HAL Interface/Test Suit
8	LibDRM	HAL Interface/Test Suit NA
9	AvSync	HAL Interface/Test Suit NA
10	V4L2	HAL Interface/Test Suit NA

How to build the test suite

In order to build the test suits, there is a requirement to supply the toolchain, either as a vendor independent toolchain, an SDK, or an RDK toolchain.

• export the toolchain path, e.g.:

export TOOLCHAIN_PATH=/opt/toolchains/rdk-glibc-x86_64/sysroots/armv7at2hf-neon-rdk-linux-gnueabi
export CC="arm-rdk-linux-gnueabi-gcc  -march=armv7-a -mthumb -mfpu=neon -mfloat-abi=hard --sysroot=$TOOLCHAIN_PATH"

For more information about RDK Docker Toolchain, please check RDK Docker Toolchain

• Clone the hal repo, e.g.:

git clone [email protected]:rdkcentral/rdk-halif-hdmi_cec.git

• Set Project Version:

If you want to build the test repository with a specific tag or branch, set the UT_PROJECT_VERSION variable accordingly. If not set, the default main branch will be used.

export UT_PROJECT_VERSION=1.0.1  # Build using a specific tag

or

export UT_PROJECT_VERSION=develop  # Build using a specific branch

• Build Targets:

There are two targets for the platform

1. linux - (default)
2. arm - TARGET=arm

build_ut.sh TARGET=arm

• build_ut.sh script will clone the hal-test repo, ut-core and generate a hal_test binary in ut/bin/ upon successful completion.

Levels of Test for Vendor Layer

• Details regarding the levels of testing can be found on the linked page Levels

Executing the L1 L2 and L3 test suites via automation on the target

• Goto ut/host folder. This folder contains the script files required for installing python
• Run script files to download the python environment
• For more details refer Guide-for-Setting-up-the-Python-RAFT-Testing-Suite
• More information about the Python installation and requirement refer RAFT
• For detailed instructions on how to run the L1 , L2 & L3 automation tests for a specific HPK component, please refer to the doc folder within the corresponding test repository.

Executing L1 and L2 test suites manually on the target

Copy files from bin/* to the target.

Log into the target.

Assuming the files that are copied are in the /home/root directory, then the following export is required.

• All external library dependencies are copied into the ut/bin directory

export LD_LIBRARY_PATH=/usr/lib:/lib:/home/root:./

or use the run.sh, which is in the same directory

Now the hal test can be executed, -h for help is supported.

./hal_test  -h
Help
-c - Console Mode (Default)
-a - Automated Mode
-b - Basic Mode
-t - List all tests run to a file
-l - Set the log Path
-p - <profile_filename> - specify the profile to load YAML or JSON, also used by kvp_assert
-h - Help

Modes of operation

1. Console Mode - will open the interactive console
2. Automated Mode - will output in xUnit form as a .xml file
3. Basic Mode - All tests will be ran and the output redirected to the shell

Release History

The latest release information is available here.

Reference

• Reference the RDK UT Core Wiki for more comprehensive information UT Core Wiki