/****************************************************************************
*  Program/file: APP_TASK.H
*
*  Copyright (C) by RTX TELECOM A/S, Denmark.
*  These computer program listings and specifications, are the property of
*  RTX TELECOM A/S, Denmark and shall not be reproduced or copied or used in
*  whole or in part without written permission from RTX TELECOM A/S, Denmark.
*
*  Programmer: SS
*
*  MODULE:
*  CONTROLLING DOCUMENT: 
*  SYSTEM DEPENDENCIES:
*
*
*  DESCRIPTION: API Interface definitions
*
****************************************************************************/

/****************************************************************************
*                                  PVCS info
*****************************************************************************

$Author:   SS  $
$Date:   14 Jan 2004 13:21:02  $
$Revision:   1.10  $
$Modtime:   14 Jan 2004 13:19:42  $

*/


#ifndef __API_H
#define __API_H

/////////////////////////////////////////////////////////////////////////////// 
// API DSP command definitions ////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////// 
enum CmdDsp {
  CMD_DSP_CONNECT,
  CMD_DSP_DISCONNECT,
  CMD_DSP_MUTE,
  CMD_DSP_UNMUTE,
  CMD_DSP_MUTE_DEVICE,
  CMD_DSP_UNMUTE_DEVICE,
  CMD_DSP_SWITCH_TONE,
  CMD_DSP_SWITCH_OUTPUT,
  CMD_DSP_WRITE_SW_POINT,
  CMD_DSP_READ_SW_POINT,
  CMD_DSP_START_MELODY,
  CMD_DSP_START_TONE_PATTERN,
  CMD_DSP_STOP_TONE_GEN,
  CMD_DSP_START_DTMF_TONE,
  CMD_DSP_STOP_DTMF_TONE,
  CMD_DSP_INIT_BLOCK,
  CMD_DSP_ACTIVATE_BLOCK,
  CMD_DSP_DEACTIVATE_BLOCK
};


/////////////////////////////////////////////////////////////////////////////// 
// FP API CALL INSTANCE definitions ///////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////// 
#define SW_EI_TYPE_AUDIO_EXT    0x00

#define SW_EI_TYPE_OUT_AUDIO    0x70
#define SW_EI_TYPE_IN_AUDIO     0x60

#define SW_EI_TYPE_IN_DATA0     0x68
#define SW_EI_TYPE_IN_DATA1     0x69
#define SW_EI_TYPE_IN_DATA2     0x6a
#define SW_EI_TYPE_IN_DATA3     0x6b
#define SW_EI_TYPE_IN_DATA4     0x6c
#define SW_EI_TYPE_IN_DATA5     0x6d
#define SW_EI_TYPE_IN_DATA6     0x6e
#define SW_EI_TYPE_IN_DATA7     0x6f
                                
#define SW_EI_TYPE_OUT_DATA0    0x78
#define SW_EI_TYPE_OUT_DATA1    0x79
#define SW_EI_TYPE_OUT_DATA2    0x7a
#define SW_EI_TYPE_OUT_DATA3    0x7b
#define SW_EI_TYPE_OUT_DATA4    0x7c
#define SW_EI_TYPE_OUT_DATA5    0x7d
#define SW_EI_TYPE_OUT_DATA6    0x7e
#define SW_EI_TYPE_OUT_DATA7    0x7f

 

// CvmFpAudioOpenReqType/CvmFpAudioCloseReqType bAudioRoute emun
#define SPK_AEC_ENABLED   0x00
#define SPK_AEC_DISABLED  0x01
#define LINE_LEC_ENABLED  0x02
#define LINE_LEC_DISABLED 0x03

#define CALLCLASS__EXT_GROUP  0x07 // <- in
// #define SW_CALLTYPE_EXT_GROUP 0x0C // -> out

#define HOOKLED_ONHOOK            0x00
#define HOOKLED_OFFHOOK           0x01
#define HOOKLED_ACRIGHTS_ONHOOK   0x10
#define HOOKLED_ACRIGHTS_OFFHOOK  0x11

extern uint8 HookLedState;


/////////////////////////////////////////////////////////////////////////////// 
// API commands interface type definitions ////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////// 


/////////////////////////////////////////////////////////////////////////////// 
// Protocol PP: MCU_PP -> CVM_PP //////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////// 

// API_PP_LOCK_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bSubsriptionNo;
} ApiPpMacLockReqType;

// API_PP_SETUP_REQ
typedef struct
{
  PrimitiveType  PrimitiveIdentifier;
  uint8          bCallClass;
  uint8          bSignal;
  uint8          bLength;
  uint8          bData[1];
} ApiPpSetupReqType;

// API_PP_KEYPAD_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bLength;
   uint8          bData[1];
} ApiPpKeypadReqType;

//API_PP_CONNECT_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpConnectReqType;

//API_PP_ALERT_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpAlertReqType;

//API_PP_RELEASE_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bReason;
} ApiPpReleaseReqType;

//API_PP_RELEASE_RES
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpReleaseResType;

//API_PP_REJECT_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bReason;
} ApiPpRejectReqType;

// API_PP_ACCESS_RIGHTS_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bSubscriptionNo;
   uint8          AcString[4];
} ApiPpAccessRightsReqType;

// API_PP_DELETE_SUBS_REQ
// API_PP_REMOTE_DELETE_SUBS_REQ
typedef struct 
{
  PrimitiveType  PrimitiveIdentifier;
  uint8 bBaseNo;
} ApiPpDeleteSubsReqType;

//API_PP_STOP_PROTOCOL
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
}ApiPpStopProtocolReqType;



