RDK-B
Data Structures | Macros | Typedefs | Enumerations
MOCA HAL Data Types
MoCA HAL

Description

Data Structures

struct  moca_cfg_t
 
struct  moca_static_info_t
 
struct  moca_dynamic_info_t
 
struct  moca_stats_t
 
struct  moca_mac_counters_t
 
struct  moca_aggregate_counters_t
 
struct  moca_cpe_t
 
struct  moca_associated_device_t
 
struct  moca_mesh_table_t
 
struct  moca_flow_table_t
 
struct  moca_assoc_pnc_info
 
struct  moca_scmod_stat_t
 
struct  moca_aca_cfg_t
 
struct  moca_aca_stat_t
 

Macros

#define kMoca_MaxCpeList   256
 
#define kMoca_MaxMocaNodes   16
 
#define MAC_PADDING   12
 
#define STATUS_INPROGRESS   -1
 
#define STATUS_NO_NODE   -2
 
#define STATUS_INVALID_PROBE   -3
 
#define STATUS_INVALID_CHAN   -4
 

Typedefs

typedef int(* moca_associatedDevice_callback) (unsigned long ifIndex, moca_associated_device_t *moca_dev)
 
typedef struct moca_assoc_pnc_info moca_assoc_pnc_info_t
 

Enumerations

enum  moca_if_status_t {
  IF_STATUS_Up = 1, IF_STATUS_Down, IF_STATUS_Unknown, IF_STATUS_Dormant,
  IF_STATUS_NotPresent, IF_STATUS_LowerLayerDown, IF_STATUS_Error
}
 
enum  PROBE_TYPE { PROBE_QUITE = 0, PROBE_EVM }
 

Data Structure Documentation

◆ moca_cfg_t

struct moca_cfg_t

Definition at line 181 of file moca_hal.h.

Collaboration diagram for moca_cfg_t:
Collaboration graph

Data Fields

unsigned long InstanceNumber
 
char Alias [64]
 
unsigned char bEnabled
 
unsigned char bPreferredNC
 
unsigned char PrivacyEnabledSetting
 
unsigned char FreqCurrentMaskSetting [128]
 
char KeyPassphrase [18]
 
int TxPowerLimit
 
unsigned long AutoPowerControlPhyRate
 
unsigned long BeaconPowerLimit
 
unsigned long MaxIngressBWThreshold
 
unsigned long MaxEgressBWThreshold
 
unsigned char Reset
 
unsigned char MixedMode
 
unsigned char ChannelScanning
 
unsigned char AutoPowerControlEnable
 
unsigned char EnableTabooBit
 
unsigned char NodeTabooMask [128]
 
unsigned char ChannelScanMask [128]
 

Field Documentation

◆ InstanceNumber

unsigned long moca_cfg_t::InstanceNumber

Instance Number when Multiple MoCA interfaces exist. 0 - In the case of only one interface.

Definition at line 184 of file moca_hal.h.

◆ Alias

char moca_cfg_t::Alias[64]

Set the Alias Name for the interface

Definition at line 185 of file moca_hal.h.

◆ bEnabled

unsigned char moca_cfg_t::bEnabled

Enable/Disable the interface.

Definition at line 186 of file moca_hal.h.

◆ bPreferredNC

unsigned char moca_cfg_t::bPreferredNC

Enable/Disable the Node's preference to be Network Coordinator

Definition at line 187 of file moca_hal.h.

◆ PrivacyEnabledSetting

unsigned char moca_cfg_t::PrivacyEnabledSetting

Enable/Disable Link Privacy. A Password is required when Privacy is enabled

Definition at line 188 of file moca_hal.h.

◆ FreqCurrentMaskSetting

unsigned char moca_cfg_t::FreqCurrentMaskSetting[128]

Set of Frequencies that should be used for forming network (bitmask)

Definition at line 189 of file moca_hal.h.

◆ KeyPassphrase

char moca_cfg_t::KeyPassphrase[18]

Privacy Password. This field is valid only if the Link Privacy is enabled.

Definition at line 190 of file moca_hal.h.

◆ TxPowerLimit

int moca_cfg_t::TxPowerLimit

Maximum Transmission Power allowed

Definition at line 191 of file moca_hal.h.

◆ AutoPowerControlPhyRate

unsigned long moca_cfg_t::AutoPowerControlPhyRate

AutoPowerControlPhyRate: PowerCtrlPhyTarget Used as a reference to achieve the PHY rate by adjusting power.

Definition at line 192 of file moca_hal.h.

◆ BeaconPowerLimit

unsigned long moca_cfg_t::BeaconPowerLimit

