From f24a2794e1b527e45efbbcad1c272f176f3d9df0 Mon Sep 17 00:00:00 2001
From: Aaron Young
Date: Wed, 27 Oct 2021 16:05:43 -0700
Subject: [virtio] Update driver to use DMA API

Signed-off-by: Aaron Young <aaron.young@oracle.com>
---
 src/drivers/bus/virtio-pci.c  | 45 ++++++++++++++++++++++++++++---------------
 src/drivers/bus/virtio-ring.c |  4 ++--
 src/drivers/net/virtio-net.c  | 36 +++++++++++++++++++++++-----------
 3 files changed, 57 insertions(+), 28 deletions(-)

(limited to 'src/drivers')

diff --git a/src/drivers/bus/virtio-pci.c b/src/drivers/bus/virtio-pci.c
index 5d2d62750..8b34c7277 100644
--- a/src/drivers/bus/virtio-pci.c
+++ b/src/drivers/bus/virtio-pci.c
@@ -17,37 +17,47 @@
 #include "ipxe/io.h"
 #include "ipxe/iomap.h"
 #include "ipxe/pci.h"
+#include "ipxe/dma.h"
 #include "ipxe/reboot.h"
 #include "ipxe/virtio-pci.h"
 #include "ipxe/virtio-ring.h"
 
