include/sync.h
author oremeq
Sat, 20 May 2006 00:16:29 +0200
changeset 21 8737e6224393
parent 0 4472ee7c6c3e
child 149 fe50ada8020b
permissions -rw-r--r--
Some documentation correction
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
#ifndef __SYNC_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    24
#define __SYNC_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    25
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    26
void startSYNC(CO_Data* d);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    27
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    28
void stopSYNC(CO_Data* d);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    29
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    30
typedef void (*post_sync_t)(void);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    31
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    32
typedef void (*post_TPDO_t)(void);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    33
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    34
/** transmit a SYNC message on the bus number bus_id
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    35
 * bus_id is hardware dependant
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    36
 * return canSend(bus_id,&m)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    37
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    38
UNS8 sendSYNC (CO_Data* d, UNS32 cob_id);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    39
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    40
/** This function is called when the node is receiving a SYNC 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    41
 * message (cob-id = 0x80).
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    42
 * What does the function :
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    43
 * check if the node is in OERATIONAL mode. (other mode : return 0 but does nothing).
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    44
 * Get the SYNC cobId by reading the dictionary index 1005. (Return -1 if it does not correspond 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    45
 * to the cobId received).
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    46
 * Scan the dictionary from index 0x1800 to the last PDO defined (dict_cstes.max_count_of_PDO_transmit)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    47
 *   for each PDO whose transmission type is on synchro (transmission type < 241) and if the msg must
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    48
 *   be send at this SYNC. read the COBID. Verify that the nodeId inside the 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    49
 *   nodeId correspond to bDeviceNodeId. (Assume that the cobId of a PDO Transmit is made 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    50
 *   with the node id of the node who transmit), get the mapping, launch PDOmGR to send the PDO
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    51
 * *m is a pointer to the message received
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    52
 * bus_id is hardware dependant
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    53
 * return 0 if OK, 0xFF if error
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    54
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    55
UNS8 proceedSYNC (CO_Data* d, Message * m);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    56
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    57
#endif