Versions Compared

Key

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

HideElements
sidebartrue

The Aim of this document is to explain on what OEM layer does which sits on top of SoC layer and how OEM adopt RDK and its step by step procedure of adopting RDK, OEM later adds support for software for boot-up, image updates, and APIs to handle custom drivers. These could be specializations to the generic or SoC components or complementary software components provided by the OEM to create a fully functional set-top device.

Info
iconfalse

On this Page:

Table of Contents
maxLevel1

Background Color
color#F5F5F5

Before You Begin

RDK License


OEMs 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 OEM.

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. See here to know what are all the features available in RDK-V and can implement based on your requirement. OEM can cross check the expected features/specifications with the capabilities of the SoC platform being used and can finalize the features supported by the product.

RDKM On-boarding


RDKM provides a collaboration zone facility for OEMs to facilitate easier engineering of RDK based devices. The collaboration zone will help OEMs to work with SoCs, 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 OEM & RDKM in the collaboration zone is given below:


#

Activity

Owner

Remarks

1

OEM Collaboration zone creation

RDKM

RDKM will setup Collaboration space, access restrictions

2

JIRA Project creation

OEM

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

3

SOC / OEM meta -layer creation in collaboration zone

OEM/RDKM

RDKM will create the space and SOC/OEM push the code changes

4

Device specific HAL repo creation

OEM

Create necessary device specific HAL implementation for porting RDK into Accelerator

5

Share SOC SDK Artifacts

RDKM

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

6

Manifest creation

OEM

Manifest for building the accelerator

7

Remote control integration

RDKM/OEM

RDKM approved RCU’s are enabled by default

8

UI/UX

RDKM/OEM

Comes with pre-integrated UI’s, OEM and RDKM will discuss ont he default UI

9

Create Accelerator build from CMF GIT

OEM / RDKM

Both teams work together to build Accelerator from CMF.

10

Provide Devices to RDKM team

OEM


11

Device flashing instructions / recovery mechanisms

OEM

OEM should share the device flashing instruction.

12

Sanity, Functionality Testing & automation tests

RDKM/OEM

RDK Certification Suite

13

Monthly release & tagging

OEM

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 OEM Members, creating a JIRA project for OEM etc.

How to create a collaboration zone
Anchor
How to create a collaboration zone
How to create a collaboration zone


It is expected that OEM has already obtained a license to work with RDKM (If not, OEM 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 OEM members


OEM 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
Anchor
How to get access to the collaboration zone/repo
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
  • OEM 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 OEM
Anchor
How to create a JIRA project for OEM
How to create a JIRA project for OEM


An INFRA ticket needs to be raised at https://jira.rdkcentral.com to create a JIRA project for OEM.  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
Anchor
How to create a Git/ Github repository for meta layers or manifests or HAL layers
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
Anchor
How to get access to SoC SDK artifacts
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. OEM needs to decide on the hardware layout that incorporates OEM components to the SoC board. Device will be categorized as Low Profile and High Profile device based on the hardware capabilities. In a low profile device 4k support might be optional but it is expected to have 4k support in high profile device.

Sample Reference Flash Layout (Optional) :

Reference Flash Layout

  flash0.macadr  EMMC flash Data :  1024B
  flash0.nvram  EMMC flash Data : 64KB
  flash0.recovery  EMMC flash Data : 256MB
  flash0.vendor  EMMC flash Data : 128MB
  flash0.kernel_a  EMMC flash Data : 128MB
  flash0.kernel_b  EMMC flash Data : 128MB
  flash0.rootfs_a  EMMC flash Data : 1024MB
  flash0.rootfs_b  EMMC flash Data : 1024MB
  flash0.rootdata  EMMC flash Data : 2048MB
  flash0.rsvd  EMMC flash Data : 10174MB


Device Firmware


OEM can make use of the below details to start developing a Yocto build to engineer the device firmware builds based on RDK Yocto build setup.

Yocto based RDK builds are flexible enough to easily accommodate SoC & OEM changes. The starting point for the Yocto builds are a manifest file. The manifest file is an xml file that contains details of the different open embedded Yocto build layers, meta layers , rdk as well as open source components that needs to be fetched during initial stages ( than during bitbake time ) as well as the URL locations from where the data can be pulled. A set of sample manifests that can be used as a template for developing OEM specific manifests are given below


Expand
titleClick here to see set of sample manifests for developing OEM specific manifests

#

File

Remarks

1

Device Specific Manifest

This is the starting point of the build and is specific to a device. Usually it contains references to other manifest files which will be having  specific set of repos

2

SoC manifest

This manifest contains meta layer details of SoC and , optionally, some SoC specific repos

3

OEM manifest

This manifest contains meta layer details of OEM( which might or might not be generic across OEMs multiple devices ) and , optionally, some OEM specific repos

4

OE layers manifest

This manifest has details of the basic Yocto Open Embedded layers

5

RDK-V manifest

This manifest can contain meta layers specific to RDK & RDK-V and , for EXTERNALSRC cases, the RDK & RDK-V component repo details too. It might be supplemented with a conf file too

6

Third party apps

This manifest can contain meta layers related to Premium streaming applications which are chosen by OEM


For more details on getting RDK-V ported to an OEM device, please refer the links Add New SoC and OEM to RDK RDK-V OEM Specific Porting and Guideline for SoC and OEM Vendors

TDK and RDK Certification Suite Package


RDKM offers an in-house Test & certification suite that facilitates OEMs to get their IP based 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.

Certification suite is available at RDK IP Set-top Product Certification and for TDK test app please refer TDK-V Documentation.

Background Color
color#F5F5F5

Procedure for OEM porting of RDK

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