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

[Werner Zeh (Code Review)]

Werner Zeh has submitted this change. ( https://review.coreboot.org/c/coreboot/+/55769 )

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.

Original-Change-Id: I42ede1d9200bb5d0dbb455d2ff66e2816f10e86b
Original-Signed-off-by: Johnny Lin 
Original-Reviewed-on: https://review.coreboot.org/c/coreboot/+/45103
Original-Reviewed-by: Patrick Georgi 
Original-Reviewed-by: Angel Pons 
Original-Reviewed-by: Paul Menzel 
Original-Tested-by: build bot (Jenkins) 
(cherry picked from commit d04c06b472495bce49af0e171c333de26e8fd86a)

Change-Id: I7046467d41e1feddb07081964466c8189321cb1d
Signed-off-by: Marc Jones 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/55769
Reviewed-by: Martin Roth 
Reviewed-by: Jay Talbott 
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
  Martin Roth: Looks good to me, approved
  Jay Talbott: Looks good to me, but someone else must approve

diff --git a/src/drivers/ipmi/Kconfig b/src/drivers/ipmi/Kconfig
index 37cfc0d..b54b23d 100644
--- a/src/drivers/ipmi/Kconfig
+++ b/src/drivers/ipmi/Kconfig
@@ -18,3 +18,12 @@
      IPMB messages are limited to 32-bytes total. When the
      data size is larger than this value, IPMI can complete
      reading/writing the data over multiple commands.
+
+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 6076621..bf7f393 100644
--- a/src/drivers/ipmi/ipmi_kcs.c
+++ b/src/drivers/ipmi/ipmi_kcs.c
@@ -15,7 +15,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)
@@ -48,27 +48,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;
+	}
 }