Description

Functions
int	cm_hal_InitDB (void)

int	docsis_InitDS (void)

int	docsis_InitUS (void)

int	docsis_getCMStatus (char *cm_status)

int	docsis_GetDSChannel (PCMMGMT_CM_DS_CHANNEL *ppinfo)

int	docsis_GetUsStatus (unsigned short i, PCMMGMT_CM_US_CHANNEL pinfo)

int	docsis_GetUSChannel (PCMMGMT_CM_US_CHANNEL *ppinfo)

int	docsis_GetDOCSISInfo (PCMMGMT_CM_DOCSIS_INFO pinfo)

int	docsis_GetNumOfActiveTxChannels (unsigned long *cnt)

int	docsis_GetNumOfActiveRxChannels (unsigned long *cnt)

int	docsis_GetErrorCodewords (PCMMGMT_CM_ERROR_CODEWORDS *ppinfo)

int	docsis_GetMddIpModeOverride (char *pValue)

int	docsis_SetMddIpModeOverride (char *pValue)

unsigned char	docsis_GetUSChannelId (void)

void	docsis_SetUSChannelId (int index)

unsigned long	docsis_GetDownFreq (void)

void	docsis_SetStartFreq (unsigned long value)

int	docsis_GetDocsisEventLogItems (CMMGMT_CM_EventLogEntry_t *entryArray, int len)

int	docsis_ClearDocsisEventLog (void)

int	cm_hal_GetDHCPInfo (PCMMGMT_CM_DHCP_INFO pInfo)

int	cm_hal_GetIPv6DHCPInfo (PCMMGMT_CM_IPV6DHCP_INFO pInfo)

int	cm_hal_GetCPEList (PCMMGMT_DML_CPE_LIST ppCPEList, unsigned long InstanceNum, char *LanMode)

int	cm_hal_GetMarket (char *market)

int	cm_hal_Set_HTTP_Download_Url (char pHttpUrl, char pfilename)

int	cm_hal_Get_HTTP_Download_Url (char pHttpUrl, char pfilename)

int	cm_hal_Set_HTTP_Download_Interface (unsigned int interface)

int	cm_hal_Get_HTTP_Download_Interface (unsigned int *pinterface)

int	cm_hal_HTTP_Download ()

int	cm_hal_Get_HTTP_Download_Status ()

int	cm_hal_Reboot_Ready (unsigned long *pValue)

int	cm_hal_HTTP_Download_Reboot_Now ()

int	cm_hal_FWupdateAndFactoryReset (char pUrl, char pImagename)

int	cm_hal_ReinitMac ()

int	docsis_GetProvIpType (char *pValue)

int	docsis_GetCert (char *pCert)

int	docsis_GetCertStatus (unsigned long *pVal)

int	cm_hal_Get_CableModemResetCount (unsigned long *resetcnt)

int	cm_hal_Get_LocalResetCount (unsigned long *resetcnt)

int	cm_hal_Get_DocsisResetCount (unsigned long *resetcnt)

int	cm_hal_Get_ErouterResetCount (unsigned long *resetcnt)

int	cm_hal_HTTP_LED_Flash (unsigned char LedFlash)

int	docsis_GetDsOfdmChanTable (PDOCSIF31_CM_DS_OFDM_CHAN ppinfo, int output_NumberOfEntries)

int	docsis_GetUsOfdmaChanTable (PDOCSIF31_CM_US_OFDMA_CHAN ppinfo, int output_NumberOfEntries)

int	docsis_GetStatusOfdmaUsTable (PDOCSIF31_CMSTATUSOFDMA_US ppinfo, int output_NumberOfEntries)

int	cm_hal_snmpv3_kickstart_initialize (snmpv3_kickstart_table_t *pKickstart_Table)

Function Documentation

◆ cm_hal_InitDB()

int cm_hal_InitDB ( void )

@description Retrieves the global information for all shared DBs and makes them accessible locally.

Parameters

None

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_InitDS()

int docsis_InitDS ( void )

@description Init global PHY level info and DBs and get direct access to DS HW.

Parameters

None

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_InitUS()

int docsis_InitUS ( void )

@description Init global PHY level info and DBs and get direct access to US HW.

Parameters

None

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_getCMStatus()

int docsis_getCMStatus ( char * cm_status )

@description Retrieve, format and output the Cable Modem DOCSIS status.

Parameters

CHAR* cm_status - status string, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetDSChannel()

int docsis_GetDSChannel ( PCMMGMT_CM_DS_CHANNEL * ppinfo )

@description Retrieve all the relevant DS channel info from global DBs.

Parameters

PCMMGMT_CM_DS_CHANNEL * ppinfo - all info of DS channel, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetUsStatus()

