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 __sdo_h__

    24

#define __sdo_h__

    25

    26

typedef void (*SDOtimeoutError_t)(UNS8 line);

    27

struct struct_s_transfer;

    28

    29

#include "timer.h"

    30

    31

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

    32

    33

/* The Transfer structure

    34

Used to store the different segments of 

    35

 - a SDO received before writing in the dictionary  

    36

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

    37

*/

    38

    39

struct struct_s_transfer {

    40

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

    41

    42

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

    43

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

    44

  UNS8           toggle;

    45

  UNS32          abortCode;  /* Sent or received */

    46

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

    47

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

    48

  UNS16          index; 

    49

  UNS8           subIndex; 

    50

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

    51

  UNS32          offset;     /* stack pointer of data[]

    52

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

    53

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

    54

                              * WARNING s_transfer.data is subject to ENDIANISATION 

    55

                              * (with respect to CANOPEN_BIG_ENDIAN)

    56

                              */

    57

  UNS8           data [SDO_MAX_LENGTH_TRANSFERT];

    58

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

    59

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

    60

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

    61

                              */

    62

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

    63

                              * It is automatically incremented whenever 

    64

                              * the line state is in SDO_DOWNLOAD_IN_PROGRESS or 

    65

                              * SDO_UPLOAD_IN_PROGRESS, and reseted to 0 

    66

                              * when the response SDO have been received.

    67

                              */

    68

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

    69

};

    70

typedef struct struct_s_transfer s_transfer;

    71

    72

    73

#include "data.h"

    74

    75

/* The 8 bytes data of the SDO */

    76

struct BODY{

    77

    UNS8 data[8];

    78

};

    79

    80

/* The SDO structure ...*/

    81

struct struct_s_SDO {

    82

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

    83

  struct BODY body;

    84

};

    85

    86

    87

typedef struct struct_s_SDO s_SDO;

    88

    89

/** Reset of a SDO exchange on timeout. 

    90

 * Send a SDO abort

    91

 */

    92

void SDOTimeoutAlarm(CO_Data* d, UNS32 id);

    93

    94

/** Reset all sdo buffers

    95

 */

    96

void resetSDO (CO_Data* d);

    97

    98

    99

/** Copy the data received from the SDO line transfert to the object dictionary

   100

 * Returns SDO error code if error. Else, returns 0; 

   101

 */

   102

UNS32 SDOlineToObjdict (CO_Data* d, UNS8 line);

   103

   104

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

   105

 * Returns SDO error code if error. Else, returns 0; 

   106

 */

   107

UNS32 objdictToSDOline (CO_Data* d, UNS8 line);

   108

   109

/** copy data from an existant line in the argument "* data"

   110

 * Returns 0xFF if error. Else, returns 0; 

   111

 */

   112

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

   113

   114

/** Add data to an existant line

   115

 * Returns 0xFF if error. Else, returns 0; 

   116

 */

   117

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

   118

   119

/** Called when an internal SDO abort occurs.

   120

 * Release the line * Only if server * 

   121

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

   122

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

   123

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

   124

 * In all cases, sends a SDO abort.

   125

 * Returns 0

   126

 */

   127

UNS8 failedSDO (CO_Data* d, UNS8 nodeId, UNS8 whoami, UNS16 index, 

   128

		UNS8 subIndex, UNS32 abortCode);

   129

   130

/** Reset an unused line.

   131

 * 

   132

 */

   133

void resetSDOline (CO_Data* d, UNS8 line);

   134

   135

/** Initialize some fields of the structure.

   136

 * Returns 0

   137

 */

   138

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

   139

   140

/** Search for an unused line in the transfers array

   141

 * to store a new SDO.

   142

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

   143

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

   144

 * bus_id is hardware dependant

   145

 * whoami : create the line for a SDO_SERVER or SDO_CLIENT.

   146

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

   147

 */

   148

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

   149

   150

/** Search for the line, in the transfers array, which contains the

   151

 * beginning of the reception of a fragmented SDO

   152

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

   153

 * bus_id is hardware dependant

   154

 * nodeId correspond to the message node-id 

   155

 * return 0xFF if error.  Else, return 0

   156

 */

   157

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

   158

   159

