RDK-B
CM HAL Data Types

Description

Data Structures

struct  _CMMGMT_CM_DS_CHANNEL
 
struct  _CMMGMT_CM_US_CHANNEL
 
struct  _CMMGMT_CM_DOCSIS_INFO
 
struct  _CMMGMT_CM_ERROR_CODEWORDS
 
struct  CMMGMT_CM_EventLogEntry_t
 
struct  _CMMGMT_DML_CM_LOG
 
struct  _CMMGMT_DML_DOCSISLOG_FULL
 
struct  _CMMGMT_CM_DHCP_INFO
 
struct  _CMMGMT_CM_IPV6DHCP_INFO
 
struct  _CMMGMT_DML_CPE_LIST
 
struct  _DOCSIF31_CM_DS_OFDM_CHAN
 
struct  _DOCSIF31_CM_US_OFDMA_CHAN
 
struct  _DOCSIF31_CMSTATUSOFDMA_US
 
struct  _fixed_length_buffer
 
struct  _snmpv3_kickstart_row
 
struct  _snmpv3_kickstart_table
 
struct  _CM_DIPLEXER_SETTINGS
 

Macros

#define EVM_MAX_EVENT_TEXT   255
 
#define MAX_KICKSTART_ROWS   5
 

Typedefs

typedef struct _CMMGMT_CM_DS_CHANNEL CMMGMT_CM_DS_CHANNEL
 
typedef struct _CMMGMT_CM_DS_CHANNELPCMMGMT_CM_DS_CHANNEL
 
typedef struct _CMMGMT_CM_US_CHANNEL CMMGMT_CM_US_CHANNEL
 
typedef struct _CMMGMT_CM_US_CHANNELPCMMGMT_CM_US_CHANNEL
 
typedef struct _CMMGMT_CM_DOCSIS_INFO CMMGMT_CM_DOCSIS_INFO
 
typedef struct _CMMGMT_CM_DOCSIS_INFOPCMMGMT_CM_DOCSIS_INFO
 
typedef struct _CMMGMT_CM_ERROR_CODEWORDS CMMGMT_CM_ERROR_CODEWORDS
 
typedef struct _CMMGMT_CM_ERROR_CODEWORDSPCMMGMT_CM_ERROR_CODEWORDS
 
typedef struct _CMMGMT_DML_CM_LOG CMMGMT_DML_CM_LOG
 
typedef struct _CMMGMT_DML_CM_LOGPCMMGMT_DML_CM_LOG
 
typedef struct _CMMGMT_DML_DOCSISLOG_FULL CMMGMT_DML_DOCSISLOG_FULL
 
typedef struct _CMMGMT_DML_DOCSISLOG_FULLPCMMGMT_DML_DOCSISLOG_FULL
 
typedef struct _CMMGMT_CM_DHCP_INFO CMMGMT_CM_DHCP_INFO
 
typedef struct _CMMGMT_CM_DHCP_INFOPCMMGMT_CM_DHCP_INFO
 
typedef struct _CMMGMT_CM_IPV6DHCP_INFO CMMGMT_CM_IPV6DHCP_INFO
 
typedef struct _CMMGMT_CM_IPV6DHCP_INFOPCMMGMT_CM_IPV6DHCP_INFO
 
typedef struct _CMMGMT_DML_CPE_LIST CMMGMT_DML_CPE_LIST
 
typedef struct _CMMGMT_DML_CPE_LISTPCMMGMT_DML_CPE_LIST
 
typedef struct _DOCSIF31_CM_DS_OFDM_CHAN DOCSIF31_CM_DS_OFDM_CHAN
 
typedef struct _DOCSIF31_CM_DS_OFDM_CHANPDOCSIF31_CM_DS_OFDM_CHAN
 
typedef struct _DOCSIF31_CM_US_OFDMA_CHAN DOCSIF31_CM_US_OFDMA_CHAN
 
typedef struct _DOCSIF31_CM_US_OFDMA_CHANPDOCSIF31_CM_US_OFDMA_CHAN
 
typedef struct _DOCSIF31_CMSTATUSOFDMA_US DOCSIF31_CMSTATUSOFDMA_US
 
typedef struct _DOCSIF31_CMSTATUSOFDMA_USPDOCSIF31_CMSTATUSOFDMA_US
 
typedef struct _fixed_length_buffer fixed_length_buffer_t
 
typedef struct _snmpv3_kickstart_row snmp_kickstart_row_t
 
typedef struct _snmpv3_kickstart_table snmpv3_kickstart_table_t
 
typedef struct _CM_DIPLEXER_SETTINGS CM_DIPLEXER_SETTINGS
 

Data Structure Documentation

◆ _CMMGMT_CM_DS_CHANNEL

struct _CMMGMT_CM_DS_CHANNEL

Definition at line 181 of file cm_hal.h.

Collaboration diagram for _CMMGMT_CM_DS_CHANNEL:
Collaboration graph

Data Fields

unsigned long ChannelID
 
char Frequency [64]
 
char PowerLevel [64]
 
char SNRLevel [64]
 
char Modulation [64]
 
unsigned long Octets
 
unsigned long Correcteds
 
unsigned long Uncorrectables
 
char LockStatus [64]
 

Field Documentation

◆ ChannelID