-static int vp_alloc_vq(struct vring_virtqueue *vq, u16 num)
+static int vp_alloc_vq(struct vring_virtqueue *vq, u16 num, size_t header_size)
 {
-    size_t queue_size = PAGE_MASK + vring_size(num);
+    size_t ring_size = PAGE_MASK + vring_size(num);
     size_t vdata_size = num * sizeof(void *);
+    size_t queue_size = ring_size + vdata_size + header_size;
 
-    vq->queue = zalloc(queue_size + vdata_size);
+    vq->queue = dma_alloc(vq->dma, &vq->map, queue_size, queue_size);
     if (!vq->queue) {
         return -ENOMEM;
     }
 
+    memset ( vq->queue, 0, queue_size );
+    vq->queue_size = queue_size;
+
     /* vdata immediately follows the ring */
-    vq->vdata = (void **)(vq->queue + queue_size);
+    vq->vdata = (void **)(vq->queue + ring_size);
+
+    /* empty header immediately follows vdata */
+    vq->empty_header = (struct virtio_net_hdr_modern *)(vq->queue + ring_size + vdata_size);
 
     return 0;
 }
 
 void vp_free_vq(struct vring_virtqueue *vq)
 {
-    if (vq->queue) {
-        free(vq->queue);
+    if (vq->queue && vq->queue_size) {
+        dma_free(&vq->map, vq->queue, vq->queue_size);
         vq->queue = NULL;
         vq->vdata = NULL;
+        vq->queue_size = 0;
     }
 }
 
 int vp_find_vq(unsigned int ioaddr, int queue_index,
-               struct vring_virtqueue *vq)
+               struct vring_virtqueue *vq, struct dma_device *dma_dev,
+               size_t header_size)
 {
    struct vring * vr = &vq->vring;
    u16 num;
@@ -73,9 +83,10 @@ int vp_find_vq(unsigned int ioaddr, int queue_index,
    }
 
    vq->queue_index = queue_index;
+   vq->dma = dma_dev;
 
    /* initialize the queue */
-   rc = vp_alloc_vq(vq, num);
+   rc = vp_alloc_vq(vq, num, header_size);
    if (rc) {
            DBG("VIRTIO-PCI ERROR: failed to allocate queue memory\n");
            return rc;
@@ -87,8 +98,7 @@ int vp_find_vq(unsigned int ioaddr, int queue_index,
     * NOTE: vr->desc is initialized by vring_init()
     */
 
-   outl((unsigned long)virt_to_phys(vr->desc) >> PAGE_SHIFT,
-        ioaddr + VIRTIO_PCI_QUEUE_PFN);
+   outl(dma(&vq->map, vr->desc) >> PAGE_SHIFT, ioaddr + VIRTIO_PCI_QUEUE_PFN);
 
    return num;
 }
@@ -348,7 +358,8 @@ void vpm_notify(struct virtio_pci_modern_device *vdev,
 }
 
 int vpm_find_vqs(struct virtio_pci_modern_device *vdev,
-                 unsigned nvqs, struct vring_virtqueue *vqs)
+                 unsigned nvqs, struct vring_virtqueue *vqs,
+                 struct dma_device *dma_dev, size_t header_size)
 {
     unsigned i;
     struct vring_virtqueue *vq;
@@ -392,11 +403,12 @@ int vpm_find_vqs(struct virtio_pci_modern_device *vdev,
 
         vq = &vqs[i];
         vq->queue_index = i;
+        vq->dma = dma_dev;
 
         /* get offset of notification word for this vq */
         off = vpm_ioread16(vdev, &vdev->common, COMMON_OFFSET(queue_notify_off));
 
-        err = vp_alloc_vq(vq, size);
+        err = vp_alloc_vq(vq, size, header_size);
         if (err) {
             DBG("VIRTIO-PCI %p: failed to allocate queue memory\n", vdev);
             return err;
@@ -406,13 +418,16 @@ int vpm_find_vqs(struct virtio_pci_modern_device *vdev,
         /* activate the queue */
         vpm_iowrite16(vdev, &vdev->common, size, COMMON_OFFSET(queue_size));
 
-        vpm_iowrite64(vdev, &vdev->common, virt_to_phys(vq->vring.desc),
+        vpm_iowrite64(vdev, &vdev->common,
+                      dma(&vq->map, vq->vring.desc),
                       COMMON_OFFSET(queue_desc_lo),
                       COMMON_OFFSET(queue_desc_hi));
-        vpm_iowrite64(vdev, &vdev->common, virt_to_phys(vq->vring.avail),
+        vpm_iowrite64(vdev, &vdev->common,
+                      dma(&vq->map, vq->vring.avail),
                       COMMON_OFFSET(queue_avail_lo),
                       COMMON_OFFSET(queue_avail_hi));
-        vpm_iowrite64(vdev, &vdev->common, virt_to_phys(vq->vring.used),
+        vpm_iowrite64(vdev, &vdev->common,
+                      dma(&vq->map, vq->vring.used),
                       COMMON_OFFSET(queue_used_lo),
                       COMMON_OFFSET(queue_used_hi));
 
diff --git a/src/drivers/bus/virtio-ring.c b/src/drivers/bus/virtio-ring.c
index 98e787e16..e448c3488 100644
--- a/src/drivers/bus/virtio-ring.c
+++ b/src/drivers/bus/virtio-ring.c
@@ -98,7 +98,7 @@ void vring_add_buf(struct vring_virtqueue *vq,
    for (i = head; out; i = vr->desc[i].next, out--) {
 
            vr->desc[i].flags = VRING_DESC_F_NEXT;
-           vr->desc[i].addr = (u64)virt_to_phys(list->addr);
+           vr->desc[i].addr = list->addr;
            vr->desc[i].len = list->length;
            prev = i;
            list++;
@@ -106,7 +106,7 @@ void vring_add_buf(struct vring_virtqueue *vq,
    for ( ; in; i = vr->desc[i].next, in--) {
 
            vr->desc[i].flags = VRING_DESC_F_NEXT|VRING_DESC_F_WRITE;
-           vr->desc[i].addr = (u64)virt_to_phys(list->addr);
+           vr->desc[i].addr = list->addr;
            vr->desc[i].len = list->length;
            prev = i;
            list++;
diff --git a/src/drivers/net/virtio-net.c b/src/drivers/net/virtio-net.c
index 78ec9ac4e..0c4541924 100644
--- a/src/drivers/net/virtio-net.c
+++ b/src/drivers/net/virtio-net.c
@@ -29,6 +29,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/iobuf.h>
 #include <ipxe/netdevice.h>
 #include <ipxe/pci.h>
+#include <ipxe/dma.h>
 #include <ipxe/if_ether.h>
 #include <ipxe/ethernet.h>
 #include <ipxe/virtio-pci.h>
@@ -99,8 +100,9 @@ struct virtnet_nic {
 	/** Pending rx packet count */
 	unsigned int rx_num_iobufs;
 
-	/** Virtio net dummy packet headers */
-	struct virtio_net_hdr_modern empty_header[QUEUE_NB];
+	/** DMA device */
+	struct dma_device *dma;
+
 };
 
 /** Add an iobuf to a virtqueue
@@ -115,7 +117,7 @@ static void virtnet_enqueue_iob ( struct net_device *netdev,
 				  int vq_idx, struct io_buffer *iobuf ) {
 	struct virtnet_nic *virtnet = netdev->priv;
 	struct vring_virtqueue *vq = &virtnet->virtqueue[vq_idx];
-	struct virtio_net_hdr_modern *header = &virtnet->empty_header[vq_idx];
+	struct virtio_net_hdr_modern *header = vq->empty_header;
 	unsigned int out = ( vq_idx == TX_INDEX ) ? 2 : 0;
 	unsigned int in = ( vq_idx == TX_INDEX ) ? 0 : 2;
 	size_t header_len = ( virtnet->virtio_version ?
@@ -132,11 +134,11 @@ static void virtnet_enqueue_iob ( struct net_device *netdev,
 			 * to header->flags for received packets.  Work around
 			 * this by using separate RX and TX headers.
 			 */
-			.addr = ( char* ) header,
+			.addr = dma ( &vq->map, header ),
 			.length = header_len,
 		},
 		{
-			.addr = ( char* ) iobuf->data,
+			.addr = iob_dma ( iobuf ),
 			.length = iob_len ( iobuf ),
 		},
 	};
@@ -161,7 +163,7 @@ static void virtnet_refill_rx_virtqueue ( struct net_device *netdev ) {
 		struct io_buffer *iobuf;
 
 		/* Try to allocate a buffer, stop for now if out of memory */
-		iobuf = alloc_iob ( len );
+		iobuf = alloc_rx_iob ( len, virtnet->dma );
 		if ( ! iobuf )
 			break;
 
@@ -215,7 +217,8 @@ static int virtnet_open_legacy ( struct net_device *netdev ) {
 
 	/* Initialize rx/tx virtqueues */
 	for ( i = 0; i < QUEUE_NB; i++ ) {
-		if ( vp_find_vq ( ioaddr, i, &virtnet->virtqueue[i] ) == -1 ) {
+		if ( vp_find_vq ( ioaddr, i, &virtnet->virtqueue[i], virtnet->dma,
+                                  sizeof ( struct virtio_net_hdr_modern ) ) == -1 ) {
 			DBGC ( virtnet, "VIRTIO-NET %p cannot register queue %d\n",
 			       virtnet, i );
 			virtnet_free_virtqueues ( netdev );
@@ -280,7 +283,8 @@ static int virtnet_open_modern ( struct net_device *netdev ) {
 	}
 
 	/* Initialize rx/tx virtqueues */
-	if ( vpm_find_vqs ( &virtnet->vdev, QUEUE_NB, virtnet->virtqueue ) ) {
+	if ( vpm_find_vqs ( &virtnet->vdev, QUEUE_NB, virtnet->virtqueue,
+                            virtnet->dma, sizeof ( struct virtio_net_hdr_modern ) ) ) {
 		DBGC ( virtnet, "VIRTIO-NET %p cannot register queues\n",
 		       virtnet );
 		virtnet_free_virtqueues ( netdev );
@@ -335,7 +339,7 @@ static void virtnet_close ( struct net_device *netdev ) {
 
 	/* Free rx iobufs */
 	list_for_each_entry_safe ( iobuf, next_iobuf, &virtnet->rx_iobufs, list ) {
-		free_iob ( iobuf );
+		free_rx_iob ( iobuf );
 	}
 	INIT_LIST_HEAD ( &virtnet->rx_iobufs );
 	virtnet->rx_num_iobufs = 0;
@@ -478,6 +482,12 @@ static int virtnet_probe_legacy ( struct pci_device *pci ) {
 
 	/* Enable PCI bus master and reset NIC */
 	adjust_pci_device ( pci );
+
+	/* Configure DMA */
+	virtnet->dma =  &pci->dma;
+	dma_set_mask_64bit ( virtnet->dma );
+	netdev->dma = virtnet->dma;
+
 	vp_reset ( ioaddr );
 
 	/* Load MAC address and MTU */
@@ -506,7 +516,7 @@ static int virtnet_probe_legacy ( struct pci_device *pci ) {
 	return 0;
 
 	unregister_netdev ( netdev );
- err_register_netdev:
+err_register_netdev:
 	vp_reset ( ioaddr );
 	netdev_nullify ( netdev );
 	netdev_put ( netdev );
@@ -586,6 +596,11 @@ static int virtnet_probe_modern ( struct pci_device *pci, int *found_dev ) {
 	/* Enable the PCI device */
 	adjust_pci_device ( pci );
 
+	/* Configure DMA */
+	virtnet->dma =  &pci->dma;
+	dma_set_mask_64bit ( virtnet->dma );
+	netdev->dma = virtnet->dma;
+
 	/* Reset the device and set initial status bits */
 	vpm_reset ( &virtnet->vdev );
 	vpm_add_status ( &virtnet->vdev, VIRTIO_CONFIG_S_ACKNOWLEDGE );
@@ -633,7 +648,6 @@ err_mac_address:
 	vpm_reset ( &virtnet->vdev );
 	netdev_nullify ( netdev );
 	netdev_put ( netdev );
-
 	virtio_pci_unmap_capability ( &virtnet->vdev.device );
 err_map_device:
 	virtio_pci_unmap_capability ( &virtnet->vdev.isr );
-- 
cgit v1.2.3-55-g7522


From 85eb961bf9afd61385430f8837485ba69cc0cc11 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 28 Oct 2021 00:38:02 +0100
Subject: [xhci] Allow for permanent failure of the command mechanism

Some xHCI controllers (observed with the Thunderbolt ports on a
ThinkPad X1 Extreme Gen3 and a ThinkPad P53) seem to suffer a
catastrophic failure at the point that ExitBootServices() is called if
the IOMMU is enabled.  The symptoms appear to be consistent with
another UEFI driver (e.g. the IOMMU driver, or the Thunderbolt driver)
having torn down the DMA mappings, leaving the xHCI controller unable
to write to host memory.  The observable effect is that all commands
fail with a timeout, and attempts to abort command execution similarly
fail since the xHCI controller is unable to report the abort
completion.

Check for failure to abort a command, and respond by performing a full
device reset (as recommended by the xHCI specification) and by marking
the device as permanently failed.

Reported-by: Andreas Hammarskjöld <junior@2PintSoftware.com>
Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/drivers/usb/xhci.c | 51 ++++++++++++++++++++++++++++++++++++++++++++++++--
 src/drivers/usb/xhci.h |  2 ++
 2 files changed, 51 insertions(+), 2 deletions(-)

(limited to 'src/drivers')

diff --git a/src/drivers/usb/xhci.c b/src/drivers/usb/xhci.c
index cc48af033..3d98b1e10 100644
--- a/src/drivers/usb/xhci.c
+++ b/src/drivers/usb/xhci.c
@@ -1165,6 +1165,31 @@ static int xhci_reset ( struct xhci_device *xhci ) {
 	return -ETIMEDOUT;
 }
 
+/**
+ * Mark xHCI device as permanently failed
+ *
+ * @v xhci		xHCI device
+ * @ret rc		Return status code
+ */
+static int xhci_fail ( struct xhci_device *xhci ) {
+	size_t len;
+	int rc;
+
+	/* Mark command mechanism as permanently failed */
+	xhci->failed = 1;
+
+	/* Reset device */
+	if ( ( rc = xhci_reset ( xhci ) ) != 0 )
+		return rc;
+
+	/* Discard DCBAA entries since DCBAAP has been cleared */
+	assert ( xhci->dcbaa.context != NULL );
+	len = ( ( xhci->slots + 1 ) * sizeof ( xhci->dcbaa.context[0] ) );
+	memset ( xhci->dcbaa.context, 0, len );
+
+	return 0;
+}
+
 /******************************************************************************
  *
  * Transfer request blocks
@@ -1720,6 +1745,10 @@ static void xhci_event_poll ( struct xhci_device *xhci ) {
 	unsigned int consumed;
 	unsigned int type;
 
+	/* Do nothing if device has permanently failed */
+	if ( xhci->failed )
+		return;
+
 	/* Poll for events */
 	profile_start ( &xhci_event_profiler );
 	for ( consumed = 0 ; ; consumed++ ) {
@@ -1778,6 +1807,7 @@ static void xhci_event_poll ( struct xhci_device *xhci ) {
  */
 static void xhci_abort ( struct xhci_device *xhci ) {
 	physaddr_t crp;
+	uint32_t crcr;
 
 	/* Abort the command */
 	DBGC2 ( xhci, "XHCI %s aborting command\n", xhci->name );
@@ -1786,8 +1816,18 @@ static void xhci_abort ( struct xhci_device *xhci ) {
 	/* Allow time for command to abort */
 	mdelay ( XHCI_COMMAND_ABORT_DELAY_MS );
 
-	/* Sanity check */
-	assert ( ( readl ( xhci->op + XHCI_OP_CRCR ) & XHCI_CRCR_CRR ) == 0 );
+	/* Check for failure to abort */
+	crcr = readl ( xhci->op + XHCI_OP_CRCR );
+	if ( crcr & XHCI_CRCR_CRR ) {
+
+		/* Device has failed to abort a command and is almost
+		 * certainly beyond repair.  Reset device, abandoning
+		 * all state, and mark device as failed to avoid
+		 * delays on any future command attempts.
+		 */
+		DBGC ( xhci, "XHCI %s failed to abort command\n", xhci->name );
+		xhci_fail ( xhci );
+	}
 
 	/* Consume (and ignore) any final command status */
 	xhci_event_poll ( xhci );
@@ -1813,6 +1853,12 @@ static int xhci_command ( struct xhci_device *xhci, union xhci_trb *trb ) {
 	unsigned int i;
 	int rc;
 
+	/* Immediately fail all commands if command mechanism has failed */
+	if ( xhci->failed ) {
+		rc = -EPIPE;
+		goto err_failed;
+	}
+
 	/* Sanity check */
 	if ( xhci->pending ) {
 		DBGC ( xhci, "XHCI %s command ring busy\n", xhci->name );
@@ -1863,6 +1909,7 @@ static int xhci_command ( struct xhci_device *xhci, union xhci_trb *trb ) {
  err_enqueue:
 	xhci->pending = NULL;
  err_pending:
+ err_failed:
 	return rc;
 }
 
diff --git a/src/drivers/usb/xhci.h b/src/drivers/usb/xhci.h
index 6e02d70e0..a3c8888af 100644
--- a/src/drivers/usb/xhci.h
+++ b/src/drivers/usb/xhci.h
@@ -1115,6 +1115,8 @@ struct xhci_device {
 	struct xhci_event_ring event;
 	/** Current command (if any) */
 	union xhci_trb *pending;
+	/** Command mechanism has permanently failed */
+	int failed;
 
 	/** Device slots, indexed by slot ID */
 	struct xhci_slot **slot;
-- 
cgit v1.2.3-55-g7522


From 236299baa32452c79a59138c44eca5fcf4a918f9 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 12 Nov 2021 15:57:51 +0000
Subject: [xhci] Avoid DMA during shutdown if firmware has disabled bus
 mastering

On some systems (observed with the Thunderbolt ports on a ThinkPad X1
Extreme Gen3 and a ThinkPad P53), the system firmware will disable bus
mastering on the xHCI controller and all PCI bridges at the point that
ExitBootServices() is called if the IOMMU is enabled.  This leaves the
xHCI controller unable to shut down cleanly since all commands will
fail with a timeout.

Commit 85eb961 ("[xhci] Allow for permanent failure of the command
mechanism") allows us to detect that this has happened and respond
cleanly.  However, some unidentified hardware component (either the
xHCI controller or one of the PCI bridges) seems to manage to enqueue
the attempted DMA operation and eventually complete it after the
operating system kernel has reenabled bus mastering.  This results in
a DMA operation to an area of memory that the hardware is no longer
permitted to access.  On Windows with the Driver Verifier enabled,
this will result in a STOP 0xE6 (DRIVER_VERIFIER_DMA_VIOLATION).

Work around this problem by detecting when bus mastering has been
disabled, and immediately failing the device to avoid initiating any
further DMA attempts.

Reported-by: Andreas Hammarskjöld <junior@2PintSoftware.com>
Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/drivers/usb/xhci.c | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'src/drivers')

diff --git a/src/drivers/usb/xhci.c b/src/drivers/usb/xhci.c
index 3d98b1e10..3247ee69c 100644
--- a/src/drivers/usb/xhci.c
+++ b/src/drivers/usb/xhci.c
@@ -3459,14 +3459,36 @@ static int xhci_probe ( struct pci_device *pci ) {
 static void xhci_remove ( struct pci_device *pci ) {
 	struct xhci_device *xhci = pci_get_drvdata ( pci );
 	struct usb_bus *bus = xhci->bus;
+	uint16_t command;
 
+	/* Some systems are observed to disable bus mastering on
+	 * Thunderbolt controllers before we get a chance to shut
+	 * down.  Detect this and avoid attempting any DMA operations,
+	 * which are guaranteed to fail and may end up spuriously
+	 * completing after the operating system kernel starts up.
+	 */
+	pci_read_config_word ( pci, PCI_COMMAND, &command );
+	if ( ! ( command & PCI_COMMAND_MASTER ) ) {
+		DBGC ( xhci, "XHCI %s DMA was disabled\n", xhci->name );
+		xhci_fail ( xhci );
+	}
+
+	/* Unregister and free USB bus */
 	unregister_usb_bus ( bus );
 	free_usb_bus ( bus );
+
+	/* Reset device and undo any PCH-specific fixes */
 	xhci_reset ( xhci );
 	if ( xhci->quirks & XHCI_PCH )
 		xhci_pch_undo ( xhci, pci );
+
+	/* Release ownership back to BIOS */
 	xhci_legacy_release ( xhci );
+
+	/* Unmap registers */
 	iounmap ( xhci->regs );
+
+	/* Free device */
 	free ( xhci );
 }
 
-- 
cgit v1.2.3-55-g7522


From 3ad27fbe78fec22e9af754242586f2ef621c8d2f Mon Sep 17 00:00:00 2001
From: Benedikt Braunger
Date: Tue, 16 Nov 2021 13:42:14 +0100
Subject: [intel] Add PCI ID for Intel X553 0x15e4

Modified-by: Michael Brown <mcb30@ipxe.org>
Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/drivers/net/intelx.c | 1 +
 1 file changed, 1 insertion(+)

(limited to 'src/drivers')

diff --git a/src/drivers/net/intelx.c b/src/drivers/net/intelx.c
index ccf6b0648..f4dad8859 100644
--- a/src/drivers/net/intelx.c
+++ b/src/drivers/net/intelx.c
@@ -481,6 +481,7 @@ static struct pci_device_id intelx_nics[] = {
 	PCI_ROM ( 0x8086, 0x15ab, "x552", "X552", 0 ),
 	PCI_ROM ( 0x8086, 0x15c8, "x553t", "X553/X557-AT", 0 ),
 	PCI_ROM ( 0x8086, 0x15ce, "x553-sfp", "X553 (SFP+)", 0 ),
+	PCI_ROM ( 0x8086, 0x15e4, "x553a", "X553", 0 ),
 	PCI_ROM ( 0x8086, 0x15e5, "x553", "X553", 0 ),
 };
 
-- 
cgit v1.2.3-55-g7522


From 562c74e1ea52a399f7a6c416e35d98f4b37888cf Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 22 Nov 2021 14:53:33 +0000
Subject: [efi] Run ExitBootServices shutdown hook at TPL_NOTIFY

On some systems (observed with the Thunderbolt ports on a ThinkPad X1
Extreme Gen3 and a ThinkPad P53), if the IOMMU is enabled then the
system firmware will install an ExitBootServices notification event
that disables bus mastering on the Thunderbolt xHCI controller and all
PCI bridges, and destroys any extant IOMMU mappings.  This leaves the
xHCI controller unable to perform any DMA operations.

As described in commit 236299b ("[xhci] Avoid DMA during shutdown if
firmware has disabled bus mastering"), any subsequent DMA operation
attempted by the xHCI controller will end up completing after the
operating system kernel has reenabled bus mastering, resulting in a
DMA operation to an area of memory that the hardware is no longer
permitted to access and, on Windows with the Driver Verifier enabled,
a STOP 0xE6 (DRIVER_VERIFIER_DMA_VIOLATION).

That commit avoids triggering any DMA attempts during the shutdown of
the xHCI controller itself.  However, this is not a complete solution
since any attached and opened USB device (e.g. a USB NIC) may
asynchronously trigger DMA attempts that happen to occur after bus
mastering has been disabled but before we reset the xHCI controller.

Avoid this problem by installing our own ExitBootServices notification
event at TPL_NOTIFY, thereby causing it to be invoked before the
firmware's own ExitBootServices notification event that disables bus
mastering.

This unsurprisingly causes the shutdown hook itself to be invoked at
TPL_NOTIFY, which causes a fatal error when later code attempts to
raise the TPL to TPL_CALLBACK (which is a lower TPL).  Work around
this problem by redefining the "internal" iPXE TPL to be variable, and
set this internal TPL to TPL_NOTIFY when the shutdown hook is invoked.

Avoid calling into an underlying SNP protocol instance from within our
shutdown hook at TPL_NOTIFY, since the underlying SNP driver may
attempt to raise the TPL to TPL_CALLBACK (which would cause a fatal
error).  Failing to shut down the underlying SNP device is safe to do
since the underlying device must, in any case, have installed its own
ExitBootServices hook if any shutdown actions are required.

Reported-by: Andreas Hammarskjöld <junior@2PintSoftware.com>
Tested-by: Andreas Hammarskjöld <junior@2PintSoftware.com>
Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/drivers/net/efi/nii.c       |  2 +-
 src/drivers/net/efi/snpnet.c    | 18 ++++++++++++++----
 src/include/ipxe/efi/efi.h      |  1 +
 src/interface/efi/efi_entropy.c |  4 ++--
 src/interface/efi/efi_init.c    | 20 +++++++++++++++++---
 src/interface/efi/efi_timer.c   |  2 +-
 6 files changed, 36 insertions(+), 11 deletions(-)

(limited to 'src/drivers')

diff --git a/src/drivers/net/efi/nii.c b/src/drivers/net/efi/nii.c
index b9f34650e..833462e77 100644
--- a/src/drivers/net/efi/nii.c
+++ b/src/drivers/net/efi/nii.c
@@ -576,7 +576,7 @@ static int nii_issue_cpb_db ( struct nii_nic *nii, unsigned int op, void *cpb,
 	cdb.IFnum = nii->nii->IfNum;
 
 	/* Raise task priority level */
-	tpl = bs->RaiseTPL ( TPL_CALLBACK );
+	tpl = bs->RaiseTPL ( efi_internal_tpl );
 
 	/* Issue command */
 	DBGC2 ( nii, "NII %s issuing %02x:%04x ifnum %d%s%s\n",
diff --git a/src/drivers/net/efi/snpnet.c b/src/drivers/net/efi/snpnet.c
index fb5240277..69ec6f5e5 100644
--- a/src/drivers/net/efi/snpnet.c
+++ b/src/drivers/net/efi/snpnet.c
@@ -164,6 +164,10 @@ static int snpnet_transmit ( struct net_device *netdev,
 	EFI_STATUS efirc;
 	int rc;
 
+	/* Do nothing if shutdown is in progress */
+	if ( efi_shutdown_in_progress )
+		return -ECANCELED;
+
 	/* Defer the packet if there is already a transmission in progress */
 	if ( snp->txbuf ) {
 		netdev_tx_defer ( netdev, iobuf );
@@ -283,6 +287,10 @@ static void snpnet_poll_rx ( struct net_device *netdev ) {
  */
 static void snpnet_poll ( struct net_device *netdev ) {
 
+	/* Do nothing if shutdown is in progress */
+	if ( efi_shutdown_in_progress )
+		return;
+
 	/* Process any TX completions */
 	snpnet_poll_tx ( netdev );
 
@@ -426,8 +434,9 @@ static void snpnet_close ( struct net_device *netdev ) {
 	EFI_STATUS efirc;
 	int rc;
 
-	/* Shut down NIC */
-	if ( ( efirc = snp->snp->Shutdown ( snp->snp ) ) != 0 ) {
+	/* Shut down NIC (unless whole system shutdown is in progress) */
+	if ( ( ! efi_shutdown_in_progress ) &&
+	     ( ( efirc = snp->snp->Shutdown ( snp->snp ) ) != 0 ) ) {
 		rc = -EEFI ( efirc );
 		DBGC ( snp, "SNP %s could not shut down: %s\n",
 		       netdev->name, strerror ( rc ) );
@@ -589,8 +598,9 @@ void snpnet_stop ( struct efi_device *efidev ) {
 	/* Unregister network device */
 	unregister_netdev ( netdev );
 
-	/* Stop SNP protocol */
-	if ( ( efirc = snp->snp->Stop ( snp->snp ) ) != 0 ) {
+	/* Stop SNP protocol (unless whole system shutdown is in progress) */
+	if ( ( ! efi_shutdown_in_progress ) &&
+	     ( ( efirc = snp->snp->Stop ( snp->snp ) ) != 0 ) ) {
 		rc = -EEFI ( efirc );
 		DBGC ( device, "SNP %s could not stop: %s\n",
 		       efi_handle_name ( device ), strerror ( rc ) );
diff --git a/src/include/ipxe/efi/efi.h b/src/include/ipxe/efi/efi.h
index a83fa0f27..1dd0d4453 100644
--- a/src/include/ipxe/efi/efi.h
+++ b/src/include/ipxe/efi/efi.h
@@ -223,6 +223,7 @@ extern EFI_HANDLE efi_image_handle;
 extern EFI_LOADED_IMAGE_PROTOCOL *efi_loaded_image;
 extern EFI_DEVICE_PATH_PROTOCOL *efi_loaded_image_path;
 extern EFI_SYSTEM_TABLE *efi_systab;
+extern EFI_TPL efi_internal_tpl;
 extern EFI_TPL efi_external_tpl;
 extern int efi_shutdown_in_progress;
 
diff --git a/src/interface/efi/efi_entropy.c b/src/interface/efi/efi_entropy.c
index 70cd06293..1e8ddfb68 100644
--- a/src/interface/efi/efi_entropy.c
+++ b/src/interface/efi/efi_entropy.c
@@ -104,8 +104,8 @@ static void efi_entropy_disable ( void ) {
 	/* Close timer tick event */
 	bs->CloseEvent ( tick );
 
-	/* Return to TPL_CALLBACK */
-	bs->RaiseTPL ( TPL_CALLBACK );
+	/* Return to internal TPL */
+	bs->RaiseTPL ( efi_internal_tpl );
 }
 
 /**
diff --git a/src/interface/efi/efi_init.c b/src/interface/efi/efi_init.c
index 1c6e9d440..5d98f9ff7 100644
--- a/src/interface/efi/efi_init.c
+++ b/src/interface/efi/efi_init.c
@@ -47,6 +47,9 @@ EFI_DEVICE_PATH_PROTOCOL *efi_loaded_image_path;
  */
 EFI_SYSTEM_TABLE * _C2 ( PLATFORM, _systab );
 
+/** Internal task priority level */
+EFI_TPL efi_internal_tpl = TPL_CALLBACK;
+
 /** External task priority level */
 EFI_TPL efi_external_tpl = TPL_APPLICATION;
 
@@ -79,6 +82,17 @@ static EFI_STATUS EFIAPI efi_unload ( EFI_HANDLE image_handle );
 static EFIAPI void efi_shutdown_hook ( EFI_EVENT event __unused,
 				       void *context __unused ) {
 
+	/* This callback is invoked at TPL_NOTIFY in order to ensure
+	 * that we have an opportunity to shut down cleanly before
+	 * other shutdown hooks perform destructive operations such as
+	 * disabling the IOMMU.
+	 *
+	 * Modify the internal task priority level so that no code
+	 * attempts to raise from TPL_NOTIFY to TPL_CALLBACK (which
+	 * would trigger a fatal exception).
+	 */
+	efi_internal_tpl = TPL_NOTIFY;
+
 	/* Mark shutdown as being in progress, to indicate that large
 	 * parts of the system (e.g. timers) are no longer functional.
 	 */
@@ -273,7 +287,7 @@ EFI_STATUS efi_init ( EFI_HANDLE image_handle,
 	 * bother doing so when ExitBootServices() is called.
 	 */
 	if ( ( efirc = bs->CreateEvent ( EVT_SIGNAL_EXIT_BOOT_SERVICES,
-					 TPL_CALLBACK, efi_shutdown_hook,
+					 TPL_NOTIFY, efi_shutdown_hook,
 					 NULL, &efi_shutdown_event ) ) != 0 ) {
 		rc = -EEFI ( efirc );
 		DBGC ( systab, "EFI could not create ExitBootServices event: "
@@ -373,7 +387,7 @@ __attribute__ (( noreturn )) void __stack_chk_fail ( void ) {
 }
 
 /**
- * Raise task priority level to TPL_CALLBACK
+ * Raise task priority level to internal level
  *
  * @v tpl		Saved TPL
  */
@@ -384,7 +398,7 @@ void efi_raise_tpl ( struct efi_saved_tpl *tpl ) {
 	tpl->previous = efi_external_tpl;
 
 	/* Raise TPL and record previous TPL as new external TPL */
-	tpl->current = bs->RaiseTPL ( TPL_CALLBACK );
+	tpl->current = bs->RaiseTPL ( efi_internal_tpl );
 	efi_external_tpl = tpl->current;
 }
 
diff --git a/src/interface/efi/efi_timer.c b/src/interface/efi/efi_timer.c
index 405cd3454..6427eb1d8 100644
--- a/src/interface/efi/efi_timer.c
+++ b/src/interface/efi/efi_timer.c
@@ -137,7 +137,7 @@ static unsigned long efi_currticks ( void ) {
 		efi_jiffies++;
 	} else {
 		bs->RestoreTPL ( efi_external_tpl );
-		bs->RaiseTPL ( TPL_CALLBACK );
+		bs->RaiseTPL ( efi_internal_tpl );
 	}
 
 	return ( efi_jiffies * ( TICKS_PER_SEC / EFI_JIFFIES_PER_SEC ) );
-- 
cgit v1.2.3-55-g7522


From 468980db2b99f54ffec7d2a44c281308b4eec3c0 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 9 Feb 2022 21:54:47 +0000
Subject: [usb] Support keyboard remapping via the native USB keyboard driver

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/drivers/usb/usbkbd.c | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/drivers')

diff --git a/src/drivers/usb/usbkbd.c b/src/drivers/usb/usbkbd.c
index a8ab6ab76..397ed77ec 100644
--- a/src/drivers/usb/usbkbd.c
+++ b/src/drivers/usb/usbkbd.c
@@ -29,6 +29,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <assert.h>
 #include <ipxe/console.h>
 #include <ipxe/keys.h>
+#include <ipxe/keymap.h>
 #include <ipxe/usb.h>
 #include "usbkbd.h"
 
@@ -122,6 +123,10 @@ static unsigned int usbkbd_map ( unsigned int keycode, unsigned int modifiers,
 		key = 0;
 	}
 
+	/* Remap key if applicable */
+	if ( keycode < USBKBD_KEY_CAPS_LOCK )
+		key = key_remap ( key );
+
 	return key;
 }
 
-- 
cgit v1.2.3-55-g7522


From eb92ba0a4fe6b1b56e3ca5edfb93fdd545bc901a Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 10 Feb 2022 11:55:54 +0000
Subject: [usb] Handle upper/lower case and Ctrl-<key> after applying remapping

Some keyboard layouts (e.g. "fr") swap letter and punctuation keys.
Apply the logic for upper and lower case and for Ctrl-<key> only after
applying remapping, in order to handle these layouts correctly.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/drivers/usb/usbkbd.c | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

(limited to 'src/drivers')

diff --git a/src/drivers/usb/usbkbd.c b/src/drivers/usb/usbkbd.c
index 397ed77ec..ba4b2d4d7 100644
--- a/src/drivers/usb/usbkbd.c
+++ b/src/drivers/usb/usbkbd.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
 #include <string.h>
+#include <ctype.h>
 #include <errno.h>
 #include <assert.h>
 #include <ipxe/console.h>
@@ -70,12 +71,6 @@ static unsigned int usbkbd_map ( unsigned int keycode, unsigned int modifiers,
 	} else if ( keycode <= USBKBD_KEY_Z ) {
 		/* Alphabetic keys */
 		key = ( keycode - USBKBD_KEY_A + 'a' );
-		if ( modifiers & USBKBD_CTRL ) {
-			key -= ( 'a' - CTRL_A );
-		} else if ( ( modifiers & USBKBD_SHIFT ) ||
-			    ( leds & USBKBD_LED_CAPS_LOCK ) ) {
-			key -= ( 'a' - 'A' );
-		}
 	} else if ( keycode <= USBKBD_KEY_0 ) {
 		/* Numeric key row */
 		if ( modifiers & USBKBD_SHIFT ) {
@@ -127,6 +122,16 @@ static unsigned int usbkbd_map ( unsigned int keycode, unsigned int modifiers,
 	if ( keycode < USBKBD_KEY_CAPS_LOCK )
 		key = key_remap ( key );
 
+	/* Handle upper/lower case and Ctrl-<key> */
+	if ( islower ( key ) ) {
+		if ( modifiers & USBKBD_CTRL ) {
+			key -= ( 'a' - CTRL_A );
+		} else if ( ( modifiers & USBKBD_SHIFT ) ||
+			    ( leds & USBKBD_LED_CAPS_LOCK ) ) {
+			key -= ( 'a' - 'A' );
+		}
+	}
+
 	return key;
 }
 
-- 
cgit v1.2.3-55-g7522


From 0bbd8967830097b9141945ba960e90339c230ccb Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 9 Feb 2022 15:43:42 +0000
Subject: [console] Handle remapping of scancode 86

The key with scancode 86 appears in the position between left shift
and Z on a US keyboard, where it typically fails to exist entirely.
Most US keyboard maps define this nonexistent key as generating "\|",
with the notable exception of "loadkeys" which instead reports it as
generating "<>".  Both of these mapping choices duplicate keys that
exist elsewhere in the map, which causes problems for our ASCII-based
remapping mechanism.

Work around these quirks by treating the key as generating "\|" with
the high bit set, and making it subject to remapping.  Where the BIOS
generates "\|" as expected, this allows us to remap to the correct
ASCII value.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/interface/pcbios/bios_console.c |  9 ++++++++
 src/core/keymap.c                            |  3 +++
 src/drivers/usb/usbkbd.c                     |  8 ++++++-
 src/drivers/usb/usbkbd.h                     |  1 +
 src/hci/keymap/keymap_al.c                   |  2 ++
 src/hci/keymap/keymap_az.c                   |  2 ++
 src/hci/keymap/keymap_by.c                   |  2 ++
 src/hci/keymap/keymap_de.c                   |  2 ++
 src/hci/keymap/keymap_dk.c                   |  2 ++
 src/hci/keymap/keymap_es.c                   |  2 ++
 src/hci/keymap/keymap_et.c                   |  2 ++
 src/hci/keymap/keymap_fi.c                   |  2 ++
 src/hci/keymap/keymap_fr.c                   |  2 ++
 src/hci/keymap/keymap_gr.c                   |  2 ++
 src/hci/keymap/keymap_il.c                   |  2 ++
 src/hci/keymap/keymap_it.c                   |  2 ++
 src/hci/keymap/keymap_mk.c                   |  2 ++
 src/hci/keymap/keymap_nl.c                   |  2 ++
 src/hci/keymap/keymap_no-latin1.c            |  2 ++
 src/hci/keymap/keymap_no.c                   |  2 ++
 src/hci/keymap/keymap_pl.c                   |  2 ++
 src/hci/keymap/keymap_pt.c                   |  2 ++
 src/hci/keymap/keymap_ru.c                   |  2 ++
 src/hci/keymap/keymap_sg.c                   |  2 ++
 src/hci/keymap/keymap_sr-latin.c             |  2 ++
 src/hci/keymap/keymap_ua.c                   |  2 ++
 src/include/ipxe/keymap.h                    |  3 +++
 src/util/genkeymap.py                        | 31 +++++++++++++++++++++++-----
 28 files changed, 93 insertions(+), 6 deletions(-)

(limited to 'src/drivers')

diff --git a/src/arch/x86/interface/pcbios/bios_console.c b/src/arch/x86/interface/pcbios/bios_console.c
index 443513e9e..438a01d07 100644
--- a/src/arch/x86/interface/pcbios/bios_console.c
+++ b/src/arch/x86/interface/pcbios/bios_console.c
@@ -68,6 +68,13 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 #define SCANCODE_RSHIFT		0x36
 
+/** Scancode for the "non-US \ and |" key
+ *
+ * This is the key that appears between Left Shift and Z on non-US
+ * keyboards.
+ */
+#define SCANCODE_NON_US		0x56
+
 /* Set default console usage if applicable */
 #if ! ( defined ( CONSOLE_PCBIOS ) && CONSOLE_EXPLICIT ( CONSOLE_PCBIOS ) )
 #undef CONSOLE_PCBIOS
@@ -383,6 +390,8 @@ static int bios_getchar ( void ) {
 	if ( character && ( character < 0x80 ) ) {
 		if ( scancode < SCANCODE_RSHIFT ) {
 			return key_remap ( character );
+		} else if ( scancode == SCANCODE_NON_US ) {
+			return key_remap ( character | KEYMAP_PSEUDO );
 		} else {
 			return character;
 		}
diff --git a/src/core/keymap.c b/src/core/keymap.c
index a6707a2ce..5054e4769 100644
--- a/src/core/keymap.c
+++ b/src/core/keymap.c
@@ -48,5 +48,8 @@ unsigned int key_remap ( unsigned int character ) {
 		}
 	}
 
+	/* Clear pseudo key flag */
+	character &= ~KEYMAP_PSEUDO;
+
 	return character;
 }
diff --git a/src/drivers/usb/usbkbd.c b/src/drivers/usb/usbkbd.c
index ba4b2d4d7..6954cd69b 100644
--- a/src/drivers/usb/usbkbd.c
+++ b/src/drivers/usb/usbkbd.c
@@ -114,13 +114,19 @@ static unsigned int usbkbd_map ( unsigned int keycode, unsigned int modifiers,
 			};
 			key = keypad[ keycode - USBKBD_KEY_PAD_1 ];
 		};
+	} else if ( keycode == USBKBD_KEY_NON_US ) {
+		/* Non-US \ and | */
+		key = ( ( modifiers & USBKBD_SHIFT ) ?
+			( KEYMAP_PSEUDO | '|' ) : ( KEYMAP_PSEUDO | '\\' ) );
 	} else {
 		key = 0;
 	}
 
 	/* Remap key if applicable */
-	if ( keycode < USBKBD_KEY_CAPS_LOCK )
+	if ( ( keycode < USBKBD_KEY_CAPS_LOCK ) ||
+	     ( keycode == USBKBD_KEY_NON_US ) ) {
 		key = key_remap ( key );
+	}
 
 	/* Handle upper/lower case and Ctrl-<key> */
 	if ( islower ( key ) ) {
diff --git a/src/drivers/usb/usbkbd.h b/src/drivers/usb/usbkbd.h
index cedebfe71..1a3fea1ba 100644
--- a/src/drivers/usb/usbkbd.h
+++ b/src/drivers/usb/usbkbd.h
@@ -75,6 +75,7 @@ enum usb_keycode {
 	USBKBD_KEY_PAD_ENTER = 0x58,
 	USBKBD_KEY_PAD_1 = 0x59,
 	USBKBD_KEY_PAD_DOT = 0x63,
+	USBKBD_KEY_NON_US = 0x64,
 };
 
 /** USB keyboard LEDs */
diff --git a/src/hci/keymap/keymap_al.c b/src/hci/keymap/keymap_al.c
index e4418361b..6b4663489 100644
--- a/src/hci/keymap/keymap_al.c
+++ b/src/hci/keymap/keymap_al.c
@@ -30,4 +30,6 @@ struct key_mapping al_mapping[] __keymap = {
 	{ 0x7c, 0x7d },	/* '|' => '}' */
 	{ 0x7d, 0x27 },	/* '}' => '\'' */
 	{ 0x7e, 0x7c },	/* '~' => '|' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_az.c b/src/hci/keymap/keymap_az.c
index 525ab2336..91a243460 100644
--- a/src/hci/keymap/keymap_az.c
+++ b/src/hci/keymap/keymap_az.c
@@ -21,4 +21,6 @@ struct key_mapping az_mapping[] __keymap = {
 	{ 0x40, 0x22 },	/* '@' => '"' */
 	{ 0x5e, 0x3a },	/* '^' => ':' */
 	{ 0x7c, 0x2f },	/* '|' => '/' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_by.c b/src/hci/keymap/keymap_by.c
index 514d0b532..43fb746bf 100644
--- a/src/hci/keymap/keymap_by.c
+++ b/src/hci/keymap/keymap_by.c
@@ -12,4 +12,6 @@ FILE_LICENCE ( PUBLIC_DOMAIN );
 
 /** "by" keyboard mapping */
 struct key_mapping by_mapping[] __keymap = {
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_de.c b/src/hci/keymap/keymap_de.c
index 2559e1538..85574d487 100644
--- a/src/hci/keymap/keymap_de.c
+++ b/src/hci/keymap/keymap_de.c
@@ -36,4 +36,6 @@ struct key_mapping de_mapping[] __keymap = {
 	{ 0x7a, 0x79 },	/* 'z' => 'y' */
 	{ 0x7c, 0x27 },	/* '|' => '\'' */
 	{ 0x7d, 0x2a },	/* '}' => '*' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_dk.c b/src/hci/keymap/keymap_dk.c
index 05110dc89..4e1d5a739 100644
--- a/src/hci/keymap/keymap_dk.c
+++ b/src/hci/keymap/keymap_dk.c
@@ -28,4 +28,6 @@ struct key_mapping dk_mapping[] __keymap = {
 	{ 0x5e, 0x26 },	/* '^' => '&' */
 	{ 0x5f, 0x3f },	/* '_' => '?' */
 	{ 0x7c, 0x2a },	/* '|' => '*' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_es.c b/src/hci/keymap/keymap_es.c
index 51dedfff7..91327ea51 100644
--- a/src/hci/keymap/keymap_es.c
+++ b/src/hci/keymap/keymap_es.c
@@ -28,4 +28,6 @@ struct key_mapping es_mapping[] __keymap = {
 	{ 0x5e, 0x26 },	/* '^' => '&' */
 	{ 0x5f, 0x3f },	/* '_' => '?' */
 	{ 0x7d, 0x2a },	/* '}' => '*' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_et.c b/src/hci/keymap/keymap_et.c
index dd0f879b1..493ec93d4 100644
--- a/src/hci/keymap/keymap_et.c
+++ b/src/hci/keymap/keymap_et.c
@@ -26,4 +26,6 @@ struct key_mapping et_mapping[] __keymap = {
 	{ 0x5e, 0x26 },	/* '^' => '&' */
 	{ 0x5f, 0x3f },	/* '_' => '?' */
 	{ 0x7c, 0x2a },	/* '|' => '*' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_fi.c b/src/hci/keymap/keymap_fi.c
index c489bf0e5..18f48d47e 100644
--- a/src/hci/keymap/keymap_fi.c
+++ b/src/hci/keymap/keymap_fi.c
@@ -26,4 +26,6 @@ struct key_mapping fi_mapping[] __keymap = {
 	{ 0x5e, 0x26 },	/* '^' => '&' */
 	{ 0x5f, 0x3f },	/* '_' => '?' */
 	{ 0x7c, 0x2a },	/* '|' => '*' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_fr.c b/src/hci/keymap/keymap_fr.c
index 8f3b4999d..808cd7945 100644
--- a/src/hci/keymap/keymap_fr.c
+++ b/src/hci/keymap/keymap_fr.c
@@ -57,4 +57,6 @@ struct key_mapping fr_mapping[] __keymap = {
 	{ 0x71, 0x61 },	/* 'q' => 'a' */
 	{ 0x77, 0x7a },	/* 'w' => 'z' */
 	{ 0x7a, 0x77 },	/* 'z' => 'w' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_gr.c b/src/hci/keymap/keymap_gr.c
index 42b6418e8..b48142e5e 100644
--- a/src/hci/keymap/keymap_gr.c
+++ b/src/hci/keymap/keymap_gr.c
@@ -12,4 +12,6 @@ FILE_LICENCE ( PUBLIC_DOMAIN );
 
 /** "gr" keyboard mapping */
 struct key_mapping gr_mapping[] __keymap = {
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_il.c b/src/hci/keymap/keymap_il.c
index f631f7ac9..78e7fa970 100644
--- a/src/hci/keymap/keymap_il.c
+++ b/src/hci/keymap/keymap_il.c
@@ -24,4 +24,6 @@ struct key_mapping il_mapping[] __keymap = {
 	{ 0x60, 0x3b },	/* '`' => ';' */
 	{ 0x7b, 0x7d },	/* '{' => '}' */
 	{ 0x7d, 0x7b },	/* '}' => '{' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_it.c b/src/hci/keymap/keymap_it.c
index d96102c9e..5a8e2b38d 100644
--- a/src/hci/keymap/keymap_it.c
+++ b/src/hci/keymap/keymap_it.c
@@ -30,4 +30,6 @@ struct key_mapping it_mapping[] __keymap = {
 	{ 0x60, 0x5c },	/* '`' => '\\' */
 	{ 0x7d, 0x2a },	/* '}' => '*' */
 	{ 0x7e, 0x7c },	/* '~' => '|' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_mk.c b/src/hci/keymap/keymap_mk.c
index 8f5060778..9f2cff78b 100644
--- a/src/hci/keymap/keymap_mk.c
+++ b/src/hci/keymap/keymap_mk.c
@@ -12,4 +12,6 @@ FILE_LICENCE ( PUBLIC_DOMAIN );
 
 /** "mk" keyboard mapping */
 struct key_mapping mk_mapping[] __keymap = {
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_nl.c b/src/hci/keymap/keymap_nl.c
index 2a0fbbcbd..d248fc8ae 100644
--- a/src/hci/keymap/keymap_nl.c
+++ b/src/hci/keymap/keymap_nl.c
@@ -33,4 +33,6 @@ struct key_mapping nl_mapping[] __keymap = {
 	{ 0x60, 0x40 },	/* '`' => '@' */
 	{ 0x7c, 0x3e },	/* '|' => '>' */
 	{ 0x7d, 0x7c },	/* '}' => '|' */
+	{ 0xdc, 0x5d },	/* Pseudo-'\\' => ']' */
+	{ 0xfc, 0x5b },	/* Pseudo-'|' => '[' */
 };
diff --git a/src/hci/keymap/keymap_no-latin1.c b/src/hci/keymap/keymap_no-latin1.c
index 655e4cef7..d5a721a90 100644
--- a/src/hci/keymap/keymap_no-latin1.c
+++ b/src/hci/keymap/keymap_no-latin1.c
@@ -32,4 +32,6 @@ struct key_mapping no_latin1_mapping[] __keymap = {
 	{ 0x60, 0x7c },	/* '`' => '|' */
 	{ 0x7c, 0x2a },	/* '|' => '*' */
 	{ 0x7d, 0x5e },	/* '}' => '^' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_no.c b/src/hci/keymap/keymap_no.c
index 7a2df7c5a..b6190da4a 100644
--- a/src/hci/keymap/keymap_no.c
+++ b/src/hci/keymap/keymap_no.c
@@ -30,4 +30,6 @@ struct key_mapping no_mapping[] __keymap = {
 	{ 0x5f, 0x3f },	/* '_' => '?' */
 	{ 0x60, 0x7c },	/* '`' => '|' */
 	{ 0x7c, 0x2a },	/* '|' => '*' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_pl.c b/src/hci/keymap/keymap_pl.c
index 51822e072..224fbde28 100644
--- a/src/hci/keymap/keymap_pl.c
+++ b/src/hci/keymap/keymap_pl.c
@@ -12,4 +12,6 @@ FILE_LICENCE ( PUBLIC_DOMAIN );
 
 /** "pl" keyboard mapping */
 struct key_mapping pl_mapping[] __keymap = {
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_pt.c b/src/hci/keymap/keymap_pt.c
index b993902af..6d850fee8 100644
--- a/src/hci/keymap/keymap_pt.c
+++ b/src/hci/keymap/keymap_pt.c
@@ -29,4 +29,6 @@ struct key_mapping pt_mapping[] __keymap = {
 	{ 0x60, 0x5c },	/* '`' => '\\' */
 	{ 0x7b, 0x2a },	/* '{' => '*' */
 	{ 0x7e, 0x7c },	/* '~' => '|' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_ru.c b/src/hci/keymap/keymap_ru.c
index c120ffd82..f7611c30a 100644
--- a/src/hci/keymap/keymap_ru.c
+++ b/src/hci/keymap/keymap_ru.c
@@ -13,4 +13,6 @@ FILE_LICENCE ( PUBLIC_DOMAIN );
 /** "ru" keyboard mapping */
 struct key_mapping ru_mapping[] __keymap = {
 	{ 0x0d, 0x0a },	/* Ctrl-M => Ctrl-J */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_sg.c b/src/hci/keymap/keymap_sg.c
index 0b0820929..9a515c745 100644
--- a/src/hci/keymap/keymap_sg.c
+++ b/src/hci/keymap/keymap_sg.c
@@ -38,4 +38,6 @@ struct key_mapping sg_mapping[] __keymap = {
 	{ 0x7a, 0x79 },	/* 'z' => 'y' */
 	{ 0x7c, 0x24 },	/* '|' => '$' */
 	{ 0x7d, 0x21 },	/* '}' => '!' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_sr-latin.c b/src/hci/keymap/keymap_sr-latin.c
index 9d76e8a6c..1d4588733 100644
--- a/src/hci/keymap/keymap_sr-latin.c
+++ b/src/hci/keymap/keymap_sr-latin.c
@@ -12,4 +12,6 @@ FILE_LICENCE ( PUBLIC_DOMAIN );
 
 /** "sr-latin" keyboard mapping */
 struct key_mapping sr_latin_mapping[] __keymap = {
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/hci/keymap/keymap_ua.c b/src/hci/keymap/keymap_ua.c
index 1106a8b28..50f2e184d 100644
--- a/src/hci/keymap/keymap_ua.c
+++ b/src/hci/keymap/keymap_ua.c
@@ -12,4 +12,6 @@ FILE_LICENCE ( PUBLIC_DOMAIN );
 
 /** "ua" keyboard mapping */
 struct key_mapping ua_mapping[] __keymap = {
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0xfc, 0x3e },	/* Pseudo-'|' => '>' */
 };
diff --git a/src/include/ipxe/keymap.h b/src/include/ipxe/keymap.h
index 62b3bb131..93c9e7314 100644
--- a/src/include/ipxe/keymap.h
+++ b/src/include/ipxe/keymap.h
@@ -27,6 +27,9 @@ struct key_mapping {
 /** Define a keyboard mapping */
 #define __keymap __table_entry ( KEYMAP, 01 )
 
+/** Pseudo key flag */
+#define KEYMAP_PSEUDO 0x80
+
 extern unsigned int key_remap ( unsigned int character );
 
 #endif /* _IPXE_KEYMAP_H */
diff --git a/src/util/genkeymap.py b/src/util/genkeymap.py
index 1bb494f83..081e314cc 100755
--- a/src/util/genkeymap.py
+++ b/src/util/genkeymap.py
@@ -219,12 +219,28 @@ class KeyMapping(UserDict[KeyModifiers, Sequence[Key]]):
 
 
 class BiosKeyMapping(KeyMapping):
-    """Keyboard mapping as used by the BIOS"""
+    """Keyboard mapping as used by the BIOS
+
+    To allow for remappings of the somewhat interesting key 86, we
+    arrange for our keyboard drivers to generate this key as "\\|"
+    with the high bit set.
+    """
+
+    KEY_PSEUDO: ClassVar[int] = 0x80
+    """Flag used to indicate a fake ASCII value"""
+
+    KEY_NON_US_UNSHIFTED: ClassVar[str] = chr(KEY_PSEUDO | ord('\\'))
+    """Fake ASCII value generated for unshifted key code 86"""
+
+    KEY_NON_US_SHIFTED: ClassVar[str] = chr(KEY_PSEUDO | ord('|'))
+    """Fake ASCII value generated for shifted key code 86"""
 
     @property
     def inverse(self) -> MutableMapping[str, Key]:
         inverse = super().inverse
         assert len(inverse) == 0x7f
+        inverse[self.KEY_NON_US_UNSHIFTED] = self.unshifted[self.KEY_NON_US]
+        inverse[self.KEY_NON_US_SHIFTED] = self.shifted[self.KEY_NON_US]
         assert all(x.modifiers in {KeyModifiers.NONE, KeyModifiers.SHIFT,
                                    KeyModifiers.CTRL}
                    for x in inverse.values())
@@ -251,12 +267,13 @@ class KeyRemapping:
         raw = {source: self.target[key.modifiers][key.keycode].ascii
                for source, key in self.source.inverse.items()}
         # Eliminate any null mappings, mappings that attempt to remap
-        # the backspace key, or identity mappings
+        # the backspace key, or mappings that would become identity
+        # mappings after clearing the high bit
         table = {source: target for source, target in raw.items()
                  if target
                  and ord(source) != 0x7f
                  and ord(target) != 0x7f
-                 and ord(source) != ord(target)}
+                 and ord(source) & ~BiosKeyMapping.KEY_PSEUDO != ord(target)}
         # Recursively delete any mappings that would produce
         # unreachable alphanumerics (e.g. the "il" keymap, which maps
         # away the whole lower-case alphabet)
@@ -281,13 +298,17 @@ class KeyRemapping:
         """C variable name"""
         return re.sub(r'\W', '_', self.name) + "_mapping"
 
-    @staticmethod
-    def ascii_name(char: str) -> str:
+    @classmethod
+    def ascii_name(cls, char: str) -> str:
         """ASCII character name"""
         if char == '\\':
             name = "'\\\\'"
         elif char == '\'':
             name = "'\\\''"
+        elif ord(char) & BiosKeyMapping.KEY_PSEUDO:
+            name = "Pseudo-%s" % cls.ascii_name(
+                chr(ord(char) & ~BiosKeyMapping.KEY_PSEUDO)
+            )
         elif char.isprintable():
             name = "'%s'" % char
         elif ord(char) <= 0x1a:
-- 
cgit v1.2.3-55-g7522


From f2a59d5973da2041f93264609698b9b3f4ec101b Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 14 Feb 2022 16:31:08 +0000
Subject: [console] Centralise handling of key modifiers

Handle Ctrl and CapsLock key modifiers within key_remap(), to provide
consistent behaviour across different console types.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/include/bios.h                  |  3 ++
 src/arch/x86/interface/pcbios/bios_console.c | 23 +++++++++++----
 src/core/keymap.c                            | 41 ++++++++++++++++++++++----
 src/drivers/usb/usbkbd.c                     | 21 ++++++-------
 src/include/ipxe/keymap.h                    | 21 +++++++++++++
 src/interface/efi/efi_console.c              | 44 ++++++++++++++++++----------
 6 files changed, 116 insertions(+), 37 deletions(-)

(limited to 'src/drivers')

diff --git a/src/arch/x86/include/bios.h b/src/arch/x86/include/bios.h
index 14e7acbc7..3ba8264ec 100644
--- a/src/arch/x86/include/bios.h
+++ b/src/arch/x86/include/bios.h
@@ -6,6 +6,9 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define BDA_SEG 0x0040
 #define BDA_EBDA 0x000e
 #define BDA_EQUIPMENT_WORD 0x0010
+#define BDA_KB0 0x0017
+#define BDA_KB0_CTRL 0x04
+#define BDA_KB0_CAPSLOCK 0x040
 #define BDA_FBMS 0x0013
 #define BDA_TICKS 0x006c
 #define BDA_MIDNIGHT 0x0070
diff --git a/src/arch/x86/interface/pcbios/bios_console.c b/src/arch/x86/interface/pcbios/bios_console.c
index 438a01d07..2664ac8a5 100644
--- a/src/arch/x86/interface/pcbios/bios_console.c
+++ b/src/arch/x86/interface/pcbios/bios_console.c
@@ -361,6 +361,7 @@ static const char * bios_ansi_seq ( unsigned int scancode ) {
  */
 static int bios_getchar ( void ) {
 	uint16_t keypress;
+	uint8_t kb0;
 	unsigned int scancode;
 	unsigned int character;
 	const char *ansi_seq;
@@ -385,16 +386,28 @@ static int bios_getchar ( void ) {
 	bios_inject_lock--;
 	scancode = ( keypress >> 8 );
 	character = ( keypress & 0xff );
+	get_real ( kb0, BDA_SEG, BDA_KB0 );
 
 	/* If it's a normal character, map (if applicable) and return it */
 	if ( character && ( character < 0x80 ) ) {
-		if ( scancode < SCANCODE_RSHIFT ) {
-			return key_remap ( character );
-		} else if ( scancode == SCANCODE_NON_US ) {
-			return key_remap ( character | KEYMAP_PSEUDO );
-		} else {
+
+		/* Handle special scancodes */
+		if ( scancode == SCANCODE_NON_US ) {
+			/* Treat as "\|" with high bit set */
+			character |= KEYMAP_PSEUDO;
+		} else if ( scancode >= SCANCODE_RSHIFT ) {
+			/* Non-remappable scancode (e.g. numeric keypad) */
 			return character;
 		}
+
+		/* Apply modifiers */
+		if ( kb0 & BDA_KB0_CTRL )
+			character |= KEYMAP_CTRL;
+		if ( kb0 & BDA_KB0_CAPSLOCK )
+			character |= KEYMAP_CAPSLOCK_REDO;
+
+		/* Map and return */
+		return key_remap ( character );
 	}
 
 	/* Otherwise, check for a special key that we know about */
diff --git a/src/core/keymap.c b/src/core/keymap.c
index c0953967a..a5209bc20 100644
--- a/src/core/keymap.c
+++ b/src/core/keymap.c
@@ -23,6 +23,8 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <ctype.h>
+#include <ipxe/keys.h>
 #include <ipxe/keymap.h>
 
 /** @file
@@ -31,6 +33,18 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 
+/** ASCII character mask */
+#define ASCII_MASK 0x7f
+
+/** Control character mask */
+#define CTRL_MASK 0x1f
+
+/** Upper case character mask */
+#define UPPER_MASK 0x5f
+
+/** Case toggle bit */
+#define CASE_TOGGLE ( ASCII_MASK & ~UPPER_MASK )
+
 /** Default keyboard mapping */
 static TABLE_START ( keymap_start, KEYMAP );
 
@@ -41,21 +55,36 @@ static struct keymap *keymap = keymap_start;
  * Remap a key
  *
  * @v character		Character read from console
- * @ret character	Mapped character
+ * @ret mapped		Mapped character
  */
 unsigned int key_remap ( unsigned int character ) {
+	unsigned int mapped = ( character & KEYMAP_MASK );
 	struct keymap_key *key;
 
+	/* Invert case before remapping if applicable */
+	if ( ( character & KEYMAP_CAPSLOCK_UNDO ) && isalpha ( mapped ) )
+		mapped ^= CASE_TOGGLE;
+
 	/* Remap via table */
 	for ( key = keymap->basic ; key->from ; key++ ) {
-		if ( key->from == character ) {
-			character = key->to;
+		if ( mapped == key->from ) {
+			mapped = key->to;
 			break;
 		}
 	}
 
-	/* Clear pseudo key flag */
-	character &= ~KEYMAP_PSEUDO;
+	/* Handle Ctrl-<key> and CapsLock */
+	if ( isalpha ( mapped ) ) {
+		if ( character & KEYMAP_CTRL ) {
+			mapped &= CTRL_MASK;
+		} else if ( character & KEYMAP_CAPSLOCK ) {
+			mapped ^= CASE_TOGGLE;
+		}
+	}
+
+	/* Clear flags */
+	mapped &= ASCII_MASK;
 
-	return character;
+	DBGC2 ( &keymap, "KEYMAP mapped %04x => %02x\n", character, mapped );
+	return mapped;
 }
diff --git a/src/drivers/usb/usbkbd.c b/src/drivers/usb/usbkbd.c
index 6954cd69b..516667b25 100644
--- a/src/drivers/usb/usbkbd.c
+++ b/src/drivers/usb/usbkbd.c
@@ -71,6 +71,9 @@ static unsigned int usbkbd_map ( unsigned int keycode, unsigned int modifiers,
 	} else if ( keycode <= USBKBD_KEY_Z ) {
 		/* Alphabetic keys */
 		key = ( keycode - USBKBD_KEY_A + 'a' );
+		if ( modifiers & USBKBD_SHIFT ) {
+			key -= ( 'a' - 'A' );
+		}
 	} else if ( keycode <= USBKBD_KEY_0 ) {
 		/* Numeric key row */
 		if ( modifiers & USBKBD_SHIFT ) {
@@ -125,17 +128,15 @@ static unsigned int usbkbd_map ( unsigned int keycode, unsigned int modifiers,
 	/* Remap key if applicable */
 	if ( ( keycode < USBKBD_KEY_CAPS_LOCK ) ||
 	     ( keycode == USBKBD_KEY_NON_US ) ) {
-		key = key_remap ( key );
-	}
 
-	/* Handle upper/lower case and Ctrl-<key> */
-	if ( islower ( key ) ) {
-		if ( modifiers & USBKBD_CTRL ) {
-			key -= ( 'a' - CTRL_A );
-		} else if ( ( modifiers & USBKBD_SHIFT ) ||
-			    ( leds & USBKBD_LED_CAPS_LOCK ) ) {
-			key -= ( 'a' - 'A' );
-		}
+		/* Apply modifiers */
+		if ( modifiers & USBKBD_CTRL )
+			key |= KEYMAP_CTRL;
+		if ( leds & USBKBD_LED_CAPS_LOCK )
+			key |= KEYMAP_CAPSLOCK;
+
+		/* Remap key */
+		key = key_remap ( key );
 	}
 
 	return key;
diff --git a/src/include/ipxe/keymap.h b/src/include/ipxe/keymap.h
index a64ab9cd4..3da25190b 100644
--- a/src/include/ipxe/keymap.h
+++ b/src/include/ipxe/keymap.h
@@ -40,9 +40,30 @@ struct keymap {
 /** Define a keyboard mapping */
 #define __keymap __table_entry ( KEYMAP, 01 )
 
+/** Mappable character mask */
+#define KEYMAP_MASK 0xff
+
 /** Pseudo key flag */
 #define KEYMAP_PSEUDO 0x80
 
+/** Ctrl key flag */
+#define KEYMAP_CTRL 0x0100
+
+/** CapsLock key flag */
+#define KEYMAP_CAPSLOCK 0x0200
+
+/** Undo CapsLock key flag
+ *
+ * Used when the keyboard driver has already interpreted the CapsLock
+ * key, in which case the effect needs to be undone before remapping
+ * in order to correctly handle keyboard mappings that swap alphabetic
+ * and non-alphabetic keys.
+ */
+#define KEYMAP_CAPSLOCK_UNDO 0x0400
+
+/** Undo and redo CapsLock key flags */
+#define KEYMAP_CAPSLOCK_REDO ( KEYMAP_CAPSLOCK | KEYMAP_CAPSLOCK_UNDO )
+
 extern unsigned int key_remap ( unsigned int character );
 
 #endif /* _IPXE_KEYMAP_H */
diff --git a/src/interface/efi/efi_console.c b/src/interface/efi/efi_console.c
index 874f54b6c..9adce4a9b 100644
--- a/src/interface/efi/efi_console.c
+++ b/src/interface/efi/efi_console.c
@@ -55,8 +55,6 @@ FILE_LICENCE ( GPL2_OR_LATER );
 
 #define ATTR_DEFAULT		ATTR_FCOL_WHITE
 
-#define CTRL_MASK		0x1f
-
 /* Set default console usage if applicable */
 #if ! ( defined ( CONSOLE_EFI ) && CONSOLE_EXPLICIT ( CONSOLE_EFI ) )
 #undef CONSOLE_EFI
@@ -286,6 +284,9 @@ static int efi_getchar ( void ) {
 	EFI_SIMPLE_TEXT_INPUT_PROTOCOL *conin = efi_systab->ConIn;
 	EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *conin_ex = efi_conin_ex;
 	const char *ansi_seq;
+	unsigned int character;
+	unsigned int shift;
+	unsigned int toggle;
 	EFI_KEY_DATA key;
 	EFI_STATUS efirc;
 	int rc;
@@ -318,23 +319,34 @@ static int efi_getchar ( void ) {
 	       key.KeyState.KeyToggleState, key.Key.UnicodeChar,
 	       key.Key.ScanCode );
 
-	/* Remap key.  There is unfortunately no way to avoid
-	 * remapping the numeric keypad, since EFI destroys the scan
-	 * code information that would allow us to differentiate
-	 * between main keyboard and numeric keypad.
+	/* If key has a Unicode representation, remap and return it.
+	 * There is unfortunately no way to avoid remapping the
+	 * numeric keypad, since EFI destroys the scan code
+	 * information that would allow us to differentiate between
+	 * main keyboard and numeric keypad.
 	 */
-	key.Key.UnicodeChar = key_remap ( key.Key.UnicodeChar );
+	if ( ( character = key.Key.UnicodeChar ) != 0 ) {
+
+		/* Apply shift state */
+		shift = key.KeyState.KeyShiftState;
+		if ( shift & EFI_SHIFT_STATE_VALID ) {
+			if ( shift & ( EFI_LEFT_CONTROL_PRESSED |
+				       EFI_RIGHT_CONTROL_PRESSED ) ) {
+				character |= KEYMAP_CTRL;
+			}
+		}
 
-	/* Translate Ctrl-<key> */
-	if ( ( key.KeyState.KeyShiftState & EFI_SHIFT_STATE_VALID ) &&
-	     ( key.KeyState.KeyShiftState & ( EFI_LEFT_CONTROL_PRESSED |
-					      EFI_RIGHT_CONTROL_PRESSED ) ) ) {
-		key.Key.UnicodeChar &= CTRL_MASK;
-	}
+		/* Apply toggle state */
+		toggle = key.KeyState.KeyToggleState;
+		if ( toggle & EFI_TOGGLE_STATE_VALID ) {
+			if ( toggle & EFI_CAPS_LOCK_ACTIVE ) {
+				character |= KEYMAP_CAPSLOCK_REDO;
+			}
+		}
 
-	/* If key has a Unicode representation, return it */
-	if ( key.Key.UnicodeChar )
-		return key.Key.UnicodeChar;
+		/* Remap and return key */
+		return key_remap ( character );
+	}
 
 	/* Otherwise, check for a special key that we know about */
 	if ( ( ansi_seq = scancode_to_ansi_seq ( key.Key.ScanCode ) ) ) {
-- 
cgit v1.2.3-55-g7522


From e1cedbc0d4fdb0e16818f6b722f4873a50780761 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 14 Feb 2022 13:45:59 +0000
Subject: [console] Support AltGr to access ASCII characters via remapping

Several keyboard layouts define ASCII characters as accessible only
via the AltGr modifier.  Add support for this modifier to ensure that
all ASCII characters are accessible.

Experiments suggest that the BIOS console is likely to fail to
generate ASCII characters when the AltGr key is pressed.  Work around
this limitation by accepting LShift+RShift (which will definitely
produce an ASCII character) as a synonym for AltGr.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/include/bios.h                  |  4 +++
 src/arch/x86/interface/pcbios/bios_console.c | 12 +++++++++
 src/core/keymap.c                            |  5 +++-
 src/drivers/usb/usbkbd.c                     |  2 ++
 src/hci/keymap/keymap_al.c                   |  8 ++++++
 src/hci/keymap/keymap_az.c                   |  7 +++++
 src/hci/keymap/keymap_by.c                   |  6 +++++
 src/hci/keymap/keymap_cf.c                   |  9 +++++++
 src/hci/keymap/keymap_cz.c                   | 26 ++++++++++++++++++
 src/hci/keymap/keymap_de.c                   | 11 ++++++++
 src/hci/keymap/keymap_dk.c                   |  9 +++++++
 src/hci/keymap/keymap_es.c                   | 11 ++++++++
 src/hci/keymap/keymap_et.c                   | 10 +++++++
 src/hci/keymap/keymap_fi.c                   |  9 +++++++
 src/hci/keymap/keymap_fr.c                   | 12 +++++++++
 src/hci/keymap/keymap_gr.c                   |  6 +++++
 src/hci/keymap/keymap_hu.c                   | 17 ++++++++++++
 src/hci/keymap/keymap_il.c                   |  6 +++++
 src/hci/keymap/keymap_it.c                   | 12 +++++++++
 src/hci/keymap/keymap_lt.c                   |  6 +++++
 src/hci/keymap/keymap_mk.c                   |  6 +++++
 src/hci/keymap/keymap_mt.c                   |  7 +++++
 src/hci/keymap/keymap_nl.c                   |  8 ++++++
 src/hci/keymap/keymap_no-latin1.c            | 10 +++++++
 src/hci/keymap/keymap_no.c                   |  8 ++++++
 src/hci/keymap/keymap_pl.c                   |  6 +++++
 src/hci/keymap/keymap_pt.c                   | 10 +++++++
 src/hci/keymap/keymap_ro.c                   |  6 +++++
 src/hci/keymap/keymap_ru.c                   |  6 +++++
 src/hci/keymap/keymap_sg.c                   | 10 +++++++
 src/hci/keymap/keymap_sr-latin.c             |  6 +++++
 src/hci/keymap/keymap_ua.c                   |  6 +++++
 src/hci/keymap/keymap_uk.c                   |  6 +++++
 src/hci/keymap/keymap_us.c                   |  6 +++++
 src/include/ipxe/keymap.h                    |  5 ++++
 src/interface/efi/efi_console.c              |  3 +++
 src/util/genkeymap.py                        | 40 +++++++++++++++++++++++++---
 37 files changed, 332 insertions(+), 5 deletions(-)

(limited to 'src/drivers')

diff --git a/src/arch/x86/include/bios.h b/src/arch/x86/include/bios.h
index 3ba8264ec..6391a4958 100644
--- a/src/arch/x86/include/bios.h
+++ b/src/arch/x86/include/bios.h
@@ -7,6 +7,8 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define BDA_EBDA 0x000e
 #define BDA_EQUIPMENT_WORD 0x0010
 #define BDA_KB0 0x0017
+#define BDA_KB0_RSHIFT 0x01
+#define BDA_KB0_LSHIFT 0x02
 #define BDA_KB0_CTRL 0x04
 #define BDA_KB0_CAPSLOCK 0x040
 #define BDA_FBMS 0x0013
@@ -16,5 +18,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define BDA_REBOOT_WARM 0x1234
 #define BDA_NUM_DRIVES 0x0075
 #define BDA_CHAR_HEIGHT 0x0085
+#define BDA_KB2 0x0096
+#define BDA_KB2_RALT 0x08
 
 #endif /* BIOS_H */
diff --git a/src/arch/x86/interface/pcbios/bios_console.c b/src/arch/x86/interface/pcbios/bios_console.c
index 2664ac8a5..0220c8564 100644
--- a/src/arch/x86/interface/pcbios/bios_console.c
+++ b/src/arch/x86/interface/pcbios/bios_console.c
@@ -362,6 +362,7 @@ static const char * bios_ansi_seq ( unsigned int scancode ) {
 static int bios_getchar ( void ) {
 	uint16_t keypress;
 	uint8_t kb0;
+	uint8_t kb2;
 	unsigned int scancode;
 	unsigned int character;
 	const char *ansi_seq;
@@ -387,6 +388,7 @@ static int bios_getchar ( void ) {
 	scancode = ( keypress >> 8 );
 	character = ( keypress & 0xff );
 	get_real ( kb0, BDA_SEG, BDA_KB0 );
+	get_real ( kb2, BDA_SEG, BDA_KB2 );
 
 	/* If it's a normal character, map (if applicable) and return it */
 	if ( character && ( character < 0x80 ) ) {
@@ -405,6 +407,16 @@ static int bios_getchar ( void ) {
 			character |= KEYMAP_CTRL;
 		if ( kb0 & BDA_KB0_CAPSLOCK )
 			character |= KEYMAP_CAPSLOCK_REDO;
+		if ( kb2 & BDA_KB2_RALT )
+			character |= KEYMAP_ALTGR;
+
+		/* Treat LShift+RShift as AltGr since many BIOSes will
+		 * not return ASCII characters when AltGr is pressed.
+		 */
+		if ( ( kb0 & ( BDA_KB0_LSHIFT | BDA_KB0_RSHIFT ) ) ==
+		     ( BDA_KB0_LSHIFT | BDA_KB0_RSHIFT ) ) {
+			character |= KEYMAP_ALTGR;
+		}
 
 		/* Map and return */
 		return key_remap ( character );
diff --git a/src/core/keymap.c b/src/core/keymap.c
index a5209bc20..3fa85f74e 100644
--- a/src/core/keymap.c
+++ b/src/core/keymap.c
@@ -65,8 +65,11 @@ unsigned int key_remap ( unsigned int character ) {
 	if ( ( character & KEYMAP_CAPSLOCK_UNDO ) && isalpha ( mapped ) )
 		mapped ^= CASE_TOGGLE;
 
+	/* Select remapping table */
+	key = ( ( character & KEYMAP_ALTGR ) ? keymap->altgr : keymap->basic );
+
 	/* Remap via table */
-	for ( key = keymap->basic ; key->from ; key++ ) {
+	for ( ; key->from ; key++ ) {
 		if ( mapped == key->from ) {
 			mapped = key->to;
 			break;
diff --git a/src/drivers/usb/usbkbd.c b/src/drivers/usb/usbkbd.c
index 516667b25..b284e584f 100644
--- a/src/drivers/usb/usbkbd.c
+++ b/src/drivers/usb/usbkbd.c
@@ -132,6 +132,8 @@ static unsigned int usbkbd_map ( unsigned int keycode, unsigned int modifiers,
 		/* Apply modifiers */
 		if ( modifiers & USBKBD_CTRL )
 			key |= KEYMAP_CTRL;
+		if ( modifiers & USBKBD_ALT_RIGHT )
+			key |= KEYMAP_ALTGR;
 		if ( leds & USBKBD_LED_CAPS_LOCK )
 			key |= KEYMAP_CAPSLOCK;
 
diff --git a/src/hci/keymap/keymap_al.c b/src/hci/keymap/keymap_al.c
index a3df385a9..b68b98878 100644
--- a/src/hci/keymap/keymap_al.c
+++ b/src/hci/keymap/keymap_al.c
@@ -35,8 +35,16 @@ static struct keymap_key al_basic[] = {
 	{ 0, 0 }
 };
 
+/** "al" AltGr remapping */
+static struct keymap_key al_altgr[] = {
+	{ 0x31, 0x7e },	/* '1' => '~' */
+	{ 0x37, 0x60 },	/* '7' => '`' */
+	{ 0, 0 }
+};
+
 /** "al" keyboard map */
 struct keymap al_keymap __keymap = {
 	.name = "al",
 	.basic = al_basic,
+	.altgr = al_altgr,
 };
diff --git a/src/hci/keymap/keymap_az.c b/src/hci/keymap/keymap_az.c
index 7b382ca8b..03087e01e 100644
--- a/src/hci/keymap/keymap_az.c
+++ b/src/hci/keymap/keymap_az.c
@@ -26,8 +26,15 @@ static struct keymap_key az_basic[] = {
 	{ 0, 0 }
 };
 
+/** "az" AltGr remapping */
+static struct keymap_key az_altgr[] = {
+	{ 0xdc, 0x7c },	/* Pseudo-'\\' => '|' */
+	{ 0, 0 }
+};
+
 /** "az" keyboard map */
 struct keymap az_keymap __keymap = {
 	.name = "az",
 	.basic = az_basic,
+	.altgr = az_altgr,
 };
diff --git a/src/hci/keymap/keymap_by.c b/src/hci/keymap/keymap_by.c
index 4127609e3..9af6c966d 100644
--- a/src/hci/keymap/keymap_by.c
+++ b/src/hci/keymap/keymap_by.c
@@ -17,8 +17,14 @@ static struct keymap_key by_basic[] = {
 	{ 0, 0 }
 };
 
+/** "by" AltGr remapping */
+static struct keymap_key by_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "by" keyboard map */
 struct keymap by_keymap __keymap = {
 	.name = "by",
 	.basic = by_basic,
+	.altgr = by_altgr,
 };
diff --git a/src/hci/keymap/keymap_cf.c b/src/hci/keymap/keymap_cf.c
index 0bbe89659..09242ee6f 100644
--- a/src/hci/keymap/keymap_cf.c
+++ b/src/hci/keymap/keymap_cf.c
@@ -24,8 +24,17 @@ static struct keymap_key cf_basic[] = {
 	{ 0, 0 }
 };
 
+/** "cf" AltGr remapping */
+static struct keymap_key cf_altgr[] = {
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0x3b, 0x7e },	/* ';' => '~' */
+	{ 0x60, 0x5c },	/* '`' => '\\' */
+	{ 0, 0 }
+};
+
 /** "cf" keyboard map */
 struct keymap cf_keymap __keymap = {
 	.name = "cf",
 	.basic = cf_basic,
+	.altgr = cf_altgr,
 };
diff --git a/src/hci/keymap/keymap_cz.c b/src/hci/keymap/keymap_cz.c
index 8655d5b68..cce686d9a 100644
--- a/src/hci/keymap/keymap_cz.c
+++ b/src/hci/keymap/keymap_cz.c
@@ -46,8 +46,34 @@ static struct keymap_key cz_basic[] = {
 	{ 0, 0 }
 };
 
+/** "cz" AltGr remapping */
+static struct keymap_key cz_altgr[] = {
+	{ 0x2c, 0x3c },	/* ',' => '<' */
+	{ 0x2e, 0x3e },	/* '.' => '>' */
+	{ 0x2f, 0x2a },	/* '/' => '*' */
+	{ 0x30, 0x7d },	/* '0' => '}' */
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0x33, 0x23 },	/* '3' => '#' */
+	{ 0x34, 0x24 },	/* '4' => '$' */
+	{ 0x36, 0x5e },	/* '6' => '^' */
+	{ 0x37, 0x26 },	/* '7' => '&' */
+	{ 0x38, 0x2a },	/* '8' => '*' */
+	{ 0x39, 0x7b },	/* '9' => '{' */
+	{ 0x3b, 0x24 },	/* ';' => '$' */
+	{ 0x62, 0x7b },	/* 'b' => '{' */
+	{ 0x63, 0x26 },	/* 'c' => '&' */
+	{ 0x67, 0x5d },	/* 'g' => ']' */
+	{ 0x68, 0x60 },	/* 'h' => '`' */
+	{ 0x6d, 0x5e },	/* 'm' => '^' */
+	{ 0x6e, 0x7d },	/* 'n' => '}' */
+	{ 0x76, 0x40 },	/* 'v' => '@' */
+	{ 0x78, 0x23 },	/* 'x' => '#' */
+	{ 0, 0 }
+};
+
 /** "cz" keyboard map */
 struct keymap cz_keymap __keymap = {
 	.name = "cz",
 	.basic = cz_basic,
+	.altgr = cz_altgr,
 };
diff --git a/src/hci/keymap/keymap_de.c b/src/hci/keymap/keymap_de.c
index 4d23c2e60..4a889a242 100644
--- a/src/hci/keymap/keymap_de.c
+++ b/src/hci/keymap/keymap_de.c
@@ -41,8 +41,19 @@ static struct keymap_key de_basic[] = {
 	{ 0, 0 }
 };
 
+/** "de" AltGr remapping */
+static struct keymap_key de_altgr[] = {
+	{ 0x2d, 0x5c },	/* '-' => '\\' */
+	{ 0x30, 0x7d },	/* '0' => '}' */
+	{ 0x39, 0x5d },	/* '9' => ']' */
+	{ 0x71, 0x40 },	/* 'q' => '@' */
+	{ 0xdc, 0x7c },	/* Pseudo-'\\' => '|' */
+	{ 0, 0 }
+};
+
 /** "de" keyboard map */
 struct keymap de_keymap __keymap = {
 	.name = "de",
 	.basic = de_basic,
+	.altgr = de_altgr,
 };
diff --git a/src/hci/keymap/keymap_dk.c b/src/hci/keymap/keymap_dk.c
index 100246bf5..4d40743b1 100644
--- a/src/hci/keymap/keymap_dk.c
+++ b/src/hci/keymap/keymap_dk.c
@@ -33,8 +33,17 @@ static struct keymap_key dk_basic[] = {
 	{ 0, 0 }
 };
 
+/** "dk" AltGr remapping */
+static struct keymap_key dk_altgr[] = {
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0x3d, 0x7c },	/* '=' => '|' */
+	{ 0x71, 0x40 },	/* 'q' => '@' */
+	{ 0, 0 }
+};
+
 /** "dk" keyboard map */
 struct keymap dk_keymap __keymap = {
 	.name = "dk",
 	.basic = dk_basic,
+	.altgr = dk_altgr,
 };
diff --git a/src/hci/keymap/keymap_es.c b/src/hci/keymap/keymap_es.c
index 2f4b86c47..397e2cbaa 100644
--- a/src/hci/keymap/keymap_es.c
+++ b/src/hci/keymap/keymap_es.c
@@ -33,8 +33,19 @@ static struct keymap_key es_basic[] = {
 	{ 0, 0 }
 };
 
+/** "es" AltGr remapping */
+static struct keymap_key es_altgr[] = {
+	{ 0x30, 0x7d },	/* '0' => '}' */
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0x39, 0x5d },	/* '9' => ']' */
+	{ 0x5c, 0x7d },	/* '\\' => '}' */
+	{ 0x71, 0x40 },	/* 'q' => '@' */
+	{ 0, 0 }
+};
+
 /** "es" keyboard map */
 struct keymap es_keymap __keymap = {
 	.name = "es",
 	.basic = es_basic,
+	.altgr = es_altgr,
 };
diff --git a/src/hci/keymap/keymap_et.c b/src/hci/keymap/keymap_et.c
index a8bf46ebc..4120dbed9 100644
--- a/src/hci/keymap/keymap_et.c
+++ b/src/hci/keymap/keymap_et.c
@@ -31,8 +31,18 @@ static struct keymap_key et_basic[] = {
 	{ 0, 0 }
 };
 
+/** "et" AltGr remapping */
+static struct keymap_key et_altgr[] = {
+	{ 0x27, 0x5e },	/* '\'' => '^' */
+	{ 0x2d, 0x5c },	/* '-' => '\\' */
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0xdc, 0x7c },	/* Pseudo-'\\' => '|' */
+	{ 0, 0 }
+};
+
 /** "et" keyboard map */
 struct keymap et_keymap __keymap = {
 	.name = "et",
 	.basic = et_basic,
+	.altgr = et_altgr,
 };
diff --git a/src/hci/keymap/keymap_fi.c b/src/hci/keymap/keymap_fi.c
index eb75eb4dc..978121a88 100644
--- a/src/hci/keymap/keymap_fi.c
+++ b/src/hci/keymap/keymap_fi.c
@@ -31,8 +31,17 @@ static struct keymap_key fi_basic[] = {
 	{ 0, 0 }
 };
 
+/** "fi" AltGr remapping */
+static struct keymap_key fi_altgr[] = {
+	{ 0x2d, 0x5c },	/* '-' => '\\' */
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0xdc, 0x7c },	/* Pseudo-'\\' => '|' */
+	{ 0, 0 }
+};
+
 /** "fi" keyboard map */
 struct keymap fi_keymap __keymap = {
 	.name = "fi",
 	.basic = fi_basic,
+	.altgr = fi_altgr,
 };
diff --git a/src/hci/keymap/keymap_fr.c b/src/hci/keymap/keymap_fr.c
index 523254ee5..c0a959f0d 100644
--- a/src/hci/keymap/keymap_fr.c
+++ b/src/hci/keymap/keymap_fr.c
@@ -62,8 +62,20 @@ static struct keymap_key fr_basic[] = {
 	{ 0, 0 }
 };
 
+/** "fr" AltGr remapping */
+static struct keymap_key fr_altgr[] = {
+	{ 0x2d, 0x5d },	/* '-' => ']' */
+	{ 0x30, 0x40 },	/* '0' => '@' */
+	{ 0x33, 0x23 },	/* '3' => '#' */
+	{ 0x38, 0x5c },	/* '8' => '\\' */
+	{ 0x39, 0x5e },	/* '9' => '^' */
+	{ 0x61, 0x40 },	/* 'a' => '@' */
+	{ 0, 0 }
+};
+
 /** "fr" keyboard map */
 struct keymap fr_keymap __keymap = {
 	.name = "fr",
 	.basic = fr_basic,
+	.altgr = fr_altgr,
 };
diff --git a/src/hci/keymap/keymap_gr.c b/src/hci/keymap/keymap_gr.c
index 16a2a7032..4826c26c2 100644
--- a/src/hci/keymap/keymap_gr.c
+++ b/src/hci/keymap/keymap_gr.c
@@ -17,8 +17,14 @@ static struct keymap_key gr_basic[] = {
 	{ 0, 0 }
 };
 
+/** "gr" AltGr remapping */
+static struct keymap_key gr_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "gr" keyboard map */
 struct keymap gr_keymap __keymap = {
 	.name = "gr",
 	.basic = gr_basic,
+	.altgr = gr_altgr,
 };
diff --git a/src/hci/keymap/keymap_hu.c b/src/hci/keymap/keymap_hu.c
index 5e407161f..64e27dda6 100644
--- a/src/hci/keymap/keymap_hu.c
+++ b/src/hci/keymap/keymap_hu.c
@@ -35,8 +35,25 @@ static struct keymap_key hu_basic[] = {
 	{ 0, 0 }
 };
 
+/** "hu" AltGr remapping */
+static struct keymap_key hu_altgr[] = {
+	{ 0x2e, 0x3e },	/* '.' => '>' */
+	{ 0x2f, 0x2a },	/* '/' => '*' */
+	{ 0x33, 0x5e },	/* '3' => '^' */
+	{ 0x37, 0x60 },	/* '7' => '`' */
+	{ 0x3b, 0x24 },	/* ';' => '$' */
+	{ 0x63, 0x26 },	/* 'c' => '&' */
+	{ 0x6d, 0x3c },	/* 'm' => '<' */
+	{ 0x76, 0x40 },	/* 'v' => '@' */
+	{ 0x78, 0x23 },	/* 'x' => '#' */
+	{ 0x7a, 0x3e },	/* 'z' => '>' */
+	{ 0xdc, 0x3c },	/* Pseudo-'\\' => '<' */
+	{ 0, 0 }
+};
+
 /** "hu" keyboard map */
 struct keymap hu_keymap __keymap = {
 	.name = "hu",
 	.basic = hu_basic,
+	.altgr = hu_altgr,
 };
diff --git a/src/hci/keymap/keymap_il.c b/src/hci/keymap/keymap_il.c
index de5e639ca..e3061fa54 100644
--- a/src/hci/keymap/keymap_il.c
+++ b/src/hci/keymap/keymap_il.c
@@ -29,8 +29,14 @@ static struct keymap_key il_basic[] = {
 	{ 0, 0 }
 };
 
+/** "il" AltGr remapping */
+static struct keymap_key il_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "il" keyboard map */
 struct keymap il_keymap __keymap = {
 	.name = "il",
 	.basic = il_basic,
+	.altgr = il_altgr,
 };
diff --git a/src/hci/keymap/keymap_it.c b/src/hci/keymap/keymap_it.c
index a4921020a..f67bbadcb 100644
--- a/src/hci/keymap/keymap_it.c
+++ b/src/hci/keymap/keymap_it.c
@@ -35,8 +35,20 @@ static struct keymap_key it_basic[] = {
 	{ 0, 0 }
 };
 
+/** "it" AltGr remapping */
+static struct keymap_key it_altgr[] = {
+	{ 0x2d, 0x60 },	/* '-' => '`' */
+	{ 0x30, 0x7d },	/* '0' => '}' */
+	{ 0x39, 0x5d },	/* '9' => ']' */
+	{ 0x3b, 0x40 },	/* ';' => '@' */
+	{ 0x3d, 0x7e },	/* '=' => '~' */
+	{ 0x71, 0x40 },	/* 'q' => '@' */
+	{ 0, 0 }
+};
+
 /** "it" keyboard map */
 struct keymap it_keymap __keymap = {
 	.name = "it",
 	.basic = it_basic,
+	.altgr = it_altgr,
 };
diff --git a/src/hci/keymap/keymap_lt.c b/src/hci/keymap/keymap_lt.c
index 333241d21..5d6ee5a8c 100644
--- a/src/hci/keymap/keymap_lt.c
+++ b/src/hci/keymap/keymap_lt.c
@@ -15,8 +15,14 @@ static struct keymap_key lt_basic[] = {
 	{ 0, 0 }
 };
 
+/** "lt" AltGr remapping */
+static struct keymap_key lt_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "lt" keyboard map */
 struct keymap lt_keymap __keymap = {
 	.name = "lt",
 	.basic = lt_basic,
+	.altgr = lt_altgr,
 };
diff --git a/src/hci/keymap/keymap_mk.c b/src/hci/keymap/keymap_mk.c
index 1656fb99c..4b90ef799 100644
--- a/src/hci/keymap/keymap_mk.c
+++ b/src/hci/keymap/keymap_mk.c
@@ -17,8 +17,14 @@ static struct keymap_key mk_basic[] = {
 	{ 0, 0 }
 };
 
+/** "mk" AltGr remapping */
+static struct keymap_key mk_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "mk" keyboard map */
 struct keymap mk_keymap __keymap = {
 	.name = "mk",
 	.basic = mk_basic,
+	.altgr = mk_altgr,
 };
diff --git a/src/hci/keymap/keymap_mt.c b/src/hci/keymap/keymap_mt.c
index ebff8506f..f5baf6907 100644
--- a/src/hci/keymap/keymap_mt.c
+++ b/src/hci/keymap/keymap_mt.c
@@ -20,8 +20,15 @@ static struct keymap_key mt_basic[] = {
 	{ 0, 0 }
 };
 
+/** "mt" AltGr remapping */
+static struct keymap_key mt_altgr[] = {
+	{ 0x2d, 0x5c },	/* '-' => '\\' */
+	{ 0, 0 }
+};
+
 /** "mt" keyboard map */
 struct keymap mt_keymap __keymap = {
 	.name = "mt",
 	.basic = mt_basic,
+	.altgr = mt_altgr,
 };
diff --git a/src/hci/keymap/keymap_nl.c b/src/hci/keymap/keymap_nl.c
index 2172e045f..bbee4cbdf 100644
--- a/src/hci/keymap/keymap_nl.c
+++ b/src/hci/keymap/keymap_nl.c
@@ -38,8 +38,16 @@ static struct keymap_key nl_basic[] = {
 	{ 0, 0 }
 };
 
+/** "nl" AltGr remapping */
+static struct keymap_key nl_altgr[] = {
+	{ 0x2d, 0x5c },	/* '-' => '\\' */
+	{ 0x39, 0x7d },	/* '9' => '}' */
+	{ 0, 0 }
+};
+
 /** "nl" keyboard map */
 struct keymap nl_keymap __keymap = {
 	.name = "nl",
 	.basic = nl_basic,
+	.altgr = nl_altgr,
 };
diff --git a/src/hci/keymap/keymap_no-latin1.c b/src/hci/keymap/keymap_no-latin1.c
index 65f30beae..63fe85548 100644
--- a/src/hci/keymap/keymap_no-latin1.c
+++ b/src/hci/keymap/keymap_no-latin1.c
@@ -37,8 +37,18 @@ static struct keymap_key no_latin1_basic[] = {
 	{ 0, 0 }
 };
 
+/** "no-latin1" AltGr remapping */
+static struct keymap_key no_latin1_altgr[] = {
+	{ 0x30, 0x7d },	/* '0' => '}' */
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0x39, 0x5d },	/* '9' => ']' */
+	{ 0x5b, 0x7d },	/* '[' => '}' */
+	{ 0, 0 }
+};
+
 /** "no-latin1" keyboard map */
 struct keymap no_latin1_keymap __keymap = {
 	.name = "no-latin1",
 	.basic = no_latin1_basic,
+	.altgr = no_latin1_altgr,
 };
diff --git a/src/hci/keymap/keymap_no.c b/src/hci/keymap/keymap_no.c
index d3d06bce3..95a95428b 100644
--- a/src/hci/keymap/keymap_no.c
+++ b/src/hci/keymap/keymap_no.c
@@ -35,8 +35,16 @@ static struct keymap_key no_basic[] = {
 	{ 0, 0 }
 };
 
+/** "no" AltGr remapping */
+static struct keymap_key no_altgr[] = {
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0x71, 0x40 },	/* 'q' => '@' */
+	{ 0, 0 }
+};
+
 /** "no" keyboard map */
 struct keymap no_keymap __keymap = {
 	.name = "no",
 	.basic = no_basic,
+	.altgr = no_altgr,
 };
diff --git a/src/hci/keymap/keymap_pl.c b/src/hci/keymap/keymap_pl.c
index a23c01f2c..a76181fbc 100644
--- a/src/hci/keymap/keymap_pl.c
+++ b/src/hci/keymap/keymap_pl.c
@@ -17,8 +17,14 @@ static struct keymap_key pl_basic[] = {
 	{ 0, 0 }
 };
 
+/** "pl" AltGr remapping */
+static struct keymap_key pl_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "pl" keyboard map */
 struct keymap pl_keymap __keymap = {
 	.name = "pl",
 	.basic = pl_basic,
+	.altgr = pl_altgr,
 };
diff --git a/src/hci/keymap/keymap_pt.c b/src/hci/keymap/keymap_pt.c
index c065fd76f..99ba52e4b 100644
--- a/src/hci/keymap/keymap_pt.c
+++ b/src/hci/keymap/keymap_pt.c
@@ -34,8 +34,18 @@ static struct keymap_key pt_basic[] = {
 	{ 0, 0 }
 };
 
+/** "pt" AltGr remapping */
+static struct keymap_key pt_altgr[] = {
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0x37, 0x7b },	/* '7' => '{' */
+	{ 0x38, 0x5b },	/* '8' => '[' */
+	{ 0x71, 0x40 },	/* 'q' => '@' */
+	{ 0, 0 }
+};
+
 /** "pt" keyboard map */
 struct keymap pt_keymap __keymap = {
 	.name = "pt",
 	.basic = pt_basic,
+	.altgr = pt_altgr,
 };
diff --git a/src/hci/keymap/keymap_ro.c b/src/hci/keymap/keymap_ro.c
index 334cf6080..620450001 100644
--- a/src/hci/keymap/keymap_ro.c
+++ b/src/hci/keymap/keymap_ro.c
@@ -15,8 +15,14 @@ static struct keymap_key ro_basic[] = {
 	{ 0, 0 }
 };
 
+/** "ro" AltGr remapping */
+static struct keymap_key ro_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "ro" keyboard map */
 struct keymap ro_keymap __keymap = {
 	.name = "ro",
 	.basic = ro_basic,
+	.altgr = ro_altgr,
 };
diff --git a/src/hci/keymap/keymap_ru.c b/src/hci/keymap/keymap_ru.c
index a08b115ed..2aafcf9bd 100644
--- a/src/hci/keymap/keymap_ru.c
+++ b/src/hci/keymap/keymap_ru.c
@@ -18,8 +18,14 @@ static struct keymap_key ru_basic[] = {
 	{ 0, 0 }
 };
 
+/** "ru" AltGr remapping */
+static struct keymap_key ru_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "ru" keyboard map */
 struct keymap ru_keymap __keymap = {
 	.name = "ru",
 	.basic = ru_basic,
+	.altgr = ru_altgr,
 };
diff --git a/src/hci/keymap/keymap_sg.c b/src/hci/keymap/keymap_sg.c
index 152c5d631..9a6db9cb4 100644
--- a/src/hci/keymap/keymap_sg.c
+++ b/src/hci/keymap/keymap_sg.c
@@ -43,8 +43,18 @@ static struct keymap_key sg_basic[] = {
 	{ 0, 0 }
 };
 
+/** "sg" AltGr remapping */
+static struct keymap_key sg_altgr[] = {
+	{ 0x32, 0x40 },	/* '2' => '@' */
+	{ 0x33, 0x23 },	/* '3' => '#' */
+	{ 0x37, 0x7c },	/* '7' => '|' */
+	{ 0x5c, 0x7d },	/* '\\' => '}' */
+	{ 0, 0 }
+};
+
 /** "sg" keyboard map */
 struct keymap sg_keymap __keymap = {
 	.name = "sg",
 	.basic = sg_basic,
+	.altgr = sg_altgr,
 };
diff --git a/src/hci/keymap/keymap_sr-latin.c b/src/hci/keymap/keymap_sr-latin.c
index ec5efdc89..7e55714a2 100644
--- a/src/hci/keymap/keymap_sr-latin.c
+++ b/src/hci/keymap/keymap_sr-latin.c
@@ -17,8 +17,14 @@ static struct keymap_key sr_latin_basic[] = {
 	{ 0, 0 }
 };
 
+/** "sr-latin" AltGr remapping */
+static struct keymap_key sr_latin_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "sr-latin" keyboard map */
 struct keymap sr_latin_keymap __keymap = {
 	.name = "sr-latin",
 	.basic = sr_latin_basic,
+	.altgr = sr_latin_altgr,
 };
diff --git a/src/hci/keymap/keymap_ua.c b/src/hci/keymap/keymap_ua.c
index b4199cdad..44e82cb2d 100644
--- a/src/hci/keymap/keymap_ua.c
+++ b/src/hci/keymap/keymap_ua.c
@@ -17,8 +17,14 @@ static struct keymap_key ua_basic[] = {
 	{ 0, 0 }
 };
 
+/** "ua" AltGr remapping */
+static struct keymap_key ua_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "ua" keyboard map */
 struct keymap ua_keymap __keymap = {
 	.name = "ua",
 	.basic = ua_basic,
+	.altgr = ua_altgr,
 };
diff --git a/src/hci/keymap/keymap_uk.c b/src/hci/keymap/keymap_uk.c
index 156b42dff..28cf7aac4 100644
--- a/src/hci/keymap/keymap_uk.c
+++ b/src/hci/keymap/keymap_uk.c
@@ -19,8 +19,14 @@ static struct keymap_key uk_basic[] = {
 	{ 0, 0 }
 };
 
+/** "uk" AltGr remapping */
+static struct keymap_key uk_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "uk" keyboard map */
 struct keymap uk_keymap __keymap = {
 	.name = "uk",
 	.basic = uk_basic,
+	.altgr = uk_altgr,
 };
diff --git a/src/hci/keymap/keymap_us.c b/src/hci/keymap/keymap_us.c
index 5d78f80a2..6432474e2 100644
--- a/src/hci/keymap/keymap_us.c
+++ b/src/hci/keymap/keymap_us.c
@@ -15,8 +15,14 @@ static struct keymap_key us_basic[] = {
 	{ 0, 0 }
 };
 
+/** "us" AltGr remapping */
+static struct keymap_key us_altgr[] = {
+	{ 0, 0 }
+};
+
 /** "us" keyboard map */
 struct keymap us_keymap __keymap = {
 	.name = "us",
 	.basic = us_basic,
+	.altgr = us_altgr,
 };
diff --git a/src/include/ipxe/keymap.h b/src/include/ipxe/keymap.h
index 3da25190b..72b6961ef 100644
--- a/src/include/ipxe/keymap.h
+++ b/src/include/ipxe/keymap.h
@@ -32,6 +32,8 @@ struct keymap {
 	const char *name;
 	/** Basic remapping table (zero-terminated) */
 	struct keymap_key *basic;
+	/** AltGr remapping table (zero-terminated) */
+	struct keymap_key *altgr;
 };
 
 /** Keyboard mapping table */
@@ -64,6 +66,9 @@ struct keymap {
 /** Undo and redo CapsLock key flags */
 #define KEYMAP_CAPSLOCK_REDO ( KEYMAP_CAPSLOCK | KEYMAP_CAPSLOCK_UNDO )
 
+/** AltGr key flag */
+#define KEYMAP_ALTGR 0x0800
+
 extern unsigned int key_remap ( unsigned int character );
 
 #endif /* _IPXE_KEYMAP_H */
diff --git a/src/interface/efi/efi_console.c b/src/interface/efi/efi_console.c
index 9adce4a9b..fc1500afb 100644
--- a/src/interface/efi/efi_console.c
+++ b/src/interface/efi/efi_console.c
@@ -334,6 +334,9 @@ static int efi_getchar ( void ) {
 				       EFI_RIGHT_CONTROL_PRESSED ) ) {
 				character |= KEYMAP_CTRL;
 			}
+			if ( shift & EFI_RIGHT_ALT_PRESSED ) {
+				character |= KEYMAP_ALTGR;
+			}
 		}
 
 		/* Apply toggle state */
diff --git a/src/util/genkeymap.py b/src/util/genkeymap.py
index d38552eb4..ff5ff0a87 100755
--- a/src/util/genkeymap.py
+++ b/src/util/genkeymap.py
@@ -171,6 +171,11 @@ class KeyLayout(UserDict[KeyModifiers, Sequence[Key]]):
         """Basic shifted keyboard layout"""
         return self[KeyModifiers.SHIFT]
 
+    @property
+    def altgr(self):
+        """AltGr keyboard layout"""
+        return self.get(KeyModifiers.ALTGR, self.unshifted)
+
     @classmethod
     def load(cls, name: str) -> KeyLayout:
         """Load keymap using 'loadkeys -b'"""
@@ -278,6 +283,7 @@ class KeymapKeys(UserDict[str, str]):
                 self.ascii_name(source), self.ascii_name(target)
             )
             for source, target in self.items()
+            if ord(source) & ~BiosKeyLayout.KEY_PSEUDO != ord(target)
         ) + '\t{ 0, 0 }\n}'
 
 
@@ -301,13 +307,12 @@ class Keymap:
         raw = {source: self.target[key.modifiers][key.keycode].ascii
                for source, key in self.source.inverse.items()}
         # Eliminate any null mappings, mappings that attempt to remap
-        # the backspace key, or mappings that would become identity
-        # mappings after clearing the high bit
+        # the backspace key, or identity mappings
         table = {source: target for source, target in raw.items()
                  if target
                  and ord(source) != 0x7f
                  and ord(target) != 0x7f
-                 and ord(source) & ~BiosKeyLayout.KEY_PSEUDO != ord(target)}
+                 and source != target}
         # Recursively delete any mappings that would produce
         # unreachable alphanumerics (e.g. the "il" keymap, which maps
         # away the whole lower-case alphabet)
@@ -327,6 +332,28 @@ class Keymap:
                              (unshifted, shifted))
         return KeymapKeys(dict(sorted(table.items())))
 
+    @property
+    def altgr(self) -> KeymapKeys:
+        """AltGr remapping table"""
+        # Construct raw mapping from source ASCII to target ASCII
+        raw = {source: self.target.altgr[key.keycode].ascii
+               for source, key in self.source.inverse.items()
+               if key.modifiers == KeyModifiers.NONE}
+        # Identify printable keys that are unreachable via the basic map
+        basic = self.basic
+        unmapped = set(x for x in basic.keys()
+                       if x.isascii() and x.isprintable())
+        remapped = set(basic.values())
+        unreachable = unmapped - remapped
+        # Eliminate any null mappings, mappings for unprintable
+        # characters, or mappings for characters that are reachable
+        # via the basic map
+        table = {source: target for source, target in raw.items()
+                 if source.isprintable()
+                 and target
+                 and target in unreachable}
+        return KeymapKeys(dict(sorted(table.items())))
+
     def cname(self, suffix: str) -> str:
         """C variable name"""
         return re.sub(r'\W', '_', (self.name + '_' + suffix))
@@ -336,6 +363,7 @@ class Keymap:
         """Generated source code"""
         keymap_name = self.cname("keymap")
         basic_name = self.cname("basic")
+        altgr_name = self.cname("altgr")
         code = textwrap.dedent(f"""
         /** @file
          *
@@ -352,12 +380,16 @@ class Keymap:
         /** "{self.name}" basic remapping */
         static struct keymap_key {basic_name}[] = %s;
 
+        /** "{self.name}" AltGr remapping */
+        static struct keymap_key {altgr_name}[] = %s;
+
         /** "{self.name}" keyboard map */
         struct keymap {keymap_name} __keymap = {{
         \t.name = "{self.name}",
         \t.basic = {basic_name},
+        \t.altgr = {altgr_name},
         }};
-        """).strip() % self.basic.code
+        """).strip() % (self.basic.code, self.altgr.code)
         return code
 
 
-- 
cgit v1.2.3-55-g7522


From 04288974f6d81019314cbf9cbd72ab1fae95496f Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 16 Feb 2022 12:30:02 +0000
Subject: [pci] Ensure that pci_read_config() initialises all fields

As per the general pattern for initialisation functions in iPXE,
pci_init() saves code size by assuming that the caller has already
zeroed the underlying storage (e.g. as part of zeroing a larger
containing structure).  There are several places within the code where
pci_init() is deliberately used to initialise a transient struct
pci_device without zeroing the entire structure, because the calling
code knows that only the PCI bus:dev.fn address is required to be
initialised (e.g. when reading from PCI configuration space).

Ensure that using pci_init() followed by pci_read_config() will fully
initialise the struct pci_device even if the caller did not previously
zero the underlying storage, since Coverity reports that there are
several places in the code that rely upon this.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/drivers/bus/pci.c | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/drivers')

diff --git a/src/drivers/bus/pci.c b/src/drivers/bus/pci.c
index 1b7350c8b..5891e42ff 100644
--- a/src/drivers/bus/pci.c
+++ b/src/drivers/bus/pci.c
@@ -121,6 +121,11 @@ static void pci_read_bases ( struct pci_device *pci ) {
 	unsigned long bar;
 	int reg;
 
+	/* Clear any existing base addresses */
+	pci->ioaddr = 0;
+	pci->membase = 0;
+
+	/* Get first memory and I/O BAR addresses */
 	for ( reg = PCI_BASE_ADDRESS_0; reg <= PCI_BASE_ADDRESS_5; reg += 4 ) {
 		bar = pci_bar ( pci, reg );
 		if ( bar & PCI_BASE_ADDRESS_SPACE_IO ) {
-- 
cgit v1.2.3-55-g7522