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 "sdo_request.h"

    40

#include "fsm_slave_config.h"

    41

#include "fsm_slave_scan.h"

    42

#include "fsm_pdo.h"

    43

    44

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

    45

    46

/** SII write request.

    47

 */

    48

typedef struct {

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

} ec_sii_write_request_t;

    56

    57

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

    58

    59

/** Physical memory request.

    60

 */

    61

typedef struct {

    62

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

    63

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

    64

    ec_direction_t dir; /**< Direction. */

    65

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

    66

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

    67

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

    68

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

    69

} ec_phy_request_t;

    70

    71

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

    72

    73

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

    74

 */

    75

typedef struct {

    76

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

    77

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

    78

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

    79

} ec_master_sdo_request_t;

    80

    81

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

    82

    83

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

    84

    85

/** Finite state machine of an EtherCAT master.

    86

 */

    87

struct ec_fsm_master {

    88

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

    89

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

    90

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

    91

    92

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

    93

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

    94

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

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

   104

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

   105

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

   106

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

   107

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

   108

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

   109

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

   110

};

   111

   112

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

   113

   114

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

   115

void ec_fsm_master_clear(ec_fsm_master_t *);

   116

   117

void ec_fsm_master_exec(ec_fsm_master_t *);

   118

int ec_fsm_master_idle(const ec_fsm_master_t *);

   119

   120

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

   121

   122

#endif