1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2012  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 slave request state machine.

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_FSM_SLAVE_H__

    38

#define __EC_FSM_SLAVE_H__

    39

    40

#include "globals.h"

    41

#include "datagram.h"

    42

#include "sdo_request.h"

    43

#include "reg_request.h"

    44

#include "fsm_coe.h"

    45

#include "fsm_foe.h"

    46

#include "fsm_soe.h"

    47

    48

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

    49

    50

typedef struct ec_fsm_slave ec_fsm_slave_t; /**< \see ec_fsm_slave */

    51

    52

/** Finite state machine of an EtherCAT slave.

    53

 */

    54

struct ec_fsm_slave {

    55

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

    56

    struct list_head list; /**< Used for execution list. */

    57

    58

    void (*state)(ec_fsm_slave_t *, ec_datagram_t *); /**< State function. */

    59

    ec_datagram_t *datagram; /**< Previous state datagram. */

    60

    ec_sdo_request_t *sdo_request; /**< SDO request to process. */

    61

    ec_reg_request_t *reg_request; /**< Register request to process. */

    62

    ec_foe_request_t *foe_request; /**< FoE request to process. */

    63

    off_t foe_index; /**< Index to FoE write request data. */

    64

    ec_soe_request_t *soe_request; /**< SoE request to process. */

    65

    66

    ec_fsm_coe_t fsm_coe; /**< CoE state machine. */

    67

    ec_fsm_foe_t fsm_foe; /**< FoE state machine. */

    68

    ec_fsm_soe_t fsm_soe; /**< SoE state machine. */

    69

};

    70

    71

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

    72

    73

void ec_fsm_slave_init(ec_fsm_slave_t *, ec_slave_t *);

    74

void ec_fsm_slave_clear(ec_fsm_slave_t *);

    75

    76

int ec_fsm_slave_exec(ec_fsm_slave_t *, ec_datagram_t *);

    77

void ec_fsm_slave_set_ready(ec_fsm_slave_t *);

    78

int ec_fsm_slave_is_ready(const ec_fsm_slave_t *);

    79

    80

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

    81

    82

    83

#endif // __EC_FSM_SLAVE_H__