include/nmtSlave.h
author fbeaulier
Tue, 16 Aug 2011 14:15:52 +0200
changeset 663 70fc3603e36f
parent 561 f9be4262c68d
permissions -rwxr-xr-x
timers_unix.c : remove sigint and sigterm catch
sdo : Allow multiple servers
The sdo transfer struct is not anymore referenced by server's node id but by
client or server number in the OD. Node id is not relevant in SDO transfert.
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 nmtslave NMT Slave
529
c171e11707c5 Second time, Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 528
diff changeset
    24
 *  @brief The NMT Slave methods are called automatically when a NMT message from Master are received. 
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    25
 *  @ingroup networkmanagement
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    26
 */
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    27
 
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    28
#ifndef __nmtSlave_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    29
#define __nmtSlave_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    30
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    31
#include <applicfg.h>
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    32
#include "data.h"
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    33
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    34
/** 
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    35
 * @brief Threat the reception of a NMT message from the master.
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    36
 * @param *d Pointer to the CAN data structure
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
    37
 * @param *m Pointer to the message received
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    38
 * @return 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    39
 *  -  0 if OK 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    40
 *  - -1 if the slave is not allowed, by its state, to receive the message
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    41
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    42
void proceedNMTstateChange (CO_Data* d, Message * m);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    43
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    44
/** 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    45
 * @brief Transmit the boot-Up frame when the slave is moving from initialization
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    46
 * state to pre_operational state.
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    47
 * @param *d Pointer on the CAN data structure
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 71
diff changeset
    48
 * @return canSend(bus_id,&m)
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    49
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    50
UNS8 slaveSendBootUp (CO_Data* d);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    51
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    52
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 0
diff changeset
    53
#endif /* __nmtSlave_h__ */