From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1pKypr-0000X1-L4 for mharc-grub-devel@gnu.org; Thu, 26 Jan 2023 04:46:23 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pKypo-0000WH-0U for grub-devel@gnu.org; Thu, 26 Jan 2023 04:46:20 -0500 Received: from desiato.infradead.org ([2001:8b0:10b:1:d65d:64ff:fe57:4e05]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pKypj-0002Hc-Lm for grub-devel@gnu.org; Thu, 26 Jan 2023 04:46:19 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=desiato.20200630; h=In-Reply-To:Content-Type:MIME-Version: References:Message-ID:Subject:Cc:To:From:Date:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description; bh=K1+UQyqjIdYTg/h/sEPMuc29lFfwHb8hBHrITHLMLCU=; b=A4sicmS4DQ01W8LAs0eL/EOaKt AOeIvIwFHlv0yE3IhAcwGFhekOcRTkWpKDq22/k9aVtX8vD9OEkwdzvW54qc0o11IiFGOPnbdcHxP 8TbG9RwuFjlNYb55w1Iu+JZeMErmLukVFczAbyPiuvN4S0yZEDQu5VBIGnYjCl/Ktzpmcidd+tpvY txAccCFSNmnHMsE+yeJcyRInGxRYc1zKt+sYdVh2bZPDhNb0OzsT0JA7RndLiDkAxQYU2YHJflcF6 Y3Nc/6L3EW9lMqAUBlAiarLLhoz0eaCJQv2Jamhh5eXPUFg6RnaJj2wZmA7AJOFkcSYzRhYkp+SOK f2o8+kkg==; Received: from j130084.upc-j.chello.nl ([24.132.130.84] helo=noisy.programming.kicks-ass.net) by desiato.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1pKyp4-002Q93-0C for grub-devel@gnu.org; Thu, 26 Jan 2023 09:45:34 +0000 Received: from hirez.programming.kicks-ass.net (hirez.programming.kicks-ass.net [192.168.1.225]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (Client did not present a certificate) by noisy.programming.kicks-ass.net (Postfix) with ESMTPS id 1AF81300137 for ; Thu, 26 Jan 2023 10:46:03 +0100 (CET) Received: by hirez.programming.kicks-ass.net (Postfix, from userid 1000) id 4B3212013E79C; Thu, 26 Jan 2023 10:37:35 +0100 (CET) Date: Thu, 26 Jan 2023 10:37:35 +0100 From: Peter Zijlstra To: Daniel Kiper Cc: grub-devel@gnu.org, development@efficientek.com Subject: Re: [PATCH v2 2/3] term/serial: Add support for PCI serial devices Message-ID: References: <20220826110142.966628595@alderlake.programming.kicks-ass.net> <20220826111358.334758397@alderlake.programming.kicks-ass.net> <20221221125902.jw5kjwmxupeozt3b@tomti.i.net-space.pl> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20221221125902.jw5kjwmxupeozt3b@tomti.i.net-space.pl> Received-SPF: none client-ip=2001:8b0:10b:1:d65d:64ff:fe57:4e05; envelope-from=peterz@infradead.org; helo=desiato.infradead.org X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 26 Jan 2023 09:46:20 -0000 On Wed, Dec 21, 2022 at 01:59:02PM +0100, Daniel Kiper wrote: > Sorry for late reply... > > May I ask you to send the patches using "git send-email"? I'll try -- I'm one of the few quilt holdouts in Linux-land so I don't have much experience with it. > Please add a blurb how to use this driver to the docs/grub.texi file. > > > GRUB_TERMINAL="serial console" > > > > Signed-off-by: Peter Zijlstra (Intel) > > --- > > > > Index: grub/grub-core/Makefile.core.def > > =================================================================== > > --- grub.orig/grub-core/Makefile.core.def > > +++ grub/grub-core/Makefile.core.def > > @@ -2047,6 +2047,7 @@ module = { > > ieee1275 = term/ieee1275/serial.c; > > mips_arc = term/arc/serial.c; > > efi = term/efi/serial.c; > > + pci = term/pci/serial.c; > > I think this should be "x86 = term/pci/serial.c". I thought the whole purpose of Glenn's patch was to allow doing the 'pci =' thing, so that all platforms that support PCI get to have the benefit. But if you really want I can make it 'x86 =' ofcourse. > > +static int > > +find_pciserial (grub_pci_device_t dev, grub_pci_id_t pciid, void *data) > > grub_pci_id_t pciid __attribute__ ((unused)) > > > +{ > > + grub_pci_address_t cmd_addr, class_addr, bar_addr; > > + struct grub_serial_port *port; > > + grub_uint32_t class, bar; > > + grub_uint16_t cmdreg; > > + int *port_num = data; > > + grub_err_t err; > > + > > + (void)pciid; > > ... and please drop this... > > > +error: > > s/error/fail/ > > And please add a space before label... All done, except the Makefile thing, find the updated version below. I'll attempt to git-send-email both patches once we agree on the Makefile hunk. --- Subject: term/serial: Add support for PCI serial devices Loosely based on early_pci_serial_init() from Linux, allow GRUB to make use of PCI serial devices. Specifically, my Alderlake NUC exposes the Intel AMT SoL UART as a PCI enumerated device but doesn't include it in the EFI tables. Tested and confirmed working on a "Lenovo P360 Tiny" with Intel AMT enabled. This specific machine has (from lspci -vv): 00:16.3 Serial controller: Intel Corporation Device 7aeb (rev 11) (prog-if 02 [16550]) DeviceName: Onboard - Other Subsystem: Lenovo Device 330e Control: I/O+ Mem+ BusMaster- SpecCycle- MemWINV- VGASnoop- ParErr- Stepping- SERR- FastB2B- DisINTx- Status: Cap+ 66MHz+ UDF- FastB2B+ ParErr- DEVSEL=fast >TAbort- SERR- From which the following config (/etc/default/grub) gets a working serial setup: GRUB_CMDLINE_LINUX="console=tty0 earlyprintk=pciserial,00:16.3,115200 console=ttyS0,115200" GRUB_SERIAL_COMMAND="serial --speed=115200 pci_00:16.3" GRUB_TERMINAL="serial console" Signed-off-by: Peter Zijlstra (Intel) Tested-by: Glenn Washburn Reviewed-by: Glenn Washburn --- Index: grub/grub-core/Makefile.core.def =================================================================== --- grub.orig/grub-core/Makefile.core.def +++ grub/grub-core/Makefile.core.def @@ -2057,6 +2057,7 @@ module = { ieee1275 = term/ieee1275/serial.c; mips_arc = term/arc/serial.c; efi = term/efi/serial.c; + pci = term/pci/serial.c; enable = terminfomodule; enable = ieee1275; Index: grub/grub-core/term/pci/serial.c =================================================================== --- /dev/null +++ grub/grub-core/term/pci/serial.c @@ -0,0 +1,93 @@ +/* + * GRUB -- GRand Unified Bootloader + * Copyright (C) 2022 Free Software Foundation, Inc. + * + * GRUB is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * GRUB is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with GRUB. If not, see . + */ + +#include +#include +#include +#include +#include +#include + +static int +find_pciserial (grub_pci_device_t dev, + grub_pci_id_t pciid __attribute__ ((unused)), + void *data __attribute__ ((unused))) +{ + grub_pci_address_t cmd_addr, class_addr, bar_addr; + struct grub_serial_port *port; + grub_uint32_t class, bar; + grub_uint16_t cmdreg; + grub_err_t err; + + cmd_addr = grub_pci_make_address (dev, GRUB_PCI_REG_COMMAND); + cmdreg = grub_pci_read (cmd_addr); + + class_addr = grub_pci_make_address (dev, GRUB_PCI_REG_REVISION); + class = grub_pci_read (class_addr); + + bar_addr = grub_pci_make_address (dev, GRUB_PCI_REG_ADDRESS_REG0); + bar = grub_pci_read (bar_addr); + + /* 16550 compatible MODEM or SERIAL */ + if (((class >> 16) != GRUB_PCI_CLASS_COMMUNICATION_MODEM && + (class >> 16) != GRUB_PCI_CLASS_COMMUNICATION_SERIAL) || + ((class >> 8) & 0xff) != GRUB_PCI_SERIAL_16550_COMPATIBLE) + return 0; + + if ((bar & GRUB_PCI_ADDR_SPACE_MASK) != GRUB_PCI_ADDR_SPACE_IO) + return 0; + + port = grub_zalloc (sizeof (*port)); + if (port == NULL) + return 0; + + port->name = grub_xasprintf ("pci_%02x:%02x.%x", + grub_pci_get_bus (dev), + grub_pci_get_device (dev), + grub_pci_get_function (dev)); + if (port->name == NULL) + goto fail; + + grub_pci_write (cmd_addr, cmdreg | GRUB_PCI_COMMAND_IO_ENABLED); + + port->driver = &grub_ns8250_driver; + port->port = bar & GRUB_PCI_ADDR_IO_MASK; + err = grub_serial_config_defaults (port); + if (err != GRUB_ERR_NONE) + { + grub_print_error (); + goto fail; + } + + err = grub_serial_register (port); + if (err != GRUB_ERR_NONE) + goto fail; + + return 0; + + fail: + grub_free (port->name); + grub_free (port); + return 0; +} + +void +grub_pciserial_init (void) +{ + grub_pci_iterate (find_pciserial, NULL); +} Index: grub/grub-core/term/serial.c =================================================================== --- grub.orig/grub-core/term/serial.c +++ grub/grub-core/term/serial.c @@ -505,6 +505,9 @@ GRUB_MOD_INIT(serial) #ifdef GRUB_MACHINE_ARC grub_arcserial_init (); #endif +#ifdef GRUB_HAS_PCI + grub_pciserial_init (); +#endif } GRUB_MOD_FINI(serial) Index: grub/include/grub/pci.h =================================================================== --- grub.orig/include/grub/pci.h +++ grub/include/grub/pci.h @@ -80,8 +80,13 @@ #define GRUB_PCI_STATUS_DEVSEL_TIMING_SHIFT 9 #define GRUB_PCI_STATUS_DEVSEL_TIMING_MASK 0x0600 + #define GRUB_PCI_CLASS_SUBCLASS_VGA 0x0300 #define GRUB_PCI_CLASS_SUBCLASS_USB 0x0c03 +#define GRUB_PCI_CLASS_COMMUNICATION_SERIAL 0x0700 +#define GRUB_PCI_CLASS_COMMUNICATION_MODEM 0x0703 + +#define GRUB_PCI_SERIAL_16550_COMPATIBLE 0x02 #ifndef ASM_FILE Index: grub/include/grub/serial.h =================================================================== --- grub.orig/include/grub/serial.h +++ grub/include/grub/serial.h @@ -210,6 +210,10 @@ grub_arcserial_init (void); struct grub_serial_port *grub_arcserial_add_port (const char *path); #endif +#ifdef GRUB_HAS_PCI +void grub_pciserial_init (void); +#endif + struct grub_serial_port *grub_serial_find (const char *name); extern struct grub_serial_driver grub_ns8250_driver; void EXPORT_FUNC(grub_serial_unregister_driver) (struct grub_serial_driver *driver); Index: grub/docs/grub.texi =================================================================== --- grub.orig/docs/grub.texi +++ grub/docs/grub.texi @@ -1386,6 +1386,7 @@ separated by spaces. Valid terminal input names depend on the platform, but may include @samp{console} (native platform console), @samp{serial} (serial terminal), @samp{serial_} (serial terminal with explicit port selection), +@samp{pci_:.} (PCI serial with explicit location), @samp{at_keyboard} (PC AT keyboard), or @samp{usb_keyboard} (USB keyboard using the HID Boot Protocol, for cases where the firmware does not handle this). @@ -1399,6 +1400,7 @@ separated by spaces. Valid terminal output names depend on the platform, but may include @samp{console} (native platform console), @samp{serial} (serial terminal), @samp{serial_} (serial terminal with explicit port selection), +@samp{pci_:.} (PCI serial with explicit location), @samp{gfxterm} (graphics-mode output), @samp{vga_text} (VGA text output), @samp{mda_text} (MDA text output), @samp{morse} (Morse-coding using system beeper) or @samp{spkmodem} (simple data protocol using system speaker). @@ -4165,7 +4167,7 @@ Commands usable anywhere in the menu and @node serial @subsection serial -@deffn Command serial [@option{--unit=unit}] [@option{--port=port}] [@option{--speed=speed}] [@option{--word=word}] [@option{--parity=parity}] [@option{--stop=stop}] +@deffn Command serial [@option{--unit=unit}] [@option{--port=port}] [@option{--speed=speed}] [@option{--word=word}] [@option{--parity=parity}] [@option{--stop=stop}] [@option{name}] Initialize a serial device. @var{unit} is a number in the range 0-3 specifying which serial port to use; default is 0, which corresponds to the port often called COM1. @@ -4197,6 +4199,19 @@ If passed no @var{unit} nor @var{port}, the system default serial port and its configuration. If this information is not available, it will default to @var{unit} 0. +If used @var{name}, a machine and driver specific name given during probing, +will be used to indicate which serial port to use. Possible forms include: +@itemize @bullet +@item +@samp{serial_} as an alternative to --port +@item +@samp{usbN} the N'th USB serial detected +@item +@samp{efiN} the N'th EFI serial detected +@item +@samp{pci_:.} PCI serial at the specified location +@end itemize + The serial port is not used as a communication channel unless the @command{terminal_input} or @command{terminal_output} command is used (@pxref{terminal_input}, @pxref{terminal_output}). @@ -4205,6 +4220,7 @@ Examples: @example serial --port=3f8 --speed=9600 serial --port=mmio,fefb0000.l --speed=115200 +serial --speed=115200 pci_00:16.3 @end example See also @ref{Serial terminal}.