Received: by 2002:a05:7412:31a9:b0:e2:908c:2ebd with SMTP id et41csp4257333rdb; Thu, 14 Sep 2023 17:34:42 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHJXeyHPMKx85MozKlwhcEqe4BhX9f3nnACmVF46VdmpvH12F5yiRxWSOtv2BejSZDGx9WX X-Received: by 2002:a17:902:ce88:b0:1c3:b268:ecba with SMTP id f8-20020a170902ce8800b001c3b268ecbamr4984946plg.18.1694738081830; Thu, 14 Sep 2023 17:34:41 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1694738081; cv=none; d=google.com; s=arc-20160816; b=K6UAnKUbo9ynUdpW9WsS8JaxkNS8yobaVmFeuTezlebbNXvUFz22GpbngcMA/tKHXS SoqNtL8Zja3/J1lJhncKOOJz8C7pW66qKaV70dNvgQVvqTfICMvQesZKh8rbKlNgUbY4 ZyycThQk9s3NE1romb2jh7oq1D0bJRfAIysXykMz2rC2ZdqVv5llqOa0Wi9Kb1X53OAY WHX2yQBub0Q4eSt8Fa0aDrHbbwwwRpAA95/niM4xl9vjGAaL7V1SZHhYQeqUS5eNbBv1 dLy9byDdtgqyCrWzaS01ob7f9A5xOcBencVb73+uwmvYybKb+x7zf2G0g2ktLXsRT3WN 4WRA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:dkim-signature:dkim-signature:from; bh=aQcu0Tj+ffJBWZVQ9fNZPj8/IhtyreTS7DJJKIPF900=; fh=XGcUGZFq91PndIxB/X5tkBsXmlDmdTqA4KDzRqQvHYg=; b=A7DReS8lD8TW44li9frR+PRn0m+1mzRPso967iZl3uN40gNosIv2vitoHsMNxtmk10 gsIBPfUR8RLT4tjA+owUm36PW2/pFfwV2PjF26jjs4b/aheAfClKW7fMOQnbW2kTtfEL 8heXAaBqVqZzvJDC/1dut/wbprf1PiNVuWWx0J47+l6aEDO77GDrf+WrZBkzVCKd1CCN mMm4O78Ta7vvq5inXp5PMwzpPx9dF9shXPeXwsuIbwILOzNEQ2QdAn63x7XDsoQFzmSK 6oUMvlkD3VhYH5AqOsDKFBb7ARaBL9TJMUf6Yg42shakHJy4vcI59ElyUqwCE0D/l0Q3 68Dw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=Z8UeMKj4; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Return-Path: Received: from howler.vger.email (howler.vger.email. [23.128.96.34]) by mx.google.com with ESMTPS id y3-20020a636403000000b005694f4b9e85si2345309pgb.229.2023.09.14.17.34.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Sep 2023 17:34:41 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) client-ip=23.128.96.34; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=Z8UeMKj4; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by howler.vger.email (Postfix) with ESMTP id 578468489E49; Thu, 14 Sep 2023 11:38:58 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at howler.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241678AbjINSiz (ORCPT + 99 others); Thu, 14 Sep 2023 14:38:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55394 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231243AbjINSiq (ORCPT ); Thu, 14 Sep 2023 14:38:46 -0400 Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DD4911FD7; Thu, 14 Sep 2023 11:38:41 -0700 (PDT) From: John Ogness DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1694716719; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=aQcu0Tj+ffJBWZVQ9fNZPj8/IhtyreTS7DJJKIPF900=; b=Z8UeMKj4Fav9MLhk6d+JmpTi5nJHEpVJNO1ur5Ad3vBiVWCnoe9Eog0Qg33XlH6id3FWbz S8l2Lt2jSbU2XHwf8xi9UIitF4+b8K7paGx1bjjYr5t2rdTDVV0Fim6UAKFi2CtuZ1mb3L E0TJN4HYA+tWtKTLOiVDx3F+jVsGlfsYYAnFZvFt3iKUUrP7SkGJJcZ1UIkJ/UqIQ0831V SMEuLB8ZIcl+FG04i7hT9/QWq5F02SyOTdFIc9j7ps1+LHHwMSHMPuADoGutw3ZHkUAICp RXxdloN+Gh4cSEl07/GwEgsU+m8aqlGccQ2NbBYv7A5wSEzPoJaqC36jkiHDjg== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1694716719; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=aQcu0Tj+ffJBWZVQ9fNZPj8/IhtyreTS7DJJKIPF900=; b=6i/Rykkl4Rl5SBtIHP9RIQNQNOB8Crkkj2AcFISLN8Dmxq51odZMyUMI6Usmo7xHPgkuGu 8OGeRMSrDoYZsqCg== To: Greg Kroah-Hartman Cc: Jiri Slaby , linux-serial@vger.kernel.org, Petr Mladek , Thomas Gleixner , linux-kernel@vger.kernel.org, Tobias Klauser , Thierry Reding , Joel Stanley , Andrew Jeffery , linux-arm-kernel@lists.infradead.org, linux-aspeed@lists.ozlabs.org, Al Cooper , Broadcom internal kernel review list , Tony Lindgren , Andy Shevchenko , =?UTF-8?q?Ilpo=20J=C3=A4rvinen?= , Florian Fainelli , Andrew Davis , Matthew Howell , =?UTF-8?q?Uwe=20Kleine-K=C3=B6nig?= , Johan Hovold , Matthias Brugger , AngeloGioacchino Del Regno , Chen-Yu Tsai , linux-mediatek@lists.infradead.org, Lukas Wunner , Matthias Schiffer , Arnd Bergmann , Kumaravel Thiagarajan , Tharun Kumar P , Russell King , "Maciej W. Rozycki" , Hongyu Xie , Jiamei Xie , Rob Herring , delisun , Lino Sanfilippo , Yangtao Li , Vineet Gupta , linux-snps-arc@lists.infradead.org, Richard Genoud , Nicolas Ferre , Alexandre Belloni , Claudiu Beznea , Arend van Spriel , Christophe Leroy , Baruch Siach , Sherry Sun , Shenwei Wang , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , NXP Linux Team , Sergey Organov , Tom Rix , Marek Vasut , Karol Gugala , Mateusz Holenko , Gabriel Somlo , Vladimir Zapolskiy , Jacky Huang , Shan-Chun Hung , Neil Armstrong , Kevin Hilman , Jerome Brunet , Martin Blumenstingl , Dmitry Rokosov , Lucas Tanure , linux-amlogic@lists.infradead.org, Taichi Sugaya , Takao Orito , Liviu Dudau , Sudeep Holla , Lorenzo Pieralisi , Andy Gross , Bjorn Andersson , Konrad Dybcio , linux-arm-msm@vger.kernel.org, =?UTF-8?q?Pali=20Roh=C3=A1r?= , Andrew Morton , =?UTF-8?q?Andreas=20F=C3=A4rber?= , Manivannan Sadhasivam , linux-actions@lists.infradead.org, Xiongfeng Wang , Yuan Can , Michael Ellerman , Nicholas Piggin , linuxppc-dev@lists.ozlabs.org, linux-unisoc@lists.infradead.org, Kevin Cernekee , Krzysztof Kozlowski , Alim Akhtar , linux-samsung-soc@vger.kernel.org, Lukas Bulwahn , Lech Perczak , Hugo Villeneuve , Andy Shevchenko , Isaac True , Laxman Dewangan , Thierry Reding , Jonathan Hunter , linux-tegra@vger.kernel.org, Biju Das , Geert Uytterhoeven , Palmer Dabbelt , Paul Walmsley , Nick Hu , Ruan Jinjie , Samuel Holland , linux-riscv@lists.infradead.org, Orson Zhai , Baolin Wang , Chunyan Zhang , Patrice Chotard , Maxime Coquelin , Alexandre Torgue , Valentin Caron , Sebastian Andrzej Siewior , linux-stm32@st-md-mailman.stormreply.com, "David S. Miller" , sparclinux@vger.kernel.org, Hammer Hsieh , Peter Korsgaard , Timur Tabi , Mukesh Ojha , =?UTF-8?q?Jonathan=20Neusch=C3=A4fer?= , Michal Simek Subject: [PATCH tty v1 00/74] serial: wrappers for uart port lock Date: Thu, 14 Sep 2023 20:43:17 +0206 Message-Id: <20230914183831.587273-1-john.ogness@linutronix.de> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (howler.vger.email [0.0.0.0]); Thu, 14 Sep 2023 11:38:58 -0700 (PDT) When a serial port is used for kernel console output, then all modifications to the UART registers which are done from other contexts, e.g. getty, termios, are interference points for the kernel console. So far this has been ignored and the printk output is based on the principle of hope. The rework of the console infrastructure which aims to support threaded and atomic consoles, requires to mark sections which modify the UART registers as unsafe. This allows the atomic write function to make informed decisions and eventually to restore operational state. It also allows to prevent the regular UART code from modifying UART registers while printk output is in progress. All modifications of UART registers are guarded by the UART port lock, which provides an obvious synchronization point with the console infrastructure. Provide and use wrapper functions for spin_[un]lock*(port->lock) invocations so that the console mechanics can be applied later on at a single place and does not require to copy the same logic all over the drivers. Patch 1 adds the wrapper functions. Patches 2-74 switch all uart port locking call sites to use the new wrappers. These patches were automatically generated using coccinelle. The 2 used coccinelle scripts are included below and executed as follows: $ spatch --sp-file uartlock-1.cocci $FILE $ spatch --sp-file uartlock-2.cocci --recursive-includes $FILE This series brings no functional change. Patches 2-74 contain identical commit message bodies. Feel free to fold them into a single commit if that seems more reasonable. Thomas Gleixner (74): serial: core: Provide port lock wrappers serial: core: Use lock wrappers serial: 21285: Use port lock wrappers serial: 8250_aspeed_vuart: Use port lock wrappers serial: 8250_bcm7271: Use port lock wrappers serial: 8250: Use port lock wrappers serial: 8250_dma: Use port lock wrappers serial: 8250_dw: Use port lock wrappers serial: 8250_exar: Use port lock wrappers serial: 8250_fsl: Use port lock wrappers serial: 8250_mtk: Use port lock wrappers serial: 8250_omap: Use port lock wrappers serial: 8250_pci1xxxx: Use port lock wrappers serial: altera_jtaguart: Use port lock wrappers serial: altera_uart: Use port lock wrappers serial: amba-pl010: Use port lock wrappers serial: amba-pl011: Use port lock wrappers serial: apb: Use port lock wrappers serial: ar933x: Use port lock wrappers serial: arc_uart: Use port lock wrappers serial: atmel: Use port lock wrappers serial: bcm63xx-uart: Use port lock wrappers serial: cpm_uart: Use port lock wrappers serial: digicolor: Use port lock wrappers serial: dz: Use port lock wrappers serial: linflexuart: Use port lock wrappers serial: fsl_lpuart: Use port lock wrappers serial: icom: Use port lock wrappers serial: imx: Use port lock wrappers serial: ip22zilog: Use port lock wrappers serial: jsm: Use port lock wrappers serial: liteuart: Use port lock wrappers serial: lpc32xx_hs: Use port lock wrappers serial: ma35d1: Use port lock wrappers serial: mcf: Use port lock wrappers serial: men_z135_uart: Use port lock wrappers serial: meson: Use port lock wrappers serial: milbeaut_usio: Use port lock wrappers serial: mpc52xx: Use port lock wrappers serial: mps2-uart: Use port lock wrappers serial: msm: Use port lock wrappers serial: mvebu-uart: Use port lock wrappers serial: omap: Use port lock wrappers serial: owl: Use port lock wrappers serial: pch: Use port lock wrappers serial: pic32: Use port lock wrappers serial: pmac_zilog: Use port lock wrappers serial: pxa: Use port lock wrappers serial: qcom-geni: Use port lock wrappers serial: rda: Use port lock wrappers serial: rp2: Use port lock wrappers serial: sa1100: Use port lock wrappers serial: samsung_tty: Use port lock wrappers serial: sb1250-duart: Use port lock wrappers serial: sc16is7xx: Use port lock wrappers serial: tegra: Use port lock wrappers serial: core: Use port lock wrappers serial: mctrl_gpio: Use port lock wrappers serial: txx9: Use port lock wrappers serial: sh-sci: Use port lock wrappers serial: sifive: Use port lock wrappers serial: sprd: Use port lock wrappers serial: st-asc: Use port lock wrappers serial: stm32: Use port lock wrappers serial: sunhv: Use port lock wrappers serial: sunplus-uart: Use port lock wrappers serial: sunsab: Use port lock wrappers serial: sunsu: Use port lock wrappers serial: sunzilog: Use port lock wrappers serial: timbuart: Use port lock wrappers serial: uartlite: Use port lock wrappers serial: ucc_uart: Use port lock wrappers serial: vt8500: Use port lock wrappers serial: xilinx_uartps: Use port lock wrappers drivers/tty/serial/21285.c | 8 +- drivers/tty/serial/8250/8250_aspeed_vuart.c | 6 +- drivers/tty/serial/8250/8250_bcm7271.c | 28 +++--- drivers/tty/serial/8250/8250_core.c | 12 +-- drivers/tty/serial/8250/8250_dma.c | 8 +- drivers/tty/serial/8250/8250_dw.c | 8 +- drivers/tty/serial/8250/8250_exar.c | 4 +- drivers/tty/serial/8250/8250_fsl.c | 6 +- drivers/tty/serial/8250/8250_mtk.c | 8 +- drivers/tty/serial/8250/8250_omap.c | 52 +++++----- drivers/tty/serial/8250/8250_pci1xxxx.c | 8 +- drivers/tty/serial/8250/8250_port.c | 100 ++++++++++---------- drivers/tty/serial/altera_jtaguart.c | 28 +++--- drivers/tty/serial/altera_uart.c | 20 ++-- drivers/tty/serial/amba-pl010.c | 20 ++-- drivers/tty/serial/amba-pl011.c | 72 +++++++------- drivers/tty/serial/apbuart.c | 8 +- drivers/tty/serial/ar933x_uart.c | 26 ++--- drivers/tty/serial/arc_uart.c | 16 ++-- drivers/tty/serial/atmel_serial.c | 24 ++--- drivers/tty/serial/bcm63xx_uart.c | 22 ++--- drivers/tty/serial/cpm_uart.c | 8 +- drivers/tty/serial/digicolor-usart.c | 18 ++-- drivers/tty/serial/dz.c | 32 +++---- drivers/tty/serial/fsl_linflexuart.c | 26 ++--- drivers/tty/serial/fsl_lpuart.c | 88 ++++++++--------- drivers/tty/serial/icom.c | 26 ++--- drivers/tty/serial/imx.c | 84 ++++++++-------- drivers/tty/serial/ip22zilog.c | 36 +++---- drivers/tty/serial/jsm/jsm_neo.c | 4 +- drivers/tty/serial/jsm/jsm_tty.c | 16 ++-- drivers/tty/serial/liteuart.c | 20 ++-- drivers/tty/serial/lpc32xx_hs.c | 26 ++--- drivers/tty/serial/ma35d1_serial.c | 22 ++--- drivers/tty/serial/mcf.c | 20 ++-- drivers/tty/serial/men_z135_uart.c | 8 +- drivers/tty/serial/meson_uart.c | 30 +++--- drivers/tty/serial/milbeaut_usio.c | 16 ++-- drivers/tty/serial/mpc52xx_uart.c | 12 +-- drivers/tty/serial/mps2-uart.c | 16 ++-- drivers/tty/serial/msm_serial.c | 38 ++++---- drivers/tty/serial/mvebu-uart.c | 18 ++-- drivers/tty/serial/omap-serial.c | 38 ++++---- drivers/tty/serial/owl-uart.c | 26 ++--- drivers/tty/serial/pch_uart.c | 10 +- drivers/tty/serial/pic32_uart.c | 20 ++-- drivers/tty/serial/pmac_zilog.c | 52 +++++----- drivers/tty/serial/pxa.c | 30 +++--- drivers/tty/serial/qcom_geni_serial.c | 8 +- drivers/tty/serial/rda-uart.c | 34 +++---- drivers/tty/serial/rp2.c | 20 ++-- drivers/tty/serial/sa1100.c | 20 ++-- drivers/tty/serial/samsung_tty.c | 50 +++++----- drivers/tty/serial/sb1250-duart.c | 12 +-- drivers/tty/serial/sc16is7xx.c | 40 ++++---- drivers/tty/serial/serial-tegra.c | 32 +++---- drivers/tty/serial/serial_core.c | 88 ++++++++--------- drivers/tty/serial/serial_mctrl_gpio.c | 4 +- drivers/tty/serial/serial_port.c | 4 +- drivers/tty/serial/serial_txx9.c | 26 ++--- drivers/tty/serial/sh-sci.c | 68 ++++++------- drivers/tty/serial/sifive.c | 16 ++-- drivers/tty/serial/sprd_serial.c | 30 +++--- drivers/tty/serial/st-asc.c | 18 ++-- drivers/tty/serial/stm32-usart.c | 38 ++++---- drivers/tty/serial/sunhv.c | 28 +++--- drivers/tty/serial/sunplus-uart.c | 26 ++--- drivers/tty/serial/sunsab.c | 34 +++---- drivers/tty/serial/sunsu.c | 46 ++++----- drivers/tty/serial/sunzilog.c | 42 ++++---- drivers/tty/serial/timbuart.c | 8 +- drivers/tty/serial/uartlite.c | 18 ++-- drivers/tty/serial/ucc_uart.c | 4 +- drivers/tty/serial/vt8500_serial.c | 8 +- drivers/tty/serial/xilinx_uartps.c | 56 +++++------ include/linux/serial_core.h | 91 ++++++++++++++++-- 76 files changed, 1086 insertions(+), 1007 deletions(-) base-commit: 0bb80ecc33a8fb5a682236443c1e740d5c917d1d -- 2.39.2 --------------8<-------------- // uartlock-1.cocci @r1@ struct uart_port *U; @@ -spin_lock(&U->lock) +uart_port_lock(U) @r2@ struct uart_port *U; @@ -spin_lock_irq(&U->lock) +uart_port_lock_irq(U) @r3@ struct uart_port *U; identifier F; @@ -spin_lock_irqsave(&U->lock, F) +uart_port_lock_irqsave(U, &F) @r4@ struct uart_port *U; @@ -spin_unlock(&U->lock) +uart_port_unlock(U) @r5@ struct uart_port *U; @@ -spin_unlock_irq(&U->lock) +uart_port_unlock_irq(U) @r6@ struct uart_port *U; identifier F; @@ -spin_unlock_irqrestore(&U->lock, F) +uart_port_unlock_irqrestore(U, F) @r7@ struct uart_port *U; @@ -spin_trylock(&U->lock) +uart_port_trylock(U) @r8@ struct uart_port *U; identifier F; @@ -spin_trylock_irqsave(&U->lock, F) +uart_port_trylock_irqsave(U, &F) --------------8<-------------- // uartlock-2.cocci @r10@ type T1; identifier U; @@ T1 { ... struct uart_port U; ... }; @r11@ r10.T1 *E; identifier r10.U; @@ -spin_lock(&E->U.lock) +uart_port_lock(&E->U) @r12@ r10.T1 *E; identifier r10.U; @@ -spin_lock_irq(&E->U.lock) +uart_port_lock_irq(&E->U) @r13@ r10.T1 *E; identifier r10.U; identifier F; @@ -spin_lock_irqsave(&E->U.lock, F) +uart_port_lock_irqsave(&E->U, &F) @r14@ r10.T1 *E; identifier r10.U; @@ -spin_unlock(&E->U.lock) +uart_port_unlock(&E->U) @r15@ r10.T1 *E; identifier r10.U; @@ -spin_unlock_irq(&E->U.lock) +uart_port_unlock_irq(&E->U) @r16@ r10.T1 *E; identifier r10.U; identifier F; @@ -spin_unlock_irqrestore(&E->U.lock, F) +uart_port_unlock_irqrestore(&E->U, F) @r17@ r10.T1 *E; identifier r10.U; @@ -spin_trylock(&E->U.lock) +uart_port_trylock(&E->U) @r18@ r10.T1 *E; identifier r10.U; identifier F; @@ -spin_trylock_irqsave(&E->U.lock, F) +uart_port_trylock_irqsave(&E->U, &F)