Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

HideElements
commentstrue
breadcrumbfalse
sidebartrue
headerfalse

The aim of this page is to provide the details and guide SoC Vendors on how to adopt RDK and take them through the porting procedure and what SoC has to do and develop to get an RDK based Platform up and running.

Info
iconfalse

On this Page :

Table of Contents
maxLevel1


Background Color
color#F5F5F5

Before You Begin


RDK License

SoC vendors are advised to get into an agreement with RDK Management LLC to obtain the free license so as to use the complete RDK Code base in their platform. More details about license is available at https://rdkcentral.com/licenses/ . Please email info@rdkcentral.com if you have additional questions about licenses or membership


Background Color
color#F5F5F5

Overview

This section will detail the recommended step by step procedure of adopting RDK by a SoC

Product Specifications

The first step to get a fully functional product is to define the product features and see if they meet the standard requirements. A list of expected features from an IP based Set-top box are listed at Product Specifications.  SoC See here to know what are all the features available in RDK-V and can implement based on your requirement. SoC can use this as a guide while engineering the RDK SoC platform.

Info

For details of product specifications, please refer:  

Link to New Window
pageProduct SpecificationsRDK-V Features
link-textProduct Specifications

RDKM On-boarding

RDKM provides a collaboration zone facility for SoCs to facilitate easier engineering of RDK based devices. The collaboration zone will help SoCs to work with OEMs, RDKM and any 3rd party along with a common space to develop & integrate, manage and verify the device. The zone includes facilities for code management, a confluence based RDK Wiki for knowledge management & sharing, a JIRA for tracking activity progress, issues as well as to manage the activities, a test setup to validate devices. The access restrictions implemented will help the collaboration zone to be accessible only for the authorized personnel thereby guarding any sensitive information related to SoC/OEM/Third party.

Roles & Responsibilities

A table explaining the roles & responsibilities of SoC & RDKM in the collaboration zone is given below:


#

Activity

Owner

Remarks

1

RDKM

RDKM will setup Collaboration space, access restrictions

2

JIRA Project creation

SoC

JIRA project. SoC will be the owner for the JIRA project

3

SOC  meta-layer creation in collaboration zone

SoC/RDKM

RDKM will create the space and SOC push the code changes

4

Device specific HAL repo creation

SoC

Create necessary device specific HAL implementation for porting RDK into Accelerator

5

Share SOC SDK Artifacts

SoC

Which SDK version to be used. RDKM will support the integration with SoC libraries

6

Manifest creation

SoC

Manifest for building the accelerator

7

UI/UX

RDKM/SoC

Comes with pre-integrated UI’s, SoC and RDKM will discuss on the default UI

8

Create Accelerator build from CMF GIT

SoC/ RDKM

Both teams work together to build Accelerator from CMF

9

Provide Devices to RDKM team

SoC


10

Device flashing instructions / recovery mechanisms

SoC

SoC should share the device flashing instruction

11

Sanity, Functionality Testing & automation tests

RDKM/SoC

RDK Certification Suite

12

Monthly release & tagging

SoC

Monthly tagging and release with stakeholders along with test results



Expand
titleClick here for more details such as creating collaboration zone, creating user accounts for SoC Members, creating a JIRA project for SoC etc.

How to create a collaboration zone

It is expected that SoC has already obtained a license to work with RDKM (If not, SoC can send a mail to support@rdkcentral.com to start off with the discussions).

With this user account an INFRA ticket can be raised at https://jira.rdkcentral.com to create a collaboration repo. The ticket should contain the details for:

  • Location of collaboration zone
  • Collaboration zone access groups/members

How to create user accounts for SoC Members

SoC users can sign up at https://wiki.rdkcentral.com/signup.action to create a user account in RDK. For any issues faced, a mail can be sent to support@rdkcentral.com

How to get access to the collaboration zone/repo

An INFRA ticket needs to be raised at https://jira.rdkcentral.com with the below details:

  • Collaboration zone/repo name
  • User name and the mail id's of the members to whom the access is needed
  • SoC collaboration zone/repo owner name

For any issues faced, a mail can be sent to support@rdkcentral.com

How to create a JIRA project for SoC

An INFRA ticket needs to be raised at https://jira.rdkcentral.com to create a JIRA project for SoC. Once approvals are received along with required access restrictions, the project will be created. For any issues faced, a mail can be sent to support@rdkcentral.com

How to create a Git/ Github repository for meta layers or manifests or HAL layers

To get a Git repository a request needs to be raised to CMF team using the CMFSUPPORT ticket at https://jira.rdkcentral.com. Once approvals are received along with required access restrictions, the repo will be created. Any changes in merge permissions can be requested in same ticket. For creating any specific branches in the repo, another ticket in the same CMFSUPPORT can be raised. For any issues faced, a mail can be sent to support@rdkcentral.com

