mcu/interface/protocol/as_c2k/1xrtt/namdata.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:    namdata.h
 *
 * Purpose:   Definitions and prototypes for IS-95 NAM data parameters
 *
 ****************************************************************************
 *
 *                          PVCS Header Information
 *
 *
 *  $Log: namdata.h $
 *
 *  08 24 2017 sue.zhong
 *  [MOLY00273584] [6293][C2K]Remove un-used C source file in makefile to save compile time.
 *
 *  07 06 2017 sue.zhong
 *  [MOLY00259241] [6293][C2K]Replace with KAL data type
 *  Correct copyright file header
 *  Revision 1.3  2005/03/18 10:24:53  bcolford
 *  CBP4.05 [4.21] to CBP6.1 [2.9.0] CP Software Merge.
 *  Revision 1.2  2004/08/13 10:04:18  agontar
 *  Removed T53 flag; cleaned up logs
 *  Revision 1.2  2004/03/25 12:09:38  fpeng
 *  Updated from 6.0 CP 2.5.0
 *  Revision 1.1  2003/05/12 15:38:55  fpeng
 *  Initial revision
 *  Revision 1.10  2002/09/30 15:17:46  mshaver
 *  Changed NamData typedef to be of PswIs95NamT type as this
 *  is now is the single NAM data structure type.
 *  Revision 1.9  2002/07/31 17:12:13  hans
 *  ENG_PREF_BAND_4 (cr726) added as sys option to NAM preferred band selection.
 *  Revision 1.8  2002/06/06 13:13:47  chinh
 *  Changed and Added Copyright
 *  Revision 1.7  2002/02/06 11:43:23  mclee
 *  Removed prototypes to deleted files.
 *  Revision 1.6  2001/11/20 12:32:28  mclee
 *  Move IS95Nam struct and add prototype namGetNam
 *  Revision 1.5  2001/11/08 12:20:33  AMALA
 *  Deleted compiler switch SYS_SEL_1_CBP3_MERGE &
 *  associated non-compiled code.
 *  Revision 1.4  2001/10/08 14:47:02  mclee
 *  comment out NamNumber, move definition to sysdefs.h
 *  Revision 1.3  2001/09/17 14:11:41  AMALA
 *  CBP3 System Selection port
 *  Revision 1.2  2001/05/09 09:45:03  cmastro
 *  changes to compile MMI-integration
 *  Revision 1.1  2001/01/17 10:59:05  plabarbe
 *  Initial revision
 *  Revision 1.1  2000/10/24 14:11:21  fpeng
 *  Initial revision
 *  Revision 1.6  2000/09/23 02:39:28Z  rnookala
 *  added spc and nam_lock to structure IS95Nam
 *  Revision 1.5  2000/08/31 23:41:56Z  bcolford
 *  Replaced AMPS_SUPPORTED with SYS_OPTION_AMPS.
 *  Revision 1.4  2000/08/23 22:21:27Z  rnookala
 *  Isotel release 2.8  Added checksum field to NAM
 *  Revision 1.3  2000/03/01 18:15:19Z  rsattari
 *  Isotel release 2.3 updates.
 *  Revision 1.16  1999/12/09 23:06:28  gfrye
 *  Added CDMA Primary and Secondary Channel definitions to the NAM so
 *  that they can be modified by different customers.
 *
 *  Revision 1.15  1999/08/05 01:11:23  scotvold
 *  Moved CP_BCAST_ADDRESS_MAX_SIZE to custom.h.
 *
 *  Revision 1.14  1999/01/20 19:08:07  mhayduk
 *  Added broadcast address.
 *
 *  Revision 1.13  1998/12/30 18:59:49  mhayduk
 *  Moved analog parameters inside SYS_OPTION_AMPS.
 *
 *  Revision 1.12  1998/11/24 05:40:36  mhayduk
 *  Cleaned up definitions for checking of TMSI Zone length -
 *  max zone size is 8.
 *
 *  Revision 1.11  1998/10/28 01:26:55  guterman
 *  Changed SCMp tp SCMP[0] for AMPS macros
 *
 *  Revision 1.10  1998/10/20 23:58:23  mhayduk
 *  Added T53 support.
 *
 *  Revision 1.9  1998/09/22 18:44:57  tdaly
 *  Added IS-95 analog mode support.
 *
 *  Revision 1.8  1998/06/08 21:48:25  scotvold
 *  Updated for Release 0.06.
 *
 * Revision 1.7  1998/05/29  20:34:49  mhayduk
 * Fixed SCM mask.
 *
 * Revision 1.6  1998/05/27  17:16:28  scotvold
 * Updated for Release 0.05.
 *
 * Revision 1.5  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 _NAMDATA_H_

  #define _NAMDATA_H_ 1

/*****************************************************************************
 * Includes
 ****************************************************************************/
#include "pswnam.h"
/*****************************************************************************
 * Definitions for use with NAM
 ****************************************************************************/

  /* Slotted mode bit mask in SCM */
  #define CP_SLOTTED_MODE_BIT_MASK 0x20 

  /* MEID Support indication bit mask in SCM */  
  #define CP_MEID_SUPPORT_INDICATOR_BIT_MASK 0x10

  /* Fields for Station Class Mark (SCMp) -- RS-553 Section 2.3.3 */
  #define SCM_Band(x)   ((x) & 0x08)      /* SCMp Mask -- Bandwidth       */
  #define SCM_Trans(x)  ((x) & 0x04)      /* SCMp Mask -- Transmission    */
  #define SCM_PClass(x) ((x) & 0x03)      /* SCMp Mask -- Power Class     */

  #define SCM_20MHz   (0 << 3)            /* 20MHz Bandwidth */
  #define SCM_25MHz   (1 << 3)            /* 25MHz Bandwidth */

  #define SCM_NODTX   (0 << 2)            /* DTX capability disabled */
  #define SCM_DTX     (1 << 2)            /* DTX capability enabled  */

  #define PCLASS1     0                   /* Power Class I   -- High    */
  #define PCLASS2     1                   /* Power Class II  -- Medium  */
  #define PCLASS3     2                   /* Power Class III -- Low     */
  #define NO_PCLASS   3                   /* Power Class Reserved (bad) */

  /* Macros */
  #define IS_DTX_ENABLED(x)  ( (SCM_Trans(x.SCMp[0]) == SCM_DTX) && ((x).DTXp) )

#endif  /* _NAMDATA_H_ */