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)(void);
  31 void _post_sync();
  32
  33 typedef void (*post_TPDO_t)(void);
  34 void _post_TPDO();
  35
  36 /** transmit a SYNC message on the bus number bus_id
  37  * bus_id is hardware dependant
  38  * return canSend(bus_id,&m)
  39  */
  40 UNS8 sendSYNC (CO_Data* d, UNS32 cob_id);
  41
  42 /** This function is called when the node is receiving a SYNC
  43  * message (cob-id = 0x80).
  44  * What does the function :
  45  * check if the node is in OERATIONAL mode. (other mode : return 0 but does nothing).
  46  * Get the SYNC cobId by reading the dictionary index 1005. (Return -1 if it does not correspond
  47  * to the cobId received).
  48  * Scan the dictionary from index 0x1800 to the last PDO defined (dict_cstes.max_count_of_PDO_transmit)
  49  *   for each PDO whose transmission type is on synchro (transmission type < 241) and if the msg must
  50  *   be send at this SYNC. read the COBID. Verify that the nodeId inside the
  51  *   nodeId correspond to bDeviceNodeId. (Assume that the cobId of a PDO Transmit is made
  52  *   with the node id of the node who transmit), get the mapping, launch PDOmGR to send the PDO
  53  * *m is a pointer to the message received
  54  * bus_id is hardware dependant
  55  * return 0 if OK, 0xFF if error
  56  */
  57 UNS8 proceedSYNC (CO_Data* d, Message * m);
  58
  59 #endif