fsm_pdo_entry.h File Reference

EtherCAT PDO entry configuration state machine structures. More...

Go to the source code of this file.

Data Structures
struct	ec_fsm_pdo_entry
	PDO configuration state machine. More...

Typedefs
typedef struct ec_fsm_pdo_entry	ec_fsm_pdo_entry_t

Functions
void	ec_fsm_pdo_entry_init (ec_fsm_pdo_entry_t *, ec_fsm_coe_t *)
	Constructor.
void	ec_fsm_pdo_entry_clear (ec_fsm_pdo_entry_t *)
	Destructor.
void	ec_fsm_pdo_entry_start_reading (ec_fsm_pdo_entry_t *, ec_slave_t *, ec_pdo_t *)
	Start reading a PDO's entries.
void	ec_fsm_pdo_entry_start_configuration (ec_fsm_pdo_entry_t *, ec_slave_t *, const ec_pdo_t *, const ec_pdo_t *)
	Start PDO mapping state machine.
int	ec_fsm_pdo_entry_exec (ec_fsm_pdo_entry_t *, ec_datagram_t *)
	Executes the current state.
int	ec_fsm_pdo_entry_success (const ec_fsm_pdo_entry_t *)
	Get execution result.

Detailed Description

EtherCAT PDO entry configuration state machine structures.

Definition in file fsm_pdo_entry.h.

Typedef Documentation

ec_fsm_pdo_entry_t

typedef struct ec_fsm_pdo_entry ec_fsm_pdo_entry_t

See also

ec_fsm_pdo_entry

Definition at line 40 of file fsm_pdo_entry.h.

Function Documentation

ec_fsm_pdo_entry_init()

void ec_fsm_pdo_entry_init	(	ec_fsm_pdo_entry_t *	fsm,
		ec_fsm_coe_t *	fsm_coe )

Constructor.

Parameters

fsm	PDO mapping state machine.
fsm_coe	CoE state machine to use.

Definition at line 68 of file fsm_pdo_entry.c.

ec_fsm_pdo_entry_clear()

void ec_fsm_pdo_entry_clear

(

ec_fsm_pdo_entry_t *

fsm

)

Destructor.

Parameters

fsm	PDO mapping state machine.

Definition at line 81 of file fsm_pdo_entry.c.

ec_fsm_pdo_entry_start_reading()

void ec_fsm_pdo_entry_start_reading	(	ec_fsm_pdo_entry_t *	fsm,
		ec_slave_t *	slave,
		ec_pdo_t *	pdo )

Start reading a PDO's entries.

Parameters

fsm	PDO mapping state machine.
slave	Slave to configure.
pdo	PDO to read entries for.

Definition at line 107 of file fsm_pdo_entry.c.

ec_fsm_pdo_entry_start_configuration()

void ec_fsm_pdo_entry_start_configuration	(	ec_fsm_pdo_entry_t *	fsm,
		ec_slave_t *	slave,
		const ec_pdo_t *	pdo,
		const ec_pdo_t *	cur_pdo )

Start PDO mapping state machine.

Parameters

fsm	PDO mapping state machine.
slave	Slave to configure.
pdo	PDO with the desired entries.
cur_pdo	Current PDO mapping.

Definition at line 125 of file fsm_pdo_entry.c.

ec_fsm_pdo_entry_exec()

int ec_fsm_pdo_entry_exec	(	ec_fsm_pdo_entry_t *	fsm,
		ec_datagram_t *	datagram )

Executes the current state.

Returns

false, if state machine has terminated

Parameters

fsm	PDO mapping state machine.
datagram	Datagram to use.

Definition at line 165 of file fsm_pdo_entry.c.

ec_fsm_pdo_entry_success()

int ec_fsm_pdo_entry_success

(

const ec_fsm_pdo_entry_t *

fsm

)

Get execution result.

Returns

true, if the state machine terminated gracefully

Parameters

fsm	PDO mapping state machine.

Definition at line 181 of file fsm_pdo_entry.c.