Maximum Transmission Power Allowed when transmitting Beacons

Definition at line 193 of file moca_hal.h.

◆ MaxIngressBWThreshold

unsigned long moca_cfg_t::MaxIngressBWThreshold

Maximum Ingress Bandwidth Thresholds

Definition at line 194 of file moca_hal.h.

◆ MaxEgressBWThreshold

unsigned long moca_cfg_t::MaxEgressBWThreshold

Maximum Egress Bandwidth Thresholds

Definition at line 195 of file moca_hal.h.

◆ Reset

unsigned char moca_cfg_t::Reset

Reset MoCA Configuration Parameters to Defaults

Definition at line 196 of file moca_hal.h.

◆ MixedMode

unsigned char moca_cfg_t::MixedMode

Enable/Disable the Node to operate in mixed mode (1.0/1.1/2.0 versions). i.e Enable backward compatibility on the MoCA Protocol Versions.

Definition at line 197 of file moca_hal.h.

◆ ChannelScanning

unsigned char moca_cfg_t::ChannelScanning

Enable/Disable the Node to operate in single frequency mode or scanning mode.

Definition at line 199 of file moca_hal.h.

◆ AutoPowerControlEnable

unsigned char moca_cfg_t::AutoPowerControlEnable

Enable/Disable adjusting Power to achieve the Target PHY rate

Definition at line 200 of file moca_hal.h.

◆ EnableTabooBit

unsigned char moca_cfg_t::EnableTabooBit

Enable/Disable the Node to support Taboo Mask

Definition at line 201 of file moca_hal.h.

◆ NodeTabooMask

unsigned char moca_cfg_t::NodeTabooMask[128]

Set of Frequencis to Avoid (bitmask)

Definition at line 202 of file moca_hal.h.

◆ ChannelScanMask

unsigned char moca_cfg_t::ChannelScanMask[128]

Set of Frequencies to Scan for Beacons to form network (bitmask). Very often, this is same as FreqCurrentMaskSetting.

Definition at line 203 of file moca_hal.h.

◆ moca_static_info_t

struct moca_static_info_t

Definition at line 205 of file moca_hal.h.

Collaboration diagram for moca_static_info_t:
Collaboration graph

Data Fields

char Name [64]
 
unsigned char MacAddress [6+12]
 
char FirmwareVersion [64]
 
unsigned long MaxBitRate
 
char HighestVersion [64]
 
unsigned char FreqCapabilityMask [8]
 
unsigned char NetworkTabooMask [128]
 
unsigned long TxBcastPowerReduction
 
unsigned char QAM256Capable
 
unsigned char PacketAggregationCapability
 

Field Documentation

◆ Name

char moca_static_info_t::Name[64]

< Interface Name (for example: moca0) Uniquely identifying the entry

Definition at line 207 of file moca_hal.h.

◆ MacAddress

unsigned char moca_static_info_t::MacAddress[6+ 12]

MAC Address of the Local Node

Definition at line 208 of file moca_hal.h.

◆ FirmwareVersion

char moca_static_info_t::FirmwareVersion[64]

Firmware Version of the MoCA Firmware

Definition at line 209 of file moca_hal.h.

◆ MaxBitRate

unsigned long moca_static_info_t::MaxBitRate

Maximum PHY Rate that the Node can support

Definition at line 210 of file moca_hal.h.

◆ HighestVersion

char moca_static_info_t::HighestVersion[64]

Highest Version of the MoCA Protocol that the Local Node Supports

Definition at line 211 of file moca_hal.h.

◆ FreqCapabilityMask

unsigned char moca_static_info_t::FreqCapabilityMask[8]

Frequencies that the Local Node supports (bitmask)

Definition at line 212 of file moca_hal.h.

◆ NetworkTabooMask

unsigned char moca_static_info_t::NetworkTabooMask[128]

Frequencies that the Local Node does not support (bitmask)

Definition at line 213 of file moca_hal.h.

◆ TxBcastPowerReduction

unsigned long moca_static_info_t::TxBcastPowerReduction

Beacon Backoff in dB

Definition at line 214 of file moca_hal.h.

◆ QAM256Capable

unsigned char moca_static_info_t::QAM256Capable

Local Node is QAM-256 Capable or Not

Definition at line 215 of file moca_hal.h.

◆ PacketAggregationCapability

unsigned char moca_static_info_t::PacketAggregationCapability

Local Node can aggregate Ethernet Packets for MoCA PDU transfers

Definition at line 216 of file moca_hal.h.

◆ moca_dynamic_info_t

struct moca_dynamic_info_t

Definition at line 220 of file moca_hal.h.

