author | greg |
Wed, 15 Jul 2009 09:36:36 +0200 | |
changeset 556 | 8296acd119a9 |
parent 529 | c171e11707c5 |
child 561 | f9be4262c68d |
permissions | -rw-r--r-- |
0 | 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 |
||
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 | 28 |
#ifndef __nmtSlave_h__ |
29 |
#define __nmtSlave_h__ |
|
30 |
||
31 |
#include <applicfg.h> |
|
32 |
#include "data.h" |
|
33 |
||
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
34 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
35 |
* @brief Threat the reception of a NMT message from the master |
0 | 36 |
* bus_id is hardware dependant |
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
37 |
* @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
|
38 |
* @param *m Pointer on the message received |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
39 |
* @return |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
40 |
* - 0 if OK |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
41 |
* - -1 if the slave is not allowed, by its state, to receive the message |
0 | 42 |
*/ |
43 |
void proceedNMTstateChange (CO_Data* d, Message * m); |
|
44 |
||
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
45 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
46 |
* @brief Transmit the boot-Up frame when the slave is moving from initialization |
0 | 47 |
* state to pre_operational state. |
48 |
* bus_id is hardware dependant |
|
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
71
diff
changeset
|
49 |
* @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
|
50 |
* @return canSend(bus_id,&m) |
0 | 51 |
*/ |
52 |
UNS8 slaveSendBootUp (CO_Data* d); |
|
53 |
||
54 |
||
71 | 55 |
#endif /* __nmtSlave_h__ */ |