include/nmtSlave.h
changeset 528 0a30e161d63c
parent 71 95cd3376cc9f
child 529 c171e11707c5
equal deleted inserted replaced
527:7d5c74cc8f91 528:0a30e161d63c
    18 You should have received a copy of the GNU Lesser General Public
    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
    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
    20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    21 */
    21 */
    22 
    22 
       
    23 /** @defgroup nmtslave NMT Slave
       
    24  *  @ingroup networkmanagement
       
    25  */
       
    26  
    23 #ifndef __nmtSlave_h__
    27 #ifndef __nmtSlave_h__
    24 #define __nmtSlave_h__
    28 #define __nmtSlave_h__
    25 
    29 
    26 #include <applicfg.h>
    30 #include <applicfg.h>
    27 #include "data.h"
    31 #include "data.h"
    28 
    32 
    29 /** Threat the reception of a NMT message from the master
    33 /** 
    30  * *m is a pointer to the message received
    34  * @ingroup nmtslave
       
    35  * @brief Threat the reception of a NMT message from the master
    31  * bus_id is hardware dependant
    36  * bus_id is hardware dependant
    32  * return 0 if OK, -1 if the slave is not allowed, by its state,
    37  * @param *d Pointer on the CAN data structure
    33  * to receive the message
    38  * @param *m Pointer on the message received
       
    39  * @return 
       
    40  *  -  0 if OK 
       
    41  *  - -1 if the slave is not allowed, by its state, to receive the message
    34  */
    42  */
    35 void proceedNMTstateChange (CO_Data* d, Message * m);
    43 void proceedNMTstateChange (CO_Data* d, Message * m);
    36 
    44 
    37 /** Transmit the boot-Up frame when the slave is moving from initialization
    45 /** 
       
    46  * @ingroup nmtslave
       
    47  * @brief Transmit the boot-Up frame when the slave is moving from initialization
    38  * state to pre_operational state.
    48  * state to pre_operational state.
    39  * bus_id is hardware dependant
    49  * bus_id is hardware dependant
    40  * return canSend(bus_id,&m)
    50  * @param *d Pointer on the CAN data structure
       
    51  * @return canSend(bus_id,&m)
    41  */
    52  */
    42 UNS8 slaveSendBootUp (CO_Data* d);
    53 UNS8 slaveSendBootUp (CO_Data* d);
    43 
    54 
    44 
    55 
    45 #endif /* __nmtSlave_h__ */
    56 #endif /* __nmtSlave_h__ */