Collaboration diagram for moca_dynamic_info_t:
Collaboration graph

Data Fields

moca_if_status_t Status
 
unsigned long LastChange
 
unsigned long MaxIngressBW
 
unsigned long MaxEgressBW
 
char CurrentVersion [64]
 
unsigned long NetworkCoordinator
 
unsigned long NodeID
 
unsigned long BackupNC
 
unsigned char PrivacyEnabled
 
unsigned char FreqCurrentMask [8]
 
unsigned long CurrentOperFreq
 
unsigned long LastOperFreq
 
unsigned long TxBcastRate
 
unsigned char MaxIngressBWThresholdReached
 
unsigned char MaxEgressBWThresholdReached
 
unsigned long NumberOfConnectedClients
 
char NetworkCoordinatorMACAddress [18]
 
unsigned long LinkUpTime
 

Field Documentation

◆ Status

moca_if_status_t moca_dynamic_info_t::Status

< Current Status of the LoCAL Interface (Up/Down etc.)

Definition at line 222 of file moca_hal.h.

◆ LastChange

unsigned long moca_dynamic_info_t::LastChange

Last Link Status Change (Up/Down/ etc.)

Definition at line 223 of file moca_hal.h.

◆ MaxIngressBW

unsigned long moca_dynamic_info_t::MaxIngressBW

Maximum Ingress Bandwidth reached

Definition at line 224 of file moca_hal.h.

◆ MaxEgressBW

unsigned long moca_dynamic_info_t::MaxEgressBW

Maximum Egress Bandwidth reached

Definition at line 225 of file moca_hal.h.

◆ CurrentVersion

char moca_dynamic_info_t::CurrentVersion[64]

Current Operating MoCA Protocol Version Valid Values: 1.0, 1.1, 2.0

Definition at line 226 of file moca_hal.h.

◆ NetworkCoordinator

unsigned long moca_dynamic_info_t::NetworkCoordinator

Node ID of the Network Coordinator. Valid Values: 0-7 (Protocol: 1.0) Valid Values: 0-15 (Protocol: 1.1, 2.0)

Definition at line 227 of file moca_hal.h.

◆ NodeID

unsigned long moca_dynamic_info_t::NodeID

Node ID of the Local Node. Valid Values: 0-7 (Protocol: 1.0) Valid Values: 0-15 (Protocol: 1.1, 2.0)

Definition at line 230 of file moca_hal.h.

◆ BackupNC

unsigned long moca_dynamic_info_t::BackupNC

Node ID of the Backup Network Coordinator Valid Values: 0-7 (Protocol: 1.0) Valid Values: 0-15 (Protocol: 1.1, 2.0)

Definition at line 233 of file moca_hal.h.

◆ PrivacyEnabled

unsigned char moca_dynamic_info_t::PrivacyEnabled

If Privacy is enabled on the network

Definition at line 236 of file moca_hal.h.

◆ FreqCurrentMask

unsigned char moca_dynamic_info_t::FreqCurrentMask[8]

This should be same as the Configured Frequencies that the Node can operate

Definition at line 237 of file moca_hal.h.

◆ CurrentOperFreq

unsigned long moca_dynamic_info_t::CurrentOperFreq

The Current Frequency on which the Node formed the Network

Definition at line 238 of file moca_hal.h.

◆ LastOperFreq

unsigned long moca_dynamic_info_t::LastOperFreq

The Last Operating Frequency on which the Node formed the Network earlier

Definition at line 239 of file moca_hal.h.

◆ TxBcastRate

unsigned long moca_dynamic_info_t::TxBcastRate

Transmission Broadcast Rate

Definition at line 240 of file moca_hal.h.

◆ MaxIngressBWThresholdReached

unsigned char moca_dynamic_info_t::MaxIngressBWThresholdReached

Flag Indicating that the Ingress Bandwidth reached the Maximum Threshold Set

Definition at line 241 of file moca_hal.h.

◆ MaxEgressBWThresholdReached

unsigned char moca_dynamic_info_t::MaxEgressBWThresholdReached

Flag Indicating that the Egress Bandwidth reached the Maximum Threshold Set

Definition at line 242 of file moca_hal.h.

◆ NumberOfConnectedClients

unsigned long moca_dynamic_info_t::NumberOfConnectedClients

Number of Nodes on the MoCA Network

  • Cannot exceed the maximum supported by MoCA Protocol.

Definition at line 243 of file moca_hal.h.

◆ NetworkCoordinatorMACAddress

char moca_dynamic_info_t::NetworkCoordinatorMACAddress[18]

Network Coordinator MAC Address

