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

** @file   states.c

    24

** @author Edouard TISSERANT and Francis DUPIN

    25

** @date   Tue Jun  5 09:32:32 2007

    26

**

    27

** @brief

    28

**

    29

**

    30

*/

    31

    32

#include "data.h"

    33

#include "sysdep.h"

    34

    35

/** Prototypes for internals functions */

    36

/*!                                                                                                

    37

**                                                                                                 

    38

**                                                                                                 

    39

** @param d                                                                                        

    40

** @param newCommunicationState                                                                    

    41

**/     

    42

void switchCommunicationState(CO_Data* d, 

    43

	s_state_communication *newCommunicationState);

    44

    45

/*!                                                                                                

    46

**                                                                                                 

    47

**                                                                                                 

    48

** @param d                                                                                        

    49

**                                                                                                 

    50

** @return                                                                                         

    51

**/    

    52

e_nodeState getState(CO_Data* d)

    53

{

    54

  return d->nodeState;

    55

}

    56

    57

/*!                                                                                                

    58

**                                                                                                 

    59

**                                                                                                 

    60

** @param d                                                                                        

    61

** @param m                                                                                        

    62

**/  

    63

void canDispatch(CO_Data* d, Message *m)

    64

{

    65

	UNS16 cob_id = UNS16_LE(m->cob_id);

    66

	 switch(cob_id >> 7)

    67

	{

    68

		case SYNC:		/* can be a SYNC or a EMCY message */

    69

			if(cob_id == 0x080)	/* SYNC */

    70

			{

    71

				if(d->CurrentCommunicationState.csSYNC)

    72

					proceedSYNC(d);

    73

			} else 		/* EMCY */

    74

				if(d->CurrentCommunicationState.csEmergency)

    75

					proceedEMCY(d,m);

    76

			break;

    77

		/* case TIME_STAMP: */

    78

		case PDO1tx:

    79

		case PDO1rx:

    80

		case PDO2tx:

    81

		case PDO2rx:

    82

		case PDO3tx:

    83

		case PDO3rx:

    84

		case PDO4tx:

    85

		case PDO4rx:

    86

			if (d->CurrentCommunicationState.csPDO)

    87

				proceedPDO(d,m);

    88

			break;

    89

		case SDOtx:

    90

		case SDOrx:

    91

			if (d->CurrentCommunicationState.csSDO)

    92

				proceedSDO(d,m);

    93

			break;

    94

		case NODE_GUARD:

    95

			if (d->CurrentCommunicationState.csHeartbeat)

    96

				proceedNODE_GUARD(d,m);

    97

			break;

    98

		case NMT:

    99

			if (*(d->iam_a_slave))

   100

			{

   101

				proceedNMTstateChange(d,m);

   102

			}

   103

            break;

   104

#ifdef CO_ENABLE_LSS

   105

		case LSS:

   106

			if (!d->CurrentCommunicationState.csLSS)break;

   107

			if ((*(d->iam_a_slave)) && cob_id==MLSS_ADRESS)

   108

			{

   109

				proceedLSS_Slave(d,m);

   110

			}

   111

			else if(!(*(d->iam_a_slave)) && cob_id==SLSS_ADRESS)

   112

			{

   113

				proceedLSS_Master(d,m);

   114

			}

   115

			break;

   116

#endif

   117

	}

   118

}

   119

   120

