fsm_sii.h File Reference

EtherCAT slave information interface FSM structure. More...

Go to the source code of this file.

Data Structures
struct	ec_fsm_sii
	Slave information interface FSM. More...

Typedefs
typedef struct ec_fsm_sii	ec_fsm_sii_t

Enumerations
enum	ec_fsm_sii_addressing_t { EC_FSM_SII_USE_INCREMENT_ADDRESS , EC_FSM_SII_USE_CONFIGURED_ADDRESS }
	SII access addressing mode. More...

Functions
void	ec_fsm_sii_init (ec_fsm_sii_t *, ec_datagram_t *)
	Constructor.
void	ec_fsm_sii_clear (ec_fsm_sii_t *)
	Destructor.
void	ec_fsm_sii_read (ec_fsm_sii_t *, ec_slave_t *, uint16_t, ec_fsm_sii_addressing_t)
	Initializes the SII read state machine.
void	ec_fsm_sii_write (ec_fsm_sii_t *, ec_slave_t *, uint16_t, const uint16_t *, ec_fsm_sii_addressing_t)
	Initializes the SII write state machine.
int	ec_fsm_sii_exec (ec_fsm_sii_t *)
	Executes the SII state machine.
int	ec_fsm_sii_success (ec_fsm_sii_t *)
	Returns, if the master startup state machine terminated with success.

Detailed Description

EtherCAT slave information interface FSM structure.

Definition in file fsm_sii.h.

Typedef Documentation

ec_fsm_sii_t

typedef struct ec_fsm_sii ec_fsm_sii_t

See also

ec_fsm_sii

Definition at line 47 of file fsm_sii.h.

Enumeration Type Documentation

ec_fsm_sii_addressing_t

enum ec_fsm_sii_addressing_t

SII access addressing mode.

Enumerator
EC_FSM_SII_USE_INCREMENT_ADDRESS	Use auto-increment addressing.
EC_FSM_SII_USE_CONFIGURED_ADDRESS	Use configured addresses.

Definition at line 40 of file fsm_sii.h.

Function Documentation

ec_fsm_sii_init()

void ec_fsm_sii_init	(	ec_fsm_sii_t *	fsm,
		ec_datagram_t *	datagram )

Constructor.

Parameters

fsm	finite state machine
datagram	datagram structure to use

Definition at line 66 of file fsm_sii.c.

ec_fsm_sii_clear()

void ec_fsm_sii_clear

(

ec_fsm_sii_t *

fsm

)

Destructor.

Parameters

fsm	finite state machine

Definition at line 80 of file fsm_sii.c.

ec_fsm_sii_read()

void ec_fsm_sii_read	(	ec_fsm_sii_t *	fsm,
		ec_slave_t *	slave,
		uint16_t	word_offset,
		ec_fsm_sii_addressing_t	mode )

Initializes the SII read state machine.

Parameters

fsm	finite state machine
slave	slave to read from
word_offset	offset to read from
mode	addressing scheme

Definition at line 90 of file fsm_sii.c.

ec_fsm_sii_write()

void ec_fsm_sii_write	(	ec_fsm_sii_t *	fsm,
		ec_slave_t *	slave,
		uint16_t	word_offset,
		const uint16_t *	value,
		ec_fsm_sii_addressing_t	mode )

Initializes the SII write state machine.

Parameters

fsm	finite state machine
slave	slave to read from
word_offset	offset to read from
value	pointer to 2 bytes of data
mode	addressing scheme

Definition at line 108 of file fsm_sii.c.

ec_fsm_sii_exec()

int ec_fsm_sii_exec

(

ec_fsm_sii_t *

fsm

)

Executes the SII state machine.

Returns

false, if the state machine has terminated

Parameters

fsm	finite state machine

Definition at line 129 of file fsm_sii.c.

ec_fsm_sii_success()

int ec_fsm_sii_success

(

ec_fsm_sii_t *

fsm

)

Returns, if the master startup state machine terminated with success.

Returns

non-zero if successful.

Parameters

fsm	Finite state machine

Definition at line 144 of file fsm_sii.c.