From 634707a42d0a4670e5177638986232c4e992d403 Mon Sep 17 00:00:00 2001
From: Edward O'Callaghan <quasisec@google.com>
Date: Sat, 13 Nov 2021 13:14:06 +1100
Subject: [PATCH] pcidev: Avoid internal programmer relying on pacc global

Make progress towards the goal of removing pacc from global
state as noted in the FIXME of programmer.h

BUG=b:220950271
TEST=```sudo ./flashrom -p internal --flash-size
<snip>
Found Programmer flash chip "Opaque flash chip" (16384 kB, Programmer-specific) mapped at physical address 0x0000000000000000.
16777216
```

Change-Id: Id83bfd41f785f907e52a65a6689e8c7016fc1b77
Signed-off-by: Edward O'Callaghan <quasisec@google.com>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/59275
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Nico Huber <nico.h@gmx.de>
Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
---
 internal.c   | 37 ++++++++++++++-----------------------
 pcidev.c     |  9 +++++++++
 programmer.h |  2 ++
 3 files changed, 25 insertions(+), 23 deletions(-)

diff --git a/internal.c b/internal.c
index 995290e7f..dcb83cdb7 100644
--- a/internal.c
+++ b/internal.c
@@ -36,58 +36,49 @@ enum chipbustype internal_buses_supported = BUS_NONE;
 
 struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t devclass)
 {
-	struct pci_dev *temp;
+	struct pci_dev *temp = NULL;
 	struct pci_filter filter;
 	uint16_t tmp2;
 
 	pci_filter_init(NULL, &filter);
 	filter.vendor = vendor;
 
-	for (temp = pacc->devices; temp; temp = temp->next)
-		if (pci_filter_match(&filter, temp)) {
-			/* Read PCI class */
-			tmp2 = pci_read_word(temp, 0x0a);
-			if (tmp2 == devclass)
-				return temp;
-		}
+	while ((temp = pcidev_scandev(&filter, temp))) {
+		/* Read PCI class */
+		tmp2 = pci_read_word(temp, 0x0a);
+		if (tmp2 == devclass)
+			return temp;
+	}
 
 	return NULL;
 }
 
 struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device)
 {
-	struct pci_dev *temp;
 	struct pci_filter filter;
 
 	pci_filter_init(NULL, &filter);
 	filter.vendor = vendor;
 	filter.device = device;
 
-	for (temp = pacc->devices; temp; temp = temp->next)
-		if (pci_filter_match(&filter, temp))
-			return temp;
-
-	return NULL;
+	return pcidev_scandev(&filter, NULL);
 }
 
 struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
 			      uint16_t card_vendor, uint16_t card_device)
 {
-	struct pci_dev *temp;
+	struct pci_dev *temp = NULL;
 	struct pci_filter filter;
 
 	pci_filter_init(NULL, &filter);
 	filter.vendor = vendor;
 	filter.device = device;
 
-	for (temp = pacc->devices; temp; temp = temp->next)
-		if (pci_filter_match(&filter, temp)) {
-			if ((card_vendor ==
-			     pci_read_word(temp, PCI_SUBSYSTEM_VENDOR_ID))
-			    && (card_device ==
-				pci_read_word(temp, PCI_SUBSYSTEM_ID)))
-				return temp;
-		}
+	while ((temp = pcidev_scandev(&filter, temp))) {
+		if ((card_vendor == pci_read_word(temp, PCI_SUBSYSTEM_VENDOR_ID))
+		    && (card_device == pci_read_word(temp, PCI_SUBSYSTEM_ID)))
+			return temp;
+	}
 
 	return NULL;
 }
diff --git a/pcidev.c b/pcidev.c
index bd558ed27..f32385180 100644
--- a/pcidev.c
+++ b/pcidev.c
@@ -148,6 +148,15 @@ uintptr_t pcidev_readbar(struct pci_dev *dev, int bar)
 	return (uintptr_t)addr;
 }
 
+struct pci_dev *pcidev_scandev(struct pci_filter *filter, struct pci_dev *start)
+{
+	struct pci_dev *temp;
+	for (temp = start ? start->next : pacc->devices; temp; temp = temp->next)
+		if (pci_filter_match(filter, temp))
+			return temp;
+	return NULL;
+}
+
 static int pcidev_shutdown(void *data)
 {
 	if (pacc == NULL) {
diff --git a/programmer.h b/programmer.h
index 08e5e9cda..4024966e6 100644
--- a/programmer.h
+++ b/programmer.h
@@ -117,6 +117,7 @@ struct bitbang_spi_master {
 
 #if NEED_PCI == 1
 struct pci_dev;
+struct pci_filter;
 
 /* pcidev.c */
 // FIXME: This needs to be local, not global(?)
@@ -124,6 +125,7 @@ extern struct pci_access *pacc;
 int pci_init_common(void);
 uintptr_t pcidev_readbar(struct pci_dev *dev, int bar);
 struct pci_dev *pcidev_init(const struct dev_entry *devs, int bar);
+struct pci_dev *pcidev_scandev(struct pci_filter *filter, struct pci_dev *start);
 /* rpci_write_* are reversible writes. The original PCI config space register
  * contents will be restored on shutdown.
  * To clone the pci_dev instances internally, the `pacc` global