ethercatfoe.c File Reference

File over EtherCAT (FoE) module. More...

#include <stdio.h>
#include <string.h>
#include "ethercat_soem/osal.h"
#include "ethercat_soem/oshw.h"
#include "ethercat_soem/ethercattype.h"
#include "ethercat_soem/ethercatbase.h"
#include "ethercat_soem/ethercatmain.h"
#include "ethercat_soem/ethercatfoe.h"

Include dependency graph for ethercatfoe.c:

Go to the source code of this file.

Classes
struct	PACKED
Defines
#define	EC_MAXFOEDATA   512
Typedefs
typedef PACKED_BEGIN struct PACKED	ec_FOEt
Functions
PACKED_END int	ecx_FOEdefinehook (ecx_contextt *context, void *hook)
int	ecx_FOEread (ecx_contextt *context, uint16 slave, char *filename, uint32 password, int *psize, void *p, int timeout)
int	ecx_FOEwrite (ecx_contextt *context, uint16 slave, char *filename, uint32 password, int psize, void *p, int timeout)

---

Detailed Description

File over EtherCAT (FoE) module.

SDO read / write and SDO service functions

Definition in file ethercatfoe.c.

---

Define Documentation

#define EC_MAXFOEDATA   512

Definition at line 59 of file ethercatfoe.c.

---

Typedef Documentation

typedef PACKED_BEGIN struct PACKED ec_FOEt

FOE structure. Used for Read, Write, Data, Ack and Error mailbox packets.

---

Function Documentation

PACKED_END int ecx_FOEdefinehook	(	ecx_contextt *	context,
		void *	hook
	)

FoE progress hook.

Parameters:

[in]	context	= context struct
[in]	hook	= Pointer to hook function.

Returns:

1

Definition at line 91 of file ethercatfoe.c.

int ecx_FOEread	(	ecx_contextt *	context,
		uint16	slave,
		char *	filename,
		uint32	password,
		int *	psize,
		void *	p,
		int	timeout
	)

FoE read, blocking.

Parameters:

[in]	context	= context struct
[in]	slave	= Slave number.
[in]	filename	= Filename of file to read.
[in]	password	= password.
[in,out]	psize	= Size in bytes of file buffer, returns bytes read from file.
[out]	p	= Pointer to file buffer
[in]	timeout	= Timeout per mailbox cycle in us, standard is EC_TIMEOUTRXM

Returns:

Workcounter from last slave response

Definition at line 108 of file ethercatfoe.c.

int ecx_FOEwrite	(	ecx_contextt *	context,
		uint16	slave,
		char *	filename,
		uint32	password,
		int	psize,
		void *	p,
		int	timeout
	)

FoE write, blocking.

Parameters:

[in]	context	= context struct
[in]	slave	= Slave number.
[in]	filename	= Filename of file to write.
[in]	password	= password.
[in]	psize	= Size in bytes of file buffer.
[out]	p	= Pointer to file buffer
[in]	timeout	= Timeout per mailbox cycle in us, standard is EC_TIMEOUTRXM

Returns:

Workcounter from last slave response

Definition at line 236 of file ethercatfoe.c.