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

/**

    53

 * @ingroup od

    54

 * @brief This structure contains all necessary informations to define a CANOpen node 

    55

 */

    56

struct struct_CO_Data {

    57

	/* Object dictionary */

    58

	UNS8 *bDeviceNodeId;

    59

	const indextable *objdict;

    60

	s_PDO_status *PDO_status;

    61

	const quick_index *firstIndex;

    62

	const quick_index *lastIndex;

    63

	const UNS16 *ObjdictSize;

    64

	const UNS8 *iam_a_slave;

    65

	valueRangeTest_t valueRangeTest;

    66

    67

	/* SDO */

    68

	s_transfer transfers[SDO_MAX_SIMULTANEOUS_TRANSFERTS];

    69

	/* s_sdo_parameter *sdo_parameters; */

    70

    71

	/* State machine */

    72

	e_nodeState nodeState;

    73

	s_state_communication CurrentCommunicationState;

    74

	initialisation_t initialisation;

    75

	preOperational_t preOperational;

    76

	operational_t operational;

    77

	stopped_t stopped;

    78

     void (*NMT_Slave_Node_Reset_Callback)(CO_Data*);

    79

     void (*NMT_Slave_Communications_Reset_Callback)(CO_Data*);

    80

    81

	/* NMT-heartbeat */

    82

	UNS8 *ConsumerHeartbeatCount;

    83

	UNS32 *ConsumerHeartbeatEntries;

    84

	TIMER_HANDLE *ConsumerHeartBeatTimers;

    85

	UNS16 *ProducerHeartBeatTime;

    86

	TIMER_HANDLE ProducerHeartBeatTimer;

    87

	heartbeatError_t heartbeatError;

    88

	e_nodeState NMTable[NMT_MAX_NODE_ID]; 

    89

    90

	/* SYNC */

    91

	TIMER_HANDLE syncTimer;

    92

	UNS32 *COB_ID_Sync;

    93

	UNS32 *Sync_Cycle_Period;

    94

	/*UNS32 *Sync_window_length;;*/

    95

	post_sync_t post_sync;

    96

	post_TPDO_t post_TPDO;

    97

	post_SlaveBootup_t post_SlaveBootup;

    98

    post_SlaveStateChange_t post_SlaveStateChange;

    99

   100

	/* General */

   101

	UNS8 toggle;

   102

	CAN_PORT canHandle;	

   103

	scanIndexOD_t scanIndexOD;

   104

	storeODSubIndex_t storeODSubIndex; 

   105

   106

	/* DCF concise */

   107

    const indextable* dcf_odentry;

   108

	UNS8* dcf_cursor;

   109

	UNS32 dcf_entries_count;

   113

   114

	/* EMCY */

   115

	e_errorState error_state;

   116

	UNS8 error_history_size;

   117

	UNS8* error_number;

   118

	UNS32* error_first_element;

   119

	UNS8* error_register;

   120

    UNS32* error_cobid;

   121

	s_errors error_data[EMCY_MAX_ERRORS];

   122

	post_emcy_t post_emcy;

   123

   124

#ifdef CO_ENABLE_LSS

   125

	/* LSS */

   126

	lss_transfer_t lss_transfer;

   127

	lss_StoreConfiguration_t lss_StoreConfiguration;

   128

#endif	

   129

};

   130

   131

#define NMTable_Initializer Unknown_state,

   132

   133

#ifdef SDO_DYNAMIC_BUFFER_ALLOCATION

   134

#define s_transfer_Initializer {\

   135

		0,          /* CliServNbr */\

   136

		0,          /* wohami */\

   137

		SDO_RESET,  /* state */\

   138

		0,          /* toggle */\

   139

		0,          /* abortCode */\

   140

		0,          /* index */\

   141

		0,          /* subIndex */\

   142

		0,          /* count */\

   143

		0,          /* offset */\

   144

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

   145

    NULL,       /* dynamicData */ \

   146

    0,          /* dynamicDataSize */ \

   147

		0,          /* peerCRCsupport */\

   148

		0,          /* blksize */\

   149

		0,          /* ackseq */\

   150

		0,          /* objsize */\

   151

		0,          /* lastblockoffset */\

   152

		0,          /* seqno */\

   153

		0,          /* endfield */\

   154

		RXSTEP_INIT,/* rxstep */\

   155

		{0},        /* tmpData */\

   156

		0,          /* dataType */\

   157

		-1,         /* timer */\

   158

		NULL        /* Callback */\

   159

	  },

   160

#else

   161

#define s_transfer_Initializer {\

   162

		0,          /* nodeId */\

   163

		0,          /* wohami */\

   164

		SDO_RESET,  /* state */\

   165

		0,          /* toggle */\

   166

		0,          /* abortCode */\

   167

		0,          /* index */\

   168

		0,          /* subIndex */\

   169

		0,          /* count */\

   170

		0,          /* offset */\

   171

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

   172

		0,          /* peerCRCsupport */\

   173

		0,          /* blksize */\

   174

		0,          /* ackseq */\

   175

		0,          /* objsize */\

   176

		0,          /* lastblockoffset */\

   177

		0,          /* seqno */\

   178

		0,          /* endfield */\

   179

		RXSTEP_INIT,/* rxstep */\

   180

		{0},        /* tmpData */\

   181

		0,          /*  */\

   182

		-1,         /*  */\

   183

		NULL        /*  */\

   184

	  },

   185

#endif //SDO_DYNAMIC_BUFFER_ALLOCATION

   186

   187