Definition at line 245 of file moca_hal.h.

◆ LinkUpTime

unsigned long moca_dynamic_info_t::LinkUpTime

Indicate the length of time this node has been connected to the MoCA network with at least one other node

Definition at line 246 of file moca_hal.h.

◆ moca_stats_t

struct moca_stats_t

Definition at line 252 of file moca_hal.h.

Collaboration diagram for moca_stats_t:
Collaboration graph

Data Fields

unsigned long BytesSent
 
unsigned long BytesReceived
 
unsigned long PacketsSent
 
unsigned long PacketsReceived
 
unsigned long ErrorsSent
 
unsigned long ErrorsReceived
 
unsigned long UnicastPacketsSent
 
unsigned long UnicastPacketsReceived
 
unsigned long DiscardPacketsSent
 
unsigned long DiscardPacketsReceived
 
unsigned long MulticastPacketsSent
 
unsigned long MulticastPacketsReceived
 
unsigned long BroadcastPacketsSent
 
unsigned long BroadcastPacketsReceived
 
unsigned long UnknownProtoPacketsReceived
 
unsigned long ExtAggrAverageTx
 
unsigned long ExtAggrAverageRx
 

Field Documentation

◆ BytesSent

unsigned long moca_stats_t::BytesSent

Number of Bytes Sent & Received

Definition at line 253 of file moca_hal.h.

◆ BytesReceived

unsigned long moca_stats_t::BytesReceived

Number of Bytes Sent & Received

Definition at line 254 of file moca_hal.h.

◆ PacketsSent

unsigned long moca_stats_t::PacketsSent

Number of Packets Sent & Received

Definition at line 256 of file moca_hal.h.

◆ PacketsReceived

unsigned long moca_stats_t::PacketsReceived

Number of Packets Sent & Received

Definition at line 257 of file moca_hal.h.

◆ ErrorsSent

unsigned long moca_stats_t::ErrorsSent

Number of Errors in Sent & Received Packets

Definition at line 259 of file moca_hal.h.

◆ ErrorsReceived

unsigned long moca_stats_t::ErrorsReceived

Number of Errors in Sent & Received Packets

Definition at line 260 of file moca_hal.h.

◆ UnicastPacketsSent

unsigned long moca_stats_t::UnicastPacketsSent

Number of Unicast Packets Sent

Definition at line 262 of file moca_hal.h.

◆ UnicastPacketsReceived

unsigned long moca_stats_t::UnicastPacketsReceived

Number of Unicast Packets Received

Definition at line 263 of file moca_hal.h.

◆ DiscardPacketsSent

unsigned long moca_stats_t::DiscardPacketsSent

Number of Packets Discard (Tx side)

Definition at line 265 of file moca_hal.h.

◆ DiscardPacketsReceived

unsigned long moca_stats_t::DiscardPacketsReceived

Number of Packets Discard (Rx side)

Definition at line 266 of file moca_hal.h.

◆ MulticastPacketsSent

unsigned long moca_stats_t::MulticastPacketsSent

Number of Multicast Packets Sent

Definition at line 268 of file moca_hal.h.

◆ MulticastPacketsReceived

unsigned long moca_stats_t::MulticastPacketsReceived

Number of Multicast Packets Received

Definition at line 269 of file moca_hal.h.

◆ BroadcastPacketsSent

unsigned long moca_stats_t::BroadcastPacketsSent

Number of Broadcast Packets Sent

Definition at line 271 of file moca_hal.h.

◆ BroadcastPacketsReceived

unsigned long moca_stats_t::BroadcastPacketsReceived

Number of Broadcast Packets Received

Definition at line 272 of file moca_hal.h.

◆ UnknownProtoPacketsReceived

unsigned long moca_stats_t::UnknownProtoPacketsReceived

Number of Unknown Protocol Packets Received

Definition at line 274 of file moca_hal.h.

◆ ExtAggrAverageTx

unsigned long moca_stats_t::ExtAggrAverageTx

Aggregate Averages of Packet Counts (Tx)

Definition at line 276 of file moca_hal.h.

◆ ExtAggrAverageRx

unsigned long moca_stats_t::ExtAggrAverageRx

Aggregate Averages of Packet Counts (Rx)

Definition at line 277 of file moca_hal.h.

◆ moca_mac_counters_t

struct moca_mac_counters_t

Definition at line 281 of file moca_hal.h.

Collaboration diagram for moca_mac_counters_t:
Collaboration graph

Data Fields

unsigned long Map
 
unsigned long Rsrv
 
unsigned long Lc
 
unsigned long Adm
 
unsigned long Probe
 
unsigned long Async
 

