Gitiles
Code Review Sign In
192.168.1.100 / T800_MD / b0f5b85a5b9d69cbfa1dd990d559a4a9c7d8f2a6 / . / mcu / interface / l1 / cl1 / common / cl1sleep.h
blob: aded35ecc9b5a45c0959dd8ce3680f00a43a5401 [file] [log] [blame]
rjw6c1fd8f2022-11-30 14:33:01 +0800[diff] [blame]1/*****************************************************************************
2* Copyright Statement:
3* --------------------
4* This software is protected by Copyright and the information contained
5* herein is confidential. The software may not be copied and the information
6* contained herein may not be used or disclosed except with the written
7* permission of MediaTek Inc. (C) 2016
8*
9* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
10* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
11* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
12* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
13* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
14* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
15* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
16* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
17* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
18* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
19* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
20* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
21*
22* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
23* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
24* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
25* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
26* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
27*
28* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
29* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
30* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
31* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
32* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
33*
34*****************************************************************************/
35
36#ifndef _CL1SLEEP_H_
37#define _CL1SLEEP_H_
38/*****************************************************************************
39
40 FILE NAME: hwdsleep.h
41
42 DESCRIPTION:
43 Interface to hwdsleep.c
44
45*****************************************************************************/
46
47#include "sysapi.h"
48
49/*------------------------------------------------------------------------
50 * exported data
51 *------------------------------------------------------------------------*/
52
53
54/*----------------------------------------------------------------------------
55 Global Defines and Macros
56----------------------------------------------------------------------------*/
57#define PAUSE_CMD_SW_MARGIN (1500) /* 5T 32K SW Margin */
58#define PAUSE_CMD_MARGIN (1500 + PAUSE_CMD_SW_MARGIN) /* 3T 32K + 2T uncertanty + 5T SW Margin */
59
60typedef struct
61{
62 kal_bool SleepState; /* Indicate whether UE is in sleep state */
63 kal_uint32 WakeTime; /* record wake up time */
64 kal_uint64 WakeDuration; /* record total wake duration after UE boot up */
65} Cl1WakeInfoT;
66
67typedef struct
68{
69 kal_uint8 CurrentIdx; /* Indicate current index */
70 Cl1WakeInfoT WakeInfo[2]; /* record wake info, 2 index for ping-pang buffer for corner case query in sleep or wake up boundary */
71 kal_uint32 WakeCnt; /* record total wake counts after UE boot up */
72 kal_uint32 SleepCnt; /* record total sleep counts after UE boot up */
73} Cl1SleepEmInfoT;
74
75extern Cl1SleepEmInfoT gCl1SleepEmInfo[SYS_MODE_MAX];
76
77/* Clock Control Blocks */
78typedef enum
79{
80 HWD_BLK_CTRL_PPP_HA,
81 HWD_BLK_CTRL_1X_SYSTIME,
82 HWD_BLK_CTRL_DO_SYSTIME,
83
84 HWD_BLK_CTRL_FT_CTRL,
85 HWD_BLK_CTRL_RF_CTRL,
86
87 HWD_BLK_CTRL_NUM_BLOCKS
88} HwdBlkControlBlocksT;
89
90#ifndef MTK_PLT_ON_PC
91#define IRQ_WAKE1X_IRQ_CODE IRQ_ST1x_WAKEUP_IRQ_CODE
92#define IRQ_WAKEDO_IRQ_CODE IRQ_STDO_WAKEUP_IRQ_CODE
93#else
94#define IRQ_WAKE1X_IRQ_CODE OSC_ISR_SRC_CUSTOM10
95#define IRQ_WAKEDO_IRQ_CODE OSC_ISR_SRC_CUSTOM11
96#endif
97
98/*------------------------------------------------------------------------
99 * exported functions
100 *------------------------------------------------------------------------*/
101
102extern void HwdSleepInit(void);
103extern kal_bool HwdEnterCbpDeepSleepCheck(SysAirInterfaceT Interface) ;
104extern void HwdWakeupSlpCtrl( SysAirInterfaceT Interface ) ;
105extern void HwdDeepSleepClearCancellingFlag(SysAirInterfaceT Interface);
106extern kal_bool HwdIsBlockConfigValid( HwdBlkControlBlocksT Block );
107extern kal_bool HwdCheckDeepSleepMode( SysAirInterfaceT Interface);
108extern kal_bool HwdCheckDeepSleepHWMode(SysAirInterfaceT Interface);
109extern void HwdSleepOverHisr1x(void);
110extern void HwdSleepOverHisrDO(void);
111extern void HwdSleepSetCalValue(SysAirInterfaceT Interface, kal_uint32 CalValue);
112extern kal_uint32 HwdSleepCalcCalValue(SysAirInterfaceT Interface, kal_uint32 ScCnt, kal_uint32 FcFreq, kal_uint32 FcCnt);
113extern void HwdSleepSetSlpOffset(SysAirInterfaceT Interface, kal_int16 Offset);
114extern kal_uint32 HwdSleepTimesGet(SysAirInterfaceT Interface);
115extern void Cl1SmTick(SysAirInterfaceT Interface);
116extern void HwdDeepSleepRecover(void);
117extern void Cl1_slp_info_calc(SysAirInterfaceT Interface, kal_uint64 *working_time, kal_uint32 *wakeup_cnt, kal_uint32 *sleep_cnt);
118
119/*****************************************************************************
120 * End of file
121 *****************************************************************************/
122#endif
123