1

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

     2

 *

     3

 *  c o m m a n d . h

     4

 *

     5

 *  EtherCAT command structure.

     6

 *

     7

 *  $Id$

     8

 *

     9

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

    10

    11

#ifndef _EC_COMMAND_H_

    12

#define _EC_COMMAND_H_

    13

    14

#include <linux/list.h>

    15

    16

#include "globals.h"

    17

    18

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

    19

    20

/**

    21

   EtherCAT command type.

    22

*/

    23

    24

typedef enum

    25

{

    26

    EC_CMD_NONE = 0x00, /**< Dummy */

    27

    EC_CMD_APRD = 0x01, /**< Auto-increment physical read */

    28

    EC_CMD_APWR = 0x02, /**< Auto-increment physical write */

    29

    EC_CMD_NPRD = 0x04, /**< Node-addressed physical read */

    30

    EC_CMD_NPWR = 0x05, /**< Node-addressed physical write */

    31

    EC_CMD_BRD  = 0x07, /**< Broadcast read */

    32

    EC_CMD_BWR  = 0x08, /**< Broadcast write */

    33

    EC_CMD_LRW  = 0x0C  /**< Logical read/write */

    34

}

    35

ec_command_type_t;

    36

    37

/**

    38

   EtherCAT command state.

    39

*/

    40

    41

typedef enum

    42

{

    43

    EC_CMD_INIT, /**< new command */

    44

    EC_CMD_QUEUED, /**< command queued by master */

    45

    EC_CMD_SENT, /**< command has been sent */

    46

    EC_CMD_RECEIVED, /**< command has been received */

    47

    EC_CMD_TIMEOUT, /**< command timed out */

    48

    EC_CMD_ERROR /**< error while sending/receiving */

    49

}

    50

ec_command_state_t;

    51

    52

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

    53

    54

/**

    55

   EtherCAT address.

    56

*/

    57

    58

typedef union

    59

{

    60

    struct

    61

    {

    62

        uint16_t slave; /**< configured or autoincrement address */

    63

        uint16_t mem; /**< physical memory address */

    64

    }

    65

    physical; /**< physical address */

    66

    67

    uint32_t logical; /**< logical address */

    68

}

    69

ec_address_t;

    70

    71

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

    72

    73

/**

    74

   EtherCAT command

    75

*/

    76

    77

typedef struct

    78

{

    79

    struct list_head list; /**< needed by domain command lists */

    80

    struct list_head queue; /**< master command queue item */

    81

    ec_command_type_t type; /**< command type (APRD, BWR, etc) */

    82

    ec_address_t address; /**< receipient address */

    83

    uint8_t *data; /**< command data */

    84

    size_t mem_size; /**< command \a data memory size */

    85

    size_t data_size; /**< size of the data in \a data */

    86

    uint8_t index; /**< command index (set by master) */

    87

    uint16_t working_counter; /**< working counter */

    88

    ec_command_state_t state; /**< command state */

    89

}

    90

ec_command_t;

    91

    92

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

    93

    94

void ec_command_init(ec_command_t *);

    95

void ec_command_clear(ec_command_t *);

    96

    97

int ec_command_nprd(ec_command_t *, uint16_t, uint16_t, size_t);

    98

int ec_command_npwr(ec_command_t *, uint16_t, uint16_t, size_t);

    99

int ec_command_aprd(ec_command_t *, uint16_t, uint16_t, size_t);

   100

int ec_command_apwr(ec_command_t *, uint16_t, uint16_t, size_t);

   101

int ec_command_brd(ec_command_t *, uint16_t, size_t);

   102

int ec_command_bwr(ec_command_t *, uint16_t, size_t);

   103

int ec_command_lrw(ec_command_t *, uint32_t, size_t);

   104

   105

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

   106

   107

#endif