/////////////////////////////////////////////////////////////////////////////// 
// Protocol PP: CVM_PP -> MCU_PP //////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////// 

//API_PP_LOCKED_IND
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
}ApiPpLockedindType;

//API_PP_UNLOCKED_IND
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
}ApiPpUnLockedindType;

// API_PP_SETUP_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bCallClass;
   uint8          bSignal;
   uint8          bClipLength;
   uint8          bClipData[1];
} ApiPpSetupIndType;

//API_PP_CONNECT_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpConnectIndType;

//API_PP_CONNECT_CFM
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpConnectCfmType;

//API_PP_SETUP_ACK_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpSetupAckIndType;

//API_PP_ALERT_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpAlertIndType;

//API_PP_ALERT_ON_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8 bSignal;
} ApiPpAlertOnIndType;

//API_PP_ALERT_OFF_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8 bSignal;
} ApiPpAlertOffIndType;


//API_PP_SIGNAL_ON_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8 bSignal;
} ApiPpSignalOnIndType;

//API_PP_SIGNAL_OFF_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8 bSignal;
} ApiPpSignalOffIndType;

//API_PP_RELEASE_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bReason;
} ApiPpReleaseIndType;

//API_PP_RELEASE_CFM
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpReleaseCfmType;

//API_PP_REJECT_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bReason;
} ApiPpRejectIndType;

// API_PP_ACCESS_RIGHTS_CFM
typedef struct
{
   PrimitiveType               PrimitiveIdentifier;
   uint8                       bHsNr;
   uint8                       fKnownFp;
} ApiPpAccessRightsCfmType;

//API_PP_ACCESS_RIGHTS_REJ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bReason;
} ApiPpAccessRightsRejType;

//API_PP_DELETE_SUBS_CFM
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpDeleteSubsCfmType;

//API_PP_REMOTE_DELETE_SUBS_CFM
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
} ApiPpRemoteDeleteSubsCfmType;

//API_PP_CLIP_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8 bClipType;
   uint8 bClipReason;
   uint8 bClipMonth;
   uint8 bClipDate;
   uint8 bClipHours;
   uint8 bClipMinutes;
   uint8 bClipNameLength;
   uint8 bClipNumberLength;
   uint8 bClipName;
   uint8 bClipNumber;
} ApiPpClipInd;


//API_PP_SW_STATUS_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8 bSwStatus;
   uint8 bSwBitMask;
} ApiPpSwStatusInd;


// CVM_FP_PLUG_STATUS_IND
// CVM_PP_PLUG_STATUS_IND
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
  uint8 bPlugState;
}CvmFpPpPlugStatusIndType;

// CVM_FP_LINE_STATUS_IND
// CVM_PP_LINE_STATUS_IND
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
  uint8 bLineState;
}CvmFpPpLineStatusIndType;


/////////////////////////////////////////////////////////////////////////////// 
// Protocol FP (SpeakerPhone): MCU_FP -> CVM_FP ///////////////////////////////
/////////////////////////////////////////////////////////////////////////////// 

// API_FP_INVOKE_ACCESS_RIGHTS_REQ
typedef struct 
{
  PrimitiveType  PrimitiveIdentifier;
  uint8 bAccessRight;
} ApiFpInvokeAccessRightsReqType;

//API_FP_DELETE_SUBS_REQ
typedef struct 
{
  PrimitiveType  PrimitiveIdentifier;
  uint8 bBaseNo;
} ApiFpDeleteSubsReqType;

// API_FP_SETUP_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
   uint8          bCallClass;
//   uint8          bDstCallerId;
//    uint8          bLength;
//    uint8          bData[1];
} ApiFpSetupReqType;


// API_FP_SETUP_ADVANCED_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
   uint8          bCallClass;
   uint8          bCallerDst;
   uint8          bSignal;
   uint8          bIwuLength;
   uint8          bIwuData[1];
} ApiFpSetupAdvancedReqType;


// API_FP_KEYPAD_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
   uint8          bLength;
   uint8          bData[1];
} ApiFpKeypadReqType;

//API_FP_CONNECT_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
} ApiFpConnectReqType;

//API_FP_ALERT_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
} ApiFpAlertReqType;

//API_FP_RELEASE_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
   uint8          bReason;

} ApiFpReleaseReqType;

//API_FP_RELEASE_RES
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
} ApiFpReleaseResType;

//API_FP_REJECT_REQ
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
   uint8          bReason;
} ApiFpRejectReqType;

//API_FP_STOP_PROTOCOL
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
}ApiFpStopProtocolReqType;

//API_FP_ALERT_ON_REQ
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
  uint8         bConnectionEI;
}ApiFpAlertOnReqType;

//API_FP_ALERT_OFF_REQ
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
  uint8         bConnectionEI;
}ApiFpAlertOffReqType;

//API_FP_ALERT_DISTINTIVE_OFF_REQ
typedef struct
{
  PrimitiveType PrimitiveIdentifier;
  uint8         bConnectionEI;
}ApiFpAlertDistintiveOffReqType;



/////////////////////////////////////////////////////////////////////////////// 
// Protocol FP (SpeakerPhone): CVM_FP -> MCU_FP ///////////////////////////////
/////////////////////////////////////////////////////////////////////////////// 

// API_FP_SETUP_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
   uint8          bCallClass;
   uint8          bSignal;
   uint8          bClipLength;
   uint8          bClipData[1];
} ApiFpSetupIndType;

//API_FP_CONNECT_IND
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
} ApiFpConnectIndType;

//API_FP_CONNECT_CFM
typedef struct
{
   PrimitiveType  PrimitiveIdentifier;
   uint8          bConnectionEI;
} ApiFpConnectCfmType;