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 domain structure.

    37

*/

    38

    39

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

    40

    41

#ifndef _EC_DOMAIN_H_

    42

#define _EC_DOMAIN_H_

    43

    44

#include <linux/list.h>

    45

#include <linux/kobject.h>

    46

    47

#include "globals.h"

    48

#include "slave.h"

    49

#include "datagram.h"

    50

    51

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

    52

    53

/**

    54

   Data field registration type.

    55

*/

    56

    57

typedef struct

    58

{

    59

    struct list_head list; /**< list item */

    60

    ec_slave_t *slave; /**< slave */

    61

    const ec_sync_t *sync; /**< sync manager */

    62

    uint32_t field_offset; /**< data field offset */

    63

    void **data_ptr; /**< pointer to process data pointer(s) */

    64

}

    65

ec_field_reg_t;

    66

    67

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

    68

    69

/**

    70

   EtherCAT domain.

    71

   Handles the process data and the therefore needed datagrams of a certain

    72

   group of slaves.

    73

*/

    74

    75

struct ec_domain

    76

{

    77

    struct kobject kobj; /**< kobject */

    78

    struct list_head list; /**< list item */

    79

    unsigned int index; /**< domain index (just a number) */

    80

    ec_master_t *master; /**< EtherCAT master owning the domain */

    81

    size_t data_size; /**< size of the process data */

    82

    struct list_head datagrams; /**< process data datagrams */

    83

    uint32_t base_address; /**< logical offset address of the process data */

    84

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

    85

    struct list_head field_regs; /**< data field registrations */

    86

};

    87

    88

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

    89

    90

int ec_domain_init(ec_domain_t *, ec_master_t *, unsigned int);

    91

void ec_domain_clear(struct kobject *);

    92

int ec_domain_alloc(ec_domain_t *, uint32_t);

    93

    94

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

    95

    96

#endif