[mirror_ubuntu-artful-kernel.git] / arch / mips / include / asm / mips-cm.h

/*
 * Copyright (C) 2013 Imagination Technologies
 * Author: Paul Burton <paul.burton@imgtec.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 __MIPS_ASM_MIPS_CM_H__
#define __MIPS_ASM_MIPS_CM_H__

#include <linux/bitops.h>
#include <linux/errno.h>
#include <linux/io.h>
#include <linux/types.h>

/* The base address of the CM GCR block */
extern void __iomem *mips_cm_base;

/* The base address of the CM L2-only sync region */
extern void __iomem *mips_cm_l2sync_base;

/**
 * __mips_cm_phys_base - retrieve the physical base address of the CM
 *
 * This function returns the physical base address of the Coherence Manager
 * global control block, or 0 if no Coherence Manager is present. It provides
 * a default implementation which reads the CMGCRBase register where available,
 * and may be overridden by platforms which determine this address in a
 * different way by defining a function with the same prototype except for the
 * name mips_cm_phys_base (without underscores).
 */
extern phys_addr_t __mips_cm_phys_base(void);

/*
 * mips_cm_is64 - determine CM register width
 *
 * The CM register width is determined by the version of the CM, with CM3
 * introducing 64 bit GCRs and all prior CM versions having 32 bit GCRs.
 * However we may run a kernel built for MIPS32 on a system with 64 bit GCRs,
 * or vice-versa. This variable indicates the width of the memory accesses
 * that the kernel will perform to GCRs, which may differ from the actual
 * width of the GCRs.
 *
 * It's set to 0 for 32-bit accesses and 1 for 64-bit accesses.
 */
extern int mips_cm_is64;

/**
 * mips_cm_error_report - Report CM cache errors
 */
#ifdef CONFIG_MIPS_CM
extern void mips_cm_error_report(void);
#else
static inline void mips_cm_error_report(void) {}
#endif

/**
 * mips_cm_probe - probe for a Coherence Manager
 *
 * Attempt to detect the presence of a Coherence Manager. Returns 0 if a CM
 * is successfully detected, else -errno.
 */
#ifdef CONFIG_MIPS_CM
extern int mips_cm_probe(void);
#else
static inline int mips_cm_probe(void)
{
	return -ENODEV;
}
#endif

/**
 * mips_cm_present - determine whether a Coherence Manager is present
 *
 * Returns true if a CM is present in the system, else false.
 */
static inline bool mips_cm_present(void)
{
#ifdef CONFIG_MIPS_CM
	return mips_cm_base != NULL;
#else
	return false;
#endif
}

/**
 * mips_cm_has_l2sync - determine whether an L2-only sync region is present
 *
 * Returns true if the system implements an L2-only sync region, else false.
 */
static inline bool mips_cm_has_l2sync(void)
{
#ifdef CONFIG_MIPS_CM
	return mips_cm_l2sync_base != NULL;
#else
	return false;
#endif
}

/* Offsets to register blocks from the CM base address */
#define MIPS_CM_GCB_OFS		0x0000 /* Global Control Block */
#define MIPS_CM_CLCB_OFS	0x2000 /* Core Local Control Block */
#define MIPS_CM_COCB_OFS	0x4000 /* Core Other Control Block */
#define MIPS_CM_GDB_OFS		0x6000 /* Global Debug Block */

/* Total size of the CM memory mapped registers */
#define MIPS_CM_GCR_SIZE	0x8000

/* Size of the L2-only sync region */
#define MIPS_CM_L2SYNC_SIZE	0x1000

/* Macros to ease the creation of register access functions */
#define BUILD_CM_R_(name, off)					\
static inline unsigned long __iomem *addr_gcr_##name(void)	\
{								\
	return (unsigned long __iomem *)(mips_cm_base + (off));	\
}								\
								\
