UM0541

DCP-Application Programming Interface

9/19

3

DCP-Application Programming Interface

3.1

Introduction

This section describes the API (Application Programming Interface) for the DCP protocol.

Following a list of the functions implemented to realize the communication using DCP

protocol:

●

DCP_Register

●

DCP_RegisterErrorHandler

●

DCP_SendFrame

●

DCCallback

●

DCErrorManagement

3.2

API reference

3.2.1

DCP_register

Definition

UINT32 DCP_register( PFN_DCB2 pfnDCB ).

Arguments

pfnDCB [in] a pointer to callback that processes received frames.

Returns

This function returns DCN_SUCCESS on successful completion, DCN_BAD_PARAMETER

if pfnDCB is NULL.

Description

The function DCP_register is used by the user application to register the callback function

defined by the user.

3.2.2

DCP_RegisterErrorHandler

Definition

UINT32 DCP_RegisterErrorHandler( PFN_DEH pfnDEH ).

Arguments

pfnDEH [in] a pointer to function that processes errors.

Returns

This function returns DCN_SUCCESS on successful completion, DCN_BAD_PARAMETER

if pfnDEH is NULL.