skylake: sanitize pcr header for ACPI and assembler

Remove the C types and functions from PCR so that pcr.h
can be included from assembly and ACPI. While in there
make the PCR reg caclulation using a C function and
place the P2SB (PCH_PCR_BASE_ADDRESS) address in iomap.h.

BUG=None
BRANCH=None
TEST=Built and booted glados.

Change-Id: I9cde178bcdbf49327ef7892393fc277f6c74f34b
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: fdf5c77ecfa0ca8d3c45604d15b9dec9a6e85193
Original-Change-Id: I5996efaa9869f8f412e4d45c13f30233384a38b2
Original-Signed-off-by: Aaron Durbin <adurbin@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/286901
Original-Reviewed-by: Duncan Laurie <dlaurie@chromium.org>
Reviewed-on: http://review.coreboot.org/11030
Tested-by: build bot (Jenkins)
Reviewed-by: Aaron Durbin <adurbin@chromium.org>

3 files changed, 61 insertions, 59 deletions

diff --git a/src/soc/intel/skylake/include/soc/iomap.h b/src/soc/intel/skylake/include/soc/iomap.h
index 05c5419f49..920b6f6655 100644
--- a/src/soc/intel/skylake/include/soc/iomap.h
+++ b/src/soc/intel/skylake/include/soc/iomap.h
@@ -24,6 +24,9 @@
 #define MCFG_BASE_ADDRESS	CONFIG_MMCONF_BASE_ADDRESS
 #define MCFG_BASE_SIZE		0x4000000
 
+#define PCH_PCR_BASE_ADDRESS	0xfd000000
+#define PCH_BCR_BASE_SIZE	0x1000000
+
 #define MCH_BASE_ADDRESS	0xfed10000
 #define MCH_BASE_SIZE		0x8000
 
diff --git a/src/soc/intel/skylake/include/soc/pcr.h b/src/soc/intel/skylake/include/soc/pcr.h
index a6987cb33a..3f8ee2f281 100644
--- a/src/soc/intel/skylake/include/soc/pcr.h
+++ b/src/soc/intel/skylake/include/soc/pcr.h
@@ -20,8 +20,9 @@
  * Primary to sideband (P2SB) for private configuration registers (PCR).
  */
 
-/* PCH (SunRisePoint LP) */
-#define PCH_PCR_BASE_ADDRESS	0xFD000000
+/* Port Id lives in bits 23:16 and register offset lives in 15:0 of address. */
+#define PCR_PORTID_SHIFT	16
+#define PCR_OFFSET_SHIFT	0
 
 /* DMI Control Register */
 #define R_PCH_PCR_DMI_DMIC	0x2234
@@ -70,38 +71,30 @@
 #define SIO_PCH_LEGACY_UART2		(1 << 2)
 
 /*
- * Definition for PCR address
- * The PCR address is used to the PCR MMIO programming
+ * P2SB port ids.
  */
-#define PCH_PCR_ADDRESS(pid, offset)	(void *)(\
-	PCH_PCR_BASE_ADDRESS | ((u8)(pid) << 16) | (u16)(offset))
+#define PID_PSTH	0x89
+#define PID_GPIOCOM3	0xAC
+#define PID_GPIOCOM2	0xAD
+#define PID_GPIOCOM1	0xAE
+#define PID_GPIOCOM0	0xAF
+#define PID_LPC		0xC7
+#define PID_ITSS	0xC4
+#define PID_RTC		0xC3
+#define PID_SERIALIO	0xCB
+#define PID_DMI		0xEF
 
