[coreboot-gerrit] Change in coreboot[master]: drivers/ipmi: Add CONFIG_IPMI_KCS_TIMEOUT_MS for IPMI KCS timeout value

[Patrick Georgi (Code Review)]

Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/coreboot/+/45103 )

Change subject: drivers/ipmi: Add CONFIG_IPMI_KCS_TIMEOUT_MS for IPMI KCS timeout value
......................................................................

drivers/ipmi: Add CONFIG_IPMI_KCS_TIMEOUT_MS for IPMI KCS timeout value

With the current timeout of 1000 cycles of 100 microsecond would see
timeout occurs on OCP Delta Lake if the log level is set to values
smaller than 8. Because the prink(BIOS_SPEW, ..) in ipmi_kcs_status()
creates delay and avoid the problem, but after setting the log level
to 4 we see some timeout occurs.

The unit is millisecond and the default value is set to 5000 according
to IPMI spec v2.0 rev 1.1 Sec. 9.15, a five-second timeout or greater
is recommended.

Tested=On OCP Delta Lake, with log level 4 cannot observe timeout
occurs.

Change-Id: I42ede1d9200bb5d0dbb455d2ff66e2816f10e86b
Signed-off-by: Johnny Lin 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/45103
Reviewed-by: Patrick Georgi 
Reviewed-by: Angel Pons 
Reviewed-by: Paul Menzel 
Tested-by: build bot (Jenkins) 
---
M src/drivers/ipmi/Kconfig
M src/drivers/ipmi/ipmi_kcs.c
2 files changed, 22 insertions(+), 18 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Patrick Georgi: Looks good to me, approved
  Paul Menzel: Looks good to me, but someone else must approve
  Angel Pons: Looks good to me, but someone else must approve

diff --git a/src/drivers/ipmi/Kconfig b/src/drivers/ipmi/Kconfig
index 44ed17e..1137dcf 100644
--- a/src/drivers/ipmi/Kconfig
+++ b/src/drivers/ipmi/Kconfig
@@ -33,3 +33,12 @@
    help
      The PNP base address of BMC KCS. It must be equal to the
      pnp port value defined in devicetree for chip drivers/ipmi.
+
+config IPMI_KCS_TIMEOUT_MS
+	int
+	default 5000
+	depends on IPMI_KCS
+	help
+	  The time unit is millisecond for each IPMI KCS transfer.
+	  IPMI spec v2.0 rev 1.1 Sec. 9.15, a five-second timeout or
+	  greater is recommended.
diff --git a/src/drivers/ipmi/ipmi_kcs.c b/src/drivers/ipmi/ipmi_kcs.c
index 1d6b71c..f8c64c6 100644
--- a/src/drivers/ipmi/ipmi_kcs.c
+++ b/src/drivers/ipmi/ipmi_kcs.c
@@ -3,7 +3,7 @@
 #include <console/console.h>
 #include <device/device.h>
 #include <arch/io.h>
-#include <delay.h>
+#include <timer.h>
 #include "ipmi_kcs.h"

#define IPMI_KCS_STATE(_x)	((_x) >> 6)
@@ -35,27 +35,22 @@

static int wait_ibf_timeout(int port)
 {
-	int timeout = 1000;
-	do {
-		if (!(ipmi_kcs_status(port) & IPMI_KCS_IBF))
-			return 0;
-		udelay(100);
-	} while (timeout--);
-	printk(BIOS_ERR, "wait_ibf timeout!\n");
-	return timeout;
+	if (!wait_ms(CONFIG_IPMI_KCS_TIMEOUT_MS, !(ipmi_kcs_status(port) & IPMI_KCS_IBF))) {
+		printk(BIOS_ERR, "wait_ibf timeout!\n");
+		return 1;
+	} else {
+		return 0;
+	}
 }

static int wait_obf_timeout(int port)
 {
-	int timeout = 1000;
-	do {
-		if ((ipmi_kcs_status(port) & IPMI_KCS_OBF))
-			return 0;
-		udelay(100);
-	} while (timeout--);
-
-	printk(BIOS_ERR, "wait_obf timeout!\n");
-	return timeout;
+	if (!wait_ms(CONFIG_IPMI_KCS_TIMEOUT_MS, (ipmi_kcs_status(port) & IPMI_KCS_OBF))) {
+		printk(BIOS_ERR, "wait_obf timeout!\n");
+		return 1;
+	} else {
+		return 0;
+	}
 }