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

/** @defgroup comobj Communication Objects

    24

 *  @ingroup userapi

    25

 */

    26

    27

/** @defgroup sdo Service Data Object (SDO)

    28

 *  SDOs provide the access to entries in the CANopen Object Dictionary.

    29

 * 	An SDO is made up of at least two CAN messages with different identifiers.

    30

 * 	SDO s are always confirmed point-to-point communications services. 

    31

 *  @ingroup comobj

    32

 */

    33

    34

#ifndef __sdo_h__

    35

#define __sdo_h__

    36

    37

struct struct_s_transfer;

    38

    39

#include "timer.h"

    40

    41

typedef void (*SDOCallback_t)(CO_Data* d, UNS8 nodeId);

    42

    43

/* The Transfer structure

    44

Used to store the different segments of

    45

 - a SDO received before writing in the dictionary

    46

 - the reading of the dictionary to put on a SDO to transmit

    47

*/

    48

    49

struct struct_s_transfer {

    50

  UNS8           nodeId;     /**<own ID if server, or node ID of the server if client */

    51

    52

  UNS8           whoami;     /**< Takes the values SDO_CLIENT or SDO_SERVER */

    53

  UNS8           state;      /**< state of the transmission : Takes the values SDO_... */

    54

  UNS8           toggle;	

    55

  UNS32          abortCode;  /**< Sent or received */

    56

  /**< index and subindex of the dictionary where to store */

    57

  /**< (for a received SDO) or to read (for a transmit SDO) */

    58

  UNS16          index;

    59

  UNS8           subIndex;

    60

  UNS32          count;      /**< Number of data received or to be sent. */

    61

  UNS32          offset;     /**< stack pointer of data[]

    62

                              * Used only to tranfer part of a line to or from a SDO.

    63

                              * offset is always pointing on the next free cell of data[].

    64

                              * WARNING s_transfer.data is subject to ENDIANISATION

    65

                              * (with respect to CANOPEN_BIG_ENDIAN)

    66

                              */

    67

  UNS8           data [SDO_MAX_LENGTH_TRANSFERT];

    68

#ifdef SDO_DYNAMIC_BUFFER_ALLOCATION

    69

  UNS8           *dynamicData;

    70

  UNS32          dynamicDataSize;

    71

#endif //SDO_DYNAMIC_BUFFER_ALLOCATION

    72

  UNS8           dataType;   /**< Defined in objdictdef.h Value is visible_string

    73

                              * if it is a string, any other value if it is not a string,

    74

                              * like 0. In fact, it is used only if client.

    75

                              */

    76

  TIMER_HANDLE   timer;      /**< Time counter to implement a timeout in milliseconds.

    77

                              * It is automatically incremented whenever

    78

                              * the line state is in SDO_DOWNLOAD_IN_PROGRESS or

    79

                              * SDO_UPLOAD_IN_PROGRESS, and reseted to 0

    80

                              * when the response SDO have been received.

    81

                              */

    82

  SDOCallback_t Callback;   /**< The user callback func to be called at SDO transaction end */

    83

};

    84

typedef struct struct_s_transfer s_transfer;

    85

    86

    87

#include "data.h"

    88

    89

    90

struct BODY{

    91

    UNS8 data[8]; /**< The 8 bytes data of the SDO */

    92

};

    93

    94

/* The SDO structure ...*/

    95

struct struct_s_SDO {

    96

  UNS8 nodeId;		/**< In any case, Node ID of the server (case sender or receiver).*/

    97

  struct BODY body;

    98

};

    99

   100

   101

typedef struct struct_s_SDO s_SDO;

   102

   103

/** 

   104

 * @brief Reset of a SDO exchange on timeout.

   105

 * Send a SDO abort.

   106

 * @param *d Pointer on a CAN object data structure

   107

 * @param id

   108

 */

   109

void SDOTimeoutAlarm(CO_Data* d, UNS32 id);

   110

   111

/** 

   112

 * @brief Reset all SDO buffers.

   113

 * @param *d Pointer on a CAN object data structure

   114

 */

   115

void resetSDO (CO_Data* d);

   116

   117

   118