Once the git repo is created, it can be accessed at https://code.rdkcentral.com

How to get access to SoC SDK Artifacts

An INFRA ticket needs to be raised at https://jira.rdkcentral.com to get access to SDK Artifacts. Once approvals are received along with required access restrictions, the access should be in place. For any issues faced, a mail can be sent to support@rdkcentral.com



Product Engineering

Once the product features are decided, the device engineering can be started. SoC needs to decide on the hardware layout that incorporates components to the target board. A sample expected hardware specification list as well as a sample flash layout is available at Product Engineering
Info

For details of product engineering, please refer: 

Link to New Window
pageProduct Engineering
link-textProduct Engineering

SoC Platform Firmware

SoC can make use of the details available at SoC Platform Firmware to start developing a Yocto build to engineer the device firmware builds based on RDK Yocto build setup.

Info

For details please refer: 

Link to New Window
pagehttps://wiki.rdkcentral.com/display/RDK/SoC+Platform+Firmware
link-textSoC Platform Firmware

RDK Certification Suite Package

RDKM offers an in-house Test & certification suite that facilitates SoCs to get their IP Set-top product certified as RDK Compliant device.

Certification program includes testing which validates the RDK stack on the device with defined test suite called as RDK Certification Test Suite. It is mandatory to go through this program in order to brand user's platform as RDK compliant product.

Info

For details on the RDK Certification please refer: IP based Set-top device Certification

SDK Releases

Once the RDK bring-up in SoC is completed, the vendor needs to plan on the delivery of the software to OEM vendors. This usually happens in 2 ways:

HAL + SDK binary

In this approach will make use of the RDK Artifactory server. Artifactory server is a Repository Manager that functions as a single access point organizing all the binary resources including proprietary libraries, remote artifacts and other 3rd party resources. It is a secure and restricted server, only collaboration members will have access to this server. SOC secure information like secure components such as PlayReady, widevine and Dolby libraries etc. can be hosted in Artifactory server.

SoC vendor can define a HAL layer, share the source of HAL & yocto meta layer that can be stored in RDK CMF Git repository (which will be shared only  to authorized OEM vendors who will work in collaboration with the SoC vendor), share the SDK binary that can be stored in RDK Artifactory (which will be shared only to authorized OEM vendors who will work in collaboration with the SoC vendor) and then publish necessary documentation on how to build the SoC SDK. SoC vendor can use the git/ Artifactory for periodic updated (for releases) or for bug fixes. All the source code, binary and documentation will be strictly access restricted and access will be allowed only for authorized personnel by SoC vendor.

Artifactory server can be accessed by adding the Artifactory details and login credentials in the .netrc file, just like it is done for normal git repositories. A sample is given below:

machine your.artifactory.host
login YOUR_ARTIFACTORY_USERNAME
password YOUR_PASSWORD_OR_KEY_OR_TOKEN

Complete source code

In this approach, SoC vendor can define a HAL layer, share the source of HAL , yocto meta layer and SDK source code that can be stored in RDK CMF Git repository( which will be shared only  to authorized OEM vendors who will work in collaboration with the SoC vendor )  and then publish necessary documentation on how to build the SoC SDK. SoC vendor can use the git for periodic updated ( for releases ) or for bug fixes. All the source code and documentation will be strictly access restricted and access will be allowed only for authorized personnel by SoC vendor.


For both approaches, the RDKM collaboration zone will be used with strict access restrictions.


Collaboration with OEMs

After a successful bring up of RDK on SoC platform, the next step will be to allow OEMs to work with SoCs to get a device based on the SoC platform. RDKM offers collaboration space for SoCs which would help SoCs to collaborate with OEM and RDK teams (as well as any 3rd party) in their journey to engineer a successful RDK product. RDKM collaboration zone includes features like (but not limited to) CMF facility to maintain build manifests as well as SoC/OEM specific code, SoC SDK artifact storage facility, JIRA & RDK Wiki spaces, integration with Test & Certification suites, monthly & release tagging etc.

Please refer RDKM On-boarding for more details on facilities available for SoCs and OEMs as part of collaboration zone . In short, it will include:

  • Access restricted Git repositories and Artifactory servers
  • Access restricted Confluence and JIRA spaces for Management and Documentation
  • Access to RDKM support as well as extended documentation
  • Access to test & certification support 



Background Color
color#F5F5F5

Porting RDK to SoC


Include Page
RDK-V 4.0 - SOC Porting Guide
RDK-V 4.0 - SOC Porting Guide