clid_miket.h

This R2.9 revision of the CLID detector provides the TYPE 1 (on-hook, between first and second ring,

/*------------------------------------------------------------------------*
*                                                                         *
*   THIS IS AN UNPUBLISHED WORK CONTAINING CONFIDENTIAL AND PROPRIETARY   *
*   INFORMATION.  IF PUBLICATION OCCURS, THE FOLLOWING NOTICE APPLIES:    *
*      "COPYRIGHT 2001 MIKET DSP SOLUTIONS, ALL RIGHTS RESERVED"          *
*                                                                         *
*-------------------------------------------------------------------------*/
#ifndef CLID_MIKET_
#define CLID_MIKET_

#include <std.h>                 
#include <iclid.h>


/*--------------------- public defs ---------------------------------------*/
/* sizes in long words */
#define CLID_MIKET_DB_LSZ	(130)
#define CLID_MIKET_SC_LSZ	(215)

/*--------------------- public vars ---------------------------------------*/

extern const IALG_Fxns 		CLID_MIKET_IALG; 
extern const ICLID_Fxns 	CLID_MIKET_ICLID; 
extern const ICLID_tCfg 	ICLID_MIKET_DefaultCfg;
extern const ICLID_Params 	ICLID_MIKET_DefaultParams;
extern const char			CLID_MIKET_aVersion[];

/*--------------------- local vars ----------------------------------------*/
/*--------------------- local functions -----------------------------------*/
/*--------------------- public  functions ---------------------------------*/
/*
 *  Required module finalization function : THIS FUNCTION IS EMPTY
 */
extern Void CLID_MIKET_exit(Void);

/*
 *  Required module initialization function: THIS FUNCTION IS EMPTY
 */
extern Void CLID_MIKET_init(Void);

/* ---- Native API ----- */

/*  Initialises database. (mem[1])
    pBuff points to 128 words of memory to store the message.
 */
extern void CLID_MIKET_init_db   (void *pDb, ICLID_tCfg *pCfg);

/*  pCfg in pStatus can point to the same config data for any number of MF
    detector instances. 
    If RESET is not or-ed with OFF, the detector starts running.
    It is not recommened to apply OFF without RESET due to
    the obvious consequences of calling _control(pDb, 0); afterwards. 
    Asynchronous calling _control() and _process() from different tasks
    is not recommended. */
extern void CLID_MIKET_control(void *pDb, Int Cmd, ICLID_Status *pStatus );

/*  returns report word:
        - MSByte as event and 
        - LSByte as msg len. 

    pDb must point to initialized database (mem[1]).

    pSc must point to scratch pad (mem[2])
    pScratch shall point to DARAM if max speed is required,
    otherwise MIPS will almost double.

    pIn shall point to a frame (40 samples) of continuous data. 
    
    If receiver was turned off, then pSc and pIn
    can point anywhere. */           
    
extern Int  CLID_MIKET_process(void *pDb, void *pSc, Int *pIn);

/* statistics */
typedef struct CLID_MIKET_tStts {

    Int sStart;
    Int sEnd;
    Int sAbort;
    Int sCas;

} CLID_MIKET_tStts;

extern void CLID_MIKET_get_stts(void *pDb, CLID_MIKET_tStts *pStts);

#endif  /* CLID_MIKET_ */