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 master state machine.

    30

*/

    31

    32

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

    33

    34

#ifndef __EC_FSM_MASTER_H__

    35

#define __EC_FSM_MASTER_H__

    36

    37

#include "globals.h"

    38

#include "datagram.h"

    39

#include "foe_request.h"

    40

#include "sdo_request.h"

    41

#include "fsm_slave_config.h"

    42

#include "fsm_slave_scan.h"

    43

#include "fsm_pdo.h"

    44

#include "fsm_foe.h"

    45

    46

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

    47

    48

/** SII write request.

    49

 */

    50

typedef struct {

    51

    struct list_head list; /**< List head. */

    52

    ec_slave_t *slave; /**< EtherCAT slave. */

    53

    uint16_t offset; /**< SII word offset. */

    54

    size_t nwords; /**< Number of words. */

    55

    const uint16_t *words; /**< Pointer to the data words. */

    56

    ec_internal_request_state_t state; /**< State of the request. */

    57

} ec_sii_write_request_t;

    58

    59

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

    60

    61

/** Physical memory request.

    62

 */

    63

typedef struct {

    64

    struct list_head list; /**< List head. */

    65

    ec_slave_t *slave; /**< EtherCAT slave. */

    66

    ec_direction_t dir; /**< Direction. */

    67

    uint16_t offset; /**< Physical memory offset. */

    68

    size_t length; /**< Number of bytes. */

    69

    uint8_t *data; /**< Data to write / memory for read data. */

    70

    ec_internal_request_state_t state; /**< State of the request. */

    71

} ec_phy_request_t;

    72

    73

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

    74

    75

/** Slave/SDO request record for master's SDO request list.

    76

 */

    77

typedef struct {

    78

    struct list_head list; /**< List element. */

    79

    ec_slave_t *slave; /**< Slave. */

    80

    ec_sdo_request_t req; /**< SDO request. */

    81

} ec_master_sdo_request_t;

    82

    83

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

    84

    85

/** FoE write request.

    86

 */

    87

typedef struct {

    88

    struct list_head list; /**< List head. */

    89

    ec_slave_t *slave; /**< EtherCAT slave. */

    90

    ec_foe_request_t req; /**< FoE request. */

    91

} ec_master_foe_request_t;

    92

    93

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

    94

    95

typedef struct ec_fsm_master ec_fsm_master_t; /**< \see ec_fsm_master */

    96

    97

/** Finite state machine of an EtherCAT master.

    98

 */

    99

struct ec_fsm_master {

   100

    ec_master_t *master; /**< master the FSM runs on */

   101

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

   102

    unsigned int retries; /**< retries on datagram timeout. */

   103

   104

    void (*state)(ec_fsm_master_t *); /**< master state function */

   105

    int idle; /**< state machine is in idle phase */

   106

    unsigned long scan_jiffies; /**< beginning of slave scanning */

   107

    unsigned int slaves_responding; /**< number of responding slaves */

   108

    unsigned int topology_change_pending; /**< bus topology changed */

   109

    ec_slave_state_t slave_states; /**< states of responding slaves */

   110

    ec_slave_t *slave; /**< current slave */

   111

    ec_sii_write_request_t *sii_request; /**< SII write request */

   112

    off_t sii_index; /**< index to SII write request data */

   113

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

   114

    ec_phy_request_t *phy_request; /**< Physical memory request to process. */

   115

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

   116

    off_t foe_index; /**< index to FoE write request data */

   117

   118

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

   119

    ec_fsm_pdo_t fsm_pdo; /**< PDO configuration state machine. */

   120

    ec_fsm_change_t fsm_change; /**< State change state machine */

   121

    ec_fsm_slave_config_t fsm_slave_config; /**< slave state machine */

   122

    ec_fsm_slave_scan_t fsm_slave_scan; /**< slave state machine */

   123

    ec_fsm_sii_t fsm_sii; /**< SII state machine */

   124

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

   125

};

   126

   127

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

   128

   129

void ec_fsm_master_init(ec_fsm_master_t *, ec_master_t *, ec_datagram_t *);

   130

void ec_fsm_master_clear(ec_fsm_master_t *);

   131

   132

void ec_fsm_master_exec(ec_fsm_master_t *);

   133

int ec_fsm_master_idle(const ec_fsm_master_t *);

   134

   135

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

   136

   137

#endif