RDK-B
mta_hal.h File Reference

For CCSP Component: CcspMtaAgent. More...

#include <stdint.h>
#include <netinet/in.h>
Include dependency graph for mta_hal.h:

Go to the source code of this file.

Data Structures

struct  _MTAMGMT_MTA_DECT
 
struct  _MTAMGMT_MTA_HANDSETS_INFO
 
struct  _MTAMGMT_MTA_DHCP_INFO
 
struct  _MTAMGMT_MTA_DHCPv6_INFO
 
struct  _MTAMGMT_MTA_SERVICE_FLOW
 
struct  _MTAMGMT_MTA_CALLS
 
struct  _MTAMGMT_MTA_LINETABLE_INFO
 
struct  _MTAMGMT_MTA_CALLP
 
struct  _MTAMGMT_MTA_DSXLOG
 
struct  _MTAMGMT_MTA_MTALOG_FULL
 
struct  _MTAMGMT_MTA_BATTERY_INFO
 
struct  _MTAMGMT_PROVISIONING_PARAMS
 

Macros

#define ULONG   unsigned long
 
#define CHAR   char
 
#define UCHAR   unsigned char
 
#define BOOLEAN   UCHAR
 
#define INT   int
 
#define TRUE   1
 
#define FALSE   0
 
#define ENABLE   1
 
#define RETURN_OK   0
 
#define RETURN_ERR   -1
 
#define IPV4_ADDRESS_SIZE   4
 
#define MTA_HAL_SHORT_VALUE_LEN   16
 
#define MTA_HAL_LONG_VALUE_LEN   64
 
#define ANSC_IPV4_ADDRESS
 
#define DECT_MAX_HANDSETS   5
 
#define MTA_LINENUMBER   8
 
#define MTA_DHCPOPTION122SUBOPTION1_MAX   4
 
#define MTA_DHCPOPTION122SUBOPTION2_MAX   4
 
#define MTA_DHCPOPTION122CCCV6DSSID1_MAX   32
 
#define MTA_DHCPOPTION122CCCV6DSSID2_MAX   32
 

Typedefs

typedef struct _MTAMGMT_MTA_DECT MTAMGMT_MTA_DECT
 
typedef struct _MTAMGMT_MTA_DECTPMTAMGMT_MTA_DECT
 
typedef struct _MTAMGMT_MTA_HANDSETS_INFO MTAMGMT_MTA_HANDSETS_INFO
 
typedef struct _MTAMGMT_MTA_HANDSETS_INFOPMTAMGMT_MTA_HANDSETS_INFO
 
typedef struct _MTAMGMT_MTA_DHCP_INFO MTAMGMT_MTA_DHCP_INFO
 
typedef struct _MTAMGMT_MTA_DHCP_INFOPMTAMGMT_MTA_DHCP_INFO
 
typedef struct _MTAMGMT_MTA_DHCPv6_INFO MTAMGMT_MTA_DHCPv6_INFO
 
typedef struct _MTAMGMT_MTA_DHCPv6_INFOPMTAMGMT_MTA_DHCPv6_INFO
 
typedef struct _MTAMGMT_MTA_SERVICE_FLOW MTAMGMT_MTA_SERVICE_FLOW
 
typedef struct _MTAMGMT_MTA_SERVICE_FLOWPMTAMGMT_MTA_SERVICE_FLOW
 
typedef struct _MTAMGMT_MTA_CALLS MTAMGMT_MTA_CALLS
 
typedef struct _MTAMGMT_MTA_CALLSPMTAMGMT_MTA_CALLS
 
typedef struct _MTAMGMT_MTA_LINETABLE_INFO MTAMGMT_MTA_LINETABLE_INFO
 
typedef struct _MTAMGMT_MTA_LINETABLE_INFOPMTAMGMT_MTA_LINETABLE_INFO
 
typedef struct _MTAMGMT_MTA_CALLP MTAMGMT_MTA_CALLP
 
typedef struct _MTAMGMT_MTA_CALLPPMTAMGMT_MTA_CALLP
 
typedef struct _MTAMGMT_MTA_DSXLOG MTAMGMT_MTA_DSXLOG
 
typedef struct _MTAMGMT_MTA_DSXLOGPMTAMGMT_MTA_DSXLOG
 
typedef struct _MTAMGMT_MTA_MTALOG_FULL MTAMGMT_MTA_MTALOG_FULL
 
typedef struct _MTAMGMT_MTA_MTALOG_FULLPMTAMGMT_MTA_MTALOG_FULL
 
typedef struct _MTAMGMT_MTA_BATTERY_INFO MTAMGMT_MTA_BATTERY_INFO
 
typedef struct _MTAMGMT_MTA_BATTERY_INFOPMTAMGMT_MTA_BATTERY_INFO
 
typedef struct _MTAMGMT_PROVISIONING_PARAMS MTAMGMT_PROVISIONING_PARAMS
 
typedef struct _MTAMGMT_PROVISIONING_PARAMSPMTAMGMT_MTA_PROVISIONING_PARAMS
 
typedef int(* mta_hal_getLineRegisterStatus_callback) (MTAMGMT_MTA_STATUS *output_status_array, int array_size)
 

Enumerations

enum  MTAMGMT_MTA_STATUS {
  MTA_INIT =0, MTA_START =1, MTA_COMPLETE =2, MTA_ERROR =3,
  MTA_REJECTED =4
}
 