/** 

   119

 * @brief Copy the data received from the SDO line transfert to the object dictionary.

   120

 * @param *d Pointer on a CAN object data structure

   121

 * @param line SDO line

   122

 * @return SDO error code if error. Else, returns 0.

   123

 */

   124

UNS32 SDOlineToObjdict (CO_Data* d, UNS8 line);

   125

   126

/** 

   127

 * @brief Copy the data from the object dictionary to the SDO line for a network transfert.

   128

 * @param *d Pointer on a CAN object data structure

   129

 * @param line SDO line

   130

 * @return SDO error code if error. Else, returns 0.

   131

 */

   132

UNS32 objdictToSDOline (CO_Data* d, UNS8 line);

   133

   134

/** 

   135

 * @brief Copy data from an existant line in the argument "* data"

   136

 * @param d Pointer on a CAN object data structure

   137

 * @param line SDO line

   138

 * @param nbBytes

   139

 * @param *data Pointer on the data

   140

 * @return 0xFF if error. Else, returns 0.

   141

 */

   142

UNS8 lineToSDO (CO_Data* d, UNS8 line, UNS32 nbBytes, UNS8 * data);

   143

   144

/** 

   145

 * @brief Add data to an existant line

   146

 * @param d Pointer on a CAN object data structure

   147

 * @param line SDO line

   148

 * @param nbBytes

   149

 * @param *data Pointer on the data

   150

 * @return 0xFF if error. Else, returns 0.

   151

 */

   152

UNS8 SDOtoLine (CO_Data* d, UNS8 line, UNS32 nbBytes, UNS8 * data);

   153

   154

/** 

   155

 * @brief Called when an internal SDO abort occurs.

   156

 * Release the line * Only if server *

   157

 * If client, the line must be released manually in the core application.

   158

 * The reason of that is to permit the program to read the transfers structure before its reset,

   159

 * because many informations are stored on it : index, subindex, data received or trasmited, ...

   160

 * In all cases, sends a SDO abort.

   161

 * @param *d Pointer on a CAN object data structure

   162

 * @param nodeId

   163

 * @param whoami

   164

 * @param index

   165

 * @param subIndex

   166

 * @param abortCode

   167

 * @return 0

   168

 */

   169

UNS8 failedSDO (CO_Data* d, UNS8 nodeId, UNS8 whoami, UNS16 index, UNS8 subIndex, UNS32 abortCode);

   170

   171

/** 

   172

 * @brief Reset an unused line.

   173

 * @param *d Pointer on a CAN object data structure

   174

 * @param line SDO line

   175

 */

   176

void resetSDOline (CO_Data* d, UNS8 line);

   177

   178

/** 

   179

 * @brief Initialize some fields of the structure.

   180

 * @param *d Pointer on a CAN object data structure

   181

 * @param line

   182

 * @param nodeId

   183

 * @param index

   184

 * @param subIndex

   185

 * @param state

   186

 * @return 0

   187

 */

   188

UNS8 initSDOline (CO_Data* d, UNS8 line, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 state);

   189

   190

/** 

   191

 * @brief Search for an unused line in the transfers array

   192

 * to store a new SDO.

   193

 * ie a line which value of the field "state" is "SDO_RESET"

   194

 * An unused line have the field "state" at the value SDO_RESET

   195

 * @param *d Pointer on a CAN object data structure

   196

 * @param whoami Create the line for a SDO_SERVER or SDO_CLIENT.

   197

 * @param *line Pointer on a SDO line 

   198

 * @return 0xFF if all the lines are on use. Else, return 0.

   199

 */

   200

UNS8 getSDOfreeLine (CO_Data* d, UNS8 whoami, UNS8 *line);

   201

   202

/** 

   203

 * @brief Search for the line, in the transfers array, which contains the

   204

 * beginning of the reception of a fragmented SDO

   205

 * @param *d Pointer on a CAN object data structure

   206

 * @param nodeId correspond to the message node-id

   207

 * @param whoami takes 2 values : look for a line opened as SDO_CLIENT or SDO_SERVER

   208

 * @param *line Pointer on a SDO line 

   209

 * @return 0xFF if error.  Else, return 0

   210

 */

   211

