1

/*

     2

This file is part of CanFestival, a library implementing CanOpen Stack. 

     3

     4

Copyright (C): Edouard TISSERANT and Francis DUPIN

     5

     6

See COPYING file for copyrights details.

     7

     8

This library is free software; you can redistribute it and/or

     9

modify it under the terms of the GNU Lesser General Public

    10

License as published by the Free Software Foundation; either

    11

version 2.1 of the License, or (at your option) any later version.

    12

    13

This library is distributed in the hope that it will be useful,

    14

but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    16

Lesser General Public License for more details.

    17

    18

You should have received a copy of the GNU Lesser General Public

    19

License along with this library; if not, write to the Free Software

    20

Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    21

*/

    22

    23

#ifndef __data_h__

    24

#define __data_h__

    25

    26

#ifdef __cplusplus

    27

extern "C" {

    28

#endif

    29

    30

/* declaration of CO_Data type let us include all necessary headers

    31

 struct struct_CO_Data can then be defined later

    32

 */

    33

typedef struct struct_CO_Data CO_Data;

    34

    35

#include "applicfg.h"

    36

#include "def.h"

    37

#include "can.h"

    38

#include "objdictdef.h"

    39

#include "objacces.h"

    40

#include "sdo.h"

    41

#include "pdo.h"

    42

#include "states.h"

    43

#include "lifegrd.h"

    44

#include "sync.h"

    45

#include "nmtMaster.h"

    46

#include "emcy.h"

    47

#ifdef CO_ENABLE_LSS

    48

#include "lss.h"

    49

#endif

    50

    51

/* This structurs contains all necessary information for a CanOpen node */

    52

struct struct_CO_Data {

    53

	/* Object dictionary */

    54

	UNS8 *bDeviceNodeId;

    55

	const indextable *objdict;

    56

	s_PDO_status *PDO_status;

    57

	quick_index *firstIndex;

    58

	quick_index *lastIndex;

    59

	UNS16 *ObjdictSize;

    60

	const UNS8 *iam_a_slave;

    61

	valueRangeTest_t valueRangeTest;

    62

    63

	/* SDO */

    64

	s_transfer transfers[SDO_MAX_SIMULTANEOUS_TRANSFERTS];

    65

	/* s_sdo_parameter *sdo_parameters; */

    66

    67

	/* State machine */

    68

	e_nodeState nodeState;

    69

	s_state_communication CurrentCommunicationState;

    70

	initialisation_t initialisation;

    71

	preOperational_t preOperational;

    72

	operational_t operational;

    73

	stopped_t stopped;

    74

    75

	/* NMT-heartbeat */

    76

	UNS8 *ConsumerHeartbeatCount;

    77

	UNS32 *ConsumerHeartbeatEntries;

    78

	TIMER_HANDLE *ConsumerHeartBeatTimers;

    79

	UNS16 *ProducerHeartBeatTime;

    80

	TIMER_HANDLE ProducerHeartBeatTimer;

    81

	heartbeatError_t heartbeatError;

    82

	e_nodeState NMTable[NMT_MAX_NODE_ID]; 

    83

    84

	/* SYNC */

    85

	TIMER_HANDLE syncTimer;

    86

	UNS32 *COB_ID_Sync;

    87

	UNS32 *Sync_Cycle_Period;

    88

	/*UNS32 *Sync_window_length;;*/

    89

	post_sync_t post_sync;

    90

	post_TPDO_t post_TPDO;

    91

	post_SlaveBootup_t post_SlaveBootup;

    92

    93

	/* General */

    94

	UNS8 toggle;

    95

	CAN_HANDLE canHandle;	

    96

	scanIndexOD_t scanIndexOD;

    97

	storeODSubIndex_t storeODSubIndex; 

    98

    99

	/* DCF concise */

   100

    const indextable* dcf_odentry;

   101

	UNS8* dcf_cursor;

   102

	UNS32 dcf_entries_count;

   103

   104

	/* EMCY */

   105

	e_errorState error_state;

   106

	UNS8 error_history_size;

   107

	UNS8* error_number;

   108

	UNS32* error_first_element;

   109

	UNS8* error_register;

   110

    UNS32* error_cobid;

   111

	s_errors error_data[EMCY_MAX_ERRORS];

   112

	post_emcy_t post_emcy;

   113

   114

#ifdef CO_ENABLE_LSS

   115

	/* LSS */

   116

	lss_transfer_t lss_transfer;

   117

	lss_StoreConfiguration_t lss_StoreConfiguration;

   118

	lss_ChangeBaudRate_t lss_ChangeBaudRate;

   119

#endif	

   120

};

   121

   122

#define NMTable_Initializer Unknown_state,

   123

   124

#define s_transfer_Initializer {\

   125

		0,          /* nodeId */\

   126

		0,          /* wohami */\

   127

		SDO_RESET,  /* state */\

   128

		0,          /* toggle */\

   129

		0,          /* abortCode */\

   130

		0,          /* index */\

   131

		0,          /* subIndex */\

   132

		0,          /* count */\

   133

		0,          /* offset */\

   134

		{0},        /* data (static use, so that all the table is initialize at 0)*/\

   135

		0,          /* dataType */\

   136

		-1,         /* timer */\

   137

		NULL        /* Callback */\

   138

	  },

   139

   140

