|
1 /****************************************************************************** |
|
2 * |
|
3 * $Id:$ |
|
4 * |
|
5 * Copyright (C) 2008 Olav Zarges, imc Meßsysteme 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 |
|
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 FoE request structure. |
|
37 */ |
|
38 |
|
39 /*****************************************************************************/ |
|
40 |
|
41 #ifndef __EC_FOE_REQUEST_H__ |
|
42 #define __EC_FOE_REQUEST_H__ |
|
43 |
|
44 #include <linux/list.h> |
|
45 |
|
46 #include "../include/ecrt.h" |
|
47 |
|
48 #include "globals.h" |
|
49 |
|
50 /*****************************************************************************/ |
|
51 |
|
52 /** FoE request. |
|
53 */ |
|
54 typedef struct { |
|
55 uint8_t *buffer; /**< Pointer to FoE data. */ |
|
56 size_t buffer_size; /**< Size of FoE data memory. */ |
|
57 size_t data_size; /**< Size of FoE data. */ |
|
58 |
|
59 uint32_t issue_timeout; /**< Maximum time in ms, the processing of the |
|
60 request may take. */ |
|
61 uint32_t response_timeout; /**< Maximum time in ms, the transfer is |
|
62 retried, if the slave does not respond. */ |
|
63 ec_direction_t dir; /**< Direction. EC_DIR_OUTPUT means downloading to |
|
64 the slave, EC_DIR_INPUT means uploading from the |
|
65 slave. */ |
|
66 ec_request_state_t state; /**< FoE request state. */ |
|
67 unsigned long jiffies_start; /**< Jiffies, when the request was issued. */ |
|
68 unsigned long jiffies_sent; /**< Jiffies, when the upload/download |
|
69 request was sent. */ |
|
70 uint8_t *file_name; /**< Pointer to the filename. */ |
|
71 uint32_t abort_code; /**< FoE request abort code. Zero on success. */ |
|
72 } ec_foe_request_t; |
|
73 |
|
74 /*****************************************************************************/ |
|
75 |
|
76 void ec_foe_request_init(ec_foe_request_t *, uint8_t* file_name); |
|
77 void ec_foe_request_clear(ec_foe_request_t *); |
|
78 |
|
79 void ec_foe_request_address(ec_foe_request_t *, uint16_t, uint8_t); |
|
80 int ec_foe_request_alloc(ec_foe_request_t *, size_t); |
|
81 int ec_foe_request_copy_data(ec_foe_request_t *, const uint8_t *, size_t); |
|
82 int ec_foe_request_timed_out(const ec_foe_request_t *); |
|
83 |
|
84 void ec_foe_request_write(ec_foe_request_t *); |
|
85 void ec_foe_request_read(ec_foe_request_t *); |
|
86 |
|
87 /*****************************************************************************/ |
|
88 |
|
89 #endif |