Field Documentation

◆ Map

unsigned long moca_mac_counters_t::Map

Number of MAP packets

Definition at line 282 of file moca_hal.h.

◆ Rsrv

unsigned long moca_mac_counters_t::Rsrv

Number of Reservation Request Packets

Definition at line 283 of file moca_hal.h.

◆ Lc

unsigned long moca_mac_counters_t::Lc

Number of Link Control Packets

Definition at line 284 of file moca_hal.h.

◆ Adm

unsigned long moca_mac_counters_t::Adm

Number of Admission Request Packets

Definition at line 285 of file moca_hal.h.

◆ Probe

unsigned long moca_mac_counters_t::Probe

Number of Probes

Definition at line 286 of file moca_hal.h.

◆ Async

unsigned long moca_mac_counters_t::Async

Number of Beacons

Definition at line 287 of file moca_hal.h.

◆ moca_aggregate_counters_t

struct moca_aggregate_counters_t

Definition at line 290 of file moca_hal.h.

Collaboration diagram for moca_aggregate_counters_t:
Collaboration graph

Data Fields

unsigned long Tx
 
unsigned long Rx
 

Field Documentation

◆ Tx

unsigned long moca_aggregate_counters_t::Tx

Aggregate Tx Payload Data Units (Not MoCA Control Packets).

Definition at line 291 of file moca_hal.h.

◆ Rx

unsigned long moca_aggregate_counters_t::Rx

Aggregate Rx Payload Data Units (Not MoCA Control Packets).

Definition at line 292 of file moca_hal.h.

◆ moca_cpe_t

struct moca_cpe_t

Definition at line 295 of file moca_hal.h.

Collaboration diagram for moca_cpe_t:
Collaboration graph

Data Fields

char mac_addr [6]
 

Field Documentation

◆ mac_addr

char moca_cpe_t::mac_addr[6]

MAC Address of the Node

Definition at line 296 of file moca_hal.h.

◆ moca_associated_device_t

struct moca_associated_device_t

Definition at line 299 of file moca_hal.h.

Collaboration diagram for moca_associated_device_t:
Collaboration graph

Data Fields

unsigned char MACAddress [6+12]
 
unsigned long NodeID
 
unsigned char PreferredNC
 
char HighestVersion [64]
 
unsigned long PHYTxRate
 
unsigned long PHYRxRate
 
unsigned long TxPowerControlReduction
 
int RxPowerLevel
 
unsigned long TxBcastRate
 
int RxBcastPowerLevel
 
unsigned long TxPackets
 
unsigned long RxPackets
 
unsigned long RxErroredAndMissedPackets
 
unsigned char QAM256Capable
 
unsigned char PacketAggregationCapability
 
unsigned long RxSNR
 
unsigned char Active
 
unsigned long RxBcastRate
 
unsigned long NumberOfClients
 

Field Documentation

◆ MACAddress

unsigned char moca_associated_device_t::MACAddress[6+ 12]

< This Data Structure corresponds to information of the associated device on the network. The term 'this Node' pertains to that particulard device for which the information in this data structure is valid MAC Address of the Associated Device

Definition at line 306 of file moca_hal.h.

◆ NodeID

unsigned long moca_associated_device_t::NodeID

Node ID of the Associated Device

Definition at line 307 of file moca_hal.h.

◆ PreferredNC

unsigned char moca_associated_device_t::PreferredNC

Whether this Node is a Preferred NC.

Definition at line 308 of file moca_hal.h.

◆ HighestVersion

char moca_associated_device_t::HighestVersion[64]

Highest MoCA Protocol Version that this Node supports

Definition at line 309 of file moca_hal.h.

◆ PHYTxRate

unsigned long moca_associated_device_t::PHYTxRate

Tx PHY Rate of this Node

Definition at line 310 of file moca_hal.h.

◆ PHYRxRate

unsigned long moca_associated_device_t::PHYRxRate

Rx PHY Rate of this Node

Definition at line 311 of file moca_hal.h.

◆ TxPowerControlReduction

unsigned long moca_associated_device_t::TxPowerControlReduction

Tx Power Reduced by this Node

Definition at line 312 of file moca_hal.h.

◆ RxPowerLevel

int moca_associated_device_t::RxPowerLevel

Rx Power Level read by this Node

Definition at line 313 of file moca_hal.h.

◆ TxBcastRate

unsigned long moca_associated_device_t::TxBcastRate

Tx Broadcast PHY Rate

Definition at line 314 of file moca_hal.h.

◆ RxBcastPowerLevel

int moca_associated_device_t::RxBcastPowerLevel

