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

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

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/**

    28

   \file

    29

   EtherCAT state change FSM.

    30

*/

    31

    32

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

    33

    34

#ifndef __EC_FSM_CHANGE_H__

    35

#define __EC_FSM_CHANGE_H__

    36

    37

#include "globals.h"

    38

#include "datagram.h"

    39

#include "slave.h"

    40

    41

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

    42

    43

/**

    44

   Mode of the change state machine.

    45

*/

    46

    47

typedef enum {

    48

    EC_FSM_CHANGE_MODE_FULL, /**< full state change */

    49

    EC_FSM_CHANGE_MODE_ACK_ONLY /**< only state acknowledgement */

    50

}

    51

ec_fsm_change_mode_t;

    52

    53

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

    54

    55

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

    56

    57

/**

    58

   EtherCAT state change FSM.

    59

*/

    60

    61

struct ec_fsm_change

    62

{

    63

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

    64

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

    65

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

    66

    67

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

    68

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

    69

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

    70

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

    71

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

    72

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

    73

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

    74

};

    75

    76

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

    77

    78

void ec_fsm_change_init(ec_fsm_change_t *, ec_datagram_t *);

    79

void ec_fsm_change_clear(ec_fsm_change_t *);

    80

    81

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

    82

void ec_fsm_change_ack(ec_fsm_change_t *, ec_slave_t *);

    83

    84

int ec_fsm_change_exec(ec_fsm_change_t *);

    85

int ec_fsm_change_success(ec_fsm_change_t *);

    86

    87

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

    88

    89

#endif