#define ERROR_DATA_INITIALIZER \

   141

	{\

   142

	0, /* errCode */\

   143

	0, /* errRegMask */\

   144

	0 /* active */\

   145

	},

   146

   147

#ifdef CO_ENABLE_LSS

   148

#define lss_Initializer {\

   149

		LSS_RESET,  			/* state */\

   150

		0,						/* command */\

   151

		LSS_WAITING_MODE, 		/* mode */\

   152

		0,						/* dat1 */\

   153

		0,						/* dat2 */\

   154

		Unknown_state,  		/* currentState */\

   155

		0,          			/* NodeID */\

   156

		0,          			/* addr_sel_match */\

   157

		0,          			/* addr_ident_match */\

   158

		"none",         		/* BaudRate */\

   159

		0,          			/* SwitchDelay */\

   160

		SDELAY_OFF,   			/* SwitchDelayState */\

   161

		{-1,-1},          		/* Timers[2] */\

   162

		NULL,        			/* Callback */\

   163

		0,						/* IDNumber */\

   164

  		128, 					/* BitChecked */\

   165

  		0,						/* LSSSub */\

   166

  		0, 						/* LSSNext */\

   167

  		0, 						/* LSSPos */\

   168

  		LSS_FS_RESET			/* FastScan_SM */\

   169

	  },\

   170

	  NULL, 	/* _lss_StoreConfiguration*/\

   171

	  NULL    /* _lss_ChangeBaudRate */

   172

#else

   173

#define lss_Initializer

   174

#endif

   175

   176

   177

/* A macro to initialize the data in client app.*/

   178

/* CO_Data structure */

   179

