/**
********************************************************************************
\file   user/obdal.h

\brief  Header file for object dictionary abstraction layer

This file provides the interface functions and constants for the abstracted
object dictionary access.
*******************************************************************************/

/*------------------------------------------------------------------------------
Copyright (c) 2016, Bernecker+Rainer Industrie-Elektronik Ges.m.b.H. (B&R)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the copyright holders nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
------------------------------------------------------------------------------*/
#ifndef _INC_user_obdal_H_
#define _INC_user_obdal_H_

//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
#include <common/oplkinc.h>

//------------------------------------------------------------------------------
// const defines
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
// typedef
//------------------------------------------------------------------------------
/**
\brief Callback for accessing the user defined object dictionary

This callback is used to access the user defined object dictionary.

\param tObdAlConHdl     Connection handle for user defined OD

\return The function returns a tOplkError error code.
*/
typedef tOplkError (*tObdAlUserObdAccessCb)(tObdAlConHdl*);

//------------------------------------------------------------------------------
// function prototypes
//------------------------------------------------------------------------------
#ifdef __cplusplus
extern "C"
{
#endif

tOplkError obdal_processSdoRead(tSdoObdConHdl* pSdoHdl_p,
                                tCmdLayerObdFinishedCb pfnFinishSdoCb_p);
tOplkError obdal_processSdoWrite(tSdoObdConHdl* pSdoHdl_p,
                                 tCmdLayerObdFinishedCb pfnFinishSdoCb_p);
tOplkError obdal_init(tObdAlUserObdAccessCb pfnUserObdAccess_p);
tOplkError obdal_exit(void);
tOplkError obdal_enableUserObdAccess(BOOL fEnable_p);
tOplkError obdal_finishUserObdAccess(tObdAlConHdl* pUserObdConHdl_p);

#ifdef __cplusplus
}
#endif

#endif /* _INC_user_obdal_H_ */
