MoCA HAL SoC APIs

Description

Functions
RMH_Result	RMH_Self_GetEnabled (const RMH_Handle handle, bool *response)
	Return if the MoCA driver is actively connected to or attempting to connect to a MoCA network. More...
RMH_Result	RMH_Self_SetEnabled (const RMH_Handle handle, const bool value)
	Enable or disable the MoCA driver to connect to a MoCA network. Once enabled the driver will use whatever parameters it has been configured for. More...
RMH_Result	RMH_Self_GetMoCALinkUp (const RMH_Handle handle, bool *response)
	Check if this device is actively connected to a MoCA network. If so, RMH_Network and RMH_Remote APIs will then be valid to call. More...
RMH_Result	RMH_Self_GetLOF (const RMH_Handle handle, uint32_t *response)
	The last frequency on which this device operated. More...
RMH_Result	RMH_Self_SetLOF (const RMH_Handle handle, const uint32_t value)
	Manually set the last operating frequency of the device. More...
RMH_Result	RMH_Self_GetScanLOFOnly (const RMH_Handle handle, bool *response)
	Return if the device is scanning only the last operating frequency when attempting to establish a connection to a MoCA network. More...
RMH_Result	RMH_Self_SetScanLOFOnly (const RMH_Handle handle, const bool value)
	Indicate if the device should join networks only on the last operating frequency. More...
RMH_Result	RMH_Self_GetPreferredNCEnabled (const RMH_Handle handle, bool *response)
	Return if this device is a preferred NC. More...
RMH_Result	RMH_Self_SetPreferredNCEnabled (const RMH_Handle handle, const bool value)
	Enable or disable preferred NC on this device. More...
RMH_Result	RMH_Self_GetPrimaryChannelOffset (const RMH_Handle handle, int32_t *response)
	TBD [mocaIfPrimaryChannelOffset]. More...
RMH_Result	RMH_Self_SetPrimaryChannelOffset (const RMH_Handle handle, const int32_t value)
	TBD [mocaIfSecondaryChannelOffset]. More...
RMH_Result	RMH_Self_GetSecondaryChannelOffset (const RMH_Handle handle, int32_t *response)
	TBD [mocaIfSecondaryChannelOffset]. More...
RMH_Result	RMH_Self_SetSecondaryChannelOffset (const RMH_Handle handle, const int32_t value)
	TBD [mocaIfSecondaryChannelOffset]. More...
RMH_Result	RMH_Self_GetSoftwareVersion (const RMH_Handle handle, char *responseBuf, const size_t responseBufSize)
	Return the version of software being used by the MoCA driver on this device. [mocaIfSoftwareVersion]. More...
RMH_Result	RMH_Self_GetHighestSupportedMoCAVersion (const RMH_Handle handle, RMH_MoCAVersion *response)
	Return the highest version of MoCA supported by the MoCA driver on this device. [mocaIfMocaVersion]. More...
RMH_Result	RMH_Self_GetFrequencyMask (const RMH_Handle handle, uint32_t *response)
	Gets the bit mask of frequencies the device used during the listening phase of network search. More...
RMH_Result	RMH_Self_SetFrequencyMask (const RMH_Handle handle, const uint32_t value)
	Set the bit mask for specifying which frequencies should be scanned during the listening phase of network search. More...
RMH_Result	RMH_Self_GetMaxPacketAggregation (const RMH_Handle handle, uint32_t *response)
	Get the maximum number of packets this device will aggregate. More...
RMH_Result	RMH_Self_SetMaxPacketAggregation (const RMH_Handle handle, const uint32_t value)
	Set the maximum allowed packets for aggregated transmissions. More...
RMH_Result	RMH_Self_GetMaxFrameSize (const RMH_Handle handle, uint32_t *response)
	The maximum number of bytes this node can receive in one frame. More...
RMH_Result	RMH_Self_SetMaxFrameSize (const RMH_Handle handle, const uint32_t value)
	Set the maximum number of bytes this node can receive in one frame (aggregated transmission). More...
RMH_Result	RMH_Self_GetLowBandwidthLimit (const RMH_Handle handle, uint32_t *response)
	Get the current lower limit for PHY rate between two nodes. More...
RMH_Result	RMH_Self_SetLowBandwidthLimit (const RMH_Handle handle, const uint32_t value)
	Set the lower threshold for the PHY link bandwidth between two nodes. More...
RMH_Result	RMH_Self_GetMaxBitrate (const RMH_Handle handle, uint32_t *response)
	The maximum PHY rate supported in non-turbo mode. More...
RMH_Result	RMH_Self_SetTxPowerLimit (const RMH_Handle handle, const int32_t value)
	Set the maximum transmitter power level for this device. More...
RMH_Result	RMH_Self_GetTxPowerLimit (const RMH_Handle handle, int32_t *response)
	Returns the maximum transmitter power level for this device. More...
