 |
RDK-B
|
|
RDK-B
|
Data Structures | |
| struct | _MTAMGMT_PROVISIONING_PARAMS |
Macros | |
| #define | MTA_DHCPOPTION122SUBOPTION1_MAX 4 |
| #define | MTA_DHCPOPTION122SUBOPTION2_MAX 4 |
| #define | MTA_DHCPOPTION122CCCV6DSSID1_MAX 32 |
| #define | MTA_DHCPOPTION122CCCV6DSSID2_MAX 32 |
Typedefs | |
| typedef struct _MTAMGMT_PROVISIONING_PARAMS | MTAMGMT_PROVISIONING_PARAMS |
| typedef struct _MTAMGMT_PROVISIONING_PARAMS * | PMTAMGMT_MTA_PROVISIONING_PARAMS |
| typedef int(* | mta_hal_getLineRegisterStatus_callback) (MTAMGMT_MTA_STATUS *output_status_array, int array_size) |
Enumerations | |
| enum | MTAMGMT_MTA_PROV_IP_MODE { MTA_IPV4 =0, MTA_IPV6 =1, MTA_DUAL_STACK =2 } |
| struct _MTAMGMT_PROVISIONING_PARAMS |
Data Fields | |
| int | MtaIPMode |
| int | DhcpOption2171CccV6DssID1Len |
| int | DhcpOption2171CccV6DssID2Len |
| char | DhcpOption122Suboption1 [4+1] |
| char | DhcpOption122Suboption2 [4+1] |
| char | DhcpOption2171CccV6DssID1 [32+1] |
| char | DhcpOption2171CccV6DssID2 [32+1] |
| int _MTAMGMT_PROVISIONING_PARAMS::DhcpOption2171CccV6DssID1Len |
| int _MTAMGMT_PROVISIONING_PARAMS::DhcpOption2171CccV6DssID2Len |
| char _MTAMGMT_PROVISIONING_PARAMS::DhcpOption122Suboption1[4+1] |
| char _MTAMGMT_PROVISIONING_PARAMS::DhcpOption122Suboption2[4+1] |
| char _MTAMGMT_PROVISIONING_PARAMS::DhcpOption2171CccV6DssID1[32+1] |
| typedef int( * mta_hal_getLineRegisterStatus_callback) (MTAMGMT_MTA_STATUS *output_status_array, int array_size) |
@description This call back will be invoked to returing MTA line
| MTAMGMT_MTA_STATUS | *output_status_array - return array buffer for all line register status |
| int | array_size - buffer size (total line number) |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_InitDB | ( | void | ) |
@description Retrieves the global information for all shared DBs and makes them accessible locally.
| None |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetDHCPInfo | ( | PMTAMGMT_MTA_DHCP_INFO | pInfo | ) |
@description Retrieve all the relevant DHCP info for MTA.
| PMTAMGMT_MTA_DHCP_INFO | pInfo - all DHCP info for MTA, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetDHCPV6Info | ( | PMTAMGMT_MTA_DHCPv6_INFO | pInfo | ) |
| unsigned long mta_hal_LineTableGetNumberOfEntries | ( | void | ) |
@description Get number of entries in the line table.
| None |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_LineTableGetEntry | ( | unsigned long | Index, |
| PMTAMGMT_MTA_LINETABLE_INFO | pEntry | ||
| ) |
@description Get entry of the line table at the given index
| INT | Index - index to the table entry |
| PMTAMGMT_MTA_LINETABLE_INFO | pEntry - entry info, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_TriggerDiagnostics | ( | unsigned long | Index | ) |
@description Trigger GR909 Diagnostics
| INT | Index - line number to perform the GR909 diagnostics on |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetServiceFlow | ( | unsigned long * | Count, |
| PMTAMGMT_MTA_SERVICE_FLOW * | ppCfg | ||
| ) |
@description Get all the service flow info
| ULONG* | Count - number of service flow entries, to be returned |
| PMTAMGMT_MTA_SERVICE_FLOW | *ppCfg - service flow info, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_DectGetEnable | ( | unsigned char * | pBool | ) |
@description Get info on if Dect is enabled
| BOOLEAN* | pBool - boolean value for enabled or not, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_DectSetEnable | ( | unsigned char | bBool | ) |
@description Set Dect to boolean value passed in
| BOOLEAN* | bBool - boolean value for enabled or not, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_DectGetRegistrationMode | ( | unsigned char * | pBool | ) |
@description Set Dect to boolean value passed in
| BOOLEAN* | bBool - boolean value for enabled or not, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_DectSetRegistrationMode | ( | unsigned char | bBool | ) |
@description Set Dect registration mode
| BOOLEAN* | bBool - boolean value for enabled or not, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_DectDeregisterDectHandset | ( | unsigned long | uValue | ) |
@description Deregister Dect Handset
| ULONG* | uValue - unsigned long value for |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetDect | ( | PMTAMGMT_MTA_DECT | pDect | ) |
@description Get Dect info
| PMTAMGMT_MTA_DECT* | pDect - info of Dect |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetDectPIN | ( | char * | pPINString | ) |
@description get Decr PIN
| char* | pPINString - PIN value |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_SetDectPIN | ( | char * | pPINString | ) |
@description Set Dect PIN
| char* | pPINString - PIN value |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetHandsets | ( | unsigned long * | pulCount, |
| PMTAMGMT_MTA_HANDSETS_INFO * | ppHandsets | ||
| ) |
@description Get MTA handset info
| ULONG* | pulCount - handset number |
| PMTAMGMT_MTA_HANDSETS_INFO* | ppHandsets - Info of MTA handset |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetCalls | ( | unsigned long | InstanceNumber, |
| unsigned long * | Count, | ||
| PMTAMGMT_MTA_CALLS * | ppCfg | ||
| ) |
@description Retrieve all call info for the given instance number of LineTable
| ULONG | InstanceNumber - LineTable's instance number |
| ULONG | *Count - number of entries(calls) for the call info array, to be returned |
| PMTAMGMT_MTA_CALLS | *ppCfg - Array of call info, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetCALLP | ( | unsigned long | LineNumber, |
| PMTAMGMT_MTA_CALLP | pCallp | ||
| ) |
@description Retrieve the CALLP status info for the line number
| ULONG | LineNumber - Line number for which to retrieve info on |
| PMTAMGMT_MTA_CALLP | pCallp - CallP info, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetDSXLogs | ( | unsigned long * | Count, |
| PMTAMGMT_MTA_DSXLOG * | ppDSXLog | ||
| ) |
@description Retrieve all DSX log entries
| ULONG | *Count - number of entries in the log, to be returned |
| PMTAMGMT_MTA_DSXLOG | *ppDSXLog - array of log entries, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetDSXLogEnable | ( | unsigned char * | pBool | ) |
@description Get the value of if DSX log is enabled
| BOOLEAN | * pBool - boolean value of enable, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_SetDSXLogEnable | ( | unsigned char | Bool | ) |
@description Set value of DSX enable to the value
| BOOLEAN | Bool - value to set DSX log enable to |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_ClearDSXLog | ( | unsigned char | Bool | ) |
@description Set value of ClearDSXLog to the value
| BOOLEAN | Bool - value to set to clear DSX log. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetCallSignallingLogEnable | ( | unsigned char * | pBool | ) |
@description Get the value of if CallSignalling log is enabled
| BOOLEAN | * pBool - boolean value of enable, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_SetCallSignallingLogEnable | ( | unsigned char | Bool | ) |
@description Set value of CallSignalling enable to the value
| BOOLEAN | Bool - value to set CallSignalling log enable to |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_ClearCallSignallingLog | ( | unsigned char | Bool | ) |
@description Set value of CallSignalling enable to the value
| BOOLEAN | Bool - value to set to clear CallSignalling log. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_GetMtaLog | ( | unsigned long * | Count, |
| PMTAMGMT_MTA_MTALOG_FULL * | ppCfg | ||
| ) |
@description Get all log entries from the MTA Log
| ULONG | *Count - number of entries in the log, to be returned |
| PMTAMGMT_MTA_MTALOG_FULL | *ppCfg - array of log entries, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetInstalled | ( | unsigned char * | Val | ) |
@description Check to see if the battery is installed
| BOOLEAN* | Val - TRUE/FALSE, value to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetTotalCapacity | ( | unsigned long * | Val | ) |
@description Get the total capacity of the battery
| INT* | Val - capacity in mAVHour, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetActualCapacity | ( | unsigned long * | Val | ) |
@description Retrieve the actual capacity of the battery
| INT* | Val - capacity in mAVHour, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetRemainingCharge | ( | unsigned long * | Val | ) |
@description Retrieve the current charge remain in the battery
| INT* | Val - capacity in mAVHour, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetRemainingTime | ( | unsigned long * | Val | ) |
@description Get estimated battery remaining time if current usage continues
| INT* | Val - Remaining time in minutes, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetNumberofCycles | ( | unsigned long * | Val | ) |
@description Get max number of cycles the battery can be charge cycled
| INT* | Val - Max number of cycles, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetPowerStatus | ( | char * | Val, |
| unsigned long * | len | ||
| ) |
@description Get power status of MTA
| CHAR* | Val - Status of "AC", "Battery", or "Unknown", to be returned |
| ULONG | *len - string length, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetCondition | ( | char * | Val, |
| unsigned long * | len | ||
| ) |
@description Get the battery condition
| CHAR* | Val - Status of "Good" or "Bad", to be returned |
| ULONG | *len - string length, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetStatus | ( | char * | Val, |
| unsigned long * | len | ||
| ) |
@description Get the battery status
| CHAR* | Val - Status of "Missing", "Idle", "Charging", "Discharging", or "Unknown", to be returned |
| ULONG | *len - string length, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetLife | ( | char * | Val, |
| unsigned long * | len | ||
| ) |
@description Get the battery life status
| CHAR* | Val - Values of "Need Replacement", or "Good", to be returned |
| ULONG | *len - string length, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetInfo | ( | PMTAMGMT_MTA_BATTERY_INFO | pInfo | ) |
@description Get the battery info
| PMTAMGMT_MTA_BATTERY_INFO | pInfo - battery info, to be returned |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_BatteryGetPowerSavingModeStatus | ( | unsigned long * | pValue | ) |
@description Get the battery Power Saving Mode Status
| ULONG | *pValue- Values of 1 for Enabled, 2 for Disabled |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_Get_MTAResetCount | ( | unsigned long * | resetcnt | ) |
@description Get the reset count of MTA
| ULONG | *pValue- count |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_Get_LineResetCount | ( | unsigned long * | resetcnt | ) |
@description Get the reset count of MTA Lines
| ULONG | *pValue- count |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_ClearCalls | ( | unsigned long | InstanceNumber | ) |
@description clear the VQM stats per line
| ULONG | InstanceNumber - instance number |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_getDhcpStatus | ( | MTAMGMT_MTA_STATUS * | output_pIpv4status, |
| MTAMGMT_MTA_STATUS * | output_pIpv6status | ||
| ) |
@description Get the DHCP status for MTA
| MTAMGMT_MTA_STATUS | *output_pIpv4status - ipv4 dhcp status |
| MTAMGMT_MTA_STATUS | *output_pIpv6status - ipv6 dhcp status |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_getConfigFileStatus | ( | MTAMGMT_MTA_STATUS * | poutput_status | ) |
@description Get the MTA config file status
| MTAMGMT_MTA_STATUS | *poutput_status - config file status |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_getLineRegisterStatus | ( | MTAMGMT_MTA_STATUS * | output_status_array, |
| int | array_size | ||
| ) |
@description Get the register status for all lines
| MTAMGMT_MTA_STATUS | *output_status_array - return array buffer for all line register status |
| int | array_size - buffer size (total line number) |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_devResetNow | ( | unsigned char | bResetValue | ) |
@description Set boolean value passed to reset MTA device
| BOOLEAN | bResetValue - boolean value to reset the device |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_getMtaOperationalStatus | ( | MTAMGMT_MTA_STATUS * | operationalStatus | ) |
@description Get the operational status of MTA
| MTAMGMT_MTA_STATUS | *operationalStatus - return buffer for operational status |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_getMtaProvisioningStatus | ( | MTAMGMT_MTA_PROVISION_STATUS * | provisionStatus | ) |
@description Get the provisional status of MTA
| MTAMGMT_MTA_PROVISION_STATUS | *provisionStatus - return buffer for provision status |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int mta_hal_start_provisioning | ( | PMTAMGMT_MTA_PROVISIONING_PARAMS | pParameters | ) |
@description This API call will start IP provisioning for all the lines for IPv4/IPv6 , or dual mode
| PMTAMGMT_MTA_PROVISIONING | pParameters - IP provisioning for all line register status |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| void mta_hal_LineRegisterStatus_callback_register | ( | mta_hal_getLineRegisterStatus_callback | callback_proc | ) |
@description This call back will be invoked to returing MTA line
| mta_hal_getLineRegisterStatus_callback | callback_proc - Callback registration function. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
1.8.17