include/states.h
author frdupin
Wed, 13 Dec 2006 14:14:18 +0100
changeset 53 73bc47a0db55
parent 0 4472ee7c6c3e
child 71 95cd3376cc9f
permissions -rw-r--r--
Add prototypes
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 __states_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    24
#define __states_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    25
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    26
#include <applicfg.h>
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    27
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    28
///The nodes states 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    29
//-----------------
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    30
/// values are choosen so, that they can be sent directly
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    31
/// for heartbeat messages...
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    32
/// Must be coded on 7 bits only
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    33
/* Should not be modified */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    34
enum enum_nodeState {
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    35
  Initialisation  = 0x00, 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    36
  Disconnected    = 0x01,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    37
  Connecting      = 0x02,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    38
  Preparing       = 0x02,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    39
  Stopped         = 0x04,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    40
  Operational     = 0x05,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    41
  Pre_operational = 0x7F,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    42
  Unknown_state   = 0x0F
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    43
};
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    44
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    45
typedef enum enum_nodeState e_nodeState;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    46
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    47
typedef struct
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    48
{
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    49
	UNS8 csBoot_Up;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    50
	UNS8 csSDO;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    51
	UNS8 csEmergency;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    52
	UNS8 csSYNC;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    53
	UNS8 csHeartbeat;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    54
	UNS8 csPDO;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    55
} s_state_communication;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    56
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    57
/** Function that user app must provide
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    58
 * 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    59
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    60
typedef void (*initialisation_t)(void);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    61
typedef void (*preOperational_t)(void);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    62
typedef void (*operational_t)(void);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    63
typedef void (*stopped_t)(void);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    64
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    65
#include "data.h"
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    66
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    67
/************************* prototypes ******************************/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    68
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    69
/** Called by driver/app when receiving messages
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    70
*/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    71
void canDispatch(CO_Data* d, Message *m);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    72
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    73
/** Returns the state of the node 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    74
*/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    75
e_nodeState getState (CO_Data* d);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    76
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    77
/** Change the state of the node 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    78
*/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    79
UNS8 setState (CO_Data* d, e_nodeState newState);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    80
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    81
/** Returns the nodId 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    82
*/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    83
UNS8 getNodeId (CO_Data* d);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    84
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    85
/** Define the node ID. Initialize the object dictionary
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    86
*/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    87
void setNodeId (CO_Data* d, UNS8 nodeId);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    88
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    89
/** Some stuff to do when the node enter in reset mode
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    90
 *
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    91
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    92
//void initResetMode (CO_Data* d);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    93
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    94
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    95
/** Some stuff to do when the node enter in pre-operational mode
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    96
 *
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    97
 */
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    98
void initPreOperationalMode (CO_Data* d);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    99
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
   100
#endif