1

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

     2

 *

     3

 *  t y p e s . h

     4

 *

     5

 *  EtherCAT slave types.

     6

 *

     7

 *  $Id$

     8

 *

     9

 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

    10

 *

    11

 *  This file is part of the IgH EtherCAT Master.

    12

 *

    13

 *  The IgH EtherCAT Master is free software; you can redistribute it

    14

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

    15

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

    16

 *

    17

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

    18

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

    19

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

 *  GNU General Public License for more details.

    21

 *

    22

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

    23

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

    24

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

    25

 *

    26

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

    27

    28

#ifndef _EC_TYPES_H_

    29

#define _EC_TYPES_H_

    30

    31

#include <linux/types.h>

    32

    33

#include "../include/ecrt.h"

    34

    35

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

    36

    37

#define EC_MAX_FIELDS 10

    38

#define EC_MAX_SYNC   16

    39

    40

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

    41

    42

/**

    43

   Special slaves.

    44

   \ingroup Slave

    45

*/

    46

    47

typedef enum

    48

{

    49

    EC_TYPE_NORMAL, /**< no special slave */

    50

    EC_TYPE_BUS_COUPLER, /**< slave is a bus coupler */

    51

    EC_TYPE_EOE /**< slave is an EoE switch */

    52

}

    53

ec_special_type_t;

    54

    55

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

    56

    57

/**

    58

   Process data field.

    59

   \ingroup Slave

    60

*/

    61

    62

typedef struct

    63

{

    64

    const char *name; /**< field name */

    65

    size_t size; /**< field size in bytes */

    66

}

    67

ec_field_t;

    68

    69

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

    70

    71

/**

    72

   Sync-Manager.

    73

   \ingroup Slave

    74

*/

    75

    76

typedef struct

    77

{

    78

    uint16_t physical_start_address; /**< physical start address */

    79

    uint16_t size; /**< size in bytes */

    80

    uint8_t control_byte; /**< control register value */

    81

    const ec_field_t *fields[EC_MAX_FIELDS]; /**< field array */

    82

}

    83

ec_sync_t;

    84

    85

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

    86

    87

/**

    88

   Slave description type.

    89

   \ingroup Slave

    90

*/

    91

    92

typedef struct ec_slave_type

    93

{

    94

    const char *vendor_name; /**< vendor name*/

    95

    const char *product_name; /**< product name */

    96

    const char *description; /**< free description */

    97

    ec_special_type_t special; /**< special slave type? */

    98

    const ec_sync_t *sync_managers[EC_MAX_SYNC]; /**< sync managers */

    99

}

   100

ec_slave_type_t;

   101

   102

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

   103

   104

/**

   105

   Slave type identification.

   106

   \ingroup Slave

   107

*/

   108

   109

typedef struct

   110

{

   111

    uint32_t vendor_id; /**< vendor id */

   112

    uint32_t product_code; /**< product code */

   113

    const ec_slave_type_t *type; /**< associated slave description object */

   114

}

   115

ec_slave_ident_t;

   116

   117

extern ec_slave_ident_t slave_idents[]; /**< array with slave descriptions */

   118

   119

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

   120

   121

#endif