RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
HideElements | ||
---|---|---|
|
Background Color | ||||||
---|---|---|---|---|---|---|
| ||||||
Before You Begin Anchor |
|
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
OEM Guide Anchor |
|
This section will detail the recommended step by step procedure of adopting RDK by OEM.
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.
Anchor | ||||
---|---|---|---|---|
|
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.
A table explaining the roles & responsibilities of OEM & RDKM in the collaboration zone is given below:
# | Activity | Owner | Remarks |
---|---|---|---|
1 | RDKM | RDKM will setup Collaboration space, access restrictions | |
2 | OEM | JIRA project. OEM will be the owner for the JIRA project. | |
3 | OEM/RDKM | RDKM will create the space and SOCSoC/OEM push the code changes | |
4 | OEM | Create necessary device specific HAL implementation for porting RDK into Accelerator | |
5 | RDKM | Which SDK version to be used. RDKM will support the integration with OEM libraries | |
6 | OEM | Manifest for building the accelerator | |
7 | RDKM/OEM | RDKM approved RCU’s are enabled by default | |
8 | 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 | |
13 | Monthly release & tagging | OEM | Monthly tagging and release with stakeholders along with test results |
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
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
How to create user accounts for OEM membersOEM 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
For any issues faced, a mail can be sent to support@rdkcentral.com 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
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 |
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.
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 |
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 | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
|
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
To match the layered structure of Yocto builds, a OEM specific layer is used to include OEM changes and additions. Use the yocto-layer create sub-command to create a new general layer.
|
There shall be separate device (machine) configuration file (.conf) for each device for the particular OEM for which the layer is intended for. The general naming terminology for OEM layer is meta-rdk-oem-<oem name>
The device (machine) configuration file shall include corresponding include (.inc) file to get machine configuration details.
Expand | ||
---|---|---|
| ||
Adding the Machine Configuration File for the new OEMEach meta-* layer should have a conf folder containing the machine configuration we can select during 'source setup-environment' . Optionally it can also have a class/classes folder for keeping information that is useful to share between metadata files. To add a machine configuration, you need to add a .conf file with details of the device being added to the conf/machine/ file. In the machine conf file the basic machine configuration should be defined. OEM can have several meta-rdk-<oem> layers containing chip specific implementation. Generally conf file name will be SoC name. If both OEM and SOCSoC are present then machine configuration should be coming from master i.e. OEM . It means whatever image that gets created comes from meta-rdk-oem The most important variables to set in this file are as follows :
For SOCSoC, The most important variables to set in this conf file are as follows :
Basic configuration of building kernelStandard meta-rdk/recipe-core/images will have different kinds of images which one can use and build. This recipe-core/images will have bbappend or main image name. If meta-rdk is used( i.e. meta-rdk image ) then bbappend of that image client is required For example, <image name>.bbappend Define "bbappend of images" and "conf file" as required. Adding Recipe for SoC/OEMThe following kind of recipes can be added to SoC/OEM layer. The recipes shall be grouped as described in “BSP Reference Layer”.
|
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(only for RDK licensee) and for TDK test app please refer TDK-V Documentation.
Once the RDK bring-up in OEM is completed, the software to OEM is delivered by the SoC vendors. This usually happens in 2 ways:
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. OEM secure information can be hosted in Artifactory server.
OEM vendors will work in collaboration with the SoC vendor. SoC vendor can define a HAL layer, share the source of HAL & yocto meta layer that can be stored in RDK CMF Git repository,share the SDK binary that can be stored in RDK Artifactory (Shared only from authorized SoC vendors who will work in collaboration with the OEM vendor) and then publish necessary documentation on how to build the OEM SDK. OEM 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 OEM 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
in this approach, OEM vendors will work in collaboration with the SoC vendor. SoC vendor can define a HAL layer, share the source of HAL & yocto meta layer that can be stored in RDK CMF Git repository and then publish necessary documentation on how to build the OEM SDK.OEM 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 OEM vendor.
For both approaches, the RDKM collaboration zone will be used with strict access restrictions.
After a successful bring up of RDK on OEM platform, the next step will be to allow SoCs to work with OEMs to get a device based on the OEM platform. RDKM offers collaboration space for OEMs which would help OEMs to collaborate with SoC 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:
Background Color | ||||||
---|---|---|---|---|---|---|
| ||||||
Procedure for OEM porting of RDK Anchor |
|
Include Page | ||||
---|---|---|---|---|
|