os_hal_lp.h

/*
 * (C) 2005-2020 MediaTek Inc. All rights reserved.
 *
 * Copyright Statement:
 *
 * This MT3620 driver software/firmware and related documentation
 * ("MediaTek Software") are protected under relevant copyright laws.
 * The information contained herein is confidential and proprietary to
 * MediaTek Inc. ("MediaTek"). You may only use, reproduce, modify, or
 * distribute (as applicable) MediaTek Software if you have agreed to and been
 * bound by this Statement and the applicable license agreement with MediaTek
 * ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 *
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE
 * PROVIDED TO RECEIVER 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 MEDIATEK SOFTWARE, AND RECEIVER AGREES TO
 * LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN MEDIATEK
 * SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE
 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S
 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED
 * HEREUNDER WILL BE ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY
 * RECEIVER TO MEDIATEK DURING THE PRECEDING TWELVE (12) MONTHS FOR SUCH
 * MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __OS_HAL_LP_H__
#define __OS_HAL_LP_H__

#include <stdint.h>

typedef enum {
    PRE_DEEP_SLEEP = 0,
    POST_DEEP_SLEEP
} dslp_check;

typedef enum {
    CPU_CLOCK_GATING = 0,
    LEGACY_SLEEP,
    DEEP_SLEEP
} lp_scenario;

typedef enum {
    EINT_WAKEUP_SRC_0 = (1 << 0),
    EINT_WAKEUP_SRC_1 = (1 << 1),
    EINT_WAKEUP_SRC_2 = (1 << 2),
    EINT_WAKEUP_SRC_3 = (1 << 3),
    EINT_WAKEUP_SRC_4 = (1 << 4),
    EINT_WAKEUP_SRC_5 = (1 << 5),
    EINT_WAKEUP_SRC_6 = (1 << 6),
    EINT_WAKEUP_SRC_7 = (1 << 7),
    EINT_WAKEUP_SRC_8 = (1 << 8),
    EINT_WAKEUP_SRC_9 = (1 << 9),
    EINT_WAKEUP_SRC_10 = (1 << 10),
    EINT_WAKEUP_SRC_11 = (1 << 11),
    EINT_WAKEUP_SRC_12 = (1 << 12),
    EINT_WAKEUP_SRC_13 = (1 << 13),
    EINT_WAKEUP_SRC_14 = (1 << 14),
    EINT_WAKEUP_SRC_15 = (1 << 15),
    EINT_WAKEUP_SRC_16 = (1 << 16),
    EINT_WAKEUP_SRC_17 = (1 << 17),
    EINT_WAKEUP_SRC_18 = (1 << 18),
    EINT_WAKEUP_SRC_19 = (1 << 19),
    EINT_WAKEUP_SRC_20 = (1 << 20),
    EINT_WAKEUP_SRC_21 = (1 << 21),
    EINT_WAKEUP_SRC_22 = (1 << 22),
    EINT_WAKEUP_SRC_23 = (1 << 23),
    GPT3_WAKEUP_SRC_24 = (1 << 24),
    WAKEUP_SRC_MAX = 25
} lp_wakeup_src;

#ifdef __cplusplus
extern "C" {
#endif

void mtk_os_hal_lp_config_gpt3_timeout(uint32_t time_val);

int mtk_os_hal_lp_dslp_check(dslp_check stage);

int mtk_os_hal_lp_enter(uint32_t wakeup_src, lp_scenario lp);

#ifdef __cplusplus
}
#endif

#endif