unsigned long _CMMGMT_CM_DS_CHANNEL::ChannelID

Definition at line 185 of file cm_hal.h.

◆ Frequency

char _CMMGMT_CM_DS_CHANNEL::Frequency[64]

Definition at line 186 of file cm_hal.h.

◆ PowerLevel

char _CMMGMT_CM_DS_CHANNEL::PowerLevel[64]

Definition at line 187 of file cm_hal.h.

◆ SNRLevel

char _CMMGMT_CM_DS_CHANNEL::SNRLevel[64]

Definition at line 188 of file cm_hal.h.

◆ Modulation

char _CMMGMT_CM_DS_CHANNEL::Modulation[64]

Definition at line 189 of file cm_hal.h.

◆ Octets

unsigned long _CMMGMT_CM_DS_CHANNEL::Octets

Definition at line 190 of file cm_hal.h.

◆ Correcteds

unsigned long _CMMGMT_CM_DS_CHANNEL::Correcteds

Definition at line 191 of file cm_hal.h.

◆ Uncorrectables

unsigned long _CMMGMT_CM_DS_CHANNEL::Uncorrectables

Definition at line 192 of file cm_hal.h.

◆ LockStatus

char _CMMGMT_CM_DS_CHANNEL::LockStatus[64]

Definition at line 193 of file cm_hal.h.

◆ _CMMGMT_CM_US_CHANNEL

struct _CMMGMT_CM_US_CHANNEL

Definition at line 195 of file cm_hal.h.

Collaboration diagram for _CMMGMT_CM_US_CHANNEL:
Collaboration graph

Data Fields

unsigned long ChannelID
 
char Frequency [64]
 
char PowerLevel [64]
 
char ChannelType [64]
 
char SymbolRate [64]
 
char Modulation [64]
 
char LockStatus [64]
 

Field Documentation

◆ ChannelID

unsigned long _CMMGMT_CM_US_CHANNEL::ChannelID

Definition at line 197 of file cm_hal.h.

◆ Frequency

char _CMMGMT_CM_US_CHANNEL::Frequency[64]

Definition at line 198 of file cm_hal.h.

◆ PowerLevel

char _CMMGMT_CM_US_CHANNEL::PowerLevel[64]

Definition at line 199 of file cm_hal.h.

◆ ChannelType

char _CMMGMT_CM_US_CHANNEL::ChannelType[64]

Definition at line 200 of file cm_hal.h.

◆ SymbolRate

char _CMMGMT_CM_US_CHANNEL::SymbolRate[64]

Definition at line 201 of file cm_hal.h.

◆ Modulation

char _CMMGMT_CM_US_CHANNEL::Modulation[64]

Definition at line 202 of file cm_hal.h.

◆ LockStatus

char _CMMGMT_CM_US_CHANNEL::LockStatus[64]

Definition at line 203 of file cm_hal.h.

◆ _CMMGMT_CM_DOCSIS_INFO

struct _CMMGMT_CM_DOCSIS_INFO

Definition at line 207 of file cm_hal.h.

Collaboration diagram for _CMMGMT_CM_DOCSIS_INFO:
Collaboration graph

Data Fields

char DOCSISVersion [64]
 
char DOCSISDownstreamScanning [64]
 
char DOCSISDownstreamRanging [64]
 
char DOCSISUpstreamScanning [64]
 
char DOCSISUpstreamRanging [64]
 
char DOCSISTftpStatus [64]
 
char DOCSISDataRegComplete [64]
 
unsigned long DOCSISDHCPAttempts
 
char DOCSISConfigFileName [64]
 
unsigned long DOCSISTftpAttempts
 
char ToDStatus [64]
 
unsigned char BPIState
 
unsigned char NetworkAccess
 
union {
   unsigned char   Dot [4]
 