UNS8 getSDOlineOnUse (CO_Data* d, UNS8 nodeId, UNS8 whoami, UNS8 *line);

   212

   213

/** 

   214

 * @brief Close a transmission.

   215

 * @param *d Pointer on a CAN object data structure

   216

 * @param nodeId Node id of the server if both server or client

   217

 * @param whoami Line opened as SDO_CLIENT or SDO_SERVER

   218

 */

   219

UNS8 closeSDOtransfer (CO_Data* d, UNS8 nodeId, UNS8 whoami);

   220

   221

/** 

   222

 * @brief Bytes in the line structure which must be transmited (or received)

   223

 * @param *d Pointer on a CAN object data structure

   224

 * @param line SDO line 

   225

 * @param *nbBytes Pointer on nbBytes

   226

 * @return 0.

   227

 */

   228

UNS8 getSDOlineRestBytes (CO_Data* d, UNS8 line, UNS32 * nbBytes);

   229

   230

/** 

   231

 * @brief Store in the line structure the nb of bytes which must be transmited (or received)

   232

 * @param *d Pointer on a CAN object data structure

   233

 * @param line SDO line 

   234

 * @param nbBytes

   235

 * @return 0 if success, 0xFF if error.

   236

 */

   237

UNS8 setSDOlineRestBytes (CO_Data* d, UNS8 line, UNS32 nbBytes);

   238

   239

/**

   240

 * @brief Transmit a SDO frame on the bus bus_id

   241

 * @param *d Pointer on a CAN object data structure

   242

 * @param whoami Takes 2 values : SDO_CLIENT or SDO_SERVER

   243

 * @param sdo SDO Structure which contains the sdo to transmit

   244

 * @return canSend(bus_id,&m) or 0xFF if error.

   245

 */

   246

UNS8 sendSDO (CO_Data* d, UNS8 whoami, s_SDO sdo);

   247

   248

/** 

   249

 * @brief Transmit a SDO error to the client. The reasons may be :

   250

 * Read/Write to a undefined object

   251

 * Read/Write to a undefined subindex

   252

 * Read/write a not valid length object

   253

 * Write a read only object

   254

 * @param *d Pointer on a CAN object data structure

   255

 * @param whoami takes 2 values : SDO_CLIENT or SDO_SERVER

   256

 * @param nodeId

   257

 * @param index

   258

 * @param subIndex

   259

 * @param abortCode

   260

 * @return 0

   261

 */

   262

UNS8 sendSDOabort (CO_Data* d, UNS8 whoami, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS32 abortCode);

   263

   264

/** 

   265

 * @brief Treat a SDO frame reception

   266

 * call the function sendSDO

   267

 * @param *d Pointer on a CAN object data structure

   268

 * @param *m Pointer on a CAN message structure 

   269

 * @return code : 

   270

 * 		   - 0xFF if error

   271

 *         - 0x80 if transfert aborted by the server

   272

 *         - 0x0  ok

   273

 */

   274

UNS8 proceedSDO (CO_Data* d, Message *m);

   275

   276

/** 

   277

 * @ingroup sdo

   278

 * @brief Used to send a SDO request frame to write the data at the index and subIndex indicated

   279

 * @param *d Pointer to a CAN object data structure

   280

 * @param nodeId Node Id of the slave

   281

 * @param index At index indicated

   282

 * @param subIndex At subIndex indicated

   283

 * @param count number of bytes to write in the dictionnary.

   284

 * @param dataType (defined in objdictdef.h) : put "visible_string" for strings, 0 for integers or reals or other value.

   285

 * @param *data Pointer to data

   286

 * @return 

   287

 * - 0 is returned upon success.

   288

 * - 0xFE is returned when no sdo client to communicate with node.

   289

 * - 0xFF is returned when error occurs.

   290

 */

   291

UNS8 writeNetworkDict (CO_Data* d, UNS8 nodeId, UNS16 index,

   292

		       UNS8 subIndex, UNS32 count, UNS8 dataType, void *data);

   293

   294

