Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals | Related Pages
master

mailbox.c File Reference

Detailed Description

Mailbox functionality.

Definition in file mailbox.c.

Go to the source code of this file.

Functions

uint8_t * ec_slave_mbox_prepare_send (const ec_slave_t *slave, ec_datagram_t *datagram, uint8_t type, size_t size)
 Prepares a mailbox-send datagram.
int ec_slave_mbox_prepare_check (const ec_slave_t *slave, ec_datagram_t *datagram)
 Prepares a datagram for checking the mailbox state.
int ec_slave_mbox_check (const ec_datagram_t *datagram)
 Processes a mailbox state checking datagram.
int ec_slave_mbox_prepare_fetch (const ec_slave_t *slave, ec_datagram_t *datagram)
 Prepares a datagram to fetch mailbox data.
uint8_t * ec_slave_mbox_fetch (const ec_slave_t *slave, ec_datagram_t *datagram, uint8_t *type, size_t *size)
 Processes received mailbox data.

Variables

const ec_code_msg_t mbox_error_messages []
 Mailbox error codes.

Function Documentation

uint8_t* ec_slave_mbox_prepare_send (  const ec_slave_t *  slave,
ec_datagram_t *  datagram,
uint8_t  type,
size_t  size
) 
 

Prepares a mailbox-send datagram.

Returns:
pointer to mailbox datagram data
Parameters:
slave  slave
datagram  datagram
type  mailbox protocol
size  size of the data

Definition at line 55 of file mailbox.c.

int ec_slave_mbox_prepare_check (  const ec_slave_t *  slave,
ec_datagram_t *  datagram
) 
 

Prepares a datagram for checking the mailbox state.

Returns:
0 in case of success, else < 0
Parameters:
slave  slave
datagram  datagram

Definition at line 95 of file mailbox.c.

int ec_slave_mbox_check (  const ec_datagram_t *  datagram  ) 
 

Processes a mailbox state checking datagram.

Returns:
0 in case of success, else < 0
Parameters:
datagram  datagram

Definition at line 113 of file mailbox.c.

int ec_slave_mbox_prepare_fetch (  const ec_slave_t *  slave,
ec_datagram_t *  datagram
) 
 

Prepares a datagram to fetch mailbox data.

Returns:
0 in case of success, else < 0
Parameters:
slave  slave
datagram  datagram

Definition at line 125 of file mailbox.c.

uint8_t* ec_slave_mbox_fetch (  const ec_slave_t *  slave,
ec_datagram_t *  datagram,
uint8_t *  type,
size_t *  size
) 
 

Processes received mailbox data.

Returns:
pointer to the received data
Parameters:
slave  slave
datagram  datagram
type  expected mailbox protocol
size  size of the received data

Definition at line 160 of file mailbox.c.

Variable Documentation

const ec_code_msg_t mbox_error_messages[]
 

Initial value:

 {
    {0x00000001, "MBXERR_SYNTAX"},
    {0x00000002, "MBXERR_UNSUPPORTEDPROTOCOL"},
    {0x00000003, "MBXERR_INVAILDCHANNEL"},
    {0x00000004, "MBXERR_SERVICENOTSUPPORTED"},
    {0x00000005, "MBXERR_INVALIDHEADER"},
    {0x00000006, "MBXERR_SIZETOOSHORT"},
    {0x00000007, "MBXERR_NOMOREMEMORY"},
    {0x00000008, "MBXERR_INVALIDSIZE"},
    {}
}
Mailbox error codes.

Definition at line 141 of file mailbox.c.

Generated on Tue Nov 7 15:03:37 2006 for IgH EtherCAT master by  doxygen 1.4.4