Rx Broadcast Power Level read by this Node

Definition at line 315 of file moca_hal.h.

◆ TxPackets

unsigned long moca_associated_device_t::TxPackets

Number of Transmitted Packets from this Node

Definition at line 316 of file moca_hal.h.

◆ RxPackets

unsigned long moca_associated_device_t::RxPackets

Number of Recieved Packets by this Node

Definition at line 317 of file moca_hal.h.

◆ RxErroredAndMissedPackets

unsigned long moca_associated_device_t::RxErroredAndMissedPackets

Number of (Rx) Error or Missed Packets by this Node

Definition at line 318 of file moca_hal.h.

◆ QAM256Capable

unsigned char moca_associated_device_t::QAM256Capable

Flag if this Node is capable of QAM-256

Definition at line 319 of file moca_hal.h.

◆ PacketAggregationCapability

unsigned char moca_associated_device_t::PacketAggregationCapability

Flag if this Node is capable of Packet Aggregation

Definition at line 320 of file moca_hal.h.

◆ RxSNR

unsigned long moca_associated_device_t::RxSNR

Receive Signal to Noise Ration

Definition at line 321 of file moca_hal.h.

◆ Active

unsigned char moca_associated_device_t::Active

Flag if this Node is Active

Definition at line 322 of file moca_hal.h.

◆ RxBcastRate

unsigned long moca_associated_device_t::RxBcastRate

Recevie Broadcast PHY Rate

Definition at line 323 of file moca_hal.h.

◆ NumberOfClients

unsigned long moca_associated_device_t::NumberOfClients

Number of Clients connected to this Node

Definition at line 324 of file moca_hal.h.

◆ moca_mesh_table_t

struct moca_mesh_table_t

Definition at line 328 of file moca_hal.h.

Collaboration diagram for moca_mesh_table_t:
Collaboration graph

Data Fields

unsigned long RxNodeID
 
unsigned long TxNodeID
 
unsigned long TxRate
 
unsigned long TxRateNper
 
unsigned long TxRateVlper
 

Field Documentation

◆ RxNodeID

unsigned long moca_mesh_table_t::RxNodeID

< This data structure represents teh MoCA mesh PHY rate table. This table contains the unicast transmit PHY rate between all pair of nodes in the MoCA Network. The node ID of the receive MoCA node is used as one of the index to order the mesh PHY rate table.

Definition at line 333 of file moca_hal.h.

◆ TxNodeID

unsigned long moca_mesh_table_t::TxNodeID

The node ID of the transmit MoCA node is used as one of the index to order the mesh PHY rate table.

Definition at line 336 of file moca_hal.h.

◆ TxRate

unsigned long moca_mesh_table_t::TxRate

Indicate the transmit PHY rate in Mbps from the MoCA node identified by 'mocaMeshTxNodeIndex' to the MoCA node identified by 'mocaMeshRxNodeIndex'.

Definition at line 339 of file moca_hal.h.

◆ TxRateNper

unsigned long moca_mesh_table_t::TxRateNper

Only for MoCA 2.x

Definition at line 342 of file moca_hal.h.

◆ TxRateVlper

unsigned long moca_mesh_table_t::TxRateVlper

Only for MoCA 2.x

Definition at line 343 of file moca_hal.h.

◆ moca_flow_table_t

struct moca_flow_table_t

Definition at line 348 of file moca_hal.h.

Collaboration diagram for moca_flow_table_t:
Collaboration graph

Data Fields

unsigned long FlowID
 
unsigned long IngressNodeID
 
unsigned long EgressNodeID
 
unsigned long FlowTimeLeft
 
char DestinationMACAddress [18]
 
unsigned long PacketSize
 
unsigned long PeakDataRate
 
unsigned long BurstSize
 
unsigned long FlowTag
 
unsigned long LeaseTime
 

Field Documentation

◆ FlowID

unsigned long moca_flow_table_t::FlowID

< This Data Structure respresents the MoCA interface flow statistics table. This table provides statistics of ingress PQoS flow in the MoCA interface. Indicate the flow ID of a PQoS flow.

Definition at line 353 of file moca_hal.h.

◆ IngressNodeID

unsigned long moca_flow_table_t::IngressNodeID

Indicate the flow ID of a Ingress PQoS flow.

Definition at line 354 of file moca_hal.h.

◆ EgressNodeID

unsigned long moca_flow_table_t::EgressNodeID

Indicate the flow ID of a Egress PQoS flow.

Definition at line 355 of file moca_hal.h.

◆ FlowTimeLeft

unsigned long moca_flow_table_t::FlowTimeLeft

