Go to the source code of this file.
|
enum | _XTM_LINK_TYPE { PTM_LINK = 0,
ATM_LINK,
NOT_SUPPORTED
} |
| enum to identify the XTM link type. It could be either ATM, PTM or Not Supported. More...
|
|
enum | _XTM_LINK_STATUS {
XTM_LINK_TRAINING = 0,
XTM_LINK_UP,
XTM_LINK_DOWN,
XTM_LINK_DORMANT,
XTM_LINK_NOT_PRESENT,
XTM_LINK_LOWER_LAYER_DOWN,
XTM_LINK_UNKNOWN,
XTM_LINK_ERROR
} |
|
|
int | xtm_hal_init () |
|
- Initialise the xtm features
More...
|
|
int | xtm_hal_setLinkEnable (XTM_LINK_TYPE type, unsigned int lineIndex, unsigned char enable) |
|
- Enable/Disable XTM link interface. This bringup the XTM interface up.
More...
|
|
int | xtm_hal_getLinkEnable (XTM_LINK_TYPE type, unsigned char *enable) |
|
- Get XTM link interface enabled or not.
More...
|
|
int | xtm_hal_getLinkStats (XTM_LINK_TYPE type, unsigned int lineIndex, PXTM_LINK_STATS linkStats) |
|
- Get XTM link statistics information
More...
|
|
int | xtm_hal_getLinkName (XTM_LINK_TYPE type, unsigned int lineIndex, char *ifName) |
|
- Get XTM (ATM/PTM) link interface name
More...
|
|
int | xtm_hal_getLinkMacAddress (XTM_LINK_TYPE type, unsigned int lineIndex, char *macAddr) |
|
- Get XTM (ATM/PTM) link interface mac address.
More...
|
|
int | xtm_hal_getLinkStatus (XTM_LINK_TYPE type, unsigned int lineIndex, PXTM_LINK_STATUS linkStatus) |
|
- Get XTM (ATM/PTM) interface link status.
More...
|
|
int | xtm_hal_getLinkNumberOfEntries (XTM_LINK_TYPE type, unsigned int *lineCount) |
|
- Get total number of XTM (ATM/PTM) link entries.
More...
|
|
int | xtm_hal_getLinkLastChange (XTM_LINK_TYPE type, unsigned int lineIndex, unsigned int *timestamp) |
|
- Get XTM (ATM/PTM) link interface last configured time stamp.
More...
|
|
◆ ULLONG
#define ULLONG unsigned long long |
◆ ULONG
#define ULONG unsigned long |
◆ USHORT
#define USHORT unsigned short |
◆ BOOL
#define BOOL unsigned char |
◆ CHAR
◆ UCHAR
#define UCHAR unsigned char |
◆ INT
◆ UINT
#define UINT unsigned int |
◆ TRUE
◆ FALSE
◆ ENABLE
◆ RETURN_OK
◆ RETURN_ERR
◆ XTM_LINK_TYPE
enum to identify the XTM link type. It could be either ATM, PTM or Not Supported.
◆ PXTM_LINK_TYPE
◆ XTM_LINK_STATUS
Enum to store the link status information.
◆ PXTM_LINK_STATUS
◆ XTM_LINK_STATS
Struture used to hold the XTM (PTM/ATM) line Statistics information.
◆ PXTM_LINK_STATS
◆ _XTM_LINK_TYPE
enum to identify the XTM link type. It could be either ATM, PTM or Not Supported.
Enumerator |
---|
PTM_LINK | |
ATM_LINK | |
NOT_SUPPORTED | |
Definition at line 79 of file xtm_hal.h.
◆ _XTM_LINK_STATUS
Enum to store the link status information.
Enumerator |
---|
XTM_LINK_TRAINING | |
XTM_LINK_UP | |
XTM_LINK_DOWN | |
XTM_LINK_DORMANT | |
XTM_LINK_NOT_PRESENT | |
XTM_LINK_LOWER_LAYER_DOWN | |
XTM_LINK_UNKNOWN | |
XTM_LINK_ERROR | |
Definition at line 89 of file xtm_hal.h.
◆ xtm_hal_init()
- Initialise the xtm features
- Returns
- The status of the operation
- Return values
-
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
◆ xtm_hal_setLinkEnable()
int xtm_hal_setLinkEnable |
( |
XTM_LINK_TYPE |
type, |
|
|
unsigned int |
lineIndex, |
|
|
unsigned char |
enable |
|
) |
| |
- Enable/Disable XTM link interface. This bringup the XTM interface up.
- Parameters
-
Type | of XTM link type. Could be ATM or PTM |
XTM | link line index |
Enable/Disable | flag |
- Returns
- The status of the operation
- Return values
-
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
◆ xtm_hal_getLinkEnable()
int xtm_hal_getLinkEnable |
( |
XTM_LINK_TYPE |
type, |
|
|
unsigned char * |
enable |
|
) |
| |
- Get XTM link interface enabled or not.
- Parameters
-
Type | of XTM link type. Could be ATM or PTM |
Flag | to store enable/disable status |
- Returns
- The status of the operation
- Return values
-
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
◆ xtm_hal_getLinkStats()
- Get XTM link statistics information
- Parameters
-
Type | of XTM link type. Could be ATM or PTM |
Structure | pointer to hold statistics information |
- Returns
- The status of the operation
- Return values
-
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
◆ xtm_hal_getLinkName()
int xtm_hal_getLinkName |
( |
XTM_LINK_TYPE |
type, |
|
|
unsigned int |
lineIndex, |
|
|
char * |
ifName |
|
) |
| |
- Get XTM (ATM/PTM) link interface name
- Parameters
-
Type | of XTM link type. Could be ATM or PTM |
XTM | link line index |
String | to hold XTM link interface name |
- Returns
- The status of the operation
- Return values
-
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
◆ xtm_hal_getLinkMacAddress()
int xtm_hal_getLinkMacAddress |
( |
XTM_LINK_TYPE |
type, |
|
|
unsigned int |
lineIndex, |
|
|
char * |
macAddr |
|
) |
| |
- Get XTM (ATM/PTM) link interface mac address.
- Parameters
-
Type | of XTM link type. Could be ATM or PTM |
XTM | link line index |
String | to hold XTM link interface Mac address |
- Returns
- The status of the operation
- Return values
-
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
◆ xtm_hal_getLinkStatus()
- Get XTM (ATM/PTM) interface link status.
- Parameters
-
Type | of XTM link type. Could be ATM or PTM |
XTM | link line index |
Enum | object to hold the link status |
- Returns
- The status of the operation
- Return values
-
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
◆ xtm_hal_getLinkNumberOfEntries()
int xtm_hal_getLinkNumberOfEntries |
( |
XTM_LINK_TYPE |
type, |
|
|
unsigned int * |
lineCount |
|
) |
| |
- Get total number of XTM (ATM/PTM) link entries.
- Parameters
-
Type | of XTM link type. Could be ATM or PTM |
Unsigned | integer to store the total number of XTM line entries |
- Returns
- The status of the operation
- Return values
-
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
◆ xtm_hal_getLinkLastChange()
int xtm_hal_getLinkLastChange |
( |
XTM_LINK_TYPE |
type, |
|
|
unsigned int |
lineIndex, |
|
|
unsigned int * |
timestamp |
|
) |
| |
- Get XTM (ATM/PTM) link interface last configured time stamp.
- Parameters
-
Type | of XTM link type. Could be ATM or PTM |
PTM | line index number |
String | to hold the last XTM interface configured time. |
- Returns
- The status of the operation
-
The status of the operation
- Return values
-
Return | last timestamp value |