include/sync.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 #ifndef __SYNC_h__
  24 #define __SYNC_h__
  25
  26 void startSYNC(CO_Data* d);
  27
  28 void stopSYNC(CO_Data* d);
  29
  30 typedef void (*post_sync_t)(CO_Data*);
  31 void _post_sync(CO_Data* d);
  32
  33 typedef void (*post_TPDO_t)(CO_Data*);
  34 void _post_TPDO(CO_Data* d);
  35
  36 /** transmit a SYNC message and trigger sync TPDOs
  37  */
  38 UNS8 sendSYNC (CO_Data* d);
  39 /** transmit a SYNC message on CAN bus
  40  */
  41 UNS8 sendSYNCMessage(CO_Data* d);
  42
  43 /** This function is called when the node is receiving a SYNC message (cob-id = 0x80).
  44  *  - check if the node is in OERATIONAL mode. (other mode : return 0 but does nothing).
  45  *  - Get the SYNC cobId by reading the dictionary index 1005, check it does correspond to the received cobId
  46  *  - Trigger sync TPDO emission
  47  *  - return 0 if OK, 0xFF if error
  48  */
  49 UNS8 proceedSYNC (CO_Data* d);
  50
  51 #endif