int docsis_GetUsStatus	(	unsigned short	i,
		PCMMGMT_CM_US_CHANNEL	pinfo
	)

@description Retrieve all the relevant US channel info from global DBs.

Parameters

USHORT	i - index to the US channel
PCMMGMT_CM_US_CHANNEL	pinfo - info of one US channel, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetUSChannel()

int docsis_GetUSChannel ( PCMMGMT_CM_US_CHANNEL * ppinfo )

@description Retrieve particular US channel information from global DBs.

Parameters

PCMMGMT_CM_US_CHANNEL * ppinfo - all info of US channel, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetDOCSISInfo()

int docsis_GetDOCSISInfo ( PCMMGMT_CM_DOCSIS_INFO pinfo )

@description Retrieve current DOCSIS registration status and report it.

Parameters

PCMMGMT_CM_DOCSIS_INFO pinfo - registration info, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetNumOfActiveTxChannels()

int docsis_GetNumOfActiveTxChannels ( unsigned long * cnt )

@description Retrieve number of US channels actively in use in current registration.

Parameters

ULONG * cnt - pointer to number, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetNumOfActiveRxChannels()

int docsis_GetNumOfActiveRxChannels ( unsigned long * cnt )

@description Retrieve number of DS channels actively in use in current registration. @Param ULONG * cnt - pointer to number, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetErrorCodewords()

int docsis_GetErrorCodewords ( PCMMGMT_CM_ERROR_CODEWORDS * ppinfo )

@description Scan all active DS channels and report errors in packets received.

Parameters

PCMMGMT_CM_ERROR_CODEWORDS * ppinfo - error info retrieved

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetMddIpModeOverride()

int docsis_GetMddIpModeOverride ( char * pValue )

@description Retrieve the current MIMO status.

Parameters

CHAR	*pValue - status retrieved

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_SetMddIpModeOverride()

int docsis_SetMddIpModeOverride ( char * pValue )

@description Set the current global MIMO status.

Parameters

CHAR	*pValue - status to be set to

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetUSChannelId()

unsigned char docsis_GetUSChannelId ( void )

@description Retrieve the US channel ID in its MAC domain.

Parameters

none

Returns: UINT8 - Channel ID

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_SetUSChannelId()

void docsis_SetUSChannelId ( int index )

@description Set the US channel ID in its MAC domain.

Parameters

INT	index = Index to set the Upstream Channel ID to

Returns: None

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetDownFreq()

unsigned long docsis_GetDownFreq ( void )

@description Retrieve the current primary channel DS channel frequency from the LKF table.

Parameters

None

Returns: ULONG - channel frequency

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_SetStartFreq()

void docsis_SetStartFreq ( unsigned long value )

@description Change the DS primary channel frequency in the LKF table.

Parameters

ULONG value - frequency to get set to

Returns: None

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetDocsisEventLogItems()

int docsis_GetDocsisEventLogItems	(	CMMGMT_CM_EventLogEntry_t *	entryArray,
		int	len
	)

@description Retrieve the DOCSIS event log entries and display it.

Parameters

CMMGMT_CM_EventLogEntry_t	*entryArray - entries to be returned
INT	len - length of log entries

Returns: INT - number of log entries retrieved

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_ClearDocsisEventLog()

int docsis_ClearDocsisEventLog ( void )

@description Clear the DOCSIS event log.

Parameters

None

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_GetDHCPInfo()

int cm_hal_GetDHCPInfo ( PCMMGMT_CM_DHCP_INFO pInfo )

@description Retrieve all the relevant DHCP info for this CM.

Parameters

PCMMGMT_CM_DHCP_INFO pInfo - all DHCP info for CM, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_GetIPv6DHCPInfo()

int cm_hal_GetIPv6DHCPInfo ( PCMMGMT_CM_IPV6DHCP_INFO pInfo )

@description Retrieve all the relevant IPv6 DHCP info for this CM.

Parameters

PCMMGMT_CM_IPV6DHCP_INFO pInfo - all IPv6 DHCP info for CM, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_GetCPEList()

int cm_hal_GetCPEList	(	PCMMGMT_DML_CPE_LIST *	ppCPEList,
		unsigned long *	InstanceNum,
		char *	LanMode
	)

@description Retrieve list of CPEs connected to the CM

Parameters

PCMMGMT_DML_CPE_LIST	* ppCPEList - List of all CPE, to be returned
ULONG*	InstnaceNum - Number of instances, to be returned
CHAR*	LanMode - input of "router" or "bridge" mode of the modem

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_GetMarket()

int cm_hal_GetMarket ( char * market )

@description Retrieve the market of this modem

Parameters

CHAR* market - Name of the market for this modem, "US" or "EURO", to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_Set_HTTP_Download_Url()