-/*
- * Definition for SBI PID
- * The PCH_SBI_PID defines the PID for PCR MMIO programming and
- * PCH SBI programming as well.
- */
-typedef enum {
-	PID_PSTH = 0x89,
-	PID_GPIOCOM3 = 0xAC,
-	PID_GPIOCOM2 = 0xAD,
-	PID_GPIOCOM1 = 0xAE,
-	PID_GPIOCOM0 = 0xAF,
-	PID_LPC = 0xC7,
-	PID_ITSS = 0xC4,
-	PID_RTC = 0xC3,
-	PID_SERIALIO = 0xCB,
-	PID_DMI = 0xEF,
-} PCH_SBI_PID;
-
-u8 pcr_read32(PCH_SBI_PID pid, u16 offset, u32 *outdata);
-u8 pcr_read16(PCH_SBI_PID pid, u16 offset, u16 *outdata);
-u8 pcr_read8(PCH_SBI_PID pid, u16 offset, u8 *outdata);
-u8 pcr_write32(PCH_SBI_PID pid, u16 offset, u32 indata);
-u8 pcr_write16(PCH_SBI_PID pid, u16 offset, u16 indata);
-u8 pcr_write8(PCH_SBI_PID pid, u16 offset, u8 indata);
-u8 pcr_andthenor32(PCH_SBI_PID pid, u16 offset, u32 anddata, u32 ordata);
-u8 pcr_andthenor16(PCH_SBI_PID pid, u16 offset, u16 anddata, u16 ordata);
-u8 pcr_andthenor8(PCH_SBI_PID pid, u16 offset, u8 anddata, u8 ordata);
+#if !defined(__ASSEMBLER__) && !defined(__ACPI__)
+/* All these return 0 on success and < 0 on errror. */
+int pcr_read32(u8 pid, u16 offset, u32 *outdata);
+int pcr_read16(u8 pid, u16 offset, u16 *outdata);
+int pcr_read8(u8 pid, u16 offset, u8 *outdata);
+int pcr_write32(u8 pid, u16 offset, u32 indata);
+int pcr_write16(u8 pid, u16 offset, u16 indata);
+int pcr_write8(u8 pid, u16 offset, u8 indata);
+int pcr_andthenor32(u8 pid, u16 offset, u32 anddata, u32 ordata);
+int pcr_andthenor16(u8 pid, u16 offset, u16 anddata, u16 ordata);
+int pcr_andthenor8(u8 pid, u16 offset, u8 anddata, u8 ordata);
+#endif /* if !defined(__ASSEMBLER__) && !defined(__ACPI__) */
 
 #endif /* _SOC_PCR_H_ */
diff --git a/src/soc/intel/skylake/pcr.c b/src/soc/intel/skylake/pcr.c
index 79c32f90a7..0e97265497 100644
--- a/src/soc/intel/skylake/pcr.c
+++ b/src/soc/intel/skylake/pcr.c
@@ -22,15 +22,24 @@
 #include <soc/iomap.h>
 #include <console/console.h>
 
+static inline void *pcr_reg_address(u8 pid, u16 offset)
+{
+	uintptr_t reg_addr;
+
+	/* Create an address based off of port id and offset. */
+	reg_addr = PCH_PCR_BASE_ADDRESS;
+	reg_addr += ((uintptr_t)pid) << PCR_PORTID_SHIFT;
+	reg_addr += ((uintptr_t)offset) << PCR_OFFSET_SHIFT;
+
+	return (void *)reg_addr;
+}
+
 /*
  * Read PCR register. (This is internal function)
  * It returns PCR register and size in 1/2/4 bytes.
  * The offset should not exceed 0xFFFF and must be aligned with size
- *
- * PCH_SBI_PID defines as 8 bit Port ID that will be used when sending
- * transaction to sideband.
  */
