fsm_master.h File Reference

EtherCAT master state machine. More...

Go to the source code of this file.

Data Structures
struct	ec_sii_write_request_t
	SII write request. More...
struct	ec_fsm_master
	Finite state machine of an EtherCAT master. More...

Typedefs
typedef struct ec_fsm_master	ec_fsm_master_t

Functions
void	ec_fsm_master_init (ec_fsm_master_t *, ec_master_t *, ec_datagram_t *)
	Constructor.
void	ec_fsm_master_clear (ec_fsm_master_t *)
	Destructor.
void	ec_fsm_master_reset (ec_fsm_master_t *)
	Reset state machine.
int	ec_fsm_master_exec (ec_fsm_master_t *)
	Executes the current state of the state machine.
int	ec_fsm_master_idle (const ec_fsm_master_t *)

Detailed Description

EtherCAT master state machine.

Definition in file fsm_master.h.

Typedef Documentation

ec_fsm_master_t

typedef struct ec_fsm_master ec_fsm_master_t

See also

ec_fsm_master

Definition at line 56 of file fsm_master.h.

Function Documentation

ec_fsm_master_init()

void ec_fsm_master_init	(	ec_fsm_master_t *	fsm,
		ec_master_t *	master,
		ec_datagram_t *	datagram )

Constructor.

Parameters

fsm	Master state machine.
master	EtherCAT master.
datagram	Datagram object to use.

Definition at line 82 of file fsm_master.c.

ec_fsm_master_clear()

void ec_fsm_master_clear

(

ec_fsm_master_t *

fsm

)

Destructor.

Parameters

fsm	Master state machine.

Definition at line 123 of file fsm_master.c.

ec_fsm_master_reset()

void ec_fsm_master_reset

(

ec_fsm_master_t *

fsm

)

Reset state machine.

Parameters

fsm	Master state machine.

Definition at line 144 of file fsm_master.c.

ec_fsm_master_exec()

int ec_fsm_master_exec

(

ec_fsm_master_t *

fsm

)

Executes the current state of the state machine.

If the state machine's datagram is not sent or received yet, the execution of the state machine is delayed to the next cycle.

Returns

true, if the state machine was executed

Parameters

fsm	Master state machine.

Definition at line 173 of file fsm_master.c.

ec_fsm_master_idle()

int ec_fsm_master_idle

(

const ec_fsm_master_t *

fsm

)

Returns

true, if the state machine is in an idle phase

Parameters

fsm	Master state machine.

Definition at line 192 of file fsm_master.c.