mbox_gateway_request.h File Reference

EtherCAT Mailbox Gateway request structure. More...

Go to the source code of this file.

Data Structures
struct	ec_mbg_request_t
	EtherCAT Mailbox Gateway request. More...

Functions
void	ec_mbg_request_init (ec_mbg_request_t *)
	Mbox Gateway request constructor.
void	ec_mbg_request_clear (ec_mbg_request_t *)
	Mbox Gateway request destructor.
int	ec_mbg_request_alloc (ec_mbg_request_t *, size_t)
	Pre-allocates the data memory. More...
int	ec_mbg_request_copy_data (ec_mbg_request_t *, const uint8_t *, size_t)
	Copies Mbox Gateway data from an external source. More...
void	ec_mbg_request_run (ec_mbg_request_t *)
	Request to run.

Detailed Description

EtherCAT Mailbox Gateway request structure.

Definition in file mbox_gateway_request.h.

Function Documentation

ec_mbg_request_alloc()

int ec_mbg_request_alloc	(	ec_mbg_request_t *	req,
		size_t	size
	)

Pre-allocates the data memory.

If the mem_size is already bigger than size, nothing is done.

Returns

0 on success, otherwise -ENOMEM.

Parameters

req	Mbox Gateway request.
size	Data size to allocate.

Definition at line 106 of file mbox_gateway_request.c.

ec_mbg_request_copy_data()

int ec_mbg_request_copy_data	(	ec_mbg_request_t *	req,
		const uint8_t *	source,
		size_t	size
	)

Copies Mbox Gateway data from an external source.

If the mem_size is to small, new memory is allocated.

Return values

0	Success.
<0	Error code.

Parameters

req	Mbox Gateway request.
source	Source data.
size	Number of bytes in source.

Definition at line 135 of file mbox_gateway_request.c.