#define CANOPEN_NODE_DATA_INITIALIZER(NODE_PREFIX) {\

   180

	/* Object dictionary*/\

   181

	& NODE_PREFIX ## _bDeviceNodeId,     /* bDeviceNodeId */\

   182

	NODE_PREFIX ## _objdict,             /* objdict  */\

   183

	NODE_PREFIX ## _PDO_status,          /* PDO_status */\

   184

	& NODE_PREFIX ## _firstIndex,        /* firstIndex */\

   185

	& NODE_PREFIX ## _lastIndex,         /* lastIndex */\

   186

	& NODE_PREFIX ## _ObjdictSize,       /* ObjdictSize */\

   187

	& NODE_PREFIX ## _iam_a_slave,       /* iam_a_slave */\

   188

	NODE_PREFIX ## _valueRangeTest,      /* valueRangeTest */\

   189

	\

   190

	/* SDO, structure s_transfer */\

   191

	{\

   192

          REPEAT_SDO_MAX_SIMULTANEOUS_TRANSFERTS_TIMES(s_transfer_Initializer)\

   193

	},\

   194

	\

   195

	/* State machine*/\

   196

	Unknown_state,      /* nodeState */\

   197

	/* structure s_state_communication */\

   198

	{\

   199

		0,          /* csBoot_Up */\

   200

		0,          /* csSDO */\

   201

		0,          /* csEmergency */\

   202

		0,          /* csSYNC */\

   203

		0,          /* csHeartbeat */\

   204

		0           /* csPDO */\

   205

	},\

   206

	_initialisation,     /* initialisation */\

   207

	_preOperational,     /* preOperational */\

   208

	_operational,        /* operational */\

   209

	_stopped,            /* stopped */\

   210

	\

   211

	/* NMT-heartbeat */\

   212

	& NODE_PREFIX ## _highestSubIndex_obj1016, /* ConsumerHeartbeatCount */\

   213

	NODE_PREFIX ## _obj1016,                   /* ConsumerHeartbeatEntries */\

   214

	NODE_PREFIX ## _heartBeatTimers,           /* ConsumerHeartBeatTimers  */\

   215

	& NODE_PREFIX ## _obj1017,                 /* ProducerHeartBeatTime */\

   216

	TIMER_NONE,                                /* ProducerHeartBeatTimer */\

   217

	_heartbeatError,           /* heartbeatError */\

   218

	\

   219

	{REPEAT_NMT_MAX_NODE_ID_TIMES(NMTable_Initializer)},\

   220

                                                   /* is  well initialized at "Unknown_state". Is it ok ? (FD)*/\

   221

	\

   222

	/* SYNC */\

   223

	TIMER_NONE,                                /* syncTimer */\

   224

	& NODE_PREFIX ## _obj1005,                 /* COB_ID_Sync */\

   225

	& NODE_PREFIX ## _obj1006,                 /* Sync_Cycle_Period */\

   226

	/*& NODE_PREFIX ## _obj1007, */            /* Sync_window_length */\

   227

	_post_sync,                 /* post_sync */\

   228

	_post_TPDO,                 /* post_TPDO */\

   229

	_post_SlaveBootup,			/* post_SlaveBootup */\

   230

	\

   231

	/* General */\

   232

	0,                                         /* toggle */\

   233

	NULL,                   /* canSend */\

   234

	NODE_PREFIX ## _scanIndexOD,                /* scanIndexOD */\

   235

	_storeODSubIndex,                /* storeODSubIndex */\

   236

    /* DCF concise */\

   237

    NULL,       /*dcf_odentry*/\

   238

	NULL,		/*dcf_cursor*/\

   239

	1,		/*dcf_entries_count*/\

   240

	\

   241

	/* EMCY */\

   242

	Error_free,                      /* error_state */\

   243

	sizeof(NODE_PREFIX ## _obj1003) / sizeof(NODE_PREFIX ## _obj1003[0]),      /* error_history_size */\

   244

	& NODE_PREFIX ## _highestSubIndex_obj1003,    /* error_number */\

   245

	& NODE_PREFIX ## _obj1003[0],    /* error_first_element */\

   246

	& NODE_PREFIX ## _obj1001,       /* error_register */\

   247

    & NODE_PREFIX ## _obj1014,       /* error_cobid */\

   248

	/* error_data: structure s_errors */\

   249

	{\

   250

	REPEAT_EMCY_MAX_ERRORS_TIMES(ERROR_DATA_INITIALIZER)\

   251

	},\

   252

	_post_emcy,              /* post_emcy */\

   253

	/* LSS */\

   254

	lss_Initializer\

   255

}

   256

   257

#ifdef __cplusplus

   258

};

   259

#endif

   260

   261

#endif /* __data_h__ */

   262

   263