   uint32_t   Value
 
UpgradeServerIP
 
unsigned long MaxCpeAllowed
 
char UpstreamServiceFlowParams [64]
 
char DownstreamServiceFlowParams [64]
 
char DOCSISDownstreamDataRate [64]
 
char DOCSISUpstreamDataRate [64]
 
char CoreVersion [64]
 

Field Documentation

◆ DOCSISVersion

char _CMMGMT_CM_DOCSIS_INFO::DOCSISVersion[64]

Definition at line 210 of file cm_hal.h.

◆ DOCSISDownstreamScanning

char _CMMGMT_CM_DOCSIS_INFO::DOCSISDownstreamScanning[64]

Definition at line 211 of file cm_hal.h.

◆ DOCSISDownstreamRanging

char _CMMGMT_CM_DOCSIS_INFO::DOCSISDownstreamRanging[64]

Definition at line 212 of file cm_hal.h.

◆ DOCSISUpstreamScanning

char _CMMGMT_CM_DOCSIS_INFO::DOCSISUpstreamScanning[64]

Definition at line 213 of file cm_hal.h.

◆ DOCSISUpstreamRanging

char _CMMGMT_CM_DOCSIS_INFO::DOCSISUpstreamRanging[64]

Definition at line 214 of file cm_hal.h.

◆ DOCSISTftpStatus

char _CMMGMT_CM_DOCSIS_INFO::DOCSISTftpStatus[64]

Definition at line 215 of file cm_hal.h.

◆ DOCSISDataRegComplete

char _CMMGMT_CM_DOCSIS_INFO::DOCSISDataRegComplete[64]

Definition at line 216 of file cm_hal.h.

◆ DOCSISDHCPAttempts

unsigned long _CMMGMT_CM_DOCSIS_INFO::DOCSISDHCPAttempts

Definition at line 217 of file cm_hal.h.

◆ DOCSISConfigFileName

char _CMMGMT_CM_DOCSIS_INFO::DOCSISConfigFileName[64]

Definition at line 218 of file cm_hal.h.

◆ DOCSISTftpAttempts

unsigned long _CMMGMT_CM_DOCSIS_INFO::DOCSISTftpAttempts

Definition at line 219 of file cm_hal.h.

◆ ToDStatus

char _CMMGMT_CM_DOCSIS_INFO::ToDStatus[64]

Definition at line 220 of file cm_hal.h.

◆ BPIState

unsigned char _CMMGMT_CM_DOCSIS_INFO::BPIState

Definition at line 221 of file cm_hal.h.

◆ NetworkAccess

unsigned char _CMMGMT_CM_DOCSIS_INFO::NetworkAccess

Definition at line 222 of file cm_hal.h.

◆ Dot

unsigned char _CMMGMT_CM_DOCSIS_INFO::Dot[4]

Definition at line 223 of file cm_hal.h.

◆ Value

uint32_t _CMMGMT_CM_DOCSIS_INFO::Value

Definition at line 223 of file cm_hal.h.

◆ UpgradeServerIP

union { ... } _CMMGMT_CM_DOCSIS_INFO::UpgradeServerIP

◆ MaxCpeAllowed

unsigned long _CMMGMT_CM_DOCSIS_INFO::MaxCpeAllowed

Definition at line 224 of file cm_hal.h.

◆ UpstreamServiceFlowParams

char _CMMGMT_CM_DOCSIS_INFO::UpstreamServiceFlowParams[64]

Definition at line 225 of file cm_hal.h.

◆ DownstreamServiceFlowParams

char _CMMGMT_CM_DOCSIS_INFO::DownstreamServiceFlowParams[64]

Definition at line 226 of file cm_hal.h.

◆ DOCSISDownstreamDataRate

char _CMMGMT_CM_DOCSIS_INFO::DOCSISDownstreamDataRate[64]

Definition at line 227 of file cm_hal.h.

◆ DOCSISUpstreamDataRate

char _CMMGMT_CM_DOCSIS_INFO::DOCSISUpstreamDataRate[64]

Definition at line 228 of file cm_hal.h.

◆ CoreVersion

char _CMMGMT_CM_DOCSIS_INFO::CoreVersion[64]

Definition at line 229 of file cm_hal.h.

◆ _CMMGMT_CM_ERROR_CODEWORDS

struct _CMMGMT_CM_ERROR_CODEWORDS

Definition at line 233 of file cm_hal.h.

Collaboration diagram for _CMMGMT_CM_ERROR_CODEWORDS:
Collaboration graph

Data Fields

unsigned long UnerroredCodewords
 
unsigned long CorrectableCodewords
 
unsigned long UncorrectableCodewords
 

Field Documentation

◆ UnerroredCodewords

unsigned long _CMMGMT_CM_ERROR_CODEWORDS::UnerroredCodewords

Definition at line 235 of file cm_hal.h.

◆ CorrectableCodewords

unsigned long _CMMGMT_CM_ERROR_CODEWORDS::CorrectableCodewords

Definition at line 236 of file cm_hal.h.

◆ UncorrectableCodewords

unsigned long _CMMGMT_CM_ERROR_CODEWORDS::UncorrectableCodewords

Definition at line 237 of file cm_hal.h.

◆ CMMGMT_CM_EventLogEntry_t

struct CMMGMT_CM_EventLogEntry_t

Definition at line 260 of file cm_hal.h.

Collaboration diagram for CMMGMT_CM_EventLogEntry_t:
Collaboration graph

Data Fields

unsigned int docsDevEvIndex
 
struct timeval docsDevEvFirstTime
 
struct timeval docsDevEvLastTime
 
unsigned int docsDevEvCounts
 
unsigned int docsDevEvLevel
 
unsigned int docsDevEvId
 
char docsDevEvText [255]
 

Field Documentation

◆ docsDevEvIndex

unsigned int CMMGMT_CM_EventLogEntry_t::docsDevEvIndex

Definition at line 262 of file cm_hal.h.

◆ docsDevEvFirstTime

struct timeval CMMGMT_CM_EventLogEntry_t::docsDevEvFirstTime

Definition at line 263 of file cm_hal.h.

◆ docsDevEvLastTime

struct timeval CMMGMT_CM_EventLogEntry_t::docsDevEvLastTime

Definition at line 264 of file cm_hal.h.

◆ docsDevEvCounts

unsigned int CMMGMT_CM_EventLogEntry_t::docsDevEvCounts

Definition at line 265 of file cm_hal.h.

◆ docsDevEvLevel

unsigned int CMMGMT_CM_EventLogEntry_t::docsDevEvLevel

Definition at line 266 of file cm_hal.h.

◆ docsDevEvId

unsigned int CMMGMT_CM_EventLogEntry_t::docsDevEvId

Definition at line 267 of file cm_hal.h.

◆ docsDevEvText

char CMMGMT_CM_EventLogEntry_t::docsDevEvText[255]

Definition at line 268 of file cm_hal.h.

◆ _CMMGMT_DML_CM_LOG

struct _CMMGMT_DML_CM_LOG

Definition at line 272 of file cm_hal.h.

Collaboration diagram for _CMMGMT_DML_CM_LOG:
Collaboration graph

Data Fields

unsigned char EnableLog
 
unsigned char ClearDocsisLog
 

Field Documentation

◆ EnableLog

unsigned char _CMMGMT_DML_CM_LOG::EnableLog

Definition at line 274 of file cm_hal.h.

◆ ClearDocsisLog

unsigned char _CMMGMT_DML_CM_LOG::ClearDocsisLog

Definition at line 275 of file cm_hal.h.

◆ _CMMGMT_DML_DOCSISLOG_FULL

struct _CMMGMT_DML_DOCSISLOG_FULL

Definition at line 279 of file cm_hal.h.

Collaboration diagram for _CMMGMT_DML_DOCSISLOG_FULL:
Collaboration graph

Data Fields

unsigned long Index
 
unsigned long EventID
 
unsigned long EventLevel
 
char Time [64]
 
char Description [256]
 

Field Documentation

◆ Index

unsigned long _CMMGMT_DML_DOCSISLOG_FULL::Index

Definition at line 281 of file cm_hal.h.

◆ EventID

unsigned long _CMMGMT_DML_DOCSISLOG_FULL::EventID

Definition at line 282 of file cm_hal.h.

◆ EventLevel

unsigned long _CMMGMT_DML_DOCSISLOG_FULL::EventLevel

Definition at line 283 of file cm_hal.h.

◆ Time

char _CMMGMT_DML_DOCSISLOG_FULL::Time[64]

Definition at line 284 of file cm_hal.h.

◆ Description

char _CMMGMT_DML_DOCSISLOG_FULL::Description[256]

Definition at line 285 of file cm_hal.h.

◆ _CMMGMT_CM_DHCP_INFO

struct _CMMGMT_CM_DHCP_INFO

Definition at line 289 of file cm_hal.h.

Collaboration diagram for _CMMGMT_CM_DHCP_INFO:
Collaboration graph

Data Fields

union {
   unsigned char   Dot [4]
 