/** Close a transmission.

   160

 * nodeId : Node id of the server if both server or client

   161

 * whoami : Line opened as SDO_CLIENT or SDO_SERVER

   162

 */

   163

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

   164

   165

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

   166

 * bus_id is hardware dependant.

   167

 * return 0.

   168

 */

   169

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

   170

   171

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

   172

 * bus_id is hardware dependant.

   173

 * return 0 if success, 0xFF if error.

   174

 */

   175

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

   176

   177

/** Transmit a SDO frame on the bus bus_id

   178

 * sdo is a structure which contains the sdo to transmit

   179

 * bus_id is hardware dependant

   180

 * whoami takes 2 values : SDO_CLIENT or SDO_SERVER

   181

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

   182

 */

   183

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

   184

   185

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

   186

 * Read/Write to a undefined object

   187

 * Read/Write to a undefined subindex

   188

 * Read/write a not valid length object

   189

 * Write a read only object

   190

 * whoami takes 2 values : SDO_CLIENT or SDO_SERVER

   191

 */

   192

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

   193

   194

/** Treat a SDO frame reception

   195

 * bus_id is hardware dependant

   196

 * call the function sendSDO

   197

 * return 0xFF if error

   198

 *        0x80 if transfert aborted by the server

   199

 *        0x0  ok

   200

 */

   201

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

   202

   203

/** Used by the application to send a SDO request frame to write the data *data

   204

 * at the index and subIndex indicated

   205

 * in the dictionary of the slave whose node_id is nodeId

   206

 * Count : nb of bytes to write in the dictionnary.

   207

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

   208

 * bus_id is hardware dependant

   209

 * return 0xFF if error, else return 0

   210

 */

   211

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

   212

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

   213

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

   214

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

   215

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

   216

 */       		       

   217

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

   218

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

   219

/** Used by the application to send a SDO request frame to read

   220

 * in the dictionary of a server node whose node_id is ID

   221

 * at the index and subIndex indicated

   222

 * bus_id is hardware dependant

   223

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

   224

 * return 0xFF if error, else return 0

   225

 */

   226

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

   227

		      UNS8 subIndex, UNS8 dataType);

   228

   229

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

   230

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

   231

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

   232

 */   

   233

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

   234

   235

/** Use this function after a readNetworkDict to get the result.

   236

  Returns : SDO_FINISHED             // data is available

   237

            SDO_ABORTED_RCV          // Transfert failed. (abort SDO received)

   238

            SDO_ABORTED_INTERNAL     // Transfert failed. Internal abort.

   239

            SDO_UPLOAD_IN_PROGRESS   // Data not yet available

   240

	    SDO_DOWNLOAD_IN_PROGRESS // Should not arrive ! 

   241

   242

  dataType (defined in objdictdef.h) : type expected. put "visible_string" for strings, 0 for integers or reals.

   243

  abortCode : 0 = not available. Else : SDO abort code. (received if return SDO_ABORTED_RCV)

   244

  example :

   245

  UNS32 data;

   246

  UNS8 size;

   247

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

   248

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

   249

*/

   250

UNS8 getReadResultNetworkDict (CO_Data* d, UNS8 nodeId, void* data, 

   251

			       UNS8 *size, UNS32 * abortCode);

   252

   253

/**

   254

  Use this function after a writeNetworkDict to get the result of the write

   255

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

   256

  Returns : SDO_FINISHED             // data is available

   257

            SDO_ABORTED_RCV          // Transfert failed. (abort SDO received)

   258

            SDO_ABORTED_INTERNAL     // Transfert failed. Internal abort.

   259

            SDO_DOWNLOAD_IN_PROGRESS // Data not yet available

   260

	    SDO_UPLOAD_IN_PROGRESS   // Should not arrive ! 

   261

  abortCode : 0 = not available. Else : SDO abort code. (received if return SDO_ABORTED_RCV)

   262

  example :

   263

  UNS32 data = 0x50;

   264

  UNS8 size;

   265

  UNS32 abortCode;

   266

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

   267

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

   268

*/

   269

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

   270

   271

   272

   273

   274

#endif