Re-write doxygen tags in headers files to generate User API documentation

[CanFestival-3.git] / include / data.h

diff --git a/include/data.h b/include/data.h
index ef3e710791e35d469fa28b7c100165586683b705..080ceecfc0b624b71d172da3359dc1e35a1bb94a 100644 (file)
--- a/include/data.h
+++ b/include/data.h
@@ -42,21 +42,25 @@ typedef struct struct_CO_Data CO_Data;
 #include "states.h"
 #include "lifegrd.h"
 #include "sync.h"
+#include "nmtSlave.h"
 #include "nmtMaster.h"
 #include "emcy.h"
 #ifdef CO_ENABLE_LSS
 #include "lss.h"
 #endif
 
-/* This structurs contains all necessary information for a CanOpen node */
+/**
+ * @ingroup od
+ * @brief This structure contains all necessary information for a CanOpen node 
+ */
 struct struct_CO_Data {
        /* Object dictionary */
        UNS8 *bDeviceNodeId;
        const indextable *objdict;
        s_PDO_status *PDO_status;
-       quick_index *firstIndex;
-       quick_index *lastIndex;
-       UNS16 *ObjdictSize;
+       const quick_index *firstIndex;
+       const quick_index *lastIndex;
+       const UNS16 *ObjdictSize;
        const UNS8 *iam_a_slave;
        valueRangeTest_t valueRangeTest;
        
@@ -71,7 +75,9 @@ struct struct_CO_Data {
        preOperational_t preOperational;
        operational_t operational;
        stopped_t stopped;
-
+     void (*NMT_Slave_Node_Reset_Callback)(CO_Data*);
+     void (*NMT_Slave_Communications_Reset_Callback)(CO_Data*);
+     
        /* NMT-heartbeat */
        UNS8 *ConsumerHeartbeatCount;
        UNS32 *ConsumerHeartbeatEntries;
@@ -92,7 +98,7 @@ struct struct_CO_Data {
        
        /* General */
        UNS8 toggle;
-       CAN_HANDLE canHandle;   
+       CAN_PORT canHandle;     
        scanIndexOD_t scanIndexOD;
        storeODSubIndex_t storeODSubIndex; 
        
@@ -116,7 +122,6 @@ struct struct_CO_Data {
        /* LSS */
        lss_transfer_t lss_transfer;
        lss_StoreConfiguration_t lss_StoreConfiguration;
-       lss_ChangeBaudRate_t lss_ChangeBaudRate;
 #endif 
 };
 
@@ -155,7 +160,8 @@ struct struct_CO_Data {
                0,                                              /* LSSNext */\
                0,                                              /* LSSPos */\
                LSS_FS_RESET,                   /* FastScan_SM */\
-               -1                                              /* timerFS */
+               -1,                                             /* timerFS */\
+               {{0,0,0,0},{0,0,0,0}}   /* lss_fs_transfer */
 #else
 #define lss_fs_Initializer
 #endif         
@@ -179,8 +185,7 @@ struct struct_CO_Data {
                0                                               /* LSSanswer */\
                lss_fs_Initializer              /*FastScan service initialization */\
          },\
-         NULL,         /* _lss_StoreConfiguration*/\
-         NULL    /* _lss_ChangeBaudRate */
+         NULL  /* _lss_StoreConfiguration*/
 #else
 #define lss_Initializer
 #endif
@@ -220,6 +225,8 @@ struct struct_CO_Data {
        _preOperational,     /* preOperational */\
        _operational,        /* operational */\
        _stopped,            /* stopped */\
+       NULL,                /* NMT node reset callback */\
+       NULL,                /* NMT communications reset callback */\
        \
        /* NMT-heartbeat */\
        & NODE_PREFIX ## _highestSubIndex_obj1016, /* ConsumerHeartbeatCount */\