Application Callbacks

To use the full potential of EtherNet/IP the stack allows you to interact at several stages of the protocol. For example you may receive a callback after new assembly data has arrived.

The stack calls the callback handler registered via the function goal_eipNew(). The callback handler returns a GOAL_STATUS_T value.

Table: parameters of the callback handler

The callback parameter is an array of unions that has up to 10 elements.

/****************************************************************************/
/** EtherNet/IP Callback Handler
 *
 * This function collects all callbacks from the stack and decides if the
 * callback must be handled.
 */
GOAL_STATUS_T main_eipCallback(
    GOAL_EIP_T *pHdlEip,                        /**< PROFINET handle */
    GOAL_EIP_CB_ID_T id,                        /**< callback id */
    GOAL_EIP_CB_DATA_T *pCb                     /**< callback parameters */
)
{
    GOAL_STATUS_T res = GOAL_OK;                /* result */

    switch (id) {
        case GOAL_EIP_CB_ID_INIT:
            /* initialize application resources */
            break;

        /* ... */
    }

    return res;
}

GOAL_EIP_CB_ID_INIT

The stack was initialized. The application can initialize its resources.

Parameter

<none>

Return Value

• GOAL_OK - success

• other - fail

GOAL_EIP_CB_ID_READY

Initialization is done.

Parameter

<none>

Return Value

<ignored>

GOAL_EIP_CB_ID_CONNECT_EVENT

Inform the application about a connection event

Parameter

Table: callback parameters of GOAL_EIP_CB_ID_CONNECT_EVENT

Return Value

<ignored>

GOAL_EIP_CB_ID_ASSEMBLY_DATA_RECV

New data for an assembly has been received.

Parameter

Table: callback parameters of GOAL_EIP_CB_ID_ASSEMBLY_DATA_RECV

Return Value

• GOAL_OK - success

• other - fail

GOAL_EIP_CB_ID_ASSEMBLY_DATA_SEND

Inform application that data of an assembly will be sent.

Parameter

Table: callback parameters of GOAL_EIP_CB_ID_ASSEMBLY_DATA_SEND

Return Value

• GOAL_OK - data has changed

• other - data has not changed

GOAL_EIP_CB_ID_RUN_IDLE_CHANGED

Inform application that the Run/Idle header of consumed cyclic data has changed.

Parameter

Table: callback parameters of GOAL_EIP_CB_ID_RUN_IDLE_CHANGED

Return Value

<ignored>

GOAL_EIP_CB_ID_LED_CHANGED

Inform the application that a Module Status or Network Status LED must be changed. The parameter contains a bitmap made out of GOAL_EIP_LED_* macros. If a bit is set the corresponding LED must be set. Otherwise it must be cleared.

Parameter

Table: callback parameters of GOAL_EIP_CB_ID_LED_CHANGED

Return Value

<ignored>

GOAL_EIP_CB_ID_DEVICE_RESET

Inform the application that the device will be reset. Depending on the platform the device is either reset or the reset is only simulated. Therefore the application must reinitialize its resources. The callback parameter indicates the reset type.

Parameter

Table: callback parameters of GOAL_EIP_CB_ID_LED_CHANGED

Return Value

<ignored>

GOAL_EIP_CB_ID_REVISION_CHECK

If the compatibility bit is set in the Electronic Key Segment the application can decide whether a Minor Revision is supported or not. This means the application can decide if it is stil compatible to a previous revision of itself.

Parameter

Table: callback parameters of GOAL_EIP_CB_ID_REVISION_CHECK

Return Value

• GOAL_OK Revision is supported

• other Revision is not supported