include/nmtMaster.h
author edouard
Fri, 10 Sep 2010 13:44:56 +0200
changeset 627 4939452b1bf1
parent 561 f9be4262c68d
child 631 08b6b903f84a
permissions -rwxr-xr-x
Fixed SDO loop in some situations.
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
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    23
/** @defgroup networkmanagement Network Management
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    24
 *  @ingroup userapi
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    25
 */
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    26
/** @defgroup nmtmaster NMT Master
529
c171e11707c5 Second time, Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 528
diff changeset
    27
 *  @brief NMT master provides mechanisms that control and monitor the state of nodes and their behavior in the network.
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    28
 *  @ingroup networkmanagement
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    29
 */
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    30
 
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    31
#ifndef __nmtMaster_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    32
#define __nmtMaster_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    33
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    34
#include "data.h"
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    35
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    36
/** 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    37
 * @ingroup nmtmaster
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    38
 * @brief Transmit a NMT message on the network to the slave whose nodeId is node ID.
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    39
 * 
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    40
 * @param *d Pointer to a CAN object data structure
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    41
 * @param nodeId Id of the slave node
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    42
 * @param cs The order of state changement \n\n
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    43
 * 
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    44
 * Allowed states :
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    45
 *  - cs =  NMT_Start_Node               // Put the node in operational mode             
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    46
 *  - cs =	NMT_Stop_Node		         // Put the node in stopped mode
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    47
 *  - cs =	NMT_Enter_PreOperational     // Put the node in pre_operational mode  
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    48
 *  - cs =  NMT_Reset_Node		         // Put the node in initialization mode 
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    49
 *  - cs =  NMT_Reset_Comunication	     // Put the node in initialization mode
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    50
 *  
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    51
 * The mode is changed according to the slave state machine mode :
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    52
 *  - initialisation  ---> pre-operational (Automatic transition)
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    53
 *  - pre-operational <--> operational
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    54
 *  - pre-operational <--> stopped
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    55
 *  - pre-operational, operational, stopped -> initialisation
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    56
 * \n\n
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    57
 * @return errorcode
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    58
 *                   - 0 if the NMT message was send
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    59
 *                   - 1 if an error occurs 
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    60
 */
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    61
UNS8 masterSendNMTstateChange (CO_Data* d, UNS8 nodeId, UNS8 cs);
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    62
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    63
/**
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    64
 * @ingroup nmtmaster 
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    65
 * @brief Transmit a NodeGuard message on the network to the slave whose nodeId is node ID
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    66
 * 
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    67
 * @param *d Pointer to a CAN object data structure
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    68
 * @param nodeId Id of the slave node
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    69
 * @return
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    70
 *         - 0 is returned if the NodeGuard message was send.
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    71
 *         - 1 is returned if an error occurs.
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    72
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    73
UNS8 masterSendNMTnodeguard (CO_Data* d, UNS8 nodeId);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    74
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    75
/** 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    76
 * @ingroup nmtmaster
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    77
 * @brief Ask the state of the slave node whose nodeId is node Id.
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    78
 * 
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    79
 * To ask states of all nodes on the network (NMT broadcast), nodeId must be equal to 0
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    80
 * @param *d Pointer to a CAN object data structure
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    81
 * @param nodeId Id of the slave node
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    82
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    83
void masterRequestNodeState (CO_Data* d, UNS8 nodeId);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    84
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    85
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 0
diff changeset
    86
#endif /* __nmtMaster_h__ */