Indicate the LEASE_TIME_LEFT of the PQoS flow identified by 'mocaIfFlowID' in which this MoCA interface is an ingress node for this PQoS flow.

Definition at line 356 of file moca_hal.h.

◆ DestinationMACAddress

char moca_flow_table_t::DestinationMACAddress[18]

Indicate the Destination Address (DA) of Ethernet packets of the PQoS Flow for which this node is the ingress node

Definition at line 358 of file moca_hal.h.

◆ PacketSize

unsigned long moca_flow_table_t::PacketSize

Indicate the number of MoCA aggregation MoCA frames.

Definition at line 360 of file moca_hal.h.

◆ PeakDataRate

unsigned long moca_flow_table_t::PeakDataRate

Indicate the T_PEAK_DATA_RATE of the PQoS flow identified by 'mocaIfFlowID' in which this MoCA interface is an ingress node for the PQoS flow.

Definition at line 361 of file moca_hal.h.

◆ BurstSize

unsigned long moca_flow_table_t::BurstSize

Indicate the T_BURST_SIZE of the PQoS flow identified by 'mocaIfFlowID' in which this MoCA interface is an ingress node for this PQoS flow.

Definition at line 363 of file moca_hal.h.

◆ FlowTag

unsigned long moca_flow_table_t::FlowTag

Indicate the FLOW_TAG of the PQoS flow identified by 'mocaIfFlowID' in which this MoCA interface is an ingress node for this PQoS flow. The FLOW_TAG carries application specific content of this PQoS flow.

Definition at line 365 of file moca_hal.h.

◆ LeaseTime

unsigned long moca_flow_table_t::LeaseTime

Indicate the T_LEASE_TIME of the PQoS flow identified by 'mocaIfFlowID' in which this MoCA interface is an ingress node for this PQoS flow.

Definition at line 367 of file moca_hal.h.

◆ moca_assoc_pnc_info

struct moca_assoc_pnc_info

Definition at line 373 of file moca_hal.h.

Collaboration diagram for moca_assoc_pnc_info:
Collaboration graph

Data Fields

unsigned long mocaNodeIndex
 
unsigned char mocaNodePreferredNC
 
unsigned long mocaNodeMocaversion
 

Field Documentation

◆ mocaNodeIndex

unsigned long moca_assoc_pnc_info::mocaNodeIndex

The index of this node

Definition at line 374 of file moca_hal.h.

◆ mocaNodePreferredNC

unsigned char moca_assoc_pnc_info::mocaNodePreferredNC

Whether this Node is a Preferred NC.

Definition at line 375 of file moca_hal.h.

◆ mocaNodeMocaversion

unsigned long moca_assoc_pnc_info::mocaNodeMocaversion

The MoCA version of this node

Definition at line 376 of file moca_hal.h.

◆ moca_scmod_stat_t

struct moca_scmod_stat_t

Definition at line 380 of file moca_hal.h.

Collaboration diagram for moca_scmod_stat_t:
Collaboration graph

Data Fields

int TxNode
 
int RxNode
 
int Channel
 
unsigned char Mod [512]
 
unsigned char Nper [512]
 
unsigned char Vlper [512]
 

Field Documentation

◆ TxNode

int moca_scmod_stat_t::TxNode

The NODE ID of Transmit MOCA NODE.

Definition at line 381 of file moca_hal.h.

◆ RxNode

int moca_scmod_stat_t::RxNode

The Node ID of Receive MOCA Node.

Definition at line 382 of file moca_hal.h.

◆ Channel

int moca_scmod_stat_t::Channel

The Primary channel or Secondary channel used to calculate the NPER and VLPER

Definition at line 383 of file moca_hal.h.

◆ Mod

unsigned char moca_scmod_stat_t::Mod[512]

Subcarrier MODULATION used to calcuate the NPER and VLPER between two nodes

Definition at line 384 of file moca_hal.h.

◆ Nper

unsigned char moca_scmod_stat_t::Nper[512]

Each NPER of between two nodes on Corresponding Channel

Definition at line 385 of file moca_hal.h.

◆ Vlper

unsigned char moca_scmod_stat_t::Vlper[512]

Each Vlper of between two nodes on Corresponding Channel

Definition at line 386 of file moca_hal.h.

◆ moca_aca_cfg_t

struct moca_aca_cfg_t

Definition at line 390 of file moca_hal.h.

Collaboration diagram for moca_aca_cfg_t:
Collaboration graph

Data Fields

unsigned int NodeID
 
PROBE_TYPE Type
 
unsigned int Channel
 
unsigned int ReportNodes
 
unsigned char ACAStart
 

Field Documentation

