mcu/interface/protocol/as_c2k/1xrtt/status.h

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2016
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS (""MEDIATEK SOFTWARE"")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN ""AS-IS"" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
/*************************************************************
*
* This Software is the property of VIA Telecom, Inc. and may only be used pursuant to a license from VIA Telecom, Inc.  
* 
* Any unauthorized use inconsistent with the terms of such license is strictly prohibited.
* 
* Copyright (c) 1999-2010 VIA Telecom, Inc.  All rights reserved.
*
*************************************************************/
/****************************************************************************
 *
 * Module:     status.h
 *
 * Purpose:    Definitions and prototypes for Call Progression Status.
 *
 ****************************************************************************
 *
 *                          PVCS Header Information
 *
 *  $Workfile$
 *  $Revision: 1.2 $
 *  $Modtime$
 *  $Author: fpeng $
 *
 *  $Log: status.h $
 *
 *  08 29 2017 tina.ma
 *  [MOLY00274341] [Merge from MP5.TC10]when exit flight mode, if camp on the same cell, report MCC search response eraly
 *  	
 *  	merge code from MP5.TC10
 *
 *  07 06 2017 sue.zhong
 *  [MOLY00259241] [6293][C2K]Replace with KAL data type
 *  Correct copyright file header
 *
 *  05 17 2017 peijun.zheng
 *  [MOLY00249027] [BIACNO][MT6763][New feature]C2K code release code modification
 *  	
 *  	C2k code release.
 *
 *  11 09 2016 sue.zhong
 *  [MOLY00208435] [6293][C2K]Sync C2K code to UMOLYA TRUNK
 *  Update C2K PS code (1/2)
 *  Revision 1.2  2004/03/25 12:09:46  fpeng
 *  Updated from 6.0 CP 2.5.0
 *  Revision 1.2  2004/02/10 12:50:56  bcolford
 *  Merged CBP4.0 Release 8.05.0 changes.
 *  Revision 1.4  2003/11/06 11:24:06  ameya
 *  Added prototype for cpGetCurrentBand().
 *  Revision 1.3  2002/06/06 13:15:00  chinh
 *  Changed and Added Copyright
 *  Revision 1.2  2001/12/14 17:12:20  mclee
 *  prototype cpGetCurrentMode(), cpGetNID(), cpGetPilotPN()
 *  Revision 1.1  2001/01/17 10:59:29  plabarbe
 *  Initial revision
 *  Revision 1.1  2000/10/24 14:11:29  fpeng
 *  Initial revision
 *  Revision 1.5  2000/08/31 23:41:58Z  bcolford
 *  Replaced AMPS_SUPPORTED with SYS_OPTION_AMPS.
 *  Revision 1.4  2000/08/23 22:11:31Z  RSATTARI
 *  Isotel release 2.8 plus LSI applicable IS-95B changes.
 *  Revision 1.17  1999/12/09 22:01:46  gfrye
 *  Moved definitions of System Determination Indications to css_api.h
 *
 *  Revision 1.16  1999/08/31 00:09:18  gfrye
 *  Added new system determination indication CP_PREV_SYSTEM_LOST_ACCESS.
 *
 *  Revision 1.15  1999/03/02 00:53:43  dfischer
 *  Added state CP_AMPS_SYSDET_DELAY
 *
 *  Revision 1.14  1999/02/26 00:33:36  mhayduk
 *  Added PILOT_PN to status record.
 *
 *  Revision 1.13  1999/02/25 19:40:55  mhayduk
 *  Added call to allow any engine component to request status be
 *  sent to wbios.
 *
 *  Revision 1.12  1998/12/22 19:08:55  dfischer
 *  Added CP_AMPS_REGCONF_WFOMT
 *
 *  Revision 1.11  1998/11/27 22:29:13  mhayduk
 *  Removed system A/B definitions and just use the
 *  current ones defined in engine.h.
 *
 *  Revision 1.10  1998/11/26 23:15:13  mhayduk
 *  Added interfaces to update the new status elements -
 *    mode and block.
 *
 *  Revision 1.9  1998/11/26 22:08:19  mhayduk
 *  Updated status structure for new api.
 *
 *  Revision 1.8  1998/10/20 23:58:23  mhayduk
 *  Added T53 support.
 *
 *  Revision 1.7  1998/09/22 18:44:57  tdaly
 *  Added IS-95 analog mode support.
 *
 *  Revision 1.6  1998/08/28 20:15:59  mhayduk
 *  Added setting of band.
 *
 *  Revision 1.5  1998/05/27 17:16:28  scotvold
 *  Updated for Release 0.05.
 *
 * Revision 1.4  1998/05/01  18:13:54  scotvold
 * Update for release 0.04
 *
 * Revision 1.3  1998/03/30  23:26:03  mhayduk
 * Release 0.03.
 *
 * Revision 1.1  1997/11/06  17:49:24  mhayduk
 * Initial revision
 *
 * 
 ****************************************************************************
 ****************************************************************************/

