/*
 * Copyright (c) 2021 Chipsea Technologies (Shenzhen) Corp., Ltd. All rights reserved.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 ****************************************************************************************
 *
 * @file sleep_api.h
 *
 * @brief SLEEP utility functions
 *
 ****************************************************************************************
 */

#ifndef _SLEEP_API_H_
#define _SLEEP_API_H_

#include "plf.h"

/*
 * ENUMS
 ****************************************************************************************
 */
typedef enum {
    PM_LEVEL_ACTIVE       = 0,  // cpu active/wfi,              peripheral active,              dig_top power up
    PM_LEVEL_LIGHT_SLEEP  = 1,  // cpu active/wfi/clock gating, peripheral active/clock gating, dig_top power up
    PM_LEVEL_DEEP_SLEEP   = 2,  // cpu active/wfi/power down,   peripheral active/power down,   dig_top power up
    PM_LEVEL_HIBERNATE    = 3,  // cpu active/wfi/power down,   peripheral active/power down,   dig_top power up/power down
    PM_LEVEL_ULP_0        = 4,  // dig_top power up/power down, aon_sys power up/power down, pmic power up
    PM_LEVEL_ULP_1        = 5,  // dig_top power up/power down, aon_sys power up/power down, pmic power up/deep sleep
    PM_LEVEL_POWER_OFF    = 6,  // dig_top power up/power down, aon_sys power up/power down, pmic power up/power down
    PM_LEVEL_LEVEL_NUM
} POWER_MODE_LEVEL_T;

typedef enum {
    WAKESRC_UART    = 0,
    WAKESRC_GPIO    = 1,
    WAKESRC_TIMER   = 2,
    WAKESRC_NUM_MAX
} WAKEUP_SOURCE_T;

typedef enum {
    SLEEP_PREVENT_WPAS_ASSOC    = (0x1UL << 0),
    SLEEP_PREVENT_LWIP_DHCP     = (0x1UL << 1),
    SLEEP_PREVENT_MSG           = (0x1UL << 2),
} SLEEP_PREVENT_T;

typedef struct {
    void (*set_sleep_level) (POWER_MODE_LEVEL_T level);
    int  (*is_sleep_allowed)(void);
    void (*indicate_sleep) (POWER_MODE_LEVEL_T level);
    void (*indicate_wakeup) (void);
} sleep_entry_t;

/**
 * register sleep entry
 */
void sleep_entry_register(sleep_entry_t *entry);

#if PLF_PMIC
/**
 * set pmic dcdc vcore
 */
void pmic_dcdc_vcore_set(POWER_MODE_LEVEL_T level);
void pmic_dcdc_rf_set(POWER_MODE_LEVEL_T level);
void pmic_ldo_vrtc09_set(POWER_MODE_LEVEL_T level);
void pmic_ldo_vcore09_set(POWER_MODE_LEVEL_T level);

/**
 * set pmic sleep level
 */
void pmic_sleep_level_set(POWER_MODE_LEVEL_T level);
#endif

/**
 * sleep manager
 */
int sleep_management(unsigned int time_ms);

/**
 * get sleep level
 */
POWER_MODE_LEVEL_T sleep_level_get(void);

/**
 * set sleep level
 */
void sleep_level_set(POWER_MODE_LEVEL_T level);

/**
 * get sleep prevent bits
 */
unsigned int sleep_prevent_get(void);

/**
 * set sleep prevent bits
 */
void sleep_prevent_set(SLEEP_PREVENT_T flag);

/**
 * clear sleep prevent bits
 */
void sleep_prevent_clr(SLEEP_PREVENT_T flag);

/**
 * allow user sleep or not
 */
void user_sleep_allow(int yes);

/**
 * indicate powerkey is pressed
 */
void user_powerkey_pressed(void);

/**
 * set user wakeup source
 * @param src  The wakeup source type, UART/GPIO/TIMER supported
 * @param en   To enable or not, non-zero means enable
 * @param src  The input argument, GPIO index or time interval
 */
void user_sleep_wakesrc_set(WAKEUP_SOURCE_T src, int en, unsigned int arg);

void sleep_data_save(void);

void sleep_data_restore(void);

void sys_wakeup_indicate(void);

#endif /* _SLEEP_API_H_ */