RMH_Result	RMH_Self_GetSupportedFrequencies (const RMH_Handle handle, uint32_t *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return a list of frequencies in the band used by this node. More...
RMH_Result	RMH_Self_GetSupportedBand (const RMH_Handle handle, RMH_Band *response)
	Return the band supported by the MoCA device. [mocaIfSupportedBands]. More...
RMH_Result	RMH_Self_GetQAM256Enabled (const RMH_Handle handle, bool *response)
	Return if this device is set as QAM256 capable in admission negotiations. More...
RMH_Result	RMH_Self_SetQAM256Enabled (const RMH_Handle handle, const bool value)
	Enable or disable the QAM256 ability in admission negotiations. More...
RMH_Result	RMH_Self_GetQAM256TargetPhyRate (const RMH_Handle handle, uint32_t *response)
	Get the target PHY rate in Mbps. More...
RMH_Result	RMH_Self_SetQAM256TargetPhyRate (const RMH_Handle handle, const uint32_t value)
	Set the target PHY rate in Mbps. More...
RMH_Result	RMH_Self_GetTurboEnabled (const RMH_Handle handle, bool *response)
	Return if turbo mode is enabled on this device. More...
RMH_Result	RMH_Self_SetTurboEnabled (const RMH_Handle handle, const bool value)
	Enable or disable turbo mode on this device. More...
RMH_Result	RMH_Self_GetBondingEnabled (const RMH_Handle handle, bool *response)
	Return if bonding mode is enabled on this device. More...
RMH_Result	RMH_Self_SetBondingEnabled (const RMH_Handle handle, const bool value)
	Enable or disable bonding mode on this device. More...
RMH_Result	RMH_Self_GetPrivacyEnabled (const RMH_Handle handle, bool *response)
	Return if MoCA privacy is enabled on this device. More...
RMH_Result	RMH_Self_SetPrivacyEnabled (const RMH_Handle handle, const bool value)
	Enable or disable MoCA privacy on this device. More...
RMH_Result	RMH_Self_GetPrivacyPassword (const RMH_Handle handle, char *responseBuf, const size_t responseBufSize)
	Get the current MoCA privacy password. More...
RMH_Result	RMH_Self_SetPrivacyPassword (const RMH_Handle handle, const char *value)
	Set the network password used to generate privacy keys. More...
RMH_Result	RMH_Self_GetPrivacyMACManagementKey (RMH_Handle handle, char *responseBuf, const size_t responseBufSize)
	Get the SHA1 hash of the MoCA password as an ASCII string. [mocaIfPasswordHash]. More...
RMH_Result	RMH_Self_GetRDKInteroperabilityIFGEnabled (const RMH_Handle handle, bool *response)
	Return if the RDK specific inter-frame gap of 10us is enabled on this device. More...
RMH_Result	RMH_Self_SetRDKInteroperabilityIFGEnabled (const RMH_Handle handle, const bool value)
	Enable or disable the RDK specific inter-frame gap of 10us. More...
RMH_Result	RMH_Self_GetTabooChannels (const RMH_Handle handle, uint32_t *channelMaskStart, uint32_t *channelMask)
	Return which channels will be taboo on this device. More...
RMH_Result	RMH_Self_SetTabooChannels (const RMH_Handle handle, const uint32_t channelMaskStart, const uint32_t channelMask)
	Set which channels will be taboo on this device. More...
RMH_Result	RMH_Self_RestoreDefaultSettings (const RMH_Handle handle)
	Return this device to its default configuration. More...
RMH_Result	RMH_Self_GetMaxAllocationElements (const RMH_Handle handle, uint32_t *response)
	Return the maximum number of allocation elements, excluding the TAUs and the Dummy DAUs, in one MAP the Node can process [mocaIfAeNumber]. More...
RMH_Result	RMH_Self_GetLastResetReason (const RMH_Handle handle, RMH_MoCAResetReason *response)
	Return the reason for the most recent link reset [mocaIfResetReason]. More...
RMH_Result	RMH_Interface_GetName (const RMH_Handle handle, char *responseBuf, const size_t responseBufSize)
	Return the Linux interface name associated with the MoCA device. [mocaIfName]. More...
RMH_Result	RMH_Interface_GetMac (const RMH_Handle handle, RMH_MacAddress_t *response)
	Return the MAC address associated with this MoCA device. [mocaIfMacAddress]. More...
RMH_Result	RMH_Interface_SetMac (const RMH_Handle handle, const RMH_MacAddress_t value)
	Set the MAC address associated with this MoCA device. More...
RMH_Result	RMH_Power_GetMode (const RMH_Handle handle, RMH_PowerMode *response)
	Return the current MoCA power state of this device. More...
RMH_Result	RMH_Power_GetSupportedModes (const RMH_Handle handle, uint32_t *response)
	Return a bitmask of RMH_PowerMode indicating all MoCA power modes supported by this device mocaIfPowerStateCap. More...
RMH_Result	RMH_Power_GetTxPowerControlEnabled (const RMH_Handle handle, bool *response)
	Return if transmit power control is enabled or disabled for this device. More...
RMH_Result	RMH_Power_SetTxPowerControlEnabled (const RMH_Handle handle, const bool value)
	Enable or disable if transmit power control is enabled for this device. More...
RMH_Result	RMH_Power_GetTxBeaconPowerReductionEnabled (const RMH_Handle handle, bool *response)
	Return if beacon power reduction is enabled on this device. More...
RMH_Result	RMH_Power_SetTxBeaconPowerReductionEnabled (const RMH_Handle handle, const bool value)
	Enable or disable if beacon power reduction on this device. More...
RMH_Result	RMH_Power_GetTxBeaconPowerReduction (const RMH_Handle handle, uint32_t *response)
	Return the power control back-off used by this node for transmitting beacons. More...
RMH_Result	RMH_Power_SetTxBeaconPowerReduction (const RMH_Handle handle, const uint32_t value)
	Set the power control back-off used by this node for transmitting beacons. More...
RMH_Result	RMH_Network_GetNumNodes (const RMH_Handle handle, uint32_t *response)
	Return the number of MoCA nodes in the network. [mocaIfNumNodes]. More...
RMH_Result	RMH_Network_GetNodeId (const RMH_Handle handle, uint32_t *response)
	Return the node ID of this device. More...
RMH_Result	RMH_Network_GetNodeIds (const RMH_Handle handle, RMH_NodeList_Uint32_t *response)
	Return a list of every node ID on the network. More...
RMH_Result	RMH_Network_GetRemoteNodeIds (const RMH_Handle handle, RMH_NodeList_Uint32_t *response)
	Return a list of every node ID on the network. More...
RMH_Result	RMH_Network_GetNCNodeId (const RMH_Handle handle, uint32_t *response)
	Return the node ID of the network coordinator. [mocaIfNC]. More...
RMH_Result	RMH_Network_GetBackupNCNodeId (const RMH_Handle handle, uint32_t *response)
	Return the node ID of the backup network coordinator [mocaIfBackupNC]. More...
RMH_Result	RMH_Network_GetNCMac (const RMH_Handle handle, RMH_MacAddress_t *response)
	Return the MAC address of the network coordinator. More...
RMH_Result	RMH_Network_GetLinkUptime (const RMH_Handle handle, uint32_t *response)
	Returns the amount of time this node has been part of the MoCA network [mocaIfLinkUpTime]. More...
RMH_Result	RMH_Network_GetResetCount (const RMH_Handle handle, uint32_t *response)
	Returns the number of times the MoCA link has gone down since the last boot. [mocaIfResetCount]. More...
RMH_Result	RMH_Network_GetLinkDownCount (const RMH_Handle handle, uint32_t *response)
	Returns the number of times the MoCA link has gone down since the last boot [mocaIfLinkDownCount]. More...
RMH_Result	RMH_Network_GetMixedMode (const RMH_Handle handle, bool *response)
	Check if the MoCA network contains both 1.1 and 2.0 nodes. More...
RMH_Result	RMH_Network_GetRFChannelFreq (const RMH_Handle handle, uint32_t *response)
	Return the frequency which the MoCA network is operating on. [mocaIfRFChannel]. More...
RMH_Result	RMH_Network_GetPrimaryChannelFreq (const RMH_Handle handle, uint32_t *response)
	Return the primary MoCA 2.0 channel. More...
RMH_Result	RMH_Network_GetSecondaryChannelFreq (const RMH_Handle handle, uint32_t *response)
	Return the secondary MoCA 2.0 channel. More...
RMH_Result	RMH_Network_GetMoCAVersion (const RMH_Handle handle, RMH_MoCAVersion *response)
	Return the version of MoCA under which the network is operating. [mocaIfNetworkVersion]. More...
RMH_Result	RMH_Network_GetTxBroadcastPhyRate (const RMH_Handle handle, uint32_t *response)
	Return the PHY rate at which broadcast packets are transmitted from this node. More...
RMH_Result	RMH_Network_GetTxGCDPhyRate (const RMH_Handle handle, uint32_t *response)
	Return the GCD PHY rate which packets are transmitted from this node. More...
RMH_Result	RMH_Network_GetTxMapPhyRate (const RMH_Handle handle, uint32_t *response)
	Return the PHY rate at which MAP packets are transmitted from this node. More...
RMH_Result	RMH_Network_GetTxGcdPowerReduction (const RMH_Handle handle, uint32_t *response)
	The transmit power control back-off used for broadcast transmissions from this node. [mocaIfTxGcdPowerReduction]. More...
RMH_Result	RMH_Network_GetTabooChannels (const RMH_Handle handle, uint32_t *channelMaskStart, uint32_t *channelMask)
	Return which beacon channels will be taboo on this device. More...
RMH_Result	RMH_Network_GetTxUnicastPhyRate (const RMH_Handle handle, RMH_NodeMesh_Uint32_t *response)
	Return the unicast transmit PHY rates between all nodes on the network. More...
RMH_Result	RMH_Network_GetTxVLPER (const RMH_Handle handle, RMH_NodeMesh_Uint32_t *response)
	Return the transmit VLPER (Very Low Packet Error Rate) PHY rates between all MoCA 2.0 nodes on the network. More...
RMH_Result	RMH_Network_GetTxNPER (const RMH_Handle handle, RMH_NodeMesh_Uint32_t *response)
	Return the transmit NPER (Nominal Packet Error Rate) PHY rates from all MoCA 2.0 nodes on the network. More...
RMH_Result	RMH_Network_GetBitLoadingInfo (const RMH_Handle handle, RMH_NodeMesh_Uint32_t *response)
	Returns the bit loading information. More...
RMH_Result	RMH_RemoteNode_GetMac (const RMH_Handle handle, const uint32_t nodeId, RMH_MacAddress_t *response)
	Return the MAC address of the remote node specified by nodeId. More...
RMH_Result	RMH_RemoteNode_GetPreferredNC (const RMH_Handle handle, const uint32_t nodeId, bool *response)
	Return if the node indicated by nodeId is a preferred NC or not. More...
RMH_Result	RMH_RemoteNode_GetHighestSupportedMoCAVersion (const RMH_Handle handle, const uint32_t nodeId, RMH_MoCAVersion *response)
	Return the highest supported version of MoCA by the remote node specified by nodeId. More...
RMH_Result	RMH_RemoteNode_GetActiveMoCAVersion (const RMH_Handle handle, const uint32_t nodeId, RMH_MoCAVersion *response)
	Return the active supported version of MoCA by the remote node specificed by nodeId. More...
RMH_Result	RMH_RemoteNode_GetQAM256Capable (const RMH_Handle handle, const uint32_t nodeId, bool *response)
	Return if the node indicated by nodeId has QAM256 enabled or not. More...
RMH_Result	RMH_RemoteNode_GetMaxPacketAggregation (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the maximum number of packets for aggregated transmissions for the node indicated by nodeId. More...
RMH_Result	RMH_RemoteNode_GetMaxFrameSize (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	The maximum number of bytes this node can receive in one frame (aggregated transmission). More...
RMH_Result	RMH_RemoteNode_GetBondingCapable (const RMH_Handle handle, const uint32_t nodeId, bool *response)
	Return if the node indicated by nodeId is bonding capable enabled or not. More...
RMH_Result	RMH_RemoteNode_GetRxUnicastPhyRate (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the PHY rate at which unicast packets are received from nodeId of the self node. More...
RMH_Result	RMH_RemoteNode_GetRxBroadcastPhyRate (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the PHY rate at which broadcast packets are received from nodeId. More...
RMH_Result	RMH_RemoteNode_GetRxBroadcastPower (const RMH_Handle handle, const uint32_t nodeId, float *response)
	Return the power level at which broadcast packets are received from nodeId. More...
RMH_Result	RMH_RemoteNode_GetRxUnicastPower (const RMH_Handle handle, const uint32_t nodeId, float *response)
	Return the power level at which unicast packets are received from nodeId from the self node. More...
RMH_Result	RMH_RemoteNode_GetRxMapPower (const RMH_Handle handle, const uint32_t nodeId, float *response)
	Return the power level at which MAP packets are received by nodeId. More...
RMH_Result	RMH_RemoteNode_GetRxPackets (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the number of packets nodeId has received. More...
RMH_Result	RMH_RemoteNode_GetRxSNR (const RMH_Handle handle, const uint32_t nodeId, float *response)
	The signal to noise ratio of nodeId based on the Type 1 probe from per node. More...
RMH_Result	RMH_RemoteNode_GetRxCorrectedErrors (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the number of packets with corrected errors nodeId has received. More...
RMH_Result	RMH_RemoteNode_GetRxUnCorrectedErrors (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the number of packets with uncorrected errors <nodeId> has received. More...
RMH_Result	RMH_RemoteNode_GetRxTotalErrors (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the total number of packets with errors nodeId has received. More...
RMH_Result	RMH_RemoteNode_GetTxUnicastPhyRate (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the PHY rate at which unicast packets are transmitted from nodeId to the self node. More...
RMH_Result	RMH_RemoteNode_GetTxUnicastPower (const RMH_Handle handle, const uint32_t nodeId, float *response)
	Return the power level rate at which unicast packets are transmitted from nodeId to the self node. More...
RMH_Result	RMH_RemoteNode_GetTxPowerReduction (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	The transmit power control back-off used for transmissions from the specified nodeId. More...
RMH_Result	RMH_RemoteNode_GetTxPackets (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the total number of packets nodeId has transmitted. More...
RMH_Result	RMH_RemoteNode_Reset (const RMH_Handle handle, const uint32_t nodeListMask, const uint32_t startTime)
	Instruct one or more nodes to initiate a MoCA Reset command. More...
RMH_Result	RMH_RemoteNode_GetRxUnicastSubcarrierModulation (const RMH_Handle handle, const uint32_t nodeId, const RMH_PERMode perMode, RMH_SubcarrierProfile *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return the unicast recieve subcarrier modulation profiles for the primary MoCA channel. More...
RMH_Result	RMH_RemoteNode_GetTxUnicastSubcarrierModulation (const RMH_Handle handle, const uint32_t nodeId, const RMH_PERMode perMode, RMH_SubcarrierProfile *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return the unicast transmit subcarrier modulation profiles for the primary MoCA channel. More...
RMH_Result	RMH_RemoteNode_GetSecondaryRxUnicastSubcarrierModulation (const RMH_Handle handle, const uint32_t nodeId, const RMH_PERMode perMode, RMH_SubcarrierProfile *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return the unicast recieve subcarrier modulation profiles for the secondary MoCA channel. More...
RMH_Result	RMH_RemoteNode_GetSecondaryTxUnicastSubcarrierModulation (const RMH_Handle handle, const uint32_t nodeId, const RMH_PERMode perMode, RMH_SubcarrierProfile *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return the unicast transmit subcarrier modulation profiles for the secondary MoCA channel. More...
RMH_Result	RMH_RemoteNode_GetRxBroadcastSubcarrierModulation (const RMH_Handle handle, const uint32_t nodeId, const RMH_PERMode perMode, RMH_SubcarrierProfile *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return the receive broadcast subcarrier modulation profiles for the channel. More...
RMH_Result	RMH_RemoteNode_GetTxBroadcastSubcarrierModulation (const RMH_Handle handle, const uint32_t nodeId, const RMH_PERMode perMode, RMH_SubcarrierProfile *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return the transmission broadcast subcarrier modulation profiles for the channel. More...
RMH_Result	RMH_PQOS_GetMaxIngressFlows (const RMH_Handle handle, uint32_t *response)
	Return the maximum number of supported Ingress PQoS Flows by the Node [mocaIfSupportedIngressPqosFlows]. More...
RMH_Result	RMH_PQOS_GetMaxEgressFlows (const RMH_Handle handle, uint32_t *response)
	Return the maximum number of supported Egress PQoS Flows by the Node [mocaIfSupportedEgressPqosFlows]. More...
RMH_Result	RMH_PQoS_GetNumIngressFlows (const RMH_Handle handle, uint32_t *response)
	Return the number of ingress flows. More...
RMH_Result	RMH_PQoS_GetNumEgressFlows (const RMH_Handle handle, uint32_t *response)
	Return the number of egress flows. More...
RMH_Result	RMH_PQoS_GetEgressBandwidth (const RMH_Handle handle, const uint32_t nodeId, uint32_t *response)
	Return the amount of egress bandwidth available on a particular node. More...
RMH_Result	RMH_PQoS_GetIngressFlowIds (const RMH_Handle handle, RMH_MacAddress_t *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return a list of the unique Id for each existing ingress flows. More...
RMH_Result	RMH_PQoSFlow_GetPeakDataRate (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the peak data rate in Kbps for the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetBurstSize (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the number of packets per burst for the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetLeaseTime (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the lease time in seconds for the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetLeaseTimeRemaining (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the lease time remaining in seconds for the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetFlowTag (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the tag for the flow specified by flowId. This is optional for application use. More...
RMH_Result	RMH_PQoSFlow_GetMaxLatency (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the maximum latency of the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetShortTermAvgRatio (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the short term average ratio for the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetMaxRetry (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the maximum number of retransmission attempts for each MSDU of the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetVLANTag (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the VLAN priority for the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetFlowPer (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the flow packet error ratio profile for the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetIngressClassificationRule (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the ingress classification rule for assigning MSDUs to the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetPacketSize (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the packet size in bytes of the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetTotalTxPackets (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the total number of packets transmitted on the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetDSCPMoCA (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the DSCP MoCA value for the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetDFID (const RMH_Handle handle, const RMH_MacAddress_t flowId, uint32_t *response)
	Return the destination flow ID of the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetDestination (const RMH_Handle handle, const RMH_MacAddress_t flowId, RMH_MacAddress_t *response)
	Return the destination flow ID of the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetIngressMac (const RMH_Handle handle, const RMH_MacAddress_t flowId, RMH_MacAddress_t *response)
	Return the ingress MAC address of the flow specified by flowId. More...
RMH_Result	RMH_PQoSFlow_GetEgressMac (const RMH_Handle handle, const RMH_MacAddress_t flowId, RMH_MacAddress_t *response)
	Return the egress MAC address of the flow specified by flowId. More...
RMH_Result	RMH_PQoS_GetMinEgressBandwidth (const RMH_Handle handle, uint32_t *response)
	Return the node Id with the minimum available bandwidth. More...
RMH_Result	RMH_Stats_GetAdmissionAttempts (const RMH_Handle handle, uint32_t *response)
	Return the number of admission attempts this node has made. More...
RMH_Result	RMH_Stats_GetAdmissionFailures (const RMH_Handle handle, uint32_t *response)
	Return the number of admission failures for this node. More...
RMH_Result	RMH_Stats_GetAdmissionSucceeded (const RMH_Handle handle, uint32_t *response)
	Return the number of successful admissions for this node. More...
RMH_Result	RMH_Stats_GetAdmissionsDeniedAsNC (const RMH_Handle handle, uint32_t *response)
	Return the number of admissions this node has denied when it was the NC. More...
RMH_Result	RMH_Stats_GetTxTotalBytes (const RMH_Handle handle, uint32_t *response)
	Return the total number of bytes transmitted by this node. More...
RMH_Result	RMH_Stats_GetRxTotalBytes (const RMH_Handle handle, uint32_t *response)
	Return the total number of bytes received by this node. More...
RMH_Result	RMH_Stats_GetTxTotalPackets (const RMH_Handle handle, uint32_t *response)
	Return the total number of packets transmitted by this node. More...
RMH_Result	RMH_Stats_GetRxTotalPackets (const RMH_Handle handle, uint32_t *response)
	Return the total number of packets received by this node. More...
RMH_Result	RMH_Stats_GetTxUnicastPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of unicast packets transmitted by this node. More...
RMH_Result	RMH_Stats_GetRxUnicastPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of unicast packets received by this node. More...
RMH_Result	RMH_Stats_GetTxBroadcastPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of broadcast packets transmitted by this node. More...
RMH_Result	RMH_Stats_GetRxBroadcastPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of broadcast packets received by this node. More...
RMH_Result	RMH_Stats_GetTxMulticastPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of multicast packets transmitted by this node. More...
RMH_Result	RMH_Stats_GetRxMulticastPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of multicast packets received by this node. More...
RMH_Result	RMH_Stats_GetTxReservationRequestPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of reservation request packets transmitted by this node. More...
RMH_Result	RMH_Stats_GetRxReservationRequestPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of reservation request packets received by this node. More...
RMH_Result	RMH_Stats_GetTxMapPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of MAP transmitted by this node. More...
RMH_Result	RMH_Stats_GetRxMapPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of MAP received by this node. More...
RMH_Result	RMH_Stats_GetTxLinkControlPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of link control transmitted by this node. More...
RMH_Result	RMH_Stats_GetRxLinkControlPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of link control received by this node. More...
RMH_Result	RMH_Stats_GetTxBeacons (const RMH_Handle handle, uint32_t *response)
	Return the number of link control received by this node. More...
RMH_Result	RMH_Stats_GetRxBeacons (const RMH_Handle handle, uint32_t *response)
	Return the number of beacons received by this node. More...
RMH_Result	RMH_Stats_GetRxUnknownProtocolPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of unknown packets received by this node. More...
RMH_Result	RMH_Stats_GetTxDroppedPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of packets this node has dropped before transmitting. More...
RMH_Result	RMH_Stats_GetRxDroppedPackets (const RMH_Handle handle, uint32_t *response)
	Return the number of packets this node has dropped after receiving. More...
RMH_Result	RMH_Stats_GetTxTotalErrors (const RMH_Handle handle, uint32_t *response)
	Return the total number of transmit errors by this node. More...
RMH_Result	RMH_Stats_GetRxTotalErrors (const RMH_Handle handle, uint32_t *response)
	Return the total number of received errors by this node. More...
RMH_Result	RMH_Stats_GetRxCRCErrors (const RMH_Handle handle, uint32_t *response)
	Return the total number of packets this node has received with CRC errors. More...
RMH_Result	RMH_Stats_GetRxTimeoutErrors (const RMH_Handle handle, uint32_t *response)
	Return the total number of packets this node has received with timeout errors. More...
RMH_Result	RMH_Stats_GetRxTotalAggregatedPackets (const RMH_Handle handle, uint32_t *response)
	Return the total number of received aggregated packets. More...
RMH_Result	RMH_Stats_GetTxTotalAggregatedPackets (const RMH_Handle handle, uint32_t *response)
	Return the total number of transmitted aggregated packets. More...
RMH_Result	RMH_Stats_GetRxPacketAggregation (const RMH_Handle handle, uint32_t *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return an array indicating the number of packets received per aggregation number. More...
RMH_Result	RMH_Stats_GetTxPacketAggregation (const RMH_Handle handle, uint32_t *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Return an array indicating the number of packets transmitted per aggregation number. More...
RMH_Result	RMH_Stats_GetRxCorrectedErrors (const RMH_Handle handle, RMH_NodeList_Uint32_t *response)
	Return the number of received packets from every node with errors which were corrected. More...
RMH_Result	RMH_Stats_GetRxUncorrectedErrors (const RMH_Handle handle, RMH_NodeList_Uint32_t *response)
	Return the number of received packets from every node with errors which were not corrected. More...
RMH_Result	RMH_Stats_Reset (const RMH_Handle handle)
	Reset MoCA statistics counters back to zero. More...
RMH_Result	RMH_Log_GetAPILevel (const RMH_Handle handle, uint32_t *response)
	Return a bitmask of RMH_LogLevel which indicates the currently enabled RMH log types in the RMH library. More...
RMH_Result	RMH_Log_SetAPILevel (const RMH_Handle handle, const uint32_t value)
	Set the log level of the RMH library. More...
RMH_Result	RMH_Log_GetDriverLevel (const RMH_Handle handle, RMH_LogLevel *response)
	Return a bitmask of RMH_LogLevel which indicates the currently enabled RMH log types in the MoCA driver. More...
RMH_Result	RMH_Log_SetDriverLevel (const RMH_Handle handle, const RMH_LogLevel value)
	Set the log level of the MoCA driver. More...
RMH_Result	RMH_Log_GetDriverFilename (const RMH_Handle handle, char *responseBuf, const size_t responseBufSize)
	Get the file name where MoCA driver logs are currently being captured. More...
RMH_Result	RMH_Log_SetDriverFilename (const RMH_Handle handle, const char *value)
	Set the file name where MoCA driver logs should be captured to. More...
RMH_Result	RMH_Log_PrintStatus (const RMH_Handle handle, const char *filename)
	Print a generic status summary of the MoCA device and network. More...
RMH_Result	RMH_ACA_Request (const RMH_Handle handle, const uint32_t channelNum, const uint32_t sourceNodeId, const uint32_t destinationNodeMask, const RMH_ACAType type)
	Print a summary of the sub carrier modulation bitloading information. More...
RMH_Result	RMH_ACA_GetChannel (const RMH_Handle handle, uint32_t *response)
	Return the channel number of the last requested ACA. [mocaIfAcaNodeID]. More...
RMH_Result	RMH_ACA_GetSourceNodeId (const RMH_Handle handle, uint32_t *response)
	Return the Node ID of the source node for the last requested ACA. [mocaIfAcaNodeID]. More...
RMH_Result	RMH_ACA_GetDestinationNodeMask (const RMH_Handle handle, uint32_t *response)
	Return the bitmask of the destination nodes for the last requested ACA. [mocaIfAcaReportNodeMask]. More...
RMH_Result	RMH_ACA_GetType (const RMH_Handle handle, RMH_ACAType *response)
	Return the type of the last requested ACA operation. More...
RMH_Result	RMH_ACA_GetStatus (const RMH_Handle handle, RMH_ACAStatus *response)
	Return the current status of the last requested ACA operation. More...
RMH_Result	RMH_ACA_GetTotalRxPower (const RMH_Handle handle, int32_t *response)
	Return the total power from the last completed ACA operation. More...
RMH_Result	RMH_ACA_GetPowerProfile (const RMH_Handle handle, uint8_t *responseArray, const size_t responseArraySize, size_t *responseArrayUsed)
	Returns the ACA power profile. More...

Function Documentation

RMH_Self_GetEnabled()

RMH_Result RMH_Self_GetEnabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if the MoCA driver is actively connected to or attempting to connect to a MoCA network.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	response	Set to 'true' if the MoCA driver is active. Otherwise set to 'false'.

RMH_Self_SetEnabled()

RMH_Result RMH_Self_SetEnabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable the MoCA driver to connect to a MoCA network. Once enabled the driver will use whatever parameters it has been configured for.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Pass 'true' to enable the MoCA driver. Otherwise pass to 'false'.

RMH_Self_GetMoCALinkUp()

RMH_Result RMH_Self_GetMoCALinkUp	(	const RMH_Handle	handle,
		bool *	response
	)

Check if this device is actively connected to a MoCA network. If so, RMH_Network and RMH_Remote APIs will then be valid to call.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	response	Set to 'true' if this is device is actively connected to a MoCA Network.

RMH_Self_GetLOF()

RMH_Result RMH_Self_GetLOF	(	const RMH_Handle	handle,
		uint32_t *	response
	)

The last frequency on which this device operated.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	response	The last operating frequency of the device.

RMH_Self_SetLOF()

RMH_Result RMH_Self_SetLOF	(	const RMH_Handle	handle,
		const uint32_t	value
	)

Manually set the last operating frequency of the device.

This can be helpful to control what frequency is used for future network connections.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The desired last operating frequency of the device.

RMH_Self_GetScanLOFOnly()

RMH_Result RMH_Self_GetScanLOFOnly	(	const RMH_Handle	handle,
		bool *	response
	)

Return if the device is scanning only the last operating frequency when attempting to establish a connection to a MoCA network.

This can be helpful to control what frequency is used for future network connections.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to 'true' if only the LOF is being checked when joining a MoCA network. Otherwise set to 'false'.

RMH_Self_SetScanLOFOnly()

RMH_Result RMH_Self_SetScanLOFOnly	(	const RMH_Handle	handle,
		const bool	value
	)

Indicate if the device should join networks only on the last operating frequency.

This is helpful to control the exact frequency used for MoCA.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Pass 'true' to ensure this node will only join a network at the LOF. Otherwise pass to 'false'.

RMH_Self_GetPreferredNCEnabled()

RMH_Result RMH_Self_GetPreferredNCEnabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if this device is a preferred NC.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to 'true' if the device is a preferred NC. Otherwise set to 'false'.

RMH_Self_SetPreferredNCEnabled()

RMH_Result RMH_Self_SetPreferredNCEnabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable preferred NC on this device.

If this is enabled the device has a greater chance of becoming the NC, if set disable the chance of becoming the NC is reduced. However, please keep in mind that depending on your network configuration, a device with preferred NC disabled could still become the NC.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	value	Pass 'true' to enable this device as a preferred NC. Otherwise pass to 'false'.

Note

Setting this value may trigger a restart of the MoCA driver and cause the device to temporarily leave the network.

RMH_Self_GetPrimaryChannelOffset()

RMH_Result RMH_Self_GetPrimaryChannelOffset	(	const RMH_Handle	handle,
		int32_t *	response
	)

TBD [mocaIfPrimaryChannelOffset].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	TBD.

RMH_Self_SetPrimaryChannelOffset()

RMH_Result RMH_Self_SetPrimaryChannelOffset	(	const RMH_Handle	handle,
		const int32_t	value
	)

TBD [mocaIfSecondaryChannelOffset].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	TBD.

RMH_Self_GetSecondaryChannelOffset()

RMH_Result RMH_Self_GetSecondaryChannelOffset	(	const RMH_Handle	handle,
		int32_t *	response
	)

TBD [mocaIfSecondaryChannelOffset].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	TBD.

RMH_Self_SetSecondaryChannelOffset()

RMH_Result RMH_Self_SetSecondaryChannelOffset	(	const RMH_Handle	handle,
		const int32_t	value
	)

TBD [mocaIfSecondaryChannelOffset].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	TBD.

RMH_Self_GetSoftwareVersion()

RMH_Result RMH_Self_GetSoftwareVersion	(	const RMH_Handle	handle,
		char *	responseBuf,
		const size_t	responseBufSize
	)

Return the version of software being used by the MoCA driver on this device. [mocaIfSoftwareVersion].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseBuf	A buffer where the software version string will be written.
[in]	responseBufSize	The size in bytes of the buffer <responseBuf>.

RMH_Self_GetHighestSupportedMoCAVersion()

RMH_Result RMH_Self_GetHighestSupportedMoCAVersion	(	const RMH_Handle	handle,
		RMH_MoCAVersion *	response
	)

Return the highest version of MoCA supported by the MoCA driver on this device. [mocaIfMocaVersion].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The highest version of MoCA supported.

RMH_Self_GetFrequencyMask()

RMH_Result RMH_Self_GetFrequencyMask	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Gets the bit mask of frequencies the device used during the listening phase of network search.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The bitmask of frequencies this device will use when joining a network.

RMH_Self_SetFrequencyMask()

RMH_Result RMH_Self_SetFrequencyMask	(	const RMH_Handle	handle,
		const uint32_t	value
	)

Set the bit mask for specifying which frequencies should be scanned during the listening phase of network search.

Depending on the RF band of operation, the MSB of this parameter corresponds to the lowest frequency channel of the band. Each subsequent bit of this parameter represents the next highest 25MHz channel. The base channels for each RF band are as follows:

• Band D-Low : 46 (1150 MHz)
• Band D-High: 56 (1400 MHz)
• Band Ext-D : 46 (1150 MHz)
• Band C4 : 40 (1000 MHz)
• Band E : 20 ( 500 MHz)
• Band F : 27 ( 675 MHz)
• Band H : 39 ( 975 MHz)

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The bitmask of frequencies this device should use when joining a network.

RMH_Self_GetMaxPacketAggregation()

RMH_Result RMH_Self_GetMaxPacketAggregation	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Get the maximum number of packets this device will aggregate.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	response	The maximum number of packets this device will aggregate.

RMH_Self_SetMaxPacketAggregation()

RMH_Result RMH_Self_SetMaxPacketAggregation	(	const RMH_Handle	handle,
		const uint32_t	value
	)

Set the maximum allowed packets for aggregated transmissions.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The maximum number of packets this device can aggregate.

RMH_Self_GetMaxFrameSize()

RMH_Result RMH_Self_GetMaxFrameSize	(	const RMH_Handle	handle,
		uint32_t *	response
	)

The maximum number of bytes this node can receive in one frame.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The maximum number of packets this device can aggregate.

RMH_Self_SetMaxFrameSize()

RMH_Result RMH_Self_SetMaxFrameSize	(	const RMH_Handle	handle,
		const uint32_t	value
	)

Set the maximum number of bytes this node can receive in one frame (aggregated transmission).

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The maximum number of packets this device can aggregate.

RMH_Self_GetLowBandwidthLimit()

RMH_Result RMH_Self_GetLowBandwidthLimit	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Get the current lower limit for PHY rate between two nodes.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The lower PHY limit.

RMH_Self_SetLowBandwidthLimit()

RMH_Result RMH_Self_SetLowBandwidthLimit	(	const RMH_Handle	handle,
		const uint32_t	value
	)

Set the lower threshold for the PHY link bandwidth between two nodes.

If the rate falls below this limit a callback of type <RMH_EVENT_LOW_BANDWIDTH> will be triggered.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The new value to use as the lower PHY limit.

RMH_Self_GetMaxBitrate()

RMH_Result RMH_Self_GetMaxBitrate	(	const RMH_Handle	handle,
		uint32_t *	response
	)

The maximum PHY rate supported in non-turbo mode.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	response	The maximum PHY rate.

RMH_Self_SetTxPowerLimit()

RMH_Result RMH_Self_SetTxPowerLimit	(	const RMH_Handle	handle,
		const int32_t	value
	)

Set the maximum transmitter power level for this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Desired transmitter power level. Minimum value -31, maximum value 3.

Note

Setting this value may trigger a restart of the MoCA driver and cause the device to temporarily leave the network.

RMH_Self_GetTxPowerLimit()

RMH_Result RMH_Self_GetTxPowerLimit	(	const RMH_Handle	handle,
		int32_t *	response
	)

Returns the maximum transmitter power level for this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The maximum transmission power for this device.

RMH_Self_GetSupportedFrequencies()

RMH_Result RMH_Self_GetSupportedFrequencies	(	const RMH_Handle	handle,
		uint32_t *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return a list of frequencies in the band used by this node.

This frequency list does not account for taboo channels or other filters which would limit the scope of frequencies this device would use to join a network. [mocaIfChannelSupport].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseArray	An array where the frequency list should be stored.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

RMH_Self_GetSupportedBand()

RMH_Result RMH_Self_GetSupportedBand	(	const RMH_Handle	handle,
		RMH_Band *	response
	)

Return the band supported by the MoCA device. [mocaIfSupportedBands].

• RMH_BAND_C4 [MoCA 1.1]: 1000
• RMH_BAND_D [MoCA 1.1]: 1150, 1200, 1250, 1300, 1350, 1400, 1450, 1500
• RMH_BAND_D_LOW: 1125, 1150, 1175, 1200, 1225
• RMH_BAND_D_HIGH: 1350, 1375, 1400, 1425, 1450, 1475, 1500, 1525, 1550, 1575, 1600, 1625
• RMH_BAND_D_EX: 1150, 1200, 1250, 1300, 1350, 1400, 1450, 1500
• RMH_BAND_E: 500, 525, 550, 575, 600
• RMH_BAND_F: 675, 700, 725, 750, 775, 800, 825, 850
• RMH_BAND_H: 975, 1000, 1025

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The band supported by this MoCA device.

RMH_Self_GetQAM256Enabled()

RMH_Result RMH_Self_GetQAM256Enabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if this device is set as QAM256 capable in admission negotiations.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to 'true' if QAM256 support is enabled. Otherwise set to 'false'.

RMH_Self_SetQAM256Enabled()

RMH_Result RMH_Self_SetQAM256Enabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable the QAM256 ability in admission negotiations.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Pass 'true' to enable QAM256 support on this device. Otherwise pass to 'false'.

Note

Setting this value may trigger a restart of the MoCA driver and cause the device to temporarily leave the network.

RMH_Self_GetQAM256TargetPhyRate()

RMH_Result RMH_Self_GetQAM256TargetPhyRate	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Get the target PHY rate in Mbps.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The target PHY rate in Mbps.

RMH_Self_SetQAM256TargetPhyRate()

RMH_Result RMH_Self_SetQAM256TargetPhyRate	(	const RMH_Handle	handle,
		const uint32_t	value
	)

Set the target PHY rate in Mbps.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The target PHY rate in Mbps.

Note

Setting this value may trigger a restart of the MoCA driver and cause the device to temporarily leave the network.

RMH_Self_GetTurboEnabled()

RMH_Result RMH_Self_GetTurboEnabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if turbo mode is enabled on this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to true if turbo is enabled. Otherwise set to false.

RMH_Self_SetTurboEnabled()

RMH_Result RMH_Self_SetTurboEnabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable turbo mode on this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Pass 'true' to enable turbo on this device. Otherwise pass to 'false'.

RMH_Self_GetBondingEnabled()

RMH_Result RMH_Self_GetBondingEnabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if bonding mode is enabled on this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	response	Set to 'true' if bonding is enabled. Otherwise set to 'false'.

RMH_Self_SetBondingEnabled()

RMH_Result RMH_Self_SetBondingEnabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable bonding mode on this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Pass 'true' to enable bonding on this device. Otherwise pass to 'false'.

RMH_Self_GetPrivacyEnabled()

RMH_Result RMH_Self_GetPrivacyEnabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if MoCA privacy is enabled on this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to 'true' if MoCA privacy is enabled. Otherwise set to 'false'.

RMH_Self_SetPrivacyEnabled()

RMH_Result RMH_Self_SetPrivacyEnabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable MoCA privacy on this device.

If enabled the device will only be permitted to join networks with other devices which have the same password.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	value	"Pass 'true' to enable MoCA privacy on this device. Otherwise pass to 'false'.

RMH_Self_GetPrivacyPassword()

RMH_Result RMH_Self_GetPrivacyPassword	(	const RMH_Handle	handle,
		char *	responseBuf,
		const size_t	responseBufSize
	)

Get the current MoCA privacy password.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseBuf	A buffer where the MoCA password will be written.
[in]	responseBufSize	The size in bytes of the buffer <responseBuf>.

RMH_Self_SetPrivacyPassword()

RMH_Result RMH_Self_SetPrivacyPassword	(	const RMH_Handle	handle,
		const char *	value
	)

Set the network password used to generate privacy keys.

This string must be between 12 and 17 characters long with each character being a decimal number (0-9).

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The MoCA network password. Although this is a string only 0-9 are permitted.

RMH_Self_GetPrivacyMACManagementKey()

RMH_Result RMH_Self_GetPrivacyMACManagementKey	(	RMH_Handle	handle,
		char *	responseBuf,
		const size_t	responseBufSize
	)

Get the SHA1 hash of the MoCA password as an ASCII string. [mocaIfPasswordHash].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseBuf	A buffer where the MoCA managment key will be written.
[in]	responseBufSize	The size in bytes of the buffer responseBuf.

RMH_Self_GetRDKInteroperabilityIFGEnabled()

RMH_Result RMH_Self_GetRDKInteroperabilityIFGEnabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if the RDK specific inter-frame gap of 10us is enabled on this device.

This should be enabled on all MoCA 2.0 devices that would become the NC to ensure endure compatibility with all RDK vendors.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to 'true' if RDK IFG of 10us is enabled. Otherwise set to 'false'.

RMH_Self_SetRDKInteroperabilityIFGEnabled()

RMH_Result RMH_Self_SetRDKInteroperabilityIFGEnabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable the RDK specific inter-frame gap of 10us.

This setting is needed by all MoCA 2.0 devices that would become the NC to ensure endure compatibility with all RDK vendors.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Pass true to enable RDK IFG of 10us. Otherwise pass to false.

RMH_Self_GetTabooChannels()

RMH_Result RMH_Self_GetTabooChannels	(	const RMH_Handle	handle,
		uint32_t *	channelMaskStart,
		uint32_t *	channelMask
	)

Return which channels will be taboo on this device.

channelMaskStart will indicate the channel number of the lowest RF frequency covered by channel mask. The bitmask channelMask is then used to identify exactly which frequencies are taboo. Each consecutive bit of channelMask corresponds to channels offset by multiples of 25MHz. A bit in channelMask will be set to '1' if that channel is taboo.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	channelMaskStart	The channel number of the lowest frequency which is taboo.
[in]	channelMask	A bitmask of channels which are taboo. The first bit corresponds to the frequency of channelMaskStart.

RMH_Self_SetTabooChannels()

RMH_Result RMH_Self_SetTabooChannels	(	const RMH_Handle	handle,
		const uint32_t	channelMaskStart,
		const uint32_t	channelMask
	)

Set which channels will be taboo on this device.

channelMaskStart will indicate the channel number of the lowest RF frequency covered by channel mask. The bitmask channelMask is then used to identify exactly which frequencies are taboo. Each consecutive bit of channelMask corresponds to channels offset by multiples of 25MHz. A bit in channelMask must be set to 1 if that channel is taboo.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	channelMaskStart	The channel number of the lowest frequency which is taboo.
[in]	channelMask	A bitmask of channels which are taboo. The first bit corresponds to the frequency of channelMaskStart.

RMH_Self_RestoreDefaultSettings()

RMH_Result RMH_Self_RestoreDefaultSettings

(

const RMH_Handle

handle

)

Return this device to its default configuration.

Parameters

[in]

handle

The RMH handle as returned by RMH_Initialize.

RMH_Self_GetMaxAllocationElements()

RMH_Result RMH_Self_GetMaxAllocationElements	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the maximum number of allocation elements, excluding the TAUs and the Dummy DAUs, in one MAP the Node can process [mocaIfAeNumber].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Maximum number of allocation elements.

RMH_Self_GetLastResetReason()

RMH_Result RMH_Self_GetLastResetReason	(	const RMH_Handle	handle,
		RMH_MoCAResetReason *	response
	)

Return the reason for the most recent link reset [mocaIfResetReason].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The reason for the most recent link reset.

RMH_Interface_GetName()

RMH_Result RMH_Interface_GetName	(	const RMH_Handle	handle,
		char *	responseBuf,
		const size_t	responseBufSize
	)

Return the Linux interface name associated with the MoCA device. [mocaIfName].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseBuf	A buffer where the interface name will be written.
[in]	responseBufSize	The size in bytes of the buffer responseBuf.

RMH_Interface_GetMac()

RMH_Result RMH_Interface_GetMac	(	const RMH_Handle	handle,
		RMH_MacAddress_t *	response
	)

Return the MAC address associated with this MoCA device. [mocaIfMacAddress].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The MAC address as a byte array.

RMH_Interface_SetMac()

RMH_Result RMH_Interface_SetMac	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	value
	)

Set the MAC address associated with this MoCA device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The desired MAC address as a byte array.

RMH_Power_GetMode()

RMH_Result RMH_Power_GetMode	(	const RMH_Handle	handle,
		RMH_PowerMode *	response
	)

Return the current MoCA power state of this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The current power mode of this device.

RMH_Power_GetSupportedModes()

RMH_Result RMH_Power_GetSupportedModes	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return a bitmask of RMH_PowerMode indicating all MoCA power modes supported by this device mocaIfPowerStateCap.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	A bitmask of RMH_PowerMode listing supported modes.

RMH_Power_GetTxPowerControlEnabled()

RMH_Result RMH_Power_GetTxPowerControlEnabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if transmit power control is enabled or disabled for this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to 'true' if transmission power control is enabled. Otherwise set to 'false'.

RMH_Power_SetTxPowerControlEnabled()

RMH_Result RMH_Power_SetTxPowerControlEnabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable if transmit power control is enabled for this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Pass 'true' to enable transmission power control on this device. Otherwise pass to 'false'.

RMH_Power_GetTxBeaconPowerReductionEnabled()

RMH_Result RMH_Power_GetTxBeaconPowerReductionEnabled	(	const RMH_Handle	handle,
		bool *	response
	)

Return if beacon power reduction is enabled on this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to 'true' if beacon power reduction is enabled. Otherwise set to 'false'.

RMH_Power_SetTxBeaconPowerReductionEnabled()

RMH_Result RMH_Power_SetTxBeaconPowerReductionEnabled	(	const RMH_Handle	handle,
		const bool	value
	)

Enable or disable if beacon power reduction on this device.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Pass true to enable beacon power control on this device. Otherwise pass to false.

RMH_Power_GetTxBeaconPowerReduction()

RMH_Result RMH_Power_GetTxBeaconPowerReduction	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the power control back-off used by this node for transmitting beacons.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Beacon power reduction.

RMH_Power_SetTxBeaconPowerReduction()

RMH_Result RMH_Power_SetTxBeaconPowerReduction	(	const RMH_Handle	handle,
		const uint32_t	value
	)

Set the power control back-off used by this node for transmitting beacons.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	Beacon power reduction. Minimum value 0, Maximum value 5.

RMH_Network_GetNumNodes()

RMH_Result RMH_Network_GetNumNodes	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of MoCA nodes in the network. [mocaIfNumNodes].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Number of MoCA nodes in the network.

RMH_Network_GetNodeId()

RMH_Result RMH_Network_GetNodeId	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the node ID of this device.

[mocaIfNodeID] This is a zero based ID which uniquely identifies this node on the network.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The device's node ID.

RMH_Network_GetNodeIds()

RMH_Result RMH_Network_GetNodeIds	(	const RMH_Handle	handle,
		RMH_NodeList_Uint32_t *	response
	)

Return a list of every node ID on the network.

This differs from RMH_Network_GetRemoteNodeIds as this API includes the self node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The index is the node Id, if nodePresent is 'true', nodeValue is the node Id.

RMH_Network_GetRemoteNodeIds()

RMH_Result RMH_Network_GetRemoteNodeIds	(	const RMH_Handle	handle,
		RMH_NodeList_Uint32_t *	response
	)

Return a list of every node ID on the network.

This differs from RMH_Network_GetNodeIds as this API does not include the self node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The index is the node Id, if nodePresent is 'true', nodeValue is the node Id.

RMH_Network_GetNCNodeId()

RMH_Result RMH_Network_GetNCNodeId	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the node ID of the network coordinator. [mocaIfNC].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The network coordinator node Id.

RMH_Network_GetBackupNCNodeId()

RMH_Result RMH_Network_GetBackupNCNodeId	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the node ID of the backup network coordinator [mocaIfBackupNC].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The backup network coordinator node Id.

RMH_Network_GetNCMac()

RMH_Result RMH_Network_GetNCMac	(	const RMH_Handle	handle,
		RMH_MacAddress_t *	response
	)

Return the MAC address of the network coordinator.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The MAC address of the network coordinator.

RMH_Network_GetLinkUptime()

RMH_Result RMH_Network_GetLinkUptime	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Returns the amount of time this node has been part of the MoCA network [mocaIfLinkUpTime].

Time is in seconds.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Number of seconds this node has been in the network.

RMH_Network_GetResetCount()

RMH_Result RMH_Network_GetResetCount	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Returns the number of times the MoCA link has gone down since the last boot. [mocaIfResetCount].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Number of seconds this node has been in the network.

RMH_Network_GetLinkDownCount()

RMH_Result RMH_Network_GetLinkDownCount	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Returns the number of times the MoCA link has gone down since the last boot [mocaIfLinkDownCount].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Number of seconds this node has been in the network.

RMH_Network_GetMixedMode()

RMH_Result RMH_Network_GetMixedMode	(	const RMH_Handle	handle,
		bool *	response
	)

Check if the MoCA network contains both 1.1 and 2.0 nodes.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Set to true if both 1.1 and 2.0 nodes are present in the network. Otherwise set to false.

RMH_Network_GetRFChannelFreq()

RMH_Result RMH_Network_GetRFChannelFreq	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the frequency which the MoCA network is operating on. [mocaIfRFChannel].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The frequency of the MoCA network.

RMH_Network_GetPrimaryChannelFreq()

RMH_Result RMH_Network_GetPrimaryChannelFreq	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the primary MoCA 2.0 channel.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The primary MoCA 2.0 channel.

RMH_Network_GetSecondaryChannelFreq()

RMH_Result RMH_Network_GetSecondaryChannelFreq	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the secondary MoCA 2.0 channel.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The secondary MoCA 2.0 channel.

RMH_Network_GetMoCAVersion()

RMH_Result RMH_Network_GetMoCAVersion	(	const RMH_Handle	handle,
		RMH_MoCAVersion *	response
	)

Return the version of MoCA under which the network is operating. [mocaIfNetworkVersion].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The MoCA version of the network.

RMH_Network_GetTxBroadcastPhyRate()

RMH_Result RMH_Network_GetTxBroadcastPhyRate	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the PHY rate at which broadcast packets are transmitted from this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The broadcast transmission PHY rate.

RMH_Network_GetTxGCDPhyRate()

RMH_Result RMH_Network_GetTxGCDPhyRate	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the GCD PHY rate which packets are transmitted from this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The GCD transmission PHY rate.

RMH_Network_GetTxMapPhyRate()

RMH_Result RMH_Network_GetTxMapPhyRate	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the PHY rate at which MAP packets are transmitted from this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The MAP transmission PHY rate.

RMH_Network_GetTxGcdPowerReduction()

RMH_Result RMH_Network_GetTxGcdPowerReduction	(	const RMH_Handle	handle,
		uint32_t *	response
	)

The transmit power control back-off used for broadcast transmissions from this node. [mocaIfTxGcdPowerReduction].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Transmit power control reduction. Minimum value 0, Maximum value 35.

RMH_Network_GetTabooChannels()

RMH_Result RMH_Network_GetTabooChannels	(	const RMH_Handle	handle,
		uint32_t *	channelMaskStart,
		uint32_t *	channelMask
	)

Return which beacon channels will be taboo on this device.

channelMaskStart will indicate the channel number of the lowest. RF frequency covered by channel mask. The bitmask channelMask is then used to identify exactly which frequencies.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	channelMaskStart	The channel number of the lowest frequency which is taboo.
[in]	channelMask	A bitmask of channels which are taboo. The first bit corresponds to the frequency of channelMaskStart.

RMH_Network_GetTxUnicastPhyRate()

RMH_Result RMH_Network_GetTxUnicastPhyRate	(	const RMH_Handle	handle,
		RMH_NodeMesh_Uint32_t *	response
	)

Return the unicast transmit PHY rates between all nodes on the network.

The resulting matrix will be in RMH_NodeMesh_Uint32_t Where the index is the node Id If nodePresent is 'true', then nodeValue is a list of the unicast PHY rates from this node Id to every other node on the network.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	A bitmask of channels which are taboo. The first bit corresponds to the frequency of channelMaskStart.

RMH_Network_GetTxVLPER()

RMH_Result RMH_Network_GetTxVLPER	(	const RMH_Handle	handle,
		RMH_NodeMesh_Uint32_t *	response
	)

Return the transmit VLPER (Very Low Packet Error Rate) PHY rates between all MoCA 2.0 nodes on the network.

The resulting matrix will be in RMH_NodeMesh_Uint32_t Where the index is the node Id. if nodePresent is 'true'then <nodeValue> is a list of the unicast PHY rates from this node Id to every other node on the network.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	A bitmask of channels which are taboo. The first bit corresponds to the frequency of channelMaskStart.

Note

MoCA 1.1 nodes will have nodePresent set to 'true', however they nodeValue will be 0.

RMH_Network_GetTxNPER()

RMH_Result RMH_Network_GetTxNPER	(	const RMH_Handle	handle,
		RMH_NodeMesh_Uint32_t *	response
	)

Return the transmit NPER (Nominal Packet Error Rate) PHY rates from all MoCA 2.0 nodes on the network.

The resulting matrix will be in RMH_NodeMesh_Uint32_t Where the index is the node Id. if nodePresent is 'true'then nodeValue is a list of the unicast PHY rates from this node Id to every other node on the network.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The PHY rate mesh table.

Note

MoCA 1.1 nodes will have nodePresent set to 'true', however they nodeValue will be 0.

RMH_Network_GetBitLoadingInfo()

RMH_Result RMH_Network_GetBitLoadingInfo	(	const RMH_Handle	handle,
		RMH_NodeMesh_Uint32_t *	response
	)

Returns the bit loading information.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The resulting bitloading information.

RMH_RemoteNode_GetMac()

RMH_Result RMH_RemoteNode_GetMac	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		RMH_MacAddress_t *	response
	)

Return the MAC address of the remote node specified by nodeId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The MAC address of the remote node as a byte array.

RMH_RemoteNode_GetPreferredNC()

RMH_Result RMH_RemoteNode_GetPreferredNC	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		bool *	response
	)

Return if the node indicated by nodeId is a preferred NC or not.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	Returns True, if the remote node is a preferred NC. False otherwise.

RMH_RemoteNode_GetHighestSupportedMoCAVersion()

RMH_Result RMH_RemoteNode_GetHighestSupportedMoCAVersion	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		RMH_MoCAVersion *	response
	)

Return the highest supported version of MoCA by the remote node specified by nodeId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The highest version of MoCA supported.

RMH_RemoteNode_GetActiveMoCAVersion()

RMH_Result RMH_RemoteNode_GetActiveMoCAVersion	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		RMH_MoCAVersion *	response
	)

Return the active supported version of MoCA by the remote node specificed by nodeId.

There are cases where devices that support MoCA 2.0 may be actively using MoCA 1.1 . For example, when the NC is a MoCA 1.1 node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The active version of MoCA on the remote node.

RMH_RemoteNode_GetQAM256Capable()

RMH_Result RMH_RemoteNode_GetQAM256Capable	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		bool *	response
	)

Return if the node indicated by nodeId has QAM256 enabled or not.

There are cases where devices that support MoCA 2.0 may be actively using MoCA 1.1 . For example, when the NC is a MoCA 1.1 node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	Set to true if the remote node is a QAM256 capable. Otherwise set to false.

RMH_RemoteNode_GetMaxPacketAggregation()

RMH_Result RMH_RemoteNode_GetMaxPacketAggregation	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the maximum number of packets for aggregated transmissions for the node indicated by nodeId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The maximum number of packets nodeId will aggregate.

RMH_RemoteNode_GetMaxFrameSize()

RMH_Result RMH_RemoteNode_GetMaxFrameSize	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

The maximum number of bytes this node can receive in one frame (aggregated transmission).

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The maximum number of packets this device will aggregate.

RMH_RemoteNode_GetBondingCapable()

RMH_Result RMH_RemoteNode_GetBondingCapable	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		bool *	response
	)

Return if the node indicated by nodeId is bonding capable enabled or not.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	Set to true if the remote node supports bonding. Otherwise set to false.

RMH_RemoteNode_GetRxUnicastPhyRate()

RMH_Result RMH_RemoteNode_GetRxUnicastPhyRate	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the PHY rate at which unicast packets are received from nodeId of the self node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The unicast receive PHY rate.

RMH_RemoteNode_GetRxBroadcastPhyRate()

RMH_Result RMH_RemoteNode_GetRxBroadcastPhyRate	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the PHY rate at which broadcast packets are received from nodeId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The broadcast receive PHY rate.

RMH_RemoteNode_GetRxBroadcastPower()

RMH_Result RMH_RemoteNode_GetRxBroadcastPower	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		float *	response
	)

Return the power level at which broadcast packets are received from nodeId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The broadcast receive power level.

RMH_RemoteNode_GetRxUnicastPower()

RMH_Result RMH_RemoteNode_GetRxUnicastPower	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		float *	response
	)

Return the power level at which unicast packets are received from nodeId from the self node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The unicast receive power level.

RMH_RemoteNode_GetRxMapPower()

RMH_Result RMH_RemoteNode_GetRxMapPower	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		float *	response
	)

Return the power level at which MAP packets are received by nodeId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The MAP receive power level rate.

RMH_RemoteNode_GetRxPackets()

RMH_Result RMH_RemoteNode_GetRxPackets	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the number of packets nodeId has received.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	Number of packets received by nodeId.

RMH_RemoteNode_GetRxSNR()

RMH_Result RMH_RemoteNode_GetRxSNR	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		float *	response
	)

The signal to noise ratio of nodeId based on the Type 1 probe from per node.

Measured in dB.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The SNR of nodeId.

RMH_RemoteNode_GetRxCorrectedErrors()

RMH_Result RMH_RemoteNode_GetRxCorrectedErrors	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the number of packets with corrected errors nodeId has received.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The number of corrected packets with errors.

RMH_RemoteNode_GetRxUnCorrectedErrors()

RMH_Result RMH_RemoteNode_GetRxUnCorrectedErrors	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the number of packets with uncorrected errors <nodeId> has received.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The number of corrected packets with errors.

RMH_RemoteNode_GetRxTotalErrors()

RMH_Result RMH_RemoteNode_GetRxTotalErrors	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the total number of packets with errors nodeId has received.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The number of total number of packets with errors.

RMH_RemoteNode_GetTxUnicastPhyRate()

RMH_Result RMH_RemoteNode_GetTxUnicastPhyRate	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the PHY rate at which unicast packets are transmitted from nodeId to the self node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The unicast transmission PHY rate.

RMH_RemoteNode_GetTxUnicastPower()

RMH_Result RMH_RemoteNode_GetTxUnicastPower	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		float *	response
	)

Return the power level rate at which unicast packets are transmitted from nodeId to the self node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The unicast transmission power level rate.

RMH_RemoteNode_GetTxPowerReduction()

RMH_Result RMH_RemoteNode_GetTxPowerReduction	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

The transmit power control back-off used for transmissions from the specified nodeId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The transmission power reduction of nodeId.

RMH_RemoteNode_GetTxPackets()

RMH_Result RMH_RemoteNode_GetTxPackets	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the total number of packets nodeId has transmitted.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The total number of packets transmitted by nodeId.

RMH_RemoteNode_Reset()

RMH_Result RMH_RemoteNode_Reset	(	const RMH_Handle	handle,
		const uint32_t	nodeListMask,
		const uint32_t	startTime
	)

Instruct one or more nodes to initiate a MoCA Reset command.

This will result in the specfied nodes dropping from the network and then rejoining.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeListMask	A bitmask of nodes to be reset [mocaIfMrNodeMask]. For example, to reset a given node use 'nodeListMask |= (1 << nodeId)'")
[in]	startTime	The time in seconds to start the reset command [mocaIfMrStartTime].

RMH_RemoteNode_GetRxUnicastSubcarrierModulation()

RMH_Result RMH_RemoteNode_GetRxUnicastSubcarrierModulation	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		const RMH_PERMode	perMode,
		RMH_SubcarrierProfile *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return the unicast recieve subcarrier modulation profiles for the primary MoCA channel.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[in]	perMode	The PER Mode to check.This parameter will be ignored for MoCA devices older than 2.0.
[out]	responseArray	An array where the sub carrier modulation should be stored.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

RMH_RemoteNode_GetTxUnicastSubcarrierModulation()

RMH_Result RMH_RemoteNode_GetTxUnicastSubcarrierModulation	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		const RMH_PERMode	perMode,
		RMH_SubcarrierProfile *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return the unicast transmit subcarrier modulation profiles for the primary MoCA channel.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[in]	perMode	The PER Mode to check.This parameter will be ignored for MoCA devices older than 2.0.
[out]	responseArray	An array where the sub carrier modulation should be stored.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

RMH_RemoteNode_GetSecondaryRxUnicastSubcarrierModulation()

RMH_Result RMH_RemoteNode_GetSecondaryRxUnicastSubcarrierModulation	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		const RMH_PERMode	perMode,
		RMH_SubcarrierProfile *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return the unicast recieve subcarrier modulation profiles for the secondary MoCA channel.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[in]	perMode	The PER Mode to check.This parameter will be ignored for MoCA devices older than 2.0.
[out]	responseArray	An array where the sub carrier modulation should be stored.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

RMH_RemoteNode_GetSecondaryTxUnicastSubcarrierModulation()

RMH_Result RMH_RemoteNode_GetSecondaryTxUnicastSubcarrierModulation	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		const RMH_PERMode	perMode,
		RMH_SubcarrierProfile *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return the unicast transmit subcarrier modulation profiles for the secondary MoCA channel.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[in]	perMode	The PER Mode to check.This parameter will be ignored for MoCA devices older than 2.0.
[out]	responseArray	An array where the sub carrier modulation should be stored.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

RMH_RemoteNode_GetRxBroadcastSubcarrierModulation()

RMH_Result RMH_RemoteNode_GetRxBroadcastSubcarrierModulation	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		const RMH_PERMode	perMode,
		RMH_SubcarrierProfile *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return the receive broadcast subcarrier modulation profiles for the channel.

In the case of a MoCA 1.1 connection this will return the SubcarrierModulation.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[in]	perMode	The PER Mode to check.This parameter will be ignored for MoCA devices older than 2.0.
[out]	responseArray	An array where the sub carrier modulation should be stored.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

RMH_RemoteNode_GetTxBroadcastSubcarrierModulation()

RMH_Result RMH_RemoteNode_GetTxBroadcastSubcarrierModulation	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		const RMH_PERMode	perMode,
		RMH_SubcarrierProfile *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return the transmission broadcast subcarrier modulation profiles for the channel.

In the case of a MoCA 1.1 connection this will return the SubcarrierModulation.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[in]	perMode	The PER Mode to check.This parameter will be ignored for MoCA devices older than 2.0.
[out]	responseArray	An array where the sub carrier modulation should be stored.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

RMH_PQOS_GetMaxIngressFlows()

RMH_Result RMH_PQOS_GetMaxIngressFlows	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the maximum number of supported Ingress PQoS Flows by the Node [mocaIfSupportedIngressPqosFlows].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Maximum number of supported Ingress PQoS Flows by the Node.

RMH_PQOS_GetMaxEgressFlows()

RMH_Result RMH_PQOS_GetMaxEgressFlows	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the maximum number of supported Egress PQoS Flows by the Node [mocaIfSupportedEgressPqosFlows].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Maximum number of supported Egress PQoS Flows by the Node.

RMH_PQoS_GetNumIngressFlows()

RMH_Result RMH_PQoS_GetNumIngressFlows	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of ingress flows.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of ingress flows.

RMH_PQoS_GetNumEgressFlows()

RMH_Result RMH_PQoS_GetNumEgressFlows	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of egress flows.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of egress flows.

RMH_PQoS_GetEgressBandwidth()

RMH_Result RMH_PQoS_GetEgressBandwidth	(	const RMH_Handle	handle,
		const uint32_t	nodeId,
		uint32_t *	response
	)

Return the amount of egress bandwidth available on a particular node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	nodeId	The node Id of the remote node to inspect.
[out]	response	The available egress bandwidth.

RMH_PQoS_GetIngressFlowIds()

RMH_Result RMH_PQoS_GetIngressFlowIds	(	const RMH_Handle	handle,
		RMH_MacAddress_t *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return a list of the unique Id for each existing ingress flows.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseArray	An array where the flow unique Ids should be returned.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

RMH_PQoSFlow_GetPeakDataRate()

RMH_Result RMH_PQoSFlow_GetPeakDataRate	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the peak data rate in Kbps for the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The peak data rate in Kbps.

RMH_PQoSFlow_GetBurstSize()

RMH_Result RMH_PQoSFlow_GetBurstSize	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the number of packets per burst for the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The packets per burst.

RMH_PQoSFlow_GetLeaseTime()

RMH_Result RMH_PQoSFlow_GetLeaseTime	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the lease time in seconds for the flow specified by flowId.

Zero indicates an infinite lease time.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The lease time in seconds.

RMH_PQoSFlow_GetLeaseTimeRemaining()

RMH_Result RMH_PQoSFlow_GetLeaseTimeRemaining	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the lease time remaining in seconds for the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The lease time remaining in seconds.

RMH_PQoSFlow_GetFlowTag()

RMH_Result RMH_PQoSFlow_GetFlowTag	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the tag for the flow specified by flowId. This is optional for application use.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The flow tag.

RMH_PQoSFlow_GetMaxLatency()

RMH_Result RMH_PQoSFlow_GetMaxLatency	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the maximum latency of the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The maximum latency.

RMH_PQoSFlow_GetShortTermAvgRatio()

RMH_Result RMH_PQoSFlow_GetShortTermAvgRatio	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the short term average ratio for the flow specified by flowId.

This is the ratio of the short term average rate of the flow compared to the peak rate over the interval of RMH_PQoSFlow_GetMaxLatency. This value plus one serves as the numerator of the ratio. The denominator is 256. This value is only applicable when the maximun latency value is greater than or equal to 10 ms.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The short term average ratio.

RMH_PQoSFlow_GetMaxRetry()

RMH_Result RMH_PQoSFlow_GetMaxRetry	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the maximum number of retransmission attempts for each MSDU of the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The maximum retransmission attempts.

RMH_PQoSFlow_GetVLANTag()

RMH_Result RMH_PQoSFlow_GetVLANTag	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the VLAN priority for the flow specified by flowId.

This is used for MSDU classification when RMH_PQoSFlow_GetIngressClassificationRule is 6 or 7.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The VLAN tag.

RMH_PQoSFlow_GetFlowPer()

RMH_Result RMH_PQoSFlow_GetFlowPer	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the flow packet error ratio profile for the flow specified by flowId.

This is to specify whether the flow should use the nominal packet error rate (PER) PHY profile or the Very Low PER PHY profile.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The flow PER profile.

RMH_PQoSFlow_GetIngressClassificationRule()

RMH_Result RMH_PQoSFlow_GetIngressClassificationRule	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the ingress classification rule for assigning MSDUs to the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The ingress classification rule.

RMH_PQoSFlow_GetPacketSize()

RMH_Result RMH_PQoSFlow_GetPacketSize	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the packet size in bytes of the flow specified by flowId.

This includes the VLAN header but not including the FCS.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The flow packet size.

RMH_PQoSFlow_GetTotalTxPackets()

RMH_Result RMH_PQoSFlow_GetTotalTxPackets	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the total number of packets transmitted on the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The total number of packets transmitted.

RMH_PQoSFlow_GetDSCPMoCA()

RMH_Result RMH_PQoSFlow_GetDSCPMoCA	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the DSCP MoCA value for the flow specified by flowId.

The value of the three MSB of the DSCP Type of Service field is used for MSDU classification when RMH_PQoSFlow_GetIngressClassificationRule is set to 1 or 3.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The DSCP MoCA.

RMH_PQoSFlow_GetDFID()

RMH_Result RMH_PQoSFlow_GetDFID	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		uint32_t *	response
	)

Return the destination flow ID of the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The DFID of the flow.

RMH_PQoSFlow_GetDestination()

RMH_Result RMH_PQoSFlow_GetDestination	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		RMH_MacAddress_t *	response
	)

Return the destination flow ID of the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The DFID of the flow.

RMH_PQoSFlow_GetIngressMac()

RMH_Result RMH_PQoSFlow_GetIngressMac	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		RMH_MacAddress_t *	response
	)

Return the ingress MAC address of the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The ingress MAC of the flow.

RMH_PQoSFlow_GetEgressMac()

RMH_Result RMH_PQoSFlow_GetEgressMac	(	const RMH_Handle	handle,
		const RMH_MacAddress_t	flowId,
		RMH_MacAddress_t *	response
	)

Return the egress MAC address of the flow specified by flowId.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	flowId	The unique flow identifier.
[out]	response	The ingress MAC of the flow.

RMH_PQoS_GetMinEgressBandwidth()

RMH_Result RMH_PQoS_GetMinEgressBandwidth	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the node Id with the minimum available bandwidth.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The node Id with the minimum available bandwidth.

RMH_Stats_GetAdmissionAttempts()

RMH_Result RMH_Stats_GetAdmissionAttempts	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of admission attempts this node has made.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of admission attempts.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetAdmissionFailures()

RMH_Result RMH_Stats_GetAdmissionFailures	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of admission failures for this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of admission failures by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetAdmissionSucceeded()

RMH_Result RMH_Stats_GetAdmissionSucceeded	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of successful admissions for this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of successful admissions by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetAdmissionsDeniedAsNC()

RMH_Result RMH_Stats_GetAdmissionsDeniedAsNC	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of admissions this node has denied when it was the NC.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of admissions this node has denied when it was the NC.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxTotalBytes()

RMH_Result RMH_Stats_GetTxTotalBytes	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of bytes transmitted by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total number of bytes transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxTotalBytes()

RMH_Result RMH_Stats_GetRxTotalBytes	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of bytes received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total number of bytes received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxTotalPackets()

RMH_Result RMH_Stats_GetTxTotalPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of packets transmitted by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of packets transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxTotalPackets()

RMH_Result RMH_Stats_GetRxTotalPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of packets received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of received transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxUnicastPackets()

RMH_Result RMH_Stats_GetTxUnicastPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of unicast packets transmitted by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of unicast packets transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxUnicastPackets()

RMH_Result RMH_Stats_GetRxUnicastPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of unicast packets received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of unicast packets received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxBroadcastPackets()

RMH_Result RMH_Stats_GetTxBroadcastPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of broadcast packets transmitted by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of broadcast packets transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxBroadcastPackets()

RMH_Result RMH_Stats_GetRxBroadcastPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of broadcast packets received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of broadcast packets received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxMulticastPackets()

RMH_Result RMH_Stats_GetTxMulticastPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of multicast packets transmitted by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of multicast packets transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxMulticastPackets()

RMH_Result RMH_Stats_GetRxMulticastPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of multicast packets received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of multicast packets received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxReservationRequestPackets()

RMH_Result RMH_Stats_GetTxReservationRequestPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of reservation request packets transmitted by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of reservation request packets transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxReservationRequestPackets()

RMH_Result RMH_Stats_GetRxReservationRequestPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of reservation request packets received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of reservation request packets received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxMapPackets()

RMH_Result RMH_Stats_GetTxMapPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of MAP transmitted by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of MAP packets transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxMapPackets()

RMH_Result RMH_Stats_GetRxMapPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of MAP received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of MAP packets received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxLinkControlPackets()

RMH_Result RMH_Stats_GetTxLinkControlPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of link control transmitted by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of link control packets transmitted by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxLinkControlPackets()

RMH_Result RMH_Stats_GetRxLinkControlPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of link control received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of link control packets received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxBeacons()

RMH_Result RMH_Stats_GetTxBeacons	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of link control received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of link control packets received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxBeacons()

RMH_Result RMH_Stats_GetRxBeacons	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of beacons received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of beacons received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxUnknownProtocolPackets()

RMH_Result RMH_Stats_GetRxUnknownProtocolPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of unknown packets received by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of unknown packets received by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxDroppedPackets()

RMH_Result RMH_Stats_GetTxDroppedPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of packets this node has dropped before transmitting.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of packets dropped by this node before transmitting.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxDroppedPackets()

RMH_Result RMH_Stats_GetRxDroppedPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the number of packets this node has dropped after receiving.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The number of received packets dropped by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxTotalErrors()

RMH_Result RMH_Stats_GetTxTotalErrors	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of transmit errors by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total number of transmit errors by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxTotalErrors()

RMH_Result RMH_Stats_GetRxTotalErrors	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of received errors by this node.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total number of receive errors by this node.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxCRCErrors()

RMH_Result RMH_Stats_GetRxCRCErrors	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of packets this node has received with CRC errors.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total number of received packets with CRC errors.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxTimeoutErrors()

RMH_Result RMH_Stats_GetRxTimeoutErrors	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of packets this node has received with timeout errors.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total number of received packets with timeout errors.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxTotalAggregatedPackets()

RMH_Result RMH_Stats_GetRxTotalAggregatedPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of received aggregated packets.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total number of received aggregated packets.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxTotalAggregatedPackets()

RMH_Result RMH_Stats_GetTxTotalAggregatedPackets	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the total number of transmitted aggregated packets.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total number of transmitted aggregated packets.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxPacketAggregation()

RMH_Result RMH_Stats_GetRxPacketAggregation	(	const RMH_Handle	handle,
		uint32_t *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return an array indicating the number of packets received per aggregation number.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseArray	The total number of transmitted aggregated packets.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetTxPacketAggregation()

RMH_Result RMH_Stats_GetTxPacketAggregation	(	const RMH_Handle	handle,
		uint32_t *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Return an array indicating the number of packets transmitted per aggregation number.

The array index indicates the number of transmitted bursts. So index 0 counts transmitted bursts with actual aggregation of 0, index 2 counts actual aggregation of 2, and so on.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseArray	An array where the aggregation information should be returned.
[in]	responseArraySize	The size of the response array.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxCorrectedErrors()

RMH_Result RMH_Stats_GetRxCorrectedErrors	(	const RMH_Handle	handle,
		RMH_NodeList_Uint32_t *	response
	)

Return the number of received packets from every node with errors which were corrected.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Number of corrected errors for that node, if nodePresent is true.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_GetRxUncorrectedErrors()

RMH_Result RMH_Stats_GetRxUncorrectedErrors	(	const RMH_Handle	handle,
		RMH_NodeList_Uint32_t *	response
	)

Return the number of received packets from every node with errors which were not corrected.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	Number of corrected errors for that node, if nodePresent is true.

Note

This counter is reset by RMH_Stats_Reset.

RMH_Stats_Reset()

RMH_Result RMH_Stats_Reset

(

const RMH_Handle

handle

)

Reset MoCA statistics counters back to zero.

Parameters

[in]

handle

The RMH handle as returned by RMH_Initialize.

RMH_Log_GetAPILevel()

RMH_Result RMH_Log_GetAPILevel	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return a bitmask of RMH_LogLevel which indicates the currently enabled RMH log types in the RMH library.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The RMH API log level.

Note

This API is for log messages from RMH libraries only. The log level of the lower level MoCA driver should be read with RMH_Log_GetDriverLevel.

RMH_Log_SetAPILevel()

RMH_Result RMH_Log_SetAPILevel	(	const RMH_Handle	handle,
		const uint32_t	value
	)

Set the log level of the RMH library.

This is set as a bitmask of RMH_LogLevel indicating the RMH log types to enable in the RMH libraries.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	The desired RMH API log level.

RMH_Log_GetDriverLevel()

RMH_Result RMH_Log_GetDriverLevel	(	const RMH_Handle	handle,
		RMH_LogLevel *	response
	)

Return a bitmask of RMH_LogLevel which indicates the currently enabled RMH log types in the MoCA driver.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The SoC MoCA Driver log level.

Note

This API is for log messages from SoC MoCA driver only. The log level of the RMH library should be read with RMH_Log_GetDriverLevel.

RMH_Log_SetDriverLevel()

RMH_Result RMH_Log_SetDriverLevel	(	const RMH_Handle	handle,
		const RMH_LogLevel	value
	)

Set the log level of the MoCA driver.

This is set as a bitmask of RMH_LogLevel indicating the RMH log types to enable at the driver.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The SoC MoCA Driver log level.

Note

This API is for log messages from SoC MoCA driver only. The log level of the RMH libraries should be set with RMH_Log_SetAPILevel.

RMH_Log_GetDriverFilename()

RMH_Result RMH_Log_GetDriverFilename	(	const RMH_Handle	handle,
		char *	responseBuf,
		const size_t	responseBufSize
	)

Get the file name where MoCA driver logs are currently being captured.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	responseBuf	A buffer where the filename will be written.
[in]	responseBufSize	The size in bytes of the buffer responseBuf.

Note

This API is for log messages from SoC MoCA driver only. The log level of the RMH libraries should be set with RMH_Log_SetAPILevel.

RMH_Log_SetDriverFilename()

RMH_Result RMH_Log_SetDriverFilename	(	const RMH_Handle	handle,
		const char *	value
	)

Set the file name where MoCA driver logs should be captured to.

If logs are already being captured to a file this capture will stop at that location and begin in this file. If the new log file already exists new logs will append to it.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	value	A file name where logs should be written.

Note

This API is for log messages from SoC MoCA driver only. The log level of the RMH libraries should be set with RMH_Log_SetAPILevel.

RMH_Log_PrintStatus()

RMH_Result RMH_Log_PrintStatus	(	const RMH_Handle	handle,
		const char *	filename
	)

Print a generic status summary of the MoCA device and network.

If filename is NULL all log messages are printed with RMH_LOG_MESSAGE. If it is not NULL the status will be appended to that file.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize. NULL is valid for this API.
[in]	filename	The file name where to write the status. If this is NULL the status will be written to RMH_LOG_MESSAGE.

RMH_ACA_Request()

RMH_Result RMH_ACA_Request	(	const RMH_Handle	handle,
		const uint32_t	channelNum,
		const uint32_t	sourceNodeId,
		const uint32_t	destinationNodeMask,
		const RMH_ACAType	type
	)

Print a summary of the sub carrier modulation bitloading information.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize. NULL is valid for this API.
[in]	filename	The file name where to write the status. If this is NULL the status will be written to RMH_LOG_MESSAGE.

RMH_ACA_GetChannel()

RMH_Result RMH_ACA_GetChannel	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the channel number of the last requested ACA. [mocaIfAcaNodeID].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The channel number of the last requested ACA. [mocaIfAcaNodeID].

RMH_ACA_GetSourceNodeId()

RMH_Result RMH_ACA_GetSourceNodeId	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the Node ID of the source node for the last requested ACA. [mocaIfAcaNodeID].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The Node ID of the source node for the last requested ACA. [mocaIfAcaNodeID].

RMH_ACA_GetDestinationNodeMask()

RMH_Result RMH_ACA_GetDestinationNodeMask	(	const RMH_Handle	handle,
		uint32_t *	response
	)

Return the bitmask of the destination nodes for the last requested ACA. [mocaIfAcaReportNodeMask].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The bitmask of the destination nodes for the last requested ACA. [mocaIfAcaReportNodeMask].

RMH_ACA_GetType()

RMH_Result RMH_ACA_GetType	(	const RMH_Handle	handle,
		RMH_ACAType *	response
	)

Return the type of the last requested ACA operation.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The type of the last requested ACA operation [mocaIfAcaType].

RMH_ACA_GetStatus()

RMH_Result RMH_ACA_GetStatus	(	const RMH_Handle	handle,
		RMH_ACAStatus *	response
	)

Return the current status of the last requested ACA operation.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The current status of the previously started ACA operation [mocaIfAcaStatus].

RMH_ACA_GetTotalRxPower()

RMH_Result RMH_ACA_GetTotalRxPower	(	const RMH_Handle	handle,
		int32_t *	response
	)

Return the total power from the last completed ACA operation.

This call will fail if an ACA operation is already in progress.

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[out]	response	The total power from the last completed ACA operation [mocaIfAcaTotalRxPower].

RMH_ACA_GetPowerProfile()

RMH_Result RMH_ACA_GetPowerProfile	(	const RMH_Handle	handle,
		uint8_t *	responseArray,
		const size_t	responseArraySize,
		size_t *	responseArrayUsed
	)

Returns the ACA power profile.

Returns a binary string array with 1 byte for each subcarrier. [mocaIfAcaPowerProfile].

Parameters

[in]	handle	The RMH handle as returned by RMH_Initialize.
[in]	responseArray	The ACA power profile.
[in]	responseArraySize	The size of responseArray.
[out]	responseArrayUsed	The number of entries in the response array which have valid data.