AM64x MCU+ SDK  08.03.00
hsrPrp_red_snmp.h
Go to the documentation of this file.
1 
38 #ifndef RED_SNMP_H_
39 #define RED_SNMP_H_
40 
41 #ifdef __cplusplus
42 extern "C"
43 {
44 #endif
45 
46 
47 /* ========================================================================== */
48 /* Include Files */
49 /* ========================================================================== */
50 
51 #include "hsrPrp_red_common.h"
52 #include "hsrPrp_handle.h"
53 
54 /* ========================================================================== */
55 /* Function Declarations */
56 /* ========================================================================== */
57 
65 const char *getLreManufacturerName(void);
72 int32_t getLreInterfaceCount(void);
73 
88 const char *getLreNodeName(void);
95 const char *getLreVersionName(void);
96 
107  ICSS_EMAC_Handle icssEmacHandle);
118  int32_t adminState);
128  pruicssHandle);
141  duplicateDiscard, PRUICSS_Handle pruicssHandle);
154  pruicssHandle);
165  transparentReception, PRUICSS_Handle pruicssHandle);
185  PRUICSS_Handle pruicssHandle);
218  LreTableOperation_t action);
241  PRUICSS_Handle pruicssHandle);
253  pruicssHandle);
263 int32_t getLreNodeTableSize(PRUICSS_Handle pruicssHandle);
264 
274 int32_t getLreNodeTable(RED_NODE_TABLE *pNodeTable,
275  hsrPrpHandle *hsrPrphandle);
284 RemNodeType_t getLreRemNodeType(uint8_t nodeEntryStatus);
285 
286 
287 #ifdef __cplusplus
288 }
289 #endif
290 
291 #endif /* RED_SNMP_H_ */
LreNodeType_t
LreNodeType_t
LRE Node Type.
Definition: hsrPrp_red_common.h:174
LreTruthValue_t
LreTruthValue_t
LRE Truth Value.
Definition: hsrPrp_red_common.h:304
ICSS_EMAC_Handle
struct ICSS_EMAC_Config_s * ICSS_EMAC_Handle
Alias for ICSS EMAC Handle containing base addresses and modules.
Definition: icss_emac.h:368
LreTableOperation_t
LreTableOperation_t
LRE Table Operation.
Definition: hsrPrp_red_common.h:315
getLreManufacturerName
const char * getLreManufacturerName(void)
Returns the manufacturer name.
LreRedBoxIdentity_t
LreRedBoxIdentity_t
LRE RedBox Identity.
Definition: hsrPrp_red_common.h:281
getLrePortAdminState
int32_t getLrePortAdminState(RedPort_t port, ICSS_EMAC_Handle icssEmacHandle)
Returns the LRE admin state of a port.
RemNodeType_t
RemNodeType_t
Remote Node Type.
Definition: hsrPrp_red_common.h:360
getLreNodeTableSize
int32_t getLreNodeTableSize(PRUICSS_Handle pruicssHandle)
Returns the node table size. Use this function to determine the size of the buffer to pass to getLreN...
HSRMode_t
HSRMode_t
LRE HSR Mode.
Definition: hsrPrp_red_common.h:250
setLreHsrLREMode
RED_STATUS setLreHsrLREMode(HSRMode_t mode, PRUICSS_Handle pruicssHandle)
Sets the HSR LRE Mode.
getLreNodeType
LreNodeType_t getLreNodeType(void)
Returns lreNodeType specified in LREInterfaceConfigEntry.
getLreNodeName
const char * getLreNodeName(void)
Returns the LRE's node name. Default: "IEC62439-3".
RedPort_t
RedPort_t
RED Port.
Definition: hsrPrp_red_common.h:195
LreDuplicateDiscard_t
LreDuplicateDiscard_t
LRE Duplicate Discard.
Definition: hsrPrp_red_common.h:228
LreTransparentReception_t
LreTransparentReception_t
LRE Transparent Reception.
Definition: hsrPrp_red_common.h:239
getLreTransparentReception
LreTransparentReception_t getLreTransparentReception(PRUICSS_Handle pruicssHandle)
setLreNodeTableClear
RED_STATUS setLreNodeTableClear(hsrPrpHandle *, LreTableOperation_t action)
Clears the node table if action is "clearNodeTable". No action is performed if action is noOp.
getLreVersionName
const char * getLreVersionName(void)
Returns the LRE's version information.
value
uint32_t value
Definition: tisci_otp_revision.h:2
hsrPrpHandle
struct hsrPrp_Config_s hsrPrpHandle
Definition: hsrPrp_handle.h:92
getLreInterfaceStatBase
const int32_t * getLreInterfaceStatBase(PRUICSS_Handle pruicssHandle)
Returns the base address of the LREInterfaceStatsEntry (see IEC-62439-3-MIB DEFINITIONS) in the ICSS ...
setLreDuplicateDiscard
RED_STATUS setLreDuplicateDiscard(hsrPrpHandle *hsrPrphandle, LreDuplicateDiscard_t duplicateDiscard, PRUICSS_Handle pruicssHandle)
Sets whether a duplicate discard algorithm is used at reception.
hsrPrp_red_common.h
Commonly used Macros, structures and Offsets.
RED_STATUS
RED_STATUS
RED Status.
Definition: hsrPrp_red_common.h:530
getLreInterfaceStats
RED_STATUS getLreInterfaceStats(LreIfStat_t stat, int32_t *value, PRUICSS_Handle pruicssHandle)
Returns a single entry of LREInterfaceStatsEntry (see IEC-62439-3-MIB DEFINITIONS)....
LreIfStat_t
LreIfStat_t
LRE Interface Statistics Entry.
Definition: hsrPrp_red_common.h:326
SwitchingEndNode_t
SwitchingEndNode_t
The switching end node functionality.
Definition: hsrPrp_red_common.h:264
getLreNodeTable
int32_t getLreNodeTable(RED_NODE_TABLE *pNodeTable, hsrPrpHandle *hsrPrphandle)
Copies the complete node table to pNodeTable.
mode
char mode[32]
Definition: tisci_pm_core.h:1
hsrPrp_handle.h
Include file for hsrPrp_red_hsr.c.
setLrePortAdminState
RED_STATUS setLrePortAdminState(RedPort_t port, int32_t adminState)
Sets the LRE admin state of a port.
setLreTransparentReception
RED_STATUS setLreTransparentReception(LreTransparentReception_t transparentReception, PRUICSS_Handle pruicssHandle)
Sets Transparent Reception.
getLreHsrLREMode
HSRMode_t getLreHsrLREMode(PRUICSS_Handle pruicssHandle)
Returns the HSR LRE Mode.
setLreProxyNodeTableClear
RED_STATUS setLreProxyNodeTableClear(LreTableOperation_t action)
Clears the Proxy Node Table if action is "clearProxyNodeTable". No action is performed if action is n...
getLreEvaluateSupervision
LreTruthValue_t getLreEvaluateSupervision(void)
True if the LRE evaluates received supervision frames. False if it drops the supervision frames witho...
getLreRedBoxIdentity
LreRedBoxIdentity_t getLreRedBoxIdentity(void)
Returns the LRE RedBox Identity.
getLreSwitchingEndNode
SwitchingEndNode_t getLreSwitchingEndNode(void)
Returns the SwitchingEndNode status.
getLreInterfaceCount
int32_t getLreInterfaceCount(void)
Returns the number of supported LRE.
PRUICSS_Handle
struct PRUICSS_Config_s * PRUICSS_Handle
A handle that is returned from a PRUICSS_open() call. This handle is required for calling other APIs.
Definition: pruicss/g_v0/pruicss.h:234
RED_NODE_TABLE
Node Table.
Definition: hsrPrp_red_common.h:518
getLreRemNodeType
RemNodeType_t getLreRemNodeType(uint8_t nodeEntryStatus)
Gets the type of a remote node.
getLreDuplicateDiscard
LreDuplicateDiscard_t getLreDuplicateDiscard(PRUICSS_Handle pruicssHandle)
Returns whether a duplicate discard algorithm is used at reception.