#ifndef _STATUS_H_

  #define _STATUS_H_ 1

/*****************************************************************************
 * Includes
 ****************************************************************************/
#include "cssapi.h"
#include "pswapi.h"

/*****************************************************************************
 * Definitions
 ****************************************************************************/


  #define CP_AMPS_FIRST_STATE  CP_AMPS_WBIOS_INIT

  #define CP_AMPS_LAST_STATE   CP_AMPS_NUM_STATES

/*****************************************************************************
 * Call Processing Status Information structure
 ****************************************************************************/
  typedef struct
  {
    CPState state;                /* Call Processing State                */
    CPState prevState;            /* Previous Call Processing State       */
    kal_uint8   roam;                 /* ROAM Status                          */
    SysCdmaBandT band;            /* Current Operating Band               */
    kal_uint16  channel;              /* Current Channel Number               */
    kal_uint8   mode;                 /* current mode: PCS/CellularAnalog     */
    kal_uint8   block;                /* current CDMA block (if CDMA system)  */
    kal_uint8   servingSystem;        /* Serving System/Block                 */
    kal_uint16  sid;                  /* Last-Received System ID              */
    kal_uint16  nid;                  /* Last-Received Network ID             */
    kal_uint16  pilotPN;              /* PILOT_PN                             */
  } CPStatus;


/*****************************************************************************
 * Function prototypes
 ****************************************************************************/
  void    cpSetSystemIndication(kal_uint8 indication);
  kal_uint8   cpGetSystemIndication(void);
  void    setCPState(CPState state);
  void    cpSetRoam(kal_uint8 roam);
  kal_uint8   cpGetRoam(void);
  void    cpSetCurrentBand(SysCdmaBandT band);
  SysCdmaBandT cpGetCurrentBand(void);
  void    cpSetCurrentChannel(kal_uint16 channel);
  kal_uint16  cpGetCurrentChannel(void);
  void    cpSetCurrentBlock(kal_uint8 block);
  void    cpSetServingSystem(kal_uint8 servingSystem);
  kal_uint8   cpGetServingSystem(void);
  void    cpSetSysID(kal_uint16 sid);
  kal_uint16  cpGetSysID(void);
  void    cpSetNID(kal_uint16 nid);
  kal_uint16  cpGetNID(void);
  void    cpSetPilotPN(kal_uint16 pn);
  kal_uint16  cpGetPilotPN(void);
  void    cpReportStatus(void);
  void    cpSetProtocolRev( kal_uint8 prev );
  kal_uint8    cpGetProtocolRev(void);
  void    cpSetSystemStatus( kal_uint8 status );
  kal_uint8   cpGetSystemStatus(void);
  kal_uint8   cpGetOrigCallMode(void);
  void    cpSetOrigCallMode(kal_uint8 callMode);

#if defined(MTK_DEV_SLT)
  kal_bool lstIf1xRxValidated (void);
  
  void lstSet1xRxValidated (kal_bool value);
  
  void lstInit1xProcedureVariable (void);
  
  kal_bool lstIf1xTxValidated (void);
  
  void lstSet1xTxValidated (kal_bool value);
#endif /* MTK_DEV_SLT */
void cpSetRegZone(kal_uint16 regZone);
CPState getCPPrevState(void);
void cpInitStatus(void);

#endif  /* _STATUS_H_ */