[Skiboot] [PATCH 3/4] fwts: Add FWTS annotations for NPU errors

[Stewart Smith]

We also remove the NPUERR macros so that the FWTS parsing magic
can construct find the prlog statements.

Signed-off-by: Stewart Smith <stewart at linux.vnet.ibm.com>
---
 hw/npu-hw-procedures.c |  9 +++++----
 hw/npu.c               | 29 ++++++++++++++++++++++++++++-
 include/npu.h          |  3 ---
 3 files changed, 33 insertions(+), 8 deletions(-)

diff --git a/hw/npu-hw-procedures.c b/hw/npu-hw-procedures.c
index 4dbb4bafeac5..cc3dcadd0382 100644
--- a/hw/npu-hw-procedures.c
+++ b/hw/npu-hw-procedures.c
@@ -516,7 +516,7 @@ int64_t npu_dev_procedure_read(struct npu_dev_trap *trap,
 
 	if (size != 4) {
 		/* Short config reads are not supported */
-		NPUDEVERR(dev, "Short read of procedure register\n");
+		prlog(PR_ERR, "NPU%d: Short read of procedure register\n", dev->npu->phb.opal_id);
 		return OPAL_PARAMETER;
 	}
 
@@ -538,8 +538,8 @@ int64_t npu_dev_procedure_read(struct npu_dev_trap *trap,
 		break;
 
 	default:
-		NPUDEVERR(dev, "Invalid vendor specific offset 0x%08x\n",
-			  offset);
+		prlog(PR_ERR, "NPU%d: Invalid vendor specific offset 0x%08x\n",
+		      dev->npu->phb.opal_id, offset);
 		rc = OPAL_PARAMETER;
 	}
 
@@ -557,7 +557,8 @@ int64_t npu_dev_procedure_write(struct npu_dev_trap *trap,
 
 	if (size != 4) {
 		/* Short config writes are not supported */
-		NPUDEVERR(dev, "Short read of procedure register\n");
+		prlog(PR_ERR, "NPU%d: Short read of procedure register\n",
+		      dev->npu->phb.opal_id);
 		return OPAL_PARAMETER;
 	}
 
diff --git a/hw/npu.c b/hw/npu.c
index e444b96a9f09..d54e4bc9f091 100644
--- a/hw/npu.c
+++ b/hw/npu.c
@@ -552,6 +552,11 @@ static void npu_dev_bind_pci_dev(struct npu_dev *dev)
 		}
 	}
 
+	/**
+	 * @fwts-label NPUNotBound
+	 * @fwts-advice Start debugging why we didn't find the right device.
+	 * End result is that NVLink will not function properly
+	 */
 	prlog(PR_ERR, "%s: NPU device %04x:00:%02x.0 not binding to PCI device\n",
 	      __func__, dev->npu->phb.opal_id, dev->index);
 }
@@ -683,7 +688,12 @@ static int npu_isn_valid(struct npu *p, uint32_t isn)
 	if (p->chip_id != p8_irq_to_chip(isn) || p->index != 0 ||
 	    NPU_IRQ_NUM(isn) < NPU_LSI_IRQ_MIN ||
 	    NPU_IRQ_NUM(isn) > NPU_LSI_IRQ_MAX) {
-		NPUERR(p, "isn 0x%x not valid for this NPU\n", isn);
+		/**
+		 * @fwts-label NPUisnInvalid
+		 * @fwts-advice NVLink not functional
+		 */
+		prlog(PR_ERR, "NPU%d: isn 0x%x not valid for this NPU\n",
+		      p->phb.opal_id, isn);
 		return false;
 	}
 
@@ -1276,6 +1286,10 @@ static void npu_probe_phb(struct dt_node *dn)
 	xscom_read(gcid, npu_link_scom_base(dn, xscom, 1) + NX_MMIO_BAR_1,
 		   &val);
 	if (!(val & NX_MMIO_BAR_ENABLE)) {
+		/**
+		 * @fwts-label NPUATBARDisabled
+		 * @fwts-advice NVLink not functional
+		 */
 		prlog(PR_ERR, "   AT BAR disabled!\n");
 		return;
 	}
@@ -1288,6 +1302,12 @@ static void npu_probe_phb(struct dt_node *dn)
 	/* Create PCI root device node */
 	np = dt_new_addr(dt_root, "pciex", at_bar[0]);
 	if (!np) {
+		/**
+		 * @fwts-label NPUPHBDeviceNodeFailure
+		 * @fwts-advice Error adding the PHB device node. The
+		 * only real reason for this is that firmware may have
+		 * run out of memory.
+		 */
 		prlog(PR_ERR, "%s: Cannot create PHB device node\n",
 		      __func__);
 		return;
@@ -1818,7 +1838,14 @@ static void npu_create_phb(struct dt_node *dn)
 	/* Create PHB slot */
 	slot = npu_slot_create(&p->phb);
 	if (!slot)
+	{
+		/**
+		 * @fwts-label NPUCannotCreatePHBSlot
+		 * @fwts-advice Firmware probably ran out of memory creating
+		 * NPU slot. NVLink functionality could be broken.
+		 */
 		prlog(PR_ERR, "NPU: Cannot create PHB slot\n");
+	}
 
 	/* Register PHB */
 	pci_register_phb(&p->phb, OPAL_DYNAMIC_PHB_ID);
diff --git a/include/npu.h b/include/npu.h
index ff6201efb475..7258e6962ed1 100644
--- a/include/npu.h
+++ b/include/npu.h
@@ -205,11 +205,8 @@ int64_t npu_dev_procedure_write(struct npu_dev_trap *trap,
 				      (p)->phb.opal_id, ##a)
 #define NPUINF(p, fmt, a...)	prlog(PR_INFO,  "NPU%d: " fmt, \
 				      (p)->phb.opal_id, ##a)
-#define NPUERR(p, fmt, a...)	prlog(PR_ERR,   "NPU%d: " fmt, \
-				      (p)->phb.opal_id, ##a)
 
 #define NPUDEVDBG(p, fmt, a...)	NPUDBG((p)->npu, fmt, ##a)
 #define NPUDEVINF(p, fmt, a...)	NPUINF((p)->npu, fmt, ##a)
-#define NPUDEVERR(p, fmt, a...)	NPUERR((p)->npu, fmt, ##a)
 
 #endif /* __NPU_H */
-- 
2.1.4