From nobody Thu Mar 31 23:02:35 2022 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 7091D1A5F002; Thu, 31 Mar 2022 23:02:35 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4KTzNC2b08z3Cbm; Thu, 31 Mar 2022 23:02:35 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1648767755; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=y4NynupTeiJK8AXqYnM3NKoGnZw4pELULDZLn4J32Lo=; b=m33VzIvrqjuYA5mxl8UdRakvPtkHbbOohSZVfKrzxmOO+NkazTKtsabtby6f+POWsto6wu 5wRAhgw+kcdRZficPxulnOCf9WVkEBEr4Y/4Kdv22Ubip+BM7rw9i+/1Ao23y7tR8wvSOn 0IP+K8UK90/IzXv6hmBdUGnK3RYCn+SefsemnGlGB1vIhOILXaLkewDlWYgPKDW0IQwY/M QjsGFYoX6M5t61ihFdU41VEwG9LLlWfRMG/jubRcg1eqLAMsMbUdglHjFsAZn5KAVRUmXH 2NctIbmpdDgEUpA9tYdijugYNtW/3RwHRroP8E1axudIl9A7QYBS/BSP0v/oNQ== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 38AF1B0E; Thu, 31 Mar 2022 23:02:35 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 22VN2ZIK065635; Thu, 31 Mar 2022 23:02:35 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 22VN2ZK7065634; Thu, 31 Mar 2022 23:02:35 GMT (envelope-from git) Date: Thu, 31 Mar 2022 23:02:35 GMT Message-Id: <202203312302.22VN2ZK7065634@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Colin Percival Subject: git: ad93649d2304 - main - uart(4): Add a concept of "unique" serial devices List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: cperciva X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: ad93649d230428561db983153c546b39336fa4f1 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1648767755; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=y4NynupTeiJK8AXqYnM3NKoGnZw4pELULDZLn4J32Lo=; b=Rsp24sjzfYfF0jyPgidPys1+cK1EQuBdORFYjMS8FJoN7hdAYmr0jfiYZCOVvDFMBYB+Dy Rvk7dijoKZaZv0h+LnwMHtVIWrpTxM7eVY4jhc6pE+fiG0GACEy2Ie7w9rM3HpVpo1uqfS 0tKVtufUxr95pWbpFjnZbecbexuAYlJf/TgoI2/0rPiq7BspoIjKfDz9d6CElScbhFhUOy 21rUEFWvuzp66ikcaZoiHbvQ8HesFQ2Q+rXYXfTIeRPrkr++TTJlZplj5s3MJGbCXVWb6v 8dCimkTaSV0oqNpmvrnNYCPYvWo1R0V3QsaG0eEwWM1sH62FKQM1NHA+SMkISg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1648767755; a=rsa-sha256; cv=none; b=weJHz3KhCB+nihki4IwB0LNhDSW4AEa3Cit28j1I+n4bIj7cq7BmJLiofB3vYTHOLGcEUr wN30nNnGv1e5Gwwf55RcOY1BMmgu/YpefCmORQYOla42nXWrnDyIMARGdwr/nYCESeI9HW UYUDJZtTrikLtrD8mqYTVtHDha4WausUTY6iIQH9+Y/zvkyIkyDQG5gX13NRniYZ+kOHxX Ie2KA0jDBzpoG8nXuog4OpZ5DbCG54fweOPAka+GsMBAxEwBJuF8TwZLvGngutuaE3SXOX 0FXNQ1z3pqKjs6GOCIIX84JjwED4WPfRWgfoeHddHteO4u3PTqq8HBIWAYKR2g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by cperciva: URL: https://cgit.FreeBSD.org/src/commit/?id=ad93649d230428561db983153c546b39336fa4f1 commit ad93649d230428561db983153c546b39336fa4f1 Author: Colin Percival AuthorDate: 2022-03-29 07:41:37 +0000 Commit: Colin Percival CommitDate: 2022-03-31 23:02:24 +0000 uart(4): Add a concept of "unique" serial devices FreeBSD detects serial ports twice: First, very early in the boot process, in order to obtain a usable console; and second, during the device probe/attach process. When a UART is discovered during device probing, FreeBSD attempts to determine whether it is a device which was already being used as a console; without this, the console doesn't work in userland. Unfortunately it's possible for a UART to be mapped to a different location in memory when it is discovered on a bus than it has when it is announced via the ACPI SPCR table; this breaks the matching process, which relies on comparing bus addresses. To address this, we introduce a concept of "unique" serial devices, i.e. devices which are guaranteed to be present *only once* on any system. If we discover one of these during device probing, we can match it to a same-PCI-vendor-and-device-numbers console which was announced via the ACPI SPCR table, regardless of the differing bus addresses. At present, the only unique serial device is the "Amazon PCI serial device" (vendor 0x1d0f, device 0x8250) found in some EC2 instances. This unbreaks the serial console on those systems. Reviewed by: imp MFC after: 3 days Sponsored by: https://www.patreon.com/cperciva Differential Revision: https://reviews.freebsd.org/D34703 --- sys/dev/uart/uart_bus_pci.c | 51 ++++++++++++++++++++++++++++++++++++++++++++ sys/dev/uart/uart_cpu.h | 9 ++++++++ sys/dev/uart/uart_cpu_acpi.c | 7 ++++++ 3 files changed, 67 insertions(+) diff --git a/sys/dev/uart/uart_bus_pci.c b/sys/dev/uart/uart_bus_pci.c index fe5ad2b6d206..a20be1c577d4 100644 --- a/sys/dev/uart/uart_bus_pci.c +++ b/sys/dev/uart/uart_bus_pci.c @@ -43,6 +43,7 @@ __FBSDID("$FreeBSD$"); #include #include +#include #define DEFAULT_RCLK 1843200 @@ -76,6 +77,11 @@ struct pci_id { int regshft; }; +struct pci_unique_id { + uint16_t vendor; + uint16_t device; +}; + #define PCI_NO_MSI 0x40000000 #define PCI_RID_MASK 0x0000ffff @@ -214,6 +220,44 @@ uart_pci_match(device_t dev, const struct pci_id *id) return ((id->vendor == vendor && id->device == device) ? id : NULL); } +extern SLIST_HEAD(uart_devinfo_list, uart_devinfo) uart_sysdevs; + +/* PCI vendor/device pairs of devices guaranteed to be unique on a system. */ +static const struct pci_unique_id pci_unique_devices[] = { +{ 0x1d0f, 0x8250 } /* Amazon PCI serial device */ +}; + +/* Match a UART to a console if it's a PCI device known to be unique. */ +static void +uart_pci_unique_console_match(device_t dev) +{ + struct uart_softc *sc; + struct uart_devinfo * sysdev; + const struct pci_unique_id * id; + uint16_t vendor, device; + + sc = device_get_softc(dev); + vendor = pci_get_vendor(dev); + device = pci_get_device(dev); + + /* Is this a device known to exist only once in a system? */ + for (id = pci_unique_devices; ; id++) { + if (id == &pci_unique_devices[nitems(pci_unique_devices)]) + return; + if (id->vendor == vendor && id->device == device) + break; + } + + /* If it matches a console, it must be the same device. */ + SLIST_FOREACH(sysdev, &uart_sysdevs, next) { + if (sysdev->pci_info.vendor == vendor && + sysdev->pci_info.device == device) { + sc->sc_sysdev = sysdev; + sysdev->bas.rclk = sc->sc_bas.rclk; + } + } +} + static int uart_pci_probe(device_t dev) { @@ -251,6 +295,13 @@ uart_pci_probe(device_t dev) /* Bail out on error. */ if (result > 0) return (result); + /* + * If we haven't already matched this to a console, check if it's a + * PCI device which is known to only exist once in any given system + * and we can match it that way. + */ + if (sc->sc_sysdev == NULL) + uart_pci_unique_console_match(dev); /* Set/override the device description. */ if (id->desc) device_set_desc(dev, id->desc); diff --git a/sys/dev/uart/uart_cpu.h b/sys/dev/uart/uart_cpu.h index 4f34c767efc0..4eb7327fc788 100644 --- a/sys/dev/uart/uart_cpu.h +++ b/sys/dev/uart/uart_cpu.h @@ -52,6 +52,14 @@ struct uart_ops { extern bus_space_tag_t uart_bus_space_io; extern bus_space_tag_t uart_bus_space_mem; +/* + * PCI ID used for matching "unique" devices to a console. + */ +struct uart_pci_info { + uint16_t vendor; + uint16_t device; +}; + /* * Console and debug port device info. */ @@ -72,6 +80,7 @@ struct uart_devinfo { void *cookie; /* Type dependent use. */ struct mtx *hwmtx; struct uart_softc *sc; /* valid only from start of attach */ + struct uart_pci_info pci_info; }; int uart_cpu_eqres(struct uart_bas *, struct uart_bas *); diff --git a/sys/dev/uart/uart_cpu_acpi.c b/sys/dev/uart/uart_cpu_acpi.c index 1e46462fc58a..68f743c8e8d2 100644 --- a/sys/dev/uart/uart_cpu_acpi.c +++ b/sys/dev/uart/uart_cpu_acpi.c @@ -36,6 +36,8 @@ __FBSDID("$FreeBSD$"); #include +#include + #include #include #include @@ -182,6 +184,11 @@ uart_cpu_acpi_spcr(int devtype, struct uart_devinfo *di) (int)spcr->BaudRate); goto out; } + if (spcr->PciVendorId != PCIV_INVALID && + spcr->PciDeviceId != PCIV_INVALID) { + di->pci_info.vendor = spcr->PciVendorId; + di->pci_info.device = spcr->PciDeviceId; + } /* Apply device tweaks. */ if ((cd->cd_quirks & UART_F_IGNORE_SPCR_REGSHFT) ==