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:

• A cable modem on the customer end 
• A cable modem termination system (CMTS) at the cable provider's end.

The CMTS takes the traffic coming in from a group of customers on a single channel and routes it to an Internet service provider (ISP) for connection to the Internet. At the head-end, the cable providers will have, or lease space for a third-party ISP to have, servers for accounting and logging, Dynamic Host Configuration Protocol (DHCP) for assigning and administering the IP addresses of all the cable system's users, and control servers.

RDK-B was designed to support any wide area network (WAN) type e.g DOCSIS, EPON. Gateways using RDK-B may provide a DOCSIS interface, but that DOCSIS code is typically tied to a particular piece of silicon and may even be provided by that silicon vendor. And the core philosophy of RDK-B was to be hardware and WAN type independent.

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.

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

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.

Data Model Management Layer

• Maintains the parameter list specified in the Data model XML file.
• Data Model Management Layer loads all data model access APIs from the Data model XML file
• The data model implementation in shared library interfaces HAL Integration (backend) Layer by calling backend integration APIs.

CM Agent HAL Integration (backend) Layer, a.k.a, component-specific HAL

• 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

Objects

CMAgent object in its DML layer:

Retrieving  cable modem values using dmcli

HAL APIs

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

The CM HAL provides a well-defined software interface that cable modem software developers can use to interface to RDK-B.

cm_hal.h provides function call prototypes and structure definitions used for the RDK-Broadband CM HAL.

Git repo: rdkb-halif-cm/include/cm_hal.h at main · rdkcentral/rdkb-halif-cm

Some example APIs  are listed below: