1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2008  Olav Zarges, imc Messsysteme GmbH

     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

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/**

    31

   \file

    32

   EtherCAT FoE request structure.

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_FOE_REQUEST_H__

    38

#define __EC_FOE_REQUEST_H__

    39

    40

#include <linux/list.h>

    41

    42

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

    43

    44

#include "globals.h"

    45

    46

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

    47

    48

/** FoE request.

    49

 */

    50

typedef struct {

    51

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

    52

    uint8_t *buffer; /**< Pointer to FoE data. */

    53

    size_t buffer_size; /**< Size of FoE data memory. */

    54

    size_t data_size; /**< Size of FoE data. */

    55

    56

    uint32_t issue_timeout; /**< Maximum time in ms, the processing of the

    57

                              request may take. */

    58

    uint32_t response_timeout; /**< Maximum time in ms, the transfer is

    59

                                 retried, if the slave does not respond. */

    60

    ec_direction_t dir; /**< Direction. EC_DIR_OUTPUT means downloading to

    61

                          the slave, EC_DIR_INPUT means uploading from the

    62

                          slave. */

    63

    ec_internal_request_state_t state; /**< FoE request state. */

    64

    unsigned long jiffies_start; /**< Jiffies, when the request was issued. */

    65

    unsigned long jiffies_sent; /**< Jiffies, when the upload/download

    66

                                     request was sent. */

    67

    uint8_t *file_name; /**< Pointer to the filename. */

    68

    uint32_t result; /**< FoE request abort code. Zero on success. */

    69

    uint32_t error_code; /**< Error code from an FoE Error Request. */

    70

} ec_foe_request_t;

    71

    72

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

    73

    74

void ec_foe_request_init(ec_foe_request_t *, uint8_t *file_name);

    75

void ec_foe_request_clear(ec_foe_request_t *);

    76

    77

int ec_foe_request_alloc(ec_foe_request_t *, size_t);

    78

int ec_foe_request_copy_data(ec_foe_request_t *, const uint8_t *, size_t);

    79

int ec_foe_request_timed_out(const ec_foe_request_t *);

    80

    81

void ec_foe_request_write(ec_foe_request_t *);

    82

void ec_foe_request_read(ec_foe_request_t *);

    83

    84

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

    85

    86

#endif