◆ NodeID

unsigned int moca_aca_cfg_t::NodeID

The NodeID where we want to start the ACA testing

Definition at line 391 of file moca_hal.h.

◆ Type

PROBE_TYPE moca_aca_cfg_t::Type

The Probe Type could be Enum EVM=1 or Quite=0

Definition at line 392 of file moca_hal.h.

◆ Channel

unsigned int moca_aca_cfg_t::Channel

The Channel on which ACA test should start

Definition at line 393 of file moca_hal.h.

◆ ReportNodes

unsigned int moca_aca_cfg_t::ReportNodes

Specifies the MoCA Nodes that are requested to be part of the channel assessment: Setting bits corresponding to Node IDs of these MoCA Nodes to 1 (LSB corresponds to Node ID 0x0). For example: 0000 0000 0000 0101 can be represented as 0x0005, Node 0 and Node 2.

Definition at line 394 of file moca_hal.h.

◆ ACAStart

unsigned char moca_aca_cfg_t::ACAStart

The ACAStart will indiacte to start the ACA process or not. 0 for no action , 1 for config and start the process

Definition at line 398 of file moca_hal.h.

◆ moca_aca_stat_t

struct moca_aca_stat_t

Definition at line 403 of file moca_hal.h.

Collaboration diagram for moca_aca_stat_t:
Collaboration graph

Data Fields

moca_aca_cfg_t acaCfg
 
int stat
 
int RxPower
 
int ACAPowProfile [512]
 
unsigned char ACATrapCompleted
 

Field Documentation

◆ acaCfg

moca_aca_cfg_t moca_aca_stat_t::acaCfg

the current configuration on ACA process started

Definition at line 404 of file moca_hal.h.

◆ stat

int moca_aca_stat_t::stat

SUCCESS=0, Fail-BADCHANNEL=1,Fail-NoEVMPROBE=2, Fail=3,In-Progress=4

Definition at line 405 of file moca_hal.h.

◆ RxPower

int moca_aca_stat_t::RxPower

Total RX Power in DBM

Definition at line 406 of file moca_hal.h.

◆ ACAPowProfile

int moca_aca_stat_t::ACAPowProfile[512]

Power Profile Representation for each channel

Definition at line 407 of file moca_hal.h.

◆ ACATrapCompleted

unsigned char moca_aca_stat_t::ACATrapCompleted

mocaIfAcaStatusTrapCompleted ReadOnly parameter, it will be TRUE when PowerPorfile is ready

Definition at line 408 of file moca_hal.h.

Macro Definition Documentation

◆ kMoca_MaxCpeList

#define kMoca_MaxCpeList   256

Definition at line 137 of file moca_hal.h.

◆ kMoca_MaxMocaNodes

#define kMoca_MaxMocaNodes   16

Definition at line 138 of file moca_hal.h.

◆ MAC_PADDING

#define MAC_PADDING   12

RDKB expects 6 byte MAC, padding required for platforms handling as 18 bytes MAC

Definition at line 139 of file moca_hal.h.

◆ STATUS_INPROGRESS

#define STATUS_INPROGRESS   -1

If ACA process already running

Definition at line 141 of file moca_hal.h.

◆ STATUS_NO_NODE

#define STATUS_NO_NODE   -2

If specified NODE not exist

Definition at line 142 of file moca_hal.h.

◆ STATUS_INVALID_PROBE

#define STATUS_INVALID_PROBE   -3

If HAL API called with invalid probe TYPE

Definition at line 143 of file moca_hal.h.

◆ STATUS_INVALID_CHAN

#define STATUS_INVALID_CHAN   -4

If HAL API called with invalid channel

Definition at line 144 of file moca_hal.h.

Typedef Documentation

◆ moca_associatedDevice_callback

typedef int( * moca_associatedDevice_callback) (unsigned long ifIndex, moca_associated_device_t *moca_dev)

Definition at line 371 of file moca_hal.h.

◆ moca_assoc_pnc_info_t

typedef struct moca_assoc_pnc_info moca_assoc_pnc_info_t

Enumeration Type Documentation

◆ moca_if_status_t

enum moca_if_status_t
Enumerator
IF_STATUS_Up 
IF_STATUS_Down 
IF_STATUS_Unknown 
IF_STATUS_Dormant 
IF_STATUS_NotPresent 
IF_STATUS_LowerLayerDown 
IF_STATUS_Error 

Definition at line 150 of file moca_hal.h.

◆ PROBE_TYPE

enum PROBE_TYPE
Enumerator
PROBE_QUITE 
PROBE_EVM 

Definition at line 162 of file moca_hal.h.