include/objacces.h
author etisserant
Sat, 07 Apr 2007 09:49:05 +0200
changeset 150 d2fc5d5f8a36
parent 75 debc68b124b7
child 161 c4908cc776a9
permissions -rw-r--r--
Some win32 fixes following yesterday's API changes.
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     1
/*
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     2
This file is part of CanFestival, a library implementing CanOpen Stack. 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     3
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     4
Copyright (C): Edouard TISSERANT and Francis DUPIN
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     5
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     6
See COPYING file for copyrights details.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     7
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     8
This library is free software; you can redistribute it and/or
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     9
modify it under the terms of the GNU Lesser General Public
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    10
License as published by the Free Software Foundation; either
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    11
version 2.1 of the License, or (at your option) any later version.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    12
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    13
This library is distributed in the hope that it will be useful,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    14
but WITHOUT ANY WARRANTY; without even the implied warranty of
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    16
Lesser General Public License for more details.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    17
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    18
You should have received a copy of the GNU Lesser General Public
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    19
License along with this library; if not, write to the Free Software
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    20
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    21
*/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    22
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    23
/** \file
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    24
 *  \brief Responsible for accessing the object dictionary.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    25
 *
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    26
 *  This file contains functions for accessing the object dictionary and
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    27
 *  variables that are contained by the object dictionary.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    28
 *  Accessing the object dictionary contains setting local variables
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    29
 *  as PDOs and accessing (read/write) all entries of the object dictionary
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    30
 *  \warning Only the basic entries of an object dictionary are included
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    31
 *           at the moment.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    32
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    33
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    34
#ifndef __objacces_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    35
#define __objacces_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    36
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    37
#include <applicfg.h>
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    38
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    39
typedef UNS32 (*valueRangeTest_t)(UNS8 typeValue, void *Value);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    40
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    41
#include "data.h"
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    42
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    43
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    44
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 13
diff changeset
    45
/*
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    46
Print MSG_WAR (s) if error to the access to the object dictionary occurs.
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 13
diff changeset
    47
You must uncomment the lines
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    48
//#define DEBUG_CAN
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    49
//#define DEBUG_WAR_CONSOLE_ON
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    50
//#define DEBUG_ERR_CONSOLE_ON
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 13
diff changeset
    51
in the file objaccess.c
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    52
sizeDataDict : Size of the data defined in the dictionary
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    53
sizeDataGiven : Size data given by the user.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    54
code : error code to print. (SDO abort code. See file def.h)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    55
Beware that sometimes, we force the sizeDataDict or sizeDataGiven to 0, when we wants to use
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    56
this function but we do not have the access to the right value. One example is
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    57
getSDOerror(). So do not take attention to these variables if they are null.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    58
*/
75
debc68b124b7 compiler compatibility : accessDictionaryError contains nothing out of debogue mode
frdupin
parents: 71
diff changeset
    59
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    60
UNS8 accessDictionaryError(UNS16 index, UNS8 subIndex, 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    61
			   UNS8 sizeDataDict, UNS8 sizeDataGiven, UNS32 code);
75
debc68b124b7 compiler compatibility : accessDictionaryError contains nothing out of debogue mode
frdupin
parents: 71
diff changeset
    62
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    63
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 13
diff changeset
    64
/* Reads an entry from the object dictionary.\n
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    65
 *  \code
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    66
 *  // Example usage:
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    67
 *  UNS8  *pbData;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    68
 *  UNS8 length;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    69
 *  UNS32 returnValue;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    70
 *
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    71
 *  returnValue = getODentry( (UNS16)0x100B, (UNS8)1, 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    72
 *  (void * *)&pbData, (UNS8 *)&length );
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    73
 *  if( returnValue != SUCCESSFUL )
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    74
 *  {
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    75
 *      // error handling
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    76
 *  }
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    77
 *  \endcode 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    78
 *  \param wIndex The index in the object dictionary where you want to read
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    79
 *                an entry
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    80
 *  \param bSubindex The subindex of the Index. e.g. mostly subindex 0 is
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    81
 *                   used to tell you how many valid entries you can find
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    82
 *                   in this index. Look at the canopen standard for further
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    83
 *                   information
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    84
 *  \param ppbData Pointer to the pointer which points to the variable where
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    85
 *                 the value of this object dictionary entry should be copied
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    86
 *  \param pdwSize This function writes the size of the copied value (in Byte)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    87
 *                 into this variable.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    88
 *  \param pDataType : The type of the data. See objdictdef.h
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    89
 *  \param CheckAccess if other than 0, do not read if the data is Write Only
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    90
 *                     [Not used today. Put always 0].
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    91
 *  \return OD_SUCCESSFUL or SDO abort code. (See file def.h)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    92
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    93
UNS32 getODentry( CO_Data* d, 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    94
                  UNS16 wIndex,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    95
		  UNS8 bSubindex,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    96
		  void * pDestData,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    97
		  UNS8 * pExpectedSize,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    98
		  UNS8 * pDataType,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    99
		  UNS8 checkAccess);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   100
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   101
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 13
diff changeset
   102
/* By this function you can write an entry into the object dictionary\n
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   103
 *  \code
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   104
 *  // Example usage:
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   105
 *  UNS8 B;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   106
 *  B = 0xFF; // set transmission type
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   107
 *
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   108
 *  retcode = setODentry( (UNS16)0x1800, (UNS8)2, &B, sizeof(UNS8), 1 );
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   109
 *  \endocde
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   110
 *  \param wIndex The index in the object dictionary where you want to write
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   111
 *                an entry
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   112
 *  \param bSubindex The subindex of the Index. e.g. mostly subindex 0 is
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   113
 *                   used to tell you how many valid entries you can find
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   114
 *                   in this index. Look at the canopen standard for further
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   115
 *                   information
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   116
 *  \param pbData Pointer to the variable that holds the value that should
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   117
 *                 be copied into the object dictionary
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   118
 *  \param dwSize The size of the value (in Byte).
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   119
 *  \param CheckAccess if other than 0, do not read if the data is Read Only or Constant
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   120
 *  \return OD_SUCCESSFUL or SDO abort code. (See file def.h)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   121
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   122
UNS32 setODentry( CO_Data* d, 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   123
                  UNS16 wIndex,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   124
		  UNS8 bSubindex, 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   125
		  void * pSourceData, 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   126
		  UNS8 * pExpectedSize, 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   127
		  UNS8 checkAccess);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   128
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   129
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 13
diff changeset
   130
/* Scan the index of object dictionary. Used only by setODentry and getODentry.
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   131
 *  *errorCode :  OD_SUCCESSFUL if index foundor SDO abort code. (See file def.h)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   132
 *  Return NULL if index not found. Else : return the table part of the object dictionary.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   133
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   134
 const indextable * scanIndexOD (CO_Data* d, UNS16 wIndex, UNS32 *errorCode, ODCallback_t **Callback);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   135
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   136
UNS32 RegisterSetODentryCallBack(CO_Data* d, UNS16 wIndex, UNS8 bSubindex, ODCallback_t Callback);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   137
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 13
diff changeset
   138
#endif /* __objacces_h__ */