/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (c) 2019 MediaTek Inc.
*/

#ifndef __MT_FREQHOPPING_H__
#define __MT_FREQHOPPING_H__


/* Disable all FHCTL Common Interface for chip Bring-up */
#undef DISABLE_FREQ_HOPPING
/* Use HW semaphore to share REG_FHCTL_HP_EN with secure CPU DVFS */
#define HP_EN_REG_SEMAPHORE_PROTECT

#define FHTAG "[FH]"
#define VERBOSE_DEBUG 0
#define DEBUG_MSG_ENABLE 0

#if VERBOSE_DEBUG
	#define FH_MSG(fmt, args...) \
	pr_debug(FHTAG""fmt" <- %s(): L<%d>  PID<%s><%d>\n", \
		##args, __func__, __LINE__, current->comm, current->pid)

	#define FH_MSG_DEBUG   FH_MSG
#else
#define FH_MSG(fmt, args...) pr_debug_ratelimited(fmt, ##args)

	#define FH_MSG_DEBUG(fmt, args...)\
	do {    \
		if (DEBUG_MSG_ENABLE)           \
			pr_debug(FHTAG""fmt"\n", ##args); \
	} while (0)
#endif

enum FH_FH_STATUS {
	FH_FH_DISABLE = 0,
	FH_FH_ENABLE_SSC,
};

enum FH_FH_PLL_SSC_DEF_STATUS {
	FH_SSC_DEF_DISABLE = 0,
	FH_SSC_DEF_ENABLE_SSC,
	FH_SSC_DEF_DYNAMIC_SSC,
};


enum FH_PLL_STATUS {
	FH_PLL_DISABLE = 0,
	FH_PLL_ENABLE = 1
};


enum FH_CMD {
	FH_CMD_ENABLE = 1,
	FH_CMD_DISABLE,
	FH_CMD_ENABLE_USR_DEFINED,
	FH_CMD_DISABLE_USR_DEFINED,
	FH_CMD_INTERNAL_MAX_CMD
};

enum FH_PLL_STRUCT_FIELD {
	CURR_FREQ = 0,
	FH_STATUS,
	PLL_STATUS,
	SETTING_ID,
	SETTING_IDX_PATTERN,
	USER_DEFINED
};


enum FH_PLL_ID {
	FH_PLL0  = 0,       /* ARMPLL */
	FH_PLL1  = 1,       /* MAINPLL */
	FH_PLL2  = 2,       /* MSDCLL */
	FH_PLL3  = 3,       /* MFGPLL */
	FH_PLL4  = 4,       /* MEMPLL */
	FH_PLL5  = 5        /* MMPLL */
};

#define FH_PLL_NUM 6

#define FH_ARM_PLLID FH_PLL0
#define FH_MAIN_PLLID FH_PLL1
#define FH_MSDC_PLLID FH_PLL2
#define FH_MFG_PLLID FH_PLL3
#define FH_MEM_PLLID FH_PLL4
#define FH_MM_PLLID  FH_PLL5
#define isFHCTL(id) ((id >= FH_PLL0 && id <= FH_PLL5)?true:false)


/* keep track the status of each PLL */
/* TODO: do we need another "uint mode" for Dynamic FH */
struct fh_pll_t {
	unsigned int	curr_freq;    /* Useless variable, just a legacy */
	unsigned int    fh_status;
	unsigned int    pll_status;
	/* Index in the corresponding pll's table of type freqhopping_ssc */
	unsigned int    setting_id;
	/* Used to match the idx_pattern in freqhopping_ssc */
	unsigned int	setting_idx_pattern;
	unsigned int    user_defined;
};


struct freqhopping_ssc {
	unsigned int	idx_pattern;
	unsigned int	dt;
	unsigned int	df;
	unsigned int	upbnd;
	unsigned int	lowbnd;
	unsigned int	dds;
};

struct freqhopping_ioctl {
	unsigned int		pll_id;
	struct freqhopping_ssc	ssc_setting; /* used only when user-define */
	int			result;
};

struct fhctl_ipi_data {
	unsigned int cmd;
	union {
		struct freqhopping_ioctl	fh_ctl;
		unsigned int			args[8];
	} u;
};


/* FHCTL HAL driver Interface. */
int mt_pause_armpll(unsigned int pll, unsigned int pause);
struct mt_fh_hal_driver *mt_get_fh_hal_drv(void);


#endif                /* !__MT_FREQHOPPING_H__ */