Versions Compared

Key

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

Table of Contents

Introduction

When a cable company offers Internet access over the cable, Internet information can use the same cables. Putting both upstream and downstream data on the cable television system requires two types of equipment:

...

To address this situation, RDK-B does not include DOCSIS. It only includes components that provide an abstraction layer software interface to third party WAN. For the DOCSIS WAN, this component is known as the Cable Modem (CM) Agent. CM Agent provides interfaces for integrating WAN interfaces with RDK-B. RDK-B is not tied to DOCSIS and may be used with any WAN interface. Other RDK-B software components can be created that provide interfaces to other WANs.


draw.io Diagram
diagramNameCM Agent.drawio
Image Removed
revision1

Architecture


  • CM Agent is a CCSP component that exposes TR181 parameters related to CM/DOCSIS interface characteristics.
  • CM agent provides info like Upstream channels, downstream channels, boot file name, DOCSIS log, etc along with CM interface details.
  • Maintains a TR181 data model XML file with dbus object path as /com/cisco/spvtg/ccsp/cm
  • Has a layered architecture similar to any other CCSP component

draw.io Diagram
diagramNameCCSP Message Bus.drawio
revision1
Image Removed

Access Layer

  • Access Layer interfaces with the CCSP message bus
  • Receives any set or get calls and pass them onto the DML layer to manage the data which is in the request.

...

  • This layer makes calls to underlying HAL functions, Linux system calls/commands, third party modules, open-source modules etc.
  • This layer will be more component-specific.

Code Flow


draw.io Diagram
diagramNameCodeflow.drawio
revision1
Image Removed

Objects

CMAgent object in its DML layer:

Panel

Device.X_RDKCENTRAL-COM_CableModem.

Dmcli

Retrieving  cable modem values using dmcli

Panel
$ dmcli eRT getv Device.X_RDKCENTRAL-COM_CableModem.
CR component name is: eRT.com.cisco.spvtg.ccsp.CR
subsystem_prefix eRT.
getv from/to component(eRT.com.cisco.spvtg.ccsp.cm): Device.X_RDKCENTRAL-COM_CableModem.
Execution succeed.
Parameter    1 name: Device.X_RDKCENTRAL-COM_CableModem.DsOfdmChanNumberOfEntries
               type:       uint,    value: 0
Parameter    2 name: Device.X_RDKCENTRAL-COM_CableModem.UsOfdmaChanNumberOfEntries
               type:       uint,    value: 0
Parameter    3 name: Device.X_RDKCENTRAL-COM_CableModem.StatusOfdmaNumberOfEntries
               type:       uint,    value: 0

...

HAL APIs

This hardware abstraction layer (HAL) concept is used for every interface.

...

Some example APIs  are listed below:

APIs
cm_hal_InitDB
docsis_InitDS
docsis_InitUS
docsis_getCMStatus
docsis_GetDSChannel
docsis_GetUsStatus
docsis_GetUSChannel
docsis_GetDOCSISInfo
docsis_GetNumOfActiveTxChannels
docsis_GetNumOfActiveRxChannels
docsis_GetErrorCodewords
docsis_GetMddIpModeOverride
docsis_SetMddIpModeOverride
docsis_GetUSChannelId
docsis_GetDownFreq
docsis_SetStartFreq
docsis_GetDocsisEventLogItems
docsis_ClearDocsisEventLog
cm_hal_GetDHCPInfo
cm_hal_GetIPv6DHCPInfo
cm_hal_GetCPEList
cm_hal_GetMarket
cm_hal_Set_HTTP_Download_Url
cm_hal_Get_HTTP_Download_Url
cm_hal_Set_HTTP_Download_Interface
cm_hal_Get_HTTP_Download_Interface
cm_hal_HTTP_Download
cm_hal_Get_HTTP_Download_Status
cm_hal_Reboot_Ready
cm_hal_HTTP_Download_Reboot_Now
cm_hal_FWupdateAndFactoryReset
cm_hal_ReinitMac
docsis_GetProvIpType
docsis_GetCert
docsis_GetCertStatus
cm_hal_Get_CableModemResetCount
cm_hal_Get_LocalResetCount
cm_hal_Get_DocsisResetCount
cm_hal_Get_ErouterResetCount
cm_hal_HTTP_LED_Flash
docsis_GetDsOfdmChanTable
docsis_GetUsOfdmaChanTable