static inline u32 read32_gcr_##name(void)			\
{								\
	return __raw_readl(addr_gcr_##name());			\
}								\
								\
static inline u64 read64_gcr_##name(void)			\
{								\
	void __iomem *addr = addr_gcr_##name();			\
	u64 ret;						\
								\
	if (mips_cm_is64) {					\
		ret = __raw_readq(addr);			\
	} else {						\
		ret = __raw_readl(addr);			\
		ret |= (u64)__raw_readl(addr + 0x4) << 32;	\
	}							\
								\
	return ret;						\
}								\
								\
static inline unsigned long read_gcr_##name(void)		\
{								\
	if (mips_cm_is64)					\
		return read64_gcr_##name();			\
	else							\
		return read32_gcr_##name();			\
}

#define BUILD_CM__W(name, off)					\
static inline void write32_gcr_##name(u32 value)		\
{								\
	__raw_writel(value, addr_gcr_##name());			\
}								\
								\
static inline void write64_gcr_##name(u64 value)		\
{								\
	__raw_writeq(value, addr_gcr_##name());			\
}								\
								\
static inline void write_gcr_##name(unsigned long value)	\
{								\
	if (mips_cm_is64)					\
		write64_gcr_##name(value);			\
	else							\
		write32_gcr_##name(value);			\
}

#define BUILD_CM_RW(name, off)					\
	BUILD_CM_R_(name, off)					\
	BUILD_CM__W(name, off)

#define BUILD_CM_Cx_R_(name, off)				\
	BUILD_CM_R_(cl_##name, MIPS_CM_CLCB_OFS + (off))	\
	BUILD_CM_R_(co_##name, MIPS_CM_COCB_OFS + (off))

#define BUILD_CM_Cx__W(name, off)				\
	BUILD_CM__W(cl_##name, MIPS_CM_CLCB_OFS + (off))	\
	BUILD_CM__W(co_##name, MIPS_CM_COCB_OFS + (off))

#define BUILD_CM_Cx_RW(name, off)				\
	BUILD_CM_Cx_R_(name, off)				\
	BUILD_CM_Cx__W(name, off)

/* GCB register accessor functions */
BUILD_CM_R_(config,		MIPS_CM_GCB_OFS + 0x00)
BUILD_CM_RW(base,		MIPS_CM_GCB_OFS + 0x08)
BUILD_CM_RW(access,		MIPS_CM_GCB_OFS + 0x20)
BUILD_CM_R_(rev,		MIPS_CM_GCB_OFS + 0x30)
BUILD_CM_RW(err_control,	MIPS_CM_GCB_OFS + 0x38)
BUILD_CM_RW(error_mask,		MIPS_CM_GCB_OFS + 0x40)
BUILD_CM_RW(error_cause,	MIPS_CM_GCB_OFS + 0x48)
BUILD_CM_RW(error_addr,		MIPS_CM_GCB_OFS + 0x50)
BUILD_CM_RW(error_mult,		MIPS_CM_GCB_OFS + 0x58)
BUILD_CM_RW(l2_only_sync_base,	MIPS_CM_GCB_OFS + 0x70)
BUILD_CM_RW(gic_base,		MIPS_CM_GCB_OFS + 0x80)
BUILD_CM_RW(cpc_base,		MIPS_CM_GCB_OFS + 0x88)
BUILD_CM_RW(reg0_base,		MIPS_CM_GCB_OFS + 0x90)
BUILD_CM_RW(reg0_mask,		MIPS_CM_GCB_OFS + 0x98)
BUILD_CM_RW(reg1_base,		MIPS_CM_GCB_OFS + 0xa0)
BUILD_CM_RW(reg1_mask,		MIPS_CM_GCB_OFS + 0xa8)
BUILD_CM_RW(reg2_base,		MIPS_CM_GCB_OFS + 0xb0)
BUILD_CM_RW(reg2_mask,		MIPS_CM_GCB_OFS + 0xb8)
BUILD_CM_RW(reg3_base,		MIPS_CM_GCB_OFS + 0xc0)
BUILD_CM_RW(reg3_mask,		MIPS_CM_GCB_OFS + 0xc8)
BUILD_CM_R_(gic_status,		MIPS_CM_GCB_OFS + 0xd0)
BUILD_CM_R_(cpc_status,		MIPS_CM_GCB_OFS + 0xf0)
BUILD_CM_RW(l2_config,		MIPS_CM_GCB_OFS + 0x130)
BUILD_CM_RW(sys_config2,	MIPS_CM_GCB_OFS + 0x150)
BUILD_CM_RW(l2_pft_control,	MIPS_CM_GCB_OFS + 0x300)
BUILD_CM_RW(l2_pft_control_b,	MIPS_CM_GCB_OFS + 0x308)
BUILD_CM_RW(bev_base,		MIPS_CM_GCB_OFS + 0x680)

/* Core Local & Core Other register accessor functions */
BUILD_CM_Cx_RW(reset_release,	0x00)
BUILD_CM_Cx_RW(coherence,	0x08)
BUILD_CM_Cx_R_(config,		0x10)
BUILD_CM_Cx_RW(other,		0x18)
BUILD_CM_Cx_RW(reset_base,	0x20)
BUILD_CM_Cx_R_(id,		0x28)
BUILD_CM_Cx_RW(reset_ext_base,	0x30)
BUILD_CM_Cx_R_(tcid_0_priority,	0x40)
BUILD_CM_Cx_R_(tcid_1_priority,	0x48)
BUILD_CM_Cx_R_(tcid_2_priority,	0x50)
BUILD_CM_Cx_R_(tcid_3_priority,	0x58)
BUILD_CM_Cx_R_(tcid_4_priority,	0x60)
BUILD_CM_Cx_R_(tcid_5_priority,	0x68)
BUILD_CM_Cx_R_(tcid_6_priority,	0x70)
BUILD_CM_Cx_R_(tcid_7_priority,	0x78)
BUILD_CM_Cx_R_(tcid_8_priority,	0x80)

/* GCR_CONFIG register fields */
#define CM_GCR_CONFIG_NUMIOCU_SHF		8
#define CM_GCR_CONFIG_NUMIOCU_MSK		(_ULCAST_(0xf) << 8)
#define CM_GCR_CONFIG_PCORES_SHF		0
#define CM_GCR_CONFIG_PCORES_MSK		(_ULCAST_(0xff) << 0)

/* GCR_BASE register fields */
#define CM_GCR_BASE_GCRBASE_SHF			15
#define CM_GCR_BASE_GCRBASE_MSK			(_ULCAST_(0x1ffff) << 15)
#define CM_GCR_BASE_CMDEFTGT_SHF		0
#define CM_GCR_BASE_CMDEFTGT_MSK		(_ULCAST_(0x3) << 0)
#define  CM_GCR_BASE_CMDEFTGT_DISABLED		0
#define  CM_GCR_BASE_CMDEFTGT_MEM		1
#define  CM_GCR_BASE_CMDEFTGT_IOCU0		2
#define  CM_GCR_BASE_CMDEFTGT_IOCU1		3

/* GCR_RESET_EXT_BASE register fields */
#define CM_GCR_RESET_EXT_BASE_EVARESET		BIT(31)
#define CM_GCR_RESET_EXT_BASE_UEB		BIT(30)

/* GCR_ACCESS register fields */
#define CM_GCR_ACCESS_ACCESSEN_SHF		0
#define CM_GCR_ACCESS_ACCESSEN_MSK		(_ULCAST_(0xff) << 0)

/* GCR_REV register fields */
#define CM_GCR_REV_MAJOR_SHF			8
#define CM_GCR_REV_MAJOR_MSK			(_ULCAST_(0xff) << 8)
#define CM_GCR_REV_MINOR_SHF			0
#define CM_GCR_REV_MINOR_MSK			(_ULCAST_(0xff) << 0)

#define CM_ENCODE_REV(major, minor) \
		(((major) << CM_GCR_REV_MAJOR_SHF) | \
		 ((minor) << CM_GCR_REV_MINOR_SHF))

#define CM_REV_CM2				CM_ENCODE_REV(6, 0)
#define CM_REV_CM2_5				CM_ENCODE_REV(7, 0)
#define CM_REV_CM3				CM_ENCODE_REV(8, 0)

/* GCR_ERR_CONTROL register fields */
#define CM_GCR_ERR_CONTROL_L2_ECC_EN_SHF	1
#define CM_GCR_ERR_CONTROL_L2_ECC_EN_MSK	(_ULCAST_(0x1) << 1)
#define CM_GCR_ERR_CONTROL_L2_ECC_SUPPORT_SHF	0
#define CM_GCR_ERR_CONTROL_L2_ECC_SUPPORT_MSK	(_ULCAST_(0x1) << 0)

/* GCR_ERROR_CAUSE register fields */
#define CM_GCR_ERROR_CAUSE_ERRTYPE_SHF		27
#define CM_GCR_ERROR_CAUSE_ERRTYPE_MSK		(_ULCAST_(0x1f) << 27)
#define CM3_GCR_ERROR_CAUSE_ERRTYPE_SHF		58
#define CM3_GCR_ERROR_CAUSE_ERRTYPE_MSK		GENMASK_ULL(63, 58)
#define CM_GCR_ERROR_CAUSE_ERRINFO_SHF		0
#define CM_GCR_ERROR_CAUSE_ERRINGO_MSK		(_ULCAST_(0x7ffffff) << 0)

/* GCR_ERROR_MULT register fields */
#define CM_GCR_ERROR_MULT_ERR2ND_SHF		0
#define CM_GCR_ERROR_MULT_ERR2ND_MSK		(_ULCAST_(0x1f) << 0)

/* GCR_L2_ONLY_SYNC_BASE register fields */
#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCBASE_SHF	12
#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCBASE_MSK	(_ULCAST_(0xfffff) << 12)
#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCEN_SHF	0
#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCEN_MSK	(_ULCAST_(0x1) << 0)

/* GCR_GIC_BASE register fields */
#define CM_GCR_GIC_BASE_GICBASE_SHF		17
#define CM_GCR_GIC_BASE_GICBASE_MSK		(_ULCAST_(0x7fff) << 17)
#define CM_GCR_GIC_BASE_GICEN_SHF		0
#define CM_GCR_GIC_BASE_GICEN_MSK		(_ULCAST_(0x1) << 0)

/* GCR_CPC_BASE register fields */
#define CM_GCR_CPC_BASE_CPCBASE_SHF		15
#define CM_GCR_CPC_BASE_CPCBASE_MSK		(_ULCAST_(0x1ffff) << 15)
#define CM_GCR_CPC_BASE_CPCEN_SHF		0
#define CM_GCR_CPC_BASE_CPCEN_MSK		(_ULCAST_(0x1) << 0)

/* GCR_GIC_STATUS register fields */
#define CM_GCR_GIC_STATUS_GICEX_SHF		0
#define CM_GCR_GIC_STATUS_GICEX_MSK		(_ULCAST_(0x1) << 0)

/* GCR_REGn_BASE register fields */
#define CM_GCR_REGn_BASE_BASEADDR_SHF		16
#define CM_GCR_REGn_BASE_BASEADDR_MSK		(_ULCAST_(0xffff) << 16)

/* GCR_REGn_MASK register fields */
#define CM_GCR_REGn_MASK_ADDRMASK_SHF		16
#define CM_GCR_REGn_MASK_ADDRMASK_MSK		(_ULCAST_(0xffff) << 16)
#define CM_GCR_REGn_MASK_CCAOVR_SHF		5
#define CM_GCR_REGn_MASK_CCAOVR_MSK		(_ULCAST_(0x3) << 5)
#define CM_GCR_REGn_MASK_CCAOVREN_SHF		4
#define CM_GCR_REGn_MASK_CCAOVREN_MSK		(_ULCAST_(0x1) << 4)
#define CM_GCR_REGn_MASK_DROPL2_SHF		2
#define CM_GCR_REGn_MASK_DROPL2_MSK		(_ULCAST_(0x1) << 2)
#define CM_GCR_REGn_MASK_CMTGT_SHF		0
#define CM_GCR_REGn_MASK_CMTGT_MSK		(_ULCAST_(0x3) << 0)
#define  CM_GCR_REGn_MASK_CMTGT_DISABLED	(_ULCAST_(0x0) << 0)
#define  CM_GCR_REGn_MASK_CMTGT_MEM		(_ULCAST_(0x1) << 0)
#define  CM_GCR_REGn_MASK_CMTGT_IOCU0		(_ULCAST_(0x2) << 0)
#define  CM_GCR_REGn_MASK_CMTGT_IOCU1		(_ULCAST_(0x3) << 0)

/* GCR_GIC_STATUS register fields */
#define CM_GCR_GIC_STATUS_EX_SHF		0
#define CM_GCR_GIC_STATUS_EX_MSK		(_ULCAST_(0x1) << 0)

/* GCR_CPC_STATUS register fields */
#define CM_GCR_CPC_STATUS_EX_SHF		0
#define CM_GCR_CPC_STATUS_EX_MSK		(_ULCAST_(0x1) << 0)

/* GCR_L2_CONFIG register fields */
#define CM_GCR_L2_CONFIG_BYPASS_SHF		20
#define CM_GCR_L2_CONFIG_BYPASS_MSK		(_ULCAST_(0x1) << 20)
#define CM_GCR_L2_CONFIG_SET_SIZE_SHF		12
#define CM_GCR_L2_CONFIG_SET_SIZE_MSK		(_ULCAST_(0xf) << 12)
#define CM_GCR_L2_CONFIG_LINE_SIZE_SHF		8
#define CM_GCR_L2_CONFIG_LINE_SIZE_MSK		(_ULCAST_(0xf) << 8)
#define CM_GCR_L2_CONFIG_ASSOC_SHF		0
#define CM_GCR_L2_CONFIG_ASSOC_MSK		(_ULCAST_(0xff) << 0)

/* GCR_SYS_CONFIG2 register fields */
#define CM_GCR_SYS_CONFIG2_MAXVPW_SHF		0
#define CM_GCR_SYS_CONFIG2_MAXVPW_MSK		(_ULCAST_(0xf) << 0)

/* GCR_L2_PFT_CONTROL register fields */
#define CM_GCR_L2_PFT_CONTROL_PAGEMASK_SHF	12
#define CM_GCR_L2_PFT_CONTROL_PAGEMASK_MSK	(_ULCAST_(0xfffff) << 12)
#define CM_GCR_L2_PFT_CONTROL_PFTEN_SHF		8
#define CM_GCR_L2_PFT_CONTROL_PFTEN_MSK		(_ULCAST_(0x1) << 8)
#define CM_GCR_L2_PFT_CONTROL_NPFT_SHF		0
#define CM_GCR_L2_PFT_CONTROL_NPFT_MSK		(_ULCAST_(0xff) << 0)

/* GCR_L2_PFT_CONTROL_B register fields */
#define CM_GCR_L2_PFT_CONTROL_B_CEN_SHF		8
#define CM_GCR_L2_PFT_CONTROL_B_CEN_MSK		(_ULCAST_(0x1) << 8)
#define CM_GCR_L2_PFT_CONTROL_B_PORTID_SHF	0
#define CM_GCR_L2_PFT_CONTROL_B_PORTID_MSK	(_ULCAST_(0xff) << 0)

/* GCR_Cx_COHERENCE register fields */
#define CM_GCR_Cx_COHERENCE_COHDOMAINEN_SHF	0
#define CM_GCR_Cx_COHERENCE_COHDOMAINEN_MSK	(_ULCAST_(0xff) << 0)
#define CM3_GCR_Cx_COHERENCE_COHEN_MSK		(_ULCAST_(0x1) << 0)

/* GCR_Cx_CONFIG register fields */
#define CM_GCR_Cx_CONFIG_IOCUTYPE_SHF		10
#define CM_GCR_Cx_CONFIG_IOCUTYPE_MSK		(_ULCAST_(0x3) << 10)
#define CM_GCR_Cx_CONFIG_PVPE_SHF		0
#define CM_GCR_Cx_CONFIG_PVPE_MSK		(_ULCAST_(0x3ff) << 0)

/* GCR_Cx_OTHER register fields */
#define CM_GCR_Cx_OTHER_CORENUM_SHF		16
#define CM_GCR_Cx_OTHER_CORENUM_MSK		(_ULCAST_(0xffff) << 16)
#define CM3_GCR_Cx_OTHER_CORE_SHF		8
#define CM3_GCR_Cx_OTHER_CORE_MSK		(_ULCAST_(0x3f) << 8)
#define CM3_GCR_Cx_OTHER_VP_SHF			0
#define CM3_GCR_Cx_OTHER_VP_MSK			(_ULCAST_(0x7) << 0)

/* GCR_Cx_RESET_BASE register fields */
#define CM_GCR_Cx_RESET_BASE_BEVEXCBASE_SHF	12
#define CM_GCR_Cx_RESET_BASE_BEVEXCBASE_MSK	(_ULCAST_(0xfffff) << 12)

/* GCR_Cx_RESET_EXT_BASE register fields */
#define CM_GCR_Cx_RESET_EXT_BASE_EVARESET_SHF	31
#define CM_GCR_Cx_RESET_EXT_BASE_EVARESET_MSK	(_ULCAST_(0x1) << 31)
#define CM_GCR_Cx_RESET_EXT_BASE_UEB_SHF	30
#define CM_GCR_Cx_RESET_EXT_BASE_UEB_MSK	(_ULCAST_(0x1) << 30)
#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCMASK_SHF	20
#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCMASK_MSK	(_ULCAST_(0xff) << 20)
#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCPA_SHF	1
#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCPA_MSK	(_ULCAST_(0x7f) << 1)
#define CM_GCR_Cx_RESET_EXT_BASE_PRESENT_SHF	0
#define CM_GCR_Cx_RESET_EXT_BASE_PRESENT_MSK	(_ULCAST_(0x1) << 0)

/**
 * mips_cm_numcores - return the number of cores present in the system
 *
 * Returns the value of the PCORES field of the GCR_CONFIG register plus 1, or
 * zero if no Coherence Manager is present.
 */
static inline unsigned mips_cm_numcores(void)
{
	if (!mips_cm_present())
		return 0;

	return ((read_gcr_config() & CM_GCR_CONFIG_PCORES_MSK)
		>> CM_GCR_CONFIG_PCORES_SHF) + 1;
}

/**
 * mips_cm_numiocu - return the number of IOCUs present in the system
 *
 * Returns the value of the NUMIOCU field of the GCR_CONFIG register, or zero
 * if no Coherence Manager is present.
 */
static inline unsigned mips_cm_numiocu(void)
{
	if (!mips_cm_present())
		return 0;

	return (read_gcr_config() & CM_GCR_CONFIG_NUMIOCU_MSK)
		>> CM_GCR_CONFIG_NUMIOCU_SHF;
}

/**
 * mips_cm_l2sync - perform an L2-only sync operation
 *
 * If an L2-only sync region is present in the system then this function
 * performs and L2-only sync and returns zero. Otherwise it returns -ENODEV.
 */
static inline int mips_cm_l2sync(void)
{
	if (!mips_cm_has_l2sync())
		return -ENODEV;

	writel(0, mips_cm_l2sync_base);
	return 0;
}

/**
 * mips_cm_revision() - return CM revision
 *
 * Return: The revision of the CM, from GCR_REV, or 0 if no CM is present. The
 * return value should be checked against the CM_REV_* macros.
 */
static inline int mips_cm_revision(void)
{
	if (!mips_cm_present())
		return 0;

	return read_gcr_rev();
}

/**
 * mips_cm_max_vp_width() - return the width in bits of VP indices
 *
 * Return: the width, in bits, of VP indices in fields that combine core & VP
 * indices.
 */
static inline unsigned int mips_cm_max_vp_width(void)
{
	extern int smp_num_siblings;
	uint32_t cfg;

	if (mips_cm_revision() >= CM_REV_CM3)
		return read_gcr_sys_config2() & CM_GCR_SYS_CONFIG2_MAXVPW_MSK;

	if (mips_cm_present()) {
		/*
		 * We presume that all cores in the system will have the same
		 * number of VP(E)s, and if that ever changes then this will
		 * need revisiting.
		 */
		cfg = read_gcr_cl_config() & CM_GCR_Cx_CONFIG_PVPE_MSK;
		return (cfg >> CM_GCR_Cx_CONFIG_PVPE_SHF) + 1;
	}

	if (IS_ENABLED(CONFIG_SMP))
		return smp_num_siblings;

	return 1;
}

/**
 * mips_cm_vp_id() - calculate the hardware VP ID for a CPU
 * @cpu: the CPU whose VP ID to calculate
 *
 * Hardware such as the GIC uses identifiers for VPs which may not match the
 * CPU numbers used by Linux. This function calculates the hardware VP
 * identifier corresponding to a given CPU.
 *
 * Return: the VP ID for the CPU.
 */
static inline unsigned int mips_cm_vp_id(unsigned int cpu)
{
	unsigned int core = cpu_data[cpu].core;
	unsigned int vp = cpu_vpe_id(&cpu_data[cpu]);

	return (core * mips_cm_max_vp_width()) + vp;
}

#ifdef CONFIG_MIPS_CM

/**
 * mips_cm_lock_other - lock access to another core
 * @core: the other core to be accessed
 * @vp: the VP within the other core to be accessed
 *
 * Call before operating upon a core via the 'other' register region in
 * order to prevent the region being moved during access. Must be followed
 * by a call to mips_cm_unlock_other.
 */
extern void mips_cm_lock_other(unsigned int core, unsigned int vp);

/**
 * mips_cm_unlock_other - unlock access to another core
 *
 * Call after operating upon another core via the 'other' register region.
 * Must be called after mips_cm_lock_other.
 */
extern void mips_cm_unlock_other(void);

#else /* !CONFIG_MIPS_CM */

static inline void mips_cm_lock_other(unsigned int core, unsigned int vp) { }
static inline void mips_cm_unlock_other(void) { }

#endif /* !CONFIG_MIPS_CM */

#endif /* __MIPS_ASM_MIPS_CM_H__ */
Commit	Line	Data
9f98f3dd PB	1	/*
	2	* Copyright (C) 2013 Imagination Technologies
	3	* Author: Paul Burton <paul.burton@imgtec.com>
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License as published by the
	7	* Free Software Foundation; either version 2 of the License, or (at your
	8	* option) any later version.
	9	*/
	10
	11	#ifndef __MIPS_ASM_MIPS_CM_H__
	12	#define __MIPS_ASM_MIPS_CM_H__
	13
47b26a46	14	#include <linux/bitops.h>
56d4c99b	15	#include <linux/errno.h>
9f98f3dd PB	16	#include <linux/io.h>
	17	#include <linux/types.h>
	18
	19	/* The base address of the CM GCR block */
	20	extern void __iomem *mips_cm_base;
	21
	22	/* The base address of the CM L2-only sync region */
	23	extern void __iomem *mips_cm_l2sync_base;
	24
	25	/**
	26	* __mips_cm_phys_base - retrieve the physical base address of the CM
	27	*
	28	* This function returns the physical base address of the Coherence Manager
	29	* global control block, or 0 if no Coherence Manager is present. It provides
	30	* a default implementation which reads the CMGCRBase register where available,
92a76f6d	31	* and may be overridden by platforms which determine this address in a
9f98f3dd PB	32	* different way by defining a function with the same prototype except for the
	33	* name mips_cm_phys_base (without underscores).
	34	*/
15d45cce	35	extern phys_addr_t __mips_cm_phys_base(void);
9f98f3dd	36
c0b584a2 MC	37	/*
	38	* mips_cm_is64 - determine CM register width
	39	*
7784494a PB	40	* The CM register width is determined by the version of the CM, with CM3
	41	* introducing 64 bit GCRs and all prior CM versions having 32 bit GCRs.
	42	* However we may run a kernel built for MIPS32 on a system with 64 bit GCRs,
	43	* or vice-versa. This variable indicates the width of the memory accesses
	44	* that the kernel will perform to GCRs, which may differ from the actual
	45	* width of the GCRs.
c0b584a2 MC	46	*
	47	* It's set to 0 for 32-bit accesses and 1 for 64-bit accesses.
	48	*/
	49	extern int mips_cm_is64;
	50
3885c2b4 MC	51	/**
	52	* mips_cm_error_report - Report CM cache errors
	53	*/
	54	#ifdef CONFIG_MIPS_CM
	55	extern void mips_cm_error_report(void);
	56	#else
	57	static inline void mips_cm_error_report(void) {}
	58	#endif
	59
9f98f3dd PB	60	/**
	61	* mips_cm_probe - probe for a Coherence Manager
	62	*
	63	* Attempt to detect the presence of a Coherence Manager. Returns 0 if a CM
	64	* is successfully detected, else -errno.
	65	*/
	66	#ifdef CONFIG_MIPS_CM
	67	extern int mips_cm_probe(void);
	68	#else
	69	static inline int mips_cm_probe(void)
	70	{
	71	return -ENODEV;
	72	}
	73	#endif
	74
	75	/**
	76	* mips_cm_present - determine whether a Coherence Manager is present
	77	*
	78	* Returns true if a CM is present in the system, else false.
	79	*/
	80	static inline bool mips_cm_present(void)
	81	{
	82	#ifdef CONFIG_MIPS_CM
	83	return mips_cm_base != NULL;
	84	#else
	85	return false;
	86	#endif
	87	}
	88
	89	/**
	90	* mips_cm_has_l2sync - determine whether an L2-only sync region is present
	91	*
	92	* Returns true if the system implements an L2-only sync region, else false.
	93	*/
	94	static inline bool mips_cm_has_l2sync(void)
	95	{
	96	#ifdef CONFIG_MIPS_CM
	97	return mips_cm_l2sync_base != NULL;
	98	#else
	99	return false;
	100	#endif
	101	}
	102
	103	/* Offsets to register blocks from the CM base address */
	104	#define MIPS_CM_GCB_OFS 0x0000 /* Global Control Block */
	105	#define MIPS_CM_CLCB_OFS 0x2000 /* Core Local Control Block */
	106	#define MIPS_CM_COCB_OFS 0x4000 /* Core Other Control Block */
	107	#define MIPS_CM_GDB_OFS 0x6000 /* Global Debug Block */
	108
	109	/* Total size of the CM memory mapped registers */
	110	#define MIPS_CM_GCR_SIZE 0x8000
	111
	112	/* Size of the L2-only sync region */
	113	#define MIPS_CM_L2SYNC_SIZE 0x1000
	114
	115	/* Macros to ease the creation of register access functions */
	116	#define BUILD_CM_R_(name, off) \
c0b584a2	117	static inline unsigned long __iomem *addr_gcr_##name(void) \
9f98f3dd	118	{ \
c0b584a2	119	return (unsigned long __iomem *)(mips_cm_base + (off)); \
9f98f3dd PB	120	} \
9f98f3dd PB	121	\
c0b584a2	122	static inline u32 read32_gcr_##name(void) \
9f98f3dd	123	{ \
cd217546	124	return __raw_readl(addr_gcr_##name()); \
c0b584a2 MC	125	} \
	126	\
	127	static inline u64 read64_gcr_##name(void) \
	128	{ \
b657a628 PB	129	void __iomem *addr = addr_gcr_##name(); \
	130	u64 ret; \
	131	\
	132	if (mips_cm_is64) { \
	133	ret = __raw_readq(addr); \
	134	} else { \
	135	ret = __raw_readl(addr); \
	136	ret \|= (u64)__raw_readl(addr + 0x4) << 32; \
	137	} \
	138	\
	139	return ret; \
c0b584a2 MC	140	} \
	141	\
	142	static inline unsigned long read_gcr_##name(void) \
	143	{ \
	144	if (mips_cm_is64) \
	145	return read64_gcr_##name(); \
	146	else \
	147	return read32_gcr_##name(); \
9f98f3dd PB	148	}
	149
	150	#define BUILD_CM__W(name, off) \
c0b584a2	151	static inline void write32_gcr_##name(u32 value) \
9f98f3dd	152	{ \
cd217546	153	__raw_writel(value, addr_gcr_##name()); \
c0b584a2 MC	154	} \
	155	\
	156	static inline void write64_gcr_##name(u64 value) \
	157	{ \
	158	__raw_writeq(value, addr_gcr_##name()); \
	159	} \
	160	\
	161	static inline void write_gcr_##name(unsigned long value) \
	162	{ \
	163	if (mips_cm_is64) \
	164	write64_gcr_##name(value); \
	165	else \
	166	write32_gcr_##name(value); \
9f98f3dd PB	167	}
	168
	169	#define BUILD_CM_RW(name, off) \
	170	BUILD_CM_R_(name, off) \
	171	BUILD_CM__W(name, off)
	172
	173	#define BUILD_CM_Cx_R_(name, off) \
	174	BUILD_CM_R_(cl_##name, MIPS_CM_CLCB_OFS + (off)) \
	175	BUILD_CM_R_(co_##name, MIPS_CM_COCB_OFS + (off))
	176
	177	#define BUILD_CM_Cx__W(name, off) \
	178	BUILD_CM__W(cl_##name, MIPS_CM_CLCB_OFS + (off)) \
	179	BUILD_CM__W(co_##name, MIPS_CM_COCB_OFS + (off))
	180
	181	#define BUILD_CM_Cx_RW(name, off) \
	182	BUILD_CM_Cx_R_(name, off) \
	183	BUILD_CM_Cx__W(name, off)
	184
	185	/* GCB register accessor functions */
	186	BUILD_CM_R_(config, MIPS_CM_GCB_OFS + 0x00)
	187	BUILD_CM_RW(base, MIPS_CM_GCB_OFS + 0x08)
	188	BUILD_CM_RW(access, MIPS_CM_GCB_OFS + 0x20)
	189	BUILD_CM_R_(rev, MIPS_CM_GCB_OFS + 0x30)
35e6de38	190	BUILD_CM_RW(err_control, MIPS_CM_GCB_OFS + 0x38)
9f98f3dd PB	191	BUILD_CM_RW(error_mask, MIPS_CM_GCB_OFS + 0x40)
	192	BUILD_CM_RW(error_cause, MIPS_CM_GCB_OFS + 0x48)
	193	BUILD_CM_RW(error_addr, MIPS_CM_GCB_OFS + 0x50)
	194	BUILD_CM_RW(error_mult, MIPS_CM_GCB_OFS + 0x58)
	195	BUILD_CM_RW(l2_only_sync_base, MIPS_CM_GCB_OFS + 0x70)
	196	BUILD_CM_RW(gic_base, MIPS_CM_GCB_OFS + 0x80)
	197	BUILD_CM_RW(cpc_base, MIPS_CM_GCB_OFS + 0x88)
	198	BUILD_CM_RW(reg0_base, MIPS_CM_GCB_OFS + 0x90)
	199	BUILD_CM_RW(reg0_mask, MIPS_CM_GCB_OFS + 0x98)
	200	BUILD_CM_RW(reg1_base, MIPS_CM_GCB_OFS + 0xa0)
	201	BUILD_CM_RW(reg1_mask, MIPS_CM_GCB_OFS + 0xa8)
	202	BUILD_CM_RW(reg2_base, MIPS_CM_GCB_OFS + 0xb0)
	203	BUILD_CM_RW(reg2_mask, MIPS_CM_GCB_OFS + 0xb8)
	204	BUILD_CM_RW(reg3_base, MIPS_CM_GCB_OFS + 0xc0)
	205	BUILD_CM_RW(reg3_mask, MIPS_CM_GCB_OFS + 0xc8)
	206	BUILD_CM_R_(gic_status, MIPS_CM_GCB_OFS + 0xd0)
	207	BUILD_CM_R_(cpc_status, MIPS_CM_GCB_OFS + 0xf0)
0ba3c125	208	BUILD_CM_RW(l2_config, MIPS_CM_GCB_OFS + 0x130)
7573b94e	209	BUILD_CM_RW(sys_config2, MIPS_CM_GCB_OFS + 0x150)
4d035516 PB	210	BUILD_CM_RW(l2_pft_control, MIPS_CM_GCB_OFS + 0x300)
4d035516 PB	211	BUILD_CM_RW(l2_pft_control_b, MIPS_CM_GCB_OFS + 0x308)
db8e00af	212	BUILD_CM_RW(bev_base, MIPS_CM_GCB_OFS + 0x680)
9f98f3dd PB	213
	214	/* Core Local & Core Other register accessor functions */
	215	BUILD_CM_Cx_RW(reset_release, 0x00)
	216	BUILD_CM_Cx_RW(coherence, 0x08)
	217	BUILD_CM_Cx_R_(config, 0x10)
	218	BUILD_CM_Cx_RW(other, 0x18)
	219	BUILD_CM_Cx_RW(reset_base, 0x20)
	220	BUILD_CM_Cx_R_(id, 0x28)
	221	BUILD_CM_Cx_RW(reset_ext_base, 0x30)
	222	BUILD_CM_Cx_R_(tcid_0_priority, 0x40)
	223	BUILD_CM_Cx_R_(tcid_1_priority, 0x48)
	224	BUILD_CM_Cx_R_(tcid_2_priority, 0x50)
	225	BUILD_CM_Cx_R_(tcid_3_priority, 0x58)
	226	BUILD_CM_Cx_R_(tcid_4_priority, 0x60)
	227	BUILD_CM_Cx_R_(tcid_5_priority, 0x68)
	228	BUILD_CM_Cx_R_(tcid_6_priority, 0x70)
	229	BUILD_CM_Cx_R_(tcid_7_priority, 0x78)
	230	BUILD_CM_Cx_R_(tcid_8_priority, 0x80)
	231
	232	/* GCR_CONFIG register fields */
	233	#define CM_GCR_CONFIG_NUMIOCU_SHF 8
	234	#define CM_GCR_CONFIG_NUMIOCU_MSK (_ULCAST_(0xf) << 8)
	235	#define CM_GCR_CONFIG_PCORES_SHF 0
	236	#define CM_GCR_CONFIG_PCORES_MSK (_ULCAST_(0xff) << 0)
	237
	238	/* GCR_BASE register fields */
	239	#define CM_GCR_BASE_GCRBASE_SHF 15
	240	#define CM_GCR_BASE_GCRBASE_MSK (_ULCAST_(0x1ffff) << 15)
	241	#define CM_GCR_BASE_CMDEFTGT_SHF 0
	242	#define CM_GCR_BASE_CMDEFTGT_MSK (_ULCAST_(0x3) << 0)
	243	#define CM_GCR_BASE_CMDEFTGT_DISABLED 0
	244	#define CM_GCR_BASE_CMDEFTGT_MEM 1
	245	#define CM_GCR_BASE_CMDEFTGT_IOCU0 2
	246	#define CM_GCR_BASE_CMDEFTGT_IOCU1 3
	247
497e803e MR	248	/* GCR_RESET_EXT_BASE register fields */
	249	#define CM_GCR_RESET_EXT_BASE_EVARESET BIT(31)
	250	#define CM_GCR_RESET_EXT_BASE_UEB BIT(30)
	251
9f98f3dd PB	252	/* GCR_ACCESS register fields */
	253	#define CM_GCR_ACCESS_ACCESSEN_SHF 0
	254	#define CM_GCR_ACCESS_ACCESSEN_MSK (_ULCAST_(0xff) << 0)
	255
	256	/* GCR_REV register fields */
	257	#define CM_GCR_REV_MAJOR_SHF 8
	258	#define CM_GCR_REV_MAJOR_MSK (_ULCAST_(0xff) << 8)
	259	#define CM_GCR_REV_MINOR_SHF 0
	260	#define CM_GCR_REV_MINOR_MSK (_ULCAST_(0xff) << 0)
	261
197e89e0 PB	262	#define CM_ENCODE_REV(major, minor) \
	263	(((major) << CM_GCR_REV_MAJOR_SHF) \| \
	264	((minor) << CM_GCR_REV_MINOR_SHF))
	265
	266	#define CM_REV_CM2 CM_ENCODE_REV(6, 0)
4d035516	267	#define CM_REV_CM2_5 CM_ENCODE_REV(7, 0)
197e89e0 PB	268	#define CM_REV_CM3 CM_ENCODE_REV(8, 0)
197e89e0 PB	269
35e6de38 PB	270	/* GCR_ERR_CONTROL register fields */
	271	#define CM_GCR_ERR_CONTROL_L2_ECC_EN_SHF 1
	272	#define CM_GCR_ERR_CONTROL_L2_ECC_EN_MSK (_ULCAST_(0x1) << 1)
	273	#define CM_GCR_ERR_CONTROL_L2_ECC_SUPPORT_SHF 0
	274	#define CM_GCR_ERR_CONTROL_L2_ECC_SUPPORT_MSK (_ULCAST_(0x1) << 0)
	275
9f98f3dd PB	276	/* GCR_ERROR_CAUSE register fields */
	277	#define CM_GCR_ERROR_CAUSE_ERRTYPE_SHF 27
	278	#define CM_GCR_ERROR_CAUSE_ERRTYPE_MSK (_ULCAST_(0x1f) << 27)
47b26a46 PB	279	#define CM3_GCR_ERROR_CAUSE_ERRTYPE_SHF 58
47b26a46 PB	280	#define CM3_GCR_ERROR_CAUSE_ERRTYPE_MSK GENMASK_ULL(63, 58)
9f98f3dd PB	281	#define CM_GCR_ERROR_CAUSE_ERRINFO_SHF 0
	282	#define CM_GCR_ERROR_CAUSE_ERRINGO_MSK (_ULCAST_(0x7ffffff) << 0)
	283
	284	/* GCR_ERROR_MULT register fields */
	285	#define CM_GCR_ERROR_MULT_ERR2ND_SHF 0
	286	#define CM_GCR_ERROR_MULT_ERR2ND_MSK (_ULCAST_(0x1f) << 0)
	287
	288	/* GCR_L2_ONLY_SYNC_BASE register fields */
	289	#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCBASE_SHF 12
	290	#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCBASE_MSK (_ULCAST_(0xfffff) << 12)
	291	#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCEN_SHF 0
	292	#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCEN_MSK (_ULCAST_(0x1) << 0)
	293
	294	/* GCR_GIC_BASE register fields */
	295	#define CM_GCR_GIC_BASE_GICBASE_SHF 17
	296	#define CM_GCR_GIC_BASE_GICBASE_MSK (_ULCAST_(0x7fff) << 17)
	297	#define CM_GCR_GIC_BASE_GICEN_SHF 0
	298	#define CM_GCR_GIC_BASE_GICEN_MSK (_ULCAST_(0x1) << 0)
	299
	300	/* GCR_CPC_BASE register fields */
e03ac9f0 NM	301	#define CM_GCR_CPC_BASE_CPCBASE_SHF 15
e03ac9f0 NM	302	#define CM_GCR_CPC_BASE_CPCBASE_MSK (_ULCAST_(0x1ffff) << 15)
9f98f3dd PB	303	#define CM_GCR_CPC_BASE_CPCEN_SHF 0
	304	#define CM_GCR_CPC_BASE_CPCEN_MSK (_ULCAST_(0x1) << 0)
	305
921d55e3 PB	306	/* GCR_GIC_STATUS register fields */
	307	#define CM_GCR_GIC_STATUS_GICEX_SHF 0
	308	#define CM_GCR_GIC_STATUS_GICEX_MSK (_ULCAST_(0x1) << 0)
	309
9f98f3dd PB	310	/* GCR_REGn_BASE register fields */
	311	#define CM_GCR_REGn_BASE_BASEADDR_SHF 16
	312	#define CM_GCR_REGn_BASE_BASEADDR_MSK (_ULCAST_(0xffff) << 16)
	313
	314	/* GCR_REGn_MASK register fields */
	315	#define CM_GCR_REGn_MASK_ADDRMASK_SHF 16
	316	#define CM_GCR_REGn_MASK_ADDRMASK_MSK (_ULCAST_(0xffff) << 16)
	317	#define CM_GCR_REGn_MASK_CCAOVR_SHF 5
	318	#define CM_GCR_REGn_MASK_CCAOVR_MSK (_ULCAST_(0x3) << 5)
	319	#define CM_GCR_REGn_MASK_CCAOVREN_SHF 4
	320	#define CM_GCR_REGn_MASK_CCAOVREN_MSK (_ULCAST_(0x1) << 4)
	321	#define CM_GCR_REGn_MASK_DROPL2_SHF 2
	322	#define CM_GCR_REGn_MASK_DROPL2_MSK (_ULCAST_(0x1) << 2)
	323	#define CM_GCR_REGn_MASK_CMTGT_SHF 0
	324	#define CM_GCR_REGn_MASK_CMTGT_MSK (_ULCAST_(0x3) << 0)
	325	#define CM_GCR_REGn_MASK_CMTGT_DISABLED (_ULCAST_(0x0) << 0)
	326	#define CM_GCR_REGn_MASK_CMTGT_MEM (_ULCAST_(0x1) << 0)
	327	#define CM_GCR_REGn_MASK_CMTGT_IOCU0 (_ULCAST_(0x2) << 0)
	328	#define CM_GCR_REGn_MASK_CMTGT_IOCU1 (_ULCAST_(0x3) << 0)
	329
	330	/* GCR_GIC_STATUS register fields */
	331	#define CM_GCR_GIC_STATUS_EX_SHF 0
	332	#define CM_GCR_GIC_STATUS_EX_MSK (_ULCAST_(0x1) << 0)
	333
	334	/* GCR_CPC_STATUS register fields */
	335	#define CM_GCR_CPC_STATUS_EX_SHF 0
	336	#define CM_GCR_CPC_STATUS_EX_MSK (_ULCAST_(0x1) << 0)
	337
0ba3c125 PB	338	/* GCR_L2_CONFIG register fields */
	339	#define CM_GCR_L2_CONFIG_BYPASS_SHF 20
	340	#define CM_GCR_L2_CONFIG_BYPASS_MSK (_ULCAST_(0x1) << 20)
	341	#define CM_GCR_L2_CONFIG_SET_SIZE_SHF 12
	342	#define CM_GCR_L2_CONFIG_SET_SIZE_MSK (_ULCAST_(0xf) << 12)
	343	#define CM_GCR_L2_CONFIG_LINE_SIZE_SHF 8
	344	#define CM_GCR_L2_CONFIG_LINE_SIZE_MSK (_ULCAST_(0xf) << 8)
	345	#define CM_GCR_L2_CONFIG_ASSOC_SHF 0
	346	#define CM_GCR_L2_CONFIG_ASSOC_MSK (_ULCAST_(0xff) << 0)
	347
7573b94e PB	348	/* GCR_SYS_CONFIG2 register fields */
	349	#define CM_GCR_SYS_CONFIG2_MAXVPW_SHF 0
	350	#define CM_GCR_SYS_CONFIG2_MAXVPW_MSK (_ULCAST_(0xf) << 0)
	351
4d035516 PB	352	/* GCR_L2_PFT_CONTROL register fields */
	353	#define CM_GCR_L2_PFT_CONTROL_PAGEMASK_SHF 12
	354	#define CM_GCR_L2_PFT_CONTROL_PAGEMASK_MSK (_ULCAST_(0xfffff) << 12)
	355	#define CM_GCR_L2_PFT_CONTROL_PFTEN_SHF 8
	356	#define CM_GCR_L2_PFT_CONTROL_PFTEN_MSK (_ULCAST_(0x1) << 8)
	357	#define CM_GCR_L2_PFT_CONTROL_NPFT_SHF 0
	358	#define CM_GCR_L2_PFT_CONTROL_NPFT_MSK (_ULCAST_(0xff) << 0)
	359
	360	/* GCR_L2_PFT_CONTROL_B register fields */
	361	#define CM_GCR_L2_PFT_CONTROL_B_CEN_SHF 8
	362	#define CM_GCR_L2_PFT_CONTROL_B_CEN_MSK (_ULCAST_(0x1) << 8)
	363	#define CM_GCR_L2_PFT_CONTROL_B_PORTID_SHF 0
	364	#define CM_GCR_L2_PFT_CONTROL_B_PORTID_MSK (_ULCAST_(0xff) << 0)
	365
9f98f3dd PB	366	/* GCR_Cx_COHERENCE register fields */
	367	#define CM_GCR_Cx_COHERENCE_COHDOMAINEN_SHF 0
	368	#define CM_GCR_Cx_COHERENCE_COHDOMAINEN_MSK (_ULCAST_(0xff) << 0)
77451997	369	#define CM3_GCR_Cx_COHERENCE_COHEN_MSK (_ULCAST_(0x1) << 0)
9f98f3dd PB	370
	371	/* GCR_Cx_CONFIG register fields */
	372	#define CM_GCR_Cx_CONFIG_IOCUTYPE_SHF 10
	373	#define CM_GCR_Cx_CONFIG_IOCUTYPE_MSK (_ULCAST_(0x3) << 10)
	374	#define CM_GCR_Cx_CONFIG_PVPE_SHF 0
252d6aa6	375	#define CM_GCR_Cx_CONFIG_PVPE_MSK (_ULCAST_(0x3ff) << 0)
9f98f3dd PB	376
	377	/* GCR_Cx_OTHER register fields */
	378	#define CM_GCR_Cx_OTHER_CORENUM_SHF 16
	379	#define CM_GCR_Cx_OTHER_CORENUM_MSK (_ULCAST_(0xffff) << 16)
23d5de8e PB	380	#define CM3_GCR_Cx_OTHER_CORE_SHF 8
	381	#define CM3_GCR_Cx_OTHER_CORE_MSK (_ULCAST_(0x3f) << 8)
	382	#define CM3_GCR_Cx_OTHER_VP_SHF 0
	383	#define CM3_GCR_Cx_OTHER_VP_MSK (_ULCAST_(0x7) << 0)
9f98f3dd PB	384
	385	/* GCR_Cx_RESET_BASE register fields */
	386	#define CM_GCR_Cx_RESET_BASE_BEVEXCBASE_SHF 12
	387	#define CM_GCR_Cx_RESET_BASE_BEVEXCBASE_MSK (_ULCAST_(0xfffff) << 12)
	388
	389	/* GCR_Cx_RESET_EXT_BASE register fields */
	390	#define CM_GCR_Cx_RESET_EXT_BASE_EVARESET_SHF 31
	391	#define CM_GCR_Cx_RESET_EXT_BASE_EVARESET_MSK (_ULCAST_(0x1) << 31)
	392	#define CM_GCR_Cx_RESET_EXT_BASE_UEB_SHF 30
	393	#define CM_GCR_Cx_RESET_EXT_BASE_UEB_MSK (_ULCAST_(0x1) << 30)
	394	#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCMASK_SHF 20
	395	#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCMASK_MSK (_ULCAST_(0xff) << 20)
	396	#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCPA_SHF 1
	397	#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCPA_MSK (_ULCAST_(0x7f) << 1)
	398	#define CM_GCR_Cx_RESET_EXT_BASE_PRESENT_SHF 0
	399	#define CM_GCR_Cx_RESET_EXT_BASE_PRESENT_MSK (_ULCAST_(0x1) << 0)
	400
	401	/**
	402	* mips_cm_numcores - return the number of cores present in the system
	403	*
	404	* Returns the value of the PCORES field of the GCR_CONFIG register plus 1, or
	405	* zero if no Coherence Manager is present.
	406	*/
	407	static inline unsigned mips_cm_numcores(void)
	408	{
	409	if (!mips_cm_present())
	410	return 0;
	411
	412	return ((read_gcr_config() & CM_GCR_CONFIG_PCORES_MSK)
	413	>> CM_GCR_CONFIG_PCORES_SHF) + 1;
	414	}
	415
	416	/**
	417	* mips_cm_numiocu - return the number of IOCUs present in the system
	418	*
	419	* Returns the value of the NUMIOCU field of the GCR_CONFIG register, or zero
	420	* if no Coherence Manager is present.
	421	*/
	422	static inline unsigned mips_cm_numiocu(void)
	423	{
	424	if (!mips_cm_present())
	425	return 0;
	426
	427	return (read_gcr_config() & CM_GCR_CONFIG_NUMIOCU_MSK)
	428	>> CM_GCR_CONFIG_NUMIOCU_SHF;
	429	}
	430
	431	/**
	432	* mips_cm_l2sync - perform an L2-only sync operation
	433	*
	434	* If an L2-only sync region is present in the system then this function
	435	* performs and L2-only sync and returns zero. Otherwise it returns -ENODEV.
	436	*/
	437	static inline int mips_cm_l2sync(void)
	438	{
	439	if (!mips_cm_has_l2sync())
	440	return -ENODEV;
	441
	442	writel(0, mips_cm_l2sync_base);
	443	return 0;
	444	}
	445
197e89e0 PB	446	/**
	447	* mips_cm_revision() - return CM revision
	448	*
	449	* Return: The revision of the CM, from GCR_REV, or 0 if no CM is present. The
	450	* return value should be checked against the CM_REV_* macros.
	451	*/
	452	static inline int mips_cm_revision(void)
	453	{
	454	if (!mips_cm_present())
	455	return 0;
	456
	457	return read_gcr_rev();
	458	}
	459
7573b94e PB	460	/**
	461	* mips_cm_max_vp_width() - return the width in bits of VP indices
	462	*
	463	* Return: the width, in bits, of VP indices in fields that combine core & VP
	464	* indices.
	465	*/
	466	static inline unsigned int mips_cm_max_vp_width(void)
	467	{
	468	extern int smp_num_siblings;
6605d156	469	uint32_t cfg;
7573b94e PB	470
	471	if (mips_cm_revision() >= CM_REV_CM3)
	472	return read_gcr_sys_config2() & CM_GCR_SYS_CONFIG2_MAXVPW_MSK;
	473
6605d156 PB	474	if (mips_cm_present()) {
	475	/*
	476	* We presume that all cores in the system will have the same
	477	* number of VP(E)s, and if that ever changes then this will
	478	* need revisiting.
	479	*/
	480	cfg = read_gcr_cl_config() & CM_GCR_Cx_CONFIG_PVPE_MSK;
	481	return (cfg >> CM_GCR_Cx_CONFIG_PVPE_SHF) + 1;
	482	}
	483
97f2645f	484	if (IS_ENABLED(CONFIG_SMP))
a60ae81e PB	485	return smp_num_siblings;
	486
	487	return 1;
7573b94e PB	488	}
	489
	490	/**
	491	* mips_cm_vp_id() - calculate the hardware VP ID for a CPU
	492	* @cpu: the CPU whose VP ID to calculate
	493	*
	494	* Hardware such as the GIC uses identifiers for VPs which may not match the
	495	* CPU numbers used by Linux. This function calculates the hardware VP
	496	* identifier corresponding to a given CPU.
	497	*
	498	* Return: the VP ID for the CPU.
	499	*/
	500	static inline unsigned int mips_cm_vp_id(unsigned int cpu)
	501	{
	502	unsigned int core = cpu_data[cpu].core;
	503	unsigned int vp = cpu_vpe_id(&cpu_data[cpu]);
	504
	505	return (core * mips_cm_max_vp_width()) + vp;
	506	}
	507
23d5de8e PB	508	#ifdef CONFIG_MIPS_CM
	509
	510	/**
	511	* mips_cm_lock_other - lock access to another core
	512	* @core: the other core to be accessed
	513	* @vp: the VP within the other core to be accessed
	514	*
	515	* Call before operating upon a core via the 'other' register region in
	516	* order to prevent the region being moved during access. Must be followed
	517	* by a call to mips_cm_unlock_other.
	518	*/
	519	extern void mips_cm_lock_other(unsigned int core, unsigned int vp);
	520
	521	/**
	522	* mips_cm_unlock_other - unlock access to another core
	523	*
	524	* Call after operating upon another core via the 'other' register region.
	525	* Must be called after mips_cm_lock_other.
	526	*/
	527	extern void mips_cm_unlock_other(void);
	528
	529	#else /* !CONFIG_MIPS_CM */
	530
0868971a	531	static inline void mips_cm_lock_other(unsigned int core, unsigned int vp) { }
23d5de8e PB	532	static inline void mips_cm_unlock_other(void) { }
	533
	534	#endif /* !CONFIG_MIPS_CM */
	535
9f98f3dd	536	#endif /* __MIPS_ASM_MIPS_CM_H__ */