Before You Begin RDK License Vendors are advised to get into an agreement with RDK Management LLC to obtain the free license to use the complete RDK Code base in their platform. More details about license are available at https://rdkcentral.com/licenses/ . Please email info@rdkcentral.com if you have additional questions about licenses or membership. |
This document helps vendors understand how to create a successful port of RDK on their platform with the help of the HAL API Specification for different RDK Components, as well as how the port can be successfully certified. Depending on the device profile ( IP STB or IP TV ), vendors may choose the relevant components and perform the port by implementing the HAL layer.
Details of how to port third-party software stacks or applications to a SoC platform are out of the scope of this porting guide.
Prerequisites
The vendor is expected to have certain prerequisites before proceeding to the porting process, which include:
RDK device profile:
- Decide on the profile by referring to the available RDK profiles ( IP STB or IP TV ) and have a platform with the expected capabilities for the chosen profile. Depending on the device profile selected, the components that are required to be ported are available in the HAL table below.
- RDK HAL API Source code access:
- The RDK source code is distributed across multiple source code repositories which are available in RDK Central GitHub.
Platform-specific Kernel:
- It is highly recommended to use ACK for the target platform as RDK7 is recommended to run on top of ACK 5.15 64-bit version
Porting
The Hardware Porting Kit( HPK ) provide both Hardware Abstraction Layer (API) Header files, and software tests to ensure compatibility with the RDK Middleware Stack. HPK enables vendor to implement the required interfaces that will enable them to bring RDK on top of their platform. Once the HAL layer for each component is implemented, vendors can use the respective test component to certify their port
The elaborated documentation on HAL APIs, the test suites and how to build and execute them are all available at the HPK Documentation portal
For an exhaustive list of component versions, as well as test suite version for each of the HAL component, please refer below table
| # | Component Name | HAL Interface Version | HAL Testing Suite Version | ||||
| Current | Change Info | Previous | Current | Change Info | Previous | ||
| 1 | Deep Sleep Manager | No change | 1.0.4 | No change | 1.3.0 | ||
| 2 | Power Manager | No change | 1.0.3 | No change | 1.4.0 | ||
| 3 | Device Settings | 4.1.2 | 4.1.1...4.1.2 | 4.1.1 | No change | 3.5.0 | |
| 4 | HDMI CEC | 1.3.10 | 1.3.9...1.3.10 | 1.3.9 | No change | 1.4.0 | |
| 5 | RMF Audio Capture | No change | 1.0.5 | No change | 1.4.0 | ||
| 6 | RDK-V TVSettings | No change | 2.1.0 | No change | 2.1.3 | ||
| 7 | RDK-V WiFi | No change | 2.0.0 | No change | 1.0.0 | ||
| 8 | LibDRM | No change | 1.0.0 | NYA | |||
| 9 | AvSync | No change | 1.0.0 | NYA | |||
| 10 | V4L2 | No change | 1.0.0 | NYA |
Certification
While the test suite associated with the vendor porting kit helps to certify the port is working as expected, RDK certification program facilitates users to get their product certified as an RDK compliance device.
RDKM provides the RDK Certification suite to verify the compliance of the RDK Video Accelerator device. The certification program includes testing that validates the RDK stack on the user platform with a defined test suite called as RDK Certification Test Suite. It is mandatory to go through this program in order to brand the user’s platform as an RDK-compliant product.