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

	TIMER_HANDLE *RxPDO_EventTimers;

    62

	void (*RxPDO_EventTimers_Handler)(CO_Data*, UNS32);

    63

	const quick_index *firstIndex;

    64

	const quick_index *lastIndex;

    65

	const UNS16 *ObjdictSize;

    66

	const UNS8 *iam_a_slave;

    67

	valueRangeTest_t valueRangeTest;

    68

    69

	/* SDO */

    70

	s_transfer transfers[SDO_MAX_SIMULTANEOUS_TRANSFERS];

    71

	/* s_sdo_parameter *sdo_parameters; */

    72

    73

	/* State machine */

    74

	e_nodeState nodeState;

    75

	s_state_communication CurrentCommunicationState;

    76

	initialisation_t initialisation;

    77

	preOperational_t preOperational;

    78

	operational_t operational;

    79

	stopped_t stopped;

    80

     void (*NMT_Slave_Node_Reset_Callback)(CO_Data*);

    81

     void (*NMT_Slave_Communications_Reset_Callback)(CO_Data*);

    82

    83

	/* NMT-heartbeat */

    84

	UNS8 *ConsumerHeartbeatCount;

    85

	UNS32 *ConsumerHeartbeatEntries;

    86

	TIMER_HANDLE *ConsumerHeartBeatTimers;

    87

	UNS16 *ProducerHeartBeatTime;

    88

	TIMER_HANDLE ProducerHeartBeatTimer;

    89

	heartbeatError_t heartbeatError;

    90

	e_nodeState NMTable[NMT_MAX_NODE_ID]; 

    91

    92

	/* SYNC */

    93

	TIMER_HANDLE syncTimer;

    94

	UNS32 *COB_ID_Sync;

    95

	UNS32 *Sync_Cycle_Period;

    96

	/*UNS32 *Sync_window_length;;*/

    97

	post_sync_t post_sync;

    98

	post_TPDO_t post_TPDO;

    99

	post_SlaveBootup_t post_SlaveBootup;

   100

    post_SlaveStateChange_t post_SlaveStateChange;

   101

   102

	/* General */

   103

	UNS8 toggle;

   104

	CAN_PORT canHandle;	

   105

	scanIndexOD_t scanIndexOD;

   106

	storeODSubIndex_t storeODSubIndex; 

   107

   108

	/* DCF concise */

   109

    const indextable* dcf_odentry;

   110

	UNS8* dcf_cursor;

   111

	UNS32 dcf_entries_count;

   112

	UNS8 dcf_status;

   113

    UNS32 dcf_size;

   114

    UNS8* dcf_data;

   115

   116

	/* EMCY */

   117

	e_errorState error_state;

   118

	UNS8 error_history_size;

   119

	UNS8* error_number;

   120

	UNS32* error_first_element;

   121

	UNS8* error_register;

   122

    UNS32* error_cobid;

   123

	s_errors error_data[EMCY_MAX_ERRORS];

   124

	post_emcy_t post_emcy;

   125

   126

#ifdef CO_ENABLE_LSS

   127

	/* LSS */

   128

	lss_transfer_t lss_transfer;

   129

	lss_StoreConfiguration_t lss_StoreConfiguration;

   130

#endif	

   131

};

   132

   133

#define NMTable_Initializer Unknown_state,

   134

   135

#ifdef SDO_DYNAMIC_BUFFER_ALLOCATION

   136

#define s_transfer_Initializer {\

   137

		0,          /* CliServNbr */\

   138

		0,          /* wohami */\

   139

		SDO_RESET,  /* state */\

   140

		0,          /* toggle */\

   141

		0,          /* abortCode */\

   142

		0,          /* index */\

   143

		0,          /* subIndex */\

   144

		0,          /* count */\

   145

		0,          /* offset */\

   146

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

   147

    NULL,       /* dynamicData */ \

   148

    0,          /* dynamicDataSize */ \

   149

		0,          /* peerCRCsupport */\

   150

		0,          /* blksize */\

   151

		0,          /* ackseq */\

   152

		0,          /* objsize */\

   153

		0,          /* lastblockoffset */\

   154

		0,          /* seqno */\

   155

		0,          /* endfield */\

   156

		RXSTEP_INIT,/* rxstep */\

   157

		{0},        /* tmpData */\

   158

		0,          /* dataType */\

   159

		-1,         /* timer */\

   160

		NULL        /* Callback */\

   161

	  },

   162

#else

   163

#define s_transfer_Initializer {\

   164

		0,          /* nodeId */\

   165

		0,          /* wohami */\

   166

		SDO_RESET,  /* state */\

   167

		0,          /* toggle */\

   168

		0,          /* abortCode */\

   169

		0,          /* index */\

   170

		0,          /* subIndex */\

   171

		0,          /* count */\

   172

		0,          /* offset */\

   173

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

   174

		0,          /* peerCRCsupport */\

   175

		0,          /* blksize */\

   176

		0,          /* ackseq */\

   177

		0,          /* objsize */\

   178

		0,          /* lastblockoffset */\

   179

		0,          /* seqno */\

   180

		0,          /* endfield */\

   181

		RXSTEP_INIT,/* rxstep */\

   182

		{0},        /* tmpData */\

   183

		0,          /*  */\

   184

		-1,         /*  */\

   185

		NULL        /*  */\

   186

	  },

   187

#endif //SDO_DYNAMIC_BUFFER_ALLOCATION

   188

   189

#define ERROR_DATA_INITIALIZER \

   190

	{\

   191

	0, /* errCode */\

   192

	0, /* errRegMask */\

   193

	0 /* active */\

   194

	},

   195

   196

