1 /**************************************************************************** 2 3 (c) SYSTEC electronic GmbH, D-07973 Greiz, August-Bebel-Str. 29 4 www.systec-electronic.com 5 6 Project: openPOWERLINK 7 8 Description: include file for NMT-MN-Userspace-Module 9 10 License: 11 12 Redistribution and use in source and binary forms, with or without 13 modification, are permitted provided that the following conditions 14 are met: 15 16 1. Redistributions of source code must retain the above copyright 17 notice, this list of conditions and the following disclaimer. 18 19 2. Redistributions in binary form must reproduce the above copyright 20 notice, this list of conditions and the following disclaimer in the 21 documentation and/or other materials provided with the distribution. 22 23 3. Neither the name of SYSTEC electronic GmbH nor the names of its 24 contributors may be used to endorse or promote products derived 25 from this software without prior written permission. For written 26 permission, please contact info@systec-electronic.com. 27 28 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 29 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 30 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 31 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 32 COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 33 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 34 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 35 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 36 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 37 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 38 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 39 POSSIBILITY OF SUCH DAMAGE. 40 41 Severability Clause: 42 43 If a provision of this License is or becomes illegal, invalid or 44 unenforceable in any jurisdiction, that shall not affect: 45 1. the validity or enforceability in that jurisdiction of any other 46 provision of this License; or 47 2. the validity or enforceability in other jurisdictions of that or 48 any other provision of this License. 49 50 ------------------------------------------------------------------------- 51 52 $RCSfile: EplNmtMnu.h,v $ 53 54 $Author: D.Krueger $ 55 56 $Revision: 1.6 $ $Date: 2008/10/17 15:32:32 $ 57 58 $State: Exp $ 59 60 Build Environment: 61 GCC V3.4 62 63 ------------------------------------------------------------------------- 64 65 Revision History: 66 67 2006/06/09 k.t.: start of the implementation 68 69 ****************************************************************************/ 70 71 #include "EplNmtu.h" 72 73 #ifndef _EPLNMTMNU_H_ 74 #define _EPLNMTMNU_H_ 75 76 //--------------------------------------------------------------------------- 77 // const defines 78 //--------------------------------------------------------------------------- 79 80 //--------------------------------------------------------------------------- 81 // typedef 82 //--------------------------------------------------------------------------- 83 84 typedef tEplKernel(PUBLIC * tEplNmtMnuCbNodeEvent) (unsigned int uiNodeId_p, 85 tEplNmtNodeEvent 86 NodeEvent_p, 87 tEplNmtState NmtState_p, 88 WORD wErrorCode_p, 89 BOOL fMandatory_p); 90 91 typedef tEplKernel(PUBLIC * 92 tEplNmtMnuCbBootEvent) (tEplNmtBootEvent BootEvent_p, 93 tEplNmtState NmtState_p, 94 WORD wErrorCode_p); 95 96 //--------------------------------------------------------------------------- 97 // function prototypes 98 //--------------------------------------------------------------------------- 99 100 #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_NMT_MN)) != 0) 101 102 tEplKernel EplNmtMnuInit(tEplNmtMnuCbNodeEvent pfnCbNodeEvent_p, 103 tEplNmtMnuCbBootEvent pfnCbBootEvent_p); 104 105 tEplKernel EplNmtMnuAddInstance(tEplNmtMnuCbNodeEvent pfnCbNodeEvent_p, 106 tEplNmtMnuCbBootEvent pfnCbBootEvent_p); 107 108 tEplKernel EplNmtMnuDelInstance(void); 109 110 EPLDLLEXPORT tEplKernel PUBLIC EplNmtMnuProcessEvent(tEplEvent * pEvent_p); 111 112 tEplKernel EplNmtMnuSendNmtCommand(unsigned int uiNodeId_p, 113 tEplNmtCommand NmtCommand_p); 114 115 tEplKernel EplNmtMnuTriggerStateChange(unsigned int uiNodeId_p, 116 tEplNmtNodeCommand NodeCommand_p); 117 118 tEplKernel PUBLIC EplNmtMnuCbNmtStateChange(tEplEventNmtStateChange 119 NmtStateChange_p); 120 121 tEplKernel PUBLIC EplNmtMnuCbCheckEvent(tEplNmtEvent NmtEvent_p); 122 123 tEplKernel PUBLIC EplNmtMnuGetDiagnosticInfo(unsigned int 124 *puiMandatorySlaveCount_p, 125 unsigned int 126 *puiSignalSlaveCount_p, 127 WORD * pwFlags_p); 128 129 #endif 130 131 #endif // #ifndef _EPLNMTMNU_H_ 132