/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
 *		http://www.samsung.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#ifndef __EXYNOS_SCI_H_
#define __EXYNOS_SCI_H_

#include <linux/module.h>

#define EXYNOS_SCI_MODULE_NAME		"exynos-sci"
#define LLC_DSS_NAME			"log_llc"

#define LLC_DUMP_DATA_Q_SIZE			8
#define LLC_SLICE_END				(0x1)
#define LLC_BANK_END				(0x1)
#define LLC_SET_END				(0x1FF)
#define LLC_WAY_END				(0xF)
#define LLC_QWORD_END				(0x7)

#define SCI_BASE				0x1A000000
#define ArrDbgCntl				0x05C
#define ArrDbgRDataHi				0x06C
#define ArrDbgRDataMi				0x070
#define ArrDbgRDataLo				0x074
#define CCMControl1				0x0A8
#define PM_SCI_CTL				0x140
#define SCI_SB_LLCSTATUS			0xA0C

#define LLC_En_Bit				(25)
#define DisableLlc_Bit				(9)

#define FULL_WAY_NUM				(16)
#define SYSFS_FLUSH_REGION_INDEX		(0)
#define FULL_INV				0xFFFF
#define TOPWAY					0xFF00
#define BOTTOMWAY				0x00FF

/* IPC common definition */
#define SCI_ONE_BIT_MASK			(0x1)
#define SCI_ERR_MASK				(0x7)
#define SCI_ERR_SHIFT				(13)

#define SCI_CMD_IDX_MASK			(0x3F)
#define SCI_CMD_IDX_SHIFT			(0)
#define SCI_DATA_MASK				(0x3F)
#define SCI_DATA_SHIFT				(6)
#define SCI_IPC_DIR_SHIFT			(12)

#define SCI_CMD_GET(cmd_data, mask, shift)	((cmd_data & (mask << shift)) >> shift)
#define SCI_CMD_CLEAR(mask, shift)		(~(mask << shift))
#define SCI_CMD_SET(data, mask, shift)		((data & mask) << shift)

#define SCI_DBGGEN
#ifdef SCI_DBGGEN
#define SCI_DBG(x...)	pr_info("sci_dbg: " x)
#else
#define SCI_DBG(x...)	do {} while (0)
#endif

#define SCI_INFO(x...)	pr_info("sci_info: " x)
#define SCI_ERR(x...)	pr_err("sci_err: " x)

#if defined(CONFIG_SOC_S5E9925_EVT0)
#define CLEAR_GOV_ENCNT
#endif

enum exynos_sci_cmd_index {
	SCI_LLC_INVAL = 0,
	SCI_LLC_FLUSH_PRE,
	SCI_LLC_FLUSH_POST,
	SCI_LLC_REGION_ALLOC,
	SCI_LLC_EN,
	SCI_LLC_RET_EN,
	SCI_LLC_REGION_DEALLOC,
	SCI_LLC_REGION_PRIORITY,
	SCI_LLC_GET_REGION_INFO,
	SCI_LLC_CPU_MIN_REGION,
	SCI_LLC_SLICE_EN,
	SCI_LLC_SLICE_RET,
	SCI_LLC_QUADRANT_EN,
	SCI_VCH_SET,
	SCI_CMD_MAX,
};

enum exynos_sci_err_code {
	E_OK_S = 0,
	E_INVAL_S,
	E_BUSY_S,
};

enum exynos_sci_ipc_dir {
	SCI_IPC_GET = 0,
	SCI_IPC_SET,
};

