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 "nmtSlave.h"

    46

#include "nmtMaster.h"

    47

#include "emcy.h"

    48

#ifdef CO_ENABLE_LSS

    49

#include "lss.h"

    50

#endif

    51

    52

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

    53

struct struct_CO_Data {

    54

	/* Object dictionary */

    55

	UNS8 *bDeviceNodeId;

    56

	const indextable *objdict;

    57

	s_PDO_status *PDO_status;

    58

	const quick_index *firstIndex;

    59

	const quick_index *lastIndex;

    60

	const UNS16 *ObjdictSize;

    61

	const UNS8 *iam_a_slave;

    62

	valueRangeTest_t valueRangeTest;

    63

    64

	/* SDO */

    65

	s_transfer transfers[SDO_MAX_SIMULTANEOUS_TRANSFERTS];

    66

	/* s_sdo_parameter *sdo_parameters; */

    67

    68

	/* State machine */

    69

	e_nodeState nodeState;

    70

	s_state_communication CurrentCommunicationState;

    71

	initialisation_t initialisation;

    72

	preOperational_t preOperational;

    73

	operational_t operational;

    74

	stopped_t stopped;

    75

     void (*NMT_Slave_Node_Reset_Callback)(CO_Data*);

    76

     void (*NMT_Slave_Communications_Reset_Callback)(CO_Data*);

    77

    78

	/* NMT-heartbeat */

    79

	UNS8 *ConsumerHeartbeatCount;

    80

	UNS32 *ConsumerHeartbeatEntries;

    81

	TIMER_HANDLE *ConsumerHeartBeatTimers;

    82

	UNS16 *ProducerHeartBeatTime;

    83

	TIMER_HANDLE ProducerHeartBeatTimer;

    84

	heartbeatError_t heartbeatError;

    85

	e_nodeState NMTable[NMT_MAX_NODE_ID]; 

    86

    87

	/* SYNC */

    88

	TIMER_HANDLE syncTimer;

    89

	UNS32 *COB_ID_Sync;

    90

	UNS32 *Sync_Cycle_Period;

    91

	/*UNS32 *Sync_window_length;;*/

    92

	post_sync_t post_sync;

    93

	post_TPDO_t post_TPDO;

    94

	post_SlaveBootup_t post_SlaveBootup;

    95

    96

	/* General */

    97

	UNS8 toggle;

    98

	CAN_PORT canHandle;	

    99

	scanIndexOD_t scanIndexOD;

   100

	storeODSubIndex_t storeODSubIndex; 

   101

   102

	/* DCF concise */

   103

    const indextable* dcf_odentry;

   104

	UNS8* dcf_cursor;

   105

	UNS32 dcf_entries_count;

   106

	UNS8 dcf_request;

   107

   108

	/* EMCY */

   109

	e_errorState error_state;

   110

	UNS8 error_history_size;

   111

	UNS8* error_number;

   112

	UNS32* error_first_element;

   113

	UNS8* error_register;

   114

    UNS32* error_cobid;

   115

	s_errors error_data[EMCY_MAX_ERRORS];

   116

	post_emcy_t post_emcy;

   117

   118

#ifdef CO_ENABLE_LSS

   119

	/* LSS */

   120

	lss_transfer_t lss_transfer;

   121

	lss_StoreConfiguration_t lss_StoreConfiguration;

   122

#endif	

   123

};

   124

   125

#define NMTable_Initializer Unknown_state,

   126

   127

#define s_transfer_Initializer {\

   128

		0,          /* nodeId */\

   129

		0,          /* wohami */\

   130

		SDO_RESET,  /* state */\

   131

		0,          /* toggle */\

   132

		0,          /* abortCode */\

   133

		0,          /* index */\

   134

		0,          /* subIndex */\

   135

		0,          /* count */\

   136

		0,          /* offset */\

   137

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

   138

		0,          /* dataType */\

   139

		-1,         /* timer */\

   140

		NULL        /* Callback */\

   141

	  },

   142

   143

#define ERROR_DATA_INITIALIZER \

   144

	{\

   145

	0, /* errCode */\

   146

	0, /* errRegMask */\

   147

	0 /* active */\

   148

	},

   149

   150

#ifdef CO_ENABLE_LSS

   151

   152

#ifdef CO_ENABLE_LSS_FS	

   153

#define lss_fs_Initializer \

   154

		,0,						/* IDNumber */\

   155

  		128, 					/* BitChecked */\

   156

  		0,						/* LSSSub */\

   157

  		0, 						/* LSSNext */\

   158

  		0, 						/* LSSPos */\

   159

  		LSS_FS_RESET,			/* FastScan_SM */\

   160

  		-1,						/* timerFS */\

   161

  		{{0,0,0,0},{0,0,0,0}}   /* lss_fs_transfer */

   162

