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

    24

 *  @brief Responsible for accessing the object dictionary.

    25

 *

    26

 *  This file contains functions for accessing the object dictionary and

    27

 *  variables that are contained by the object dictionary.

    28

 *  Accessing the object dictionary contains setting local variables

    29

 *  as PDOs and accessing (read/write) all entries of the object dictionary

    30

 *  @warning Only the basic entries of an object dictionary are included

    31

 *           at the moment.

    32

 */

    33

    34

/** @defgroup od Object Dictionary Management

    35

 *  @brief The Object Dictionary is the heart of each CANopen device containing all communication and application objects.

    36

 *  @ingroup userapi

    37

 */

    38

    39

#ifndef __objacces_h__

    40

#define __objacces_h__

    41

    42

#include <applicfg.h>

    43

    50

typedef UNS32 (*valueRangeTest_t)(UNS8 typeValue, void *Value);

    51

typedef void (* storeODSubIndex_t)(CO_Data* d, UNS16 wIndex, UNS8 bSubindex);

    52

void _storeODSubIndex (CO_Data* d, UNS16 wIndex, UNS8 bSubindex);

    53

    54

/**

    55

 * @brief Print MSG_WAR (s) if error to the access to the object dictionary occurs.

    56

 * 

    57

 * You must uncomment the lines in the file objaccess.c :\n

    58

 * //#define DEBUG_CAN\n

    59

 * //#define DEBUG_WAR_CONSOLE_ON\n

    60

 * //#define DEBUG_ERR_CONSOLE_ON\n\n

    61

 * Beware that sometimes, we force the sizeDataDict or sizeDataGiven to 0, when we wants to use

    62

 * this function but we do not have the access to the right value. One example is

    63

 * getSDOerror(). So do not take attention to these variables if they are null.

    64

 * @param index

    65

 * @param subIndex

    66

 * @param sizeDataDict Size of the data defined in the dictionary

    67

 * @param sizeDataGiven Size data given by the user.

    68

 * @param code error code to print. (SDO abort code. See file def.h)

    69

 * @return

    70

 */ 

    71

UNS8 accessDictionaryError(UNS16 index, UNS8 subIndex, 

    72

			   UNS32 sizeDataDict, UNS32 sizeDataGiven, UNS32 code);

    73

    74

    75

/* _getODentry() Reads an entry from the object dictionary.\n

    76

 * 

    77

 *    use getODentry() macro to read from object and endianize

    78

 *    use readLocalDict() macro to read from object and not endianize   

    79

 *

    80

 * @code

    81

 * // Example usage:

    82

 * UNS8  *pbData;

    83

 * UNS8 length;

    84

 * UNS32 returnValue;

    85

 *

    86

 * returnValue = getODentry( (UNS16)0x100B, (UNS8)1, 

    87

 * (void * *)&pbData, (UNS8 *)&length );

    88

 * if( returnValue != SUCCESSFUL )

    89

 * {

    90

 *     // error handling

    91

 * }

    92

 * @endcode 

    93

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

    94

 * @param wIndex The index in the object dictionary where you want to read

    95

 *               an entry

    96

 * @param bSubindex The subindex of the Index. e.g. mostly subindex 0 is

    97

 *                  used to tell you how many valid entries you can find

    98

 *                  in this index. Look at the canopen standard for further

    99

 *                  information

   100

 * @param *pDestData Pointer to the pointer which points to the variable where

   101

 *                   the value of this object dictionary entry should be copied

   102

 * @param pExpectedSize This function writes the size of the copied value (in Byte)

   103

 *                      into this variable.

   104

 * @param *pDataType Pointer to the type of the data. See objdictdef.h

   105

 * @param CheckAccess if other than 0, do not read if the data is Write Only

   106

 *                    [Not used today. Put always 0].

   107

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

   108

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

   109

 *                   endianness 

   110

 * @return 

   111

 * - OD_SUCCESSFUL is returned upon success. 

   112

 * - SDO abort code is returned if error occurs . (See file def.h)

   113

 */

   123

   124

/** 

   125

 * @ingroup od

   126

 * @brief getODentry() to read from object and endianize

   127

 * @param OD Pointer to a CAN object data structure

   128

 * @param wIndex The index in the object dictionary where you want to read

   129

 *                an entry

   130

 * @param bSubindex The subindex of the Index. e.g. mostly subindex 0 is

   131

 *                  used to tell you how many valid entries you can find

   132

 *                  in this index. Look at the canopen standard for further

   133

 *                  information

   134

 * @param *pDestData Pointer to the pointer which points to the variable where

   135

 *                   the value of this object dictionary entry should be copied

   136

 * @param pExpectedSize This function writes the size of the copied value (in Byte)

   137

 *                      into this variable.

   138

 * @param *pDataType Pointer to the type of the data. See objdictdef.h

   139

 * @param checkAccess Flag that indicate if a check rights must be perfomed (0 : no , other than 0 : yes)

   140

 * @param endianize  Set to 1 : endianized into network byte order 

   141

 * @return 

   142

 * - OD_SUCCESSFUL is returned upon success. 

   143

 * - SDO abort code is returned if error occurs . (See file def.h)

   144

 */

   152

   153

