mcu/interface/protocol/as_c2k/evdo/cspdefs.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) 2010 VIA Telecom, Inc.  All rights reserved.
*
*************************************************************/
#ifndef _CSPDEFS_H_
#define _CSPDEFS_H_ 1
/****************************************************************************
 *
 * Module:     cspdefs.h
 *
 * Purpose:    
 *
 ****************************************************************************/

/*----------------------------------------------------------------------------
 Include Files
----------------------------------------------------------------------------*/
#include "sysapi.h"

/*----------------------------------------------------------------------------
 Local Defines and Macros
----------------------------------------------------------------------------*/
#define CP_CSP_MESSAGE_ID_WIDTH                   8
#define CP_CLOSE_REASON_WIDTH                     3
#define CP_SUSPEND_ENABLE_WIDTH                   1
#define CP_CSP_32_BITS_WIDTH                     32
#define CP_CSP_4_BITS_WIDTH                       4

#define CONN_CLOSE_GUARD_TIMER_DISABLE            0

typedef enum
{
   CSP_INACTIVE_STATE,
   CSP_CLOSING_STATE,
   CSP_OPEN_STATE,
} CspStateT;

typedef enum 
{
   CSP_CONN_CLOSE_MESSAGE = 0x00,
   CSP_CONFIG_REQUEST_MESSAGE = 0x50,
   CSP_CONFIG_RESPONSE_MESSAGE,
} CspMsgTypeT;

typedef enum
{
  CSP_NORMAL_CLOSE_NO_REASON            = 0x00,
  CSP_CLOSE_REPLY_CLOSE_REASON          = 0x01,
  CSP_CONN_ERROR_CLOSE_REASON           = 0x02,
  CSP_NORMAL_CLOSE_CHANGE_SYSTEM        = 0x03,
  CSP_NORMAL_CLOSE_WITH_SUSPEND_TIME    = 0x04,
  CSP_NORMAL_CLOSE_WITHOUT_SUSPEND_TIME = 0x05,
} CspCloseReasonT;

/* CSP Close Connection Message */
typedef struct
{
   kal_uint8              MessageId;        /* 8 bits */
   kal_uint8              CloseReason;      /* 8 bits */
   kal_bool               SuspendEnable;    /* 8 bits */
   SysTimeFullT       SuspendTime; 
} CspConnCloseMsgT;

typedef struct
{
  kal_bool SuspendEnable;
  kal_uint32 SuspendTime;
} SuspendTimeConfigT;

/*----------------------------------------------------------------------------
  Function Prototypes
----------------------------------------------------------------------------*/
void CspInitialize(void);
void RunCspStateMachine(kal_uint32 MsgId, void *MsgDataP);
void ProcessCspActivateMsg(void);
void ProcessCspCloseConnMsg(void *MsgBufPtr);
void ProcessCspDeactivateMsg(void);
void ProcessCspDsaFwdMsg(DsaFwdMsgT *MsgDataP); 
void SetCspState(CspStateT state);
CspStateT GetCspState(void);

void SetCspSuspendTime(kal_bool SuspendEnable, kal_uint32 SuspendTime);

/*****************************************************************************
* End of File
*****************************************************************************/
#endif /*_CSPDEFS_H_*/