1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

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

    20

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

    21

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

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT master state machine.

    37

*/

    38

    39

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

    40

    41

#ifndef __EC_FSM_MASTER_H__

    42

#define __EC_FSM_MASTER_H__

    43

    44

#include "globals.h"

    45

#include "datagram.h"

    46

#include "sdo_request.h"

    47

#include "fsm_slave_config.h"

    48

#include "fsm_slave_scan.h"

    49

#include "fsm_pdo.h"

    50

    51

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

    52

    53

/** SII write request.

    54

 */

    55

typedef struct {

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

} ec_sii_write_request_t;

    63

    64

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

    65

    66

/** Physical memory request.

    67

 */

    68

typedef struct {

    69

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

    70

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

    71

    ec_direction_t dir; /**< Direction. */

    72

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

    73

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

    74

    uint8_t *data;

    75

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

    76

} ec_phy_request_t;

    77

    78

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

    79

    80

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

    81

 */

    82

typedef struct {

    83

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

    84

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

    85

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

    86

} ec_master_sdo_request_t;

    87

    88

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

    89

    90

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

    91

    92

/** Finite state machine of an EtherCAT master.

    93

 */

    94

struct ec_fsm_master {

    95

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

    96

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

    97

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

    98

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

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

   109

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

   110

   111

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

   112

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

   113

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

   114

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

   115

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

   116

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

   117

};

   118

   119

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

   120

   121

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

   122

void ec_fsm_master_clear(ec_fsm_master_t *);

   123

   124

void ec_fsm_master_exec(ec_fsm_master_t *);

   125

int ec_fsm_master_idle(const ec_fsm_master_t *);

   126

   127

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

   128

   129

#endif