prototypes.h

基于TB板卡的FSK编程,telcobridges fsk develop

/*--------------------------------------------------------------------------------------------------------------------------------
 |
 |	Project:    	VoiceLink TB640 sample (FSK)
 |
 |	Filename:   	prototypes.h
 |
 |	Copyright:  	TelcoBridges 2002-2003, All Rights Reserved
 |
 |	Description:	This file contains the function prototypes
 |
 |	Notes:      	Tabs = 4
 |
 *-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Revision:   	$Revision: 1.4 $
 |
 *------------------------------------------------------------------------------------------------------------------------------*/


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Define header file
 *------------------------------------------------------------------------------------------------------------------------------*/
#ifndef __PROTOTYPES_H__
#define __PROTOTYPES_H__


/*--------------------------------------------------------------------------------------------------------------------------------
 |  C++ support
 *------------------------------------------------------------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Forward declarations
 *------------------------------------------------------------------------------------------------------------------------------*/


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Defines
 *------------------------------------------------------------------------------------------------------------------------------*/


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Types
 *------------------------------------------------------------------------------------------------------------------------------*/

typedef TBX_VOID (*PFCT_TB640_FSK_CMDLINE_ACTION)
(
  IN		TBX_UINT32					in_un32Param,
  IN		TBX_UINT32					in_un32AdapterIdx,
  IN		TBX_UINT32					in_un32TrunkIdx,
  IN		TBX_UINT32					in_un32TimeslotIdx
);



/*--------------------------------------------------------------------------------------------------------------------------------
 |  Global variables
 *------------------------------------------------------------------------------------------------------------------------------*/

/* File fsk.c */
extern PTB640_FSK_CONTEXT				g_AppContext;

/* File cli.c */
extern volatile TBX_BOOL				g_fRefreshDisplay;
extern TBX_SEM							g_StressStatsSem;
extern volatile TB640_FSK_STRESS_STATS	g_StressStats;

/* File parse.c */
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkTypes [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkE1Framing [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkE1Encoding [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkE1Termination [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkT1Framing [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkT1Encoding [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkT1Termination [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkJ1Framing [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkJ1Encoding [];
extern      TB640_FSK_PARSING_ENTRY			g_aParseTrunkJ1Termination [];

/*--------------------------------------------------------------------------------------------------------------------------------
 |  Macros
 *------------------------------------------------------------------------------------------------------------------------------*/


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Function Prototypes
 *------------------------------------------------------------------------------------------------------------------------------*/

/* File in cli.c */
TBX_RESULT TB640FskCli (void);

void TB640FskAsyncLibErrorPrint(PTBX_CHAR in_pszFormatString, ...);


/* File config.c */
TBX_RESULT TB640FskConfigureSystem (void);

TBX_RESULT TB640FskCleanSystem (void);


/* File parse.c */
TBX_RESULT TB640FskParseAndLoadConfiguration(
  IN		PTBX_CHAR					in_pszFilename);

TBX_VOID TB640FskToUpper(
  IN		PTBX_CHAR					in_pszLine);

TBX_VOID TB640FskToLower(
  IN		PTBX_CHAR					in_pszLine);

PTBX_CHAR TB640FskGetTokenString(
  IN		PTB640_FSK_PARSING_ENTRY	in_paParsingEntries,
  IN		TBX_UINT32					in_un32Value );


/* File states.c */
TBX_VOID TB640FskActivateReception (
  IN		TBX_UINT32					in_un32UnusedParam,
  IN		TBX_UINT32					in_un32AdapterIdx,
  IN		TBX_UINT32					in_un32TrunkIdx,
  IN		TBX_UINT32					in_un32TimeslotIdx);

TBX_VOID TB640FskActivateTransmission (
  IN		TBX_UINT32					in_un32Protocol,
  IN		TBX_UINT32					in_un32AdapterIdx,
  IN		TBX_UINT32					in_un32TrunkIdx,
  IN		TBX_UINT32					in_un32TimeslotIdx);

TBX_VOID TB640FskKickTransmission (
  IN		TBX_UINT32					in_un32UnusedParam,
  IN		TBX_UINT32					in_un32AdapterIdx,
  IN		TBX_UINT32					in_un32TrunkIdx,
  IN		TBX_UINT32					in_un32TimeslotIdx);

TBX_VOID TB640FskDeactivate (
  IN		TBX_UINT32					in_un32UnusedParam,
  IN		TBX_UINT32					in_un32AdapterIdx,
  IN		TBX_UINT32					in_un32TrunkIdx,
  IN		TBX_UINT32					in_un32TimeslotIdx);



TBX_VOID
TB640FskResponseMessageHandler(
	IN		PTBX_VOID								in_pvAppContext,
	IN		PTBX_VOID								in_pRequestContext,
	IN		TBX_UINT32								in_un32SearchKey,
	IN		TBX_MSG_ID								in_MsgId,
	IN		PTBX_VOID								in_pvMsgPayload );

TBX_VOID TB640FskEventMessageHandler (
  IN		PTBX_VOID					in_pvAppContext,
  IN		TBX_MSG_HANDLE				in_hMsg);

TBX_VOID TB640FskRequestTimeoutHandler (
  IN		PTBX_VOID 						in_pvAppContext,
  IN		PTBX_VOID						in_pRequestContext,
  IN		TBX_UINT32						in_un32SearchKey);

TBX_RESULT TB640FskHandleReceive
(
  IN		PTB640_FSK_CALL_CONTEXT				in_pCallContext,
  IN		PTB640_EVT_VP_FSK_NOTIF_RECEIVE		in_pEventRxData
);

TBX_VOID	TB640FskUpdateStateTimestamp
(
  IN		PTB640_FSK_CALL_CONTEXT			in_pCallContext,
  IN		TBX_UINT32						in_un32Timestamp
);


/*
 * Callback functions used to implement various protocols over FSK
*/
TBX_RESULT TB640FskTransmitDataModeEnter
(
  IN		PTB640_FSK_CALL_CONTEXT				in_pCallContext,
  OUT		PTB640_FSK_TX_ACTION				out_pTxAction
);

TBX_RESULT TB640FskReadyToTransmitData
(
  IN		PTB640_FSK_CALL_CONTEXT				in_pCallContext
);

TBX_RESULT TB640FskTransmitDataConfirmed
(
  IN		PTB640_FSK_CALL_CONTEXT				in_pCallContext,
  OUT		PTB640_FSK_TX_ACTION				out_pTxAction
);

TBX_RESULT TB640FskRetransmitData
(
  IN		PTB640_FSK_CALL_CONTEXT				in_pCallContext,
  IN		TBX_UINT32							in_un32RetransmitCount
);

/*--------------------------------------------------------------------------------------------------------------------------------
 |  C++ support
 *------------------------------------------------------------------------------------------------------------------------------*/
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __PROTOTYPES_H__ */