#define StartOrStop(CommType, FuncStart, FuncStop) \

   121

	if(newCommunicationState->CommType && d->CurrentCommunicationState.CommType == 0){\

   122

		MSG_WAR(0x9999,#FuncStart, 9999);\

   123

		d->CurrentCommunicationState.CommType = 1;\

   124

		FuncStart;\

   125

	}else if(!newCommunicationState->CommType && d->CurrentCommunicationState.CommType == 1){\

   126

		MSG_WAR(0x9999,#FuncStop, 9999);\

   127

		d->CurrentCommunicationState.CommType = 0;\

   128

		FuncStop;\

   129

	}

   130

#define None

   131

   132

/*!                                                                                                

   133

**                                                                                                 

   134

**                                                                                                 

   135

** @param d                                                                                        

   136

** @param newCommunicationState                                                                    

   137

**/  	

   138

void switchCommunicationState(CO_Data* d, s_state_communication *newCommunicationState)

   139

{

   140

#ifdef CO_ENABLE_LSS

   141

	StartOrStop(csLSS,	startLSS(d),	stopLSS(d))

   142

#endif

   143

	StartOrStop(csSDO,	None,		resetSDO(d))

   144

	StartOrStop(csSYNC,	startSYNC(d),		stopSYNC(d))

   145

	StartOrStop(csHeartbeat,	heartbeatInit(d),	heartbeatStop(d))

   146

	StartOrStop(csEmergency,	emergencyInit(d),	emergencyStop(d)) 

   147

	StartOrStop(csPDO,	PDOInit(d),	PDOStop(d))

   148

	StartOrStop(csBoot_Up,	None,	slaveSendBootUp(d))

   149

}

   150

   151

/*!                                                                                                

   152

**                                                                                                 

   153

**                                                                                                 

   154

** @param d                                                                                        

   155

** @param newState                                                                                 

   156

**                                                                                                 

   157

** @return                                                                                         

   158

**/  

   159

UNS8 setState(CO_Data* d, e_nodeState newState)

   160

{

   161

	if(newState != d->nodeState){

   162

		switch( newState ){

   163

			case Initialisation:

   164

			{

   165

				s_state_communication newCommunicationState = {1, 0, 0, 0, 0, 0, 0};

   166

				d->nodeState = Initialisation;

   167

				switchCommunicationState(d, &newCommunicationState);

   168

				/* call user app init callback now. */

   169

				/* d->initialisation MUST NOT CALL SetState */

   170

				(*d->initialisation)(d);				

   171

			}

   172

   173

			/* Automatic transition - No break statement ! */

   174

			/* Transition from Initialisation to Pre_operational */

   175

			/* is automatic as defined in DS301. */

   176

			/* App don't have to call SetState(d, Pre_operational) */

   177

   178

			case Pre_operational:

   179

			{

   180

   181

				s_state_communication newCommunicationState = {0, 1, 1, 1, 1, 0, 1};

   182

				d->nodeState = Pre_operational;

   183

				switchCommunicationState(d, &newCommunicationState);

   184

				if (!(*(d->iam_a_slave)))

   185

				{

   186

					masterSendNMTstateChange (d, 0, NMT_Reset_Node);

   187

				}

   188

                (*d->preOperational)(d);

   189

			}

   190

			break;

   191

   192

			case Operational:

   193

			if(d->nodeState == Initialisation) return 0xFF;

   194

			{

   195

				s_state_communication newCommunicationState = {0, 1, 1, 1, 1, 1, 0};

   196

				d->nodeState = Operational;

   197

				newState = Operational;

   198

				switchCommunicationState(d, &newCommunicationState);

   199

				(*d->operational)(d);

   200

			}

   201

			break;

   202

   203

			case Stopped:

   204

			if(d->nodeState == Initialisation) return 0xFF;

   205

			{

   206

				s_state_communication newCommunicationState = {0, 0, 0, 0, 1, 0, 1};

   207

				d->nodeState = Stopped;

   208

				newState = Stopped;

   209

				switchCommunicationState(d, &newCommunicationState);

   210

				(*d->stopped)(d);

   211

			}

   212

			break;

   213

			default:

   214

				return 0xFF;

   215

   216

		}/* end switch case */

   217

   218

	}

   219

	/* d->nodeState contains the final state */

   220

	/* may not be the requested state */

   221

    return d->nodeState;  

   222

}

   223

   224

/*!                                                                                                

   225

**                                                                                                 

   226

**                                                                                                 

   227

** @param d                                                                                        

   228

**                                                                                                 

   229

** @return                                                                                         

   230

**/ 

   231

UNS8 getNodeId(CO_Data* d)

   232

{

   233

  return *d->bDeviceNodeId;

   234

}

   235

   236

/*!                                                                                                

   237

**                                                                                                 

   238

**                                                                                                 

   239

** @param d                                                                                        

   240

** @param nodeId                                                                                   

   241

**/   

   242

void setNodeId(CO_Data* d, UNS8 nodeId)

   243

{

   244

  UNS16 offset = d->firstIndex->SDO_SVR;

   245

   246

#ifdef CO_ENABLE_LSS

   247

  d->lss_transfer.nodeID=nodeId;

   248

  if(nodeId==0xFF){

   249

  	*d->bDeviceNodeId = nodeId;

   250

  	return;

   251

  }

   252

  else

   253

#endif

   254

  if(!(nodeId>0 && nodeId<=127)){

   255

	  MSG_WAR(0x2D01, "Invalid NodeID",nodeId);

   256

	  return;

   257

  }

   258

   259

  if(offset){

   260

    /* Adjust COB-ID Client->Server (rx) only id already set to default value or id not valid (id==0xFF)*/

   261

    if((*(UNS32*)d->objdict[offset].pSubindex[1].pObject == 0x600 + *d->bDeviceNodeId)||(*d->bDeviceNodeId==0xFF)){

   262

      /* cob_id_client = 0x600 + nodeId; */

   263

      *(UNS32*)d->objdict[offset].pSubindex[1].pObject = 0x600 + nodeId;

   264

    }

   265

    /* Adjust COB-ID Server -> Client (tx) only id already set to default value or id not valid (id==0xFF)*/

   266

    if((*(UNS32*)d->objdict[offset].pSubindex[2].pObject == 0x580 + *d->bDeviceNodeId)||(*d->bDeviceNodeId==0xFF)){

   267

      /* cob_id_server = 0x580 + nodeId; */

   268

      *(UNS32*)d->objdict[offset].pSubindex[2].pObject = 0x580 + nodeId;

   269

    }

   270

  }

   271

   272

  /* 

   273

   	Initialize the server(s) SDO parameters

   274

  	Remember that only one SDO server is allowed, defined at index 0x1200	

   275

   276

  	Initialize the client(s) SDO parameters 	

   277

  	Nothing to initialize (no default values required by the DS 401)	

   278

  	Initialize the receive PDO communication parameters. Only for 0x1400 to 0x1403 

   279

  */

   280

  {

   281

    UNS8 i = 0;

   282

    UNS16 offset = d->firstIndex->PDO_RCV;

   283

    UNS16 lastIndex = d->lastIndex->PDO_RCV;

   284

    UNS32 cobID[] = {0x200, 0x300, 0x400, 0x500};

   285

    if( offset ) while( (offset <= lastIndex) && (i < 4)) {

   286

      if((*(UNS32*)d->objdict[offset].pSubindex[1].pObject == cobID[i] + *d->bDeviceNodeId)||(*d->bDeviceNodeId==0xFF))

   287

	      *(UNS32*)d->objdict[offset].pSubindex[1].pObject = cobID[i] + nodeId;

   288

      i ++;

   289

      offset ++;

   290

    }

   291

  }

   292

  /* ** Initialize the transmit PDO communication parameters. Only for 0x1800 to 0x1803 */

   293

  {

   294

    UNS8 i = 0;

   295

    UNS16 offset = d->firstIndex->PDO_TRS;

   296

    UNS16 lastIndex = d->lastIndex->PDO_TRS;

   297

    UNS32 cobID[] = {0x180, 0x280, 0x380, 0x480};

   298

    i = 0;

   299

    if( offset ) while ((offset <= lastIndex) && (i < 4)) {

   300

      if((*(UNS32*)d->objdict[offset].pSubindex[1].pObject == cobID[i] + *d->bDeviceNodeId)||(*d->bDeviceNodeId==0xFF))

   301

	      *(UNS32*)d->objdict[offset].pSubindex[1].pObject = cobID[i] + nodeId;

   302

      i ++;

   303

      offset ++;

   304

    }

   305

  }

   306

   307

  /* Update EMCY COB-ID if already set to default*/

   308

  if((*d->error_cobid == *d->bDeviceNodeId + 0x80)||(*d->bDeviceNodeId==0xFF))

   309

    *d->error_cobid = nodeId + 0x80;

   310

   311

  /* bDeviceNodeId is defined in the object dictionary. */

   312

  *d->bDeviceNodeId = nodeId;

   313

}

   314

   315

void _initialisation(CO_Data* d){}

   316

void _preOperational(CO_Data* d){}

   317

void _operational(CO_Data* d){}

   318

void _stopped(CO_Data* d){}