/** 

   154

 * @ingroup od

   155

 * @brief readLocalDict() reads an entry from the object dictionary, but in 

   156

 * contrast to getODentry(), readLocalDict() doesn't endianize entry and reads

   157

 * entry in machine native endianness. 

   158

 * @param OD Pointer to a CAN object data structure

   159

 * @param wIndex The index in the object dictionary where you want to read

   160

 *                an entry

   161

 * @param bSubindex The subindex of the Index. e.g. mostly subindex 0 is

   162

 *                  used to tell you how many valid entries you can find

   163

 *                  in this index. Look at the canopen standard for further

   164

 *                  information

   165

 * @param *pDestData Pointer to the pointer which points to the variable where

   166

 *                   the value of this object dictionary entry should be copied

   167

 * @param pExpectedSize This function writes the size of the copied value (in Byte)

   168

 *                      into this variable.

   169

 * @param *pDataType Pointer to the type of the data. See objdictdef.h

   170

 * @param checkAccess if other than 0, do not read if the data is Write Only

   171

 *                    [Not used today. Put always 0].

   172

 * @param endianize Set to 0, data is not endianized and copied in machine native

   173

 *                  endianness 

   174

 * @return 

   175

 * - OD_SUCCESSFUL is returned upon success. 

   176

 * - SDO abort code is returned if error occurs . (See file def.h)

   177

 */

   185

   186

/* By this function you can write an entry into the object dictionary

   187

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

   188

 * @param wIndex The index in the object dictionary where you want to write

   189

 *               an entry

   190

 * @param bSubindex The subindex of the Index. e.g. mostly subindex 0 is

   191

 *                  used to tell you how many valid entries you can find

   192

 *                  in this index. Look at the canopen standard for further

   193

 *                  information

   194

 * @param *pSourceData Pointer to the variable that holds the value that should

   195

 *                     be copied into the object dictionary

   196

 * @param *pExpectedSize The size of the value (in Byte).

   197

 * @param checkAccess Flag that indicate if a check rights must be perfomed (0 : no , other than 0 : yes)

   198

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

   199

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

   200

 *                  endianness   

   201

 * @return 

   202

 * - OD_SUCCESSFUL is returned upon success. 

   203

 * - SDO abort code is returned if error occurs . (See file def.h)

   204

 */

   205

UNS32 _setODentry( CO_Data* d,

   206

                   UNS16 wIndex,

   207

                   UNS8 bSubindex,

   208

                   void * pSourceData,

   209

                   UNS32 * pExpectedSize,

   210

                   UNS8 checkAccess,

   211

                   UNS8 endianize);

   212

   213

/**

   214

 * @ingroup od

   215

 * @brief setODentry converts SourceData from network byte order to machine native 

   216

 * format, and writes that to OD.

   217

 * @code

   218

 * // Example usage:

   219

 * UNS8 B;

   220

 * B = 0xFF; // set transmission type

   221

 *

   222

 * retcode = setODentry( (UNS16)0x1800, (UNS8)2, &B, sizeof(UNS8), 1 );

   223

 * @endcode

   224

 * @param d Pointer to a CAN object data structure

   225

 * @param wIndex The index in the object dictionary where you want to write

   226

 *               an entry

   227

 * @param bSubindex The subindex of the Index. e.g. mostly subindex 0 is

   228

 *                  used to tell you how many valid entries you can find

   229

 *                  in this index. Look at the canopen standard for further

   230

 *                  information

   231

 * @param *pSourceData Pointer to the variable that holds the value that should

   232

 *                     be copied into the object dictionary

   233

 * @param *pExpectedSize The size of the value (in Byte).

   234

 * @param checkAccess Flag that indicate if a check rights must be perfomed (0 : no , other than 0 : yes)

   235

 * @param endianize Set to 1 : endianized into network byte order

   236

 * @return 

   237

 * - OD_SUCCESSFUL is returned upon success. 

   238

 * - SDO abort code is returned if error occurs . (See file def.h)

   239

 */

   246

   247

/** @fn UNS32 writeLocalDict(d, wIndex, bSubindex, pSourceData, pExpectedSize, checkAccess)

   248

 * @ingroup od

   249

 * @hideinitializer

   250

 * @brief Writes machine native SourceData to OD.

   251

 * @param d Pointer to a CAN object data structure

   252

 * @param wIndex The index in the object dictionary where you want to write

   253

 *               an entry

   254

 * @param bSubindex The subindex of the Index. e.g. mostly subindex 0 is

   255

 *                  used to tell you how many valid entries you can find

   256

 *                  in this index. Look at the canopen standard for further

   257

 *                  information

   258

 * @param *pSourceData Pointer to the variable that holds the value that should

   259

 *                     be copied into the object dictionary

   260

 * @param *pExpectedSize The size of the value (in Byte).

   261

 * @param checkAccess Flag that indicate if a check rights must be perfomed (0 : no , other than 0 : yes)

   262

 * @param endianize Data is not endianized and copied in machine native endianness 

   263

 * @return 

   264

 * - OD_SUCCESSFUL is returned upon success. 

   265

 * - SDO abort code is returned if error occurs . (See file def.h)

   266

 * \n\n

   267

 * @code

   268

 * // Example usage:

   269

 * UNS8 B;

   270

 * B = 0xFF; // set transmission type

   271

 *

   272

 * retcode = writeLocalDict( (UNS16)0x1800, (UNS8)2, &B, sizeof(UNS8), 1 );

   273

 * @endcode

   274

 */

   281

/**

   282

 * @brief Scan the index of object dictionary. Used only by setODentry and getODentry.

   283

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

   284

 * @param wIndex

   285

 * @param *errorCode :  OD_SUCCESSFUL if index foundor SDO abort code. (See file def.h)

   286

 * @param **Callback

   287

 * @return NULL if index not found. Else : return the table part of the object dictionary.

   288

 */

   289

 const indextable * scanIndexOD (CO_Data* d, UNS16 wIndex, UNS32 *errorCode, ODCallback_t **Callback);

   290

   291

UNS32 RegisterSetODentryCallBack(CO_Data* d, UNS16 wIndex, UNS8 bSubindex, ODCallback_t Callback);

   292

   297

#endif /* __objacces_h__ */