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

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

    69

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

    70

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

    71

                              */

    72

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

    73

                              * It is automatically incremented whenever

    74

                              * the line state is in SDO_DOWNLOAD_IN_PROGRESS or

    75

                              * SDO_UPLOAD_IN_PROGRESS, and reseted to 0

    76

                              * when the response SDO have been received.

    77

                              */

    78

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

    79

};

    80

typedef struct struct_s_transfer s_transfer;

    81

    82

    83

#include "data.h"

    84

    85

    86

struct BODY{

    87

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

    88

};

    89

    90

/* The SDO structure ...*/

    91

struct struct_s_SDO {

    92

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

    93

  struct BODY body;

    94

};

    95

    96

    97

typedef struct struct_s_SDO s_SDO;

    98

    99

/** 

   100

 * @brief Reset of a SDO exchange on timeout.

   101

 * Send a SDO abort.

   102

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

   103

 * @param id

   104

 */

   105

void SDOTimeoutAlarm(CO_Data* d, UNS32 id);

   106

   107

/** 

   108

 * @brief Reset all SDO buffers.

   109

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

   110

 */

   111

void resetSDO (CO_Data* d);

   112

   113

   114

/** 

   115

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

   116

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

   117

 * @param line SDO line

   118

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

   119

 */

   120

UNS32 SDOlineToObjdict (CO_Data* d, UNS8 line);

   121

   122

/** 

   123

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

   124

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

   125

 * @param line SDO line

   126

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

   127

 */

   128

UNS32 objdictToSDOline (CO_Data* d, UNS8 line);

   129

   130

/** 

   131

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

   132

 * @param d Pointer on a CAN object data structure

   133

 * @param line SDO line

   134

 * @param nbBytes

   135

 * @param *data Pointer on the data

   136

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

   137

 */

   138

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

   139

   140

/** 

   141

 * @brief Add data to an existant line

   142

 * @param d Pointer on a CAN object data structure

   143

 * @param line SDO line

   144

 * @param nbBytes

   145

 * @param *data Pointer on the data

   146

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

   147

 */

   148

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

   149

   150

/** 

   151

 * @brief Called when an internal SDO abort occurs.

   152

 * Release the line * Only if server *

   153

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

   154

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

   155

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

   156

 * In all cases, sends a SDO abort.

   157

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

   158

 * @param nodeId

   159

 * @param whoami

   160

 * @param index

   161

 * @param subIndex

   162

 * @param abortCode

   163

 * @return 0

   164

 */

   165

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

   166

   167

/** 

   168

 * @brief Reset an unused line.

   169

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

   170

 * @param line SDO line

   171

 */

   172

void resetSDOline (CO_Data* d, UNS8 line);

   173

   174

/** 

   175

 * @brief Initialize some fields of the structure.

   176

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

   177

 * @param line

   178

 * @param nodeId

   179

 * @param index

   180

 * @param subIndex

   181

 * @param state

   182

 * @return 0

   183

 */

   184

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

   185

   186

/** 

   187

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

   188

 * to store a new SDO.

   189

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

   190

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

   191

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

   192

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

   193

 * @param *line Pointer on a SDO line 

   194

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

   195

 */

   196

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

   197

   198

/** 

   199

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

   200

 * beginning of the reception of a fragmented SDO

   201

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

   202

 * @param nodeId correspond to the message node-id

   203

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

   204

 * @param *line Pointer on a SDO line 

   205

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

   206

 */

   207

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

   208

   209

/** 

   210

 * @brief Close a transmission.

   211

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

   212

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

   213

 * @param whoami Line opened as SDO_CLIENT or SDO_SERVER

   214

 */

   215

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

   216

   217

/** 

   218

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

   219

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

   220

 * @param line SDO line 

   221

 * @param *nbBytes Pointer on nbBytes

   222

 * @return 0.

   223

 */

   224

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

   225

   226

/** 

   227

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

   228

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

   229

 * @param line SDO line 

   230

 * @param nbBytes

   231

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

   232

 */

   233

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

   234

   235

/**

   236

 * @brief Transmit a SDO frame on the bus bus_id

   237

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

   238

 * @param whoami Takes 2 values : SDO_CLIENT or SDO_SERVER

   239

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

   240

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

   241

 */

   242

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

   243

   244

/** 

   245

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

   246

 * Read/Write to a undefined object

   247

 * Read/Write to a undefined subindex

   248

 * Read/write a not valid length object

   249

 * Write a read only object

   250

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

   251

 * @param whoami takes 2 values : SDO_CLIENT or SDO_SERVER

   252

 * @param nodeId

   253

 * @param index

   254

 * @param subIndex

   255

 * @param abortCode

   256

 * @return 0

   257

 */

   258

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

   259

   260

/** 

   261

 * @brief Treat a SDO frame reception

   262

 * call the function sendSDO

   263

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

   264

 * @param *m Pointer on a CAN message structure 

   265

 * @return code : 

   266

 * 		   - 0xFF if error

   267

 *         - 0x80 if transfert aborted by the server

   268

 *         - 0x0  ok

   269

 */

   270

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

   271

   272