int cm_hal_Set_HTTP_Download_Url	(	char *	pHttpUrl,
		char *	pfilename
	)

@description Set Http Download Settings

Parameters

char*	pHttpUrl
char*	pfilename

Returns: the status of the operation

Return values

RETURN_OK	if successful.
RETURN_ERR	if any Downloading is in process or Url string is invalided.

◆ cm_hal_Get_HTTP_Download_Url()

int cm_hal_Get_HTTP_Download_Url	(	char *	pHttpUrl,
		char *	pfilename
	)

@description Get Http Download Url

Parameters

char*	pHttpUrl
char*	pfilename

Returns: the status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if http url string is empty.

◆ cm_hal_Set_HTTP_Download_Interface()

int cm_hal_Set_HTTP_Download_Interface ( unsigned int interface )

@description Set the HTTP Download Interface

Parameters

unsigned int interface - interface=0 for wan0, interface=1 for erouter0

Returns: the status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

◆ cm_hal_Get_HTTP_Download_Interface()

int cm_hal_Get_HTTP_Download_Interface ( unsigned int * pinterface )

@description Get the HTTP Download Interface

Parameters

unsigned int* pinterface - interface=0 for wan0, interface=1 for erouter0

Returns: the status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

◆ cm_hal_HTTP_Download()

int cm_hal_HTTP_Download ( )

@description Start Http Download

Parameters

<None>

Returns: the status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any Downloading is in process.

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_Get_HTTP_Download_Status()

int cm_hal_Get_HTTP_Download_Status ( )

@description Get the HTTP Download Status

Parameters

<None>

Returns: the status of the HTTP Download.

Return values

0	- Download is not started.
0-100	- Values of percent of download.
200	- Download is completed and waiting for reboot.
400	- Invalided Http server Url
401	- Cannot connect to Http server
402	- File is not found on Http server
403	- HW_Type_DL_Protection Failure
404	- HW Mask DL Protection Failure
405	- DL Rev Protection Failure
406	- DL Header Protection Failure
407	- DL CVC Failure
500	- General Download Failure

◆ cm_hal_Reboot_Ready()

int cm_hal_Reboot_Ready ( unsigned long * pValue )

@description Get the Reboot Ready Status

Parameters

ULONG *pValue- Values of 1 for Ready, 2 for Not Ready

Returns: the status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

◆ cm_hal_HTTP_Download_Reboot_Now()

int cm_hal_HTTP_Download_Reboot_Now ( )

@description Http Download Reboot Now

Parameters

<None>

Returns: the status of the reboot operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any reboot is in process.

◆ cm_hal_FWupdateAndFactoryReset()

int cm_hal_FWupdateAndFactoryReset	(	char *	pUrl,
		char *	pImagename
	)

@description: Firmware update and factory reset the device

Parameters

char*	pUrl - NULL for snmp
char*	pImagename - NULL for snmp

Returns: the status of the Firmware update and factory reset operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any reboot is in process.

◆ cm_hal_ReinitMac()

int cm_hal_ReinitMac ( )

@description Reinit CM. Performs reinit MAC only to same DS/US

Parameters

None

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetProvIpType()

int docsis_GetProvIpType ( char * pValue )

@description Retrieve the provisioned wan0 IP type

Parameters

CHAR* pValue - ip type currently provisioned on wan0 values are "IPv4", "IPv6", or "unknown"

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetCert()

int docsis_GetCert ( char * pCert )

@description Retrieve the location of the certificate

Parameters

CHAR* pCert - certificate location, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetCertStatus()

int docsis_GetCertStatus ( unsigned long * pVal )

@description Retrieve status of the certificate

Parameters

ULONG *pVal - certificate status, to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_Get_CableModemResetCount()

int cm_hal_Get_CableModemResetCount ( unsigned long * resetcnt )

@description Retrieve the count of cable modem reset

Parameters

ULONG *resetcnt - Count to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_Get_LocalResetCount()

int cm_hal_Get_LocalResetCount ( unsigned long * resetcnt )

@description Retrieve the count of local reset

Parameters

ULONG *resetcnt - Count to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_Get_DocsisResetCount()

int cm_hal_Get_DocsisResetCount ( unsigned long * resetcnt )

@description Retrieve the count of docsis reset

Parameters

ULONG *resetcnt - Count to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_Get_ErouterResetCount()

int cm_hal_Get_ErouterResetCount ( unsigned long * resetcnt )

@description Retrieve the count of erouter reset

Parameters

ULONG *resetcnt - Count to be returned

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ cm_hal_HTTP_LED_Flash()

int cm_hal_HTTP_LED_Flash ( unsigned char LedFlash )

@description Enable/Disable HTTP LED Flashing

Parameters

BOOLEAN *bLEDFlashState - Enable/Disable LED Flash

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ docsis_GetDsOfdmChanTable()

