CLC_Main.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Main.h
// Project:         CopperLan CHAILink Client SDK
// Version:         1.3
// Release Date:    2014/04/15
//*********************************************************

/********************************************************************
Software License Agreement:  CHAILink Client source code

The software supplied herewith by Klavis Technology (the “Company”) is intended and
supplied to you, the Company’s customer, for use solely and exclusively on embedded
CopperLan products needing a CHAILink Client. 
 The software is owned by the Company and/or its supplier, and is protected 
 under applicable copyright laws. All rights are reserved. Any use in violation of the 
 foregoing restrictions may subject the user to criminal sanctions under applicable laws,
as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS, 
 IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF 
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
OF ANY KIND.
********************************************************************/

#ifndef _CLC_MAIN_H_
#define _CLC_MAIN_H_

// MACRO for Transport protocol
#define _CLTP_CLIENTMODE

#include "CLC_CustomizationVerif.h"
#include "CLCm_Defines.h"
#include "CLC_Types.h"
#include "CLC_Enums.h"

#include "CLCm_TransportProtocol.h"
#include "CLCm_Utils.h"

#include "CLC_Utils.h"
#include "CLC_Fct_Async.h"

#include "CLC_Fct_Value.h"

#include "CLC_Fct_EventMessage.h"
#include "CLC_Fct_ModifierMessage.h"
#include "CLC_Fct_SelectorMessage.h"
#include "CLC_Fct_TextMessage.h"
#include "CLC_Fct_DataTransferMessage.h"

#include "CLC_Fct_CHAI.h"
#include "CLC_Fct_LocalDevice.h"
#include "CLC_Fct_CP2Midi.h"
#include "CLC_Fct_Midi2CP.h"
#include "CLC_Fct_HybridMidi.h"
#include "CLC_Fct_SharedDisplayClient.h"
#include "CLC_Fct_SharedDisplay.h"
#include "CLC_Fct_VMIDILink.h"
#include "CLC_Fct_Input.h"
#include "CLC_Fct_Output.h"
#include "CLC_Fct_Pipe.h"
#include "CLC_Fct_RemoteDevice.h"

#include "CLC_Fct_HookedObject.h"
#include "CLC_Fct_Server.h"

#include "CLC_Callbacks.h"

#ifdef __cplusplus
extern "C" {
#endif

//=========================================================================
// runtime check defines
//=========================================================================
#ifdef ENABLE_RUNTIMECHECK
#define CHECK_INSYSTEMPROCESS()     if (!(g_CLCWD.eStatus & CLCS_InCPProcess)) \
    return CLC_ErrorCode_General_CannotCallFromSystem;
#else
#define CHECK_INSYSTEMPROCESS()
#endif

//=========================================================================
// CHAILink control
//=========================================================================

CLC_SDK_API CPBOOLEAN CLC_Init(
    CLC_Callbacks const * const pCB, 
    CLT_Interface const * const pTransportInterface, 
    CPBOOLEAN const fKeepAliveActive );

CLC_SDK_API CPBOOLEAN  CLC_StartScheduler(void);

CLC_SDK_API CPBOOLEAN CLC_StopScheduler(void);

#ifdef ENABLE_THREADING
CLC_SDK_API void  CLC_RequestProcessing(void);
#else
#define CLC_RequestProcessing()
#endif

CLC_SDK_API void CLC_DoProcess(void);

CLC_SDK_API CPBOOLEAN CLC_IsReady(void);

CLC_SDK_API CPBOOLEAN CLC_IsInitialized(void);

CLC_SDK_API void CLC_CallSystemDoProcess(void);


//=========================================================================
// Timeout Values
//=========================================================================
#define CLC_FUNCTIONRETURN_TIMEOUTMS            (5000000)

//=========================================================================
// Complex data empty values
//=========================================================================
extern CLC_SDK_API CPDEVICEID const EmptyDeviceID;
extern CLC_SDK_API CPENDPOINT const EmptyEndPoint;
extern CLC_SDK_API CPPARAMETERID const EmptyParameterID;
extern CLC_SDK_API CPSECTIONID const NullSectionID;
extern CLC_SDK_API CPSECTIONID const AnySectionID;
extern CLC_SDK_API CPPARAMETERID const NullParameterID;

//=========================================================================
// For internal use only
//=========================================================================

typedef enum
{
    CLCS_None                           = 0x0000,
    CLCS_CLTPConnected                  = 0x0001,       // CHAILink Transport Protocol connected to server
    CLCS_WaitingForRT                   = 0x0002,       // CHAILink is waiting for a function call response
    CLCS_RTToProcess                    = 0x0004,       // CHAILink has received a function response
    CLCS_AHToProcess                    = 0x0008,       // CHAILink has received an asynchronous handler to process
    CLCS_InCPProcess                    = 0x0010,       // CHAILink is in CopperLan pseudo process
    CLCS_NotifyConnectionStateChanged   = 0x0020,       // CHAILink has to notify the OnConnectionStateChanged callback
    CLCS_StopRequired                   = 0x0040        // CHAILink scheduler has to stop (CLC_StartScheduler will exit after this call)
}CLC_Status;

typedef struct
{
    //---------------------------------------------------------------------
    // Transport protocol data
    //---------------------------------------------------------------------
    CLTP_Working                CLTPVariables;
    //---------------------------------------------------------------------
    // Function returns and ARH and NH management
    //---------------------------------------------------------------------
    CPBYTE          *pAHBuffer;
    CPBYTE          *pRTBuffer;
    // data for buffers management
    CPHOBJECT       hAHObj;
    CPUINT16        wRTMethodID;  
    CPUINT16        wRTCHAILinkError;
    CPUINT16        wRTPayloadSize;  
    CPUINT16        wAHPayloadSize;  
    CPUINT16        wAHMethodID;
    //---------------------------------------------------------------------
    // Connection status
    //---------------------------------------------------------------------
    volatile CLC_Status     eStatus;
    CPUINT16            wResetCode;
    // Buffer for Async handler (ARH & NH)
#if defined(ENABLE_ETHERNET_PASSTHRU)
    CPBYTE          arbAHBufferT[sizeof(CPUINT16) + CLMSG_ETHERNETFRAMEMAXSIZE + 3];      
#else
    CPBYTE          arbAHBufferT[CLMSG_PAYLOADMAXSIZE + 3];      
#endif
    // Buffer for Return data type    
    CPBYTE          arbRTBufferT[CLMSG_PAYLOADMAXSIZE + 3];    
} CLC_WorkingData;

extern CLC_WorkingData g_CLCWD;

CLC_ErrorCode _CLC_SendCopperLanCMDMessage( CPHOBJECT hObject, CPUINT16 wMethodID );
CLC_ErrorCode _CLC_FinishAndSendMessage(  CPUINT16 wMethodID, CPBYTE * pEndPointer );

void _CLC_Error( CLC_ErrorCode eErrorCode );


#ifdef __cplusplus
}
#endif

#endif // _CLC_MAIN_H_