make GRUB multi-tree and re-add xhci patches

Re-add xHCI only on haswell and broadwell machines, where
they are needed. Otherwise, keep the same GRUB code.

The xHCI patches were removed because they caused issues
on Sandybridge-based Dell Latitude laptops. See:
https://codeberg.org/libreboot/lbmk/issues/216

The issue was not reported elsewhere, including on the
Haswell/Broadwell hardware where they are needed, but the
build system could only build one version of GRUB.

The older machines do not need xHCI patches, because they
either do not have xHCI patches, or work (in GRUB) because
they're in EHCI mode when running the payload.

So, the problem is that we need the xHCI patches for GRUB
on Haswell/Broadwell hardware, but the patches break
Sandybridge hardware, and we only had the one build of GRUB.
To mitigate this problem, the build system now supports
building multiple revisions of GRUB, with different patches,
and each given coreboot target can say which GRUB tree to use
by setting this in target.cfg:

grubtree="xhci"

In the above example, the "xhci" tree would be used. Some
generic GRUB config has been moved to config/data/grub/
and config/grub/ now looks like config/coreboot/ - also,
the grub.cfg file (named "payload" in each tree) is copied
to the GRUB source tree as ".config", then added to GRUB's
memdisk in the same way, as grub.cfg.

Several other design changes had to be made because of this:

* grub.cfg in memdisk no longer automatically jumps to one
  in CBFS, but now shows a menuentry for it if available

* Certain commands in script/trees are disabled for GRUB,
  such as *config make commands.

* gnulib is now defined in config/submodule/grub/, instead
  of config/git/grub - and this mitigates an existing bug
  where downloading gnulib first would make grub no longer
  possible to download in lbmk.

The coreboot option CONFIG_FINALIZE_USB_ROUTE_XHCI has been
re-enabled on: Dell OptiPlex 9020 MT, Dell OptiPlex 9020 SFF,
Lenovo ThinkPad T440p and Lenovo ThinkPad W541 - now USB should
work again in GRUB.

The GRUB payload has been re-enabled on HP EliteBook 820 G2.

This change will enable per-board GRUB optimisation in the
future. For example, we hardcode what partitions and LVMs
GRUB scans because * is slow on ICH7-based machines, due
to GRUB's design. On other machines, * is reasonably fast,
for automatically enumerating the list of devices for boot.

Use of * (and other wildcards) could enable our GRUB payload
to automatically boot more distros, with minimal fuss. This
can be done at a later date, in subsequent revisions.

Signed-off-by: Leah Rowe <leah@libreboot.org>

1 files changed, 90 insertions, 0 deletions

