| author | Florian Pose <fp@igh-essen.com> |
| Mon, 22 Sep 2008 14:43:40 +0000 | |
| changeset 1216 | e70c4d71cebd |
| parent 1209 | 8be462afb7f4 |
| child 1218 | 6f3a973fc29e |
| permissions | -rw-r--r-- |
| 1209 | 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 |
/** \file |
|
35 |
* Vendor-specific-over-EtherCAT protocol handler functions. |
|
36 |
*/ |
|
37 |
||
38 |
/*****************************************************************************/ |
|
39 |
||
40 |
#include <linux/module.h> |
|
41 |
||
42 |
#include "master.h" |
|
43 |
#include "slave_config.h" |
|
44 |
#include "mailbox.h" |
|
45 |
#include "voe_handler.h" |
|
46 |
||
|
1216
e70c4d71cebd
Changed VoE mailbox type to 0xff.
Florian Pose <fp@igh-essen.com>
parents:
1209
diff
changeset
|
47 |
/** VoE mailbox type. |
|
e70c4d71cebd
Changed VoE mailbox type to 0xff.
Florian Pose <fp@igh-essen.com>
parents:
1209
diff
changeset
|
48 |
*/ |
|
e70c4d71cebd
Changed VoE mailbox type to 0xff.
Florian Pose <fp@igh-essen.com>
parents:
1209
diff
changeset
|
49 |
#define EC_MBOX_TYPE_VOE 0xff |
|
e70c4d71cebd
Changed VoE mailbox type to 0xff.
Florian Pose <fp@igh-essen.com>
parents:
1209
diff
changeset
|
50 |
|
| 1209 | 51 |
/** VoE response timeout in [ms]. |
52 |
*/ |
|
53 |
#define EC_VOE_RESPONSE_TIMEOUT 500 |
|
54 |
||
55 |
/*****************************************************************************/ |
|
56 |
||
57 |
void ec_voe_handler_clear_data(ec_voe_handler_t *); |
|
58 |
||
59 |
void ec_voe_handler_state_write_start(ec_voe_handler_t *); |
|
60 |
void ec_voe_handler_state_write_response(ec_voe_handler_t *); |
|
61 |
||
62 |
void ec_voe_handler_state_read_start(ec_voe_handler_t *); |
|
63 |
void ec_voe_handler_state_read_check(ec_voe_handler_t *); |
|
64 |
void ec_voe_handler_state_read_response(ec_voe_handler_t *); |
|
65 |
||
66 |
void ec_voe_handler_state_end(ec_voe_handler_t *); |
|
67 |
void ec_voe_handler_state_error(ec_voe_handler_t *); |
|
68 |
||
69 |
/*****************************************************************************/ |
|
70 |
||
71 |
/** VoE handler constructor. |
|
72 |
*/ |
|
73 |
int ec_voe_handler_init( |
|
74 |
ec_voe_handler_t *voe, /**< VoE handler. */ |
|
75 |
ec_slave_config_t *sc, /**< Parent slave configuration. */ |
|
76 |
size_t size /**< Size of memory to reserve. */ |
|
77 |
) |
|
78 |
{
|
|
79 |
voe->config = sc; |
|
80 |
voe->data_size = 0; |
|
81 |
voe->dir = EC_DIR_INVALID; |
|
82 |
voe->state = ec_voe_handler_state_error; |
|
83 |
voe->request_state = EC_INT_REQUEST_INIT; |
|
84 |
||
85 |
ec_datagram_init(&voe->datagram); |
|
86 |
if (ec_datagram_prealloc(&voe->datagram, size + 6)) |
|
87 |
return -1; |
|
88 |
||
89 |
return 0; |
|
90 |
} |
|
91 |
||
92 |
/*****************************************************************************/ |
|
93 |
||
94 |
/** VoE handler destructor. |
|
95 |
*/ |
|
96 |
void ec_voe_handler_clear( |
|
97 |
ec_voe_handler_t *voe /**< VoE handler. */ |
|
98 |
) |
|
99 |
{
|
|
100 |
ec_datagram_clear(&voe->datagram); |
|
101 |
} |
|
102 |
||
103 |
/***************************************************************************** |
|
104 |
* Application interface. |
|
105 |
****************************************************************************/ |
|
106 |
||
107 |
uint8_t *ecrt_voe_handler_data(ec_voe_handler_t *voe) |
|
108 |
{
|
|
109 |
return voe->datagram.data + 6; |
|
110 |
} |
|
111 |
||
112 |
/*****************************************************************************/ |
|
113 |
||
114 |
size_t ecrt_voe_handler_data_size(const ec_voe_handler_t *voe) |
|
115 |
{
|
|
116 |
return voe->data_size; |
|
117 |
} |
|
118 |
||
119 |
/*****************************************************************************/ |
|
120 |
||
121 |
void ecrt_voe_handler_read(ec_voe_handler_t *voe) |
|
122 |
{
|
|
123 |
voe->dir = EC_DIR_INPUT; |
|
124 |
voe->state = ec_voe_handler_state_read_start; |
|
125 |
voe->request_state = EC_INT_REQUEST_QUEUED; |
|
126 |
} |
|
127 |
||
128 |
/*****************************************************************************/ |
|
129 |
||
130 |
void ecrt_voe_handler_write(ec_voe_handler_t *voe, size_t size) |
|
131 |
{
|
|
132 |
voe->dir = EC_DIR_OUTPUT; |
|
133 |
voe->datagram.data_size = size + 6; |
|
134 |
voe->state = ec_voe_handler_state_write_start; |
|
135 |
voe->request_state = EC_INT_REQUEST_QUEUED; |
|
136 |
} |
|
137 |
||
138 |
/*****************************************************************************/ |
|
139 |
||
140 |
ec_request_state_t ecrt_voe_handler_execute(ec_voe_handler_t *voe) |
|
141 |
{
|
|
142 |
if (voe->config->slave) {
|
|
143 |
voe->state(voe); |
|
144 |
if (voe->request_state == EC_REQUEST_BUSY) |
|
145 |
ec_master_queue_datagram(voe->config->master, &voe->datagram); |
|
146 |
} else {
|
|
147 |
voe->state = ec_voe_handler_state_error; |
|
148 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
149 |
} |
|
150 |
||
151 |
return ec_request_state_translation_table[voe->request_state]; |
|
152 |
} |
|
153 |
||
154 |
/****************************************************************************** |
|
155 |
* State functions. |
|
156 |
*****************************************************************************/ |
|
157 |
||
158 |
void ec_voe_handler_state_write_start(ec_voe_handler_t *voe) |
|
159 |
{
|
|
160 |
ec_slave_t *slave = voe->config->slave; |
|
161 |
uint8_t *data; |
|
162 |
||
163 |
if (slave->master->debug_level) {
|
|
164 |
EC_DBG("Writing %u bytes of VoE data to slave %u.\n",
|
|
165 |
voe->data_size, slave->ring_position); |
|
166 |
ec_print_data(ecrt_voe_handler_data(voe), voe->data_size); |
|
167 |
} |
|
168 |
||
169 |
if (!(slave->sii.mailbox_protocols & EC_MBOX_VOE)) {
|
|
170 |
EC_ERR("Slave %u does not support VoE!\n", slave->ring_position);
|
|
171 |
voe->state = ec_voe_handler_state_error; |
|
172 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
173 |
return; |
|
174 |
} |
|
175 |
||
|
1216
e70c4d71cebd
Changed VoE mailbox type to 0xff.
Florian Pose <fp@igh-essen.com>
parents:
1209
diff
changeset
|
176 |
if (!(data = ec_slave_mbox_prepare_send(slave, &voe->datagram, |
|
e70c4d71cebd
Changed VoE mailbox type to 0xff.
Florian Pose <fp@igh-essen.com>
parents:
1209
diff
changeset
|
177 |
EC_MBOX_TYPE_VOE, voe->data_size))) {
|
| 1209 | 178 |
voe->state = ec_voe_handler_state_error; |
179 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
180 |
return; |
|
181 |
} |
|
182 |
||
183 |
voe->retries = EC_FSM_RETRIES; |
|
184 |
voe->jiffies_start = jiffies; |
|
185 |
voe->state = ec_voe_handler_state_write_response; |
|
186 |
} |
|
187 |
||
188 |
/*****************************************************************************/ |
|
189 |
||
190 |
void ec_voe_handler_state_write_response(ec_voe_handler_t *voe) |
|
191 |
{
|
|
192 |
ec_datagram_t *datagram = &voe->datagram; |
|
193 |
ec_slave_t *slave = voe->config->slave; |
|
194 |
||
195 |
if (datagram->state == EC_DATAGRAM_TIMED_OUT && voe->retries--) |
|
196 |
return; |
|
197 |
||
198 |
if (datagram->state != EC_DATAGRAM_RECEIVED) {
|
|
199 |
voe->state = ec_voe_handler_state_error; |
|
200 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
201 |
EC_ERR("Failed to receive VoE write request datagram for"
|
|
202 |
" slave %u (datagram state %u).\n", |
|
203 |
slave->ring_position, datagram->state); |
|
204 |
return; |
|
205 |
} |
|
206 |
||
207 |
if (datagram->working_counter != 1) {
|
|
208 |
if (!datagram->working_counter) {
|
|
209 |
unsigned long diff_ms = |
|
210 |
(jiffies - voe->jiffies_start) * 1000 / HZ; |
|
211 |
if (diff_ms < EC_VOE_RESPONSE_TIMEOUT) {
|
|
212 |
if (slave->master->debug_level) {
|
|
213 |
EC_DBG("Slave %u did not respond to VoE write request. "
|
|
214 |
"Retrying after %u ms...\n", |
|
215 |
slave->ring_position, (u32) diff_ms); |
|
216 |
} |
|
217 |
// no response; send request datagram again |
|
218 |
return; |
|
219 |
} |
|
220 |
} |
|
221 |
voe->state = ec_voe_handler_state_error; |
|
222 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
223 |
EC_ERR("Reception of VoE write request failed on slave %u: ",
|
|
224 |
slave->ring_position); |
|
225 |
ec_datagram_print_wc_error(datagram); |
|
226 |
return; |
|
227 |
} |
|
228 |
||
229 |
if (voe->config->master->debug_level) |
|
230 |
EC_DBG("VoE write request successful.\n");
|
|
231 |
||
232 |
voe->request_state = EC_INT_REQUEST_SUCCESS; |
|
233 |
voe->state = ec_voe_handler_state_end; |
|
234 |
} |
|
235 |
||
236 |
/*****************************************************************************/ |
|
237 |
||
238 |
void ec_voe_handler_state_read_start(ec_voe_handler_t *voe) |
|
239 |
{
|
|
240 |
ec_datagram_t *datagram = &voe->datagram; |
|
241 |
ec_slave_t *slave = voe->config->slave; |
|
242 |
||
243 |
if (slave->master->debug_level) |
|
244 |
EC_DBG("Reading VoE data to slave %u.\n", slave->ring_position);
|
|
245 |
||
246 |
if (!(slave->sii.mailbox_protocols & EC_MBOX_VOE)) {
|
|
247 |
EC_ERR("Slave %u does not support VoE!\n", slave->ring_position);
|
|
248 |
voe->state = ec_voe_handler_state_error; |
|
249 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
250 |
return; |
|
251 |
} |
|
252 |
||
253 |
ec_slave_mbox_prepare_check(slave, datagram); // can not fail. |
|
254 |
||
255 |
voe->jiffies_start = jiffies; |
|
256 |
voe->retries = EC_FSM_RETRIES; |
|
257 |
voe->state = ec_voe_handler_state_read_check; |
|
258 |
} |
|
259 |
||
260 |
/*****************************************************************************/ |
|
261 |
||
262 |
void ec_voe_handler_state_read_check(ec_voe_handler_t *voe) |
|
263 |
{
|
|
264 |
ec_datagram_t *datagram = &voe->datagram; |
|
265 |
ec_slave_t *slave = voe->config->slave; |
|
266 |
||
267 |
if (datagram->state == EC_DATAGRAM_TIMED_OUT && voe->retries--) |
|
268 |
return; |
|
269 |
||
270 |
if (datagram->state != EC_DATAGRAM_RECEIVED) {
|
|
271 |
voe->state = ec_voe_handler_state_error; |
|
272 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
273 |
EC_ERR("Failed to receive VoE mailbox check datagram from slave %u"
|
|
274 |
" (datagram state %u).\n", |
|
275 |
slave->ring_position, datagram->state); |
|
276 |
return; |
|
277 |
} |
|
278 |
||
279 |
if (datagram->working_counter != 1) {
|
|
280 |
voe->state = ec_voe_handler_state_error; |
|
281 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
282 |
EC_ERR("Reception of VoE mailbox check"
|
|
283 |
" datagram failed on slave %u: ", slave->ring_position); |
|
284 |
ec_datagram_print_wc_error(datagram); |
|
285 |
return; |
|
286 |
} |
|
287 |
||
288 |
if (!ec_slave_mbox_check(datagram)) {
|
|
289 |
unsigned long diff_ms = |
|
290 |
(datagram->jiffies_received - voe->jiffies_start) * 1000 / HZ; |
|
291 |
if (diff_ms >= EC_VOE_RESPONSE_TIMEOUT) {
|
|
292 |
voe->state = ec_voe_handler_state_error; |
|
293 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
294 |
EC_ERR("Timeout while waiting for VoE data on "
|
|
295 |
"slave %u.\n", slave->ring_position); |
|
296 |
return; |
|
297 |
} |
|
298 |
||
299 |
ec_slave_mbox_prepare_check(slave, datagram); // can not fail. |
|
300 |
voe->retries = EC_FSM_RETRIES; |
|
301 |
return; |
|
302 |
} |
|
303 |
||
304 |
// Fetch response |
|
305 |
ec_slave_mbox_prepare_fetch(slave, datagram); // can not fail. |
|
306 |
voe->retries = EC_FSM_RETRIES; |
|
307 |
voe->state = ec_voe_handler_state_read_response; |
|
308 |
} |
|
309 |
||
310 |
/*****************************************************************************/ |
|
311 |
||
312 |
void ec_voe_handler_state_read_response(ec_voe_handler_t *voe) |
|
313 |
{
|
|
314 |
ec_datagram_t *datagram = &voe->datagram; |
|
315 |
ec_slave_t *slave = voe->config->slave; |
|
316 |
ec_master_t *master = voe->config->master; |
|
317 |
uint8_t *data, mbox_prot; |
|
318 |
size_t rec_size; |
|
319 |
||
320 |
if (datagram->state == EC_DATAGRAM_TIMED_OUT && voe->retries--) |
|
321 |
return; |
|
322 |
||
323 |
if (datagram->state != EC_DATAGRAM_RECEIVED) {
|
|
324 |
voe->state = ec_voe_handler_state_error; |
|
325 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
326 |
EC_ERR("Failed to receive VoE read datagram for"
|
|
327 |
" slave %u (datagram state %u).\n", |
|
328 |
slave->ring_position, datagram->state); |
|
329 |
return; |
|
330 |
} |
|
331 |
||
332 |
if (datagram->working_counter != 1) {
|
|
333 |
voe->state = ec_voe_handler_state_error; |
|
334 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
335 |
EC_ERR("Reception of VoE read response failed on slave %u: ",
|
|
336 |
slave->ring_position); |
|
337 |
ec_datagram_print_wc_error(datagram); |
|
338 |
return; |
|
339 |
} |
|
340 |
||
341 |
if (!(data = ec_slave_mbox_fetch(slave, datagram, |
|
342 |
&mbox_prot, &rec_size))) {
|
|
343 |
voe->state = ec_voe_handler_state_error; |
|
344 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
345 |
return; |
|
346 |
} |
|
347 |
||
|
1216
e70c4d71cebd
Changed VoE mailbox type to 0xff.
Florian Pose <fp@igh-essen.com>
parents:
1209
diff
changeset
|
348 |
if (mbox_prot != EC_MBOX_TYPE_VOE) {
|
| 1209 | 349 |
voe->state = ec_voe_handler_state_error; |
350 |
voe->request_state = EC_INT_REQUEST_FAILURE; |
|
351 |
EC_WARN("Received mailbox protocol 0x%02X as response.\n", mbox_prot);
|
|
352 |
ec_print_data(data, rec_size); |
|
353 |
return; |
|
354 |
} |
|
355 |
||
356 |
if (master->debug_level) {
|
|
357 |
EC_DBG("VoE data:\n");
|
|
358 |
ec_print_data(data, rec_size); |
|
359 |
} |
|
360 |
||
361 |
voe->data_size = rec_size; |
|
362 |
voe->request_state = EC_INT_REQUEST_SUCCESS; |
|
363 |
voe->state = ec_voe_handler_state_end; // success |
|
364 |
} |
|
365 |
||
366 |
/*****************************************************************************/ |
|
367 |
||
368 |
void ec_voe_handler_state_end(ec_voe_handler_t *voe) |
|
369 |
{
|
|
370 |
} |
|
371 |
||
372 |
/*****************************************************************************/ |
|
373 |
||
374 |
void ec_voe_handler_state_error(ec_voe_handler_t *voe) |
|
375 |
{
|
|
376 |
} |
|
377 |
||
378 |
/*****************************************************************************/ |
|
379 |
||
380 |
/** \cond */ |
|
381 |
||
382 |
EXPORT_SYMBOL(ecrt_voe_handler_data); |
|
383 |
EXPORT_SYMBOL(ecrt_voe_handler_data_size); |
|
384 |
EXPORT_SYMBOL(ecrt_voe_handler_read); |
|
385 |
EXPORT_SYMBOL(ecrt_voe_handler_write); |
|
386 |
EXPORT_SYMBOL(ecrt_voe_handler_execute); |
|
387 |
||
388 |
/** \endcond */ |
|
389 |
||
390 |
/*****************************************************************************/ |