int docsis_GetDsOfdmChanTable	(	PDOCSIF31_CM_DS_OFDM_CHAN *	ppinfo,
		int *	output_NumberOfEntries
	)

@description Get the Downstream DSOF channel table (docsIf31CmDsOfdmChanTable)

Parameters

PDOCSIF31_CM_DS_OFDM_CHAN	*ppinfo - Ponter to get the return array
int	*output_NumberOfEntries - Array size need to be return with output_NumberOfEntries

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: HAL function need to allocate the array of DOCSIF31_CM_DS_OFDM_CHAN and return with ppinfo.

◆ docsis_GetUsOfdmaChanTable()

int docsis_GetUsOfdmaChanTable	(	PDOCSIF31_CM_US_OFDMA_CHAN *	ppinfo,
		int *	output_NumberOfEntries
	)

@description Get the Upstream DSOFA channel table (docsIf31CmUsOfdmaChanTables)

Parameters

PDOCSIF31_CM_US_OFDMA_CHAN	*ppinfo - Ponter to get the return array
int	*output_NumberOfEntries - Array size need to be return with output_NumberOfEntries

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: HAL function need to allocate the array of DOCSIF31_CM_US_OFDMA_CHAN and return with ppinfo.

◆ docsis_GetStatusOfdmaUsTable()

int docsis_GetStatusOfdmaUsTable	(	PDOCSIF31_CMSTATUSOFDMA_US *	ppinfo,
		int *	output_NumberOfEntries
	)

@description Get the Upstream DSOFA channel status table (docsIf31CmStatusOfdmaUsTable)

Parameters

PDOCSIF31_CMSTATUSOFDMA_US	*ppinfo - Ponter to get the return array
int	*output_NumberOfEntries - Array size need to be return with output_NumberOfEntries

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Note: HAL function need to allocate the array of DOCSIF31_CMSTATUSOFDMA_US and return with ppinfo.

◆ cm_hal_snmpv3_kickstart_initialize()

int cm_hal_snmpv3_kickstart_initialize ( snmpv3_kickstart_table_t * pKickstart_Table )

@description Configure the SNMPv3 security parameters on the CM.

Parameters

snmpv3_kickstart_table_t * pKickstart_Table - a pointer to the SNMPv3 kickstart table

Returns: The status of the operation.

Return values

RETURN_OK	if successful.
RETURN_ERR	if any error is detected

Execution:\n Synchronous.

Side Effects:\n None.

Description

Functions

Function Documentation

◆ cm_hal_InitDB()

◆ docsis_InitDS()

◆ docsis_InitUS()

◆ docsis_getCMStatus()

◆ docsis_GetDSChannel()

◆ docsis_GetUsStatus()

◆ docsis_GetUSChannel()

◆ docsis_GetDOCSISInfo()

◆ docsis_GetNumOfActiveTxChannels()

◆ docsis_GetNumOfActiveRxChannels()

◆ docsis_GetErrorCodewords()

◆ docsis_GetMddIpModeOverride()

◆ docsis_SetMddIpModeOverride()

◆ docsis_GetUSChannelId()

◆ docsis_SetUSChannelId()

◆ docsis_GetDownFreq()

◆ docsis_SetStartFreq()

◆ docsis_GetDocsisEventLogItems()

◆ docsis_ClearDocsisEventLog()

◆ cm_hal_GetDHCPInfo()

◆ cm_hal_GetIPv6DHCPInfo()

◆ cm_hal_GetCPEList()

◆ cm_hal_GetMarket()

◆ cm_hal_Set_HTTP_Download_Url()

◆ cm_hal_Get_HTTP_Download_Url()

◆ cm_hal_Set_HTTP_Download_Interface()

◆ cm_hal_Get_HTTP_Download_Interface()

◆ cm_hal_HTTP_Download()

◆ cm_hal_Get_HTTP_Download_Status()

◆ cm_hal_Reboot_Ready()

◆ cm_hal_HTTP_Download_Reboot_Now()

◆ cm_hal_FWupdateAndFactoryReset()

◆ cm_hal_ReinitMac()

◆ docsis_GetProvIpType()

◆ docsis_GetCert()

◆ docsis_GetCertStatus()

◆ cm_hal_Get_CableModemResetCount()

◆ cm_hal_Get_LocalResetCount()

◆ cm_hal_Get_DocsisResetCount()

◆ cm_hal_Get_ErouterResetCount()

◆ cm_hal_HTTP_LED_Flash()

◆ docsis_GetDsOfdmChanTable()

◆ docsis_GetUsOfdmaChanTable()

◆ docsis_GetStatusOfdmaUsTable()

◆ cm_hal_snmpv3_kickstart_initialize()