/** 

   273

 * @ingroup sdo

   274

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

   275

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

   276

 * @param nodeId Node Id of the slave

   277

 * @param index At index indicated

   278

 * @param subIndex At subIndex indicated

   279

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

   280

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

   281

 * @param *data Pointer to data

   282

 * @return 

   283

 * - 0 is returned upon success.

   284

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

   285

 * - 0xFF is returned when error occurs.

   286

 */

   287

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

   288

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

   289

   290

/** 

   291

 * @ingroup sdo

   292

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

   293

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

   294

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

   295

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

   296

 * @param nodeId Node Id of the slave

   297

 * @param index At index indicated

   298

 * @param subIndex At subIndex indicated

   299

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

   300

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

   301

 * @param *data Pointer to data

   302

 * @param Callback Callback function

   303

 * @return 

   304

 * - 0 is returned upon success.

   305

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

   306

 * - 0xFF is returned when error occurs.

   307

 */

   308

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

   309

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

   310

   311

/**

   312

 * @ingroup sdo 

   313

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

   314

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

   315

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

   316

 * automatically initialized for specific node if not already defined.

   317

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

   318

 * @param nodeId Node Id of the slave

   319

 * @param index At index indicated

   320

 * @param subIndex At subIndex indicated

   321

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

   322

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

   323

 * @param *data Pointer to data

   324

 * @param Callback Callback function

   325

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

   326

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

   327

 *                  endianness

   328

 * @return 

   329

 * - 0 is returned upon success.

   330

 * - 0xFF is returned when error occurs.

   331

 */

   332

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

   333

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

   334

   335

/**

   336

 * @ingroup sdo 

   337

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

   338

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

   339

 * @param nodeId Node Id of the slave

   340

 * @param index At index indicated

   341

 * @param subIndex At subIndex indicated

   342

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

   343

 * @return 

   344

 * - 0 is returned upon success.

   345

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

   346

 * - 0xFF is returned when error occurs.

   347

 */

   348

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

   349

   350

/** 

   351

 * @ingroup sdo

   352

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

   353

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

   354

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

   355

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

   356

 * @param nodeId Node Id of the slave

   357

 * @param index At index indicated

   358

 * @param subIndex At subIndex indicated

   359

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

   360

 * @param Callback Callback function

   361

 * @return 

   362

 * - 0 is returned upon success.

   363

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

   364

 * - 0xFF is returned when error occurs.

   365

 */

   366

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

   367

   368

/** 

   369

 * @ingroup sdo

   370

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

   371

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

   372

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

   373

 * automatically initialized for specific node if not already defined.

   374

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

   375

 * @param nodeId Node Id of the slave

   376

 * @param index At index indicated

   377

 * @param subIndex At subIndex indicated

   378

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

   379

 * @param Callback Callback function

   380

 * @return 

   381

 * - 0 is returned upon success.

   382

 * - 0xFF is returned when error occurs.

   383

 */

   384

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

   385

   386

/** 

   387

 * @ingroup sdo

   388

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

   389

 * 

   390

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

   391

 * @param nodeId Node Id of the slave

   392

 * @param *data Pointer to the datas

   393

 * @param *size Pointer to the size

   394

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

   395

 * 

   396

 * 

   397

 * @return

   398

 *           - SDO_FINISHED             // datas are available

   399

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

   400

 *           - SDO_ABORTED_INTERNAL     // Transfert failed (internal abort)

   401

 *           - SDO_UPLOAD_IN_PROGRESS   // Datas are not yet available

   402

 *           - SDO_DOWNLOAD_IN_PROGRESS // Download is in progress

   403

 * \n\n

   404

 * example :

   405

 * @code

   406

 * UNS32 data;

   407

 * UNS8 size;

   408

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

   409

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

   410

 * @endcode

   411

*/

   412

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

   413

   414

/**

   415

 * @ingroup sdo

   416

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

   417

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

   418

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

   419

 * @param nodeId Node Id of the slave

   420

 * @param *abortCode Pointer to the abortcode

   421

 * - 0 = not available. 

   422

 * - SDO abort code (received if return SDO_ABORTED_RCV)

   423

 * 

   424

 * @return : 

   425

 *           - SDO_FINISHED             // datas are available

   426

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

   427

 *           - SDO_ABORTED_INTERNAL     // Transfert failed (Internal abort)

   428

 *           - SDO_DOWNLOAD_IN_PROGRESS // Datas are not yet available

   429

 *           - SDO_UPLOAD_IN_PROGRESS   // Upload in progress

   430

 * \n\n

   431

 * example :

   432

 * @code

   433

 * UNS32 data = 0x50;

   434

 * UNS8 size;

   435

 * UNS32 abortCode;

   436

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

   437

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

   438

 * @endcode

   439

*/

   440

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

   441

   442

#endif