DeviceApi.h

/**************************************************************************************************
**  Copyright (c) 2013 by Enclustra, Switzerland
**  All rights reserved.
**************************************************************************************************/

#ifndef _DeviceApi_h
#define _DeviceApi_h

#include "DllImportExport.h"
#include "MmAccessApi.h"
#include "StreamApi.h"

typedef void* DeviceHandle;

//*************************************************************************
// Construct / Destruct
//*************************************************************************
FPGAMANAGER_DLL_FCT EN_RESULT DeviceApi_Delete(DeviceHandle* const handle_p);

FPGAMANAGER_DLL_FCT EN_RESULT DeviceApi_Create( DeviceHandle* const handle_p,
                                                                                                const char* url,
                                                                                                const en_uint8 streams);
FPGAMANAGER_DLL_FCT DeviceHandle DeviceApi_CreateObj(   const char* url,
                                                                                                                const en_uint8 streams,
                                                                                                                EN_RESULT* const retVal_p);

//*************************************************************************
// Methods
//*************************************************************************
FPGAMANAGER_DLL_FCT EN_RESULT DeviceApi_Open(   DeviceHandle const handle);

FPGAMANAGER_DLL_FCT EN_RESULT DeviceApi_Close(  DeviceHandle const handle,
                                                                                                const bool forcing);

FPGAMANAGER_DLL_FCT EN_RESULT DeviceApi_CreateMmAccess( DeviceHandle const deviceHandle,
                                                                                                                MmAccessHandle const mmAccessHandle,
                                                                                                                const en_uint8 streamNr);

FPGAMANAGER_DLL_FCT EN_RESULT DeviceApi_CreateStream(   DeviceHandle const deviceHandle,
                                                                                                                StreamHandle const streamHandle,
                                                                                                                const en_uint8 streamNr,
                                                                                                                const bool frameBased,
                                                                                                                const bool upStreamEna,
                                                                                                                const bool downStreamEna);

FPGAMANAGER_DLL_FCT EN_RESULT DeviceApi_SetProperty(    DeviceHandle const deviceHandle,
                                                                                                                const char* const name,
                                                                                                                const en_uint32 value);
FPGAMANAGER_DLL_FCT EN_RESULT DeviceApi_GetProperty(    DeviceHandle const deviceHandle,
                                                                                                                const char* const name,
                                                                                                                en_uint32* const value_p);

#endif