| author | Florian Pose <fp@igh-essen.com> |
| Mon, 23 Oct 2006 14:00:58 +0000 | |
| changeset 435 | 779a18d12e6c |
| parent 433 | 100f51f28cf2 |
| child 505 | bc443ca0077f |
| permissions | -rw-r--r-- |
| 433 | 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 |
/** |
|
35 |
\file |
|
36 |
EtherCAT slave information interface FSM. |
|
37 |
*/ |
|
38 |
||
39 |
/*****************************************************************************/ |
|
40 |
||
41 |
#include "globals.h" |
|
42 |
#include "mailbox.h" |
|
43 |
#include "master.h" |
|
44 |
#include "fsm_sii.h" |
|
45 |
||
46 |
/*****************************************************************************/ |
|
47 |
||
48 |
void ec_fsm_sii_start_reading(ec_fsm_sii_t *); |
|
49 |
void ec_fsm_sii_read_check(ec_fsm_sii_t *); |
|
50 |
void ec_fsm_sii_read_fetch(ec_fsm_sii_t *); |
|
51 |
void ec_fsm_sii_start_writing(ec_fsm_sii_t *); |
|
52 |
void ec_fsm_sii_write_check(ec_fsm_sii_t *); |
|
53 |
void ec_fsm_sii_write_check2(ec_fsm_sii_t *); |
|
54 |
void ec_fsm_sii_end(ec_fsm_sii_t *); |
|
55 |
void ec_fsm_sii_error(ec_fsm_sii_t *); |
|
56 |
||
57 |
/*****************************************************************************/ |
|
58 |
||
59 |
/** |
|
60 |
Constructor. |
|
61 |
*/ |
|
62 |
||
63 |
void ec_fsm_sii_init(ec_fsm_sii_t *fsm, /**< finite state machine */ |
|
64 |
ec_datagram_t *datagram /**< datagram structure to use */ |
|
65 |
) |
|
66 |
{
|
|
67 |
fsm->state = NULL; |
|
68 |
fsm->datagram = datagram; |
|
69 |
} |
|
70 |
||
71 |
/*****************************************************************************/ |
|
72 |
||
73 |
/** |
|
74 |
Destructor. |
|
75 |
*/ |
|
76 |
||
77 |
void ec_fsm_sii_clear(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
78 |
{
|
|
79 |
} |
|
80 |
||
81 |
/*****************************************************************************/ |
|
82 |
||
83 |
/** |
|
84 |
Initializes the SII read state machine. |
|
85 |
*/ |
|
86 |
||
87 |
void ec_fsm_sii_read(ec_fsm_sii_t *fsm, /**< finite state machine */ |
|
88 |
ec_slave_t *slave, /**< slave to read from */ |
|
89 |
uint16_t offset, /**< offset to read from */ |
|
90 |
ec_fsm_sii_addressing_t mode /**< addressing scheme */ |
|
91 |
) |
|
92 |
{
|
|
93 |
fsm->state = ec_fsm_sii_start_reading; |
|
94 |
fsm->slave = slave; |
|
95 |
fsm->offset = offset; |
|
96 |
fsm->mode = mode; |
|
97 |
} |
|
98 |
||
99 |
/*****************************************************************************/ |
|
100 |
||
101 |
/** |
|
102 |
Initializes the SII write state machine. |
|
103 |
*/ |
|
104 |
||
105 |
void ec_fsm_sii_write(ec_fsm_sii_t *fsm, /**< finite state machine */ |
|
106 |
ec_slave_t *slave, /**< slave to read from */ |
|
107 |
uint16_t offset, /**< offset to read from */ |
|
108 |
uint16_t *value, /**< pointer to 2 bytes of data */ |
|
109 |
ec_fsm_sii_addressing_t mode /**< addressing scheme */ |
|
110 |
) |
|
111 |
{
|
|
112 |
fsm->state = ec_fsm_sii_start_writing; |
|
113 |
fsm->slave = slave; |
|
114 |
fsm->offset = offset; |
|
115 |
fsm->mode = mode; |
|
116 |
memcpy(fsm->value, value, 2); |
|
117 |
} |
|
118 |
||
119 |
/*****************************************************************************/ |
|
120 |
||
121 |
/** |
|
122 |
Executes the SII state machine. |
|
|
435
779a18d12e6c
Removed state machine running() methods.
Florian Pose <fp@igh-essen.com>
parents:
433
diff
changeset
|
123 |
\return false, if the state machine has terminated |
|
779a18d12e6c
Removed state machine running() methods.
Florian Pose <fp@igh-essen.com>
parents:
433
diff
changeset
|
124 |
*/ |
|
779a18d12e6c
Removed state machine running() methods.
Florian Pose <fp@igh-essen.com>
parents:
433
diff
changeset
|
125 |
|
|
779a18d12e6c
Removed state machine running() methods.
Florian Pose <fp@igh-essen.com>
parents:
433
diff
changeset
|
126 |
int ec_fsm_sii_exec(ec_fsm_sii_t *fsm /**< finite state machine */) |
| 433 | 127 |
{
|
128 |
fsm->state(fsm); |
|
|
435
779a18d12e6c
Removed state machine running() methods.
Florian Pose <fp@igh-essen.com>
parents:
433
diff
changeset
|
129 |
|
| 433 | 130 |
return fsm->state != ec_fsm_sii_end && fsm->state != ec_fsm_sii_error; |
131 |
} |
|
132 |
||
133 |
/*****************************************************************************/ |
|
134 |
||
135 |
/** |
|
136 |
Returns, if the master startup state machine terminated with success. |
|
137 |
\return non-zero if successful. |
|
138 |
*/ |
|
139 |
||
140 |
int ec_fsm_sii_success(ec_fsm_sii_t *fsm /**< Finite state machine */) |
|
141 |
{
|
|
142 |
return fsm->state == ec_fsm_sii_end; |
|
143 |
} |
|
144 |
||
145 |
/****************************************************************************** |
|
146 |
* SII state machine |
|
147 |
*****************************************************************************/ |
|
148 |
||
149 |
/** |
|
150 |
SII state: START READING. |
|
151 |
Starts reading the slave information interface. |
|
152 |
*/ |
|
153 |
||
154 |
void ec_fsm_sii_start_reading(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
155 |
{
|
|
156 |
ec_datagram_t *datagram = fsm->datagram; |
|
157 |
||
158 |
// initiate read operation |
|
159 |
switch (fsm->mode) {
|
|
160 |
case EC_FSM_SII_POSITION: |
|
161 |
ec_datagram_apwr(datagram, fsm->slave->ring_position, 0x502, 4); |
|
162 |
break; |
|
163 |
case EC_FSM_SII_NODE: |
|
164 |
ec_datagram_npwr(datagram, fsm->slave->station_address, 0x502, 4); |
|
165 |
break; |
|
166 |
} |
|
167 |
||
168 |
EC_WRITE_U8 (datagram->data, 0x00); // read-only access |
|
169 |
EC_WRITE_U8 (datagram->data + 1, 0x01); // request read operation |
|
170 |
EC_WRITE_U16(datagram->data + 2, fsm->offset); |
|
171 |
ec_master_queue_datagram(fsm->slave->master, datagram); |
|
172 |
fsm->state = ec_fsm_sii_read_check; |
|
173 |
} |
|
174 |
||
175 |
/*****************************************************************************/ |
|
176 |
||
177 |
/** |
|
178 |
SII state: READ CHECK. |
|
179 |
Checks, if the SII-read-datagram has been sent and issues a fetch datagram. |
|
180 |
*/ |
|
181 |
||
182 |
void ec_fsm_sii_read_check(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
183 |
{
|
|
184 |
ec_datagram_t *datagram = fsm->datagram; |
|
185 |
||
186 |
if (datagram->state != EC_DATAGRAM_RECEIVED |
|
187 |
|| datagram->working_counter != 1) {
|
|
188 |
EC_ERR("SII: Reception of read datagram failed.\n");
|
|
189 |
fsm->state = ec_fsm_sii_error; |
|
190 |
return; |
|
191 |
} |
|
192 |
||
193 |
fsm->cycles_start = datagram->cycles_sent; |
|
194 |
fsm->check_once_more = 1; |
|
195 |
||
196 |
// issue check/fetch datagram |
|
197 |
switch (fsm->mode) {
|
|
198 |
case EC_FSM_SII_POSITION: |
|
199 |
ec_datagram_aprd(datagram, fsm->slave->ring_position, 0x502, 10); |
|
200 |
break; |
|
201 |
case EC_FSM_SII_NODE: |
|
202 |
ec_datagram_nprd(datagram, fsm->slave->station_address, 0x502, 10); |
|
203 |
break; |
|
204 |
} |
|
205 |
ec_master_queue_datagram(fsm->slave->master, datagram); |
|
206 |
fsm->state = ec_fsm_sii_read_fetch; |
|
207 |
} |
|
208 |
||
209 |
/*****************************************************************************/ |
|
210 |
||
211 |
/** |
|
212 |
SII state: READ FETCH. |
|
213 |
Fetches the result of an SII-read datagram. |
|
214 |
*/ |
|
215 |
||
216 |
void ec_fsm_sii_read_fetch(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
217 |
{
|
|
218 |
ec_datagram_t *datagram = fsm->datagram; |
|
219 |
||
220 |
if (datagram->state != EC_DATAGRAM_RECEIVED |
|
221 |
|| datagram->working_counter != 1) {
|
|
222 |
EC_ERR("SII: Reception of check/fetch datagram failed.\n");
|
|
223 |
fsm->state = ec_fsm_sii_error; |
|
224 |
return; |
|
225 |
} |
|
226 |
||
227 |
// check "busy bit" |
|
228 |
if (EC_READ_U8(datagram->data + 1) & 0x81) {
|
|
229 |
// still busy... timeout? |
|
230 |
if (datagram->cycles_received |
|
231 |
- fsm->cycles_start >= (cycles_t) 10 * cpu_khz) {
|
|
232 |
if (!fsm->check_once_more) {
|
|
233 |
EC_ERR("SII: Read timeout.\n");
|
|
234 |
fsm->state = ec_fsm_sii_error; |
|
235 |
#if 0 |
|
236 |
EC_DBG("SII busy: %02X %02X %02X %02X\n",
|
|
237 |
EC_READ_U8(datagram->data + 0), |
|
238 |
EC_READ_U8(datagram->data + 1), |
|
239 |
EC_READ_U8(datagram->data + 2), |
|
240 |
EC_READ_U8(datagram->data + 3)); |
|
241 |
#endif |
|
242 |
return; |
|
243 |
} |
|
244 |
fsm->check_once_more = 0; |
|
245 |
} |
|
246 |
||
247 |
// issue check/fetch datagram again |
|
248 |
switch (fsm->mode) {
|
|
249 |
case EC_FSM_SII_POSITION: |
|
250 |
ec_datagram_aprd(datagram, fsm->slave->ring_position, 0x502, 10); |
|
251 |
break; |
|
252 |
case EC_FSM_SII_NODE: |
|
253 |
ec_datagram_nprd(datagram, fsm->slave->station_address, 0x502, 10); |
|
254 |
break; |
|
255 |
} |
|
256 |
ec_master_queue_datagram(fsm->slave->master, datagram); |
|
257 |
return; |
|
258 |
} |
|
259 |
||
260 |
#if 0 |
|
261 |
EC_DBG("SII rec: %02X %02X %02X %02X - %02X %02X %02X %02X\n",
|
|
262 |
EC_READ_U8(datagram->data + 0), EC_READ_U8(datagram->data + 1), |
|
263 |
EC_READ_U8(datagram->data + 2), EC_READ_U8(datagram->data + 3), |
|
264 |
EC_READ_U8(datagram->data + 6), EC_READ_U8(datagram->data + 7), |
|
265 |
EC_READ_U8(datagram->data + 8), EC_READ_U8(datagram->data + 9)); |
|
266 |
#endif |
|
267 |
||
268 |
// SII value received. |
|
269 |
memcpy(fsm->value, datagram->data + 6, 4); |
|
270 |
fsm->state = ec_fsm_sii_end; |
|
271 |
} |
|
272 |
||
273 |
/*****************************************************************************/ |
|
274 |
||
275 |
/** |
|
276 |
SII state: START WRITING. |
|
277 |
Starts reading the slave information interface. |
|
278 |
*/ |
|
279 |
||
280 |
void ec_fsm_sii_start_writing(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
281 |
{
|
|
282 |
ec_datagram_t *datagram = fsm->datagram; |
|
283 |
||
284 |
// initiate write operation |
|
285 |
ec_datagram_npwr(datagram, fsm->slave->station_address, 0x502, 8); |
|
286 |
EC_WRITE_U8 (datagram->data, 0x01); // enable write access |
|
287 |
EC_WRITE_U8 (datagram->data + 1, 0x02); // request write operation |
|
288 |
EC_WRITE_U32(datagram->data + 2, fsm->offset); |
|
289 |
memcpy(datagram->data + 6, fsm->value, 2); |
|
290 |
ec_master_queue_datagram(fsm->slave->master, datagram); |
|
291 |
fsm->state = ec_fsm_sii_write_check; |
|
292 |
} |
|
293 |
||
294 |
/*****************************************************************************/ |
|
295 |
||
296 |
/** |
|
297 |
SII state: WRITE CHECK. |
|
298 |
*/ |
|
299 |
||
300 |
void ec_fsm_sii_write_check(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
301 |
{
|
|
302 |
ec_datagram_t *datagram = fsm->datagram; |
|
303 |
||
304 |
if (datagram->state != EC_DATAGRAM_RECEIVED |
|
305 |
|| datagram->working_counter != 1) {
|
|
306 |
EC_ERR("SII: Reception of write datagram failed.\n");
|
|
307 |
fsm->state = ec_fsm_sii_error; |
|
308 |
return; |
|
309 |
} |
|
310 |
||
311 |
fsm->cycles_start = datagram->cycles_sent; |
|
312 |
fsm->check_once_more = 1; |
|
313 |
||
314 |
// issue check/fetch datagram |
|
315 |
ec_datagram_nprd(datagram, fsm->slave->station_address, 0x502, 2); |
|
316 |
ec_master_queue_datagram(fsm->slave->master, datagram); |
|
317 |
fsm->state = ec_fsm_sii_write_check2; |
|
318 |
} |
|
319 |
||
320 |
/*****************************************************************************/ |
|
321 |
||
322 |
/** |
|
323 |
SII state: WRITE CHECK 2. |
|
324 |
*/ |
|
325 |
||
326 |
void ec_fsm_sii_write_check2(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
327 |
{
|
|
328 |
ec_datagram_t *datagram = fsm->datagram; |
|
329 |
||
330 |
if (datagram->state != EC_DATAGRAM_RECEIVED |
|
331 |
|| datagram->working_counter != 1) {
|
|
332 |
EC_ERR("SII: Reception of write check datagram failed.\n");
|
|
333 |
fsm->state = ec_fsm_sii_error; |
|
334 |
return; |
|
335 |
} |
|
336 |
||
337 |
if (EC_READ_U8(datagram->data + 1) & 0x82) {
|
|
338 |
// still busy... timeout? |
|
339 |
if (datagram->cycles_received |
|
340 |
- fsm->cycles_start >= (cycles_t) 10 * cpu_khz) {
|
|
341 |
if (!fsm->check_once_more) {
|
|
342 |
EC_ERR("SII: Write timeout.\n");
|
|
343 |
fsm->state = ec_fsm_sii_error; |
|
344 |
return; |
|
345 |
} |
|
346 |
fsm->check_once_more = 0; |
|
347 |
} |
|
348 |
||
349 |
// issue check/fetch datagram again |
|
350 |
ec_master_queue_datagram(fsm->slave->master, datagram); |
|
351 |
return; |
|
352 |
} |
|
353 |
||
354 |
if (EC_READ_U8(datagram->data + 1) & 0x40) {
|
|
355 |
EC_ERR("SII: Write operation failed!\n");
|
|
356 |
fsm->state = ec_fsm_sii_error; |
|
357 |
return; |
|
358 |
} |
|
359 |
||
360 |
// success |
|
361 |
fsm->state = ec_fsm_sii_end; |
|
362 |
} |
|
363 |
||
364 |
/*****************************************************************************/ |
|
365 |
||
366 |
/** |
|
367 |
State: ERROR. |
|
368 |
*/ |
|
369 |
||
370 |
void ec_fsm_sii_error(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
371 |
{
|
|
372 |
} |
|
373 |
||
374 |
/*****************************************************************************/ |
|
375 |
||
376 |
/** |
|
377 |
State: END. |
|
378 |
*/ |
|
379 |
||
380 |
void ec_fsm_sii_end(ec_fsm_sii_t *fsm /**< finite state machine */) |
|
381 |
{
|
|
382 |
} |
|
383 |
||
384 |
/*****************************************************************************/ |