/** 

   295

 * @ingroup sdo

   296

 * @brief Used to send a SDO request frame to write in a distant node dictionnary.

   297

 * @details The function Callback which must be defined in the user code is called at the

   298

 * end of the exchange. (on succes or abort).

   299

 * @param *d Pointer to a CAN object data structure

   300

 * @param nodeId Node Id of the slave

   301

 * @param index At index indicated

   302

 * @param subIndex At subIndex indicated

   303

 * @param count number of bytes to write in the dictionnary.

   304

 * @param dataType (defined in objdictdef.h) : put "visible_string" for strings, 0 for integers or reals or other value.

   305

 * @param *data Pointer to data

   306

 * @param Callback Callback function

   307

 * @return 

   308

 * - 0 is returned upon success.

   309

 * - 0xFE is returned when no sdo client to communicate with node.

   310

 * - 0xFF is returned when error occurs.

   311

 */

   312

UNS8 writeNetworkDictCallBack (CO_Data* d, UNS8 nodeId, UNS16 index,

   313

		       UNS8 subIndex, UNS32 count, UNS8 dataType, void *data, SDOCallback_t Callback);

   314

   315

/**

   316

 * @ingroup sdo 

   317

 * @brief Used to send a SDO request frame to write in a distant node dictionnary.

   318

 * @details The function Callback which must be defined in the user code is called at the

   319

 * end of the exchange. (on succes or abort). First free SDO client parameter is

   320

 * automatically initialized for specific node if not already defined.

   321

 * @param *d Pointer to a CAN object data structure

   322

 * @param nodeId Node Id of the slave

   323

 * @param index At index indicated

   324

 * @param subIndex At subIndex indicated

   325

 * @param count number of bytes to write in the dictionnary.

   326

 * @param dataType (defined in objdictdef.h) : put "visible_string" for strings, 0 for integers or reals or other value.

   327

 * @param *data Pointer to data

   328

 * @param Callback Callback function

   329

 * @param endianize When not 0, data is endianized into network byte order

   330

 *                  when 0, data is not endianized and copied in machine native

   331

 *                  endianness

   332

 * @return 

   333

 * - 0 is returned upon success.

   334

 * - 0xFF is returned when error occurs.

   335

 */

   336

UNS8 writeNetworkDictCallBackAI (CO_Data* d, UNS8 nodeId, UNS16 index,

   337

		       UNS8 subIndex, UNS32 count, UNS8 dataType, void *data, SDOCallback_t Callback, UNS8 endianize);

   338

   339

/**

   340

 * @ingroup sdo 

   341

 * @brief Used to send a SDO request frame to read.

   342

 * @param *d Pointer to a CAN object data structure

   343

 * @param nodeId Node Id of the slave

   344

 * @param index At index indicated

   345

 * @param subIndex At subIndex indicated

   346

 * @param dataType (defined in objdictdef.h) : put "visible_string" for strings, 0 for integers or reals or other value.

   347

 * @return 

   348

 * - 0 is returned upon success.

   349

 * - 0xFE is returned when no sdo client to communicate with node.

   350

 * - 0xFF is returned when error occurs.

   351

 */

   352

UNS8 readNetworkDict (CO_Data* d, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 dataType);

   353

   354

/** 

   355

 * @ingroup sdo

   356

 * @brief Used to send a SDO request frame to read in a distant node dictionnary.

   357

 * @details The function Callback which must be defined in the user code is called at the

   358

 * end of the exchange. (on succes or abort).

   359

 * @param *d Pointer on a CAN object data structure

   360

 * @param nodeId Node Id of the slave

   361

 * @param index At index indicated

   362

 * @param subIndex At subIndex indicated

   363

 * @param dataType (defined in objdictdef.h) : put "visible_string" for strings, 0 for integers or reals or other value.

   364

 * @param Callback Callback function

   365

 * @return 

   366

 * - 0 is returned upon success.

   367

 * - 0xFE is returned when no sdo client to communicate with node.

   368

 * - 0xFF is returned when error occurs.

   369

 */

   370

UNS8 readNetworkDictCallback (CO_Data* d, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 dataType, SDOCallback_t Callback);

   371

   372