#ifdef CO_ENABLE_LSS

   197

   198

#ifdef CO_ENABLE_LSS_FS	

   199

#define lss_fs_Initializer \

   200

		,0,						/* IDNumber */\

   201

  		128, 					/* BitChecked */\

   202

  		0,						/* LSSSub */\

   203

  		0, 						/* LSSNext */\

   204

  		0, 						/* LSSPos */\

   205

  		LSS_FS_RESET,			/* FastScan_SM */\

   206

  		-1,						/* timerFS */\

   207

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

   208

#else

   209

#define lss_fs_Initializer

   210

#endif		

   211

   212

#define lss_Initializer {\

   213

		LSS_RESET,  			/* state */\

   214

		0,						/* command */\

   215

		LSS_WAITING_MODE, 		/* mode */\

   216

		0,						/* dat1 */\

   217

		0,						/* dat2 */\

   218

		0,          			/* NodeID */\

   219

		0,          			/* addr_sel_match */\

   220

		0,          			/* addr_ident_match */\

   221

		"none",         		/* BaudRate */\

   222

		0,          			/* SwitchDelay */\

   223

		SDELAY_OFF,   			/* SwitchDelayState */\

   224

		NULL,					/* canHandle_t */\

   225

		-1,						/* TimerMSG */\

   226

		-1,          			/* TimerSDELAY */\

   227

		NULL,        			/* Callback */\

   228

		0						/* LSSanswer */\

   229

		lss_fs_Initializer		/*FastScan service initialization */\

   230

	  },\

   231

	  NULL 	/* _lss_StoreConfiguration*/

   232

#else

   233

#define lss_Initializer

   234

#endif

   235

   236

   237

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

   238

/* CO_Data structure */

   239

#define CANOPEN_NODE_DATA_INITIALIZER(NODE_PREFIX) {\

   240

	/* Object dictionary*/\

   241

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

   242

	NODE_PREFIX ## _objdict,             /* objdict  */\

   243

	NODE_PREFIX ## _PDO_status,          /* PDO_status */\

   244

	NULL,                                /* RxPDO_EventTimers */\

   245

	_RxPDO_EventTimers_Handler,          /* RxPDO_EventTimers_Handler */\

   246

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

   247

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

   248

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

   249

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

   250

	NODE_PREFIX ## _valueRangeTest,      /* valueRangeTest */\

   251

	\

   252

	/* SDO, structure s_transfer */\

   253

	{\

   254

          REPEAT_SDO_MAX_SIMULTANEOUS_TRANSFERS_TIMES(s_transfer_Initializer)\

   255

	},\

   256

	\

   257

	/* State machine*/\

   258

	Unknown_state,      /* nodeState */\

   259

	/* structure s_state_communication */\

   260

	{\

   261

		0,          /* csBoot_Up */\

   262

		0,          /* csSDO */\

   263

		0,          /* csEmergency */\

   264

		0,          /* csSYNC */\

   265

		0,          /* csHeartbeat */\

   266

		0,           /* csPDO */\

   267

		0           /* csLSS */\

   268

	},\

   269

	_initialisation,     /* initialisation */\

   270

	_preOperational,     /* preOperational */\

   271

	_operational,        /* operational */\

   272

	_stopped,            /* stopped */\

   273

	NULL,                /* NMT node reset callback */\

   274

	NULL,                /* NMT communications reset callback */\

   275

	\

   276

	/* NMT-heartbeat */\

   277

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

   278

	NODE_PREFIX ## _obj1016,                   /* ConsumerHeartbeatEntries */\

   279

	NODE_PREFIX ## _heartBeatTimers,           /* ConsumerHeartBeatTimers  */\

   280

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

   281

	TIMER_NONE,                                /* ProducerHeartBeatTimer */\

   282

	_heartbeatError,           /* heartbeatError */\

   283

	\

   284

	{REPEAT_NMT_MAX_NODE_ID_TIMES(NMTable_Initializer)},\

   285

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

   286

	\

   287

	/* SYNC */\

   288

	TIMER_NONE,                                /* syncTimer */\

   289

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

   290

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

   291

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

   292

	_post_sync,                 /* post_sync */\

   293

	_post_TPDO,                 /* post_TPDO */\

   294

	_post_SlaveBootup,			/* post_SlaveBootup */\

   295

  _post_SlaveStateChange,			/* post_SlaveStateChange */\

   296

	\

   297

	/* General */\

   298

	0,                                         /* toggle */\

   299

	NULL,                   /* canSend */\

   300

	NODE_PREFIX ## _scanIndexOD,                /* scanIndexOD */\

   301

	_storeODSubIndex,                /* storeODSubIndex */\

   302

    /* DCF concise */\

   303

    NULL,       /*dcf_odentry*/\

   304

	NULL,		/*dcf_cursor*/\

   305

	1,		/*dcf_entries_count*/\

   306

	0,		/* dcf_status*/\

   307

    0,      /* dcf_size */\

   308

    NULL,   /* dcf_data */\

   309

	\

   310

	/* EMCY */\

   311

	Error_free,                      /* error_state */\

   312

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

   313

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

   314

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

   315

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

   316

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

   317

	/* error_data: structure s_errors */\

   318

	{\

   319

	REPEAT_EMCY_MAX_ERRORS_TIMES(ERROR_DATA_INITIALIZER)\

   320

	},\

   321

	_post_emcy,              /* post_emcy */\

   322

	/* LSS */\

   323

	lss_Initializer\

   324

}

   325

   326

#ifdef __cplusplus

   327

};

   328

#endif

   329

   330

#endif /* __data_h__ */

   331

   332