versadac  1
versadac - Scalable Recorder Firmware
lldpapi.h
1 /*---------------------------------------------------------------------------*/
2 /* Copyright (C) 2006 Woodhead Software & Electonics. All rights reserved. */
3 /*---------------------------------------------------------------------------*/
4 /* This program is protected by international copyright. */
5 /* */
6 /* The use of this software including but not limited to its Source Code */
7 /* is subject to restrictions as agreed in the license agreement between */
8 /* you and Woodhead. */
9 /* Copying or distribution is not allowed unless expressly permitted */
10 /* according to your license agreement with Woodhead. */
11 /*---------------------------------------------------------------------------*/
12 /* */
13 /* Project : STACK PROFINET Controller */
14 /* Component : LLDP */
15 /* $Workfile:: lldpapi.h $*/
16 /* $Revision:: 1 $*/
17 /* $Date:: 9/07/09 4:45p $*/
18 /* */
19 /*---------------------------------------------------------------------------*/
20 /* */
21 /* D e s c r i p t i o n : */
22 /* - LLDP API header */
23 /*---------------------------------------------------------------------------*/
24 #ifndef _LLDPAPI_H
25 #define _LLDPAPI_H
26 
27 #include "system.h"
28 
29 
30 #define LLDP_STAT_OK 0
31 #define LLDP_STAT_PAR 1
32 #define LLDP_STAT_RES 2
33 #define LLDP_STAT_OUT_OF_RANGE 3
34 #define LLDP_STAT_INIT_TWICE 4
35 #define LLDP_STAT_NOT_SUPPORTED 5
36 #define LLDP_STAT_NO_RECORD 6
37 
38 #define LLDP_STAT_ALREADY_STOPPED 7
39 #define LLDP_STAT_ALREADY_STARTED 8
40 #define LLDP_STAT_STARTED 9
41 
42 
43 /* LLDP API DEFINITION */
44 APP_WORD WSE_LLDP_Init_Req(APP_LPVOID lpContext, APP_LPVOID lpvHandle, APP_LPBYTE lpbyMacAddr, APP_BYTE byMacAddrBufferLen, APP_LPWORD lpwStatus);
45 APP_WORD WSE_LLDP_Start_Req(APP_LPVOID lpContext, APP_LPWORD lpwStatus);
46 
47 
48 APP_WORD WSE_LLDP_SetTimeConfig_Req(APP_LPVOID lpContext, APP_WORD wMsgTxHold, APP_WORD wMsgTxInterval, APP_WORD wMsgTxReInitDelay, APP_WORD wMsgTxDelay, APP_LPWORD lpwStatus);
49 APP_WORD WSE_LLDP_GetTimeConfig_Req(APP_LPVOID lpContext, APP_LPWORD lpwStatus);
50 
51 APP_WORD WSE_LLDP_SetPortConfig_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_BYTE byLLDPAdminStatus, APP_BOOL bLLDPPortEnabled, APP_BYTE byLLDPTlvTxEnabled, APP_LPBYTE sPortID, APP_BYTE byPortSubType, APP_LPWORD lpwStatus);
52 APP_WORD WSE_LLDP_GetPortConfig_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
53 
54 APP_WORD WSE_LLDP_SetSystemConfig_Req(APP_LPVOID lpContext, APP_LPBYTE sChassisID, APP_BYTE byChassisIDSubType, APP_LPWORD lpwStatus);
55 APP_WORD WSE_LLDP_GetSystemConfig_Req(APP_LPVOID lpContext, APP_LPWORD lpwStatus);
56 
57 APP_WORD WSE_LLDP_SetAddressMgt_Req(APP_LPVOID lpContext, APP_BYTE byMgtAddrSubType, APP_DWORD dwMgtAddr, APP_BYTE byMgtAddrItfSubType, APP_DWORD dwMgtAddrItfNumber, APP_BYTE byMgtAddrOidLength, APP_LPBYTE sMgtAddrOid, APP_LPWORD lpwStatus);
58 APP_WORD WSE_LLDP_GetAddressMgt_Req(APP_LPVOID lpContext, APP_LPWORD lpwStatus);
59 
60 APP_WORD WSE_LLDP_SetDescription_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPBYTE sPortDesc, APP_LPBYTE sSysName, APP_LPBYTE sSysDesc, APP_WORD wSysCap, APP_WORD wSysCapEnabled, APP_LPWORD lpwStatus);
61 APP_WORD WSE_LLDP_GetDescription_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
62 
63 
64 APP_WORD WSE_LLDP_PN_SetTxEnable_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_BYTE byPnTxEnable, APP_LPWORD lpwStatus);
65 APP_WORD WSE_LLDP_PN_GetTxEnable_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
66 
67 
68 
69 
70 
71 APP_WORD WSE_LLDP_PN_SetPortStatus_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_WORD wPNPortStatusRt2, APP_WORD wPNPortStatusRt3, APP_LPWORD lpwStatus);
72 APP_WORD WSE_LLDP_PN_GetPortStatus_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
73 
74 
75 APP_WORD WSE_LLDP_PN_SetChassisMac_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPBYTE sChassisMac, APP_LPWORD lpwStatus);
76 APP_WORD WSE_LLDP_PN_GetChassisMac_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
77 
78 
79 APP_WORD WSE_LLDP_PN_SetMrp_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_WORD wMRRT_PortStatus, APP_LPBYTE sUUIDDomain, APP_LPWORD lpwStatus);
80 APP_WORD WSE_LLDP_PN_GetMrp_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
81 
82 
83 
84 APP_WORD WSE_LLDP_8023_SetTxEnable_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_BYTE by802TxEnable, APP_LPWORD lpwStatus);
85 APP_WORD WSE_LLDP_8023_GetTxEnable_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
86 
87 APP_WORD WSE_LLDP_8023_SetAutoNeg_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_BOOL b8023AutoNegSupported, APP_BOOL b8023AutoNegEnabled, APP_WORD w8023AutoNegAdvCapability, APP_WORD wOperationMauType, APP_LPWORD lpwStatus);
88 APP_WORD WSE_LLDP_8023_GetAutoNeg_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
89 
90 APP_WORD WSE_LLDP_GetPortSysList_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
91 APP_WORD WSE_LLDP_GetPortRemoteInformation_Req(APP_LPVOID lpContext, APP_BYTE byRemIndex, APP_LPWORD lpwStatus);
92 
93 
94 APP_WORD WSE_LLDP_GetPortAddrMgtList_Req(APP_LPVOID lpContext, APP_BYTE byRemoteIndex, APP_LPWORD lpwStatus);
95 APP_WORD WSE_LLDP_GetRemoteAddressMgt_Req(APP_LPVOID lpContext, APP_BYTE byRemoteIndex, APP_BYTE byMgtAddrIndex, APP_LPWORD lpwStatus);
96 
97 APP_WORD WSE_LLDP_GetRemoteOrganizationUnkTlv_Req(APP_LPVOID lpContext, APP_BYTE byRemoteIndex, APP_BYTE byRemoteOrgUnknownTlvIndex, APP_LPWORD lpwStatus);
98 APP_WORD WSE_LLDP_GetRemoteOrgUnkTlvList_Req(APP_LPVOID lpContext, APP_BYTE byRemoteIndex, APP_LPWORD lpwStatus);
99 
100 APP_WORD WSE_LLDP_GetRemoteUnknownTlv_Req(APP_LPVOID lpContext, APP_BYTE byRemoteIndex, APP_BYTE byRemoteUnknownTlvIndex, APP_LPWORD lpwStatus);
101 APP_WORD WSE_LLDP_GetRemoteUnknownTlvList_Req(APP_LPVOID lpContext, APP_BYTE byRemoteIndex, APP_LPWORD lpwStatus);
102 
103 APP_WORD WSE_LLDP_GetRemoteAddressMgt_Req(APP_LPVOID lpContext, APP_BYTE byRemoteIndex, APP_BYTE byMgtAddrIndex, APP_LPWORD lpwStatus);
104 APP_WORD WSE_LLDP_GetPortAddrMgtList_Req(APP_LPVOID lpContext, APP_BYTE byRemoteIndex, APP_LPWORD lpwStatus);
105 
106 
107 APP_WORD WSE_LLDP_PN_GetRemPortStatus_Req(APP_LPVOID lpContext, APP_BYTE byRemIndex, APP_LPWORD lpwStatus);
108 APP_WORD WSE_LLDP_PN_GetRemChassisMac_Req(APP_LPVOID lpContext, APP_BYTE byRemIndex, APP_LPWORD lpwStatus);
109 APP_WORD WSE_LLDP_PN_GetRemMrp_Req(APP_LPVOID lpContext, APP_BYTE byRemIndex, APP_LPWORD lpwStatus);
110 
111 APP_WORD WSE_LLDP_8023_GetRemAutoNeg_Req(APP_LPVOID lpContext, APP_BYTE byRemIndex, APP_LPWORD lpwStatus);
112 
113 APP_WORD WSE_LLDP_Rx_Stats_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
114 APP_WORD WSE_LLDP_Tx_Stats_Req(APP_LPVOID lpContext, APP_BYTE byPortIndex, APP_LPWORD lpwStatus);
115 
116 APP_WORD WSE_LLDP_Stop_Req(APP_LPVOID lpContext, APP_LPWORD lpwStatus);
117 APP_WORD WSE_LLDP_Exit_Req(APP_LPVOID lpContext, APP_LPWORD lpwStatus);
118 
119 #endif /* END OF HEADER FILE */