enum  MTAMGMT_MTA_PROVISION_STATUS { MTA_PROVISIONED =0, MTA_NON_PROVISIONED =1 }
 
enum  MTAMGMT_MTA_PROV_IP_MODE { MTA_IPV4 =0, MTA_IPV6 =1, MTA_DUAL_STACK =2 }
 

Functions

int mta_hal_InitDB (void)
 
int mta_hal_GetDHCPInfo (PMTAMGMT_MTA_DHCP_INFO pInfo)
 
int mta_hal_GetDHCPV6Info (PMTAMGMT_MTA_DHCPv6_INFO pInfo)
 
unsigned long mta_hal_LineTableGetNumberOfEntries (void)
 
int mta_hal_LineTableGetEntry (unsigned long Index, PMTAMGMT_MTA_LINETABLE_INFO pEntry)
 
int mta_hal_TriggerDiagnostics (unsigned long Index)
 
int mta_hal_GetServiceFlow (unsigned long *Count, PMTAMGMT_MTA_SERVICE_FLOW *ppCfg)
 
int mta_hal_DectGetEnable (unsigned char *pBool)
 
int mta_hal_DectSetEnable (unsigned char bBool)
 
int mta_hal_DectGetRegistrationMode (unsigned char *pBool)
 
int mta_hal_DectSetRegistrationMode (unsigned char bBool)
 
int mta_hal_DectDeregisterDectHandset (unsigned long uValue)
 
int mta_hal_GetDect (PMTAMGMT_MTA_DECT pDect)
 
int mta_hal_GetDectPIN (char *pPINString)
 
int mta_hal_SetDectPIN (char *pPINString)
 
int mta_hal_GetHandsets (unsigned long *pulCount, PMTAMGMT_MTA_HANDSETS_INFO *ppHandsets)
 
int mta_hal_GetCalls (unsigned long InstanceNumber, unsigned long *Count, PMTAMGMT_MTA_CALLS *ppCfg)
 
int mta_hal_GetCALLP (unsigned long LineNumber, PMTAMGMT_MTA_CALLP pCallp)
 
int mta_hal_GetDSXLogs (unsigned long *Count, PMTAMGMT_MTA_DSXLOG *ppDSXLog)
 
int mta_hal_GetDSXLogEnable (unsigned char *pBool)
 
int mta_hal_SetDSXLogEnable (unsigned char Bool)
 
int mta_hal_ClearDSXLog (unsigned char Bool)
 
int mta_hal_GetCallSignallingLogEnable (unsigned char *pBool)
 
int mta_hal_SetCallSignallingLogEnable (unsigned char Bool)
 
int mta_hal_ClearCallSignallingLog (unsigned char Bool)
 
int mta_hal_GetMtaLog (unsigned long *Count, PMTAMGMT_MTA_MTALOG_FULL *ppCfg)
 
int mta_hal_BatteryGetInstalled (unsigned char *Val)
 
int mta_hal_BatteryGetTotalCapacity (unsigned long *Val)
 
int mta_hal_BatteryGetActualCapacity (unsigned long *Val)
 
int mta_hal_BatteryGetRemainingCharge (unsigned long *Val)
 
int mta_hal_BatteryGetRemainingTime (unsigned long *Val)
 
int mta_hal_BatteryGetNumberofCycles (unsigned long *Val)
 
int mta_hal_BatteryGetPowerStatus (char *Val, unsigned long *len)
 
int mta_hal_BatteryGetCondition (char *Val, unsigned long *len)
 
int mta_hal_BatteryGetStatus (char *Val, unsigned long *len)
 
int mta_hal_BatteryGetLife (char *Val, unsigned long *len)
 
int mta_hal_BatteryGetInfo (PMTAMGMT_MTA_BATTERY_INFO pInfo)
 
int mta_hal_BatteryGetPowerSavingModeStatus (unsigned long *pValue)
 
int mta_hal_Get_MTAResetCount (unsigned long *resetcnt)
 
int mta_hal_Get_LineResetCount (unsigned long *resetcnt)
 
int mta_hal_ClearCalls (unsigned long InstanceNumber)
 
int mta_hal_getDhcpStatus (MTAMGMT_MTA_STATUS *output_pIpv4status, MTAMGMT_MTA_STATUS *output_pIpv6status)
 
int mta_hal_getConfigFileStatus (MTAMGMT_MTA_STATUS *poutput_status)
 
int mta_hal_getLineRegisterStatus (MTAMGMT_MTA_STATUS *output_status_array, int array_size)
 
int mta_hal_devResetNow (unsigned char bResetValue)
 
int mta_hal_getMtaOperationalStatus (MTAMGMT_MTA_STATUS *operationalStatus)
 
int mta_hal_getMtaProvisioningStatus (MTAMGMT_MTA_PROVISION_STATUS *provisionStatus)
 
int mta_hal_start_provisioning (PMTAMGMT_MTA_PROVISIONING_PARAMS pParameters)
 
void mta_hal_LineRegisterStatus_callback_register (mta_hal_getLineRegisterStatus_callback callback_proc)
 

yes

For CCSP Component: CcspMtaAgent.

Author
cisco @description This header file gives the function call prototypes and structure definitions used for the RDK-Broadband hardware abstraction layer for Cable Modem

Definition in file mta_hal.h.