mcu/interface/protocol/as_c2k/1xrtt/cave.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:     cave.h
 *
 * Purpose:    Header File for the CAVE Algorithm Function.
 *
 ****************************************************************************
 *
 * VCS Header Information
 *
 * $Revision: 1.2 $
 *   $Author: fpeng $
 *
 *      $Log: cave.h $
 *
 *      07 06 2017 sue.zhong
 *      [MOLY00259241] [6293][C2K]Replace with KAL data type
 *      Correct copyright file header
 *      Revision 1.2  2004/03/25 12:09:18  fpeng
 *      Updated from 6.0 CP 2.5.0
 *      Revision 1.1  2003/05/12 15:38:30  fpeng
 *      Initial revision
 *      Revision 1.2  2002/06/06 13:16:40  chinh
 *      Changed and Added Copyright
 *      Revision 1.1  2001/01/17 10:58:08  plabarbe
 *      Initial revision
 *      Revision 1.1  2000/10/24 14:11:03  fpeng
 *      Initial revision
 *      Revision 1.3  2000/08/23 22:05:14Z  RSATTARI
 *      Isotel release 2.8 plus LSI applicable IS-95B changes
 *      Revision 1.3  1998/03/30 23:26:03  mhayduk
 *      Release 0.03.
 *
 *
 ****************************************************************************
 ****************************************************************************/
 

#ifndef _CAVE_H_ 

  #define _CAVE_H_ 1

  /* CAVE Registers structure */
  typedef struct CaveRegs
    {
      kal_uint32 post_auth_lfsr;         /* Linear Feedback Shift Register     */
      kal_uint8  post_auth_offset1;      /* offset_1                           */
      kal_uint8  post_auth_offset2;      /* offset_2                           */
      kal_uint8  post_auth_data[3];      /* Last auth value saved              */
      kal_uint8  Register[16];           /* Mixing Registers                   */

    } CAVEREGS;

  /* Function prototypes */
  void      cave( kal_uint8* reg, short nRounds, kal_uint8 *ofs_1, kal_uint8 *ofs_2,
                  kal_uint32 *LFSR);

  void      dwordToBytes(kal_uint32 value, kal_uint8 *array);
  kal_uint32    bytesToDword(kal_uint8 *array);
  CAVEREGS* getCaveRegs(void);

  /* CMEA/VPM Function Prototypes */
  void generateCMEAandVPM(kal_uint32 esn, kal_uint32 rands, kal_uint8 *ssdb);

  /* Cellular Data Key generation (ORYX algorithm) */
  void   generateDataKeyORYX(kal_uint8 *ssdb);
  void   generateLTableORYX(kal_uint32 rands);
  kal_uint8* getLTable(void);
  kal_uint32 getORYXDataKey(void);

  /* A few handy macros are always appreciated! */
  #define EncryptMsg(buf, len)  EncryptDecryptCMEA(len, buf)
  #define DecryptMsg(buf, len)  EncryptDecryptCMEA(len, buf)

  #define GetAAV() ((kal_uint8) 0xc7)


#endif