diff --git a/config/grub/xhci/patches/0005-xhci/0008-Fix-compilation-on-x86_64.patch b/config/grub/xhci/patches/0005-xhci/0008-Fix-compilation-on-x86_64.patch
new file mode 100644
index 00000000..af79c3d0
--- /dev/null
+++ b/config/grub/xhci/patches/0005-xhci/0008-Fix-compilation-on-x86_64.patch
@@ -0,0 +1,90 @@
+From 871d768f8c5c960cb0d9761a9028b16882e1a7d3 Mon Sep 17 00:00:00 2001
+From: Patrick Rudolph <patrick.rudolph@9elements.com>
+Date: Wed, 24 Feb 2021 08:25:41 +0100
+Subject: [PATCH 8/8] Fix compilation on x86_64
+
+Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com>
+---
+ grub-core/bus/usb/xhci.c | 24 ++++++++++++++++--------
+ 1 file changed, 16 insertions(+), 8 deletions(-)
+
+diff --git a/grub-core/bus/usb/xhci.c b/grub-core/bus/usb/xhci.c
+index f4591ffb5..3495bb919 100644
+--- a/grub-core/bus/usb/xhci.c
++++ b/grub-core/bus/usb/xhci.c
+@@ -184,7 +184,7 @@ enum
+  *  then we can get it from a trb pointer (provided by evt ring).
+  */
+ #define XHCI_RING(_trb)	  \
+-    ((struct grub_xhci_ring*)((grub_uint32_t)(_trb) & ~(GRUB_XHCI_RING_SIZE-1)))
++    ((struct grub_xhci_ring*)((grub_addr_t)(_trb) & ~(GRUB_XHCI_RING_SIZE-1)))
+ 
+ /* slot context */
+ struct grub_xhci_slotctx {
+@@ -495,6 +495,14 @@ grub_xhci_read8(volatile void *addr) {
+   return (*((volatile grub_uint32_t *)addr));
+ }
+ 
++static inline void *
++grub_xhci_read_etrb_ptr(volatile struct grub_xhci_trb *trb) {
++  grub_uint64_t tmp;
++  tmp = (grub_uint64_t)grub_xhci_read32(&trb->ptr_low);
++  tmp |= ((grub_uint64_t)grub_xhci_read32(&trb->ptr_high)) << 32;
++  return (void *)(grub_addr_t)tmp;
++}
++
+ static inline grub_uint32_t
+ grub_xhci_port_read (struct grub_xhci *x, grub_uint32_t port)
+ {
+@@ -664,7 +672,7 @@ static void xhci_process_events(struct grub_xhci *x)
+ 	    case ER_TRANSFER:
+ 	    case ER_COMMAND_COMPLETE:
+ 	      {
+-		struct grub_xhci_trb  *rtrb = (void*)grub_xhci_read32(&etrb->ptr_low);
++		struct grub_xhci_trb  *rtrb = grub_xhci_read_etrb_ptr(etrb);
+ 		struct grub_xhci_ring *ring = XHCI_RING(rtrb);
+ 		volatile struct grub_xhci_trb  *evt = &ring->evt;
+ 		grub_uint32_t eidx = rtrb - ring->ring + 1;
+@@ -697,9 +705,9 @@ static void xhci_process_events(struct grub_xhci *x)
+ 	  }
+ 	grub_xhci_write32(&evts->nidx, nidx);
+ 	volatile struct grub_xhci_ir *ir = x->ir;
+-	grub_uint32_t erdp = (grub_uint32_t)(evts->ring + nidx);
+-	grub_xhci_write32(&ir->erdp_low, erdp);
+-	grub_xhci_write32(&ir->erdp_high, 0);
++	grub_uint64_t erdp = (grub_addr_t)(void *)(&evts->ring[nidx]);
++	grub_xhci_write32(&ir->erdp_low, erdp & 0xffffffff);
++	grub_xhci_write32(&ir->erdp_high, erdp >> 32);
+     }
+ }
+ 
+@@ -800,7 +808,7 @@ static void xhci_trb_queue(volatile struct grub_xhci_ring *ring,
+ 			   grub_uint32_t xferlen, grub_uint32_t flags)
+ {
+   grub_dprintf("xhci", "%s: ring %p data %llx len %d flags 0x%x remain 0x%x\n", __func__,
+-      ring, data_or_addr, xferlen & 0x1ffff, flags, xferlen >> 17);
++      ring, (unsigned long long)data_or_addr, xferlen & 0x1ffff, flags, xferlen >> 17);
+ 
+   if (xhci_ring_full(ring))
+     {
+@@ -1907,7 +1915,7 @@ grub_xhci_setup_transfer (grub_usb_controller_t dev,
+   if (transfer->type == GRUB_USB_TRANSACTION_TYPE_CONTROL)
+   {
+     volatile struct grub_usb_packet_setup *setupdata;
+-    setupdata = (void *)transfer->transactions[0].data;
++    setupdata = (void *)(grub_addr_t)transfer->transactions[0].data;
+     grub_dprintf("xhci", "%s: CONTROLL TRANS req %d\n", __func__, setupdata->request);
+     grub_dprintf("xhci", "%s: CONTROLL TRANS length %d\n", __func__, setupdata->length);
+ 
+@@ -1974,7 +1982,7 @@ grub_xhci_setup_transfer (grub_usb_controller_t dev,
+ 	/* Assume the ring has enough free space for all TRBs */
+ 	if (flags & TRB_TR_IDT && tr->size <= (int)sizeof(inline_data))
+ 	  {
+-	    grub_memcpy(&inline_data, (void *)tr->data, tr->size);
++	    grub_memcpy(&inline_data, (void *)(grub_addr_t)tr->data, tr->size);
+ 	    xhci_trb_queue(reqs, inline_data, tr->size, flags);
+ 	  }
+ 	else
+-- 
+2.39.2
+