include/nmtMaster.h
author frdupin
Thu, 25 Jan 2007 17:36:58 +0100
changeset 71 95cd3376cc9f
parent 0 4472ee7c6c3e
child 528 0a30e161d63c
permissions -rw-r--r--
compilator compatitibility
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 __nmtMaster_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    24
#define __nmtMaster_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    25
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    26
#include "data.h"
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    27
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    28
/** Transmit a NMT message on the bus number bus_id
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    29
 * to the slave whose node_id is ID
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    30
 * bus_id is hardware dependant
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    31
 * cs represents the order of state changement:
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    32
 * cs =  NMT_Start_Node            // Put the node in operational mode             
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    33
 * cs =	 NMT_Stop_Node		   // Put the node in stopped mode
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    34
 * cs =	 NMT_Enter_PreOperational  // Put the node in pre_operational mode  
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    35
 * cs =  NMT_Reset_Node		   // Put the node in initialization mode 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    36
 * cs =  NMT_Reset_Comunication	   // Put the node in initialization mode 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    37
 * The mode is changed according to the slave state machine mode :
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    38
 *        initialisation  ---> pre-operational (Automatic transition)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    39
 *        pre-operational <--> operational
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    40
 *        pre-operational <--> stopped
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    41
 *        pre-operational, operational, stopped -> initialisation
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    42
 *
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    43
 * return canSend(bus_id,&m)               
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    44
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    45
UNS8 masterSendNMTstateChange (CO_Data* d, UNS8 Node_ID, UNS8 cs);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    46
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    47
/** Transmit a Node_Guard message on the bus number bus_id
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    48
 * to the slave whose node_id is nodeId
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    49
 * bus_id is hardware dependant
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    50
 * return canSend(bus_id,&m)
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    51
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    52
UNS8 masterSendNMTnodeguard (CO_Data* d, UNS8 nodeId);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    53
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    54
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    55
/** Prepare a Node_Guard message transmission on the bus number bus_id
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    56
 * to the slave whose node_id is nodeId
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    57
 * Put nodeId = 0 to send an NMT broadcast.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    58
 * This message will ask for the slave, whose node_id is nodeId, its state
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    59
 * bus_id is hardware dependant
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    60
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    61
void masterRequestNodeState (CO_Data* d, UNS8 nodeId);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    62
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    63
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 0
diff changeset
    64
#endif /* __nmtMaster_h__ */