• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 PDO 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: EplPdo.h,v $
53 
54                 $Author: D.Krueger $
55 
56                 $Revision: 1.5 $  $Date: 2008/04/17 21:36:32 $
57 
58                 $State: Exp $
59 
60                 Build Environment:
61                     GCC V3.4
62 
63   -------------------------------------------------------------------------
64 
65   Revision History:
66 
67   2006/05/22 d.k.:   start of the implementation, version 1.00
68 
69 ****************************************************************************/
70 
71 #ifndef _EPL_PDO_H_
72 #define _EPL_PDO_H_
73 
74 #include "EplInc.h"
75 
76 //---------------------------------------------------------------------------
77 // const defines
78 //---------------------------------------------------------------------------
79 
80 // invalid PDO-NodeId
81 #define EPL_PDO_INVALID_NODE_ID     0xFF
82 // NodeId for PReq RPDO
83 #define EPL_PDO_PREQ_NODE_ID        0x00
84 // NodeId for PRes TPDO
85 #define EPL_PDO_PRES_NODE_ID        0x00
86 
87 //---------------------------------------------------------------------------
88 // typedef
89 //---------------------------------------------------------------------------
90 
91 typedef struct {
92 	void *m_pVar;
93 	WORD m_wOffset;		// in Bits
94 	WORD m_wSize;		// in Bits
95 	BOOL m_fNumeric;	// numeric value -> use AMI functions
96 
97 } tEplPdoMapping;
98 
99 typedef struct {
100 	unsigned int m_uiSizeOfStruct;
101 	unsigned int m_uiPdoId;
102 	unsigned int m_uiNodeId;
103 	// 0xFF=invalid, RPDO: 0x00=PReq, localNodeId=PRes, remoteNodeId=PRes
104 	//               TPDO: 0x00=PRes, MN: CnNodeId=PReq
105 
106 	BOOL m_fTxRx;
107 	BYTE m_bMappingVersion;
108 	unsigned int m_uiMaxMappingEntries;	// maximum number of mapping entries, i.e. size of m_aPdoMapping
109 	tEplPdoMapping m_aPdoMapping[1];
110 
111 } tEplPdoParam;
112 
113 //---------------------------------------------------------------------------
114 // function prototypes
115 //---------------------------------------------------------------------------
116 
117 #endif // #ifndef _EPL_PDO_H_
118