[Skiboot] [PATCH v5 2/7] vas: Define macros of constants and register fields

[Sukadev Bhattiprolu]

Define macros for the various Base Address Regions and Register fields
that are needed by VAS.

Signed-off-by: Sukadev Bhattiprolu <sukadev at linux.vnet.ibm.com>
---
Changelog[v4]:
	[Balbir Singh] Add a few missing abbreviations and fix up couple
		of macros for consistency.
	- Add VAS_WINDOWS_PER_CHIP

Changelog[v3]
	[Oliver O'Halloran] Fold vas.c and Makefile changes into next
		patch; remove unnecessary macros.
---
 include/vas.h | 156 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 156 insertions(+)
 create mode 100644 include/vas.h

diff --git a/include/vas.h b/include/vas.h
new file mode 100644
index 0000000..56e8a13
--- /dev/null
+++ b/include/vas.h
@@ -0,0 +1,156 @@
+/* Copyright 2013-2016 IBM Corp.
+ *
+ * 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.
+ */
+
+#ifndef __VAS_H
+#define __VAS_H
+
+#include <xscom.h>
+
+/*
+ * Abbreviations used in VAS:
+ *	WC:	Window Context
+ *	WCM:	Window Context MMIO
+ *	HVWC:	Hypervisor Window Context
+ *	UWC:	OS/User Window Context
+ *	UWCM:	OS/User Window Context MMIO
+ *	WIDM:	Window ID MMIO
+ *	BAR:	Base Address Register
+ *	BAMR:	Base Address Mask Register
+ *	N (S):	North (South)
+ *	CONTS	Contents
+ *	FIR:	Fault Isolation Register
+ *	RMA:	Real Mode Addressing
+ *	CQ:	(Power Bus) Common Queue
+ */
+
+extern void vas_init(void);
+
+/*
+ * HVWC and UWC BAR.
+ *
+ * A Power node can have (upto?) 8 Power chips.
+ *
+ * There is one instance of VAS in each Power chip. Each instance of VAS
+ * has 64K windows, which can be used to send/receive messages from
+ * software threads and coprocessors.
+ *
+ * Each window is described by two types of window contexts:
+ *
+ *      Hypervisor Window Context (HVWC) of size VAS_HVWC_SIZE bytes
+ *      OS/User Window Context (UWC) of size VAS_UWC_SIZE bytes.
+ *
+ * A window context can be viewed as a set of 64-bit registers. The settings
+ * of these registers control/determine the behavior of the VAS hardware
+ * when messages are sent/received through the window.
+ *
+ * Each Power chip i.e each instance of VAS, is assigned two distinct ranges
+ * (one for each type of context) of Power-bus addresses (aka Base Address
+ * Region or BAR) which can be used to access the window contexts in that
+ * instance of VAS.
+ *
+ * From the Power9 MMIO Ranges Spreadsheet:
+ *
+ * The HVWC BAR is of size 0x40000000000. For chip 0, the HVWC BAR begins
+ * at 0x6019000000000ULL, for chip 1 at 0x0006059000000000 etc.
+ *
+ * i.e the HVWC for each of the 64K windows on chip 0 can be accessed at the
+ * address 0x6019000000000ULL, and HVWC for the 64K windows on chip 1 can be
+ * accessed at the address 0x0006059000000000 and so on.
+ *
+ * Similarly, the UWC BAR is also of size 0x40000000000. For chip 0, UWC BAR
+ * begins at 0x0006019100000000, for chip 1 at 0x0006059100000000 etc.
+ *
+ * Following macros specify the HVWC and UWC BARs for chip 0. The BARs for
+ * the other chips are computed in get_hvwc_mmio_bar() and get_uwc_mmio_bar().
+ */
+#define VAS_HVWC_MMIO_BAR_BASE		0x0006019100000000ULL
+#define VAS_HVWC_MMIO_BAR_SIZE		0x40000000000
+
+#define VAS_UWC_MMIO_BAR_BASE		0x0006019000000000ULL
+#define VAS_UWC_MMIO_BAR_SIZE		0x40000000000
+
+/* Window Context Backing Store Size */
+#define VAS_WCBS_SIZE			0x800000        /* 8MB */
+
+/* Window context size of each window */
+#define VAS_WC_SIZE			512
+
+#define VAS_WINDOWS_PER_CHIP		65536		/* 64K */
+
+/*
+ * SCOM Base Address from P9 SCOM Assignment spreadsheet
+ */
+#define VAS_SCOM_BASE_ADDR		0x03011800
+
+/*
+ * NOTE: VAS_SCOM_BASE_ADDR (0x3011840) includes the SCOM ring of 6. So,
+ *	 setting the ring to 0 here.
+ *
+ *	 The satellite and offset values below are from "Table 3.1 VAS
+ *	 Internal Register Listing" of the P9 VAS Workbook.
+ */
+#define VAS_P9_SAT(sat, offset)		XSCOM_SAT(0x0, sat, offset)
+
+#define VAS_FIR0			VAS_P9_SAT(0x0, 0x0)
+#define VAS_FIR1			VAS_P9_SAT(0x0, 0x1)
+#define VAS_FIR2			VAS_P9_SAT(0x0, 0x2)
+#define VAS_FIR3			VAS_P9_SAT(0x0, 0x3)
+#define VAS_FIR4			VAS_P9_SAT(0x0, 0x4)
+#define VAS_FIR5			VAS_P9_SAT(0x0, 0x5)
+#define VAS_FIR6			VAS_P9_SAT(0x0, 0x6)
+#define VAS_FIR7			VAS_P9_SAT(0x0, 0x7)
+
+#define VAS_WCM_BAR			VAS_P9_SAT(0x0, 0xA)
+#define VAS_UWCM_BAR			VAS_P9_SAT(0x0, 0xB)
+#define VAS_BUF_CTL			VAS_P9_SAT(0x0, 0xC)
+#define VAS_MISC_N_CTL			VAS_P9_SAT(0x0,	0xD)
+#define VAS_RMA_BAR			VAS_P9_SAT(0x0, 0xE)
+#define VAS_RMA_BAMR			VAS_P9_SAT(0x0, 0xF)
+#define VAS_WIDM_CTL			VAS_P9_SAT(0x0, 0x29)
+#define VAS_WIDM_DATA			VAS_P9_SAT(0x0, 0x2A)
+#define VAS_IN_CERR_RPT_CONTS		VAS_P9_SAT(0x0, 0x2B)
+#define VAS_RG_CERR_RPT_CONTS		VAS_P9_SAT(0x0, 0x2B)
+#define VAS_WIDM_ECC			VAS_P9_SAT(0x0, 0x31)
+
+#define VAS_WCBS_BAR			VAS_P9_SAT(0x1, 0x0)
+#define VAS_CQ_CERR_RPT_CONTS		VAS_P9_SAT(0x1, 0x8)
+#define VAS_WC_CERR_RPT_CONTS		VAS_P9_SAT(0x1, 0x9)
+#define VAS_EG_CERR_RPT_CONTS		VAS_P9_SAT(0x1, 0xA)
+
+#define VAS_PB_CFG0			VAS_P9_SAT(0x1, 0xD)
+#define VAS_PB_CFG1			VAS_P9_SAT(0x1, 0xE)
+#define VAS_MISC_S_CTL			VAS_P9_SAT(0x1,	0xF)
+
+#define VAS_BUF_CTL_FREE_COUNT		PPC_BITMASK(49:55)
+#define VAS_BUF_CTL_USED_COUNT		PPC_BITMASK(57:63)
+#define VAS_RMA_BAR_ADDR		PPC_BITMASK(8, 51)
+#define VAS_RMA_BAMR_MASK		PPC_BITMASK(8, 51)
+
+/* Some VAS Miscellaneous Status and North Control Register bits. */
+#define VAS_64K_MODE_MASK		PPC_BIT(0)
+#define VAS_ACCEPT_PASTE_MASK		PPC_BIT(1)
+#define VAS_QUIESCE_REQ_MASK		PPC_BIT(4)
+#define VAS_HMI_ACTIVE_MASK		PPC_BIT(58)
+#define VAS_RG_IDLE_MASK		PPC_BIT(59)
+
+/* Some PowerBus Configuration Register 0 Bits */
+#define VAS_CQ_SCOM_HANG_POLL_MAX	PPC_BITMASK(7, 10)
+#define VAS_CQ_SCOM_HANG_NX_MAX		PPC_BITMASK(15, 18)
+
+#define VAS_RMA_BAR_ADDR_MASK		PPC_BITMASK(8, 51)
+#define VAS_RMA_BAMR_ADDR_MASK		PPC_BITMASK(8, 51)
+
+#endif
-- 
2.7.4