#else

   163

#define lss_fs_Initializer

   164

#endif		

   165

   166

#define lss_Initializer {\

   167

		LSS_RESET,  			/* state */\

   168

		0,						/* command */\

   169

		LSS_WAITING_MODE, 		/* mode */\

   170

		0,						/* dat1 */\

   171

		0,						/* dat2 */\

   172

		0,          			/* NodeID */\

   173

		0,          			/* addr_sel_match */\

   174

		0,          			/* addr_ident_match */\

   175

		"none",         		/* BaudRate */\

   176

		0,          			/* SwitchDelay */\

   177

		SDELAY_OFF,   			/* SwitchDelayState */\

   178

		NULL,					/* canHandle_t */\

   179

		-1,						/* TimerMSG */\

   180

		-1,          			/* TimerSDELAY */\

   181

		NULL,        			/* Callback */\

   182

		0						/* LSSanswer */\

   183

		lss_fs_Initializer		/*FastScan service initialization */\

   184

	  },\

   185

	  NULL 	/* _lss_StoreConfiguration*/

   186

#else

   187

#define lss_Initializer

   188

#endif

   189

   190

   191

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

   192

/* CO_Data structure */

   193

#define CANOPEN_NODE_DATA_INITIALIZER(NODE_PREFIX) {\

   194

	/* Object dictionary*/\

   195

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

   196

	NODE_PREFIX ## _objdict,             /* objdict  */\

   197

	NODE_PREFIX ## _PDO_status,          /* PDO_status */\

   198

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

   199

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

   200

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

   201

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

   202

	NODE_PREFIX ## _valueRangeTest,      /* valueRangeTest */\

   203

	\

   204

	/* SDO, structure s_transfer */\

   205

	{\

   206

          REPEAT_SDO_MAX_SIMULTANEOUS_TRANSFERTS_TIMES(s_transfer_Initializer)\

   207

	},\

   208

	\

   209

	/* State machine*/\

   210

	Unknown_state,      /* nodeState */\

   211

	/* structure s_state_communication */\

   212

	{\

   213

		0,          /* csBoot_Up */\

   214

		0,          /* csSDO */\

   215

		0,          /* csEmergency */\

   216

		0,          /* csSYNC */\

   217

		0,          /* csHeartbeat */\

   218

		0,           /* csPDO */\

   219

		0           /* csLSS */\

   220

	},\

   221

	_initialisation,     /* initialisation */\

   222

	_preOperational,     /* preOperational */\

   223

	_operational,        /* operational */\

   224

	_stopped,            /* stopped */\

   225

	NULL,                /* NMT node reset callback */\

   226

	NULL,                /* NMT communications reset callback */\

   227

	\

   228

	/* NMT-heartbeat */\

   229

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

   230

	NODE_PREFIX ## _obj1016,                   /* ConsumerHeartbeatEntries */\

   231

	NODE_PREFIX ## _heartBeatTimers,           /* ConsumerHeartBeatTimers  */\

   232

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

   233

	TIMER_NONE,                                /* ProducerHeartBeatTimer */\

   234

	_heartbeatError,           /* heartbeatError */\

   235

	\

   236

	{REPEAT_NMT_MAX_NODE_ID_TIMES(NMTable_Initializer)},\

   237

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

   238

	\

   239

	/* SYNC */\

   240

	TIMER_NONE,                                /* syncTimer */\

   241

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

   242

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

   243

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

   244

	_post_sync,                 /* post_sync */\

   245

	_post_TPDO,                 /* post_TPDO */\

   246

	_post_SlaveBootup,			/* post_SlaveBootup */\

   247

	\

   248

	/* General */\

   249

	0,                                         /* toggle */\

   250

	NULL,                   /* canSend */\

   251

	NODE_PREFIX ## _scanIndexOD,                /* scanIndexOD */\

   252

	_storeODSubIndex,                /* storeODSubIndex */\

   253

    /* DCF concise */\

   254

    NULL,       /*dcf_odentry*/\

   255

	NULL,		/*dcf_cursor*/\

   256

	1,		/*dcf_entries_count*/\

   257

	0,		/* dcf_request*/\

   258

	\

   259

	/* EMCY */\

   260

	Error_free,                      /* error_state */\

   261

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

   262

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

   263

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

   264

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

   265

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

   266

	/* error_data: structure s_errors */\

   267

	{\

   268

	REPEAT_EMCY_MAX_ERRORS_TIMES(ERROR_DATA_INITIALIZER)\

   269

	},\

   270

	_post_emcy,              /* post_emcy */\

   271

	/* LSS */\

   272

	lss_Initializer\

   273

}

   274

   275

#ifdef __cplusplus

   276

};

   277

#endif

   278

   279

#endif /* __data_h__ */

   280

   281