fsm_eoe.c File Reference

EtherCAT EoE state machines. More...

Go to the source code of this file.

Macros
#define	EC_EOE_RESPONSE_TIMEOUT   3000
	Maximum time to wait for a set IP parameter response.

Functions
void	memcpy_swap32 (void *dst, const void *src)
	Host-architecture-independent 32-bit swap function.
int	ec_fsm_eoe_prepare_set (ec_fsm_eoe_t *fsm, ec_datagram_t *datagram)
	Prepare a set IP parameters operation.
void	ec_fsm_eoe_set_ip_start (ec_fsm_eoe_t *fsm, ec_datagram_t *datagram)
	EoE state: SET IP START.
void	ec_fsm_eoe_set_ip_request (ec_fsm_eoe_t *fsm, ec_datagram_t *datagram)
	EoE state: SET IP REQUEST.
void	ec_fsm_eoe_set_ip_check (ec_fsm_eoe_t *fsm, ec_datagram_t *datagram)
	EoE state: SET IP CHECK.
void	ec_fsm_eoe_set_ip_response (ec_fsm_eoe_t *fsm, ec_datagram_t *datagram)
	EoE state: SET IP RESPONSE.
void	ec_fsm_eoe_end (ec_fsm_eoe_t *fsm, ec_datagram_t *datagram)
	State: END.
void	ec_fsm_eoe_error (ec_fsm_eoe_t *fsm, ec_datagram_t *datagram)
	State: ERROR.
void	ec_fsm_eoe_init (ec_fsm_eoe_t *fsm)
	Constructor.
void	ec_fsm_eoe_clear (ec_fsm_eoe_t *fsm)
	Destructor.
void	ec_fsm_eoe_set_ip_param (ec_fsm_eoe_t *fsm, ec_slave_t *slave, ec_eoe_request_t *request)
	Starts to set the EoE IP partameters of a slave.
int	ec_fsm_eoe_exec (ec_fsm_eoe_t *fsm, ec_datagram_t *datagram)
	Executes the current state of the state machine.
int	ec_fsm_eoe_success (const ec_fsm_eoe_t *fsm)
	Returns, if the state machine terminated with success.

Detailed Description

EtherCAT EoE state machines.

Definition in file fsm_eoe.c.

Macro Definition Documentation

EC_EOE_RESPONSE_TIMEOUT

#define EC_EOE_RESPONSE_TIMEOUT   3000

Maximum time to wait for a set IP parameter response.

Definition at line 38 of file fsm_eoe.c.

Function Documentation

memcpy_swap32()

void memcpy_swap32	(	void *	dst,
		const void *	src )

Host-architecture-independent 32-bit swap function.

The internal storage of struct in_addr is always big-endian. The mailbox protocol format to supply IPv4 adresses is little-endian (Yuck!). So we need a swap function, that is independent of the CPU architecture. ntohl()/htonl() can not be used, because they evaluate to NOPs if the host architecture matches the target architecture!

Definition at line 65 of file fsm_eoe.c.

ec_fsm_eoe_prepare_set()

int ec_fsm_eoe_prepare_set	(	ec_fsm_eoe_t *	fsm,
		ec_datagram_t *	datagram )

Prepare a set IP parameters operation.

Returns

0 on success, otherwise a negative error code.

Parameters

fsm	finite state machine
datagram	Datagram to use.

Definition at line 169 of file fsm_eoe.c.

ec_fsm_eoe_set_ip_start()

void ec_fsm_eoe_set_ip_start	(	ec_fsm_eoe_t *	fsm,
		ec_datagram_t *	datagram )

EoE state: SET IP START.

Parameters

fsm	finite state machine
datagram	Datagram to use.

Definition at line 262 of file fsm_eoe.c.

ec_fsm_eoe_set_ip_request()

void ec_fsm_eoe_set_ip_request	(	ec_fsm_eoe_t *	fsm,
		ec_datagram_t *	datagram )

EoE state: SET IP REQUEST.

Parameters

fsm	finite state machine
datagram	Datagram to use.

Definition at line 290 of file fsm_eoe.c.

ec_fsm_eoe_set_ip_check()

void ec_fsm_eoe_set_ip_check	(	ec_fsm_eoe_t *	fsm,
		ec_datagram_t *	datagram )

EoE state: SET IP CHECK.

Parameters

fsm	finite state machine
datagram	Datagram to use.

Definition at line 343 of file fsm_eoe.c.

ec_fsm_eoe_set_ip_response()

void ec_fsm_eoe_set_ip_response	(	ec_fsm_eoe_t *	fsm,
		ec_datagram_t *	datagram )

EoE state: SET IP RESPONSE.

Parameters

fsm	finite state machine
datagram	Datagram to use.

Definition at line 396 of file fsm_eoe.c.

ec_fsm_eoe_end()

void ec_fsm_eoe_end	(	ec_fsm_eoe_t *	fsm,
		ec_datagram_t *	datagram )

State: END.

Parameters

fsm	finite state machine
datagram	Datagram to use.

Definition at line 502 of file fsm_eoe.c.

ec_fsm_eoe_error()

void ec_fsm_eoe_error	(	ec_fsm_eoe_t *	fsm,
		ec_datagram_t *	datagram )

State: ERROR.

Parameters

fsm	finite state machine
datagram	Datagram to use.

Definition at line 491 of file fsm_eoe.c.

ec_fsm_eoe_init()

void ec_fsm_eoe_init

(

ec_fsm_eoe_t *

fsm

)

Constructor.

Parameters

fsm	finite state machine

Definition at line 77 of file fsm_eoe.c.

ec_fsm_eoe_clear()

void ec_fsm_eoe_clear

(

ec_fsm_eoe_t *

fsm

)

Destructor.

Parameters

fsm	finite state machine

Definition at line 94 of file fsm_eoe.c.

ec_fsm_eoe_set_ip_param()

void ec_fsm_eoe_set_ip_param	(	ec_fsm_eoe_t *	fsm,
		ec_slave_t *	slave,
		ec_eoe_request_t *	request )

Starts to set the EoE IP partameters of a slave.

Parameters

fsm	State machine.
slave	EtherCAT slave.
request	EoE request.

Definition at line 104 of file fsm_eoe.c.

ec_fsm_eoe_exec()

int ec_fsm_eoe_exec	(	ec_fsm_eoe_t *	fsm,
		ec_datagram_t *	datagram )

Executes the current state of the state machine.

Returns

1 if the datagram was used, else 0.

Parameters

fsm	finite state machine
datagram	Datagram to use.

Definition at line 121 of file fsm_eoe.c.

ec_fsm_eoe_success()

int ec_fsm_eoe_success

(

const ec_fsm_eoe_t *

fsm

)

Returns, if the state machine terminated with success.

Returns

non-zero if successful.

Parameters

fsm	Finite state machine

Definition at line 156 of file fsm_eoe.c.