#define ERROR_DATA_INITIALIZER \

   188

	{\

   189

	0, /* errCode */\

   190

	0, /* errRegMask */\

   191

	0 /* active */\

   192

	},

   193

   194

#ifdef CO_ENABLE_LSS

   195

   196

#ifdef CO_ENABLE_LSS_FS	

   197

#define lss_fs_Initializer \

   198

		,0,						/* IDNumber */\

   199

  		128, 					/* BitChecked */\

   200

  		0,						/* LSSSub */\

   201

  		0, 						/* LSSNext */\

   202

  		0, 						/* LSSPos */\

   203

  		LSS_FS_RESET,			/* FastScan_SM */\

   204

  		-1,						/* timerFS */\

   205

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

   206

#else

   207

#define lss_fs_Initializer

   208

#endif		

   209

   210

#define lss_Initializer {\

   211

		LSS_RESET,  			/* state */\

   212

		0,						/* command */\

   213

		LSS_WAITING_MODE, 		/* mode */\

   214

		0,						/* dat1 */\

   215

		0,						/* dat2 */\

   216

		0,          			/* NodeID */\

   217

		0,          			/* addr_sel_match */\

   218

		0,          			/* addr_ident_match */\

   219

		"none",         		/* BaudRate */\

   220

		0,          			/* SwitchDelay */\

   221

		SDELAY_OFF,   			/* SwitchDelayState */\

   222

		NULL,					/* canHandle_t */\

   223

		-1,						/* TimerMSG */\

   224

		-1,          			/* TimerSDELAY */\

   225

		NULL,        			/* Callback */\

   226

		0						/* LSSanswer */\

   227

		lss_fs_Initializer		/*FastScan service initialization */\

   228

	  },\

   229

	  NULL 	/* _lss_StoreConfiguration*/

   230

#else

   231

#define lss_Initializer

   232

#endif

   233

   234

   235

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

   236

/* CO_Data structure */

   237

#define CANOPEN_NODE_DATA_INITIALIZER(NODE_PREFIX) {\

   238

	/* Object dictionary*/\

   239

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

   240

	NODE_PREFIX ## _objdict,             /* objdict  */\

   241

	NODE_PREFIX ## _PDO_status,          /* PDO_status */\

   242

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

   243

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

   244

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

   245

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

   246

	NODE_PREFIX ## _valueRangeTest,      /* valueRangeTest */\

   247

	\

   248

	/* SDO, structure s_transfer */\

   249

	{\

   250

          REPEAT_SDO_MAX_SIMULTANEOUS_TRANSFERTS_TIMES(s_transfer_Initializer)\

   251

	},\

   252

	\

   253

	/* State machine*/\

   254

	Unknown_state,      /* nodeState */\

   255

	/* structure s_state_communication */\

   256

	{\

   257

		0,          /* csBoot_Up */\

   258

		0,          /* csSDO */\

   259

		0,          /* csEmergency */\

   260

		0,          /* csSYNC */\

   261

		0,          /* csHeartbeat */\

   262

		0,           /* csPDO */\

   263

		0           /* csLSS */\

   264

	},\

   265

	_initialisation,     /* initialisation */\

   266

	_preOperational,     /* preOperational */\

   267

	_operational,        /* operational */\

   268

	_stopped,            /* stopped */\

   269

	NULL,                /* NMT node reset callback */\

   270

	NULL,                /* NMT communications reset callback */\

   271

	\

   272

	/* NMT-heartbeat */\

   273

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

   274

	NODE_PREFIX ## _obj1016,                   /* ConsumerHeartbeatEntries */\

   275

	NODE_PREFIX ## _heartBeatTimers,           /* ConsumerHeartBeatTimers  */\

   276

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

   277

	TIMER_NONE,                                /* ProducerHeartBeatTimer */\

   278

	_heartbeatError,           /* heartbeatError */\

   279

	\

   280

	{REPEAT_NMT_MAX_NODE_ID_TIMES(NMTable_Initializer)},\

   281

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

   282

	\

   283

	/* SYNC */\

   284

	TIMER_NONE,                                /* syncTimer */\

   285

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

   286

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

   287

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

   288

	_post_sync,                 /* post_sync */\

   289

	_post_TPDO,                 /* post_TPDO */\

   290

	_post_SlaveBootup,			/* post_SlaveBootup */\

   291

  _post_SlaveStateChange,			/* post_SlaveStateChange */\

   292

	\

   293

	/* General */\

   294

	0,                                         /* toggle */\

   295

	NULL,                   /* canSend */\

   296

	NODE_PREFIX ## _scanIndexOD,                /* scanIndexOD */\

   297

	_storeODSubIndex,                /* storeODSubIndex */\

   298

    /* DCF concise */\

   299

    NULL,       /*dcf_odentry*/\

   300

	NULL,		/*dcf_cursor*/\

   301

	1,		/*dcf_entries_count*/\

   305

	\

   306

	/* EMCY */\

   307

	Error_free,                      /* error_state */\

   308

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

   309

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

   310

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

   311

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

   312

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

   313

	/* error_data: structure s_errors */\

   314

	{\

   315

	REPEAT_EMCY_MAX_ERRORS_TIMES(ERROR_DATA_INITIALIZER)\

   316

	},\

   317

	_post_emcy,              /* post_emcy */\

   318

	/* LSS */\

   319

	lss_Initializer\

   320

}

   321

   322

#ifdef __cplusplus

   323

};

   324

#endif

   325

   326

#endif /* __data_h__ */

   327

   328