/** 

   373

 * @ingroup sdo

   374

 * @brief Used to send a SDO request frame to read in a distant node dictionnary.

   375

 * @details The function Callback which must be defined in the user code is called at the

   376

 * end of the exchange. (on succes or abort). First free SDO client parameter is

   377

 * automatically initialized for specific node if not already defined.

   378

 * @param *d Pointer on a CAN object data structure

   379

 * @param nodeId Node Id of the slave

   380

 * @param index At index indicated

   381

 * @param subIndex At subIndex indicated

   382

 * @param dataType (defined in objdictdef.h) : put "visible_string" for strings, 0 for integers or reals or other value.

   383

 * @param Callback Callback function

   384

 * @return 

   385

 * - 0 is returned upon success.

   386

 * - 0xFF is returned when error occurs.

   387

 */

   388

UNS8 readNetworkDictCallbackAI (CO_Data* d, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 dataType, SDOCallback_t Callback);

   389

   390

/** 

   391

 * @ingroup sdo

   392

 * @brief Use this function after calling readNetworkDict to get the result.

   393

 * 

   394

 * @param *d Pointer to a CAN object data structure

   395

 * @param nodeId Node Id of the slave

   396

 * @param *data Pointer to the datas

   397

 * @param *size Pointer to the size

   398

 * @param *abortCode Pointer to the abortcode. (0 = not available. Else : SDO abort code. (received if return SDO_ABORTED_RCV)

   399

 * 

   400

 * 

   401

 * @return

   402

 *           - SDO_FINISHED             // datas are available

   403

 *           - SDO_ABORTED_RCV          // Transfert failed (abort SDO received)

   404

 *           - SDO_ABORTED_INTERNAL     // Transfert failed (internal abort)

   405

 *           - SDO_UPLOAD_IN_PROGRESS   // Datas are not yet available

   406

 *           - SDO_DOWNLOAD_IN_PROGRESS // Download is in progress

   407

 * \n\n

   408

 * example :

   409

 * @code

   410

 * UNS32 data;

   411

 * UNS8 size;

   412

 * readNetworkDict(0, 0x05, 0x1016, 1, 0) // get the data index 1016 subindex 1 of node 5

   413

 * while (getReadResultNetworkDict (0, 0x05, &data, &size) == SDO_UPLOAD_IN_PROGRESS);

   414

 * @endcode

   415

*/

   416

UNS8 getReadResultNetworkDict (CO_Data* d, UNS8 nodeId, void* data, UNS32 *size, UNS32 * abortCode);

   417

   418

/**

   419

 * @ingroup sdo

   420

 * @brief Use this function after calling writeNetworkDict function to get the result of the write.

   421

 * @details It is mandatory to call this function because it is releasing the line used for the transfer.

   422

 * @param *d Pointer to a CAN object data structure

   423

 * @param nodeId Node Id of the slave

   424

 * @param *abortCode Pointer to the abortcode

   425

 * - 0 = not available. 

   426

 * - SDO abort code (received if return SDO_ABORTED_RCV)

   427

 * 

   428

 * @return : 

   429

 *           - SDO_FINISHED             // datas are available

   430

 *           - SDO_ABORTED_RCV          // Transfert failed (abort SDO received)

   431

 *           - SDO_ABORTED_INTERNAL     // Transfert failed (Internal abort)

   432

 *           - SDO_DOWNLOAD_IN_PROGRESS // Datas are not yet available

   433

 *           - SDO_UPLOAD_IN_PROGRESS   // Upload in progress

   434

 * \n\n

   435

 * example :

   436

 * @code

   437

 * UNS32 data = 0x50;

   438

 * UNS8 size;

   439

 * UNS32 abortCode;

   440

 * writeNetworkDict(0, 0x05, 0x1016, 1, size, &data) // write the data index 1016 subindex 1 of node 5

   441

 * while (getWriteResultNetworkDict (0, 0x05, &abortCode) == SDO_DOWNLOAD_IN_PROGRESS);

   442

 * @endcode

   443

*/

   444

UNS8 getWriteResultNetworkDict (CO_Data* d, UNS8 nodeId, UNS32 * abortCode);

   445

   446

#endif