mikroSDK Reference Manual
lldp_mgmt.h
Go to the documentation of this file.
1
31#ifndef _LLDP_MGMT_H
32#define _LLDP_MGMT_H
33
34//Dependencies
35#include "core/net.h"
36#include "lldp/lldp.h"
37
38//C++ guard
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43//LLDP related functions
44void lldpMgmtLock(LldpAgentContext *context);
45void lldpMgmtUnlock(LldpAgentContext *context);
46
47error_t lldpMgmtSetMsgTxInterval(LldpAgentContext *context,
48 uint_t msgTxInterval, bool_t commit);
49
50error_t lldpMgmtSetMsgTxHold(LldpAgentContext *context, uint_t msgTxHold,
51 bool_t commit);
52
53error_t lldpMgmtSetReinitDelay(LldpAgentContext *context, uint_t reinitDelay,
54 bool_t commit);
55
56error_t lldpMgmtSetTxDelay(LldpAgentContext *context, uint_t txDelay,
57 bool_t commit);
58
59error_t lldpMgmtSetNotificationInterval(LldpAgentContext *context,
60 uint_t notificationInterval, bool_t commit);
61
62error_t lldpMgmtSetAdminStatus(LldpAgentContext *context,
63 uint_t portIndex, LldpAdminStatus adminStatus, bool_t commit);
64
65error_t lldpMgmtSetNotificationEnable(LldpAgentContext *context,
66 uint_t portIndex, bool_t notificationEnable, bool_t commit);
67
68error_t lldpMgmtSetBasicTlvFilter(LldpAgentContext *context, uint_t portIndex,
69 uint8_t mask, bool_t commit);
70
71error_t lldpMgmtGetMsgTxInterval(LldpAgentContext *context,
72 uint_t *msgTxInterval);
73
74error_t lldpMgmtGetMsgTxHold(LldpAgentContext *context, uint_t *msgTxHold);
75error_t lldpMgmtGetReinitDelay(LldpAgentContext *context, uint_t *reinitDelay);
76error_t lldpMgmtGetTxDelay(LldpAgentContext *context, uint_t *txDelay);
77
78error_t lldpMgmtGetNotificationInterval(LldpAgentContext *context,
79 uint_t *notificationInterval);
80
81error_t lldpMgmtGetAdminStatus(LldpAgentContext *context,
82 uint_t portIndex, LldpAdminStatus *adminStatus);
83
84error_t lldpMgmtGetNotificationEnable(LldpAgentContext *context,
85 uint_t portIndex, bool_t *notificationEnable);
86
87error_t lldpMgmtGetMibBasicTlvsTxEnable(LldpAgentContext *context,
88 uint_t portIndex, uint8_t *mibBasicTlvsTxEnable);
89
90error_t lldpMgmtGetLocalChassisId(LldpAgentContext *context,
91 LldpChassisIdSubtype *chassisIdSubtype, const uint8_t **chassisId,
92 size_t *chassisIdLen);
93
94error_t lldpMgmtGetLocalPortId(LldpAgentContext *context, uint_t portIndex,
95 LldpPortIdSubtype *portIdSubtype, const uint8_t **portId,
96 size_t *portIdLen);
97
98error_t lldpMgmtGetLocalPortDesc(LldpAgentContext *context, uint_t portIndex,
99 const char_t **portDesc, size_t *portDescLen);
100
101error_t lldpMgmtGetLocalSysName(LldpAgentContext *context,
102 const char_t **sysName, size_t *sysNameLen);
103
104error_t lldpMgmtGetLocalSysDesc(LldpAgentContext *context,
105 const char_t **sysDesc, size_t *sysDescLen);
106
107error_t lldpMgmtGetLocalSysCap(LldpAgentContext *context,
108 uint16_t *supportedCap, uint16_t *enabledCap);
109
110int_t lldpMgmtFindLocalMgmtAddr(LldpAgentContext *context,
111 uint8_t mgmtAddrSubtype, const uint8_t *mgmtAddr, size_t mgmtAddrLen);
112
113error_t lldpMgmtGetLocalMgmtAddr(LldpAgentContext *context, uint_t index,
114 LldpMgmtAddrSubtype *mgmtAddrSubtype, const uint8_t **mgmtAddr,
115 size_t *mgmtAddrLen, LldpIfNumSubtype *ifNumSubtype, uint32_t *ifNum,
116 const uint8_t **oid, size_t *oidLen);
117
118LldpNeighborEntry *lldpMgmtFindRemoteTableEntry(LldpAgentContext *context,
119 uint32_t timeMark, uint_t portIndex, uint32_t index);
120
121error_t lldpMgmtGetRemoteChassisId(LldpNeighborEntry *entry,
122 LldpChassisIdSubtype *chassisIdSubtype, const uint8_t **chassisId,
123 size_t *chassisIdLen);
124
125error_t lldpMgmtGetRemotePortId(LldpNeighborEntry *entry,
126 LldpPortIdSubtype *portIdSubtype, const uint8_t **portId,
127 size_t *portIdLen);
128
129error_t lldpMgmtGetRemotePortDesc(LldpNeighborEntry *entry,
130 const char_t **portDesc, size_t *portDescLen);
131
132error_t lldpMgmtGetRemoteSysName(LldpNeighborEntry *entry,
133 const char_t **sysName, size_t *sysNameLen);
134
135error_t lldpMgmtGetRemoteSysDesc(LldpNeighborEntry *entry,
136 const char_t **sysDesc, size_t *sysDescLen);
137
138error_t lldpMgmtGetRemoteSysCap(LldpNeighborEntry *entry,
139 uint16_t *supportedCap, uint16_t *enabledCap);
140
141int_t lldpMgmtFindRemoteMgmtAddr(LldpNeighborEntry *entry,
142 uint8_t mgmtAddrSubtype, const uint8_t *mgmtAddr, size_t mgmtAddrLen);
143
144error_t lldpMgmtGetRemoteMgmtAddr(LldpNeighborEntry *entry, uint_t index,
145 LldpMgmtAddrSubtype *mgmtAddrSubtype, const uint8_t **mgmtAddr,
146 size_t *mgmtAddrLen, LldpIfNumSubtype *ifNumSubtype, uint32_t *ifNum,
147 const uint8_t **oid, size_t *oidLen);
148
149error_t lldpMgmtGetRemoteUnknownTlv(LldpNeighborEntry *entry,
150 uint8_t type, uint_t index, const uint8_t **info, size_t *infoLen);
151
152error_t lldpMgmtGetRemoteOrgDefInfo(LldpNeighborEntry *entry,
153 uint32_t oui, uint8_t subtype, uint_t index, const uint8_t **info,
154 size_t *infoLen);
155
156error_t lldpMgmtGetStatsFramesOutTotal(LldpAgentContext *context,
157 uint_t portIndex, uint32_t *statsFramesOutTotal);
158
159error_t lldpMgmtGetStatsFramesDiscardedTotal(LldpAgentContext *context,
160 uint_t portIndex, uint32_t *statsFramesDiscardedTotal);
161
162error_t lldpMgmtGetStatsFramesInErrorsTotal(LldpAgentContext *context,
163 uint_t portIndex, uint32_t *statsFramesInErrorsTotal);
164
165error_t lldpMgmtGetStatsFramesInTotal(LldpAgentContext *context,
166 uint_t portIndex, uint32_t *statsFramesInTotal);
167
168error_t lldpMgmtGetStatsTLVsDiscardedTotal(LldpAgentContext *context,
169 uint_t portIndex, uint32_t *statsTLVsDiscardedTotal);
170
171error_t lldpMgmtGetStatsTLVsUnrecognizedTotal(LldpAgentContext *context,
172 uint_t portIndex, uint32_t *statsTLVsUnrecognizedTotal);
173
174error_t lldpMgmtGetStatsAgeoutsTotal(LldpAgentContext *context,
175 uint_t portIndex, uint32_t *statsAgeoutsTotal);
176
177error_t lldpMgmtGetStatsRemTablesLastChangeTime(LldpAgentContext *context,
178 uint32_t *statsRemTablesLastChangeTime);
179
180error_t lldpMgmtGetStatsRemTablesInserts(LldpAgentContext *context,
181 uint32_t *statsRemTablesInserts);
182
183error_t lldpMgmtGetStatsRemTablesDeletes(LldpAgentContext *context,
184 uint32_t *statsRemTablesDeletes);
185
186error_t lldpMgmtGetStatsRemTablesDrops(LldpAgentContext *context,
187 uint32_t *statsRemTablesDrops);
188
189error_t lldpMgmtGetStatsRemTablesAgeouts(LldpAgentContext *context,
190 uint32_t *statsRemTablesAgeouts);
191
192//C++ guard
193#ifdef __cplusplus
194}
195#endif
196
197#endif
error_t
Error codes.
Definition error.h:43
LLDP (Link Layer Discovery Protocol)
LldpAdminStatus
Administrative status.
Definition lldp.h:187
LldpMgmtAddrSubtype
Management address subtypes.
Definition lldp_tlv.h:162
LldpPortIdSubtype
Port ID subtypes.
Definition lldp_tlv.h:128
LldpChassisIdSubtype
Chassis ID subtypes.
Definition lldp_tlv.h:111
LldpIfNumSubtype
Interface numbering subtypes.
Definition lldp_tlv.h:175
TCP/IP stack core.
LLDP neighbor entry.
Definition lldp.h:260