Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | _open_port_mask_ |
struct | OPEN_ASIC_CAPABILITIES_ALL_t |
Macros | |
#define | CONVERT_32_TO_64_INT(dest, src) |
#define | CONVERT_64_TO_32_INT(dest, src) |
#define | OPEN_INSTRU_MAX_PACKET_SIZE 1588 |
These data structure are used for OpEN API only. | |
#define | OPEN_MASK_BASE_UNIT unsigned int |
Base type for declarations. | |
#define | OPEN_MASK_SIZE(_max) (((_max) + OPEN_MASKWID - 1) / OPEN_MASKWID) |
(internal) Number of BVIEW_MASK_BASE_UNITs needed to contain _max bits | |
#define | OPEN_MASKWID 32 |
#define | OPEN_MAX_PORT_LIST_STR 256 |
Typedefs | |
typedef struct _open_port_mask_ | OPEN_PORT_MASK_t |
typedef time_t | OPEN_TIME_t |
Functions | |
open_error_t | openapiAsicCapabilityGet (openapiClientHandle_t *clientHandle, int asic, OPEN_ASIC_CAPABILITIES_ALL_t *asicCap) |
Asic capabilities get function. More... | |
open_error_t | openapiBstMaxSnapshotCompressedGet (openapiClientHandle_t *clientHandle, int asic, open_buffdesc *compSnapshot, time_t *time) |
Obtain compressed complete ASIC Statistics Report of maximum buffer values. More... | |
open_error_t | openapiBstMaxSnapshotGet (openapiClientHandle_t *clientHandle, int asic, OPEN_BST_ASIC_SNAPSHOT_DATA_t *data1, OPEN_BST_EGRESS_UC_QUEUE_DATA_t *data2, OPEN_BST_EGRESS_MC_QUEUE_DATA_t *data3, time_t *time) |
Obtain Complete ASIC Statistics Report of maximum buffer values. More... | |
open_error_t | openapiChipFamilyNameGet (openapiClientHandle_t *client_handle, open_buffdesc *buf) |
Get Chip Family name. More... | |
open_error_t | openapiHttpPortGet (openapiClientHandle_t *client_handle, int asic, int *httpPort) |
Get HTTP listening port. More... | |
open_error_t | openapiHwMaxPortsGet (openapiClientHandle_t *client_handle, int *maxPhysPorts, int *maxHiGigPorts) |
Get Chip Max Ports. More... | |
open_error_t | openapiLagTranslateToNotation (openapiClientHandle_t *client_handle, int asic, int lag, open_buffdesc *dst) |
Get LAG string from SDK lag number. More... | |
open_error_t | openapiMacAddrGet (openapiClientHandle_t *client_handle, open_buffdesc *mac) |
Get System MAC Address. More... | |
open_error_t | openapiSystemCosqHwqFullMapGet (openapiClientHandle_t *client_handle, int asic, OPEN_SYSTEM_COSQ_HWQ_MAP_t *cosq_hwq_map) |
Get HW queue map of cosqs in the system. More... | |
open_error_t | openapiSystemCosqHwqFullMapGetV2 (openapiClientHandle_t *client_handle, int asic, OPEN_SYSTEM_COSQ_HWQ_MAP_V2_t *cosq_hwq_map) |
Get HW queue map of cosqs in the system. More... | |
open_error_t | openapiSystemHwqMCosqMapGet (openapiClientHandle_t *client_handle, int asic, int hwQNum, int *port, int *cosq) |
Get the port and cos queue number of a multicast HW queue. More... | |
open_error_t | openapiSystemHwqUCosqMapGet (openapiClientHandle_t *client_handle, int asic, int hwQNum, int *port, int *cosq) |
Get the port and cos queue number of a unicast HW queue. More... | |
open_error_t | openapiSystemMCosqHwqMapGet (openapiClientHandle_t *client_handle, int asic, int port, int cosq, int *hwQNum) |
Get the HW queue number of a multicast cosq. More... | |
open_error_t | openapiSystemPacketTcamRegister (openapiClientHandle_t *clientHandle, int asic, open_buffdesc *name, int ClientId) |
Register with System for TCAM packets. More... | |
open_error_t | openapiSystemUCosqHwqMapGet (openapiClientHandle_t *client_handle, int asic, int port, int cosq, int *hwQNum) |
Get the HW queue number of a unicast cosq. More... | |
open_error_t | openapiTimeGet (openapiClientHandle_t *client_handle, int *second, int *nanosecond) |
Get System Time. More... | |
#define CONVERT_32_TO_64_INT | ( | dest, | |
src | |||
) |
Definition at line 60 of file openapi_instru_nos.h.
#define CONVERT_64_TO_32_INT | ( | dest, | |
src | |||
) |
Definition at line 69 of file openapi_instru_nos.h.
open_error_t openapiAsicCapabilityGet | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
OPEN_ASIC_CAPABILITIES_ALL_t * | asicCap | ||
) |
Asic capabilities get function.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[out] | asicCap | Asic capability |
OPEN_E_NONE | |
OPEN_E_ERROR | OpEN API Version: 1.14 |
open_error_t openapiBstMaxSnapshotCompressedGet | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | compSnapshot, | ||
time_t * | time | ||
) |
Obtain compressed complete ASIC Statistics Report of maximum buffer values.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[out] | compSnapshot | compressed snapshot data |
[out] | time | Time of retrieving data |
OPEN_E_NONE | |
OPEN_E_ERROR |
OpEN API Version: 1.14
open_error_t openapiBstMaxSnapshotGet | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
OPEN_BST_ASIC_SNAPSHOT_DATA_t * | data1, | ||
OPEN_BST_EGRESS_UC_QUEUE_DATA_t * | data2, | ||
OPEN_BST_EGRESS_MC_QUEUE_DATA_t * | data3, | ||
time_t * | time | ||
) |
Obtain Complete ASIC Statistics Report of maximum buffer values.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[out] | data1 | Snapshot data |
[out] | data2 | Eucq snapshot data |
[out] | data3 | Emcq Snapshot data |
[out] | time | Time of retrieving data |
OPEN_E_NONE | |
OPEN_E_ERROR |
OpEN API Version: 1.10
open_error_t openapiChipFamilyNameGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | buf | ||
) |
Get Chip Family name.
[in] | client_handle | Client handle from registration API |
[out] | buf | family name to be fetched |
OPEN_E_NONE | |
OPEN_E_ERROR | OpEN API Version: 1.3 |
open_error_t openapiHttpPortGet | ( | openapiClientHandle_t * | client_handle, |
int | asic, | ||
int * | httpPort | ||
) |
Get HTTP listening port.
client_handle | Openapi connection handle |
asic | The UNIT number |
httpPort | HTTP listening port |
OPEN_E_NONE | |
OPEN_E_ERROR | OpEN API Version: 1.10 |
open_error_t openapiHwMaxPortsGet | ( | openapiClientHandle_t * | client_handle, |
int * | maxPhysPorts, | ||
int * | maxHiGigPorts | ||
) |
Get Chip Max Ports.
[in] | client_handle | Client handle from registration API |
[out] | maxPhysPorts | MAX Physical ports |
[out] | maxHiGigPorts | MAX Hi Gig Ports |
OPEN_E_NONE | |
OPEN_E_ERROR | OpEN API Version: 1.3 |
open_error_t openapiLagTranslateToNotation | ( | openapiClientHandle_t * | client_handle, |
int | asic, | ||
int | lag, | ||
open_buffdesc * | dst | ||
) |
Get LAG string from SDK lag number.
client_handle | Openapi connection handle |
asic | The ASIC number |
lag | SDK trunk number |
dst | Lag string |
OPEN_E_NONE | |
OPEN_E_ERROR | OpEN API Version: 1.9 |
open_error_t openapiMacAddrGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | mac | ||
) |
Get System MAC Address.
[in] | client_handle | Client handle from registration API |
[out] | mac | MAC Address |
OPEN_E_NONE | |
OPEN_E_ERROR | OpEN API Version: 1.3 |
open_error_t openapiSystemCosqHwqFullMapGet | ( | openapiClientHandle_t * | client_handle, |
int | asic, | ||
OPEN_SYSTEM_COSQ_HWQ_MAP_t * | cosq_hwq_map | ||
) |
Get HW queue map of cosqs in the system.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[out] | cosq_hwq_map | H/W queue map |
OPEN_E_NONE | |
OPEN_E_ERROR |
OpEN API Version: 1.14 OpEN API Version: 1.19
open_error_t openapiSystemCosqHwqFullMapGetV2 | ( | openapiClientHandle_t * | client_handle, |
int | asic, | ||
OPEN_SYSTEM_COSQ_HWQ_MAP_V2_t * | cosq_hwq_map | ||
) |
Get HW queue map of cosqs in the system.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[out] | cosq_hwq_map | H/W queue map |
OPEN_E_NONE | |
OPEN_E_ERROR |
OpEN API Version: 1.19
open_error_t openapiSystemHwqMCosqMapGet | ( | openapiClientHandle_t * | client_handle, |
int | asic, | ||
int | hwQNum, | ||
int * | port, | ||
int * | cosq | ||
) |
Get the port and cos queue number of a multicast HW queue.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | hwQNum | H/W queue number |
[out] | port | Port number |
[out] | cosq | Cosq number |
OPEN_E_NONE | |
OPEN_E_ERROR |
OpEN API Version: 1.14
open_error_t openapiSystemHwqUCosqMapGet | ( | openapiClientHandle_t * | client_handle, |
int | asic, | ||
int | hwQNum, | ||
int * | port, | ||
int * | cosq | ||
) |
Get the port and cos queue number of a unicast HW queue.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | hwQNum | H/W queue number |
[out] | port | Port number |
[out] | cosq | Cosq number |
OPEN_E_NONE | |
OPEN_E_ERROR |
OpEN API Version: 1.14
open_error_t openapiSystemMCosqHwqMapGet | ( | openapiClientHandle_t * | client_handle, |
int | asic, | ||
int | port, | ||
int | cosq, | ||
int * | hwQNum | ||
) |
Get the HW queue number of a multicast cosq.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | port | Port number |
[in] | cosq | Cosq number |
[out] | hwQNum | H/W queue number |
OPEN_E_NONE | |
OPEN_E_ERROR |
OpEN API Version: 1.14
open_error_t openapiSystemPacketTcamRegister | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | name, | ||
int | ClientId | ||
) |
Register with System for TCAM packets.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | ASIC number |
[in] | name | Client name |
[in] | agentId | agentId to be Registered |
BVIEW_STATUS_FAILURE | Registration is failure. |
BVIEW_STATUS_SUCCESS | Registration is successful |
BVIEW_STATUS_UNSUPPORTED | Packet TCAM registration is not supported |
OpEN API Version: 1.12
open_error_t openapiSystemUCosqHwqMapGet | ( | openapiClientHandle_t * | client_handle, |
int | asic, | ||
int | port, | ||
int | cosq, | ||
int * | hwQNum | ||
) |
Get the HW queue number of a unicast cosq.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | port | Port number |
[in] | cosq | Cosq number |
[out] | hwQNum | H/W queue number |
OPEN_E_NONE | |
OPEN_E_ERROR |
OpEN API Version: 1.14
open_error_t openapiTimeGet | ( | openapiClientHandle_t * | client_handle, |
int * | second, | ||
int * | nanosecond | ||
) |
Get System Time.
[in] | client_handle | Client handle from registration API |
[out] | second | Time |
[out] | nanosecond | Time |
OPEN_E_NONE | |
OPEN_E_ERROR | OpEN API Version: 1.3 |