enum exynos_sci_llc_region_index {
	LLC_REGION_DISABLE = 0,
	LLC_REGION_CPU, /* default policy */
	LLC_REGION_CALL,
	LLC_REGION_OFFLOAD,
	LLC_REGION_CPD2,
	LLC_REGION_CPCPU,
	LLC_REGION_DPU,
	LLC_REGION_MFC0_INT,
	LLC_REGION_MFC1_INT,
	LLC_REGION_MFC0_DPB,
	LLC_REGION_MFC1_DPB,
	LLC_REGION_GDC,
	LLC_REGION_MIGOV,
	LLC_REGION_GPU,
	LLC_REGION_NPU0,
	LLC_REGION_NPU1,
	LLC_REGION_NPU2,
	LLC_REGION_DSP0,
	LLC_REGION_DSP1,
	LLC_REGION_CAM_MCFP,
	LLC_REGION_CAM_CSIS,
	LLC_REGION_CP_MAX_TP,
	LLC_REGION_MAX,
};

struct exynos_sci_cmd_info {
	enum exynos_sci_cmd_index	cmd_index;
	enum exynos_sci_ipc_dir		direction;
	unsigned int			data;
};

struct exynos_llc_dump_data {
	u32				data_lo;
	u32				data_mi;
	u32				data_hi;
};

struct exynos_llc_dump_fmt {
	u16				slice;
	u16				bank;
	u16				set;
	u16				way;
	struct exynos_llc_dump_data	tag;
	struct exynos_llc_dump_data	data_q[LLC_DUMP_DATA_Q_SIZE];
} __attribute__((packed));

struct exynos_llc_dump_addr {
        u32                             p_addr;
        u32                             p_size;
        u32                             buff_size;
        void __iomem                    *v_addr;
};

struct exynos_sci_gov_data {
	struct mutex			lock;
	struct delayed_work		get_noti_work;
	unsigned int			llc_gov_en;
	unsigned int			en_cnt;
	unsigned int			llc_req_flag;
	unsigned int			hfreq_rate;
	unsigned int			freq_th;
	unsigned int			on_time_th;
	unsigned int			off_time_th;

	u64				start_time;
	u64				last_time;
	u64				high_time;
	u64				enabled_time;
};

struct exynos_sci_data {
	struct device			*dev;
	spinlock_t			lock;

	unsigned int			ipc_ch_num;
	unsigned int			ipc_ch_size;

	unsigned int			use_init_llc_region;
	unsigned int			initial_llc_region;
	unsigned int			llc_enable;
	unsigned int			ret_enable; /* retention */
	unsigned int			cpu_min_region;

	unsigned int			plugin_init_llc_region;
	unsigned int			llc_region_prio[LLC_REGION_MAX];
	unsigned int			llc_region_old[LLC_REGION_MAX];
	unsigned int			invway;

	void __iomem			*sci_base;
	struct exynos_llc_dump_addr	llc_dump_addr;
	const char			*region_name[LLC_REGION_MAX];
	unsigned int			region_priority[LLC_REGION_MAX];
	struct exynos_sci_gov_data	*gov_data;

	unsigned int			qpd_onoff[LLC_REGION_MAX];

	bool				llc_suspend_flag;
	bool				llc_disable_force_flag;

	unsigned int			vch_size;
	unsigned int			*vch_pd_calid;
};

#if defined(CONFIG_EXYNOS_SCI) || defined(CONFIG_EXYNOS_SCI_MODULE)
extern void llc_invalidate(unsigned int invway);
extern void llc_flush(unsigned int invway);
extern int llc_enable(bool on);
extern int llc_get_en(void);
extern unsigned int llc_get_region_info(unsigned int region_index);
extern int llc_region_alloc(unsigned int region_index, bool on, unsigned int way);
extern int llc_disable_force(bool off);
#else
static inline void llc_invalidate(unsigned int invway) {}
static inline void llc_flush(unsigned int invway) {}
static inline int llc_enable(bool on) { return -ENODEV; }
static inline int llc_get_en(void) { return 0; }
static inline unsigned int llc_get_region_info(void) { return -ENODEV; }
static inline int llc_region_alloc(unsigned int region_index, bool on, unsigned int way)
{
	return -ENODEV;
}
static inline int llc_disable_force(bool off) { return 0; }
#endif

#endif	/* __EXYNOS_SCI_H_ */