include/data.h

   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
  24 #ifndef __data_h__
  25 #define __data_h__
  26
  27 /* declaration of CO_Data type let us include all necessary headers
  28  struct struct_CO_Data can then be defined later
  29  */
  30 typedef struct struct_CO_Data CO_Data;
  31
  32 #include "applicfg.h"
  33 #include "def.h"
  34 #include "can.h"
  35 #include "objdictdef.h"
  36 #include "objacces.h"
  37 #include "sdo.h"
  38 #include "pdo.h"
  39 #include "states.h"
  40 #include "lifegrd.h"
  41 #include "sync.h"
  42 #include "nmtMaster.h"
  43
  44 /* This structurs contains all necessary information for a CanOpen node */
  45 struct struct_CO_Data {
  46         /* Object dictionary */
  47         UNS8 *bDeviceNodeId;
  48         const indextable *objdict;
  49         UNS8 *count_sync;
  50         quick_index *firstIndex;
  51         quick_index *lastIndex;
  52         UNS16 *ObjdictSize;
  53         const UNS8 *iam_a_slave;
  54         valueRangeTest_t valueRangeTest;
  55
  56         /* SDO */
  57         s_transfer transfers[SDO_MAX_SIMULTANEOUS_TRANSFERTS];
  58         SDOtimeoutError_t SDOtimeoutError;
  59         /* s_sdo_parameter *sdo_parameters; */
  60
  61         /* State machine */
  62         e_nodeState nodeState;
  63         s_state_communication CurrentCommunicationState;
  64         initialisation_t initialisation;
  65         preOperational_t preOperational;
  66         operational_t operational;
  67         stopped_t stopped;
  68
  69         /* NMT-heartbeat */
  70         UNS8 *ConsumerHeartbeatCount;
  71         UNS32 *ConsumerHeartbeatEntries;
  72         TIMER_HANDLE *ConsumerHeartBeatTimers;
  73         UNS16 *ProducerHeartBeatTime;
  74         TIMER_HANDLE ProducerHeartBeatTimer;
  75         heartbeatError_t heartbeatError;
  76         e_nodeState NMTable[NMT_MAX_NODE_ID];
  77
  78         /* SYNC */
  79         TIMER_HANDLE syncTimer;
  80         UNS32 *COB_ID_Sync;
  81         UNS32 *Sync_Cycle_Period;
  82         /*UNS32 *Sync_window_length;;*/
  83         post_sync_t post_sync;
  84         post_TPDO_t post_TPDO;
  85
  86         /* PDO */
  87         s_process_var process_var;
  88
  89         /* General */
  90         UNS8 toggle;
  91         CAN_HANDLE canHandle;
  92         scanIndexOD_t scanIndexOD;
  93 };
  94
  95 #define NMTable_Initializer Unknown_state,
  96
  97 #define s_transfer_Initializer {\
  98                 0,          /* nodeId */\
  99                 0,          /* wohami */\
 100                 SDO_RESET,  /* state */\
 101                 0,          /* toggle */\
 102                 0,          /* abortCode */\
 103                 0,          /* index */\
 104                 0,          /* subIndex */\
 105                 0,          /* count */\
 106                 0,          /* offset */\
 107                 {0},        /* data (static use, so that all the table is initialize at 0)*/\
 108                 0,          /* dataType */\
 109                 -1,         /* timer */\
 110                 NULL        /* Callback */\
 111           },
 112
 113 /* A macro to initialize the data in client app.*/
 114 /* CO_Data structure */
 115 #define CANOPEN_NODE_DATA_INITIALIZER(NODE_PREFIX) {\
 116         /* Object dictionary*/\
 117         & NODE_PREFIX ## _bDeviceNodeId,     /* bDeviceNodeId */\
 118         NODE_PREFIX ## _objdict,             /* objdict  */\
 119         NODE_PREFIX ## _count_sync,          /* count_sync */\
 120         & NODE_PREFIX ## _firstIndex,        /* firstIndex */\
 121         & NODE_PREFIX ## _lastIndex,         /* lastIndex */\
 122         & NODE_PREFIX ## _ObjdictSize,       /* ObjdictSize */\
 123         & NODE_PREFIX ## _iam_a_slave,       /* iam_a_slave */\
 124         NODE_PREFIX ## _valueRangeTest,      /* valueRangeTest */\
 125         \
 126         /* SDO, structure s_transfer */\
 127         {\
 128           REPEAT_SDO_MAX_SIMULTANEOUS_TRANSFERTS_TIMES(s_transfer_Initializer)\
 129         },\
 130         _SDOtimeoutError,/*&NODE_PREFIX ## _SDOtimeoutError,    /* SDOtimeoutError */\
 131         \
 132         /* State machine*/\
 133         Unknown_state,      /* nodeState */\
 134         /* structure s_state_communication */\
 135         {\
 136                 0,          /* csBoot_Up */\
 137                 0,          /* csSDO */\
 138                 0,          /* csEmergency */\
 139                 0,          /* csSYNC */\
 140                 0,          /* csHeartbeat */\
 141                 0           /* csPDO */\
 142         },\
 143         _initialisation,/*&NODE_PREFIX ## _initialisation,     /* initialisation */\
 144         _preOperational,/*&NODE_PREFIX ## _preOperational,     /* preOperational */\
 145         _operational,/*&NODE_PREFIX ## _operational,        /* operational */\
 146         _stopped,/*&NODE_PREFIX ## _stopped,            /* stopped */\
 147         \
 148         /* NMT-heartbeat */\
 149         & NODE_PREFIX ## _highestSubIndex_obj1016, /* ConsumerHeartbeatCount */\
 150         NODE_PREFIX ## _obj1016,                   /* ConsumerHeartbeatEntries */\
 151         NODE_PREFIX ## _heartBeatTimers,           /* ConsumerHeartBeatTimers  */\
 152         & NODE_PREFIX ## _obj1017,                 /* ProducerHeartBeatTime */\
 153         TIMER_NONE,                                /* ProducerHeartBeatTimer */\
 154         _heartbeatError,/*NODE_PREFIX ## _heartbeatError,            /* heartbeatError */\
 155         \
 156         {REPEAT_NMT_MAX_NODE_ID_TIMES(NMTable_Initializer)},\
 157                                                    /* is  well initialized at "Unknown_state". Is it ok ? (FD)*/\
 158         \
 159         /* SYNC */\
 160         TIMER_NONE,                                /* syncTimer */\
 161         & NODE_PREFIX ## _obj1005,                 /* COB_ID_Sync */\
 162         & NODE_PREFIX ## _obj1006,                 /* Sync_Cycle_Period */\
 163         /*& NODE_PREFIX ## _obj1007, */            /* Sync_window_length */\
 164         _post_sync,/*NODE_PREFIX ## _post_sync,                 /* post_sync */\
 165         _post_TPDO,/*NODE_PREFIX ## _post_TPDO,                 /* post_TPDO */\
 166         \
 167         /* PDO, structure s_process_var */\
 168         {\
 169                 0,          /* count */\
 170                 {0}         /* data (static use, so that all the table is initialize at 0)*/\
 171         },\
 172         \
 173         /* General */\
 174         0,                                         /* toggle */\
 175         NULL,/*NODE_PREFIX ## _canSend,                   /* canSend */\
 176         NODE_PREFIX ## _scanIndexOD                /* scanIndexOD */\
 177 }
 178
 179 #endif /* __data_h__ */
 180
 181