   uint32_t   Value
 
IPAddress
 
char BootFileName [64]
 
union {
   unsigned char   Dot [4]
 
   uint32_t   Value
 
SubnetMask
 
union {
   unsigned char   Dot [4]
 
   uint32_t   Value
 
Gateway
 
union {
   unsigned char   Dot [4]
 
   uint32_t   Value
 
TFTPServer
 
char TimeServer [64]
 
int TimeOffset
 
unsigned long LeaseTimeRemaining
 
char RebindTimeRemaining [64]
 
char RenewTimeRemaining [64]
 
char MACAddress [64]
 
char DOCSISDHCPStatus [64]
 

Field Documentation

◆ Dot

unsigned char _CMMGMT_CM_DHCP_INFO::Dot[4]

Definition at line 292 of file cm_hal.h.

◆ Value

uint32_t _CMMGMT_CM_DHCP_INFO::Value

Definition at line 292 of file cm_hal.h.

◆ IPAddress

union { ... } _CMMGMT_CM_DHCP_INFO::IPAddress

◆ BootFileName

char _CMMGMT_CM_DHCP_INFO::BootFileName[64]

Definition at line 293 of file cm_hal.h.

◆ SubnetMask

union { ... } _CMMGMT_CM_DHCP_INFO::SubnetMask

◆ Gateway

union { ... } _CMMGMT_CM_DHCP_INFO::Gateway

◆ TFTPServer

union { ... } _CMMGMT_CM_DHCP_INFO::TFTPServer

◆ TimeServer

char _CMMGMT_CM_DHCP_INFO::TimeServer[64]

Definition at line 297 of file cm_hal.h.

◆ TimeOffset

int _CMMGMT_CM_DHCP_INFO::TimeOffset

Definition at line 298 of file cm_hal.h.

◆ LeaseTimeRemaining

unsigned long _CMMGMT_CM_DHCP_INFO::LeaseTimeRemaining

Definition at line 299 of file cm_hal.h.

◆ RebindTimeRemaining

char _CMMGMT_CM_DHCP_INFO::RebindTimeRemaining[64]

Definition at line 300 of file cm_hal.h.

◆ RenewTimeRemaining

char _CMMGMT_CM_DHCP_INFO::RenewTimeRemaining[64]

Definition at line 301 of file cm_hal.h.

◆ MACAddress

char _CMMGMT_CM_DHCP_INFO::MACAddress[64]

Definition at line 302 of file cm_hal.h.

◆ DOCSISDHCPStatus

char _CMMGMT_CM_DHCP_INFO::DOCSISDHCPStatus[64]

Definition at line 303 of file cm_hal.h.

◆ _CMMGMT_CM_IPV6DHCP_INFO

struct _CMMGMT_CM_IPV6DHCP_INFO

Definition at line 307 of file cm_hal.h.

Collaboration diagram for _CMMGMT_CM_IPV6DHCP_INFO:
Collaboration graph

Data Fields

char IPv6Address [40]
 
char IPv6BootFileName [64]
 
char IPv6Prefix [40]
 
char IPv6Router [40]
 
char IPv6TFTPServer [40]
 
char IPv6TimeServer [40]
 
unsigned long IPv6LeaseTimeRemaining
 
unsigned long IPv6RebindTimeRemaining
 
unsigned long IPv6RenewTimeRemaining
 

Field Documentation

◆ IPv6Address

char _CMMGMT_CM_IPV6DHCP_INFO::IPv6Address[40]

Definition at line 310 of file cm_hal.h.

◆ IPv6BootFileName

char _CMMGMT_CM_IPV6DHCP_INFO::IPv6BootFileName[64]

Definition at line 311 of file cm_hal.h.

◆ IPv6Prefix

char _CMMGMT_CM_IPV6DHCP_INFO::IPv6Prefix[40]

Definition at line 312 of file cm_hal.h.

◆ IPv6Router

char _CMMGMT_CM_IPV6DHCP_INFO::IPv6Router[40]

Definition at line 313 of file cm_hal.h.

◆ IPv6TFTPServer

char _CMMGMT_CM_IPV6DHCP_INFO::IPv6TFTPServer[40]

Definition at line 314 of file cm_hal.h.

◆ IPv6TimeServer

char _CMMGMT_CM_IPV6DHCP_INFO::IPv6TimeServer[40]

Definition at line 315 of file cm_hal.h.

◆ IPv6LeaseTimeRemaining

unsigned long _CMMGMT_CM_IPV6DHCP_INFO::IPv6LeaseTimeRemaining

Definition at line 317 of file cm_hal.h.

◆ IPv6RebindTimeRemaining

unsigned long _CMMGMT_CM_IPV6DHCP_INFO::IPv6RebindTimeRemaining

Definition at line 318 of file cm_hal.h.

◆ IPv6RenewTimeRemaining

unsigned long _CMMGMT_CM_IPV6DHCP_INFO::IPv6RenewTimeRemaining

Definition at line 319 of file cm_hal.h.

◆ _CMMGMT_DML_CPE_LIST

struct _CMMGMT_DML_CPE_LIST

Definition at line 323 of file cm_hal.h.

Collaboration diagram for _CMMGMT_DML_CPE_LIST:
Collaboration graph

Data Fields

char IPAddress [32]
 
char MACAddress [32]
 

Field Documentation

◆ IPAddress

char _CMMGMT_DML_CPE_LIST::IPAddress[32]

Definition at line 326 of file cm_hal.h.

◆ MACAddress

char _CMMGMT_DML_CPE_LIST::MACAddress[32]

Definition at line 327 of file cm_hal.h.

◆ _DOCSIF31_CM_DS_OFDM_CHAN

struct _DOCSIF31_CM_DS_OFDM_CHAN

Definition at line 332 of file cm_hal.h.

Collaboration diagram for _DOCSIF31_CM_DS_OFDM_CHAN:
Collaboration graph

Data Fields

unsigned int ChannelId
 
unsigned int ChanIndicator
 
unsigned int SubcarrierZeroFreq
 
unsigned int FirstActiveSubcarrierNum
 
unsigned int LastActiveSubcarrierNum
 
unsigned int NumActiveSubcarriers
 
unsigned int SubcarrierSpacing
 
unsigned int CyclicPrefix
 
unsigned int RollOffPeriod
 
unsigned int PlcFreq
 
unsigned int NumPilots
 
unsigned int TimeInterleaverDepth
 
char averageSNR [64]
 
char PowerLevel [64]
 
unsigned long long PlcTotalCodewords
 
unsigned long long PlcUnreliableCodewords
 
unsigned long long NcpTotalFields
 
unsigned long long NcpFieldCrcFailures
 

Field Documentation

◆ ChannelId

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::ChannelId

The Cable Modem Termination System identification of the OFDM downstream channel within this particular MAC interface. if the interface is down, the object returns the most current value. If the downstream channel ID is unknown, this object returns a value of 0.

Definition at line 333 of file cm_hal.h.

◆ ChanIndicator

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::ChanIndicator

This data type defines the subcarrier spacing for the FFT mode in use. For downstream OFDM channels, if the FFT mode is 4K mode, then spacing is 50 kHz; if it is 8K mode, then the spacing is 25 kHz. For upstream OFDMA channels, if the FFT mode is 2K mode, then the spacing is 50kHz; if the mode is 4K mode, then the spacing is 25kHz. In units of kHz. other(1), primary(2), backupPrimary(3), nonPrimary(4)

Definition at line 334 of file cm_hal.h.

◆ SubcarrierZeroFreq

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::SubcarrierZeroFreq

The center frequency of the subcarrier 0 of the OFDM transmission. Note that since ubcarrier 0 is always excluded, it will actually be below the allowed downstream spectrum band. This is the frequency of subcarrier X(0) in the definition of the DFT.

Definition at line 336 of file cm_hal.h.

◆ FirstActiveSubcarrierNum

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::FirstActiveSubcarrierNum

The number of the first non-excluded subcarrier. The valid range is 148 to 7895

Definition at line 337 of file cm_hal.h.

◆ LastActiveSubcarrierNum

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::LastActiveSubcarrierNum

The number of the last non-excluded subcarrier. The valid range is 148 to 7895

Definition at line 338 of file cm_hal.h.

◆ NumActiveSubcarriers

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::NumActiveSubcarriers

The number of active data subcarriers within the OFDM downstream channel (i.e. this exclude subcarriers for continuous pilots and the PLC). For 4K FFT mode, the maximum number of subcarriers including continuous pilots and the PLC cannot exceed 3800, and for 8K FFT mode, the maximum number of active subcarriers including continuous pilots and the PLC cannot be greater than 7600. There are a minimum of 56 continuous pilots in a 192MHz channel that has no exclusions, and the size of the PLC is 8 subcarriers for 4K FFT mode and 16 subcarriers for 8K FFT mode. Therefore the maximum value of NumActiveSubcarriers is 3736 (or 3800 - 56 - 8) for 4K FFT mode and 7528 (or 7600 - 56 - 16) for 8K FFT mode.

Definition at line 339 of file cm_hal.h.

◆ SubcarrierSpacing

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::SubcarrierSpacing

The subcarrier spacing associated with a particular FFT mode configured on the OFDM downstream channel. If it is 4K mode, then the subcarrier spacing is 50kHz. If it is 8K mode, then the subcarrier spacing is 25kHz. in kHz

Definition at line 341 of file cm_hal.h.

◆ CyclicPrefix

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::CyclicPrefix

Cyclic prefix enables the receiver to overcome the effects of inter-symbol-interference and intercarrier-interference caused by micro-reflections in the channel. There are five possible alues for the length of the CP and the choice depends on the delay spread of the channel - a longer delay spread requires a longer cyclic prefix. The cyclic prefix (in usec) are converted into samples using the sample rate of 204.8 Msamples/s and is an integer multiple of: 1/64 * 20 us.

Definition at line 343 of file cm_hal.h.

◆ RollOffPeriod

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::RollOffPeriod

Roll off period maximizes channel capacity by sharpening the edges of the spectrum of the OFDM signal. For windowing purposes another segment at the start of the IDFT output is appended to the end of the IDFT output - the roll-off postfix (RP). There are five possible values for the (RP), and the choice depends on the bandwidth of the channel and the number of exclusion bands within the channel. A larger RP provides sharper edges in the spectrum of the OFDM signal; however, there is a time vs. frequency trade-off. Larger RP values reduce the efficiency of transmission in the time domain, but because the spectral edges are sharper, more useful subcarriers appear in the frequency domain. There is an optimum value for the RP that maximizes capacity for a given bandwidth and/or exclusion band scenario.

Definition at line 344 of file cm_hal.h.

◆ PlcFreq

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::PlcFreq

This is the PHY Link Channel (PLC) frequency. It is the center frequency of the lowest frequency subcarrier of the PLC. The aim of the PLC is for the CMTS to convey to the CM the physical properties of the OFDM channel

Definition at line 345 of file cm_hal.h.

◆ NumPilots

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::NumPilots

The number of continuous pilots configured for the OFDM downstream channel as received in the OCD message.

Definition at line 346 of file cm_hal.h.

◆ TimeInterleaverDepth

unsigned int _DOCSIF31_CM_DS_OFDM_CHAN::TimeInterleaverDepth

The time interleaving used for this downstream channel as received in the OCD message.

Definition at line 347 of file cm_hal.h.

◆ averageSNR

char _DOCSIF31_CM_DS_OFDM_CHAN::averageSNR[64]

The averageSNR value of this downstream channel

Definition at line 348 of file cm_hal.h.

◆ PowerLevel

char _DOCSIF31_CM_DS_OFDM_CHAN::PowerLevel[64]

The power level of this downstream channel

Definition at line 349 of file cm_hal.h.

◆ PlcTotalCodewords

unsigned long long _DOCSIF31_CM_DS_OFDM_CHAN::PlcTotalCodewords

The total number of PLC codewords received by the CM.

Definition at line 350 of file cm_hal.h.

◆ PlcUnreliableCodewords

unsigned long long _DOCSIF31_CM_DS_OFDM_CHAN::PlcUnreliableCodewords

The total number of PLC codewords which failed post-decoding LDPC syndrome check.

Definition at line 351 of file cm_hal.h.

◆ NcpTotalFields

unsigned long long _DOCSIF31_CM_DS_OFDM_CHAN::NcpTotalFields

The total number of NCP fields received by the CM.

Definition at line 352 of file cm_hal.h.

◆ NcpFieldCrcFailures

unsigned long long _DOCSIF31_CM_DS_OFDM_CHAN::NcpFieldCrcFailures

The total number of NCP fields received by the CM which failed the CRC check.

Definition at line 353 of file cm_hal.h.

◆ _DOCSIF31_CM_US_OFDMA_CHAN

struct _DOCSIF31_CM_US_OFDMA_CHAN

Definition at line 358 of file cm_hal.h.

Collaboration diagram for _DOCSIF31_CM_US_OFDMA_CHAN:
Collaboration graph

Data Fields

unsigned int ChannelId
 
unsigned int ConfigChangeCt
 
unsigned int SubcarrierZeroFreq
 
unsigned int FirstActiveSubcarrierNum
 
unsigned int LastActiveSubcarrierNum
 
unsigned int NumActiveSubcarriers
 
unsigned int SubcarrierSpacing
 
unsigned int CyclicPrefix
 
unsigned int RollOffPeriod
 
unsigned int NumSymbolsPerFrame
 
unsigned int TxPower
 
unsigned char PreEqEnabled
 

Field Documentation

◆ ChannelId

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::ChannelId

The Cable Modem identification of the OFDMA upstream channel within this particular MAC interface. If the interface is down, the object returns the most current value. If the upstream channel ID is unknown, this object returns a value of 0.

Definition at line 359 of file cm_hal.h.

◆ ConfigChangeCt

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::ConfigChangeCt

The value of the Configuration Change Count field in the Upstream Channel Descriptor (UCD) MAC Management Message corresponding to this OFDMA channel.

Definition at line 360 of file cm_hal.h.

◆ SubcarrierZeroFreq

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::SubcarrierZeroFreq

The lower edge frequency of the OFDMA upstream channel in Hz

Definition at line 361 of file cm_hal.h.

◆ FirstActiveSubcarrierNum

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::FirstActiveSubcarrierNum

The upper edge of the OFDMA upstream channel. The minimum channel width for an OFDMA upstream channel is 6.4 MHz in 4K mode and 10MHz in 2K mode. The valid range is 74 to 3947.

Definition at line 362 of file cm_hal.h.

◆ LastActiveSubcarrierNum

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::LastActiveSubcarrierNum

The last active subcarrier number. The valid range is 74 to 3947.

Definition at line 363 of file cm_hal.h.

◆ NumActiveSubcarriers

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::NumActiveSubcarriers

The number of active subcarriers within the OFDMA upstream channel. The valid range is 1 to 3800.

Definition at line 364 of file cm_hal.h.

◆ SubcarrierSpacing

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::SubcarrierSpacing

The subcarrier spacing associated with a particular FFT mode configured on the OFDMA upstream channel. If it is 2K mode, then the subcarrier spacing is 50kHz. If it is 4K mode, then the subcarrier spacing is 25kHz.

Definition at line 365 of file cm_hal.h.

◆ CyclicPrefix

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::CyclicPrefix

Cyclic prefix is added in order to enable the receiver to overcome the effects of inter-symbol interference (ISI) and inter-carrier interference caused by microreflections in the channel. The cyclic prefix (in usec) is converted into samples using the sample rate of 102.4 Msamples/s. There are eleven values for the length of the CP and the choice depends on the delay spread of the channel; a longer delay spread requires a longer cyclic prefix.

Definition at line 366 of file cm_hal.h.

◆ RollOffPeriod

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::RollOffPeriod

Windowing is applied in order to maximize channel capacity by sharpening the edges of the spectrum of the OFDMA signal. Windowing is applied in the time domain by tapering (or rolling off) the edges using a raised cosine function. There are eight possible values of roll-off prefix. The Roll-Off Period is given in us and in number of samples using the sample rate of 102.4 Msamples/s. The configuration where Roll-off prefix value is greater than or equal to cyclic prefix value is considered invalid.

Definition at line 367 of file cm_hal.h.

◆ NumSymbolsPerFrame

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::NumSymbolsPerFrame

The number of symbol periods per frame. For channel bandwidth greater than 72MHz, the maximum number of symbol periods per frame is 18 for 2K mode and 9 for 4K mode. For channel bandwidth less than 72 MHz but greater than 48MHz, the maximum number of symbols per frame is 24 for 2K mode and 12 for 4K mode. For channel bandwidth less than 48MHz, the maximum number of symbol periods is 36 for 2K mode and 18 for 4K mode. The minimum number of symbol periods per frame is 6 for both the FFT modes and is independent of the channel bandwidth.

Definition at line 368 of file cm_hal.h.

◆ TxPower

unsigned int _DOCSIF31_CM_US_OFDMA_CHAN::TxPower

The operational transmit power for the associated OFDMA upstream channel.The CM reports its Target Power, P1.6r_n as described in [PHYv3.1]. Valid values for this object are 68 to (213 + (4*(Pmax - 65 dBmV))), since 68 quarter dBmV represents the lowest Tx power value 17 dBmV and 213 represents the nearest quarter dBmV to the highest Tx power value 53.2 dBmV.

Definition at line 369 of file cm_hal.h.

◆ PreEqEnabled

unsigned char _DOCSIF31_CM_US_OFDMA_CHAN::PreEqEnabled

Whether pre-equalization is enabled on the associated OFDMA upstream channel.

Definition at line 370 of file cm_hal.h.

◆ _DOCSIF31_CMSTATUSOFDMA_US

struct _DOCSIF31_CMSTATUSOFDMA_US

Definition at line 373 of file cm_hal.h.

Collaboration diagram for _DOCSIF31_CMSTATUSOFDMA_US:
Collaboration graph

Data Fields

unsigned int ChannelId
 
unsigned int T3Timeouts
 
unsigned int T4Timeouts
 
unsigned int RangingAborteds
 
unsigned int T3Exceededs
 
unsigned char IsMuted
 
unsigned int RangingStatus
 

Field Documentation

◆ ChannelId

unsigned int _DOCSIF31_CMSTATUSOFDMA_US::ChannelId

Definition at line 375 of file cm_hal.h.

◆ T3Timeouts

unsigned int _DOCSIF31_CMSTATUSOFDMA_US::T3Timeouts

Definition at line 382 of file cm_hal.h.

◆ T4Timeouts

unsigned int _DOCSIF31_CMSTATUSOFDMA_US::T4Timeouts

Definition at line 383 of file cm_hal.h.

◆ RangingAborteds

unsigned int _DOCSIF31_CMSTATUSOFDMA_US::RangingAborteds

Definition at line 384 of file cm_hal.h.

◆ T3Exceededs

unsigned int _DOCSIF31_CMSTATUSOFDMA_US::T3Exceededs

Definition at line 386 of file cm_hal.h.

◆ IsMuted

unsigned char _DOCSIF31_CMSTATUSOFDMA_US::IsMuted

Definition at line 387 of file cm_hal.h.

◆ RangingStatus

unsigned int _DOCSIF31_CMSTATUSOFDMA_US::RangingStatus

Definition at line 388 of file cm_hal.h.

◆ _fixed_length_buffer

struct _fixed_length_buffer

Definition at line 396 of file cm_hal.h.

Collaboration diagram for _fixed_length_buffer:
Collaboration graph

Data Fields

unsigned short length
 
unsigned char * buffer
 

Field Documentation

◆ length

unsigned short _fixed_length_buffer::length

Definition at line 397 of file cm_hal.h.

◆ buffer

unsigned char* _fixed_length_buffer::buffer

Definition at line 398 of file cm_hal.h.

◆ _snmpv3_kickstart_row

struct _snmpv3_kickstart_row

Definition at line 401 of file cm_hal.h.

Collaboration diagram for _snmpv3_kickstart_row:
Collaboration graph

Data Fields

fixed_length_buffer_t security_name
 
fixed_length_buffer_t security_number
 

Field Documentation

◆ security_name

fixed_length_buffer_t _snmpv3_kickstart_row::security_name

Definition at line 402 of file cm_hal.h.

◆ security_number

fixed_length_buffer_t _snmpv3_kickstart_row::security_number

Definition at line 403 of file cm_hal.h.

◆ _snmpv3_kickstart_table

struct _snmpv3_kickstart_table

Definition at line 406 of file cm_hal.h.

Collaboration diagram for _snmpv3_kickstart_table:
Collaboration graph

Data Fields

unsigned char n_rows
 
snmp_kickstart_row_tkickstart_values [5]
 

Field Documentation

◆ n_rows

unsigned char _snmpv3_kickstart_table::n_rows

Definition at line 407 of file cm_hal.h.

◆ kickstart_values

snmp_kickstart_row_t* _snmpv3_kickstart_table::kickstart_values[5]

Definition at line 408 of file cm_hal.h.

◆ _CM_DIPLEXER_SETTINGS

struct _CM_DIPLEXER_SETTINGS

Definition at line 411 of file cm_hal.h.

Collaboration diagram for _CM_DIPLEXER_SETTINGS:
Collaboration graph

Data Fields

unsigned int usDiplexerSetting
 
unsigned int dsDiplexerSetting
 

Field Documentation

◆ usDiplexerSetting

unsigned int _CM_DIPLEXER_SETTINGS::usDiplexerSetting

Definition at line 414 of file cm_hal.h.

◆ dsDiplexerSetting

unsigned int _CM_DIPLEXER_SETTINGS::dsDiplexerSetting

Definition at line 415 of file cm_hal.h.

Macro Definition Documentation

◆ EVM_MAX_EVENT_TEXT

#define EVM_MAX_EVENT_TEXT   255

Definition at line 258 of file cm_hal.h.

◆ MAX_KICKSTART_ROWS

#define MAX_KICKSTART_ROWS   5

Definition at line 394 of file cm_hal.h.

Typedef Documentation

◆ CMMGMT_CM_DS_CHANNEL

◆ PCMMGMT_CM_DS_CHANNEL

◆ CMMGMT_CM_US_CHANNEL

◆ PCMMGMT_CM_US_CHANNEL

◆ CMMGMT_CM_DOCSIS_INFO

◆ PCMMGMT_CM_DOCSIS_INFO

◆ CMMGMT_CM_ERROR_CODEWORDS

◆ PCMMGMT_CM_ERROR_CODEWORDS

◆ CMMGMT_DML_CM_LOG

◆ PCMMGMT_DML_CM_LOG

◆ CMMGMT_DML_DOCSISLOG_FULL

◆ PCMMGMT_DML_DOCSISLOG_FULL

◆ CMMGMT_CM_DHCP_INFO

◆ PCMMGMT_CM_DHCP_INFO

◆ CMMGMT_CM_IPV6DHCP_INFO

◆ PCMMGMT_CM_IPV6DHCP_INFO

◆ CMMGMT_DML_CPE_LIST

◆ PCMMGMT_DML_CPE_LIST

◆ DOCSIF31_CM_DS_OFDM_CHAN

◆ PDOCSIF31_CM_DS_OFDM_CHAN

◆ DOCSIF31_CM_US_OFDMA_CHAN

◆ PDOCSIF31_CM_US_OFDMA_CHAN

◆ DOCSIF31_CMSTATUSOFDMA_US

◆ PDOCSIF31_CMSTATUSOFDMA_US

◆ fixed_length_buffer_t

◆ snmp_kickstart_row_t

◆ snmpv3_kickstart_table_t

◆ CM_DIPLEXER_SETTINGS