-static u8 pch_pcr_read(PCH_SBI_PID pid, u16 offset, u32 size, void *data)
+static int pch_pcr_read(u8 pid, u16 offset, u32 size, void *data)
 {
 	if ((offset & (size - 1)) != 0) {
 		printk(BIOS_DEBUG,
@@ -40,13 +49,13 @@ static u8 pch_pcr_read(PCH_SBI_PID pid, u16 offset, u32 size, void *data)
 	}
 	switch (size) {
 	case 4:
-		*(u32 *) data = read32(PCH_PCR_ADDRESS(pid, offset));
+		*(u32 *) data = read32(pcr_reg_address(pid, offset));
 		break;
 	case 2:
-		*(u16 *) data = read16(PCH_PCR_ADDRESS(pid, offset));
+		*(u16 *) data = read16(pcr_reg_address(pid, offset));
 		break;
 	case 1:
-		*(u8 *) data = read8(PCH_PCR_ADDRESS(pid, offset));
+		*(u8 *) data = read8(pcr_reg_address(pid, offset));
 		break;
 	default:
 		break;
@@ -54,17 +63,17 @@ static u8 pch_pcr_read(PCH_SBI_PID pid, u16 offset, u32 size, void *data)
 	return 0;
 }
 
-u8 pcr_read32(PCH_SBI_PID pid, u16 offset, u32 *outdata)
+int pcr_read32(u8 pid, u16 offset, u32 *outdata)
 {
 	return pch_pcr_read(pid, offset, sizeof(u32), (u32 *)outdata);
 }
 
-u8 pcr_read16(PCH_SBI_PID pid, u16 offset, u16 *outdata)
+int pcr_read16(u8 pid, u16 offset, u16 *outdata)
 {
 	return pch_pcr_read(pid, offset, sizeof(u16), (u32 *)outdata);
 }
 
-u8 pcr_read8(PCH_SBI_PID pid, u16 offset, u8 *outdata)
+int pcr_read8(u8 pid, u16 offset, u8 *outdata)
 {
 	return pch_pcr_read(pid, offset, sizeof(u8), (u32 *)outdata);
 }
@@ -79,18 +88,15 @@ static inline void complete_write(void)
 {
 	/* Read the general control and function disable register. */
 	const size_t R_PCH_PCR_LPC_GCFD = 0x3418;
-	read32(PCH_PCR_ADDRESS(PID_LPC, R_PCH_PCR_LPC_GCFD));
+	read32(pcr_reg_address(PID_LPC, R_PCH_PCR_LPC_GCFD));
 }
 
 /*
  * Write PCR register. (This is internal function)
  * It returns PCR register and size in 1/2/4 bytes.
  * The offset should not exceed 0xFFFF and must be aligned with size
- *
- * PCH_SBI_PID defines as 8 bit Port ID that will be used when sending
- * transaction to sideband.
  */
-static u8 pch_pcr_write(PCH_SBI_PID pid, u16 offset, u32 size, u32 data)
+static int pch_pcr_write(u8 pid, u16 offset, u32 size, u32 data)
 {
 	if ((offset & (size - 1)) != 0) {
 		printk(BIOS_DEBUG,
@@ -103,13 +109,13 @@ static u8 pch_pcr_write(PCH_SBI_PID pid, u16 offset, u32 size, u32 data)
 	 */
 	switch (size) {
 	case 4:
-		write32(PCH_PCR_ADDRESS(pid, offset), (u32) data);
+		write32(pcr_reg_address(pid, offset), (u32) data);
 		break;
 	case 2:
-		write16(PCH_PCR_ADDRESS(pid, offset), (u16) data);
+		write16(pcr_reg_address(pid, offset), (u16) data);
 		break;
 	case 1:
-		write8(PCH_PCR_ADDRESS(pid, offset), (u8) data);
+		write8(pcr_reg_address(pid, offset), (u8) data);
 		break;
 	default:
 		break;
@@ -120,17 +126,17 @@ static u8 pch_pcr_write(PCH_SBI_PID pid, u16 offset, u32 size, u32 data)
 	return 0;
 }
 
-u8 pcr_write32(PCH_SBI_PID pid, u16 offset, u32 indata)
+int pcr_write32(u8 pid, u16 offset, u32 indata)
 {
 	return pch_pcr_write(pid, offset, sizeof(u32), indata);
 }
 
-u8 pcr_write16(PCH_SBI_PID pid, u16 offset, u16 indata)
+int pcr_write16(u8 pid, u16 offset, u16 indata)
 {
 	return pch_pcr_write(pid, offset, sizeof(u16), indata);
 }
 
-u8 pcr_write8(PCH_SBI_PID pid, u16 offset, u8 indata)
+int pcr_write8(u8 pid, u16 offset, u8 indata)
 {
 	return pch_pcr_write(pid, offset, sizeof(u8), indata);
 }
@@ -140,10 +146,10 @@ u8 pcr_write8(PCH_SBI_PID pid, u16 offset, u8 indata)
  * It programs  PCR register and size in 1/2/4 bytes.
  * The offset should not exceed 0xFFFF and must be aligned with size
  *
- * PCH_SBI_PID defines as 8 bit Port ID that will be used when sending
+ * u8 defines as 8 bit Port ID that will be used when sending
  * transaction to sideband.
  */
-static u8 pcr_and_then_or(PCH_SBI_PID pid, u16 offset, u32 size, u32 anddata,
+static int pcr_and_then_or(u8 pid, u16 offset, u32 size, u32 anddata,
 		   u32 ordata)
 {
 	u8 status;
@@ -160,17 +166,17 @@ static u8 pcr_and_then_or(PCH_SBI_PID pid, u16 offset, u32 size, u32 anddata,
 	return status;
 }
 
-u8 pcr_andthenor32(PCH_SBI_PID pid, u16 offset, u32 anddata, u32 ordata)
+int pcr_andthenor32(u8 pid, u16 offset, u32 anddata, u32 ordata)
 {
 	return pcr_and_then_or(pid, offset, sizeof(u32), anddata, ordata);
 }
 
-u8 pcr_andthenor16(PCH_SBI_PID pid, u16 offset, u16 anddata, u16 ordata)
+int pcr_andthenor16(u8 pid, u16 offset, u16 anddata, u16 ordata)
 {
 	return pcr_and_then_or(pid, offset, sizeof(u16), anddata, ordata);
 }
 
-u8 pcr_andthenor8(PCH_SBI_PID pid, u16 offset, u8 anddata, u8 ordata)
+int pcr_andthenor8(u8 pid, u16 offset, u8 anddata, u8 ordata)
 {
 	return pcr_and_then_or(pid, offset, sizeof(u8), anddata, ordata);
 }