IgH EtherCAT Master  1.5.2
fsm_foe.h File Reference

EtherCAT FoE state machines. More...

Go to the source code of this file.

Data Structures

struct  ec_fsm_foe
 Finite state machines for the CANopen-over-EtherCAT protocol. More...
 

Typedefs

typedef struct ec_fsm_foe ec_fsm_foe_t
 

Functions

void ec_fsm_foe_init (ec_fsm_foe_t *)
 Constructor.
 
void ec_fsm_foe_clear (ec_fsm_foe_t *)
 Destructor.
 
int ec_fsm_foe_exec (ec_fsm_foe_t *, ec_datagram_t *)
 Executes the current state of the state machine. More...
 
int ec_fsm_foe_success (const ec_fsm_foe_t *)
 Returns, if the state machine terminated with success. More...
 
void ec_fsm_foe_transfer (ec_fsm_foe_t *, ec_slave_t *, ec_foe_request_t *)
 Prepares an FoE transfer.
 

Detailed Description

EtherCAT FoE state machines.

Definition in file fsm_foe.h.

Typedef Documentation

◆ ec_fsm_foe_t

typedef struct ec_fsm_foe ec_fsm_foe_t
See also
ec_fsm_foe

Definition at line 49 of file fsm_foe.h.

Function Documentation

◆ ec_fsm_foe_exec()

int ec_fsm_foe_exec ( ec_fsm_foe_t fsm,
ec_datagram_t datagram 
)

Executes the current state of the state machine.

Returns
1 if the state machine is still in progress, else 0.
Parameters
fsmfinite state machine
datagramDatagram to use.

Definition at line 127 of file fsm_foe.c.

◆ ec_fsm_foe_success()

int ec_fsm_foe_success ( const ec_fsm_foe_t fsm)

Returns, if the state machine terminated with success.

Returns
non-zero if successful.
Parameters
fsmFinite state machine

Definition at line 151 of file fsm_foe.c.