1

/******************************************************************************

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

 *  The IgH EtherCAT Master 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 General

    16

 *  Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License along

    19

 *  with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

 *****************************************************************************/

    29

    30

/**

    31

   \file

    32

   EtherCAT state change FSM.

    33

*/

    34

    35

/*****************************************************************************/

    36

    37

#ifndef __EC_FSM_CHANGE_H__

    38

#define __EC_FSM_CHANGE_H__

    39

    40

#include "globals.h"

    41

#include "datagram.h"

    42

#include "slave.h"

    43

    44

/*****************************************************************************/

    45

    46

/**

    47

   Mode of the change state machine.

    48

*/

    49

    50

typedef enum {

    51

    EC_FSM_CHANGE_MODE_FULL, /**< full state change */

    52

    EC_FSM_CHANGE_MODE_ACK_ONLY /**< only state acknowledgement */

    53

}

    54

ec_fsm_change_mode_t;

    55

    56

/*****************************************************************************/

    57

    58

typedef struct ec_fsm_change ec_fsm_change_t; /**< \see ec_fsm_change */

    59

    60

/**

    61

   EtherCAT state change FSM.

    62

*/

    63

    64

struct ec_fsm_change

    65

{

    66

    ec_slave_t *slave; /**< slave the FSM runs on */

    67

    ec_datagram_t *datagram; /**< datagram used in the state machine */

    68

    unsigned int retries; /**< retries upon datagram timeout */

    69

    70

    void (*state)(ec_fsm_change_t *); /**< slave state change state function */

    71

    ec_fsm_change_mode_t mode; /**< full state change, or ack only. */

    72

    ec_slave_state_t requested_state; /**< input: state */

    73

    ec_slave_state_t old_state; /**< prior slave state */

    74

    unsigned long jiffies_start; /**< change timer */

    75

    uint8_t take_time; /**< take sending timestamp */

    76

    uint8_t spontaneous_change; /**< spontaneous state change detected */

    77

};

    78

    79

/*****************************************************************************/

    80

    81

void ec_fsm_change_init(ec_fsm_change_t *, ec_datagram_t *);

    82

void ec_fsm_change_clear(ec_fsm_change_t *);

    83

    84

void ec_fsm_change_start(ec_fsm_change_t *, ec_slave_t *, ec_slave_state_t);

    85

void ec_fsm_change_ack(ec_fsm_change_t *, ec_slave_t *);

    86

    87

int ec_fsm_change_exec(ec_fsm_change_t *);

    88

int ec_fsm_change_success(ec_fsm_change_t *);

    89

    90

/*****************************************************************************/

    91

    92

#endif